angus-router 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23e229a9ab8e0ab0c5a2759cccc252bf0f55df8b
+  data.tar.gz: 2717f43c081f4ae84cd8cff84a5d790750c47117
+SHA512:
+  metadata.gz: 9ebabff008794050195ef91b935fe19ec1ac4bb2fa937a595ae96b593ca0269f33045dcb6b040488a8aeb2e841d95438a5a05c727884d37e1d7ae5d8c8ed9b81
+  data.tar.gz: 2d3e178c3ef09c9646df5768d7c2968d6138943b707adebcb18189122fc351931163b6d93c3de5c73728cdbf28073318ce0a41af77c266748ae71a6d3a43dfbd

data/lib/angus-router.rb

@@ -0,0 +1 @@
+require_relative 'angus/router'

data/lib/angus/router.rb

@@ -1,7 +1,198 @@
-require "angus/router/version"
+require 'rack'
 
 module Angus
-  module Router
-    # Your code goes here...
+  class Router
+
+    VERSION = '0.0.2'
+
+    RE_TRAILING_SLASH = %r{/\Z}
+
+    SUPPORTED_HTTP_METHODS = [
+      :get,
+      :post,
+      :put,
+      :delete,
+      :head,
+      :options,
+      :patch,
+      :trace
+    ]
+
+    PathPattern = Struct.new(:re_path, :param_names) do
+
+      # Matches the given path against #re_path.
+      #
+      # @return [MatchData] when match succeeds
+      # @return [nil] when match fails
+      def match(path)
+        re_path.match(path)
+      end
+    end
+
+    Route = Struct.new(:method, :proc, :path_pattern) do
+
+      # Returns the parameter names for this route.
+      #
+      # @return [Array<String>]
+      def param_names
+        path_pattern.param_names
+      end
+
+      # Returns the true if the current route contains defined params.
+      #
+      # @return [Boolean]
+      def params?
+        param_names.any?
+      end
+
+      # Matches the given path against #path_pattern.
+      #
+      # @return [MatchData] when match succeeds
+      # @return [nil] when match fails
+      def match(path)
+        path_pattern.match(path)
+      end
+    end
+
+    # It registers block to be yielded at a given HTTP method and path.
+    #
+    # @param [Symbol] m HTTP method (see SUPPORTED_HTTP_METHODS)
+    # @param [String] path Url path
+    # @param [Proc] block The block that will be yielded when an incoming request matches the route
+    def on(m, path, &block)
+      path = path.gsub(RE_TRAILING_SLASH, '')
+
+      unless SUPPORTED_HTTP_METHODS.include?(m)
+        raise ArgumentError.new("Unsupported HTTP method #{m}")
+      end
+
+      route = Route.new(m.to_s.upcase, block, compile(path))
+
+      if route.params?
+        dynamic_routes << route
+      else
+        static_routes << route
+      end
+    end
+
+    # Calls the corresponding previously registered block.
+    #
+    # When calling, the rack environment and the extracted path params are passed
+    # to the route block.
+    #
+    # @param [Hash] env A Rack environment. (see http://rack.rubyforge.org/doc/SPEC.html)
+    #
+    # @return The result of the block call
+    def route(env)
+      request = Rack::Request.new(env)
+
+      path_info = request.path_info.gsub(RE_TRAILING_SLASH, '').squeeze('/')
+      matched_route = match_route(env['REQUEST_METHOD'], path_info)
+
+      match, route_block, path_param_names = matched_route
+
+      unless match
+        raise NotImplementedError, "No route found #{request.path_info}"
+      end
+
+      path_params = extract_params(match, path_param_names)
+      whole_params = request.params.clone.merge!(path_params)
+      whole_params = symbolize(whole_params)
+
+      route_block.call(env, whole_params)
+    end
+
+    private
+    # Returns a shallow copy with keys as symbols of hash.
+    #
+    # @param [Hash] hash
+    #
+    # @return [Hash]
+    def symbolize(hash)
+      Hash[
+        hash.map { |k, v| [k.to_sym, v] }
+      ]
+    end
+
+    def dynamic_routes
+      @dynamic_routes ||= []
+    end
+
+    def static_routes
+      @static_routes ||= []
+    end
+
+    # Returns a path pattern base on the given pattern.
+    #
+    # @example compile('/users/:id')
+    #   => PathPattern.new(/^\/users\/([^\/?#]+)$/, ['id']])
+    #
+    # @param [String] Url path
+    #
+    # @return [PathPattern]
+    def compile(pattern)
+      keys = []
+
+      pattern = pattern.to_str.squeeze('/')
+      pattern.gsub!(/[^\?\%\\\/\:\*\w]/) { |c| encoded(c) }
+      pattern.gsub!(/(:\w+)/) do |match|
+        keys << $1[1..-1]
+        "([^/?#]+)"
+      end
+
+      PathPattern.new(/^#{pattern}$/, keys)
+    end
+
+    # Escapes a char for uri regex matching.
+    #
+    # @param [String] char
+    #
+    # @return [String]
+    def encoded(char)
+      enc = URI.escape(char)
+      enc = "(?:#{Regexp.escape enc}|#{URI.escape char, /./})" if enc == char
+      enc = "(?:#{enc}|#{encoded('+')})" if char == " "
+      enc
+    end
+
+    # Returns regexp, block and path param names according to the route that matches
+    # the given method and path.
+    #
+    # @param [String] method HTTP method
+    # @param [String] path Url path
+    #
+    # @return [regexp, route_block, path_param_names]
+    def match_route(method, path)
+      [static_routes, dynamic_routes].each do |routes|
+        routes.each do |route|
+          if method == route.method && match = route.match(path)
+            return [match, route.proc, route.param_names]
+          end
+        end
+      end
+
+      nil
+    end
+
+    # Extracts matched values from the given match.
+    #
+    # Assoaciates each match to the corresponding key.
+    #
+    # @param [MatchData] match
+    # @param [Array] keys
+    #
+    # @return [Hash] A hash containing extracted key / values
+    def extract_params(match, keys)
+      hash = {}
+
+      captures = match.captures
+
+      keys.each_with_index do |k, i|
+        hash[k] = captures[i]
+      end
+
+      hash
+    end
+
   end
 end

metadata

@@ -1,32 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: angus-router
 version: !ruby/object:Gem::Version
-  prerelease:
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
-- Adrian Gomez
+- Gianfranco Zas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-10-10 00:00:00.000000000 Z
+date: 2013-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rack
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
-    none: false
+        version: '1.5'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
-    none: false
+        version: '1.5'
   prerelease: false
-  type: :development
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: rake
   version_requirements: !ruby/object:Gem::Requirement
@@ -34,33 +31,98 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
   prerelease: false
   type: :development
-description: angus-router
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov-text
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: ci_reporter
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+description: |2
+      Angus-router is a powerful router for your next generation of awesome Rack applications.
+      Just throw your shit into angus-router and run away.
 email:
-- adrian.gomez@moove-it.com
+- angus@moove-it.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- angus-router.gemspec
+- lib/angus-router.rb
 - lib/angus/router.rb
-- lib/angus/router/version.rb
-homepage: ''
+homepage: http://mooveit.github.io/angus-router
 licenses:
 - MIT
+metadata: {}
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -70,17 +132,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project:
-rubygems_version: 1.8.24
+rubygems_version: 2.1.5
 signing_key:
-specification_version: 3
-summary: angus-router
+specification_version: 4
+summary: Router for Rack applications.
 test_files: []

data/.gitignore

@@ -1,17 +0,0 @@
-*.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

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

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Adrian Gomez
-
-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

@@ -1,29 +0,0 @@
-# Angus::Router
-
-TODO: Write a gem description
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'angus-router'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install angus-router
-
-## 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

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

data/angus-router.gemspec

@@ -1,23 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'angus/router/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "angus-router"
-  spec.version       = Angus::Router::VERSION
-  spec.authors       = ["Adrian Gomez"]
-  spec.email         = ["adrian.gomez@moove-it.com"]
-  spec.description   = %q{angus-router}
-  spec.summary       = %q{angus-router}
-  spec.homepage      = ""
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-end

data/lib/angus/router/version.rb

@@ -1,5 +0,0 @@
-module Angus
-  module Router
-    VERSION = "0.0.1"
-  end
-end