friendly_id-globalize 1.0.0.alpha2 → 1.0.0.alpha3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c240c7dc5d34b3afb7338ae100c7202f04d73e96
-  data.tar.gz: f5655d526ff831df27bad81a74699c824123ffb0
+  metadata.gz: 26844163b66ff103307b8f064989dd81cd75dde5
+  data.tar.gz: 8fa22695b5243a5a024477d47f82864305c00691
 SHA512:
-  metadata.gz: a6b36a173d89897737d18071f84a55eddeeb9edf1afaf61cec54b703a9a2975e1e65ab632486a5873bd707ab994a366c2d6105bbe15fb1008c8b455de332f5a9
-  data.tar.gz: 07d69a9ec4616a7ba1da6f744cae485b6c1bb7a75abd5b379334492992f1d0a829de35b3dd78454f87193663488b00dcaf77f3d5ef5636fc1ac64b967c50a53b
+  metadata.gz: d33a80f8d66e16a97169a66230f7042ef4767adb3b7ee7425205aa1fe969026c0774f2f093d4f5207927ce6de4d440916a9c1554d34a7fabce070d507a3131fb
+  data.tar.gz: 24eff53635369319398cb77547f6edd11a7b7a70531504b9e7d95d99c7c9d81af84dba24a66b0e6fb0f3b8a1210af79122ec9238fbedc451a693f1dc320a8479

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.2.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.alpha3'
   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.quoted_table_name}.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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: friendly_id-globalize
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha2
+  version: 1.0.0.alpha3
 platform: ruby
 authors:
 - Norman Clarke
@@ -9,68 +9,68 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-23 00:00:00.000000000 Z
+date: 2017-04-30 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
-    - - "<"
+        version: 5.2.0
+    - - <
       - !ruby/object:Gem::Version
         version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 5.1.0
-    - - "<"
+        version: 5.2.0
+    - - <
       - !ruby/object:Gem::Version
         version: '6.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: globalize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Adds Globalize support to the FriendlyId gem.
@@ -81,8 +81,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".yardopts"
+- .gitignore
+- .yardopts
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -90,6 +90,9 @@ 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:
@@ -101,19 +104,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - '>'
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Globalize support for FriendlyId.
 test_files: []
-has_rdoc: