rbminivents 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 516cebd771ef42bc0233d276a1e9d7cafd2f129b70e6f96c6a1e124537a200a8
-  data.tar.gz: ab39feb59826b236c658261550d3d026abab22f2cd608130fac42f626a83e9fa
+  metadata.gz: '069468a2b42d7e60881c9ee410f04f1934260b404515f0800cb6aa71764ffe01'
+  data.tar.gz: 4b156f5ba2ffec43e0935b6d8b8052e43ea5427f885ab8a86657582ae7cccb9d
 SHA512:
-  metadata.gz: f88f86014ab9421eea8f98a5af2d385bd3e6927b119de5b22067c73b66359058e932bffb45b5caf20563fab042aef56253c271637bd8c268c2b9f16833b388d2
-  data.tar.gz: c3ca2963c64c069b89efa6c2b10f0425184276f3c314a04d95d7e6988474f8654dc8e62d441ec9f7aaabf064c2183564db61add707cfc2f8680c7231f4576753
+  metadata.gz: 6cc90acb5e271b621b3fe4cf3ba1d167d915d2a287c40004c91d77636b5b0348ea821fe9401d8341724877d2ab83ba5e8b2fb913f55d9e61b435232abcd052b1
+  data.tar.gz: 3be1006231fec1b47e6b02912a25b1ca320a1c08391e21ded687911648d3eca469e23a5942ce3c0f1921400ff640772e74ab799e6589235252ab7b239e1c7121

data/README.md

@@ -1,8 +1,9 @@
 # rbminivents
-This gem allows you to create and emit your events very easily and minimalistic.
+This gem allows you to easily use minimalistic events in Ruby.
 
 ## Description
-This gem was made under the influence of the tiny JS library [minivents](https://github.com/allouis/minivents) by [allouis](https://github.com/allouis) that I liked. It seemed to me that it would be nice to transfer this to Ruby.
+This gem was made under the influence of the tiny JS library [minivents](https://github.com/allouis/minivents) by [allouis](https://github.com/allouis) that I liked.
+It seemed to me that it would be quite nice to move something like this to Ruby.
 
 ## Getting started
 
@@ -25,12 +26,11 @@ bundle install
 ```
 
 ## API
-This project is similar to the original one in many ways, but some features are not implemented
-So,
+This project is similar to the original one in many ways, but some features are not implemented. You can use standard ruby mixins for fully functionality. So,
 
-`on`: Listen to event
+`on`: Listen to event. Returns handle
 
-`off`: Stop listening to event
+`off`: Stop listening to event 
 
 `emit`: Emit event
 
@@ -64,9 +64,6 @@ sandbox.on(:event) do |name|
 end
 
 sandbox.emit(:event, 'Max')  #=> Hello, Max!
-# OR
-# when there are > 1 arguments, pass them through the array
-sandbox.emit(:event, ['Max'])  #=> Hello, Max!
 ```
 
 ```ruby
@@ -83,11 +80,42 @@ end
 
 # max, [1, 2, 3], 5 + 7 = 12
 sandbox.emit(:event,
-             [ 
-               {name: 'max'},
-               [1, 2, 3],
-               7,
-               false
-             ]
+             {name: 'max'},
+             [1, 2, 3],
+             7,
+             false
 )
 ```
+
+### Using Off
+```ruby
+require 'rbminivents'
+
+sandbox = RbMinivents::Events.new
+
+handler1 = sandbox.on(:event) do
+  puts "First Hello!"
+end
+
+handler2 = sandbox.on(:event) do
+  puts "Second Hello!"
+end
+
+# remove just this callback
+sandbox.emit(:event)  # => First Hello!\nSecond Hello!
+
+sandbox.off(:event, handler1)
+sandbox.emit(:event)  # => Second Hello!
+
+sandbox.off(:event, handler2)
+sandbox.emit(:event)  # => nothing...
+
+# re-add listener to show can remove all at once
+sandbox.on(:event) do
+  puts "Hello!"
+end
+
+# remove all
+sandbox.off(:event)
+sandbox.emit(:event)  # => nothing again
+```

data/lib/rbminivents.rb

@@ -2,38 +2,26 @@ module RbMinivents
   class Events
 
     def initialize
-      @events = Hash.new
+      @handlers = {}
     end
 
     # On: listen to events
-    def on(type, &prc)
-      sym = type.to_s.to_sym
-
-      @events[sym] = prc if block_given?
-      self
+    def on(name, &handler)
+      @handlers[name] ||= []
+      @handlers[name] << handler
+      handler
     end
 
-    # Off: stop listening to event
-    def off(type)
-      sym = type.to_s.to_sym
-
-      if @events.has_key?(sym)
-        @events.delete(sym)
-      end
-
-      self
+    # Off: stop listening to event / specific callback
+    def off(name, handler)
+      @handlers[name] ||= []
+      @handlers[name].delete(handler)
     end
 
     # Emit: send event, callbacks will be triggered
-    def emit(type, args = nil)
-      sym = type.to_s.to_sym
-
-      if @events.has_key?(sym)
-        @events[sym].call(*args)
-        @events.delete(sym)
-      end
-
-      self
+     def emit(name, *args)
+      @handlers[name] ||= []
+      @handlers[name].each { |handler| handler.call(*args) }
     end
   end
 end

data/lib/rbminivents/version.rb

@@ -1,3 +1,3 @@
 module RbMinivents
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbminivents
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Max Barsukov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-12 00:00:00.000000000 Z
+date: 2021-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop