friendly_id 2.3.4 → 3.0.0.beta1

data/Changelog.md

@@ -6,6 +6,16 @@ suggestions, ideas and improvements to FriendlyId.
 * Table of Contents
 {:toc}
 
+## 3.0.0 (NOT RELEASED YET)
+
+* Rails 3 support.
+* Removed features deprecated in FriendlyId 2.3.
+
+## 2.3.5 (NOT RELEASED YET)
+
+* Fixed searching by numeric friendly_id in non-slugged models.
+* Added allow_nil option (Andre Duffeck and Norman Clarke)
+
 ## 2.3.4 (2010-03-22)
 
 * Made slugged status use the slug sequence. This fixes problems with #best?

data/Contributors.md

@@ -4,6 +4,7 @@ community, in particular from the following people:
 * Adam Cigánek
 * Alexander Gräfe
 * Alistair Holt
+* Andre Duffeck
 * Andrew Loe III
 * Ben Woosley
 * Bence Nagy

data/Guide.md

@@ -66,7 +66,7 @@ These features are explained in detail {file:Guide.md#features below}.
 ## Installation
 
 FriendlyId can be installed as a gem, or as a Rails plugin. It is compatible
-with Rails 2.2.x, 2.3.x. Support for Rails 3.x is in progress.
+with Rails 2.2.x, 2.3.x. and 3.0.
 
 ### As a Gem
 
@@ -76,7 +76,13 @@ with Rails 2.2.x, 2.3.x. Support for Rails 3.x is in progress.
 
 After installing the gem, add an entry in environment.rb:
 
-    config.gem "friendly_id", :version => ">= 2.3"
+    config.gem "friendly_id", :version => "~> 2.3"
+    
+### Rails 3.0
+
+After installing the gem, add an entry in the Gemfile:
+
+    gem "friendly_id", "~> 3.0"
 
 ### As a Plugin
 
@@ -85,8 +91,8 @@ Plugin installation is simple for all supported versions of Rails:
     ./script/plugin install git://github.com/norman/friendly_id.git
 
 However, installing as a gem offers simpler version control than plugin
-installation. Whenever possible, install as a gem instead. Plugin support will
-probably be removed in version 3.0.
+installation. Whenever possible, install as a gem instead. Plugin support may
+eventually be removed in a future version.
 
 ### Setup
 
@@ -384,6 +390,24 @@ You can also use a different name for the column if you choose, via the
     end
 
 
+## Nil slugs and skipping validations
+
+You can choose to allow `nil` friendly_ids via the `:allow_nil` config option:
+
+    class User < ActiveRecord::Base
+      has_friendly_id :name, :allow_nil => true
+    end
+
+This works whether the model uses slugs or not.
+
+For slugged models, if the friendly_id text is `nil`, no slug will be created. This can be useful, for example, to only create slugs for published articles and avoid creating many slugs with sequences.
+
+For models that don't use slugs, this will make FriendlyId skip all its validations when the friendly_id text is `nil`. This can be useful, for example, if you wish to add the friendly_id value in an `:after_save` callback.
+
+For non-slugged models, if you simply wish to skip friendly_ids's validations
+for some reason, you can override the `skip_friendly_id_validations` method.
+Note that this method is **not** used by slugged models.
+
 ## Scoped Slugs
 
 FriendlyId can generate unique slugs within a given scope. For example, assume
@@ -467,6 +491,16 @@ Use this task if you wish to delete expired slugs; manually or perhaps via
 cron. If you don't specify the days option, the default is to remove unused
 slugs older than 45 days.
 
+# Misc tips
+
+## MySQL 5.0 or less
+
+Currently, the default FriendlyId migration will not work with MySQL 5.0 or less
+because it creates and index that's too large. The easiest way to work around
+this is to change the generated migration to add limits on some column lengths.
+Please see [this issue](http://github.com/norman/friendly_id/issues#issue/50) in
+the FriendlyId issue tracker for more information.
+
 # Hacking FriendlyId
 
 A couple of notes for programmers intending to work on FriendlyId:
@@ -478,6 +512,15 @@ Before removing any public or protected methods, FriendlyId will deprecate
 them through one major release cycle. Private methods may, however, change at
 any time.
 
+## Running the Tests
+
+FriendlyId uses [Bundler](http://github.com/carlhuda/bundler) to manage its gem
+dependencies. To run the tests, first make sure you have bundler installed.
+Then, copy Gemfile.default to Gemfile. If you wish to test against different gem
+versions than the ones specifed in the Gemfile (for example, to test with
+Postgres or MySQL rather than SQLite3, or to test against different versions of
+ActiveRecord), then simply modify the Gemfile to suit your dependencies.
+
 ## Some Benchmarks
 
 These benchmarks can give you an idea of FriendlyId's impact on the
@@ -491,6 +534,7 @@ own solution is unlikely to be any faster than FriendlyId with cached slugs
 enabled. But if it is, then your patches would be very welcome!
 
     ruby 1.9.1p378 (2010-01-10 revision 26273) [i386-darwin10.2.0]
+    activerecord (2.3.5)
     friendly_id (2.3.0)
     sqlite3 3.6.19 in-memory database
     ------------------------------------------------------------------------------------------------

data/README.md

@@ -19,6 +19,8 @@ versioning, scoped slugs, reserved words, custom slug generators, and
 excellent Unicode support. For complete information on using FriendlyId,
 please see the {http://norman.github.com/friendly_id/file.Guide.html FriendlyId Guide}.
 
+FriendlyId is compatible with Rails 2.2.x - 3.0.
+
 ## Rails Quickstart
 
     gem install friendly_id
@@ -27,11 +29,11 @@ please see the {http://norman.github.com/friendly_id/file.Guide.html FriendlyId
 
     cd my_app
 
-    # add to config/environment.rb
-    config.gem "friendly_id", :version => ">= 2.3.0"
+    # add to Gemfile
+    gem "friendly_id", "~> 3.0"
 
-    ./script/generate friendly_id
-    ./script/generate scaffold user name:string cached_slug:string
+    rails generate friendly_id
+    rails generate scaffold user name:string cached_slug:string
 
     rake db:migrate
 

data/Rakefile

@@ -44,7 +44,7 @@ namespace :test do
     sh "cd fid; rake test"
   end
   Rake::TestTask.new(:friendly_id) { |t| t.pattern = "test/*_test.rb" }
-  Rake::TestTask.new(:ar) { |t| t.pattern = "test/active_record2/*_test.rb" }
+  Rake::TestTask.new(:ar) { |t| t.pattern = "test/acktive_record/*_test.rb" }
   
   namespace :rails do
     task :plugin do

data/extras/extras.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby -KU
 require File.dirname(__FILE__) + '/../test/test_helper'
-require File.dirname(__FILE__) + '/../test/active_record2/test_helper'
+require File.dirname(__FILE__) + '/../test/acktive_record/test_helper'
 require 'ffaker'
 
 TIMES = (ENV['N'] || 100).to_i

data/generators/friendly_id/friendly_id_generator.rb

@@ -7,7 +7,7 @@ class FriendlyIdGenerator < Rails::Generator::Base
       end
       unless options[:skip_tasks]
         m.directory "lib/tasks"
-        m.file "/../../../lib/friendly_id/active_record2/tasks/friendly_id.rake", "lib/tasks/friendly_id.rake"
+        m.file "/../../../lib/friendly_id/acktive_record/tasks/friendly_id.rake", "lib/tasks/friendly_id.rake"
       end
     end
   end

data/lib/friendly_id.rb

@@ -1,9 +1,12 @@
+require "active_support/core_ext/class/attribute_accessors"
 require File.join(File.dirname(__FILE__), "friendly_id", "slug_string")
 require File.join(File.dirname(__FILE__), "friendly_id", "configuration")
 require File.join(File.dirname(__FILE__), "friendly_id", "status")
 require File.join(File.dirname(__FILE__), "friendly_id", "finders")
 require File.join(File.dirname(__FILE__), "friendly_id", "slugged")
 
+
+
 # FriendlyId is a comprehensive Ruby library for slugging and permalinks with
 # ActiveRecord.
 # @author Norman Clarke
@@ -30,11 +33,6 @@ module FriendlyId
     # @param [Hash] options For valid configuration options, see
     #   {FriendlyId::Configuration}.
     #
-    # @param [block] block An optional block through which to filter the
-    #   friendly_id text; see {FriendlyId::Configuration#normalizer}. Note that
-    #   passing a block parameter is now deprecated and will be removed
-    #   from FriendlyId 3.0.
-    #
     # @example
     #
     #   class User < ActiveRecord::Base
@@ -46,7 +44,7 @@ module FriendlyId
     #   end
     #
     # @see FriendlyId::Configuration
-    def has_friendly_id(method, options = {}, &block)
+    def has_friendly_id(method, options = {})
       raise NotImplementedError
     end
 

data/lib/friendly_id/{active_record2 → acktive_record}/configuration.rb

@@ -1,5 +1,5 @@
 module FriendlyId
-  module ActiveRecord2
+  module AcktiveRecord
 
     class Configuration < FriendlyId::Configuration
 
@@ -7,7 +7,7 @@ module FriendlyId
       # FriendlyId will look for a column named +cached_slug+ and use it automatically
       # if it exists. If for some reason you have a column named +cached_slug+
       # but don't want FriendlyId to modify it, pass the option
-      # +:cache_column => false+ to {FriendlyId::ActiveRecord2#has_friendly_id has_friendly_id}.
+      # +:cache_column => false+ to {FriendlyId::AcktiveRecord#has_friendly_id has_friendly_id}.
       attr_accessor :cache_column
 
       # An array of classes for which the configured class serves as a

data/lib/friendly_id/{active_record2 → acktive_record}/finders.rb

@@ -2,7 +2,7 @@ module FriendlyId
 
   # The adapter for Ruby on Rails's ActiveRecord. Compatible with AR 2.2.x -
   # 2.3.x.
-  module ActiveRecord2
+  module AcktiveRecord
 
     # The classes in this module are used internally by FriendlyId, and exist
     # largely to avoid polluting the ActiveRecord models with too many
@@ -22,10 +22,10 @@ module FriendlyId
         attr :model_class
         attr :options
 
-        def initialize(ids, model_class, options={})
-          @ids = ids
+        def initialize(model_class, *args, &block)
           @model_class = model_class
-          @options = options
+          @ids = args.shift
+          @options = args.first.kind_of?(Hash) ? args.first : {}
         end
 
         def method_missing(symbol, *args)
@@ -37,22 +37,20 @@ module FriendlyId
           @finder ||= finder_class.new(ids, model_class, options)
         end
 
-        private
-
         def finder_class
           @finder_class ||= slugged? ? slugged_finder_class : simple_finder_class
         end
 
+        def multiple?
+          ids.kind_of? Array
+        end
+
         private
 
         def cache_available?
           !! model_class.friendly_id_config.cache_column
         end
 
-        def multiple?
-          ids.kind_of? Array
-        end
-
         def multiple_slugged_finder_class
           use_cache? ? SluggedModel::CachedMultipleFinder : SluggedModel::MultipleFinder
         end
@@ -136,5 +134,21 @@ module FriendlyId
       end
 
     end
+
+    # The methods in this module override ActiveRecord's +find_one+ and
+    # +find_some+ to add FriendlyId's features.
+    module FinderMethods
+
+      def find(*args, &block)
+        finder = Finders::FinderProxy.new(self, *args, &block)
+        if finder.multiple?
+          finder.find
+        else
+          finder.unfriendly? ? super : finder.find or super
+        end
+      end
+
+    end
+
   end
 end

data/lib/friendly_id/{active_record2 → acktive_record}/simple_model.rb

@@ -1,5 +1,5 @@
 module FriendlyId
-  module ActiveRecord2
+  module AcktiveRecord
 
     module SimpleModel
 
@@ -21,11 +21,11 @@ module FriendlyId
       class MultipleFinder
 
         include FriendlyId::Finders::Base
-        include FriendlyId::ActiveRecord2::Finders::Multiple
+        include FriendlyId::AcktiveRecord::Finders::Multiple
         include SimpleFinder
 
         def find
-          @results = with_scope(:find => options) { find_every :conditions => conditions }
+          @results = model_class.scoped(:conditions => conditions).scoped(options).all(options)
           raise(::ActiveRecord::RecordNotFound, error_message) if @results.size != expected_size
           friendly_results.each { |result| result.friendly_id_status.name = result.to_param }
           @results
@@ -50,7 +50,7 @@ module FriendlyId
         include SimpleFinder
 
         def find
-          result = with_scope(:find => find_options) { find_initial options }
+          result = model_class.scoped(find_options).first(options)
           raise ::ActiveRecord::RecordNotFound.new if friendly? && !result
           result.friendly_id_status.name = id if result
           result
@@ -64,56 +64,14 @@ module FriendlyId
 
       end
 
-      # The methods in this module override ActiveRecord's +find_one+ and
-      # +find_some+ to add FriendlyId's features.
-      module FinderMethods
-        protected
-
-        def find_one(id, options)
-          finder = Finders::FinderProxy.new(id, self, options)
-          !finder.friendly? ? super : finder.find
-        end
-
-        def find_some(ids_and_names, options)
-          Finders::FinderProxy.new(ids_and_names, self, options).find
-        end
-      end
-
-      # These methods will be removed in FriendlyId 3.0.
-      module DeprecatedMethods
-
-        # Was the record found using one of its friendly ids?
-        # @deprecated Please use #friendly_id_status.friendly?
-        def found_using_friendly_id?
-          warn("found_using_friendly_id? is deprecated and will be removed in 3.0. Please use #friendly_id_status.friendly?")
-          friendly_id_status.friendly?
-        end
-
-        # Was the record found using its numeric id?
-        # @deprecated Please use #friendly_id_status.numeric?
-        def found_using_numeric_id?
-          warn("found_using_numeric_id is deprecated and will be removed in 3.0. Please use #friendly_id_status.numeric?")
-          friendly_id_status.numeric?
-        end
-
-        # Was the record found using an old friendly id, or its numeric id?
-        # @deprecated Please use !#friendly_id_status.best?
-        def has_better_id?
-          warn("has_better_id? is deprecated and will be removed in 3.0. Please use !#friendly_id_status.best?")
-          ! friendly_id_status.best?
-        end
-
-      end
-
       def self.included(base)
         base.class_eval do
           column = friendly_id_config.column
-          validate :validate_friendly_id
-          validates_presence_of column
-          validates_length_of column, :maximum => friendly_id_config.max_length
+          validate :validate_friendly_id, :unless => :skip_friendly_id_validations
+          validates_presence_of column, :unless => :skip_friendly_id_validations
+          validates_length_of column, :maximum => friendly_id_config.max_length, :unless => :skip_friendly_id_validations
           after_update :update_scopes
-          extend FinderMethods
-          include DeprecatedMethods
+          extend FriendlyId::AcktiveRecord::FinderMethods
         end
       end
 
@@ -150,6 +108,10 @@ module FriendlyId
         end
       end
 
+      def skip_friendly_id_validations
+        friendly_id.nil? && self.class.friendly_id_config.allow_nil?
+      end
+
       def validate_friendly_id
         if result = friendly_id_config.reserved_error_message(friendly_id)
           self.errors.add(*result)

data/lib/friendly_id/acktive_record/slug.rb

@@ -0,0 +1,66 @@
+# A Slug is a unique, human-friendly identifier for an ActiveRecord.
+class Slug < ::ActiveRecord::Base
+
+  table_name = "slugs"
+  belongs_to :sluggable, :polymorphic => true
+  before_save :enable_name_reversion, :set_sequence
+  validate :validate_name
+  send FriendlyId::AcktiveRecord::Compat.scope_method, :similar_to, lambda {|slug| {:conditions => {
+        :name           => slug.name,
+        :scope          => slug.scope,
+        :sluggable_type => slug.sluggable_type
+      },
+      :order => "sequence ASC"
+    }
+  }
+
+  # Whether this slug is the most recent of its owner's slugs.
+  def current?
+    sluggable.slug == self
+  end
+
+  def outdated?
+    !current?
+  end
+
+  def to_friendly_id
+    sequence > 1 ? friendly_id_with_sequence : name
+  end
+
+  # Raise a FriendlyId::SlugGenerationError if the slug name is blank.
+  def validate_name
+    if name.blank?
+      raise FriendlyId::BlankError.new("slug.name can not be blank.")
+    end
+  end
+
+  private
+
+  # 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.
+  def enable_name_reversion
+    sluggable.slugs.find_all_by_name_and_scope(name, scope).each { |slug| slug.destroy }
+  end
+
+  def friendly_id_with_sequence
+    "#{name}#{separator}#{sequence}"
+  end
+
+  def similar_to_other_slugs?
+    !similar_slugs.empty?
+  end
+
+  def similar_slugs
+    self.class.similar_to(self)
+  end
+
+  def separator
+    sluggable.friendly_id_config.sequence_separator
+  end
+
+  def set_sequence
+    return unless new_record?
+    self.sequence = similar_slugs.last.sequence.succ if similar_to_other_slugs?
+  end
+
+end