friendly_id 5.2.4 → 5.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 19856ab4f2e02ba7eed649beef7728be7eae0a58
-  data.tar.gz: bcf94acb37ff90b70916a96a34a2035570490128
+SHA256:
+  metadata.gz: cd9172f2c624c948c208a4e89b1d8de61f895d8d2cf0d233a3622d1f03da53f2
+  data.tar.gz: 1cb881d8be37a992cbac2d8def2c18338829e84b577bb364b36901a627849533
 SHA512:
-  metadata.gz: 41b11ab959bcf15522a627431421bdb4542fd8768ee1695d6bf68d2351f479c4cd49e6f42e9b46a8f6aac0557bf199b8ad58582c02b049624204e12283740643
-  data.tar.gz: 221d38007de3e624191d6905bd0430dc90bce1a9b1212cc20e8bb9bfbd06aa60fc8e0e44c74ec52b9d424210806683ed39446bd623eae09cc07d0542f58db0e6
+  metadata.gz: 9bca1be76cbc05a4d5dde5b936121ecf89b44c9949eb9b7ad574a20affd34fef104a443379b13d9a1a4843bbba9812366bd99d9b6db7eb56ace44581fecdad4a
+  data.tar.gz: d9c2ba647f04848ab3a690fd064e1669316bfc69116aa868a17034bed6916758e643365e425bc88f024fdec9bc7b5faaba89a5200696e0c1a3fddac04f140a30

data/Gemfile

@@ -5,6 +5,7 @@ gemspec
 group :development, :test do
   platforms :ruby do
     gem 'byebug'
+    gem 'pry'
   end
 
   platforms :jruby do

data/README.md

@@ -39,7 +39,7 @@ FriendlyId offers many advanced features, including:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'friendly_id', '~> 5.1.0' # Note: You MUST use 5.0.0 or greater for Rails 4.0+
+gem 'friendly_id', '~> 5.2.4' # Note: You MUST use 5.0.0 or greater for Rails 4.0+
 ```
 
 And then execute:
@@ -48,14 +48,18 @@ And then execute:
 bundle install
 ```
 
-Generate the friendly configuration file
+Add a `slug` column to the desired table (e.g. `Users`)
+```shell
+rails g migration AddSlugToUsers slug:uniq
+```
+
+Generate the friendly configuration file and a new migration
 
 ```shell
 rails generate friendly_id
 ```
 
->Temp solution for Rails 5.1+ : Before running the migration, go into the generated migration file and specify the Rails version:  
-`class CreateFriendlyIdSlugs < ActiveRecord::Migration[5.1]`  
+Note: You can delete the `CreateFriendlyIdSlugs` migration if you won't use the slug history feature. ([Read more](https://norman.github.io/friendly_id/FriendlyId/History.html))
 
 Run the migration scripts
 

data/gemfiles/Gemfile.rails-5.0.rb

@@ -9,8 +9,8 @@ gem 'i18n', '~> 0.7.0'
 # Database Configuration
 group :development, :test do
   platforms :jruby do
-    gem 'activerecord-jdbcmysql-adapter', git: 'https://github.com/jruby/activerecord-jdbc-adapter', branch: '50-stable'
-    gem 'activerecord-jdbcpostgresql-adapter', git: 'https://github.com/jruby/activerecord-jdbc-adapter', branch: '50-stable'
+    gem 'activerecord-jdbcmysql-adapter', '~> 50.1'
+    gem 'activerecord-jdbcpostgresql-adapter', '~> 50.1'
     gem 'kramdown'
   end
 

data/gemfiles/Gemfile.rails-5.1.rb

@@ -8,8 +8,8 @@ gem 'railties', '~> 5.1.0'
 # Database Configuration
 group :development, :test do
   platforms :jruby do
-    gem 'activerecord-jdbcmysql-adapter', git: 'https://github.com/jruby/activerecord-jdbc-adapter', branch: 'master'
-    gem 'activerecord-jdbcpostgresql-adapter', git: 'https://github.com/jruby/activerecord-jdbc-adapter', branch: 'master'
+    gem 'activerecord-jdbcmysql-adapter', '~> 50.1'
+    gem 'activerecord-jdbcpostgresql-adapter', '~> 50.1'
     gem 'kramdown'
   end
 

data/gemfiles/Gemfile.rails-5.2.rb

@@ -8,8 +8,8 @@ gem 'railties', '~> 5.2.0'
 # Database Configuration
 group :development, :test do
   platforms :jruby do
-    gem 'activerecord-jdbcmysql-adapter', git: 'https://github.com/jruby/activerecord-jdbc-adapter', branch: 'master'
-    gem 'activerecord-jdbcpostgresql-adapter', git: 'https://github.com/jruby/activerecord-jdbc-adapter', branch: 'master'
+    gem 'activerecord-jdbcmysql-adapter', '~> 51.1'
+    gem 'activerecord-jdbcpostgresql-adapter', '~> 51.1'
     gem 'kramdown'
   end
 

data/lib/friendly_id/base.rb

@@ -261,12 +261,7 @@ often better and easier to use {FriendlyId::Slugged slugs}.
     # Either the friendly_id, or the numeric id cast to a string.
     def to_param
       if friendly_id_config.routes == :friendly
-        if attribute_changed?(friendly_id_config.query_field)
-          diff = changes[friendly_id_config.query_field]
-          diff.first || diff.second
-        else
-          friendly_id.presence.to_param || super
-        end
+        friendly_id.presence.to_param || super
       else
         super
       end

data/lib/friendly_id/finder_methods.rb

@@ -20,20 +20,22 @@ module FriendlyId
       return super if args.count != 1 || id.unfriendly_id?
       first_by_friendly_id(id).tap {|result| return result unless result.nil?}
       return super if potential_primary_key?(id)
-      raise ActiveRecord::RecordNotFound, "can't find record with friendly id: #{id.inspect}"
+      raise_not_found_exception id
+      
     end
 
     # Returns true if a record with the given id exists.
     def exists?(conditions = :none)
-      return super unless conditions.friendly_id?
-      exists_by_friendly_id?(conditions)
+      return super if conditions.unfriendly_id?
+      return true if exists_by_friendly_id?(conditions)
+      super
     end
 
     # Finds exclusively by the friendly id, completely bypassing original
     # `find`.
     # @raise ActiveRecord::RecordNotFound
     def find_by_friendly_id(id)
-      first_by_friendly_id(id) or raise ActiveRecord::RecordNotFound, "can't find record with friendly id: #{id.inspect}"
+      first_by_friendly_id(id) or raise raise_not_found_exception(id)
     end
 
     def exists_by_friendly_id?(id)
@@ -60,5 +62,14 @@ module FriendlyId
       find_by(friendly_id_config.query_field => id)
     end
 
+    def raise_not_found_exception(id)
+      message = "can't find record with friendly id: #{id.inspect}"
+      if ActiveRecord.version < Gem::Version.create('5.0') then 
+        raise ActiveRecord::RecordNotFound.new(message)
+      else 
+        raise ActiveRecord::RecordNotFound.new(message, name, friendly_id_config.query_field, id)
+      end
+    end
+
   end
 end

data/lib/friendly_id/history.rb

@@ -110,9 +110,10 @@ method.
     # 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.joins(:slugs).merge(Slug.where('sluggable_id <> ?', id))
+      relation = super.joins(:slugs)
+      unless new_record?
+        relation = relation.merge(Slug.where('sluggable_id <> ?', id))
+      end
       if friendly_id_config.uses?(:scoped)
         relation = relation.where(Slug.arel_table[:scope].eq(serialized_scope))
       end

data/lib/friendly_id/initializer.rb

@@ -19,7 +19,7 @@ FriendlyId.defaults do |config|
   config.reserved_words = %w(new edit index session login logout users admin
     stylesheets assets javascripts images)
     
-  # This adds an option to to treat reserved words as conflicts rather than exceptions.
+  # This adds an option to treat reserved words as conflicts rather than exceptions.
   # When there is no good candidate, a UUID will be appended, matching the existing
   # conflict behavior.
 

data/lib/friendly_id/migration.rb

@@ -1,11 +1,11 @@
-migration_class =
+MIGRATION_CLASS =
   if ActiveRecord::VERSION::MAJOR >= 5
-    ActiveRecord::Migration[4.2]
+    ActiveRecord::Migration["#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"]
   else
     ActiveRecord::Migration
   end
 
-class CreateFriendlyIdSlugs < migration_class
+class CreateFriendlyIdSlugs < MIGRATION_CLASS
   def change
     create_table :friendly_id_slugs do |t|
       t.string   :slug,           :null => false
@@ -14,9 +14,8 @@ class CreateFriendlyIdSlugs < migration_class
       t.string   :scope
       t.datetime :created_at
     end
-    add_index :friendly_id_slugs, :sluggable_id
+    add_index :friendly_id_slugs, [:sluggable_type, :sluggable_id]
     add_index :friendly_id_slugs, [:slug, :sluggable_type], length: { slug: 140, sluggable_type: 50 }
     add_index :friendly_id_slugs, [:slug, :sluggable_type, :scope], length: { slug: 70, sluggable_type: 50, scope: 70 }, unique: true
-    add_index :friendly_id_slugs, :sluggable_type
   end
 end

data/lib/friendly_id/scoped.rb

@@ -122,7 +122,10 @@ an example of one way to set this up:
     end
 
     def scope_for_slug_generator
-      relation = self.class.unscoped.friendly
+      if friendly_id_config.uses?(:History)
+        return super
+      end
+      relation = self.class.base_class.unscoped.friendly
       friendly_id_config.scope_columns.each do |column|
         relation = relation.where(column => send(column))
       end
@@ -136,6 +139,10 @@ an example of one way to set this up:
     end
     private :slug_generator
 
+    def should_generate_new_friendly_id?
+      (changed & friendly_id_config.scope_columns).any? || super
+    end
+
     # This module adds the `:scope` configuration option to
     # {FriendlyId::Configuration FriendlyId::Configuration}.
     module Configuration

data/lib/friendly_id/sequentially_slugged.rb

@@ -11,7 +11,7 @@ module FriendlyId
                                   candidate,
                                   friendly_id_config.slug_column,
                                   friendly_id_config.sequence_separator,
-                                  self.class.base_class).next_slug
+                                  slug_base_class).next_slug
     end
 
     class SequentialSlugCalculator
@@ -73,5 +73,15 @@ module FriendlyId
         "#{length_command}(#{slug_column}) ASC, #{slug_column} ASC"
       end
     end
+
+    private
+
+    def slug_base_class
+      if friendly_id_config.uses?(:history)
+        Slug
+      else
+        self.class.base_class
+      end
+    end
   end
 end

data/lib/friendly_id/version.rb

@@ -1,3 +1,3 @@
 module FriendlyId
-  VERSION = '5.2.4'.freeze
+  VERSION = '5.2.5'.freeze
 end

data/test/helper.rb

@@ -69,7 +69,6 @@ module FriendlyId
 
       def connect
         version = ActiveRecord::VERSION::STRING
-        driver  = FriendlyId::Test::Database.driver
         engine  = RUBY_ENGINE rescue "ruby"
 
         ActiveRecord::Base.establish_connection config[driver]
@@ -90,7 +89,9 @@ module FriendlyId
       end
 
       def driver
-        (ENV["DB"] or "sqlite3").downcase
+        _driver = ENV.fetch('DB', 'sqlite3').downcase
+        _driver = "postgres" if %w(postgresql pg).include?(_driver)
+        _driver
       end
 
       def in_memory?

data/test/numeric_slug_test.rb

@@ -0,0 +1,31 @@
+require 'helper'
+
+class NumericSlugTest < TestCaseClass
+  include FriendlyId::Test
+  include FriendlyId::Test::Shared::Core
+
+  def model_class
+    Article
+  end
+
+  test "should generate numeric slugs" do
+    transaction do
+      record = model_class.create! :name => "123"
+      assert_equal "123", record.slug
+    end
+  end
+
+  test "should find by numeric slug" do
+    transaction do
+      record = model_class.create! :name => "123"
+      assert_equal model_class.friendly.find("123").id, record.id
+    end
+  end
+
+  test "should exist? by numeric slug" do
+    transaction do
+      record = model_class.create! :name => "123"
+      assert model_class.friendly.exists?("123")
+    end
+  end
+end

data/test/scoped_test.rb

@@ -81,4 +81,17 @@ class ScopedTest < TestCaseClass
     end
   end
 
+  test "should generate new slug when scope changes" do
+    transaction do
+      novelist = Novelist.create! :name => "a"
+      publisher = Publisher.create! :name => "b"
+      novel1 = Novel.create! :name => "c", :novelist => novelist, :publisher => publisher
+      novel2 = Novel.create! :name => "c", :novelist => novelist, :publisher => Publisher.create(:name => "d")
+      assert_equal novel1.friendly_id, novel2.friendly_id
+      novel2.publisher = publisher
+      novel2.save!
+      assert novel2.friendly_id != novel1.friendly_id
+    end
+  end
+
 end

data/test/sequentially_slugged_test.rb

@@ -137,4 +137,63 @@ class SequentiallySluggedTestWithHistory < TestCaseClass
       assert_equal 'test-name-2', record2.slug
     end
   end
+
+  test "should work with regeneration with history when 2 slugs already exists and the second is changed" do
+    transaction do
+      record1 = model_class.create! :name => "Test name"
+      record2 = model_class.create! :name => "Test name"
+      record3 = model_class.create! :name => "Another test name"
+      assert_equal 'test-name', record1.slug
+      assert_equal 'test-name-2', record2.slug
+      assert_equal 'another-test-name', record3.slug
+
+      record2.name = "One more test name"
+      record2.slug = nil
+      record2.save!
+      assert_equal 'one-more-test-name', record2.slug
+
+      record3.name = "Test name"
+      record3.slug = nil
+      record3.save!
+      assert_equal 'test-name-3', record3.slug
+    end
+  end
+end
+
+class City < ActiveRecord::Base
+  has_many :restaurants
+end
+
+class Restaurant < ActiveRecord::Base
+  extend FriendlyId
+  belongs_to :city
+  friendly_id :name, :use => [:sequentially_slugged, :scoped, :history], :scope => :city
+end
+
+class SequentiallySluggedTestWithScopedHistory < TestCaseClass
+  include FriendlyId::Test
+  include FriendlyId::Test::Shared::Core
+
+  def model_class
+    Restaurant
+  end
+
+  test "should work with regeneration with scoped history" do
+    transaction do
+      city1 = City.create!
+      city2 = City.create!
+      record1 = model_class.create! :name => "Test name", :city => city1
+      record2 = model_class.create! :name => "Test name", :city => city1
+
+      assert_equal 'test-name', record1.slug
+      assert_equal 'test-name-2', record2.slug
+
+      record2.name = 'Another test name'
+      record2.slug = nil
+      record2.save!
+
+      record3 = model_class.create! :name => "Test name", :city => city1
+      assert_equal 'test-name-3', record3.slug
+    end
+  end
 end

data/test/slugged_test.rb

@@ -152,7 +152,6 @@ class SluggedTest < TestCaseClass
       assert_equal 'foo', instance.slug
     end
   end
-
 end
 
 class SlugGeneratorTest < TestCaseClass
@@ -419,6 +418,85 @@ class FailedValidationAfterUpdateRegressionTest < TestCaseClass
 
 end
 
+class ToParamTest < TestCaseClass
+
+  include FriendlyId::Test
+
+  class Journalist < ActiveRecord::Base
+    extend FriendlyId
+    validates_presence_of :active
+    friendly_id :name, :use => :slugged
+
+    attr_accessor :to_param_in_callback
+
+    after_save do
+      self.to_param_in_callback = to_param
+    end
+  end
+
+  test "to_param should return nil if record is unpersisted" do
+    assert_nil Journalist.new.to_param
+  end
+
+  test "to_param should return nil if record failed validation" do
+    journalist = Journalist.new :name => 'Clark Kent', :active => nil
+    refute journalist.save
+    assert_nil journalist.to_param
+  end
+
+  test "to_param should use slugged attribute if record saved successfully" do
+    transaction do
+      journalist = Journalist.new :name => 'Clark Kent', :active => true
+      assert journalist.save
+      assert_equal 'clark-kent', journalist.to_param
+    end
+  end
+
+  test "to_param should use original slug if existing record changes but fails to save" do
+    transaction do
+      journalist = Journalist.new :name => 'Clark Kent', :active => true
+      assert journalist.save
+      journalist.name = 'Superman'
+      journalist.slug = nil
+      journalist.active = nil
+      refute journalist.save
+      assert_equal 'clark-kent', journalist.to_param
+    end
+  end
+
+  test "to_param should use new slug if existing record changes successfully" do
+    transaction do
+      journalist = Journalist.new :name => 'Clark Kent', :active => true
+      assert journalist.save
+      journalist.name = 'Superman'
+      journalist.slug = nil
+      assert journalist.save
+      assert_equal 'superman', journalist.to_param
+    end
+  end
+
+  test "to_param should use new slug within callbacks if new record is saved successfully" do
+    transaction do
+      journalist = Journalist.new :name => 'Clark Kent', :active => true
+      assert journalist.save
+      assert_equal 'clark-kent', journalist.to_param_in_callback, "value of to_param in callback should use the new slug value"
+    end
+  end
+
+  test "to_param should use new slug within callbacks if existing record changes successfully" do
+    transaction do
+      journalist = Journalist.new :name => 'Clark Kent', :active => true
+      assert journalist.save
+      assert journalist.valid?
+      journalist.name = 'Superman'
+      journalist.slug = nil
+      assert journalist.save, "save should be successful"
+      assert_equal 'superman', journalist.to_param_in_callback, "value of to_param in callback should use the new slug value"
+    end
+  end
+
+end
+
 class ConfigurableRoutesTest < TestCaseClass
   include FriendlyId::Test
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: friendly_id
 version: !ruby/object:Gem::Version
-  version: 5.2.4
+  version: 5.2.5
 platform: ruby
 authors:
 - Norman Clarke
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-24 00:00:00.000000000 Z
+date: 2018-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -199,6 +199,7 @@ files:
 - test/generator_test.rb
 - test/helper.rb
 - test/history_test.rb
+- test/numeric_slug_test.rb
 - test/object_utils_test.rb
 - test/reserved_test.rb
 - test/schema.rb
@@ -228,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: friendly_id
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A comprehensive slugging and pretty-URL plugin.