friendly_id-globalize 1.0.0.alpha1 → 1.0.0.alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62cd4376867d5bac0911aee989a1772629a02456
-  data.tar.gz: 1b996d875da46468e07477f4c6b4ca293c403730
+  metadata.gz: c240c7dc5d34b3afb7338ae100c7202f04d73e96
+  data.tar.gz: f5655d526ff831df27bad81a74699c824123ffb0
 SHA512:
-  metadata.gz: 34e2632179917e0fd224e2bf296a55d31ade506f83f16fbae8191be5adb795949bffff910726b3bc94a435af68617e51e7be6006766c3ed0cea25b454b86433d
-  data.tar.gz: cef14323a9b9c071b823a0b059ada2becfa590548634061d6151ba4d4f9ca3a5bbd4beb8016f92c3909b79e9d718996c4c271b4f5bc7d385a32916b3e0350924
+  metadata.gz: a6b36a173d89897737d18071f84a55eddeeb9edf1afaf61cec54b703a9a2975e1e65ab632486a5873bd707ab994a366c2d6105bbe15fb1008c8b455de332f5a9
+  data.tar.gz: 07d69a9ec4616a7ba1da6f744cae485b6c1bb7a75abd5b379334492992f1d0a829de35b3dd78454f87193663488b00dcaf77f3d5ef5636fc1ac64b967c50a53b

data/.gitignore

@@ -10,3 +10,6 @@ coverage
 *.rbc
 *.lock
 .rbx
+bin
+.bundle
+

data/Gemfile

@@ -4,9 +4,8 @@ gemspec
 
 # Database Configuration
 group :development, :test do
-  gem 'globalize3',  github: 'svenfuchs/globalize3', branch: 'rails4'
-  gem 'paper_trail', github: 'airblade/paper_trail', branch: 'master'
-  gem 'friendly_id', github: 'norman/friendly_id', branch: 'master'
+  gem "globalize", '~> 5.0.0'
+  gem 'rake'
 
   platforms :jruby do
     gem 'activerecord-jdbcsqlite3-adapter', '>= 1.3.0.beta2'
@@ -20,3 +19,4 @@ group :development, :test do
   gem 'pry'
   gem 'pry-nav'
 end
+

data/README.md

@@ -1,4 +1,58 @@
 # FriendlyId Globalize
 
-[Globalize3](https://github.com/svenfuchs/globalize3) support for
+[Globalize](https://github.com/globalize/globalize) support for
 [FriendlyId](https://github.com/norman/friendly_id).
+
+### Translating Slugs Using Globalize
+The `FriendlyId::Globalize Globalize` module lets you use
+[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`
+module.
+
+In order to use this module, your model's table and translation table must both
+have a slug column, and your model must set the `slug` field as translatable
+with Globalize:
+```ruby
+class Post < ActiveRecord::Base
+  translates :title, :slug
+  extend FriendlyId
+  friendly_id :title, :use => :globalize
+end
+```
+Note that call to `translates` must be made before calling `friendly_id`.
+
+### Finds
+Finds will take the current locale into consideration:
+```ruby
+I18n.locale = :it
+Post.find("guerre-stellari")
+I18n.locale = :en
+Post.find("star-wars")
+```
+Additionally, finds will fall back to the default locale:
+```ruby
+I18n.locale = :it
+Post.find("star-wars")
+```
+To find a slug by an explicit locale, perform the find inside a block
+passed to I18n's `with_locale` method:
+```ruby
+I18n.with_locale(:it) { Post.find("guerre-stellari") }
+```
+### Creating Records
+When new records are created, the slug is generated for the current locale only.
+### Translating Slugs
+To translate an existing record's friendly_id, use
+`FriendlyId::Globalize::Model#set_friendly_id`. This will ensure that the slug
+you add is properly escaped, transliterated and sequenced:
+```ruby
+post = Post.create :name => "Star Wars"
+post.set_friendly_id("Guerre stellari", :it)
+```
+If you don't pass in a locale argument, `FriendlyId::Globalize` will just use the
+current locale:
+```ruby
+I18n.with_locale(:it) { post.set_friendly_id("Guerre stellari") }
+```

data/friendly_id-globalize.gemspec

@@ -12,12 +12,13 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test}/*`.split("\n")
   s.require_paths = ['lib']
   s.license       = 'MIT'
-  s.description   = 'Adds Globalize 3 support to the FriendlyId gem.'
+  s.description   = 'Adds Globalize support to the FriendlyId gem.'
 
   s.required_ruby_version = '>= 1.9.3'
 
-  s.add_dependency 'friendly_id', '>= 5.0.0.beta4', '< 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 "globalize3"
+  s.add_development_dependency "globalize"
 end
+

data/lib/friendly_id/globalize.rb

@@ -94,7 +94,22 @@ current locale:
     end
 
     def set_slug(normalized_slug = nil)
-      ::Globalize.with_locale(::Globalize.locale) { super }
+      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) }
+      end
+    end
+
+    def super_set_slug(normalized_slug = nil)
+      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
+      end
     end
   end
 end
+

data/lib/friendly_id/globalize/version.rb

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

data/test/globalize_test.rb

@@ -3,32 +3,34 @@ require 'bundler/setup'
 require 'active_record'
 require 'friendly_id'
 require 'friendly_id/globalize'
-require 'globalize3'
+require 'globalize'
 require 'minitest/autorun'
 
 ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
-
-class Article < ActiveRecord::Base
-  translates :slug, :title
-  extend FriendlyId
-  friendly_id :title, :use => [:slugged, :globalize]
-end
+::I18n.enforce_available_locales = false
+Globalize.fallbacks = {:en => [:en, :de], :de => [:de, :en]}
 
 class FriendlyIdGlobalizeTest < ActiveRecord::Migration
   def self.up
     create_table :articles do |t|
       t.string   :name
-      t.string   :slug
     end
-
-    add_index :articles, :slug, unique: true
-    Article.create_translation_table! :slug => :string, :title => :string
   end
 end
 
 ActiveRecord::Migration.verbose = false
 FriendlyIdGlobalizeTest.up
 
+class Article < ActiveRecord::Base
+  translates :slug, :title, fallbacks_for_empty_translations: true
+  accepts_nested_attributes_for :translations
+
+  extend FriendlyId
+  friendly_id :title, :use => [:slugged, :globalize]
+end
+
+Article.create_translation_table! :slug => :string, :title => :string
+
 class Module
   def test(name, &block)
     define_method("test_#{name.gsub(/[^a-z0-9']/i, "_")}".to_sym, &block)
@@ -53,18 +55,11 @@ class GlobalizeTest < MiniTest::Unit::TestCase
 
   test 'should have a value for friendly_id after creation' do
     transaction do
-      article = I18n.with_locale(:de) { Article.create!(:title => 'Der Herbst des Einsamen') }
+      article = ::I18n.with_locale(:de) { Article.create!(:title => 'Der Herbst des Einsamen') }
       refute_nil article.friendly_id
     end
   end
 
-  test 'should allow nil friendly_ids' do
-    transaction do
-      article = I18n.with_locale(:de) { Article.create!(:title => nil) }
-      assert_nil article.reload.friendly_id
-    end
-  end
-
   test "should find slug in current locale if locale is set, otherwise in default locale" do
     transaction do
       I18n.default_locale = :en
@@ -89,6 +84,17 @@ class GlobalizeTest < MiniTest::Unit::TestCase
     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' }
+      })
+      I18n.with_locale(:it) { assert_equal "guerra-e-pace", article.friendly_id }
+      I18n.with_locale(:fr) { assert_equal "guerre-et-paix", article.friendly_id }
+    end
+  end
+
   # https://github.com/svenfuchs/globalize3/blob/master/test/globalize3/dynamic_finders_test.rb#L101
   # see: https://github.com/svenfuchs/globalize3/issues/100
   test "record returned by friendly_id should have all translations" do
@@ -104,3 +110,4 @@ class GlobalizeTest < MiniTest::Unit::TestCase
     end
   end
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: friendly_id-globalize
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha1
+  version: 1.0.0.alpha2
 platform: ruby
 authors:
 - Norman Clarke
@@ -9,71 +9,71 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-29 00:00:00.000000000 Z
+date: 2015-07-23 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.0.0.beta4
-    - - <
+        version: 5.1.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.0.0.beta4
-    - - <
+        version: 5.1.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: globalize3
+  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 3 support to the FriendlyId gem.
+description: Adds Globalize support to the FriendlyId gem.
 email:
 - norman@njclarke.com
 - p@arndt.io
@@ -81,8 +81,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .yardopts
+- ".gitignore"
+- ".yardopts"
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -101,17 +101,17 @@ 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.0.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Globalize support for FriendlyId.