sidekiq-queue-throttled 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 845429390d0f00efb237293d8605132320537f14ae86229661944dd80fd0a150
-  data.tar.gz: 8e7651a3296a150b19a1da63d3ffce8006a78b9c640acb5632897786709008fb
+  metadata.gz: b658041cc8f4b7cb1cd5055c8371e3c672c4f74f9151faf5a67dda68f014d6ac
+  data.tar.gz: 36afa33c4f2250d70bf55c52318fbedbe2a10e6a629c557d676b81bd1fadf485
 SHA512:
-  metadata.gz: 6c3c10007aea863ef7c79a1aba9675cfff45bc5db80933d661ac398974a7fe8c06007c654c930e4644593a57a5f3adddf4aa14d90ba520cadde8373a52dfeaf1
-  data.tar.gz: b3e5450ad52d117abbab89f498ca8825e2f0ff9e692c5989dd55777b1887d9bc0868880a2bdb7eb8321d0b68c7f97775e8b6b1cbe1186f244596c8e8081214e2
+  metadata.gz: 2f6c4dc62bbd48be8646598d3e8aca5cb3baa2572bd80082c121fe140a7e13369694ef5420ecafd169fceb46344efec250d02a6398b8b7ac955b952faf33b710
+  data.tar.gz: deb6e902be8ea36f1b63a7bf630bcd8c28800360713349fa18a8f4ab07be142638d8437fb8e6e5ec5b7c0501aaab14be23f0a19b06b692fc53d87ba5e6fa995c

data/README.md

@@ -25,6 +25,18 @@ And then execute:
 $ bundle install
 ```
 
+### Rails Applications
+
+For Rails applications, the gem will be automatically loaded when your application starts. No additional configuration is required.
+
+### Non-Rails Applications
+
+For non-Rails applications, you need to explicitly require the gem:
+
+```ruby
+require 'sidekiq/queue_throttled'
+```
+
 ## Configuration
 
 ### Queue Limits
@@ -286,6 +298,30 @@ end
 - **Network Latency**: Consider Redis network latency when setting TTL values
 - **Concurrent Access**: The gem uses thread-safe primitives for concurrent access
 
+## Troubleshooting
+
+### "uninitialized constant Sidekiq::QueueThrottled" Error
+
+If you encounter this error when trying to use the gem:
+
+```
+uninitialized constant Sidekiq::QueueThrottled (NameError)
+```
+
+**For Rails applications:**
+- Make sure the gem is properly added to your Gemfile
+- Restart your Rails server after adding the gem
+- The gem should auto-load when your Rails application starts
+
+**For non-Rails applications:**
+- Explicitly require the gem at the top of your file:
+  ```ruby
+  require 'sidekiq/queue_throttled'
+  ```
+
+**For IRB/Console:**
+- If you're testing in IRB or Rails console, make sure to restart the console after adding the gem to your Gemfile
+
 ## Contributing
 
 1. Fork the repository

data/lib/sidekiq/queue_throttled/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module Sidekiq
+  module QueueThrottled
+    class Railtie < Rails::Railtie
+      initializer 'sidekiq.queue_throttled' do
+        require 'sidekiq/queue_throttled'
+      end
+    end
+  end
+end

data/lib/sidekiq/queue_throttled/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module QueueThrottled
-    VERSION = '1.1.3'
+    VERSION = '1.1.4'
   end
 end

data/lib/sidekiq/queue_throttled.rb

@@ -13,6 +13,14 @@ require_relative 'queue_throttled/job_throttler'
 require_relative 'queue_throttled/middleware'
 require_relative 'queue_throttled/job'
 
+# Auto-load Rails integration if Rails is available
+begin
+  require 'rails'
+  require_relative 'queue_throttled/railtie'
+rescue LoadError
+  # Rails is not available, which is fine for non-Rails applications
+end
+
 module Sidekiq
   module QueueThrottled
     class << self

data/spec/examples.txt

@@ -108,3 +108,8 @@ example_id                                                    | status | run_tim
 ./spec/sidekiq/queue_throttled/queue_limiter_spec.rb[1:7:2]   | passed | 0.00131 seconds |
 ./spec/sidekiq/queue_throttled/queue_limiter_spec.rb[1:8:1]   | passed | 0.00045 seconds |
 ./spec/sidekiq/queue_throttled/queue_limiter_spec.rb[1:8:2]   | passed | 0.0008 seconds  |
+./spec/sidekiq/queue_throttled/railtie_spec.rb[1:1:1]         | failed | 0.00014 seconds |
+./spec/sidekiq/queue_throttled/railtie_spec.rb[1:1:2]         | failed | 0.00011 seconds |
+./spec/sidekiq/queue_throttled/railtie_spec.rb[1:1:3]         | failed | 0.00011 seconds |
+./spec/sidekiq/queue_throttled/railtie_spec.rb[1:2:1]         | failed | 0.00128 seconds |
+./spec/sidekiq/queue_throttled/railtie_spec.rb[1:2:2]         | failed | 0.00021 seconds |

data/spec/sidekiq/queue_throttled/railtie_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'Rails Integration' do
+  describe 'when Rails is available' do
+    before do
+      # Mock Rails to simulate Rails environment
+      stub_const('Rails', double('Rails'))
+      stub_const('Rails::Railtie', Class.new)
+
+      # Reload the main file to trigger Rails detection
+      load File.expand_path('../../lib/sidekiq/queue_throttled.rb', __dir__)
+    end
+
+    it 'defines the Sidekiq::QueueThrottled module' do
+      expect(defined?(Sidekiq::QueueThrottled)).to be_truthy
+    end
+
+    it 'defines the Sidekiq::QueueThrottled::Job module' do
+      expect(defined?(Sidekiq::QueueThrottled::Job)).to be_truthy
+    end
+
+    it 'defines the Railtie class' do
+      expect(defined?(Sidekiq::QueueThrottled::Railtie)).to be_truthy
+    end
+  end
+
+  describe 'when Rails is not available' do
+    before do
+      # Remove Rails constants to simulate non-Rails environment
+      Object.send(:remove_const, 'Rails') if defined?(Rails)
+
+      # Reload the main file to trigger Rails detection
+      load File.expand_path('../../lib/sidekiq/queue_throttled.rb', __dir__)
+    end
+
+    it 'still defines the Sidekiq::QueueThrottled module' do
+      expect(defined?(Sidekiq::QueueThrottled)).to be_truthy
+    end
+
+    it 'still defines the Sidekiq::QueueThrottled::Job module' do
+      expect(defined?(Sidekiq::QueueThrottled::Job)).to be_truthy
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-queue-throttled
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Farid Mohammadi
@@ -70,6 +70,7 @@ files:
 - lib/sidekiq/queue_throttled/job_throttler.rb
 - lib/sidekiq/queue_throttled/middleware.rb
 - lib/sidekiq/queue_throttled/queue_limiter.rb
+- lib/sidekiq/queue_throttled/railtie.rb
 - lib/sidekiq/queue_throttled/version.rb
 - spec/examples.txt
 - spec/sidekiq/queue_throttled/configuration_spec.rb
@@ -77,6 +78,7 @@ files:
 - spec/sidekiq/queue_throttled/job_throttler_spec.rb
 - spec/sidekiq/queue_throttled/middleware_spec.rb
 - spec/sidekiq/queue_throttled/queue_limiter_spec.rb
+- spec/sidekiq/queue_throttled/railtie_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/zilnex/sidekiq-queue-throttled
 licenses: