rbevents 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 120093ba34a6948eb460635604e1bd0dcef60dcf
-  data.tar.gz: f213b08fd409557759a0a43b92533f48d50cadda
+  metadata.gz: 8b4bfd418d2b7bb1a9498a476e928b14b24a62f2
+  data.tar.gz: 35c34018c0886e3dfd67d29eb5a66265c0bed8ae
 SHA512:
-  metadata.gz: 9ed412aac01a34b9c5e2a039a220910fbc34177ab6cf9810a0f85e204db42d007e62f3deb1a5354cd9e3e912abe832d069ce9d01a8dcac7df123eb7ebc79c1e8
-  data.tar.gz: 3a23b58dfcb8eee7da1bb0be0f6bceedc67b229eac692f6f509a7c532743c2175cddcd90b3325ca44ed83f1c8e2cc1fa51adc3765ab03f9a519992c4423bc3c9
+  metadata.gz: 77d19532e77ff61fb62417d8590a305d61ceb840918429730fd806573e63b3eaa54914df1ea178d26dcbd379b9072b807f930edfef5f93cf1636ed2d14d9e514
+  data.tar.gz: e5d1f44f51e3dd97565a585dbc3ad1e78439bb0ee9f6f02726f96e4ff53982b8c0cb2a7ca00b914f955da21797b99eb996bb4d67e4124f88b7fccbdb88f8a623

data/.gitignore

@@ -1,18 +1,18 @@
-*.gem
-*.rbc
-.bundle
-.config
-coverage
-InstalledFiles
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-
-# YARD artifacts
-.yardoc
-_yardoc
-doc/
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -1 +1 @@
-gemspec
+gemspec

data/README.md

@@ -1,40 +1,43 @@
-rbevents
-========
-
-It's like Observable, but better.
-
-Example
-=======
-```ruby
-
-# Let's define a class with subscribable events
-class EventsExample
-  include Events # Mix in the magic
-  
-  # Define an event
-  event :activation
-  
-  # Here, we define a method that fires the event 
-  def activate
-    # Event.fire sets off the event and collects
-    # any return values from subscribed events
-    return_values = @activation.fire
-    return_values
-  end
-end
-
-# Let's build an object...
-example = EventsExample.new
-
-# ...and then add some subscribers
-example.on_activation do
-  "Hello"
-end
-example.on_activation do
-  "World!"
-end
-
-# Finally, we call a method which alerts the subscribers
-example.activate # => ["Hello", "World!"]
-```
-Full documentation to follow!
+rbevents
+========
+
+It's like Observable, but better.
+
+[![Gem Version](https://badge.fury.io/rb/rbevents.png)](http://badge.fury.io/rb/rbevents) [![Code Climate](https://codeclimate.com/github/jonnyarnold/rbevents.png)](https://codeclimate.com/github/jonnyarnold/rbevents)
+
+Example
+=======
+```ruby
+
+# Let's define a class with subscribable events
+class EventsExample
+  include Events # Mix in the magic
+  
+  # Define an event
+  event :activation
+  
+  # Here, we define a method that fires the event 
+  def activate
+    # Event.fire sets off the event and collects
+    # any return values from subscribed events
+    return_values = @activation.fire
+    return_values
+  end
+end
+
+# Let's build an object...
+example = EventsExample.new
+
+# ...and then add some subscribers
+example.on_activation do
+  "Hello"
+end
+example.on_activation do
+  "World!"
+end
+
+# Finally, we call a method which alerts the subscribers
+example.activate # => ["Hello", "World!"]
+```
+
+Anything else? Check the code.

data/lib/events.rb

@@ -1,119 +1,119 @@
-# Mixin for event-driven programming.
-#
-# The mixin adds the following:
-# - <tt>event [sym]</tt>: Creates an +Event+ with the given name
-# - <tt>singleton_event [sym]</tt>: Creates a +SingleSubscriberEvent+ with the given name
-# Note that the command <tt>event :abc</tt> adds an alias, <tt>on_abc</tt>, for adding event callbacks
-#
-# == Example
-# See README
-#
-# == License
-# If you use this, let me know? jonny.arnold89@gmail.com. Thanks.
-module Events
-
-    # Version number
-    # Uses Semantic Versioning: http://semver.org/
-    VERSION = '0.1.0'
-
-    # An event that can be subscribed to,
-    # and runs any subscribed callback when
-    # it is fired.
-    class Event 
-        # Gets the collection of callbacks subscribed to this event.
-        attr_accessor :callbacks
-
-        # Class initializer
-        def initialize
-            @callbacks = []
-        end
-        
-        # Called when the event occurs
-        # [*arguments] The arguments to pass to each callback
-        # Returns any values returned by any subscribed callback
-        def fire(*arguments)
-            return_values = []
-
-            @callbacks.each do |proc| 
-                return_values << proc.call(*arguments) 
-            end
-
-            return_values
-        end
-        
-        # Adds a callback to the event
-        # [proc] The block to execute
-        def add_callback(&proc)
-            @callbacks << proc
-        end
-
-        # Removes the given block from the event
-        # [proc] The block to remove
-        def remove_callback(&proc)
-            @callbacks.delete proc
-        end
-    end
-
-    # An event with a single subscriber
-    class SingleSubscriberEvent < Event
-
-        # Override of Event.add_callback
-        def add_callback(&proc)
-            if callbacks.length == 1
-                raise EventSubscriptionError, "Cannot add more than one callback to SingleSubscriberEvent"
-            end
-
-            super
-        end
-
-        # Override of Event.fire
-        def fire(*args)
-            packed_result = super
-            if packed_result.length == 0
-                return nil
-            else
-                return packed_result.first
-            end
-        end
-    end
-
-    # Denotes an error with event subscription
-    class EventSubscriptionError < StandardError
-    end
-
-    # :nodoc:
-    def self.append_features(cls)
-        # Create an event
-        # [sym] The name to assign to the event
-        # Retrieve via .sym
-        def cls.event(sym)
-            variable_name = "@#{sym}"
-
-            define_method(sym.to_s) do
-                if not instance_variable_defined? variable_name then
-                    instance_variable_set variable_name, Event.new
-                end
-                instance_variable_get variable_name
-            end
-
-            firealias = "on_#{sym}"
-            define_method(firealias) do |&proc|
-                if not instance_variable_defined? variable_name then
-                    instance_variable_set variable_name, Event.new
-                end
-                event_obj = instance_variable_get variable_name
-                event_obj.add_callback &proc
-            end
-        end
-
-        def cls.singleton_event(sym)
-            define_method(sym.to_s) do
-                variable_name = "@#{sym}"
-                if not instance_variable_defined? variable_name then
-                    instance_variable_set variable_name, SingleSubscriberEvent.new
-                end
-                instance_variable_get variable_name
-            end
-        end
-    end
-end
+# Mixin for event-driven programming.
+#
+# The mixin adds the following:
+# - <tt>event [sym]</tt>: Creates an +Event+ with the given name
+# - <tt>singleton_event [sym]</tt>: Creates a +SingleSubscriberEvent+ with the given name
+# Note that the command <tt>event :abc</tt> adds an alias, <tt>on_abc</tt>, for adding event callbacks
+#
+# == Example
+# See README
+#
+# == License
+# If you use this, let me know? jonny.arnold89@gmail.com. Thanks.
+module Events
+
+  # Version number
+  # Uses Semantic Versioning: http://semver.org/
+  VERSION = '1.0.0'
+
+  # An event that can be subscribed to,
+  # and runs any subscribed callback when
+  # it is fired.
+  class Event 
+    # Gets the collection of callbacks subscribed to this event.
+    attr_accessor :callbacks
+
+    # Class initializer
+    def initialize
+      @callbacks = []
+    end
+    
+    # Called when the event occurs
+    # [*arguments] The arguments to pass to each callback
+    # Returns any values returned by any subscribed callback
+    def fire(*arguments)
+      return_values = []
+
+      @callbacks.each do |proc| 
+        return_values << proc.call(*arguments) 
+      end
+
+      return_values
+    end
+    
+    # Adds a callback to the event
+    # [proc] The block to execute
+    def add_callback(&proc)
+      @callbacks << proc
+    end
+
+    # Removes the given block from the event
+    # [proc] The block to remove
+    def remove_callback(&proc)
+      @callbacks.delete proc
+    end
+  end
+
+  # An event with a single subscriber
+  class SingleSubscriberEvent < Event
+
+    # Override of Event.add_callback
+    def add_callback(&proc)
+      if callbacks.length == 1
+        raise EventSubscriptionError, "Cannot add more than one callback to SingleSubscriberEvent"
+      end
+
+      super
+    end
+
+    # Override of Event.fire
+    def fire(*args)
+      packed_result = super
+      if packed_result.length == 0
+        return nil
+      else
+        return packed_result.first
+      end
+    end
+  end
+
+  # Denotes an error with event subscription
+  class EventSubscriptionError < StandardError
+  end
+
+  # :nodoc:
+  def self.append_features(cls)
+    # Create an event
+    # [sym] The name to assign to the event
+    # Retrieve via .sym
+    def cls.event(sym)
+      variable_name = "@#{sym}"
+
+      define_method(sym.to_s) do
+        if not instance_variable_defined? variable_name then
+          instance_variable_set variable_name, Event.new
+        end
+        instance_variable_get variable_name
+      end
+
+      firealias = "on_#{sym}"
+      define_method(firealias) do |&proc|
+        if not instance_variable_defined? variable_name then
+          instance_variable_set variable_name, Event.new
+        end
+        event_obj = instance_variable_get variable_name
+        event_obj.add_callback &proc
+      end
+    end
+
+    def cls.singleton_event(sym)
+      define_method(sym.to_s) do
+        variable_name = "@#{sym}"
+        if not instance_variable_defined? variable_name then
+          instance_variable_set variable_name, SingleSubscriberEvent.new
+        end
+        instance_variable_get variable_name
+      end
+    end
+  end
+end

data/rakefile

@@ -1,15 +1,15 @@
-require 'rake/testtask'
-require 'rdoc/task'
-
-task :default => :test
-
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/test*.rb']
-  t.verbose = true
-end
-
-Rake::RDocTask.new do |rd|
-  rd.main = "README.md"
-  rd.rdoc_files.include "lib/**.rb"
-end
+require 'rake/testtask'
+require 'rdoc/task'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README.md"
+  rd.rdoc_files.include "lib/**.rb"
+end

data/rbevents.gemspec

@@ -1,24 +1,24 @@
-# -*- encoding: utf-8 -*-
-
-require File.expand_path('../lib/events', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.name          = "rbevents"
-  gem.version       = Events::VERSION
-  gem.summary       = %q{Events for Ruby}
-  gem.description   = %q{Provides an Event mixin for enabling classes to create events for public and private subscription.}
-  gem.license       = "GPL"
-  gem.authors       = ["Jonny Arnold"]
-  gem.email         = "jonny.arnold89@gmail.com"
-  gem.homepage      = "https://github.com/jonnyarnold/rbevents"
-
-  gem.files         = `git ls-files`.split($/)
-  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']
-
-  gem.add_development_dependency 'bundler', '~> 1.0'
-  gem.add_development_dependency 'rake', '~> 0.8'
-  gem.add_development_dependency 'rdoc', '~> 3.0'
-  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
-end
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/events', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "rbevents"
+  gem.version       = Events::VERSION
+  gem.summary       = %q{Events for Ruby}
+  gem.description   = %q{Provides an Event mixin for enabling classes to create events for public and private subscription.}
+  gem.license       = "GPL"
+  gem.authors       = ["Jonny Arnold"]
+  gem.email         = "jonny.arnold89@gmail.com"
+  gem.homepage      = "https://github.com/jonnyarnold/rbevents"
+
+  gem.files         = `git ls-files`.split($/)
+  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']
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'rake', '~> 0.8'
+  gem.add_development_dependency 'rdoc', '~> 3.0'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+end

data/test/test_events.rb

@@ -1,52 +1,52 @@
-require "./lib/events"
-require "test/unit"
-
-class ClassWithEvents
-	include Events
-	event :test_event
-	singleton_event :test_singleton_event
-end
-
-class EventDrivenTest < Test::Unit::TestCase
-
-	def setup
-		@test_object = ClassWithEvents.new
-	end
-
-	def test_can_subscribe_to_event
-		@test_object.test_event.add_callback { puts "Hello!" }
-
-		assert @test_object.test_event.callbacks.length == 1
-	end
-
-	def test_event_can_return_values
-		@test_object.test_event.add_callback { return 1 }
-
-		results = @test_object.test_event.fire
-		assert results == [1]
-	end
-
-	def test_single_subscriber_event_raises_error_on_second_callback
-		assert_nothing_raised do 
-			@test_object.test_singleton_event.add_callback { puts "Hello!" }
-		end
-
-		assert_raises(Events::EventSubscriptionError) do
-			@test_object.test_singleton_event.add_callback { puts "Hello again!" }
-		end
-	end
-
-	def test_event_fire_alias
-		@test_object.on_test_event { puts "Hello" }
-		assert @test_object.test_event.callbacks.length == 1
-	end
-
-	def test_event_can_be_given_arguments
-		@test_object.on_test_event do |arg|
-			arg
-		end
-
-		results = @test_object.test_event.fire("abc")
-		assert results == ["abc"]
-	end
+require "./lib/events"
+require "test/unit"
+
+class ClassWithEvents
+	include Events
+	event :test_event
+	singleton_event :test_singleton_event
+end
+
+class EventDrivenTest < Test::Unit::TestCase
+
+	def setup
+		@test_object = ClassWithEvents.new
+	end
+
+	def test_can_subscribe_to_event
+		@test_object.test_event.add_callback { puts "Hello!" }
+
+		assert @test_object.test_event.callbacks.length == 1
+	end
+
+	def test_event_can_return_values
+		@test_object.test_event.add_callback { return 1 }
+
+		results = @test_object.test_event.fire
+		assert results == [1]
+	end
+
+	def test_single_subscriber_event_raises_error_on_second_callback
+		assert_nothing_raised do 
+			@test_object.test_singleton_event.add_callback { puts "Hello!" }
+		end
+
+		assert_raises(Events::EventSubscriptionError) do
+			@test_object.test_singleton_event.add_callback { puts "Hello again!" }
+		end
+	end
+
+	def test_event_fire_alias
+		@test_object.on_test_event { puts "Hello" }
+		assert @test_object.test_event.callbacks.length == 1
+	end
+
+	def test_event_can_be_given_arguments
+		@test_object.on_test_event do |arg|
+			arg
+		end
+
+		results = @test_object.test_event.fire("abc")
+		assert results == ["abc"]
+	end
 end

data/test/test_example.rb

@@ -1,30 +1,30 @@
-require "./lib/events"
-require "test/unit"
-
-# Test class in example
-class EventsExample
-  include Events
-  event :activation
-
-  def activate
-    return_values = @activation.fire
-    return_values
-  end
-end
-
-# Test usage in example
-class ExampleTests < Test::Unit::TestCase
-  def test_example_executes_correctly
-    example = EventsExample.new
-
-    example.on_activation do
-      "Hello"
-    end
-
-    example.on_activation do
-      "World!"
-    end
-
-    assert example.activate == ["Hello", "World!"]
-  end
+require "./lib/events"
+require "test/unit"
+
+# Test class in example
+class EventsExample
+  include Events
+  event :activation
+
+  def activate
+    return_values = @activation.fire
+    return_values
+  end
+end
+
+# Test usage in example
+class ExampleTests < Test::Unit::TestCase
+  def test_example_executes_correctly
+    example = EventsExample.new
+
+    example.on_activation do
+      "Hello"
+    end
+
+    example.on_activation do
+      "World!"
+    end
+
+    assert example.activate == ["Hello", "World!"]
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbevents
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jonny Arnold
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-16 00:00:00.000000000 Z
+date: 2014-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0.rc.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Events for Ruby