Sha256: a71c417d13e9dee660cce09658d2f3b3839f0c8853ddb5b9645572a06d9f6fb3

Contents?: true

Size: 1.43 KB

Versions: 5

Compression:

Stored size: 1.43 KB

Contents

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

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
spree-0.4.1 vendor/plugins/find_by_param/README
spree-0.4.0 vendor/plugins/find_by_param/README
spree-0.5.0 vendor/plugins/find_by_param/README
spree-0.5.1 vendor/plugins/find_by_param/README
spree-0.6.0 vendor/plugins/find_by_param/README