rack-rewrite 0.2.0 → 0.2.1

data/History.rdoc

@@ -1,3 +1,12 @@
+=== 0.2.1 / 2010-01-06
+* API
+  * Implement $& substitution pattern (thanks to {Ben Brinckerhoff}[http://github.com/bhb])
+  
+* Maintenance
+  * Ignore empty captures instead of failing during subsitution (thanks to {Ben Brinckerhoff}[http://github.com/bhb])
+  * Play nice with Rack::Test requests which only set PATH_INFO and not REQUEST_URI (thanks to {@docunext}[http://github.com/docunext])
+  * Use QUERY_STRING instead of QUERYSTRING as per Rack spec.  Closes Issue #1.
+
 === 0.2.0 / 2009-11-14
 * API
   * Allow Proc's to be be passed as the 'to' argument to rule declarations

data/README.rdoc

@@ -3,11 +3,18 @@
 A rack middleware for defining and applying rewrite rules. In many cases you 
 can get away with rack-rewrite instead of writing Apache mod_rewrite rules.
 
+== References
+
+* Source[http://github.com/jtrupiano/rack-rewrite]
+* Documentation[http://johntrupiano.rubyforge.org/rack-rewrite]
+* {Rack::Rewrite for Site Maintenance and Downtime}[http://blog.smartlogicsolutions.com/2009/11/16/rack-rewrite-for-site-maintenance-and-downtime/]
+* {Rack::Rewrite + Google Analytics Makes Site Transitions Seamless}[http://blog.smartlogicsolutions.com/2009/11/24/rack-rewrite-google-analytics-makes-site-transitions-seamless/]
+
 == Usage
 
 === Sample rackup file
   
-  gem 'rack-rewrite', '~> 0.1.3'
+  gem 'rack-rewrite', '~> 0.2.1'
   require 'rack-rewrite
   use Rack::Rewrite do
     rewrite '/wiki/John_Trupiano', '/john'
@@ -17,7 +24,7 @@ can get away with rack-rewrite instead of writing Apache mod_rewrite rules.
   end
 
 === Sample usage in a rails app
-  config.gem 'rack-rewrite', '~> 0.1.3'
+  config.gem 'rack-rewrite', '~> 0.2.1'
   require 'rack-rewrite
   config.middleware.insert_before(Rack::Lock, Rack::Rewrite) do
     rewrite '/wiki/John_Trupiano', '/john'
@@ -53,6 +60,16 @@ to these routes and keep your routes.rb clean.
 
   rewrite %r{/features(.*)}, '/facial_features$1'
 
+=== CNAME alternative
+
+In the event that you do not control your DNS, you can leverage Rack::Rewrite
+to redirect to a canonical domain.  In the following rule we utilize the
+$& substitution operator to capture the entire request URI.
+
+  r301 %r{.*}, 'http://mynewdomain.com$&', :if => Proc.new {|rack_env|
+    rack_env['SERVER_NAME'] != 'mynewdomain.com'
+  }
+
 === Site Maintenance
 
 Most capistrano users will be familiar with the following Apache rewrite rules:
@@ -72,10 +89,10 @@ We can replace the mod_rewrite rules with the following Rack::Rewrite rule:
 
   maintenance_file = File.join(RAILS_ROOT, 'public', 'system', 'maintenance.html')
   send_file /.*/, maintenance_file, :if => Proc.new { |rack_env|
-    File.exists?(maintenance_file) && !%w(css jpg png).any? {|ext| maintenance_file =~ Regexp.new("\.#{ext}$")}
+    File.exists?(maintenance_file) && rack_env['REQUEST_URI'] !~ /\.(css|jpg|png)/
   }
 
-If you're running Ruby 1.9, this rule is highly simplified:
+If you're running Ruby 1.9, this rule is simplified:
 
   maintenance_file = File.join(RAILS_ROOT, 'public', 'system', 'maintenance.html')
   send_file /(.*)$(?<!css|png|jpg)/, maintenance_file, :if => Proc.new { |rack_env|
@@ -83,19 +100,13 @@ If you're running Ruby 1.9, this rule is highly simplified:
   }
 
 For those using the oniguruma gem with their ruby 1.8 installation, you can 
-get away with this:
+get away with:
 
   maintenance_file = File.join(RAILS_ROOT, 'public', 'system', 'maintenance.html')
-  send_file Oniguruma::ORegexp.new("(.*)$(?<!css|png|jpg)"), maintenace_file, :if => Proc.new { |rack_env|
+  send_file Oniguruma::ORegexp.new("(.*)$(?<!css|png|jpg)"), maintenance_file, :if => Proc.new { |rack_env|
     File.exists?(maintenance_file)
   }
 
-NOTE: These replacement rules actually issue redirects.  The apache config
-snippet referenced above actually performs a rewrite.  With Rack::Rewrite
-we currently have to issue a redirect because rails will not recognize the
-maintenance route.  If you have any ideas on how to fix this, I would love
-to discuss it with you.
-
 == Rewrite Rules
 
 === :rewrite
@@ -179,17 +190,6 @@ received between 12AM and 8AM to an unavailable page.
     Time.now.hour < 8 ? "/unavailable.html" : match[1]
   }
   
-Note also that the rack environment is yielded to the lambda.  The 
-following redirect rule will send all visitors coming from a 
-
-rewrite %r{(.*)}, lambda { |match, rack_env|
-  if rack_env['HTTP_REFERER'] =~ /microsoft\.com/
-    
-  Time.now.hour < 8 ? "/unavailable.html" : match[1]
-}
-
-
-  
 == Copyright
 
-Copyright (c) 2009 John Trupiano. See LICENSE for details.
+Copyright (c) 2009-2010 John Trupiano. See LICENSE for details.

data/Rakefile

@@ -57,5 +57,6 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "rack-rewrite #{version}"
   rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('History.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/rack-rewrite/rule.rb

@@ -13,7 +13,7 @@ module Rack
         # using method_missing
         
         # Creates a rewrite rule that will simply rewrite the REQUEST_URI,
-        # PATH_INFO, and QUERYSTRING headers of the Rack environment.  The 
+        # PATH_INFO, and QUERY_STRING headers of the Rack environment.  The 
         # user's browser will continue to show the initially requested URL.
         # 
         #  rewrite '/wiki/John_Trupiano', '/john'
@@ -45,7 +45,7 @@ module Rack
         # Creates a rule that will render a file if matched.
         #
         #  send_file /*/, 'public/system/maintenance.html', 
-        #    :if => { File.exists?('public/system/maintenance.html') }
+        #    :if => Proc.new { File.exists?('public/system/maintenance.html') }
         def send_file(from, to, *args)
           options = args.last.is_a?(Hash) ? args.last : {}
           @rules << Rule.new(:send_file, from, to, options[:if])          
@@ -55,7 +55,7 @@ module Rack
         # if matched.
         #
         #  x_send_file /*/, 'public/system/maintenance.html', 
-        #    :if => { File.exists?('public/system/maintenance.html') }
+        #    :if => Proc.new { File.exists?('public/system/maintenance.html') }
         def x_send_file(from, to, *args)
           options = args.last.is_a?(Hash) ? args.last : {}
           @rules << Rule.new(:x_send_file, from, to, options[:if])
@@ -71,8 +71,8 @@ module Rack
 
       def matches?(rack_env) #:nodoc:
         return false if !guard.nil? && !guard.call(rack_env)
-        path = rack_env['REQUEST_URI']
-        if self.from.is_a?(Regexp) || (Object.const_defined?(:Oniguruma) && self.from.is_a?(Oniguruma::ORegexp))
+        path = rack_env['REQUEST_URI'].nil? ? rack_env['PATH_INFO'] : rack_env['REQUEST_URI']
+        if self.is_a_regexp?(self.from)
           path =~ self.from
         elsif self.from.is_a?(String)
           path == self.from
@@ -84,7 +84,7 @@ module Rack
       # Either (a) return a Rack response (short-circuiting the Rack stack), or
       # (b) alter env as necessary and return true
       def apply!(env) #:nodoc:
-        interpreted_to = self.send(:interpret_to, env['REQUEST_URI'], env)
+        interpreted_to = self.interpret_to(env['REQUEST_URI'], env)
         case self.rule_type
         when :r301
           [301, {'Location' => interpreted_to, 'Content-Type' => 'text/html'}, ['Redirecting...']]
@@ -95,10 +95,10 @@ module Rack
           env['REQUEST_URI'] = interpreted_to
           if q_index = interpreted_to.index('?')
             env['PATH_INFO'] = interpreted_to[0..q_index-1]
-            env['QUERYSTRING'] = interpreted_to[q_index+1..interpreted_to.size-1]
+            env['QUERY_STRING'] = interpreted_to[q_index+1..interpreted_to.size-1]
           else
             env['PATH_INFO'] = interpreted_to
-            env['QUERYSTRING'] = ''
+            env['QUERY_STRING'] = ''
           end
           true
         when :send_file
@@ -117,20 +117,25 @@ module Rack
         end
       end
       
-      private
+      protected
         def interpret_to(path, env={}) #:nodoc:
           return interpret_to_proc(path, env) if self.to.is_a?(Proc)
           return computed_to(path) if compute_to?(path)
           self.to
         end
+        
+        def is_a_regexp?(obj)
+          obj.is_a?(Regexp) || (Object.const_defined?(:Oniguruma) && obj.is_a?(Oniguruma::ORegexp))
+        end
 
+      private
         def interpret_to_proc(path, env)
           return self.to.call(match(path), env) if self.from.is_a?(Regexp)
           self.to.call(self.from, env)
         end
 
         def compute_to?(path)
-          self.from.is_a?(Regexp) && match(path)
+          self.is_a_regexp?(from) && match(path)
         end
 
         def match(path) 
@@ -140,11 +145,12 @@ module Rack
         def computed_to(path)
           # is there a better way to do this?
           computed_to = self.to.dup
+          computed_to.gsub!("$&",match(path).to_s)
           (match(path).size - 1).downto(1) do |num|
-            computed_to.gsub!("$#{num}", match(path)[num])
+            computed_to.gsub!("$#{num}", match(path)[num].to_s)
           end
           return computed_to
-        end
+        end        
     end
   end
 end

data/rack-rewrite.gemspec

@@ -5,16 +5,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rack-rewrite}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Trupiano"]
-  s.date = %q{2009-11-14}
+  s.date = %q{2010-01-06}
   s.description = %q{A rack middleware for enforcing rewrite rules. In many cases you can get away with rack-rewrite instead of writing Apache mod_rewrite rules.}
   s.email = %q{jtrupiano@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.rdoc",
+     "TODO"
   ]
   s.files = [
     ".document",

data/test/rack-rewrite_test.rb

@@ -3,7 +3,11 @@ require 'test_helper'
 class RackRewriteTest < Test::Unit::TestCase
 
   def call_args(overrides={})
-    {'REQUEST_URI' => '/wiki/Yair_Flicker', 'PATH_INFO' => '/wiki/Yair_Flicker', 'QUERYSTRING' => ''}.merge(overrides)
+    {'REQUEST_URI' => '/wiki/Yair_Flicker', 'PATH_INFO' => '/wiki/Yair_Flicker', 'QUERY_STRING' => ''}.merge(overrides)
+  end
+  
+  def call_args_no_req(overrides={})
+    {'PATH_INFO' => '/wiki/Yair_Flicker', 'QUERY_STRING' => ''}.merge(overrides)
   end
   
   def self.should_not_halt
@@ -90,10 +94,36 @@ class RackRewriteTest < Test::Unit::TestCase
           assert_equal '/john', @initial_args['PATH_INFO']
         end
         should "set REQUEST_URI to '/john'" do
-          assert_equal '/john', @initial_args['REQUEST_URI']          
+          assert_equal '/john', @initial_args['REQUEST_URI']
+        end
+        should "set QUERY_STRING to ''" do
+          assert_equal '', @initial_args['QUERY_STRING']
+        end
+      end
+    end
+
+    context 'when a rewrite rule matches but there is no REQUEST_URI set' do
+      setup {
+        @rack = Rack::Rewrite.new(@app) do
+          rewrite '/wiki/Yair_Flicker', '/john'
+        end
+      }
+      should_not_halt
+
+      context 'the env' do
+        setup do
+          @initial_args = call_args_no_req.dup
+          @rack.call(@initial_args)
+        end
+
+        should "set PATH_INFO to '/john'" do
+          assert_equal '/john', @initial_args['PATH_INFO']
+        end
+        should "set REQUEST_URI to '/john'" do
+          assert_equal '/john', @initial_args['REQUEST_URI']
         end
-        should "set QUERYSTRING to ''" do
-          assert_equal '', @initial_args['QUERYSTRING']          
+        should "set QUERY_STRING to ''" do
+          assert_equal '', @initial_args['QUERY_STRING']
         end
       end
     end

data/test/rule_test.rb

@@ -38,27 +38,27 @@ class RuleTest < Test::Unit::TestCase
       assert_equal rule.send(:interpret_to, '/abc'), rule.apply!(env)[1]['Location']
     end
     
-    should 'keep the QUERYSTRING when a 301 rule matches a URL with a querystring' do
+    should 'keep the QUERY_STRING when a 301 rule matches a URL with a querystring' do
       rule = Rack::Rewrite::Rule.new(:r301, %r{/john(.*)}, '/yair$1')
-      env = {'REQUEST_URI' => '/john?show_bio=1', 'PATH_INFO' => '/john', 'QUERYSTRING' => 'show_bio=1'}
+      env = {'REQUEST_URI' => '/john?show_bio=1', 'PATH_INFO' => '/john', 'QUERY_STRING' => 'show_bio=1'}
       assert_equal '/yair?show_bio=1', rule.apply!(env)[1]['Location']
     end
     
-    should 'keep the QUERYSTRING when a rewrite rule that requires a querystring matches a URL with a querystring' do
+    should 'keep the QUERY_STRING when a rewrite rule that requires a querystring matches a URL with a querystring' do
       rule = Rack::Rewrite::Rule.new(:rewrite, %r{/john(\?.*)}, '/yair$1')
-      env = {'REQUEST_URI' => '/john?show_bio=1', 'PATH_INFO' => '/john', 'QUERYSTRING' => 'show_bio=1'}
+      env = {'REQUEST_URI' => '/john?show_bio=1', 'PATH_INFO' => '/john', 'QUERY_STRING' => 'show_bio=1'}
       rule.apply!(env)
       assert_equal '/yair', env['PATH_INFO']
-      assert_equal 'show_bio=1', env['QUERYSTRING']
+      assert_equal 'show_bio=1', env['QUERY_STRING']
       assert_equal '/yair?show_bio=1', env['REQUEST_URI']
     end
     
-    should 'update the QUERYSTRING when a rewrite rule changes its value' do
+    should 'update the QUERY_STRING when a rewrite rule changes its value' do
       rule = Rack::Rewrite::Rule.new(:rewrite, %r{/(\w+)\?show_bio=(\d)}, '/$1?bio=$2')
-      env = {'REQUEST_URI' => '/john?show_bio=1', 'PATH_INFO' => '/john', 'QUERYSTRING' => 'show_bio=1'}
+      env = {'REQUEST_URI' => '/john?show_bio=1', 'PATH_INFO' => '/john', 'QUERY_STRING' => 'show_bio=1'}
       rule.apply!(env)
       assert_equal '/john', env['PATH_INFO']
-      assert_equal 'bio=1', env['QUERYSTRING']
+      assert_equal 'bio=1', env['QUERY_STRING']
       assert_equal '/john?bio=1', env['REQUEST_URI']
     end
 
@@ -206,7 +206,7 @@ class RuleTest < Test::Unit::TestCase
       setup do
         @rule = Rack::Rewrite::Rule.new(:rewrite, /.*/, '/system/maintenance.html', lambda { |rack_env|
           maintenance_file = File.join('system', 'maintenance.html')
-          File.exists?(maintenance_file) && !%w(css jpg png).any? {|ext| rack_env['REQUEST_URI'] =~ Regexp.new("\.#{ext}$")}
+          File.exists?(maintenance_file) && rack_env['REQUEST_URI'] !~ /\.(css|jpg|png)/
         })
       end
       should_pass_maintenance_tests
@@ -222,6 +222,25 @@ class RuleTest < Test::Unit::TestCase
         should_pass_maintenance_tests
       end
     end
+    
+    context 'Given the CNAME alternative rewrite rule in our README' do
+      setup do
+        @rule = Rack::Rewrite::Rule.new(:r301, %r{.*}, 'http://mynewdomain.com$&', lambda {|rack_env|
+          rack_env['SERVER_NAME'] != 'mynewdomain.com'
+        })
+      end
+      
+      should 'match requests for domain myolddomain.com and redirect to mynewdomain.com' do
+        env = {'REQUEST_URI' => '/anything?abc=1', 'PATH_INFO' => '/anything', 'QUERY_STRING' => 'abc=1', 'SERVER_NAME' => 'myolddomain.com'}
+        assert @rule.matches?(env)
+        rack_response = @rule.apply!(env)
+        assert_equal 'http://mynewdomain.com/anything?abc=1', rack_response[1]['Location']
+      end
+      
+      should 'not match requests for domain mynewdomain.com' do
+        assert !@rule.matches?({'REQUEST_URI' => '/anything', 'SERVER_NAME' => 'mynewdomain.com'})
+      end
+    end
   end
   
   context 'Rule#interpret_to' do
@@ -246,6 +265,16 @@ class RuleTest < Test::Unit::TestCase
       assert_equal 'jihgfedcba', rule.send(:interpret_to, "abcdefghij")
     end
 
+    should 'replace $& on a match' do
+      rule = Rack::Rewrite::Rule.new(:rewrite, %r{.*}, 'http://example.org$&')
+      assert_equal 'http://example.org/person/1', rule.send(:interpret_to, "/person/1")
+    end
+
+    should 'ignore empty captures' do
+      rule = Rack::Rewrite::Rule.new(:rewrite, %r{/person(_\d+)?}, '/people/$1')
+      assert_equal '/people/', rule.send(:interpret_to, "/person")
+    end
+
     should 'call to with from when it is a lambda' do
       rule = Rack::Rewrite::Rule.new(:rewrite, 'a', lambda { |from, env| from * 2 })
       assert_equal 'aa', rule.send(:interpret_to, 'a')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rack-rewrite
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - John Trupiano
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-14 00:00:00 -05:00
+date: 2010-01-06 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,6 +31,7 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 - README.rdoc
+- TODO
 files: 
 - .document
 - .gitignore