sidekiq-transaction_guard 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 294e37857447f017a08970a3d0430042c69e0afee645d25ce3f2350ce93fb9e6
-  data.tar.gz: ee1c16813ca499c9c146fa3db6dcc4f7d3f1c4b8417769ca1fa9635cdcd793c0
+  metadata.gz: 0fe8af50053f7431c866b6091475ac6c11498619b6dc443e3a6320fa54ce41e0
+  data.tar.gz: fc14706b5ad35440b365db3065f12f5342ecf048a2a29e96a0baecff8179ea0a
 SHA512:
-  metadata.gz: b533961d40cc75425032fbb39ecf51a216bca82cf50f3e5d45d2b6c0a628b7da38b03e4c1bc5387711d4a4ddb36a120626826156d42020fd768ff6adb0e16069
-  data.tar.gz: 520048075eb69133f17233a5d8ef037e8d8f6ce4c886be5c1f398b966154bb7c0e27ed1a6e4c4694e17d46abd1e69a0651b5f72cd44c13520a2b8d07bbb05907
+  metadata.gz: e4902e75a12e5b2ae4943cd415cbe7e4173db2304b8c431d40e49cd51b4c41a8acb5f23e0c20f8f1d2062593f559b4edb34ea479621988cc6df55f4e0a749a4f
+  data.tar.gz: 88cbea82b257c33439955f45e49a36beba1d0b7b72de2a7f4fb74d6bfbda6cfc2c292bbfc12b6eed8d0ac0cf9f6565f46d9508aa100be29d6fc8f954230c389f

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+# Dependabot update strategy
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: weekly
+    allow:
+      # Automatically keep all runtime dependencies updated
+      - dependency-name: "*"
+        dependency-type: "production"
+    versioning-strategy: lockfile-only

data/.github/workflows/continuous_integration.yml

@@ -0,0 +1,84 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches:
+      - master
+      - actions-*
+    tags:
+      - v*
+  pull_request:
+    branches-ignore:
+      - actions-*
+
+env:
+  BUNDLE_CLEAN: "true"
+  BUNDLE_PATH: vendor/bundle
+  BUNDLE_JOBS: 3
+  BUNDLE_RETRY: 3
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - ruby: "ruby"
+            standardrb: true
+          - ruby: "3.2"
+            appraisal: "activerecord_7.0"
+          - ruby: "3.1"
+            appraisal: "activerecord_6.1"
+          - ruby: "2.7"
+            appraisal: "activerecord_6.0"
+          - ruby: "2.7"
+            appraisal: "activerecord_5.2"
+          - ruby: "2.6"
+            appraisal: "activerecord_5.1"
+          - ruby: "2.6"
+            appraisal: "activerecord_5.0"
+          - ruby: "2.5"
+            appraisal: "activerecord_4.2"
+          - ruby: "2.5"
+            appraisal: "activerecord_4.1"
+          - ruby: "2.5"
+            appraisal: "activerecord_4.0"
+          - ruby: "3.2"
+            appraisal: "sidekiq_7"
+          - ruby: "3.0"
+            appraisal: "sidekiq_6"
+          - ruby: "2.7"
+            appraisal: "sidekiq_5"
+          - ruby: "2.6"
+            appraisal: "sidekiq_4"
+          - ruby: "2.5"
+            appraisal: "sidekiq_3"
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "${{ matrix.ruby }}"
+    - name: Install packages
+      run: |
+        sudo apt-get update
+        sudo apt-get install libsqlite3-dev
+    - name: Setup bundler
+      if: matrix.bundler != ''
+      run: |
+        gem uninstall bundler --all
+        gem install bundler --no-document --version ${{ matrix.bundler }}
+    - name: Set Appraisal bundle
+      if: matrix.appraisal != ''
+      run: |
+        echo "using gemfile gemfiles/${{ matrix.appraisal }}.gemfile"
+        bundle config set gemfile "gemfiles/${{ matrix.appraisal }}.gemfile"
+    - name: Install gems
+      run: |
+        bundle update
+    - name: Run Tests
+      run: bundle exec rake
+    - name: standardrb
+      if:   matrix.standardrb == true
+      run:  bundle exec rake standard

data/.standard.yml

@@ -0,0 +1,9 @@
+format: progress
+
+ruby_version: 2.5
+
+ignore:
+  - 'spec/**/*':
+    - Lint/ConstantDefinitionInBlock
+    - Lint/UselessAssignment
+

data/CHANGELOG.md

@@ -1,3 +1,21 @@
-# 1.0.0
+# Changelog
+All notable changes to this project will be documented in this file.
 
-* Initial release
+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.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

@@ -59,7 +59,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.0
+1.0.2

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

@@ -12,23 +12,25 @@ module Sidekiq
     class Middleware
       def call(worker_class, job, queue, redis_pool)
         # Check if we need to log this. Also, convert worker_class to its actual class
-        log_transaction(worker_class.constantize, job) if in_transaction?
-
+        if in_transaction?
+          worker_class = worker_class.constantize if worker_class.is_a?(String)
+          log_transaction(worker_class, job)
+        end
         yield
       end
 
       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
@@ -38,13 +40,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)
@@ -52,14 +54,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
@@ -69,7 +71,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

@@ -3,18 +3,18 @@
 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 = Sidekiq::TransactionGuard::VERSION
+  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(
+  ignore_files = %w[
     .gitignore
     .travis.yml
     Appraisals
@@ -23,23 +23,16 @@ Gem::Specification.new do |spec|
     Rakefile
     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(File.expand_path("..", __FILE__)) 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.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"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-transaction_guard
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Brian Durand
 - Winston Durand
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-10-08 00:00:00.000000000 Z
+date: 2023-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -39,91 +39,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         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:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
+description:
 email:
 - bbdurand@gmail.com
 - me@winstondurand.com
@@ -131,6 +47,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/continuous_integration.yml"
+- ".standard.yml"
 - CHANGELOG.md
 - MIT_LICENSE.txt
 - README.md
@@ -145,7 +64,7 @@ homepage: https://github.com/bdurand/sidekiq-transaction_guard
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,9 +79,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Protect from accidentally invoking Sidekiq jobs when there are open database
   transactions