usher 0.5.6 → 0.5.7

data/Rakefile

@@ -1,4 +1,7 @@
-require 'lib/usher'
+libdir = File.expand_path("lib")
+$:.unshift(libdir) unless $:.include?(libdir)
+
+require 'usher'
 
 begin
   require 'jeweler'
@@ -12,6 +15,7 @@ begin
     s.add_dependency 'fuzzyhash', '>=0.0.6'
     s.rubyforge_project = 'joshbuddy-usher'
   end
+  Jeweler::GemcutterTasks.new
   Jeweler::RubyforgeTasks.new do |rubyforge|
     rubyforge.doc_task = "rdoc"
     rubyforge.remote_doc_path = ''

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 5
-:patch: 6
+:patch: 7
 :major: 0

data/lib/usher.rb

@@ -9,7 +9,7 @@ require File.join(File.dirname(__FILE__), 'usher', 'util')
 class Usher
   attr_reader :root, :named_routes, :routes, :splitter,
               :delimiters, :delimiter_chars, :delimiters_regex,
-              :parent_route, :generator
+              :parent_route, :generator, :grapher
 
   # Returns whether the route set is empty
   #

data/lib/usher/interface.rb

@@ -1,37 +1,43 @@
+# From Extlib
+module CamelCaseMixin
+  def camel_case
+    return self if self !~ /_/ && self =~ /[A-Z]+.*/
+    split('_').map{|e| e.capitalize}.join
+  end
+end
+
+# TODO: refactoring: I suggest to use usher/interfaces/rack.rb instead of
+# usher/interface/rack_interface.rb, it will enable me to simplify this code
 class Usher
   module Interface
-    autoload :Rails2_2Interface, File.join(File.dirname(__FILE__), 'interface', 'rails2_2_interface')
-    autoload :Rails2_3Interface, File.join(File.dirname(__FILE__), 'interface', 'rails2_3_interface')
-    autoload :MerbInterface, File.join(File.dirname(__FILE__), 'interface', 'merb_interface')
-    autoload :RackInterface, File.join(File.dirname(__FILE__), 'interface', 'rack_interface')
-    autoload :EmailInterface, File.join(File.dirname(__FILE__), 'interface', 'email_interface')
-    autoload :Rails3Interface, File.join(File.dirname(__FILE__), 'interface', 'rails3_interface')
-    autoload :TextInterface, File.join(File.dirname(__FILE__), 'interface', 'text_interface')
-    
-    def self.for(type, &blk)
-      class_for(type).new(&blk)
+    # Get root directory of interfaces of path to specified interface
+    def self.interface_directory
+      File.join(File.dirname(__FILE__), "interface")
+    end
+
+    # path to file
+    def self.interface_path(name)
+      File.join(self.interface_directory, "#{name}_interface.rb")
+    end
+
+    # Usher::Interface.for(:rack, &block)
+    def self.for(name, &block)
+      if File.exist?(self.interface_path(name))
+        require self.interface_path(name)
+        snake_cased = "#{name}_interface".extend(CamelCaseMixin)
+        Usher::Interface.const_get(snake_cased.camel_case).new(&block)
+      else
+        raise ArgumentError, "Interface #{name} doesn't exist. Choose one of: #{self.interfaces.inspect}"
+      end
     end
-    
-    def self.class_for(type)
-      case type
-      when :rails2_2
-        Rails2_2Interface
-      when :rails2_3
-        Rails2_3Interface
-      when :merb
-        MerbInterface
-      when :rack
-        RackInterface
-      when :email
-        EmailInterface
-      when :rails3
-        Rails3Interface
-      when :text
-        TextInterface
+
+    # Array of symbols
+    # Usher::Interface.interfaces
+    # => [:email_interface, :merb_interface, :rack_interface, :rails2_2_interface, :rails2_3_interface, :rails3_interface, :text_interface]
+    def self.interfaces
+      Dir["#{self.interface_directory}/*.rb"].map do |interface|
+        File.basename(interface).sub("_interface.rb", "").to_sym
       end
-      
     end
-    
-    
   end
-end
+end

data/lib/usher/interface/rack_interface.rb

@@ -3,16 +3,7 @@ require 'rack'
 class Usher
   module Interface
     class RackInterface
-
-      attr_reader :router
-      attr_accessor :app
-
-      DEFAULT_APPLICATION = lambda do |env|
-        Rack::Response.new("No route found", 404).finish
-      end
-
       class Builder < Rack::Builder
-
         def initialize(&block)
           @usher = Usher::Interface::RackInterface.new
           super
@@ -23,10 +14,28 @@ class Usher
           @ins << @usher unless @ins.last == @usher
         end
 
+        def get(path, options = nil, &block)
+          self.map(path, options.merge!(:conditions => {:request_method => "GET"}), &block)
+        end
+
+        def post(path, options = nil, &block)
+          self.map(path, options.merge!(:conditions => {:request_method => "POST"}), &block)
+        end
+
+        def put(path, options = nil, &block)
+          self.map(path, options.merge!(:conditions => {:request_method => "PUT"}), &block)
+        end
+
+        def delete(path, options = nil, &block)
+          self.map(path, options.merge!(:conditions => {:request_method => "DELETE"}), &block)
+        end
       end
 
+      attr_reader :router
+      attr_accessor :app
+
       def initialize(app = nil, &blk)
-        @app = app || DEFAULT_APPLICATION
+        @app = app || lambda { |env| Rack::Response.new("No route found", 404).finish }
         @router = Usher.new(:request_methods => [:request_method, :host, :port, :scheme], :generator => Usher::Util::Generators::URL.new)
         instance_eval(&blk) if blk
       end
@@ -42,7 +51,36 @@ class Usher
 
       def add(path, options = nil)
         @router.add_route(path, options)
-       end
+      end
+
+      # default { |env| ... }
+      # default DefaultApp
+      def default(app = nil, &block)
+        @app = app ? app : block
+      end
+
+      # shortcuts for adding routes for HTTP methods, for example:
+      # add("/url", :conditions => {:request_method => "POST"}})
+      # is the same as:
+      # post("/url")
+      #
+      # if you need more complex setup, use method add directly, for example:
+      # add("/url", :conditions => {:request_method => ["POST", "PUT"]}})
+      def get(path, options = {})
+        self.add(path, options.merge!(:conditions => {:request_method => "GET"}))
+      end
+
+      def post(path, options = {})
+        self.add(path, options.merge!(:conditions => {:request_method => "POST"}))
+      end
+
+      def put(path, options = {})
+        self.add(path, options.merge!(:conditions => {:request_method => "PUT"}))
+      end
+
+      def delete(path, options = {})
+        self.add(path, options.merge!(:conditions => {:request_method => "DELETE"}))
+      end
 
       def parent_route=(route)
         @router.parent_route = route
@@ -57,8 +95,9 @@ class Usher
       end
 
       def call(env)
-        response = @router.recognize(request = Rack::Request.new(env), request.path_info)
-        after_match(env, response) if response
+        request = Rack::Request.new(env)
+        response = @router.recognize(request, request.path_info)
+        after_match(request, response) if response
         determine_respondant(response).call(env)
       end
 
@@ -70,18 +109,18 @@ class Usher
       # and calling the application
       #
       # @api plugin
-      def after_match(env, response)
+      def after_match(request, response)
         params = response.path.route.default_values ?
-          response.path.route.default_values.merge(Hash[response.params]) :
-          Hash[response.params]
+          response.path.route.default_values.merge(Hash[*response.params.flatten]) :
+          Hash[*response.params.flatten]
         
-        env['usher.params'] ?
-          env['usher.params'].merge!(params) :
-          env['usher.params'] = params
+        request.env['usher.params'] ?
+          request.env['usher.params'].merge!(params) :
+          (request.env['usher.params'] = params)
         
         # consume the path_info to the script_name
         # response.remaining_path
-        consume_path!(env, response) if response.partial_match?
+        consume_path!(request, response) if response.partial_match?
       end
 
       # Determines which application to respond with.
@@ -102,9 +141,9 @@ class Usher
       end
 
       # Consume the path from path_info to script_name
-      def consume_path!(env, response)
-        env["SCRIPT_NAME"] = (env["SCRIPT_NAME"] + response.matched_path)   || ""
-        env["PATH_INFO"] = response.remaining_path    || ""
+      def consume_path!(request, response)
+        request.env["SCRIPT_NAME"] = (request.env["SCRIPT_NAME"] + response.matched_path)   || ""
+        request.env["PATH_INFO"] = response.remaining_path    || ""
       end
     end
   end

data/lib/usher/interface/rack_interface/route.rb

@@ -2,8 +2,15 @@ class Usher
   module Interface
     class RackInterface
       module Route
-        
+        # add("/index.html").redirect("/")
+        def redirect(path, status = 302)
+          lambda do
+            response = Rack::Response.new
+            response.redirect(path, status)
+            response.finish
+          end
+        end
       end
     end
   end
-end
+end

data/lib/usher/interface/rails2_2_interface.rb

@@ -2,7 +2,7 @@ require File.join(File.dirname(__FILE__), 'rails2_2_interface', 'mapper')
 
 class Usher
   module Interface
-    class Rails2_2Interface
+    class Rails22Interface
       
       attr_reader :usher
       attr_accessor :configuration_file

data/lib/usher/interface/rails2_2_interface/mapper.rb

@@ -1,6 +1,6 @@
 class Usher
   module Interface
-    class Rails2_2Interface
+    class Rails22Interface
       
       class Mapper #:doc:
         def initialize(set) #:nodoc:
@@ -41,4 +41,4 @@ class Usher
 
     end
   end
-end
+end

data/lib/usher/interface/rails2_3_interface.rb

@@ -1,6 +1,6 @@
 class Usher
   module Interface
-    class Rails2_3Interface
+    class Rails23Interface
       
       attr_reader :configuration_files
       
@@ -131,4 +131,4 @@ class Usher
       
     end
   end
-end
+end

data/lib/usher/route.rb

@@ -57,7 +57,7 @@ class Usher
     #   route.to(:controller => 'testing', :action => 'index')
     #   set.recognize(Request.new('/test')).first.params => {:controller => 'testing', :action => 'index'}
     def to(options = nil, &block)
-      raise "cannot set destintaion as block and argument" if block_given? && options
+      raise "cannot set destination as block and argument" if block_given? && options
       @destination = if block_given?
         block
       else

data/lib/usher/route/util.rb

@@ -22,7 +22,7 @@ class Usher
         (lval.size * rval.size).times do |index|
           val = []
           val.push(*lval[index % lval.size])
-          val.push(*rval[index % rval.size])
+          val.push(*rval[index / lval.size])
           product << val
         end
         lval.replace(product)

data/spec/private/email/recognize_spec.rb

@@ -1,4 +1,5 @@
-require 'lib/usher'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+require "usher"
 
 def build_email_mock(email)
   request = mock "Request"
@@ -33,4 +34,4 @@ describe "Usher (for email) route recognition" do
     @route_set.act('sub+ect.123-456-sdqwe123ae@mydomain.org')
   end
 
-end
+end

data/spec/private/generate_spec.rb

@@ -1,4 +1,5 @@
-require 'lib/usher'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+require "usher"
 require 'rack'
 
 describe "Usher URL generation" do

data/spec/private/grapher_spec.rb

@@ -1,5 +1,5 @@
-require 'lib/usher'
-
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+require "usher"
 
 describe "Usher grapher" do
 
@@ -37,4 +37,4 @@ describe "Usher grapher" do
   #  proc{ route_set.generate_url(nil, {:a => 'A', :b => 'B'})}.should raise_error Usher::ValidationException
   #end
 
-end
+end

data/spec/private/parser_spec.rb

@@ -1,4 +1,5 @@
-require 'lib/usher'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+require "usher"
 
 describe "Usher route tokenizing" do
   
@@ -72,4 +73,4 @@ describe "Usher route tokenizing" do
     parts[1].should == parts[3]
   end
   
-end
+end

data/spec/private/path_spec.rb

@@ -1,4 +1,5 @@
-require 'lib/usher'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+require "usher"
 
 route_set = Usher.new
 
@@ -22,14 +23,13 @@ describe "Usher route adding" do
   it "should add every kind of optional route possible" do
     route_set.add_route('/a/b(/c)(/d(/e))')
     route_set.routes.first.paths.collect{|a| a.parts }.should == [
-      ['/', "a", '/', "b"],
-      ['/', "a", '/', "b", '/', "c", '/', "d"], 
-      ['/', "a", '/', "b", '/', "d", '/', "e"], 
-      ['/', "a", '/', "b", '/', "c"],
-      ['/', "a", '/', "b", '/', "d"],
-      ['/', "a", '/', "b", '/', "c", '/', "d", '/', "e"]
+      ["/", "a", "/", "b"],
+      ["/", "a", "/", "b", "/", "c"],
+      ["/", "a", "/", "b", "/", "d"],
+      ["/", "a", "/", "b", "/", "c", "/", "d"],
+      ["/", "a", "/", "b", "/", "d", "/", "e"],
+      ["/", "a", "/", "b", "/", "c", "/", "d", "/", "e"]
     ]
-    
   end
 
   it "should allow named routes to be added" do
@@ -73,4 +73,4 @@ describe "Usher route adding" do
     
   end
 
-end
+end

data/spec/private/rack/dispatch_spec.rb

@@ -1,7 +1,7 @@
-require 'lib/usher'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+require "usher"
 require 'rack'
 
-require File.join(File.dirname(__FILE__), "..", "..", "spec_helper")
 route_set = Usher::Interface.for(:rack)
 route_set.extend(CallWithMockRequestMixin)
 

data/spec/private/rack/generate_spec.rb

@@ -1,7 +1,7 @@
-require 'lib/usher'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+require "usher"
 require 'rack'
 
-require File.join(File.dirname(__FILE__), "..", "..", "spec_helper")
 route_set = Usher::Interface.for(:rack)
 route_set.extend(CallWithMockRequestMixin)
 

data/spec/private/rails2_2/compat.rb

@@ -1 +1,2 @@
-require 'activesupport'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+require 'activesupport'

data/spec/private/rails2_2/generate_spec.rb

@@ -1,5 +1,6 @@
-require File.join(File.dirname(__FILE__), 'compat')
-require 'lib/usher'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+require File.expand_path(File.join(File.dirname(__FILE__), 'compat'))
+require "usher"
 
 route_set = Usher::Interface.for(:rails2_2)
 
@@ -25,4 +26,4 @@ describe "Usher (for rails 2.2) URL generation" do
     route_set.generate({:action => 'thingy'}, {:controller => 'sample', :action => 'index', :id => 123}, :generate).should == '/sample/thingy'
   end
 
-end
+end

data/spec/private/rails2_2/path_spec.rb

@@ -1,5 +1,6 @@
-require File.join(File.dirname(__FILE__), 'compat')
-require 'lib/usher'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+require File.expand_path(File.join(File.dirname(__FILE__), 'compat'))
+require "usher"
 
 route_set = Usher::Interface.for(:rails2_2)
 
@@ -13,4 +14,4 @@ describe "Usher (for rails 2.2) route adding" do
     proc { route_set.add_route('/bad/route') }.should raise_error
   end
 
-end
+end

data/spec/private/rails2_2/recognize_spec.rb

@@ -1,5 +1,6 @@
-require File.join(File.dirname(__FILE__), 'compat')
-require 'lib/usher'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+require File.expand_path(File.join(File.dirname(__FILE__), 'compat'))
+require "usher"
 require 'action_controller'
 
 route_set = Usher::Interface.for(:rails2_2)
@@ -76,4 +77,4 @@ describe "Usher (for rails 2.2) route recognition" do
   end
   
   
-end
+end

data/spec/private/rails2_3/compat.rb

@@ -1 +1,2 @@
-require 'activesupport'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+require 'activesupport'

data/spec/private/rails2_3/generate_spec.rb

@@ -1,5 +1,6 @@
-require File.join(File.dirname(__FILE__), 'compat')
-require 'lib/usher'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+require File.expand_path(File.join(File.dirname(__FILE__), 'compat'))
+require "usher"
 
 route_set = Usher::Interface.for(:rails2_3)
 
@@ -25,4 +26,4 @@ describe "Usher (for rails 2.3) URL generation" do
     route_set.generate({:action => 'thingy'}, {:controller => 'sample', :action => 'index', :id => 123}, :generate).should == '/sample/thingy'
   end
 
-end
+end

data/spec/private/rails2_3/path_spec.rb

@@ -1,5 +1,6 @@
-require File.join(File.dirname(__FILE__), 'compat')
-require 'lib/usher'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+require File.expand_path(File.join(File.dirname(__FILE__), 'compat'))
+require "usher"
 
 route_set = Usher::Interface.for(:rails2_3)
 
@@ -13,4 +14,4 @@ describe "Usher (for rails 2.3) route adding" do
     proc { route_set.add_route('/bad/route') }.should raise_error
   end
 
-end
+end

data/spec/private/rails2_3/recognize_spec.rb

@@ -1,5 +1,6 @@
-require File.join(File.dirname(__FILE__), 'compat')
-require 'lib/usher'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+require File.expand_path(File.join(File.dirname(__FILE__), 'compat'))
+require "usher"
 require 'action_controller'
 
 route_set = Usher::Interface.for(:rails2_3)
@@ -76,4 +77,4 @@ describe "Usher (for rails 2.3) route recognition" do
   end
   
   
-end
+end

data/spec/private/recognize_spec.rb

@@ -1,4 +1,5 @@
-require 'lib/usher'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+require "usher"
 
 route_set = Usher.new
 
@@ -208,6 +209,14 @@ describe "Usher route recognition" do
     proc {route_set.recognize(build_request({:method => 'get', :path => '/products/show/qweasd', :domain => 'admin.host.com'}))}.should raise_error
   end
   
+  it "should recognize multiple optional parts" do
+    target_route = route_set.add_route('/test(/this)(/too)')
+    route_set.recognize_path('/test').path.route.should == target_route
+    route_set.recognize_path('/test/this').path.route.should == target_route
+    route_set.recognize_path('/test/too').path.route.should == target_route
+    route_set.recognize_path('/test/this/too').path.route.should == target_route
+  end
+  
   describe "partial recognition" do
     it "should partially match a route" do
       route = route_set.add_route("/foo")

data/spec/private/request_method_spec.rb

@@ -1,4 +1,5 @@
-require 'lib/usher'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+require "usher"
 
 describe "Usher request method" do
 
@@ -12,4 +13,4 @@ describe "Usher request method" do
   end
 
 
-end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+libdir = File.expand_path("lib")
+$:.unshift(libdir) unless $:.include?(libdir)
+
 module CallWithMockRequestMixin
   def call_with_mock_request(url = "/sample", method = "GET", params = Hash.new)
     params.merge!(:method => method)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: usher
 version: !ruby/object:Gem::Version 
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors: 
 - Joshua Hull
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-15 00:00:00 -06:00
+date: 2009-09-25 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency