eventish 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b680cd59cf6faa489efed4b75bd284699213c249ff2d29c82f62d67facf634a2
-  data.tar.gz: 52bb544e7348bf01b9d0b60b236123488a0bdc5cb4e3138dac817292710517a3
+  metadata.gz: 04c5125d8999ca2ad1a5ed1a81f7eae2adc4380aa7402cf93c17c8d92e7879f4
+  data.tar.gz: ef364bf047a9c29733793bb3d1b737842f392d414b61430f624d991700d9b560
 SHA512:
-  metadata.gz: 69cc41ae3fb78d9cee65ee21cd71b480534fc0381acedf41bf6d4e26c3d5fe6ec9377359ed44b01b3834af2e2f4a35a39462e2be39f47c672290fc49585e08e7
-  data.tar.gz: 98718a8527924fe2e6396fdba0170b5998398aa4427f9b7af92fbf103e4c4a631da4ad9a349ec8131905ec651d3b5225d654200e01445312536313fb68ada425
+  metadata.gz: f39ee5f5a27fc61ae32a3a7c8747430334a437de11671b8ab6666ad3bbbb6636784d2b1b0a84a249ba5495408f24f75ccae70e350d20c76c7ddf8c77dc685eee
+  data.tar.gz: 6dbbd5ff2495ed5a85263bbbdafe863fba988494426acfcaf142c122084effe60fbbbd557ec61cf780d9c2f2e1c839b6a2183159756093b7e72308f33d1fc84b

data/README.md

@@ -4,19 +4,23 @@
 [![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](#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 [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'
@@ -40,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
@@ -56,7 +60,8 @@ For a complete example please take a look at the [dummy app](spec/dummy) in the
 
 ### Adapters
 
-Only _ActiveSupport_ is supported for now.
+The component used events subscription and publishing.
+Only _ActiveSupport Notification_ is supported for now.
 
 ```rb
 # initializer setup
@@ -80,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
@@ -99,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
@@ -114,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
@@ -128,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
@@ -136,6 +146,7 @@ require 'eventish/active_record/callback'
 ```
 
 ```rb
+# sample model
 class SomeModel < ActiveRecord::Base
   extend ::Eventish::ActiveRecord::Callback
 
@@ -171,6 +182,8 @@ module Eventish::Plugins::RailsLogger
 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/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

@@ -28,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/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/version.rb

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

data/lib/eventish.rb

@@ -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.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-21 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