rack-routes 0.1.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,5 @@
+=== 0.1.0 / 2012-02-22
+
+* 1 major enhancement
+
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,9 @@
+.autotest
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+examples/config.ru
+lib/rack/routes.rb
+test/helper.rb
+test/test_rack_routes.rb

data/README.rdoc

@@ -0,0 +1,59 @@
+= rack-routes
+
+* https://github.com/bhenderson/rack-routes
+
+== DESCRIPTION:
+
+Provides a routing layer for Rack similar to nginx location directive.
+http://wiki.nginx.org/HttpCoreModule#location
+
+support provided by ATT Interactive (http://yp.com)
+
+== SYNOPSIS:
+
+Adding location directives will route any request which matches the path according to the rules to the given block. The idea is to further extend this to call your own code (controller/action, etc.)
+
+see sample controller in examples/config.ru
+see also the docs for Rack::Routes#location
+
+== FEATURES/PROBLEMS:
+
+* attempting to copy the nginx location directive.
+
+== INSTALL:
+
+* gem install rack-routes
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012 bhenderson
+
+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,19 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+# Hoe.plugin :compiler
+# Hoe.plugin :gem_prelude_sucks
+# Hoe.plugin :inline
+# Hoe.plugin :isolate
+# Hoe.plugin :racc
+# Hoe.plugin :rubyforge
+
+Hoe.spec 'rack-routes' do
+  developer 'Brian Henderson', 'bhenderson@attinteractive.com'
+
+  # self.rubyforge_name = 'rack-routesx' # if different than 'rack-routes'
+end
+
+# vim: syntax=ruby

data/examples/config.ru

@@ -0,0 +1,76 @@
+require 'rack/routes'
+
+class Server
+  class Request < Rack::Request
+  end
+  class Response < Rack::Response
+  end
+
+  def self.route verb, path, opts = {}, &blk
+    app = self
+    opts.merge! :method => verb.upcase
+
+    # change default behavior to use exact
+    opts[:exact] = opts.fetch(:exact, true)
+    Rack::Routes.location path, opts do |env|
+      app.call(env, &blk)
+    end
+  end
+
+  def self.get(*a, &b)  route 'GET', *a, &b end
+  def self.post(*a, &b) route 'POST', *a, &b end
+
+  def self.call env, &blk
+    new.call! env, &blk
+  end
+
+  attr_reader :env, :request, :response
+  def call! env, &blk
+    @env = env
+    @request  = Request.new @env
+    @response = Response.new
+
+    status 200
+    content_type 'text/plain'
+
+    response.write instance_exec(&blk)
+    response.finish
+  end
+
+  def content_type type
+    return headers['Content-Type'] unless type
+    headers 'Content-Type' => type
+  end
+
+  def headers opts = {}
+    response.headers.merge! opts
+  end
+
+  def status num = nil
+    return response.status unless num
+    response.status = num.to_i
+  end
+
+  get '/' do
+    foo
+  end
+
+  get '/asdf', :exact => false do
+    'hi there'
+  end
+
+  post '/' do
+    bar
+  end
+
+  def foo
+    '3'
+  end
+
+  def bar
+    '4'
+  end
+end
+
+use Rack::Routes
+run lambda{|env| [500, {'Content-Type' => 'text/plain'}, ['not found']]}

data/lib/rack/routes.rb

@@ -0,0 +1,181 @@
+require 'uri'
+
+module Rack
+  class Routes
+    VERSION = '0.1.0'
+
+    class LocDirectiveError < RuntimeError; end
+
+    class << self
+
+      # convience rack interface
+      # Enables the use of either:
+      # use Rack::Routes
+      # or
+      # run Rack::Routes
+
+      def call env
+        @app ||= new
+        @app.call env
+      end
+
+      # location directives should be run in a certain order. This is needed to
+      # establish that order.
+
+      def compile!
+        # longest first
+        [:exact, :string, :string_break].each do |type|
+          locations[type].sort_by!{|path, _| -path.length}
+        end
+      end
+
+      ##
+      # === Description
+      #
+      # Main interface method.
+      # Reimplementation of nginx location directive.
+      #
+      # === Args
+      # +path+:: The path to match on. Can be String or Regexp.
+      # +opts+:: Hash of options. see below.
+      #
+      # +opts+ keys:
+      # +:exact+:: Type of string matching. default false
+      #            Also can be +:prefix+ (for making '^~' make sense)
+      # +:method+:: HTTP Request Method matching. defaults nil (all)
+      # +:type+:: Explicetly set the type of match.
+      #
+      # +exact+ values can be:
+      # +false+:: prefix match
+      # +true+:: literal match
+      # +=+:: literal match
+      # +^~+:: skip regex matching
+      #
+      # yields +env+
+      #
+      # === Examples
+      #
+      # # config.ru
+      #
+      # # matches everything
+      # # but longer matches will get applied first
+      # Rack::Routes.location '/' do
+      #   [200, {}, ['hi']]
+      # end
+      #
+      # # matches everything beginning with /asdf
+      # Rack::Routes.location '/asdf' do
+      #   [200, {}, ['hi asdf']]
+      # end
+      #
+      # # matches /foo and not /foobar nor /foo/baz etc.
+      # Rack::Routes.location '/foo', :exact => true do
+      #   [200, {}, ['hi foo']]
+      # end
+      #
+      # # matches anything beginning with /bar
+      # # +path+ can be any ruby regex
+      # # matchdata is stored in env['routes.location.matchdata']
+      # Rack::Routes.location /\/bar(.*)/ do |env|
+      #   m = env['routes.location.matchdata']
+      #   [200, {}, ["hi #{m[1]}"]]
+      # end
+      #
+      # # matches beginning of path but stops if match is found. Does not
+      # evaluate regexen
+      # Rack::Routes.location '/baz', :prefix => '^~' do
+      #   [200, {}, ['hi baz']]
+      # end
+      #
+      # run Rack::Routes
+
+      def location path, opts = {}, &blk
+        type = opts.fetch(:type, nil)
+        type = :regex if Regexp === path
+        type ||= case opts.fetch(:exact, opts.fetch(:prefix, false))
+                 when FalseClass
+                   :string
+                 when TrueClass, '='
+                   :exact
+                 when '^~'
+                   :string_break
+                 end
+
+        raise LocDirectiveError, "unknown type `#{type}'" unless
+          [:regex, :string, :exact, :string_break].include? type
+
+        app = blk
+
+        locations[type] << [path, app, opts]
+      end
+
+      # accessor for @locations hash
+      def locations
+        @locations ||= Hash.new{|h,k| h[k] = []}
+      end
+    end
+
+
+    # rack app
+    def initialize app = nil
+      self.class.compile!
+      @app = app
+    end
+
+    # rack interface
+    def call env
+      dup.call! env
+    end
+
+    def call! env
+      @env  = env
+      @path = URI.decode @env['PATH_INFO']
+
+      (matching_app || @app).call(env)
+    end
+
+    def find_type type
+      _, app = locations[type].find do |path, _, opts|
+        next if opts[:method] and opts[:method] != @env['REQUEST_METHOD']
+        yield path
+      end
+      app
+    end
+
+    def find_exact
+      find_type(:exact){|pth| pth == @path}
+    end
+
+    def find_string
+      find_type(:string){|pth| @path[0, pth.length] == pth}
+    end
+
+    def find_string_break
+      find_type(:string_break){|pth| @path[0, pth.length] == pth}
+    end
+
+    def find_regex
+      find_type(:regex){|pth| pth === @path and
+        @env['routes.location.matchdata'] = Regexp.last_match }
+    end
+
+    def locations
+      self.class.locations
+    end
+
+    # search exact matches first
+    # then ^~ strings (not sure what else to call them)
+    # then regex
+    # then all the other strings
+    #
+    # NOTE the docs say to run strings before regex but I don't see why it
+    # matters as the return logic is the same.
+
+    def matching_app
+      find_exact          ||
+        find_string_break ||
+        find_regex        ||
+        find_string
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'minitest/autorun'
+require 'rack/routes'
+
+class TestRack
+end
+class RoutesTestCase < MiniTest::Unit::TestCase
+  def app
+    Rack::Routes
+  end
+end

data/test/test_rack_routes.rb

@@ -0,0 +1,149 @@
+require 'helper'
+
+class TestRack::TestRoutes < RoutesTestCase
+  def setup
+    @env = {'REQUEST_METHOD' => 'GET', 'PATH_INFO' => '/'}
+    app.locations.clear
+  end
+
+  def test_location_exact
+    app.location '/', :exact => true do
+      "1"
+    end
+
+    assert_location_match '1', '/'
+    refute_location_match '/asdf'
+  end
+
+  def test_location_string
+    app.location '/' do
+      "2"
+    end
+
+    assert_location_match '2', '/'
+    assert_location_match '2', '/asdf'
+  end
+
+  def test_location_string_longest
+    app.location '/' do
+      "2"
+    end
+    app.location '/asd' do
+      "3"
+    end
+    app.compile!
+
+    assert_location_match '3', '/asdf'
+  end
+
+  def test_location_complex
+    app.location '/', :exact => true do
+      "1"
+    end
+    app.location '/' do
+      "2"
+    end
+    app.location '/images/', :prefix => '^~' do
+      "3"
+    end
+    app.location /\.(gif|jpg|jpeg)$/i do
+      "4"
+    end
+
+    assert_location_match '1', '/'
+    assert_location_match '2', '/docs/docs.html'
+    assert_location_match '3', '/images/1.gif'
+    assert_location_match '4', '/docs/1.jpg'
+  end
+
+  def test_decoded_uris
+    app.location '/images/ /test' do
+      '1'
+    end
+
+    assert_location_match '1', '/images/%20/test'
+  end
+
+  def test_captures
+    app.location /^\/imag(.*)/ do
+    end
+
+    @env['PATH_INFO'] = '/images/foo'
+    app.call @env
+
+    m = @env['routes.location.matchdata']
+    assert_equal 'es/foo', m[1]
+  end
+
+  def test_request_method
+    app.location '/', :method => 'GET' do
+      '1'
+    end
+    app.location '/', :method => 'POST' do
+      '2'
+    end
+
+    assert_location_match '1', '/'
+    assert_location_match '2', '/', 'REQUEST_METHOD' => 'POST'
+  end
+
+  def test_string_break_skips_regex
+    app.location '/asd', :prefix => '^~' do
+      '1'
+    end
+
+    app.location /\/asdf/ do
+      '2'
+    end
+
+    assert_location_match '1', '/asdf'
+  end
+
+  def test_regex_first
+    app.location '/asd' do
+      '1'
+    end
+
+    assert_location_match '1', '/asdf'
+
+    app.location /\/asdf/ do
+      '2'
+    end
+
+    assert_location_match '2', '/asdf'
+  end
+
+  def test_call_twice
+    app.location /\/asdf/ do
+      '2'
+    end
+
+    assert_location_match '2', '/asdf'
+    assert_location_match '2', '/asdf'
+  end
+
+  def test_invalid_types
+    assert_raises app::LocDirectiveError do
+      app.location '/', :prefix => nil do
+      end
+    end
+    assert_raises app::LocDirectiveError do
+      app.location '/', :prefix => 'unknown' do
+      end
+    end
+  end
+
+  def assert_location_match expected, path, opts = {}
+    @env.merge! opts
+    @env['PATH_INFO'] = path
+    actual = app.call @env
+    assert_equal expected, actual, path
+  end
+
+  def refute_location_match path
+    assert_raises NoMethodError do
+      app.call 'PATH_INFO' => path
+    end
+  end
+
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: rack-routes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Brian Henderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &20516820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: *20516820
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &20516400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: *20516400
+description: ''
+email:
+- bhenderson@attinteractive.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+files:
+- .autotest
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- examples/config.ru
+- lib/rack/routes.rb
+- test/helper.rb
+- test/test_rack_routes.rb
+- .gemtest
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.txt
+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: rack-routes
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- test/test_rack_routes.rb