sinatra-named-routes 0.0.1 → 0.1.0

data/.travis.yml

@@ -0,0 +1 @@
+rvm: 1.9.2

data/Gemfile

@@ -4,11 +4,12 @@ source 'http://rubygems.org'
 gemspec
 
 group :development, :test do
+  gem 'rake'
   gem 'sinatra-contrib'
   gem 'rspec'
   gem 'guard-rspec'
 end
 
 group :test do
-  gem 'simplecov', require: false
+  gem 'simplecov', :require => false
 end

data/Gemfile.lock

@@ -2,6 +2,7 @@ PATH
   remote: .
   specs:
     sinatra-named-routes (0.0.1)
+      sinatra
 
 GEM
   remote: http://rubygems.org/
@@ -9,31 +10,34 @@ GEM
     backports (2.3.0)
     diff-lcs (1.1.3)
     eventmachine (0.12.10)
-    guard (0.8.8)
+    ffi (1.0.11)
+    guard (1.0.0)
+      ffi (>= 0.5.0)
       thor (~> 0.14.6)
-    guard-rspec (0.5.2)
-      guard (>= 0.8.4)
-    multi_json (1.0.3)
-    rack (1.3.5)
-    rack-protection (1.1.4)
+    guard-rspec (0.6.0)
+      guard (>= 0.10.0)
+    multi_json (1.0.4)
+    rack (1.4.1)
+    rack-protection (1.2.0)
       rack
     rack-test (0.6.1)
       rack (>= 1.0)
-    rspec (2.7.0)
-      rspec-core (~> 2.7.0)
-      rspec-expectations (~> 2.7.0)
-      rspec-mocks (~> 2.7.0)
-    rspec-core (2.7.1)
-    rspec-expectations (2.7.0)
+    rake (0.9.2.2)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.7.0)
+    rspec-mocks (2.8.0)
     simplecov (0.5.4)
       multi_json (~> 1.0.3)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
-    sinatra (1.3.1)
-      rack (~> 1.3, >= 1.3.4)
-      rack-protection (~> 1.1, >= 1.1.2)
+    sinatra (1.3.2)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
       tilt (~> 1.3, >= 1.3.3)
     sinatra-contrib (1.3.1)
       backports (>= 2.0)
@@ -50,8 +54,8 @@ PLATFORMS
 
 DEPENDENCIES
   guard-rspec
+  rake
   rspec
   simplecov
-  sinatra
   sinatra-contrib
   sinatra-named-routes!

data/README.md

@@ -1,3 +1,3 @@
-# Sinatra Named Routes
-
+# Sinatra Named Routes [![Build Status](https://secure.travis-ci.org/ckhampus/sinatra-named-routes.png)](http://travis-ci.org/ckhampus/sinatra-named-routes)
+
 This gem allows the use of named routes in Sinatra applications.

data/Rakefile

@@ -1 +1,5 @@
 require 'bundler/gem_tasks'
+
+task(:spec) { ruby '-S rspec spec -c' }
+task(:test => :spec)
+task(:default => :spec)

data/lib/sinatra/named_routes.rb

@@ -1,103 +1,52 @@
-require_relative 'version'
+require File.join(File.dirname(__FILE__), 'version')
+require File.join(File.dirname(__FILE__), 'route_parser')
 
 module Sinatra
   module NamedRoutes
-    @@routes = {}
+    module Helpers
 
-    #def uri(addr = nil, absolute = true, add_script_name = true, params = {})
-    def uri(*args)
-      path = args.shift if args.first.is_a? Symbol
-      params = args.pop if args.last.is_a? Array or args.last.is_a? Hash
+      # def uri(addr = nil, absolute = true, add_script_name = true, params = {})
+      def uri(*args)
+        path = args.shift if args.first.is_a? Symbol
+        params = args.pop if args.last.is_a? Array or args.last.is_a? Hash
 
-      if path
-        addr = get_path(path, params)
+        if path
+          addr = NamedRoutes.get_path(path, params)
 
-        super(addr, *args)
-      else
-        super(*args)
-      end
+          super(addr, *args)
+        else
+          super(*args)
+        end
 
+      end
+      alias :to :uri
+      alias :url :uri
     end
 
-    alias :to :uri
-    alias :url :uri
-
     def map(name, path)
-      route = {}
-      route[:path] = path
-
-      if path.is_a? String
-        named = path.scan(/(?<=:)[^\.\/]*/).map { |item| item.to_sym }
-        splat = path.scan(/\*/)
-
-        params = { named: named, splat: splat }
-      elsif path.is_a? Regexp
-        regexp = path.source.scan(/\([^\)]*\)/)
-
-        params = { regexp: regexp }
-      end
-
-      route[:params] = params
-
-      @@routes[name] = route
+      NamedRoutes.routes[name] = Route.new path
     end
 
     private
 
-    def get_path(name, params = {})
-      route = @@routes[name]
-
-      path = route[:path]
-
-      if params.is_a? Hash
-        
-        # Turn string keys into symbols
-        params = params.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
-
-        if path.is_a? String
-          route[:params][:named].each do |key|
-            if params.has_key? key
-              path = path.sub(key.inspect, params[key])
-            else
-              raise ArgumentError.new
-            end
-          end
-        end
-      elsif params.is_a? Array
-        if path.is_a? String
-          if route[:params][:splat].length != params.length
-            raise ArgumentError.new
-          end
-
-          params.each do |value|
-            path = path.sub('*', value)
-          end
-        elsif path.is_a? Regexp
-          if route[:params][:regexp].length != params.length
-            raise ArgumentError.new
-          end
-
-          path = path.source
-
-          params.each_index do |index|
-            path = path.sub(route[:params][:regexp][index], params[index])
-          end
-        end
-      end
-
-      path
-    end
-
     def route(verb, path, options={}, &block)
       if path.is_a?(Symbol)
-        path = @@routes[path][:path]
+        path = NamedRoutes.routes[path].source
       end
 
       super(verb, path, options, &block)
     end
 
+    def self.get_path(name, params = {})
+      NamedRoutes.routes[name].build params
+    end
+
+    def self.routes
+      @@routes ||= {}
+    end
+
     def self.registered(app)
-      app.helpers NamedRoutes
+      app.helpers NamedRoutes::Helpers
     end
   end
 end

data/lib/sinatra/route_parser.rb

@@ -0,0 +1,164 @@
+class Route
+  attr_reader :source
+
+  def initialize(route)
+    route = route.source if route.is_a? Regexp
+
+    @source = route
+    @input = StringScanner.new(route)
+    @output = []
+
+    parse
+  end
+
+  # Public: Build URL with parameters.
+  #
+  # params - The hash or array of parameters to pass to URL.
+  #
+  # Returns the URL as a String.
+  def build(params = {})
+    path = []
+    params = {} if params.nil?
+
+    @output.each_index do |index|
+      item = @output[index]
+      next_item = @output.fetch(index + 1, nil)
+
+      case item[:token]
+      when :slash
+        @trailing_slash = item[:optional]
+        path << '/'
+      when :dot
+        @trailing_dot = item[:optional]
+        path << '.'
+      when :splat
+        if params.is_a? Hash
+          raise ArgumentError, 'No parameters passed.' if params[:splat].empty?
+          path << params[:splat].shift
+        else
+          raise ArgumentError, 'No enough parameters passed.' if params.empty?
+          path << params.shift
+        end
+      when :path
+        path << item[:value]
+      when :named_param
+        item_key = item[:value]
+
+        if params.has_key? item_key
+          path << params.delete(item_key)
+        else
+          raise ArgumentError, "No value passed for '#{item_key.to_s}'" unless item[:optional]
+        end
+      when :regexp
+        name = /#{item[:value]}/.names
+
+        if name.any?
+          name = name.first.to_sym
+
+          if params.has_key? name
+            path << params.delete(name)
+          else
+            raise ArgumentError, "No value passed for '#{name.to_s}'" unless item[:optional]
+          end
+        else
+          if params.is_a? Hash
+            raise ArgumentError, 'No enough parameters passed.' if params[:captures].empty? and !item[:optional]
+            path << params[:captures].shift
+          else
+            raise ArgumentError, 'No enough parameters passed.' if params.empty?
+            path << params.shift
+          end
+        end
+      end
+    end
+
+    path = path.join
+
+    if @trailing_dot
+      path = path.chomp '.'
+    end
+
+    if @trailing_slash
+      path = path.chomp '/'
+    end
+
+    path
+  end
+
+  private
+
+  def is_optional?
+    @output.last[:optional] = @input.scan(/\?/) ? true : false
+  end
+
+  def parse
+    while token = parse_slash || parse_path || parse_named_param || 
+                  parse_dot || parse_splat || parse_regexp
+      @output << token
+      is_optional?
+    end
+  end
+
+  def parse_slash
+    if @input.scan(/\//)
+      {
+        :token => :slash
+      }
+    else
+      nil
+    end
+  end
+
+  def parse_dot
+    if @input.scan(/\./)
+      {
+        :token => :dot
+      }
+    else
+      nil
+    end
+  end
+
+  def parse_splat
+    if @input.scan(/\*/)
+      {
+        :token => :splat
+      }
+    else
+      nil
+    end
+  end
+
+  def parse_path
+    if @input.scan(/\w+/)
+      {
+        :token => :path,
+        :value => @input.matched
+      }
+    else
+      nil
+    end
+  end
+
+  def parse_named_param
+    if @input.scan(/:[^\W]*/)
+      {
+        :token => :named_param,
+        :value => @input.matched.sub(':', '').to_sym
+      }
+    else
+      nil
+    end
+  end
+
+  def parse_regexp
+    if @input.scan(/\([^\)]*\)/)
+      {
+        :token => :regexp,
+        :value => @input.matched
+      }
+    else
+      nil
+    end
+  end
+end

data/lib/sinatra/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module NamedRoutes
-    VERSION = '0.0.1'
+    VERSION = '0.1.0'
   end
 end

data/spec/named_routes_spec.rb

@@ -1,147 +1,105 @@
-require_relative 'spec_helper'
+require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe Sinatra::NamedRoutes do
   def helper_route(&block)
-    result = nil
-    @helper_app.get('/helper_route') do
-      result = instance_eval(&block)
-      'ok'
-    end
-    get '/helper_route'
-    last_response.should be_ok
-    body.should be == 'ok'
-    result
-  end
-
-  before do
-    app = nil
+    time = Time.now.usec
 
     mock_app do
       register Sinatra::NamedRoutes
 
-      map(:hello, '/hello')
-
-      map(:path_named, '/hello/:name')
-      map(:path_multi_named, '/hello/:name.:format')
-      map(:path_splat, '/hello/*')
-      map(:path_multi_splat, '/hello/*.*')
-      map(:path_regexp, %r{/hello/([\w]+)})
-      map(:path_multi_regexp, %r{/hello/([\w]+).([\w]+)})
+      map(:path_named_params, '/hello/:name.:format')
+      map(:path_splats, '/hello/*.*')
+      map(:path_regexp, %r{/hello/([\w]+).([\w]+)})
+      map(:path_named_captures, %r{/hello/(?<person>[^/?#]+)})
+      map(:path_optional_named_captures, %r{/page(?<format>.[^/?#]+)?})
 
-      get('/') { 'hello' }
-      get(:hello) { 'hello world' }
-      get('/hello/:name') { |name| "hello #{name}" }
-
-      app = self
+      get "/#{time}" do
+        instance_eval(&block)
+      end
     end
 
-    @helper_app = app
+    get "/#{time}"
   end
 
-  describe :helper_route do
-    it 'runs the block' do
-      ran = false
-      helper_route { ran = true }
-      ran.should be_true
-    end
-
-    it 'returns the block result' do
-      helper_route { 42 }.should be == 42
-    end
+  describe :routing do
+    it 'does allow routing with symbols as paths' do
+      mock_app do
+        register Sinatra::NamedRoutes
 
-  end
+        map :test, '/test'
 
-  describe :routing do
-    it 'does still allow normal routing' do
-      get('/').should be_ok
-      body.should be == 'hello'
+        get :test do
+          'symbols work'
+        end
+      end
 
-      get('/hello/cristian').should be_ok
-      body.should be == 'hello cristian'
+      get('/test').should be_ok
+      body.should be == 'symbols work'
     end
 
-    it 'does still allow routing with symbols as paths' do 
-      get('/hello').should be_ok
-      body.should be == 'hello world'
+    it 'does not break normal routing' do
+      mock_app do
+        register Sinatra::NamedRoutes
+
+        get '/normal' do
+          'still works'
+        end
+      end
+
+      get('/normal').should be_ok
+      body.should be == 'still works'
     end
 
   end
 
   describe :path_helper do
 
-    it 'does not break normal behavior' do
-      helper_route do
-        url '/route_one', false
-      end.should be == '/route_one'
-    end
-
-    it 'ignores params if path is not a symbol' do
-      helper_route do
-        url '/route_one', false, name: 'cristian'
-      end.should be == '/route_one'
-    end
+    it 'does not break normal helper behavior' do
+      mock_app do
+        register Sinatra::NamedRoutes
 
-    describe :named do
-      it 'returns the correct path if passed a hash with symbols as keys' do 
-        helper_route do
-          url :path_multi_named, false, name: 'cristian', format: 'json'  
-        end.should be == '/hello/cristian.json'
+        get '/' do
+          url '/route', false
+        end
       end
 
-      it 'returns the correct path if passed a hash with strings as keys' do
-        helper_route do
-          url :path_multi_named, false, 'name' => 'cristian', 'format' => 'json'  
-        end.should be == '/hello/cristian.json'
-      end
+      get('/').should be_ok
+      body.should be == '/route'
+    end
 
-      it 'ignores keys that are left' do
-        helper_route do
-          url :path_multi_named, false, name: 'cristian', format: 'json', color: 'blue'  
-        end.should be == '/hello/cristian.json'
-      end
+    it 'ignores params if path is not a symbol' do
+      mock_app do
+        register Sinatra::NamedRoutes
 
-      it 'throws an exception if required keys do not exist' do
-        expect do
-          helper_route do
-            url :path_multi_named, false, name: 'cristian', color: 'blue'
-          end
-        end.to raise_exception ArgumentError
+        get '/' do
+          url '/route', false, :name => 'cristian'
+        end
       end
 
+      get('/').should be_ok
+      body.should be == '/route'
     end
 
-    describe :splat do
-      it 'returns the correct url for path with splats' do
-        helper_route do
-          url :path_multi_splat, false, ['cristian', 'json'] 
-        end.should be == '/hello/cristian.json'
-      end
+    it 'returns the correct urls' do
+      mock_app do
+        register Sinatra::NamedRoutes
 
-      it 'throws exception if params does not match number of splats' do
-        expect do
-          helper_route do
-            url :path_multi_splat, false, ['cristian']
-          end
-        end.to raise_exception ArgumentError
-      end
+        map :path, '/hello/?:person?'
 
-    end
+        get '/test1' do
+          url :path, false, :person => 'cristian'
+        end
 
-    describe :regular_expression do
-      it 'returns the correct url for path with regular expressions' do
-        helper_route do
-          url :path_multi_regexp, false, ['cristian', 'json'] 
-        end.should be == '/hello/cristian.json'
+        get '/test2' do
+          url :path, false
+        end
       end
 
-      it 'throws exception if params does not match number of captures' do
-        expect do
-          helper_route do
-            url :path_multi_regexp, false, ['cristian']
-          end
-        end.to raise_exception ArgumentError
-      end
+      get('/test1').should be_ok
+      body.should be == '/hello/cristian'
 
+      get('/test2').should be_ok
+      body.should be == '/hello'
     end
 
   end

data/spec/route_parser_spec.rb

@@ -0,0 +1,72 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Route do
+  it 'supports named parameters' do
+    route = Route.new('/hello/:person.:format')
+    url = route.build :person => 'cristian', :format => 'json'
+    url.should eql '/hello/cristian.json'
+  end
+
+  it 'throws exception if required named params are missing' do
+    expect do
+      route = Route.new('/hello/:person.:format')
+      url = route.build :person => 'cristian'
+    end.to raise_exception ArgumentError
+  end
+
+  it 'supports splats' do
+    route = Route.new('/hello/*.*')
+    url = route.build ['cristian', 'json']
+    url.should eql '/hello/cristian.json'
+  end
+
+  it 'throws exception if required splats are missing' do
+    expect do
+    route = Route.new('/hello/*.*')
+    url = route.build ['cristian']
+    end.to raise_exception ArgumentError
+  end
+
+  it 'supports splats mixed wih named parameters' do
+    route = Route.new('/hello/:person.*')
+    url = route.build :person => 'cristian', :splat => ['json']
+    url.should eql '/hello/cristian.json'
+  end
+
+  it 'supports regular expressions' do
+    route = Route.new(%r{/hello/([\w]+).([\w]+)})
+    url = route.build ['cristian', 'html']
+    url.should eql '/hello/cristian.html'
+  end
+
+  it 'supports optional regular expressions mixed with named params' do
+    route = Route.new(%r{/hello/:lang/([\w]+).?([\w]+)?})
+    url = route.build :lang => 'en', :captures => ['cristian', 'html']
+    url.should eql '/hello/en/cristian.html'
+
+    url = route.build :lang => 'en', :captures => ['cristian']
+    url.should eql '/hello/en/cristian'
+  end
+
+  it 'supports named capture groups' do
+    next if RUBY_VERSION < '1.9'
+
+    route = Route.new(%r{/hello/(?<person>[^/?#]+)})
+    url = route.build :person => 'cristian'
+    url.should eql '/hello/cristian'
+  end
+
+  it 'supports optional named capture groups' do
+    next if RUBY_VERSION < '1.9'
+
+    route = Route.new(%r{/page(?<format>.[^/?#]+)?})
+    url = route.build
+    url.should eql '/page'
+
+    url = route.build :format => '.html'
+    url.should eql '/page.html'
+
+    url = route.build :format => '.xml'
+    url.should eql '/page.xml'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-named-routes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-13 00:00:00.000000000Z
+date: 2012-02-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &22756416 !ruby/object:Gem::Requirement
+  requirement: &70197364991660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22756416
+  version_requirements: *70197364991660
 description: Allows the use of named routes in Sinatra applications.
 email:
 - contact@cristianhampus.se
@@ -30,15 +30,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - Guardfile
 - README.md
 - Rakefile
 - lib/sinatra/named_routes.rb
+- lib/sinatra/route_parser.rb
 - lib/sinatra/version.rb
 - sinatra-named-routes.gemspec
 - spec/named_routes_spec.rb
+- spec/route_parser_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ckhampus/sinatra-named-routes
 licenses: []
@@ -60,8 +63,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: sinatra-named-routes
-rubygems_version: 1.7.2
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Named Routes for Sinatra
-test_files: []
+test_files:
+- spec/named_routes_spec.rb
+- spec/route_parser_spec.rb
+- spec/spec_helper.rb