rack-rewrite 0.1.1 → 0.1.2

data/README.rdoc

@@ -14,8 +14,8 @@ that hard-earned reputation.  By writing rewrite rules that issue 301's for
 old URL's, we can "transfer" that google ranking to the new site.  An example
 rule might look like:
 
-  rewrite '/contact-us.php', '/contact-us'
-  rewrite '/wiki/John_Trupiano', '/john'
+  r301 '/contact-us.php', '/contact-us'
+  r301 '/wiki/John_Trupiano', '/john'
 
 === Retiring old routes
 
@@ -83,7 +83,20 @@ however, is that these actually short-circuit the rack stack and send back
 Recall that rules are interpreted from top to bottom.  So you can install 
 "default" rewrite rules if you like.  [2] is a sample default rule that
 will redirect all other requests to the wiki to a google search.
+
+== Tips
+
+=== Keeping your querystring
+
+When rewriting a URL, you may want to keep your querystring in tact (for 
+example if you're tracking traffic sources).  You will need to include a
+capture group and substitution pattern in your rewrite rule to achieve this.
+
+  rewrite %r{/wiki/John_Trupiano(\?.*)?}, '/john$1'
   
+This rule will store the querystring in a capture group (via '(?.*)' ) and
+will substitute the querystring back into the rewritten URL (via $1).
+
 == Copyright
 
 Copyright (c) 2009 John Trupiano. See LICENSE for details.

data/Rakefile

@@ -10,7 +10,7 @@ begin
     gem.email = "jtrupiano@gmail.com"
     gem.homepage = "http://github.com/jtrupiano/rack-rewrite"
     gem.authors = ["John Trupiano"]
-    gem.rubyforge_project = "rack-rewrite"
+    gem.rubyforge_project = "johntrupiano"
     gem.add_development_dependency "shoulda"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/rack-rewrite.rb

@@ -23,7 +23,7 @@ module Rack
         
     private
       def find_first_matching_rule(env) #:nodoc:
-        @rule_set.rules.detect { |rule| rule.matches?(env['PATH_INFO']) }
+        @rule_set.rules.detect { |rule| rule.matches?(env['REQUEST_URI']) }
       end    
   end
 end

data/lib/rack-rewrite/rule.rb

@@ -10,9 +10,9 @@ module Rack
         # We're explicitly defining private functions for our DSL rather than
         # using method_missing
         
-        # Creates a rewrite rule that will simply rewrite the REQUEST_URI and
-        # PATH_INFO headers of the Rack environment.  The user's browser
-        # will continue to show the initially requested URL.
+        # Creates a rewrite rule that will simply rewrite the REQUEST_URI,
+        # PATH_INFO, and QUERYSTRING headers of the Rack environment.  The 
+        # user's browser will continue to show the initially requested URL.
         # 
         #  rewrite '/wiki/John_Trupiano', '/john'
         #  rewrite %r{/wiki/(\w+)_\w+}, '/$1'        
@@ -55,10 +55,10 @@ module Rack
         end
       end
 
-      # Either (a) return a Rack response (short-circuting the Rack stack), or
+      # 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['PATH_INFO'])
+        interpreted_to = self.send(:interpret_to, env['REQUEST_URI'])
         case self.rule_type
         when :r301
           [301, {'Location' => interpreted_to}, ['Redirecting...']]
@@ -66,10 +66,17 @@ module Rack
           [302, {'Location' => interpreted_to}, ['Redirecting...']]
         when :rewrite
           # return [200, {}, {:content => env.inspect}]
-          env['PATH_INFO'] = env['REQUEST_URI'] = interpreted_to
+          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]
+          else
+            env['PATH_INFO'] = interpreted_to
+            env['QUERYSTRING'] = ''
+          end
           true
         else
-          raise Exception.new("Unsupported rule: #{rule.rule_type}")
+          raise Exception.new("Unsupported rule: #{self.rule_type}")
         end
       end
       

data/rack-rewrite.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rack-rewrite}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Trupiano"]
-  s.date = %q{2009-10-12}
+  s.date = %q{2009-10-13}
   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 = [
@@ -33,7 +33,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/jtrupiano/rack-rewrite}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{rack-rewrite}
+  s.rubyforge_project = %q{johntrupiano}
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{A rack middleware for enforcing rewrite rules}
   s.test_files = [

data/test/rack-rewrite_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 class RackRewriteTest < Test::Unit::TestCase
 
   def call_args(overrides={})
-    {'PATH_INFO' => '/wiki/Yair_Flicker'}.merge(overrides)
+    {'REQUEST_URI' => '/wiki/Yair_Flicker', 'PATH_INFO' => '/wiki/Yair_Flicker', 'QUERYSTRING' => ''}.merge(overrides)
   end
   
   def self.should_not_halt
@@ -42,7 +42,7 @@ class RackRewriteTest < Test::Unit::TestCase
   
   context 'Given an app' do
     setup do
-      @app = Class.new { def call; true; end }.new
+      @app = Class.new { def call(app); true; end }.new
     end
   
     context 'when no rewrite rule matches' do
@@ -79,10 +79,24 @@ class RackRewriteTest < Test::Unit::TestCase
         end
       }
       should_not_halt
-      should "set PATH_INFO and REQUEST_URI to '/john'" do
-        @app.expects(:call).with(call_args.merge({'PATH_INFO' => '/john', 'REQUEST_URI' => '/john'})).once
-        @rack.call(call_args)
+      
+      context 'the env' do
+        setup do
+          @initial_args = call_args.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']          
+        end
       end
     end
+    
   end
 end

data/test/rule_test.rb

@@ -8,10 +8,33 @@ class RuleTest < Test::Unit::TestCase
       env = {'PATH_INFO' => '/abc'}
       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
+      rule = Rack::Rewrite::Rule.new(:r301, %r{/john(.*)}, '/yair$1')
+      env = {'REQUEST_URI' => '/john?show_bio=1', 'PATH_INFO' => '/john', 'QUERYSTRING' => '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
+      rule = Rack::Rewrite::Rule.new(:rewrite, %r{/john(\?.*)}, '/yair$1')
+      env = {'REQUEST_URI' => '/john?show_bio=1', 'PATH_INFO' => '/john', 'QUERYSTRING' => 'show_bio=1'}
+      rule.apply!(env)
+      assert_equal '/yair', env['PATH_INFO']
+      assert_equal 'show_bio=1', env['QUERYSTRING']
+      assert_equal '/yair?show_bio=1', env['REQUEST_URI']
+    end
+    
+    should 'update the QUERYSTRING 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'}
+      rule.apply!(env)
+      assert_equal '/john', env['PATH_INFO']
+      assert_equal 'bio=1', env['QUERYSTRING']
+      assert_equal '/john?bio=1', env['REQUEST_URI']
+    end
   end
   
   context 'Rule#matches' do
-    
     context 'Given any rule with a "from" string of /features' do
       setup do
         @rule = Rack::Rewrite::Rule.new(:rewrite, '/features', '/facial_features')
@@ -58,7 +81,6 @@ class RuleTest < Test::Unit::TestCase
   end
   
   context 'Rule#interpret_to' do
-    
     should 'return #to when #from is a string' do
       rule = Rack::Rewrite::Rule.new(:rewrite, '/abc', '/def')
       assert_equal '/def', rule.send(:interpret_to, '/abc')
@@ -80,5 +102,4 @@ class RuleTest < Test::Unit::TestCase
       assert_equal 'jihgfedcba', rule.send(:interpret_to, "abcdefghij")
     end
   end
-  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rack-rewrite
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - John Trupiano
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-12 00:00:00 -04:00
+date: 2009-10-13 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: rack-rewrite
+rubyforge_project: johntrupiano
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3