deploy_pin 1.3.2 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0133c82dd0826300585629d58af3f3e10a58b481e7c65a589a834fd0d7d79bdd
-  data.tar.gz: 220af2e000347c6835673f664f3413d3775cba0d3f1ccb9778cd324fcce1f08a
+  metadata.gz: 64b7fc8e444888aebbf7bb08e4df2b259544a07fbef796cdda49412344b2dccd
+  data.tar.gz: 05ced857a7699b580554dd7a2a416c7b71950da11da3857a5ce5fd5167be0f9d
 SHA512:
-  metadata.gz: 602e2f80e418e91e0d0045b5f5635c001d221217566581df4eea11b499dcd974b188b5de5adc7b37452c156f2c00d35b8238e4bc80a6d50ba2c962d48df7952f
-  data.tar.gz: 202f198bb6197464495d7b418a568022b2869bf8800c959ffc09310db7a7335c16bd902652cda7b5ee2a734335bb88e35722f278f84005683935b29e6a0c9651
+  metadata.gz: fb7b9da496971cdb3906d9f298eb3e5587205106c28f7352d492a49d13db7ef37b5f6706d3fff7d1130573ae3ac73f9a662fbc58bf072e823ee9fe6d79873df5
+  data.tar.gz: 68c448505f328bcaa1a7367e14d32feb785354f7fdf993b2d97d2c4194a612aead8fd28b08a3042dbe85c89dc9838f9205317aa4abd8d682b0efaad19358c3c8

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
 
@@ -105,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/app/models/deploy_pin/application_record.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
-class DeployPin::ApplicationRecord < ActiveRecord::Base
-  self.abstract_class = true
+module DeployPin
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
 end

data/app/models/deploy_pin/record.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
-class DeployPin::Record < DeployPin::ApplicationRecord
-  self.table_name = 'deploy_pins'
+module DeployPin
+  class Record < DeployPin::ApplicationRecord
+    self.table_name = 'deploy_pins'
+  end
 end

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.2'
+  VERSION = '1.3.4'
 end

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

@@ -1,21 +1,23 @@
 # frozen_string_literal: true
 
-class DeployPin::InstallGenerator < Rails::Generators::Base
-  include Rails::Generators::Migration
+module DeployPin
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
 
-  source_root File.expand_path('templates', __dir__)
-  desc 'Add the migration & initializer for DeployPin'
+    source_root File.expand_path('templates', __dir__)
+    desc 'Add the migration & initializer 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 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 'create_deploy_pins.rb', 'db/migrate/create_deploy_pins.rb'
-  end
+    def copy_migrations
+      migration_template 'create_deploy_pins.rb', 'db/migrate/create_deploy_pins.rb'
+    end
 
-  def copy_initializer
-    template 'deploy_pin.rb', 'config/initializers/deploy_pin.rb'
+    def copy_initializer
+      template 'deploy_pin.rb', 'config/initializers/deploy_pin.rb'
+    end
   end
 end

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

@@ -1,24 +1,26 @@
 # frozen_string_literal: true
 
-class DeployPin::TaskGenerator < Rails::Generators::Base
-  class_option :parallel, type: :boolean
-  argument :title, required: true
-  class_option :group, aliases: "-g", default: DeployPin.fallback_group
-  class_option :author, aliases: "-a"
+module DeployPin
+  class TaskGenerator < Rails::Generators::Base
+    class_option :parallel, type: :boolean
+    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__)
+    source_root File.expand_path('templates', __dir__)
 
-  desc 'This generator creates deploy_pin task at lib/deploy_pin/'
-  def create_task_file
-    template_file = if options[:parallel]
-                      'parallel_task.rb.erb'
-                    else
-                      'task.rb.erb'
-                    end
+    desc 'This generator creates deploy_pin task at lib/deploy_pin/'
+    def create_task_file
+      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}_#{title}.rb"
+      @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}_#{title}.rb"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deploy_pin
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.4
 platform: ruby
 authors:
 - Viktor Sych
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-26 00:00:00.000000000 Z
+date: 2023-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -150,6 +150,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  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
+  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
@@ -193,7 +235,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="