maintenance_tasks 1.0.0 → 1.2.1

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|
@@ -73,7 +73,7 @@ module MaintenanceTasks
     def code
       return if deleted?
       task = Task.named(name)
-      file = task.instance_method(:collection).source_location.first
+      file = task.instance_method(:process).source_location.first
       File.read(file)
     end
 
@@ -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.
@@ -127,11 +127,15 @@ module MaintenanceTasks
       end
     end
 
+    # @return [Boolean] whether the Task inherits from CsvTask.
+    def csv_task?
+      !deleted? && Task.named(name) < CsvCollection
+    end
+
     private
 
     def runs
-      Run.where(task_name: name).order(created_at: :desc)
+      Run.where(task_name: name).with_attached_csv.order(created_at: :desc)
     end
   end
-  private_constant :TaskData
 end

data/app/models/maintenance_tasks/ticker.rb

@@ -54,5 +54,4 @@ module MaintenanceTasks
       Time.now - @last_persisted >= @throttle_duration
     end
   end
-  private_constant :Ticker
 end

data/app/tasks/maintenance_tasks/task.rb

@@ -16,9 +16,12 @@ module MaintenanceTasks
       #
       # @raise [NotFoundError] if a Task with the given name does not exist.
       def named(name)
-        name.constantize
-      rescue NameError
-        raise NotFoundError.new("Task #{name} not found.", name)
+        task = name.safe_constantize
+        raise NotFoundError.new("Task #{name} not found.", name) unless task
+        unless task.is_a?(Class) && task < Task
+          raise NotFoundError.new("#{name} is not a Task.", name)
+        end
+        task
       end
 
       # Returns a list of concrete classes that inherit from the Task
@@ -30,6 +33,41 @@ module MaintenanceTasks
         descendants
       end
 
+      # Make this Task a task that handles CSV.
+      #
+      # 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
+        include(CsvCollection)
+      end
+
+      # Processes one item.
+      #
+      # Especially useful for tests.
+      #
+      # @param item the item to process.
+      def process(item)
+        new.process(item)
+      end
+
+      # Returns the collection for this Task.
+      #
+      # Especially useful for tests.
+      #
+      # @return the collection.
+      def collection
+        new.collection
+      end
+
+      # Returns the count of items for this Task.
+      #
+      # Especially useful for tests.
+      #
+      # @return the count of items.
+      def count
+        new.count
+      end
+
       private
 
       def load_constants
@@ -45,8 +83,7 @@ module MaintenanceTasks
     # @raise [NotImplementedError] with a message advising subclasses to
     #   implement an override for this method.
     def collection
-      raise NotImplementedError,
-        "#{self.class.name} must implement `collection`."
+      raise NoMethodError, "#{self.class.name} must implement `collection`."
     end
 
     # Placeholder method to raise in case a subclass fails to implement the
@@ -57,8 +94,7 @@ module MaintenanceTasks
     # @raise [NotImplementedError] with a message advising subclasses to
     #   implement an override for this method.
     def process(_item)
-      raise NotImplementedError,
-        "#{self.class.name} must implement `process`."
+      raise NoMethodError, "#{self.class.name} must implement `process`."
     end
 
     # Total count of iterations to be performed.
@@ -70,14 +106,5 @@ module MaintenanceTasks
     # @return [Integer, nil]
     def count
     end
-
-    # Convenience method to allow tasks define enumerators with cursors for
-    # compatibility with Job Iteration.
-    #
-    # @return [JobIteration::EnumeratorBuilder] instance of an enumerator
-    #   builder available to tasks.
-    def enumerator_builder
-      JobIteration.enumerator_builder.new(nil)
-    end
   end
 end

data/app/validators/maintenance_tasks/run_status_validator.rb

@@ -11,8 +11,9 @@ module MaintenanceTasks
       # enqueued -> pausing occurs when the task is paused before starting.
       # enqueued -> cancelling occurs when the task is cancelled
       #   before starting.
-      # enqueued -> errored occurs when the task job fails to be enqueued.
-      'enqueued' => ['running', 'pausing', 'cancelling', 'errored'],
+      # 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"],
       # 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
@@ -23,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.
@@ -39,24 +40,26 @@ 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
       #   it is interrupted.
       # interrupted -> cancelling occurs when the task is cancelled by the user
       #   while it is interrupted.
-      'interrupted' => ['running', 'pausing', 'cancelling'],
+      # interrupted -> errored occurs when the task is deleted while it is
+      #   interrupted.
+      "interrupted" => ["running", "pausing", "cancelling", "errored"],
     }
 
     # Validate whether a transition from one Run status
@@ -82,5 +85,4 @@ module MaintenanceTasks
       )
     end
   end
-  private_constant :RunStatusValidator
 end

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

@@ -2,10 +2,4 @@
   <div class="navbar-brand">
     <%= link_to 'Maintenance Tasks', root_path, class: 'navbar-item is-size-4 has-text-weight-semibold has-text-danger' %>
   </div>
-
-  <div id="navbarMenu" class="navbar-menu is-active">
-    <div class="navbar-start">
-      <%= link_to "Runs", runs_path, class: 'navbar-item' %>
-    </div>
-  </div>
 </nav>

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

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

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

@@ -1,11 +1,3 @@
 <div class="box">
-  <% if with_task_name %>
-    <h3 class="title is-3">
-      <%= link_to run.task_name, task_path(run.task_name) %>
-      <%= status_tag run.status %>
-    </h3>
-    <%= render 'maintenance_tasks/runs/info', run: run, with_status: false %>
-  <% else %>
-    <%= render 'maintenance_tasks/runs/info', run: run, with_status: true %>
-  <% end %>
+  <%= render 'maintenance_tasks/runs/info', run: run, with_status: true %>
 </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

@@ -7,19 +7,46 @@
 <%= render 'maintenance_tasks/runs/info', run: @task.last_run, with_status: false if @task.last_run %>
 
 <div class="buttons">
-  <%= render "maintenance_tasks/tasks/actions/#{@task.status}", task: @task %>
+  <% last_run = @task.last_run %>
+  <% if last_run.nil? || last_run.completed? %>
+    <%= form_with url: run_task_path(@task), method: :put do |form| %>
+      <% if @task.csv_task? %>
+        <div class="block">
+          <%= form.label :csv_file %>
+          <%= form.file_field :csv_file %>
+        </div>
+      <% end %>
+      <div class="block">
+        <%= form.submit 'Run', class: "button is-success", disabled: @task.deleted? %>
+      </div>
+    <% end %>
+  <% elsif last_run.cancelling? %>
+    <%= button_to 'Run', run_task_path(@task), method: :put, class: 'button is-success', disabled: true %>
+    <% if last_run.stuck? %>
+      <%= button_to 'Cancel', cancel_task_run_path(@task, last_run), method: :put, class: 'button is-danger', disabled: @task.deleted? %>
+    <% end %>
+  <% elsif last_run.pausing? %>
+    <%= button_to 'Pausing', pause_task_run_path(@task, last_run), method: :put, class: 'button is-warning', disabled: true %>
+    <%= button_to 'Cancel', cancel_task_run_path(@task, last_run), method: :put, class: 'button is-danger' %>
+  <% elsif last_run.paused? %>
+    <%= button_to 'Resume', run_task_path(@task), method: :put, class: 'button is-primary', disabled: @task.deleted? %>
+    <%= button_to 'Cancel', cancel_task_run_path(@task, last_run), method: :put, class: 'button is-danger' %>
+  <% else %>
+    <%= button_to 'Pause', pause_task_run_path(@task, last_run), method: :put, class: 'button is-warning', disabled: @task.deleted? %>
+    <%= button_to 'Cancel', cancel_task_run_path(@task, last_run), method: :put, class: 'button is-danger' %>
+  <% end%>
 </div>
 
 <% if (code = @task.code) %>
   <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, with_task_name: false %>
+  <%= 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

@@ -1,19 +1,17 @@
 # frozen_string_literal: true
 MaintenanceTasks::Engine.routes.draw do
-  resources :runs, only: [:index], format: false
-
   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

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

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,18 +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
-  private_constant :InstallGenerator
 end

data/lib/generators/maintenance_tasks/task_generator.rb

@@ -5,11 +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."
 
-    check_class_collision suffix: 'Task'
+    class_option :csv, type: :boolean, default: false,
+      desc: "Generate a CSV Task."
+
+    check_class_collision suffix: "Task"
 
     # Creates the Task file.
     def create_task_file
@@ -18,7 +21,11 @@ module MaintenanceTasks
         class_path,
         "#{file_name}_task.rb"
       )
-      template('task.rb', template_file)
+      if options[:csv]
+        template("csv_task.rb", template_file)
+      else
+        template("task.rb", template_file)
+      end
     end
 
     # Creates the Task test file, according to the app's test framework.
@@ -42,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
@@ -51,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
@@ -70,5 +77,4 @@ module MaintenanceTasks
       Rails.application.config.generators.options[:rails][:test_framework]
     end
   end
-  private_constant :TaskGenerator
 end