patches 3.3.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31f20fe803ffb8762b4ebdbdacb5b33564d67eaa24505ffb8fdd25fc88a6198c
-  data.tar.gz: c7fbbb497911d30dd73555a77f8ea946788de6b43110df7afcf6e680f9a349a3
+  metadata.gz: c1f8701526a4dd4b0b2f9468a341fda316bde2dd0ba8b9bf0cea5e4236aa9ee5
+  data.tar.gz: 6b340c8ab529811f011ba4b984f208f2abb080dfe4b97bcbbd2e7fcccf78e92a
 SHA512:
-  metadata.gz: 2b2674ce8e4f2deb2f856e67c32d381bf4007729fad286179b89c0c982c8991b58072c59de133485ea7d9a40071df36778198037569a496a60fa25f4371ce6e1
-  data.tar.gz: 5fee7f04b02862424097a26e51fe6ad376e885637e67aa90f3986942457494900646426a393f3b1a8946fc3fbb748a8bed89619a9cd7e28a2278151a0eefbc34
+  metadata.gz: fa96ce95251d9295cd6544c54d8b2670c1d9f8aab860a50874539662a58e571ae902e400169cf58cfbb0649a980cb29badbb9b0dd65c09c2ecea35bfdd26a823
+  data.tar.gz: 5e08319d65bbd8d940ef2fd79091c0d6780e35878c4881fdc491a119eeb6a4fbb640a675e3d38d386d3a69eddb192f916d617aeb2285ca565ce187f2b1a32709

data/.github/workflows/publish.yml

@@ -0,0 +1,26 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '2.7'
+
+    - name: Publish to RubyGems
+      run: |
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/CHANGELOG.md

@@ -6,6 +6,23 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [3.6.0] - 2022-05-27
+### Added
+- Added `notification_prefix` and `notification_suffix` to configuration options
+- Linked to docs/usage.md in README
+
+### Changed
+- Refactored `Patches::Notifier`
+- `Patches::Notifier.append_tenant_message` effectively replaced by `tenant_suffix`
+
+## [3.5.0] - 2020-07-22
+### Added
+- Enable application version constraint support on `Patches::TenantWorker`
+
+## [3.4.0] - 2020-07-22
+### Added
+- `Patches::TenantWorker` application version constraint forward compatibility
+
 ## [3.3.0] - 2020-07-20
 ### Added
 - Application version constraints

data/README.md

@@ -11,7 +11,7 @@ A simple gem for one off tasks
 
 ## Version 2.0
 
-Please note the breaking change release around deployment. See docs/usage.md for the full change.
+Please note the breaking change release around deployment. See [docs/usage.md](docs/usage.md) for the full change.
 
 TL;DR You need to manually declare the patches task to run in your deploy.rb
 
@@ -32,7 +32,7 @@ Or install it yourself as:
 
 ## Usage
 
-see `docs/usage.md`
+see [docs/usage.md](docs/usage.md)
 
 ## Development
 

data/docs/usage.md

@@ -39,6 +39,15 @@ Patches::Config.configure do |config|
 end
 ```
 
+Additionally, you can override the default prefix and suffix of the
+notification message in the patches config:
+
+```ruby
+  # for example
+  config.notification_prefix = "#{Tenant.current.name}-#{Rails.env}"  # => [READYTECH-STAGING]
+  config.notification_suffix = Tenant.current.name  # => ... patches succeeded for Readytech
+```
+
 ### Running patches in parallel for tenants
 
 If you are using the Apartment gem, you can run the patches for each tenant in parallel.

data/lib/patches/application_version_validation.rb

@@ -0,0 +1,9 @@
+module Patches
+  module ApplicationVersionValidation
+    def valid_application_version?(application_version)
+      return true unless application_version
+      return true unless Patches::Config.configuration.application_version
+      Patches::Config.configuration.application_version == application_version
+    end
+  end
+end

data/lib/patches/config.rb

@@ -16,6 +16,8 @@ module Patches
       class Configuration
         attr_accessor \
           :application_version,
+          :notification_prefix,
+          :notification_suffix,
           :retry_after_version_mismatch_in,
           :sidekiq_options,
           :sidekiq_parallel,

data/lib/patches/notifier.rb

@@ -11,23 +11,32 @@ class Patches::Notifier
     end
 
     def success_message(patches)
-      message = "#{environment_prefix}#{patches.count} patches succeeded"
-      append_tenant_message(message)
+      message(patches.count, "patches succeeded")
     end
 
     def failure_message(patch_path, error)
-      details = "#{Pathname.new(patch_path).basename} failed with error: #{error}"
-      message = "#{environment_prefix}Error applying patch: #{details}"
-      append_tenant_message(message)
+      message("Error applying patch:", Pathname.new(patch_path).basename, "failed with error:", error)
+    end
+
+    def message(*args)
+      [notification_prefix, *args, notification_suffix].compact.join(" ")
+    end
+
+    def notification_prefix
+      prefix = config.notification_prefix.presence || environment_prefix
+      "[#{prefix}]" if prefix.present?
     end
 
     def environment_prefix
-      "[#{Rails.env.upcase}] " if defined?(Rails)
+      Rails.env.upcase if defined?(Rails)
+    end
+
+    def notification_suffix
+      config.notification_suffix.presence || tenant_suffix
     end
 
-    def append_tenant_message(message)
-      message = message + " for tenant: #{Apartment::Tenant.current}" if defined?(Apartment)
-      message
+    def tenant_suffix
+      "for tenant: #{Apartment::Tenant.current}" if defined?(Apartment)
     end
 
     def send_slack_message(message, color)

data/lib/patches/tenant_runner.rb

@@ -11,7 +11,11 @@ class Patches::TenantRunner
     Patches.logger.info("Patches tenant runner for: #{tenants.join(',')}")
     tenants.each do |tenant|
       if parallel?
-        Patches::TenantWorker.perform_async(tenant, path)
+        Patches::TenantWorker.perform_async(
+          tenant,
+          path,
+          application_version: Patches::Config.configuration.application_version
+        )
       else
         run(tenant, path)
       end

data/lib/patches/tenant_worker.rb

@@ -3,10 +3,15 @@ require 'sidekiq'
 class Patches::TenantWorker
   include Sidekiq::Worker
   include Patches::TenantRunConcern
+  include Patches::ApplicationVersionValidation
 
   sidekiq_options Patches::Config.configuration.sidekiq_options
 
-  def perform(tenant_name, path)
-    run(tenant_name, path)
+  def perform(tenant_name, path, params = {})
+    if valid_application_version?(params['application_version'])
+      run(tenant_name, path)
+    else
+      self.class.perform_in(Patches::Config.configuration.retry_after_version_mismatch_in, tenant_name, path, params)
+    end
   end
 end

data/lib/patches/version.rb

@@ -1,6 +1,6 @@
 module Patches
   MAJOR = 3
-  MINOR = 3
+  MINOR = 6
   PATCH = 0
   VERSION = [MAJOR, MINOR, PATCH].compact.join(".").freeze
 end

data/lib/patches/worker.rb

@@ -2,22 +2,15 @@ require 'sidekiq'
 
 class Patches::Worker
   include Sidekiq::Worker
+  include Patches::ApplicationVersionValidation
 
   sidekiq_options Patches::Config.configuration.sidekiq_options
 
   def perform(runner, params = {})
-    if valid_application_version?(params)
+    if valid_application_version?(params['application_version'])
       runner.constantize.new.perform
     else
       self.class.perform_in(Patches::Config.configuration.retry_after_version_mismatch_in, runner, params)
     end
   end
-
-  private
-
-  def valid_application_version?(params)
-    return true unless params['application_version']
-    return true unless Patches::Config.configuration.application_version
-    Patches::Config.configuration.application_version == params['application_version']
-  end
 end

data/lib/patches.rb

@@ -22,6 +22,7 @@ end
 require "patches/base"
 require "patches/config"
 require "patches/tenant_run_concern"
+require "patches/application_version_validation"
 require "patches/tenant_worker" if defined?(Sidekiq)
 require "patches/engine" if defined?(Rails)
 require "patches/patch"

data/lib/tasks/patches.rake

@@ -22,7 +22,7 @@ namespace :patches do
   end
 
   task :pending => [:environment] do
-    Patches::Pending.each do |patch|
+    Patches::Pending.new.each do |patch|
       puts patch
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: patches
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.6.0
 platform: ruby
 authors:
 - JobReady
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2022-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -242,6 +242,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".buildkite/pipeline.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
@@ -261,6 +262,7 @@ files:
 - lib/generators/patches/templates/patch.rb.erb
 - lib/generators/patches/templates/patch_spec.rb.erb
 - lib/patches.rb
+- lib/patches/application_version_validation.rb
 - lib/patches/base.rb
 - lib/patches/capistrano.rb
 - lib/patches/capistrano/tasks.rake
@@ -296,7 +298,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A simple gem for one off tasks