maintenance_tasks 1.0.0

data/lib/maintenance_tasks/cli.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module MaintenanceTasks
+  # Defines the command line interface commands exposed by Maintenance Tasks in
+  # the executable file.
+  class CLI < Thor
+    class << self
+      # Return a failed exit status in case of an error.
+      def exit_on_failure?
+        true
+      end
+    end
+
+    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
+
+    # Command to run a Task.
+    #
+    # It instantiates a Runner and sends a run message with the given Task name.
+    #
+    # @param name [String] the name of the Task to be run.
+    def perform(name)
+      task = Runner.new.run(name: name)
+      say_status(:success, "#{task.name} was enqueued.", :green)
+    rescue => error
+      say_status(:error, error.message, :red)
+    end
+  end
+  private_constant :CLI
+end

data/lib/maintenance_tasks/engine.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require 'active_record/railtie'
+
+module MaintenanceTasks
+  # The engine's main class, which defines its namespace. The engine is mounted
+  # by the host application.
+  class Engine < ::Rails::Engine
+    isolate_namespace MaintenanceTasks
+
+    config.to_prepare do
+      unless Rails.autoloaders.zeitwerk_enabled?
+        tasks_module = MaintenanceTasks.tasks_module.underscore
+        Dir["#{Rails.root}/app/tasks/#{tasks_module}/*.rb"].each do |file|
+          require_dependency(file)
+        end
+      end
+    end
+
+    config.after_initialize do
+      eager_load! unless Rails.autoloaders.zeitwerk_enabled?
+      JobIteration.max_job_runtime ||= 5.minutes
+    end
+
+    config.action_dispatch.rescue_responses.merge!(
+      'MaintenanceTasks::Task::NotFoundError' => :not_found,
+    )
+  end
+end

data/lib/maintenance_tasks/integrations/bugsnag_handler.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+require 'bugsnag'
+
+MaintenanceTasks.error_handler = ->(error) { Bugsnag.notify(error) }

data/lib/tasks/maintenance_tasks_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :maintenance_tasks do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: maintenance_tasks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Shopify Engineering
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: job-iteration
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: 
+email: gems@shopify.com
+executables:
+- maintenance_tasks
+extensions: []
+extra_rdoc_files: []
+files:
+- 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/task_helper.rb
+- app/jobs/maintenance_tasks/task_job.rb
+- app/models/maintenance_tasks/application_record.rb
+- app/models/maintenance_tasks/progress.rb
+- app/models/maintenance_tasks/run.rb
+- app/models/maintenance_tasks/runner.rb
+- app/models/maintenance_tasks/task_data.rb
+- app/models/maintenance_tasks/ticker.rb
+- app/tasks/maintenance_tasks/task.rb
+- app/validators/maintenance_tasks/run_status_validator.rb
+- app/views/layouts/maintenance_tasks/_navbar.html.erb
+- app/views/layouts/maintenance_tasks/application.html.erb
+- app/views/maintenance_tasks/runs/_info.html.erb
+- app/views/maintenance_tasks/runs/_run.html.erb
+- app/views/maintenance_tasks/runs/index.html.erb
+- app/views/maintenance_tasks/runs/info/_cancelled.html.erb
+- app/views/maintenance_tasks/runs/info/_cancelling.html.erb
+- app/views/maintenance_tasks/runs/info/_enqueued.html.erb
+- app/views/maintenance_tasks/runs/info/_errored.html.erb
+- app/views/maintenance_tasks/runs/info/_interrupted.html.erb
+- app/views/maintenance_tasks/runs/info/_paused.html.erb
+- app/views/maintenance_tasks/runs/info/_pausing.html.erb
+- app/views/maintenance_tasks/runs/info/_running.html.erb
+- app/views/maintenance_tasks/runs/info/_succeeded.html.erb
+- app/views/maintenance_tasks/tasks/_task.html.erb
+- app/views/maintenance_tasks/tasks/actions/_cancelled.html.erb
+- app/views/maintenance_tasks/tasks/actions/_cancelling.html.erb
+- app/views/maintenance_tasks/tasks/actions/_enqueued.html.erb
+- app/views/maintenance_tasks/tasks/actions/_errored.html.erb
+- app/views/maintenance_tasks/tasks/actions/_interrupted.html.erb
+- app/views/maintenance_tasks/tasks/actions/_new.html.erb
+- app/views/maintenance_tasks/tasks/actions/_paused.html.erb
+- app/views/maintenance_tasks/tasks/actions/_pausing.html.erb
+- app/views/maintenance_tasks/tasks/actions/_running.html.erb
+- app/views/maintenance_tasks/tasks/actions/_succeeded.html.erb
+- app/views/maintenance_tasks/tasks/index.html.erb
+- app/views/maintenance_tasks/tasks/show.html.erb
+- config/routes.rb
+- db/migrate/20201211151756_create_maintenance_tasks_runs.rb
+- exe/maintenance_tasks
+- lib/generators/maintenance_tasks/install_generator.rb
+- lib/generators/maintenance_tasks/task_generator.rb
+- lib/generators/maintenance_tasks/templates/task.rb.tt
+- lib/generators/maintenance_tasks/templates/task_spec.rb.tt
+- lib/generators/maintenance_tasks/templates/task_test.rb.tt
+- lib/maintenance_tasks.rb
+- lib/maintenance_tasks/cli.rb
+- lib/maintenance_tasks/engine.rb
+- lib/maintenance_tasks/integrations/bugsnag_handler.rb
+- lib/tasks/maintenance_tasks_tasks.rake
+homepage: https://github.com/Shopify/maintenance_tasks
+licenses: []
+metadata:
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.0.0
+  allowed_push_host: https://rubygems.org
+post_install_message: |-
+  Thank you for installing Maintenance Tasks 1.0.0. To complete, please run:
+
+  rails generate maintenance_tasks:install
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A Rails engine for queuing and managing maintenance tasks
+test_files: []