wisper-activerecord-publisher 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f481f3a7e215a299ad8852ed13ca58015e567a26
-  data.tar.gz: d9103ee22d6a60efc68694c7ebceac390516acff
+SHA256:
+  metadata.gz: 164a0ca8671589cf020e6de23cc9fb349c0ef9be1ea90ebe0fbe6e8f3d4fc4c6
+  data.tar.gz: a0224dc694ee505e116f0a8b3d5debec80b4ca5abcb73c5aba66f7493f7a701f
 SHA512:
-  metadata.gz: d91617efd5bec3e16f0533d28fa1e37b27f0d50e872bfededbe884b1c9745bcc5c5f6d8ac5b9e47771c92270ce7f998051d898588f0ca9a1c9f55afe7a74f408
-  data.tar.gz: 61ba29218c5f18db8a79e9c3c1f592a430d56148589774f8fd827339e2ba998c6fac893e91e762d31ae2695c793f59f9c35f7777f735f4c76f17042e74f42f01
+  metadata.gz: f0225ec11f2609585aef571208e0ac74fe2370b1b01db4c400b39e7107bd904ce439f88398d45575c3877d7e4a5fe4157be1a7180b314d565ad1affe9cb6d25e
+  data.tar.gz: 27378a8026b2ca278433477c225d567be2569f76c30995a38d13642f20a828ba54c01cf2b2a75669975b819f0f8503353166520b39aee7620b71eec156e0426d

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+3.1.3

data/README.md

@@ -26,7 +26,7 @@ This gem *does* support background event processing since the events are
 published after commit and each event includes the necessary payload (ie:
 changes).
 
-## Example
+### Example
 
 ```ruby
 class Foo < ActiveRecord::Base
@@ -47,6 +47,45 @@ class MyListener
 end
 ```
 
+### Limiting events per model
+
+Rather than have a model broadcast all events, you can limit them using the `broadcast_on` method.
+
+```ruby
+class Foo < ActiveRecord::Base
+  broadcast_on :create
+end
+
+class MyListener
+  def foo_created(model)
+    # do something here with the model
+  end
+
+  def foo_updated(model, changes)
+    # Will not be called
+  end
+
+  def foo_destroyed(model_attributes)
+    # Will not be called
+  end
+end
+```
+
+### Changing default event broadcasts
+
+You can turn off or limit broadcasts for all models in your application via an initializer.
+
+```ruby
+# config/initializers/wisper_activerecord_publisher.rb
+
+Wisper::ActiveRecord::Publisher.configure do |config|
+  config.default_broadcast_events = [:create, :update] # Only broadcast create and update events
+end
+```
+
+Additionally, you can disable all broadcasts in a model by calling `disable_all_lifecycle_broadcasts!` on the model
+class.
+
 ## 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/wisper/activerecord/publisher/configuration.rb

@@ -0,0 +1,27 @@
+module Wisper
+  module ActiveRecord
+    module Publisher
+      def self.configuration
+        @configuration ||= Configuration.new
+      end
+
+      def self.configure
+        yield configuration
+      end
+
+      class Configuration
+        attr_reader :default_broadcast_events
+
+        def initialize
+          @default_broadcast_events = VALID_BROADCAST_EVENTS
+        end
+
+        def default_broadcast_events=(events)
+          raise ArgumentError, "default_broadcast_events must be an array" unless events.is_a?(Array)
+
+          @default_broadcast_events = events
+        end
+      end
+    end
+  end
+end

data/lib/wisper/activerecord/publisher/version.rb

@@ -1,7 +1,7 @@
 module Wisper
   module Activerecord
     module Publisher
-      VERSION = '0.1.2'.freeze
+      VERSION = '0.2.0'.freeze
     end
   end
 end

data/lib/wisper/activerecord/publisher.rb

@@ -1,4 +1,5 @@
 require 'wisper/activerecord/publisher/version'
+require 'wisper/activerecord/publisher/configuration'
 require 'active_record'
 require 'wisper'
 
@@ -10,14 +11,30 @@ module Wisper
     module Publisher
       extend ActiveSupport::Concern
 
+      VALID_BROADCAST_EVENTS = %i[create update destroy].freeze
+
       included do
         include Wisper::Publisher
 
         # NOTE: do not need to silence deprecations on Rails 5+
         ActiveSupport::Deprecation.silence do
-          after_commit :broadcast_create, on: :create
-          after_commit :broadcast_update, on: :update
-          after_commit :broadcast_destroy, on: :destroy
+          VALID_BROADCAST_EVENTS.each do |event_name|
+            after_commit "broadcast_#{event_name}".to_sym, on: event_name, if: -> { should_broadcast?(event_name) }
+          end
+        end
+
+        class_attribute :wisper_activerecord_publisher_broadcast_events
+
+        def self.broadcast_on(*events)
+          events.each do |event|
+            raise ArgumentError, "Unknown broadcast event '#{event}'" unless VALID_BROADCAST_EVENTS.include?(event)
+          end
+
+          self.wisper_activerecord_publisher_broadcast_events = events
+        end
+
+        def self.disable_all_lifecycle_broadcasts!
+          self.wisper_activerecord_publisher_broadcast_events = []
         end
       end
 
@@ -45,9 +62,17 @@ module Wisper
       def broadcast_event_name(lifecycle)
         "#{self.class.model_name.param_key}_#{lifecycle}"
       end
+
+      def should_broadcast?(event)
+        (
+          wisper_activerecord_publisher_broadcast_events ||
+          Wisper::ActiveRecord::Publisher.configuration.default_broadcast_events
+        ).include?(event)
+      end
     end
   end
 end
+
 ActiveSupport.on_load(:active_record) do
   include Wisper::ActiveRecord::Publisher
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wisper-activerecord-publisher
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - BetterUp Developers
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-09-08 00:00:00.000000000 Z
+date: 2023-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wisper
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - developers@betterup.co
 executables: []
@@ -100,13 +100,14 @@ files:
 - bin/setup
 - circle.yml
 - lib/wisper/activerecord/publisher.rb
+- lib/wisper/activerecord/publisher/configuration.rb
 - lib/wisper/activerecord/publisher/version.rb
 - wisper-activerecord-publisher.gemspec
 homepage: https://github.com/betterup/wisper-activerecord-publisher
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,9 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.6
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Publish wisper events for activerecord model lifecycle
 test_files: []