eventish 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 419b6aafd21ffe1e4c9041549dc80b77fe7973975732a44feeac183f28d8f474
-  data.tar.gz: 50e7f43233ee05c86c930807677cdee82a21471b6d4f4c4a037ea1062e6f3127
+  metadata.gz: 5074ba83f3c48572d1074e1f212c2220a7fe98f21868d2a331439b642fb44745
+  data.tar.gz: dcb4ff6ea905f77414c74c369c803e582c2e143b50b59f8903e7eec91a4d0538
 SHA512:
-  metadata.gz: b768c6c9baaac52a7b3bd841569714727a43527d90956881645e17b11afc5be65e14bfec6424d4a877f12d7294dc4a69edaf94a55b62b4da7f9bb133d1d69c41
-  data.tar.gz: a272f0d0420ae08b627be7fcb975d7051af6f7662b2089f91b4719a1b97fab70fd3cc7872031fba83ccb8d61881953f08d921476b4918cd9dfff82be05d6272b
+  metadata.gz: fdbf059ef0be7568fa12a5df0fde30920adb881f5e5df40b2bb0b130dad3e620b5f415fdf9ceb3f0c18075bf77996606653ef40a982558546cfb1f708864c40f
+  data.tar.gz: 7f8395c61e2662fd4b801ef99577d4b8085b5b0d484867444ef12a25bf7df2657d68a5edf329b70de0b48196839424fa90cba933e6c3f3f848be05b1f5547a40

data/README.md

@@ -11,8 +11,15 @@ Main features:
 - _composable_: just require the components that you need;
 - 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 [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.
 
@@ -199,6 +206,24 @@ 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/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.5.0'
+  VERSION = '0.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eventish
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-31 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal