friendly_id 2.2.5 → 2.2.6

data/History.txt

@@ -1,8 +1,21 @@
+== 2.2.6 2009-12-10
+
+* 2 major fixes
+  * Made cached_slug automagic configuration occur outside of has_friendly_id. This was causing problems
+    in code where the class is loaded before ActiveRecord has established its connection.
+  * Fixes for scope feature with Postgres (Ben Woosley)
+
+* 2 minor enhancements
+  * Migrated away from Hoe/Newgem for gem management.
+  * Made tests database-agnostic (Ben Woosley)
+
 == 2.2.5 2009-11-30
+
 * 1 minor fix
   * Fixed typo which in config options (Steven Noble).
 
 == 2.2.4 2009-11-12
+
 * 1 minor fix
   * Fixed typo in post-install message.
 

data/README.rdoc

@@ -12,9 +12,8 @@ instead of:
 
   http://example.com/states/4323454
 
-Want to find out more? Read on. The {most recent version of the FriendlyId
-RDocs}[http://friendly-id.rubyforge.org] can always be found on
-Rubyforge[http://www.rubyforge.org].
+You can always read the latest version of this document at the {friendly_id page on
+rdoc.info}[http://rdoc.info/projects/norman/friendly_id].
 
 === Why?
 
@@ -294,8 +293,7 @@ discouraged:
 == Setting it up
 
 The current release works with Rails 2.2 and above, and is compatible with
-Ruby 1.8 and 1.9. If you need support for Rails 2.0 - 2.1, you need to install
-an older version of FriendlyId. Here's how to set it up.
+Ruby 1.8 and 1.9.
 
 1) Install the Gem:
 
@@ -363,6 +361,7 @@ particular from the following people:
 * Adam Cigánek
 * Alistair Holt
 * Andrew Loe III
+* Ben Woosley
 * Bence Nagy
 * Bruno Michel
 * Chris Nolan
@@ -378,6 +377,7 @@ particular from the following people:
 * Rob Ingram
 * Sean Abrahams
 * Steve Luscher
+* Steven Noble
 * Tim Kadom
 
 Copyright (c) 2008 Norman Clarke, Adrian Mugnolo and Emilio Tagua, released

data/Rakefile

@@ -1,46 +1,35 @@
-require 'newgem'
-require 'hoe'
-require 'lib/friendly_id/version'
-require 'hoe'
-
-Hoe.spec "friendly_id" do
-  self.version = FriendlyId::Version::STRING
-  self.rubyforge_name = "friendly-id"
-  self.author = ['Norman Clarke', 'Adrian Mugnolo', 'Emilio Tagua']
-  self.email = ['norman@njclarke.com', 'adrian@mugnolo.com', 'miloops@gmail.com']
-  self.summary = "A comprehensive slugging and pretty-URL plugin for ActiveRecord."
-  self.description = 'A comprehensive slugging and pretty-URL plugin for Rails apps using ActiveRecord.'
-  self.url = 'http://friendly-id.rubyforge.org/'
-  self.test_globs = ['test/**/*_test.rb']
-  self.extra_deps << ['activerecord', '>= 2.2.3']
-  self.extra_deps << ['activesupport', '>= 2.2.3']
-  self.extra_dev_deps << ['newgem', ">= #{::Newgem::VERSION}"]
-  self.extra_dev_deps << ['sqlite3-ruby']
-  self.remote_rdoc_dir = ""
-	self.readme_file = "README.rdoc"
-  self.extra_rdoc_files = ["README.rdoc"]
-  self.post_install_message = <<-EOM
-
-    ***********************************************************
-
-      If you are upgrading friendly_id, please run
-
-          ./script/generate friendly_id --skip-migration
-
-      in your Rails application to ensure that you have the
-      latest friendly_id Rake tasks.
-
-    ***********************************************************
-
-  EOM
+require 'rake'
+require 'rake/testtask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/clean'
+
+CLEAN	<< "pkg" << "docs" << "coverage"
+
+task :default => :test
+
+Rake::TestTask.new(:test) { |t| t.pattern = 'test/**/*_test.rb' }
+Rake::GemPackageTask.new(eval(File.read("friendly_id.gemspec"))) { |pkg| }
+Rake::RDocTask.new do |r|
+	r.rdoc_dir = "docs"
+	r.main = "README.rdoc"
+	r.rdoc_files.include "README.rdoc", "History.txt", "lib/**/*.rb"
 end
 
-require 'newgem/tasks'
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new do |t|
+    t.options = ["--output-dir=docs"]
+  end
+rescue LoadError
+end
 
-desc 'Publish RDoc to RubyForge.'
-task :publish_docs => [:clean, :docs] do
-  host = "compay@rubyforge.org"
-  remote_dir = "/var/www/gforge-projects/friendly-id"
-  local_dir = 'doc'
-  sh %{rsync -av --delete #{local_dir}/ #{host}:#{remote_dir}}
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |r|
+    r.test_files = FileList['test/*_test.rb']
+    r.verbose = true
+    r.rcov_opts << "--exclude gems/*"
+  end
+rescue LoadError
 end

data/extras/README.txt

@@ -0,0 +1,3 @@
+These templates are here to generate FriendlyId-enabled Rails apps for
+testing. They are for developers, they are not intended for generating
+"real" applications.

data/extras/template-gem.rb

@@ -0,0 +1,26 @@
+run "rm public/index.html"
+gem "friendly_id"
+gem "haml"
+gem "will_paginate"
+run "haml --rails ."
+generate "friendly_id"
+generate :haml_scaffold, "post title:string"
+route "map.root :controller => 'posts', :action => 'index'"
+rake "db:migrate"
+rake "db:fixtures:load"
+file 'app/models/post.rb',
+%q{class Post < ActiveRecord::Base
+  has_friendly_id :title, :use_slug => true
+end}
+file 'test/fixtures/slugs.yml',
+%q{
+one:
+  name: mystring
+  sequence: 1
+  sluggable: one (Post)
+
+two:
+  name: mystring
+  sequence: 2
+  sluggable: two (Post)
+}

data/extras/template-plugin.rb

@@ -0,0 +1,28 @@
+run "rm public/index.html"
+inside 'vendor/plugins' do
+  run "git clone ../../../../ friendly_id"
+end
+gem "haml"
+gem "will_paginate"
+run "haml --rails ."
+generate "friendly_id"
+generate :haml_scaffold, "post title:string"
+route "map.root :controller => 'posts', :action => 'index'"
+rake "db:migrate"
+rake "db:fixtures:load"
+file 'app/models/post.rb',
+%q{class Post < ActiveRecord::Base
+  has_friendly_id :title, :use_slug => true
+end}
+file 'test/fixtures/slugs.yml',
+%q{
+one:
+  name: mystring
+  sequence: 1
+  sluggable: one (Post)
+
+two:
+  name: mystring
+  sequence: 2
+  sluggable: two (Post)
+}

data/lib/friendly_id.rb

@@ -70,6 +70,6 @@ module FriendlyId
   end
 end
 
-class ActiveRecord::Base
-  extend FriendlyId
+class ActiveRecord::Base #:nodoc:#
+  extend FriendlyId #:nodoc:#
 end

data/lib/friendly_id/non_sluggable_class_methods.rb

@@ -5,7 +5,7 @@ module FriendlyId::NonSluggableClassMethods
   protected
 
   def find_one(id, options) #:nodoc:#
-    if id.is_a?(String) && result = send("find_by_#{ friendly_id_options[:method] }", id, options)
+    if id.respond_to?(:to_str) && result = send("find_by_#{ friendly_id_options[:method] }", id.to_str, options)
       result.send(:found_using_friendly_id=, true)
     else
       result = super id, options
@@ -15,9 +15,10 @@ module FriendlyId::NonSluggableClassMethods
 
   def find_some(ids_and_names, options) #:nodoc:#
 
+    names, ids = ids_and_names.partition {|id_or_name| id_or_name.respond_to?(:to_str) && id_or_name.to_str }
     results = with_scope :find => options do
-      find :all, :conditions => ["#{quoted_table_name}.#{primary_key} IN (?) OR #{friendly_id_options[:method].to_s} IN (?)",
-        ids_and_names, ids_and_names]
+      find :all, :conditions => ["#{quoted_table_name}.#{primary_key} IN (?) OR #{friendly_id_options[:method]} IN (?)",
+        ids, names]
     end
 
     expected = expected_size(ids_and_names, options)
@@ -25,7 +26,7 @@ module FriendlyId::NonSluggableClassMethods
       raise ActiveRecord::RecordNotFound, "Couldn't find all #{ name.pluralize } with IDs (#{ ids_and_names * ', ' }) AND #{ sanitize_sql options[:conditions] } (found #{ results.size } results, but was looking for #{ expected })"
     end
 
-    results.each {|r| r.send(:found_using_friendly_id=, true) if ids_and_names.include?(r.friendly_id)}
+    results.each {|r| r.send(:found_using_friendly_id=, true) if names.include?(r.friendly_id)}
 
     results
 

data/lib/friendly_id/sluggable_class_methods.rb

@@ -6,6 +6,7 @@ module FriendlyId::SluggableClassMethods
   def find_one(id_or_name, options) #:nodoc:#
 
     scope = options.delete(:scope)
+    scope = scope.to_param if scope && scope.respond_to?(:to_param)
 
     if id_or_name.is_a?(Integer) || id_or_name.kind_of?(ActiveRecord::Base)
       return super(id_or_name, options)
@@ -23,7 +24,6 @@ module FriendlyId::SluggableClassMethods
     }
 
     result = with_scope(:find => find_options) { find_initial(options) }
-
     if result
       result.finder_slug_name = id_or_name
     elsif id_or_name.to_i.to_s != id_or_name

data/lib/friendly_id/sluggable_instance_methods.rb

@@ -1,18 +1,31 @@
 module FriendlyId::SluggableInstanceMethods
 
   def self.included(base)
-    base.has_many :slugs, :order => 'id DESC', :as => :sluggable, :dependent => :destroy
-    base.before_save :set_slug
-    base.after_save :set_slug_cache
-    unless base.friendly_id_options[:cache_column]
-      if base.columns.any? { |c| c.name == 'cached_slug' }
-        base.friendly_id_options[:cache_column] = :cached_slug
+    base.class_eval do
+      has_many :slugs, :order => 'id DESC', :as => :sluggable, :dependent => :destroy
+      before_save :set_slug
+      after_save :set_slug_cache
+      # only protect the column if the class is not already using attributes_accessible
+      if !accessible_attributes
+        if friendly_id_options[:cache_column]
+          attr_protected friendly_id_options[:cache_column].to_sym
+        end
+        attr_protected :cached_slug
       end
     end
-    # only protect the column if the class is not already using attributes_accessible
-    if base.friendly_id_options[:cache_column] && !base.accessible_attributes
-      base.attr_protected base.friendly_id_options[:cache_column].to_sym
+
+    def base.cache_column
+      if defined?(@cache_column)
+        return @cache_column
+      elsif friendly_id_options[:cache_column]
+        @cache_column = friendly_id_options[:cache_column].to_sym
+      elsif columns.any? { |c| c.name == 'cached_slug' }
+        @cache_column = :cached_slug
+      else
+        @cache_column = nil
+      end
     end
+
   end
 
   NUM_CHARS_RESERVED_FOR_FRIENDLY_ID_EXTENSION = 2
@@ -36,9 +49,7 @@ module FriendlyId::SluggableInstanceMethods
 
   # Was the record found using an old friendly id?
   def found_using_outdated_friendly_id?
-    if cache = friendly_id_options[:cache_column]
-      return false if send(cache) == @finder_slug_name
-    end
+    return false if cache_column && send(cache_column) == @finder_slug_name
     finder_slug.id != slug.id
   end
 
@@ -73,10 +84,11 @@ module FriendlyId::SluggableInstanceMethods
 
   # Returns the friendly id, or if none is available, the numeric id.
   def to_param
-    if cache = friendly_id_options[:cache_column]
-      return read_attribute(cache) || id.to_s
+    if cache_column
+      read_attribute(cache_column) || id.to_s
+    else
+      slug ? slug.to_friendly_id : id.to_s
     end
-    slug ? slug.to_friendly_id : id.to_s
   end
 
   # Get the processed string used as the basis of the friendly id.
@@ -105,6 +117,10 @@ module FriendlyId::SluggableInstanceMethods
 
 private
 
+  def cache_column
+    self.class.cache_column
+  end
+
   def finder_slug=(finder_slug)
     @finder_slug_name = finder_slug.name
     slug = finder_slug
@@ -130,14 +146,14 @@ private
       end
       # If we're renaming back to a previously used friendly_id, delete the
       # slug so that we can recycle the name without having to use a sequence.
-      slugs.find(:all, :conditions => {:name => slug_text, :scope => scope}).each { |s| s.destroy }
+      slugs.find(:all, :conditions => {:name => slug_text, :scope => slug_attributes[:scope]}).each { |s| s.destroy }
       slugs.build slug_attributes
     end
   end
 
   def set_slug_cache
-    if friendly_id_options[:cache_column] && send(friendly_id_options[:cache_column]) != slug.to_friendly_id
-      send "#{friendly_id_options[:cache_column]}=", slug.to_friendly_id
+    if cache_column && send(cache_column) != slug.to_friendly_id
+      send "#{cache_column}=", slug.to_friendly_id
       send :update_without_callbacks
     end
   end

data/lib/friendly_id/tasks.rb

@@ -19,8 +19,8 @@ module FriendlyId
         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")
+        if klass.cache_column
+          klass.update_all("#{klass.cache_column} = NULL")
         end
       end
 

data/lib/friendly_id/version.rb

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

data/test/cached_slug_test.rb

@@ -1,6 +1,3 @@
-# encoding: utf-8!
-require "mocha"
-
 require File.dirname(__FILE__) + '/test_helper'
 
 class CachedSlugModelTest < Test::Unit::TestCase

data/test/custom_slug_normalizer_test.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require File.dirname(__FILE__) + '/test_helper'
 
 class CustomSlugNormalizerTest < Test::Unit::TestCase
@@ -7,29 +5,29 @@ class CustomSlugNormalizerTest < Test::Unit::TestCase
   context "A slugged model using a custom slug generator" do
 
     setup do
-      Thing.friendly_id_options = FriendlyId::DEFAULT_OPTIONS.merge(:method => :name, :use_slug => true)
+      Person.friendly_id_options = FriendlyId::DEFAULT_OPTIONS.merge(:method => :name, :use_slug => true)
     end
 
     teardown do
-      Thing.delete_all
+      Person.delete_all
       Slug.delete_all
     end
 
     should "invoke the block code" do
-      thing = Thing.create!(:name => "test")
-      assert_equal "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3", thing.friendly_id
+      @person = Person.create!(:name => "Joe Schmoe")
+      assert_equal "JOE SCHMOE", @person.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
+      Person.friendly_id_options = Person.friendly_id_options.merge(:max_length => 3)
+      @person = Person.create!(:name => "Joe Schmoe")
+      assert_equal "JOE", @person.friendly_id
     end
 
     should "respect the reserved option" do
-      Thing.friendly_id_options = Thing.friendly_id_options.merge(:reserved => ["a94a8fe5ccb19ba61c4c0873d391e987982fbbd3"])
+      Person.friendly_id_options = Person.friendly_id_options.merge(:reserved => ["JOE"])
       assert_raises FriendlyId::SlugGenerationError do
-        Thing.create!(:name => "test")
+        Person.create!(:name => "Joe")
       end
     end
 

data/test/non_slugged_test.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require File.dirname(__FILE__) + '/test_helper'
 
 class NonSluggedTest < Test::Unit::TestCase
@@ -7,7 +5,7 @@ class NonSluggedTest < Test::Unit::TestCase
   context "A non-slugged model with default FriendlyId options" do
 
     setup do
-      @user = User.create!(:login => "joe", :email => "joe@example.org")
+      @user = User.create!(:name => "joe")
     end
 
     teardown do
@@ -52,7 +50,7 @@ class NonSluggedTest < Test::Unit::TestCase
     end
 
     should "not validate if the friendly_id text is reserved" do
-      user = User.new(:login => "new", :email => "test@example.org")
+      user = User.new(:name => "new")
       assert !user.valid?
     end
 
@@ -61,7 +59,7 @@ class NonSluggedTest < Test::Unit::TestCase
     end
 
     should "return its id if the friendly_id is null" do
-      @user.login = nil
+      @user.name = nil
       assert_equal @user.id.to_s, @user.to_param
     end
 
@@ -69,7 +67,7 @@ class NonSluggedTest < Test::Unit::TestCase
     context "when using an array as the find argument" do
 
       setup do
-        @user2 = User.create(:login => "jane", :email => "jane@example.org")
+        @user2 = User.create(:name => "jane")
       end
 
       should "return results" do
@@ -89,7 +87,7 @@ class NonSluggedTest < Test::Unit::TestCase
       end
 
       should "indicate if the results were found using a friendly_id" do
-        users = User.find([@user.id, @user2.friendly_id], :order => "login ASC")
+        users = User.find([@user.id, @user2.friendly_id], :order => "name ASC")
         assert users[0].found_using_friendly_id?
         assert users[1].found_using_numeric_id?
       end