maintenance_tasks 1.9.0 → 1.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a050fbc2d9dbc3eab88b027ee68163f09cae1472df9e236a7151f5fa1f4464b
-  data.tar.gz: c6cf0f55b868b7810c7361669d4383d0fd159dc337b270396e3123a795e75d24
+  metadata.gz: 8035a01cd9e715fec1b276b2f1c609266daeca88fa13d49ee1e2993370103f87
+  data.tar.gz: b6ec7e053b256aa725cd3c23f932fe35b480b2398667cdc2ba9e72b3059ca614
 SHA512:
-  metadata.gz: 903da6a69576ffcf022a09248fd7945ec816150505d36c65d96f70cfeec969cb3315e820317c5bff8c882d4e0c09ad33758f9221b2d4d2cf08292a0415219c3a
-  data.tar.gz: 811d79fa5d58252649faea6ed0bc82b6f8fa471d77ae02535cf73fb873a9e663deb893fc81d2528863f68194123db7f7dc55c1a9dc299143da9586fccb4570a6
+  metadata.gz: 49aa01470360b4cde07fe1ce1d6a47158924fe0acca500ca21237374244c23a63560f4ea3fa03ec3f0dfae1ae8bb211817999b79c3057f1486f1c46ac75faab6
+  data.tar.gz: 85ac09e52d9396e83254fd1f0451e6627542a7fed4238397960b14b4c14112f71dc7f51600a8f650331bc9f74192e98e962537bb472021903e5a7fd93dfcec02

data/README.md

@@ -8,9 +8,9 @@ A Rails engine for queuing and managing maintenance tasks.
 
 To install the gem and run the install generator, execute:
 
-```bash
-$ bundle add maintenance_tasks
-$ bin/rails generate maintenance_tasks:install
+```sh-session
+bundle add maintenance_tasks
+bin/rails generate maintenance_tasks:install
 ```
 
 The generator creates and runs a migration to add the necessary table to your
@@ -39,8 +39,8 @@ take a look at the [Active Job documentation][active-job-docs].
 
 A generator is provided to create tasks. Generate a new task by running:
 
-```bash
-$ bin/rails generate maintenance_tasks:task update_posts
+```sh-session
+bin/rails generate maintenance_tasks:task update_posts
 ```
 
 This creates the task file `app/tasks/maintenance/update_posts_task.rb`.
@@ -86,8 +86,8 @@ instuctions][setup].
 
 Generate a CSV Task by running:
 
-```bash
-$ bin/rails generate maintenance_tasks:task import_posts --csv
+```sh-session
+bin/rails generate maintenance_tasks:task import_posts --csv
 ```
 
 The generated task is a subclass of `MaintenanceTasks::Task` that implements:
@@ -195,8 +195,8 @@ collection-less tasks.
 
 Generate a collection-less Task by running:
 
-```bash
-$ bin/rails generate maintenance_tasks:task no_collection_task --no-collection
+```sh-session
+bin/rails generate maintenance_tasks:task no_collection_task --no-collection
 ```
 
 The generated task is a subclass of `MaintenanceTasks::Task` that implements:
@@ -483,21 +483,21 @@ You can run your new Task by accessing the Web UI and clicking on "Run".
 
 Alternatively, you can run your Task in the command line:
 
-```bash
-$ bundle exec maintenance_tasks perform Maintenance::UpdatePostsTask
+```sh-session
+bundle exec maintenance_tasks perform Maintenance::UpdatePostsTask
 ```
 
 To run a Task that processes CSVs from the command line, use the --csv option:
 
-```bash
-$ bundle exec maintenance_tasks perform Maintenance::ImportPostsTask --csv "path/to/my_csv.csv"
+```sh-session
+bundle exec maintenance_tasks perform Maintenance::ImportPostsTask --csv "path/to/my_csv.csv"
 ```
 
 To run a Task that takes arguments from the command line, use the --arguments
 option, passing arguments as a set of \<key>:\<value> pairs:
 
-```bash
-$ bundle exec maintenance_tasks perform Maintenance::ParamsTask \
+```sh-session
+bundle exec maintenance_tasks perform Maintenance::ParamsTask \
   --arguments post_ids:1,2,3 content:"Hello, World!"
 ```
 
@@ -745,8 +745,8 @@ clean backtraces.
 Use bundler to check for and upgrade to newer versions. After installing a new
 version, re-run the install command:
 
-```bash
-$ bin/rails generate maintenance_tasks:install
+```sh-session
+bin/rails generate maintenance_tasks:install
 ```
 
 This ensures that new migrations are installed and run as well.

data/app/controllers/maintenance_tasks/application_controller.rb

@@ -8,7 +8,15 @@ module MaintenanceTasks
     BULMA_CDN = "https://cdn.jsdelivr.net"
 
     content_security_policy do |policy|
-      policy.style_src(BULMA_CDN)
+      policy.style_src(
+        BULMA_CDN,
+        # ruby syntax highlighting
+        "'sha256-y9V0na/WU44EUNI/HDP7kZ7mfEci4PAOIjYOOan6JMA='",
+      )
+      policy.script_src(
+        # page refresh script
+        "'sha256-2RPaBS4XCMLp0JJ/sW407W9l4qjC+WQAHmTOFJTGfqo='",
+      )
       policy.frame_ancestors(:self)
     end
 

data/app/controllers/maintenance_tasks/tasks_controller.rb

@@ -44,7 +44,7 @@ module MaintenanceTasks
     private
 
     def set_refresh
-      @refresh = 3
+      @refresh = true
     end
   end
 end

data/app/models/maintenance_tasks/batch_csv_collection_builder.rb

@@ -33,7 +33,8 @@ module MaintenanceTasks
     #
     # @return [Integer] the approximate number of batches to process.
     def count(task)
-      (task.csv_content.count("\n") + @batch_size - 1) / @batch_size
+      count = task.csv_content.count("\n") - 1
+      (count + @batch_size - 1) / @batch_size
     end
   end
 end

data/app/views/layouts/maintenance_tasks/application.html.erb

@@ -15,13 +15,13 @@
     <%= csrf_meta_tags %>
 
     <%=
-      stylesheet_link_tag URI.join(controller.class::BULMA_CDN, 'npm/bulma@0.9.1/css/bulma.css'),
+      stylesheet_link_tag(URI.join(controller.class::BULMA_CDN, 'npm/bulma@0.9.3/css/bulma.css'),
         media: :all,
-        integrity: 'sha256-67AR2JVjhMZCLVxapLuBSMap5RrXbksv4vlllenHBSE=',
-        crossorigin: 'anonymous'
+        integrity: 'sha384-Zkr9rpl37lclZu6AwYQZZm0CxiMqLZFiibodW+UXLnAWPBr6qgIzPpcmHkpwnyWD',
+        crossorigin: 'anonymous') unless request.xhr?
     %>
 
-    <style nonce="<%= content_security_policy_nonce %>">
+    <style>
       .ruby-comment { color: #6a737d;}
       .ruby-const { color: #e36209; }
       .ruby-embexpr-beg, .ruby-embexpr-end, .ruby-period { color: #24292e; }
@@ -31,12 +31,30 @@
       .ruby-label, .ruby-tstring-beg, .ruby-tstring-content, .ruby-tstring-end { color: #032f62; }
     </style>
 
-    <% if defined?(@refresh) %>
-      <meta http-equiv="refresh" content="<%= @refresh %>">
-    <% end %>
+    <script>
+      function refresh() {
+        if (!("refresh" in document.body.dataset)) return
+        window.setTimeout(() => {
+          document.body.style.cursor = "wait"
+          fetch(document.location, { headers: { "X-Requested-With": "XMLHttpRequest" } }).then(
+            async response => {
+              const text = await response.text()
+              const newDocument = new DOMParser().parseFromString(text, "text/html")
+              document.body.replaceWith(newDocument.body)
+              <%# force a redraw for Safari %>
+              window.scrollTo({ top: document.documentElement.scrollTop + 1 })
+              window.scrollTo({ top: document.documentElement.scrollTop - 1 })
+              refresh()
+            },
+            error => location.reload()
+          )
+        }, 3000)
+      }
+      document.addEventListener('DOMContentLoaded', refresh)
+    </script>
   </head>
 
-  <body>
+  <%= tag.body(data: { refresh: defined?(@refresh) && @refresh }) do %>
     <%= render 'layouts/maintenance_tasks/navbar' %>
 
     <section class="section">
@@ -50,5 +68,5 @@
         <%= yield %>
       </div>
     </div>
-  </body>
+  <% end %>
 </html>

data/db/migrate/20220706101937_change_runs_tick_columns_to_bigints.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class ChangeRunsTickColumnsToBigints < ActiveRecord::Migration[6.0]
+  def up
+    change_table(:maintenance_tasks_runs, bulk: true) do |t|
+      t.change(:tick_count, :bigint)
+      t.change(:tick_total, :bigint)
+    end
+  end
+
+  def down
+    change_table(:maintenance_tasks_runs, bulk: true) do |t|
+      t.change(:tick_count, :integer)
+      t.change(:tick_total, :integer)
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'test_helper'
+require "test_helper"
 
 module <%= tasks_module %>
 <% module_namespacing do -%>

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

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

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'test_helper'
+require "test_helper"
 
 module <%= tasks_module %>
 <% module_namespacing do -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maintenance_tasks
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.2
 platform: ruby
 authors:
 - Shopify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-05 00:00:00.000000000 Z
+date: 2022-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -133,6 +133,7 @@ files:
 - db/migrate/20210225152418_remove_index_on_task_name.rb
 - db/migrate/20210517131953_add_arguments_to_maintenance_tasks_runs.rb
 - db/migrate/20211210152329_add_lock_version_to_maintenance_tasks_runs.rb
+- db/migrate/20220706101937_change_runs_tick_columns_to_bigints.rb
 - exe/maintenance_tasks
 - lib/generators/maintenance_tasks/install_generator.rb
 - lib/generators/maintenance_tasks/task_generator.rb
@@ -151,7 +152,7 @@ homepage: https://github.com/Shopify/maintenance_tasks
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.9.0
+  source_code_uri: https://github.com/Shopify/maintenance_tasks/tree/v1.10.2
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
@@ -168,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: A Rails engine for queuing and managing maintenance tasks