friendly_id 2.2.1 → 2.2.2

data/History.txt

@@ -1,3 +1,8 @@
+== 2.2.2 2009-10-26
+
+* 1 minor enhancement:
+  * Fixed Rake tasks creating duplicate slugs and not properly clearing cached slugs (closes GH issues #14 and #15)
+
 == 2.2.1 2009-10-23
 
 * 2 minor enhancements:

data/Manifest.txt

@@ -16,13 +16,17 @@ 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/tasks.rb
 lib/friendly_id/version.rb
 lib/tasks/friendly_id.rake
 lib/tasks/friendly_id.rb
+test/cached_slug_test.rb
 test/contest.rb
 test/custom_slug_normalizer_test.rb
 test/models/book.rb
+test/models/city.rb
 test/models/country.rb
+test/models/district.rb
 test/models/event.rb
 test/models/novel.rb
 test/models/person.rb
@@ -35,4 +39,5 @@ test/scoped_model_test.rb
 test/slug_test.rb
 test/slugged_model_test.rb
 test/sti_test.rb
+test/tasks_test.rb
 test/test_helper.rb

data/lib/friendly_id/tasks.rb

@@ -0,0 +1,57 @@
+module FriendlyId
+  class Tasks
+    class << self
+
+      def make_slugs(klass, options = {})
+        klass = parse_class_name(klass)
+        validate_uses_slugs(klass)
+        options = {:limit => 100, :include => :slugs, :order => "#{klass.table_name}.id ASC",
+          :conditions => "slugs.id IS NULL"}.merge(options)
+        while records = klass.find(:all, options) do
+          break if records.size == 0
+          records.each do |r|
+            r.save!
+            yield(r) if block_given?
+          end
+        end
+      end
+
+      def delete_slugs_for(klass)
+        klass = parse_class_name(klass)
+        validate_uses_slugs(klass)
+        Slug.destroy_all(["sluggable_type = ?", klass.to_s])
+        if klass.friendly_id_options[:cache_column]
+          klass.update_all("#{klass.friendly_id_options[:cache_column]} = NULL")
+        end
+      end
+
+      def delete_old_slugs(days = nil, class_name = nil)
+        days = days.blank? ? 45 : days.to_i
+        klass = class_name.blank? ? nil : parse_class_name(class_name.to_s)
+        conditions = ["created_at < ?", DateTime.now - days.days]
+        if klass
+          conditions[0] << " AND sluggable_type = ?"
+          conditions << klass.to_s
+        end
+        slugs = Slug.find :all, :conditions => conditions
+        slugs.each { |s| s.destroy unless s.is_most_recent? }
+      end
+
+      def parse_class_name(class_name)
+        return class_name if class_name.class == Class
+        if (class_name.split('::').size > 1)
+          class_name.split('::').inject(Kernel) {|scope, const_name| scope.const_get(const_name)}
+        else
+          Object.const_get(class_name)
+        end
+      end
+
+      private
+
+      def validate_uses_slugs(klass)
+        raise "Class '%s' doesn't use slugs" % klass.to_s unless klass.friendly_id_options[:use_slug]
+      end
+
+    end
+  end
+end

data/lib/friendly_id/version.rb

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

data/lib/tasks/friendly_id.rake

@@ -1,50 +1,27 @@
-# encoding: utf-8
+require "friendly_id/tasks"
 
 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
+    validate_model_given
+    FriendlyId::Tasks.make_slugs(ENV["MODEL"]) do |r|
+      puts "%s(%d) friendly_id set to '%s'" % [r.class.to_s, r.id, r.slug.name]
     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])
+    validate_model_given
+    FriendlyId::Tasks.delete_slugs_for(ENV["MODEL"])
     Rake::Task["friendly_id:make_slugs"].invoke
   end
 
-  desc "Kill obsolete slugs older than 45 days."
+  desc "Kill obsolete slugs older than DAYS=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
+    FriendlyId::Task.delete_old_slugs(ENV["DAYS"], ENV["MODEL"])
   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
+def validate_model_given
+  raise 'USAGE: rake friendly_id:make_slugs MODEL=MyModelName' if ENV["MODEL"].nil?
+end

data/test/cached_slug_test.rb

@@ -8,12 +8,15 @@ 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
 
+    teardown do
+      City.delete_all
+      Slug.delete_all
+    end
+
     should "have a slug" do
       assert_not_nil @paris.slug
     end

data/test/custom_slug_normalizer_test.rb

@@ -8,6 +8,9 @@ class CustomSlugNormalizerTest < Test::Unit::TestCase
 
     setup do
       Thing.friendly_id_options = FriendlyId::DEFAULT_FRIENDLY_ID_OPTIONS.merge(:column => :name, :use_slug => true)
+    end
+
+    teardown do
       Thing.delete_all
       Slug.delete_all
     end
@@ -29,7 +32,7 @@ class CustomSlugNormalizerTest < Test::Unit::TestCase
         Thing.create!(:name => "test")
       end
     end
-  
+
   end
 
-end
+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/district.rb

@@ -0,0 +1,3 @@
+class District < ActiveRecord::Base
+  has_friendly_id :name
+end

data/test/non_slugged_test.rb

@@ -7,10 +7,13 @@ 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
 
+    teardown do
+      User.delete_all
+    end
+
     should "have friendly_id options" do
       assert_not_nil User.friendly_id_options
     end
@@ -95,4 +98,4 @@ class NonSluggedTest < Test::Unit::TestCase
 
   end
 
-end
+end

data/test/scoped_model_test.rb

@@ -7,15 +7,18 @@ 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
 
+    teardown do
+      Person.delete_all
+      Country.delete_all
+      Slug.delete_all
+    end
+
     should "find all scoped records without scope" do
       assert_equal 2, Person.find(:all, @person.friendly_id).size
     end
@@ -50,4 +53,4 @@ class ScopedModelTest < Test::Unit::TestCase
 
   end
 
-end
+end

data/test/slug_test.rb

@@ -6,7 +6,7 @@ class SlugTest < Test::Unit::TestCase
 
   context "a slug" do
 
-    setup do
+    teardown do
       Slug.delete_all
       Post.delete_all
     end

data/test/slugged_model_test.rb

@@ -8,12 +8,15 @@ class SluggedModelTest < Test::Unit::TestCase
 
     setup do
       Post.friendly_id_options = FriendlyId::DEFAULT_FRIENDLY_ID_OPTIONS.merge(:column => :title, :use_slug => true)
+      @post = Post.new :title => "Test post", :content => "Test content", :published => true
+      @post.save!
+    end
+
+    teardown do
       Post.delete_all
       Person.delete_all
       Slug.delete_all
       Thing.delete_all
-      @post = Post.new :title => "Test post", :content => "Test content", :published => true
-      @post.save!
     end
 
     should "have friendly_id options" do

data/test/sti_test.rb

@@ -8,12 +8,15 @@ class STIModelTest < Test::Unit::TestCase
 
     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
 
+    teardown do
+      Novel.delete_all
+      Slug.delete_all
+    end
+
     should "have a slug" do
       assert_not_nil @novel.slug
     end

data/test/tasks_test.rb

@@ -0,0 +1,106 @@
+require File.dirname(__FILE__) + '/test_helper'
+require "friendly_id/tasks"
+require "mocha"
+
+class TasksTest < Test::Unit::TestCase
+
+  context "FriendlyId tasks" do
+
+    should "parse a top-level class name and return a class" do
+      assert_equal String, FriendlyId::Tasks.parse_class_name("String")
+    end
+
+    should "parse a namespaced class name and return a class" do
+      assert_equal Test::Unit, FriendlyId::Tasks.parse_class_name("Test::Unit")
+    end
+
+  end
+
+  context "The 'make slugs' task" do
+
+    setup do
+      City.create! :name => "Buenos Aires"
+      City.create! :name => "Rio de Janeiro"
+      City.create! :name => "Tokyo"
+      City.create! :name => "Nairobi"
+      Slug.delete_all
+    end
+
+    teardown do
+      City.delete_all
+      Slug.delete_all
+    end
+
+    should "make one slug per model" do
+      assert_equal 0, Slug.count
+      FriendlyId::Tasks.make_slugs("City")
+      assert_equal 4, Slug.count
+    end
+
+  end
+
+  context "The 'delete_slugs_for' task" do
+
+    setup do
+      @post = Post.create! :title => "Slugs Considered Harmful"
+      @city = City.create! :name => "Buenos Aires"
+    end
+
+    teardown do
+      Post.delete_all
+      City.delete_all
+      Slug.delete_all
+    end
+
+    should "Delete only slugs for the specified model" do
+      assert_equal 2, Slug.count
+      FriendlyId::Tasks.delete_slugs_for("City")
+      assert_equal 1, Slug.count
+    end
+
+    should "set the cached_slug column to NULL" do
+      FriendlyId::Tasks.delete_slugs_for("City")
+      @city.reload
+      assert_nil @city.my_slug
+    end
+
+  end
+
+  context "The 'delete_old_slugs' task" do
+
+    setup do
+      @post = Post.create! :title => "Slugs Considered Harmful"
+      @city = City.create! :name => "Buenos Aires"
+      City.connection.execute "UPDATE slugs SET created_at = '%s' WHERE id = %d" % [
+        45.days.ago.strftime("%Y-%m-%d"), @city.slug.id]
+      @city.name = "Ciudad de Buenos Aires"
+      @city.save!
+    end
+
+    teardown do
+      Post.delete_all
+      City.delete_all
+      Slug.delete_all
+    end
+
+    should "delete slugs older than 45 days by default" do
+      assert_equal 3, Slug.count
+      FriendlyId::Tasks.delete_old_slugs
+      assert_equal 2, Slug.count
+    end
+
+    should "respect the days argument" do
+      assert_equal 3, Slug.count
+      FriendlyId::Tasks.delete_old_slugs(100)
+      assert_equal 3, Slug.count
+    end
+
+    should "respect the class argument" do
+      assert_equal 3, Slug.count
+      FriendlyId::Tasks.delete_old_slugs(1, "Post")
+      assert_equal 3, Slug.count
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: friendly_id
 version: !ruby/object:Gem::Version 
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors: 
 - Norman Clarke
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-23 00:00:00 -03:00
+date: 2009-10-26 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -96,13 +96,17 @@ files:
 - lib/friendly_id/slug.rb
 - lib/friendly_id/sluggable_class_methods.rb
 - lib/friendly_id/sluggable_instance_methods.rb
+- lib/friendly_id/tasks.rb
 - lib/friendly_id/version.rb
 - lib/tasks/friendly_id.rake
 - lib/tasks/friendly_id.rb
+- test/cached_slug_test.rb
 - test/contest.rb
 - test/custom_slug_normalizer_test.rb
 - test/models/book.rb
+- test/models/city.rb
 - test/models/country.rb
+- test/models/district.rb
 - test/models/event.rb
 - test/models/novel.rb
 - test/models/person.rb
@@ -115,6 +119,7 @@ files:
 - test/slug_test.rb
 - test/slugged_model_test.rb
 - test/sti_test.rb
+- test/tasks_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://friendly-id.rubyforge.org/
@@ -153,3 +158,4 @@ test_files:
 - test/slug_test.rb
 - test/slugged_model_test.rb
 - test/sti_test.rb
+- test/tasks_test.rb