koine-event_manager 1.0.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b203d892bc234ce8366802859308e8c9656da9e
-  data.tar.gz: fd4a6216c688e50ac46ec059cd7cf0c8e1bb9a77
+  metadata.gz: 775de95f0d2768e1147c12eea5a66dd28fd23fee
+  data.tar.gz: 6bb2f1ef07c98614d119a615769f67e318f32e77
 SHA512:
-  metadata.gz: fbdc01af9f5a357354aadae2fc8350fc5023dd8add92148ac3ffba7dd229519e7ddc8b81656cd347fa919c02e2e4f9f3b06bacdcd355ba327cbc4d8fa40c9ae2
-  data.tar.gz: e175d834d2aa00b61b561996d231d340f3345224ca4f7e09c4f67a8854c2d5b003dc2f57c9eef34da0d86b1cd286b64b1a4f93039a998c62d8809ccaf8edb0db
+  metadata.gz: 0c6b9922bd907cd760a065bb74a564142b6817881a213e52b0674535beb223b954eda7e418e389c101b71a29ffbde0ab7d3b98329318453a59d2e57e9d5896dc
+  data.tar.gz: 7c653751ff81a31f53ec7267aa952225b61de01f50b9e1181a3b506cdd18e22270c3131e043ae25383e7c3a3a95b32bfacee96c317b1c077930711bd793b7ccd

data/README.md

@@ -83,6 +83,38 @@ And trigger the event on the event manager
 event_manager.trigger(UserSignedIn.new(some_user))
 ```
 
+## Adding event manager awareness to your classes
+
+**CAUTION**: This make use of the singleton instance of event manager.
+Singletons are usually a bad idea, so prefer dependency injection over
+singleton instances.
+
+```ruby
+require "koine/event_manager/event_manager_aware"
+
+class MyModel
+  include Koine::EventManager::EventManagerAware
+
+  def some_method
+    event_manager.trigger(SomeEvent.new(foo: :bar))
+  end
+end
+```
+
+The above is the same as:
+
+```ruby
+class MyModel
+  def some_method
+    event_manager.trigger(SomeEvent.new(foo: :bar))
+  end
+
+  def event_manager
+    Koine::EventManager::EventManager.instance
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/koine/event_manager/event_manager.rb

@@ -28,6 +28,10 @@ module Koine
       def listeners
         @listners ||= []
       end
+
+      def self.instance
+        @@instance ||= new
+      end
     end
   end
 end

data/lib/koine/event_manager/event_manager_aware.rb

@@ -0,0 +1,13 @@
+module Koine
+  module EventManager
+    module EventManagerAware
+      def self.included(klass)
+        klass.instance_eval do
+          define_method "event_manager" do
+            Koine::EventManager::EventManager.instance
+          end
+        end
+      end
+    end
+  end
+end

data/lib/koine/event_manager/version.rb

@@ -1,5 +1,5 @@
 module Koine
   module EventManager
-    VERSION = "1.0.0"
+    VERSION = "1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: koine-event_manager
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: '1.1'
 platform: ruby
 authors:
 - Marcelo Jacobus
@@ -115,6 +115,7 @@ files:
 - lib/koine/event_manager.rb
 - lib/koine/event_manager/event_listener.rb
 - lib/koine/event_manager/event_manager.rb
+- lib/koine/event_manager/event_manager_aware.rb
 - lib/koine/event_manager/version.rb
 homepage: https://github.com/mjacobus/koine-event-manager
 licenses: