krider2010 / friendly_id

FriendlyId is the “Swiss Army bulldozer” of slugging and permalink plugins for ActiveRecord. It allows you to create pretty URL’s and work with human-friendly strings as if they were numeric ids for ActiveRecord models.

FriendlyId

FriendlyId is the "Swiss Army bulldozer" of slugging and permalink plugins for Ruby on Rails. It allows you to create pretty URL's and work with human-friendly strings as if they were numeric ids for Active Record models.

Using FriendlyId, it's easy to make your application use URL's like:

http://example.com/states/washington

instead of:

http://example.com/states/4323454

FriendlyId Features

FriendlyId offers many advanced features, including: slug history and versioning, scoped slugs, reserved words, custom slug generators, and excellent Unicode support. For complete information on using FriendlyId, please see the FriendlyId Guide.

FriendlyId is compatible with Active Record 2.3.x and 3.0.

Docs, Info and Support

• FriendlyId Guide
• API Docs
• Google Group
• Source Code
• Issue Tracker

Rails Quickstart

gem install friendly_id

rails new my_app

cd my_app

# add to Gemfile
gem "friendly_id", "~> 3.1"

rails generate friendly_id
rails generate scaffold user name:string cached_slug:string

rake db:migrate

# edit app/models/user.rb
class User < ActiveRecord::Base
  has_friendly_id :name, :use_slug => true
end

User.create! :name => "Joe Schmoe"

rails server

GET http://0.0.0.0:3000/users/joe-schmoe

Sequel and DataMapper, too

FriendlyId has experimental support for Sequel. Support for Datamapper is in progress. To find out more, check out the Github projects:

• http://github.com/norman/friendly_id_sequel
• http://github.com/myabc/friendly_id_datamapper

Bugs

Please report them on the Github issue tracker for this project.

If you have a bug to report, please include the following information:

• Version information for FriendlyId, Rails and Ruby.
• Stack trace and error message.
• Any snippets of relevant model, view or controller code that shows how your are using FriendlyId.

If you are able to, it helps even more if you can fork FriendlyId on Github, and add a test that reproduces the error you are experiencing.

Credits

FriendlyId was created by Norman Clarke, Adrian Mugnolo, and Emilio Tagua.

If you like FriendlyId, please recommend us on Working With Rails:

• http://bit.ly/recommend-norman
• http://bit.ly/recommend-emilio
• http://bit.ly/recommend-adrian

Thanks!

Copyright (c) 2008-2010, released under the MIT license.