eventish 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b680cd59cf6faa489efed4b75bd284699213c249ff2d29c82f62d67facf634a2
-  data.tar.gz: 52bb544e7348bf01b9d0b60b236123488a0bdc5cb4e3138dac817292710517a3
+  metadata.gz: 5074ba83f3c48572d1074e1f212c2220a7fe98f21868d2a331439b642fb44745
+  data.tar.gz: dcb4ff6ea905f77414c74c369c803e582c2e143b50b59f8903e7eec91a4d0538
 SHA512:
-  metadata.gz: 69cc41ae3fb78d9cee65ee21cd71b480534fc0381acedf41bf6d4e26c3d5fe6ec9377359ed44b01b3834af2e2f4a35a39462e2be39f47c672290fc49585e08e7
-  data.tar.gz: 98718a8527924fe2e6396fdba0170b5998398aa4427f9b7af92fbf103e4c4a631da4ad9a349ec8131905ec651d3b5225d654200e01445312536313fb68ada425
+  metadata.gz: fdbf059ef0be7568fa12a5df0fde30920adb881f5e5df40b2bb0b130dad3e620b5f415fdf9ceb3f0c18075bf77996606653ef40a982558546cfb1f708864c40f
+  data.tar.gz: 7f8395c61e2662fd4b801ef99577d4b8085b5b0d484867444ef12a25bf7df2657d68a5edf329b70de0b48196839424fa90cba933e6c3f3f848be05b1f5547a40

data/README.md

@@ -1,22 +1,34 @@
 # Eventish
 
 [![Gem Version](https://badge.fury.io/rb/eventish.svg)](https://badge.fury.io/rb/eventish)
-[![Specs](https://github.com/blocknotes/eventish/actions/workflows/main.yml/badge.svg)](https://github.com/blocknotes/eventish/actions/workflows/main.yml)
+[![Specs Rails 6](https://github.com/blocknotes/eventish/actions/workflows/rails6.yml/badge.svg)](https://github.com/blocknotes/eventish/actions/workflows/rails6.yml)
+[![Specs Rails 7](https://github.com/blocknotes/eventish/actions/workflows/rails7.yml/badge.svg)](https://github.com/blocknotes/eventish/actions/workflows/rails7.yml)
 [![Linters](https://github.com/blocknotes/eventish/actions/workflows/linters.yml/badge.svg)](https://github.com/blocknotes/eventish/actions/workflows/linters.yml)
 
-Yet another opinionated events library which proposes a simple API to handle... events 🎉
+Yet another events library with a _simple_ API to handle... events :tada:
 
-The main features:
+Main features:
 - _composable_: just require the components that you need;
-- with [adapters](#adapters): support ActiveSupport::Notifications for pub/sub events;
-- with [async events](#async-events): support ActiveJob for background execution;
-- with [callbacks wrapper](#callbacks): support ActiveRecord.
-- with [plugins](#plugins): logger and Rails logger included.
+- with [adapters](#adapters): support ActiveSupport::Notifications and Wisper for pub/sub events;
+- with [async events](#async-events): support ActiveJob for events background execution;
+- with [callbacks wrapper](#callbacks): support ActiveRecord callbacks;
+- with [plugins](#plugins): a simple logger and a Rails logger are included;
+- with conditional event execution (overriding `callable?`).
+
+This component can be useful to:
+- decouple callbacks from the side-effect;
+- permit to test the side-effects in isolation;
+- permit to spy/block the side-effects;
+- permit to execute the side-effects from other contexts.
+
+Please :star: if you like it.
+
+> Do you want to speak by events? Try _eventish_ :smile:
 
 ## Install
 
 - Add to your Gemfile: `gem 'eventish'` (and execute `bundle`)
-- Create an initializer - _config/initializers/eventish.rb_:
+- Create an initializer - ex. _config/initializers/eventish.rb_:
 
 ```rb
 require 'eventish/adapters/active_support'
@@ -40,7 +52,7 @@ Rails.configuration.after_initialize do
 end
 ```
 
-- Create some events - _app/events/main/app_loaded_event.rb_:
+- Create some events - ex. _app/events/main/app_loaded_event.rb_:
 
 ```rb
 module Main
@@ -56,7 +68,9 @@ For a complete example please take a look at the [dummy app](spec/dummy) in the
 
 ### Adapters
 
-Only _ActiveSupport_ is supported for now.
+Used for events subscription and publishing.
+
+_ActiveSupport Notification_:
 
 ```rb
 # initializer setup
@@ -67,6 +81,18 @@ Eventish.setup do |config|
 end
 ```
 
+_Wisper_ (NOTE: around callback wrappers are not supported):
+
+```rb
+# initializer setup
+require 'wisper'
+require 'eventish/adapters/wisper'
+
+Eventish.setup do |config|
+  config.adapter = Eventish::Adapters::Wisper
+end
+```
+
 ### Simple events
 
 Generic events not related to a specific component.
@@ -80,7 +106,7 @@ Rails.configuration.after_initialize do
 end
 ```
 
-Sample event - _app/events/main/test_event.rb_:
+Sample event - ex. _app/events/main/test_event.rb_:
 
 ```rb
 module Main
@@ -99,14 +125,20 @@ module Main
 end
 ```
 
-Publish the event: `Eventish.publish('some_event')`
+Publish the event with:
+
+```rb
+Eventish.publish('some_event')
+```
 
 ### Async events
 
-Events executed in a background process. Only _ActiveJob_ is supported for now.
+Events executed in a background process.
+Only _ActiveJob_ is supported for now.
 
 ```rb
 # initializer setup
+require 'active_job/railtie'
 require 'eventish/active_job_event'
 
 Rails.configuration.after_initialize do
@@ -114,7 +146,7 @@ Rails.configuration.after_initialize do
 end
 ```
 
-Sample event - _app/events/notifications/user_after_save_commit_event.rb_:
+Sample event - ex. _app/events/notifications/user_after_save_commit_event.rb_:
 
 ```rb
 module Notifications
@@ -128,7 +160,7 @@ end
 
 ### Callbacks
 
-Only for ActiveRecord, callbacks wrapper are available with the postfix `_event` (ex. `after_commit_event SomeEvent`).
+Wrappers for ActiveRecord callbacks using the postfix `_event` (ex. `after_commit_event SomeEvent`).
 
 ```rb
 # initializer setup
@@ -136,6 +168,7 @@ require 'eventish/active_record/callback'
 ```
 
 ```rb
+# sample model
 class SomeModel < ActiveRecord::Base
   extend ::Eventish::ActiveRecord::Callback
 
@@ -171,6 +204,26 @@ module Eventish::Plugins::RailsLogger
 end
 ```
 
+Plugins can also be configured for single events overriding _before_event_ and _after_event_.
+
+### Conditional events
+
+Optionally an event can override the `callable?` method to define preconditions on the execution of the `call` method.
+
+Example:
+
+```rb
+class TestEvent < Eventish::SimpleEvent
+  def callable?(target)
+    target.ready?
+  end
+
+  def call(target, _options = {})
+    puts '> A test event'
+  end
+end
+```
+
 ## Do you like it? Star it!
 
 If you use this component just star it. A developer is more motivated to improve a project when there is some interest.

data/lib/eventish/active_job_event.rb

@@ -6,6 +6,10 @@ module Eventish
       raise NotImplementedError
     end
 
+    def callable?(_target)
+      true
+    end
+
     def perform(target, args)
       self.class.before_event.each { |plugin| plugin.call(target, args, event: self, hook: :before) }
       call(target, args)
@@ -17,6 +21,8 @@ module Eventish
       include Eventish::EventApi
 
       def trigger(target, args, &_block)
+        return unless new.callable?(target)
+
         perform_later(target, args)
       end
     end

data/lib/eventish/active_record/callback.rb

@@ -4,103 +4,126 @@ module Eventish
   module ActiveRecord
     module Callback
       # Init events
-      def after_initialize_event(event)
-        after_initialize -> { ::Eventish.publish(event, self) }
+      def after_initialize_event(*args)
+        event = args.shift
+        after_initialize -> { ::Eventish.publish(event, self) }, *args
       end
 
-      def after_find_event(event)
-        after_find -> { ::Eventish.publish(event, self) }
+      def after_find_event(*args)
+        event = args.shift
+        after_find -> { ::Eventish.publish(event, self) }, *args
       end
 
       # Validation events
-      def before_validation_event(event)
-        before_validation -> { ::Eventish.publish(event, self) }
+      def before_validation_event(*args)
+        event = args.shift
+        before_validation -> { ::Eventish.publish(event, self) }, *args
       end
 
-      def after_validation_event(event)
-        after_validation -> { ::Eventish.publish(event, self) }
+      def after_validation_event(*args)
+        event = args.shift
+        after_validation -> { ::Eventish.publish(event, self) }, *args
       end
 
       # Create events
-      def before_create_event(event)
-        before_create -> { ::Eventish.publish(event, self) }
+      def before_create_event(*args)
+        event = args.shift
+        before_create -> { ::Eventish.publish(event, self) }, *args
       end
 
-      def around_create_event(event)
-        around_create ->(_object, block) { ::Eventish.publish(event, self, block: block) }
+      def around_create_event(*args)
+        event = args.shift
+        around_create ->(_object, block) { ::Eventish.publish(event, self, block: block) }, *args
       end
 
-      def after_create_event(event)
-        after_create -> { ::Eventish.publish(event, self) }
+      def after_create_event(*args)
+        event = args.shift
+        after_create -> { ::Eventish.publish(event, self) }, *args
       end
 
       # Update events
-      def before_update_event(event)
-        before_update -> { ::Eventish.publish(event, self) }
+      def before_update_event(*args)
+        event = args.shift
+        before_update -> { ::Eventish.publish(event, self) }, *args
       end
 
-      def around_update_event(event)
-        around_update ->(_object, block) { ::Eventish.publish(event, self, block: block) }
+      def around_update_event(*args)
+        event = args.shift
+        around_update ->(_object, block) { ::Eventish.publish(event, self, block: block) }, *args
       end
 
-      def after_update_event(event)
-        after_update -> { ::Eventish.publish(event, self) }
+      def after_update_event(*args)
+        event = args.shift
+        after_update -> { ::Eventish.publish(event, self) }, *args
       end
 
       # Save events
-      def before_save_event(event)
-        before_save -> { ::Eventish.publish(event, self) }
+      def before_save_event(*args)
+        event = args.shift
+        before_save -> { ::Eventish.publish(event, self) }, *args
       end
 
-      def around_save_event(event)
-        around_save ->(_object, block) { ::Eventish.publish(event, self, block: block) }
+      def around_save_event(*args)
+        event = args.shift
+        around_save ->(_object, block) { ::Eventish.publish(event, self, block: block) }, *args
       end
 
-      def after_save_event(event)
-        after_save -> { ::Eventish.publish(event, self) }
+      def after_save_event(*args)
+        event = args.shift
+        after_save -> { ::Eventish.publish(event, self) }, *args
       end
 
       # Destroy events
-      def before_destroy_event(event)
-        before_destroy -> { ::Eventish.publish(event, self) }
+      def before_destroy_event(*args)
+        event = args.shift
+        before_destroy -> { ::Eventish.publish(event, self) }, *args
       end
 
-      def around_destroy_event(event)
-        around_destroy ->(_object, block) { ::Eventish.publish(event, self, block: block) }
+      def around_destroy_event(*args)
+        event = args.shift
+        around_destroy ->(_object, block) { ::Eventish.publish(event, self, block: block) }, *args
       end
 
-      def after_destroy_event(event)
-        after_destroy -> { ::Eventish.publish(event, self) }
+      def after_destroy_event(*args)
+        event = args.shift
+        after_destroy -> { ::Eventish.publish(event, self) }, *args
       end
 
       # Commit events
-      def after_commit_event(event)
-        after_commit -> { ::Eventish.publish(event, self) }
+      def after_commit_event(*args)
+        event = args.shift
+        after_commit -> { ::Eventish.publish(event, self) }, *args
       end
 
-      def after_create_commit_event(event)
-        after_create_commit -> { ::Eventish.publish(event, self) }
+      def after_create_commit_event(*args)
+        event = args.shift
+        after_create_commit -> { ::Eventish.publish(event, self) }, *args
       end
 
-      def after_update_commit_event(event)
-        after_update_commit -> { ::Eventish.publish(event, self) }
+      def after_update_commit_event(*args)
+        event = args.shift
+        after_update_commit -> { ::Eventish.publish(event, self) }, *args
       end
 
-      def after_save_commit_event(event)
-        after_save_commit -> { ::Eventish.publish(event, self) }
+      def after_save_commit_event(*args)
+        event = args.shift
+        after_save_commit -> { ::Eventish.publish(event, self) }, *args
       end
 
-      def after_destroy_commit_event(event)
-        after_destroy_commit -> { ::Eventish.publish(event, self) }
+      def after_destroy_commit_event(*args)
+        event = args.shift
+        after_destroy_commit -> { ::Eventish.publish(event, self) }, *args
       end
 
-      def after_rollback_event(event)
-        after_rollback -> { ::Eventish.publish(event, self) }
+      def after_rollback_event(*args)
+        event = args.shift
+        after_rollback -> { ::Eventish.publish(event, self) }, *args
       end
 
       # Touch events
-      def after_touch_event(event)
-        after_touch -> { ::Eventish.publish(event, self) }
+      def after_touch_event(*args)
+        event = args.shift
+        after_touch -> { ::Eventish.publish(event, self) }, *args
       end
     end
   end

data/lib/eventish/adapters/active_support.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Eventish
-  class Adapters
+  module Adapters
     class ActiveSupport
       class << self
         def publish(event, target = nil, block: nil)
@@ -15,16 +15,19 @@ module Eventish
           raise ArgumentError, 'Missing event to subscribe' if event.nil?
           raise ArgumentError, 'Missing handler for subscription' if handler.nil?
 
-          ::ActiveSupport::Notifications.subscribe(event.to_s) do |name, start, finish, id, payload|
+          subscriber = ::ActiveSupport::Notifications.subscribe(event.to_s) do |name, start, finish, id, payload|
             args = { event: name, id: id, start: start, finish: finish }
             handler.trigger(payload[:target], args, &payload.dig(:options, :block))
           end
+          Eventish.subscribers[event.to_s] = subscriber
+          subscriber
         end
 
         def unsubscribe(event)
           raise ArgumentError, 'Missing event to unsubscribe' if event.nil?
 
           ::ActiveSupport::Notifications.unsubscribe(event.to_s)
+          Eventish.subscribers.delete(event.to_s)
         end
       end
     end

data/lib/eventish/adapters/wisper.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Eventish
+  module Adapters
+    class Wisper
+      class << self
+        include ::Wisper::Publisher
+
+        def publish(event, target = nil, block: nil)
+          raise ArgumentError, 'Missing event to publish' if event.nil?
+
+          options = block ? { block: block } : {} # TODO: verify block feature
+          broadcast(event.to_s, target, options)
+        end
+
+        def subscribe(event, handler)
+          raise ArgumentError, 'Missing event to subscribe' if event.nil?
+          raise ArgumentError, 'Missing handler for subscription' if handler.nil?
+
+          ::Wisper.subscribe(handler.new, on: event.to_s, with: :call).tap do |subscriber|
+            Eventish.subscribers[event.to_s] = subscriber
+          end
+        end
+
+        def unsubscribe(event)
+          raise ArgumentError, 'Missing event to unsubscribe' if event.nil?
+
+          subscriber = Eventish.subscribers[event.to_s]
+          ::Wisper.unsubscribe(subscriber)
+          Eventish.subscribers.delete(event.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/eventish/event_api.rb

@@ -27,8 +27,14 @@ module Eventish
     end
 
     def subscribe_all
-      # iterate the descendants
-      ObjectSpace.each_object(singleton_class).sort.each(&:subscribe)
+      ignore_events = [Eventish::SimpleEvent]
+      ignore_events.push(Eventish::ActiveJobEvent) if defined? Eventish::ActiveJobEvent
+      events = Eventish.descendants(self).sort
+      (events - ignore_events).each(&:subscribe)
+    end
+
+    def unsubscribe
+      Eventish.adapter.unsubscribe(event_name)
     end
   end
 end

data/lib/eventish/plugins/rails_logger.rb

@@ -5,7 +5,7 @@ module Eventish
     class RailsLogger
       class << self
         def call(target, _args, event:, hook: nil, &_block)
-          Rails.logger.debug "EVENT: #{hook} #{event.class.event_name} on #{target.inspect}"
+          ::Rails.logger.debug "EVENT: #{hook} #{event.class.event_name} on #{target.inspect}"
         end
       end
     end

data/lib/eventish/simple_event.rb

@@ -6,11 +6,17 @@ module Eventish
       raise NotImplementedError
     end
 
+    def callable?(_target)
+      true
+    end
+
     class << self
       include EventApi
 
       def trigger(target, args, &block)
         event = new
+        return unless event.callable?(target)
+
         before_event.each { |plugin| plugin.call(target, args, event: event, hook: :before, &block) }
         event.call(target, args, &block)
         after_event.each { |plugin| plugin.call(target, args, event: event, hook: :after, &block) }

data/lib/eventish/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Eventish # :nodoc:
-  VERSION = '0.4.0'
+  VERSION = '0.5.1'
 end

data/lib/eventish.rb

@@ -18,6 +18,17 @@ module Eventish
     @options ||= Struct.new(*OPTIONS).new # rubocop:disable Naming/MemoizedInstanceVariableName
   end
 
+  # From Rails 6.0
+  def descendants(klass)
+    descendants = []
+    ObjectSpace.each_object(klass.singleton_class) do |k|
+      next if k.singleton_class?
+
+      descendants.unshift k unless k == self
+    end
+    descendants
+  end
+
   def publish(event_name, target = nil, block: nil)
     config.adapter&.publish(event_name, target, block: block)
   end
@@ -29,4 +40,8 @@ module Eventish
 
     @options
   end
+
+  def subscribers
+    @subscribers ||= {}
+  end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: eventish
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-21 00:00:00.000000000 Z
-dependencies: []
+date: 2022-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 description: A simple and composable event library
 email: mat@blocknot.es
 executables: []
@@ -22,6 +36,7 @@ files:
 - lib/eventish/active_job_event.rb
 - lib/eventish/active_record/callback.rb
 - lib/eventish/adapters/active_support.rb
+- lib/eventish/adapters/wisper.rb
 - lib/eventish/event_api.rb
 - lib/eventish/plugins/logger.rb
 - lib/eventish/plugins/rails_logger.rb