maintenance_tasks 2.3.0 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a14c442d683123d8aabb30db8c73c15a31ddd24852356aa64b0255b1cb2312e0
-  data.tar.gz: d5df5cbfa0cf9feab143ae2ea15cb5a0013978b552a068d9a588fed4e04178bd
+  metadata.gz: cfca7a21544ab46b7d3c24464b29a6ac988dafa08ac8c2f22955d037932e1710
+  data.tar.gz: bdd38b4905fcf1248ca3c88ee8e29e74fb34ca10a226b6bdbd91507d61040250
 SHA512:
-  metadata.gz: 528669b01c611fe0e502683665182bddb2a98f2a74911c5d957f3868fca2ff57323a07eb2093acdfedc39e44057f8346702f70fc67cf027f59a32b985a6f7cea
-  data.tar.gz: bb00d7ef688b49ad9ae295650eea0b57718ea95aea6b341780011d882ae2b0f9ac830241cd9663d3bd7c9b9e08b3ee9bf6daa91a4ef2e4c53b69a15350c2da06
+  metadata.gz: 97f000fad025014bba55992c5d49e1c15557b34599a3a00d7815edf2c9da99aa2a660470ae96c58e89242b515f8e9c588ff9358ae65c5692649cc5f5805cfc10
+  data.tar.gz: aef9399c97ab570a58d5768426d1d2a3e4907b20eaa36dd304f36438a2139c84116358d9e71e63a8098371a3c653f1d1adab94486e6a5ce92508e637cdf62495

data/README.md

@@ -840,8 +840,8 @@ or email of the user who performed the maintenance task.
 
 ```ruby
 # config/initializers/maintenance_tasks.rb
-MaintenanceTasks.metadata = -> do
- { user_email: current_user.email }
+MaintenanceTasks.metadata = ->(context) do
+ { user_email: context.current_user.email }
 end
 ```
 

data/app/controllers/maintenance_tasks/runs_controller.rb

@@ -14,7 +14,7 @@ module MaintenanceTasks
         name: params.fetch(:task_id),
         csv_file: params[:csv_file],
         arguments: params.fetch(:task_arguments, {}).permit!.to_h,
-        metadata: MaintenanceTasks.metadata&.call,
+        metadata: instance_exec(&MaintenanceTasks.metadata || -> {}),
         &block
       )
       redirect_to(task_path(task))

data/app/models/maintenance_tasks/task.rb

@@ -41,15 +41,27 @@ module MaintenanceTasks
         task
       end
 
-      # Returns a list of concrete classes that inherit from the Task
-      # superclass.
+      # Loads and returns a list of concrete classes that inherit
+      # from the Task superclass.
       #
       # @return [Array<Class>] the list of classes.
-      def available_tasks
+      def load_all
         load_constants
         descendants
       end
 
+      # Loads and returns a list of concrete classes that inherit
+      # from the Task superclass.
+      #
+      # @return [Array<Class>] the list of classes.
+      def available_tasks
+        warn(<<~MSG.squish, category: :deprecated)
+          MaintenanceTasks::Task.available_tasks is deprecated and will be
+          removed from maintenance-tasks 3.0.0. Use .load_all instead.
+        MSG
+        load_all
+      end
+
       # Make this Task a task that handles CSV.
       #
       # @param in_batches [Integer] optionally, supply a batch size if the CSV

data/app/models/maintenance_tasks/task_data_index.rb

@@ -25,7 +25,7 @@ module MaintenanceTasks
       def available_tasks
         tasks = []
 
-        task_names = Task.available_tasks.map(&:name)
+        task_names = Task.load_all.map(&:name)
 
         active_runs = Run.with_attached_csv.active.where(task_name: task_names)
         active_runs.each do |run|

data/lib/maintenance_tasks/cli.rb

@@ -16,15 +16,6 @@ module MaintenanceTasks
 
     desc "perform [TASK NAME]", "Runs the given Maintenance Task"
 
-    long_desc <<-LONGDESC
-      `maintenance_tasks perform` will run the Maintenance Task specified by the
-      [TASK NAME] argument.
-
-      Available Tasks:
-
-      #{MaintenanceTasks::Task.available_tasks.join("\n\n")}
-    LONGDESC
-
     # Specify the CSV file to process for CSV Tasks
     desc = "Supply a CSV file to be processed by a CSV Task, "\
       "--csv path/to/csv/file.csv"
@@ -50,6 +41,21 @@ module MaintenanceTasks
       say_status(:error, error.message, :red)
     end
 
+    # `long_desc` only allows us to use a static string as "long description".
+    # By redefining the `#long_description` method on the "perform" Command
+    # object instead, we make it dynamic, thus delaying the task loading
+    # process until it's actually required.
+    commands["perform"].define_singleton_method(:long_description) do
+      <<~LONGDESC
+        `maintenance_tasks perform` will run the Maintenance Task specified by
+        the [TASK NAME] argument.
+
+        Available Tasks:
+
+        #{Task.load_all.map(&:name).sort.join("\n\n")}
+      LONGDESC
+    end
+
     private
 
     def csv_file

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.2
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-23 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -56,14 +56,14 @@ dependencies:
   name: job-iteration
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.6
 - !ruby/object:Gem::Dependency
@@ -156,7 +156,7 @@ homepage: https://github.com/Shopify/maintenance_tasks
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.3.0
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v2.3.2
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.18
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: A Rails engine for queuing and managing maintenance tasks