opal-eventable 0.0.1

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,76 @@
+# opal-eventable
+
+An eventable module for opal (and ruby) applications.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "opal-eventable"
+```
+
+Then, inside your opal code:
+
+```ruby
+require "opal-eventable"
+```
+
+## Usage
+
+```ruby
+require "opal-eventable"
+
+class Person
+  include Eventable
+
+  def name=(name)
+    @name = name
+    trigger(:change_name, name)
+  end
+
+  def sign_in
+    @signed_in = true
+    trigger(:sign_in)
+  end
+
+end
+
+p = Person.new
+
+p.on(:change_name) { |old, new| puts "changed name from #{old.inspect} to #{new.inspect}" }
+p.on(:sign_in) { puts "signed in!" }
+
+p.name = "Adam"
+p.sign_in
+p.name = "Ben"
+
+# prints:
+# changed name from nil to "Adam"
+# signed in!
+# changed name from "Adam" to "Ben"
+```
+
+## License
+
+(The MIT License)
+
+Copyright (C) 2013 by Adam Beynon
+
+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/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler'
+Bundler.require
+
+require 'opal/spec/rake_task'
+Opal::Spec::RakeTask.new(:default)

data/lib/opal-eventable.rb

@@ -0,0 +1,5 @@
+require 'opal'
+require 'opal-eventable/version'
+
+# Just register our opal code path with opal build tools
+Opal.append_path File.expand_path('../../opal', __FILE__)

data/lib/opal-eventable/version.rb

@@ -0,0 +1,3 @@
+module OpalEventable
+  VERSION = '0.0.1'
+end

data/lib/opal/eventable.rb

@@ -0,0 +1 @@
+require 'opal-eventable'

data/opal-eventable.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
+require 'opal-eventable/version'
+
+Gem::Specification.new do |s|
+  s.name         = 'opal-eventable'
+  s.version      = OpalEventable::VERSION
+  s.author       = 'Adam Beynon'
+  s.email        = 'adam.beynon@gmail.com'
+  s.homepage     = 'http://opalrb.org'
+  s.summary      = 'Eventable module for Opal.'
+  s.description  = 'Eventable module for Opal'
+
+  s.files          = `git ls-files`.split("\n")
+  s.executables    = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.test_files     = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths  = ['lib']
+
+  s.add_dependency 'rake'
+  s.add_dependency 'opal', '~> 0.3.44'
+
+  s.add_development_dependency 'opal-spec'
+end

data/opal/opal-eventable.rb

@@ -0,0 +1,34 @@
+# A simple event registering/triggering module to mix into classes.
+# Events are stored in the `@events` ivar.
+module Eventable
+
+  # 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
+  end
+
+  def off(name, handler)
+    if @eventable and evts = @eventable[name]
+      evts.delete handler
+    end
+  end
+
+  # Trigger the given event name and passes all args to each handler
+  # for this event.
+  #
+  #   obj.trigger(:foo)
+  #   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) }
+  end
+end

data/spec/eventable_spec.rb

@@ -0,0 +1,94 @@
+require 'opal-eventable'
+
+class EventableSpec
+  include Eventable
+
+  def events
+    @eventable
+  end
+end
+
+describe Eventable do
+
+  let(:obj) { EventableSpec.new }
+
+  describe "#on" do
+    it "should register event handlers for given name" do
+      handler = Proc.new {}
+      obj.on(:foo, &handler)
+      obj.events[:foo].should == [handler]
+    end
+
+    it "returns the given handler" do
+      handler = Proc.new {}
+      obj.on(:foo, &handler).should eq(handler)
+    end
+  end
+
+  describe "#off" do
+    it "has no affect if no handlers defined at all" do
+      obj.off(:bar, proc {})
+      obj.on(:foo) { raise "err" }
+      obj.off(:bar, proc {})
+    end
+
+    it "removes the handler for the event" do
+      called = false
+      handler = obj.on(:foo) { called = true }
+
+      obj.off(:foo, handler)
+      obj.trigger(:foo)
+      called.should be_false
+    end
+  end
+
+  describe "#trigger" do
+    it "should call handler" do
+      called = false
+
+      obj.on(:foo) { called = true }
+      called.should == false
+
+      obj.trigger(:foo)
+      called.should == true
+    end
+
+    it "should pass all arguments to handler" do
+      args = nil
+      obj.on(:foo) { |*a| args = a }
+
+      obj.trigger(:foo)
+      args.should == []
+
+      obj.trigger(:foo, 1)
+      args.should == [1]
+
+      obj.trigger(:foo, 1, 2, 3)
+      args.should == [1, 2, 3]
+    end
+
+    it "should allow multiple different events to be registered" do
+      result = []
+      obj.on(:foo) { result << :foo }
+      obj.on(:bar) { result << :bar }
+
+      obj.trigger(:foo)
+      result.should == [:foo]
+
+      obj.trigger(:bar)
+      result.should == [:foo, :bar]
+    end
+
+    it "should allow multiple handlers for an event" do
+      count = 0
+
+      obj.on(:foo) { count += 1 }
+      obj.on(:foo) { count += 1 }
+      obj.on(:foo) { count += 1 }
+      obj.on(:foo) { count += 1 }
+      obj.trigger(:foo)
+
+      count.should == 4
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: opal-eventable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Adam Beynon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opal
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.44
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.44
+- !ruby/object:Gem::Dependency
+  name: opal-spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Eventable module for Opal
+email: adam.beynon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/opal-eventable.rb
+- lib/opal-eventable/version.rb
+- lib/opal/eventable.rb
+- opal-eventable.gemspec
+- opal/opal-eventable.rb
+- spec/eventable_spec.rb
+homepage: http://opalrb.org
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Eventable module for Opal.
+test_files:
+- spec/eventable_spec.rb