deploy_pin 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ebbfe96a88deeb425d7b53e1c3a99cda696fac889f80cb333bb912afe2ceba1
-  data.tar.gz: 2bda5afc250a357af2637cd950d3ed1f0362b0f32d2cf65782fe12081b88eca0
+  metadata.gz: ced30166491b43cb26d26c837ca1276e9825d3b48631cea70f3095e0a8590d01
+  data.tar.gz: '0538bf5ea753ba70a2daa8e2104939d38d8605f8ae72d284417bcbe249659a4f'
 SHA512:
-  metadata.gz: 2171f9ae37344e3fb589e99804362df12182fc1cae478b165d3d9f6d1c90b7ef86c5b34d2e099f22a5f168fbeca6e489de6526542f844edd029414fdb285f273
-  data.tar.gz: 734b7f41d25fc84abaff5e81e00c477ff382854e3175581113c967f758d5e31317d56710dbeeabf4bf198e6a27c11e96a5f678f62c4b97d8878261abbd1ded63
+  metadata.gz: f16f07130b5544236e0a17d0658e2c1b5ec2eb2103a5321c4f11ef391492f87c056b69e8b8498553f686e1523989f6723bec205147760fc2c12062f266c3a27e
+  data.tar.gz: 64424aa72c121603c5ddd23f9e15051fca979b4e3393b1ed942b0319aadd3d441515d24203201148c8c125aed4c6dcb0e43b4c2079466e430f7681a56c5700e8

data/README.md

@@ -176,6 +176,30 @@ end
 
 To use a different formatting value than the default, you need to specify it explicitly in the task, similar to the database timeout configuration.
 
+## Resumable Tasks
+
+When working with long-running code that processes a large dataset, it makes sense to store progress in the database to allow resuming the task later. You can do this by using the `DeployPin::Task` instance methods: `#progress` and `#increment_progress(num)`.
+
+Here is an example of how to use these methods:
+
+```ruby
+# Some DeployPin task
+...
+# === task code goes here ===
+
+# The progress is 0 by default
+Users.where(id: progress..).find_each do |user|
+  # Do some work
+  increment_progress(1) # Increment progress by 1 and store it in the database so you can resume the task from this point
+end
+```
+
+This allows your task to resume from where it left off, minimizing the risk of repeating work.
+
+
+
+```bash
+
 ## Recurring Tasks
 If you want to generate a recurring task, you can use the `--recurring` option. Make sure to set a correct `--identifier`, which should be a numeric value. Positive and negative numbers are possible here. The identifier affects the order of task execution, allowing you to customize the sequence as desired.
 

data/lib/deploy_pin/collector.rb

@@ -12,50 +12,51 @@ module DeployPin
     # :reek:TooManyStatements
     def run
       # cache tasks
-      _tasks = tasks
-      _tasks.each_with_index do |task, index|
-        DeployPin.task_wrapper.call(task, -> { process(_tasks, task, index) })
+      tasks = init_tasks
+      tasks.each_with_index do |task, index|
+        DeployPin.task_wrapper.call(task, -> { process(tasks, task, index) })
       end
     end
     # :reek:TooManyStatements
 
     def list
-      _tasks = tasks
-      _tasks.each_with_index do |task, index|
+      tasks = init_tasks
+      tasks.each_with_index do |task, index|
         DeployPin.list_formatter.call(index, task)
       end
     end
 
     def executable
       # cache tasks
-      _tasks = tasks
-      _tasks.map.with_index do |task, index|
-        task if _tasks[0..index].none? { |_task| task.eql?(_task) }
+      tasks = init_tasks
+      tasks.map.with_index do |task, index|
+        task if tasks[0..index].none? { |other_task| task.eql?(other_task) }
       end.compact
     end
 
     def tasks_count
-      tasks.count
+      init_tasks.count
     end
 
     private
 
       # :reek:FeatureEnvy
       # :reek:TooManyStatements
-      def process(cached_tasks, task, index)
+      def process(tasks, task, index)
         # run only uniq tasks
-        executable = cached_tasks[0..index].none? { |_task| task.eql?(_task) }
+        executable = tasks[0..index].none? { |other_task| task.eql?(other_task) }
 
-        DeployPin.run_formatter.call(index, cached_tasks.count, task, executable, true)
+        DeployPin.run_formatter.call(index, tasks.count, task, executable, true)
+
+        task.prepare
 
         # run if executable
         if executable
           duration = execution_duration { run_with_timeout(task) { task.run } }
-          DeployPin.run_formatter.call(index, cached_tasks.count, task, executable, false, duration)
+          DeployPin.run_formatter.call(index, tasks.count, task, executable, false, duration)
         end
 
-        # mark each task as done
-        task.mark unless task.done?
+        task.mark # mark each task as done
       end
       # :reek:TooManyStatements
       # :reek:FeatureEnvy
@@ -65,7 +66,7 @@ module DeployPin
         Dir["#{DeployPin.tasks_path}/*.rb"]
       end
 
-      def tasks
+      def init_tasks
         [*DeployPin.deployment_tasks_code, *files].map do |file|
           task = DeployPin::Task.new(file)
           task.parse
@@ -76,7 +77,7 @@ module DeployPin
       end
 
       def task_criteria
-        @task_criteria ||= DeployPin::TaskCriteria.new(identifiers: identifiers)
+        @task_criteria ||= DeployPin::TaskCriteria.new(identifiers:)
       end
 
       # :reek:UtilityFunction and :reek:ControlParameter

data/lib/deploy_pin/runner.rb

@@ -4,17 +4,17 @@
 module DeployPin
   module Runner
     def self.run(identifiers:)
-      DeployPin::Collector.new(identifiers: identifiers).run
+      DeployPin::Collector.new(identifiers:).run
     end
 
     def self.list(identifiers:)
-      DeployPin::Collector.new(identifiers: identifiers).list
+      DeployPin::Collector.new(identifiers:).list
     end
 
     def self.summary(identifiers:)
       # print summary
       self.print('======= Summary ========')
-      self.print("Tasks number: #{DeployPin::Collector.new(identifiers: identifiers).tasks_count}")
+      self.print("Tasks number: #{DeployPin::Collector.new(identifiers:).tasks_count}")
     end
 
     def self.print(msg)

data/lib/deploy_pin/task.rb

@@ -14,6 +14,8 @@ module DeployPin
                 :recurring,
                 :explicit_timeout
 
+    delegate :progress, to: :record
+
     def initialize(file)
       @file = file
       @identifier = nil
@@ -29,17 +31,34 @@ module DeployPin
       eval(script)
     end
 
+    def record
+      DeployPin::Record.find_by(uuid: identifier)
+    end
+
+    def prepare
+      return if recurring
+
+      DeployPin::Record.create(uuid: identifier) unless record
+    end
+
     def mark
       return if recurring
 
       # store record in the DB
-      DeployPin::Record.create(uuid: identifier)
+      record.update(completed_at: Time.current)
+    end
+
+    def increment_progress!(incrementor)
+      raise NotImplementedError, 'Recurring tasks do not support progress yet.' if recurring
+
+      record.increment!(:progress, incrementor)
     end
 
     def done?
       return if recurring
+      return unless record
 
-      DeployPin::Record.where(uuid: identifier).exists?
+      record.completed_at.present?
     end
 
     def under_timeout?
@@ -74,9 +93,9 @@ module DeployPin
 
     def details
       {
-        identifier: identifier,
-        group: group,
-        title: title
+        identifier:,
+        group:,
+        title:
       }
     end
 
@@ -104,7 +123,6 @@ module DeployPin
 
     protected
 
-
       def group_index
         DeployPin.groups.index(group)
       end

data/lib/deploy_pin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeployPin
-  VERSION = '1.6.0'
+  VERSION = '1.7.0'
 end

data/lib/generators/deploy_pin/install/templates/create_deploy_pins.rb

@@ -4,6 +4,8 @@ class CreateDeployPins < ActiveRecord::Migration[7.0]
   def change
     create_table :deploy_pins do |t|
       t.string :uuid
+      t.integer :progress, default: 0
+      t.datetime :completed_at, default: nil
       t.timestamps
     end
   end

data/lib/generators/deploy_pin/install/templates/deploy_pin.rb

@@ -6,11 +6,11 @@ DeployPin.setup do
   fallback_group 'III'
   statement_timeout 10.minutes
   deployment_state_transition({
-    ongoing: %w[I III],
-    pending: 'rollback', # enters to pending step before "rollback"
-    ttl: 20.second, # memoize the state to avoid the store spam
-    redis_url: 'redis://localhost:6379'
-  })
+                                ongoing: %w[I III],
+                                pending: 'rollback', # enters to pending step before "rollback"
+                                ttl: 20.second, # memoize the state to avoid the store spam
+                                redis_url: 'redis://localhost:6379'
+                              })
   run_formatter(
     lambda do |index, task_count, task, executable, start, duration = nil|
       end_of_msg = if executable

data/lib/generators/deploy_pin/upgrade/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Upgrades the deploy_pins table in the DB with an extra columns for resumable tasks
+
+Example:
+    rails generate deploy_pin:upgrade
+
+    This will create:
+        db/migrate/upgrade_deploy_pins.rb

data/lib/generators/deploy_pin/upgrade/templates/upgrade_deploy_pins.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class UpgradeDeployPins < ActiveRecord::Migration[7.0]
+  def change
+    add_column :deploy_pins, :progress, :integer, default: 0, if_not_exists: true
+    add_column :deploy_pins, :completed_at, :datetime, default: nil, if_not_exists: true
+  end
+end

data/lib/generators/deploy_pin/upgrade/upgrade_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DeployPin
+  # This generator is used to generate the migration file for upgrading db schema for 1.7 version support.
+  class UpgradeGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('templates', __dir__)
+    desc 'Add the upgrade migration for DeployPin.'
+
+    def self.next_migration_number(path)
+      next_migration_number = current_migration_number(path) + 1
+      ActiveRecord::Migration.next_migration_number(next_migration_number)
+    end
+
+    def copy_migrations
+      migration_template 'upgrade_deploy_pins.rb', 'db/migrate/upgrade_deploy_pins.rb'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deploy_pin
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Viktor Sych
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-07 00:00:00.000000000 Z
+date: 2024-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -251,6 +251,9 @@ files:
 - lib/generators/deploy_pin/task/task_generator.rb
 - lib/generators/deploy_pin/task/templates/parallel_task.rb.erb
 - lib/generators/deploy_pin/task/templates/task.rb.erb
+- lib/generators/deploy_pin/upgrade/USAGE
+- lib/generators/deploy_pin/upgrade/templates/upgrade_deploy_pins.rb
+- lib/generators/deploy_pin/upgrade/upgrade_generator.rb
 - lib/tasks/deploy_pin_tasks.rake
 homepage: https://github.com/skcc321/deploy_pin
 licenses:
@@ -265,7 +268,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="