deploy_pin 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4dfa8e844cfa02e0324e4af067d6ac5a8e3d8b7829a90970bf7db6cb60cdb47
-  data.tar.gz: caf02bfb5aaa6e6edd82f83bacef7113f0c62de799cbfebe45b94d88d71553e1
+  metadata.gz: 7ebbfe96a88deeb425d7b53e1c3a99cda696fac889f80cb333bb912afe2ceba1
+  data.tar.gz: 2bda5afc250a357af2637cd950d3ed1f0362b0f32d2cf65782fe12081b88eca0
 SHA512:
-  metadata.gz: '0909b4f5366aeeb71e51cacf70d72d08a18486eab638d428950a53e6735155afb6af6bcab7c48095511372a18b9deac024a25adb291fab2206c79e63a61a9175'
-  data.tar.gz: ce86dd3f2c2f7d6c3ec2957e1c1cb3eab4618aa88979b61418d6ca03fa2e9c5c59651aa5db630df166c1da05e9c126829e0b3823dd18ce3a0c8b733092fdbf33
+  metadata.gz: 2171f9ae37344e3fb589e99804362df12182fc1cae478b165d3d9f6d1c90b7ef86c5b34d2e099f22a5f168fbeca6e489de6526542f844edd029414fdb285f273
+  data.tar.gz: 734b7f41d25fc84abaff5e81e00c477ff382854e3175581113c967f758d5e31317d56710dbeeabf4bf198e6a27c11e96a5f678f62c4b97d8878261abbd1ded63

data/README.md

@@ -6,8 +6,6 @@
 
 # DeployPin
 
-![DeployPin](http://hereisfree.com/content1//pic/zip/2009109935062477801.jpg)
-
 Deploying applications often involves the need to execute a series of specific commands or tasks either before or after the deployment process. While you might typically turn to migrations for such operations, these tasks aren't always migration-related. Additionally, there are situations where you need to execute code before or after a migration without causing the main thread to block.
 
 Introducing deploy_pins – your go-to solution for streamlined task management during the deployment process. This Ruby library allows you to seamlessly orchestrate tasks before, after, or independently of migrations, offering the flexibility you need to maintain a smooth and efficient deployment workflow. With deploy_pins, you can take control of your deployment tasks and ensure that your application operates flawlessly in any environment.
@@ -119,6 +117,7 @@ If you want to use a different value than the default, you need to specify it ex
 # Some deploy_pin task
 # 20190401135040:I
 # task_title: Execute some query with timeout
+# affected_areas: none
 
 # === task code goes down here ===
 DeployPin::Database::execute_with_timeout do
@@ -191,27 +190,29 @@ rails g deploy_pin:task some_task_title --parallel --recurring --identifier 5
 ## DeploymentStateTrack
 In the initializer
 ```ruby
-    DeployPin.setup do
-      groups %w[I II III post rollback]
-      ...
-      deployment_state_transition({
-        ongoing: %w[I III],
-        pending: "rollback", # enters to pending step before "rollback"
-        ttl: 20.second, # memoize the state to avoid Redis spam
-        redis_url: "redis://localhost:6379"
-      })
-    end
+DeployPin.setup do
+  groups %w[I II III post rollback]
+  ...
+  deployment_state_transition({
+    ongoing: %w[I III],
+    pending: "rollback", # enters to pending step before "rollback"
+    ttl: 20.second, # memoize the state to avoid Redis spam
+    redis_url: "redis://localhost:6379"
+  })
+end
 
-    # enabled next methods
-    DeployPin.ongoing_deployment?
-    DeployPin.pending_deployment?
+# enabled next methods
+DeployPin.ongoing_deployment?
+DeployPin.pending_deployment?
 ```
 
 Around the deployment
 ```bash
-    bundle exec rake deploy_pin:run[I, II, III] - # enters to ongoing state before "I" and leaves it after "III" so all tasks in I, II, III have DeployPin.oingoing_deployment? == true
-    bundle exec rake deploy_pin:run[rollback] - # enters "pending state"
+bundle exec rake deploy_pin:run[I, II, III] - # enters to ongoing state before "I" and leaves it after "III" so all tasks in I, II, III have DeployPin.oingoing_deployment? == true
+bundle exec rake deploy_pin:run[rollback] - # enters "pending state"
 ```
+## Similar Gems
+- https://github.com/theSteveMitchell/after_party
 
 ## Contributing
 Contribution directions go here.

data/lib/deploy_pin/database.rb

@@ -2,13 +2,8 @@
 
 module DeployPin
   module Database
-    PG_TIMEOUT_STATEMENT = 'SET statement_timeout TO %s'
-    MYSQL_TIMEOUT_STATEMENT = 'SET max_execution_time = %s'
-
     extend self
 
-    def dummy_method; end
-
     # Run a block under a sql maximum timeout.
     #
     # A default timeout will be get from DeployPin.setup
@@ -21,6 +16,7 @@ module DeployPin
     #   # <app root>/deploy_pin/20190401135040_task.rb
     #   # 20190401135040:I
     #   # task_title: Execute some query with timeout
+    #   # affected_areas: none
     #
     #   # === task code goes down here ===
     #   DeployPin::Database::execute_with_timeout do
@@ -67,23 +63,11 @@ module DeployPin
 
       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?
-            PG_TIMEOUT_STATEMENT
-          elsif mysql?
-            MYSQL_TIMEOUT_STATEMENT
-          end
-
-        connection.execute timeout_statement % connection.quote(timeout_in_milliseconds)
-      end
-
-      def postgresql?
-        connection.adapter_name =~ /postg/i
+        connection.execute db_engine::TIMEOUT_STATEMENT % connection.quote(timeout_in_milliseconds)
       end
 
-      def mysql?
-        connection.adapter_name =~ /mysql/i
+      def db_engine
+        @db_engine ||= DeployPin::DatabaseEngine.new(connection).detect
       end
 
       def connection

data/lib/deploy_pin/database_engine.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module DeployPin
+  # This class is used to detect used database engine and managing specific
+  # differences between them.
+  class DatabaseEngine
+    module PostgreSQL
+      TIMEOUT_STATEMENT = 'SET statement_timeout TO %s'
+    end
+
+    module MySQL
+      TIMEOUT_STATEMENT = 'SET max_execution_time = %s'
+    end
+
+    module MariaDB
+      TIMEOUT_STATEMENT = 'SET SESSION max_statement_time = %s'
+    end
+
+    DB_ENGINES_MAPPING = {
+      mariadb: MariaDB,
+      mysql: MySQL,
+      pg: PostgreSQL
+    }.freeze
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def detect
+      db_engine_symbol =
+        case connection.adapter_name
+        when /postg/i then :pg
+        when /mysql/i, /trilogy/i then detect_mysql_based_engine
+        end
+
+      DB_ENGINES_MAPPING[db_engine_symbol]
+    end
+
+    private
+
+      attr_reader :connection
+
+      def detect_mysql_based_engine
+        mariadb? ? :mariadb : :mysql
+      end
+
+      def mariadb?
+        connection.select_value('SELECT VERSION()') =~ /MariaDB/i
+      end
+  end
+end

data/lib/deploy_pin/version.rb

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

data/lib/deploy_pin.rb

@@ -8,20 +8,21 @@ require 'deploy_pin/task'
 require 'deploy_pin/task_criteria'
 require 'deploy_pin/engine'
 require 'deploy_pin/database'
+require 'deploy_pin/database_engine'
 require 'parallel'
 require 'ruby-progressbar'
 require 'colorize'
 
 module DeployPin
   OPTIONS = %i[
-    tasks_path
+    deployment_state_transition
     fallback_group
     groups
-    statement_timeout
-    run_formatter
     list_formatter
+    run_formatter
+    statement_timeout
     task_wrapper
-    deployment_state_transition
+    tasks_path
   ].freeze
 
   DEFAULTS = {

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

@@ -2,6 +2,7 @@
 
 # <%= @identifier %>:<%= @group %><%= @recurring ? ":recurring" : "" %>
 # task_title: <%= @author ? "@#{@author} #{title.titleize}" : "#{title.titleize}" %>
+# affected_areas: none
 
 # === parallel task code goes down here ===
 10.times { DeployPin::Record.create(uuid: "hello") }

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

@@ -2,6 +2,7 @@
 
 # <%= @identifier %>:<%= @group %><%= @recurring ? ":recurring" : "" %>
 # task_title: <%= @author ? "@#{@author} #{title.titleize}" : "#{title.titleize}" %>
+# affected_areas: none
 
 # === task code goes down here ===
 progressbar = ProgressBar.create(title: "Doing stuff", total: 20, format: '%t |%E | %B | %a')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deploy_pin
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Viktor Sych
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2024-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -235,6 +235,7 @@ files:
 - lib/deploy_pin.rb
 - lib/deploy_pin/collector.rb
 - lib/deploy_pin/database.rb
+- lib/deploy_pin/database_engine.rb
 - lib/deploy_pin/deployment_state.rb
 - lib/deploy_pin/engine.rb
 - lib/deploy_pin/parallel_wrapper.rb
@@ -271,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: pin some task around deployment