sinatra-named_routes 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Federico Romero
+
+MIT License
+
+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.md

@@ -0,0 +1,70 @@
+# Sinatra::NamedRoutes
+
+Allows you to name routes on definition and build them by name using the `url_for` helper.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatra-named_routes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-named_routes
+
+## Usage
+
+1- Register the extension
+
+    register Sinatra::NamedRoutes
+
+2- Name your routes when defining them
+
+    get named(:name, '/path') do
+      ...
+    end
+
+    get named(:short) do
+      ...
+    end
+
+3- Access the routes in your views
+
+    url_for(:name) #=> '/path'
+    url_for(:short) #=> '/short'
+
+### Params
+
+You can pass paramaters to the route like so:
+
+    get named(:with_params, '/path/:id') do
+      ...
+    end
+
+
+    url_for(:with_params, id: 2) #=> '/path/2'
+
+
+### Namespaces
+
+Named routes work with namespaces too:
+
+    namespace name(:admin) do
+      get named(:page, '/page/:id') do
+      end
+    end
+
+
+    url_for(:admin, :page, id: 3) #=> '/admin/page/3'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+    t.test_files = FileList['spec/**/*_spec.rb']
+end

data/lib/sinatra/named_routes/router.rb

@@ -0,0 +1,56 @@
+require 'tree'
+
+module Sinatra
+  module NamedRoutes
+    module Exceptions
+      class NoRouteForName < Exception; end
+      class RouteNameTaken < Exception; end
+    end
+    class Router < Tree::TreeNode
+      def self.default
+        @@default ||= Router.new(:root, '')
+      end
+
+      def traverse path
+        base = self
+        path.each do |step|
+          base = base[step]
+          yield(base) if block_given?
+        end
+        base
+      end
+
+      def set pattern, name, path = []
+        node = traverse(path)
+        raise Sinatra::NamedRoutes::Exceptions::RouteNameTaken if node[name] && node[name].content != pattern
+        node << Tree::TreeNode.new(name, pattern) unless node[name]
+      end
+
+      def get *args
+        options = args.last.is_a?(::Hash) ? args.pop : {}
+        path = ''
+        traverse(args) do |node|
+          begin
+            path += node.content
+          rescue
+            raise Sinatra::NamedRoutes::Exceptions::NoRouteForName, "No route for name #{args.inspect}"
+          end
+        end
+
+        query = []
+        options.each do |k, v|
+          regex = /(:#{k})/
+            if path =~ regex
+              path.gsub!(regex, v.to_s)
+            else
+              query << "#{k}=#{v}"
+            end
+        end
+
+        path += '?'+query.join("&") unless query.empty?
+
+        path
+      end
+    end
+  end
+end

data/lib/sinatra/named_routes/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module NamedRoutes
+    VERSION = "0.0.1"
+  end
+end

data/lib/sinatra/named_routes.rb

@@ -0,0 +1,51 @@
+require "sinatra/named_routes/version"
+require 'sinatra/named_routes/router'
+
+require 'sinatra/base'
+
+module Sinatra
+  module Namespace
+    module SharedMethods
+      def named(name, pattern = "/#{name}")
+        router.set(pattern, name, get_namespaces)
+        pattern
+      end
+
+      def get_namespaces
+        patterns = [@pattern]
+        next_base = base
+        while(next_base)
+          next_base, pattern = next_base.class_eval {
+            [defined?(base) && base, @pattern]
+          }
+          patterns << pattern if pattern
+        end
+
+        node = router
+
+        patterns.reverse.map do |p|
+          node = node.children.find {|c| c.content == p}
+          node.name
+        end
+      end
+    end
+  end
+
+  module NamedRoutes
+    def self.registered(app)
+      app.set :router, Router.default
+    end
+
+    def named(name, pattern = "/#{name}")
+      router.set(pattern, name)
+      pattern
+    end
+
+
+    module Helpers
+      def url_for(*args)
+        self.class.router.get(*args)
+      end
+    end
+  end
+end

data/sinatra-named_routes.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sinatra/named_routes/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Federico Romero"]
+  gem.email         = ["federomero@gmail.com"]
+  gem.description   = %q{Sinatra extension that allows you to use name your routes}
+  gem.summary       = %q{Sinatra named routes}
+  gem.homepage      = "https://github.com/federomero/sinatra-named_routes"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "sinatra-named_routes"
+  gem.require_paths = ["lib"]
+  gem.version       = Sinatra::NamedRoutes::VERSION
+
+  gem.add_dependency 'sinatra'
+  gem.add_dependency 'tree'
+  gem.add_development_dependency 'sinatra-contrib'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest', '3.2.0'
+end

data/spec/sinatra/named_routes/router_spec.rb

@@ -0,0 +1,33 @@
+require 'minitest/autorun'
+
+require 'sinatra/named_routes/router'
+
+describe Sinatra::NamedRoutes::Router do
+
+  subject do
+    Sinatra::NamedRoutes::Router.new(:root, '')
+  end
+
+  it 'should handle a simple route' do
+    subject.set('/admin', :admin)
+    subject.get(:admin).must_equal '/admin'
+  end
+
+  it 'should allow to set a route with params' do
+    subject.set('/petition/:id', :petition)
+    subject.get(:petition, id: 2).must_equal '/petition/2'
+  end
+
+  it 'should allow to nest routes' do
+    subject.set('/admin', :admin)
+    subject.set('/petition/:id', :petition, [:admin])
+    subject.get(:admin, :petition, id: 2).must_equal '/admin/petition/2'
+  end
+
+  it "should not allow to use the same name with different patterns" do
+    proc {
+      subject.set('/one', :name)
+      subject.set('/two', :name)
+    }.must_raise Sinatra::NamedRoutes::Exceptions::RouteNameTaken
+  end
+end

data/spec/sinatra/named_routes_spec.rb

@@ -0,0 +1,136 @@
+ENV['RACK_ENV'] = 'test'
+require 'sinatra/base'
+require 'sinatra/namespace'
+require 'minitest/autorun'
+require 'rack/test'
+
+require_relative '../../lib/sinatra/named_routes'
+
+Sinatra::Base.set :environment, :test
+
+
+class MockApp < Sinatra::Base
+  register Sinatra::Namespace
+  register Sinatra::NamedRoutes
+  helpers Sinatra::NamedRoutes::Helpers
+
+  def self.router
+    @router ||= Sinatra::NamedRoutes::Router.new(:root, nil)
+  end
+end
+
+module Rack::Test::Methods
+  def mock_app(base=MockApp, &block)
+    @app = Sinatra.new(base, &block)
+  end
+  def app
+    @app
+  end
+end
+
+describe 'NamedRoutes' do
+  include Rack::Test::Methods
+
+  it 'should handle the root path' do
+    mock_app{ get(named(:root, '/')) { "hi" }}
+    get "/"
+
+    last_response.status.must_equal 200
+    last_response.body.must_equal "hi"
+  end
+
+  describe 'with a literal path' do
+    it 'should find the route correctly' do
+      mock_app{ get(named(:some_name, '/some_path')) { "hi" }}
+      get "/some_path"
+
+      last_response.status.must_equal 200
+      last_response.body.must_equal "hi"
+    end
+
+    it 'should generate the route correctly' do
+      mock_app{ get(named(:some_name, '/some_path')) { url_for(:some_name) }}
+
+      get "/some_path"
+
+      last_response.status.must_equal 200
+      last_response.body.must_equal "/some_path"
+
+    end
+
+  end
+
+  describe 'with a params in path' do
+    it 'should find the route correctly' do
+      mock_app{ get(named(:some_name, '/some_path/:id')) { params[:id] }}
+      get "/some_path/2"
+
+      last_response.status.must_equal 200
+      last_response.body.must_equal "2"
+    end
+
+    it 'should generate the route correctly' do
+      mock_app{ get(named(:some_name, '/some_path/:id')) { url_for(:some_name, id: 3) }}
+
+      get "/some_path/2"
+
+      last_response.status.must_equal 200
+      last_response.body.must_equal "/some_path/3"
+
+    end
+
+  end
+
+  describe 'with namespaces' do
+    it 'should handle routes inside a namespace' do
+
+      mock_app do
+        namespace named(:admin) do
+          get(named(:some_name, '/some_path/:id')) { url_for(:admin, :some_name, id: 3) }
+        end
+      end
+
+      get "/admin/some_path/2"
+
+      last_response.status.must_equal 200
+      last_response.body.must_equal "/admin/some_path/3"
+    end
+
+    it 'should handle routes inside a nested namespace xxx' do
+
+      mock_app do
+        namespace named(:admin) do
+          namespace named(:namespace) do
+            get(named(:some_name, '/some_path/:id')) { url_for(:admin, :namespace, :some_name, id: 3) }
+          end
+        end
+      end
+
+      get "/admin/namespace/some_path/2"
+
+      last_response.status.must_equal 200
+      last_response.body.must_equal "/admin/namespace/some_path/3"
+    end
+
+    it 'should handle defining the same namespace route twice' do
+
+      mock_app do
+        namespace named(:admin) do
+          namespace named(:namespace) do
+            get(named(:some_name, '/some_path/:id')) { url_for(:admin, :namespace, :some_name, id: 3) }
+          end
+        end
+
+        namespace named(:admin) do
+          get(named(:other_name, '/other_path/:id')) { url_for(:admin, :other_name, id: 3) }
+        end
+      end
+
+      get "/admin/namespace/some_path/2"
+
+      last_response.status.must_equal 200
+      last_response.body.must_equal "/admin/namespace/some_path/3"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-named_routes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Federico Romero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70124965638460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70124965638460
+- !ruby/object:Gem::Dependency
+  name: tree
+  requirement: &70124965637980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70124965637980
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: &70124965637520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70124965637520
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70124965637060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70124965637060
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70124965636440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: *70124965636440
+description: Sinatra extension that allows you to use name your routes
+email:
+- federomero@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sinatra/named_routes.rb
+- lib/sinatra/named_routes/router.rb
+- lib/sinatra/named_routes/version.rb
+- sinatra-named_routes.gemspec
+- spec/sinatra/named_routes/router_spec.rb
+- spec/sinatra/named_routes_spec.rb
+homepage: https://github.com/federomero/sinatra-named_routes
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3180515975400098296
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3180515975400098296
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Sinatra named routes
+test_files:
+- spec/sinatra/named_routes/router_spec.rb
+- spec/sinatra/named_routes_spec.rb