usher 0.5.11 → 0.5.12

data/Rakefile

@@ -1,53 +1,48 @@
-libdir = File.expand_path("lib")
-$:.unshift(libdir) unless $:.include?(libdir)
-
-require 'usher'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name = "usher"
-    s.description = s.summary = "A general purpose routing library"
-    s.email = "joshbuddy@gmail.com"
-    s.homepage = "http://github.com/joshbuddy/usher"
-    s.authors = ["Joshua Hull"]
-    s.files = FileList["[A-Z]*", "{lib,spec,rails}/**/*"]
-    s.add_dependency 'fuzzyhash', '>=0.0.9'
-    s.rubyforge_project = 'joshbuddy-usher'
-  end
-  Jeweler::GemcutterTasks.new
-  Jeweler::RubyforgeTasks.new do |rubyforge|
-    rubyforge.doc_task = "rdoc"
-    rubyforge.remote_doc_path = ''
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
-
-require 'spec'
-require 'spec/rake/spectask'
-task :spec => 'spec:all'
-namespace(:spec) do
-  Spec::Rake::SpecTask.new(:all) do |t|
-    t.spec_opts ||= []
-    t.spec_opts << "-rubygems"
-    t.spec_opts << "--options" << "spec/spec.opts"
-    t.spec_files = FileList['spec/**/*_spec.rb']
-  end
-
-end
-
-desc "Run all examples with RCov"
-Spec::Rake::SpecTask.new('spec_with_rcov') do |t|
-  t.spec_files = FileList['spec/**/*.rb']
-  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
+# encoding: utf-8
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'lib', 'usher'))
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "usher"
+    s.description = s.summary = "A general purpose routing library"
+    s.email = "joshbuddy@gmail.com"
+    s.homepage = "http://github.com/joshbuddy/usher"
+    s.authors = ["Joshua Hull", 'Jakub Šťastný', 'Daniel Neighman', 'Daniel Vartanov'].sort
+    s.files = FileList["[A-Z]*", "{lib,spec,rails}/**/*"]
+    s.add_dependency 'fuzzyhash', '>=0.0.9'
+    s.rubyforge_project = 'joshbuddy-usher'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec'
+require 'spec/rake/spectask'
+task :spec => 'spec:all'
+namespace(:spec) do
+  Spec::Rake::SpecTask.new(:all) do |t|
+    t.spec_opts ||= []
+    t.spec_opts << "-rubygems"
+    t.spec_opts << "--options" << "spec/spec.opts"
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('spec_with_rcov') do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  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

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :build: 
-:patch: 11
-:major: 0
 :minor: 5
+:patch: 12
+:major: 0

data/lib/usher.rb

@@ -1,12 +1,13 @@
-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')
-require File.join(File.dirname(__FILE__), 'usher', 'util')
-require File.join(File.dirname(__FILE__), 'usher', 'spinoffs', 'strscan_additions')
-require File.join(File.dirname(__FILE__), 'usher', 'delimiters')
+$: << File.expand_path(File.dirname(__FILE__))
+require File.join('usher', 'node')
+require File.join('usher', 'route')
+require File.join('usher', 'grapher')
+require File.join('usher', 'interface')
+require File.join('usher', 'splitter')
+require File.join('usher', 'exceptions')
+require File.join('usher', 'util')
+require File.join('usher', 'spinoffs', 'strscan_additions')
+require File.join('usher', 'delimiters')
 
 class Usher
   attr_reader :root, :named_routes, :routes, :splitter,
@@ -53,8 +54,7 @@ class Usher
   # Array of methods called against the request object for the purposes of matching route requirements.
   def initialize(options = nil)
     self.generator       = options && options.delete(:generator)
-    delimiters_array     = options && options.delete(:delimiters) || ['/', '.']
-    self.delimiters      = Delimiters.new(delimiters_array)
+    self.delimiters      = Delimiters.new(options && options.delete(:delimiters) || ['/', '.'])
     self.valid_regex     = options && options.delete(:valid_regex) || '[0-9A-Za-z\$\-_\+!\*\',]+'
     self.request_methods = options && options.delete(:request_methods)
     reset!
@@ -95,7 +95,7 @@ class Usher
   #   route = set.add_route('/test')
   #   set.name(:test, route)
   def name(name, route)
-    @named_routes[name] = route
+    @named_routes[name.to_sym] = route
     route
   end
 

data/lib/usher/delimiters.rb

@@ -1,14 +1,14 @@
 class Delimiters < Array
-  # TODO: caching
+
+  attr_reader :unescaped
   
-  def unescaped
-    self.map do |delimiter|
-      (delimiter[0] == ?\\) ?
-              delimiter[1..-1] :
-              delimiter
+  def initialize(ary)
+    super ary
+    @unescaped = self.map do |delimiter|
+      (delimiter[0] == ?\\) ? delimiter[1..-1] : delimiter
     end
   end
-
+  
   def first_in(array)
     # TODO: should we optimize this O(n*m)? hash or modified or KNP or at leaset sort + b-search. But they are so short
 

data/lib/usher/interface.rb

@@ -1,43 +1,32 @@
-# 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
-    # 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")
+    InterfaceRegistry = {}
+
+    def self.register(name, cls)
+      InterfaceRegistry[name] = cls
     end
 
+    register(:email,    File.join(File.dirname(__FILE__), 'interface', 'email'))
+    register(:merb,     File.join(File.dirname(__FILE__), 'interface', 'merb'))
+    register(:rails20,  File.join(File.dirname(__FILE__), 'interface', 'rails20'))
+    register(:rails22,  File.join(File.dirname(__FILE__), 'interface', 'rails22'))
+    register(:rails23,  File.join(File.dirname(__FILE__), 'interface', 'rails23'))
+    register(:rack,     File.join(File.dirname(__FILE__), 'interface', 'rack'))
+    register(:rails3,   File.join(File.dirname(__FILE__), 'interface', 'rails3'))
+    register(:text,     File.join(File.dirname(__FILE__), 'interface', 'text'))
+
     # 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)
+      name = name.to_sym
+      if InterfaceRegistry[name]
+        require InterfaceRegistry[name]
+        const = Usher::Interface.const_get(File.basename(InterfaceRegistry[name]).to_s.split(/_/).map{|e| e.capitalize}.join)
+        const.new(&block)
       else
-        raise ArgumentError, "Interface #{name} doesn't exist. Choose one of: #{self.interfaces.inspect}"
+        raise ArgumentError, "Interface #{name.inspect} doesn't exist. Choose one of: #{InterfaceRegistry.keys.inspect}"
       end
     end
 
-    # 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

data/lib/usher/interface/{email_interface.rb → email.rb}

@@ -1,6 +1,6 @@
 class Usher
   module Interface
-    class EmailInterface
+    class Email
       
       def initialize(&blk)
         @routes = Usher.new(:delimiters => ['@', '-', '.'], :valid_regex => '[\+a-zA-Z0-9]+')

data/lib/usher/interface/{merb_interface.rb → merb.rb}

@@ -3,7 +3,7 @@ require 'merb-core/dispatch/router/behavior'
 
 class Usher
   module Interface
-    class MerbInterface
+    class Merb
       
       # merb does everything with class methods.
 

data/lib/usher/interface/{rack_interface.rb → rack.rb}

@@ -1,11 +1,12 @@
-require 'rack'
+require "rack"
+require File.join(File.dirname(__FILE__), 'rack', 'route')
 
 class Usher
   module Interface
-    class RackInterface
-      class Builder < Rack::Builder
+    class Rack
+      class Builder < ::Rack::Builder
         def initialize(&block)
-          @usher = Usher::Interface::RackInterface.new
+          @usher = Usher::Interface::Rack.new
           super
         end
 
@@ -14,7 +15,10 @@ class Usher
           @ins << @usher unless @ins.last == @usher
         end
 
+        # it returns route, and because you may want to work with the route,
+        # for example give it a name, we returns the route with GET request
         def get(path, options = nil, &block)
+          self.map(path, options.merge!(:conditions => {:request_method => "HEAD"}), &block)
           self.map(path, options.merge!(:conditions => {:request_method => "GET"}), &block)
         end
 
@@ -35,7 +39,7 @@ class Usher
       attr_accessor :app
 
       def initialize(app = nil, &blk)
-        @app = app || lambda { |env| Rack::Response.new("No route found", 404).finish }
+        @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
@@ -63,11 +67,11 @@ class Usher
       # 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"]}})
+
+      # it returns route, and because you may want to work with the route,
+      # for example give it a name, we returns the route with GET request
       def get(path, options = {})
-        self.add(path, options.merge!(:conditions => {:request_method => "GET"}))
+        self.add(path, options.merge!(:conditions => {:request_method => ["HEAD", "GET"]}))
       end
 
       def post(path, options = {})
@@ -95,7 +99,7 @@ class Usher
       end
 
       def call(env)
-        request = Rack::Request.new(env)
+        request = ::Rack::Request.new(env)
         response = @router.recognize(request, request.path_info)
         after_match(request, response) if response
         determine_respondant(response).call(env)

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

@@ -0,0 +1,16 @@
+class Usher
+  class Route
+    # add("/index.html").redirect("/")
+    def redirect(path, status = 302)
+      unless (300..399).include?(status)
+        raise ArgumentError, "Status has to be an integer between 300 and 399"
+      end
+      @destination = lambda do |env|
+        response = Rack::Response.new
+        response.redirect(path, status)
+        response.finish
+      end
+      return self
+    end
+  end
+end

data/lib/usher/interface/rails20.rb

@@ -0,0 +1,7 @@
+class Usher
+  module Interface
+    class Rails20 < Rails22
+      Mapper = Usher::Interface::Rails22::Mapper
+    end        
+  end
+end

data/lib/usher/interface/{rails2_2_interface.rb → rails22.rb}

@@ -1,8 +1,8 @@
-require File.join(File.dirname(__FILE__), 'rails2_2_interface', 'mapper')
+require File.join('usher', 'interface', 'rails22', 'mapper')
 
 class Usher
   module Interface
-    class Rails22Interface
+    class Rails22
       
       attr_reader :usher
       attr_accessor :configuration_file
@@ -10,9 +10,12 @@ class Usher
       def initialize
         reset!
       end
-      
-      def reset!
-        @usher ||= Usher.new(:generator => Usher::Util::Generators::URL.new, :request_methods => [:protocol, :domain, :port, :query_string, :remote_ip, :user_agent, :referer, :method, :subdomains])
+
+      def reset!(options={})
+        options[:generator] = options[:generator] || Usher::Util::Generators::URL.new
+        options[:request_methods] = options[:request_methods] || [:protocol, :domain, :port, :query_string, :remote_ip, :user_agent, :referer, :method, :subdomains]
+
+        @usher = Usher.new(options)
         @module ||= Module.new
         @module.instance_methods.each do |selector|
           @module.class_eval { remove_method selector }
@@ -32,7 +35,7 @@ class Usher
           add_route('/:controller', options.merge({:action => 'index'}))
           @controller_route_added = true 
         end
-        
+
         options[:action] = 'index' unless options[:action]
 
         path[0, 0] = '/' unless path[0] == ?/
@@ -109,25 +112,22 @@ class Usher
         reload
       end
 
-      def draw
-        reset!
+      def draw(options={})
+        reset!(options)
         yield Mapper.new(self)
         install_helpers
       end
 
       def install_helpers(destinations = [ActionController::Base, ActionView::Base], regenerate_code = false)
-        #*_url and hash_for_*_url
-        Array(destinations).each do |d| d.module_eval { include Helpers } 
-          @usher.named_routes.keys.each do |name|
-            @module.module_eval <<-end_eval # We use module_eval to avoid leaks
-              def #{name}_url(options = {})
-                ActionController::Routing::UsherRoutes.generate(options, {}, :generate, :#{name})
-              end
-            end_eval
-          end
-          d.__send__(:include, @module)
+        Array(destinations).each do |destination|
+          destination.module_eval { include Helpers }
+          destination.__send__(:include, @usher.generator.generation_module)
         end
       end
+
+      def routes
+        @usher.routes
+      end
       
     end
   end

data/lib/usher/interface/{rails2_2_interface → rails22}/mapper.rb

@@ -1,13 +1,13 @@
 class Usher
   module Interface
-    class Rails22Interface
+    class Rails22
       
       class Mapper #:doc:
         def initialize(set) #:nodoc:
           @set = set
         end
 
-        def connect(path, options = nil)
+        def connect(path, options = {})
           @set.add_route(path, options)
         end
 

data/lib/usher/interface/{rails2_3_interface.rb → rails23.rb}

@@ -1,6 +1,6 @@
 class Usher
   module Interface
-    class Rails23Interface
+    class Rails23
       
       attr_reader :configuration_files
       

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

@@ -0,0 +1,44 @@
+class Usher
+  module Interface
+    class Rails23
+      
+      class Mapper #:doc:
+        def initialize(set) #:nodoc:
+          @set = set
+        end
+
+        def connect(path, options = {})
+          @set.add_route(path, options)
+        end
+
+        def root(options = {})
+          if options.is_a?(Symbol)
+            if source_route = @set.named_routes[options]
+              options = source_route.conditions.blank? ? 
+                source_route.options.merge({ :conditions => source_route.conditions }) : source_route.options
+            end
+          end
+          named_route(:root, '/', options)
+        end
+
+        def named_route(name, path, options = nil)
+          @set.add_named_route(name, path, options)
+        end
+
+        def namespace(name, options = {}, &block)
+          if options[:namespace]
+            with_options({:path_prefix => "#{options.delete(:path_prefix)}/#{name}", :name_prefix => "#{options.delete(:name_prefix)}#{name}_", :namespace => "#{options.delete(:namespace)}#{name}/" }.merge(options), &block)
+          else
+            with_options({:path_prefix => name, :name_prefix => "#{name}_", :namespace => "#{name}/" }.merge(options), &block)
+          end
+        end
+
+        def method_missing(route_name, *args, &proc) #:nodoc:
+          super unless args.length >= 1 && proc.nil?
+          @set.add_named_route(route_name, *args)
+        end
+      end
+
+    end
+  end
+end