router_simple 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in router_simple.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 tokuhirom
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# RouterSimple
+
+RouterSimple is yet another HTTP routing library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'router_simple'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install router_simple
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/*_spec.rb"
+end

data/lib/router_simple.rb

@@ -0,0 +1,130 @@
+require "router_simple/version"
+
+=begin
+
+router_simple.rb - minimalistic path dispatcher
+
+=head1 SYNOPSIS
+
+    router = RouterSimple::Router.new
+    router.register('GET',  '/', 'Root')
+    router.register('POST', '/member/create', 'Member#create')
+    router.register('GET',  '/member/:name', 'Member#detail')
+    router.register('GET',  '/download/*path', 'Download#detail')
+
+    router.match('/')
+    # => ('Root', {})
+
+    router.match('/member/dankogai')
+    # => ('Member#detail', {"name" => 'dankogai'})
+
+    router.match('/download/growthforecast')
+    # => ('Download#detail', {"path" => 'growthforecast'})
+
+=end
+
+module RouterSimple
+    # Yet another HTTP Router
+    class Router
+        # Create new instance
+        def initialize
+            @patterns = []
+        end
+
+        # register a path to router.
+        #
+        # You can specify three pattern of path.
+        #
+        # 1. Use regexp directly
+        # 2. Use /:name/:id
+        # 3. Use /*path
+        #
+        # @param [Araray or String] http_method HTTP method. You can specify nil, ['GET', 'HEAD"], 'GET', etc.
+        # @param [String or Regexp] path
+        # @param [Any]    dest Destination of this path
+        # @return None
+        def register(http_method, path, dest)
+            @patterns.push(Route.new(http_method, path, dest))
+        end
+
+        # match the path with this router.
+        #
+        # @param [String] http_method REQUEST_METHOD
+        # @param [String] path        PATH_INFO
+        #
+        # @return dest destination info
+        # @return captured captured parameters
+        # @return method_not_allowed true if method not allowed.
+        def match(http_method, path)
+            found_method_not_allowed = false
+            @patterns.each do |pattern|
+                dest, captured, method_not_allowed = pattern.match(http_method, path)
+                if dest
+                    return dest, captured
+                elsif method_not_allowed
+                    found_method_not_allowed = true
+                end
+            end
+            return nil, nil, found_method_not_allowed
+        end
+    end
+
+    # Route class
+    class Route
+        # Create new route object
+        #
+        # @param [Araray or String or NilClass] http_method HTTP method. You can specify nil, ['GET', 'HEAD"], 'GET', etc.
+        # @param [String] path
+        # @param [Any]    dest Destination of this path
+        def initialize(http_method, path, dest)
+            @path = path
+            @pattern = compile(path)
+            @dest = dest
+            @http_method = http_method.is_a?(String) ? [http_method] : http_method
+        end
+
+        # Match to this route
+        # 
+        # @param [String] http_method REQUEST_METHOD
+        # @param [String or Regexp] path        PATH_INFO
+        #
+        # @return dest               Destination for this route
+        # @return captures           captured parameters by router
+        # @return method_not_allowed True if the route was denied by method.
+        def match(http_method, path)
+            matched = @pattern.match(path)
+            if matched
+                if @http_method && !@http_method.any? {|m| m==http_method}
+                    return nil, nil, true
+                end
+                captures = {}
+                matched.names.zip(matched.captures).each {|x|
+                    captures[x[0]] = x[1]
+                }
+                return @dest, captures
+            else
+                return nil, nil
+            end
+        end
+
+        # compile 'path' pattern to regexp.
+        def compile(path)
+            if path.kind_of?(Regexp)
+                return path
+            else
+                pattern = Regexp.compile(
+                    '\A' + (
+                    path.gsub(/[-\[\]{}()+?.,\\^$|#\s]/) {|x|
+                        Regexp.escape(x)
+                    }
+                    .gsub(/:([\w\d]+)/, "(?<\\1>[^\/]+)")
+                    .gsub(/\*([\w\d]+)/, "(?<\\1>.+?)")
+                    ) + '\z'
+                )
+                pattern
+            end
+        end
+    end
+end
+
+

data/lib/router_simple/version.rb

@@ -0,0 +1,3 @@
+module RouterSimple
+  VERSION = "0.0.1"
+end

data/router_simple.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'router_simple/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "router_simple"
+  gem.version       = RouterSimple::VERSION
+  gem.authors       = ["tokuhirom"]
+  gem.email         = ["tokuhirom@gmail.com"]
+  gem.description   = %q{Simple HTTP routing library}
+  gem.summary       = %q{Yet another http routing library}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec"  
+end
+

data/spec/route_spec.rb

@@ -0,0 +1,90 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+
+require 'router_simple'
+
+describe RouterSimple::Route, '#match' do
+    describe 'GET /' do
+        r = RouterSimple::Route.new('GET', '/', 4)
+
+        it 'allows GET /' do
+            assert_equal r.match('GET', '/'), [4, {}]
+        end
+
+        it 'denides POST' do
+            assert_equal r.match('POST', '/'), [nil, nil, true]
+        end
+
+        it 'does not match to /foo' do
+            assert_equal r.match('GET', '/foo'), [nil, nil]
+        end
+    end
+
+    describe 'GET|HEAD /' do
+        r = RouterSimple::Route.new(['GET', 'HEAD'], '/', 4)
+
+        it 'allows GET /' do
+            assert_equal r.match('GET', '/'), [4, {}]
+        end
+
+        it 'also allows HEAD /' do
+            assert_equal r.match('HEAD', '/'), [4, {}]
+        end
+
+        it 'denides POST' do
+            assert_equal r.match('POST', '/'), [nil, nil, true]
+        end
+    end
+
+    describe 'GET /:name' do
+        route = RouterSimple::Route.new('GET', '/:name', 8)
+
+        it 'matches /dankogai' do
+            assert_equal route.match('GET', '/dankogai'), [8, {'name' => 'dankogai'}]
+        end
+
+        it 'does not matches /dankogai/4' do
+            assert_equal route.match('GET', '/dankogai/4'), [nil, nil]
+        end
+    end
+
+    describe 'GET /:name/:entry_id' do
+        router = RouterSimple::Route.new('GET', '/:name/:entry_id', 4)
+
+        it 'matches /dankogai/4' do
+            assert_equal router.match('GET', '/dankogai/4'), [4, {'name' => 'dankogai', 'entry_id' => '4'}]
+        end
+
+        it 'does not match /dankogai/' do
+            assert_equal router.match('GET', '/dankogai/'), [nil, nil]
+        end
+    end
+
+    describe 'GET /foo/*name' do
+        it 'matches /foo/yappo' do
+            router = RouterSimple::Route.new('GET', '/foo/*name', 8)
+            assert_equal router.match('GET', '/foo/yappo'), [8, {'name' => 'yappo'}]
+        end
+    end
+
+    describe 'use regexp as a path' do
+        describe 'using named capture' do
+            router = RouterSimple::Route.new('GET', %r{^/foo/(?<no>[0-9]+)$}, 8)
+            it 'matches /foo/111' do
+                assert_equal router.match('GET', '/foo/111'), [8, {'no' => '111'}]
+            end
+            it 'does not matches /foo/bar' do
+                assert_equal router.match('GET', '/foo/bar'), [nil, nil]
+            end
+        end
+        describe 'using paren capture' do
+            router = RouterSimple::Route.new('GET', %r{^/foo/([0-9]+)$}, 8)
+            it 'matches /foo/111' do
+                assert_equal router.match('GET', '/foo/111'), [8, {}]
+            end
+            it 'does not matches /foo/bar' do
+                assert_equal router.match('GET', '/foo/bar'), [nil, nil]
+            end
+        end
+    end
+end

data/spec/router_spec.rb

@@ -0,0 +1,56 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+
+require 'router_simple'
+
+describe RouterSimple::Router, '#xxx' do
+    it 'returns nil when there is no registered pattern' do
+        router = RouterSimple::Router.new()
+        assert_equal router.match('GET', '/'), [nil, nil, false]
+    end
+
+    describe 'GET /' do
+        it 'matches / when registered /' do
+            router = RouterSimple::Router.new()
+            router.register('GET', '/', 4)
+            assert_equal router.match('GET', '/'), [4, {}]
+        end
+
+        it 'denides POST request' do
+            router = RouterSimple::Router.new()
+            router.register('GET', '/', 4)
+            assert_equal router.match('POST', '/'), [nil, nil, true]
+        end
+    end
+
+    it 'matches /json when registered /json' do
+        router = RouterSimple::Router.new()
+        router.register('GET', '/', 2)
+        router.register('GET', '/json', 4)
+        assert_equal router.match('GET', '/json'), [4, {}]
+    end
+
+    it 'matches /dankogai when registered /:name' do
+        router = RouterSimple::Router.new()
+        router.register('GET', '/:name', 4)
+        assert_equal router.match('GET', '/dankogai'), [4, {'name' => 'dankogai'}]
+    end
+
+    it 'matches /dankogai/4 when registered /:name/:entry_id' do
+        router = RouterSimple::Router.new()
+        router.register('GET', '/:name/:entry_id', 4)
+        assert_equal router.match('GET', '/dankogai/4'), [4, {'name' => 'dankogai', 'entry_id' => '4'}]
+    end
+
+    it 'does not match /dankogai/4 when registered /:name' do
+        router = RouterSimple::Router.new()
+        router.register('GET', '/:name', 4)
+        assert_equal router.match('GET', '/dankogai/4'), [nil, nil, false]
+    end
+
+    it 'supports /foo/*name' do
+        router = RouterSimple::Router.new()
+        router.register('GET', '/foo/*name', 8)
+        assert_equal router.match('GET', '/foo/jfsdlkaf/jajkdlsfj'), [8, {'name' => 'jfsdlkaf/jajkdlsfj'}]
+    end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: router_simple
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- tokuhirom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple HTTP routing library
+email:
+- tokuhirom@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/router_simple.rb
+- lib/router_simple/version.rb
+- router_simple.gemspec
+- spec/route_spec.rb
+- spec/router_spec.rb
+homepage: ''
+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.24
+signing_key: 
+specification_version: 3
+summary: Yet another http routing library
+test_files:
+- spec/route_spec.rb
+- spec/router_spec.rb
+has_rdoc: