padrino-routing 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Padrino
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,7 @@
+= padrino-routing
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Padrino. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "padrino-routing"
+    gem.summary = "Named route mapping system"
+    gem.description = "Enhances padrino with a named route mapping system allowing for advanced routes"
+    gem.email = "nesquena@gmail.com"
+    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_development_dependency "haml",          ">= 2.2.1"
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency "mocha",         ">= 0.9.7"
+    gem.add_development_dependency "rack-test",     ">= 0.5.0"
+    gem.add_development_dependency "webrat",        ">= 0.5.1"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "padrino-routing #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/padrino-routing/helpers.rb

@@ -0,0 +1,22 @@
+module Padrino
+  module Routing
+    module Helpers
+      # Used to retrieve the full url for a given named route alias from the named_paths data
+      # Accepts parameters which will be substituted into the url if necessary
+      # url_for(:accounts) => '/accounts'
+      # url_for(:account, :id => 5) => '/account/5'
+      # url_for(:admin, show, :id => 5, :name => "demo") => '/admin/path/5/demo'
+      def url_for(*route_name)
+        values = route_name.extract_options!
+        mapped_url = self.class.named_paths[route_name] || self.class.named_paths[route_name.dup.unshift(self.class.app_name)]
+        raise Padrino::RouteNotFound.new("Route alias #{route_name.inspect} is not mapped to a url") unless mapped_url
+        result_url = String.new(File.join(self.class.uri_root, mapped_url))
+        result_url.scan(%r{/?(:\S+?)(?:/|$)}).each do |placeholder|
+          value_key = placeholder[0][1..-1].to_sym
+          result_url.gsub!(Regexp.new(placeholder[0]), values[value_key].to_s)
+        end
+        result_url
+      end
+    end
+  end
+end

data/lib/padrino-routing/named_route.rb

@@ -0,0 +1,27 @@
+module Padrino
+  module Routing
+    class NamedRoute
+      # Constructs the NamedRoute which accepts the application and
+      # the route alias names to register (i.e [:account] or [:admin, :show])
+      # NamedRoute.new(@app, :admin, :show)
+      def initialize(app, *names)
+        @app   = app
+        @names = names.flatten
+      end
+
+      # Used to define the url mapping to the supplied alias
+      # NamedRoute.new(@app, :account).to('/account/path')
+      def to(path)
+        @app.named_paths[@names.unshift(@app.app_name)] = path
+      end
+
+      # Used to define the url mappings for child aliases within a namespace
+      # Invokes map on the application itself, appending the namespace to the route
+      # NamedRoute.new(@app, :admin).map(:show).to('/admin/show')
+      # is equivalent to NamedRoute.new(@app, :admin, :show).to('/admin/show')
+      def map(*args, &block)
+        @app.map(*args.unshift(@names), &block)
+      end
+    end
+  end
+end

data/lib/padrino-routing.rb

@@ -0,0 +1,48 @@
+# require 'padrino-core/support_lite'
+Dir[File.dirname(__FILE__) + '/padrino-routing/**/*.rb'].each {|file| require file }
+
+module Padrino
+  class RouteNotFound < RuntimeError; end
+
+  module Routing
+    def self.registered(app)
+      # Named paths stores the named route aliases mapping to the url
+      # i.e { [:account] => '/account/path', [:admin, :show] => '/admin/show/:id' }
+      app.set :named_paths, {}
+      app.set :app_name, app.name.underscore.to_sym unless app.respond_to?(:app_name)
+      app.set :uri_root, '/' unless app.respond_to?(:uri_root)
+      app.helpers Padrino::Routing::Helpers
+
+      # map constructs a mapping between a named route and a specified alias
+      # the mapping url can contain url query parameters
+      # map(:accounts).to('/accounts/url')
+      # map(:admin, :show).to('/admin/show/:id')
+      # map(:admin) { |namespace| namespace.map(:show).to('/admin/show/:id') }
+      def map(*args, &block)
+        named_router = Padrino::Routing::NamedRoute.new(self, *args)
+        block_given? ? block.call(named_router) : named_router
+      end
+
+      # Used to define namespaced route configurations in order to group similar routes
+      # Class evals the routes but with the namespace assigned which will append to each route
+      # namespace(:admin) { get(:show) { "..." } }
+      def namespace(name, &block)
+        original, @_namespace = @_namespace, name
+        self.class_eval(&block)
+        @_namespace = original
+      end
+
+      # Hijacking route method in sinatra to replace a route alias (i.e :account) with the full url string mapping
+      # 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
+        end
+        super verb, path, options, &block
+      end
+    end
+  end
+end

data/padrino-routing.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{padrino-routing}
+  s.version = "0.1.0"
+
+  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-16}
+  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 = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/padrino-routing.rb",
+     "lib/padrino-routing/helpers.rb",
+     "lib/padrino-routing/named_route.rb",
+     "padrino-routing.gemspec",
+     "test/active_support_helpers.rb",
+     "test/fixtures/routing_app/app.rb",
+     "test/fixtures/routing_app/views/index.haml",
+     "test/helper.rb",
+     "test/test_padrino_routing.rb"
+  ]
+  s.homepage = %q{http://github.com/padrino/padrino-routing}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Named route mapping system}
+  s.test_files = [
+    "test/active_support_helpers.rb",
+     "test/fixtures/routing_app/app.rb",
+     "test/helper.rb",
+     "test/test_padrino_routing.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sinatra>, [">= 0.9.2"])
+      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"])
+      s.add_development_dependency(%q<rack-test>, [">= 0.5.0"])
+      s.add_development_dependency(%q<webrat>, [">= 0.5.1"])
+    else
+      s.add_dependency(%q<sinatra>, [">= 0.9.2"])
+      s.add_dependency(%q<haml>, [">= 2.2.1"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0.9.7"])
+      s.add_dependency(%q<rack-test>, [">= 0.5.0"])
+      s.add_dependency(%q<webrat>, [">= 0.5.1"])
+    end
+  else
+    s.add_dependency(%q<sinatra>, [">= 0.9.2"])
+    s.add_dependency(%q<haml>, [">= 2.2.1"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0.9.7"])
+    s.add_dependency(%q<rack-test>, [">= 0.5.0"])
+    s.add_dependency(%q<webrat>, [">= 0.5.1"])
+  end
+end
+

data/test/active_support_helpers.rb

@@ -0,0 +1,7 @@
+unless Fixnum.method_defined?(:days)
+  require 'active_support/core_ext/object/misc'
+  require 'active_support/core_ext/date'
+  require 'active_support/core_ext/time'
+  require 'active_support/core_ext/numeric'
+  require 'active_support/duration'
+end

data/test/fixtures/routing_app/app.rb

@@ -0,0 +1,47 @@
+require 'sinatra/base'
+require 'haml'
+
+class RoutingDemo < Sinatra::Base
+  register Padrino::Routing
+
+  configure do
+    set :root, File.dirname(__FILE__)
+  end
+
+  map(:admin, :show).to("/admin/:id/show")
+  map :admin do |namespace|
+    namespace.map(:update).to("/admin/:id/update/:name")
+    namespace.map(:destroy).to("/admin/:id/destroy")
+  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

data/test/fixtures/routing_app/views/index.haml

@@ -0,0 +1,7 @@
+%p.admin_url= url_for(:admin, :show, :id => 25)
+%p.app_admin_url= url_for(:routing_demo, :admin, :show, :id => 25)
+%p.admin_url2= url_for(:admin, :update, :id => 10, :name => "test")
+%p.admin_url3= url_for(:admin, :destroy, :id => 12)
+%p.account_url= url_for(:account, :name => 'foobar', :id => 10)
+%p.accounts_index=url_for(:accounts)
+%p.app_accounts_index=url_for(:routing_demo, :accounts)

data/test/helper.rb

@@ -0,0 +1,74 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'rack/test'
+require 'webrat'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'active_support_helpers'
+require File.dirname(__FILE__) + '/../../padrino-helpers/lib/padrino-helpers.rb'
+require File.dirname(__FILE__) + '/../lib/padrino-routing.rb'
+
+class Test::Unit::TestCase
+  include Padrino::Helpers::OutputHelpers
+  include Padrino::Helpers::TagHelpers
+  include Padrino::Helpers::AssetTagHelpers
+  include Rack::Test::Methods
+  include Webrat::Methods
+  include Webrat::Matchers
+
+  Webrat.configure do |config|
+    config.mode = :rack
+  end
+
+  def stop_time_for_test
+    time = Time.now
+    Time.stubs(:now).returns(time)
+    return time
+  end
+
+  # assert_has_tag(:h1, :content => "yellow") { "<h1>yellow</h1>" }
+  # In this case, block is the html to evaluate
+  def assert_has_tag(name, attributes = {}, &block)
+    html = block && block.call
+    matcher = HaveSelector.new(name, attributes)
+    raise "Please specify a block!" if html.blank?
+    assert matcher.matches?(html), matcher.failure_message
+  end
+
+  # assert_has_no_tag, tag(:h1, :content => "yellow") { "<h1>green</h1>" }
+  # In this case, block is the html to evaluate
+  def assert_has_no_tag(name, attributes = {}, &block)
+    html = block && block.call
+    attributes.merge!(:count => 0)
+    matcher = HaveSelector.new(name, attributes)
+    raise "Please specify a block!" if html.blank?
+    assert matcher.matches?(html), matcher.failure_message
+  end
+
+  # Silences the output by redirecting to stringIO
+  # silence_logger { ...commands... } => "...output..."
+  def silence_logger(&block)
+    orig_stdout = $stdout
+    $stdout = log_buffer = StringIO.new
+    block.call
+    $stdout = orig_stdout
+    log_buffer.rewind && log_buffer.read
+  end
+
+  # Asserts that a file matches the pattern
+  def assert_match_in_file(pattern, file)
+    assert File.exist?(file), "File '#{file}' does not exist!"
+    assert_match pattern, File.read(file)
+  end
+end
+
+module Webrat
+  module Logging
+    def logger # :nodoc:
+      @logger = nil
+    end
+  end
+end

data/test/test_padrino_routing.rb

@@ -0,0 +1,94 @@
+require File.dirname(__FILE__) + '/helper'
+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' }
+  end
+
+  context 'for links list displaying routes' do
+    setup { visit '/links' }
+    should 'display account route links' do
+      assert_have_selector :p, :class => 'account_url', :content => '/the/accounts/foobar/path/10/end'
+      assert_have_selector :p, :class => 'accounts_index', :content => '/the/accounts/index'
+    end
+    should "display admin route links" do
+      assert_have_selector :p, :class => 'admin_url', :content => '/admin/25/show'
+      assert_have_selector :p, :class => 'admin_url2', :content => '/admin/10/update/test'
+      assert_have_selector :p, :class => 'admin_url3', :content => '/admin/12/destroy'
+    end
+    should "support app namespaces" do
+      assert_have_selector :p, :class => 'app_accounts_index', :content => '/the/accounts/index'
+      assert_have_selector :p, :class => 'app_admin_url', :content => '/admin/25/show'
+    end
+  end
+
+  context 'for mounted application' do
+    should "support changing uri root no mount" do
+      demo = app.new
+      demo.class.stubs(:uri_root).returns("/")
+      demo.class.map(:demo).to('/demo')
+      assert_equal "/demo", demo.class.named_paths[[:routing_demo, :demo]]
+      assert_equal "/demo", demo.url_for(:demo)
+    end
+    should "support changing uri root with mount" do
+      demo = app.new
+      demo.class.stubs(:uri_root).returns("/blog")
+      demo.class.map(:demo).to('/demo')
+      assert_equal "/demo", demo.class.named_paths[[:routing_demo, :demo]]
+      assert_equal "/blog/demo", demo.url_for(:demo)
+    end
+  end
+
+  context 'for failed or missing routes' do
+    should "properly not raise when found" do
+      assert_nothing_raised { app.new.url_for(:accounts) }
+      assert_nothing_raised { app.new.url_for(:routing_demo, :admin, :show, :id => 5) }
+    end
+    should "properly raise not found exception" do
+      assert_raises(Padrino::RouteNotFound) { visit '/failed_route' }
+      assert_raises(Padrino::RouteNotFound) { app.new.url_for(:admin, :fake) }
+    end
+    should "properly raise about an invalid alias for route definition" do
+      assert_raises(Padrino::RouteNotFound) { app.get(:fake) }
+    end
+    should "properly work when alias is used in proper route definition" do
+      assert_nothing_raised { app.get(:accounts) do; end }
+    end
+  end
+
+  context 'for no namespaced account route' do
+    setup { visit '/the/accounts/demo/path/5/end'}
+    should "return proper account text" do
+      assert_have_selector :h1, :content => "the account url for demo and id 5"
+    end
+  end
+
+  context 'for no namespaced accounts index route' do
+    setup { visit '/the/accounts/index/'}
+    should "return proper account text" do
+      assert_have_selector :h1, :content => "the accounts index"
+    end
+  end
+
+  context 'for admin show url' do
+    setup { visit '/admin/50/show' }
+    should "return proper admin test" do
+      assert_have_selector :p, :content => "admin show for id 50"
+    end
+  end
+
+  context 'for admin update url' do
+    setup { visit '/admin/15/update/demo' }
+    should "return proper update text" do
+      assert_have_selector :p, :content => "updated admin with id 15 and name demo"
+    end
+  end
+
+  context 'for admin destroy url' do
+    setup { visit '/admin/60/destroy' }
+    should "return proper destroy text" do
+      assert_have_selector :p, :content => "destroy admin with id 60"
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: padrino-routing
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Padrino Team
+- Nathan Esquenazi
+- Davide D'Agostino
+- Arthur Chiu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-16 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: haml
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: webrat
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.1
+    version: 
+description: Enhances padrino with a named route mapping system allowing for advanced routes
+email: nesquena@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/padrino-routing.rb
+- lib/padrino-routing/helpers.rb
+- lib/padrino-routing/named_route.rb
+- padrino-routing.gemspec
+- test/active_support_helpers.rb
+- test/fixtures/routing_app/app.rb
+- test/fixtures/routing_app/views/index.haml
+- test/helper.rb
+- test/test_padrino_routing.rb
+has_rdoc: true
+homepage: http://github.com/padrino/padrino-routing
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Named route mapping system
+test_files: 
+- test/active_support_helpers.rb
+- test/fixtures/routing_app/app.rb
+- test/helper.rb
+- test/test_padrino_routing.rb