oscardelben-routes 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Oscar Del Ben <info@oscardelben.com>
+
+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,30 @@
+= Routes
+== A routes library for ruby
+
+USAGE:
+
+		Routes::Building.draw do
+		  map '/posts', :controller => 'posts', :action => 'index'
+		  map '/posts/:id', :controller => 'posts'
+		  map '/controller/:action', {}
+		  map '/:controller/:action/:id', {}
+		  map '/cool', lambda { |path| "This is #{path}" }
+		  map /.*/, :action => 'anything'
+		end
+
+
+		Routes::Recognition.new('/posts').recognize # => { :controller => 'posts', :action => 'index' }
+
+		Routes::Recognition.new('/posts/1').recognize # => { :controller => 'posts', :id => '1' }
+
+		Routes::Recognition.new('/controller/new').recognize # => { :action => 'new' }
+
+		Routes::Recognition.new('/posts/show/1').recognize # => { :controller => 'posts', :action => 'show', :id => '1' }
+
+		Routes::Recognition.new('/something').recognize # => { :action => 'anything' }
+
+		Routes::Recognition.new('/cool').recognize # => "This is /cool"
+
+		
+CONTRIBUTIONS
+I'm open to contributions and suggestions. Drop me an email at info@oscardelben.com

data/lib/building.rb

@@ -0,0 +1,27 @@
+module Routes  
+  class Building
+    
+    class << self
+      
+      def map(route, action={})
+        Routes::Store.routes << [normalize_route(route), action]
+      end
+    
+      def draw(&block)
+        class_eval(&block)
+      end
+    
+      private
+    
+      def normalize_route(route)
+        if route.is_a? String
+          route = "/#{route}" unless route[0] == ?/
+          route = "#{route}/" unless route[-1] == ?/
+        end
+        route
+      end
+      
+    end
+     
+  end
+end

data/lib/recognition.rb

@@ -0,0 +1,94 @@
+module Routes
+  class Recognition
+  
+    attr_accessor :path, :result, :route_pattern
+  
+    def initialize(path)
+      @path = path
+      @result = nil
+    end
+  
+    def recognize
+      Routes::Store.routes.each do |route|
+        @route_pattern = route[0]
+        @result = route[1]
+      
+        filter_route!
+      
+        return give_back_result if @result
+      end
+    
+      # Nothing matched
+      give_back_result
+    end
+  
+    private
+  
+    def segments_from_string(path)
+      path[1..-1].split('/')
+    end
+  
+    def give_back_result
+      if result.respond_to?(:call)
+        result.call(path)
+      else
+        result
+      end
+    end
+  
+    def update_result(key, value)
+      @result.merge!(key => value)
+    end
+  
+    def route_segments
+      segments_from_string(route_pattern)
+    end
+  
+    def path_segments
+      segments_from_string(path)
+    end
+  
+    def filter_route!
+      if route_pattern.is_a? String
+        match_with_string
+      elsif route_pattern.respond_to?(:match)
+        match_with_regexp
+      end
+    end
+  
+    def match_with_string
+      if compatible_segments?     
+        match_segments
+      else
+        @result = nil
+      end
+    end
+  
+    def match_with_regexp
+      if route_pattern =~ path
+        return give_back_result
+      else
+        result = nil
+      end
+    end
+  
+    # TODO: path_segments is calculated 2 times
+    def compatible_segments?
+      route_segments.size == path_segments.size
+    end
+  
+    def match_segments
+      path_segments.each_with_index do |path_segment, index|
+        route_segment = route_segments[index]
+      
+        if route_segment[0] == ?:
+          update_result(eval(route_segment), path_segment)
+        elsif path_segment != route_segment
+          @result = nil
+          break
+        end
+      end
+    end
+  
+  end
+end

data/lib/routes.rb

@@ -0,0 +1,36 @@
+#--
+# Copyright (c) 2009 Oscar Del Ben <info@oscardelben.com>
+#
+# 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.
+#++
+
+
+path = File.expand_path(File.dirname(__FILE__))
+$:.unshift(path) unless $:.include?(path)
+
+module Routes
+  
+  autoload :Building, "building"
+  autoload :Recognition, "recognition"
+  autoload :Store, "store"
+  
+  VERSION = [0,1]
+  
+end

data/lib/store.rb

@@ -0,0 +1,13 @@
+# I don't know yet how to best store routes, so for now I just use this class
+
+module Routes
+  class Store
+    class << self
+      attr_accessor :routes
+      
+      def routes
+        @routes ||= []
+      end
+    end
+  end
+end

data/spec/spec/routes_spec.rb

@@ -0,0 +1,91 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Routes do
+  context 'storing new routes' do
+    
+    before(:each) do
+      Routes::Store.routes = []
+    end
+        
+    it "should have an empty routes list on new" do
+      Routes::Store.routes.should == []
+    end
+    
+    it "should be able to add a new route with the map method" do
+      Routes::Building.map('/foo', 'some action')
+      Routes::Store.routes.should == [['/foo/', 'some action']]
+    end
+    
+    it "should consider the order of routes with the map method" do
+      Routes::Building.map('/first', 'first action')
+      Routes::Building.map('/second', 'second action')
+      Routes::Store.routes.should == [['/first/', 'first action'], ['/second/', 'second action']]
+    end
+    
+    it "should append / at the start of path if needed" do
+      Routes::Building.map('foo/', nil)
+      Routes::Store.routes.should == [['/foo/', nil]]
+    end
+    
+    it "should append / at the end of path if needed" do
+      Routes::Building.map('/foo', nil)
+      Routes::Store.routes.should == [['/foo/', nil]]
+    end
+        
+    it "should be able to storea bunch of routes with the draw method" do
+      proc = lambda { |path| "You are visiting #{path}" }
+      regex = /pos.*/
+      
+      Routes::Building.draw do
+        map '/first', 'something'
+        map '/second', :controller => 'foo', :action => 'bar'
+        map '/third', proc
+        map regex, 'something else'
+      end
+      
+      Routes::Store.routes.should == [
+          ['/first/', 'something'],
+          ['/second/', { :controller => 'foo', :action => 'bar' }],
+          ['/third/', proc],
+          [regex, 'something else']
+        ]
+    end
+    
+    
+  end
+  
+  context 'routes recognition' do
+    
+    before(:each) do
+      Routes::Store.routes = []
+      
+      Routes::Building.draw do
+        map '/posts', :controller => 'posts', :action => 'index'
+        map '/posts/:id', :controller => 'posts'
+        map '/controller/:action', {}
+        map '/:controller/:action/:id', {}
+        map '/cool', lambda { |path| "This is #{path}" }
+        map /.*/, :action => 'anything'
+      end
+    end
+    
+    it "should find route" do
+      Routes::Recognition.new('/posts').recognize.should == { :controller => 'posts', :action => 'index' }
+    end
+    
+    it "should find route with symbols as parameters" do
+      Routes::Recognition.new('/posts/1').recognize.should == { :controller => 'posts', :id => '1' }
+      Routes::Recognition.new('/controller/new').recognize.should == { :action => 'new' }
+      Routes::Recognition.new('/posts/show/1').recognize.should == { :controller => 'posts', :action => 'show', :id => '1' }
+    end
+    
+    it "should find route with regular expression" do
+      Routes::Recognition.new('/something').recognize.should == { :action => 'anything' }
+    end
+        
+    it "should directly execute lambda routes" do
+      Routes::Recognition.new('/cool').recognize.should == "This is /cool"
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'routes')

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: oscardelben-routes
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Oscar Del Ben
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-18 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A routes library for ruby.
+email: info@oscardelben.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/building.rb
+- lib/recognition.rb
+- lib/routes.rb
+- lib/store.rb
+- MIT-LICENSE
+- README.rdoc
+- spec/spec/routes_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/oscardelben/routes
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A routes library for ruby.
+test_files: []
+