Back to Repositories

Testing Multilingual Slug Generation in FriendlyId

This test suite validates the internationalization (i18n) functionality of the FriendlyId gem for generating localized slugs in Ruby applications. It ensures proper handling of URL slugs across different languages and locales while maintaining data integrity and fallback behavior.

Test Coverage Overview

The test suite comprehensively covers internationalized slug generation and management:

Locale-specific slug generation and storage
Proper slug retrieval based on current locale
Fallback behavior when slugs are missing for specific locales
Slug sequencing for duplicate entries across locales
Configuration validation for different locale formats

Implementation Analysis

The testing approach utilizes Minitest’s assertion framework with ActiveRecord integration. It implements transaction blocks for database state management and employs I18n.with_locale blocks to test behavior across different locales. The suite demonstrates proper isolation of test cases and thorough validation of locale-specific functionality.

Technical Details

Testing Framework: Minitest
Database Integration: ActiveRecord
I18n Support: Ruby I18n library
Test Structure: Hierarchical test classes with shared FriendlyId::Test module
Configuration Testing: Custom model classes for testing different slug configurations

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Proper test isolation using transaction blocks
Comprehensive edge case coverage
Clear test naming conventions
Modular test organization with separate test classes for different concerns
Effective use of setup methods and helper modules

norman/friendly_id

test/simple_i18n_test.rb

            
require "helper"

class SimpleI18nTest < TestCaseClass
  include FriendlyId::Test

  class Journalist < ActiveRecord::Base
    extend FriendlyId
    friendly_id :name, use: :simple_i18n
  end

  def setup
    I18n.locale = :en
  end

  test "friendly_id should return the current locale's slug" do
    journalist = Journalist.new(name: "John Doe")
    journalist.slug_es = "juan-fulano"
    journalist.slug_fr_ca = "jean-dupont"
    journalist.valid?
    I18n.with_locale(I18n.default_locale) do
      assert_equal "john-doe", journalist.friendly_id
    end
    I18n.with_locale(:es) do
      assert_equal "juan-fulano", journalist.friendly_id
    end
    I18n.with_locale(:"fr-CA") do
      assert_equal "jean-dupont", journalist.friendly_id
    end
  end

  test "should create record with slug in column for the current locale" do
    I18n.with_locale(I18n.default_locale) do
      journalist = Journalist.new(name: "John Doe")
      journalist.valid?
      assert_equal "john-doe", journalist.slug_en
      assert_nil journalist.slug_es
    end
    I18n.with_locale(:es) do
      journalist = Journalist.new(name: "John Doe")
      journalist.valid?
      assert_equal "john-doe", journalist.slug_es
      assert_nil journalist.slug_en
    end
  end

  test "to_param should return the numeric id when there's no slug for the current locale" do
    transaction do
      journalist = Journalist.new(name: "Juan Fulano")
      I18n.with_locale(:es) do
        journalist.save!
        assert_equal "juan-fulano", journalist.to_param
      end
      assert_equal journalist.id.to_s, journalist.to_param
    end
  end

  test "should set friendly id for locale" do
    transaction do
      journalist = Journalist.create!(name: "John Smith")
      journalist.set_friendly_id("Juan Fulano", :es)
      journalist.save!
      assert_equal "juan-fulano", journalist.slug_es
      I18n.with_locale(:es) do
        assert_equal "juan-fulano", journalist.to_param
      end
    end
  end

  test "set friendly_id should fall back default locale when none is given" do
    transaction do
      journalist = I18n.with_locale(:es) do
        Journalist.create!(name: "Juan Fulano")
      end
      journalist.set_friendly_id("John Doe")
      journalist.save!
      assert_equal "john-doe", journalist.slug_en
    end
  end

  test "should sequence localized slugs" do
    transaction do
      journalist = Journalist.create!(name: "John Smith")
      I18n.with_locale(:es) do
        Journalist.create!(name: "Juan Fulano")
      end
      journalist.set_friendly_id("Juan Fulano", :es)
      journalist.save!
      assert_equal "john-smith", journalist.to_param
      I18n.with_locale(:es) do
        assert_match(/juan-fulano-.+/, journalist.to_param)
      end
    end
  end

  class RegressionTest < TestCaseClass
    include FriendlyId::Test

    test "should not overwrite other locale's slugs on update" do
      transaction do
        journalist = Journalist.create!(name: "John Smith")
        journalist.set_friendly_id("Juan Fulano", :es)
        journalist.save!
        assert_equal "john-smith", journalist.to_param
        journalist.slug = nil
        journalist.update name: "Johnny Smith"
        assert_equal "johnny-smith", journalist.to_param
        I18n.with_locale(:es) do
          assert_equal "juan-fulano", journalist.to_param
        end
      end
    end
  end

  class ConfigurationTest < TestCaseClass
    test "should add locale to slug column for a non-default locale" do
      I18n.with_locale :es do
        assert_equal "slug_es", Journalist.friendly_id_config.slug_column
      end
    end

    test "should add locale to slug column for a locale with a region subtag" do
      I18n.with_locale :"fr-CA" do
        assert_equal "slug_fr_ca", Journalist.friendly_id_config.slug_column
      end
    end

    test "should add locale to non-default slug column and non-default locale" do
      model_class = Class.new(ActiveRecord::Base) do
        self.abstract_class = true
        extend FriendlyId
        friendly_id :name, use: :simple_i18n, slug_column: :foo
      end
      I18n.with_locale :es do
        assert_equal "foo_es", model_class.friendly_id_config.slug_column
      end
    end

    test "should add locale to slug column for default locale" do
      I18n.with_locale(I18n.default_locale) do
        assert_equal "slug_en", Journalist.friendly_id_config.slug_column
      end
    end
  end
end