maintenance_tasks 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab7d654d153de66a16dc940efdafe3c15e0f151383829b1cb331a67a86c6532c
-  data.tar.gz: 375fde5efda30bd597d9609f08ee2edada28d336e97991b05e9357f5edca17cb
+  metadata.gz: ed5e344271f9c3342d90720aef36f06a0d62634eb646318afa0bb18e29b0edcc
+  data.tar.gz: 3a32052fb7148cdf403939cbfc154c816285897dd58396db3e4b39d6bb9aa9b0
 SHA512:
-  metadata.gz: 3ec5d5108af6fecdcfa4a8fd7a37640f48f3e5dc39c918a8a0bf52bd9792474f465cfc495491caad22337da8bba6446726e0f58114e1b22a44e2b30a10168d3c
-  data.tar.gz: 07c9fc9e6e5779fe9180081c5b8306acb43ab6d30dd500b2c2184ab24e8e901e1221f88c29294eaba51cf38f81e054f4ce2575fcd02f897d22238f0fe04c08df
+  metadata.gz: 34d930320936fb1286687ec4268c1af2ba7cdd3e7a1d704ce45dc68de76ff3f47dece9ad714848b76ad6d33407dbe9204b6d2eb172cc2f1040831ab9a728bfb0
+  data.tar.gz: 612b1a57750e4a3c250d914e915b2389a8931c1b5de19fcd3bf8a3cc2be1bb5f9cc98881380294455c035d71717065fb6b6728a1b839a98cd71c2aaedc890070

data/README.md

@@ -22,6 +22,7 @@ A Rails engine for queuing and managing maintenance tasks.
     * [Customizing the maintenance tasks module](#customizing-the-maintenance-tasks-module)
     * [Customizing the underlying job class](#customizing-the-underlying-job-class)
     * [Customizing the rate at which task progress gets updated](#customizing-the-rate-at-which-task-progress-gets-updated)
+    * [Customizing which Active Storage service to use](#customizing-which-active-storage-service-to-use)
 * [Upgrading](#upgrading)
 * [Contributing](#contributing)
 * [Releasing new versions](#releasing-new-versions)
@@ -338,12 +339,15 @@ end
 
 The error handler should be a lambda that accepts three arguments:
 
-* `error`: The object containing the exception that was raised.
+* `error`: The exception that was raised.
 * `task_context`: A hash with additional information about the Task and the
   error:
   * `task_name`: The name of the Task that errored
   * `started_at`: The time the Task started
   * `ended_at`: The time the Task errored
+  Note that `task_context` may be empty if the Task produced an error before any
+  context could be gathered (for example, if deserializing the job to process
+  your Task failed).
 * `errored_element`: The element, if any, that was being processed when the
   Task raised an exception. If you would like to pass this object to your
   exception monitoring service, make sure you **sanitize the object** to avoid
@@ -400,6 +404,36 @@ MaintenanceTasks.ticker_delay = 2.seconds
 
 If no value is specified, it will default to 1 second.
 
+#### Customizing which Active Storage service to use
+
+The Active Storage framework in Rails 6.1 and up supports multiple storage
+services per environment. To specify which service to use,
+`MaintenanceTasks.active_storage_service` can be configured with the service's
+key, as specified in your application's `config/storage.yml`:
+
+```yaml
+# config/storage.yml
+user_data:
+  service: GCS
+  credentials: <%= Rails.root.join("path/to/user/data/keyfile.json") %>
+  project: "my-project"
+  bucket: "user-data-bucket"
+
+internal:
+  service: GCS
+  credentials: <%= Rails.root.join("path/to/internal/keyfile.json") %>
+  project: "my-project"
+  bucket: "internal-bucket"
+```
+
+```ruby
+# config/initializers/maintenance_tasks.rb
+MaintenanceTasks.active_storage_service = :internal
+```
+
+There is no need to configure this option if your application uses only one
+storage service per environment.
+
 ## Upgrading
 
 Use bundler to check for and upgrade to newer versions. After installing a new
@@ -421,13 +455,20 @@ pull requests. You can find the contribution guidelines on
 
 ## Releasing new versions
 
+Updates should be added to the latest draft release on GitHub as Pull Requests
+are merged.
+
+Once a release is ready, follow these steps:
+
 * Update `spec.version` in `maintenance_tasks.gemspec`.
 * Run `bundle install` to bump the `Gemfile.lock` version of the gem.
 * Open a PR and merge on approval.
-* Create a [release on GitHub][release] with a version number that matches the
-  version defined in the gemspec.
 * Deploy via [Shipit][shipit] and see the new version on
   <https://rubygems.org/gems/maintenance_tasks>.
+* Ensure the release has documented all changes and publish it.
+* Create a new [draft release on GitHub][release] with the title
+  'Upcoming Release'. The tag version can be left blank. This will be the
+  starting point for documenting changes related to the next release.
 
 [release]: https://help.github.com/articles/creating-releases/
 [shipit]: https://shipit.shopify.io/shopify/maintenance_tasks/rubygems

data/Rakefile

@@ -1,29 +1,29 @@
 # frozen_string_literal: true
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+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')
+  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')
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load("rails/tasks/engine.rake")
 
-load('rails/tasks/statistics.rake')
+load("rails/tasks/statistics.rake")
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rubocop/rake_task'
+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'])
+task(test: "app:test")
+task("test:system" => "app:test:system")
+task(default: ["db:test:prepare", "test", "test:system", "rubocop"])

data/app/controllers/maintenance_tasks/application_controller.rb

@@ -5,9 +5,7 @@ module MaintenanceTasks
   #
   # Can be extended to add different authentication and authorization code.
   class ApplicationController < ActionController::Base
-    include Pagy::Backend
-
-    BULMA_CDN = 'https://cdn.jsdelivr.net'
+    BULMA_CDN = "https://cdn.jsdelivr.net"
 
     content_security_policy do |policy|
       policy.style_src(BULMA_CDN)
@@ -17,7 +15,7 @@ module MaintenanceTasks
     before_action do
       request.content_security_policy_nonce_generator ||=
         ->(_request) { SecureRandom.base64(16) }
-      request.content_security_policy_nonce_directives = ['style-src']
+      request.content_security_policy_nonce_directives = ["style-src"]
     end
 
     protect_from_forgery with: :exception

data/app/controllers/maintenance_tasks/tasks_controller.rb

@@ -20,7 +20,7 @@ module MaintenanceTasks
     def show
       @task = TaskData.find(params.fetch(:id))
       set_refresh if @task.last_run&.active?
-      @pagy, @previous_runs = pagy(@task.previous_runs)
+      @runs_page = RunsPage.new(@task.previous_runs, params[:cursor])
     end
 
     # Runs a given Task and redirects to the Task page.

data/app/helpers/maintenance_tasks/application_helper.rb

@@ -4,17 +4,6 @@ module MaintenanceTasks
   #
   # @api private
   module ApplicationHelper
-    include Pagy::Frontend
-
-    # Renders pagination for the page, if there is more than one page present.
-    #
-    # @param pagy [Pagy] the pagy instance containing pagination details,
-    #   including the number of pages the results are spread across.
-    # @return [String] the HTML to render for pagination.
-    def pagination(pagy)
-      raw(pagy_bulma_nav(pagy)) if pagy.pages > 1
-    end
-
     # Renders a time element with the given datetime, worded as relative to the
     # current time.
     #
@@ -24,8 +13,8 @@ module MaintenanceTasks
     # @param datetime [ActiveSupport::TimeWithZone] the time to be presented.
     # @return [String] the HTML to render with the relative datetime in words.
     def time_ago(datetime)
-      time_tag(datetime, title: datetime.utc.iso8601, class: 'is-clickable') do
-        time_ago_in_words(datetime) + ' ago'
+      time_tag(datetime, title: datetime.utc.iso8601, class: "is-clickable") do
+        time_ago_in_words(datetime) + " ago"
       end
     end
   end

data/app/helpers/maintenance_tasks/tasks_helper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ripper'
+require "ripper"
 
 module MaintenanceTasks
   # Helpers for formatting data in the maintenance_tasks views.
@@ -8,16 +8,16 @@ module MaintenanceTasks
   # @api private
   module TasksHelper
     STATUS_COLOURS = {
-      'new' => ['is-primary'],
-      'enqueued' => ['is-primary is-light'],
-      'running' => ['is-info'],
-      'interrupted' => ['is-info', 'is-light'],
-      'pausing' => ['is-warning', 'is-light'],
-      'paused' => ['is-warning'],
-      'succeeded' => ['is-success'],
-      'cancelling' => ['is-light'],
-      'cancelled' => ['is-dark'],
-      'errored' => ['is-danger'],
+      "new" => ["is-primary"],
+      "enqueued" => ["is-primary is-light"],
+      "running" => ["is-info"],
+      "interrupted" => ["is-info", "is-light"],
+      "pausing" => ["is-warning", "is-light"],
+      "paused" => ["is-warning"],
+      "succeeded" => ["is-success"],
+      "cancelling" => ["is-light"],
+      "cancelled" => ["is-dark"],
+      "errored" => ["is-danger"],
     }
 
     # Formats a run backtrace.
@@ -44,12 +44,13 @@ module MaintenanceTasks
 
       progress = Progress.new(run)
 
-      tag.progress(
+      progress_bar = tag.progress(
         value: progress.value,
         max: progress.max,
-        title: progress.title,
-        class: ['progress'] + STATUS_COLOURS.fetch(run.status)
+        class: ["progress"] + STATUS_COLOURS.fetch(run.status)
       )
+      progress_text = tag.p(tag.i(progress.text))
+      tag.div(progress_bar + progress_text, class: "block")
     end
 
     # Renders a span with a Run's status, with the corresponding tag class
@@ -59,7 +60,7 @@ module MaintenanceTasks
     # @return [String] the span element containing the status, with the
     #   appropriate tag class attached.
     def status_tag(status)
-      tag.span(status.capitalize, class: ['tag'] + STATUS_COLOURS.fetch(status))
+      tag.span(status.capitalize, class: ["tag"] + STATUS_COLOURS.fetch(status))
     end
 
     # Returns the distance between now and the Run's expected completion time,
@@ -100,7 +101,7 @@ module MaintenanceTasks
         when :on_nl, :on_sp, :on_ignored_nl
           content
         else
-          tag.span(content, class: type.to_s.sub('on_', 'ruby-').dasherize)
+          tag.span(content, class: type.to_s.sub("on_", "ruby-").dasherize)
         end
       end
       safe_join(tokens)

data/app/jobs/maintenance_tasks/task_job.rb

@@ -19,7 +19,7 @@ module MaintenanceTasks
       # Overrides ActiveJob::Exceptions.retry_on to declare it unsupported.
       # The use of rescue_from prevents retry_on from being usable.
       def retry_on(*, **)
-        raise NotImplementedError, 'retry_on is not supported'
+        raise NotImplementedError, "retry_on is not supported"
       end
     end
 
@@ -38,7 +38,7 @@ module MaintenanceTasks
         JobIteration::CsvEnumerator.new(collection).rows(cursor: cursor)
       else
         raise ArgumentError, "#{@task.class.name}#collection must be either "\
-          'an Active Record Relation, Array, or CSV.'
+          "an Active Record Relation, Array, or CSV."
       end
     end
 
@@ -122,13 +122,18 @@ module MaintenanceTasks
 
     def on_error(error)
       @ticker.persist if defined?(@ticker)
-      @run.persist_error(error)
 
-      task_context = {
-        task_name: @run.task_name,
-        started_at: @run.started_at,
-        ended_at: @run.ended_at,
-      }
+      if defined?(@run)
+        @run.persist_error(error)
+
+        task_context = {
+          task_name: @run.task_name,
+          started_at: @run.started_at,
+          ended_at: @run.ended_at,
+        }
+      else
+        task_context = {}
+      end
       errored_element = @errored_element if defined?(@errored_element)
       MaintenanceTasks.error_handler.call(error, task_context, errored_element)
     end

data/app/models/maintenance_tasks/csv_collection.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'csv'
+require "csv"
 
 module MaintenanceTasks
   # Module that is included into Task classes by Task.csv_collection for

data/app/models/maintenance_tasks/progress.rb

@@ -4,6 +4,7 @@ module MaintenanceTasks
   # This class generates progress information about a Run.
   class Progress
     include ActiveSupport::NumberHelper
+    include ActionView::Helpers::TextHelper
 
     # Sets the Progress initial state with a Run.
     #
@@ -41,22 +42,23 @@ module MaintenanceTasks
       estimatable? ? @run.tick_total : @run.tick_count
     end
 
-    # The title for the progress information. This is a text that describes the
-    # progress of the Run so far. It includes the percentage that is done out of
-    # the maximum, if an estimate is possible.
+    # The text containing progress information. This describes the progress of
+    # the Run so far. It includes the percentage done out of the maximum, if an
+    # estimate is possible.
     #
-    # @return [String] the title for the Run progress.
-    def title
+    # @return [String] the text for the Run progress.
+    def text
+      count = @run.tick_count
+      total = @run.tick_total
       if !total?
-        "Processed #{@run.tick_count} #{'item'.pluralize(@run.tick_count)}."
+        "Processed #{pluralize(count, 'item')}."
       elsif over_total?
-        "Processed #{@run.tick_count} #{'item'.pluralize(@run.tick_count)} " \
-          "(expected #{@run.tick_total})."
+        "Processed #{pluralize(count, 'item')} (expected #{total})."
       else
-        percentage = 100.0 * @run.tick_count / @run.tick_total
+        percentage = 100.0 * count / total
 
-        "Processed #{@run.tick_count} out of #{@run.tick_total} "\
-          "(#{number_to_percentage(percentage, precision: 0)})"
+        "Processed #{count} out of #{pluralize(total, 'item')} "\
+          "(#{number_to_percentage(percentage, precision: 0)})."
       end
     end
 

data/app/models/maintenance_tasks/run.rb

@@ -48,7 +48,7 @@ module MaintenanceTasks
 
     validates_with RunStatusValidator, on: :update
 
-    has_one_attached :csv_file
+    has_one_attached :csv_file, service: MaintenanceTasks.active_storage_service
 
     # Sets the run status to enqueued, making sure the transition is validated
     # in case it's already enqueued.
@@ -192,9 +192,9 @@ module MaintenanceTasks
     # if the Run does not meet the above criteria.
     def csv_attachment_presence
       if Task.named(task_name) < CsvCollection && !csv_file.attached?
-        errors.add(:csv_file, 'must be attached to CSV Task.')
+        errors.add(:csv_file, "must be attached to CSV Task.")
       elsif !(Task.named(task_name) < CsvCollection) && csv_file.present?
-        errors.add(:csv_file, 'should not be attached to non-CSV Task.')
+        errors.add(:csv_file, "should not be attached to non-CSV Task.")
       end
     rescue Task::NotFoundError
       nil

data/app/models/maintenance_tasks/runner.rb

@@ -8,7 +8,7 @@ module MaintenanceTasks
     # @deprecated Use {Runner} directly instead.
     def new
       ActiveSupport::Deprecation.warn(
-        'Use Runner.run instead of Runner.new.run'
+        "Use Runner.run instead of Runner.new.run"
       )
       self
     end
@@ -57,7 +57,7 @@ module MaintenanceTasks
     def enqueue(run)
       unless MaintenanceTasks.job.constantize.perform_later(run)
         raise "The job to perform #{run.task_name} could not be enqueued. "\
-          'Enqueuing has been prevented by a callback.'
+          "Enqueuing has been prevented by a callback."
       end
     rescue => error
       run.persist_error(error)

data/app/models/maintenance_tasks/runs_page.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+module MaintenanceTasks
+  # This class is responsible for handling cursor-based pagination for Run
+  # records.
+  #
+  # @api private
+  class RunsPage
+    # The number of Runs to show on a single Task page.
+    RUNS_PER_PAGE = 20
+
+    # Initializes a Runs Page with a Runs relation and a cursor. This page is
+    # used by the views to render a set of Runs.
+    # @param runs [ActiveRecord::Relation<MaintenanceTasks::Run>] the relation
+    #   of Run records to be paginated.
+    # @param cursor [String, nil] the id that serves as the cursor when
+    #   querying the Runs dataset to produce a page of Runs. If nil, the first
+    #   Runs in the relation are used.
+    def initialize(runs, cursor)
+      @runs = runs
+      @cursor = cursor
+    end
+
+    # Returns the records for a Page, taking into account the cursor if one is
+    # present. Limits the number of records to 20.
+    #
+    # @return [ActiveRecord::Relation<MaintenanceTasks::Run>] a limited amount
+    #  of Run records.
+    def records
+      @records ||= begin
+        runs_after_cursor = if @cursor.present?
+          @runs.where("id < ?", @cursor)
+        else
+          @runs
+        end
+        runs_after_cursor.limit(RUNS_PER_PAGE)
+      end
+    end
+
+    # Returns the cursor to use for the next Page of Runs. It is the id of the
+    # last record on the current Page.
+    #
+    # @return [Integer] the id of the last record for the Page.
+    def next_cursor
+      records.last.id
+    end
+
+    # Returns whether this Page is the last one.
+    #
+    # @return [Boolean] whether this Page contains the last Run record in the
+    #   Runs dataset that is being paginated.
+    def last?
+      @runs.unscope(:includes).pluck(:id).last == next_cursor
+    end
+  end
+end

data/app/models/maintenance_tasks/task_data.rb

@@ -41,7 +41,7 @@ module MaintenanceTasks
         task_names = Task.available_tasks.map(&:name)
         available_task_runs = Run.where(task_name: task_names)
         last_runs = Run.where(
-          id: available_task_runs.select('MAX(id) as id').group(:task_name)
+          id: available_task_runs.select("MAX(id) as id").group(:task_name)
         )
 
         task_names.map do |task_name|
@@ -111,7 +111,7 @@ module MaintenanceTasks
     #
     # @return [String] the Task status.
     def status
-      last_run&.status || 'new'
+      last_run&.status || "new"
     end
 
     # Retrieves the Task's category, which is one of active, new, or completed.

data/app/validators/maintenance_tasks/run_status_validator.rb

@@ -13,7 +13,7 @@ module MaintenanceTasks
       #   before starting.
       # enqueued -> errored occurs when the task job fails to be enqueued, or
       #   if the Task is deleted before is starts running.
-      'enqueued' => ['running', 'pausing', 'cancelling', 'errored'],
+      "enqueued" => ["running", "pausing", "cancelling", "errored"],
       # pausing -> paused occurs when the task actually halts performing and
       #   occupies a status of paused.
       # pausing -> cancelling occurs when the user cancels a task immediately
@@ -24,14 +24,14 @@ module MaintenanceTasks
       #   nothing in its collection to process.
       # pausing -> errored occurs when the job raises an exception after the
       #   user has paused it.
-      'pausing' => ['paused', 'cancelling', 'succeeded', 'errored'],
+      "pausing" => ["paused", "cancelling", "succeeded", "errored"],
       # cancelling -> cancelled occurs when the task actually halts performing
       #   and occupies a status of cancelled.
       # cancelling -> succeeded occurs when the task completes immediately after
       #   being cancelled. See description for pausing -> succeeded.
       # cancelling -> errored occurs when the job raises an exception after the
       #   user has cancelled it.
-      'cancelling' => ['cancelled', 'succeeded', 'errored'],
+      "cancelling" => ["cancelled", "succeeded", "errored"],
       # running -> succeeded occurs when the task completes successfully.
       # running -> pausing occurs when a user pauses the task as
       #   it's performing.
@@ -40,17 +40,17 @@ module MaintenanceTasks
       # running -> interrupted occurs when the job infra shuts down the task as
       #   it's performing.
       # running -> errored occurs when the job raises an exception when running.
-      'running' => [
-        'succeeded',
-        'pausing',
-        'cancelling',
-        'interrupted',
-        'errored',
+      "running" => [
+        "succeeded",
+        "pausing",
+        "cancelling",
+        "interrupted",
+        "errored",
       ],
       # paused -> enqueued occurs when the task is resumed after being paused.
       # paused -> cancelling when the user cancels the task after it is paused.
       # paused -> cancelled when the user cancels the task after it is paused.
-      'paused' => ['enqueued', 'cancelling', 'cancelled'],
+      "paused" => ["enqueued", "cancelling", "cancelled"],
       # interrupted -> running occurs when the task is resumed after being
       #   interrupted by the job infrastructure.
       # interrupted -> pausing occurs when the task is paused by the user while
@@ -59,7 +59,7 @@ module MaintenanceTasks
       #   while it is interrupted.
       # interrupted -> errored occurs when the task is deleted while it is
       #   interrupted.
-      'interrupted' => ['running', 'pausing', 'cancelling', 'errored'],
+      "interrupted" => ["running", "pausing", "cancelling", "errored"],
     }
 
     # Validate whether a transition from one Run status

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/maintenance_tasks.rb

@@ -1,17 +1,15 @@
 # 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'
+require "job-iteration"
+require "maintenance_tasks/engine"
 
 # 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_relative "../app/jobs/maintenance_tasks/task_job"
 
 # The engine's namespace module. It provides isolation between the host
 # application's code and the engine-specific code. Top-level engine constants
@@ -19,13 +17,13 @@ require_relative '../app/jobs/maintenance_tasks/task_job'
 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'
+  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.
   #
   # @param [String] the name of the job class.
-  mattr_accessor :job, default: 'MaintenanceTasks::TaskJob'
+  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
@@ -36,6 +34,12 @@ module MaintenanceTasks
   #   the ticker during Task iterations.
   mattr_accessor :ticker_delay, default: 1.second
 
+  # Specifies which Active Storage service to use for uploading CSV file blobs.
+  #
+  # @param [Symbol] the key for the storage service, as specified in the app's
+  #   config/storage.yml.
+  mattr_accessor :active_storage_service
+
   # Retrieves the callback to be performed when an error occurs in the task.
   def self.error_handler
     return @error_handler if defined?(@error_handler)
@@ -46,8 +50,8 @@ module MaintenanceTasks
   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)

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,7 +7,7 @@ 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
 
@@ -25,7 +25,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.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-03-29 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
@@ -114,6 +100,7 @@ files:
 - 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
@@ -151,10 +138,10 @@ files:
 homepage: https://github.com/Shopify/maintenance_tasks
 licenses: []
 metadata:
-  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.1.2
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.2.0
   allowed_push_host: https://rubygems.org
 post_install_message: |-
-  Thank you for installing Maintenance Tasks 1.1.2. To complete, please run:
+  Thank you for installing Maintenance Tasks 1.2.0. To complete, please run:
 
   rails generate maintenance_tasks:install
 rdoc_options: []