octiron 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 336926004fffc1105bb354c76c1e5435d95b27fc
-  data.tar.gz: 9d6efe5638f209dfabf38062969b72dc0ce71ec6
+  metadata.gz: 5f6820493b0a41711b72e1cfa9b460a668c1c51a
+  data.tar.gz: 927c382237fb5ac19863356b451a5cef89610248
 SHA512:
-  metadata.gz: 05c58fdb427c609711728fb4f965a7e5a86cebe5ccac9d8f87043e1921c690562f775c0a14fb3204b7dc9b4a6d33fc6c2ddbad2999352aa2b5966d353193089a
-  data.tar.gz: fbec63c5c3956741db10a49445503aa8892d77956e3139e9539749b06e6b524998dc91e30992ec26f9b272b35d923537753b34ebdfcd4bbaed8a7708e57b5ac7
+  metadata.gz: 4a2ed141ecc3d958d49e9e9e3e79ee6e2d6187b4c470934119f8cfb71c7a756d7b8caf89a2b26552d69cc7545d61d72c342ed076c0a7a97b152e875c0afed399
+  data.tar.gz: d6843fe8e9550957fb1eee0a2cfdbee28d01ee65eab309c69842f1056709c26ad9a0bc4707c515e8c2213ca74fcdc6ba8665fdea2d996cb12e4e9189b7f53953

data/.codeclimate.yml

@@ -6,7 +6,6 @@ engines:
     enabled: true
     exclude_fingerprints:
       - 8d15a3402e79d161b5ae30535883e4e4
-      engines:
     config:
       languages:
       - ruby

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    octiron (0.1.1)
+    octiron (0.2.0)
       collapsium (~> 0.8)
       rgl (~> 0.5)
 

data/README.md

@@ -52,7 +52,7 @@ end
 ```
 
 As long as the transmogrifier returns an object of the `AnotherEvent` type,
-all is well.
+all is well. Otherwise, an exception is raised.
 
 Putting this together with the hitherto unmentioned `#publish` method, you can
 easily build processing pipelines.
@@ -78,6 +78,50 @@ publish MyEvent.new
 
 There are some more advanced topics that might be useful to understand.
 
+### Automatic Transmogrification
+
+When you write a lot of transmogrifiers, chances are your event handlers all
+look roughly the same:
+
+```ruby
+on_event(SourceEvent) do |event|
+  begin
+    new_event = transmogrify(event).to AnotherEvent
+    publish(new_event)
+  rescue RuntimeError
+  end
+end
+```
+
+This event handler pattern *tries* to transmogrify the source event to another
+type, and on success will publish the result. On failure, it just wants to
+swallow the event.
+
+This pattern is supported with the `#autotransmogrify` function:
+
+```ruby
+autotransmogrify(SourceEvent) do |event|
+  if not some_condition
+    next
+  end
+  AnotherEvent.new
+end
+```
+
+Your transmogrifier is installed as previously, and additionally an event handler
+is registered that follows the pattern above. If the transmogrifier returns
+no new event, that is silently accepted.
+
+You can use `#autotransmogrify` and still raise errors, of course:
+
+```ruby
+autotransmogrify(SourceEvent, raise_on_nil: true) do |_|
+  # do nothing
+end
+
+publish(SourceEvent.new) # will raise RuntimeError
+```
+
 ### Singletons vs. API
 
 The octiron gem exposes a number of simple wrapper functions we've used so far

data/lib/octiron/events/bus.rb

@@ -26,6 +26,12 @@ module Octiron::Events
     #     Event classes.
     def initialize(default_namespace = ::Octiron::Events)
       @default_namespace = default_namespace.to_s
+      clear
+    end
+
+    ##
+    # Clears all event handlers
+    def clear
       @handlers = {}
     end
 

data/lib/octiron/transmogrifiers/registry.rb

@@ -42,6 +42,12 @@ module Octiron::Transmogrifiers
     #     Transmogrifier classes.
     def initialize(default_namespace = ::Octiron::Transmogrifiers)
       @default_namespace = default_namespace.to_s
+      clear
+    end
+
+    ##
+    # Clears the registry of all transmogrifiers
+    def clear
       @graph = RGL::DirectedAdjacencyGraph.new
       @visitor = RGL::DijkstraVisitor.new(@graph)
       @map_data = {}

data/lib/octiron/version.rb

@@ -8,5 +8,5 @@
 #
 module Octiron
   # The current release version
-  VERSION = "0.1.1".freeze
+  VERSION = "0.2.0".freeze
 end

data/lib/octiron/world.rb

@@ -67,12 +67,51 @@ module Octiron::World
     end
   end
 
+  ##
+  # Delegator for the autotransmogiry(FROM).to TO syntax
+  # @api private
+  class AutoTransmogrifyDelegator < TransmogrifierRegistrator
+    def initialize(from, raise_on_nil)
+      @from = from
+      @raise_on_nil = raise_on_nil
+    end
+
+    def to(to, transmogrifier_object = nil, &transmogrifier_proc)
+      # First register the transmogrifier
+      super
+
+      # Then create an event handler that chains the transmogrify step with a
+      # publish step.
+      ::Octiron::World.event_bus.subscribe(@from) do |event|
+        # By default, we don't want to raise errors if the transmogrifier
+        # returns nil. Still, raising should be activated optionally.
+        begin
+          new_ev = ::Octiron::World.transmogrifier_registry.transmogrify(event, to)
+          ::Octiron::World.event_bus.publish(new_ev)
+        rescue RuntimeError
+          if @raise_on_nil
+            raise
+          end
+        end
+      end
+    end
+  end
+
   ##
   # Register a transmogrifier with the singleton transmogrifier registry
   def on_transmogrify(from)
     return TransmogrifierRegistrator.new(from)
   end
 
+  ##
+  # Automatically transmogrify one event type to another, and publish the result.
+  # By default, a transmogrifier that returns a nil object simply does not
+  # publish a result.
+  def autotransmogrify(from, options = {})
+    raise_on_nil = options[:raise_on_nil] || false
+    return AutoTransmogrifyDelegator.new(from, raise_on_nil)
+  end
+
   ##
   # Transmogrify using the singleton transmogrifier registry
   def transmogrify(from)

data/spec/world_spec.rb

@@ -11,6 +11,9 @@ describe Octiron::World do
   before :each do
     @tester = Class.new
     @tester.extend(Octiron::World)
+
+    Octiron::World.transmogrifier_registry.clear
+    Octiron::World.event_bus.clear
   end
 
   describe "singletons" do
@@ -55,4 +58,41 @@ describe Octiron::World do
       expect(result.class).to eql Test2
     end
   end
+
+  describe "autotransmogrification" do
+    it "autotransmogrifies events" do
+      @tester.autotransmogrify(Test1).to Test2 do |_|
+        next Test2.new
+      end
+
+      invoked = 0
+      @tester.on_event(Test2) do |_|
+        invoked += 1
+      end
+
+      @tester.publish(Test1.new)
+      expect(invoked).to eql 1
+    end
+
+    it "ignores nil transmogrification results by default" do
+      @tester.autotransmogrify(Test1).to Test2 do |_|
+        # Nothing happening here
+      end
+
+      invoked = 0
+      @tester.on_event(Test2) do |_|
+        invoked += 1
+      end
+
+      @tester.publish(Test1.new)
+      expect(invoked).to eql 0
+    end
+
+    it "can raise on nil transmogrification results" do
+      @tester.autotransmogrify(Test1, raise_on_nil: true).to Test2 do |_|
+        # Nothing happening here
+      end
+      expect { @tester.publish(Test1.new) }.to raise_error(RuntimeError)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octiron
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jens Finkhaeuser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-12 00:00:00.000000000 Z
+date: 2016-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler