friendly_id 1.9.9 → 2.0.0

data/History.txt

@@ -1,12 +1,13 @@
-== RELEASE DATE COMING SOON
+== 2.0.0 2009-01-03
 
-* FriendlyId 2.0 Released
+* 5 major enhancements:
   * Support for scoped slugs (Norman Clarke)
   * Support for UTF-8 friendly_ids (Norman Clarke)
   * Can now be installed via Ruby Gems, or as a Rails plugin (Norman Clarke)
-  * Shoulda macro ({Josh Nichols}[http://github.com/technicalpickles])
   * Improved handling of non-unique slugs (Norman Clarke and Adrian Mugnolo)
-  * Various small bugfixes, cleanups and refactorings (Norman Clarke and Emilio Tagua)
+* 2 minor enhancements: 
+  * Shoulda macro (Josh Nichols - http://github.com/technicalpickles)
+  * Various small bugfixes, cleanups and refactorings
 
 == 2008-12-01
 

data/Manifest.txt

@@ -3,16 +3,6 @@ MIT-LICENSE
 Manifest.txt
 README.rdoc
 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
 friendly_id.gemspec
 generators/friendly_id/friendly_id_generator.rb
 generators/friendly_id/templates/create_slugs.rb
@@ -20,6 +10,7 @@ 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/shoulda_macros.rb

data/README.rdoc

@@ -213,12 +213,18 @@ that uses a non-Roman writing system, your feedback would be most welcome.
 
 FriendlyId is installed as a Ruby Gem:
 
-  gem install friendly-id
+  gem install friendly_id
 
 Alternatively, you can install it as a Rails plugin, though this is
 discouraged:
 
-./script/plugin install git://github.com/norman/friendly_id.git
+  ./script/plugin install git://github.com/norman/friendly_id.git
+
+If you are installing as a plugin, make sure you have installed the unicode gem,
+which FriendlyId depends on:
+
+  gem install unicode
+
 
 == Setting it up
 
@@ -226,7 +232,7 @@ FriendlyId currently works with Rails 2.0.0 and higher. Here's how to set it up.
 
 1) Install the Gem:
 
-  sudo gem install friendly-id
+  sudo gem install friendly_id
   cd my_app
   script/generate friendly_id
   rake db:migrate
@@ -264,15 +270,15 @@ rake:friendly_id:remove_old_slugs MODEL=MyModelName DAYS=60
 If you installed an older version of FriendlyId and want to upgrade to 2.0,
 follow these steps:
 
-==== Install the friendly-id Gem:
+==== Install the friendly_id Gem:
+
+  sudo gem install friendly_id
 
-  sudo gem install friendly-id
-  
 ==== Add FriendlyId to environment.rb:
 
 ===== For Rails 2.1 and higher:
 
-  config.gem "friendly_id", :version => ">= 2.0.0"
+  config.gem "friendly_id"
 
 ===== For Rails 2.0:
 
@@ -293,7 +299,6 @@ Add this to the bottom of environment.rb:
 
 That's it!
 
-
 == Hacking FriendlyId:
 
 FriendlyId is {hosted on Github}[git://github.com/norman/friendly_id.git], and

data/Rakefile

@@ -1,6 +1,5 @@
-require 'hoe'
-
-require File.join(File.dirname(__FILE__), 'lib', 'friendly_id', 'version')
+require 'newgem'
+require 'lib/friendly_id/version'
 
 Hoe.new("friendly_id", FriendlyId::Version::STRING) do |p|
   p.rubyforge_name = "friendly-id"
@@ -13,6 +12,9 @@ Hoe.new("friendly_id", FriendlyId::Version::STRING) do |p|
   p.need_zip = true
   p.test_globs = ['test/**/*_test.rb']
   p.extra_deps << ['unicode', '>= 0.1']
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
   p.rdoc_pattern = /^(lib|bin|ext)|txt|rdoc$/
   changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
   p.remote_rdoc_dir = ""

data/friendly_id.gemspec

@@ -1,15 +1,15 @@
 Gem::Specification.new do |s|
   s.name = %q{friendly_id}
-  s.version = "1.9.9"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Norman Clarke", "Adrian Mugnolo", "Emilio Tagua"]
   s.cert_chain = ["/Users/norman/.gem/gem-public_cert.pem"]
-  s.date = %q{2008-12-16}
+  s.date = %q{2008-12-30}
   s.description = %q{A comprehensive slugging and pretty-URL plugin for Ruby on Rails.}
   s.email = ["norman@randomba.org", "adrian@randomba.org", "miloops@gmail.com"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt"]
-  s.files = ["History.txt", "MIT-LICENSE", "Manifest.txt", "README.rdoc", "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", "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/tasks/friendly_id.rake", "lib/tasks/friendly_id.rb", "test/database.yml", "test/fixtures/countries.yml", "test/fixtures/country.rb", "test/fixtures/people.yml", "test/fixtures/person.rb", "test/fixtures/post.rb", "test/fixtures/posts.yml", "test/fixtures/slugs.yml", "test/fixtures/user.rb", "test/fixtures/users.yml", "test/non_slugged_test.rb", "test/rails/2.x/app/controllers/application.rb", "test/rails/2.x/config/boot.rb", "test/rails/2.x/config/database.yml", "test/rails/2.x/config/environment.rb", "test/rails/2.x/config/environments/test.rb", "test/rails/2.x/config/routes.rb", "test/schema.rb", "test/scoped_model_test.rb", "test/slug_test.rb", "test/sluggable_test.rb", "test/test_helper.rb"]
+  s.files = ["History.txt", "MIT-LICENSE", "Manifest.txt", "README.rdoc", "Rakefile", "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/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/tasks/friendly_id.rake", "lib/tasks/friendly_id.rb", "test/database.yml", "test/fixtures/countries.yml", "test/fixtures/country.rb", "test/fixtures/people.yml", "test/fixtures/person.rb", "test/fixtures/post.rb", "test/fixtures/posts.yml", "test/fixtures/slugs.yml", "test/fixtures/user.rb", "test/fixtures/users.yml", "test/non_slugged_test.rb", "test/rails/2.x/app/controllers/application.rb", "test/rails/2.x/config/boot.rb", "test/rails/2.x/config/database.yml", "test/rails/2.x/config/environment.rb", "test/rails/2.x/config/environments/test.rb", "test/rails/2.x/config/routes.rb", "test/schema.rb", "test/scoped_model_test.rb", "test/slug_test.rb", "test/sluggable_test.rb", "test/test_helper.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://randomba.org}
   s.rdoc_options = ["--main", "README.txt"]

data/lib/friendly_id.rb

@@ -1,17 +1,12 @@
 require 'unicode'
+require 'friendly_id/helpers'
 require 'friendly_id/slug'
 require 'friendly_id/shoulda_macros'
 
+
 # FriendlyId is a comprehensize Rails plugin/gem for slugging and permalinks.
 module FriendlyId
 
-  # Load FriendlyId if the gem is included in a Rails app.
-  def self.enable
-    return if ActiveRecord::Base.methods.include? 'has_friendly_id'
-    ActiveRecord::Base.class_eval { extend FriendlyId::ClassMethods }
-    Test::Unit::TestCase.class_eval { include FriendlyId::ShouldaMacros }
-  end
-
   # This error is raised when it's not possible to generate a unique slug.
   class SlugGenerationError < StandardError ; end
 
@@ -38,7 +33,7 @@ module FriendlyId
       class_inheritable_reader :friendly_id_options
 
       if options[:use_slug]
-        has_many :slugs, :order => 'id DESC', :as => :sluggable, :dependent => :destroy
+        has_many :slugs, :order => 'id DESC', :as => :sluggable, :dependent => :destroy, :readonly => true
         require 'friendly_id/sluggable_class_methods'
         require 'friendly_id/sluggable_instance_methods'
         extend SluggableClassMethods
@@ -54,6 +49,18 @@ module FriendlyId
 
   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 }
+      Test::Unit::TestCase.class_eval { include FriendlyId::ShouldaMacros }
+    end
+
+  end
+
+
 end
 
 if defined?(ActiveRecord)

data/lib/friendly_id/helpers.rb

@@ -0,0 +1,13 @@
+module FriendlyId
+  
+  module Helpers
+    # Calculate expected result size for find_some_with_friendly (taken from
+    # active_record/base.rb)
+    def expected_size(ids_and_names, options) #:nodoc:#
+      size = options[:offset] ? ids_and_names.size - options[:offset] : ids_and_names.size
+      size = options[:limit] if options[:limit] && size > options[:limit]
+      size
+    end
+  end
+  
+end

data/lib/friendly_id/non_sluggable_class_methods.rb

@@ -1,5 +1,7 @@
 module FriendlyId::NonSluggableClassMethods
 
+  include FriendlyId::Helpers
+
   def self.extended(base) #:nodoc:#
     class << base
       alias_method_chain :find_one, :friendly
@@ -19,23 +21,20 @@ module FriendlyId::NonSluggableClassMethods
   end
 
   def find_some_with_friendly(ids_and_names, options) #:nodoc:#
-    results_by_name = with_scope :find => options do
-      find :all, :conditions => ["#{ quoted_table_name }.#{ friendly_id_options[:column] } IN (?)", ids_and_names]
+    
+    results = with_scope :find => options do
+      find :all, :conditions => ["#{ quoted_table_name }.#{ primary_key } IN (?) OR #{friendly_id_options[:column].to_s} IN (?)",
+        ids_and_names, ids_and_names]
     end
+    
+    expected = expected_size(ids_and_names, options)
+    if results.size != expected
+      raise ActiveRecord::RecordNotFound, "Couldn't find all #{ name.pluralize } with IDs (#{ ids_and_names * ', ' }) AND #{ sanitize_sql options[:conditions] } (found #{ results.size } results, but was looking for #{ expected })"
+    end
+    
+    results.each {|r| r.send(:found_using_friendly_id=, true) if ids_and_names.include?(r.friendly_id)}
 
-    ids     = ids_and_names - results_by_name.map { |r| r[ friendly_id_options[:column] ] }
-    results = results_by_name
-
-    results += with_scope :find => options do
-      find :all, :conditions => ["#{ quoted_table_name }.#{ primary_key } IN (?)", ids]
-    end unless ids.empty?
-
-    expected_size = options[:offset] ? ids_and_names.size - options[:offset] : ids_and_names.size
-    expected_size = options[:limit] if options[:limit] && expected_size > options[:limit]
-
-    raise ActiveRecord::RecordNotFound, "Couldn't find all #{ name.pluralize } with IDs (#{ ids_and_names * ', ' }) AND #{ sanitize_sql options[:conditions] } (found #{ results.size } results, but was looking for #{ expected_size })" if results.size != expected_size
-
-    results_by_name.each { |r| r.send(:found_using_friendly_id=, true) }
     results
+
   end
 end

data/lib/friendly_id/slug.rb

@@ -2,9 +2,7 @@
 class Slug < ActiveRecord::Base
 
   belongs_to :sluggable, :polymorphic => true
-  validates_uniqueness_of :name, :scope => [:sluggable_type, :scope, :sequence]
-  before_create :set_sequence
-  before_save :check_for_blank_name
+  before_save :check_for_blank_name, :set_sequence
 
   class << self
 
@@ -81,6 +79,7 @@ class Slug < ActiveRecord::Base
   end
 
   def set_sequence
+    return unless new_record?
     last = Slug.find(:first, :conditions => { :name => name, :scope => scope,
       :sluggable_type => sluggable_type}, :order => "sequence DESC",
       :select => 'sequence')

data/lib/friendly_id/sluggable_class_methods.rb

@@ -1,4 +1,6 @@
 module FriendlyId::SluggableClassMethods
+  
+  include FriendlyId::Helpers
 
   def self.extended(base) #:nodoc:#
 
@@ -48,11 +50,10 @@ module FriendlyId::SluggableClassMethods
     find_options = {:select => "#{self.table_name}.*"}
     find_options[:joins] = :slugs unless options[:include] && [*options[:include]].flatten.include?(:slugs)
     find_options[:conditions] = "#{quoted_table_name}.#{primary_key} IN (#{ids.empty? ? 'NULL' : ids.join(',')}) "
-    find_options[:conditions] << "OR #{Slug.quoted_table_name}.#{Slug.primary_key} IN (#{slugs.to_s(:db)})"
+    find_options[:conditions] << "OR slugs.id IN (#{slugs.to_s(:db)})"
 
     results = with_scope(:find => find_options) { find_every(options) }
 
-    # calculate expected size, taken from active_record/base.rb
     expected = expected_size(ids_and_names, options)
     if results.size != expected
       raise ActiveRecord::RecordNotFound, "Couldn't find all #{ name.pluralize } with IDs (#{ ids_and_names * ', ' }) AND #{ sanitize_sql options[:conditions] } (found #{ results.size } results, but was looking for #{ expected })"
@@ -79,13 +80,6 @@ module FriendlyId::SluggableClassMethods
     end
   end
 
-  # Calculate expected result size for find_some_with_friendly
-  def expected_size(ids_and_names, options) #:nodoc:#
-    size = options[:offset] ? ids_and_names.size - options[:offset] : ids_and_names.size
-    size = options[:limit] if options[:limit] && size > options[:limit]
-    size
-  end
-
   # Build arrays of slugs and ids, for the find_some_with_friendly method.
   def get_slugs_and_ids(ids_and_names, options) #:nodoc:#
     scope = options.delete(:scope)

data/lib/friendly_id/sluggable_instance_methods.rb

@@ -53,23 +53,6 @@ module FriendlyId::SluggableInstanceMethods
     slug ? slug.to_friendly_id : id.to_s
   end
 
-  # Set the slug using the generated friendly id.
-  def set_slug
-    if self.class.friendly_id_options[:use_slug] && new_slug_needed?
-      @most_recent_slug = nil
-      slug_attributes = {:name => slug_text}
-      if friendly_id_options[:scope]
-        scope = send(friendly_id_options[:scope])
-        slug_attributes[:scope] = scope.respond_to?(:to_param) ? scope.to_param : scope.to_s
-      end
-      # If we're renaming back to a previously used friendly_id, delete the
-      # slug so that we can recycle the name without having to use a sequence.
-      slugs.find(:all, :conditions => {:name => slug_text, :scope => scope}).each { |s| s.destroy }
-      s = slugs.build slug_attributes
-      s.send(:set_sequence)
-    end
-  end
-
   # Get the processed string used as the basis of the friendly id.
   def slug_text
     base = send friendly_id_options[:column]
@@ -98,8 +81,25 @@ module FriendlyId::SluggableInstanceMethods
 
   def init_finder_slug
     return false if !@finder_slug_name
-    slug = Slug.find(:first, :conditions => {:sluggable_id => id, :name => @finder_slug_name})
+    slug = Slug.find(:first, :conditions => {:sluggable_id => id, :name => @finder_slug_name, :sluggable_type => self.class.name })
     finder_slug = slug
   end
 
+  # Set the slug using the generated friendly id.
+  def set_slug
+    if self.class.friendly_id_options[:use_slug] && new_slug_needed?
+      @most_recent_slug = nil
+      slug_attributes = {:name => slug_text}
+      if friendly_id_options[:scope]
+        scope = send(friendly_id_options[:scope])
+        slug_attributes[:scope] = scope.respond_to?(:to_param) ? scope.to_param : scope.to_s
+      end
+      # If we're renaming back to a previously used friendly_id, delete the
+      # slug so that we can recycle the name without having to use a sequence.
+      slugs.find(:all, :conditions => {:name => slug_text, :scope => scope}).each { |s| s.destroy }
+      slug = slugs.build slug_attributes
+      slug
+    end
+  end
+
 end

data/lib/friendly_id/version.rb

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

data/lib/tasks/friendly_id.rake

@@ -8,7 +8,7 @@ namespace :friendly_id do
     while records = sluggable_class.find(:all, :include => :slugs, :conditions => "slugs.id IS NULL", :limit => 1000) do
       break if records.size == 0
       records.each do |r|
-        r.set_slug
+        r.send(:set_slug)
         r.save!
         puts "#{sluggable_class.to_s}(#{r.id}) friendly_id set to \"#{r.slug.name}\""
       end

data/test/fixtures/posts.yml

@@ -16,4 +16,8 @@ common_title:
 
 common_title2:
   name: Common Title
-  content: A second post with a very common title
+  content: A second post with a very common title
+
+john_smith:
+  name: John Smith
+  content: Should allow for identical slug names between sluggable types

data/test/fixtures/slugs.yml

@@ -1,3 +1,11 @@
+post_with_same_friendly_id_as_person:
+  name: john-smith
+  sluggable: john_smith (Post)
+
+person_with_same_friendly_id_as_post:
+  name: john-smith
+  sluggable: john_smith (Person)
+
 one:
   name: with-one-slug
   sluggable: with_one_slug

data/test/non_slugged_test.rb

@@ -11,24 +11,39 @@ class NonSluggedTest < Test::Unit::TestCase
     assert User.find(users(:joe).friendly_id)
   end
 
-  def test_to_param_should_return_a_string
-    assert_equal String, users(:joe).to_param.class
+  def test_should_find_users_using_friendly_id
+    assert User.find([users(:joe).friendly_id])
   end
 
-  def test_should_find_users_using_friendly_ids
-    assert_equal 2, User.find([users(:joe).friendly_id, users(:jane).friendly_id]).length
+  def test_to_param_should_return_a_string
+    assert_equal String, users(:joe).to_param.class
   end
 
   def test_should_not_find_users_using_non_existent_friendly_ids
     assert_raises ActiveRecord::RecordNotFound do
-      User.find(['non-existent-slug', 'yet-another-non-existent-slug'])
+      User.find(['bad', 'bad2'])
     end
   end
+  
+  def test_finding_by_array_with_friendly_and_non_friendly_id_for_same_record_raises_error
+    assert_raises ActiveRecord::RecordNotFound do
+      User.find([users(:joe).id, "joe"]).size
+    end
+  end
+
+  def test_finding_with_mixed_array_should_indicate_whether_found_by_numeric_or_friendly
+    @users = User.find([users(:jane).id, "joe"], :order => "login ASC")
+    assert @users[0].found_using_numeric_id?
+    assert @users[1].found_using_friendly_id?
+  end
 
   def test_finder_options_are_not_ignored
     assert_raises ActiveRecord::RecordNotFound do
        User.find(users(:joe).friendly_id, :conditions => "1 = 2")
     end
+    assert_raises ActiveRecord::RecordNotFound do
+       User.find([users(:joe).friendly_id], :conditions => "1 = 2")
+    end
   end
 
   def test_user_should_have_friendly_id_options
@@ -36,8 +51,12 @@ class NonSluggedTest < Test::Unit::TestCase
   end
 
   def test_user_should_not_be_found_using_friendly_id_unless_it_really_was
-    @user = User.new
-    assert !@user.found_using_friendly_id?
+    assert !User.find(users(:joe).id).found_using_friendly_id?
+  end
+
+  def test_users_should_not_be_found_using_friendly_id_unless_they_really_were
+    @users = User.find([users(:jane).id])
+    assert @users[0].found_using_numeric_id?
   end
 
   def test_user_should_be_considered_found_by_numeric_id_as_default
@@ -48,15 +67,18 @@ class NonSluggedTest < Test::Unit::TestCase
   def test_user_should_indicate_if_it_was_found_using_numeric_id
     @user = User.find(users(:joe).id)
     assert @user.found_using_numeric_id?
+    assert !@user.found_using_friendly_id?
   end
 
   def test_user_should_indicate_if_it_was_found_using_friendly_id
     @user = User.find(users(:joe).friendly_id)
+    assert !@user.found_using_numeric_id?
     assert @user.found_using_friendly_id?
   end
 
   def test_should_indicate_there_is_a_better_id_if_found_by_numeric_id
     @user = User.find(users(:joe).id)
+    assert @user.found_using_numeric_id?
     assert @user.has_better_id?
   end