mynyml-simple_router 0.8 → 0.8.1

data/README

@@ -0,0 +1,76 @@
+Small and simple standalone router, meant for use with Rack applications.
+
+PROBLEMS/FEATURES
+o Familiar Sinatra-like DSL for defining actions
+o Modular architecture (see ROUTING ENGINES section)
+o No magic
+o Low level / Highly flexible
+o Simple code
+
+
+EXAMPLES
+class App
+  include SimpleRouter::DSL
+
+  get '/' do
+    'home'
+  end
+
+  get '/archives/:year/:month/:day' do |year, month, day|
+    Article.archived.find_by_date(year, month, day)
+  end
+
+  def call(env)
+    verb, path  = ENV['REQUEST_METHOD'], ENV['PATH_INFO']
+    route, args = self.class.routes.match(verb, path)
+    route.nil? ?
+      [404, {'Content-Type' => 'text/html'}, '404 page not found'] :
+      [200, {'Content-Type' => 'text/html'}, route.action.call(*args)]
+  end
+end
+
+The SimpleRouter::DSL mixin provides 5 class methods:
+
+  #get, #post, #put, #delete and #routes
+
+The four verb methods allow you to define actions that will match a request for
+the verb and route signature it defines.
+
+The #routes method responds to #match and will return the first matching route
+(in order they were defined), and the values of the variables defined in the
+route signature if any (:year, :month, ...).
+
+Finally, the route returned is a simple object: for the second route in the
+example above:
+
+  route.verb    = :get
+  route.path    = '/archives/:year/:month/:day'
+  route.action  = lambda {|year, month, day| Article.archived.find_by_date(year, month, day) }
+
+See examples/ directory for executable code examples.
+
+
+ROUTING ENGINES
+By design, the code is seperated in two main components:
+
+  o DSL for defining routes/actions and retrieving requested action block.
+  o Routing engine
+
+Different engines can be used by assigning them to the router:
+
+  SimpleRouter.engine = UltraFastEngine
+
+This allows, for instance, a new faster engine to be used by an app without
+changes in the top level DSL.
+
+Engines can also allow route definitions to include more (or less!) features.
+For example, the built-in SimpleEngine allows route variables and extention
+handling. Others could add variable conditions ( :id => Integer ), mime-type
+restrictions, etc.
+
+ENGINE WRITERS
+Engines only need to conform to a simple interface. See the wiki for the
+details. (TODO: add interface spec to wiki)
+
+LICENSE
+MIT. See LICENSE file.

data/Rakefile

@@ -22,9 +22,9 @@ end
 
 spec = Gem::Specification.new do |s|
   s.name            = 'simple_router'
-  s.version         = '0.8'
-  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.version         = '0.8.1'
+  s.summary         = "Simple, minimalistic, standalone router meant to be used with pure rack applications."
+  s.description     = "Simple, minimalistic, standalone router meant to be used with pure rack applications."
   s.author          = "Martin Aumont"
   s.email           = 'mynyml@gmail.com'
   s.homepage        = ''

data/lib/simple_router.rb

@@ -1,4 +1,9 @@
 module SimpleRouter
+  class << self
+    attr_accessor :engine
+    def engine() @engine || Engines::SimpleEngine end
+  end
+
   autoload :DSL,    'simple_router/dsl'
   autoload :Routes, 'simple_router/routes'
 

data/lib/simple_router/routes.rb

@@ -1,13 +1,6 @@
 module SimpleRouter
   class Routes < Array
 
-    # routing engine
-    attr_accessor :engine
-
-    def engine
-      @engine || Engines::SimpleEngine
-    end
-
     def add(*args, &action)
       self << Route.new(*args, &action)
     end
@@ -16,10 +9,12 @@ module SimpleRouter
       none = [nil, nil]
       return none if self.empty?
 
+      verb = verb.to_s.downcase.strip.to_sym
+
       routes = self.select {|route| route.verb == verb }
       paths  = routes.map  {|route| route.path }
 
-      path, vars = self.engine.match(path, paths)
+      path, vars = SimpleRouter.engine.match(path, paths)
       return none if path.nil?
 
       route = routes.detect {|route| route.path == path }

data/simple_router.gemspec

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simple_router
 version: !ruby/object:Gem::Version 
-  version: "0.8"
+  version: 0.8.1
 platform: ruby
 authors: 
 - Martin Aumont
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-18 00:00:00 -04:00
+date: 2009-05-19 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: Minimalistic, simple router meant to be used with pure rack applications.
+description: Simple, minimalistic, standalone router meant to be used with pure rack applications.
 email: mynyml@gmail.com
 executables: []
 
@@ -71,6 +71,6 @@ rubyforge_project:
 rubygems_version: 1.3.3
 signing_key: 
 specification_version: 3
-summary: Minimalistic, simple router meant to be used with pure rack applications.
+summary: Simple, minimalistic, standalone router meant to be used with pure rack applications.
 test_files: []
 

data/test/test_routes.rb

@@ -31,15 +31,13 @@ class RoutesTest < Test::Unit::TestCase
     @routes.match('/baz', :get).should be([nil,nil])
   end
 
-  ## engine
-
-  test "default engine" do
-    @routes.engine.name.split('::').last.should be('SimpleEngine')
-  end
+  test "normalizes passed in verb string" do
+    @routes.add(:get, '/foo', {}, &@action)
+    @routes.add(:get, '/bar', {}, &@action)
 
-  test "custom engine" do
-    @routes.engine = ::Object
-    @routes.engine.name.should be('Object')
+    @routes.match('get',  '/bar').first.path.should be('/bar')
+    @routes.match('GET',  '/bar').first.path.should be('/bar')
+    @routes.match(' GET ','/bar').first.path.should be('/bar')
   end
 end
 

data/test/test_simple_router.rb

@@ -0,0 +1,23 @@
+require 'test/test_helper'
+
+class App
+  include SimpleRouter::DSL
+end
+
+class SimpleRouterTest < Test::Unit::TestCase
+
+  def setup
+    SimpleRouter.engine = nil
+  end
+
+  ## engine
+
+  test "default engine" do
+    SimpleRouter.engine.name.split('::').last.should be('SimpleEngine')
+  end
+
+  test "custom engine" do
+    SimpleRouter.engine = ::Object
+    SimpleRouter.engine.name.should be('Object')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mynyml-simple_router
 version: !ruby/object:Gem::Version 
-  version: "0.8"
+  version: 0.8.1
 platform: ruby
 authors: 
 - Martin Aumont
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-17 21:00:00 -07:00
+date: 2009-05-18 21:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: Minimalistic, simple router meant to be used with pure rack applications.
+description: Simple, minimalistic, standalone router meant to be used with pure rack applications.
 email: mynyml@gmail.com
 executables: []
 
@@ -69,6 +69,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
-summary: Minimalistic, simple router meant to be used with pure rack applications.
+summary: Simple, minimalistic, standalone router meant to be used with pure rack applications.
 test_files: []