sidekiq_publisher 1.8.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b87dcb63524894c48e9a75cb8ed5773fddaa897e599fbb0f9c18c2fc06d7c30e
-  data.tar.gz: f8656103322b18569ee5f5ca131e1a40348d3f7d686eb3d3f22b9481a816d89a
+  metadata.gz: aa63cc2e02febd7a4fe0da8a1deba89df521cf9df46d453626ee80c45cb441c1
+  data.tar.gz: 8c4ba92a29040892080f1b0248dfec8a6f1193063f054c48d6736e3fc15a9e40
 SHA512:
-  metadata.gz: 11199b4b29998e62288777547706a6c545b2c0a2d74bf883a5ed5264031edca7d259fb702e131e473865aaff7f447d1fbdccb6c48a5786b3cda21dba23636afc
-  data.tar.gz: 2789c1e753de096ce9b42a964e0daea6df2e542430d4ff8bd775eedae5db26ec5bf4ea17cfde021870d0f1c41869ce068d9f3230f3494a94fc3ec561d839a666
+  metadata.gz: '01874b1f9cad7364bf28af24830f62278c3e6aea796a5af4b66ca1fc5c3a63806f48fe3a44892f40c18759dabe58f825d444f28fb48f7b76777440c988120728'
+  data.tar.gz: 9c1c712c199f2abc7fa86c61d9739c1739d78200978071cb0b4ee0cb470091c5d84cf310f0a523f5cb31c98b87ed0ef2afd42ca61d3d743c7f605dde45b32663

data/Appraisals

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-appraise "rails-5.1" do
-  gem "activejob", "~> 5.1.6"
-  gem "activesupport", "~> 5.1.6"
-end
-
 appraise "rails-5.2-sidekiq-5.0" do
   gem "activejob", "~> 5.2.0"
   gem "activesupport", "~> 5.2.0"
@@ -35,6 +30,18 @@ appraise "rails-5.2-sidekiq-6.1" do
   gem "sidekiq", "~> 6.1.0"
 end
 
+appraise "rails-5.2-sidekiq-6.2" do
+  gem "activejob", "~> 5.2.0"
+  gem "activesupport", "~> 5.2.0"
+  gem "sidekiq", "~> 6.2.0"
+end
+
+appraise "rails-5.2-sidekiq-6.3" do
+  gem "activejob", "~> 5.2.0"
+  gem "activesupport", "~> 5.2.0"
+  gem "sidekiq", "~> 6.3.0"
+end
+
 appraise "rails-6.0-sidekiq-5.2" do
   gem "activejob", "~> 6.0.0"
   gem "activesupport", "~> 6.0.0"
@@ -53,6 +60,18 @@ appraise "rails-6.0-sidekiq-6.1" do
   gem "sidekiq", "~> 6.1.0"
 end
 
+appraise "rails-6.0-sidekiq-6.2" do
+  gem "activejob", "~> 6.0.0"
+  gem "activesupport", "~> 6.0.0"
+  gem "sidekiq", "~> 6.2.0"
+end
+
+appraise "rails-6.0-sidekiq-6.3" do
+  gem "activejob", "~> 6.0.0"
+  gem "activesupport", "~> 6.0.0"
+  gem "sidekiq", "~> 6.3.0"
+end
+
 appraise "rails-6.1-sidekiq-5.2" do
   gem "activejob", "~> 6.1.0"
   gem "activesupport", "~> 6.1.0"
@@ -70,3 +89,15 @@ appraise "rails-6.1-sidekiq-6.1" do
   gem "activesupport", "~> 6.1.0"
   gem "sidekiq", "~> 6.1.0"
 end
+
+appraise "rails-6.1-sidekiq-6.2" do
+  gem "activejob", "~> 6.1.0"
+  gem "activesupport", "~> 6.1.0"
+  gem "sidekiq", "~> 6.2.0"
+end
+
+appraise "rails-6.1-sidekiq-6.3" do
+  gem "activejob", "~> 6.1.0"
+  gem "activesupport", "~> 6.1.0"
+  gem "sidekiq", "~> 6.3.0"
+end

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # sidekiq_publisher
 
+## 2.1.0
+- Add support for sidekiq `7.0.0` by using `Sidekiq::Job` instead of
+  `Sidekiq::Worker` in sidekiq `>= 6.3.0` to handle name changes outlined in
+  mperham/sidekiq#4971 and first introduced in 6.2.2.
+
+## 2.0.1
+- Changing the `Job#args` validator to be a manual check instead of using the `exclusions` validator.  This is to fix an issue introduced with rails 6.1 and the condition of `in: [nil]`.  More details [here](https://github.com/rails/rails/issues/41051).
+
+## v2.0.0
+- Transition from defining a Railtie to becoming a Rails Engine
+  [(#44)](https://github.com/ezcater/sidekiq_publisher/pull/44). This change was
+  made to better support Ruby 3.0 and Rails 6.1. The change is *not* expected to
+  be breaking but it does represent a major change in the gem's implementation
+  and that is the reason for the major version bump.
+- Require Ruby 2.6 or later.
+
 ## v1.8.0
 - Extend support to Rails 6.1.
 

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ezcater-production.jfrog.io/ruby:f08726283c
+FROM ezcater-production.jfrog.io/ruby:90790156c4
 RUN mkdir /usr/src/gem
 WORKDIR /usr/src/gem
 ADD . /usr/src/gem

data/README.md

@@ -138,22 +138,23 @@ end
 
 #### ActiveJob Exception Reporting
 
-Many exception monitoring service (e.g. Sentry, Airbrake, Honeybadger, etc) already provide basic integration support for `Sidekiq`. 
-These integration should also work with `SidekiqPublisher`. 
-However, you may need to explicitly include 
+Many exception monitoring service (e.g. Sentry, Airbrake, Honeybadger, etc) already provide basic integration support for `Sidekiq`.
+These integration should also work with `SidekiqPublisher`.
+However, you may need to explicitly include
 `ActiveJob::QueueAdapters::SidekiqPublisherAdapter` as a compatible adapter for this to work properly.
 
 Alternatively, you can manually report the exception:
 
  ```ruby
 retry_on SomeError, attempts: 10 do |_job, exception|
-  Raven.capture_exception(exception, extra: { custom: :foo }) # Reporting using the Sentry gem 
+  Raven.capture_exception(exception, extra: { custom: :foo }) # Reporting using the Sentry gem
 end
 ```
 
 ### SidekiqPublisher::Worker
 
-Sidekiq workers are usually defined by including `Sidekiq::Worker` in a class.
+Sidekiq workers are usually defined by including `Sidekiq::Job` or
+`Sidekiq::Worker` in a class.
 
 To use the `SidekiqPublisher`, this can be replaced by including
 `SidekiqPublisher::Worker`. The usual `perform_async`, etc methods will be

data/{lib → app/models}/sidekiq_publisher/job.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "active_record"
-
 module SidekiqPublisher
   class Job < ActiveRecord::Base
     self.table_name = "sidekiq_publisher_jobs"
@@ -12,7 +10,11 @@ module SidekiqPublisher
     before_save :ensure_string_job_class
 
     validates :job_class, presence: true
-    validates :args, exclusion: { in: [nil] }
+    # This exclusion rule currently has a bug in rails 6.1. For now, we will use a manual implementation
+    # Github Issue: https://github.com/rails/rails/issues/41051
+    # Possible PR: https://github.com/rails/rails/pull/41412
+    # validates :args, exclusion: { in: [nil] }
+    validate :args_not_nil
 
     scope :unpublished, -> { where(published_at: nil) }
     scope :published, -> { where.not(published_at: nil) }
@@ -56,6 +58,10 @@ module SidekiqPublisher
 
     private
 
+    def args_not_nil
+      errors.add(:args, "is reserved") if args.nil?
+    end
+
     def ensure_job_id
       self.job_id ||= self.class.generate_sidekiq_jid
     end

data/docker-compose.yml

@@ -7,6 +7,7 @@ x-environment: &default-environment
   BUNDLE_IGNORE_CONFIG: 1
   BUNDLE_DISABLE_SHARED_GEMS: "true"
   PGUSER: postgres
+  PGPASSWORD: postgres
   PGHOST: sidekiq-publisher-postgres
   PGPORT: 5432
   PGDATABASE: sidekiq_publisher_test
@@ -28,9 +29,10 @@ services:
     image: redis:5.0.9-alpine
   sidekiq-publisher-postgres:
     container_name: sidekiq-publisher-postgres_1
-    image: postgres:11.6
+    image: postgres:12.6
     environment:
       POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
       POSTGRES_DB: sidekiq_publisher_test
   sidekiq-publisher-console:
     <<: *default-service

data/gemfiles/{rails_5.1.gemfile → rails_5.2_sidekiq_6.2.gemfile}

@@ -2,7 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "activejob", "~> 5.1.6"
-gem "activesupport", "~> 5.1.6"
+gem "activejob", "~> 5.2.0"
+gem "activesupport", "~> 5.2.0"
+gem "sidekiq", "~> 6.2.0"
 
 gemspec path: "../"

data/gemfiles/rails_6.0_sidekiq_6.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activejob", "~> 6.0.0"
+gem "activesupport", "~> 6.0.0"
+gem "sidekiq", "~> 6.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_6.1_sidekiq_6.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activejob", "~> 6.1.0"
+gem "activesupport", "~> 6.1.0"
+gem "sidekiq", "~> 6.2.0"
+
+gemspec path: "../"

data/lib/active_job/queue_adapters/sidekiq_publisher_adapter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_job/queue_adapters/sidekiq_adapter"
+require "active_support/core_ext/object/blank"
 
 module ActiveJob
   module QueueAdapters

data/lib/sidekiq_publisher/compatibility.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SidekiqPublisher
+  module Compatibility
+    class << self
+      # Sidekiq::Worker will be renamed to Sidekiq::Job in sidekiq 7.0.0 and a
+      # deprecation warning will be printed in sidekiq 6.4.0, per
+      # mperham/sidekiq#4971. Sidekiq 6.2.2 (mperham/sidekiq@8e36432) introduces
+      # an alias and 6.3.0 includes it when the gem is loaded. This alias is
+      # used here to ensure future compatibility.
+      def sidekiq_job_class
+        @_sidekiq_job_class ||= Gem::Dependency.new("sidekiq", ">= 6.3.0").then do |dependency|
+          if dependency.match?(Gem.loaded_specs["sidekiq"])
+            Sidekiq::Job
+          else
+            Sidekiq::Worker
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq_publisher/{railtie.rb → engine.rb}

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
 module SidekiqPublisher
-  class Railtie < Rails::Railtie
-    rake_tasks do
-      load "sidekiq_publisher/tasks.rake"
-    end
+  class Engine < Rails::Engine
+    isolate_namespace SidekiqPublisher
 
     initializer "sidekiq_publisher.configure" do
       SidekiqPublisher.logger = Rails.logger

data/lib/sidekiq_publisher/metrics_reporter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_support/subscriber"
+require "active_support/core_ext/object/try"
 
 module SidekiqPublisher
   module MetricsReporter

data/lib/sidekiq_publisher/publisher.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "sidekiq_publisher/client"
-require "active_support/core_ext/object/try"
+require "active_support/core_ext/object/blank"
 
 module SidekiqPublisher
   class Publisher

data/lib/sidekiq_publisher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqPublisher
-  VERSION = "1.8.0"
+  VERSION = "2.1.0"
 end

data/lib/sidekiq_publisher/worker.rb

@@ -3,7 +3,7 @@
 module SidekiqPublisher
   module Worker
     def self.included(base)
-      base.include(Sidekiq::Worker)
+      base.include(SidekiqPublisher::Compatibility.sidekiq_job_class)
       base.singleton_class.public_send(:alias_method, :sidekiq_client_push, :client_push)
       base.extend(ClassMethods)
     end

data/lib/sidekiq_publisher.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
 require "active_support"
+require "active_support/core_ext/numeric/time"
 require "sidekiq_publisher/version"
+require "sidekiq_publisher/compatibility"
 require "sidekiq_publisher/instrumenter"
 require "sidekiq_publisher/metrics_reporter"
 require "sidekiq_publisher/exception_reporter"
 require "sidekiq_publisher/report_unpublished_count"
-require "sidekiq_publisher/job"
 require "sidekiq_publisher/worker"
 require "sidekiq_publisher/publisher"
 require "sidekiq_publisher/runner"
-require "sidekiq_publisher/railtie" if defined?(Rails)
+require "sidekiq_publisher/engine" if defined?(Rails)
 
 module SidekiqPublisher
   DEFAULT_BATCH_SIZE = 100

data/lib/{sidekiq_publisher/tasks.rake → tasks/sidekiq_publisher.rake}

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 namespace :sidekiq_publisher do
+  desc "Start the Sidekiq Publisher runner"
   task publish: [:environment] do
     Signal.trap("INT") { exit(0) }
     Signal.trap("TERM") { exit(0) }

data/sidekiq_publisher.gemspec

@@ -41,6 +41,8 @@ Gem::Specification.new do |spec|
   spec.executables   = []
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.6"
+
   spec.add_development_dependency "activejob"
   spec.add_development_dependency "appraisal"
   spec.add_development_dependency "bundler", "~> 1.12"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_publisher
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 2.1.0
 platform: ruby
 authors:
 - ezCater, Inc
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-31 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -289,38 +289,41 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- app/models/sidekiq_publisher/job.rb
 - docker-compose.yml
-- gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_5.2_sidekiq_5.0.gemfile
 - gemfiles/rails_5.2_sidekiq_5.1.gemfile
 - gemfiles/rails_5.2_sidekiq_5.2.gemfile
 - gemfiles/rails_5.2_sidekiq_6.0.gemfile
 - gemfiles/rails_5.2_sidekiq_6.1.gemfile
+- gemfiles/rails_5.2_sidekiq_6.2.gemfile
 - gemfiles/rails_6.0_sidekiq_5.2.gemfile
 - gemfiles/rails_6.0_sidekiq_6.0.gemfile
 - gemfiles/rails_6.0_sidekiq_6.1.gemfile
+- gemfiles/rails_6.0_sidekiq_6.2.gemfile
 - gemfiles/rails_6.1_sidekiq_5.2.gemfile
 - gemfiles/rails_6.1_sidekiq_6.0.gemfile
 - gemfiles/rails_6.1_sidekiq_6.1.gemfile
+- gemfiles/rails_6.1_sidekiq_6.2.gemfile
 - lib/active_job/queue_adapters/sidekiq_publisher_adapter.rb
 - lib/generators/sidekiq_publisher/install_generator.rb
 - lib/generators/sidekiq_publisher/templates/create_sidekiq_publisher_jobs.rb
 - lib/sidekiq_publisher.rb
 - lib/sidekiq_publisher/client.rb
+- lib/sidekiq_publisher/compatibility.rb
 - lib/sidekiq_publisher/datadog_apm.rb
+- lib/sidekiq_publisher/engine.rb
 - lib/sidekiq_publisher/exception_reporter.rb
 - lib/sidekiq_publisher/instrumenter.rb
-- lib/sidekiq_publisher/job.rb
 - lib/sidekiq_publisher/metrics_reporter.rb
 - lib/sidekiq_publisher/publisher.rb
-- lib/sidekiq_publisher/railtie.rb
 - lib/sidekiq_publisher/report_unpublished_count.rb
 - lib/sidekiq_publisher/runner.rb
-- lib/sidekiq_publisher/tasks.rake
 - lib/sidekiq_publisher/testing.rb
 - lib/sidekiq_publisher/version.rb
 - lib/sidekiq_publisher/worker.rb
+- lib/tasks/sidekiq_publisher.rake
 - log/.gitkeep
 - sidekiq_publisher.gemspec
 homepage: https://github.com/ezcater/sidekiq_publisher
@@ -328,7 +331,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -336,16 +339,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Publisher for enqueuing jobs to Sidekiq
 test_files: []