shouter 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 862686691e817c5a4673b19b99d32c67972dc50b
-  data.tar.gz: ca15331f3a161e1fa990405430bcf9cbbac97a1e
+  metadata.gz: fca38a3d0a7a4056957ca27de249842abb520d76
+  data.tar.gz: 88aa5fc1c271e34e4882c5f38792a6c18fcbf6b7
 SHA512:
-  metadata.gz: 72ad83a1d5cb0b462281464213c0e58651b315cc582c21b022e1feb1c2e1084a9254f7d393bb04c504be182c43605ddd1f6d63f4342cc0e89fd996dd6336e6f1
-  data.tar.gz: 0506b4d5a87e8ae891de958e3d7ebadd8423e6e2461a41b31a49bafa3c09138b1b534b43d949d4a2a650893e22348532471f9a6d6f63890229518bbd9945a848
+  metadata.gz: 84b86db63d5054ac46eff0b5a8100a8ede7e0460b0521aa1131e8608c2f9121c9d7b20b0b77e94987947963ca5d30ddac393cc62e7ef1676119b85b1faca072c
+  data.tar.gz: e915ec735684d0956991631029d102ec55600ec06ae8e21633cd7ded6728859026f6ff5244369d66a2b6ce96c888ff22a20997303328cc7fc2b7f02b474a8d1e

data/README.md

@@ -37,6 +37,18 @@ end
 A.publish(:my_scope, :on_change)
 => "I`m changed"
 ```
+Since version `0.1.3` if you want asyncronous execution, using separate threads you can supply
+the `async` option. By default it is set to `false`
+```ruby
+class A
+  extend Shouter
+  subscribe(Listener.new, for: :my_async_scope, async: true)
+end
+```
+Now whenever you `publish` and event it will be run in a separate
+thread. If a thread for the execution is already present another one
+will not be created. If you have supplied a callback option it will be
+executed in the thread of execution of the listener.
 
 You can subscribe multiple objects:
 ```ruby
@@ -59,7 +71,6 @@ A.publish(:my_scope, :on_change)
 
 A.publish(:my_scope, :on_change)
 => nil
-
 ```
 All the arguments are passed to the method as well:
 ```ruby

data/lib/shouter.rb

@@ -1,10 +1,20 @@
 require 'shouter/version'
 require 'shouter/hook'
 require 'shouter/guard'
-require 'shouter/listener'
+require 'shouter/mixin'
+require 'shouter/listeners/async'
+require 'shouter/listeners/sync'
 require 'shouter/store'
+require 'shouter/builder'
 
 module Shouter
+
+  class ScopeMissingError < StandardError
+    def initialize
+      'You must supply a scope for running the events'
+    end
+  end
+
   def subscribe(*objects, **options)
     Shouter::Store.register(objects, options)
   end

data/lib/shouter/builder.rb

@@ -0,0 +1,14 @@
+module Shouter
+  class Builder
+    class << self
+      def register(object, options)
+        if options[:async]
+          _klass = Shouter::Listeners::Async
+        else
+          _klass = Shouter::Listeners::Sync
+        end
+        _klass.new(object, options)
+      end
+    end
+  end
+end

data/lib/shouter/listeners/async.rb

@@ -0,0 +1,34 @@
+module Shouter
+  module Listeners
+    class Async
+
+      include Shouter::Mixin
+
+      attr_reader :thread_exists
+
+      def notify!(scope, event, args, &block)
+        return unless notify?(scope, event)
+        return if thread_exists?
+
+        create_thread
+        Thread.new do
+          object.public_send(event, *args)
+          fire_hook!(options[:callback] || block)
+        end
+        unregister(object)
+      end
+
+      private
+
+      # If a thread is already spawned for this listener
+      # do not create another one
+      def thread_exists?
+        thread_exists
+      end
+
+      def create_thread
+        @thread_exists = true
+      end
+    end
+  end
+end

data/lib/shouter/listeners/sync.rb

@@ -0,0 +1,17 @@
+module Shouter
+  module Listeners
+    class Sync
+
+      include Shouter::Mixin
+
+      def notify!(scope, event, args, &block)
+        return unless notify?(scope, event)
+
+        object.public_send(event, *args)
+        fire_hook!(options[:callback] || block)
+
+        unregister(object)
+      end
+    end
+  end
+end

data/lib/shouter/mixin.rb

@@ -0,0 +1,49 @@
+module Shouter
+  module Mixin
+
+    def self.included(base)
+      base.include InstanceMethods
+    end
+
+    module InstanceMethods
+
+      attr_reader :object, :options, :scope
+
+      def initialize(object, options)
+        raise Shouter::ScopeMissingError unless options[:scope]
+
+        @object = object
+        @options = options
+        @scope = options[:scope]
+      end
+
+      private
+
+      def notify?(scope, event)
+        return false unless notification_allowed?(event, scope)
+        return false unless fire_guard!
+        true
+      end
+
+      def unregister(object)
+        Store.unregister(object) if single?
+      end
+
+      def notification_allowed?(event, desired_scope)
+        object.respond_to?(event) && scope == desired_scope
+      end
+
+      def fire_hook!(callback)
+        Shouter::Hook.(callback)
+      end
+
+      def fire_guard!
+        Shouter::Guard.(options[:guard])
+      end
+
+      def single?
+        options[:single] == true
+      end
+    end
+  end
+end

data/lib/shouter/store.rb

@@ -20,7 +20,9 @@ module Shouter
         mutex.synchronize do
           objects.each do |object|
             subscribed_objects = @@listeners.map(&:object)
-            @@listeners << Shouter::Listener.new(object, options) unless subscribed_objects.include?(object)
+            # Got through a builder class based on whether it is a sync or async listener
+            # Should Return Shouter::Listener
+            @@listeners << Shouter::Builder.register(object, options) unless subscribed_objects.include?(object)
           end
         end
       end
@@ -40,7 +42,7 @@ module Shouter
       def notify(scope, event, args, &block)
         return if listeners.empty?
 
-        listeners.each { |listener| listener.notify(scope, event, args, &block) }
+        listeners.each { |listener| listener.notify!(scope, event, args, &block) }
       end
 
       def listeners

data/lib/shouter/version.rb

@@ -1,3 +1,3 @@
 module Shouter
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shouter
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Stefan Slaveykov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-19 00:00:00.000000000 Z
+date: 2017-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,11 +70,12 @@ files:
 - bin/console
 - bin/setup
 - lib/shouter.rb
+- lib/shouter/builder.rb
 - lib/shouter/guard.rb
 - lib/shouter/hook.rb
-- lib/shouter/listener.rb
-- lib/shouter/registry/async.rb
-- lib/shouter/registry/sync.rb
+- lib/shouter/listeners/async.rb
+- lib/shouter/listeners/sync.rb
+- lib/shouter/mixin.rb
 - lib/shouter/store.rb
 - lib/shouter/version.rb
 - shouter.gemspec

data/lib/shouter/listener.rb

@@ -1,57 +0,0 @@
-module Shouter
-
-  class ScopeMissingError < StandardError
-    def initialize
-      'You must supply a scope for running the events'
-    end
-  end
-
-  class Listener
-    attr_reader :object, :options, :scope
-
-    def initialize(object, options)
-      raise Shouter::ScopeMissingError unless options[:scope]
-
-      @object = object
-      @options = options
-      @scope = options[:scope]
-    end
-
-    def notify(scope, event, args, &block)
-      return unless notification_allowed?(event, scope)
-
-      if fire_guard!
-        object.public_send(event, *args)
-        fire_hook!(callback || block)
-
-        Store.unregister(object) if single?
-      end
-    end
-
-    private
-
-    def notification_allowed?(event, desired_scope)
-      object.respond_to?(event) && scope == desired_scope
-    end
-
-    def fire_hook!(callback)
-      Shouter::Hook.(callback)
-    end
-
-    def fire_guard!
-      Shouter::Guard.(guard)
-    end
-
-    def callback
-      options[:callback]
-    end
-
-    def single?
-      options[:single] == true
-    end
-
-    def guard
-      options[:guard]
-    end
-  end
-end