dougcole-friendly_id 2.0.2

data/test/non_slugged_test.rb

@@ -0,0 +1,85 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class NonSluggedTest < Test::Unit::TestCase
+
+  fixtures :users
+
+  def setup
+  end
+
+  def test_should_find_user_using_friendly_id
+    assert User.find(users(:joe).friendly_id)
+  end
+
+  def test_should_find_users_using_friendly_id
+    assert User.find([users(:joe).friendly_id])
+  end
+
+  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(['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
+    assert_not_nil User.friendly_id_options
+  end
+
+  def test_user_should_not_be_found_using_friendly_id_unless_it_really_was
+    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
+    @user = User.new
+    assert @user.found_using_numeric_id?
+  end
+
+  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
+
+end

data/test/rails/2.x/config/boot.rb

@@ -0,0 +1,109 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.3.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/test/rails/2.x/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: ":memory:"

data/test/rails/2.x/config/environment.rb

@@ -0,0 +1,7 @@
+if ENV['RAILS_VERSION']
+  RAILS_GEM_VERSION = ENV['RAILS_VERSION']
+end
+require File.join(File.dirname(__FILE__), 'boot')
+Rails::Initializer.run
+ActiveRecord::Base.colorize_logging = false
+require File.dirname(__FILE__) + '/../../../../init.rb'

data/test/rails/2.x/config/environments/test.rb

@@ -0,0 +1,6 @@
+config.cache_classes = true
+config.whiny_nils = true
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+config.action_controller.allow_forgery_protection    = false
+config.action_mailer.delivery_method = :test

data/test/schema.rb

@@ -0,0 +1,38 @@
+ActiveRecord::Schema.define(:version => 3) do
+
+  create_table "posts", :force => true do |t|
+    t.string   "name"
+    t.text     "content"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "users", :force => true do |t|
+    t.string   "login"
+    t.string   "email"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+  
+  create_table "people", :force => true do |t|
+    t.string "name"
+    t.integer "country_id"
+  end
+  
+  create_table "countries", :force => true do |t|
+    t.string "name"
+  end
+
+  create_table "slugs", :force => true do |t|
+    t.string "name"
+    t.integer "sluggable_id"
+    t.integer "sequence", :null       => false, :default => 1
+    t.string "sluggable_type", :limit => 40
+    t.string "scope", :limit          => 40
+    t.datetime "created_at"
+  end
+
+  add_index "slugs", ["sluggable_id"], :name           => "index_slugs_on_sluggable_id"
+  add_index "slugs", ["name", "sluggable_type", "scope", "sequence"], :name => "index_slugs_on_n_s_s_and_s", :unique => true
+
+end

data/test/scoped_model_test.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ScopedModelTest < Test::Unit::TestCase
+
+  fixtures :people, :countries, :slugs
+  
+  def test_should_find_scoped_records_without_scope
+    assert_equal 2, Person.find(:all, "john-smith").size
+  end
+
+  def test_should_find_scoped_records_with_scope
+    assert_equal people(:john_smith), Person.find("john-smith", :scope => "argentina")
+    assert_equal people(:john_smith2), Person.find("john-smith", :scope => "usa")
+  end
+  
+  def test_should_create_scoped_records_with_scope
+    person = Person.create!(:name => "Joe Schmoe", :country => countries(:usa))
+    assert_equal "usa", person.slug.scope
+  end
+
+end

data/test/slug_test.rb

@@ -0,0 +1,87 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class SlugTest < Test::Unit::TestCase
+
+  fixtures :posts, :slugs
+
+  def test_should_indicate_if_it_is_the_most_recent
+    assert slugs(:two_new).is_most_recent?
+    assert !slugs(:two_old).is_most_recent?
+  end
+
+  def test_parse_should_return_slug_name_and_sequence
+    assert_equal ["test", "2"], Slug::parse("test--2")
+  end
+
+  def test_parse_should_return_a_default_sequnce_of_1
+    assert_equal ["test", "1"], Slug::parse("test")
+  end
+
+  def test_strip_diacritics_should_strip_diacritics
+    assert_equal "acai", Slug::strip_diacritics("açaí")
+  end
+
+  def test_to_friendly_id_should_include_sequence_if_its_greater_than_1
+    slug = Slug.new(:name => "test", :sequence => 2)
+    assert_equal "test--2", slug.to_friendly_id
+  end
+
+  def test_to_friendly_id_should_include_sequence_if_its_than_1
+    slug = Slug.new(:name => "test", :sequence => 1)
+    assert_equal "test", slug.to_friendly_id
+  end
+
+  def test_normalize_should_lowercase_strings
+    assert_match /abc/, Slug::normalize("ABC")
+  end
+
+  def test_normalize_should_replace_whitespace_with_dashes
+    assert_match /a-b/, Slug::normalize("a b")
+  end
+
+  def test_normalize_should_replace_2spaces_with_1dash
+    assert_match /a-b/, Slug::normalize("a  b")
+  end
+
+  def test_normalize_should_remove_punctuation
+    assert_match /abc/, Slug::normalize('abc!@#$%^&*•¶§∞¢££¡¿()><?"":;][]\.,/')
+  end
+
+  def test_normalize_should_strip_trailing_space
+    assert_match /ab/, Slug::normalize("ab ")
+  end
+
+  def test_normalize_should_strip_leading_space
+    assert_match /ab/, Slug::normalize(" ab")
+  end
+
+  def test_normalize_should_strip_trailing_slashes
+    assert_match /ab/, Slug::normalize("ab-")
+  end
+
+  def test_normalize_should_strip_leading_slashes
+    assert_match /ab/, Slug::normalize("-ab")
+  end
+
+  def test_normalize_should_not_modify_valid_name_strings
+    assert_match /a-b-c-d/, Slug::normalize("a-b-c-d")
+  end
+
+  # These strings are taken from various international Google homepages. I
+  # would be most grateful if a fluent speaker of any language that uses a
+  # writing system other than the Roman alphabet could help me make some
+  # better tests to ensure this is working correctly.
+  def test_normalize_works_with_non_roman_chars
+    assert_equal "検-索", Slug::normalize("検 索")
+  end
+
+  def test_strip_diactics_correctly_strips_diacritics
+    input  = "ÀÁÂÃÄÅÆÇÈÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýþÿ"
+    output = Slug::strip_diacritics(input).split(//)
+    expected = "AAAAAAAECEEEIIIIDNOOOOOOUUUUYThssaaaaaaaeceeeeiiiidnoooooouuuuythy".split(//)
+    output.split.each_index do |i|
+      assert_equal output[i], expected[i]
+    end
+  end
+  
+end

data/test/sluggable_test.rb

@@ -0,0 +1,185 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class SluggableTest < Test::Unit::TestCase
+
+  fixtures :posts, :slugs
+
+  def setup
+    Post.friendly_id_options[:max_length] = FriendlyId::ClassMethods::DEFAULT_FRIENDLY_ID_OPTIONS[:max_length]
+  end
+
+  def test_should_allow_for_identical_slug_names_between_sluggable_types
+    assert !Post.find(slugs(:post_with_same_friendly_id_as_person).name).has_better_id?
+  end
+
+  def test_class_should_have_friendly_id_options
+    assert_not_nil Post.friendly_id_options
+  end
+
+  def test_should_generate_slug_text
+   @post = Post.new(:name => "Test post", :content => "Test content")
+   assert_equal "test-post", @post.slug_text
+  end
+
+  def test_should_save_slug_when_creating
+    @post = Post.create(:name => "Test post", :content => "Test content")
+    assert @post.slug
+  end
+
+  def test_to_param_should_always_return_a_string
+    assert_equal String, posts(:without_slug).to_param.class
+    assert_equal String, posts(:with_one_slug).to_param.class
+  end
+
+  def test_finder_options_are_not_ignored
+    assert_raises ActiveRecord::RecordNotFound do
+      Post.find(slugs(:one).name, :conditions => "1 = 2")
+    end
+  end
+
+  def test_should_still_be_able_to_find_record_by_id
+    post = Post.create!(:name => "New post")
+    Post.create!(:name => "#{post.id.to_s} and some text")
+    assert_equal post, Post.find(post.id)
+  end
+
+
+  def test_should_not_be_found_using_friendly_id_by_default
+    @post = Post.new
+    assert !@post.found_using_friendly_id?
+    assert @post.found_using_numeric_id?
+  end
+
+  def test_should_be_using_friendly_id_when_find_arg_is_an_array
+    @posts = Post.find([posts(:with_one_slug).friendly_id, posts(:with_two_slugs).friendly_id])
+    assert @posts.all? { |post| post.found_using_friendly_id? }
+  end
+
+  def test_raises_active_record_not_found_when_not_all_records_found
+    assert_raises(ActiveRecord::RecordNotFound) do
+      Post.find([posts(:with_one_slug).slug.name, 'non-existant-slug-record'])
+    end
+  end
+
+  def test_should_indicate_if_it_was_found_using_numeric_id
+    @post = Post.find(posts(:with_two_slugs).id)
+    assert @post.found_using_numeric_id?
+  end
+
+  def test_post_should_indicate_if_it_was_found_using_friendly_id
+    @post = Post.find(posts(:with_two_slugs).slug.name)
+    assert @post.found_using_friendly_id?
+  end
+
+  def test_post_should_indicate_if_it_was_found_using_outdated_friendly_id
+    @post = Post.find(posts(:with_two_slugs).slugs.last.name)
+    assert @post.found_using_outdated_friendly_id?
+  end
+
+  def test_should_indicate_there_is_a_better_id_if_found_by_numeric_id
+    @post = Post.find(posts(:with_one_slug).id)
+    assert @post.has_better_id?
+  end
+
+  def test_should_indicate_there_is_a_better_id_if_found_by_outdated_friendly_id
+    @post = Post.find(posts(:with_two_slugs).slugs.last.name)
+    assert @post.has_better_id?
+  end
+
+  def test_slug_should_always_be_the_most_recent
+    @post = Post.find(posts(:with_two_slugs).slug.name)
+    assert !@post.has_better_id?
+    assert slugs(:two_new).name, @post.slug.name
+  end
+
+  def test_should_strip_diactics_from_slug_if_configured_to_do_so
+    Post.friendly_id_options[:strip_diacritics] = true
+    @post = Post.new(:name => "¡FELIZ AÑO!")
+    # Happy anus to you too
+    assert_equal "feliz-ano", @post.slug_text
+  end
+
+  def test_should_not_strip_diactics_from_slug_unless_configured_to_do_so
+    Post.friendly_id_options[:strip_diacritics] = false
+    @post = Post.new(:name => "¡FELIZ AÑO!")
+    assert_equal "feliz-año", @post.slug_text
+  end
+
+  def test_should_not_make_new_slug_unless_friendly_id_method_has_changed
+    posts(:with_one_slug).content = "Edited content"
+    posts(:with_one_slug).save!
+    assert_equal 1, posts(:with_one_slug).slugs.size
+  end
+
+  def test_post_should_make_new_slug_if_friendly_id_method_is_changed
+    posts(:with_one_slug).name = "Edited name"
+    posts(:with_one_slug).save!
+    assert_equal 2, posts(:with_one_slug).slugs.size
+  end
+
+  def test_should_increment_sequence_for_duplicate_slugs
+    @post = Post.create!(:name => slugs(:one).name, :content => "stuff")
+    assert_equal 2, @post.slug.sequence
+  end
+
+  def test_friendly_id_should_contain_sequence_unless_its_1
+    @post = Post.create!(:name => slugs(:one).name, :content => "stuff")
+    assert_equal "#{slugs(:one).name}--2", @post.friendly_id
+  end
+
+  def test_should_truncate_slugs_longer_than_maxlength
+    Post.friendly_id_options[:max_length] = 10
+    @post = Post.new(:name => "x" * 11, :content => "Test content")
+    assert @post.slug_text.length <= Post.friendly_id_options[:max_length]
+  end
+
+  def test_should_ensure_truncated_slugs_that_collide_have_different_sequences
+    Post.friendly_id_options[:max_length] = 2
+    p = Post.create!(:name => "aaa")
+    q = Post.create!(:name => "aaab")
+    assert_not_equal p.friendly_id, q.friendly_id
+    assert_equal p.slug.name, q.slug.name
+    assert_not_equal p.slug.sequence, q.slug.sequence
+  end
+
+  def test_should_be_able_to_rename_back_to_old_friendly_id
+    p = Post.create!(:name => "value")
+    assert_equal "value", p.friendly_id
+    p.name = "different value"
+    p.save!
+    p.reload
+    assert_equal "different-value", p.friendly_id
+    p.name = "value"
+    assert p.save!
+    p.reload
+    assert_equal "value", p.friendly_id
+  end
+
+  def test_should_raise_error_if_friendly_id_is_blank
+    assert_raises(FriendlyId::SlugGenerationError) do
+      Post.create(:name => nil)
+    end
+  end
+
+  def test_should_raise_error_if_normalized_friendly_id_becomes_blank
+    assert_raises(FriendlyId::SlugGenerationError) do
+      post = Post.create!(:name => "-.-")
+    end
+  end
+
+  def test_should_raise_error_if_slug_text_is_reserved
+    assert_raises(FriendlyId::SlugGenerationError) do
+      Post.create(:name => "new")
+    end
+  end
+
+  def test_should_allow_eager_loading_of_slugs
+    assert_nothing_raised do
+      Post.find(slugs(:one).name, :include => :slugs)
+    end
+    assert_nothing_raised do
+      Post.find([slugs(:one).name, slugs(:two_new).name], :include => :slugs)
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,35 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+$VERBOSE = false
+
+ENV['RAILS_ENV'] = 'test'
+require File.dirname(__FILE__) + '/rails/2.x/config/environment.rb'
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+
+require 'test/unit'
+require 'active_record/fixtures'
+require 'action_controller/test_process'
+require 'sqlite3'
+require 'friendly_id/slug'
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.establish_connection
+
+silence_stream(STDOUT) do
+  load(File.dirname(__FILE__) + "/schema.rb")
+end
+
+Test::Unit::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures"
+$LOAD_PATH.unshift(Test::Unit::TestCase.fixture_path)
+
+class Test::Unit::TestCase #:nodoc:
+  include ActionController::TestProcess
+  def create_fixtures(*table_names)
+    if block_given?
+      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names) { yield }
+    else
+      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names)
+    end
+  end
+  self.use_transactional_fixtures = true
+  self.use_instantiated_fixtures  = false
+end