test/custom_slug_normalizer_test.rb test/models/thing.rb @@ -1,3 +1,8 @@ +== 2.0.4 2009-02-12 + +* 1 major enhancment: + * You can now pass in your own custom slug generation blocks while setting up friendly_id. + == 2.0.3 2009-02-11 * 1 minor enhancment: History.txt @@ -20,13 +20,18 @@ lib/friendly_id/sluggable_instance_methods.rb lib/friendly_id/version.rb lib/tasks/friendly_id.rake lib/tasks/friendly_id.rb +test/custom_slug_normalizer_test.rb +test/models/book.rb test/models/country.rb +test/models/novel.rb test/models/person.rb test/models/post.rb +test/models/thing.rb test/models/user.rb test/non_slugged_test.rb test/schema.rb test/scoped_model_test.rb test/slug_test.rb test/slugged_model_test.rb +test/sti_test.rb test/test_helper.rb Manifest.txt @@ -136,9 +136,13 @@ Here's how to do it: class Restaurant < ActiveRecord::Base belongs_to :city - has_friendly_id :name, :use_slug => true, :reserved => ["new", "index"] + has_friendly_id :name, :use_slug => true, :reserved => ["my", "values"] end +As of FriendlyId version 2.0.2, "new" and "index" are reseved by default. When +you attempt to store a reserved value, FriendlyId raises a +FriendlyId::SlugGenerationError. + === Scoped Slugs @@ -208,6 +212,33 @@ that uses a non-Roman writing system, your feedback would be most welcome. @post.friendly_id # "友好编号在中国" @post2 = Post.create(:title => "友好编号在中国") @post2.friendly_id # "友好编号在中国--2" + +=== Custom Slug Generation + +While FriendlyId's slug generation options work for most people, you may need +something else. As of version 2.0.4 you can pass in your own custom slug +generation block: + + require 'stringex' + class Post < ActiveRecord::Base + has_friendly_id :title, :use_slug => true do |text| + # User stringex to generate the friendly_id rather than the baked-in methods + text.to_url + end + end + + ... + + @post = Post.create(:title => "tell your readers 你好") + @post.friendly_id # "tell-your-readers-ni-hao" + +FriendlyId will still respect your settings for max length and reserved words, +but will use your block rather than the baked-in methods to normalize the +friendly_id text. + +(As an aside, the stringex[http://github.com/rsl/stringex/tree/master] library +provides some very cool slugging functionality and is a great option for +apps using FriendlyId in either English or Chinese. Definitely check it out.) == Getting it @@ -228,7 +259,7 @@ which FriendlyId depends on: == Setting it up -FriendlyId currently works with Rails 2.0.0 and higher. Here's how to set it up. +FriendlyId currently works with Rails 2.0.0 - 2.3.0. Here's how to set it up. 1) Install the Gem: @@ -267,7 +298,7 @@ rake:friendly_id:remove_old_slugs MODEL=MyModelName DAYS=60 == Upgrading from an older version -If you installed an older version of FriendlyId and want to upgrade to 2.0, +If you installed an older version of FriendlyId and want to upgrade to 2.0.x, follow these steps: ==== Install the friendly_id Gem: @@ -297,8 +328,6 @@ Add this to the bottom of environment.rb: ./script generate friendly_id_20_upgrade rake db:migrate -That's it! - == Hacking FriendlyId: FriendlyId is {hosted on Github}[git://github.com/norman/friendly_id.git], and README.rdoc @@ -42,3 +42,11 @@ def run_coverage(files) puts cmd sh cmd end + +desc 'Publish RDoc to RubyForge.' +task :publish_docs => [:clean, :docs] do + host = "compay@rubyforge.org" + remote_dir = "/var/www/gforge-projects/friendly-id" + local_dir = 'doc' + sh %{rsync -av --delete #{local_dir}/ #{host}:#{remote_dir}} +end \ No newline at end of file Rakefile @@ -2,15 +2,15 @@ Gem::Specification.new do |s| s.name = %q{friendly_id} - s.version = "2.0.3" + s.version = "2.0.4" s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= s.authors = ["Norman Clarke", "Adrian Mugnolo", "Emilio Tagua"] - s.date = %q{2009-02-11} + s.date = %q{2009-02-12} s.description = %q{A comprehensive slugging and pretty-URL plugin for ActiveRecord.} s.email = ["norman@randomba.org", "adrian@randomba.org", "miloops@gmail.com"] s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"] - s.files = ["History.txt", "MIT-LICENSE", "Manifest.txt", "README.rdoc", "Rakefile", "config/website.yml", "friendly_id.gemspec", "generators/friendly_id/friendly_id_generator.rb", "generators/friendly_id/templates/create_slugs.rb", "generators/friendly_id_20_upgrade/friendly_id_20_upgrade_generator.rb", "generators/friendly_id_20_upgrade/templates/upgrade_friendly_id_to_20.rb", "init.rb", "lib/friendly_id.rb", "lib/friendly_id/helpers.rb", "lib/friendly_id/non_sluggable_class_methods.rb", "lib/friendly_id/non_sluggable_instance_methods.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/tasks/friendly_id.rake", "lib/tasks/friendly_id.rb", "test/models/country.rb", "test/models/person.rb", "test/models/post.rb", "test/models/user.rb", "test/non_slugged_test.rb", "test/schema.rb", "test/scoped_model_test.rb", "test/slug_test.rb", "test/slugged_model_test.rb", "test/test_helper.rb"] + s.files = ["History.txt", "MIT-LICENSE", "Manifest.txt", "README.rdoc", "Rakefile", "config/website.yml", "friendly_id.gemspec", "generators/friendly_id/friendly_id_generator.rb", "generators/friendly_id/templates/create_slugs.rb", "generators/friendly_id_20_upgrade/friendly_id_20_upgrade_generator.rb", "generators/friendly_id_20_upgrade/templates/upgrade_friendly_id_to_20.rb", "init.rb", "lib/friendly_id.rb", "lib/friendly_id/helpers.rb", "lib/friendly_id/non_sluggable_class_methods.rb", "lib/friendly_id/non_sluggable_instance_methods.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/tasks/friendly_id.rake", "lib/tasks/friendly_id.rb", "test/custom_slug_normalizer_test.rb", "test/models/book.rb", "test/models/country.rb", "test/models/novel.rb", "test/models/person.rb", "test/models/post.rb", "test/models/thing.rb", "test/models/user.rb", "test/non_slugged_test.rb", "test/schema.rb", "test/scoped_model_test.rb", "test/slug_test.rb", "test/slugged_model_test.rb", "test/sti_test.rb", "test/test_helper.rb"] s.has_rdoc = true s.homepage = %q{http://friendly-id.rubyforge.org/} s.rdoc_options = ["--main", "README.rdoc"] @@ -18,7 +18,7 @@ Gem::Specification.new do |s| s.rubyforge_project = %q{friendly-id} s.rubygems_version = %q{1.3.1} s.summary = %q{A comprehensive slugging and pretty-URL plugin for ActiveRecord.} - s.test_files = ["test/non_slugged_test.rb", "test/scoped_model_test.rb", "test/slug_test.rb", "test/slugged_model_test.rb"] + s.test_files = ["test/custom_slug_normalizer_test.rb", "test/non_slugged_test.rb", "test/scoped_model_test.rb", "test/slug_test.rb", "test/slugged_model_test.rb", "test/sti_test.rb"] if s.respond_to? :specification_version then current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION friendly_id.gemspec @@ -14,7 +14,7 @@ module FriendlyId :strip_diacritics => false, :strip_non_ascii => false, :use_slug => false }.freeze - + # Valid keys for has_friendly_id options. VALID_FRIENDLY_ID_KEYS = [ :max_length, @@ -24,7 +24,7 @@ module FriendlyId :strip_diacritics, :strip_non_ascii, :use_slug ].freeze - + # This error is raised when it's not possible to generate a unique slug. class SlugGenerationError < StandardError ; end @@ -42,11 +42,12 @@ module FriendlyId # * <tt>:strip_non_ascii</tt> - Defaults to false. If true, it will all non-ascii ([^a-z0-9]) characters. # * <tt>:reserved</tt> - Array of words that are reserved and can't be used as friendly_id's. For sluggable models, if such a word is used, it will be treated the same as if that slug was already taken (numeric extension will be appended). Defaults to ["new", "index"]. # * <tt>:reserved_message</tt> - The validation message that will be shown when a reserved word is used as a frindly_id. Defaults to '"%s" is reserved'. - def has_friendly_id(column, options = {}) + def has_friendly_id(column, options = {}, &block) options.assert_valid_keys VALID_FRIENDLY_ID_KEYS options = DEFAULT_FRIENDLY_ID_OPTIONS.merge(options).merge(:column => column) write_inheritable_attribute :friendly_id_options, options class_inheritable_accessor :friendly_id_options + class_inheritable_reader :slug_normalizer_block if options[:use_slug] has_many :slugs, :order => 'id DESC', :as => :sluggable, :dependent => :destroy @@ -55,6 +56,9 @@ module FriendlyId extend SluggableClassMethods include SluggableInstanceMethods before_save :set_slug + if block_given? + write_inheritable_attribute :slug_normalizer_block, block + end else require 'friendly_id/non_sluggable_class_methods' require 'friendly_id/non_sluggable_instance_methods' @@ -63,7 +67,7 @@ module FriendlyId validate_on_create :validate_friendly_id end end - + end class << self lib/friendly_id.rb @@ -1,7 +1,7 @@ module FriendlyId::SluggableClassMethods include FriendlyId::Helpers - + def self.extended(base) #:nodoc:# class << base lib/friendly_id/sluggable_class_methods.rb @@ -56,13 +56,17 @@ module FriendlyId::SluggableInstanceMethods # Get the processed string used as the basis of the friendly id. def slug_text base = send friendly_id_options[:column] - if self.friendly_id_options[:strip_diacritics] - base = Slug::strip_diacritics(base) - end - if self.friendly_id_options[:strip_non_ascii] - base = Slug::strip_non_ascii(base) + if self.slug_normalizer_block + base = self.slug_normalizer_block.call(base) + else + if self.friendly_id_options[:strip_diacritics] + base = Slug::strip_diacritics(base) + end + if self.friendly_id_options[:strip_non_ascii] + base = Slug::strip_non_ascii(base) + end + base = Slug::normalize(base) end - base = Slug::normalize(base) if base.length > friendly_id_options[:max_length] base = base[0...friendly_id_options[:max_length]] lib/friendly_id/sluggable_instance_methods.rb @@ -2,7 +2,7 @@ module FriendlyId #:nodoc: module Version #:nodoc: MAJOR = 2 MINOR = 0 - TINY = 3 + TINY = 4 STRING = [MAJOR, MINOR, TINY].join('.') end end \ No newline at end of file lib/friendly_id/version.rb @@ -1,10 +1,14 @@ ActiveRecord::Schema.define(:version => 1) do - + create_table "books", :force => true do |t| t.column "title", "string" t.column "type", "text" end + create_table "things", :force => true do |t| + t.column "name", "string" + end + create_table "posts", :force => true do |t| t.column "title", "string" t.column "content", "text" @@ -18,12 +22,12 @@ ActiveRecord::Schema.define(:version => 1) do t.column "created_at", "datetime" t.column "updated_at", "datetime" end - + create_table "people", :force => true do |t| t.column "name", "string" t.column "country_id", "integer" end - + create_table "countries", :force => true do |t| t.column "name", "string" end test/schema.rb @@ -18,6 +18,7 @@ require 'models/user' require 'models/country' require 'models/book' require 'models/novel' +require 'models/thing' # Borrowed from ActiveSupport def silence_stream(stream) test/test_helper.rb 50a75b9f9eec615c2ad6517f4d928d0ba98b5fcf Norman Clarke norman@randomba.org http://github.com/norman/friendly_id/commit/650e80fa1d992282b0307333664d89b495cbbbb3 650e80fa1d992282b0307333664d89b495cbbbb3 2009-02-12T07:18:09-08:00 2009-02-12T07:18:09-08:00 Added ability to use custom slug generation code by passing a block parameter to has_friendly_id. Resolves Lighthouse ticket #20. a4b5138c1846db36562b115a66e083d58d4b20f6 Norman Clarke norman@randomba.org