wallflower 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 777814642256dec3caef9316ece5411d3ae340dd7073f3b56258b2a79804603c
-  data.tar.gz: 19545678d642b13d461f26408fc8f8844d3dd79fccaddf10c2b394e892561cef
+  metadata.gz: 5e7e00290ad10fba0bfe3584638d18335a880f10613804803b84fc1bb3f5f7e9
+  data.tar.gz: 032ccc7ddcbacfbae89c35533de1be75765ce9b02750816cd6a6f5497d99fafa
 SHA512:
-  metadata.gz: 1fbef5b2d7cf042c5c4c6063726696520396fc4fba134ae5dfda7ce4456b5d25c904e26fe1efd1a718f7a555c58e36a163f77cc41008acaa21ec78108ee63778
-  data.tar.gz: 345abf578eb99a1043797466ad1c5c81d29f91086bd4ec1497c24d20bdb95b2551cfff6925409ea7ebe7afb1b09360b23fd4e57bb4d1a0691b4ebfbe1888b60b
+  metadata.gz: eb831b13ef2dc9a434c657c187695222e0bf9f7b49857583beffaee7ff6a4e665c3fb54f1fd00e89a1a14d80bacd24c3237978b2f66f3814ccbd0890b31919d7
+  data.tar.gz: 4abf66b6611750f47ffd3db7852acada04fc7687ef3dbcca85fbce2b937966fced569059d024c062430d107be2e8a6d6e15c9987d90b7f0270012b79428c8c17

data/README.md

@@ -132,11 +132,11 @@ With `keep_for` set, the same sweep deletes each finished or failed task that en
 
 ## The task list
 
-The engine's root lists the tasks the signed-in person started in the current account, newest first. Each row shows the kind's title, the status as a coloured badge, the progress and when it was started, links to the task's page, and updates while the task runs.
+The engine's root lists the tasks the signed-in person started in the current account, newest first. Each row shows the kind's title, the status as a coloured badge, the progress, the time left while it runs and when it was started, links to the task's page, and updates while the task runs.
 
 ## The task page
 
-A task's page lives at `tasks/:id` under the engine's mount path. The person who started the task sees its kind's title, its status and, once the runner has set a total, a progress bar of done against total. The page listens for changes to its task over Turbo Streams, so its status and progress update without a reload, in a browser and in the Hotwire Native iOS app alike. Anyone else, and the same person viewing from another account, gets a not-found response.
+A task's page lives at `tasks/:id` under the engine's mount path. The person who started the task sees its kind's title, its status and, once the runner has set a total, a progress bar of done against total. While the task runs and is at least five percent done, an estimate of the time left sits under the bar, worked out from how fast the task has gone since it started running. The page listens for changes to its task over Turbo Streams, so its status, progress and time left update without a reload, in a browser and in the Hotwire Native iOS app alike. Anyone else, and the same person viewing from another account, gets a not-found response.
 
 The task page and the task list reload in place when they are shown again after being hidden, such as when the iOS app returns from the background, so they show changes broadcast while they could not receive them. A page that stays visible makes no extra request. The copied controller is registered by the host's own Stimulus setup, as `wallflower--catch-up`.
 

data/app/jobs/wallflower/run_job.rb

@@ -10,7 +10,7 @@ module Wallflower
     private
 
     def run(task)
-      task.update!(status: "running")
+      task.update!(status: "running", started_at: Time.current)
       Wallflower.kind(task.kind).runner.constantize.new.call(task)
       task.update!(status: "finished", finished_at: Time.current)
     rescue StandardError => error

data/app/models/wallflower/task.rb

@@ -44,6 +44,15 @@ module Wallflower
       update!(total: total)
     end
 
+    ESTIMATE_AFTER_SHARE = 0.05
+
+    def seconds_left
+      return unless estimable?
+
+      seconds_per_row = (Time.current - started_at) / done
+      ((total - done) * seconds_per_row).round
+    end
+
     PROGRESS_SAVE_INTERVAL = 1.second
 
     def advance(by = 1)
@@ -53,5 +62,11 @@ module Wallflower
       save!
       @progress_saved_at = Time.current
     end
+
+    private
+
+    def estimable?
+      status == "running" && started_at && total && done.positive? && done >= total * ESTIMATE_AFTER_SHARE
+    end
   end
 end

data/app/views/wallflower/tasks/_live.html.erb

@@ -8,4 +8,7 @@
       <%= render Keystone::Ui::ProgressComponent.new(value: task.done, max: task.total, label: "#{task.done} of #{task.total}") %>
     <% end %>
   </div>
+  <% if task.seconds_left %>
+    <p id="<%= dom_id(task, :time_left) %>"><%= "#{distance_of_time_in_words(task.seconds_left)} left" %></p>
+  <% end %>
 </div>

data/lib/generators/wallflower/install/install_generator.rb

@@ -17,6 +17,7 @@ module Wallflower
         migration_template "create_wallflower_refusals.rb.erb", "db/migrate/create_wallflower_refusals.rb"
         migration_template "add_result_url_to_wallflower_tasks.rb.erb", "db/migrate/add_result_url_to_wallflower_tasks.rb"
         migration_template "add_error_message_to_wallflower_tasks.rb.erb", "db/migrate/add_error_message_to_wallflower_tasks.rb"
+        migration_template "add_started_at_to_wallflower_tasks.rb.erb", "db/migrate/add_started_at_to_wallflower_tasks.rb"
       end
 
       def copy_catch_up_controller

data/lib/generators/wallflower/install/templates/add_started_at_to_wallflower_tasks.rb.erb

@@ -0,0 +1,5 @@
+class AddStartedAtToWallflowerTasks < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    add_column :wallflower_tasks, :started_at, :datetime
+  end
+end

data/lib/generators/wallflower/update/update_generator.rb

@@ -24,6 +24,10 @@ module Wallflower
         migration_template "add_error_message_to_wallflower_tasks.rb.erb", "db/migrate/add_error_message_to_wallflower_tasks.rb"
       end
 
+      def copy_started_at_migration
+        migration_template "add_started_at_to_wallflower_tasks.rb.erb", "db/migrate/add_started_at_to_wallflower_tasks.rb"
+      end
+
       def copy_catch_up_controller
         source = File.expand_path("../../../../app/javascript/wallflower/catch_up_controller.js", __dir__)
         create_file "app/javascript/controllers/wallflower/catch_up_controller.js", File.read(source)

data/lib/wallflower/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wallflower
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wallflower
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tyler Schneider
@@ -105,6 +105,7 @@ files:
 - lib/generators/wallflower/install/install_generator.rb
 - lib/generators/wallflower/install/templates/add_error_message_to_wallflower_tasks.rb.erb
 - lib/generators/wallflower/install/templates/add_result_url_to_wallflower_tasks.rb.erb
+- lib/generators/wallflower/install/templates/add_started_at_to_wallflower_tasks.rb.erb
 - lib/generators/wallflower/install/templates/create_wallflower_refusals.rb.erb
 - lib/generators/wallflower/install/templates/create_wallflower_tasks.rb.erb
 - lib/generators/wallflower/update/update_generator.rb