mynyml-simple_router 0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright © 2009 Martin Aumont (mynyml)
+
+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/Rakefile

@@ -0,0 +1,66 @@
+# --------------------------------------------------
+# based on thin's Rakefile (http://github.com/macournoyer/thin)
+# --------------------------------------------------
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'pathname'
+require 'yaml'
+
+RUBY_1_9  = RUBY_VERSION =~ /^1\.9/
+WIN       = (RUBY_PLATFORM =~ /mswin|cygwin/)
+SUDO      = (WIN ? "" : "sudo")
+
+def gem
+  RUBY_1_9 ? 'gem19' : 'gem'
+end
+
+def all_except(res)
+  Dir['**/*'].reject do |path|
+    Array(res).any? {|re| path.match(re) }
+  end
+end
+
+spec = Gem::Specification.new do |s|
+  s.name            = 'simple_router'
+  s.version         = '0.1'
+  s.summary         = "Minimalistic, simple router meant to be used with pure rack applications."
+  s.description     = "Minimalistic, simple router meant to be used with pure rack applications."
+  s.author          = "Martin Aumont"
+  s.email           = 'mynyml@gmail.com'
+  s.homepage        = ''
+  s.has_rdoc        = true
+  s.require_path    = "lib"
+  s.files           = all_except(/doc\/.*/)
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+desc "Remove package products"
+task :clean => :clobber_package
+
+desc "Update the gemspec for GitHub's gem server"
+task :gemspec do
+  Pathname("#{spec.name}.gemspec").open('w') {|f| f << YAML.dump(spec) }
+end
+
+desc "Install gem"
+task :install => [:clobber, :package] do
+  sh "#{SUDO} #{gem} install pkg/#{spec.full_name}.gem"
+end
+
+desc "Uninstall gem"
+task :uninstall => :clean do
+  sh "#{SUDO} #{gem} uninstall -v #{spec.version} -x #{spec.name}"
+end
+
+desc "Generate rdoc documentation."
+Rake::RDocTask.new("rdoc") { |rdoc|
+  rdoc.rdoc_dir = 'doc/rdoc'
+  rdoc.title    = "Simple Router - Document"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}

data/TODO

@@ -0,0 +1 @@
+o improve rdocs

data/lib/simple_router/dsl.rb

@@ -0,0 +1,57 @@
+module SimpleRouter
+
+  # Mixin that provides a Sinatra-line DSL frontend to the routing engine
+  # backend.
+  #
+  # Meant to be minimal, simple and as magic-free as possible.
+  # When mixed in, only adds 5 class methods (#get, #post, #put, #delete and #routes).
+  #
+  # ==== Examples
+  # # simple rack app
+  #
+  # class App
+  #   include SimpleRouter::DSL
+  #
+  #   get '/' do
+  #     'home'
+  #   end
+  #
+  #   get '/users/:id' do |id|
+  #   end
+  #
+  #   put '/:foo/:bar' do |foo, bar, *params|
+  #   end
+  #
+  #   def call(env)
+  #     request = Rack::Request.new(env)
+  #
+  #     verb = request.request_method
+  #     path = Rack::Utils.unescape(request.path_info)
+  #
+  #     action = self.class.routes.match(verb, path).action
+  #     action.nil? ? [404, {}, []] : [200, {}, [action.call]]
+  #   end
+  # end
+  #
+  # ==== Notes
+  # Because the DSL is a simple mixin, it can be used in any class (i.e. not
+  # necessarily a rack app).
+  #
+  module DSL
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.class_eval do
+        @routes = Routes.new
+      end
+    end
+
+    module ClassMethods
+      attr_reader :routes
+
+      def get(   path, opts={}, &block) routes.add(:get,    path, opts, &block) end
+      def post(  path, opts={}, &block) routes.add(:post,   path, opts, &block) end
+      def put(   path, opts={}, &block) routes.add(:put,    path, opts, &block) end
+      def delete(path, opts={}, &block) routes.add(:delete, path, opts, &block) end
+    end
+  end
+end

data/lib/simple_router/engines/simple_engine.rb

@@ -0,0 +1,30 @@
+module SimpleRouter
+  module Engines
+    class SimpleEngine
+
+      # Finds a route definition that matches a path
+      #
+      # ===== Arguments
+      # * path: actual path to match (e.g. ENV['PATH_INFO'])
+      # * routes: array of user defined routes
+      #
+      # ===== Returns
+      # Array of two elements:
+      #
+      # * index 0: first matching route
+      # * index 1: array of values for route variables, in the order they were specified
+      #
+      # ===== Examples
+      #
+      #   SimpleEngine.match('/foo', ['/', '/foo', '/bar/baz'])   #=> ['/foo', []]
+      #   SimpleEngine.match('/80/07/01', ['/:year/:month/:day']) #=> ['/foo', ['80', '07', '01']]
+      #
+      def self.match(path, routes)
+        routes.each do |route|
+          return route if route == path
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/simple_router/routes.rb

@@ -0,0 +1,36 @@
+module SimpleRouter
+  class Routes < Array #:nodoc:
+
+    # routing engine
+    attr_accessor :engine
+
+    def engine
+      @engine || Engines::SimpleEngine
+    end
+
+    def add(*args, &action)
+      self << Route.new(*args, &action)
+    end
+
+    def match(verb, path)
+      unless self.empty?
+        routes = self.select {|route| route.verb == verb }
+        paths  = routes.map  {|route| route.path }
+
+        path = self.engine.match(path, paths)
+        routes.detect {|route| route.path == path }
+      end
+    end
+
+    class Route < Array #:nodoc:
+      attr_accessor :verb,:path,:options,:action
+
+      def initialize(verb, path, options, &action)
+        self.verb    = verb
+        self.path    = path
+        self.options = options
+        self.action  = action
+      end
+    end
+  end
+end

data/lib/simple_router.rb

@@ -0,0 +1,8 @@
+module SimpleRouter
+  autoload :DSL,    'simple_router/dsl'
+  autoload :Routes, 'simple_router/routes'
+
+  module Engines
+    autoload :SimpleEngine, 'simple_router/engines/simple_engine'
+  end
+end

data/simple_router.gemspec

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: simple_router
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Martin Aumont
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-18 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Minimalistic, simple router meant to be used with pure rack applications.
+email: mynyml@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- test
+- test/engines
+- test/engines/test_simple_engine.rb
+- test/test_simple_router.rb
+- test/test_dsl.rb
+- test/test_routes.rb
+- test/test_helper.rb
+- simple_router.gemspec
+- TODO
+- lib
+- lib/simple_router
+- lib/simple_router/routes.rb
+- lib/simple_router/engines
+- lib/simple_router/engines/simple_engine.rb
+- lib/simple_router/dsl.rb
+- lib/simple_router.rb
+- doc
+- LICENSE
+- README
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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.3.3
+signing_key: 
+specification_version: 3
+summary: Minimalistic, simple router meant to be used with pure rack applications.
+test_files: []
+

data/test/engines/test_simple_engine.rb

@@ -0,0 +1,12 @@
+require 'test/test_helper'
+
+Engine = SimpleRouter::Engines::SimpleEngine
+
+class SimpleEngineTest < Test::Unit::TestCase
+
+  test "matches simple paths" do
+    Engine.match('/',    ['/', '/foo']).should be('/')
+    Engine.match('/foo', ['/', '/foo']).should be('/foo')
+    Engine.match('/bar', ['/', '/foo']).should be(nil)
+  end
+end

data/test/test_dsl.rb

@@ -0,0 +1,38 @@
+require 'test/test_helper'
+
+class App
+  include SimpleRouter::DSL
+end
+
+class DslTest < Test::Unit::TestCase
+
+  def setup
+    App.routes.clear
+  end
+
+  ## API
+
+  test "provides action verb methods" do
+    App.get(   '/foo') {}
+    App.post(  '/foo') {}
+    App.put(   '/foo') {}
+    App.delete('/foo') {}
+
+    App.routes.size.should be(4)
+  end
+
+  test "provides routes object" do
+    App.respond_to?(:routes).should be(true)
+    App.routes.should be_kind_of(SimpleRouter::Routes)
+  end
+
+  ## matching
+
+  test "matching routes" do
+    App.get('/foo') { 'foo' }
+    App.get('/bar') { 'bar' }
+
+    App.routes.match(:get, '/foo').should_not  be( nil )
+    App.routes.match(:get, '/foo').action.call.should be('foo')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'pathname'
+require 'test/unit'
+require 'rubygems'
+require 'matchy'
+require 'pending'
+begin
+  require 'ruby-debug'
+rescue LoadError, RuntimeError
+end
+
+root = Pathname(__FILE__).dirname.parent.expand_path
+$:.unshift(root.join('lib'))
+
+require 'simple_router'
+
+class Test::Unit::TestCase
+  def self.test(name, &block)
+    name = :"test_#{name.gsub(/\s/,'_')}"
+    define_method(name, &block)
+  end
+end

data/test/test_routes.rb

@@ -0,0 +1,57 @@
+require 'test/test_helper'
+
+Routes = SimpleRouter::Routes
+
+class RoutesTest < Test::Unit::TestCase
+
+  def setup
+    @routes = Routes.new
+    @action = lambda {}
+  end
+
+  test "stores route definitions" do
+    @routes.add(:get, '/foo', {}, &@action)
+    @routes.first.path.should be('/foo')
+  end
+
+  ## matching
+
+  test "matches a path" do
+    @routes.add(:get, '/foo', {}, &@action)
+    @routes.add(:get, '/bar', {}, &@action)
+
+    @routes.match(:get, '/bar').should_not  be(nil)
+    @routes.match(:get, '/bar').path.should be('/bar')
+  end
+
+  test "returns nil when no route matches" do
+    @routes.add(:get, '/foo', {}, &@action)
+    @routes.add(:get, '/bar', {}, &@action)
+
+    @routes.match('/baz', :get).should be(nil)
+  end
+
+  ## engine
+
+  test "default engine" do
+    @routes.engine.name.split('::').last.should be('SimpleEngine')
+  end
+
+  test "custom engine" do
+    @routes.engine = ::Object
+    @routes.engine.name.should be('Object')
+  end
+end
+
+class RouteTest < Test::Unit::TestCase
+
+  test "internal API" do
+    verb, path, options, action = :get, '/foo', {}, lambda {}
+
+    route = SimpleRouter::Routes::Route.new(verb, path, options, &action)
+    route.verb    .should be(verb)
+    route.path    .should be(path)
+    route.options .should be(options)
+    route.action  .should be(action)
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: mynyml-simple_router
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Martin Aumont
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-17 21:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Minimalistic, simple router meant to be used with pure rack applications.
+email: mynyml@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- test
+- test/engines
+- test/engines/test_simple_engine.rb
+- test/test_simple_router.rb
+- test/test_dsl.rb
+- test/test_routes.rb
+- test/test_helper.rb
+- simple_router.gemspec
+- TODO
+- lib
+- lib/simple_router
+- lib/simple_router/routes.rb
+- lib/simple_router/engines
+- lib/simple_router/engines/simple_engine.rb
+- lib/simple_router/dsl.rb
+- lib/simple_router.rb
+- doc
+- LICENSE
+- README
+has_rdoc: true
+homepage: ""
+post_install_message: 
+rdoc_options: []
+
+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: 3
+summary: Minimalistic, simple router meant to be used with pure rack applications.
+test_files: []
+