friendly_id 2.2.2 → 2.2.3

data/History.txt

@@ -1,3 +1,11 @@
+== 2.2.3 2009-11-12
+
+* 4 minor enhancements:
+  * Fixed some issues with gem load order under 1.8.x (closes GH Issue #20)
+  * Made sure friendly_id generator makes a lib/tasks directory (Josh Nichols)
+  * Finders now accept instances of ActiveRecord::Base, matching AR's behavior (Josh Nichols)
+  * SlugGenerationError now raise when a blank value is passed to strip_diacritics
+
 == 2.2.2 2009-10-26
 
 * 1 minor enhancement:

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Norman Clarke and Adrian Mugnolo.
+Copyright (c) 2008 Norman Clarke, Adrian Mugnolo and Emilio Tagua.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.rdoc

@@ -343,10 +343,19 @@ we love pull requests. :-)
 Please report them on the {Github issue tracker}[http://github.com/norman/friendly_id/issues]
 for this project.
 
+If you have a bug to report, please include the following information:
+
+* Stack trace and error message.
+* Version information for FriendlyId, Rails and Ruby.
+* 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}[mailto:norman@randomba.org],
-{Adrian Mugnolo}[mailto:adrian@randomba.org], and {Emilio Tagua}[mailto:miloops@gmail.com].
+FriendlyId was created by {Norman Clarke}[mailto:norman@njclarke.com],
+{Adrian Mugnolo}[mailto:adrian@mugnolo.com], and {Emilio Tagua}[mailto:miloops@gmail.com].
 
 We are grateful for many contributions from the Ruby and Rails community, in
 particular from the following people:

data/Rakefile

@@ -9,7 +9,7 @@ Hoe.spec "friendly_id" do
   self.author = ['Norman Clarke', 'Adrian Mugnolo', 'Emilio Tagua']
   self.email = ['norman@njclarke.com', 'adrian@mugnolo.com', 'miloops@gmail.com']
   self.summary = "A comprehensive slugging and pretty-URL plugin for ActiveRecord."
-  self.description = 'A comprehensive slugging and pretty-URL plugin for ActiveRecord.'
+  self.description = 'A comprehensive slugging and pretty-URL plugin for Rails apps using ActiveRecord.'
   self.url = 'http://friendly-id.rubyforge.org/'
   self.test_globs = ['test/**/*_test.rb']
   self.extra_deps << ['activerecord', '>= 2.2.3']
@@ -17,7 +17,22 @@ Hoe.spec "friendly_id" do
   self.extra_dev_deps << ['newgem', ">= #{::Newgem::VERSION}"]
   self.extra_dev_deps << ['sqlite3-ruby']
   self.remote_rdoc_dir = ""
+	self.readme_file = "README.rdoc"
   self.extra_rdoc_files = ["README.rdoc"]
+  self.post_install_message = <<-EOM
+
+    ***********************************************************
+
+      If you are upgrading friendly_id, please run
+
+          ./script generate friendly_id --skip-migration
+
+      in your Rails application to ensure that you have the
+      latest friendly_id Rake tasks.
+
+    ***********************************************************
+
+  EOM
 end
 
 require 'newgem/tasks'

data/generators/friendly_id/friendly_id_generator.rb

@@ -1,12 +1,28 @@
 class FriendlyIdGenerator < Rails::Generator::Base
+
   def manifest
     record do |m|
       unless options[:skip_migration]
-        m.migration_template(
-          'create_slugs.rb', 'db/migrate', :migration_file_name => 'create_slugs'
-        )
+        m.migration_template('create_slugs.rb', 'db/migrate', :migration_file_name => 'create_slugs')
+      end
+      unless options[:skip_tasks]
+        m.directory "lib/tasks"
         m.file "/../../../lib/tasks/friendly_id.rake", "lib/tasks/friendly_id.rake"
       end
     end
   end
-end
+
+  protected
+
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("--skip-migration", "Don't generate a migration for the slugs table") do |value|
+      options[:skip_migration] = value
+    end
+    opt.on("--skip-tasks", "Don't add friendly_id Rake tasks to lib/tasks") do |value|
+      options[:skip_tasks] = value
+    end
+  end
+
+end

data/init.rb

@@ -1,3 +1 @@
-# encoding: utf-8
-
-require 'friendly_id'
+require "friendly_id"

data/lib/friendly_id.rb

@@ -1,115 +1,75 @@
-# encoding: utf-8
+require "friendly_id/helpers"
+require "friendly_id/slug"
+require "friendly_id/sluggable_class_methods"
+require "friendly_id/sluggable_instance_methods"
+require "friendly_id/non_sluggable_class_methods"
+require "friendly_id/non_sluggable_instance_methods"
 
-require 'friendly_id/helpers'
-require 'friendly_id/slug'
-
-# FriendlyId is a comprehensize Rails plugin/gem for slugging and permalinks.
+# FriendlyId is a comprehensive Ruby library for slugging and permalinks with
+# ActiveRecord.
 module FriendlyId
 
   # Default options for has_friendly_id.
-  DEFAULT_FRIENDLY_ID_OPTIONS = {
-    :max_length => 255,
-    :method => nil,
-    :reserved => ["new", "index"],
-    :reserved_message => 'can not be "%s"',
-    :cache_column => nil,
-    :scope => nil,
-    :strip_diacritics => false,
-    :strip_non_ascii => false,
-    :use_slug => false }.freeze
+  DEFAULT_OPTIONS = {
+    :max_length       => 255,
+    :reserved         => ["new", "index"],
+    :reserved_message => 'can not be "%s"'
+  }.freeze
 
-  # Valid keys for has_friendly_id options.
-  VALID_FRIENDLY_ID_KEYS = [
-    :max_length,
-    :reserved,
-    :reserved_message,
+  # The names of all valid configuration options.
+  VALID_OPTIONS = (DEFAULT_OPTIONS.keys + [
     :cache_column,
     :scope,
     :strip_diacritics,
-    :strip_non_ascii,
-    :use_slug ].freeze
+    :stip_non_ascii,
+    :use_slug
+  ]).freeze
 
   # This error is raised when it's not possible to generate a unique slug.
   class SlugGenerationError < StandardError ; end
 
-  module ClassMethods
-
-    # Set up an ActiveRecord model to use a friendly_id.
-    #
-    # The column argument can be one of your model's columns, or a method
-    # you use to generate the slug.
-    #
-    # Options:
-    # * <tt>:use_slug</tt> - Defaults to false. Use slugs when you want to use a non-unique text field for friendly ids.
-    # * <tt>:max_length</tt> - Defaults to 255. The maximum allowed length for a slug.
-    # * <tt>:cache_column</tt> - Defaults to nil. Use this column as a cache for generating to_param (experimental) Note that if you use this option, any calls to +attr_accessible+ must be made BEFORE any calls to has_friendly_id in your class.
-    # * <tt>:strip_diacritics</tt> - Defaults to false. If true, it will remove accents, umlauts, etc. from western characters.
-    # * <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 raise a FriendlyId::SlugGenerationError. 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'.
-    #
-    # You can also optionally pass a block if you want to use your own custom
-    # slugnormalization routines rather than the default ones that come with
-    # friendly_id:
-    #
-    #   require 'stringex'
-    #   class Post < ActiveRecord::Base
-    #     has_friendly_id :title, :use_slug => true do |text|
-    #       # Use stringex to generate the friendly_id rather than the baked-in methods
-    #       text.to_url
-    #     end
-    #   end
-    def has_friendly_id(column, options = {}, &block)
-      options.assert_valid_keys VALID_FRIENDLY_ID_KEYS
-      unless options.has_key?(:cache_column)
-        if columns.any? { |c| c.name == 'cached_slug' }
-          options[:use_slug] = true
-          options[:cache_column] = :cached_slug
-        end
-      end
-      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
-        require 'friendly_id/sluggable_class_methods'
-        require 'friendly_id/sluggable_instance_methods'
-        extend SluggableClassMethods
-        include SluggableInstanceMethods
-        before_save :set_slug
-        after_save :set_slug_cache
-        if block_given?
-          write_inheritable_attribute :slug_normalizer_block, block
-        end
-        if options[:cache_column]
-          # only protect the column if the class is not already using attributes_accessible
-          attr_protected options[:cache_column].to_sym unless accessible_attributes
-        end
-      else
-        require 'friendly_id/non_sluggable_class_methods'
-        require 'friendly_id/non_sluggable_instance_methods'
-        extend NonSluggableClassMethods
-        include NonSluggableInstanceMethods
-        validate :validate_friendly_id
-      end
-    end
-
-  end
-
-  class << self
-
-    # Load FriendlyId if the gem is included in a Rails app.
-    def enable
-      return if ActiveRecord::Base.methods.include? 'has_friendly_id'
-      ActiveRecord::Base.class_eval { extend FriendlyId::ClassMethods }
+  # Set up an ActiveRecord model to use a friendly_id.
+  #
+  # The column argument can be one of your model's columns, or a method
+  # you use to generate the slug.
+  #
+  # Options:
+  # * <tt>:use_slug</tt> - Defaults to nil. Use slugs when you want to use a non-unique text field for friendly ids.
+  # * <tt>:max_length</tt> - Defaults to 255. The maximum allowed length for a slug.
+  # * <tt>:cache_column</tt> - Defaults to nil. Use this column as a cache for generating to_param (experimental) Note that if you use this option, any calls to +attr_accessible+ must be made BEFORE any calls to has_friendly_id in your class.
+  # * <tt>:strip_diacritics</tt> - Defaults to nil. If true, it will remove accents, umlauts, etc. from western characters.
+  # * <tt>:strip_non_ascii</tt> - Defaults to nil. If true, it will remove all non-ASCII 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 raise a FriendlyId::SlugGenerationError. 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'.
+  #
+  # You can also optionally pass a block if you want to use your own custom
+  # slug normalization routines rather than the default ones that come with
+  # friendly_id:
+  #
+  #   require "stringex"
+  #   class Post < ActiveRecord::Base
+  #     has_friendly_id :title, :use_slug => true do |text|
+  #       # Use stringex to generate the friendly_id rather than the baked-in methods
+  #       text.to_url
+  #     end
+  #   end
+  def has_friendly_id(method, options = {}, &block)
+    options.assert_valid_keys VALID_OPTIONS
+    options = DEFAULT_OPTIONS.merge(options).merge(:method => method)
+    write_inheritable_attribute :friendly_id_options, options
+    class_inheritable_accessor :friendly_id_options
+    class_inheritable_reader :slug_normalizer_block
+    write_inheritable_attribute(:slug_normalizer_block, block) if block_given?
+    if friendly_id_options[:use_slug]
+      extend SluggableClassMethods
+      include SluggableInstanceMethods
+    else
+      extend NonSluggableClassMethods
+      include NonSluggableInstanceMethods
     end
-
   end
-
 end
 
-if defined?(ActiveRecord)
-  FriendlyId::enable
+class ActiveRecord::Base
+  extend FriendlyId
 end

data/lib/friendly_id/helpers.rb

@@ -1,7 +1,5 @@
-# encoding: utf-8
-
 module FriendlyId
-  
+
   module Helpers
     # Calculate expected result size for find_some_with_friendly (taken from
     # active_record/base.rb)
@@ -11,5 +9,4 @@ module FriendlyId
       size
     end
   end
-  
-end
+end

data/lib/friendly_id/non_sluggable_class_methods.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module FriendlyId::NonSluggableClassMethods
 
   include FriendlyId::Helpers
@@ -7,7 +5,7 @@ module FriendlyId::NonSluggableClassMethods
   protected
 
   def find_one(id, options) #:nodoc:#
-    if id.is_a?(String) && result = send("find_by_#{ friendly_id_options[:column] }", id, options)
+    if id.is_a?(String) && result = send("find_by_#{ friendly_id_options[:method] }", id, options)
       result.send(:found_using_friendly_id=, true)
     else
       result = super id, options
@@ -18,7 +16,7 @@ module FriendlyId::NonSluggableClassMethods
   def find_some(ids_and_names, options) #:nodoc:#
 
     results = with_scope :find => options do
-      find :all, :conditions => ["#{quoted_table_name}.#{primary_key} IN (?) OR #{friendly_id_options[:column].to_s} IN (?)",
+      find :all, :conditions => ["#{quoted_table_name}.#{primary_key} IN (?) OR #{friendly_id_options[:method].to_s} IN (?)",
         ids_and_names, ids_and_names]
     end
 
@@ -32,4 +30,4 @@ module FriendlyId::NonSluggableClassMethods
     results
 
   end
-end
+end

data/lib/friendly_id/non_sluggable_instance_methods.rb

@@ -1,7 +1,9 @@
-# encoding: utf-8
-
 module FriendlyId::NonSluggableInstanceMethods
 
+  def self.included(base)
+    base.validate :validate_friendly_id
+  end
+
   attr :found_using_friendly_id
 
   # Was the record found using one of its friendly ids?
@@ -17,7 +19,7 @@ module FriendlyId::NonSluggableInstanceMethods
 
   # Returns the friendly_id.
   def friendly_id
-    send friendly_id_options[:column]
+    send friendly_id_options[:method]
   end
   alias best_id friendly_id
 
@@ -27,10 +29,10 @@ module FriendlyId::NonSluggableInstanceMethods
   end
 
   private
-  
+
   def validate_friendly_id
     if self.class.friendly_id_options[:reserved].include? friendly_id
-      self.errors.add(self.class.friendly_id_options[:column],
+      self.errors.add(self.class.friendly_id_options[:method],
         self.class.friendly_id_options[:reserved_message] % friendly_id)
       return false
     end

data/lib/friendly_id/slug.rb

@@ -1,5 +1,3 @@
-#encoding: utf-8
-
 # A Slug is a unique, human-friendly identifier for an ActiveRecord.
 class Slug < ActiveRecord::Base
 
@@ -49,7 +47,7 @@ class Slug < ActiveRecord::Base
     # Remove diacritics (accents, umlauts, etc.) from the string. Borrowed
     # from "The Ruby Way."
     def strip_diacritics(string)
-      a = ActiveSupport::Multibyte.proxy_class.new(string).normalize(:kd) || ""
+      a = ActiveSupport::Multibyte.proxy_class.new(string || "").normalize(:kd)
       a.unpack('U*').inject([]) { |a, u|
         if ASCII_APPROXIMATIONS[u]
           a += ASCII_APPROXIMATIONS[u].unpack('U*')

data/lib/friendly_id/sluggable_class_methods.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module FriendlyId::SluggableClassMethods
 
   include FriendlyId::Helpers
@@ -8,7 +6,10 @@ module FriendlyId::SluggableClassMethods
   def find_one(id_or_name, options) #:nodoc:#
 
     scope = options.delete(:scope)
-    return super(id_or_name, options) if id_or_name.is_a?(Integer)
+
+    if id_or_name.is_a?(Integer) || id_or_name.kind_of?(ActiveRecord::Base)
+      return super(id_or_name, options)
+    end
 
     find_options = {:select => "#{self.table_name}.*"}
     find_options[:joins] = :slugs unless options[:include] && [*options[:include]].flatten.include?(:slugs)

data/lib/friendly_id/sluggable_instance_methods.rb

@@ -1,7 +1,20 @@
-# encoding: utf-8
-
 module FriendlyId::SluggableInstanceMethods
 
+  def self.included(base)
+    base.has_many :slugs, :order => 'id DESC', :as => :sluggable, :dependent => :destroy
+    base.before_save :set_slug
+    base.after_save :set_slug_cache
+    unless base.friendly_id_options[:cache_column]
+      if base.columns.any? { |c| c.name == 'cached_slug' }
+        base.friendly_id_options[:cache_column] = :cached_slug
+      end
+    end
+    # only protect the column if the class is not already using attributes_accessible
+    if base.friendly_id_options[:cache_column] && !base.accessible_attributes
+      base.attr_protected base.friendly_id_options[:cache_column].to_sym
+    end
+  end
+
   NUM_CHARS_RESERVED_FOR_FRIENDLY_ID_EXTENSION = 2
 
   attr :finder_slug
@@ -68,7 +81,7 @@ module FriendlyId::SluggableInstanceMethods
 
   # Get the processed string used as the basis of the friendly id.
   def slug_text
-    base = send friendly_id_options[:column]
+    base = send friendly_id_options[:method]
     if self.slug_normalizer_block
       base = self.slug_normalizer_block.call(base)
     else

data/lib/friendly_id/tasks.rb

@@ -5,8 +5,7 @@ module FriendlyId
       def make_slugs(klass, options = {})
         klass = parse_class_name(klass)
         validate_uses_slugs(klass)
-        options = {:limit => 100, :include => :slugs, :order => "#{klass.table_name}.id ASC",
-          :conditions => "slugs.id IS NULL"}.merge(options)
+        options = {:limit => 100, :include => :slugs, :conditions => "slugs.id IS NULL"}.merge(options)
         while records = klass.find(:all, options) do
           break if records.size == 0
           records.each do |r|

data/lib/friendly_id/version.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
-
 module FriendlyId #:nodoc:
   module Version #:nodoc:
     MAJOR = 2
     MINOR = 2
-    TINY = 2
+    TINY = 3
     STRING = [MAJOR, MINOR, TINY].join('.')
   end
 end

data/lib/tasks/friendly_id.rake

@@ -1,5 +1,3 @@
-require "friendly_id/tasks"
-
 namespace :friendly_id do
   desc "Make slugs for a model."
   task :make_slugs => :environment do

data/test/cached_slug_test.rb

@@ -36,9 +36,9 @@ class CachedSlugModelTest < Test::Unit::TestCase
     end
 
     should "cache the incremented sequence for duplicate slug names" do
-      @paris2 = City.create!(:name => "Paris")
-      assert_equal 2, @paris2.slug.sequence
-      assert_equal "paris--2", @paris2.my_slug
+      paris2 = City.create!(:name => "Paris")
+      assert_equal 2, paris2.slug.sequence
+      assert_equal "paris--2", paris2.my_slug
     end
 
     should "not update the cached slug column if it has not changed" do

data/test/custom_slug_normalizer_test.rb

@@ -7,7 +7,7 @@ class CustomSlugNormalizerTest < Test::Unit::TestCase
   context "A slugged model using a custom slug generator" do
 
     setup do
-      Thing.friendly_id_options = FriendlyId::DEFAULT_FRIENDLY_ID_OPTIONS.merge(:column => :name, :use_slug => true)
+      Thing.friendly_id_options = FriendlyId::DEFAULT_OPTIONS.merge(:method => :name, :use_slug => true)
     end
 
     teardown do
@@ -16,14 +16,14 @@ class CustomSlugNormalizerTest < Test::Unit::TestCase
     end
 
     should "invoke the block code" do
-      @thing = Thing.create!(:name => "test")
-      assert_equal "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3", @thing.friendly_id
+      thing = Thing.create!(:name => "test")
+      assert_equal "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3", thing.friendly_id
     end
 
     should "respect the max_length option" do
       Thing.friendly_id_options = Thing.friendly_id_options.merge(:max_length => 10)
-      @thing = Thing.create!(:name => "test")
-      assert_equal "a94a8fe5cc", @thing.friendly_id
+      thing = Thing.create!(:name => "test")
+      assert_equal "a94a8fe5cc", thing.friendly_id
     end
 
     should "respect the reserved option" do

data/test/models/district.rb

@@ -1,3 +1,3 @@
 class District < ActiveRecord::Base
-  has_friendly_id :name
+  has_friendly_id :name, :use_slug => true
 end

data/test/models/legacy_thing.rb

@@ -0,0 +1,4 @@
+class LegacyThing < ActiveRecord::Base
+  self.table_name = "legacy_table"
+  has_friendly_id :name, :use_slug => true
+end

data/test/non_slugged_test.rb

@@ -37,23 +37,23 @@ class NonSluggedTest < Test::Unit::TestCase
     end
 
     should "indicate if it was found by its friendly id" do
-      @user = User.find(@user.friendly_id)
-      assert @user.found_using_friendly_id?
+      user = User.find(@user.friendly_id)
+      assert user.found_using_friendly_id?
     end
 
     should "indicate if it was found by its numeric id" do
-      @user = User.find(@user.id)
-      assert @user.found_using_numeric_id?
+      user = User.find(@user.id)
+      assert user.found_using_numeric_id?
     end
 
     should "indicate if it has a better id" do
-      @user = User.find(@user.id)
-      assert @user.has_better_id?
+      user = User.find(@user.id)
+      assert user.has_better_id?
     end
 
     should "not validate if the friendly_id text is reserved" do
-      @user = User.new(:login => "new", :email => "test@example.org")
-      assert !@user.valid?
+      user = User.new(:login => "new", :email => "test@example.org")
+      assert !user.valid?
     end
 
     should "have always string for a friendly_id" do
@@ -89,9 +89,9 @@ class NonSluggedTest < Test::Unit::TestCase
       end
 
       should "indicate if the results were found using a friendly_id" do
-        @users = User.find([@user.id, @user2.friendly_id], :order => "login ASC")
-        assert @users[0].found_using_friendly_id?
-        assert @users[1].found_using_numeric_id?
+        users = User.find([@user.id, @user2.friendly_id], :order => "login ASC")
+        assert users[0].found_using_friendly_id?
+        assert users[1].found_using_numeric_id?
       end
 
     end

data/test/schema.rb

@@ -2,6 +2,10 @@
 
 ActiveRecord::Schema.define(:version => 1) do
 
+  create_table "legacy_table", :force => true do |t|
+    t.column "name", :string
+  end
+
   create_table "books", :force => true do |t|
     t.column "title", "string"
     t.column "type", "text"

data/test/slug_test.rb

@@ -12,11 +12,11 @@ class SlugTest < Test::Unit::TestCase
     end
 
     should "indicate if it is the most recent slug" do
-      @post = Post.create!(:title => "test title", :content => "test content")
-      @post.title = "a new title"
-      @post.save!
-      assert @post.slugs.last.is_most_recent?
-      assert !@post.slugs.first.is_most_recent?
+      post = Post.create!(:title => "test title", :content => "test content")
+      post.title = "a new title"
+      post.save!
+      assert post.slugs.last.is_most_recent?
+      assert !post.slugs.first.is_most_recent?
     end
 
   end

data/test/slugged_model_test.rb

@@ -7,7 +7,7 @@ class SluggedModelTest < Test::Unit::TestCase
   context "A slugged model with default FriendlyId options" do
 
     setup do
-      Post.friendly_id_options = FriendlyId::DEFAULT_FRIENDLY_ID_OPTIONS.merge(:column => :title, :use_slug => true)
+      Post.friendly_id_options = FriendlyId::DEFAULT_OPTIONS.merge(:method => :title, :use_slug => true)
       @post = Post.new :title => "Test post", :content => "Test content", :published => true
       @post.save!
     end
@@ -17,6 +17,7 @@ class SluggedModelTest < Test::Unit::TestCase
       Person.delete_all
       Slug.delete_all
       Thing.delete_all
+      LegacyThing.delete_all
     end
 
     should "have friendly_id options" do
@@ -39,6 +40,10 @@ class SluggedModelTest < Test::Unit::TestCase
       assert Post.find(@post.id.to_s)
     end
 
+    should "be findable by its instance" do
+      assert Post.find(@post)
+    end
+
     should "not be findable by its id if looking for something else" do
       assert_raises ActiveRecord::RecordNotFound do
         Post.find("#{@post.id}-i-dont-exists")
@@ -47,7 +52,7 @@ class SluggedModelTest < Test::Unit::TestCase
 
     should "generate slug text" do
       post = Post.new :title => "Test post", :content => "Test content"
-      assert_not_nil @post.slug_text
+      assert_not_nil post.slug_text
     end
 
     should "respect finder conditions" do
@@ -62,12 +67,18 @@ class SluggedModelTest < Test::Unit::TestCase
       end
     end
 
-    should "raise an error if the friendly_id text is blank" do
+    should "raise an error if the friendly_id text is an empty string" do
       assert_raises(FriendlyId::SlugGenerationError) do
         Post.create(:title => "")
       end
     end
 
+    should "raise an error if the friendly_id text is nil" do
+      assert_raises(FriendlyId::SlugGenerationError) do
+        Post.create(:title => nil)
+      end
+    end
+
     should "raise an error if the normalized friendly id becomes blank" do
       assert_raises(FriendlyId::SlugGenerationError) do
         post = Post.create!(:title => "-.-")
@@ -105,28 +116,28 @@ class SluggedModelTest < Test::Unit::TestCase
     end
 
     should "not strip diacritics" do
-      @post = Post.new(:title => "¡Feliz año!")
-      assert_match(/#{'ñ'}/, @post.slug_text)
+      post = Post.new(:title => "¡Feliz año!")
+      assert_match(/#{'ñ'}/, post.slug_text)
     end
 
     should "not convert to ASCII" do
-      @post = Post.new(:title => "katakana: ゲコゴサザシジ")
-      assert_equal "katakana-ゲコゴサザシジ", @post.slug_text
+      post = Post.new(:title => "katakana: ゲコゴサザシジ")
+      assert_equal "katakana-ゲコゴサザシジ", post.slug_text
     end
 
     should "allow the same friendly_id across models" do
-      @person = Person.create!(:name => @post.title)
-      assert_equal @person.friendly_id, @post.friendly_id
+      person = Person.create!(:name => @post.title)
+      assert_equal person.friendly_id, @post.friendly_id
     end
 
     should "truncate slug text longer than the max length" do
-      @post = Post.new(:title => "a" * (Post.friendly_id_options[:max_length] + 1))
-      assert_equal @post.slug_text.length, Post.friendly_id_options[:max_length]
+      post = Post.new(:title => "a" * (Post.friendly_id_options[:max_length] + 1))
+      assert_equal post.slug_text.length, Post.friendly_id_options[:max_length]
     end
 
     should "truncate slug in 'right way' when slug is unicode" do
-      @post = Post.new(:title => "ё" * 100 + 'ю' *(Post.friendly_id_options[:max_length] - 100 + 1))
-      assert_equal @post.slug_text.mb_chars[-1], 'ю'
+      post = Post.new(:title => "ё" * 100 + 'ю' *(Post.friendly_id_options[:max_length] - 100 + 1))
+      assert_equal post.slug_text.mb_chars[-1], 'ю'
     end
 
     should "be able to reuse an old friendly_id without incrementing the sequence" do
@@ -157,9 +168,22 @@ class SluggedModelTest < Test::Unit::TestCase
       end
 
       should "strip diacritics from Roman alphabet based characters" do
-        @post = Post.new(:title => "¡Feliz año!")
-        assert_no_match(/#{'ñ'}/, @post.slug_text)
+        post = Post.new(:title => "¡Feliz año!")
+        assert_no_match(/#{'ñ'}/, post.slug_text)
+      end
+
+      should "raise an error if the friendly_id text is an empty string" do
+        assert_raises(FriendlyId::SlugGenerationError) do
+          Post.create(:title => "")
+        end
+      end
+
+      should "raise an error if the friendly_id text is nil" do
+        assert_raises(FriendlyId::SlugGenerationError) do
+          Post.create(:title => nil)
+        end
       end
+
     end
 
     context "and configured to convert to ASCII" do
@@ -168,8 +192,17 @@ class SluggedModelTest < Test::Unit::TestCase
       end
 
       should "strip non-ascii characters" do
-        @post = Post.new(:title => "katakana: ゲコゴサザシジ")
-        assert_equal "katakana", @post.slug_text
+        post = Post.new(:title => "katakana: ゲコゴサザシジ")
+        assert_equal "katakana", post.slug_text
+      end
+    end
+
+    context "that uses a custom table name" do
+      should "support normal CRUD operations" do
+        assert thing = LegacyThing.create!(:name => "a name")
+        thing.name = "a new name"
+        assert thing.save!
+        assert thing.destroy
       end
     end
 

data/test/sti_test.rb

@@ -7,7 +7,7 @@ class STIModelTest < Test::Unit::TestCase
   context "A slugged model using single table inheritance" do
 
     setup do
-      Novel.friendly_id_options = FriendlyId::DEFAULT_FRIENDLY_ID_OPTIONS.merge(:column => :title, :use_slug => true)
+      Novel.friendly_id_options = FriendlyId::DEFAULT_OPTIONS.merge(:method => :title, :use_slug => true)
       @novel = Novel.new :title => "Test novel"
       @novel.save!
     end

data/test/test_helper.rb

@@ -35,3 +35,4 @@ require 'models/thing'
 require 'models/event'
 require 'models/city'
 require 'models/district'
+require 'models/legacy_thing'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: friendly_id
 version: !ruby/object:Gem::Version 
-  version: 2.2.2
+  version: 2.2.3
 platform: ruby
 authors: 
 - Norman Clarke
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-26 00:00:00 -03:00
+date: 2009-11-12 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,7 +64,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.3.3
     version: 
-description: A comprehensive slugging and pretty-URL plugin for ActiveRecord.
+description: A comprehensive slugging and pretty-URL plugin for Rails apps using ActiveRecord.
 email: 
 - norman@njclarke.com
 - adrian@mugnolo.com
@@ -75,15 +75,12 @@ extensions: []
 
 extra_rdoc_files: 
 - History.txt
-- Manifest.txt
 - README.rdoc
 files: 
 - History.txt
 - MIT-LICENSE
-- Manifest.txt
 - README.rdoc
 - Rakefile
-- config/website.yml
 - 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
@@ -108,6 +105,7 @@ files:
 - test/models/country.rb
 - test/models/district.rb
 - test/models/event.rb
+- test/models/legacy_thing.rb
 - test/models/novel.rb
 - test/models/person.rb
 - test/models/post.rb
@@ -125,10 +123,22 @@ has_rdoc: true
 homepage: http://friendly-id.rubyforge.org/
 licenses: []
 
-post_install_message: 
+post_install_message: |+
+  
+      ***********************************************************
+  
+        If you are upgrading friendly_id, please run
+  
+            ./script generate friendly_id --skip-migration
+  
+        in your Rails application to ensure that you have the
+        latest friendly_id Rake tasks.
+  
+      ***********************************************************
+  
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/Manifest.txt

@@ -1,43 +0,0 @@
-History.txt
-MIT-LICENSE
-Manifest.txt
-README.rdoc
-Rakefile
-config/website.yml
-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/tasks.rb
-lib/friendly_id/version.rb
-lib/tasks/friendly_id.rake
-lib/tasks/friendly_id.rb
-test/cached_slug_test.rb
-test/contest.rb
-test/custom_slug_normalizer_test.rb
-test/models/book.rb
-test/models/city.rb
-test/models/country.rb
-test/models/district.rb
-test/models/event.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/tasks_test.rb
-test/test_helper.rb

data/config/website.yml

@@ -1,2 +0,0 @@
-host: compay@rubyforge.org
-remote_dir: /var/www/gforge-projects/friendly-id