maintenance_tasks 1.1.1 → 1.3.0

data/app/views/maintenance_tasks/runs/_info.html.erb

@@ -9,7 +9,7 @@
   <%= render "maintenance_tasks/runs/info/#{run.status}", run: run %>
 </div>
 
-<% if run.csv_file.attached? %>
+<% if run.csv_file.present? %>
   <div class="block">
     <%= link_to('Download CSV', csv_file_download_path(run)) %>
   </div>

data/app/views/maintenance_tasks/runs/info/_running.html.erb

@@ -1,7 +1,5 @@
 <p>
   <% if run.estimated_completion_time %>
     <%= estimated_time_to_completion(run).capitalize %> remaining.
-  <% else %>
-    Processed <%= pluralize run.tick_count, 'item' %> so far.
   <% end %>
 </p>

data/app/views/maintenance_tasks/tasks/show.html.erb

@@ -41,12 +41,12 @@
   <pre><code><%= highlight_code(code) %></code></pre>
 <% end %>
 
-<% if @previous_runs.present? %>
+<% if @runs_page.records.present? %>
   <hr/>
 
   <h4 class="title is-4">Previous Runs</h4>
 
-  <%= render @previous_runs %>
+  <%= render @runs_page.records %>
 
-  <%= pagination(@pagy) %>
+  <%= link_to "Next page", task_path(@task, cursor: @runs_page.next_cursor) unless @runs_page.last? %>
 <% end %>

data/config/routes.rb

@@ -2,16 +2,16 @@
 MaintenanceTasks::Engine.routes.draw do
   resources :tasks, only: [:index, :show], format: false do
     member do
-      put 'run'
+      put "run"
     end
 
     resources :runs, only: [], format: false do
       member do
-        put 'pause'
-        put 'cancel'
+        put "pause"
+        put "cancel"
       end
     end
   end
 
-  root to: 'tasks#index'
+  root to: "tasks#index"
 end

data/db/migrate/20210225152418_remove_index_on_task_name.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-class RemoveIndexOnTaskName < ActiveRecord::Migration[6.1]
+class RemoveIndexOnTaskName < ActiveRecord::Migration[6.0]
   def up
     change_table(:maintenance_tasks_runs) do |t|
       t.remove_index(:task_name)

data/exe/maintenance_tasks

@@ -2,11 +2,11 @@
 
 # frozen_string_literal: true
 
-require File.expand_path('config/application', Dir.pwd)
+require File.expand_path("config/application", Dir.pwd)
 
 Rails.application.require_environment!
 
-require 'maintenance_tasks/cli'
+require "maintenance_tasks/cli"
 
 module MaintenanceTasks
   CLI.start(ARGV)

data/lib/generators/maintenance_tasks/install_generator.rb

@@ -5,17 +5,17 @@ module MaintenanceTasks
   #
   # @api private
   class InstallGenerator < Rails::Generators::Base
-    source_root File.expand_path('templates', __dir__)
+    source_root File.expand_path("templates", __dir__)
 
     # Mounts the engine in the host application's config/routes.rb
     def mount_engine
-      route("mount MaintenanceTasks::Engine => '/maintenance_tasks'")
+      route("mount MaintenanceTasks::Engine => \"/maintenance_tasks\"")
     end
 
     # Copies engine migrations to host application and migrates the database
     def install_migrations
-      rake('maintenance_tasks:install:migrations')
-      rake('db:migrate')
+      rake("maintenance_tasks:install:migrations")
+      rake("db:migrate")
     end
   end
 end

data/lib/generators/maintenance_tasks/task_generator.rb

@@ -5,14 +5,14 @@ module MaintenanceTasks
   #
   # @api private
   class TaskGenerator < Rails::Generators::NamedBase
-    source_root File.expand_path('templates', __dir__)
-    desc 'This generator creates a task file at app/tasks and a corresponding '\
-      'test.'
+    source_root File.expand_path("templates", __dir__)
+    desc "This generator creates a task file at app/tasks and a corresponding "\
+      "test."
 
     class_option :csv, type: :boolean, default: false,
-      desc: 'Generate a CSV Task.'
+      desc: "Generate a CSV Task."
 
-    check_class_collision suffix: 'Task'
+    check_class_collision suffix: "Task"
 
     # Creates the Task file.
     def create_task_file
@@ -22,9 +22,9 @@ module MaintenanceTasks
         "#{file_name}_task.rb"
       )
       if options[:csv]
-        template('csv_task.rb', template_file)
+        template("csv_task.rb", template_file)
       else
-        template('task.rb', template_file)
+        template("task.rb", template_file)
       end
     end
 
@@ -49,7 +49,7 @@ module MaintenanceTasks
         class_path,
         "#{file_name}_task_test.rb"
       )
-      template('task_test.rb', template_file)
+      template("task_test.rb", template_file)
     end
 
     def create_task_spec_file
