sidekiq-transaction_guard 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e27eee15051c5f07cf60ef45c168acc319c41883a7b67f398b7699555d7eebad
-  data.tar.gz: 4c7468a9c73455fe68eec99c6b0e756f510a8d8d2f83983523a9cb3871ead584
+  metadata.gz: 5f1c8f731c16ff8a3da91b3073be50dd1544a1b17a82521b60637baaa4643421
+  data.tar.gz: 711cd9daff96b69e24d54a8e21803bcf85bf64e60ab813ba168d943e7092f236
 SHA512:
-  metadata.gz: 23aae8c43a758882aa38de9c7cce90c709ecca1784e7c56c78e223db406d7bec88fba99fa5794226fe8a94d6a23f764b11b2e3ed42f6017847bddefa42350ecc
-  data.tar.gz: 668a578d96d136cd382a400efbf46f6f94715c53917e017c6833a5f5cf362e24254f1fa2444350a09509201785b9d62adef9008d238bbe0c40aec9ed144bb1c7
+  metadata.gz: ff23694280b688a5d0cdf7274408aa3640385dd4269814fb54421848c339f101b7dc865c7013dde0ff83ce6a9031810082155f3bfed727eaf9643a5b7cffdaa0
+  data.tar.gz: 36ad8e565e052c16e309fffa3f6e2b6fa715c8c694546b74b63d4aeee7f04224b68ebd193421a1f1f550fc8d02c8332507f0acf9583e1f074247d24eea60b3c4

data/CHANGELOG.md

@@ -1,7 +1,31 @@
-# 1.0.1
+# Changelog
+All notable changes to this project will be documented in this file.
 
-* Sidekiq 6.0 compatibility
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-# 1.0.0
+## 1.0.3
 
-* Initial release
+### Changed
+
+- Updated Middleware to include Sidekiq::ClientMiddleware for Sidekiq 7.0 compatibility
+
+
+## 1.0.2
+
+### Changed
+
+- Updated database cleaner dependency to use database_cleaner-active_record instead of deprecated database_cleaner gem.
+- Added YARD doc param and return types.
+
+## 1.0.1
+
+### Added
+
+- Sidekiq 6.0 compatibility
+
+## 1.0.0
+
+### Added
+
+- Initial release

data/README.md

@@ -1,7 +1,9 @@
-# Sidekiq::TransactionGuard
+# Sidekiq Transaction Guard
 
-[![Build Status](https://travis-ci.com/bdurand/sidekiq-transaction_guard.svg?branch=master)](https://travis-ci.com/bdurand/sidekiq-transaction_guard)
-[![Maintainability](https://api.codeclimate.com/v1/badges/17bbf5cb6eda022028fe/maintainability)](https://codeclimate.com/github/bdurand/sidekiq-transaction_guard/maintainability)
+[![Continuous Integration](https://github.com/bdurand/sidekiq-transaction_guard/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/bdurand/sidekiq-transaction_guard/actions/workflows/continuous_integration.yml)
+[![Regression Test](https://github.com/bdurand/sidekiq-transaction_guard/actions/workflows/regression_test.yml/badge.svg)](https://github.com/bdurand/sidekiq-transaction_guard/actions/workflows/regression_test.yml)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+[![Gem Version](https://badge.fury.io/rb/sidekiq-transaction_guard.svg)](https://badge.fury.io/rb/sidekiq-transaction_guard)
 
 You should never call a Sidekiq worker that relies on the state of the database from within a database transaction. You will end up with a race condition since the worker could kick off before the transaction is actually written to the database. This gem can be used to highlight where your code may be scheduling workers in an indeterminate state.
 
@@ -59,7 +61,7 @@ end
 You can use this gem to add Sidekiq client middleware that will either warn you or raise an error when workers are scheduled inside of a database transaction. You can do this by simply adding this to your application's initialization code:
 
 ```ruby
-require 'sidekiq/transaction-guard'
+require 'sidekiq/transaction_guard'
 
 Sidekiq.configure_client do |config|
   config.client_middleware do |chain|

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.3

data/lib/sidekiq/transaction_guard/database_cleaner.rb

@@ -1,6 +1,7 @@
-require 'sidekiq/transaction_guard'
-require 'database_cleaner'
-require 'database_cleaner/active_record/transaction'
+# frozen_string_literal: true
+
+require "sidekiq/transaction_guard"
+require "database_cleaner/active_record"
 
 module Sidekiq
   module TransactionGuard
@@ -16,8 +17,10 @@ module Sidekiq
 
       # Wrap the `Sidekiq::TransactionGuard.testing` which sets up the data structures
       # needed for custom counting of the transaction level within a test block.
+      #
+      # @return [Object] the return value of the block
       def cleaning(&block)
-        Sidekiq::TransactionGuard.testing{ super(&block) }
+        Sidekiq::TransactionGuard.testing { super(&block) }
       end
     end
   end

data/lib/sidekiq/transaction_guard/middleware.rb

@@ -10,6 +10,10 @@ module Sidekiq
     # the default behavior set in `Sidekiq::TransactionGuard.mode` and
     # `Sidekiq::TransactionGuard.notify` respectively.
     class Middleware
+      if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("7.0")
+        include Sidekiq::ClientMiddleware
+      end
+
       def call(worker_class, job, queue, redis_pool)
         # Check if we need to log this. Also, convert worker_class to its actual class
         if in_transaction?
@@ -21,16 +25,16 @@ module Sidekiq
 
       private
 
-      def worker_mode(worker_class)
-        read_sidekiq_option(worker_class, :transaction_guard) || Sidekiq::TransactionGuard.mode
+      def worker_mode(job)
+        read_sidekiq_option(job, :transaction_guard) || Sidekiq::TransactionGuard.mode
       end
 
       def in_transaction?
         Sidekiq::TransactionGuard.in_transaction?
       end
 
-      def notify_block(worker_class)
-        handler = read_sidekiq_option(worker_class, :notify_in_transaction)
+      def notify_block(job)
+        handler = read_sidekiq_option(job, :notify_in_transaction)
         if handler
           handler
         elsif handler == false
@@ -40,13 +44,13 @@ module Sidekiq
         end
       end
 
-      def read_sidekiq_option(worker_class, option_name)
-        options = worker_class.sidekiq_options_hash
-        options[option_name.to_s] if options
+      def read_sidekiq_option(job, option_name)
+        # options = worker_class.sidekiq_options_hash
+        job[option_name.to_s]
       end
 
       def notify!(worker_class, job)
-        notify_handler = notify_block(worker_class)
+        notify_handler = notify_block(job)
         if notify_handler
           begin
             notify_handler.call(job)
@@ -54,14 +58,14 @@ module Sidekiq
             if Sidekiq.logger
               Sidekiq.logger.error(e)
             else
-              STDERR.write("ERROR on Sidekiq::TransactionGuard notify block for #{worker_class}: #{e.inspect}\n")
+              $stderr.write("ERROR on Sidekiq::TransactionGuard notify block for #{worker_class}: #{e.inspect}\n")
             end
           end
         end
       end
 
       def log_transaction(worker_class, job)
-        mode = worker_mode(worker_class)
+        mode = worker_mode(job)
         if mode != :disabled
           message = "#{worker_class.name} was called from inside a database transaction"
           if mode == :error
@@ -71,7 +75,7 @@ module Sidekiq
             if logger
               logger.warn(message)
             else
-              STDERR.write("WARNING #{message}\n")
+              $stderr.write("WARNING #{message}\n")
             end
             notify!(worker_class, job)
           end

data/lib/sidekiq/transaction_guard.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
-require 'sidekiq'
-require 'set'
-require 'thread'
+require "sidekiq"
+require "set"
 
-require_relative 'transaction_guard/middleware'
+require_relative "transaction_guard/middleware"
 
 module Sidekiq
   module TransactionGuard
@@ -26,6 +25,9 @@ module Sidekiq
       # * :stderr - Log to STDERR
       # * :error - Throw a `Sidekiq::TransactionGuard::InsideTransactionError`
       # * :disabled - Allow workers inside of transactions
+      #
+      # @param mode [Symbol]
+      # @return [void]
       def mode=(symbol)
         if VALID_MODES.include?(symbol)
           @mode = symbol
@@ -35,18 +37,22 @@ module Sidekiq
       end
 
       # Return the current mode.
-      def mode
-        @mode
-      end
+      #
+      # @return [Symbol]
+      attr_reader :mode
 
       # Define the global notify block. This block will be called with a Sidekiq
       # job hash for all jobs enqueued inside transactions if the mode is `:warn`
       # or `:stderr`.
+      #
+      # @return [void]
       def notify(&block)
         @notify = block
       end
 
       # Return the block set as the notify handler with a call to `notify`.
+      #
+      # @return [Proc]
       def notify_block
         @notify
       end
@@ -55,15 +61,20 @@ module Sidekiq
       # being monitored for open transactions. You don't need to add `ActiveRecord::Base`
       # or subclasses. Only the base class that establishes a new connection pool
       # with a call to `establish_connection` needs to be added.
+      #
+      # @param connection_class [Class]
+      # @return [void]
       def add_connection_class(connection_class)
-        @lock.synchronize{ @connection_classes << connection_class }
+        @lock.synchronize { @connection_classes << connection_class }
       end
 
       # Return true if any connection is currently inside of a transaction.
+      #
+      # @return [Boolean]
       def in_transaction?
         connection_classes = [ActiveRecord::Base]
         unless @connection_classes.empty?
-          connection_classes.concat(@lock.synchronize{ @connection_classes.to_a })
+          connection_classes.concat(@lock.synchronize { @connection_classes.to_a })
         end
         connection_classes.any? do |connection_class|
           connection_pool = connection_class.connection_pool
@@ -78,6 +89,8 @@ module Sidekiq
 
       # This method call needs to be wrapped around tests that use transactional fixtures.
       # It sets up data structures used to track the number of open transactions.
+      #
+      # @return [Object] the return value of the block
       def testing(&block)
         var = :sidekiq_rails_transaction_guard
         save_val = Thread.current[var]
@@ -93,6 +106,9 @@ module Sidekiq
       # class (see `add_connection_class` for more info). The current transaction level
       # for that class' connection will be set as the zero point. This method can only
       # be called inside a block wrapped with the `testing` method.
+      #
+      # @param connection_class [Class]
+      # @return [void]
       def set_allowed_transaction_level(connection_class)
         connection_counts = Thread.current[:sidekiq_rails_transaction_guard]
         unless connection_counts

data/lib/sidekiq-transaction_guard.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative "sidekiq/transaction_guard"

data/sidekiq-transaction_guard.gemspec

@@ -1,45 +1,37 @@
 # frozen_string_literal: true
 
-require_relative "lib/sidekiq/transaction_guard/version"
-
 Gem::Specification.new do |spec|
-  spec.name          = "sidekiq-transaction_guard"
-  spec.version       = Sidekiq::TransactionGuard::VERSION
-  spec.authors       = ["Brian Durand", "Winston Durand"]
-  spec.email         = ["bbdurand@gmail.com", "me@winstondurand.com"]
+  spec.name = "sidekiq-transaction_guard"
+  spec.version = File.read(File.expand_path("VERSION", __dir__)).strip
+  spec.authors = ["Brian Durand", "Winston Durand"]
+  spec.email = ["bbdurand@gmail.com", "me@winstondurand.com"]
 
-  spec.summary       = "Protect from accidentally invoking Sidekiq jobs when there are open database transactions"
-  spec.homepage      = "https://github.com/bdurand/sidekiq-transaction_guard"
-  spec.license       = "MIT"
+  spec.summary = "Protect from accidentally invoking Sidekiq jobs when there are open database transactions"
+  spec.homepage = "https://github.com/bdurand/sidekiq-transaction_guard"
+  spec.license = "MIT"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  ignore_files = %w(
-    .gitignore
-    .travis.yml
+  ignore_files = %w[
+    .
     Appraisals
     Gemfile
     Gemfile.lock
     Rakefile
+    bin/
     gemfiles/
     spec/
-  )
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject{ |f| ignore_files.any?{ |path| f.start_with?(path) } }
+  ]
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject { |f| ignore_files.any? { |path| f.start_with?(path) } }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.2.2'
+  spec.required_ruby_version = ">= 2.2.2"
 
   spec.add_dependency "activerecord", ">= 4.0"
   spec.add_dependency "sidekiq", ">= 3.0"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "database_cleaner"
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "bundler"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-transaction_guard
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Brian Durand
 - Winston Durand
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2020-01-17 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -41,76 +41,6 @@ dependencies:
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  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'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  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'
-- !ruby/object:Gem::Dependency
-  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +53,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - bbdurand@gmail.com
 - me@winstondurand.com
@@ -145,7 +75,7 @@ homepage: https://github.com/bdurand/sidekiq-transaction_guard
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,8 +90,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
 summary: Protect from accidentally invoking Sidekiq jobs when there are open database
   transactions