friendly_id 4.0.1 → 4.0.2

data/Changelog.md

@@ -6,6 +6,12 @@ suggestions, ideas and improvements to FriendlyId.
 * Table of Contents
 {:toc}
 
+## 4.0.2 (2012-03-12)
+
+* Improved conflict handling and performance in History module (Erik Ogan and Thomas Shafer)
+* Fixed bug that impeded using underscores as a sequence separator (Erik Ogan and Thomas Shafer)
+* Minor documentation improvements (Norman Clarke)
+
 ## 4.0.1 (2012-02-29)
 
 * Added support for Globalize 3 (Enrico Pilotto and Philip Arndt)

data/Guide.rdoc

@@ -241,6 +241,21 @@ This functionality was in fact taken from earlier versions of FriendlyId.
 
 ==== Gotchas: Common Problems
 
+===== Slugs That Begin With Numbers
+
+Ruby's `to_i` function casts strings to integers in such a way that +23abc.to_i+
+returns 23. Because FriendlyId falls back to finding by numeric id, this means
+that if you attempt to find a record with a non-existant slug, and that slug
+begins with a number, your find will probably return the wrong record.
+
+There are two fairly simple ways to avoid this:
+
+* Use validations to ensure that slugs don't begin with numbers.
+* Use explicit finders like +find_by_id+ to always find by the numeric id, or
+  +find_by_slug+ to always find using the friendly id.
+
+===== Concurrency Issues
+
 FriendlyId uses a before_validation callback to generate and set the slug. This
 means that if you create two model instances before saving them, it's possible
 they will generate the same slug, and the second save will fail.
@@ -249,14 +264,10 @@ This can happen in two fairly normal cases: the first, when a model using nested
 attributes creates more than one record for a model that uses friendly_id. The
 second, in concurrent code, either in threads or multiple processes.
 
-===== Nested Attributes
-
 To solve the nested attributes issue, I recommend simply avoiding them when
 creating more than one nested record for a model that uses FriendlyId. See {this
 Github issue}[https://github.com/norman/friendly_id/issues/185] for discussion.
 
-===== Concurrency
-
 To solve the concurrency issue, I recommend locking the model's table against
 inserts while when saving the record. See {this Github
 issue}[https://github.com/norman/friendly_id/issues/180] for discussion.
@@ -464,4 +475,21 @@ FriendlyId.defaults}:
     config.use :reserved
     # Reserve words for English and Spanish URLs
     config.reserved_words = %w(new edit nueva nuevo editar)
+  end
+
+Note that the error message will appear on the field +:friendly_id+. If you are
+using Rails's scaffolded form errors display, then it will have no field to
+highlight. If you'd like to change this so that scaffolding works as expected,
+one way to accomplish this is to move the error message to a different field.
+For example:
+
+  class Person < ActiveRecord::Base
+    extend FriendlyId
+    friendly_id :name, use: :slugged
+
+    after_validation :move_friendly_id_error_to_name
+
+    def move_friendly_id_error_to_name
+      errors.messages[:name] = errors.messages.delete(:friendly_id)
+    end
   end

data/lib/friendly_id.rb

@@ -45,7 +45,7 @@ with numeric ids:
 module FriendlyId
 
   # The current version.
-  VERSION = "4.0.1"
+  VERSION = "4.0.2"
 
   @mutex = Mutex.new
 

data/lib/friendly_id/history.rb

@@ -117,18 +117,20 @@ method.
     module SlugGenerator
 
       private
+      def last_in_sequence
+        @_last_in_sequence ||= extract_sequence_from_slug(conflict.slug)
+      end
 
       def conflicts
         sluggable_class = friendly_id_config.model_class
         pkey            = sluggable_class.primary_key
         value           = sluggable.send pkey
-        # TODO this is a bit of a performance drain right now; optimize before next release.
-        scope = sluggable_class.unscoped.includes(:slugs).where("#{Slug.quoted_table_name}.slug = ? OR #{Slug.quoted_table_name}.slug LIKE ?", normalized, wildcard)
-        scope = scope.where(Slug.table_name => {:sluggable_type => sluggable_class.name})
-        scope = scope.where("#{sluggable_class.table_name}.#{pkey} <> ?", value) unless sluggable.new_record?
-        scope.order("LENGTH(#{Slug.quoted_table_name}.slug) DESC, #{Slug.quoted_table_name}.slug DESC")
-      end
 
+        scope = Slug.where("slug = ? OR slug LIKE ?", normalized, wildcard)
+        scope = scope.where(:sluggable_type => sluggable_class.name)
+        scope = scope.where("sluggable_id <> ?", value) unless sluggable.new_record?
+        scope.order("LENGTH(slug) DESC, slug DESC")
+      end
     end
   end
 end

data/lib/friendly_id/reserved.rb

@@ -16,6 +16,24 @@ FriendlyId.defaults}:
     # Reserve words for English and Spanish URLs
     config.reserved_words = %w(new edit nueva nuevo editar)
   end
+
+Note that the error message will appear on the field +:friendly_id+. If you are
+using Rails's scaffolded form errors display, then it will have no field to
+highlight. If you'd like to change this so that scaffolding works as expected,
+one way to accomplish this is to move the error message to a different field.
+For example:
+
+  class Person < ActiveRecord::Base
+    extend FriendlyId
+    friendly_id :name, use: :slugged
+
+    after_validation :move_friendly_id_error_to_name
+
+    def move_friendly_id_error_to_name
+      errors.messages[:name] = errors.messages.delete(:friendly_id)
+    end
+  end
+
 =end
   module Reserved
 

data/lib/friendly_id/slug_generator.rb

@@ -27,8 +27,12 @@ module FriendlyId
     end
 
     def last_in_sequence
+      @_last_in_sequence ||= extract_sequence_from_slug(conflict.to_param)
+    end
+
+    def extract_sequence_from_slug(slug)
       # Don't assume that the separator is unique in the slug.
-      @_last_in_sequence ||= conflict.to_param.gsub(/^#{Regexp.quote(normalized)}(#{Regexp.quote(separator)})?/, '').to_i
+      slug.gsub(/^#{Regexp.quote(normalized)}(#{Regexp.quote(separator)})?/, '').to_i
     end
 
     def column
@@ -65,7 +69,10 @@ module FriendlyId
     end
 
     def wildcard
-      "#{normalized}#{separator}%"
+      # Underscores (matching a single character) and percent signs (matching
+      # any number of characters) need to be escaped
+      # (While this seems like an excessive number of backslashes, it is correct)
+      "#{normalized}#{separator}".gsub(/[_%]/, '\\\\\&') + '%'
     end
   end
 end

data/lib/friendly_id/slugged.rb

@@ -160,6 +160,21 @@ This functionality was in fact taken from earlier versions of FriendlyId.
 
 ==== Gotchas: Common Problems
 
+===== Slugs That Begin With Numbers
+
+Ruby's `to_i` function casts strings to integers in such a way that +23abc.to_i+
+returns 23. Because FriendlyId falls back to finding by numeric id, this means
+that if you attempt to find a record with a non-existant slug, and that slug
+begins with a number, your find will probably return the wrong record.
+
+There are two fairly simple ways to avoid this:
+
+* Use validations to ensure that slugs don't begin with numbers.
+* Use explicit finders like +find_by_id+ to always find by the numeric id, or
+  +find_by_slug+ to always find using the friendly id.
+
+===== Concurrency Issues
+
 FriendlyId uses a before_validation callback to generate and set the slug. This
 means that if you create two model instances before saving them, it's possible
 they will generate the same slug, and the second save will fail.
@@ -168,14 +183,10 @@ This can happen in two fairly normal cases: the first, when a model using nested
 attributes creates more than one record for a model that uses friendly_id. The
 second, in concurrent code, either in threads or multiple processes.
 
-===== Nested Attributes
-
 To solve the nested attributes issue, I recommend simply avoiding them when
 creating more than one nested record for a model that uses FriendlyId. See {this
 Github issue}[https://github.com/norman/friendly_id/issues/185] for discussion.
 
-===== Concurrency
-
 To solve the concurrency issue, I recommend locking the model's table against
 inserts while when saving the record. See {this Github
 issue}[https://github.com/norman/friendly_id/issues/180] for discussion.

data/test/history_test.rb

@@ -68,6 +68,16 @@ class HistoryTest < MiniTest::Unit::TestCase
     end
   end
 
+  test "should create correct sequence numbers even when some conflicted slugs have changed" do
+    transaction do
+      record1 = model_class.create! :name => 'hello'
+      record2 = model_class.create! :name => 'hello!'
+      record2.update_attributes :name => 'goodbye'
+      record3 = model_class.create! :name => 'hello!'
+      assert_equal 'hello--3', record3.slug
+    end
+  end
+
 
   test "should raise error if used with scoped" do
     model_class = Class.new(ActiveRecord::Base) do

data/test/slugged_test.rb

@@ -10,6 +10,15 @@ class Article < ActiveRecord::Base
   friendly_id :name, :use => :slugged
 end
 
+class Novelist < ActiveRecord::Base
+  extend FriendlyId
+  friendly_id :name, :use => :slugged, :sequence_separator => '_'
+
+  def normalize_friendly_id(string)
+    super.gsub("-", "_")
+  end
+end
+
 class SluggedTest < MiniTest::Unit::TestCase
 
   include FriendlyId::Test
@@ -112,6 +121,14 @@ class SlugGeneratorTest < MiniTest::Unit::TestCase
     end
   end
 
+  test "should correctly sequence slugs with underscores" do
+    transaction do
+      record1 = Novelist.create! :name => 'wordsfail, buildings tumble'
+      record2 = Novelist.create! :name => 'word fail'
+      assert_equal 'word_fail', record2.slug
+    end
+  end
+
 end
 
 class SlugSeparatorTest < MiniTest::Unit::TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: friendly_id
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-29 00:00:00.000000000 Z
+date: 2012-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70170127893680 !ruby/object:Gem::Requirement
+  requirement: &70322875898160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.0
   type: :development
   prerelease: false
-  version_requirements: *70170127893680
+  version_requirements: *70322875898160
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70170127892900 !ruby/object:Gem::Requirement
+  requirement: &70322875893740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.2.0
   type: :development
   prerelease: false
-  version_requirements: *70170127892900
+  version_requirements: *70322875893740
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70170127892400 !ruby/object:Gem::Requirement
+  requirement: &70322875889580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70170127892400
+  version_requirements: *70322875889580
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70170127891740 !ruby/object:Gem::Requirement
+  requirement: &70322875886660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70170127891740
+  version_requirements: *70322875886660
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: &70170127891160 !ruby/object:Gem::Requirement
+  requirement: &70322875883700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70170127891160
+  version_requirements: *70322875883700
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70170127890460 !ruby/object:Gem::Requirement
+  requirement: &70322875857480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70170127890460
+  version_requirements: *70322875857480
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70170127889980 !ruby/object:Gem::Requirement
+  requirement: &70322875830720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70170127889980
+  version_requirements: *70322875830720
 - !ruby/object:Gem::Dependency
   name: ffaker
-  requirement: &70170127889500 !ruby/object:Gem::Requirement
+  requirement: &70322875828040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70170127889500
+  version_requirements: *70322875828040
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70170127888840 !ruby/object:Gem::Requirement
+  requirement: &70322875809660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70170127888840
+  version_requirements: *70322875809660
 description: ! 'FriendlyId is the "Swiss Army bulldozer" of slugging and permalink
   plugins for