maintenance_tasks 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c673afea63371c8c8f69ccda520b66fb1391d17ff6f241eb5610e45c60493561
-  data.tar.gz: a1b914d6fdf7391bda0691444f8af2e263c71313c295bf2fd38e6e655f661a99
+  metadata.gz: 45bd2df064845d494e9bfd74589131d6b77caf345b3d5f4c852403dfa05fd5ac
+  data.tar.gz: a48816bc76477c58717f273a1318249dd638daf5b186c8b196df57d41b2e50ec
 SHA512:
-  metadata.gz: d161e823b16c12abd127d725cccf985d0bca50253cb40937d265685d6078730beff127913eea7973ff23211576d5d143508ac61968ebb2460f1c12fc89ff5d82
-  data.tar.gz: 46de8ac9e6819829de191a0fcfaf40c48b2922f1cc3024df58a41a7e6763658149f3f32baa168045bae6c00790da1b789647d36bad880714bdf63e75d67aeb32
+  metadata.gz: d96b17402de319cef50393e133100317cbb480180e6c1041e998e24fa1ccd224a4f252832b60c068f489217c4c1ea60121e15e015559746bf6dfc967bceb4d12
+  data.tar.gz: 5fe898977ebda4b13829df10917466ab4c7474cf705600f5574b561073b9191cf3b200b36bc32d34f9477be51b80b70335e2ed759b241de62771500ff7e74ed5

data/LICENSE.md

@@ -0,0 +1,18 @@
+Copyright 2020-present, Shopify Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -2,35 +2,6 @@
 
 A Rails engine for queuing and managing maintenance tasks.
 
-## Table of Contents
-
-* [Demo](#demo)
-* [Installation](#installation)
-  * [Active Job Dependency](#active-job-dependency)
-* [Usage](#usage)
-  * [Creating a Task](#creating-a-task)
-  * [Creating a CSV Task](#creating-a-csv-task)
-  * [Considerations when writing Tasks](#considerations-when-writing-tasks)
-  * [Writing tests for a Task](#writing-tests-for-a-task)
-  * [Writing tests for a CSV Task](#writing-tests-for-a-csv-task)
-  * [Running a Task](#running-a-task)
-  * [Monitoring your Task's status](#monitoring-your-tasks-status)
-  * [How Maintenance Tasks runs a Task](#how-maintenance-tasks-runs-a-task)
-    * [Help! My Task is stuck](#help-my-task-is-stuck)
-  * [Configuring the gem](#configuring-the-gem)
-    * [Customizing the error handler](#customizing-the-error-handler)
-    * [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)
-
-## Demo
-
-Watch this demo video to see the gem in action:
-
 [![Link to demo video](static/demo.png)](https://www.youtube.com/watch?v=BTuvTQxlFzs)
 
 ## Installation
@@ -453,6 +424,12 @@ pull requests. You can find the contribution guidelines on
 
 [contributing]: https://github.com/Shopify/maintenance_tasks/blob/main/.github/CONTRIBUTING.md
 
+### Dependabot updates
+
+Whenever Dependabot creates a PR for a gem bump, check out the branch locally
+and run `bin/update-gemfile <gem>` to ensure all the gemfiles have the gem
+updated consistently.
+
 ## Releasing new versions
 
 Updates should be added to the latest draft release on GitHub as Pull Requests
@@ -461,14 +438,14 @@ 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.
+* Run `bin/gemfile-update install` to bump the version in all the lockfiles.
 * Open a PR and merge on approval.
 * 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.
+* 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/app/models/maintenance_tasks/run.rb

@@ -43,6 +43,7 @@ module MaintenanceTasks
 
     # Ensure ActiveStorage is in use before preloading the attachments
     scope :with_attached_csv, -> do
+      return unless defined?(ActiveStorage)
       with_attached_csv_file if ActiveStorage::Attachment.table_exists?
     end
 
@@ -51,7 +52,7 @@ module MaintenanceTasks
     if MaintenanceTasks.active_storage_service.present?
       has_one_attached :csv_file,
         service: MaintenanceTasks.active_storage_service
-    else
+    elsif respond_to?(:has_one_attached)
       has_one_attached :csv_file
     end
 
@@ -211,6 +212,7 @@ module MaintenanceTasks
     #
     # @return [ActiveStorage::Attached::One] the attached CSV file
     def csv_file
+      return unless defined?(ActiveStorage)
       return unless ActiveStorage::Attachment.table_exists?
       super
     end

data/app/tasks/maintenance_tasks/task.rb

@@ -38,6 +38,10 @@ module MaintenanceTasks
       # An input to upload a CSV will be added in the form to start a Run. The
       # collection and count method are implemented.
       def csv_collection
+        if !defined?(ActiveStorage) || !ActiveStorage::Attachment.table_exists?
+          raise NotImplementedError, "Active Storage needs to be installed\n"\
+            "To resolve this issue run: bin/rails active_storage:install"
+        end
         include(CsvCollection)
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -87,8 +87,8 @@ 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
@@ -136,12 +136,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.2.1
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.2.2
   allowed_push_host: https://rubygems.org
 post_install_message: |-
-  Thank you for installing Maintenance Tasks 1.2.1. To complete, please run:
+  Thank you for installing Maintenance Tasks 1.2.2. To complete, please run:
 
   rails generate maintenance_tasks:install
 rdoc_options: []

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:test:prepare", "test", "test:system", "rubocop"])