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:
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 3.3.0 is compatible with Active Record 3.0 and 3.1.
If you are still on Rails 2.3, please use FriendlyId 3.2.x.
FriendlyId 3.3 is now in long term maintenance mode. It will continue to be supported and maintained indefinitely, but no new features will be added to it.
FriendlyId 4.0 is a ground-up rewrite of FriendlyId, and is the project's future, and will be released by September, 2011.
Docs, Info and Support
gem install friendly_id rails new my_app cd my_app # add to Gemfile gem "friendly_id", "~> 3.3.0" 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
Norman Clarke maintains an implementation of FriendlyId forSequel with some of the features of the Active Record version.
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.
FriendlyId was created by Norman Clarke, Adrian Mugnolo, and Emilio Tagua.
If you like FriendlyId, please recommend us on Working With Rails:
Copyright (c) 2008-2010, released under the MIT license.