rack-rewrite 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 John Trupiano
+
+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/README.rdoc

@@ -0,0 +1,21 @@
+= rack-rewrite
+
+A rack middleware for enforcing rewrite rules. In many cases you can get away with rack-rewrite
+instead of writing Apache mod_rewrite rules.
+
+== Usage in a rails app
+  config.gem 'rack-rewrite', '~> 0.1.0'
+  config.middleware.insert_before(Rack::Lock, Rack::Rewrite) do
+    rewrite '/wiki/John_Trupiano', '/john'
+    r301 '/wiki/Yair_Flicker', '/yair'
+    r302 '/wiki/Greg_Jastrab', '/greg'
+  end
+
+== Notes
+
+* Haven't tested full paths for :rewrite, :r301, :r302
+* No regular expression support yet
+
+== Copyright
+
+Copyright (c) 2009 John Trupiano. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-rewrite"
+    gem.summary = %Q{A rack middleware for enforcing rewrite rules}
+    gem.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.}
+    gem.email = "jtrupiano@gmail.com"
+    gem.homepage = "http://github.com/jtrupiano/rack-rewrite"
+    gem.authors = ["John Trupiano"]
+    gem.rubyforge_project = "rack-rewrite"
+    gem.add_development_dependency "shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-rewrite #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rack-rewrite.rb

@@ -0,0 +1,55 @@
+module Rack
+  class Rewrite
+    def initialize(app, &rule_block)
+      @app = app
+      @rule_set = RuleSet.new
+      @rule_set.instance_eval(&rule_block) if block_given?
+    end
+    
+    def call(env)
+      if matched_rule = find_rule(env)
+        apply(matched_rule, env)
+      else
+        @app.call(env)
+      end
+    end
+    
+    # This logic needs to be pushed into Rule subclasses
+    def apply(rule, env)
+      case rule[0]
+      when :r301
+        [301, {'Location' => rule[2]}, ['Redirecting...']]
+      when :r302
+        [302, {'Location' => rule[2]}, ['Redirecting...']]
+      when :rewrite
+        # return [200, {}, {:content => env.inspect}]
+        env['PATH_INFO'] = env['REQUEST_URI'] = rule[2]
+        @app.call(env)
+      else
+        raise Exception.new("Unsupported rule: #{rule[0]}")
+      end
+    end
+    
+    # This will probably have to change as rule matching gets more complicated
+    def find_rule(env)
+      @rule_set.rules.detect { |rule| rule[1] == env['PATH_INFO'] }
+    end
+    
+    class RuleSet
+      
+      attr_reader :rules
+      def initialize
+        @rules = []
+      end
+      
+      private
+        # We're explicitly defining the functions for our DSL rather than using
+        # method_missing
+        %w(rewrite r301 r302).each do |meth|
+          define_method(meth) do |from, to|
+            @rules << [meth.to_sym, from, to]
+          end
+        end
+    end
+  end
+end

data/rack-rewrite.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-rewrite}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Trupiano"]
+  s.date = %q{2009-10-10}
+  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"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rack-rewrite.rb",
+     "rack-rewrite.gemspec",
+     "test/rack-rewrite_test.rb",
+     "test/test_helper.rb"
+  ]
+  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.rubygems_version = %q{1.3.5}
+  s.summary = %q{A rack middleware for enforcing rewrite rules}
+  s.test_files = [
+    "test/rack-rewrite_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end

data/test/rack-rewrite_test.rb

@@ -0,0 +1,88 @@
+require 'test_helper'
+
+class RackRewriteTest < Test::Unit::TestCase
+
+  def call_args(overrides={})
+    {'PATH_INFO' => '/wiki/Yair_Flicker'}.merge(overrides)
+  end
+  
+  def self.should_not_halt
+    should "not halt the rack chain" do
+      @app.expects(:call).once
+      @rack.call(call_args)
+    end
+  end
+  
+  def self.should_be_a_rack_response
+    should 'be a rack a response' do
+      ret = @rack.call(call_args)
+      assert ret.is_a?(Array), 'return value is not a valid rack response'
+      assert_equal 3, ret.size, 'should have 3 arguments'
+    end
+  end
+  
+  def self.should_halt
+    should "should halt the rack chain" do
+      @app.expects(:call).never
+      @rack.call(call_args)
+    end
+    should_be_a_rack_response
+  end
+      
+  def self.should_location_redirect_to(location, code)
+    should "respond with http status code #{code}" do
+      ret = @rack.call(call_args)
+      assert_equal code, ret[0]
+    end
+    should 'send a location header' do
+      ret = @rack.call(call_args)
+      assert_equal location, ret[1]['Location'], 'Location is incorrect'
+    end
+  end
+  
+  context 'Given an app' do
+    setup do
+      @app = Class.new { def call; true; end }.new
+    end
+  
+    context 'when no rewrite rule matches' do
+      setup {
+        @rack = Rack::Rewrite.new(@app)
+      }
+      should_not_halt
+    end
+    
+    context 'when a 301 rule matches' do
+      setup {
+        @rack = Rack::Rewrite.new(@app) do
+          r301 '/wiki/Yair_Flicker', '/yair'
+        end
+      }
+      should_halt
+      should_location_redirect_to('/yair', 301)
+    end
+    
+    context 'when a 302 rule matches' do
+      setup {
+        @rack = Rack::Rewrite.new(@app) do
+          r302 '/wiki/Yair_Flicker', '/yair'
+        end
+      }
+      should_halt
+      should_location_redirect_to('/yair', 302)
+    end
+    
+    context 'when a rewrite rule matches' do
+      setup {
+        @rack = Rack::Rewrite.new(@app) do
+          rewrite '/wiki/Yair_Flicker', '/john'
+        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)
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+gem 'shoulda', '~> 2.10.2'
+require 'shoulda'
+gem 'mocha', '~> 0.9.7'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rack-rewrite'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: rack-rewrite
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- John Trupiano
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-10 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A rack middleware for enforcing rewrite rules. In many cases you can get away with rack-rewrite instead of writing Apache mod_rewrite rules.
+email: jtrupiano@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack-rewrite.rb
+- rack-rewrite.gemspec
+- test/rack-rewrite_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jtrupiano/rack-rewrite
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: rack-rewrite
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A rack middleware for enforcing rewrite rules
+test_files: 
+- test/rack-rewrite_test.rb
+- test/test_helper.rb