sinatra-named-routes 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,14 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in sinatra-named-routes.gemspec
+gemspec
+
+group :development, :test do
+  gem 'sinatra-contrib'
+  gem 'rspec'
+  gem 'guard-rspec'
+end
+
+group :test do
+  gem 'simplecov', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    sinatra-named-routes (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    backports (2.3.0)
+    diff-lcs (1.1.3)
+    eventmachine (0.12.10)
+    guard (0.8.8)
+      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)
+      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)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.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)
+      tilt (~> 1.3, >= 1.3.3)
+    sinatra-contrib (1.3.1)
+      backports (>= 2.0)
+      eventmachine
+      rack-protection
+      rack-test
+      sinatra (~> 1.3.0)
+      tilt (~> 1.3)
+    thor (0.14.6)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard-rspec
+  rspec
+  simplecov
+  sinatra
+  sinatra-contrib
+  sinatra-named-routes!

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :cli => '--color --format nested', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -0,0 +1,3 @@
+# Sinatra Named Routes
+
+This gem allows the use of named routes in Sinatra applications.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/sinatra/named_routes.rb

@@ -0,0 +1,103 @@
+require_relative 'version'
+
+module Sinatra
+  module NamedRoutes
+    @@routes = {}
+
+    #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)
+
+        super(addr, *args)
+      else
+        super(*args)
+      end
+
+    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
+    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]
+      end
+
+      super(verb, path, options, &block)
+    end
+
+    def self.registered(app)
+      app.helpers NamedRoutes
+    end
+  end
+end

data/lib/sinatra/version.rb

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

data/sinatra-named-routes.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'sinatra/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'sinatra-named-routes'
+  s.version     = Sinatra::NamedRoutes::VERSION
+  s.authors     = ['Cristian Hampus']
+  s.email       = ['contact@cristianhampus.se']
+  s.homepage    = 'https://github.com/ckhampus/sinatra-named-routes'
+  s.summary     = %q{Named Routes for Sinatra}
+  s.description = %q{Allows the use of named routes in Sinatra applications.}
+
+  s.rubyforge_project = 'sinatra-named-routes'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'sinatra'
+end

data/spec/named_routes_spec.rb

@@ -0,0 +1,149 @@
+require_relative '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
+
+    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]+)})
+
+      get('/') { 'hello' }
+      get(:hello) { 'hello world' }
+      get('/hello/:name') { |name| "hello #{name}" }
+
+      app = self
+    end
+
+    @helper_app = app
+  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
+
+  end
+
+  describe :routing do
+    it 'does still allow normal routing' do
+      get('/').should be_ok
+      body.should be == 'hello'
+
+      get('/hello/cristian').should be_ok
+      body.should be == 'hello cristian'
+    end
+
+    it 'does still allow routing with symbols as paths' do 
+      get('/hello').should be_ok
+      body.should be == 'hello world'
+    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
+
+    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'
+      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
+
+      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 '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
+      end
+
+    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 '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
+
+    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'
+      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
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'sinatra/named_routes'
+require 'sinatra/contrib'
+
+RSpec.configure do |config|
+  config.expect_with :rspec, :stdlib
+  config.include Sinatra::TestHelpers
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-named-routes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Cristian Hampus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-13 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &22756416 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *22756416
+description: Allows the use of named routes in Sinatra applications.
+email:
+- contact@cristianhampus.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- lib/sinatra/named_routes.rb
+- lib/sinatra/version.rb
+- sinatra-named-routes.gemspec
+- spec/named_routes_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ckhampus/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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: sinatra-named-routes
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Named Routes for Sinatra
+test_files: []