rakutenusa-friendly_id 2.0.6

data/test/schema.rb

@@ -0,0 +1,47 @@
+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 "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 "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,51 @@
+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.split.each_index do |i|
+        assert_equal output[i], expected[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

data/test/slugged_model_test.rb

@@ -0,0 +1,263 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/test_helper'
+
+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.delete_all
+      Person.delete_all
+      Slug.delete_all
+      @post = Post.new :title => "Test post", :content => "Test content"
+      @post.save!
+    end
+
+    should "have friendly_id options" do
+      assert_not_nil Post.friendly_id_options
+    end
+
+    should "have a slug" do
+      assert_not_nil @post.slug
+    end
+
+    should "be findable by its friendly_id" do
+      assert Post.find(@post.friendly_id)
+    end
+
+    should "be findable by its regular id" do
+      assert Post.find(@post.id)
+    end
+
+    should "generate slug text" do
+      post = Post.new :title => "Test post", :content => "Test content"
+      assert_not_nil @post.slug_text
+    end
+
+    should "respect finder conditions" do
+      assert_raises ActiveRecord::RecordNotFound do
+        Post.find(@post.friendly_id, :conditions => "1 = 2")
+      end
+    end
+
+    should "raise an error if the friendly_id text is reserved" do
+      assert_raises(FriendlyId::SlugGenerationError) do
+        Post.create!(:title => "new")
+      end
+    end
+
+    should "raise an error if the friendly_id text is blank" do
+      assert_raises(FriendlyId::SlugGenerationError) do
+        Post.create(:title => "")
+      end
+    end
+
+    should "raise an error if the normalized friendly id becomes blank" do
+      assert_raises(FriendlyId::SlugGenerationError) do
+        post = Post.create!(:title => "-.-")
+      end
+    end
+
+    should "not make a new slug unless the friendly_id method value has changed" do
+      @post.content = "Changed content"
+      @post.save!
+      assert_equal 1, @post.slugs.size
+    end
+
+    should "make a new slug if the friendly_id method value has changed" do
+      @post.title = "Changed title"
+      @post.save!
+      assert_equal 2, @post.slugs.size
+    end
+
+    should "have a slug sequence of 1 by default" do
+      assert_equal 1, @post.slug.sequence
+    end
+
+    should "increment sequence for duplicate slug names" do
+      @post2 = Post.create! :title => @post.title, :content => "Test content for post2"
+      assert_equal 2, @post2.slug.sequence
+    end
+
+    should "have a friendly_id that terminates with -- and the slug sequence if the sequence is greater than 1" do
+      @post2 = Post.create! :title => @post.title, :content => "Test content for post2"
+      assert_match(/--2\z/, @post2.friendly_id)
+    end
+
+    should "not strip diacritics" do
+      @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
+    end
+    
+    should "allow the same friendly_id across models" do
+      @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]
+    end
+
+    should "be able to reuse an old friendly_id without incrementing the sequence" do
+      old_title = @post.title
+      old_friendly_id = @post.friendly_id
+      @post.title = "A changed title"
+      @post.save!
+      @post.title = old_title
+      @post.save!
+      assert_equal old_friendly_id, @post.friendly_id
+    end
+
+    should "allow eager loading of slugs" do
+      assert_nothing_raised do
+        Post.find(@post.friendly_id, :include => :slugs)
+      end
+    end
+
+    context "and configured to strip diacritics" do
+      setup do
+        Post.friendly_id_options = Post.friendly_id_options.merge(:strip_diacritics => true)
+      end
+
+      should "strip diacritics from Roman alphabet based characters" do
+        @post = Post.new(:title => "¡Feliz año!")
+        assert_no_match(/#{'ñ'}/, @post.slug_text)
+      end
+    end
+
+    context "and configured to convert to ASCII" do
+      setup do
+        Post.friendly_id_options = Post.friendly_id_options.merge(:strip_non_ascii => true)
+      end
+
+      should "strip non-ascii characters" do
+        @post = Post.new(:title => "katakana: ゲコゴサザシジ")
+        assert_equal "katakana", @post.slug_text
+      end
+    end
+
+    context "that doesn't have a slug" do
+
+      setup do
+        @post.slug.destroy
+        @post = Post.find(@post.id)
+      end
+
+      should "have a to_param method that returns the id cast to a string" do
+        assert_equal @post.id.to_s, @post.to_param
+      end
+
+    end
+
+    context "when found using its friendly_id" do
+      setup do
+        @post = Post.find(@post.friendly_id)
+      end
+
+      should "indicate that it was found using the friendly_id" do
+        assert @post.found_using_friendly_id?
+      end
+
+      should "not indicate that it has a better id" do
+        assert !@post.has_better_id?
+      end
+
+      should "not indicate that it was found using its numeric id" do
+        assert !@post.found_using_numeric_id?
+      end
+
+      should "have a finder slug" do
+        assert_not_nil @post.finder_slug
+      end
+
+    end
+
+    context "when found using its regular id" do
+      setup do
+        @post = Post.find(@post.id)
+      end
+
+      should "indicate that it was not found using the friendly id" do
+        assert !@post.found_using_friendly_id?
+      end
+
+      should "indicate that it has a better id" do
+        assert @post.has_better_id?
+      end
+
+      should "indicate that it was found using its numeric id" do
+        assert @post.found_using_numeric_id?
+      end
+
+      should "not have a finder slug" do
+        assert_nil @post.finder_slug
+      end
+
+    end
+
+    context "when found using an outdated friendly id" do
+      setup do
+        old_id = @post.friendly_id
+        @post.title = "Title changed"
+        @post.save!
+        @post = Post.find(old_id)
+      end
+
+      should "indicate that it was found using a friendly_id" do
+        assert @post.found_using_friendly_id?
+      end
+
+      should "indicate that it has a better id" do
+        assert @post.has_better_id?
+      end
+
+      should "not indicate that it was found using its numeric id" do
+        assert !@post.found_using_numeric_id?
+      end
+
+      should "should have a finder slug different from its default slug" do
+        assert_not_equal @post.slug, @post.finder_slug
+      end
+
+    end
+
+    context "when using an array as the find argument" do
+
+      setup do
+        @post2 = Post.create!(:title => "another post", :content => "more content")
+      end
+
+      should "return results" do
+        assert_equal 2, Post.find([@post.friendly_id, @post2.friendly_id]).size
+      end
+
+      should "indicate that the results were found using a friendly_id" do
+        @posts = Post.find [@post.friendly_id, @post2.friendly_id]
+        @posts.each { |p| assert p.found_using_friendly_id? }
+      end
+
+      should "raise an error when all records are not found" do
+        assert_raises(ActiveRecord::RecordNotFound) do
+          Post.find([@post.friendly_id, 'non-existant-slug-record'])
+        end
+      end
+
+      should "allow eager loading of slugs" do
+        assert_nothing_raised do
+          Post.find([@post.friendly_id, @post2.friendly_id], :include => :slugs)
+        end
+      end
+
+    end
+
+  end
+
+end

data/test/sti_test.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/test_helper'
+
+class SluggedModelTest < 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.delete_all
+      Slug.delete_all
+      @novel = Novel.new :title => "Test novel"
+      @novel.save!
+    end
+
+    should "have a slug" do
+      assert_not_nil @novel.slug
+    end
+    
+    context "found by its friendly id" do
+      
+      setup do
+        @novel = Novel.find(@novel.friendly_id)
+      end
+
+      should "not indicate that it has a better id" do
+        assert !@novel.has_better_id?
+      end
+
+    end
+    
+
+    context "found by its numeric id" do
+      
+      setup do
+        @novel = Novel.find(@novel.id)
+      end
+
+      should "indicate that it has a better id" do
+        assert @novel.has_better_id?
+      end
+
+    end
+
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,36 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+$:.unshift(File.dirname(__FILE__))
+$VERBOSE=false
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+# You can use "rake test AR_VERSION=2.0.5" to test against 2.0.5, for example.
+# The default is to use the latest installed ActiveRecord.
+if ENV["AR_VERSION"]
+  gem 'activerecord', "#{ENV["AR_VERSION"]}"
+end
+require 'active_record'
+
+require 'friendly_id'
+require 'models/post'
+require 'models/person'
+require 'models/user'
+require 'models/country'
+require 'models/book'
+require 'models/novel'
+require 'models/thing'
+
+# Borrowed from ActiveSupport
+def silence_stream(stream)
+  old_stream = stream.dup
+  stream.reopen(RUBY_PLATFORM =~ /mswin/ ? 'NUL:' : '/dev/null')
+  stream.sync = true
+  yield
+ensure
+  stream.reopen(old_stream)
+end
+
+ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
+silence_stream(STDOUT) do
+  load(File.dirname(__FILE__) + "/schema.rb")
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: rakutenusa-friendly_id
+version: !ruby/object:Gem::Version 
+  version: 2.0.6
+platform: ruby
+authors: 
+- RakutenUSA
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-29 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: TODO
+email: dev@rakutenusa.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- VERSION.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
+- 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
+has_rdoc: true
+homepage: http://github.com/rakutenusa/friendly_id
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: TODO
+test_files: 
+- 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