friendly_id 5.0.0.rc1 → 5.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb59a1c03451e5b3848ab8fa00da5aa476276d79
-  data.tar.gz: f6057d3fad4267d1cea422b0eb72b78f433afc78
+  metadata.gz: 2b8e4a5f27bb5857aa5761f04a7300d96df81078
+  data.tar.gz: 85674fed68afdc2ba0122cff6edb0424eeb3dcaa
 SHA512:
-  metadata.gz: 9bbd5d21be8df888836e6e98b14c43d45eb89da31816830c5287038dce5f1a60c9920adf3b69a498e96b5d0cb6addfe952c5983d307228f5c57726095d9160c7
-  data.tar.gz: cae59c6cbc8406c0cedf700ad1201a23b01d74ec6b7d871333d8c156e273332485f581b59d2df9e59da689e4c4219dffe6a8f770f7a48e9f8af1b8b0a18b8de3
+  metadata.gz: 39e09066a6e62b4243e19f53c8640e15bfb05ed0c70fd4dbbfdfaf3cbb8aab162392e875ec79545e460ecdb716d2f8fd007c97a356963ccde9852b273216828c
+  data.tar.gz: c1b52cbedd571df3644ce78a94b22df6a747b9b22d5d40bede443dcedd9f69c7ad6771f18e3183b1761f6ace0d512590767c349bafe75f9d5c209c537777cd7c

data/CONTRIBUTING.md

@@ -1,41 +1,11 @@
 # FriendlyId
 
