sinatra-url 0.0.1

data/Rakefile

@@ -0,0 +1,27 @@
+require "rake/testtask"
+
+begin
+  require "hanna/rdoctask"
+rescue LoadError
+  require "rake/rdoctask"
+end
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README"
+  rd.title = "API Documentation for Sinatra::Urls"
+  rd.rdoc_files.include("README", "LICENSE", "lib/**/*.rb")
+  rd.rdoc_dir = "doc"
+end
+
+begin
+  require "mg"
+  MG.new("sinatra-urls.gemspec")
+
+  task :build => :vendor
+rescue LoadError
+end
+
+desc "Default: run tests"
+task :default => :test
+
+Rake::TestTask.new

data/lib/sinatra/url.rb

@@ -0,0 +1,116 @@
+require "sinatra/base"
+
+module Sinatra
+  module URL
+    def self.extended(app)
+      app.module_eval do
+        extend DSL
+        include Helpers
+      end
+    end
+
+    class Mapper
+      def self.default
+        @default ||= new
+      end
+
+      def initialize
+        @map = {}
+      end
+
+      def [](name)
+        @map[name]
+      end
+
+      def []=(name, path)
+        @map[name] = Route.new(path)
+      end
+    end
+
+    class Route
+      def initialize(path)
+        @path = path
+        @pattern, @keys = compile(path)
+      end
+
+      def match(str)
+        @pattern.match(str)
+      end
+
+      def keys
+        @keys
+      end
+
+      def call(params)
+        params[:splat] = Array(params[:splat])
+        url = @path.dup
+
+        keys.each do |key|
+          match = key == "splat" ? "*" : ":#{key}"
+          value = key == "splat" ? params[:splat].shift : params[key.to_sym]
+          replacement = to_param(value)
+
+          unless url.sub! match, replacement
+            get_params[key] = params[key.to_sym]
+          end
+        end
+
+        get_params = {}
+        params.each do |key, value|
+          get_params[key] = to_param(value) unless
+            key == :splat || keys.include?(key.to_s)
+        end
+
+        url << "?" + Rack::Utils.build_query(get_params) unless get_params.empty?
+        url
+      end
+
+      private
+
+      def to_param(obj)
+        obj.respond_to?(:to_param) ? obj.to_param : obj.to_s
+      end
+
+      def compile(path)
+        keys = []
+        if path.respond_to? :to_str
+          special_chars = %w{. + ( )}
+          pattern =
+            path.to_str.gsub(/((:\w+)|[\*#{special_chars.join}])/) do |match|
+              case match
+              when "*"
+                keys << 'splat'
+                "(.*?)"
+              when *special_chars
+                Regexp.escape(match)
+              else
+                keys << $2[1..-1]
+                "([^/?&#]+)"
+              end
+            end
+          [/^#{pattern}$/, keys]
+        elsif path.respond_to? :match
+          [path, keys]
+        else
+          raise TypeError, path
+        end
+      end
+    end
+
+    module DSL
+      def url(name, path=nil)
+        Mapper.default[name] = path unless path.nil?
+        Mapper.default[name] or raise ArgumentError, "Unregistered path for '#{name}'"
+      end
+    end
+
+    module Helpers
+      def url_for(name, params={})
+        route = Mapper.default[name] or raise ArgumentError, "Unregistered path for '#{name}'"
+        route.call(params)
+      end
+    end
+  end
+
+  register URL
+end

data/sinatra-urls.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name        = "sinatra-url"
+  s.version     = "0.0.1"
+  s.description = "Simple sinatra extension that gives you the ability to use named URLs in your code"
+  s.summary     = "Named URLs for Sinatra apps"
+  s.authors     = ["Nicolas Sanguinetti"]
+  s.email       = "hi@nicolassanguinetti.info"
+  s.homepage    = "http://github.com/foca/sinatra-url"
+  s.has_rdoc    = false
+  s.files       = `git ls-files`.split "\n"
+  s.platform    = Gem::Platform::RUBY
+
+  s.add_dependency("sinatra")
+end

data/test/test_helper.rb

@@ -0,0 +1,34 @@
+require "test/unit"
+require "contest"
+require "rack/test"
+require File.expand_path(File.dirname(__FILE__) + "/../lib/sinatra/url")
+
+begin
+  require "redgreen"
+rescue LoadError
+end
+
+if ENV["DEBUG"]
+  require "ruby-debug"
+else
+  def debugger
+    puts "Run your tests with DEBUG=1 to use the debugger"
+  end
+end
+
+class Sinatra::TestApp < Sinatra::Base
+  include Test::Unit::Assertions
+  register Sinatra::URL
+end
+
+Sinatra::Base.set :environment, :test
+
+class Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  attr_reader :app
+
+  def mock_app(base=Sinatra::TestApp, &block)
+    @app = Sinatra.new(base, &block)
+  end
+end

data/test/test_url.rb

@@ -0,0 +1,108 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class TestUrl < Test::Unit::TestCase
+  context "registering handlers with the url DSL" do
+    test "registers urls at the DSL level and gives you access to them at the helper level" do
+      mock_app {
+        get url(:foo, "/foo") do
+          assert_equal "/foo", url_for(:foo)
+        end
+      }
+      get "/foo"
+      assert last_response.ok?
+    end
+
+    test "can register a url with parameters" do
+      mock_app {
+        get url(:foo, "/foo/:name") do |name|
+          assert_equal "bar", name
+        end
+      }
+      get "/foo/bar"
+      assert last_response.ok?
+    end
+
+    test "can register an url without specifying a path if already registered" do
+      mock_app {
+        post url(:foo, "/foo/:name") do |name|
+          assert_equal "bar", name
+        end
+
+        get url(:foo) do |name|
+          assert_equal "bar", name
+        end
+      }
+      get "/foo/bar"
+      assert last_response.ok?
+    end
+
+  end
+
+  context "generating urls with url_for for registered handlers" do
+    test "generating urls with :named_params" do
+      mock_app {
+        get url(:foo, "/foo/:name") do |name|
+          assert_equal "/foo/bar", url_for(:foo, :name => "bar")
+        end
+      }
+      get "/foo/bar"
+      assert last_response.ok?
+    end
+
+    test "generating urls with :named_params using integer" do
+      mock_app {
+        get url(:foo, "/foo/:id") do |name|
+          assert_equal "/foo/10", url_for(:foo, :id => 10)
+        end
+      }
+      get "/foo/10"
+      assert last_response.ok?
+    end
+
+    test "generating urls with :named_params using object responding to #to_param" do
+      mock_app {
+        get url(:foo, "/foo/:name") do |name|
+          obj = Object.new
+          def obj.to_param; "toparam"; end
+
+          assert_equal "/foo/toparam", url_for(:foo, :name => obj)
+        end
+      }
+      get "/foo/toparam"
+      assert last_response.ok?
+    end
+
+    test "generating urls with splat args" do
+      mock_app {
+        get url(:foo, "/say/*/to/*") do
+          assert_equal "/say/hi/to/mom", url_for(:foo, :splat => ["hi", "mom"])
+        end
+      }
+      get "/say/hi/to/mom"
+      assert last_response.ok?
+    end
+
+    test "generating urls with extra arguments for GET" do
+      mock_app {
+        get url(:foo, "/foo/:name") do |name|
+          assert_equal "/foo/bar?get=param", url_for(:foo, :name => "bar", :get => 'param')
+        end
+      }
+      get "/foo/bar"
+      assert last_response.ok?
+    end
+  end
+
+  context "generating urls with url_for for unregistered handlers" do
+    test "should raise ArgumentError" do
+      assert_raise ArgumentError do
+        mock_app {
+          get "/" do
+            url_for(:unknown)
+          end
+        }
+        get "/"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-url
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nicolas Sanguinetti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70311744499800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311744499800
+description: Simple sinatra extension that gives you the ability to use named URLs
+  in your code
+email: hi@nicolassanguinetti.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/sinatra/url.rb
+- sinatra-urls.gemspec
+- test/test_helper.rb
+- test/test_url.rb
+homepage: http://github.com/foca/sinatra-url
+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: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Named URLs for Sinatra apps
+test_files: []