@@ -58,11 +58,11 @@ module MaintenanceTasks
         class_path,
         "#{file_name}_task_spec.rb"
       )
-      template('task_spec.rb', template_file)
+      template("task_spec.rb", template_file)
     end
 
     def file_name
-      super.sub(/_task\z/i, '')
+      super.sub(/_task\z/i, "")
     end
 
     def tasks_module

data/lib/generators/maintenance_tasks/templates/task_spec.rb.tt

@@ -4,11 +4,13 @@ require 'rails_helper'
 module <%= tasks_module %>
 <% module_namespacing do -%>
   RSpec.describe <%= class_name %>Task do
-    # describe '#process' do
-      # it 'performs a task iteration' do
-        # <%= tasks_module %>::<%= class_name %>Task.process(element)
-      # end
-    # end
+    describe "#process" do
+      subject(:process) { described_class.process(element) }
+      let(:element) { 
+        # Object to be processed in a single iteration of this task
+      }
+      pending "add some examples to (or delete) #{__FILE__}"
+    end
   end
 <% end -%>
 end

data/lib/maintenance_tasks.rb

@@ -1,53 +1,67 @@
 # frozen_string_literal: true
-require 'action_controller'
-require 'action_view'
-require 'active_job'
-require 'active_record'
+require "action_controller"
+require "action_view"
+require "active_job"
+require "active_record"
 
-require 'job-iteration'
-require 'maintenance_tasks/engine'
-require 'pagy'
-require 'pagy/extras/bulma'
-
-# Force the TaskJob class to load so we can verify upstream compatibility with
-# the JobIteration gem
-require_relative '../app/jobs/maintenance_tasks/task_job'
+require "job-iteration"
+require "maintenance_tasks/engine"
 
 # The engine's namespace module. It provides isolation between the host
 # application's code and the engine-specific code. Top-level engine constants
 # and variables are defined under this module.
 module MaintenanceTasks
-  # The module to namespace Tasks in, as a String. Defaults to 'Maintenance'.
-  # @param [String] the tasks_module value.
-  mattr_accessor :tasks_module, default: 'Maintenance'
+  # @!attribute tasks_module
+  #   @scope class
+  #
+  #   The module to namespace Tasks in, as a String. Defaults to 'Maintenance'.
+  #   @return [String] the name of the module.
+  mattr_accessor :tasks_module, default: "Maintenance"
 
-  # Defines the job to be used to perform Tasks. This job must be either
-  # `MaintenanceTasks::TaskJob` or a class that inherits from it.
+  # @!attribute job
+  #   @scope class
+  #
+  #   The name of the job to be used to perform Tasks. Defaults to
+  #   `"MaintenanceTasks::TaskJob"`. This job must be either a class that
+  #   inherits from {TaskJob} or a class that includes {TaskJobConcern}.
   #
-  # @param [String] the name of the job class.
-  mattr_accessor :job, default: 'MaintenanceTasks::TaskJob'
+  #   @return [String] the name of the job class.
+  mattr_accessor :job, default: "MaintenanceTasks::TaskJob"
 
-  # After each iteration, the progress of the task may be updated. This duration
-  # in seconds limits these updates, skipping if the duration since the last
-  # update is lower than this value, except if the job is interrupted, in which
-  # case the progress will always be recorded.
+  # @!attribute ticker_delay
+  #   @scope class
   #
-  # @param [ActiveSupport::Duration, Numeric] Duration of the delay to update
-  #   the ticker during Task iterations.
+  #   The delay between updates to the tick count. After each iteration, the
+  #   progress of the Task may be updated. This duration in seconds limits
+  #   these updates, skipping if the duration since the last update is lower
+  #   than this value, except if the job is interrupted, in which case the
+  #   progress will always be recorded.
+  #
+  #   @return [ActiveSupport::Duration, Numeric] duration of the delay between
+  #     updates to the tick count during Task iterations.
   mattr_accessor :ticker_delay, default: 1.second
 
-  # Retrieves the callback to be performed when an error occurs in the task.
+  # @!attribute active_storage_service
+  #   @scope class
+  #
+  #   The Active Storage service to use for uploading CSV file blobs.
+  #
+  #   @return [Symbol] the key for the storage service, as specified in the
+  #     app's config/storage.yml.
+  mattr_accessor :active_storage_service
+
+  # @private
   def self.error_handler
     return @error_handler if defined?(@error_handler)
     @error_handler = ->(_error, _task_context, _errored_element) {}
   end
 
-  # Defines a callback to be performed when an error occurs in the task.
+  # @private
   def self.error_handler=(error_handler)
     unless error_handler.arity == 3
       ActiveSupport::Deprecation.warn(
-        'MaintenanceTasks.error_handler should be a lambda that takes three '\
-         'arguments: error, task_context, and errored_element.'
+        "MaintenanceTasks.error_handler should be a lambda that takes three "\
+         "arguments: error, task_context, and errored_element."
       )
       @error_handler = ->(error, _task_context, _errored_element) do
         error_handler.call(error)
@@ -55,4 +69,12 @@ module MaintenanceTasks
     end
     @error_handler = error_handler
   end
+
+  # @!attribute error_handler
+  #   @scope class
+  #
+  #   The callback to perform when an error occurs in the Task.  See the
+  #   {file:README#label-Customizing+the+error+handler} for details.
+  #
+  #   @return [Proc] the callback to perform when an error occurs in the Task.
 end

data/lib/maintenance_tasks/cli.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'thor'
+require "thor"
 
 module MaintenanceTasks
   # Defines the command line interface commands exposed by Maintenance Tasks in
@@ -13,7 +13,7 @@ module MaintenanceTasks
       end
     end
 
-    desc 'perform [TASK NAME]', 'Runs the given Maintenance Task'
+    desc "perform [TASK NAME]", "Runs the given Maintenance Task"
 
     long_desc <<-LONGDESC
       `maintenance_tasks perform` will run the Maintenance Task specified by the
@@ -25,7 +25,7 @@ module MaintenanceTasks
     LONGDESC
 
     # Specify the CSV file to process for CSV Tasks
-    option :csv, desc: 'Supply a CSV file to be processed by a CSV Task, '\
+    option :csv, desc: "Supply a CSV file to be processed by a CSV Task, "\
       '--csv "path/to/csv/file.csv"'
 
     # Command to run a Task.

data/lib/maintenance_tasks/engine.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'active_record/railtie'
+require "active_record/railtie"
 
 module MaintenanceTasks
   # The engine's main class, which defines its namespace. The engine is mounted
@@ -7,11 +7,12 @@ module MaintenanceTasks
   class Engine < ::Rails::Engine
     isolate_namespace MaintenanceTasks
 
-    initializer 'eager_load_for_classic_autoloader' do
+    initializer "eager_load_for_classic_autoloader" do
       eager_load! unless Rails.autoloaders.zeitwerk_enabled?
     end
 
     config.to_prepare do
+      _ = TaskJobConcern # load this for JobIteration compatibility check
       unless Rails.autoloaders.zeitwerk_enabled?
         tasks_module = MaintenanceTasks.tasks_module.underscore
         Dir["#{Rails.root}/app/tasks/#{tasks_module}/*.rb"].each do |file|
@@ -25,7 +26,7 @@ module MaintenanceTasks
     end
 
     config.action_dispatch.rescue_responses.merge!(
-      'MaintenanceTasks::Task::NotFoundError' => :not_found,
+      "MaintenanceTasks::Task::NotFoundError" => :not_found,
     )
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2021-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: pagy
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -101,19 +87,21 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.md
 - README.md
-- Rakefile
 - app/controllers/maintenance_tasks/application_controller.rb
 - app/controllers/maintenance_tasks/runs_controller.rb
 - app/controllers/maintenance_tasks/tasks_controller.rb
 - app/helpers/maintenance_tasks/application_helper.rb
 - app/helpers/maintenance_tasks/tasks_helper.rb
+- app/jobs/concerns/maintenance_tasks/task_job_concern.rb
 - app/jobs/maintenance_tasks/task_job.rb
 - app/models/maintenance_tasks/application_record.rb
 - app/models/maintenance_tasks/csv_collection.rb
 - app/models/maintenance_tasks/progress.rb
 - app/models/maintenance_tasks/run.rb
 - app/models/maintenance_tasks/runner.rb
+- app/models/maintenance_tasks/runs_page.rb
 - app/models/maintenance_tasks/task_data.rb
 - app/models/maintenance_tasks/ticker.rb
 - app/tasks/maintenance_tasks/task.rb
@@ -149,12 +137,13 @@ files:
 - lib/maintenance_tasks/engine.rb
 - lib/tasks/maintenance_tasks_tasks.rake
 homepage: https://github.com/Shopify/maintenance_tasks
-licenses: []
+licenses:
+- MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.1.1
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.3.0
   allowed_push_host: https://rubygems.org
 post_install_message: |-
-  Thank you for installing Maintenance Tasks 1.1.1. To complete, please run:
+  Thank you for installing Maintenance Tasks 1.3.0. To complete, please run:
 
   rails generate maintenance_tasks:install
 rdoc_options: []
@@ -171,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: A Rails engine for queuing and managing maintenance tasks

data/Rakefile

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'MaintenanceTasks'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
-load('rails/tasks/engine.rake')
-
-load('rails/tasks/statistics.rake')
-
-require 'bundler/gem_tasks'
-
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new
-
-task(test: 'app:test')
-task('test:system' => 'app:test:system')
-task(default: ['db:setup', 'test', 'test:system', 'rubocop'])