orator 0.3.3 → 0.4.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWVlYWM5Zjc1ZjJhOWE0Mjc5MDEzN2UzNTAzM2I3ZTdjNTc1OTU0Mw==
+  data.tar.gz: !binary |-
+    ODczZmM2MTBkOWQ2MGJkOWEwNzI0YTBlYWUxZjA2OGI5YzA1Yzg1Zg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MmFhYzJhYmQ1ZmZmMDM4YjlmYjc4ZjEwNmVjMDAwYjY4YTM2MjM4ZmIyNjNm
+    ZWE1ODc2MDQ2MzYwY2M0ZmI3YmU2ZTJiMTUyZTQ5ODNkNWU2ODcxYzc5MTkw
+    YTc3MThkYWQ5ZDM4ODYyYWI3MWNkMDEzZDRjN2FiYzE1MWJlOGY=
+  data.tar.gz: !binary |-
+    NTBjOWJlYjQyMTZhMmYwNTJhYzE0ZTg1OTVlMjRjNWQ4Yzc3MmFlNjk2ZDQ1
+    NWZhNzIzNzk5NWEwNDMzNTgwNTY5YTI5YjY2MDE5ZjhlYWJkZDhlOTcxMTA0
+    ZmEyYmI1ZmZmZWI3OTA4NzA0Nzk2NmQzYmUzZDEwMmM1ZDkxNmI=

data/lib/generators/templates/orators/application_orator.rb

@@ -0,0 +1,8 @@
+class ApplicationOrator < Orators::Base
+
+
+
+end
+
+# Do not register the ApplicationOrator with Orator, because it does not
+# respond to events.

data/lib/generators/templates/template_orator.rb

@@ -1,4 +1,4 @@
-class <%= orator_name.camelcase %>Orator < Orator::Base
+class <%= orator_name.camelcase %>Orator < ApplicationOrator
 
   orator_name '<%= orator_name.underscore %>'
 

data/lib/orator/base.rb

@@ -25,13 +25,29 @@ module Orator
       orator, method_name = event.to_s.split('.')
       __check_event(orator, method_name)
 
-      __run_callbacks(:before)
+      @event = [orator, method_name]
+      __run_callbacks(:before, args)
       out = __run_event(method_name, args) unless @__prevent_event
-      __run_callbacks(:after)
+      __run_callbacks(:after, args)
 
       out
     end
 
+    # Returns the current event that the orator is handling in `orator.event`
+    # form.
+    #
+    # @return [String]
+    def full_event
+      @event.join('.')
+    end
+
+    # Returns the current event that the orator is handling in `event` form.
+    #
+    # @return [String]
+    def event
+      @event[1]
+    end
+
     # Checks the event list to see if this class responds to it.
     #
     # @return [Set<Symbol, Proc>, nil]
@@ -103,12 +119,12 @@ module Orator
     end
 
     # Runs the callbacks.
-    def __run_callbacks(type)
+    def __run_callbacks(type, args)
       self.class.send("#{type}_list").map do |cb|
         if cb.is_a? Symbol
-          method(cb).call
+          method(cb).call(*args)
         else
-          instance_exec &cb
+          instance_exec(*args, &cb)
         end
       end
     end
@@ -160,16 +176,61 @@ module Orator
         end
       end
 
-      [:before, :after].each do |type|
-        module_eval <<-METHOD, __FILE__, __LINE__
-          def #{type}(method = nil, &block)
-            #{type}_list << (method || block)
-          end
+      # This handles the before callbacks that our orator needs.  It can accept
+      # a method or a block, and given the two, chooses the method over the
+      # block.
+      #
+      # @example
+      #   before do; something; end
+      # @example
+      #   before :some_method
+      # @param method [Symbol] the method that will be called for the before
+      #   callback.
+      # @yields []
+      def before(method = nil, &block)
+        before_list << (method or block)
+      end
+
+      # This sets up the before list on the first call, and returns the list
+      # on the first and subsequent calls.
+      #
+      # @return [Set<Symbol, Block>] the before callback list.
+      def before_list
+        @before_list ||= Set.new
+      end
+
+      # This handles the after callbacks that our operator needs.  It can accept
+      # a method or a block, and given the two, chooses the method over the
+      # block.
+      #
+      # @example
+      #   after do; something; end
+      # @example
+      #   after :some_method
+      # @param method [Symbol] the method that will be called for the after
+      #   callback.
+      # @yields []
+      def after(method = nil, &block)
+        after_list << (method or block)
+      end
 
-          def #{type}_list
-            @#{type}_list ||= Set.new
-          end
-        METHOD
+      # This sets up the after list on the first call, and returns the list on
+      # the first and subsequent calls.
+      #
+      # @return [Set<Symbol, Block>] the after callback list.
+      def after_list
+        @after_list ||= Set.new
+      end
+
+      # This is called when this class is inherited from.  We use this to make
+      # sure that each subclass inherits the event list as well as the before
+      # and after methods.
+      #
+      # @param klass [Base]
+      def inherited(klass)
+        klass.instance_variable_set(:@event_list,  event_list.dup )
+        klass.instance_variable_set(:@before_list, before_list.dup)
+        klass.instance_variable_set(:@after_list,  after_list.dup )
       end
     end
 

data/lib/orator/version.rb

@@ -1,5 +1,5 @@
 module Orator
 
   # Version of Orator.
-  VERSION = '0.3.3'
+  VERSION = '0.4.3'
 end

data/spec/base_orator_spec.rb

@@ -72,4 +72,38 @@ describe Orator::Base do
 
     klass.new(nil).__trigger('test.some_event')
   end
+
+  it "should duplicate before events for children" do
+    klass = Class.new(described_class) do
+      orator_name 'test'
+
+      before do; end
+    end
+
+    klass.before_list.length.should be 1
+
+    subklass = Class.new(klass) do
+      orator_name 'test2'
+    end
+
+    subklass.before_list.length.should be 1
+    subklass.before_list.should eql(klass.before_list)
+  end
+
+  it "should duplicate after events for children" do
+    klass = Class.new(described_class) do
+      orator_name 'test'
+
+      after do; end
+    end
+
+    klass.after_list.length.should be 1
+
+    subklass = Class.new(klass) do
+      orator_name 'test2'
+    end
+
+    subklass.after_list.length.should be 1
+    subklass.after_list.should eql(klass.after_list)
+  end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orator
 version: !ruby/object:Gem::Version
-  version: 0.3.3
-  prerelease: 
+  version: 0.4.3
 platform: ruby
 authors:
 - Jeremy Rodi
@@ -14,7 +13,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: em-websocket
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: swf_fu
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -84,63 +75,64 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/tasks/orator.rake
-- lib/orator.rb
-- lib/orator/engine.rb
-- lib/orator/server.rb
-- lib/orator/base.rb
 - lib/orator/middle_ground.rb
-- lib/orator/event_handler.rb
 - lib/orator/version.rb
+- lib/orator/server.rb
 - lib/orator/cli.rb
 - lib/orator/client.rb
-- lib/generators/templates/template_orator.rb
+- lib/orator/engine.rb
+- lib/orator/base.rb
+- lib/orator/event_handler.rb
+- lib/generators/orator/orator_generator.rb
+- lib/generators/orator/config_generator.rb
 - lib/generators/templates/config.yml
 - lib/generators/templates/orators/example_orator.rb
-- lib/generators/orator/config_generator.rb
-- lib/generators/orator/orator_generator.rb
+- lib/generators/templates/orators/application_orator.rb
+- lib/generators/templates/template_orator.rb
+- lib/orator.rb
+- lib/tasks/orator.rake
 - bin/orator
-- spec/event_handler_spec.rb
-- spec/middle_ground_spec.rb
 - spec/client_spec.rb
-- spec/base_orator_spec.rb
 - spec/spec_helper.rb
-- vendor/assets/swfs/WebSocketMain.swf
-- vendor/assets/javascripts/orator.coffee
-- vendor/assets/javascripts/orator/web_socket.js
-- vendor/assets/javascripts/orator/stringify.jquery.js
-- vendor/assets/javascripts/orator/header.coffee
-- vendor/assets/javascripts/orator/event_handler.coffee
-- vendor/assets/javascripts/orator/chat_logger.coffee
+- spec/middle_ground_spec.rb
+- spec/base_orator_spec.rb
+- spec/event_handler_spec.rb
+- vendor/assets/javascripts/orator/middle_ground.coffee
 - vendor/assets/javascripts/orator/swfobject.js
 - vendor/assets/javascripts/orator/command_handler.coffee
+- vendor/assets/javascripts/orator/event_handler.coffee
+- vendor/assets/javascripts/orator/chat_logger.coffee
+- vendor/assets/javascripts/orator/web_socket.js
 - vendor/assets/javascripts/orator/strbuf.coffee
-- vendor/assets/javascripts/orator/middle_ground.coffee
+- vendor/assets/javascripts/orator/stringify.jquery.js
+- vendor/assets/javascripts/orator/header.coffee
+- vendor/assets/javascripts/orator.coffee
+- vendor/assets/swfs/WebSocketMain.swf
 - README.md
 - Rakefile
 - LICENSE
 homepage: http://github.com/redjazz96/orator
 licenses: []
+metadata: {}
 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.24
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Magic for your browser.
 test_files: []
+has_rdoc: false