skates 0.3.0 → 0.3.1

data/lib/skates/router.rb

@@ -8,6 +8,10 @@ module Skates
     
     attr_reader :routes, :connection
     
+    def before_route(&block)
+      @before_route = block
+    end
+    
     def initialize
       @routes = []
     end
@@ -21,10 +25,28 @@ module Skates
     ##
     # Look for the first matching route and calls the corresponding action for the corresponding controller.
     # Sends the response on the XMPP stream/ 
+    # If the before_route callback is defined, it is called.
+    # If the callback returns true, then, the route is NOT executed.
+    # This callback is very useful when an application wants to redirect any stanza it receives before handling it to the routing mechanism.
     def route(xml_stanza) 
-      route = routes.select{ |r| r.accepts?(xml_stanza) }.first 
-      return false unless route 
-      execute_route(route.controller, route.action, xml_stanza)
+      abort = if !@before_route.nil?
+        begin
+          @before_route.call(xml_stanza)
+        rescue
+          Skates.logger.info {
+            "Failed to execute before_route callback. Resuming Routing"
+          }
+          false
+        end
+      end
+      if !abort
+        route = routes.select{ |r| r.accepts?(xml_stanza) }.first 
+        return false unless route 
+        execute_route(route.controller, route.action, xml_stanza)
+      else
+        # The callback triggered abortion of teh routing mechanism.
+        return false
+      end
     end 
     
     ##

data/lib/skates/runner.rb

@@ -10,8 +10,7 @@ module Skates
     # Prepares the Application to run.
     def self.prepare(env)
       # Load the configuration
-      config_file = File.open('config/config.yaml')
-      Skates.config = YAML.load(config_file)[Skates.environment]
+      Skates.config = YAML.load_file(Skates.config_file)[Skates.environment]
       
       Skates.reopen_logs
       

data/lib/skates.rb

@@ -32,7 +32,9 @@ require 'skates/base/stanza'
 # This will generate some folders and files for your application. Please see README.rdoc for further instructions
 
 module Skates
-
+  
+  @@config_file = nil
+  
   def self.environment=(_env)
     @@env = _env
   end
@@ -105,6 +107,18 @@ module Skates
     @@logger = logger
   end
 
+  ##
+  # Set the configuration file for this component.
+  def self.config_file=(file)
+    @@config_file = file
+  end
+
+  ##
+  # Return the configuration file for this component.
+  def self.config_file
+    @@config_file
+  end
+
   ##
   # Set the configuration for this component.
   def self.config=(conf)

data/spec/lib/skates/router_spec.rb

@@ -59,31 +59,94 @@ describe Skates::StanzaRouter do
       end
     end
 
-    it "should check each routes to see if they match the stanza and take the first of the matching" do
-      @router.routes.each do |r|
-        r.should_receive(:accepts?).with(@xml)
-      end
-      @router.route(@xml)
-    end
-
-    describe "if one route is found" do 
+    context "when the before_route callback is defined" do
       before(:each) do
-        @accepting_route = mock(Skates::Route, :accepts? => true, :action => "action", :controller => "controller", :xpath => "xpath")
-        @router.routes << @accepting_route
+        @proc = Proc.new { |stanza|  
+        }
+        @router.before_route(&@proc)
       end
-
-      it "should call execute_route" do
-        @router.should_receive(:execute_route).with(@accepting_route.controller, @accepting_route.action, @xml)
+      
+      it "should call the callback" do
+        @proc.should_receive(:call).with(@xml)
         @router.route(@xml)
       end
+      
+      context "when the callback returns true" do
+        before(:each) do
+          @proc = Proc.new { |stanza| 
+            true 
+          }
+          @router.before_route(&@proc)
+        end
+        
+        it "should not even check if a route accepts this stanza" do
+          @router.routes.each do |r|
+            r.should_not_receive(:accepts?).with(@xml)
+          end
+          @router.route(@xml)
+        end
+      end
+      
+      context "when the callback returns false" do
+        before(:each) do
+          @proc = Proc.new { |stanza| 
+            false 
+          }
+          @router.before_route(&@proc)
+        end
+        
+        it "should check if a route accepts this stanza" do
+          @router.routes.each do |r|
+            r.should_receive(:accepts?).with(@xml)
+          end
+          @router.route(@xml)
+        end
+      end
+      
+      context "when the callback raises an error" do
+        before(:each) do
+          @proc = Proc.new { |stanza| 
+            raise 
+          }
+          @router.before_route(&@proc)
+        end
+        
+        it "should check if a route accepts this stanza" do
+          @router.routes.each do |r|
+            r.should_receive(:accepts?).with(@xml)
+          end
+          @router.route(@xml)
+        end
+      end
+      
     end
+    
+    context "when the before_route callback is not defined" do
+      it "should check each routes to see if they match the stanza and take the first of the matching" do
+        @router.routes.each do |r|
+          r.should_receive(:accepts?).with(@xml)
+        end
+        @router.route(@xml)
+      end
+    
+      context "if one route is found" do 
+        before(:each) do
+          @accepting_route = mock(Skates::Route, :accepts? => true, :action => "action", :controller => "controller", :xpath => "xpath")
+          @router.routes << @accepting_route
+        end
+
+        it "should call execute_route" do
+          @router.should_receive(:execute_route).with(@accepting_route.controller, @accepting_route.action, @xml)
+          @router.route(@xml)
+        end
+      end
 
-    describe "if no route matches the stanza" do
-      it "should return false" do
-        @router.route(@xml).should be_false
+      context "if no route matches the stanza" do
+        it "should return false" do
+          @router.route(@xml).should be_false
+        end
       end
     end
-
   end
 
   describe "execute_route" do

data/spec/lib/skates/runner_spec.rb

@@ -8,9 +8,9 @@ describe Skates::Runner do
   
   describe ".prepare" do
     before(:each) do
-      @stub_config_file = File.open("config/config.yaml")
-      @stub_config_content = File.read("config/config.yaml")
-      File.stub!(:open).with('config/config.yaml').and_return(@stub_config_file)
+      @config = {"production"=>{"port"=>5278, "auto-reconnect"=>true, "jid"=>"component.server.com", "host"=>"localhost", "password"=>"password"}, "development"=>{"auto-reconnect"=>true, "jid"=>"user@server.com", "application_type"=>"client", "password"=>"password"}, "test"=>{"port"=>5278, "auto-reconnect"=>true, "jid"=>"component.server.com", "host"=>"localhost", "password"=>"password"}}
+      Skates.config_file = "config/config.yaml"
+      YAML.stub(:load_file).and_return(@config)
       Skates::Runner.stub!(:require_directory).and_return(true)
     end
 
@@ -47,13 +47,13 @@ describe Skates::Runner do
     end
 
     it "should load the configuration file" do
-      File.should_receive(:open).with('config/config.yaml').and_return(@stub_config_file)
+      YAML.should_receive(:load_file).with('config/config.yaml').and_return(@config)
       Skates::Runner.prepare("test")
     end
 
     it "should assign the configuration" do
       Skates::Runner.prepare("test")
-      Skates.config.should == YAML.load(@stub_config_content)["test"]
+      Skates.config.should == {"port"=>5278, "jid"=>"component.server.com", "auto-reconnect"=>true, "host"=>"localhost", "password"=>"password"}
     end
 
     it "should cache the views" do

data/templates/skates/config/boot.rb

@@ -8,6 +8,7 @@ require "rubygems"
 require "skates"
 require File.dirname(__FILE__) + "/dependencies"
 
+Skates.config_file = 'config/config.yaml'
 
 # Start the App
 Skates::Runner::run(SKATES_ENV || "development") do

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: skates
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - julien Genestoux
@@ -9,59 +14,73 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-10 00:00:00 -06:00
+date: 2010-04-05 00:00:00 +02:00
 default_executable: skates
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: eventmachine
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 12
+        - 10
         version: 0.12.10
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: log4r
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: nokogiri
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 1
         version: 1.4.1
-    version: 
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: templater
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: utf8cleaner
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id005
 description: 
 email: julien.genestoux@gmail.com
 executables: 
@@ -114,14 +133,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: 
 - eventmachine
 - yaml
@@ -135,7 +156,7 @@ requirements:
 - resolv
 - utf8cleaner
 rubyforge_project: skates
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Skates is a framework to create EventMachine based XMPP External Components in Ruby.