edrive 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cd4944abb890c46f40eb1bf9e27fc83df7c5fe2e3e8d698a1463783e670af9b
-  data.tar.gz: 54ec78f62a48010a9b07b2a26b8e769b43b6cd088d2929a4aaeef83a712c2075
+  metadata.gz: 196413aba8d4ffa5a125864721625ffbdaf52acc1126dfcb09e27762cea3c98c
+  data.tar.gz: f35cdc6664c68a55282a1c9636774253cb1a10c93c8df56f8f016a34e2c8ee1c
 SHA512:
-  metadata.gz: 25647f39711646dd577a39a8c723afdcec6cb7ef7b60222c2a3080663b83557497fadb6da046602161e8fa825346b167ff4a32bad33d617fb12b140b77ac945a
-  data.tar.gz: d2c82215cc2217930d405bda18b196bbb9fd4197936e3a46c613ff606ab0824905de5d3c7dc00a6bfbd0e133e5fdb1ef38b716badb9123066c210fee63cb14d7
+  metadata.gz: 1d675ce3010139efba5432263c5e314374e62dce68baa4678971fe4d3a914d86ab9b271dd0d2b1899c7bf70cc1a6f2ce50b2a520d74144c9ffc13a9e2a51f2d1
+  data.tar.gz: 7243170413423430eb590518cdd7c697ed41bfc56db5b8e5592a56f128af2fc4c87944fd4ffb38ac5fe0fabf067bd1f8005642af6243879dd6b75fc18ba5e09e

data/.gitignore

@@ -0,0 +1,3 @@
+pkg
+coverage
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    edrive (1.0.0)
+    edrive (1.0.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,8 @@
 # Edrive
 
-We provide simple event dispatcher mechanism for your ruby products.
+[![Gem Version](https://badge.fury.io/rb/edrive.svg)](https://badge.fury.io/rb/edrive)
+
+Provide simple event dispatcher mechanism for all of ruby products.
 
 ## Installation
 
@@ -24,10 +26,10 @@ Or install it yourself as:
 
 ```ruby
 dispatcher = Edrive::Dispatcher.new
-dispatcher.subscribe(:event, -> { puts 1 })
-dispatcher.subscribe(:event, -> { puts 2 })
-dispatcher.subscribe(:event, -> { puts 3 })
-dispatcher.dispatch(:event)
+dispatcher.on(:event, -> { puts 1 })
+dispatcher.on(:event, -> { puts 2 })
+dispatcher.on(:event, -> { puts 3 })
+dispatcher.fire(:event)
 
 1
 2
@@ -38,11 +40,11 @@ dispatcher.dispatch(:event)
 
 ```ruby
 dispatcher = Edrive::Dispatcher.new
-dispatcher.subscribe(:event, ->(data) { data + 1 })
-dispatcher.subscribe(:event, ->(data) { data + 2 })
-dispatcher.subscribe(:event, ->(data) { data + 3 })
-dispatcher.subscribe(:event, ->(data) { puts data })
-dispatcher.dispatch_with_data(:event, 100)
+dispatcher.on(:event, ->(data) { data + 1 })
+dispatcher.on(:event, ->(data) { data + 2 })
+dispatcher.on(:event, ->(data) { data + 3 })
+dispatcher.on(:event, ->(data) { puts data })
+dispatcher.fire_with_data(:event, 100)
 
 106
 ```
@@ -51,10 +53,10 @@ dispatcher.dispatch_with_data(:event, 100)
 
 ```ruby
 dispatcher = Edrive::Dispatcher.new
-dispatcher.subscribe_block(:event) { puts 1 }
-dispatcher.subscribe_block(:event) { puts 2 }
-dispatcher.subscribe_block(:event) { puts 3 }
-dispatcher.dispatch(:event)
+dispatcher.on(:event) { puts 1 }
+dispatcher.on(:event) { puts 2 }
+dispatcher.on(:event) { puts 3 }
+dispatcher.fire(:event)
 
 1
 2
@@ -65,10 +67,10 @@ dispatcher.dispatch(:event)
 
 ```ruby
 dispatcher = Edrive::Dispatcher.new
-dispatcher.subscribe_block(:event) { |data| data + 1 }
-dispatcher.subscribe_block(:event) { |data| data + 2 }
-dispatcher.subscribe_block(:event) { |data| data + 3 }
-dispatcher.dispatch_with_data(:event, 100)
+dispatcher.on(:event) { |data| data + 1 }
+dispatcher.on(:event) { |data| data + 2 }
+dispatcher.on(:event) { |data| data + 3 }
+dispatcher.fire(:event, 100)
 
 106
 ```
@@ -76,13 +78,13 @@ dispatcher.dispatch_with_data(:event, 100)
 ### clear target event
 
 ```ruby
-dispatcher.clear_subscribers!(:event)
+dispatcher.clear!(:event)
 ```
 
 ### clean all event
 
 ```ruby
-dispatcher.clear_all_subscribers!
+dispatcher.clear_all!
 ```
 
 ## Development

data/edrive.gemspec

@@ -9,8 +9,12 @@ Gem::Specification.new do |spec|
   spec.authors       = ["MichinaoShimizu"]
   spec.email         = ["shimizu.michinao@gmail.com"]
 
-  spec.summary       = %q{Generic Event Dispatcher}
-  spec.description   = %q{Generic Event Dispatcher}
+  spec.summary       = %q{Generic Event Dispatcher. Provide simple event dispatcher mechanism for all of ruby products.
+
+  }
+  spec.description   = %q{Generic Event Dispatcher. Provide simple event dispatcher mechanism for all of ruby products.
+
+  }
   spec.homepage      = "https://github.com/MichinaoShimizu/edrive"
   spec.license       = "MIT"
 

data/lib/edrive/dispatcher.rb

@@ -2,85 +2,72 @@ module Edrive
   # Simple Event Dispatcher
   # @author Michinao Shimizu <shimizu.michinao@gmail.com>
   class Dispatcher
-    attr_accessor :event_listeners
-
     # initialize
     def initialize
-      @event_listeners = {}
+      @events = {}
     end
 
-    # Subscribe with proc, lambda
+    # regist handler (proc, lambda, block)
     # @param [Symbol] event event name symbol
-    # @param [Proc] subscriber subscriber
+    # @param [Proc] handler handler (lambda, proc)
+    # @param [Block] block handler (block)
     # @raise ArgumentError
-    # @return [Array] registered subscriber list
-    def subscribe(event, subscriber)
-      raise ArgumentError, 'subscriber must be Proc object' unless subscriber.is_a?(Proc)
-      regist_subscriber_proc(event, subscriber)
+    # @return [Array] registered handler list
+    def on(event, handler = nil, &block)
+      hdl = block_given? ? block : handler
+      raise ArgumentError, 'handler must be Proc object' unless hdl.is_a?(Proc)
+      regist(event, hdl)
     end
 
-    # Subscribe with block
-    # @param [Symbol] event event name symbol
-    # @param [Block] subscriber subscriber
-    # @return [Array] registered subscriber list
-    def subscribe_block(event, &subscriber)
-      regist_subscriber_proc(event, subscriber)
-    end
-
-    # Dispatch specific event subscribers
+    # dispatch specific event handler
     # @param [Symbol] event event name
     # @param [Mixed] args
-    # @return [Mixed] last subscriber return value
-    def dispatch(event, *args)
+    # @return [Mixed] last handler return value
+    def fire(event, *args)
       result = nil
-
-      @event_listeners[event]&.each do |subscriber|
-        result = subscriber.call(*args)
-      end
+      @events[event]&.each { |hdl| result = hdl.call(*args) }
       result
     end
 
-    # Dispatch specific event subscribers with data
+    # dispatch specific event handlers with data
     # @param [Symbol] event event name
     # @param [Mixed] args
-    # @return [Mixed] last subscriber return value
-    def dispatch_with_data(event, data, *args)
+    # @return [Mixed] last handler return value
+    def fire_with_data(event, data, *args)
       result = data.dup
-      @event_listeners[event]&.each do |subscriber|
-        result = subscriber.call(result, *args)
-      end
+      @events[event]&.each { |hdl| result = hdl.call(result, *args) }
       result
     end
 
-    # Get specific event subscribers
+    # get event handlers
     # @param [Symbol] event event name symbol
-    # @return [Array] registered subscriber list
-    def subscribers(event)
-      @event_listeners[event] || []
+    # @return [Array] registered handler list
+    def handlers(event)
+      @events[event] || []
     end
 
-    # Clear specific event subscribers
+    # clear event handlers
     # @param [Symbol] event event name symbol
     # @return [Array] emnpty array
-    def clear_subscribers!(event)
-      @event_listeners[event] = []
+    def clear!(event)
+      @events[event] = []
     end
 
-    # Clear all of event subscribers
+    # clear all of event handlers
     # @return [Hash] emnpty hash
-    def clear_all_subscribers!
-      @event_listeners = {}
+    def clear_all!
+      @events = {}
     end
 
     private
 
-    # Regist subscriber proc
+    # regist hanlder to target event
     # @param [Symbol] event event name symbol
-    # @param [Proc] subscriber subscriber
-    # @return [Array] registered subscriber list
-    def regist_subscriber_proc(event, subscriber)
-      @event_listeners[event] ||= []
-      @event_listeners[event] << subscriber
+    # @param [Proc] handler handler
+    # @return [Array] registered handler list
+    def regist(event, handler)
+      @events[event] ||= []
+      @events[event] << handler
     end
   end
 end

data/lib/edrive/version.rb

@@ -1,3 +1,3 @@
 module Edrive
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: edrive
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - MichinaoShimizu
@@ -52,13 +52,15 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Generic Event Dispatcher
+description: "Generic Event Dispatcher. Provide simple event dispatcher mechanism
+  for all of ruby products.\n\n  "
 email:
 - shimizu.michinao@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -94,5 +96,6 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Generic Event Dispatcher
+summary: Generic Event Dispatcher. Provide simple event dispatcher mechanism for all
+  of ruby products.
 test_files: []