eventish 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f5572d1bca258f0f1c9bd4e09e3743f99bf3045c82013c9742e1b06cfb3c590
-  data.tar.gz: abe5bdf2cbe1998404c21686ee97758681be8e038c0af03c67b7be1cbed2c8c5
+  metadata.gz: 04c5125d8999ca2ad1a5ed1a81f7eae2adc4380aa7402cf93c17c8d92e7879f4
+  data.tar.gz: ef364bf047a9c29733793bb3d1b737842f392d414b61430f624d991700d9b560
 SHA512:
-  metadata.gz: 885eb9228852f4d143a52ca2db3b622eead0bb9c57bc47fecb8ce29ce9694488973151a1bcaf07df2783192aa362dd3626c200ca36a39afc721a6f5c22cc6222
-  data.tar.gz: e86ca0a3133a144c709a3a1cc76b2ba777d5995a8068ba202b6570bc4c31ab14e73fea390e3898825276bbc97651dfcdecb978af2266880f47219e810fc00d03
+  metadata.gz: f39ee5f5a27fc61ae32a3a7c8747430334a437de11671b8ab6666ad3bbbb6636784d2b1b0a84a249ba5495408f24f75ccae70e350d20c76c7ddf8c77dc685eee
+  data.tar.gz: 6dbbd5ff2495ed5a85263bbbdafe863fba988494426acfcaf142c122084effe60fbbbd557ec61cf780d9c2f2e1c839b6a2183159756093b7e72308f33d1fc84b

data/README.md

@@ -2,19 +2,25 @@
 
 [![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)
+[![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_: support ActiveSupport::Notifications for pub/sub events;
-- with _async events_: support ActiveJob for background execution;
-- with _callbacks_ wrapper: support ActiveRecord.
+- with [adapters](#adapters): support ActiveSupport::Notifications 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:
 
 ## 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'
@@ -38,7 +44,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
@@ -52,9 +58,10 @@ end
 
 For a complete example please take a look at the [dummy app](spec/dummy) in the specs.
 
-### Adatpers
+### Adapters
 
-Only _ActiveSupport_ is supported for now.
+The component used events subscription and publishing.
+Only _ActiveSupport Notification_ is supported for now.
 
 ```rb
 # initializer setup
@@ -78,7 +85,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
@@ -97,11 +104,16 @@ 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
@@ -112,7 +124,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
@@ -126,7 +138,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
@@ -134,6 +146,7 @@ require 'eventish/active_record/callback'
 ```
 
 ```rb
+# sample model
 class SomeModel < ActiveRecord::Base
   extend ::Eventish::ActiveRecord::Callback
 
@@ -143,6 +156,34 @@ end
 
 The related callback will be setup by the wrapper and the specified event class will be invoked accordingly.
 
+### Plugins
+
+A plugins system is available for custom processing, a logger and a Rails logger are included in the gem.
+
+```rb
+# initializer setup
+require 'eventish/plugins/rails_logger' # without rails_ for a simple stdout logger
+
+Eventish.setup do |config|
+  config.before_event = [Eventish::Plugins::RailsLogger]
+  config.after_event = [Eventish::Plugins::RailsLogger]
+end
+```
+
+A sample plugin:
+
+```rb
+module Eventish::Plugins::RailsLogger
+  class << self
+    def call(target, _args, event:, hook: nil, &_block)
+      Rails.logger.debug "EVENT: #{hook} #{event.class.event_name} on #{target.inspect}"
+    end
+  end
+end
+```
+
+Plugins can also be configured for single events overriding _before_event_ and _after_event_.
+
 ## 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

@@ -7,7 +7,10 @@ module Eventish
     end
 
     def perform(target, args)
+      self.class.before_event.each { |plugin| plugin.call(target, args, event: self, hook: :before) }
       call(target, args)
+      self.class.after_event.each { |plugin| plugin.call(target, args, event: self, hook: :after) }
+      self
     end
 
     class << self

data/lib/eventish/active_record/callback.rb

@@ -4,12 +4,12 @@ module Eventish
   module ActiveRecord
     module Callback
       # Init events
-      def after_initialize_event
-        before_validation -> { ::Eventish.publish(event, self) }
+      def after_initialize_event(event)
+        after_initialize -> { ::Eventish.publish(event, self) }
       end
 
-      def after_find_event
-        before_validation -> { ::Eventish.publish(event, self) }
+      def after_find_event(event)
+        after_find -> { ::Eventish.publish(event, self) }
       end
 
       # Validation events
@@ -27,7 +27,7 @@ module Eventish
       end
 
       def around_create_event(event)
-        around_create -> { ::Eventish.publish(event, self) }
+        around_create ->(_object, block) { ::Eventish.publish(event, self, block: block) }
       end
 
       def after_create_event(event)
@@ -40,7 +40,7 @@ module Eventish
       end
 
       def around_update_event(event)
-        around_update -> { ::Eventish.publish(event, self) }
+        around_update ->(_object, block) { ::Eventish.publish(event, self, block: block) }
       end
 
       def after_update_event(event)
@@ -53,7 +53,7 @@ module Eventish
       end
 
       def around_save_event(event)
-        around_save -> { ::Eventish.publish(event, self) }
+        around_save ->(_object, block) { ::Eventish.publish(event, self, block: block) }
       end
 
       def after_save_event(event)
@@ -66,7 +66,7 @@ module Eventish
       end
 
       def around_destroy_event(event)
-        around_destroy -> { ::Eventish.publish(event, self) }
+        around_destroy ->(_object, block) { ::Eventish.publish(event, self, block: block) }
       end
 
       def after_destroy_event(event)
@@ -78,10 +78,6 @@ module Eventish
         after_commit -> { ::Eventish.publish(event, self) }
       end
 
-      def after_save_commit_event(event)
-        after_save_commit -> { ::Eventish.publish(event, self) }
-      end
-
       def after_create_commit_event(event)
         after_create_commit -> { ::Eventish.publish(event, self) }
       end
@@ -90,6 +86,10 @@ module Eventish
         after_update_commit -> { ::Eventish.publish(event, self) }
       end
 
+      def after_save_commit_event(event)
+        after_save_commit -> { ::Eventish.publish(event, self) }
+      end
+
       def after_destroy_commit_event(event)
         after_destroy_commit -> { ::Eventish.publish(event, self) }
       end

data/lib/eventish/adapters/active_support.rb

@@ -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/event_api.rb

@@ -6,6 +6,14 @@ module Eventish
       other&.priority <=> priority
     end
 
+    def after_event
+      Eventish.config.after_event || []
+    end
+
+    def before_event
+      Eventish.config.before_event || []
+    end
+
     def event_name
       @event_name ||= to_s
     end
@@ -20,7 +28,14 @@ module Eventish
 
     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 = ObjectSpace.each_object(singleton_class).sort
+      (events - ignore_events).each(&:subscribe)
+    end
+
+    def unsubscribe
+      Eventish.adapter.unsubscribe(event_name)
     end
   end
 end

data/lib/eventish/plugins/logger.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Eventish
+  module Plugins
+    class Logger
+      class << self
+        def call(target, _args, event:, hook: nil, &_block)
+          puts "[#{Time.now}] EVENT: #{hook} #{event.class.event_name} on #{target.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/eventish/plugins/rails_logger.rb

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

data/lib/eventish/simple_event.rb

@@ -10,7 +10,11 @@ module Eventish
       include EventApi
 
       def trigger(target, args, &block)
-        new.call(target, args, &block)
+        event = new
+        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) }
+        event
       end
     end
   end

data/lib/eventish/version.rb

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

data/lib/eventish.rb

@@ -4,7 +4,7 @@ require_relative 'eventish/event_api'
 require_relative 'eventish/simple_event'
 
 module Eventish
-  OPTIONS = %i[adapter].freeze
+  OPTIONS = %i[adapter after_event before_event].freeze
 
   AdapterError = Class.new(StandardError)
 
@@ -29,4 +29,8 @@ module Eventish
 
     @options
   end
+
+  def subscribers
+    @subscribers ||= {}
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eventish
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-19 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies: []
 description: A simple and composable event library
 email: mat@blocknot.es
@@ -23,6 +23,8 @@ files:
 - lib/eventish/active_record/callback.rb
 - lib/eventish/adapters/active_support.rb
 - lib/eventish/event_api.rb
+- lib/eventish/plugins/logger.rb
+- lib/eventish/plugins/rails_logger.rb
 - lib/eventish/simple_event.rb
 - lib/eventish/version.rb
 homepage: https://github.com/blocknotes/eventish