public
Description: Create SEO friendly names for a model automatically
Homepage:
Clone URL: git://github.com/revolutionhealth/acts_as_seo_friendly.git
Thu May 14 06:47:55 -0700 2009
commit  3dca738d5f056a133843c79363907d31066a9103
tree    0e1c80f0f65479c5b31c42f459f5ccc33c49357a
parent  f91b25b55531d286b27b03675ce22fa134250514
name age message
file .gitignore Mon Jun 23 10:15:10 -0700 2008 updated to use newgem 0.25.0 to make our gems u... [Jeffrey Damick]
file History.txt Thu Dec 11 10:39:03 -0800 2008 Updated gem version [Michael Chen]
file LICENSE Mon Jun 23 10:15:10 -0700 2008 updated to use newgem 0.25.0 to make our gems u... [Jeffrey Damick]
file Manifest.txt Mon Jun 16 09:18:07 -0700 2008 updated documents and manifest files [Jeffrey Damick]
file PostInstall.txt Mon Jun 16 09:18:07 -0700 2008 updated documents and manifest files [Jeffrey Damick]
file README Mon Jun 23 10:15:10 -0700 2008 updated to use newgem 0.25.0 to make our gems u... [Jeffrey Damick]
file Rakefile Mon Jun 23 10:15:10 -0700 2008 updated to use newgem 0.25.0 to make our gems u... [Jeffrey Damick]
file TODO Mon Jun 23 10:15:10 -0700 2008 updated to use newgem 0.25.0 to make our gems u... [Jeffrey Damick]
file acts_as_seo_friendly.gemspec Thu May 14 06:47:55 -0700 2009 update gemspec Signed-off-by: Revolution Health... [revolutionhealth]
directory lib/ Thu May 14 06:13:08 -0700 2009 added ability to do seo calculation before a sa... [revolutionhealth]
directory script/ Mon Jun 16 08:59:39 -0700 2008 initial checkin [Jeffrey Damick]
file setup.rb Mon Jun 16 08:59:39 -0700 2008 initial checkin [Jeffrey Damick]
directory tasks/ Mon Jun 16 08:59:39 -0700 2008 initial checkin [Jeffrey Damick]
directory test/ Thu Dec 11 09:14:46 -0800 2008 Added missing files from previous check in [Michael Chen]
directory website/ Mon Jun 16 08:59:39 -0700 2008 initial checkin [Jeffrey Damick]
README
= acts_as_seo_friendly

http://revolutiononrails.blogspot.com/

== DESCRIPTION:

Create an SEO friendly field for a model automatically based on a given field.

So if you have a Blogs model, and you would like create an SEO friendly version 
of the 'title' field, you would just add this to your model and then be able to 
use the SEO friendly id as the unique id to the resource.  The plugin will only
append an integer to the SEO id if there is a collision.

== FEATURES/PROBLEMS:

* Only tested on mysql and sqlite3


== SYNOPSIS:


Create seo column migration:

 class CreateSeoTestModels < ActiveRecord::Migration
   def self.up
     create_table :seo_test_models do |t|
       t.string :name
       t.timestamps
     end
   SeoTestModel.create_seo_friendly_column()
   end

   def self.down
   SeoTestModel.drop_seo_friendly_column()
     drop_table :seo_test_models
   end
 end


Add to model:

 class SeoTestModel < ActiveRecord::Base
  acts_as_seo_friendly :resource_id => :name, 
               :seo_friendly_id_field => :seo_id, # default is :seo_friendly_id
               :seo_friendly_id_limit => 100 # default is 50
 end


To lookup the resource in the controllers use:

  SeoTestModel.find_by_seo_id(params[:id])



== REQUIREMENTS:


== INSTALL:

* sudo gem install revolutionhealth-acts_as_seo_friendly -s http://gems.github.com


== LICENSE:

(The MIT License)

Copyright (c) 2008 Revolution Health Group LLC

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.