event-framework 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3cbda10e80b6df93d13f522cefa9ed3abb171275
+  data.tar.gz: 93f72136192172841a40c7bbaae3fd16c95a331d
+SHA512:
+  metadata.gz: f62d9fcb4efebc163969330c73e1711d4d874b670abd346d643943516c5493b1bae7465342ca740d51d29cb5a089721df13595c8df21fdd2ab69edf7e6ccc651
+  data.tar.gz: e19680345421584544dd0562781573a4ef2b9be0ce59d68c5bf6e4411eaaf7c5e005287184248a93836a7d4514a28f7bcb3448559045eb9770acb8a967ab89c0

data/lib/event-framework.rb

@@ -0,0 +1,218 @@
+##
+# = Event Framework
+#
+# Event Framework is a minimalistic library providing publish–subscribe pattern
+#
+# === Example
+#
+#  require_relative 'event-framework'
+#
+#  class Server
+#    include EF::Object
+#  end
+#
+#  class Client
+#    include EF::Object
+#  end
+#
+#  server = Server.new
+#  client = Client.new
+#
+#  EF::Thread.new do
+#    loop do
+#      sleep 1
+#      server.trigger('event', 'message')
+#    end
+#  end
+#
+#  EF::Thread.new do
+#    client.listen_to(server, 'event') do |server, message|
+#      puts message
+#    end
+#  end
+#
+#  EF::Loop.loop
+#
+# === Notices
+#
+# * EF::Object should be included after initialize
+# * Callbacks will be executed in threads of subscribers (where they were defined)
+module EF
+  ##
+  # === provides threads with separated event loops
+  class Thread < ::Thread
+    ##
+    # returns instances of EF::Thread
+    def self.instances
+      ObjectSpace.each_object(self).to_a
+    end
+
+    ##
+    # creates a thread <br>
+    # parameters will be passed to the block
+    def initialize(*args, &block)
+      @queue = Queue.new
+
+      super do
+        block.call *args if block_given?
+
+        while true
+          args, block = @queue.pop
+          block.call *args
+        end
+      end
+    end
+
+    ##
+    # adds a task which will be executed in the event loop <br>
+    # parameters will be passed to the block
+    def add(*args, &block)
+      raise 'block not given' unless block_given?
+      @queue << [args, block]
+    end
+  end
+
+  ##
+  # === provides blocking event loop
+  module Loop
+    @@thread = nil
+
+    ##
+    # starts the loop
+    def self.loop
+      @@thread = Thread.new
+      @@thread.value
+    end
+
+    ##
+    # returns corresponding EF::Thread object <br>
+    # which you can use to add new tasks
+    def self.thread
+      @@thread
+    end
+  end
+
+  ##
+  # === provides methods for publish–subscribe pattern
+  module Object
+    ##
+    # patches initialize to admix needed variables
+    def self.included(base)
+      base.class_exec do
+        alias alias_initialize initialize
+
+        ##
+        # defines needed variables and calls original initialize
+        def initialize(*args, &block)
+          alias_initialize *args, &block
+
+          @mutex = Mutex.new
+
+          @thread = Thread.current
+
+          @observers = []
+          @observables = []
+        end
+      end
+    end
+
+    ##
+    # returns the thread where the object was defined
+    def thread
+      @thread
+    end
+
+    ##
+    # calls handlers for observers for the event <br>
+    # parameters and the caller will be passed to the handlers <br>
+    # notice: usually in threads of sibscribers
+    def trigger(event, *args)
+      raise 'event is not string' unless event.is_a? String
+
+      @mutex.synchronize do
+        @observers.each do |o, e, b|
+          if e == event
+            if Thread.instances.include? o.thread
+              o.thread.add self, *args, &b
+            elsif Loop.thread
+              Loop.thread.add self, *args, &b
+            else
+              b.call self, *args
+            end
+          end
+        end
+      end
+    end
+
+    ##
+    # registrate a handler for the event
+    def listen_to(observable, event, &block)
+      raise 'observable is not EF::Object' unless observable.is_a? Object
+      raise 'event is not string' unless event.is_a? String
+      raise 'block not given' unless block_given?
+
+      @mutex.synchronize do
+        @observables << [observable, event, block]
+        observable.registrate(self, event, block)
+      end
+    end
+
+    ##
+    # listen to self
+    def on(event, &block)
+      raise 'event is not string' unless event.is_a? String
+      raise 'block not given' unless block_given?
+
+      @mutex.synchronize do
+        listen_to self, event, &block
+      end
+    end
+
+    ##
+    # unregistrate all matching handlers
+    def stop_listening(observable=nil, event=nil, block=nil)
+      @mutex.synchronize do
+        observables = []
+
+        @observables.each do |o, e, b|
+          if (!observable || o == observable) && (!event || e == event) && (!block || b == block)
+            o.unregistrate(self, e, b)
+          else
+            observables << [o, e, b]
+          end
+        end
+
+        @observables = observables
+      end
+    end
+
+    ##
+    # stop listening to self
+    def off(event=nil, block=nil)
+      @mutex.synchronize do
+        stop_listening self, event, block
+      end
+    end
+
+    protected
+
+    ##
+    # adds observer to the list of observers
+    def registrate(observer, event, block)
+      @mutex.synchronize do
+        @observers << [observer, event, block]
+      end
+    end
+
+    ##
+    # removes observer from the list of observers
+    def unregistrate(observer, event, block)
+      @mutex.synchronize do
+        @observers.reject! do |o, e, b|
+          o == observer && e == event && b == block
+        end
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: event-framework
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Speransky Danil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-04 00:00:00.000000000 Z
+dependencies: []
+description: Event Framework is a minimalistic library providing publish–subscribe
+  pattern
+email: speranskydanil@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/event-framework.rb
+homepage: http://speranskydanil.github.io/ruby-event-framework/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Event Framework is a minimalistic library providing publish–subscribe pattern
+test_files: []