nateabbott-friendly-id 2.2.1

data/lib/friendly_id/version.rb

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

data/lib/tasks/friendly_id.rake

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+namespace :friendly_id do
+  desc "Make slugs for a model."
+  task :make_slugs => :environment do
+    raise 'USAGE: rake friendly_id:make_slugs MODEL=MyModelName' if ENV["MODEL"].nil?
+    if !sluggable_class.friendly_id_options[:use_slug]
+      raise "Class \"#{sluggable_class.to_s}\" doesn't appear to be using slugs"
+    end
+    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.send(:set_slug)
+        r.save!
+        puts "#{sluggable_class.to_s}(#{r.id}) friendly_id set to \"#{r.slug.name}\""
+      end
+    end
+  end
+
+  desc "Regenereate slugs for a model."
+  task :redo_slugs => :environment do
+    raise 'USAGE: rake friendly_id:redo_slugs MODEL=MyModelName' if ENV["MODEL"].nil?
+    if !sluggable_class.friendly_id_options[:use_slug]
+      raise "Class \"#{sluggable_class.to_s}\" doesn't appear to be using slugs"
+    end
+    Slug.destroy_all(["sluggable_type = ?", sluggable_class.to_s])
+    Rake::Task["friendly_id:make_slugs"].invoke
+  end
+
+  desc "Kill obsolete slugs older than 45 days."
+  task :remove_old_slugs => :environment do
+    if ENV["DAYS"].nil?
+      @days = 45
+    else
+      @days = ENV["DAYS"].to_i
+    end
+    slugs = Slug.find(:all, :conditions => ["created_at < ?", DateTime.now - @days.days])
+    slugs.each do |s|
+      s.destroy if !s.is_most_recent?
+    end
+  end
+end
+
+def sluggable_class
+  if (ENV["MODEL"].split('::').size > 1)
+    ENV["MODEL"].split('::').inject(Kernel) {|scope, const_name| scope.const_get(const_name)}
+  else
+    Object.const_get(ENV["MODEL"])
+  end
+end

data/lib/tasks/friendly_id.rb

@@ -0,0 +1 @@
+load 'tasks/friendly_id.rake'

data/test/cached_slug_test.rb

@@ -0,0 +1,109 @@
+# encoding: utf-8!
+require "mocha"
+
+require File.dirname(__FILE__) + '/test_helper'
+
+class CachedSlugModelTest < Test::Unit::TestCase
+
+  context "A slugged model with a cached_slugs column" do
+
+    setup do
+      City.delete_all
+      Slug.delete_all
+      @paris = City.new(:name => "Paris")
+      @paris.save!
+    end
+
+    should "have a slug" do
+      assert_not_nil @paris.slug
+    end
+
+    should "have a cached slug" do
+      assert_not_nil @paris.my_slug
+    end
+
+    should "have a to_param method that returns the cached slug" do
+      assert_equal "paris", @paris.to_param
+    end
+
+    should "protect the cached slug value" do
+      @paris.update_attributes(:my_slug => "Madrid")
+      @paris.reload
+      assert_equal "paris", @paris.my_slug
+    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
+    end
+
+    should "not update the cached slug column if it has not changed" do
+      @paris.population = 10_000_000
+      @paris.expects(:my_slug=).never
+      @paris.save
+    end
+
+
+    context "found by its friendly id" do
+
+      setup do
+        @paris = City.find(@paris.friendly_id)
+      end
+
+      should "not indicate that it has a better id" do
+        assert !@paris.has_better_id?
+      end
+
+    end
+
+    context "found by its numeric id" do
+
+      setup do
+        @paris = City.find(@paris.id)
+      end
+
+      should "indicate that it has a better id" do
+        assert @paris.has_better_id?
+      end
+
+    end
+
+
+    context "with a new slug" do
+
+      setup do
+        @paris.name = "Paris, France"
+        @paris.save!
+        @paris.reload
+      end
+
+      should "have its cached slug updated" do
+        assert_equal "paris-france", @paris.my_slug
+      end
+
+      should "have its cached slug synchronized with its friendly_id" do
+        assert_equal @paris.my_slug, @paris.friendly_id
+      end
+
+    end
+
+
+    context "with a cached_slug column" do
+
+      setup do
+        District.delete_all
+        @district = District.new(:name => "Latin Quarter")
+        @district.save!
+      end
+
+      should "have its cached_slug filled automatically" do
+        assert_equal @district.cached_slug, "latin-quarter"
+      end
+
+    end
+
+  end
+
+end
+

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/city.rb

@@ -0,0 +1,4 @@
+class City < ActiveRecord::Base
+  attr_accessible :name
+  has_friendly_id :name, :use_slug => true, :cache_column => 'my_slug'
+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/district.rb

@@ -0,0 +1,3 @@
+class District < ActiveRecord::Base
+  has_friendly_id :name
+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