friendly_id-globalize 1.0.0.alpha2 → 1.0.0.alpha4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c240c7dc5d34b3afb7338ae100c7202f04d73e96
-  data.tar.gz: f5655d526ff831df27bad81a74699c824123ffb0
+SHA256:
+  metadata.gz: 3c63abb7940af7e1cfb45dc6bcc7203699a4993ee7fb7d2bda9a8f788c2710a2
+  data.tar.gz: c87d245f950ef8da97062015d6bd05be41e4c2466953d0dcf689077d1a160839
 SHA512:
-  metadata.gz: a6b36a173d89897737d18071f84a55eddeeb9edf1afaf61cec54b703a9a2975e1e65ab632486a5873bd707ab994a366c2d6105bbe15fb1008c8b455de332f5a9
-  data.tar.gz: 07d69a9ec4616a7ba1da6f744cae485b6c1bb7a75abd5b379334492992f1d0a829de35b3dd78454f87193663488b00dcaf77f3d5ef5636fc1ac64b967c50a53b
+  metadata.gz: 70275b9abdc134b05ec8e0836b0a22894f02faa18304f8962231bcb55052312dde373d115b2ee16aeed1e33220bb063776535c3911d6ec3a56cae30f13079f52
+  data.tar.gz: 94721821b35d7ad98055e76498ac403d964af9ad03a26daf982bf2e1bc4081e650749f4b5d6ca481260a198d04fc1970c37b98a09775c35406145c7c800e7523

data/README.md

@@ -3,6 +3,12 @@
 [Globalize](https://github.com/globalize/globalize) support for
 [FriendlyId](https://github.com/norman/friendly_id).
 
+### Installation
+```ruby
+gem 'friendly_id-globalize'
+rails generate friendly_id_globalize
+```
+
 ### Translating Slugs Using Globalize
 The `FriendlyId::Globalize Globalize` module lets you use
 [Globalize](https://github.com/globalize/globalize) to translate slugs. This

data/friendly_id-globalize.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 1.9.3'
 
-  s.add_dependency 'friendly_id', '~> 5.1.0', '< 6.0'
+  s.add_dependency 'friendly_id', '>= 5.1.0', '< 6.0'
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'yard'
   s.add_development_dependency "globalize"

data/lib/friendly_id/globalize/version.rb

@@ -1,5 +1,5 @@
 module FriendlyId
   module Globalize
-    VERSION = '1.0.0.alpha2'
+    VERSION = '1.0.0.alpha4'
   end
 end

data/lib/friendly_id/globalize.rb

@@ -7,7 +7,7 @@ module FriendlyId
 == Translating Slugs Using Globalize
 
 The {FriendlyId::Globalize Globalize} module lets you use
-Globalize[https://github.com/svenfuchs/globalize3] to translate slugs. This
+Globalize[https://github.com/globalize/globalize] to translate slugs. This
 module is most suitable for applications that need to be localized to many
 languages. If your application only needs to be localized to one or two
 languages, you may wish to consider the {FriendlyId::SimpleI18n SimpleI18n}
@@ -85,7 +85,7 @@ current locale:
 
     def set_friendly_id(text, locale = nil)
       ::Globalize.with_locale(locale || ::Globalize.locale) do
-        set_slug normalize_friendly_id(text)
+        super_set_slug normalize_friendly_id(text)
       end
     end
 
@@ -94,12 +94,8 @@ current locale:
     end
 
     def set_slug(normalized_slug = nil)
-      if self.translations.size > 1
-        self.translations.map(&:locale).each do |locale|
-          ::Globalize.with_locale(locale) { super_set_slug(normalized_slug) }
-        end
-      else
-        ::Globalize.with_locale(::Globalize.locale) { super_set_slug(normalized_slug) }
+      (self.translations.map(&:locale).presence || [::Globalize.locale]).each do |locale|
+        ::Globalize.with_locale(locale) { super_set_slug(normalized_slug) }
       end
     end
 
@@ -107,9 +103,8 @@ current locale:
       if should_generate_new_friendly_id?
         candidates = FriendlyId::Candidates.new(self, normalized_slug || send(friendly_id_config.base))
         slug = slug_generator.generate(candidates) || resolve_friendly_id_conflict(candidates)
-        translation.slug = slug
+        translation.send("#{friendly_id_config.slug_column}=", slug)
       end
     end
   end
 end
-

data/lib/friendly_id/history.rb

@@ -0,0 +1,142 @@
+module FriendlyId
+
+=begin
+
+## History: Avoiding 404's When Slugs Change
+
+FriendlyId's {FriendlyId::History History} module adds the ability to store a
+log of a model's slugs, so that when its friendly id changes, it's still
+possible to perform finds by the old id.
+
+The primary use case for this is avoiding broken URLs.
+
+### Setup
+
+In order to use this module, you must add a table to your database schema to
+store the slug records. FriendlyId provides a generator for this purpose:
+
+    rails generate friendly_id_globalize
+    rake db:migrate
+
+This will add a table named `friendly_id_slugs`, used by the {FriendlyId::Slug}
+model.
+
+### Considerations
+
+Because recording slug history requires creating additional database records,
+this module has an impact on the performance of the associated model's `create`
+method.
+
+### Example
+
+    class Post < ActiveRecord::Base
+      extend FriendlyId
+      friendly_id :title, :use => :history
+    end
+
+    class PostsController < ApplicationController
+
+      before_filter :find_post
+
+      ...
+
+      def find_post
+        @post = Post.find params[:id]
+
+        # If an old id or a numeric id was used to find the record, then
+        # the request path will not match the post_path, and we should do
+        # a 301 redirect that uses the current friendly id.
+        if request.path != post_path(@post)
+          return redirect_to @post, :status => :moved_permanently
+        end
+      end
+    end
+=end
+  module History
+
+    def self.setup(model_class)
+      model_class.instance_eval do
+        friendly_id_config.use :slugged
+        friendly_id_config.finder_methods = FriendlyId::History::FinderMethods
+        if friendly_id_config.uses? :finders
+          relation.class.send(:include, friendly_id_config.finder_methods)
+          if ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR == 2
+            model_class.send(:extend, friendly_id_config.finder_methods)
+          end
+        end
+      end
+    end
+
+    # Configures the model instance to use the History add-on.
+    def self.included(model_class)
+      model_class.class_eval do
+        has_many :slugs, -> {order(Slug.arel_table[:id].desc)}, 
+          as:         :sluggable,
+          dependent:  :destroy,
+          class_name: Slug.to_s
+        
+        after_save :create_slug
+      end
+    end
+
+    module FinderMethods
+      include ::FriendlyId::FinderMethods
+
+      def exists_by_friendly_id?(id)
+        joins(:slugs, :translations).where(translation_class.arel_table[friendly_id_config.query_field].eq(id)).exists? || joins(:slugs).where(slug_history_clause(id)).exists?
+      end
+
+      private
+
+      def first_by_friendly_id(id)
+        matching_record = where(friendly_id_config.query_field => id).first
+        matching_record || slug_table_record(id)
+      end
+
+      def slug_table_record(id)
+        select(quoted_table_name + '.*').joins(:slugs).where(slug_history_clause(id)).order(Slug.arel_table[:id].desc).first
+      end
+
+      def slug_history_clause(id)
+        Slug.arel_table[:sluggable_type].eq(base_class.to_s).and(Slug.arel_table[:slug].eq(id)).and(Slug.arel_table[:locale].eq(::Globalize.locale))
+      end
+    end
+
+    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(Slug.arel_table[:scope].eq(serialized_scope))
+      end
+      relation
+    end
+
+    def create_slug
+      translations.map(&:locale).each do |locale|
+        ::Globalize.with_locale(locale) { super_create_slug(locale) }
+      end
+    end
+
+    def super_create_slug(locale)
+      return unless friendly_id
+      return if slugs.where(locale: locale).first.try(:slug) == friendly_id
+      # Allow reversion back to a previously used slug
+      relation = slugs.where(slug: friendly_id, locale: locale)
+      if friendly_id_config.uses?(:scoped)
+        relation = relation.where(:scope => serialized_scope)
+      end
+      relation.delete_all
+      slugs.create! do |record|
+        record.slug = friendly_id
+        record.locale = locale
+        record.scope = serialized_scope if friendly_id_config.uses?(:scoped)
+      end
+    end
+  end
+end

data/lib/friendly_id/migration.rb

@@ -0,0 +1,11 @@
+class AddLocaleToFriendlyIdSlugs < ActiveRecord::Migration
+  def change
+    add_column :friendly_id_slugs, :locale, :string, length: 2, null: :false, after: :scope
+
+    remove_index :friendly_id_slugs, [:slug, :sluggable_type]
+    add_index :friendly_id_slugs, [:slug, :sluggable_type, :locale], length: { slug: 140, sluggable_type: 50, locale: 2 }
+    remove_index :friendly_id_slugs, [:slug, :sluggable_type, :scope]
+    add_index :friendly_id_slugs, [:slug, :sluggable_type, :scope, :locale], length: { slug: 70, sluggable_type: 50, scope: 70, locale: 2 }, unique: true, name: :index_friendly_id_slugs_uniqueness
+    add_index :friendly_id_slugs, :locale
+  end
+end

data/lib/generators/friendly_id_globalize_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+require "rails/generators/active_record"
+
+# This generator adds a migration for the {FriendlyId::History
+# FriendlyId::History} addon.
+class FriendlyIdGlobalizeGenerator < ActiveRecord::Generators::Base
+  # ActiveRecord::Generators::Base inherits from Rails::Generators::NamedBase which requires a NAME parameter for the
+  # new table name. Our generator always uses 'friendly_id_slugs', so we just set a random name here.
+  argument :name, type: :string, default: 'random_name'
+
+  class_option :'skip-migration', :type => :boolean, :desc => "Don't generate a migration for the slugs table"
+
+  source_root File.expand_path('../../friendly_id', __FILE__)
+
+  # Copies the migration template to db/migrate.
+  def copy_files
+    return if options['skip-migration']
+    migration_template 'migration.rb', 'db/migrate/add_locale_to_friendly_id_slugs.rb'
+  end
+end

data/test/globalize_test.rb

@@ -22,14 +22,14 @@ ActiveRecord::Migration.verbose = false
 FriendlyIdGlobalizeTest.up
 
 class Article < ActiveRecord::Base
-  translates :slug, :title, fallbacks_for_empty_translations: true
+  translates :my_slug, :title, fallbacks_for_empty_translations: true
   accepts_nested_attributes_for :translations
 
   extend FriendlyId
-  friendly_id :title, :use => [:slugged, :globalize]
+  friendly_id :title, :use => :globalize, :slug_column => 'my_slug'
 end
 
-Article.create_translation_table! :slug => :string, :title => :string
+Article.create_translation_table! :my_slug => :string, :title => :string
 
 class Module
   def test(name, &block)
@@ -77,21 +77,25 @@ class GlobalizeTest < MiniTest::Unit::TestCase
     transaction do
       article = Article.create!(:title => "War and Peace")
       article.set_friendly_id("Guerra y paz", :es)
+      article.set_friendly_id("Guerra e pace", :it)
       article.save!
       found_article = Article.friendly.find('war-and-peace')
       I18n.with_locale(:es) { assert_equal "guerra-y-paz", found_article.friendly_id }
       I18n.with_locale(:en) { assert_equal "war-and-peace", found_article.friendly_id }
+      I18n.with_locale(:it) { assert_equal "guerra-e-pace", found_article.friendly_id }
     end
   end
 
   test "should set all friendly ids for each nested translation" do
     transaction do
       article = Article.create!(translations_attributes: {
-        xx: { :title => "Guerra e pace", locale: 'it' },
-        yy: { title: 'Guerre et paix', locale: 'fr' }
+        xx: { title: 'Guerra e pace', locale: 'it' },
+        yy: { title: 'Guerre et paix', locale: 'fr' },
+        zz: { title: 'Guerra y paz', locale: 'es' }
       })
       I18n.with_locale(:it) { assert_equal "guerra-e-pace", article.friendly_id }
       I18n.with_locale(:fr) { assert_equal "guerre-et-paix", article.friendly_id }
+      I18n.with_locale(:es) { assert_equal "guerra-y-paz", article.friendly_id }
     end
   end
 
@@ -110,4 +114,3 @@ class GlobalizeTest < MiniTest::Unit::TestCase
     end
   end
 end
-

metadata

@@ -1,21 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: friendly_id-globalize
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha2
+  version: 1.0.0.alpha4
 platform: ruby
 authors:
 - Norman Clarke
 - Philip Arndt
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-23 00:00:00.000000000 Z
+date: 2025-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: friendly_id
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.1.0
     - - "<"
@@ -25,7 +24,7 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.1.0
     - - "<"
@@ -90,12 +89,14 @@ files:
 - friendly_id-globalize.gemspec
 - lib/friendly_id/globalize.rb
 - lib/friendly_id/globalize/version.rb
+- lib/friendly_id/history.rb
+- lib/friendly_id/migration.rb
+- lib/generators/friendly_id_globalize_generator.rb
 - test/globalize_test.rb
 homepage: http://github.com/norman/friendly_id-globalize
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -106,14 +107,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Globalize support for FriendlyId.
 test_files: []
-has_rdoc: