deploy_pin 1.3.5 → 1.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa5407ab78ca3ddbdb272cdda4b08174f7f17e031d7e51eeecdcef087e1cf636
-  data.tar.gz: 7d7d77724bbb23a0f96223f84c451c948dd85c751b1d0fff3dd05af769491b75
+  metadata.gz: 4d5801fe8a830296f5f65c20239b11872f2e0c80cde1934a8ab953946b544ed8
+  data.tar.gz: 162751453a48bd062984e378a1bfb33825d76bf2b700e6a38324fd60c5f714e8
 SHA512:
-  metadata.gz: b363c3124fde01c582c534b90df9f2624fee9f37bb439d8a5e948672456aedb5c3162b68fb9075f910035296611228166e5306b89e6b2d9898ed2d121f397d3a
-  data.tar.gz: ed934dc9afcc4e530e6079f040bbd551a72e4ab9fccb5961d573d9bd2844cad65e0f919b3ba7bc340e5c8c935d126b4c6d0ceae57b953af0fb97e9efc3f9bd97
+  metadata.gz: '0189c0b921ed86800c1d4c7a1ce7b89f6af1a06ee8f2ced34de0797a7318fd7a508335bbd28980d01e07fce6c467c5117c781ee5958b23c0e8e1b76b33640591'
+  data.tar.gz: 1e25f0d9854201ec343414547f3dc720a932cf92053c245c878095480622ac36d8fdb42ed77d6a4bce10348960595742dcc189ba2f8500eeec94073e07f773bf

data/README.md

@@ -110,7 +110,7 @@ A default value must be defined in the deploy_pin initializer. Ex.:
 # config/initializers/deploy_pin.rb
 DeployPin.setup do
   statement_timeout 0.2.second # 200 ms
-end 
+end
 ```
 
 In order to not use the default value, it's required to use explicitly in the task, like:
@@ -127,7 +127,7 @@ end
 
 To know more about the params, please check the documentation [here](lib/deploy_pin/database.rb).
 
-### Parallel
+## Parallel
 To run parallel tasks using timeout, it's required to use the parallel wrapper, which mimics parallel interface,  
 but adding the timeout option.
 
@@ -142,6 +142,52 @@ end
 
 Check the documentation [here](lib/deploy_pin/parallel_wrapper.rb).
 
+## Formatting
+`run_formatter` is used to format the output of a `run` task
+`list_formatter` is used to format the output of a `list` task
+
+A default value must be defined in the deploy_pin initializer. Ex.:
+```ruby
+# config/initializers/deploy_pin.rb
+DeployPin.setup do
+  run_formatter(
+    lambda do |index, task_count, task, executable, start, time = nil|
+      end_of_msg = if executable
+                     start ? '(Started)' : "(Done in #{time})\n\n"
+                   else
+                     "(Skipped)\n\n"
+                   end
+
+      puts("[#{index + 1}/#{task_count}] Task #{task.title} #{task.uuid}##{task.group} #{end_of_msg}".blue.bold)
+    end
+  )
+  list_formatter(
+    lambda do |index, task|
+      puts("======= Task ##{index} ========".blue.bold)
+
+      # print details
+      task.details.each do |key, value|
+        puts("#{key}:\t\t#{value}")
+      end
+
+      puts("\n<<<\n#{task.script.strip.green}\n>>>\n\n")
+    end
+  )
+end
+```
+
+In order to not use the default value, it's required to use explicitly in the task, like:
+```ruby
+# Some deploy_pin task 
+# 20190401135040:I
+# task_title: Execute some query with timeout
+
+# === task code goes down here ===
+DeployPin::Database::execute_with_timeout do
+ ActiveRecord::Base.connection.execute("select * from shipments;")
+end
+```
+
 ## Contributing
 Contribution directions go here.
 

data/lib/deploy_pin/collector.rb

@@ -3,7 +3,9 @@
 # executes tasks
 module DeployPin
   class Collector
-    attr_reader :identifiers
+    include ActionView::Helpers::DateHelper
+
+    attr_reader :identifiers, :formatter
 
     def initialize(identifiers:)
       @identifiers = identifiers
@@ -16,13 +18,15 @@ module DeployPin
         # run only uniq tasks
         executable = _tasks[0..index].none? { |_task| task.eql?(_task) }
 
-        yield(index, _tasks.count, task, executable)
+        DeployPin.run_formatter.call(index, _tasks.count, task, executable, true)
 
         # run if executable
         if executable
-          run_with_timeout(!task.explicit_timeout? && !task.parallel?) do
-            task.run
+          time = execution_time do
+            run_with_timeout(task) { task.run }
           end
+
+          DeployPin.run_formatter.call(index, _tasks.count, task, executable, false, time)
         end
 
         # mark each task as done
@@ -33,11 +37,11 @@ module DeployPin
     def list
       _tasks = tasks
       _tasks.each_with_index do |task, index|
-        yield(index, _tasks.count, task)
+        DeployPin.list_formatter.call(index, task)
       end
     end
 
-    def exacutable
+    def executable
       # cache tasks
       _tasks = tasks
       _tasks.map.with_index do |task, index|
@@ -71,10 +75,18 @@ module DeployPin
       end
 
       # :reek:UtilityFunction and :reek:ControlParameter
-      def run_with_timeout(under_timeout, &block)
-        return yield unless under_timeout
+      def run_with_timeout(task, &block)
+        return yield unless task.under_timeout?
 
         DeployPin::Database.execute_with_timeout(DeployPin.statement_timeout, **{}, &block)
       end
+
+      def execution_time
+        start_time = Time.now
+
+        yield
+
+        time_ago_in_words(start_time)
+      end
   end
 end

data/lib/deploy_pin/runner.rb

@@ -4,32 +4,17 @@
 module DeployPin
   module Runner
     def self.run(identifiers:)
-      DeployPin::Collector.new(identifiers: identifiers).run do |index, count, task, executable|
-        self.print("[#{index + 1}/#{count}] Task #{task.title} #{task.uuid}##{task.group} (#{executable ? 'run' : 'skip'})")
-      end
+      DeployPin::Collector.new(identifiers: identifiers).run
     end
 
     def self.list(identifiers:)
-      DeployPin::Collector.new(identifiers: identifiers).list do |index, _count, task|
-        self.print("======= Task ##{index} ========".white)
-
-        # print details
-        task.details.each do |key, value|
-          self.print("#{key}:\t\t#{value}")
-        end
-
-        self.print('')
-        self.print('<<<')
-        self.print task.script.strip.green
-        self.print('>>>')
-        self.print('')
-      end
+      DeployPin::Collector.new(identifiers: 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: identifiers).tasks_count}")
     end
 
     def self.print(msg)

data/lib/deploy_pin/task.rb

@@ -37,12 +37,8 @@ module DeployPin
       DeployPin::Record.where(uuid: uuid).exists?
     end
 
-    def explicit_timeout?
-      @explicit_timeout
-    end
-
-    def parallel?
-      @parallel
+    def under_timeout?
+      !explicit_timeout? && !parallel?
     end
 
     def parse_file
@@ -85,5 +81,13 @@ module DeployPin
       def group_index
         DeployPin.groups.index(group)
       end
+
+      def explicit_timeout?
+        @explicit_timeout
+      end
+
+      def parallel?
+        @parallel
+      end
   end
 end

data/lib/deploy_pin/version.rb

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

data/lib/deploy_pin.rb

@@ -17,6 +17,8 @@ module DeployPin
     fallback_group
     groups
     statement_timeout
+    run_formatter
+    list_formatter
   ].freeze
 
   OPTIONS.each do |option|

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

@@ -4,6 +4,28 @@ DeployPin.setup do
   tasks_path 'lib/deploy_pin'
   groups %w[I II III]
   fallback_group 'II'
-
   statement_timeout 10.minutes
+  run_formatter(
+    lambda do |index, task_count, task, executable, start, time = nil|
+      end_of_msg = if executable
+                     start ? '(Started)' : "(Done in #{time})\n\n"
+                   else
+                     "(Skipped)\n\n"
+                   end
+
+      puts("[#{index + 1}/#{task_count}] Task #{task.title} #{task.uuid}##{task.group} #{end_of_msg}".blue.bold)
+    end
+  )
+  list_formatter(
+    lambda do |index, task|
+      puts("======= Task ##{index} ========".blue.bold)
+
+      # print details
+      task.details.each do |key, value|
+        puts("#{key}:\t\t#{value}")
+      end
+
+      puts("\n<<<\n#{task.script.strip.green}\n>>>\n\n")
+    end
+  )
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deploy_pin
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.3.7
 platform: ruby
 authors:
 - Viktor Sych
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-20 00:00:00.000000000 Z
+date: 2023-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize