feat(tasks): use our task template, with example doc

This commit is contained in:
Colin Darie 2024-09-19 13:25:21 +02:00
parent cbc13c4c5c
commit c0ae02f458
No known key found for this signature in database
GPG key ID: 4FB865FDBCA4BCC4
2 changed files with 26 additions and 0 deletions

View file

@ -6,6 +6,7 @@ Rails.application.config.after_initialize do
class MaintenanceTasks::TaskGenerator
alias_method :original_assign_names!, :assign_names!
source_paths << Rails.root.join("lib/templates/maintenance_tasks")
private

View file

@ -0,0 +1,25 @@
# frozen_string_literal: true
module <%= tasks_module %>
<% module_namespacing do -%>
class <%= class_name %>Task < MaintenanceTasks::Task
# Documentation: cette tâche modifie les données pour…
def collection
# Collection to be iterated over
# Must be Active Record Relation or Array
end
def process(element)
# The work to be done in a single iteration of the task.
# This should be idempotent, as the same element may be processed more
# than once if the task is interrupted and resumed.
end
def count
# Optionally, define the number of rows that will be iterated over
# This is used to track the task's progress
end
end
<% end -%>
end