patches 3.4.0 → 3.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2efd0dc04504ab68ece9ffb46f6e1c2a6adcae93b39dac5824d4cfed34093a99
-  data.tar.gz: 167f4f394fea327cbdf85f9c3e1ac067639abdfd606b2077ec70e5b1bb0a4bbb
+  metadata.gz: 3ef48f4cd04fd29602ab012fab6414c16cece6fa3ecd687f9deac3ff9244bf7b
+  data.tar.gz: f89c55aa18e9f84e77e5a26872896df6b5b0819842e940976b262a5b20e55dda
 SHA512:
-  metadata.gz: 90edf98dc27bdeb176f8075711a2703cad55853ef010ce99b908a63001739d58dfab1ccc002e5ce61e4bbfe0724b4ca08321037b673c20fe529e76bc5a58f535
-  data.tar.gz: 666b762d233f27259f8c33afe2cf2ddb4cff060d313de6795840fac767e14e46401e1c5e8ff321379b4d9f9dbeea4bd00704656e03942ac312bdb3fea13f64a4
+  metadata.gz: 5899f3e9202d2227efd661d38771eef7534ac48414903b1fbd66820631ccf8dd90dcb20b2bc9f8bfbca81375388fe531acacab6dc294c92a621804083fd0b93b
+  data.tar.gz: 59707c3bb9d64ad45971fa7ef2287c346aa72fe6bcb393ed027ddd47ca6202feff2034b5ec30c1a32e5d39041ba4fe2bb2d1ee6ca625aabc58d87978f7e9e7c6

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,7 +6,34 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-## [3.4.0] - 2020-07-21
+## [3.6.2] - 2022-08-10
+
+Fixes incorrect release - tag and published gem back in sync
+
+## [3.6.1] - 2022-08-10
+### Added
+- Github actions to publish to Rubygems upon release
+
+### Fixed
+- Fix `patches:pending` rake task
+
+## [3.6.0] - 2022-05-27
+
+3.6.1 changes were incorrectly published as 3.6.0 but tagged as 3.6.1
+
+### 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
 

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/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/version.rb

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

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.4.0
+  version: 3.6.2
 platform: ruby
 authors:
 - JobReady
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-22 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
@@ -297,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