listenable 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa0682e0a477e1a2367d552bab4b480cfdb2d902628cc0f3eff9b566750332b4
-  data.tar.gz: 81f80897906e86612474240bf7b1dedb2e7e21e4572d4313e61e65208f830d64
+  metadata.gz: ebe46a89c412b54c70f0af2f7851f46176dfd08c3dc5a611ef61c35d0bea1717
+  data.tar.gz: c19ed7b192adc50833b432058cfcdf652add0401bbbca28e869c282186ef7e88
 SHA512:
-  metadata.gz: 781cc4d59e3a98604a8c2e06a5d0d981513ab08814949695b0da3b4ff4d9bb3ce737386e414969ae13e1fca1bee2b67708a12f71d7b46a9f76fe2b19c4c961f3
-  data.tar.gz: c2ae5d198f292ea9fb2c9792da90cc0bb9a97ec950b48dbf79090a2c0ddbdef832289a807b958d9f83739d8b0999e48a50560e3a21b3be176041923a903a1669
+  metadata.gz: 6083b9a19eb74cceaec96942846f3a7b7754bf0ed27f42686f67351e8b6bd7246392c485a7b0ad4e35d909d85eb2b0f4f2cf33ebf0529ff475c9ed11b9857e68
+  data.tar.gz: 2b4c5d0b93694b35f3431f9cef48794182a621e8f937fc01bb745b895d3edbff5b38ce27c42a78c69622fecd2d2e5e1d35d5b2e171f5080dd2fd4344619c6ebd

data/README.md

@@ -72,6 +72,57 @@ Under the hood:
 | `on_updated`          | `after_update`       |
 | `on_deleted`          | `after_destroy`      |
 
+## Runtime Toggle
+By default, listeners are always active in development and production.
+
+You can enable/disable them dynamically at runtime using:
+
+```ruby
+Listenable.enabled = false  # disable all listeners
+Listenable.enabled = true   # re-enable listeners
+```
+
+This does not require restarting your Rails server or test suite.
+
+## RSpec/Test Integration
+You usually don’t want listeners firing in tests (e.g. sending jobs or emails).
+
+Disable them globally in your test suite:
+
+```ruby
+# spec/rails_helper.rb
+RSpec.configure do |config|
+  config.before(:suite) do
+    Listenable.enabled = false
+  end
+
+  # Enable listeners selectively
+  config.around(:each, listenable: true) do |example|
+    prev = Listenable.enabled
+    Listenable.enabled = true
+    example.run
+    Listenable.enabled = prev
+  end
+end
+```
+
+Now:
+
+```ruby
+RSpec.describe User do
+  it 'does not fire listeners by default' do
+    expect(UserListener).not_to receive(:on_created)
+    User.create!(name: 'Pedro')
+  end
+
+  it 'fires listeners when enabled', listenable: true do
+    expect(UserListener).to receive(:on_created)
+    User.create!(name: 'Pedro')
+  end
+end
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/listenable/railtie.rb

@@ -4,13 +4,13 @@ module Listenable
   class Railtie < Rails::Railtie
     initializer "listenable.load" do
       Rails.application.config.to_prepare do
-        # Load all listeners (supports nested paths)
+        # Load all listeners (recursive, supports namespaced)
         Dir[Rails.root.join("app/listeners/**/*.rb")].each { |f| require_dependency f }
 
-        # Wire models + listeners
+        # Find all listener classes
         ObjectSpace.each_object(Class).select { |klass| klass < Listenable }.each do |listener_class|
           model_class_name = listener_class.name.sub("Listener", "")
-          model_class = model_class_name.safe_constantize
+          model_class      = model_class_name.safe_constantize
           next unless model_class
 
           listener_class.pending_hooks.each do |hook|
@@ -19,22 +19,29 @@ module Listenable
             method   = "on_#{action}"
             event    = "#{model_class_name.underscore}.#{action}"
 
-            # Avoid duplicate subscriptions on reload
+            # Unsubscribe duplicates
             ActiveSupport::Notifications.notifier.listeners_for(event).each do |subscriber|
               ActiveSupport::Notifications.unsubscribe(subscriber)
             end
 
-            # Inject ActiveRecord callback
-            model_class.send(callback) do
-              ActiveSupport::Notifications.instrument(event, record: self)
+            # Inject AR callback once per model/event
+            injected_events = model_class.instance_variable_get(:@_listenable_injected_events) || []
+            unless injected_events.include?(event)
+              model_class.send(callback) do
+                next unless Listenable.enabled
+                ActiveSupport::Notifications.instrument(event, record: self)
+              end
+              injected_events << event
+              model_class.instance_variable_set(:@_listenable_injected_events, injected_events)
             end
 
-            # Subscribe listener
-            next unless listener_class.respond_to?(method)
-
-            ActiveSupport::Notifications.subscribe(event) do |*args|
-              _name, _start, _finish, _id, payload = args
-              listener_class.public_send(method, payload[:record])
+            # Subscribe listener (runtime-guarded)
+            if listener_class.respond_to?(method)
+              ActiveSupport::Notifications.subscribe(event) do |*args|
+                next unless Listenable.enabled
+                _name, _start, _finish, _id, payload = args
+                listener_class.public_send(method, payload[:record])
+              end
             end
           end
         end

data/lib/listenable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Listenable
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/listenable.rb

@@ -9,6 +9,8 @@ require_relative "listenable/concern"
 require_relative "listenable/railtie" if defined?(Rails)
 
 module Listenable
+  mattr_accessor :enabled, default: true
+
   class Error < StandardError; end
   # Your code goes here...
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: listenable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Den Meralpis