sinatra-snap 0.3.0

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Brandon Carlson (bcarlso)
+
+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,41 @@
+= Sinatra NAmed Paths (snap)
+
+Enables named paths in Sinatra apps.
+
+The SNAP extension is a solution for named paths in Sinatra. It also provides helper methods to
+build URLs and perform parameter substitution.
+
+Install the gem:
+
+  sudo gem install snap
+
+Then require it in your application and use away!
+
+  require 'rubygems'
+  require 'sinatra'
+  require 'snap'
+
+  paths :add => '/add/:addend/:augend',
+        :sum => '/sum/:addend/:augend',
+		:subtract => '/subtract/*/*',
+		:difference => %r{/difference/(\d+)/(\d+)}
+
+  get :add do
+    redirect path_to(:sum).with(params[:addend], params[:augend])
+  end
+
+  get :sum do
+    "#{params[:addend]} + #{params[:augend]} = #{params[:addend].to_i + params[:augend].to_i}"
+  end
+
+  get :subtract do
+    redirect path_to(:difference).with(params[:splat][0], params[:splat][1])
+  end
+
+  get :difference do
+    "#{params[:captures][0]} - #{params[:captures[1]]} = #{params[:captures][0]].to_i - params[:captures][1]].to_i}"
+  end
+
+== Copyright
+
+Copyright (c) 2009 Brandon Carlson (bcarlso). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sinatra-snap"
+    gem.summary = "Sinatra NAmed Path support"
+    gem.email = "bcarlso@gmail.com"
+    gem.homepage = "http://github.com/bcarlso/snap"
+    gem.authors = ["bcarlso"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "snap #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/examples/named_route_example.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'sinatra'
+require 'sinatra-snap'
+
+path :home => '/index'
+paths :add => '/add/:augend/:addend',
+      :sum => '/sum/:augend/:addend',
+    	:subtract => '/subtract/*/*',
+    	:difference => %r{/difference/(\d+)/(\d+)}
+
+get :home do
+  "Hello World!"
+end
+
+get :add do
+  redirect(path_to(:sum).with(params[:augend], params[:addend]))
+end
+
+get :sum do
+  "#{params[:augend]} + #{params[:addend]} = #{params[:augend].to_i + params[:addend].to_i}"
+end
+
+get :subtract do
+  redirect path_to(:difference).with(params[:splat][0], params[:splat][1])
+end
+
+get :difference do
+  "#{params[:captures][0]} - #{params[:captures][1]} = #{params[:captures][0].to_i - params[:captures][1].to_i}"
+end
+
+path :hello => '/hi/:name'
+
+get '/index.html' do
+  url = path_to(:hello).with('bcarlso')
+  "<a href='#{url}'>xxx</a>"
+  
+end
+
+get :hello do
+  "Hi #{params[:name]}"
+end

data/lib/sinatra/named_path_support.rb

@@ -0,0 +1,72 @@
+require 'sinatra/base'
+
+module Sinatra
+  module PathDefinitionSupport
+    def self.registered(app)
+      app.set :named_paths, {}
+    end
+
+    def paths(paths)
+      paths.keys.each { | k | verify_type_of(k) }
+      named_paths.merge!(paths)
+    end
+
+    alias_method :path, :paths
+    
+    def route(verb, path, options={}, &block)
+      path = named_paths[path] if path.kind_of? Symbol
+      super verb, path, options, &block
+    end
+    
+    def verify_type_of(name)
+      raise ArgumentError.new('Path name must be a symbol') unless name.kind_of?(Symbol) 
+    end
+
+    private :verify_type_of
+  end 
+
+  module PathBuilderSupport
+    def path_to path_name
+      pattern = self.class.named_paths[path_name]
+      puts "----------> " + path_name.to_s
+      pattern.instance_eval do
+        def with(*values)
+          if self.instance_of? Regexp
+            process_regex_replacement(values)
+          else
+            process_string_replacement(values)
+          end
+        end
+        
+        def process_regex_replacement(values)
+          url = String.new(self.source)
+          self.source.scan(%r{\(.+?\)}).each_with_index do | placeholder, index |
+            url.sub!(Regexp.new(Regexp.escape(placeholder)), values[index].to_s)
+          end
+          url
+        end
+        
+        def process_string_replacement(values)
+          if %r{/(\*)}.match self
+            replacement_pattern = %r{/(\*)}
+          else
+            replacement_pattern = %r{/?(:\S+?)(?:/|$)}
+          end
+          build_url_from(replacement_pattern, values)
+        end
+        
+        def build_url_from(replacement_pattern, values)
+          url = String.new(self)
+          scan(replacement_pattern).each_with_index do | placeholder, index |
+            url.sub!(Regexp.new(Regexp.escape(placeholder[0])), values[index].to_s)
+          end
+          url
+        end
+      end
+      pattern
+    end
+  end
+  
+  register PathDefinitionSupport
+  helpers PathBuilderSupport
+end

data/lib/sinatra-snap.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/sinatra/named_path_support'

data/sinatra-snap.gemspec

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sinatra-snap}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["bcarlso"]
+  s.date = %q{2010-03-06}
+  s.email = %q{bcarlso@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "examples/named_route_example.rb",
+     "lib/sinatra/named_path_support.rb",
+     "lib/sinatra-snap.rb",
+     "sinatra-snap.gemspec",
+     "spec/snap_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/bcarlso/sinatra-snap}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Sinatra NAmed Path support}
+  s.test_files = [
+    "spec/snap_spec.rb",
+     "spec/spec_helper.rb",
+     "examples/named_route_example.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
+    else
+    end
+  else
+  end
+end

data/spec/snap_spec.rb

@@ -0,0 +1,92 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'sinatra/base'
+require 'rack/test'
+
+describe "Snap DSL extensions" do
+  before :each do
+    create_and_register_snap
+  end
+  
+  it "should extend the route method to support passing in symbols" do
+    @app.path :home => 'homepage'
+    @app.get :home do
+      'irrelavent'
+    end
+
+    verify_route_added('GET', 'homepage')
+  end
+  
+  it "should initialize the named paths collection when registered" do
+    @app.named_paths.should be_empty
+  end
+  
+  it "should register a new named path when the path method is called" do
+    @app.path :name => '/url'
+    @app.named_paths.should == { :name => '/url' }
+  end
+
+  it "should register a collection of named paths when the paths method is called" do
+    @app.paths :names => '/url',
+               :other_name => '/other_url'
+    @app.named_paths.should == { :names => '/url',
+                                 :other_name => '/other_url' }
+  end
+
+  it "should only allow symbols to be passed in as the first parameter of a path call" do
+    begin
+      @app.path 'anything other than a symbol', '/irrelavent-for-this-test'
+      fail
+    rescue ArgumentError
+    end
+  end
+  
+  it "should only allow symbols to be passed in as the key to the paths hash" do
+    begin
+      @app.paths 'anything other than a symbol' => '/irrelavent-for-this-test',
+                 :name => '/also-irrelavent'
+      fail
+    rescue ArgumentError
+    end
+  end
+end
+
+describe "Snap helper methods for building URLs" do
+  before :each do
+    create_and_register_snap
+  end
+
+  it "should return a simple path using path_to" do
+    @app.path :name => '/url'
+    @app.new.path_to(:name).should == '/url'
+  end
+  
+  it "should retrieve a path by key and perform parameter substitution" do
+    @app.path :users => '/users/:name/tags/:tag'
+    @app.new.path_to(:users).with('bcarlso', 'sinatra').should == '/users/bcarlso/tags/sinatra'
+  end
+  
+  it "should retrieve a path by key and perform parameter substitution on numeric values" do
+    @app.path :users => '/users/:id'
+    @app.new.path_to(:users).with(15).should == '/users/15'
+  end
+  
+  it "should retrieve a path by key and perform parameter substitution on consecutive placeholders" do
+    @app.path :users => '/users/:id/:age'
+    @app.new.path_to(:users).with(15, 23).should == '/users/15/23'
+  end
+  
+  it "should retrieve a path defined as a regex and perform parameter substitution" do
+    @app.path :users => %r{/users/(\d+)}
+    @app.new.path_to(:users).with(15).should == '/users/15'
+  end
+  
+  it "should retrieve a path defined as a regex and perform parameter substitution on consecutive parameters" do
+    @app.path :users => %r{/users/(\d+)/(foo|bar)}
+    @app.new.path_to(:users).with(15, 'foo').should == '/users/15/foo'
+  end
+  
+  it "should support splat syntax" do
+    @app.path :say => '/say/*/to/*'
+    @app.new.path_to(:say).with('hi', 'bob').should == '/say/hi/to/bob'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'spec'
+require 'rubygems'
+require 'sinatra/named_path_support'
+
+Spec::Runner.configure do |config|
+  def create_and_register_snap
+    @app = Sinatra.new
+    @app.register Sinatra::PathDefinitionSupport
+    @app.helpers Sinatra::PathBuilderSupport
+  end
+  
+  def verify_route_added(verb, path)
+    routes = @app.routes[verb]
+    routes.size.should == 1
+    routes[0][0].should match(path)
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-snap
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- bcarlso
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-06 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: 
+email: bcarlso@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/named_route_example.rb
+- lib/sinatra/named_path_support.rb
+- lib/sinatra-snap.rb
+- sinatra-snap.gemspec
+- spec/snap_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/bcarlso/sinatra-snap
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Sinatra NAmed Path support
+test_files: 
+- spec/snap_spec.rb
+- spec/spec_helper.rb
+- examples/named_route_example.rb