emittable 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8465852e469046443fa431b53e55a596f40e1eb3
-  data.tar.gz: 0d25ef0c9c88b2b58978cb3917e3076ea56c2402
+  metadata.gz: e5c899f8668b16b6b6e51ada5aeddfb6438cdc35
+  data.tar.gz: 100c745cb652db8045df0357516218f52b696858
 SHA512:
-  metadata.gz: 9fe8df7c32e5d9ee57f2d760a6fc1b93c4bddbeee2d16978a6082993813da1097e282447823bcc37b1ad37ba34430d17d7250a512a8c8ffe39082986e2cce864
-  data.tar.gz: 1ed53782740e454931fcd4e3de09e65cdff510146bee68def86a42d1870b9cf5d8846767dcc1827557df9141de84b2c1d9dc1a2ef4cb2c0d3eca7da5b5ae636e
+  metadata.gz: 46569e1acbc0073b5b5b2e3a1becbe40b8c9219988f9ed14494afbef26c2c39579e63d0b2a6695d0a8565f7a1e6ba5fc4fb218d42bd54844d1d0a187c9e1da00
+  data.tar.gz: 5af9ef46b21c056a9da4935f9d758e397349f2bb9837078131f2ddda9ad81ca3f34721669aaa731c77a1b7401d969243ee9debbbae5ee02be35b88cf8933e569

data/README.md

@@ -1,3 +1,56 @@
 # Emittable
-A simple event registering/triggering module to mix into classes.
-Clone of Vienna::Emittable
+A Ruby Gem to register and trigger events. It is a clone of `Vienna::Emittable`.
+
+# Install
+`gem install emittable`
+
+# Example
+First `require 'emittable'` in your project. Then you can `include` `Emittable` in your classes.
+```ruby
+require 'emittable'
+
+class A
+  include Emittable
+  
+  ...
+  ...
+  
+end
+
+a = A.new(...)
+```
+
+To register a new event callback call `on` on an instance of your class, passing the name of the event and a block as the callback. You can add as many callbacks as you want for an event.
+```ruby
+a.on(:shutdown) do
+  ...
+end
+
+a.on(:shutdown) do
+  ...
+  ...
+end
+```
+
+To trigger all the event's callbacks call `trigger`, passing the name of the event.
+```ruby
+a.trigger(:shutdown)
+```
+
+You can also pass arguments to `trigger` that will get passed to a callback block.
+```ruby
+a.on(:shutdown) do |a, b|
+  ...
+end
+
+a.trigger(:shutdown, 1, 2)
+```
+
+To remove a callback you must have already saved a reference to the callback block. You can then call `off`, passing the block.
+```ruby
+callback = proc { ... }
+
+a.on(:shutdown, &callback)
+
+a.off(:shutdown, callback)
+```

data/lib/emittable.rb

@@ -1,24 +1,44 @@
-# Events are stored in the `@events` ivar.
+require 'emittable/error'
+
+
 module Emittable
 
+  def initialize(*args)
+    @emittable_events = {}
+    @emittable_mutex = Mutex.new
+    super
+  end
+  
   # Register a handler for the given event name.
   #
   #   obj.on(:foo) { puts "foo was called" }
   #
   # @param [String, Symbol] name event name
   # @return handler
-  def on(name, &handler)
-    @eventable ||= Hash.new { |hash, key| hash[key] = [] }
-    @eventable[name] << handler
-    handler
+  def on(event_name, &callback)
+    raise ArgumentError, "event name must respond to 'to_s'" unless event_name.respond_to?(:to_s)
+    event_name = event_name.to_s
+    @emittable_mutex.synchronize do
+      @emittable_events[event_name] ||= []
+      callbacks = @emittable_events[event_name]
+      callbacks << callback
+    end
+    nil
   end
-
-  def off(name, handler)
-    if @eventable and evts = @eventable[name]
-      evts.delete handler
+  
+  def off(event_name, callback)
+    raise ArgumentError, "event name must respond to 'to_s'" unless event_name.respond_to?(:to_s)
+    event_name = event_name.to_s
+    @emittable_mutex.synchronize do
+      callbacks = @emittable_events[event_name]
+      raise Error, 'no callbacks found for that event' unless callbacks
+      raise Error, 'callback not found' unless callbacks.include?(callback)
+      callbacks.delete(callback)
+      @emittable_events.delete(event_name) if callbacks.empty?
     end
+    nil
   end
-
+  
   # Trigger the given event name and passes all args to each handler
   # for this event.
   #
@@ -26,9 +46,19 @@ module Emittable
   #   obj.trigger(:foo, 1, 2, 3)
   #
   # @param [String, Symbol] name event name to trigger
-  def trigger(name, *args)
-    @eventable ||= Hash.new { |hash, key| hash[key] = [] }
-    @eventable[name].each { |handler| handler.call(*args) }
+  def trigger(event_name, *args)
+    raise ArgumentError, "event name must respond to 'to_s'" unless event_name.respond_to?(:to_s)
+    event_name = event_name.to_s
+    callbacks = nil
+    @emittable_mutex.synchronize do
+      callbacks = @emittable_events[event_name]
+      raise Error, 'no callbacks found for that event' unless callbacks
+      callbacks = callbacks.dup
+    end
+    # we are outside of the mutex so any callbacks are able to trigger an event from
+    #  this class without deadlock
+    callbacks.each { |callback| callback.call(*args) }
+    nil
   end
   
 end

data/lib/emittable/error.rb

@@ -0,0 +1,4 @@
+module Emittable
+  class Error < StandardError
+  end
+end

data/spec/emittable_spec.rb

@@ -0,0 +1,75 @@
+require 'emittable'
+
+RSpec.describe Emittable do
+  
+  before do
+    RSpec::Mocks.with_temporary_scope do
+      stub_const 'A', Class.new
+      A.class_eval{ include Emittable }
+      @a = A.new
+    end
+  end
+  
+  describe "#on" do
+  
+    context "when adding a callback" do
+      it "should not raise error" do
+        expect{ @a.on(:event) {} }.not_to raise_error
+      end
+    end
+    
+    context "when adding a second callback for same event" do
+      it "should not raise error" do
+        @a.on(:event) {}
+        expect{ @a.on(:event) {} }.not_to raise_error
+      end
+    end
+    
+  end
+  
+  describe "#trigger" do
+  
+    context "when triggering an event" do
+      it "should invoke all callbacks" do
+        $test = []
+        @a.on(:event) { $test << nil }
+        @a.on(:event) { $test << nil }
+        @a.trigger(:event)
+        expect($test.length).to eql 2
+      end
+    end
+    
+    context "when triggering an event with arguments" do
+      it "should invoke all callback with arguments" do
+        @a.on(:event) { |arg| $test = arg }
+        @a.trigger(:event, 1)
+        expect($test).to eql 1
+      end
+    end
+    
+  end
+  
+  describe "#off" do
+  
+    context "when removing an existing callback" do
+      it "should not raise error" do
+        callback = proc {}
+        @a.on(:event, &callback)
+        @a.trigger(:event)
+        expect{ @a.off(:event, callback) }.not_to raise_error
+      end
+    end
+    
+    context "after removing a callback" do
+      it "should sould raise error" do
+        callback = proc {}
+        @a.on(:event, &callback)
+        @a.trigger(:event)
+        @a.off(:event, callback)
+        expect{ @a.trigger(:event) }.to raise_error(Emittable::Error)
+      end
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emittable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Rob Fors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-25 00:00:00.000000000 Z
+date: 2018-04-15 00:00:00.000000000 Z
 dependencies: []
 description: A simple event registering/triggering module to mix into classes.
 email: mail@robfors.com
@@ -19,6 +19,9 @@ files:
 - LICENSE
 - README.md
 - lib/emittable.rb
+- lib/emittable/error.rb
+- spec/emittable_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/robfors/emittable
 licenses:
 - MIT