patches 3.6.2 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ef48f4cd04fd29602ab012fab6414c16cece6fa3ecd687f9deac3ff9244bf7b
-  data.tar.gz: f89c55aa18e9f84e77e5a26872896df6b5b0819842e940976b262a5b20e55dda
+  metadata.gz: 895215b6ac8fa6eb09aea79add6efebcead371d5b50579d983b70eff79c58682
+  data.tar.gz: aa05b38f701c0c525364d16f0f22dc7fde9b33c2a34aac240751e78b02d1c3d6
 SHA512:
-  metadata.gz: 5899f3e9202d2227efd661d38771eef7534ac48414903b1fbd66820631ccf8dd90dcb20b2bc9f8bfbca81375388fe531acacab6dc294c92a621804083fd0b93b
-  data.tar.gz: 59707c3bb9d64ad45971fa7ef2287c346aa72fe6bcb393ed027ddd47ca6202feff2034b5ec30c1a32e5d39041ba4fe2bb2d1ee6ca625aabc58d87978f7e9e7c6
+  metadata.gz: e454bd2d14b1cf02eca6fc4bd18d3732c83627032c0a6a2fb76dbf6c43d07da7ee6786f542c8f689290b75deedc48ea8fb1b8eeb0581363fd48e9719a3478e38
+  data.tar.gz: a286831eb61b05d4fbdee99989247671307d3881433e293eacda3afc533b262d0d82d1cb6e098a0c3f4153b01891bd0e4ecece47f235ed36d09715ebb81e3c64

data/CHANGELOG.md

@@ -6,6 +6,127 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [3.7.0] - 2026-09-10
+
+Declares dependencies the gem always relied on, and announces what 4.0 is
+expected to require. No public API changes and no version constraint moves, so
+anything that installed 3.6.x installs this.
+
+### Added
+- Gem metadata (`source_code_uri`, `changelog_uri`, `bug_tracker_uri`,
+  `documentation_uri`). None were declared, so rubygems.org kept showing values
+  carried over from older releases - 3.6.3 still lists `source_code_uri` as
+  `http://github.com/jobready/patches`, from before the org was renamed
+- `activerecord` as an explicit runtime dependency, at the same `>= 3.2` floor
+  as `railties` so nothing currently installable is excluded. `Patches::Patch`
+  subclasses `ActiveRecord::Base` and `Patches::Base#execute` calls
+  `ActiveRecord::Base.connection`, but only `railties` had been declared
+- `Patches.deprecator`, a gem-owned `ActiveSupport::Deprecation` instance rather
+  than the singleton Rails 7.1 deprecated and 8.0 removed. Host applications can
+  silence or redirect it with `Patches.deprecator.behavior = :silence`
+- A deprecation warning when `config.use_slack` is set: from 4.0 Patches will
+  not depend on `slack-notifier`, so only applications using Slack carry it.
+  Add `gem 'slack-notifier'` to your Gemfile to keep notifications working
+- A deprecation warning on `require 'patches/capistrano'`. The Capistrano task
+  is removed in 4.0; invoke `rake patches:run` from your deployment process
+  instead. It remains opt-in and loads nothing unless a Capfile requires it
+- Deprecation warnings for the two other things 4.0 is expected to require:
+  Sidekiq 6.3 or newer, which is where `Sidekiq::Job` arrives, and Ruby 3.2 /
+  Rails 7.2. Those floors are higher than the range CI verifies - Ruby 3.0 and
+  Rails 7.1 still pass - so anyone below them hears about it a release ahead.
+  The Ruby and Rails notice runs from a Rails initializer, after the
+  application's own, so `Patches.deprecator.behavior` can silence it
+
+### Changed
+- The published gem carries only what a consumer needs - 27 files rather than
+  42. `Dockerfile`, `docker-compose.yml`, `.devcontainer/`, `.github/`, `bin/`,
+  `Rakefile`, `RELEASING.md` and a decorative image were being packaged. `lib`,
+  the install migration, `docs/usage.md` and the top-level docs remain
+- The development container works again. It was pinned to `ruby:2.3`, which
+  cannot satisfy the current Gemfile, and had not been touched since 2018. The
+  Ruby version is now a build argument and the gem versions are passed through
+  from the shell, so any cell of the matrix in README.md is reproducible in it.
+  A `.devcontainer/` referencing the same compose service comes with it, for
+  VS Code and Codespaces
+
+### Removed
+- `.github/workflows/publish.yml`. It published on `release: published` using a
+  `GEM_HOST_API_KEY`, had never run in the four years since it was added, and
+  would now attempt a duplicate push if a GitHub Release were created after a
+  tag. Releases come from `.github/workflows/release.yml` - see
+  [RELEASING.md](RELEASING.md)
+
+## [3.6.3] - 2026-09-09
+
+Bug fixes only. No version constraint changes, no API changes and nothing
+removed from the public interface, so anything that installed 3.6.2 installs
+this. First step of a staged modernisation: declaring dependencies and adding
+deprecations comes in 3.7.0, raising minimums in 4.0.0.
+
+### Fixed
+- Sidekiq 7 and 8 compatibility. Strict argument checking, enabled by default
+  from Sidekiq 7, rejected the job arguments the workers enqueued:
+  `patches:run` passed the runner class object itself and `application_version`
+  used a symbol key, so enqueueing raised `ArgumentError: Job arguments to
+  Patches::Worker must be native JSON types`. The task now enqueues the runner
+  class name and the key is a string. The serialised payload is byte-identical
+  to 3.6.2's - the class already reached Redis as `"Patches::Runner"` and the
+  symbol key as `"application_version"` - so in-flight jobs and rolling deploys
+  that mix old and new workers are unaffected
+- The install migration inherited from a bare `ActiveRecord::Migration`, which
+  Rails has refused since 5.0 with "Directly inheriting from
+  ActiveRecord::Migration is not supported", so
+  `rake patches:install:migrations && rake db:migrate` failed on every Rails
+  since. It now declares `ActiveRecord::Migration[5.0]`, which Rails still
+  supports through 8.1, so no minimum moves
+- `Patches.default_path` guarded on `defined?(:Rails)`, which tests a symbol
+  literal and is always true; outside Rails it raised `NameError` instead of
+  returning nil
+
+### Added
+- Specs for the install migration, which shipped with no coverage at all, and
+  for `Patches.sidekiq_job_module`, including its `Sidekiq::Worker` fallback
+- A release workflow and `RELEASING.md`, both matching rdytech/superset-client:
+  pushing a `v`-prefixed tag publishes to RubyGems through trusted publishing,
+  and a tag not reachable from `develop` is refused. It also waits for the
+  version to appear on RubyGems, so a release that does not land fails loudly -
+  `3.6.1` was tagged and released on GitHub but never published, and nothing
+  reported it
+- CI now runs 17 Ruby/Rails combinations (Ruby 3.0-4.0 against Rails 7.1-8.1)
+  in place of a single Ruby 2.7 cell, plus a leg for each Sidekiq state:
+  absent, 6.5, and 7.x/8.x with strict arguments both on and off. Ruby 2.7 and
+  Rails 6.1/7.0 are not exercised, being well past upstream support; they are
+  untested rather than blocked, since no constraint changed. README.md records
+  the verified range and how to check an older combination locally
+
+### Changed
+- The workers resolve their mixin through `Patches.sidekiq_job_module`, which
+  prefers `Sidekiq::Job` (Sidekiq 6.3+) and falls back to `Sidekiq::Worker`, so
+  no Sidekiq version loses support
+- Development dependencies pruned to those actually used: `capybara`,
+  `factory_girl`, `timecop`, `generator_spec`, `byebug` and `database_cleaner`
+  were referenced by no spec, and `rspec-rails` was never required, so plain
+  `rspec` replaces it. `rails`, `sqlite3`, `sidekiq` and `concurrent-ruby` moved
+  to the Gemfile so CI can vary them; the stale `sidekiq ~> 3.4.1` pin is what
+  hid the strict argument incompatibility, and it also held `json` at `~> 1.0`
+- Sidekiq-dependent specs moved under `spec/sidekiq/` so the suite runs with the
+  gem absent
+
+### Known issues
+- The install migration now declares `ActiveRecord::Migration[5.0]`, and
+  `ActiveRecord::Migration.[]` does not exist before Rails 5.0. A *fresh*
+  install on Rails 4.2 or earlier therefore needs `patches_patches` created by
+  hand - the table it wants is a `path` string, timestamps, and a unique index
+  on `path`. Existing installs are unaffected, having already copied the
+  migration into the host application. Those versions are far outside the range
+  CI verifies, and the previous file could not be loaded by any Rails from 5.0
+  on, so this trades an impossible install for an unlikely one
+
+### Removed
+- `lib/generators/patches.rb`, a dead duplicate of the patch generator that
+  wrote to `app/db/` from a template (`patch.erb`) that does not exist. Not
+  reachable through Rails' generator lookup, so not part of the public interface
+
 ## [3.6.2] - 2022-08-10
 
 Fixes incorrect release - tag and published gem back in sync

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2015 JobReady
+Copyright (c) 2015 ReadyTech
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,52 +1,216 @@
 # Patches
-[![Build status](https://badge.buildkite.com/4f3df3f3458bcc933dc44cab6c136af5c3bbdd9f761f1a99ff.svg)](https://buildkite.com/jobready/patches)
-[![Maintainability](https://api.codeclimate.com/v1/badges/39d142050017ffeb2564/maintainability)](https://codeclimate.com/repos/557f93b76956807f81000001/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/39d142050017ffeb2564/test_coverage)](https://codeclimate.com/repos/557f93b76956807f81000001/test_coverage)
+[![Run specs](https://github.com/rdytech/patches/actions/workflows/specs.yml/badge.svg)](https://github.com/rdytech/patches/actions/workflows/specs.yml)
 [![Gem Version](https://badge.fury.io/rb/patches.svg)](https://badge.fury.io/rb/patches)
 
 ![patches](docs/patches.jpg)
 
+A simple gem for one off tasks - the things that do not belong in a schema
+migration. Back-filling a column, correcting bad data, kicking off a one-time
+import: write it as a class, deploy it, and Patches runs it once and records
+that it ran.
 
-A simple gem for one off tasks
+## Installation
 
-## Version 2.0
+Add the gem to your application's Gemfile:
 
-Please note the breaking change release around deployment. See [docs/usage.md](docs/usage.md) for the full change.
+```ruby
+gem 'patches'
+```
 
-TL;DR You need to manually declare the patches task to run in your deploy.rb
+Then install the migration that records which patches have run:
 
-## Installation
+```
+bundle exec rake patches:install:migrations
+bundle exec rake db:migrate
+```
+
+## Usage
 
-Add this line to your application's Gemfile:
+Generate a patch:
+
+```
+bundle exec rails g patches:patch PreferenceUpdate
+```
+
+Fill in `run`:
 
 ```ruby
-gem 'patches'
+class PreferenceUpdate < Patches::Base
+  def run
+    User.where(preference: nil).update_all(preference: 'default')
+  end
+end
 ```
-And then execute:
 
-    $ bundle
+Run the pending ones - each patch runs once, and is recorded in
+`patches_patches`:
 
-Or install it yourself as:
+```
+bundle exec rake patches:run
+```
 
-    $ gem install patches
+`rake patches:pending` lists what has not run yet. Patches can run inline or in
+the background via Sidekiq, across all tenants when you use Apartment, and
+report to Slack. See [docs/usage.md](docs/usage.md) for configuration, tenants,
+deployment and the Capistrano task.
 
-## Usage
+## Compatibility
+
+This release changes no version constraint: the gemspec still requires only
+`railties >= 3.2` and sets no Ruby floor, so anything that installed 3.6.2
+installs 3.6.3. The table is what CI verifies, which is narrower than what the
+gem permits - older Ruby and Rails are untested here, not blocked.
+
+| | Rails 7.1 | Rails 7.2 | Rails 8.0 | Rails 8.1 |
+|---|---|---|---|---|
+| **Ruby 3.0** | ✅ | | | |
+| **Ruby 3.1** | ✅ | ✅ | | |
+| **Ruby 3.2** | ✅ | ✅ | ✅ | ✅ |
+| **Ruby 3.3** | ✅ | ✅ | ✅ | ✅ |
+| **Ruby 3.4** | | ✅ | ✅ | ✅ |
+| **Ruby 4.0** | | ✅ | ✅ | ✅ |
+
+A blank cell is a pairing Rails itself does not support. Ruby 2.7 and Rails
+6.1/7.0 are deliberately not exercised - they are well past upstream support -
+though the gem still installs and, as of this release, passes on them.
+
+Ruby 4.0 is newer than all of these Rails releases, so those cells record that
+Patches is verified on it, not that Rails claims support for it.
+
+### Sidekiq
+
+Sidekiq is an **optional** integration, not a runtime dependency: Patches runs
+each patch inline when Sidekiq is absent. Set `config.use_sidekiq = true` to run
+them in the background - see [docs/usage.md](docs/usage.md).
+
+The workers resolve their mixin at load time via `Patches.sidekiq_job_module`,
+preferring `Sidekiq::Job` (the name Sidekiq has used since 6.3) and falling back
+to `Sidekiq::Worker`, so older Sidekiq keeps working. CI covers each state a
+consumer can be in:
+
+| State | Covered by |
+|---|---|
+| Sidekiq not installed | A leg omitting the gem entirely, exercising the `defined?(Sidekiq)` guards |
+| Installed, strict arguments on | Sidekiq 7.x and 8.x at their default (`:raise`) |
+| Installed, strict arguments off | Sidekiq 7.x and 8.x with `Sidekiq.strict_args!(false)` |
+| Older Sidekiq | A 6.5 leg, plus a spec covering the `Sidekiq::Worker` fallback |
+
+### Running one combination locally
+
+The Gemfile reads the same variables CI sets, so any cell above is reproducible.
+Bundler re-evaluates the Gemfile on every invocation, so **export** them rather
+than prefixing a single command — otherwise `bundle exec` silently resolves the
+defaults and you test something other than what you intended:
+
+```
+export RAILS_VERSION="~> 8.0.0"
+
+bundle install
+bundle exec rspec
+```
+
+Without Sidekiq at all, which is what a consumer that does not use it gets:
+
+```
+export SIDEKIQ_VERSION=none
+
+bundle install
+bundle exec rspec --exclude-pattern "sidekiq/**/*_spec.rb"
+```
 
-see [docs/usage.md](docs/usage.md)
+With Sidekiq 7 and strict argument checking turned off:
+
+```
+export SIDEKIQ_VERSION="~> 7.0" SIDEKIQ_STRICT_ARGS=false
+
+bundle install
+bundle exec rspec
+```
+
+Rails 6.1 and 7.0 need two extra pins if you do want to check them, neither
+caused by Patches — Rails <= 7.0 pins its sqlite3 adapter to `~> 1.4`, and Rails
+< 7.1 predates `concurrent-ruby` 1.3.5 removing a `Logger` constant it relies
+on:
+
+```
+export RAILS_VERSION="~> 6.1.0" \
+       SQLITE3_VERSION="~> 1.4" \
+       CONCURRENT_RUBY_VERSION="< 1.3.5"
+
+bundle install
+bundle exec rspec
+```
+
+`unset` the variables (or use a fresh shell) before running the default
+combination again, and delete `test.db` when switching between them: the suite
+creates `patches_patches` only when it is missing, so a database left by an
+earlier run can mask ordering problems.
+
+## Deprecations
+
+3.7.0 introduces no breaking changes. It announces what 4.0 is expected to
+require, so the upgrade is uneventful. Each warning names its replacement and
+goes through the gem's own deprecator, which a host application can silence or
+redirect:
+
+```ruby
+Patches.deprecator.behavior = :silence  # or :raise, :log, a lambda...
+```
+
+| Deprecated | Replacement |
+|---|---|
+| Relying on Patches to install `slack-notifier` | Add `gem 'slack-notifier'` to your Gemfile if you use `config.use_slack`. From 4.0 only applications that want it carry it |
+| `require 'patches/capistrano'` | Invoke `rake patches:run` from your deployment process. The Capistrano task is removed in 4.0 |
+| Sidekiq older than 6.3 | Any supported Sidekiq (7.x or 8.x). 4.0 is expected to include `Sidekiq::Job` directly instead of falling back to `Sidekiq::Worker` |
+| Ruby older than 3.2, Rails older than 7.2 | Ruby 3.2+ and Rails 7.2+. 4.0 is expected to raise the gemspec floors to these, which are higher than the range CI verifies today |
+
+Nothing is removed in this release, and the gemspec floors are unchanged, so
+anything that installed 3.6.x installs 3.7.0.
 
 ## Development
 
+In VS Code or Codespaces, open the repository in the dev container - it reuses
+the `app` service from `docker-compose.yml`, so there is one definition of the
+environment rather than two. Otherwise, from a shell:
+
+```
+docker compose build
+docker compose run --rm app
+```
+
+The container's default command runs the specs. Any cell of the matrix above is
+reproducible in it: the Ruby version is a build argument, and the gem versions
+are passed through from your shell. The image is built with the default
+versions, so a non-default cell has to install them first:
+
 ```
-docker-compose build
-docker-compose run app bundle exec rspec
+docker compose build --build-arg RUBY_VERSION=3.1
+
+RAILS_VERSION="~> 7.1.0" docker compose run --rm app \
+  sh -c 'bundle install && bundle exec rspec'
+
+SIDEKIQ_VERSION=none docker compose run --rm app \
+  sh -c 'bundle install && bundle exec rspec --exclude-pattern "sidekiq/**/*_spec.rb"'
+```
+
+Or without Docker, if you have the Ruby you want on your path:
+
+```
+bundle install
+bundle exec rspec
 ```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org/gems/patches).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Releasing
+
+Releases are published by GitHub Actions from a `vX.Y.Z` tag — see
+[RELEASING.md](RELEASING.md).
 
 ## Contributing
 
-1. Fork it ( https://github.com/jobready/patches/fork )
+1. Fork it ( https://github.com/rdytech/patches/fork )
 2. Create your feature branch (`git checkout -b feature/my-feature-name`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin feature/my-new-feature`)
-5. Create a new Pull Request
+5. Create a new Pull Request against `develop`

data/db/migrate/201506011700_create_patch.rb

@@ -1,4 +1,4 @@
-class CreatePatch < ActiveRecord::Migration
+class CreatePatch < ActiveRecord::Migration[5.0]
   def change
     create_table :patches_patches do |t|
       t.string :path, null: false

data/docs/usage.md

@@ -22,6 +22,10 @@ bundle exec rake db:migrate
 
 ## Configuration
 
+> **Note.** From 4.0 Patches will not depend on `slack-notifier`, so only
+> applications using Slack carry it. If you set `config.use_slack`, add
+> `gem 'slack-notifier'` to your Gemfile.
+
 If you would like to run the patches asynchronously, or would like them to notify
 your Slack channel when they fail or succeed, you need to set up
 an initializer to set those options.
@@ -113,6 +117,11 @@ bundle exec rake patches:run
 
 Patches will only ever run once, patches will run in order of creation date.
 
+### Capistrano
+
+> **Deprecated.** `patches/capistrano` is removed in 4.0. Invoke
+> `rake patches:run` from your deployment process instead.
+
 To run patches on deployment using Capistrano, edit your Capfile and add
 
 ```ruby

data/lib/patches/capistrano.rb

@@ -1 +1,5 @@
+require 'patches/deprecation'
+
+Patches.warn_capistrano_support_removed_in_4_0
+
 load File.expand_path("capistrano/tasks.rake", File.dirname(__FILE__))

data/lib/patches/config.rb

@@ -1,3 +1,5 @@
+require 'patches/deprecation'
+
 module Patches
   class Config
     class << self
@@ -30,6 +32,18 @@ module Patches
           @sidekiq_queue = 'default'
         end
 
+        # Warns only for applications that enable Slack, and only the first time
+        # - an initializer that reloads, or configures twice, should not repeat
+        # the notice.
+        def use_slack=(enabled)
+          if enabled && !@warned_about_slack_notifier
+            @warned_about_slack_notifier = true
+            Patches.warn_slack_notifier_dependency_removed_in_4_0
+          end
+
+          @use_slack = enabled
+        end
+
         def sidekiq_options
           @sidekiq_options ||= { retry: false, queue: sidekiq_queue }
         end

data/lib/patches/deprecation.rb

@@ -0,0 +1,48 @@
+require 'active_support/deprecation'
+
+module Patches
+  # A gem-owned deprecator rather than ActiveSupport::Deprecation's singleton,
+  # which Rails 7.1 deprecated and 8.0 removed. Host applications can silence or
+  # redirect it: Patches.deprecator.behavior = :silence.
+  def self.deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new('4.0', 'patches')
+  end
+
+  # The floors 4.0 is expected to set. Deliberately higher than what CI verifies
+  # today - Ruby 3.0 and Rails 7.1 still pass - so consumers on those versions
+  # hear about it a release ahead rather than at upgrade time.
+  MINIMUM_RUBY_IN_4_0 = '3.2'.freeze
+  MINIMUM_RAILS_IN_4_0 = '7.2'.freeze
+
+  def self.warn_slack_notifier_dependency_removed_in_4_0
+    deprecator.warn(
+      'patches will stop depending on slack-notifier in 4.0, so that only ' \
+      "applications using Slack carry it. Add gem 'slack-notifier' to your " \
+      'Gemfile to keep notifications working.'
+    )
+  end
+
+  def self.warn_capistrano_support_removed_in_4_0
+    deprecator.warn(
+      'patches/capistrano is deprecated and will be removed in 4.0. Invoke ' \
+      '`rake patches:run` from your deployment process instead.'
+    )
+  end
+
+  def self.warn_about_versions_dropped_in_4_0
+    if Gem::Version.new(RUBY_VERSION) < Gem::Version.new(MINIMUM_RUBY_IN_4_0)
+      deprecator.warn(
+        "Ruby #{RUBY_VERSION} will not be supported by patches 4.0, which is " \
+        "expected to require Ruby >= #{MINIMUM_RUBY_IN_4_0}."
+      )
+    end
+
+    return unless defined?(::Rails::VERSION::STRING)
+    return if Gem::Version.new(::Rails::VERSION::STRING) >= Gem::Version.new(MINIMUM_RAILS_IN_4_0)
+
+    deprecator.warn(
+      "Rails #{::Rails::VERSION::STRING} will not be supported by patches 4.0, " \
+      "which is expected to require Rails >= #{MINIMUM_RAILS_IN_4_0}."
+    )
+  end
+end

data/lib/patches/engine.rb

@@ -3,5 +3,14 @@ require 'rails/engine'
 module Patches
   class Engine < Rails::Engine
     isolate_namespace Patches
+
+    # After the application's own initializers, so that a host which sets
+    # Patches.deprecator.behavior in config/initializers can actually silence
+    # this. Warning at require time - which happens during Bundler.require,
+    # before any initializer - meant the documented mechanism could not work.
+    # It also means Rails::VERSION is always loaded by the time we look.
+    initializer 'patches.version_deprecations', after: :load_config_initializers do
+      Patches.warn_about_versions_dropped_in_4_0
+    end
   end
 end

data/lib/patches/sidekiq_job.rb

@@ -0,0 +1,18 @@
+require 'sidekiq'
+require 'patches/deprecation'
+
+module Patches
+  # Sidekiq renamed Sidekiq::Worker to Sidekiq::Job in 6.3 and still ships the
+  # old name as a deprecated alias. Resolving it at include time keeps the
+  # workers working on every Sidekiq this gem has ever supported, so the change
+  # needs no version bump from consumers.
+  def self.sidekiq_job_module
+    return ::Sidekiq::Job if defined?(::Sidekiq::Job)
+
+    deprecator.warn(
+      'Sidekiq older than 6.3 does not provide Sidekiq::Job; patches 4.0 is ' \
+      'expected to require it. Upgrade Sidekiq, which supports 7.x and 8.x.'
+    )
+    ::Sidekiq::Worker
+  end
+end

data/lib/patches/tenant_runner.rb

@@ -13,8 +13,10 @@ class Patches::TenantRunner
       if parallel?
         Patches::TenantWorker.perform_async(
           tenant,
-          path,
-          application_version: Patches::Config.configuration.application_version
+          # Sidekiq 7+ rejects anything that is not a native JSON type, and a
+          # path is commonly a Pathname (Patches.default_path returns one).
+          path && path.to_s,
+          'application_version' => Patches::Config.configuration.application_version
         )
       else
         run(tenant, path)

data/lib/patches/tenant_worker.rb

@@ -1,13 +1,15 @@
-require 'sidekiq'
+require 'active_support/core_ext/hash/keys'
+require 'patches/sidekiq_job'
 
 class Patches::TenantWorker
-  include Sidekiq::Worker
+  include Patches.sidekiq_job_module
   include Patches::TenantRunConcern
   include Patches::ApplicationVersionValidation
 
   sidekiq_options Patches::Config.configuration.sidekiq_options
 
   def perform(tenant_name, path, params = {})
+    params = (params || {}).stringify_keys
     if valid_application_version?(params['application_version'])
       run(tenant_name, path)
     else

data/lib/patches/version.rb

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

data/lib/patches/worker.rb

@@ -1,12 +1,14 @@
-require 'sidekiq'
+require 'active_support/core_ext/hash/keys'
+require 'patches/sidekiq_job'
 
 class Patches::Worker
-  include Sidekiq::Worker
+  include Patches.sidekiq_job_module
   include Patches::ApplicationVersionValidation
 
   sidekiq_options Patches::Config.configuration.sidekiq_options
 
   def perform(runner, params = {})
+    params = (params || {}).stringify_keys
     if valid_application_version?(params['application_version'])
       runner.constantize.new.perform
     else

data/lib/patches.rb

@@ -2,7 +2,7 @@ require "patches/version"
 
 module Patches
   def self.default_path
-    Rails.root.join('db/patches/') if defined?(:Rails)
+    Rails.root.join('db/patches/') if defined?(Rails)
   end
 
   def self.class_name(path)
@@ -19,10 +19,12 @@ module Patches
   end
 end
 
+require "patches/deprecation"
 require "patches/base"
 require "patches/config"
 require "patches/tenant_run_concern"
 require "patches/application_version_validation"
+require "patches/sidekiq_job" if defined?(Sidekiq)
 require "patches/tenant_worker" if defined?(Sidekiq)
 require "patches/engine" if defined?(Rails)
 require "patches/patch"

data/lib/tasks/patches.rake

@@ -9,8 +9,8 @@ namespace :patches do
 
     if defined?(Sidekiq) && Patches::Config.configuration.use_sidekiq
       Patches::Worker.perform_async(
-        runner,
-        application_version: Patches::Config.configuration.application_version
+        runner.name,
+        'application_version' => Patches::Config.configuration.application_version
       )
     else
       runner.new.perform

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: patches
 version: !ruby/object:Gem::Version
-  version: 3.6.2
+  version: 3.7.0
 platform: ruby
 authors:
-- JobReady
-autorequire: 
+- ReadyTech
 bindir: exe
 cert_chain: []
-date: 2022-08-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -24,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: slack-notifier
   requirement: !ruby/object:Gem::Requirement
@@ -42,142 +55,64 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.5
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-- !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.3.0
-- !ruby/object:Gem::Dependency
-  name: generator_spec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: factory_girl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '0.17'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 4.5.0
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '0.17'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -192,20 +127,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sidekiq
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.4.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.4.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -220,44 +141,18 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  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: A simple gem for one off tasks for example database patches
 email:
-- ruby_gems@jobready.com.au
+- ruby_gems@readytech.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".buildkite/pipeline.yml"
-- ".github/workflows/publish.yml"
-- ".gitignore"
-- ".rspec"
 - CHANGELOG.md
-- Dockerfile
-- Gemfile
 - LICENSE.md
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - db/migrate/201506011700_create_patch.rb
-- docker-compose.yml
-- docs/patches.jpg
 - docs/usage.md
-- lib/generators/patches.rb
 - lib/generators/patches/patch_generator.rb
 - lib/generators/patches/templates/patch.rb.erb
 - lib/generators/patches/templates/patch_spec.rb.erb
@@ -267,23 +162,27 @@ files:
 - lib/patches/capistrano.rb
 - lib/patches/capistrano/tasks.rake
 - lib/patches/config.rb
+- lib/patches/deprecation.rb
 - lib/patches/engine.rb
 - lib/patches/notifier.rb
 - lib/patches/patch.rb
 - lib/patches/pending.rb
 - lib/patches/runner.rb
+- lib/patches/sidekiq_job.rb
 - lib/patches/tenant_run_concern.rb
 - lib/patches/tenant_runner.rb
 - lib/patches/tenant_worker.rb
 - lib/patches/version.rb
 - lib/patches/worker.rb
 - lib/tasks/patches.rake
-- patches.gemspec
-homepage: http://github.com/jobready/patches
+homepage: https://github.com/rdytech/patches
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/rdytech/patches
+  changelog_uri: https://github.com/rdytech/patches/blob/v3.7.0/CHANGELOG.md
+  bug_tracker_uri: https://github.com/rdytech/patches/issues
+  documentation_uri: https://github.com/rdytech/patches/blob/v3.7.0/docs/usage.md
 rdoc_options: []
 require_paths:
 - lib
@@ -298,8 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A simple gem for one off tasks
 test_files: []

data/.buildkite/pipeline.yml

@@ -1,24 +0,0 @@
-steps:
-  - label: ':hammer: Tests'
-    plugins:
-      docker-compose:
-        run: app
-    command: 'bundle exec rspec'
-    agents:
-      queue: docker-heavy
-    artifact_paths: 'coverage/.resultset.json'
-
-  - wait
-
-  - command: "Report CodeClimate Coverage"
-    label: ":codeclimate: Report coverage"
-    plugins:
-      jobready/codeclimate-test-reporter#v2.0:
-        prefix: /app
-        artifact: "coverage/.resultset*.json"
-        input_type: simplecov
-        parts: 1
-    env:
-      CC_TEST_REPORTER_ID:
-    agents:
-      queue: docker-heavy

data/.github/workflows/publish.yml

@@ -1,26 +0,0 @@
-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/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/coverage/
-/test.db
-/*.gem
-.byebug_history

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/Dockerfile

@@ -1,9 +0,0 @@
-FROM ruby:2.3
-
-RUN touch ~/.gemrc && echo "gem: --no-ri --no-rdoc" >> ~/.gemrc
-
-WORKDIR /app/
-ADD . /app/
-RUN bundle install
-
-CMD bundle exec rake -T

data/Gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-gem "rails", "~> 4.1"

data/Rakefile

@@ -1,2 +0,0 @@
-require "bundler/gem_tasks"
-

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "patches"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -1,11 +0,0 @@
-version: '3.2'
-services:
-  app:
-    build: .
-    volumes:
-      - .:/app
-      - app-gems:/usr/local/bundle
-
-volumes:
-  app-gems:
-    driver: local

data/lib/generators/patches.rb

@@ -1,22 +0,0 @@
-module Patches
-  module Generators
-    class PatchGenerator < Rails::Generators::NamedBase
-      desc 'Adds an empty patch'
-      source_root File.expand_path('../templates', __FILE__)
-
-      def generate_patch
-        template "patch.erb", "app/db/#{file_name}.rb"
-      end
-
-      private
-
-      def class_name
-        name.camelize
-      end
-
-      def file_name
-        name.underscore
-      end
-    end
-  end
-end

data/patches.gemspec

@@ -1,39 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'patches/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "patches"
-  spec.version       = Patches::VERSION
-  spec.authors       = ["JobReady"]
-  spec.email         = ["ruby_gems@jobready.com.au"]
-
-  spec.licenses    = ['MIT']
-  spec.summary       = %q{A simple gem for one off tasks}
-  spec.description   = %q{A simple gem for one off tasks for example database patches}
-  spec.homepage      = "http://github.com/jobready/patches"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "railties", ">= 3.2"
-  spec.add_dependency "slack-notifier"
-
-  spec.add_development_dependency "bundler", "~> 1.8"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "sqlite3", "~> 1.3.5"
-  spec.add_development_dependency "rspec-rails", "~> 4.0.0"
-  spec.add_development_dependency "capybara", "~> 2.3.0"
-  spec.add_development_dependency "generator_spec", "~> 0.9.0"
-  spec.add_development_dependency "simplecov", "~> 0.10"
-  spec.add_development_dependency "factory_girl", "~> 4.5.0"
-  spec.add_development_dependency "timecop", "~> 0.7.0"
-  spec.add_development_dependency "database_cleaner", "~> 1.3.0"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "sidekiq", "~> 3.4.1"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "byebug"
-end