seamusabshere-redirect_routing 0.0.3

data/README

@@ -0,0 +1,64 @@
+RedirectRouting
+===============
+
+Forked by Seamus Abshere (seamus@abshere.net)
+
+Note: you may have to put
+
+    ActionController::Routing::RouteSet::Mapper.send :include, RedirectRouting::Routes
+
+at the top of config/routes.rb.
+
+This plugin lets you do simple redirects straight from your routes.rb file:
+
+    map.redirect '', :controller => 'events'
+
+This will make the root of your site redirect to the events controller, typically at /events.
+
+You can redirect any URL to any set of options, or event a string URL, like this:
+
+    map.redirect 'test', 'http://example.com'
+    
+GET /test, and you'll be redirected to my blog.
+
+You can also set the status to be a 301 permanent redirect instead of a temporary 302:
+
+    map.redirect 'oldurl', 'newurl', :permament => true
+    map.redirect 'oldurl', :controller => 'new_controller', :action => 'new_action', :permament => true
+
+Finally you can preserve wildcard paths
+
+    map.redirect 'festivals/*path', 'http://example.com/events/festivals', :keep_path => :path
+    map.redirect 'news/*articles', 'http://blog.example.com', :keep_path => :articles
+
+Motivation
+----------
+
+Why this plugin? 
+
+Because if Rails Routing is supposed to be a Ruby replacement for mod_rewrite, then at least some redirect capability is called for.
+
+But more concretely, because there's no good alternative unless you're using Apache. The alternative options that I've been able to figure out are:
+
+* Configure your web server to do the redirect for you, which is trivial with mod_rewrite in Apache, but not so trivial with Mongrel, or
+* Manually create a controller for the sole purpose of redirecting, or
+* Tack the redirect onto another controller, which isn't very RESTful
+
+If there's demand, I'll add a switch for a permanent redirect, but I don't have the need yet.
+
+If you know of a simpler way to do this, please let me know.
+
+Credits
+-------
+
+Written by Lars Pind
+
+http://pinds.com
+
+Changelog
+---------
+
+* Added :keep_path options [Seamus Abshere & Manfred Stienstra]
+* Updated to Rails Edge [Manfred Stienstra]
+* Support for 301 redirects [Gioele Barabucci]
+* Silence warning about missing helper [Tim Connor]

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the test plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the test plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Test'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |spec|
+    spec.name = "redirect_routing"
+
+    spec.author = "Manfred Stienstra"
+    spec.email = "manfred@fngtps.com"
+
+    spec.description = <<-EOF
+      simple redirects straight from your routes.rb file
+    EOF
+    spec.summary = <<-EOF
+      simple redirects straight from your routes.rb file
+    EOF
+    spec.homepage = "http://github.com/seamusabshere/redirect_routing/tree/master"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 0
+:patch: 3

data/lib/redirect_routing.rb

@@ -0,0 +1,3 @@
+require 'redirect_routing/routes'
+require 'redirect_routing_controller'
+require 'redirect_routing_helper'

data/lib/redirect_routing/routes.rb

@@ -0,0 +1,7 @@
+module RedirectRouting
+  module Routes
+    def redirect(path, *args)
+      connect path, :controller => "redirect_routing", :action => "redirect", :args => args
+    end
+  end
+end

data/lib/redirect_routing_controller.rb

@@ -0,0 +1,16 @@
+class RedirectRoutingController < ActionController::Base
+  def redirect
+    options = params[:args].extract_options!
+    status = options.delete(:permanent) == true ? :moved_permanently : :found
+    url_options = params[:args].first || options
+    
+    if path_to_keep = options[:keep_path] and !params[path_to_keep].blank?
+      raise ArgumentError, "Redirect target should be a String when using the :keep_path option" unless url_options.is_a?(String)
+      parsed_url = URI.parse(url_options)
+      parsed_url.path = ([parsed_url.path] + params[path_to_keep]).join('/')
+      url_options = parsed_url.to_s
+    end
+    
+    redirect_to url_options, :status => status
+  end
+end

data/lib/redirect_routing_helper.rb

@@ -0,0 +1,2 @@
+module RedirectRoutingHelper
+end

data/test/redirect_routing_test.rb

@@ -0,0 +1,91 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class EventsController < ActionController::Base
+end
+ActionController::Routing::Routes.add_route('/:controller/:action/:id')
+
+class RedirectRoutingTest < TestCase
+  tests RedirectRoutingController
+  
+  def setup
+    @controller = RedirectRoutingController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+  end
+
+  def test_redirect_routes
+    with_routing do |set|
+      set.draw do |map|
+        map.redirect '',                 :controller => 'events'
+        map.redirect 'test',             'http://example.com'
+        map.redirect 'oldurl', 'newurl', :permanent => true
+        map.redirect 'festivals/*path',  'http://example.com/events/festivals', :keep_path => :path
+      end
+      
+      assert_recognizes({ :controller => "redirect_routing", :action => "redirect", :args => [{ 'controller' => "events" }] }, "/")
+      assert_recognizes({ :controller => "redirect_routing", :action => "redirect", :args => ["http://example.com"] }, "/test")
+      assert_recognizes({ :controller => "redirect_routing", :action => "redirect", :args => ["newurl", {'permanent' => true}] }, "/oldurl")
+      assert_recognizes({ :controller => "redirect_routing", :action => "redirect", :args => ["http://example.com/events/festivals", {'keep_path' => :path}], :path => ['music', 'recent'] }, "/festivals/music/recent")
+    end
+  end
+  
+  def test_redirect_controller_with_hash
+    get :redirect, :args => [{ :controller => "events" }]
+    assert_redirected_to :controller => "events"
+    assert_response 302
+  end
+  
+  def test_redirect_controller_with_string
+    get :redirect, :args => ["http://example.com"]
+    assert_redirected_to "http://example.com"
+    assert_response 302
+  end
+  
+  def test_permanent_redirect_controller_with_hash
+    get :redirect, :args => [{ :controller => "events", :permanent => true }]
+    assert_redirected_to :controller => "events"
+    assert_response 301
+  end
+  
+  def test_permanent_redirect_controller_with_string
+    get :redirect, :args => ["http://example.com", { :permanent => true }]
+    assert_redirected_to "http://example.com"
+    assert_response 301
+  end
+  
+  def test_redirect_controller_with_hash_and_append_path
+    assert_raises(ArgumentError) do
+      get :redirect, :args => [{ :controller => "events", :keep_path => :path }], :path => [ "festivals/recent" ]
+    end
+  end
+  
+  def test_redirect_controller_with_string_and_append_path
+    get :redirect, :args => ["http://example.com", { :keep_path => :path }], :path => [ "festivals/recent" ]
+    assert_redirected_to "http://example.com/festivals/recent"
+    assert_response 302
+  end
+  
+  def test_redirect_controller_with_string_and_append_path_array
+    get :redirect, :args => ["http://example.com", { :keep_path => :path }], :path => [ "festivals", "recent" ]
+    assert_redirected_to "http://example.com/festivals/recent"
+    assert_response 302
+  end
+  
+  def test_permanent_redirect_controller_with_hash_and_append_path
+    assert_raises(ArgumentError) do
+      get :redirect, :args => [{ :controller => "events", :permanent => true, :keep_path => :path }], :path => [ "festivals/recent" ]
+    end
+  end
+  
+  def test_permanent_redirect_controller_with_string_and_append_path
+    get :redirect, :args => ["http://example.com", { :permanent => true, :keep_path => :path }], :path => [ "festivals/recent" ]
+    assert_redirected_to "http://example.com/festivals/recent"
+    assert_response 301
+  end
+  
+  def test_redirect_normally_when_the_path_to_keep_is_blank
+    get :redirect, :args => ["http://example.com", { :keep_path => :unknown }], :path => [ "festivals/recent" ]
+    assert_redirected_to "http://example.com"
+    assert_response 302
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,27 @@
+ENV['RAILS_ENV'] = "test"
+
+rails_vendor_path = File.expand_path('../../../vendor/rails')
+if File.exist?(rails_vendor_path)
+  $:.concat([
+    File.join(rails_vendor_path, 'activesupport', 'lib'),
+    File.join(rails_vendor_path, 'actionpack', 'lib')
+  ])
+  require 'active_support'
+  require 'action_controller'
+  require 'action_controller/test_process'
+else
+  puts "\n[!] Tests only run when the plugin is installed in the plugins directory, running the tests against anything other than your particular Rails version doesn't really serve a purpose."
+  exit -1
+end
+
+require 'test/unit'
+
+begin
+  TestCase = ActionController::TestCase
+rescue NameError
+  TestCase = Test::Unit::TestCase
+end
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'init'
+

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: seamusabshere-redirect_routing
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Manfred Stienstra
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-07 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: simple redirects straight from your routes.rb file
+email: manfred@fngtps.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- Rakefile
+- VERSION.yml
+- lib/redirect_routing.rb
+- lib/redirect_routing/routes.rb
+- lib/redirect_routing_controller.rb
+- lib/redirect_routing_helper.rb
+- test/redirect_routing_test.rb
+- test/test_helper.rb
+- README
+has_rdoc: true
+homepage: http://github.com/seamusabshere/redirect_routing/tree/master
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: simple redirects straight from your routes.rb file
+test_files: 
+- test/redirect_routing_test.rb
+- test/test_helper.rb