microevent 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5c0e175d5a47fc6de82d73f5d6133b8fbfdbcb8
+  data.tar.gz: 126873406a1970cf956d6de3755dd078c0e2a814
+SHA512:
+  metadata.gz: c212bf4db92b625537a8b4d5670050afb766237d93267ef0989b3a663442c594057d37db5ecdaef775d478011e471a71eeae455771611661fd9dfa0741f8cafb
+  data.tar.gz: 8db662bbc7f8a8f4d69030f5ab167adcece813a009953623ecdd09040290114805acbfe060d6487beacf227e40d0bab98ed21fb972fd95d201546779bd692d86

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+script: ruby spec/*
+
+rvm:
+- 2.2.1
+- 2.2.0
+- 2.1.5
+- 2.1.4
+- 2.1.3
+- 2.1.2
+- 2.1.1
+- 2.1.0
+- 2.0.0
+- rbx-2
+- jruby-head
+

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+### 1.0.0
+
+* Release
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,14 @@
+PATH
+  remote: .
+  specs:
+    microevent (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  microevent!

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Jan Lelis
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# MicroEvent.rb [![[travis]](https://travis-ci.org/janlelis/microevent.rb.png)](https://travis-ci.org/janlelis/microevent.rb)
+
+MicroEvent.rb is a event emitter library which provides the observer pattern to Ruby objects. It is inspired by [MicroEvent.js](https://github.com/jeromeetienne/microevent.js), implemented in less than [20 lines of Ruby](https://github.com/janlelis/microevent.rb/blob/master/lib/microevent.rb).
+
+
+## Setup
+
+Add to your `Gemfile`
+
+```ruby
+gem 'microevent'
+```
+
+or copy the [source file](https://github.com/janlelis/microevent.rb/blob/master/lib/microevent.rb) into your project.
+
+## How to Use It
+
+Suppose you got a class `Klass`, and you wish it to support the observer partern, do
+
+```ruby
+class Klass
+  include MicroEvent
+end
+```
+
+That's it. Now all instances of this class can `#bind`, `#unbind` and `trigger`:
+
+```ruby
+fn = proc{ puts "Go" }
+object = Klass.new
+object.bind :slot, &fn
+object.trigger :slot # => Go
+```
+
+You could also use it on class/singleton level:
+
+```ruby
+class Klass
+  extend MicroEvent
+end
+
+Klass.bind :slot do
+  puts "Go"
+end
+
+Klass.trigger :slot # => Go
+```
+
+You will find more examples in the [tests](https://github.com/janlelis/microevent.rb/blob/master/spec/microevent_test.rb).
+
+## MIT License
+
+Ruby version by [Jan Lelis](http://janlelis.com). Inspired by [MicroEvent.js](https://github.com/jeromeetienne/microevent.js) by Jerome Etienne.

data/lib/microevent.rb

@@ -0,0 +1,18 @@
+module MicroEvent
+  VERSION = "1.0.0".freeze
+
+  def bind(event, &fn)
+    @_ ||= Hash.new{ |h,k| h[k] = [] }
+    fn ? @_[event] << fn : raise(ArgumentError, "no block given")
+  end
+
+  def unbind(event, &fn)
+    @_ ||= Hash.new{ |h,k| h[k] = [] }
+    fn ? @_[event].delete(fn) : @_.delete(event) || []
+  end
+
+  def trigger(event, *args)
+    @_ ||= Hash.new{ |h,k| h[k] = [] }
+    !@_[event].each{ |fn| instance_exec(*args, &fn) }.empty?
+  end
+end

data/microevent.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/microevent', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "microevent"
+  gem.version       = MicroEvent::VERSION
+  gem.summary       = 'MicroEvent.rb is a event emitter library which provides the observer pattern to Ruby objects.'
+  gem.description   = 'MicroEvent.rb is a event emitter library which provides the observer pattern to Ruby objects. It is inspired by[MicroEvent.js and implemented in less than 20 lines of Ruby.'
+  gem.license       = "MIT"
+  gem.authors       = ["Jan Lelis"]
+  gem.email         = "mail@janlelis.de"
+  gem.homepage      = "https://github.com/janlelis/microevent.rb"
+
+  gem.files         = Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+end

data/spec/microevent_spec.rb

@@ -0,0 +1,218 @@
+require_relative '../lib/microevent'
+require 'minitest/autorun'
+
+describe MicroEvent do
+  let :object do
+    object = Object.new
+    object.extend(MicroEvent)
+    object
+  end
+
+  it "works" do
+    result = []
+
+    fn = proc{ result << 42 }
+    object.bind :slot, &fn
+    object.trigger :slot
+
+    assert_equal [42], result
+  end
+
+  it "works with blocks" do
+    result = []
+
+    object.bind(:slot){ result << 42 }
+    object.trigger :slot
+
+    assert_equal [42], result
+  end
+
+  it "supports multiple callbacks" do
+    result = []
+
+    fn  = proc{ result << 42 }
+    fn2 = proc{ result << 23 }
+    object.bind :slot, &fn
+    object.bind :slot, &fn2
+    object.trigger :slot
+
+    assert_equal [42, 23], result
+  end
+
+  it "supports multiple of the same callback" do
+    result = []
+
+    fn  = proc{ result << 21 }
+    object.bind :slot, &fn
+    object.bind :slot, &fn
+    object.trigger :slot
+
+    assert_equal [21, 21], result
+  end
+
+  it "only calls the triggered slot" do
+    result = []
+
+    fn  = proc{ result << 42 }
+    object.bind :slot, &fn
+    object.trigger :another_slot
+
+    assert_equal [], result
+  end
+
+  it "works with arguments" do
+    result = []
+
+    fn  = proc{ |add| result << add }
+    object.bind :slot, &fn
+    object.trigger :slot, 42
+
+    assert_equal [42], result
+  end
+
+  it "has access to object's instance variables" do
+    result = []
+    object.instance_variable_set :@var, 42
+
+    fn = proc{ result << @var }
+    object.bind :slot, &fn
+    object.trigger :slot
+
+    assert_equal [42], result
+  end
+
+  it "has access to object's methods" do
+    result = []
+    def object.m() 42 end
+
+    fn = proc{ result << m }
+    object.bind :slot, &fn
+    object.trigger :slot
+
+    assert_equal [42], result
+  end
+
+  describe '#bind details' do
+    it "returns array of callbacks" do
+      fn = proc{}
+      object.bind :slot, &fn
+      result = object.bind :slot, &fn
+
+      assert_equal [fn, fn], result
+    end
+
+    it "willl raise an ArgumentError if no block given" do
+      result = nil
+
+      begin
+        object.bind :slot
+      rescue ArgumentError => result
+      end
+
+      assert_equal ArgumentError, result.class
+    end
+  end
+
+  describe '#unbind details' do
+    it "removes an callback" do
+      result = []
+
+      fn = proc{ result << 42 }
+      object.bind :slot, &fn
+      object.unbind :slot, &fn
+      object.trigger :slot
+
+      assert_equal [], result
+    end
+
+    it "willl removes all instances of this callback" do
+      result = []
+
+      fn = proc{ result << 42 }
+      fn2 = proc{ result << 23 }
+      object.bind :slot, &fn
+      object.bind :slot, &fn2
+      object.bind :slot, &fn
+      object.unbind :slot, &fn
+      object.trigger :slot
+
+      assert_equal [23], result
+    end
+
+    it "will do nothing if there is nothing to remove" do
+      result = []
+
+      object.unbind :slot
+
+      assert_equal [], result
+    end
+
+    it "returns deleted callbacks" do
+      fn = proc{}
+      object.bind :slot, &fn
+      result = object.unbind :slot, &fn
+
+      assert_equal fn, result
+    end
+
+    it "will return nil if nothing is removed" do
+      fn = proc{}
+      result = object.unbind :slot, &fn
+
+      assert_equal nil, result
+    end
+
+    it 'will delete all callbacks if no block is given' do
+      result = []
+
+      fn = proc{ result << 42 }
+      fn2 = proc{ result << 23 }
+      object.bind :slot, &fn
+      object.bind :slot, &fn2
+      object.unbind :slot
+      object.trigger :slot
+
+      assert_equal [], result
+    end
+
+    it 'will return array of deleted callbacks if no block is given' do
+      fn = proc{ result << 42 }
+      fn2 = proc{ result << 23 }
+      object.bind :slot, &fn
+      object.bind :slot, &fn2
+      result = object.unbind :slot
+
+      assert_equal [fn, fn2], result
+    end
+
+    it 'will return emtpy array if no block is given and no callback deleted' do
+      result = object.unbind :slot
+
+      assert_equal [], result
+    end
+  end
+
+  describe '#trigger details' do
+    it "will do nothing if no callback is registered" do
+      result = []
+
+      object.trigger :slot
+
+      assert_equal [], result
+    end
+
+    it "will return true if there is a callback listening" do
+      fn = proc{}
+      object.bind :slot, &fn
+      result = object.trigger :slot
+
+      assert_equal true, result
+    end
+
+    it "will return false if there is no callback listening" do
+      result = object.trigger :slot
+
+      assert_equal false, result
+    end
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: microevent
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jan Lelis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-12 00:00:00.000000000 Z
+dependencies: []
+description: MicroEvent.rb is a event emitter library which provides the observer
+  pattern to Ruby objects. It is inspired by[MicroEvent.js and implemented in less
+  than 20 lines of Ruby.
+email: mail@janlelis.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE.txt
+- README.md
+- lib/microevent.rb
+- microevent.gemspec
+- spec/microevent_spec.rb
+homepage: https://github.com/janlelis/microevent.rb
+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.4.5
+signing_key: 
+specification_version: 4
+summary: MicroEvent.rb is a event emitter library which provides the observer pattern
+  to Ruby objects.
+test_files:
+- spec/microevent_spec.rb
+has_rdoc: