handler301 0.2.0

data/CHANGELOG.rdoc

@@ -0,0 +1,7 @@
+0.2.0 (Apr 12, 2010)
+
+* Releasing gem
+
+0.1.0 (Apr 8, 2010)
+
+* Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Guillaume Luccisano - g-mai|: guillaume.luccisano
+
+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,47 @@
+= Handler 301
+
+Handler 301 is a plugin for Ruby on Rails that lets you easily manage 301 redirections in on place in order to redirect them to current named routes.
+
+All necessary informations are available on the wiki : http://wiki.github.com/kwi/handler301
+
+== Configuration example :
+
+In the config/handler301.yml of your rails app :
+
+  "old_url.html": home_path
+  "old_url_without_path.html": home
+  "product_number_one.html": products_path :id => 1
+
+Then, configure a controller that match non matching routes in your config/routes.rb
+
+==== Rails2
+
+  ActionController::Routing::Routes.draw  do |map|
+    map.connect "*path", :controller => 'error', :action => 'handle404'
+  end
+
+==== Rails3
+
+  MkdBaseApp::Application.routes.draw do
+    match "*path" => 'error#handle404'
+  end
+  
+And finally, in your ErrorController (or whatever the name of your non matching routes controller) :
+
+
+  class ErrorController < ApplicationController
+    def handle404
+      unless handle_301(request.path, request.query_parameters)
+
+        # Do your stuff here
+
+      end
+    end
+  end
+  
+
+== TODO
+
+* Change for using Rails metal in order to speed up the mechanism
+
+Copyright (c) 2010 Guillaume Luccisano - g-mai|: guillaume.luccisano, released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the handler301 plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the handler301 plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Handler301'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'handler301'

data/lib/handler301.rb

@@ -0,0 +1,64 @@
+# encoding: utf8
+module Handler301
+  Hash301 = {}
+
+private
+  # Automatically add _path if not present
+  def handle_301_auto_add_path(path_name)
+    path_name =~ /(_path|_url)$/ ? path_name : "#{path_name}_path"
+  end
+
+public
+  # Handle 301 redirections 
+  # Make the redirection if an url match
+  # Return true if a redirection has been made
+  def handle_301(path, query_params = {})
+    return nil if !path
+    
+    path = path.gsub(/^\//, '').split('?', 2).first
+
+    if r = Hash301[path]
+      query_params.delete('action')
+      query_params.delete('controller')
+
+      redirect_path = nil
+      # Standard case, use the simple route name
+      if !r.index(' ')
+        redirect_path = self.send(handle_301_auto_add_path(r).to_sym, query_params)
+      else # Blank case / Works only with hashes
+
+        r = r.split(' ', 2)
+        rhash = r.last
+        rhash = "{#{rhash}}" unless rhash =~ /^\{.*\}$/
+
+        # Must do an eval here ?
+        hash = eval(rhash) rescue {}
+
+        redirect_path = send(handle_301_auto_add_path(r[0]).to_sym, hash.merge(query_params))
+      end
+
+      if redirect_path
+        redirect_to(redirect_path, :status => 301)
+        return true
+      end
+    end
+
+    # No redirection has been made
+    return nil
+  end
+  
+  def self.load_301_file(file)
+    h = YAML.load_file(file) rescue {}
+    puts "[Handler301] Error in loading '#{file}', this file is empty or not valid." if h.size == 0
+    Hash301.merge!(h)
+  end
+
+end
+
+# Load config 301 file
+if defined? Rails
+  Handler301::load_301_file('config/handler301.yml')
+end
+
+# Include 301 handler in ActionController base
+ActionController::Base.send :include, Handler301

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: handler301
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Guillaume Luccisano
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-12 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: "Handler 301 is a plugin for Ruby on Rails that lets you easily manage 301 redirections in on place in order to redirect them to current named routes. "
+email: guillaume.luccisano@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/handler301.rb
+- CHANGELOG.rdoc
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- init.rb
+has_rdoc: true
+homepage: http://github.com/kwi/handler301
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 4
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: handler301
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simple rails 301 redirection handler with a config file. Rework your url schema without being worry !
+test_files: []
+