Testing FriendlyId Slug History Management in norman/friendly_id

norman/friendly_id

test/history_test.rb

            
require "helper"

class HistoryTest < TestCaseClass
  include FriendlyId::Test
  include FriendlyId::Test::Shared::Core

  class Manual < ActiveRecord::Base
    extend FriendlyId
    friendly_id :name, use: [:slugged, :history]
  end

  def model_class
    Manual
  end

  test "should insert record in slugs table on create" do
    with_instance_of(model_class) { |record| assert record.slugs.any? }
  end

  test "should not create new slug record if friendly_id is not changed" do
    with_instance_of(model_class) do |record|
      record.active = true
      record.save!
      assert_equal 1, FriendlyId::Slug.count
    end
  end

  test "should create new slug record when friendly_id changes" do
    with_instance_of(model_class) do |record|
      record.name = record.name + "b"
      record.slug = nil
      record.save!
      assert_equal 2, FriendlyId::Slug.count
    end
  end

  test "should be findable by old slugs" do
    with_instance_of(model_class) do |record|
      old_friendly_id = record.friendly_id
      record.name = record.name + "b"
      record.slug = nil
      record.save!
      begin
        assert model_class.friendly.find(old_friendly_id)
        assert model_class.friendly.exists?(old_friendly_id), "should exist? by old id"
      rescue ActiveRecord::RecordNotFound
        flunk "Could not find record by old id"
      end
    end
  end

  test "should create slug records on each change" do
    transaction do
      model_class.create! name: "hello"
      assert_equal 1, FriendlyId::Slug.count

      record = model_class.friendly.find("hello")
      record.name = "hello again"
      record.slug = nil
      record.save!
      assert_equal 2, FriendlyId::Slug.count
    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 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
      record.name = record.name + "b"
      record.save!
      assert !model_class.friendly.find(old_friendly_id).readonly?
    end
  end

  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

  test "should maintain history even if current slug is not the most recent one" do
    with_instance_of(model_class) do |record|
      record.name = "current"
      assert record.save

      # this feels like a hack. only thing i can get to work with the HistoryTestWithSti
      # test cases. (Editorialist vs Journalist.)
      sluggable_type = FriendlyId::Slug.first.sluggable_type
      # create several slugs for record
      # current slug does not have max id
      FriendlyId::Slug.delete_all
      FriendlyId::Slug.create(sluggable_type: sluggable_type, sluggable_id: record.id, slug: "current")
      FriendlyId::Slug.create(sluggable_type: sluggable_type, sluggable_id: record.id, slug: "outdated")

      record.reload
      record.slug = nil
      assert record.save

      assert_equal 2, FriendlyId::Slug.count
    end
  end

  test "should not create new slugs that match old slugs" do
    transaction do
      first_record = model_class.create! name: "foo"
      first_record.name = "bar"
      first_record.save!
      second_record = model_class.create! name: "foo"
      assert second_record.slug != "foo"
      assert_match(/foo-.+/, second_record.slug)
    end
  end

  test "should not fail when updating historic slugs" do
    transaction do
      first_record = model_class.create! name: "foo"
      second_record = model_class.create! name: "another"

      second_record.update name: "foo", slug: nil
      assert_match(/foo-.*/, second_record.slug)

      first_record.update name: "another", slug: nil
      assert_match(/another-.*/, first_record.slug)
    end
  end

  test "should prefer product that used slug most recently" do
    transaction do
      first_record = model_class.create! name: "foo"
      second_record = model_class.create! name: "bar"

      first_record.update! slug: "not_foo"
      second_record.update! slug: "foo" # now both records have used foo; second_record most recently
      second_record.update! slug: "not_bar"

      assert_equal model_class.friendly.find("foo"), second_record
    end
  end

  test "should name table according to prefix and suffix" do
    transaction do
      prefix = "prefix_"
      without_prefix = FriendlyId::Slug.table_name
      ActiveRecord::Base.table_name_prefix = prefix
      FriendlyId::Slug.reset_table_name
      assert_equal prefix + without_prefix, FriendlyId::Slug.table_name
    ensure
      ActiveRecord::Base.table_name_prefix = ""
      FriendlyId::Slug.table_name = without_prefix
    end
  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 DependentDestroyTest < TestCaseClass
  include FriendlyId::Test

  class FalseManual < ActiveRecord::Base
    self.table_name = "manuals"

    extend FriendlyId
    friendly_id :name, use: :history, dependent: false
  end

  class DefaultManual < ActiveRecord::Base
    self.table_name = "manuals"

    extend FriendlyId
    friendly_id :name, use: :history
  end

  test "should allow disabling of dependent destroy" do
    transaction do
      assert FriendlyId::Slug.find_by_slug("foo").nil?
      l = FalseManual.create! name: "foo"
      assert FriendlyId::Slug.find_by_slug("foo").present?
      l.destroy
      assert FriendlyId::Slug.find_by_slug("foo").present?
    end
  end

  test "should dependently destroy by default" do
    transaction do
      assert FriendlyId::Slug.find_by_slug("baz").nil?
      l = DefaultManual.create! name: "baz"
      assert FriendlyId::Slug.find_by_slug("baz").present?
      l.destroy
      assert FriendlyId::Slug.find_by_slug("baz").nil?
    end
  end
end

if ActiveRecord::VERSION::STRING >= "5.0"
  class HistoryTestWithParanoidDeletes < HistoryTest
    class ParanoidRecord < ActiveRecord::Base
      extend FriendlyId
      friendly_id :name, use: :history, dependent: false

      default_scope { where(deleted_at: nil) }
    end

    def model_class
      ParanoidRecord
    end

    test "slug should have a sluggable even when soft deleted by a library" do
      transaction do
        assert FriendlyId::Slug.find_by_slug("paranoid").nil?
        record = model_class.create(name: "paranoid")
        assert FriendlyId::Slug.find_by_slug("paranoid").present?

        record.update deleted_at: Time.now

        orphan_slug = FriendlyId::Slug.find_by_slug("paranoid")
        assert orphan_slug.present?, "Orphaned slug should exist"

        assert orphan_slug.valid?, "Errors: #{orphan_slug.errors.full_messages}"
        assert orphan_slug.sluggable.present?, "Orphaned slug should still find corresponding paranoid sluggable"
      end
    end
  end
end

class HistoryTestWithSti < HistoryTest
  class Journalist < ActiveRecord::Base
    extend FriendlyId
    friendly_id :name, use: [:slugged, :history]
  end

  class Editorialist < Journalist
  end

  def model_class
    Editorialist
  end
end

class HistoryTestWithFriendlyFinders < HistoryTest
  class Journalist < ActiveRecord::Base
    extend FriendlyId
    friendly_id :name, use: [:slugged, :finders, :history]
  end

  class Restaurant < ActiveRecord::Base
    extend FriendlyId
    belongs_to :city
    friendly_id :name, use: [:slugged, :history, :finders]
  end

  test "should be findable by old slugs" do
    [Journalist, Restaurant].each do |model_class|
      with_instance_of(model_class) do |record|
        old_friendly_id = record.friendly_id
        record.name = record.name + "b"
        record.slug = nil
        record.save!
        begin
          assert model_class.find(old_friendly_id)
          assert model_class.exists?(old_friendly_id), "should exist? by old id for #{model_class.name}"
        rescue ActiveRecord::RecordNotFound
          flunk "Could not find record by old id for #{model_class.name}"
        end
      end
    end
  end
end

class HistoryTestWithFindersBeforeHistory < HistoryTest
  class Novelist < ActiveRecord::Base
    has_many :novels
  end

  class Novel < ActiveRecord::Base
    extend FriendlyId

    belongs_to :novelist

    friendly_id :name, use: [:finders, :history]

    def should_generate_new_friendly_id?
      slug.blank? || name_changed?
    end
  end

  test "should be findable by old slug through has_many association" do
    transaction do
      novelist = Novelist.create!(name: "Stephen King")
      novel = novelist.novels.create(name: "Rita Hayworth and Shawshank Redemption")
      slug = novel.slug
      novel.name = "Shawshank Redemption"
      novel.save!
      assert_equal novel, Novel.find(slug)
      assert_equal novel, novelist.novels.find(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: [:scoped, :history], scope: :city
end

class ScopedHistoryTest < TestCaseClass
  include FriendlyId::Test
  include FriendlyId::Test::Shared::Core

  def model_class
    Restaurant
  end

  test "should find old scoped slugs" do
    transaction do
      city = City.create!
      with_instance_of(Restaurant) do |record|
        record.city = city

        record.name = "x"
        record.slug = nil
        record.save!

        record.name = "y"
        record.slug = nil
        record.save!

        assert_equal city.restaurants.friendly.find("x"), city.restaurants.friendly.find("y")
      end
    end
  end

  test "should consider old scoped slugs when creating slugs" do
    transaction do
      city = City.create!
      with_instance_of(Restaurant) do |record|
        record.city = city

        record.name = "x"
        record.slug = nil
        record.save!

        record.name = "y"
        record.slug = nil
        record.save!

        second_record = model_class.create! city: city, name: "x"
        assert_match(/x-.+/, second_record.friendly_id)

        third_record = model_class.create! city: city, name: "y"
        assert_match(/y-.+/, third_record.friendly_id)
      end
    end
  end

  test "should record history when scope changes" do
    transaction do
      city1 = City.create!
      city2 = City.create!
      with_instance_of(Restaurant) do |record|
        record.name = "x"
        record.slug = nil

        record.city = city1
        record.save!
        assert_equal("city_id:#{city1.id}", record.slugs.reload.first.scope)
        assert_equal("x", record.slugs.reload.first.slug)

        record.city = city2
        record.save!
        assert_equal("city_id:#{city2.id}", record.slugs.reload.first.scope)

        record.name = "y"
        record.slug = nil
        record.city = city1
        record.save!
        assert_equal("city_id:#{city1.id}", record.slugs.reload.first.scope)
        assert_equal("y", record.slugs.reload.first.slug)
      end
    end
  end

  test "should allow equal slugs in different scopes" do
    transaction do
      city = City.create!
      second_city = City.create!
      record = model_class.create! city: city, name: "x"
      second_record = model_class.create! city: second_city, name: "x"

      assert_equal record.slug, second_record.slug
    end
  end
end