rb_event 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b6a449e74893660c85d55027c99b4666b50e832
+  data.tar.gz: eb516d2814e0f973c1d2bcef4894b4b7556d9b74
+SHA512:
+  metadata.gz: 76dec710eea8522d2b11f45b3893c5e56ac921b7906140e5d3bb4592cb298e74d3ff8cfb5da8a8fd9107552ca2e159f347b34606dd88df5d455e015abbc0da6e
+  data.tar.gz: e0d28be7f7e0af0eeb3aecb98c0988b0cb4ff2575efba235cf93519b2979abec4a4bd76fb23e1ec803f2e07276ec91c3f17b65dbd334e805b1510cbc906b56b1

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,116 @@
+CC0 1.0 Universal
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific
+works ("Commons") that the public can reliably and without fear of later
+claims of infringement build upon, modify, incorporate in other works, reuse
+and redistribute as freely as possible in any form whatsoever and for any
+purposes, including without limitation commercial purposes. These owners may
+contribute to the Commons to promote the ideal of a free culture and the
+further production of creative, cultural and scientific works, or to gain
+reputation or greater distribution for their Work in part through the use and
+efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation
+of additional consideration or compensation, the person associating CC0 with a
+Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
+and publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not limited
+to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display, communicate,
+  and translate a Work;
+
+  ii. moral rights retained by the original author(s) and/or performer(s);
+
+  iii. publicity and privacy rights pertaining to a person's image or likeness
+  depicted in a Work;
+
+  iv. rights protecting against unfair competition in regards to a Work,
+  subject to the limitations in paragraph 4(a), below;
+
+  v. rights protecting the extraction, dissemination, use and reuse of data in
+  a Work;
+
+  vi. database rights (such as those arising under Directive 96/9/EC of the
+  European Parliament and of the Council of 11 March 1996 on the legal
+  protection of databases, and under any national implementation thereof,
+  including any amended or successor version of such directive); and
+
+  vii. other similar, equivalent or corresponding rights throughout the world
+  based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
+and Related Rights and associated claims and causes of action, whether now
+known or unknown (including existing as well as future claims and causes of
+action), in the Work (i) in all territories worldwide, (ii) for the maximum
+duration provided by applicable law or treaty (including future time
+extensions), (iii) in any current or future medium and for any number of
+copies, and (iv) for any purpose whatsoever, including without limitation
+commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
+the Waiver for the benefit of each member of the public at large and to the
+detriment of Affirmer's heirs and successors, fully intending that such Waiver
+shall not be subject to revocation, rescission, cancellation, termination, or
+any other legal or equitable action to disrupt the quiet enjoyment of the Work
+by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+judged legally invalid or ineffective under applicable law, then the Waiver
+shall be preserved to the maximum extent permitted taking into account
+Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
+is so judged Affirmer hereby grants to each affected person a royalty-free,
+non transferable, non sublicensable, non exclusive, irrevocable and
+unconditional license to exercise Affirmer's Copyright and Related Rights in
+the Work (i) in all territories worldwide, (ii) for the maximum duration
+provided by applicable law or treaty (including future time extensions), (iii)
+in any current or future medium and for any number of copies, and (iv) for any
+purpose whatsoever, including without limitation commercial, advertising or
+promotional purposes (the "License"). The License shall be deemed effective as
+of the date CC0 was applied by Affirmer to the Work. Should any part of the
+License for any reason be judged legally invalid or ineffective under
+applicable law, such partial invalidity or ineffectiveness shall not
+invalidate the remainder of the License, and in such case Affirmer hereby
+affirms that he or she will not (i) exercise any of his or her remaining
+Copyright and Related Rights in the Work or (ii) assert any associated claims
+and causes of action with respect to the Work, in either case contrary to
+Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+  a. No trademark or patent rights held by Affirmer are waived, abandoned,
+  surrendered, licensed or otherwise affected by this document.
+
+  b. Affirmer offers the Work as-is and makes no representations or warranties
+  of any kind concerning the Work, express, implied, statutory or otherwise,
+  including without limitation warranties of title, merchantability, fitness
+  for a particular purpose, non infringement, or the absence of latent or
+  other defects, accuracy, or the present or absence of errors, whether or not
+  discoverable, all to the greatest extent permissible under applicable law.
+
+  c. Affirmer disclaims responsibility for clearing rights of other persons
+  that may apply to the Work or any use thereof, including without limitation
+  any person's Copyright and Related Rights in the Work. Further, Affirmer
+  disclaims responsibility for obtaining any necessary consents, permissions
+  or other rights required for any use of the Work.
+
+  d. Affirmer understands and acknowledges that Creative Commons is not a
+  party to this document and has no duty or obligation with respect to this
+  CC0 or use of the Work.
+
+For more information, please see
+<http://creativecommons.org/publicdomain/zero/1.0/>

data/README.md

@@ -0,0 +1,146 @@
+# RbEvent
+[![Gem Version](https://badge.fury.io/rb/rb_event.svg)](https://badge.fury.io/rb/rb_event)
+[![Build Status](https://travis-ci.org/sputnikgugja/rb_event.svg?branch=master)](https://travis-ci.org/sputnikgugja/rb_event)
+[![Coverage Status](https://coveralls.io/repos/github/sputnikgugja/RbEvent/badge.svg?branch=master)](https://coveralls.io/github/sputnikgugja/rb_event?branch=master)
+
+Simple event
+
+You can use event in Ruby like AS3, .Net
+
+```ruby
+require 'rb_event'
+
+class Test
+  include RbEvent
+
+  def say
+    fire_event :said, "Hello? World!"
+  end
+
+  def say_hello(msg)
+    puts msg
+  end
+end
+
+inst = Test.new
+inst.listen :said do |msg|
+  puts msg
+end
+inst.say
+# Hello? World!
+
+inst.listen :said, inst.method(:say_hello)
+inst.say
+# Hello? World!
+```
+
+## Installation
+Run `gem install rb_event` or add `gem 'rb_event'` to your Gemfile
+
+And add to your .rb source file:
+```ruby
+require 'rb_event'
+```
+
+## Usage
+Add `include RbEvent` to your class, and see below.
+
+### `listen(name, listener=nil, &listener_block)`
+  - name [#to_sym] Event name
+  - listener [#call]
+
+Adds an event listener and returns the listener added.
+
+listener 'or' listener_block required.
+
+Also aliased as: `add_listener`
+
+### `unlisten(name, listener)`
+Removes an event listener.
+
+Also aliased as: `remove_listener`
+
+### `listen?(name, listener)`
+Checks the listener is added.
+
+Also aliased as: `has_listener?`.
+
+### protected `fire_event(name, *args)`
+Calls listeners
+
+## Example
+
+### Block listener
+
+```ruby
+require 'rb_event'
+
+class Test
+  include RbEvent
+
+  def say
+    fire_event :said, "Hello? World!"
+  end
+end
+
+inst = Test.new
+inst.listen :said do |msg|
+  puts msg
+end
+inst.say
+# Hello? World!
+```
+
+### Method as a listener
+```ruby
+require 'rb_event'
+
+class Test
+  include RbEvent
+  
+  def say_hello(msg)
+    puts msg
+  end
+end
+
+inst.listen :said, inst.method(:say_hello)
+inst.say
+# Hello? World!
+```
+
+### Remove event listener
+```ruby
+require 'rb_event'
+
+class Test
+  include RbEvent
+end
+
+# Works with every listener type (Block, Proc, Method ...)
+inst = Test.new # <RbEvent::Listener: ...>
+listener = inst.listen(:test) {}
+puts inst.listen?(:test, listener) # true
+inst.unlisten :test, listener
+
+# Proc
+p = Proc.new {}
+inst.listen :test, p
+puts inst.listen?(:test, p) # true
+inst.unlisten :test, p
+
+# Method
+def callback
+end
+inst.listen :test, method(:callback)
+puts inst.listen?(:test, method(:callback)) # true
+inst.unlisten :test, method(:callback)
+```
+
+## Author
+Sputnik Gugja (sputnikgugja@gmail.com)
+
+## License
+This is free software released into the public domain (CC0 license).
+
+See `LICENSE` file.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "rspec/core/rake_task"
+
+# Default pattern is 'spec/**{,/*/**}/*_spec.rb'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/rb_event.rb

@@ -0,0 +1,80 @@
+module RbEvent
+	VERSION = '0.3.2'.freeze
+	
+	# Adds an event listener
+	# 
+	# listener 'or' listener_block required.
+	# 
+	# @param [#to_sym] name the name of event
+	# @param [#call] listener
+	# @return [#call] The listener added
+	# 
+	# @raise [ArgumentError]
+	def listen(name, listener=nil, &listener_block)
+		if listener.nil? && listener_block.nil?
+			raise ArgumentError, "listener is nil and block is not given"
+		elsif !listener.nil? && !listener_block.nil?
+			raise ArgumentError, "Both listener and block is given"
+		end
+		
+		if !listener.nil? && !listener.respond_to?(:call)
+			raise ArgumentError, "Invalid listener: #{listener.inspect} not responded to :call"
+		end
+		listener ||= listener_block
+		
+		name = name.to_sym
+		unless rb_event_listeners.key?(name)
+			rb_event_listeners[name] = []
+		end
+		rb_event_listeners[name] << listener
+		listener
+	end
+	alias_method :add_listener, :listen
+	
+	# Removes an event listener
+	# 
+	# @param [#to_sym] name The name of event
+	# @param [#call] listener
+	# @return [void]
+	def unlisten(name, listener)
+		name = name.to_sym
+		return nil unless rb_event_listeners.key?(name)
+		rb_event_listeners[name].delete listener
+		if rb_event_listeners[name].empty?
+			rb_event_listeners.delete(name)
+		end
+		nil
+	end
+	alias_method :remove_listener, :unlisten
+	
+	# Check the listener is added
+	# 
+	# @param [#to_sym] name The name of event
+	# @param [#call] listener
+	# @return [Boolean]
+	def listen?(name, listener)
+		name = name.to_sym
+		return false unless rb_event_listeners.key?(name)
+		rb_event_listeners[name].include? listener
+	end
+	alias_method :has_listener?, :listen?
+
+private
+	# Gets event listeners
+	# @return [Hash]
+	# @note rb_event_listeners[<event-name>]
+	def rb_event_listeners
+		@rb_event_listeners ||= Hash.new
+	end
+	
+protected
+	# Calls listeners
+	# @param [#to_sym] name
+	# @param [Array] args
+	def fire_event(name, *args)
+		name = name.to_sym
+		return nil unless rb_event_listeners.key?(name)
+		rb_event_listeners[name].each { |e| e.call(*args) }
+		nil
+	end
+end

data/spec/rb_event_spec.rb

@@ -0,0 +1,90 @@
+require_relative 'spec_helper'
+
+describe RbEvent do
+	let(:klass) do
+		Class.new do
+			include RbEvent
+
+			def fire(name, *args)
+				fire_event(name, *args)
+			end
+
+			attr_accessor :flag
+			def set_flag(val)
+				@flag = val
+			end
+		end
+	end
+
+	let(:instance) do
+		klass.new
+	end
+
+	describe 'RbEvent#listen' do
+		it 'pass block' do
+			flag = false
+			instance.listen :listen_test do |val|
+				flag = val
+			end
+			instance.fire :listen_test, true
+			flag.should be true
+		end
+
+		it 'pass proc' do
+			flag = false
+			instance.listen(:listen_test, proc { |val| flag = val })
+			instance.fire :listen_test, true
+			flag.should be true
+		end
+
+		it 'pass method' do
+			instance.flag = false
+			instance.listen :listen_test, instance.method(:set_flag)
+			instance.fire :listen_test, true
+			instance.flag.should be true
+		end
+	end
+
+	describe 'RbEvent#unlisten' do
+		it 'pass listener' do
+			flag = false
+			l = instance.listen :unlisten_test do |val|
+				flag = val
+			end
+			instance.unlisten :unlisten_test, l
+			instance.fire :unlisten_test, true
+			flag.should be false
+		end
+
+		it 'pass method' do
+			instance.flag = false
+			instance.listen :unlisten_test, instance.method(:set_flag)
+			instance.unlisten :unlisten_test, instance.method(:set_flag)
+			instance.fire :unlisten_test, true
+			instance.flag.should be false
+		end
+	end
+
+	describe 'RbEvent#listen?' do
+		it 'pass listener' do
+			l = instance.listen(:has_listener_test) {}
+			instance.listen?(:has_listener_test, l).should be true
+		end
+
+		it 'pass method' do
+			l = instance.listen :has_listener_test, instance.method(:set_flag)
+			instance.listen?(:has_listener_test, instance.method(:set_flag)).should be true
+		end
+	end
+
+	describe 'RbEvent#fire_event' do
+		it 'only call events of the name' do
+			flag = false
+			instance.listen :an_event do
+				flag = true
+			end
+			instance.fire :another_event
+			flag.should be false
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'rb_event'
+require 'rspec'

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: rb_event
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Sputnik Gugja
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple event library. You can use event in Ruby like AS3, .Net
+email:
+- sputnikgugja@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rb_event.rb
+- spec/rb_event_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sputnikgugja/rb_event
+licenses:
+- CC0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.3
+signing_key: 
+specification_version: 4
+summary: Ruby with event
+test_files:
+- spec/spec_helper.rb
+- spec/rb_event_spec.rb
+has_rdoc: