deploy_pin 1.7.1 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 231084c3af2dd8f819d5ff7acb16a870a82a184065bf061ec68cebd49870e2cf
-  data.tar.gz: e5137be3496284aeb4da5249860fb64f608ee5bd130203658536d834b943e68f
+  metadata.gz: bbad45594241ef2a7613489332a0efcd0604c58c30775e53027603b58059fd34
+  data.tar.gz: 24a5638349e03c92b567bb4c6e48f028c1df0129ddedfe9b4705d20036954817
 SHA512:
-  metadata.gz: 0ba193060689f387db8cfc77dca413dec40e781c7540abd2c63b887dbf023b57993678e51859b16d80dd344febbc7662ec5b58cf8eb74b8a2bcd53a8a4e11c9b
-  data.tar.gz: b7b54e4e70559aff8aaa2f7d40d208a8194802d412c4dd186aa411763eb560b36e2fd221251c8fb460e8f148546fca7d2b73995dcd2708f6ff2fcaed0d373065
+  metadata.gz: 14fef9659762d17bbdf5c721090417da057acad42d0cd235aa324ca85a635857a327db5fb3242a0bcac9e3988d114c8ca5fe08819ca9a466694c9209ae20df7f
+  data.tar.gz: 13b62e5697393d56efd1903713805770099d80b5e7668b81a723e42ede661fc3fd9643cde7ff4e0359d035def86cb1cac4873083dc988739f0733d1589221536

data/README.md

@@ -143,7 +143,7 @@ Check the documentation [here](lib/deploy_pin/parallel_wrapper.rb) for more deta
 
 ## Formatting
 
-`run_formatter` is used to format the output of a `run` task, and `list_formatter` is used to format the output of a `list` task. To set a default value, you should define it in the deploy_pin initializer:
+`run_formatter` is used to format the output of a `run` task, `list_formatter` for the `list` task and `list_short_formatter` is used to format the output of a `short_list` task. To set a default value, you should define it in the deploy_pin initializer:
 
 ```ruby
 # config/initializers/deploy_pin.rb
@@ -171,6 +171,23 @@ DeployPin.setup do
       puts("\n<<<\n#{task.script.strip.green}\n>>>\n\n")
     end
   )
+  short_list_formatter(
+    lambda do |group, tasks, start_index|
+      puts(" Group: #{group} ".center(38, "=").light_cyan.bold)
+      puts("\n")
+
+      tasks.each.with_index(start_index) do |task, index|
+        puts(" Task ##{index} ".center(38, "=").blue.bold)
+        # print details
+        task.details.each do |key, value|
+          key_aligned = "#{key}:".ljust(20)
+          puts("#{key_aligned}#{value}")
+        end
+
+        puts("\n")
+      end
+    end
+  )
 end
 ```
 
@@ -178,7 +195,7 @@ To use a different formatting value than the default, you need to specify it exp
 
 ## 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)`.
+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`, `#save_progress!(num)` and `#increment_progress!(num)`.
 
 Here is an example of how to use these methods:
 
@@ -190,7 +207,8 @@ Here is an example of how to use these methods:
 # 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
+  increment_progress!(1) # Increment progress by 1 and store it in the database so you can resume the task from this point
+  # or save_progress!(user.id) # Save the progress as the user id
 end
 ```
 
@@ -240,5 +258,34 @@ bundle exec rake deploy_pin:run[rollback] - # enters "pending state"
 ## Contributing
 Contribution directions go here.
 
+### Running Tests Locally
+
+To ensure your changes meet the required standards and pass all tests before submitting a pull request, you can simulate the GitHub Actions workflow locally using the [`act`](https://github.com/nektos/act) tool.
+
+#### Prerequisites
+
+1. **Install `act`**
+   Follow the installation guide provided in the official [`act` documentation](https://nektosact.com/installation/index.html).
+
+2. **Docker**
+   Ensure Docker is installed and running on your machine.
+
+#### Running the Workflow
+
+Use the following command to simulate the workflow locally:
+
+```bash
+act pull_request --secret-file .env --container-architecture linux/amd64 -W .github/workflows -j rspec
+```
+
+This command does the following:
+- `pull_request`: Runs the pull_request workflow defined in your .github/workflows directory.
+- `--secret-file .env`: Uses the .env file provided in the repository to load environment variables.
+- `--container-architecture linux/amd64`: Ensures compatibility with GitHub Actions runners.
+- `-W .github/workflows`: Specifies the directory containing the workflow files.
+- `-j rspec`: Runs the `rspec` job defined in the workflow.
+
+For more details on customizing this command, refer to the [act documentation](https://nektosact.com/).
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/deploy_pin/collector.rb

@@ -26,6 +26,14 @@ module DeployPin
       end
     end
 
+    def short_list
+      groups_tasks = init_tasks.group_by(&:group).to_a
+      groups_tasks.inject(0) do |offset, (group, tasks)|
+        DeployPin.short_list_formatter.call(group, tasks, offset)
+        offset + tasks.count
+      end
+    end
+
     def executable
       # cache tasks
       tasks = init_tasks

data/lib/deploy_pin/runner.rb

@@ -11,6 +11,10 @@ module DeployPin
       DeployPin::Collector.new(identifiers:).list
     end
 
+    def self.short_list(identifiers:)
+      DeployPin::Collector.new(identifiers:).short_list
+    end
+
     def self.summary(identifiers:)
       # print summary
       self.print('======= Summary ========')

data/lib/deploy_pin/task.rb

@@ -10,6 +10,7 @@ module DeployPin
                 :identifier,
                 :group,
                 :title,
+                :affected_areas,
                 :script,
                 :recurring,
                 :explicit_timeout
@@ -21,6 +22,7 @@ module DeployPin
       @identifier = nil
       @group = nil
       @title = ''
+      @affected_areas = ''
       @script = ''
       @explicit_timeout = false
       @parallel = false
@@ -54,6 +56,12 @@ module DeployPin
       record.increment!(:progress, incrementor)
     end
 
+    def save_progress!(value)
+      raise NotImplementedError, 'Recurring tasks do not support progress yet.' if recurring
+
+      record.update(progress: value)
+    end
+
     def done?
       return if recurring
       return unless record
@@ -74,6 +82,8 @@ module DeployPin
           @recurring = Regexp.last_match(3)
         when /\A# task_title:(.+)/
           @title = Regexp.last_match(1).strip
+        when /\A# affected_areas:(.+)/
+          @affected_areas = Regexp.last_match(1).strip
         when /\A[^#].*/
           @script += line
 
@@ -95,7 +105,8 @@ module DeployPin
       {
         identifier:,
         group:,
-        title:
+        title:,
+        affected_areas:
       }
     end
 

data/lib/deploy_pin/version.rb

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

data/lib/deploy_pin.rb

@@ -19,6 +19,7 @@ module DeployPin
     fallback_group
     groups
     list_formatter
+    short_list_formatter
     run_formatter
     statement_timeout
     task_wrapper

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

@@ -19,5 +19,13 @@ module DeployPin
     def copy_initializer
       template 'deploy_pin.rb', 'config/initializers/deploy_pin.rb'
     end
+
+    def activerecord_migration_class
+      if ::ActiveRecord::Migration.respond_to?(:current_version)
+        "ActiveRecord::Migration[#{::ActiveRecord::Migration.current_version}]"
+      else
+        'ActiveRecord::Migration'
+      end
+    end
   end
 end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class CreateDeployPins < ActiveRecord::Migration[7.0]
+class CreateDeployPins < <%= activerecord_migration_class %>
   def change
     create_table :deploy_pins do |t|
       t.string :uuid

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

@@ -34,4 +34,21 @@ DeployPin.setup do
       puts("\n<<<\n#{task.script.strip.green}\n>>>\n\n")
     end
   )
+  short_list_formatter(
+    lambda do |group, tasks, start_index|
+      puts(" Group: #{group} ".center(38, "=").light_cyan.bold)
+      puts("\n")
+
+      tasks.each.with_index(start_index) do |task, index|
+        puts(" Task ##{index} ".center(38, "=").blue.bold)
+        # print details
+        task.details.each do |key, value|
+          key_aligned = "#{key}:".ljust(20)
+          puts("#{key_aligned}#{value}")
+        end
+
+        puts("\n")
+      end
+    end
+  )
 end

data/lib/tasks/deploy_pin_tasks.rake

@@ -15,4 +15,11 @@ namespace :deploy_pin do
     DeployPin::Runner.list(**args)
     DeployPin::Runner.summary(**args)
   end
+
+  task :short_list, [:identifiers] => :environment do |_t, args|
+    args.with_defaults(identifiers: DeployPin.groups)
+
+    DeployPin::Runner.short_list(**args)
+    DeployPin::Runner.summary(**args)
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: deploy_pin
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.7.3
 platform: ruby
 authors:
 - Viktor Sych
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-11 00:00:00.000000000 Z
+date: 2025-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -56,16 +55,22 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -260,7 +265,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -275,8 +279,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: pin some task around deployment
 test_files: []