nateabbott-friendly_id 2.1.4

data/test/contest.rb

@@ -0,0 +1,94 @@
+# License
+# -------
+# 
+# Contest is copyright (c) 2009 Damian Janowski and Michel Martens for
+# Citrusbyte
+# 
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+require "test/unit"
+
+# Test::Unit loads a default test if the suite is empty, whose purpose is to
+# fail. Since having empty contexts is a common practice, we decided to
+# overwrite TestSuite#empty? in order to allow them. Having a failure when no
+# tests have been defined seems counter-intuitive.
+class Test::Unit::TestSuite
+  def empty?
+    false
+  end
+end
+
+# Contest adds +teardown+, +test+ and +context+ as class methods, and the
+# instance methods +setup+ and +teardown+ now iterate on the corresponding
+# blocks. Note that all setup and teardown blocks must be defined with the
+# block syntax. Adding setup or teardown instance methods defeats the purpose
+# of this library.
+class Test::Unit::TestCase
+  def self.setup(&block)
+    define_method :setup do
+      super(&block)
+      instance_eval(&block)
+    end
+  end
+
+  def self.teardown(&block)
+    define_method :teardown do
+      instance_eval(&block)
+      super(&block)
+    end
+  end
+
+  def self.context(name, &block)
+    subclass = Class.new(self)
+    remove_tests(subclass)
+    subclass.class_eval(&block)
+    const_set(context_name(name), subclass)
+  end
+
+  def self.test(name, &block)
+    define_method(test_name(name), &block)
+  end
+
+  class << self
+    alias_method :should, :test
+    alias_method :describe, :context
+  end
+
+private
+
+  def self.context_name(name)
+    "Test#{sanitize_name(name).gsub(/(^| )(\w)/) { $2.upcase }}".to_sym
+  end
+
+  def self.test_name(name)
+    "test_#{sanitize_name(name).gsub(/\s+/,'_')}".to_sym
+  end
+
+  def self.sanitize_name(name)
+    name.gsub(/\W+/, ' ').strip
+  end
+
+  def self.remove_tests(subclass)
+    subclass.public_instance_methods.grep(/^test_/).each do |meth|
+      subclass.send(:undef_method, meth.to_sym)
+    end
+  end
+end

data/test/custom_slug_normalizer_test.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/test_helper'
+
+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.delete_all
+      Slug.delete_all
+    end
+
+    should "invoke the block code" do
+      @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
+    end
+
+    should "respect the reserved option" do
+      Thing.friendly_id_options = Thing.friendly_id_options.merge(:reserved => ["a94a8fe5ccb19ba61c4c0873d391e987982fbbd3"])
+      assert_raises FriendlyId::SlugGenerationError do
+        Thing.create!(:name => "test")
+      end
+    end
+  
+  end
+
+end

data/test/models/book.rb

@@ -0,0 +1,2 @@
+class Book < ActiveRecord::Base
+end

data/test/models/country.rb

@@ -0,0 +1,4 @@
+class Country < ActiveRecord::Base
+  has_many :people
+  has_friendly_id :name, :use_slug => true
+end

data/test/models/event.rb

@@ -0,0 +1,3 @@
+class Event < ActiveRecord::Base
+  has_friendly_id :event_date, :use_slug => true
+end

data/test/models/novel.rb

@@ -0,0 +1,3 @@
+class Novel < Book
+  has_friendly_id :title, :use_slug => true
+end

data/test/models/person.rb

@@ -0,0 +1,6 @@
+class Person < ActiveRecord::Base
+
+  belongs_to :country
+  has_friendly_id :name, :use_slug => true, :scope => :country
+
+end

data/test/models/post.rb

@@ -0,0 +1,6 @@
+class Post < ActiveRecord::Base
+  has_friendly_id :title, :use_slug => true
+  
+  named_scope :published, :conditions => { :published => true }
+  
+end

data/test/models/thing.rb

@@ -0,0 +1,6 @@
+require 'digest/sha1'
+class Thing < ActiveRecord::Base
+  has_friendly_id :name, :use_slug => true do |text|
+    Digest::SHA1::hexdigest(text)
+  end
+end

data/test/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_friendly_id :login
+end

data/test/non_slugged_test.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/test_helper'
+
+class NonSluggedTest < Test::Unit::TestCase
+
+  context "A non-slugged model with default FriendlyId options" do
+
+    setup do
+      User.delete_all
+      @user = User.create!(:login => "joe", :email => "joe@example.org")
+    end
+
+    should "have friendly_id options" do
+      assert_not_nil User.friendly_id_options
+    end
+
+    should "not have a slug" do
+      assert !@user.respond_to?(:slug)
+    end
+
+    should "be findable by its friendly_id" do
+      assert User.find(@user.friendly_id)
+    end
+
+    should "be findable by its regular id" do
+      assert User.find(@user.id)
+    end
+
+    should "respect finder conditions" do
+      assert_raises ActiveRecord::RecordNotFound do
+        User.find(@user.friendly_id, :conditions => "1 = 2")
+      end
+    end
+
+    should "indicate if it was found by its friendly id" do
+      @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?
+    end
+
+    should "indicate if it has a better id" do
+      @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?
+    end
+
+    should "have always string for a friendly_id" do
+      assert_equal String, @user.to_param.class
+    end
+
+    should "return its id if the friendly_id is null" do
+      @user.login = nil
+      assert_equal @user.id.to_s, @user.to_param
+    end
+
+
+    context "when using an array as the find argument" do
+
+      setup do
+        @user2 = User.create(:login => "jane", :email => "jane@example.org")
+      end
+
+      should "return results" do
+        assert_equal 2, User.find([@user.friendly_id, @user2.friendly_id]).size
+      end
+
+      should "not allow mixed friendly and non-friendly ids for the same record" do
+        assert_raises ActiveRecord::RecordNotFound do
+          User.find([@user.id, @user.friendly_id]).size
+        end
+      end
+
+      should "raise an error when all records are not found" do
+        assert_raises ActiveRecord::RecordNotFound do
+          User.find(['bad', 'bad2'])
+        end
+      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?
+      end
+
+    end
+
+  end
+
+end

data/test/schema.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+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"
+    t.column "published", "boolean", :default => false
+    t.column "created_at", "datetime"
+    t.column "updated_at", "datetime"
+  end
+
+  create_table "users", :force => true do |t|
+    t.column "login", "string"
+    t.column "email", "string"
+    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
+
+  create_table "events", :force => true do |t|
+    t.column "name", "string"
+    t.column "event_date", "datetime"
+  end
+
+  create_table "slugs", :force => true do |t|
+    t.column "name", "string"
+    t.column "sluggable_id", "integer"
+    t.column "sequence", "integer", :null       => false, :default => 1
+    t.column "sluggable_type", "string", :limit => 40
+    t.column "scope", "string", :limit          => 40
+    t.column "created_at", "datetime"
+  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,53 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/test_helper'
+
+class ScopedModelTest < Test::Unit::TestCase
+
+  context "A slugged model that uses a scope" do
+
+    setup do
+      Person.delete_all
+      Country.delete_all
+      Slug.delete_all
+      @usa = Country.create!(:name => "USA")
+      @canada = Country.create!(:name => "Canada")
+      @person = Person.create!(:name => "John Smith", :country => @usa)
+      @person2 = Person.create!(:name => "John Smith", :country => @canada)
+    end
+
+    should "find all scoped records without scope" do
+      assert_equal 2, Person.find(:all, @person.friendly_id).size
+    end
+
+    should "find a single scoped records with a scope" do
+      assert Person.find(@person.friendly_id, :scope => @person.country.to_param)
+    end
+
+    should "raise an error when finding a single scoped record with no scope" do
+      assert_raises ActiveRecord::RecordNotFound do
+        Person.find(@person.friendly_id)
+      end
+    end
+
+    should "append scope error info when missing scope causes a find to fail" do
+      begin
+        Person.find(@person.friendly_id)
+        fail "The find should not have succeeded"
+      rescue ActiveRecord::RecordNotFound => e
+        assert_match /expected scope/, e.message
+      end
+    end
+
+    should "append scope error info when the scope value causes a find to fail" do
+      begin
+        Person.find(@person.friendly_id, :scope => "badscope")
+        fail "The find should not have succeeded"
+      rescue ActiveRecord::RecordNotFound => e
+        assert_match /scope=badscope/, e.message
+      end
+    end
+
+  end
+
+end

data/test/slug_test.rb

@@ -0,0 +1,106 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/test_helper'
+
+class SlugTest < Test::Unit::TestCase
+
+  context "a slug" do
+    
+    setup do
+      Slug.delete_all
+      Post.delete_all
+    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?
+    end
+
+  end
+  
+  context "the Slug class" do
+    
+    should "parse the slug name and sequence" do
+      assert_equal ["test", "2"], Slug::parse("test--2")
+    end
+    
+    should "parse with a default sequence of 1" do
+      assert_equal ["test", "1"], Slug::parse("test")
+    end
+
+    should "should strip diacritics" do
+      assert_equal "acai", Slug::strip_diacritics("açaí")
+    end
+  
+    should "strip diacritics correctly " do
+      input  = "ÀÁÂÃÄÅÆÇÈÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýþÿ"
+      output = Slug::strip_diacritics(input).split(//)
+      expected = "AAAAAAAECEEEIIIIDNOOOOOOUUUUYThssaaaaaaaeceeeeiiiidnoooooouuuuythy".split(//)
+      output.each_index do |i|
+        assert_equal expected[i], output[i]
+      end
+    end
+  
+  end
+  
+  context "the Slug class's to_friendly_id method" do
+    
+    should "include the sequence if the sequence is greater than 1" do
+      slug = Slug.new(:name => "test", :sequence => 2)
+      assert_equal "test--2", slug.to_friendly_id
+    end
+  
+    should "not include the sequence if the sequence is 1" do
+      slug = Slug.new(:name => "test", :sequence => 1)
+      assert_equal "test", slug.to_friendly_id
+    end
+    
+  end
+  
+  context "the Slug class's normalize method" do  
+    
+    should "should lowercase  strings" do
+      assert_match /abc/, Slug::normalize("ABC")
+    end
+  
+    should "should replace whitespace with dashes" do
+      assert_match /a-b/, Slug::normalize("a b")
+    end
+  
+    should "should replace 2spaces with 1dash" do
+      assert_match /a-b/, Slug::normalize("a  b")
+    end
+  
+    should "should remove punctuation" do
+      assert_match /abc/, Slug::normalize('abc!@#$%^&*•¶§∞¢££¡¿()><?"":;][]\.,/')
+    end
+  
+    should "should strip trailing space" do
+      assert_match /ab/, Slug::normalize("ab ")
+    end
+  
+    should "should strip leading space" do
+      assert_match /ab/, Slug::normalize(" ab")
+    end
+  
+    should "should strip trailing slashes" do
+      assert_match /ab/, Slug::normalize("ab-")
+    end
+  
+    should "should strip leading slashes" do
+      assert_match /ab/, Slug::normalize("-ab")
+    end
+  
+    should "should not modify valid name strings" do
+      assert_match /a-b-c-d/, Slug::normalize("a-b-c-d")
+    end
+  
+    should "work with non roman chars" do
+      assert_equal "検-索", Slug::normalize("検 索")
+    end
+  
+  end
+end