deploy_pin 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7675586dc8be3862feb563927693c5aea136bb26983e261d97e995f111294c99
-  data.tar.gz: de5d52bec5a3cff487667ae8a8bdb8af75b51f754507c0fb57e2f3db2cc9fd36
+  metadata.gz: a760ef5554d4821d4e57eca80bd547a24f5456c7e2bd27768fc2d62db3bad25e
+  data.tar.gz: 33e218e88444b4362b29d7f506fcdc455f07c07b4c6760228043b5f403687948
 SHA512:
-  metadata.gz: 06bf8fbe7319167b1b9b5f32af3a2116debf608c3d4c8d10835436d475ada3d21f2259d32bb0adb6832c973b3b1c279753a4e4a9abf0748ee11a63265575cc53
-  data.tar.gz: ea0f4017dd721cddfcfd75b36f81332903bdc615089631569acdfa98e0e263e60559273e32f4bedc2bb1449846e4d7f25d41a390b24d548024336a5f02803e33
+  metadata.gz: fbae2f1401711aabf1e88e3e01daeb2b8a1e07a4f3072fb8d54eb9f0f40f0bb74a4eaaed7859cd4119574544a2814393a44dcb7297808db6f89dd7e659d03220
+  data.tar.gz: cb8203f11fefb55c2e525fb2b6a2ca82e0d8791b69c64717d3f830bf2c5a3cf91977cb3e3842d780aa6084171795154eb548546a610798a60c53938b35f7173b

data/README.md

@@ -1,6 +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)
-[![Build Status](https://travis-ci.org/skcc321/deploy_pin.svg?branch=master)](https://travis-ci.org/skcc321/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)
 

data/Rakefile

@@ -1,27 +1,7 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
+# frozen_string_literal: true
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'DeployPin'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'bundler/setup'
 
 require 'bundler/gem_tasks'
 
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-task default: :test
+import 'test/dummy/Rakefile'

data/app/models/deploy_pin/application_record.rb

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

data/app/models/deploy_pin/record.rb

@@ -3,4 +3,3 @@
 class DeployPin::Record < DeployPin::ApplicationRecord
   self.table_name = 'deploy_pins'
 end
-

data/lib/deploy_pin/collector.rb

@@ -47,22 +47,22 @@ module DeployPin
 
     private
 
-      def files
-        Dir["#{DeployPin.tasks_path}/*.rb"]
-      end
+    def files
+      Dir["#{DeployPin.tasks_path}/*.rb"]
+    end
 
-      def tasks
-        files.map do |file|
-          task = DeployPin::Task.new(file)
-          task.parse_file
+    def tasks
+      files.map do |file|
+        task = DeployPin::Task.new(file)
+        task.parse_file
 
-          # check if task is suitable
-          task if task_criteria.suitable?(task)
-        end.compact.sort # sort by group position in config
-      end
+        # check if task is suitable
+        task if task_criteria.suitable?(task)
+      end.compact.sort # sort by group position in config
+    end
 
-      def task_criteria
-        @task_criteria ||= DeployPin::TaskCriteria.new(identifiers: identifiers)
-      end
+    def task_criteria
+      @task_criteria ||= DeployPin::TaskCriteria.new(identifiers: identifiers)
+    end
   end
 end

data/lib/deploy_pin/database.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module DeployPin
+  module Database
+    extend self
+
+    # Run a block under a sql maximum timeout.
+    #
+    # A default timeout will be get from DeployPin.setup
+    #
+    #   # config/initializers/deploy_pin.rb
+    #   DeployPin.setup do
+    #     statement_timeout 0.2.second # 200 ms
+    #   end
+    #
+    #   # <app root>/deploy_pin/20190401135040_task.rb
+    #   # 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
+    #
+    # A timeout can be passed as param as well:
+    #
+    #   DeployPin::Database::execute_with_timeout 10.minutes do
+    #     ActiveRecord::Base.connection.execute("select * from shipments;")
+    #   end
+    #
+    # In order to connect to multiple databases, pass the +connected_to+ keyword into the params.
+    # The +connected_to+ will use the +ActiveRecord::Base.connected_to+.
+    # To connect to a replica database, for example:
+    #
+    #   DeployPin::Database::execute_with_timeout 1.seconds, connected_to: { role: :reading } do
+    #     Shipment.all # Get all record from replica
+    #   end
+    #
+    # Or a specific database:
+    #
+    #   DeployPin::Database.execute_with_timeout 30.second, connected_to: { database: :test_mysql } do
+    #     ActiveRecord::Base.connection.execute("<some mysql query>")
+    #   end
+    def execute_with_timeout(timeout = DeployPin.statement_timeout, **params, &blk)
+      raise ArgumentError, 'timeout must be greater than zero' if timeout.to_f <= 0
+
+      return call_block_under_timeout(timeout, &blk) unless params.key? :connected_to
+
+      klass = params[:connected_to].key? :database ? ActiveRecord::Base : ::ApplicationRecord
+      klass.connected_to(**params[:connected_to]) do
+        call_block_under_timeout(timeout, &blk)
+      end
+    end
+
+    private
+
+      def call_block_under_timeout(timeout)
+        set_max_timeout(timeout)
+
+        yield
+      end
+
+      def set_max_timeout(timeout)
+        timeout_in_milliseconds = timeout.to_f.in_milliseconds.ceil # Make sure is always at least 1. 0 turns this off
+
+        timeout_statement =
+          if postgresql?
+            postgresql_timeout_statement
+          elsif mysql?
+            mysql_timeout_statement
+          end
+
+        connection.select_all "#{timeout_statement} #{connection.quote(timeout_in_milliseconds)}"
+      end
+
+      def postgresql?
+        connection.adapter_name =~ /postg/i
+      end
+
+      def postgresql_timeout_statement
+        "SET statement_timeout TO"
+      end
+
+      def mysql?
+        connection.adapter_name =~ /mysql/i
+      end
+
+      def mysql_timeout_statement
+        "SET max_execution_time ="
+      end
+
+      def connection
+        ActiveRecord::Base.connection
+      end
+  end
+end

data/lib/deploy_pin/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeployPin
   class Engine < ::Rails::Engine
     isolate_namespace DeployPin

data/lib/deploy_pin/runner.rb

@@ -10,7 +10,7 @@ module DeployPin
     end
 
     def self.list(identifiers:)
-      DeployPin::Collector.new(identifiers: identifiers).list do |index, count, task|
+      DeployPin::Collector.new(identifiers: identifiers).list do |index, _count, task|
         self.print("======= Task ##{index} ========".white)
 
         # print details
@@ -18,17 +18,17 @@ module DeployPin
           self.print("#{key}:\t\t#{value}")
         end
 
-        self.print("")
-        self.print("<<<")
+        self.print('')
+        self.print('<<<')
         self.print task.script.strip.green
-        self.print(">>>")
-        self.print("")
+        self.print('>>>')
+        self.print('')
       end
     end
 
     def self.summary(identifiers:)
       # print summary
-      self.print("======= Summary ========")
+      self.print('======= Summary ========')
       self.print("tasks number: #{DeployPin::Collector.new(identifiers: identifiers).tasks_count}")
     end
 

data/lib/deploy_pin/task.rb

@@ -4,17 +4,17 @@
 module DeployPin
   class Task
     attr_reader :file,
-      :uuid,
-      :group,
-      :title,
-      :script
+                :uuid,
+                :group,
+                :title,
+                :script
 
     def initialize(file)
       @file = file
       @uuid = nil
       @group = nil
-      @title = ""
-      @script = ""
+      @title = ''
+      @script = ''
     end
 
     def run
@@ -35,10 +35,10 @@ module DeployPin
       File.foreach(file) do |line|
         case line.strip
         when /\A# (\d+):(\w+)/
-          @uuid = $1
-          @group = $2
+          @uuid = Regexp.last_match(1)
+          @group = Regexp.last_match(2)
         when /\A# task_title:(.+)/
-          @title = $1.strip
+          @title = Regexp.last_match(1).strip
         when /\A[^#].*/
           @script += line
         end
@@ -53,20 +53,20 @@ module DeployPin
       }
     end
 
-    def eql?(task_b)
+    def eql?(other)
       # same script & different uuid
-      script == task_b.script && uuid != task_b.uuid
+      script == other.script && uuid != other.uuid
     end
 
     protected
 
-      # for sorting
-      def <=>(task_b)
-        group_index <=> task_b.group_index
-      end
+    # for sorting
+    def <=>(other)
+      group_index <=> other.group_index
+    end
 
-      def group_index
-        DeployPin.groups.index(group)
-      end
+    def group_index
+      DeployPin.groups.index(group)
+    end
   end
 end

data/lib/deploy_pin/task_criteria.rb

@@ -14,16 +14,16 @@ module DeployPin
     end
 
     def suitable?(task)
-      task_cover = ->(task, regexp) {
-        items = identifiers.flat_map {|x| x.to_s.scan(regexp) }.flatten
+      task_cover = lambda { |task, regexp|
+        items = identifiers.flat_map { |x| x.to_s.scan(regexp) }.flatten
 
         items & [task.group, task.uuid]
       }
 
-      return false if task_cover.(task, SKIP_REGEXEP).any?
-      return true if task_cover.(task, FORCE_REGEXP).any?
+      return false if task_cover.call(task, SKIP_REGEXEP).any?
+      return true if task_cover.call(task, FORCE_REGEXP).any?
 
-      task_cover.(task, COMMON_REGEXP).any? && !task.done?
+      task_cover.call(task, COMMON_REGEXP).any? && !task.done?
     end
   end
 end

data/lib/deploy_pin/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeployPin
-  VERSION = '1.2.3'
+  VERSION = '1.3.0'
 end

data/lib/deploy_pin.rb

@@ -1,18 +1,22 @@
-require "deploy_pin/runner"
-require "deploy_pin/collector"
-require "deploy_pin/task"
-require "deploy_pin/task_criteria"
-require "deploy_pin/engine"
-require "parallel"
-require "ruby-progressbar"
-require "colorize"
+# frozen_string_literal: true
+
+require 'deploy_pin/runner'
+require 'deploy_pin/collector'
+require 'deploy_pin/task'
+require 'deploy_pin/task_criteria'
+require 'deploy_pin/engine'
+require 'deploy_pin/database'
+require 'parallel'
+require 'ruby-progressbar'
+require 'colorize'
 
 module DeployPin
-  OPTIONS = %i(
+  OPTIONS = %i[
     tasks_path
     fallback_group
     groups
-  )
+    statement_timeout
+  ].freeze
 
   OPTIONS.each do |option|
     instance_eval %{
@@ -21,7 +25,7 @@ module DeployPin
 
         @@#{option} = val
       end
-    }
+    }, __FILE__, __LINE__ - 6
   end
 
   def self.setup(&block)

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CreateDeployPins < ActiveRecord::Migration[5.2]
   def change
     create_table :deploy_pins do |t|

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

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 DeployPin.setup do
-  tasks_path "lib/deploy_pin"
-  groups ["I", "II", "III"]
-  fallback_group "II"
+  tasks_path 'lib/deploy_pin'
+  groups %w[I II III]
+  fallback_group 'II'
+
+  statement_timeout 10.minutes
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # <%= @uuid %>:<%= group %>
 # task_title: super duper task
 
@@ -9,4 +11,10 @@ Parallel.each(DeployPin::Record.where(uuid: "hello"), progress: "Doing stuff") d
     pin.update_attribute(:uuid, "new uuid")
   end
   sleep(0.2)
+
+  # DeployPin::Database::execute_with_timeout 10.minutes do
+  #   ActiveRecord::Base.connection.execute("select * from shipments;")
+  #   or
+  #   Shipment.all
+  # end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # <%= @uuid %>:<%= group %>
 # task_title: super duper task
 
@@ -5,3 +7,9 @@
 progressbar = ProgressBar.create(title: "Doing stuff", total: 20, format: '%t |%E | %B | %a')
 
 20.times { progressbar.increment; sleep(0.2) }
+
+# DeployPin::Database::execute_with_timeout 10.minutes do
+#   ActiveRecord::Base.connection.execute("select * from shipments;")
+#   or
+#   Shipment.all
+# end

data/lib/tasks/deploy_pin_tasks.rake

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 namespace :deploy_pin do
-  desc "run pending tasks"
-  task :run, [:identifiers] => :environment do |t, args|
+  desc 'run pending tasks'
+  task :run, [:identifiers] => :environment do |_t, args|
     identifiers = args.identifiers
     attributes = identifiers.nil? ? DeployPin.groups : identifiers.split(/\s*,\s*/)
 
     DeployPin::Runner.run(identifiers: attributes)
   end
 
-  task :list, [:identifiers] => :environment  do |t, args|
+  task :list, [:identifiers] => :environment do |_t, args|
     args.with_defaults(identifiers: DeployPin.groups)
 
-    DeployPin::Runner.list(args)
-    DeployPin::Runner.summary(args)
+    DeployPin::Runner.list(**args)
+    DeployPin::Runner.summary(**args)
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: deploy_pin
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
-- rafael
-autorequire: 
+- Viktor Sych
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-25 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -39,41 +39,41 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: ruby-progressbar
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 6.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 6.0.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.1.0
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.1.0
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -81,95 +81,75 @@ 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.16.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.0
-- !ruby/object:Gem::Dependency
-  name: bundler
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.4
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.4
+        version: '0'
 description: pin some task around deployment to execute them during deployment circle
 email:
 - skcc321@gmail.com
@@ -184,6 +164,7 @@ files:
 - app/models/deploy_pin/record.rb
 - lib/deploy_pin.rb
 - lib/deploy_pin/collector.rb
+- lib/deploy_pin/database.rb
 - lib/deploy_pin/engine.rb
 - lib/deploy_pin/runner.rb
 - lib/deploy_pin/task.rb
@@ -203,7 +184,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -218,8 +199,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: pin some task around deployment
 test_files: []