deploy_pin 1.3.1 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3006ccc3913b4cc7ee0b5d68b316ffb70ecef2bbfeae27c7efec65422246cdb
-  data.tar.gz: d055a8554b590bc039915d3a2866f23aa8541db9ffe8c2c933294f54c2013785
+  metadata.gz: dd55cf51dd48871190b26b687e0e43ca56a460b5f38b26b65f48549c5e0e4c01
+  data.tar.gz: 814a4adaaaa6c967e715ea38ac264b76e5f2292ed79a9df5ecbaec3b8e804c99
 SHA512:
-  metadata.gz: 70d4054142995c62609666711a87d4d4e42783bf4631e61f3a43e3407a9cd68654de65b0925655ca416fb65e41bccd3a2246125e446f5f4d8a9cb48f70e7ffd4
-  data.tar.gz: 654cbb997e23bf9a2cc9d8579e71646f68fd669dfd92235da2a1d15b8b3d9775b01db714ce99e79e23e6389282a907c2f9ae5b573c348bd4b0d3f43105989903
+  metadata.gz: ac2cc4f44f70d66807b46369c2b9a942ef07eaaab858ed988c6e9dfebd4e02c0f0495fa9e5989f7204300a55150d5c8e3cbbaa10e33c9a7d6a77d16a18ce4c00
+  data.tar.gz: 37f7a702ae8d696c002a3b4af04b77e590ed20f9c81920d39ede0ec0d942b2c8ed82c7a439a08bb7a94d6d3e9fb5f531405dc796ec819248417750980afde7d4

data/README.md

@@ -1,8 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/deploy_pin.svg)](https://badge.fury.io/rb/deploy_pin)
 ![](https://ruby-gem-downloads-badge.herokuapp.com/deploy_pin)
 ![example workflow](https://github.com/skcc321/deploy_pin/actions/workflows/verify.yml/badge.svg)
-[![Maintainability](https://api.codeclimate.com/v1/badges/c0a9ca97c1f9c0478ffc/maintainability)](https://codeclimate.com/github/skcc321/deploy_pin/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/c0a9ca97c1f9c0478ffc/test_coverage)](https://codeclimate.com/github/skcc321/deploy_pin/test_coverage)
 
 # DeployPin
 
@@ -21,9 +19,14 @@ deploy_pins is exactly what you need.
 
 To generate new task template file
 ```bash
-rails g deploy_pin:task
+rails g deploy_pin:task some_task_title
 # or
-rails g deploy_pin:task --parallel
+rails g deploy_pin:task some_task_title --parallel
+```
+
+Also, you can specify author
+```bash
+rails g deploy_pin:task some_task_title -a author_name
 ```
 
 To list all pending tasks
@@ -40,11 +43,10 @@ rake deploy_pin:run
 
 Please define allowed groups in `config/initializers/deploy_pin.rb`
 if you want to group tasks around "allowed_group"
-
 ```bash
-rails g deploy_pin:task allowed_group
+rails g deploy_pin:task task_title -g allowed_group
 # or
-rails g deploy_pin:task allowed_group --parallel
+rails g deploy_pin:task task_title -g allowed_group --parallel
 ```
 
 To list all pending tasks
@@ -101,6 +103,45 @@ and run migration
 rake db:migrate
 ```
 
+## Database Timeout
+By default, deploy_pin will run all the non-parallel tasks under a database statement timeout.  
+A default value must be defined in the deploy_pin initializer. Ex.:
+```ruby
+# config/initializers/deploy_pin.rb
+DeployPin.setup do
+  statement_timeout 0.2.second # 200 ms
+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
+```
+
+To know more about the params, please check the documentation [here](lib/deploy_pin/database.rb).
+
+### Parallel
+To run parallel tasks using timeout, it's required to use the parallel wrapper, which mimics parallel interface,  
+but adding the timeout option.
+
+In a deploy_pin task, instead of using `Parallel.each(1..2, in_processes: 2)`, use:
+```ruby
+parallel_each(1..2, in_processes: 2, timeout: 0.3.seconds) do |i|
+  # ActiveRecord::Base.connection_pool.with_connection it's already include in the parallel wrapper.
+  puts "Item: #{i}, Worker: #{Parallel.worker_number}"
+  ActiveRecord::Base.connection.execute("<some db query>")
+end
+```
+
+Check the documentation [here](lib/deploy_pin/parallel_wrapper.rb).
+
 ## Contributing
 Contribution directions go here.
 

data/lib/deploy_pin/collector.rb

@@ -50,6 +50,7 @@ module DeployPin
     end
 
     private
+
       # :reek:UtilityFunction
       def files
         Dir["#{DeployPin.tasks_path}/*.rb"]

data/lib/deploy_pin/database.rb

@@ -7,6 +7,8 @@ module DeployPin
 
     extend self
 
+    def dummy_method; end
+
     # Run a block under a sql maximum timeout.
     #
     # A default timeout will be get from DeployPin.setup

data/lib/deploy_pin/version.rb

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

data/lib/generators/deploy_pin/task/USAGE

@@ -2,7 +2,7 @@ Description:
     Creates tasks for execution on deployment
 
 Example:
-    rails generate deploy_pin:task
+    rails generate deploy_pin:task some_name_of_task -a author -g I
 
     This will create:
-        lib/deploy_pin/task.rb
+        lib/deploy_pin/{task_id}_some_name_of_task.rb

data/lib/generators/deploy_pin/task/task_generator.rb

@@ -2,22 +2,23 @@
 
 class DeployPin::TaskGenerator < Rails::Generators::Base
   class_option :parallel, type: :boolean
-  argument :group, default: DeployPin.fallback_group
+  argument :title, required: true
+  class_option :group, aliases: '-g', default: DeployPin.fallback_group
+  class_option :author, aliases: '-a'
 
   source_root File.expand_path('templates', __dir__)
 
   desc 'This generator creates deploy_pin task at lib/deploy_pin/'
   def create_task_file
-    raise "Not allowed 'group' argument! possible values are #{DeployPin.groups}" \
-      unless DeployPin.groups.include?(group)
-
     template_file = if options[:parallel]
                       'parallel_task.rb.erb'
                     else
                       'task.rb.erb'
                     end
 
+    @author = options[:author] || ENV['USER']
+    @group = options[:group]
     @uuid = Time.now.strftime('%Y%m%d%H%M%S')
-    template template_file, "#{DeployPin.tasks_path}/#{@uuid}_task.rb"
+    template template_file, "#{DeployPin.tasks_path}/#{@uuid}_#{title}.rb"
   end
 end

data/lib/generators/deploy_pin/task/templates/parallel_task.rb.erb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-# <%= @uuid %>:<%= group %>
-# task_title: super duper task
+# <%= @uuid %>:<%= @group %>
+# task_title: <%= @author ? "@#{@author} #{title.titleize}" : "#{title.titleize}" %>
 
 # === parallel task code goes down here ===
 10.times { DeployPin::Record.create(uuid: "hello") }

data/lib/generators/deploy_pin/task/templates/task.rb.erb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-# <%= @uuid %>:<%= group %>
-# task_title: super duper task
+# <%= @uuid %>:<%= @group %>
+# task_title: <%= @author ? "@#{@author} #{title.titleize}" : "#{title.titleize}" %>
 
 # === task code goes down here ===
 progressbar = ProgressBar.create(title: "Doing stuff", total: 20, format: '%t |%E | %B | %a')
@@ -12,4 +12,4 @@ progressbar = ProgressBar.create(title: "Doing stuff", total: 20, format: '%t |%
 #   ActiveRecord::Base.connection.execute("select * from shipments;")
 #   or
 #   Shipment.all
-# end
+# end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deploy_pin
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.3
 platform: ruby
 authors:
 - Viktor Sych
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-09 00:00:00.000000000 Z
+date: 2023-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -150,6 +150,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-review
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: pin some task around deployment to execute them during deployment circle
 email:
 - skcc321@gmail.com