padrino-routing 0.1.1 → 0.1.2

data/README.rdoc

@@ -1,6 +1,95 @@
 = padrino-routing
 
-Description goes here.
+This component provides Sinatra with an enhanced url routing system which enables named route aliases to be defined
+and used throughout your application to refer to urls. The benefits of this is that instead of having to hard-code route urls
+into every area of your application, now we can just define the urls in a single spot and then attach an alias
+which can be used to refer to the url throughout the rest. 
+
+== Installation
+
+To install the 'full-stack' padrino framework, simply grab the latest version from gemcutter:
+
+  $ sudo gem install padrino --source http://gemcutter.org
+  
+This will install the necessary padrino gems to get you started.
+Now you are ready to use this gem to enhance your sinatra projects or to create new Padrino applications.
+
+You can also install only the padrino-routing gem for more fine-grained use:
+
+  $ sudo gem install padrino-routing --source http://gemcutter.org
+  
+== Usage
+
+Let's take a look at how to define named route mappings:
+
+  # /app/routes/example.rb
+  require 'padrino-routing'
+  
+  class RoutingDemo < Sinatra::Application
+    register SinatraMore::RoutingPlugin  
+    
+    # Define the named route mappings
+    map(:account).to("/the/accounts/:name/and/:id")
+    map(:accounts).to("/the/accounts/index")
+    
+    # Configure the routes using the named alias
+    get(:account)  { "name: params[:name] - id: params[:id]" }    
+    get(:accounts) { "I am the body for the url /the/accounts/index" }
+  end
+
+Notice we simply create a route alias using the <tt>map</tt> function and then pass in the corresponding url into the <tt>to</tt> method.
+You can then define the routes using the named symbol representing the url. The route aliases can be accessed using <tt>url_for</tt>
+
+  url_for(:accounts)
+  url_for(:account, :id => 1, :name => 'first')
+
+You can also refer to the url in views using <tt>url_for</tt>
+
+  # /app/views/index.erb
+  <p>Go to the <%= link_to 'accounts dashboard', url_for(:accounts) %> to view your accounts</p>
+  <p>Go to account for <%= link_to 'first account', url_for(:account, :id => 1, :name => 'first') %>
+
+Simply invoking <tt>url_for(name, *parameters)</tt> will return the full mapped url for use in links or anywhere else
+that the url might be required.
+
+The routing system also supports url route configuration namespaces:
+
+  # /app/routes/example.rb
+  map(:admin, :show).to("/admin/:id/show")
+  
+  namespace :admin do
+    get :show do
+      "admin show for #{params[:id]}"
+    end
+  end
+  
+You could also define the route aliases themselves using a namespace for convenience:
+
+  # /app/routes/example.rb
+  map :admin do |namespace|
+    namespace.map(:show).to("/admin/:id/show")
+    namespace.map(:destroy).to("/admin/:id/destroy")
+  end
+  
+  namespace :admin do
+    get :show do
+      "admin show for #{params[:id]}"
+    end
+    
+    get :destroy do
+      "admin destroy for #{params[:id]}"
+    end
+  end
+
+You can then reference the urls using the same <tt>url_for</tt> method:
+
+  <%= link_to 'admin page', url_for(:admin, :show, :id => 25) %>
+  <%= link_to 'admin page', url_for(:admin, :update, :id => 25) %>
+  <%= link_to 'admin page', url_for(:admin, :show, :id => 25) %>
+  
+You can freely use both named route aliases and traditional Sinatra routes in the same application without conflict.
+
+See the wiki article for additional information: <...WIKI...>
 
 == Copyright
 

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gem.homepage = "http://github.com/padrino/padrino-routing"
     gem.authors = ["Padrino Team", "Nathan Esquenazi", "Davide D'Agostino", "Arthur Chiu"]
     gem.add_runtime_dependency     "sinatra",       ">= 0.9.2"
+    gem.add_runtime_dependency     "padrino-core",  ">= 0.1.1"
     gem.add_development_dependency "haml",          ">= 2.2.1"
     gem.add_development_dependency "shoulda", ">= 0"
     gem.add_development_dependency "mocha",         ">= 0.9.7"

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/padrino-routing.rb

@@ -36,11 +36,17 @@ module Padrino
       # Supports namespaces by accessing the instance variable and appending this to the route alias name
       # If the path is not a symbol, nothing is changed and the original route method is invoked
       def route(verb, path, options={}, &block)
-        if path.kind_of? Symbol
-          route_name = [self.app_name, @_namespace, path].flatten.compact
-          path = named_paths[route_name]
-          raise RouteNotFound.new("Route alias #{route_name.inspect} is not mapped to a url") unless path
+        if path.kind_of?(Symbol) 
+          route_name = [@_namespace, path].flatten.compact
+          if mapped_url = options.delete(:map) # constructing named route
+            map(*route_name).to(mapped_url) 
+            path = mapped_url
+          else # referencing prior named route
+            route_name.unshift(self.app_name)
+            path = named_paths[route_name]
+          end
         end
+        raise RouteNotFound.new("Route alias #{route_name.inspect} is not mapped to a url") unless path
         super verb, path, options, &block
       end
     end

data/lib/padrino-routing/controller_ext.rb

@@ -0,0 +1,20 @@
+# TODO add tests to make sure this works
+
+module Padrino
+  module ControllerNamespacing
+    # Makes the routes defined in the block and in the Modules given
+    # in `extensions` available to the application
+    def controllers_with_namespaces(*namespace, &block)
+      controllers_without_namespaces unless namespace.size == 1 && namespace.first.is_a?(Symbol)
+      @routes = Padrino::Application.dupe_routes if reload?
+      namespace(namespace.first) { instance_eval(&block) } if block_given?
+    end
+  end
+  
+  class Application 
+    extend Padrino::ControllerNamespacing
+    class << self
+      alias_method_chain :controllers, :namespaces
+    end
+  end if defined?(Padrino::Application)
+end

data/padrino-routing.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{padrino-routing}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Padrino Team", "Nathan Esquenazi", "Davide D'Agostino", "Arthur Chiu"]
-  s.date = %q{2009-11-17}
+  s.date = %q{2009-11-18}
   s.description = %q{Enhances padrino with a named route mapping system allowing for advanced routes}
   s.email = %q{nesquena@gmail.com}
   s.extra_rdoc_files = [
@@ -26,13 +26,22 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/padrino-routing.rb",
+     "lib/padrino-routing/controller_ext.rb",
      "lib/padrino-routing/helpers.rb",
      "lib/padrino-routing/named_route.rb",
      "padrino-routing.gemspec",
      "test/active_support_helpers.rb",
+     "test/fixtures/adv_routing_app/Gemfile",
+     "test/fixtures/adv_routing_app/app.rb",
+     "test/fixtures/adv_routing_app/config/apps.rb",
+     "test/fixtures/adv_routing_app/config/boot.rb",
+     "test/fixtures/adv_routing_app/config/urls.rb",
+     "test/fixtures/adv_routing_app/controllers/namespacing.rb",
+     "test/fixtures/adv_routing_app/controllers/url_autogeneration.rb",
      "test/fixtures/routing_app/app.rb",
      "test/fixtures/routing_app/views/index.haml",
      "test/helper.rb",
+     "test/test_padrino_adv_routing.rb",
      "test/test_padrino_routing.rb"
   ]
   s.homepage = %q{http://github.com/padrino/padrino-routing}
@@ -47,6 +56,7 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<sinatra>, [">= 0.9.2"])
+      s.add_runtime_dependency(%q<padrino-core>, [">= 0.1.1"])
       s.add_development_dependency(%q<haml>, [">= 2.2.1"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<mocha>, [">= 0.9.7"])
@@ -54,6 +64,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<webrat>, [">= 0.5.1"])
     else
       s.add_dependency(%q<sinatra>, [">= 0.9.2"])
+      s.add_dependency(%q<padrino-core>, [">= 0.1.1"])
       s.add_dependency(%q<haml>, [">= 2.2.1"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<mocha>, [">= 0.9.7"])
@@ -62,6 +73,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<sinatra>, [">= 0.9.2"])
+    s.add_dependency(%q<padrino-core>, [">= 0.1.1"])
     s.add_dependency(%q<haml>, [">= 2.2.1"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<mocha>, [">= 0.9.7"])

data/test/fixtures/adv_routing_app/Gemfile

@@ -0,0 +1,9 @@
+clear_sources
+source 'http://gemcutter.org'
+ 
+# Base requirements
+gem 'sinatra', :require_as => 'sinatra/base'
+gem 'rack-flash'
+ 
+# Component requirements
+gem 'haml'

data/test/fixtures/adv_routing_app/app.rb

@@ -0,0 +1,4 @@
+class AdvRoutingDemo < Padrino::Application
+  set :app_file, __FILE__
+  set :reload, false
+end

data/test/fixtures/adv_routing_app/config/apps.rb

@@ -0,0 +1 @@
+Padrino.mount_core(:app_class => "AdvRoutingDemo")

data/test/fixtures/adv_routing_app/config/boot.rb

@@ -0,0 +1,6 @@
+# AUTOGENERATED FILE -- Don't change this file unless you know what you are doing! 
+PADRINO_ROOT = File.dirname(__FILE__) + '/..' unless defined? PADRINO_ROOT
+require 'padrino-core'
+require 'padrino-mailer'
+require 'padrino-routing'
+Padrino.load!

data/test/fixtures/adv_routing_app/config/urls.rb

@@ -0,0 +1,7 @@
+AdvRoutingDemo::urls do
+  map(:test).to("/test/:id/action")
+  map(:admin, :settings).to("/admin/settings/action")
+  map :admin do |admin|
+    admin.map(:dashboard).to("/admin/:id/the/dashboard")
+  end
+end

data/test/fixtures/adv_routing_app/controllers/namespacing.rb

@@ -0,0 +1,26 @@
+AdvRoutingDemo::controllers :admin do
+  get :dashboard do
+    "<h1>This is the admin dashboard, id: #{params[:id]}</h1>"
+  end
+
+  get :panel, :map => "/admin/panel/:name/thing" do
+    "<h1>This is the admin panel, name: #{params[:name]}</h1>"
+  end
+  
+  get :simple, :map => '/admin/simple' do
+    "<h1>This is the admin simple</h1>"
+  end
+  
+  get :settings do
+    "<h1>This is the settings</h1>"
+  end
+end
+
+
+AdvRoutingDemo::controllers do
+  namespace :blog do
+    get :index, :map => "/blog/index/action" do
+      "<h1>Here is the blog</h1>"
+    end
+  end
+end

data/test/fixtures/adv_routing_app/controllers/url_autogeneration.rb

@@ -0,0 +1,17 @@
+AdvRoutingDemo::controllers do
+  get :simple, :map => "/some/simple/action" do
+    "<h1>simple action welcomes you</h1>"
+  end
+  
+  get :hello, :map => "/some/hello/action/:id/param" do
+    "<h1>hello params id is #{params[:id]}</h1>"
+  end
+  
+  get :multiple, :map => '/some/:name/and/:id' do
+    "<h1>id is #{params[:id]}, name is #{params[:name]}</h1>"
+  end
+  
+  get :test do
+    "<h1>This is a test action, id: #{params[:id]}</h1>"
+  end
+end

data/test/fixtures/routing_app/app.rb

@@ -1,5 +1,6 @@
 require 'sinatra/base'
 require 'haml'
+require 'padrino-routing'
 
 class RoutingDemo < Sinatra::Base
   register Padrino::Routing
@@ -15,33 +16,34 @@ class RoutingDemo < Sinatra::Base
   end
   map(:account).to("/the/accounts/:name/path/:id/end")
   map(:accounts).to("/the/accounts/index/?")
-  
+
   namespace :admin do
     get :show do
       "<p>admin show for id #{params[:id]}</p>"
     end
-    
+
     get :update do
       "<p>updated admin with id #{params[:id]} and name #{params[:name]}</p>"
     end
-    
+
     get :destroy do
       "<p>destroy admin with id #{params[:id]}</p>"
     end
   end
+
   get :account do
     "<h1>the account url for #{params[:name]} and id #{params[:id]}</h1>"
   end
-  
+
   get :accounts do
     "<h1>the accounts index</h1>"
   end
-  
+
   get '/links' do
     haml :index
   end
-  
+
   get '/failed_route' do
     url_for(:some, :not_real, :id => 5)
   end
-end
+end

data/test/helper.rb

@@ -9,7 +9,6 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'active_support_helpers'
 require 'padrino-helpers'
-require 'padrino-routing'
 
 class Test::Unit::TestCase
   include Padrino::Helpers::OutputHelpers
@@ -51,6 +50,12 @@ class Test::Unit::TestCase
   # Silences the output by redirecting to stringIO
   # silence_logger { ...commands... } => "...output..."
   def silence_logger(&block)
+    self.class.silence_logger(&block)
+  end
+  
+  # Silences the output by redirecting to stringIO
+  # silence_logger { ...commands... } => "...output..."
+  def self.silence_logger(&block)
     orig_stdout = $stdout
     $stdout = log_buffer = StringIO.new
     block.call

data/test/test_padrino_adv_routing.rb

@@ -0,0 +1,76 @@
+PADRINO_ENV = RACK_ENV = 'test' unless defined?(PADRINO_ENV)
+require File.dirname(__FILE__) + '/helper'
+
+class TestPadrinoAdvRouting < Test::Unit::TestCase
+  silence_logger { require File.dirname(__FILE__) + '/fixtures/adv_routing_app/config/boot' }
+  require File.dirname(__FILE__) + '/fixtures/adv_routing_app/app'
+  
+  def app
+    AdvRoutingDemo.tap { |app| app.set :environment, :test }
+  end
+
+  def setup
+    @demo = app.new
+  end
+
+  context 'controller direct namespacing' do
+    should "support creating route for namespaced url" do
+      visit '/admin/32/the/dashboard'
+      assert_have_selector :h1, :content => "This is the admin dashboard, id: 32"
+    end
+
+    should "support namespaced autogenerated route" do
+      visit '/admin/panel/john/thing'
+      assert_have_selector :h1, :content => "This is the admin panel, name: john"
+    end
+
+    should "support simple namespaced mapping in urls" do
+      visit '/admin/settings/action'
+      assert_have_selector :h1, :content => "This is the settings"
+    end
+
+    should "support regular namespacing as well" do
+      visit '/blog/index/action'
+      assert_have_selector :h1, :content => "Here is the blog"
+    end
+  end
+
+  context 'controller url autogeneration' do
+    should "support creating url 'hello' route in definition" do
+      visit '/some/hello/action/5/param'
+      assert_have_selector :h1, :content => "hello params id is 5"
+    end
+
+    should "support simple url map in route" do
+      visit '/some/simple/action'
+      assert_have_selector :h1, :content => "simple action welcomes you"
+    end
+
+    should "support urls with multiple paramaters defined in route" do
+      visit '/some/dean/and/56'
+      assert_have_selector :h1, :content => "id is 56, name is dean"
+    end
+
+    should "support referencing existing urls" do
+      visit '/test/20/action'
+      assert_have_selector :h1, :content => "This is a test action, id: 20"
+    end
+  end
+
+  context 'controller url_for management' do
+    should 'recognize namespaced routes' do
+      @demo = @demo.instance_variable_get(:@app) until @demo.is_a?(AdvRoutingDemo)
+      assert_equal '/admin/18/the/dashboard', @demo.url_for(:admin, :dashboard, :id => 18)
+      assert_equal '/admin/panel/joe/thing', @demo.url_for(:admin, :panel, :name => 'joe')
+      assert_equal '/admin/simple', @demo.url_for(:admin, :simple)
+      assert_equal '/admin/settings/action', @demo.url_for(:admin, :settings)
+    end
+
+    should 'recognize for autogenerated routes' do
+      @demo = @demo.instance_variable_get(:@app) until @demo.is_a?(AdvRoutingDemo)
+      assert_equal '/some/simple/action', @demo.url_for(:simple)
+      assert_equal '/some/hello/action/27/param', @demo.url_for(:hello, :id => 27)
+      assert_equal '/test/50/action', @demo.url_for(:test, :id => 50)
+    end
+  end
+end

data/test/test_padrino_routing.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/fixtures/routing_app/app'
 
 class TestPadrinoRouting < Test::Unit::TestCase
   def app
-    RoutingDemo.tap { |app| app.set :environment, :test }.tap { |app| app.set :uri_root, '/blog' }
+    RoutingDemo.tap { |app| app.set :environment, :test }
   end
 
   context 'for links list displaying routes' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: padrino-routing
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Padrino Team
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-17 00:00:00 -08:00
+date: 2009-11-18 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +25,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.9.2
     version: 
+- !ruby/object:Gem::Dependency 
+  name: padrino-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+    version: 
 - !ruby/object:Gem::Dependency 
   name: haml
   type: :development
@@ -92,13 +102,22 @@ files:
 - Rakefile
 - VERSION
 - lib/padrino-routing.rb
+- lib/padrino-routing/controller_ext.rb
 - lib/padrino-routing/helpers.rb
 - lib/padrino-routing/named_route.rb
 - padrino-routing.gemspec
 - test/active_support_helpers.rb
+- test/fixtures/adv_routing_app/Gemfile
+- test/fixtures/adv_routing_app/app.rb
+- test/fixtures/adv_routing_app/config/apps.rb
+- test/fixtures/adv_routing_app/config/boot.rb
+- test/fixtures/adv_routing_app/config/urls.rb
+- test/fixtures/adv_routing_app/controllers/namespacing.rb
+- test/fixtures/adv_routing_app/controllers/url_autogeneration.rb
 - test/fixtures/routing_app/app.rb
 - test/fixtures/routing_app/views/index.haml
 - test/helper.rb
+- test/test_padrino_adv_routing.rb
 - test/test_padrino_routing.rb
 has_rdoc: true
 homepage: http://github.com/padrino/padrino-routing