eventish 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04c5125d8999ca2ad1a5ed1a81f7eae2adc4380aa7402cf93c17c8d92e7879f4
-  data.tar.gz: ef364bf047a9c29733793bb3d1b737842f392d414b61430f624d991700d9b560
+  metadata.gz: 419b6aafd21ffe1e4c9041549dc80b77fe7973975732a44feeac183f28d8f474
+  data.tar.gz: 50e7f43233ee05c86c930807677cdee82a21471b6d4f4c4a037ea1062e6f3127
 SHA512:
-  metadata.gz: f39ee5f5a27fc61ae32a3a7c8747430334a437de11671b8ab6666ad3bbbb6636784d2b1b0a84a249ba5495408f24f75ccae70e350d20c76c7ddf8c77dc685eee
-  data.tar.gz: 6dbbd5ff2495ed5a85263bbbdafe863fba988494426acfcaf142c122084effe60fbbbd557ec61cf780d9c2f2e1c839b6a2183159756093b7e72308f33d1fc84b
+  metadata.gz: b768c6c9baaac52a7b3bd841569714727a43527d90956881645e17b11afc5be65e14bfec6424d4a877f12d7294dc4a69edaf94a55b62b4da7f9bb133d1d69c41
+  data.tar.gz: a272f0d0420ae08b627be7fcb975d7051af6f7662b2089f91b4719a1b97fab70fd3cc7872031fba83ccb8d61881953f08d921476b4918cd9dfff82be05d6272b

data/README.md

@@ -1,21 +1,22 @@
 # 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 events library with a _simple_ API to handle... events :tada:
 
 Main features:
 - _composable_: just require the components that you need;
-- with [adapters](#adapters): support ActiveSupport::Notifications for pub/sub events;
+- 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.
 
 Please :star: if you like it.
 
-> You need _eventish_ if you want to speak by events :smile:
+> Do you want to speak by events? Try _eventish_ :smile:
 
 ## Install
 
@@ -60,8 +61,9 @@ For a complete example please take a look at the [dummy app](spec/dummy) in the
 
 ### Adapters
 
-The component used events subscription and publishing.
-Only _ActiveSupport Notification_ is supported for now.
+Used for events subscription and publishing.
+
+_ActiveSupport Notification_:
 
 ```rb
 # initializer setup
@@ -72,6 +74,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.
@@ -117,6 +131,7 @@ Only _ActiveJob_ is supported for now.
 
 ```rb
 # initializer setup
+require 'active_job/railtie'
 require 'eventish/active_job_event'
 
 Rails.configuration.after_initialize do

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)

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,10 +27,9 @@ module Eventish
     end
 
     def subscribe_all
-      # iterate the descendants
       ignore_events = [Eventish::SimpleEvent]
       ignore_events.push(Eventish::ActiveJobEvent) if defined? Eventish::ActiveJobEvent
-      events = ObjectSpace.each_object(singleton_class).sort
+      events = Eventish.descendants(self).sort
       (events - ignore_events).each(&:subscribe)
     end
 

data/lib/eventish/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Eventish # :nodoc:
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: eventish
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-24 00:00:00.000000000 Z
-dependencies: []
+date: 2022-05-31 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