generators/friendly_id/friendly_id_generator.rb generators/friendly_id/templates/create_slugs.rb init.rb lib/friendly_id/slug.rb @@ -6,25 +6,27 @@ Rakefile coverage/index.html coverage/lib-friendly_id-non_sluggable_class_methods_rb.html coverage/lib-friendly_id-non_sluggable_instance_methods_rb.html +coverage/lib-friendly_id-shoulda_macros_rb.html coverage/lib-friendly_id-sluggable_class_methods_rb.html coverage/lib-friendly_id-sluggable_instance_methods_rb.html coverage/lib-friendly_id-string_helpers_rb.html coverage/lib-friendly_id_rb.html coverage/lib-slug_rb.html coverage/rails-init_rb.html -generators/friendly_id_migration/friendly_id_migration_generator.rb -generators/friendly_id_migration/templates/create_slugs.rb +friendly_id.gemspec +generators/friendly_id/friendly_id_generator.rb +generators/friendly_id/templates/create_slugs.rb +init.rb lib/friendly_id.rb lib/friendly_id/non_sluggable_class_methods.rb lib/friendly_id/non_sluggable_instance_methods.rb lib/friendly_id/shoulda_macros.rb +lib/friendly_id/slug.rb lib/friendly_id/sluggable_class_methods.rb lib/friendly_id/sluggable_instance_methods.rb lib/friendly_id/version.rb -lib/slug.rb lib/tasks/friendly_id.rake lib/tasks/friendly_id.rb -rails/init.rb test/database.yml test/fixtures/countries.yml test/fixtures/country.rb Manifest.txt @@ -197,27 +197,30 @@ discouraged: == Setting it up -FriendlyId currently works with Rails 2.0.0 and higher. +FriendlyId currently works with Rails 2.0.0 and higher. Here's how to set it up. -Here's how to set it up: +1) Install the Gem: sudo gem install friendly-id cd my_app script/generate friendly_id rake db:migrate -Now add the following 2 lines to bottom of your Rakefile: +2) Load FriendlyId in your app: + # Rails 2.1 and higher; add this to the gem section of environment.rb: + config.gem "friendly_id" + + # Rails 2.0; this goes at the bottom of environment.rb require 'friendly_id' - require 'tasks/friendly_id' -Now add some code to your models: +3) Add some code to your models: class Post < ActiveRecord::Base has_friendly_id :title, :use_slug => true end -If you are using slugs, you can use a Rake task to generate slugs for your +4) If you are using slugs, you can use a Rake task to generate slugs for your existing records: friendly_id:make_slugs MODEL=MyModelName @@ -231,14 +234,6 @@ The default is to remove dead slugs older than 45 days, but is configurable: rake:friendly_id:remove_old_slugs MODEL=MyModelName DAYS=60 -Note that having to explicitly add the friendly_id rake tasks to the Rakefile -is a pain in the ass. This is because Rails does not have any provisions for -accessing rake tasks from Gem plugins - even though it can do this for -generators. There is {a ticket sitting waiting on -Lighthouse}[http://rails.lighthouseapp.com/projects/8994/tickets/59] since -April of 2008 asking the Rails team to fix this, but it appears no agreement -can be reached on how to proceed and so we still don't have this functionality -as of December 2008. == Hacking FriendlyId: README.rdoc @@ -1,4 +1,5 @@ require 'unicode' +require 'friendly_id/slug' require 'friendly_id/shoulda_macros' # FriendlyId is a comprehensize Rails plugin/gem for slugging and permalinks. lib/friendly_id.rb @@ -4,4 +4,4 @@ end require File.join(File.dirname(__FILE__), 'boot') Rails::Initializer.run ActiveRecord::Base.colorize_logging = false -require File.dirname(__FILE__) + '/../../../../rails/init.rb' \ No newline at end of file +require File.dirname(__FILE__) + '/../../../../init.rb' \ No newline at end of file test/rails/2.x/config/environment.rb @@ -9,7 +9,7 @@ require 'test/unit' require 'active_record/fixtures' require 'action_controller/test_process' require 'sqlite3' -require 'slug' +require 'friendly_id/slug' config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml')) ActiveRecord::Base.establish_connection test/test_helper.rb generators/friendly_id_migration/friendly_id_migration_generator.rb generators/friendly_id_migration/templates/create_slugs.rb lib/slug.rb rails/init.rb 2981801a2233157cd1009a7f4b22fba16f944cb1 Norman Clarke norman@randomba.org http://github.com/nofxx/friendly_id/commit/5ef48c140dd39f4f7c171eaa213037712eeec419 5ef48c140dd39f4f7c171eaa213037712eeec419 2008-12-16T12:09:57-08:00 2008-12-16T11:37:22-08:00 Renamed generator and made it add FriendlyId's Rake task. Tweaked init and require statement for slug.rb to make it work in both plugin and Gem contexts. ceb11f14c4f79da3c33f3293b5cc0f65c112b40b Norman Clarke norman@randomba.org