public
Description: Find_by_param is a nice and easy way to handle permalinks and dealing with searching for to_param values
Clone URL: git://github.com/bumi/find_by_param.git
Click here to lend your support to: find_by_param and make a donation at www.pledgie.com !
name age message
file MIT-LICENSE Sat Aug 16 16:44:53 -0700 2008 remove multiple dashes in escaped URL [bumi]
file README Tue Mar 25 07:15:37 -0700 2008 inital commit [bumi]
file Rakefile Tue Mar 25 07:15:37 -0700 2008 inital commit [bumi]
file init.rb Tue Mar 25 07:15:37 -0700 2008 inital commit [bumi]
file install.rb Tue Mar 25 07:15:37 -0700 2008 inital commit [bumi]
directory lib/ Sun Aug 24 17:34:06 -0700 2008 use instance level escape method that can easil... [bumi]
directory tasks/ Tue Mar 25 07:15:37 -0700 2008 inital commit [bumi]
directory test/ Fri Jun 13 07:53:43 -0700 2008 added option to truncate param to a specific size [bumi]
file uninstall.rb Tue Mar 25 07:15:37 -0700 2008 inital commit [bumi]
README
FindByParam
===========

Find_by_param helps you dealing with permalinks and finding objects by our permalink value

class Post < ActiveRecord:Base
 make_permalink :with => :title
end

now you can do Post.find_by_param(...)

If you have a permalink-column find_by_param saves the permalink there and uses that otherwise it just uses the provided 
attribute.


Example
===========

Post.create(:title => "hey ho let's go!").to_param #=> "hey-ho-lets-go"  (to_param is the method Rails calls to create 
the URL values)

Post.find_by_param("hey-ho-lets-go") #=> <Post>

Post.find_by_param("is-not-there") #=> nil
Post.find_by_param!("is-not-there") #=> raises ActiveRecord::RecordNotFound

examples:

make_permalink :with => :login
make_permalink :with => :title, :prepend_id=>true


options for make_permalink:

:with: (required) The attribute that should be used as permalink
:field: The name of your permalink column. make_permalink first checks if there is a column. 
:prepend_id: [true|false] Do you want to prepend the ID to the permalink? for URLs like: posts/123-my-post-title - 
find_by_param uses the ID column to search.
:escape: [true|false] Do you want to escape the permalink value? (strip chars like öä?&?) - actually you must do that




Issues
=======

* The database table must be created before you can use make_permalink
* write nice docs
* write nicer tests

Copyright (c) 2007 [Michael Bumann - Railslove.com], released under the MIT license