eventish 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 965405052bda0cb9903d4a447c91e5db89c8b98a868ded8428ee0399652680bd
-  data.tar.gz: 4608f89362bd42919071b404d428c8a44178d608a51ae0c0eb2aeb0b9a3d40ee
+  metadata.gz: b680cd59cf6faa489efed4b75bd284699213c249ff2d29c82f62d67facf634a2
+  data.tar.gz: 52bb544e7348bf01b9d0b60b236123488a0bdc5cb4e3138dac817292710517a3
 SHA512:
-  metadata.gz: 78839ea7b019d89e6587692faa575e345c9b72eae8355833cb374a5b7906cedd97ebcc74e4e61db1ecf9ea3c4764f5de7eeacac0a79bd6448c080f341ef33db3
-  data.tar.gz: 9b88eb7b02e330c68449cb7e978c8b40c6bc0a19cab874bd082fbf897ef61a9ec67ad3d2be866b3936d0370f777f158d423a414d3f469a4656facdfb8d201cb1
+  metadata.gz: 69cc41ae3fb78d9cee65ee21cd71b480534fc0381acedf41bf6d4e26c3d5fe6ec9377359ed44b01b3834af2e2f4a35a39462e2be39f47c672290fc49585e08e7
+  data.tar.gz: 98718a8527924fe2e6396fdba0170b5998398aa4427f9b7af92fbf103e4c4a631da4ad9a349ec8131905ec651d3b5225d654200e01445312536313fb68ada425

data/README.md

@@ -2,13 +2,16 @@
 
 [![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 🎉
 
 The 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 [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.
 
 ## Install
 
@@ -51,7 +54,7 @@ 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.
 
@@ -123,6 +126,51 @@ module Notifications
 end
 ```
 
+### Callbacks
+
+Only for ActiveRecord, callbacks wrapper are available with the postfix `_event` (ex. `after_commit_event SomeEvent`).
+
+```rb
+# initializer setup
+require 'eventish/active_record/callback'
+```
+
+```rb
+class SomeModel < ActiveRecord::Base
+  extend ::Eventish::ActiveRecord::Callback
+
+  before_validation_event SomeBeforeValidationEvent
+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
+```
+
 ## 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

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Eventish
+  module ActiveRecord
+    module Callback
+      # Init events
+      def after_initialize_event(event)
+        after_initialize -> { ::Eventish.publish(event, self) }
+      end
+
+      def after_find_event(event)
+        after_find -> { ::Eventish.publish(event, self) }
+      end
+
+      # Validation events
+      def before_validation_event(event)
+        before_validation -> { ::Eventish.publish(event, self) }
+      end
+
+      def after_validation_event(event)
+        after_validation -> { ::Eventish.publish(event, self) }
+      end
+
+      # Create events
+      def before_create_event(event)
+        before_create -> { ::Eventish.publish(event, self) }
+      end
+
+      def around_create_event(event)
+        around_create ->(_object, block) { ::Eventish.publish(event, self, block: block) }
+      end
+
+      def after_create_event(event)
+        after_create -> { ::Eventish.publish(event, self) }
+      end
+
+      # Update events
+      def before_update_event(event)
+        before_update -> { ::Eventish.publish(event, self) }
+      end
+
+      def around_update_event(event)
+        around_update ->(_object, block) { ::Eventish.publish(event, self, block: block) }
+      end
+
+      def after_update_event(event)
+        after_update -> { ::Eventish.publish(event, self) }
+      end
+
+      # Save events
+      def before_save_event(event)
+        before_save -> { ::Eventish.publish(event, self) }
+      end
+
+      def around_save_event(event)
+        around_save ->(_object, block) { ::Eventish.publish(event, self, block: block) }
+      end
+
+      def after_save_event(event)
+        after_save -> { ::Eventish.publish(event, self) }
+      end
+
+      # Destroy events
+      def before_destroy_event(event)
+        before_destroy -> { ::Eventish.publish(event, self) }
+      end
+
+      def around_destroy_event(event)
+        around_destroy ->(_object, block) { ::Eventish.publish(event, self, block: block) }
+      end
+
+      def after_destroy_event(event)
+        after_destroy -> { ::Eventish.publish(event, self) }
+      end
+
+      # Commit events
+      def after_commit_event(event)
+        after_commit -> { ::Eventish.publish(event, self) }
+      end
+
+      def after_create_commit_event(event)
+        after_create_commit -> { ::Eventish.publish(event, self) }
+      end
+
+      def after_update_commit_event(event)
+        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
+
+      def after_rollback_event(event)
+        after_rollback -> { ::Eventish.publish(event, self) }
+      end
+
+      # Touch events
+      def after_touch_event(event)
+        after_touch -> { ::Eventish.publish(event, self) }
+      end
+    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

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.0'
+  VERSION = '0.4.0'
 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)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eventish
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-18 00:00:00.000000000 Z
+date: 2022-05-21 00:00:00.000000000 Z
 dependencies: []
 description: A simple and composable event library
 email: mat@blocknot.es
@@ -20,8 +20,11 @@ files:
 - README.md
 - lib/eventish.rb
 - lib/eventish/active_job_event.rb
+- 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