friendly_id 2.3.4 → 3.0.0.beta1

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

@@ -1,5 +1,5 @@
 module FriendlyId
-  module ActiveRecord2
+  module AcktiveRecord
     module SluggedModel
 
       module SluggedFinder
@@ -18,7 +18,7 @@ module FriendlyId
       class MultipleFinder
 
         include FriendlyId::Finders::Base
-        include FriendlyId::ActiveRecord2::Finders::Multiple
+        include FriendlyId::AcktiveRecord::Finders::Multiple
         include SluggedFinder
 
         attr_reader :slugs
@@ -86,7 +86,7 @@ module FriendlyId
         include SluggedFinder
 
         def find
-          @result = with_scope({:find => find_options}) { find_initial options }
+          @result = model_class.scoped(find_options).first(options)
           handle_friendly_result if friendly?
           @result
         rescue ::ActiveRecord::RecordNotFound => @error
@@ -109,7 +109,7 @@ module FriendlyId
         end
 
         def raise_scoped_error
-          scope_message = options[:scope] || "expected, but none given"
+          scope_message = scope || "expected, but none given"
           message = "%s, scope: %s" % [@error.message, scope_message]
           raise ::ActiveRecord::RecordNotFound, message
         end
@@ -124,7 +124,7 @@ module FriendlyId
         include SluggedFinder
 
         def find
-          @result = with_scope({:find => find_options}) { find_initial options }
+          @result = model_class.scoped(find_options).first(options)
           handle_friendly_result if friendly?
           @result
         rescue ActiveRecord::RecordNotFound
@@ -138,81 +138,6 @@ 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_or_name, options)
-          finder = Finders::FinderProxy.new(id_or_name, self, options)
-          finder.unfriendly? ? super : finder.find or super
-        end
-
-        def find_some(ids_and_names, options)
-          Finders::FinderProxy.new(ids_and_names, self, options).find
-        end
-
-        # Since Rails goes out of its way to make these options completely
-        # inaccessible, we have to copy them here.
-        def validate_find_options(options)
-          options.assert_valid_keys([:conditions, :include, :joins, :limit, :offset,
-            :order, :select, :readonly, :group, :from, :lock, :having, :scope])
-        end
-
-      end
-
-      # These methods will be removed in FriendlyId 3.0.
-      module DeprecatedMethods
-
-        # @deprecated Please use #to_param
-        def best_id
-          warn("best_id is deprecated and will be removed in 3.0. Please use #to_param.")
-          to_param
-        end
-
-        # @deprecated Please use #friendly_id_status.slug.
-        def finder_slug
-          warn("finder_slug is deprecated and will be removed in 3.0. Please use #friendly_id_status.slug.")
-          friendly_id_status.slug
-        end
-
-        # 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?
-        # @deprecated Please use #friendly_id_status.outdated?
-        def found_using_outdated_friendly_id?
-          warn("found_using_outdated_friendly_id is deprecated and will be removed in 3.0. Please use #friendly_id_status.outdated?")
-          friendly_id_status.outdated?
-        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
-
-        # @deprecated Please use #slug?
-        def has_a_slug?
-          warn("has_a_slug? is deprecated and will be removed in 3.0. Please use #slug?")
-          slug?
-        end
-
-      end
-
       def self.included(base)
         base.class_eval do
           has_many :slugs, :order => 'id DESC', :as => :sluggable, :dependent => :destroy
@@ -221,18 +146,17 @@ module FriendlyId
           after_update :update_scope
           after_update :update_dependent_scopes
           protect_friendly_id_attributes
-          extend FinderMethods
+          extend FriendlyId::AcktiveRecord::FinderMethods
         end
       end
 
       include FriendlyId::Slugged::Model
-      include DeprecatedMethods
 
       def find_slug(name, sequence)
         slugs.find_by_name_and_sequence(name, sequence)
       end
 
-      # The model instance's current {FriendlyId::ActiveRecord2::Slug slug}.
+      # The model instance's current {FriendlyId::AcktiveRecord::Slug slug}.
       def slug
         return @slug if new_record?
         @slug ||= slugs.first(:order => "id DESC")
@@ -273,7 +197,7 @@ module FriendlyId
 
       # Reset the cached friendly_id?
       def new_cache_needed?
-        uses_slug_cache? && send(friendly_id_config.cache_column) != slug.to_friendly_id
+        uses_slug_cache? && slug? && send(friendly_id_config.cache_column) != slug.to_friendly_id
       end
 
       # Reset the cached friendly_id.
@@ -285,7 +209,7 @@ module FriendlyId
       end
 
       def update_scope
-        return unless scope_changed?
+        return unless slug && scope_changed?
         slug.update_attributes :scope => send(friendly_id_config.scope).to_param
       rescue ActiveRecord::StatementInvalid
         slug.update_attributes :sequence => Slug.similar_to(slug).first.sequence.succ

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

@@ -26,13 +26,15 @@ module FriendlyId
 
     def make_slugs
       validate_uses_slugs
-      options = {:limit => 100, :include => :slugs, :conditions => "slugs.id IS NULL"}.merge(task_options || {})
+      cond = "slugs.id IS NULL"
+      options = {:limit => 100, :include => :slugs, :conditions => cond, :order => "#{klass.table_name}.id ASC"}.merge(task_options || {})
       while records = find(:all, options) do
         break if records.size == 0
         records.each do |record|
           record.save!
           yield(record) if block_given?
         end
+        options[:conditions] = cond + " and #{klass.table_name}.id > #{records.last.id}"
       end
     end
 
@@ -45,7 +47,7 @@ module FriendlyId
     end
 
     def delete_old_slugs
-      conditions = ["created_at < ?", DateTime.now - days.days]
+      conditions = ["created_at < ?", DateTime.now - days]
       if klass
         conditions[0] << " AND sluggable_type = ?"
         conditions << klass.to_s
@@ -54,6 +56,7 @@ module FriendlyId
     end
 
     def validate_uses_slugs
+      (raise "You need to pass a MODEL=<model name> argument to rake") if klass.blank?
       unless friendly_id_config.use_slug?
         raise "Class '%s' doesn't use slugs" % klass.to_s
       end

data/lib/friendly_id/{active_record2 → acktive_record}/tasks/friendly_id.rake

@@ -2,7 +2,7 @@ namespace :friendly_id do
   desc "Make slugs for a model."
   task :make_slugs => :environment do
     FriendlyId::TaskRunner.new.make_slugs do |record|
-      puts "%s(%d): friendly_id set to '%s'" % [record.class.to_s, record.id, record.slug.name]
+      puts "%s(%d): friendly_id set to '%s'" % [record.class.to_s, record.id, record.slug.name] if record.slug
     end
   end
 

data/lib/friendly_id/{active_record2.rb → active_record.rb}

@@ -1,20 +1,18 @@
-require File.join(File.dirname(__FILE__), "active_record2", "configuration")
-require File.join(File.dirname(__FILE__), "active_record2", "finders")
-require File.join(File.dirname(__FILE__), "active_record2", "simple_model")
-require File.join(File.dirname(__FILE__), "active_record2", "slugged_model")
-require File.join(File.dirname(__FILE__), "active_record2", "slug")
-require File.join(File.dirname(__FILE__), "active_record2", "tasks")
-
 module FriendlyId
 
-  module ActiveRecord2
+  module AcktiveRecord
+
+    module Compat
+      def self.scope_method
+        ActiveRecord::VERSION::STRING >= "3" ? :scope : :named_scope
+      end
+    end
 
     include FriendlyId::Base
 
-    def has_friendly_id(method, options = {}, &block)
+    def has_friendly_id(method, options = {})
       class_inheritable_accessor :friendly_id_config
-      write_inheritable_attribute :friendly_id_config, Configuration.new(self,
-        method, options.merge(:normalizer => block))
+      write_inheritable_attribute :friendly_id_config, Configuration.new(self, method, options)
       if friendly_id_config.use_slug?
         include SluggedModel
       else
@@ -43,5 +41,12 @@ module FriendlyId
 end
 
 class ActiveRecord::Base
-  extend FriendlyId::ActiveRecord2
-end
+  extend FriendlyId::AcktiveRecord
+end
+
+require File.join(File.dirname(__FILE__), "acktive_record", "configuration")
+require File.join(File.dirname(__FILE__), "acktive_record", "finders")
+require File.join(File.dirname(__FILE__), "acktive_record", "simple_model")
+require File.join(File.dirname(__FILE__), "acktive_record", "slugged_model")
+require File.join(File.dirname(__FILE__), "acktive_record", "slug")
+require File.join(File.dirname(__FILE__), "acktive_record", "tasks")

data/lib/friendly_id/configuration.rb

@@ -22,6 +22,7 @@ module FriendlyId
   class Configuration
 
     DEFAULTS = {
+      :allow_nil                   => false,
       :ascii_approximation_options => [],
       :max_length                  => 255,
       :reserved_words              => ["index", "new"],
@@ -29,6 +30,12 @@ module FriendlyId
       :sequence_separator          => "--"
     }
 
+    # Whether to allow friendly_id and/or slugs to be nil. This is not
+    # generally useful on its own, but may allow you greater flexibility to
+    # customize your application.
+    attr_accessor :allow_nil
+    alias :allow_nil? :allow_nil
+
     # Strip diacritics from Western characters.
     attr_accessor :approximate_ascii
 
@@ -47,12 +54,6 @@ module FriendlyId
     attr_reader :method
     alias :column :method
 
-    # A block or proc through which to filter the friendly_id text.
-    # This method will be removed from FriendlyId 3.0.
-    # @deprecated Please override the +normalize_friendly_id+
-    #   method in your model class rather than passing a block to `has_friendly_id`.
-    attr_accessor :normalizer
-
     # The message shown when a reserved word is used.
     # @see #reserved_words
     attr_accessor :reserved_message
@@ -85,10 +86,8 @@ module FriendlyId
       yield self if block_given?
     end
 
-    def normalizer=(arg)
-      return if arg.nil?
-      warn("passing a block to has_friendly_id is deprecated and will be removed from 3.0. Please override #normalize_friendly_id.")
-      @normalizer = arg
+    def forbid_nil?
+      !allow_nil?
     end
 
     def reserved_words=(*words)
@@ -103,21 +102,7 @@ module FriendlyId
       [method, reserved_message % word] if reserved? word
     end
 
-    # This method will be removed from FriendlyId 3.0.
-    # @deprecated Please use {#reserved_words reserved_words}.
-    def reserved=(*args)
-      warn('The "reserved" option is deprecated and will be removed from FriendlyId 3.0. Please use "reserved_words".')
-      self.reserved_words = *args
-    end
-
-    # This method will be removed from FriendlyId 3.0.
-    # @deprecated Please use {#approximate_ascii approximate_ascii}.
-    def strip_diacritics=(*args)
-      warn('strip_diacritics is deprecated and will be removed from 3.0. Please use #approximate_ascii')
-      self.approximate_ascii = *args
-    end
-
-    %w[approximate_ascii normalizer scope strip_non_ascii use_slug].each do |method|
+    %w[approximate_ascii scope strip_non_ascii use_slug].each do |method|
       class_eval(<<-EOM)
         def #{method}?
           !! #{method}
@@ -129,4 +114,4 @@ module FriendlyId
 
   end
 
-end
+end

data/lib/friendly_id/finders.rb

@@ -14,7 +14,7 @@ module FriendlyId
       # @return [true, false, nil]
       # @see #unfriendly?
       def self.friendly?(id)
-        if id.is_a?(Integer) or id.class.respond_to? :friendly_id_config
+        if id.is_a?(Integer) or id.is_a?(Symbol) or id.class.respond_to? :friendly_id_config
           return false
         elsif id.to_i.to_s != id.to_s
           return true
@@ -35,7 +35,7 @@ module FriendlyId
         self.ids = ids
         self.options = options
         self.model_class = model_class
-        self.scope = options[:scope]
+        self.scope = options.delete :scope
       end
 
       def method_missing(*args, &block)
@@ -67,7 +67,9 @@ module FriendlyId
       alias :id= :ids=
 
       def scope=(scope)
-        @scope = scope.to_param unless scope.nil?
+        unless scope.nil?
+          @scope = scope.respond_to?(:to_param) ? scope.to_param : scope.to_s
+        end
       end
     end
 

data/lib/friendly_id/slug_string.rb

@@ -162,7 +162,7 @@ module FriendlyId
       # whitespace characters with a single space.
       # @return String
       def clean!
-        @wrapped_string = @wrapped_string.gsub(/\A\-|\-\z/, '').gsub(/\s+/u, ' ').strip
+        @wrapped_string = @wrapped_string.gsub(/\A\-|\-\z/, "").gsub(/\s+/u, " ").strip
       end
 
       # Lowercases the string. Note that this works for Unicode strings,
@@ -198,13 +198,9 @@ module FriendlyId
       # @param config [FriendlyId::Configuration]
       # @return String
       def normalize_for!(config)
-        if config.normalizer?
-          @wrapped_string = config.normalizer.call(to_s)
-        else
-          approximate_ascii! if config.approximate_ascii?
-          to_ascii! if config.strip_non_ascii?
-          normalize!
-        end
+        approximate_ascii! if config.approximate_ascii?
+        to_ascii! if config.strip_non_ascii?
+        normalize!
       end
 
       alias :normalize_utf8 :normalize rescue NoMethodError
@@ -231,7 +227,12 @@ module FriendlyId
       # Delete any non-ascii characters.
       # @return String
       def to_ascii!
-        @wrapped_string = normalize_utf8(:c).unpack("U*").reject {|char| char > 127}.pack("U*")
+        if ">= 1.9".respond_to?(:force_encoding)
+          @wrapped_string.encode!("ASCII", :invalid => :replace, :undef => :replace,
+            :replace => "")
+        else
+          @wrapped_string = tidy_bytes.normalize_utf8(:c).unpack("U*").reject {|char| char > 127}.pack("U*")
+        end
       end
 
       # Upper-cases the string. Note that this works for Unicode strings,
@@ -257,7 +258,7 @@ module FriendlyId
       # Replaces whitespace with dashes ("-").
       # @return String
       def with_dashes!
-        @wrapped_string = @wrapped_string.gsub(/[\s\-]+/u, '-')
+        @wrapped_string = @wrapped_string.gsub(/[\s\-]+/u, "-")
       end
 
       %w[approximate_ascii clean downcase word_chars normalize normalize_for to_ascii

data/lib/friendly_id/slugged.rb

@@ -55,7 +55,7 @@ module FriendlyId
 
       # The friendly id.
       def friendly_id
-        slug.to_friendly_id
+        slug.to_friendly_id if slug?
       end
 
       # Clean up the string before setting it as the friendly_id. You can override
@@ -75,8 +75,11 @@ module FriendlyId
 
       # Get the processed string used as the basis of the friendly id.
       def slug_text
-        text = normalize_friendly_id(SlugString.new(send(friendly_id_config.method)))
-        SlugString.new(text.to_s).validate_for!(friendly_id_config).to_s
+        base = send(friendly_id_config.method)
+        unless base.nil? && friendly_id_config.allow_nil?
+          text = normalize_friendly_id(SlugString.new(base))
+          SlugString.new(text.to_s).validate_for!(friendly_id_config).to_s
+        end
       end
 
       # Has the slug text changed?
@@ -87,7 +90,11 @@ module FriendlyId
       # Has the basis of our friendly id changed, requiring the generation of a
       # new slug?
       def new_slug_needed?
-        !slug? || slug_text_changed?
+        if friendly_id_config.allow_nil?
+          (!slug? && !slug_text.blank?) || (slug? && slug_text_changed?)
+        else
+          !slug? || slug_text_changed?
+        end
       end
 
     end

data/lib/friendly_id/test.rb

@@ -18,7 +18,6 @@ module FriendlyId
 
       def teardown
         klass.send delete_all_method
-        # other_class.delete_all
       end
 
       def instance
@@ -41,6 +40,10 @@ module FriendlyId
         raise NotImplementedError
       end
 
+      def update_method
+        raise NotImplementedError
+      end
+
       def validation_exceptions
         return RuntimeError
       end
@@ -49,7 +52,7 @@ module FriendlyId
         assert_not_nil klass.friendly_id_config
       end
 
-      test "instances should have a friendly id" do
+      test "instances should have a friendly id by default" do
         assert_not_nil instance.friendly_id
       end
 
@@ -69,6 +72,11 @@ module FriendlyId
         assert_equal instance, klass.send(find_method, instance.id.to_s)
       end
 
+      test "instances should be findable by a numeric friendly_id" do
+        instance = klass.send(create_method, :name => "206")
+        assert_equal instance, klass.send(find_method, instance.friendly_id)
+      end
+
       test "creation should raise an error if the friendly_id text is reserved" do
         assert_raise(*[validation_exceptions].flatten) do
           klass.send(create_method, :name => "new")
@@ -87,12 +95,17 @@ module FriendlyId
         end
       end
 
-      test "creation should raise an error if the friendly_id text is nil" do
+      test "creation should raise an error if the friendly_id text is nil and allow_nil is false" do
         assert_raise(*[validation_exceptions].flatten) do
           klass.send(create_method, :name => nil)
         end
       end
 
+      test "creation should succeed if the friendly_id text is nil and allow_nil is true" do
+        klass.friendly_id_config.stubs(:allow_nil?).returns(true)
+        assert klass.send(create_method, :name => nil)
+      end
+
       test "should allow the same friendly_id across models" do
         other_instance = other_class.send(create_method, :name => instance.name)
         assert_equal other_instance.friendly_id, instance.friendly_id
@@ -100,6 +113,18 @@ module FriendlyId
 
     end
 
+    module Simple
+
+      test "should allow friendly_id to be nillable if allow_nil is true" do
+        klass.friendly_id_config.stubs(:allow_nil?).returns(true)
+        instance = klass.send(create_method, :name => "hello")
+        assert instance.friendly_id
+        instance.name = nil
+        assert instance.send(save_method)
+      end
+
+    end
+
     # Tests for any model that implements slugs.
     module Slugged
 
@@ -152,6 +177,22 @@ module FriendlyId
         assert_equal instance, klass.find(old_friendly_id)
       end
 
+      test "should not create a slug when allow_nil is true and friendy_id text is blank" do
+        klass.friendly_id_config.stubs(:allow_nil?).returns(true)
+        instance = klass.send(create_method, :name => nil)
+        assert_nil instance.slug
+      end
+
+      test "should not allow friendly_id to be nillable even if allow_nil is true" do
+        klass.friendly_id_config.stubs(:allow_nil?).returns(true)
+        instance = klass.send(create_method, :name => "hello")
+        assert instance.friendly_id
+        instance.name = nil
+        assert_raise(*[validation_exceptions].flatten) do
+          instance.send(save_method)
+        end
+      end
+
     end
 
     # Tests for FriendlyId::Status.
@@ -164,7 +205,7 @@ module FriendlyId
         assert status.numeric?
       end
     end
-    
+
     # Tests for FriendlyId::Status for a model that uses slugs.
     module SluggedStatus
 
@@ -244,4 +285,4 @@ module FriendlyId
 
     end
   end
-end
+end