joshbuddy-usher 0.4.7 → 0.4.8

data/Rakefile

@@ -9,7 +9,7 @@ begin
     s.homepage = "http://github.com/joshbuddy/usher"
     s.authors = ["Joshua Hull"]
     s.files = FileList["[A-Z]*", "{lib,spec,rails}/**/*"]
-    s.add_dependency 'joshbuddy-fuzzy_hash', '>=0.0.3'
+    s.add_dependency 'fuzzyhash', '>=0.0.3'
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
@@ -34,3 +34,38 @@ Spec::Rake::SpecTask.new('spec_with_rcov') do |t|
   t.rcov = true
   t.rcov_opts = ['--exclude', 'spec']
 end
+
+require 'rake/rdoctask'
+desc "Generate documentation"
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  rd.rdoc_dir = 'rdoc'
+end
+
+# These are new tasks
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/joshbuddy-usher/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/VERSION.yml

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

data/lib/usher/generate.rb

@@ -1,22 +1,61 @@
+require 'rack'
+
+unless Rack::Utils.respond_to?(:uri_escape)
+  module Rack
+
+    module Utils
+
+      def uri_escape(s)
+        s.to_s.gsub(/([^:\/?\[\]\-_~\.!\$&'\(\)\*\+,;=@a-zA-Z0-9]+)/n) {
+          '%'<<$1.unpack('H2'*$1.size).join('%').upcase
+        }.tr(' ', '+')
+      end
+      module_function :uri_escape
+
+      def uri_unescape(s)
+        gsub(/((?:%[0-9a-fA-F]{2})+)/n){
+          [$1.delete('%')].pack('H*')
+        }
+      end
+      module_function :uri_unescape
+
+    end
+  end
+end
+
 class Usher
   class Generators
     
     class URL
-    
+      
       def initialize(usher)
         @usher = usher
       end
-    
-      # Generates a completed URL based on a +route+ or set of optional +params+
-      #   
-      #   set = Usher.new
-      #   route = set.add_named_route(:test_route, '/:controller/:action')
-      #   set.generate_url(nil, {:controller => 'c', :action => 'a'}) == '/c/a' => true
-      #   set.generate_url(:test_route, {:controller => 'c', :action => 'a'}) == '/c/a' => true
-      #   set.generate_url(route.primary_path, {:controller => 'c', :action => 'a'}) == '/c/a' => true
-      def generate(routing_lookup, params = nil, options = nil)
-        delimiter = options && options.key?(:delimiter) ? options.delete(:delimiter) : @usher.delimiters.first
 
+      def generate_full(routing_lookup, request, params = nil)
+        path = path_for_routing_lookup(routing_lookup, params)
+        result = generate_start(path, request)
+        result << generate_path(path, params)
+      end
+
+      def generate(routing_lookup, params = nil)
+        generate_path(path_for_routing_lookup(routing_lookup, params), params)
+      end
+
+      def generate_start(path, request)
+        result = (path.route.generate_with && path.route.generate_with.scheme || request.scheme).dup
+        result << '://'
+        result << (path.route.generate_with && path.route.generate_with.host) ? path.route.generate_with.host : request.host
+        port = path.route.generate_with && path.route.generate_with.port || request.port
+        if result[4] == ?s
+          result << ':' << port.to_s if port != 443
+        else
+          result << ':' << port.to_s if port != 80
+        end
+        result
+      end
+
+      def path_for_routing_lookup(routing_lookup, params)
         path = case routing_lookup
         when Symbol
           route = @usher.named_routes[routing_lookup] 
@@ -28,13 +67,23 @@ class Usher
         when Route::Path
           routing_lookup
         end
-
+      end
+    
+      # Generates a completed URL based on a +route+ or set of optional +params+
+      #   
+      #   set = Usher.new
+      #   route = set.add_named_route(:test_route, '/:controller/:action')
+      #   set.generate_url(nil, {:controller => 'c', :action => 'a'}) == '/c/a' => true
+      #   set.generate_url(:test_route, {:controller => 'c', :action => 'a'}) == '/c/a' => true
+      #   set.generate_url(route.primary_path, {:controller => 'c', :action => 'a'}) == '/c/a' => true
+      def generate_path(path, params = nil)
         raise UnrecognizedException.new unless path
 
         params = Array(params) if params.is_a?(String)
         if params.is_a?(Array)
+          given_size = params.size
           extra_params = params.last.is_a?(Hash) ? params.pop : nil
-          params = Hash[*path.dynamic_parts.inject([]){|a, dynamic_part| a.concat([dynamic_part.name, params.shift || raise(MissingParameterException.new)]); a}]
+          params = Hash[*path.dynamic_parts.inject([]){|a, dynamic_part| a.concat([dynamic_part.name, params.shift || raise(MissingParameterException.new("got #{given_size}, expected #{path.dynamic_parts.size} parameters"))]); a}]
           params.merge!(extra_params) if extra_params
         end
 
@@ -49,7 +98,7 @@ class Usher
                 current_value = current_value.to_s unless current_value.is_a?(String)
                 part.valid!(current_value)
                 result << current_value
-                result << delimiter if index != value.size - 1
+                result << '/' if index != value.size - 1
               end
             when :':'
               value = value.to_s unless value.is_a?(String)
@@ -60,7 +109,7 @@ class Usher
             result << part
           end
         end
-        result = URI.escape(result)
+        result = Rack::Utils.uri_escape(result)
 
         if params && !params.empty?
           has_query = result[??]
@@ -68,10 +117,10 @@ class Usher
             case v
             when Array
               v.each do |v_part|
-                result << (has_query ? '&' : has_query = true && '?') << CGI.escape("#{k.to_s}[]") << '=' << CGI.escape(v_part.to_s)
+                result << (has_query ? '&' : has_query = true && '?') << Rack::Utils.escape("#{k.to_s}[]") << '=' << Rack::Utils.escape(v_part.to_s)
               end
             else
-              result << (has_query ? '&' : has_query = true && '?') << CGI.escape(k.to_s) << '=' << CGI.escape(v.to_s)
+              result << (has_query ? '&' : has_query = true && '?') << Rack::Utils.escape(k.to_s) << '=' << Rack::Utils.escape(v.to_s)
             end
           end
         end

data/lib/usher/interface/email_interface.rb

@@ -1,7 +1,3 @@
-$:.unshift File.dirname(__FILE__)
-
-require 'rack_interface/route'
-
 class Usher
   module Interface
     class EmailInterface

data/lib/usher/interface/merb_interface.rb

@@ -1,5 +1,3 @@
-$:.unshift File.dirname(__FILE__)
-
 require 'merb-core'
 require 'merb-core/dispatch/router/behavior'
 

data/lib/usher/interface/rack_interface.rb

@@ -1,18 +1,13 @@
-$:.unshift File.dirname(__FILE__)
-
-require 'rack_interface/route'
+require 'rack'
 
 class Usher
   module Interface
     class RackInterface
       
-      RequestMethods = [:method, :host, :port, :scheme]
-      Request = Struct.new(:path, *RequestMethods)
-      
       attr_accessor :routes
       
       def initialize(&blk)
-        @routes = Usher.new(:request_methods => RequestMethods)
+        @routes = Usher.new(:request_methods => [:method, :host, :port, :scheme])
         @generator = Usher::Generators::URL.new(@routes)
         instance_eval(&blk) if blk
       end
@@ -26,7 +21,7 @@ class Usher
       end
 
       def call(env)
-        response = @routes.recognize(Request.new(env['REQUEST_URI'], env['REQUEST_METHOD'].downcase, env['HTTP_HOST'], env['SERVER_PORT'].to_i, env['rack.url_scheme']))
+        response = @routes.recognize(Rack::Request.new(env))
         params = {}
         response.params.each{ |hk| params[hk.first] = hk.last}
         env['usher.params'] = params

data/lib/usher/interface/rails2_2_interface.rb

@@ -1,6 +1,4 @@
-$:.unshift File.dirname(__FILE__)
-
-require 'rails2_2_interface/mapper'
+require File.join(File.dirname(__FILE__), 'rails2_2_interface', 'mapper')
 
 class Usher
   module Interface

data/lib/usher/interface/rails2_3_interface.rb

@@ -1,5 +1,3 @@
-$:.unshift File.dirname(__FILE__)
-
 class Usher
   module Interface
     class Rails2_3Interface

data/lib/usher/interface.rb

@@ -1,12 +1,10 @@
-$:.unshift File.dirname(__FILE__)
-
 class Usher
   module Interface
-    autoload :Rails2_2Interface, 'interface/rails2_2_interface'
-    autoload :Rails2_3Interface, 'interface/rails2_3_interface'
-    autoload :MerbInterface, 'interface/merb_interface'
-    autoload :RackInterface, 'interface/rack_interface'
-    autoload :EmailInterface, 'interface/email_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')
     
     def self.for(type, &blk)
       case type

data/lib/usher/node.rb

@@ -1,5 +1,3 @@
-$:.unshift File.dirname(__FILE__)
-
 require 'fuzzy_hash'
 
 class Usher
@@ -51,7 +49,7 @@ class Usher
       route.paths.each do |path|
         parts = path.parts.dup
         request_methods.each do |type|
-          parts.push(Route::RequestMethod.new(type, route.conditions[type])) if route.conditions.key?(type)
+          parts.push(Route::RequestMethod.new(type, route.conditions[type])) if route.conditions && route.conditions.key?(type)
         end
         
         current_node = self

data/lib/usher/route.rb

@@ -1,20 +1,21 @@
-$:.unshift File.dirname(__FILE__)
-
-require 'route/path'
-require 'route/variable'
-require 'route/request_method'
+require File.join(File.dirname(__FILE__), 'route', 'path')
+require File.join(File.dirname(__FILE__), 'route', 'variable')
+require File.join(File.dirname(__FILE__), 'route', 'request_method')
 
 class Usher
   class Route
-    attr_reader :paths, :original_path, :requirements, :conditions, :destination, :named
+    attr_reader :paths, :original_path, :requirements, :conditions, :destination, :named, :generate_with
+    
+    GenerateWith = Struct.new(:scheme, :port, :host)
     
-    def initialize(original_path, router, conditions, requirements, default_values) # :nodoc:
+    def initialize(original_path, router, conditions, requirements, default_values, generate_with) # :nodoc:
       @original_path = original_path
       @router = router
       @requirements = requirements
       @conditions = conditions
       @default_values = default_values
       @paths = @router.splitter.split(@original_path, @requirements, @default_values).collect {|path| Path.new(self, path)}
+      @generate_with = GenerateWith.new(generate_with[:scheme], generate_with[:port], generate_with[:host]) if generate_with
     end
     
     def grapher

data/lib/usher.rb

@@ -1,16 +1,14 @@
-$:.unshift File.dirname(__FILE__)
-
-require 'cgi'
-require 'uri'
-require 'usher/node'
-require 'usher/route'
-require 'usher/grapher'
-require 'usher/interface'
-require 'usher/splitter'
-require 'usher/exceptions'
-require 'usher/generate'
+require File.join(File.dirname(__FILE__), 'usher', 'node')
+require File.join(File.dirname(__FILE__), 'usher', 'route')
+require File.join(File.dirname(__FILE__), 'usher', 'grapher')
+require File.join(File.dirname(__FILE__), 'usher', 'interface')
+require File.join(File.dirname(__FILE__), 'usher', 'splitter')
+require File.join(File.dirname(__FILE__), 'usher', 'exceptions')
 
 class Usher
+
+  autoload :Generators, File.join(File.dirname(__FILE__), 'usher', 'generate')
+
   attr_reader :tree, :named_routes, :route_count, :routes, :splitter, :delimiters
   
   SymbolArraySorter = proc {|a,b| a.hash <=> b.hash} #:nodoc:
@@ -142,18 +140,19 @@ class Usher
   # * +conditions+ - Accepts any of the +request_methods+ specificied in the construction of Usher. This can be either a <tt>string</tt> or a regular expression.
   # * Any other key is interpreted as a requirement for the variable of its name.
   def add_route(path, options = nil)
-    conditions = options && options.delete(:conditions) || {}
-    requirements = options && options.delete(:requirements) || {}
-    default_values = options && options.delete(:default_values) || {}
+    conditions = options && options.delete(:conditions) || nil
+    requirements = options && options.delete(:requirements) || nil
+    default_values = options && options.delete(:default_values) || nil
+    generate_with = options && options.delete(:generate_with) || nil
     if options
       options.delete_if do |k, v|
         if v.is_a?(Regexp) || v.is_a?(Proc)
-          requirements[k] = v 
+          (requirements ||= {})[k] = v 
           true
         end
       end
     end
-    route = Route.new(path, self, conditions, requirements, default_values)
+    route = Route.new(path, self, conditions, requirements, default_values, generate_with)
     route.to(options) if options && !options.empty?
     
     @tree.add(route)

data/spec/private/generate_spec.rb

@@ -1,5 +1,5 @@
 require 'lib/usher'
-
+require 'rack'
 
 describe "Usher URL generation" do
   
@@ -87,6 +87,11 @@ describe "Usher URL generation" do
     @url_generator.generate(:name, ['controller', 'action', 'html']).should == '/controller/action.html'
   end
 
+  it "should generate a route with a specific host" do
+    caf = @route_set.add_named_route(:name, '/:controller/:action.:format', :generate_with => {:host => 'www.slashdot.org', :port => 80})
+    @url_generator.generate_full(:name, Rack::Request.new(Rack::MockRequest.env_for("http://localhost:8080")), ['controller', 'action', 'html']).should == 'http://www.slashdot.org/controller/action.html'
+  end
+
   it "should require all the parameters (hash) to generate a route" do
     proc {@url_generator.generate(@route_set.add_route('/:controller/:action'), {:controller => 'controller'})}.should raise_error Usher::MissingParameterException
   end

data/spec/private/rack/dispatch_spec.rb

@@ -1,22 +1,8 @@
 require 'lib/usher'
 
-route_set = Usher::Interface.for(:rack)
-
-def build_request_mock(path, method, params)
-  request = mock "Request"
-  request.should_receive(:path).any_number_of_times.and_return(path)
-  request.should_receive(:method).any_number_of_times.and_return(method)
-  params = params.with_indifferent_access
-  request.should_receive(:path_parameters=).any_number_of_times.with(params)
-  request.should_receive(:path_parameters).any_number_of_times.and_return(params)
-  request
-end
+require 'rack'
 
-def build_app_mock(params)
-  request = mock "App"
-  request.should_receive(:call).any_number_of_times.with(params)
-  request
-end
+route_set = Usher::Interface.for(:rack)
 
 describe "Usher (for rack) route dispatching" do
 
@@ -25,9 +11,19 @@ describe "Usher (for rack) route dispatching" do
   end
 
   it "should dispatch a simple request" do
-    env = {'REQUEST_URI' => '/sample', 'REQUEST_METHOD' => 'get', 'usher.params' => {}}
-    route_set.add('/sample').to(build_app_mock(env.dup))
-    route_set.call(env)
+    app = mock 'app'
+    app.should_receive(:call).once.with {|v| v['usher.params'].should == {} }
+    route_set.add('/sample').to(app)
+    route_set.call(Rack::MockRequest.env_for("/sample", :method => 'GET'))
+  end
+  
+  it "should dispatch a POST request" do
+    bad_app = mock 'bad_app'
+    app = mock 'app'
+    app.should_receive(:call).once.with {|v| v['usher.params'].should == {} }
+    route_set.add('/sample').to(bad_app)
+    route_set.add('/sample', :requirements => {:request_method => 'POST'}).to(app)
+    route_set.call(Rack::MockRequest.env_for("/sample", :request_method => 'POST'))
   end
   
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: joshbuddy-usher
 version: !ruby/object:Gem::Version 
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors: 
 - Joshua Hull
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-12 00:00:00 -07:00
+date: 2009-06-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: joshbuddy-fuzzy_hash
+  name: fuzzyhash
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -73,7 +73,7 @@ files:
 - spec/private/request_method_spec.rb
 - spec/private/split_spec.rb
 - spec/spec.opts
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/joshbuddy/usher
 post_install_message: 
 rdoc_options: 
@@ -97,7 +97,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A general purpose routing library
 test_files: 
 - spec/private/email/recognize_spec.rb