-## Getting Help
+Please ask questions on [Stack
+Overflow](http://stackoverflow.com/questions/tagged/friendly-id) using the
+"friendly_id" or "friendly-id" tag. Prior to asking, search and see if your
+question has already been anwered.
 
-Before opening a new issue, please search the existing issues to see if your
-question has been answered before.
-
-Please also take a look at the extensive documentation, especially the Guide.
-
-## FAQ
-
-Here are the answers to some common questions.
-
-### I'm using Rails 4...
-
-Then you **must** use FriendlyId 5, which is currently available in the master
-branch of the repository, and will be released to Rubygems soon.
-
-### I'm seeing a bunch of odd characters at the end of the id
-
-For example: `2bc08962-b3dd-4f29-b2e6-244710c86106`. FriendlyId 5 uses a UUID 
-rather than a sequence to simplify slug generation and avoid concurrency problems.
-
-### How do I set up my routes for FriendlyId?
-
-Exactly like in any other Rails app. FriendlyId doesn't change any routing
-functionality, it only changes the ids that are shown in your routes.
-
-TIP: Make your app work the way you want to with numeric id's. Then add
-FriendlyId later.
-
-### I'm seeing `undefined method `friendly_id'`
-
-You probably just added the friendly_id gem. Run `bundle` and restart your
-Rails app.
-
-### I'm seeing `uninitialized constant FriendlyId`
-
-You probably just added the friendly_id gem. Run `bundle` and restart your
-Rails app.
+Please only post issues in Github issues for actual bugs.
 
+I am asking people to do this because the same questions keep getting asked
+over and over and over again in the issues.

data/Changelog.md

@@ -3,6 +3,17 @@
 We would like to think our many {file:Contributors contributors} for
 suggestions, ideas and improvements to FriendlyId.
 
+## 5.0.0.rc2 (2013-09-29)
+
+* When the :finders addon has been included, use it in FriendlyId's internal
+  finds to boost performance.
+* Use instance methods rather than class methods in migrations.
+* On find, fall back to super when the primary key is a character type. Thanks
+  to [Jamie Davidson](https://github.com/jhdavids8).
+* Fix reversion to previously used slug from history table when
+  `should_generate_new_friendly_id?` is overridden.
+* Fix sequencing of numeric slugs
+
 ## 5.0.0.rc1 (2013-08-28)
 
 * Removed some outdated tests.

data/README.md

@@ -1,5 +1,17 @@
 [![Build Status](https://travis-ci.org/norman/friendly_id.png)](https://travis-ci.org/norman/friendly_id)
 
+**GETTING HELP**
+
+Please ask questions on [Stack
+Overflow](http://stackoverflow.com/questions/tagged/friendly-id) using the
+"friendly_id" or "friendly-id" tag. Prior to asking, search and see if your
+question has already been anwered.
+
+Please only post issues in Github issues for actual bugs.
+
+I am asking people to do this because the same questions keep getting asked
+over and over and over again in the issues.
+
 **VERSION NOTE**
 
 **Rails 4**:
@@ -115,7 +127,7 @@ generated in `config/initializers/friendly_id.rb`. This file contains notes
 describing how to restore (or not) some of the defaults from FriendlyId 4.0.
 
 If you want to use the `:history` and `:scoped` addons together, you must add a
-`:scope` column to your friendly_id slugs table and replace the unique index on
+`:scope` column to your friendly_id_slugs table and replace the unique index on
 `:slug` and `:sluggable_type` with a unique index on those two columns, plus
 the new `:scope` column.
 
@@ -151,7 +163,7 @@ cd my_app
 ```
 ```ruby
 # Gemfile
-gem 'friendly_id', '5.0.0.beta4' # Note: You MUST use 5.0.0 or greater for Rails 4.0+
+gem 'friendly_id', '5.0.0.rc2' # Note: You MUST use 5.0.0 or greater for Rails 4.0+
 ```
 ```shell
 rails generate friendly_id

data/bench.rb

@@ -72,6 +72,10 @@ Benchmark.bmbm do |x|
     N.times {transaction {Journalist.create :name => Faker::Name.name}}
   end
 
+  x.report 'insert (in-table-slug; included FinderMethods)' do
+    N.times {transaction {Restaurant.create :name => Faker::Name.name}}
+  end
+
   x.report 'insert (external slug)' do
     N.times {transaction {Manual.create :name => Faker::Name.name}}
   end

data/lib/friendly_id/base.rb

@@ -216,6 +216,10 @@ often better and easier to use {FriendlyId::Slugged slugs}.
         config.model_class = self
       end
     end
+
+    def primary_key_type
+      @primary_key_type ||= columns.find(&:primary).type
+    end
   end
 
   # Instance methods that will be added to all classes using FriendlyId.

data/lib/friendly_id/finder_methods.rb

@@ -1,7 +1,7 @@
 module FriendlyId
 
   module FinderMethods
-    
+
     # Finds a record using the given id.
     #
     # If the id is "unfriendly", it will call the original find method.
@@ -19,7 +19,7 @@ module FriendlyId
       id = args.first
       return super if args.count != 1 || id.unfriendly_id?
       first_by_friendly_id(id).tap {|result| return result unless result.nil?}
-      return super if Integer(id, 10) rescue nil
+      return super if potential_primary_key?(id)
       raise ActiveRecord::RecordNotFound
     end
 
@@ -36,14 +36,25 @@ module FriendlyId
       first_by_friendly_id(id) or raise ActiveRecord::RecordNotFound
     end
 
+    def exists_by_friendly_id?(id)
+      where(friendly_id_config.query_field => id).exists?
+    end
+
     private
 
-    def first_by_friendly_id(id)
-      where(friendly_id_config.query_field => id).first
+    def potential_primary_key?(id)
+      case primary_key_type
+      when :integer
+        Integer(id, 10) rescue false
+      when :uuid
+        id.match /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/
+      else
+        true
+      end
     end
 
-    def exists_by_friendly_id?(id)
-      where(friendly_id_config.query_field => id).exists?
+    def first_by_friendly_id(id)
+      where(friendly_id_config.query_field => id).first
     end
 
   end

data/lib/friendly_id/history.rb

@@ -82,16 +82,16 @@ method.
     module HistoryFinderMethods
       include FinderMethods
 
+      def exists_by_friendly_id?(id)
+        joins(:slugs).where(arel_table[friendly_id_config.query_field].eq(id).or(slug_history_clause(id))).exists?
+      end
+
       private
 
       def first_by_friendly_id(id)
         joins(:slugs).where(slug_history_clause(id)).readonly(false).first
       end
 
-      def exists_by_friendly_id?(id)
-        joins(:slugs).where(arel_table[friendly_id_config.query_field].eq(id).or(slug_history_clause(id))).exists?
-      end
-
       def slug_history_clause(id)
         Slug.arel_table[:sluggable_type].eq(base_class.to_s).and(Slug.arel_table[:slug].eq(id))
       end
@@ -99,6 +99,19 @@ method.
 
     private
 
+    # If we're updating, don't consider historic slugs for the same record
+    # to be conflicts. This will allow a record to revert to a previously
+    # used slug.
+    def scope_for_slug_generator
+      relation = super
+      return relation if new_record?
+      relation = relation.merge(Slug.where('sluggable_id <> ?', id))
+      if friendly_id_config.uses?(:scoped)
+        relation = relation.where(:scope => serialized_scope)
+      end
+      relation
+    end
+
     def create_slug
       return unless friendly_id
       return if slugs.first.try(:slug) == friendly_id

data/lib/friendly_id/initializer.rb

@@ -34,6 +34,10 @@ FriendlyId.defaults do |config|
   # all applications, so you must explicity opt-in to this behavior. You can
   # always also configure it on a per-model basis if you prefer.
   #
+  # Something else to consider is that using the :finders addon boosts
+  # performance because it will avoid Rails-internal code that makes runtime
+  # calls to `Module.extend`.
+  #
   # config.use :finders
   #
   # ## Slugs
@@ -81,4 +85,4 @@ FriendlyId.defaults do |config|
   #     text.to_slug.normalize! :transliterations => [:russian, :latin]
   #   end
   # }
-end
+end

data/lib/friendly_id/migration.rb

@@ -1,6 +1,5 @@
 class CreateFriendlyIdSlugs < ActiveRecord::Migration
-
-  def self.up
+  def change
     create_table :friendly_id_slugs do |t|
       t.string   :slug,           :null => false
       t.integer  :sluggable_id,   :null => false
@@ -13,8 +12,4 @@ class CreateFriendlyIdSlugs < ActiveRecord::Migration
     add_index :friendly_id_slugs, [:slug, :sluggable_type, :scope], :unique => true
     add_index :friendly_id_slugs, :sluggable_type
   end
-
-  def self.down
-    drop_table :friendly_id_slugs
-  end
 end

data/lib/friendly_id/slug_generator.rb

@@ -8,7 +8,7 @@ module FriendlyId
     end
 
     def available?(slug)
-      !@scope.exists?(slug)
+      !@scope.exists_by_friendly_id?(slug)
     end
 
     def add(slug)

data/lib/friendly_id/slugged.rb

@@ -297,13 +297,20 @@ Github issue](https://github.com/norman/friendly_id/issues/185) for discussion.
     end
     private :set_slug
 
-    def slug_generator
-      scope = self.class.base_class.unscoped.friendly
+    def scope_for_slug_generator
+      scope = self.class.base_class.unscoped
+      scope = scope.friendly unless friendly_id_config.uses? :finders
+
       if changed.include?(friendly_id_config.slug_column)
         column = self.class.quoted_table_name + '.' + self.class.quoted_primary_key
         scope = scope.where("#{column} <> ?", send(self.class.primary_key))
       end
-      friendly_id_config.slug_generator_class.new(scope)
+      scope
+    end
+    private :scope_for_slug_generator
+
+    def slug_generator
+      friendly_id_config.slug_generator_class.new(scope_for_slug_generator)
     end
     private :slug_generator
 

data/lib/friendly_id/version.rb

@@ -1,3 +1,3 @@
 module FriendlyId
-  VERSION = "5.0.0.rc1"
+  VERSION = "5.0.0.rc2"
 end

data/test/helper.rb

@@ -53,7 +53,7 @@ module FriendlyId
         puts "-" * 72
         if in_memory?
           ActiveRecord::Migration.verbose = false
-          Schema.up
+          Schema.migrate :up
           puts "#{message} (in-memory)"
         else
           puts message

data/test/history_test.rb

@@ -62,6 +62,14 @@ class HistoryTest < MiniTest::Unit::TestCase
     end
   end
 
+  test "should not be read only when found by slug" do
+    with_instance_of(model_class) do |record|
+      refute model_class.friendly.find(record.friendly_id).readonly?
+      assert record.update_attribute :name, 'foo'
+      assert record.update_attributes name: 'foo'
+    end
+  end
+
   test "should not be read only when found by old slug" do
     with_instance_of(model_class) do |record|
       old_friendly_id = record.friendly_id
@@ -74,10 +82,13 @@ class HistoryTest < MiniTest::Unit::TestCase
   test "should handle renames" do
     with_instance_of(model_class) do |record|
       record.name = 'x'
+      record.slug = nil
       assert record.save
       record.name = 'y'
+      record.slug = nil
       assert record.save
       record.name = 'x'
+      record.slug = nil
       assert record.save
     end
   end
@@ -122,6 +133,32 @@ class HistoryTest < MiniTest::Unit::TestCase
   end
 end
 
+class HistoryTestWithAutomaticSlugRegeneration < HistoryTest
+  class Manual < ActiveRecord::Base
+    extend FriendlyId
+    friendly_id :name, :use => [:slugged, :history]
+
+    def should_generate_new_friendly_id?
+      slug.blank? or name_changed?
+    end
+  end
+
+  def model_class
+    Manual
+  end
+
+  test 'should allow reversion back to a previously used slug' do
+    with_instance_of(model_class, name: 'foo') do |record|
+      record.name = 'bar'
+      record.save!
+      assert_equal 'bar', record.friendly_id
+      record.name = 'foo'
+      record.save!
+      assert_equal 'foo', record.friendly_id
+    end
+  end
+end
+
 class HistoryTestWithSti < HistoryTest
   class Journalist < ActiveRecord::Base
     extend FriendlyId

data/test/schema.rb

@@ -14,7 +14,7 @@ module FriendlyId
         def up
           # TODO: use schema version to avoid ugly hacks like this
           return if @done
-          CreateFriendlyIdSlugs.up
+          CreateFriendlyIdSlugs.migrate :up
 
           tables.each do |table_name|
             create_table table_name do |t|
@@ -23,6 +23,15 @@ module FriendlyId
             end
           end
 
+          tables_with_string_primary_key.each do |table_name|
+            create_table table_name, primary_key: :string_key, id: false do |t|
+              t.string :name
+              t.string :string_key, null: false
+              t.string :slug
+            end
+            add_index table_name, :slug, unique: true
+          end
+
           slugged_tables.each do |table_name|
             add_column table_name, :slug, :string
             add_index  table_name, :slug, :unique => true
@@ -64,6 +73,10 @@ module FriendlyId
           %w[journalists articles novelists novels manuals]
         end
 
+        def tables_with_string_primary_key
+          ["menu_items"]
+        end
+
         def scoped_tables
           ["restaurants"]
         end

data/test/slugged_test.rb

@@ -134,6 +134,13 @@ class SlugGeneratorTest < MiniTest::Unit::TestCase
     end
   end
 
+  test "should correctly sequence numeric slugs" do
+    transaction do
+      n2 = 2.times.map {Article.create :name => '123'}.last
+      assert_match(/\A123-.*/, n2.friendly_id)
+    end
+  end
+
 end
 
 class SlugSeparatorTest < MiniTest::Unit::TestCase
@@ -205,6 +212,40 @@ class DefaultScopeTest < MiniTest::Unit::TestCase
   end
 end
 
+class StringAsPrimaryKeyFindTest < MiniTest::Unit::TestCase
+  include FriendlyId::Test
+
+  class MenuItem < ActiveRecord::Base
+    extend FriendlyId
+    friendly_id :name, :use => :slugged
+    before_create :init_primary_key
+
+    def self.primary_key 
+      "string_key"
+    end
+
+    private
+    def init_primary_key
+      self.string_key = SecureRandom.uuid
+    end
+  end
+
+  def model_class
+    MenuItem
+  end
+
+  test "should have a string as a primary key" do
+    assert_equal model_class.primary_key, "string_key"
+    assert_equal model_class.columns.find(&:primary).name, "string_key"
+  end
+
+  test "should be findable by the string primary key" do
+    with_instance_of(model_class) do |record|
+      assert model_class.friendly.find record.id
+    end
+  end
+end
+
 class UnderscoreAsSequenceSeparatorRegressionTest < MiniTest::Unit::TestCase
   include FriendlyId::Test
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: friendly_id
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc1
+  version: 5.0.0.rc2
 platform: ruby
 authors:
 - Norman Clarke
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-28 00:00:00.000000000 Z
+date: 2013-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord