friendly_id-globalize 1.0.0.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62cd4376867d5bac0911aee989a1772629a02456
+  data.tar.gz: 1b996d875da46468e07477f4c6b4ca293c403730
+SHA512:
+  metadata.gz: 34e2632179917e0fd224e2bf296a55d31ade506f83f16fbae8191be5adb795949bffff910726b3bc94a435af68617e51e7be6006766c3ed0cea25b454b86433d
+  data.tar.gz: cef14323a9b9c071b823a0b059ada2becfa590548634061d6151ba4d4f9ca3a5bbd4beb8016f92c3909b79e9d718996c4c271b4f5bc7d385a32916b3e0350924

data/.gitignore

@@ -0,0 +1,12 @@
+Gemfile.lock
+doc
+docs
+pkg
+.DS_Store
+coverage
+.yardoc
+*.gem
+*.sqlite3
+*.rbc
+*.lock
+.rbx

data/.yardopts

@@ -0,0 +1,3 @@
+--private
+--protected
+--markup=markdown

data/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+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'
+
+  platforms :jruby do
+    gem 'activerecord-jdbcsqlite3-adapter', '>= 1.3.0.beta2'
+    gem 'jruby-openssl'
+  end
+
+  platforms :ruby do
+    gem 'sqlite3'
+  end
+
+  gem 'pry'
+  gem 'pry-nav'
+end

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Norman Clarke and Philip Arndt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+# FriendlyId Globalize
+
+[Globalize3](https://github.com/svenfuchs/globalize3) support for
+[FriendlyId](https://github.com/norman/friendly_id).

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+desc "Remove temporary files"
+task :clean do
+  %x{rm -rf *.gem doc pkg coverage}
+  %x{rm -f `find . -name '*.rbc'`}
+end
+
+desc "Build the gem"
+task :gem do
+  %x{gem build friendly_id-globalize.gemspec}
+end

data/friendly_id-globalize.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+require File.expand_path('../lib/friendly_id/globalize/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'friendly_id-globalize'
+  s.version       = FriendlyId::Globalize::VERSION
+  s.authors       = ['Norman Clarke', 'Philip Arndt']
+  s.email         = ['norman@njclarke.com', 'p@arndt.io']
+  s.homepage      = 'http://github.com/norman/friendly_id-globalize'
+  s.summary       = 'Globalize support for FriendlyId.'
+  s.files         = `git ls-files`.split("\n")
+  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.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency 'friendly_id', '>= 5.0.0.beta4', '< 6.0'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency "globalize3"
+end

data/lib/friendly_id/globalize.rb

@@ -0,0 +1,100 @@
+require 'i18n'
+
+module FriendlyId
+
+=begin
+
+== Translating Slugs Using Globalize
+
+The {FriendlyId::Globalize Globalize} module lets you use
+Globalize[https://github.com/svenfuchs/globalize3] 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:
+
+    class Post < ActiveRecord::Base
+      translates :title, :slug
+      extend FriendlyId
+      friendly_id :title, :use => :globalize
+    end
+
+=== Finds
+
+Finds will take the current locale into consideration:
+
+  I18n.locale = :it
+  Post.find("guerre-stellari")
+  I18n.locale = :en
+  Post.find("star-wars")
+
+Additionally, finds will fall back to the default locale:
+
+  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:
+
+  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:
+
+  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:
+
+  I18n.with_locale(:it) { post.set_friendly_id("Guerre stellari") }
+
+=end
+  module Globalize
+    class << self
+
+      def setup(model_class)
+        model_class.friendly_id_config.use :slugged
+      end
+
+      def included(model_class)
+        advise_against_untranslated_model(model_class)
+      end
+
+      def advise_against_untranslated_model(model)
+        field = model.friendly_id_config.query_field
+        unless model.respond_to?('translated_attribute_names') ||
+               model.translated_attribute_names.exclude?(field.to_sym)
+          raise "[FriendlyId] You need to translate the '#{field}' field with " \
+            "Globalize (add 'translates :#{field}' in your model '#{model.name}')"
+        end
+      end
+      private :advise_against_untranslated_model
+    end
+
+    def set_friendly_id(text, locale = nil)
+      ::Globalize.with_locale(locale || ::Globalize.locale) do
+        set_slug normalize_friendly_id(text)
+      end
+    end
+
+    def should_generate_new_friendly_id?
+      translation_for(::Globalize.locale).send(friendly_id_config.slug_column).nil?
+    end
+
+    def set_slug(normalized_slug = nil)
+      ::Globalize.with_locale(::Globalize.locale) { super }
+    end
+  end
+end

data/lib/friendly_id/globalize/version.rb

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

data/test/globalize_test.rb

@@ -0,0 +1,106 @@
+# encoding: utf-8
+require 'bundler/setup'
+require 'active_record'
+require 'friendly_id'
+require 'friendly_id/globalize'
+require 'globalize3'
+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
+
+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 Module
+  def test(name, &block)
+    define_method("test_#{name.gsub(/[^a-z0-9']/i, "_")}".to_sym, &block)
+  end
+end
+
+class GlobalizeTest < MiniTest::Unit::TestCase
+
+  def transaction
+    ActiveRecord::Base.transaction { yield ; raise ActiveRecord::Rollback }
+  end
+
+  def with_instance_of(*args)
+    model_class = args.shift
+    args[0] ||= {:name => "a b c"}
+    transaction { yield model_class.create!(*args) }
+  end
+
+  def setup
+    I18n.locale = :en
+  end
+
+  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') }
+      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
+      article_en = I18n.with_locale(:en) { Article.create!(:title => 'a title') }
+      article_de = I18n.with_locale(:de) { Article.create!(:title => 'titel') }
+
+      I18n.with_locale(:de) do
+        assert_equal Article.friendly.find("titel"), article_de
+        assert_equal Article.friendly.find("a-title"), article_en
+      end
+    end
+  end
+
+  test "should set friendly id for locale" do
+    transaction do
+      article = Article.create!(:title => "War and Peace")
+      article.set_friendly_id("Guerra y paz", :es)
+      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 }
+    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
+    transaction do
+      I18n.with_locale(:en) do
+        article = Article.create!(:title => 'a title')
+        Globalize.with_locale(:de) {article.update_attribute(:title, 'ein titel')}
+        article_by_friendly_id = Article.friendly.find("a-title")
+        article.translations.each do |translation|
+          assert_includes article_by_friendly_id.translations, translation
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: friendly_id-globalize
+version: !ruby/object:Gem::Version
+  version: 1.0.0.alpha1
+platform: ruby
+authors:
+- Norman Clarke
+- Philip Arndt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-29 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
+    - - <
+      - !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
+    - - <
+      - !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
+  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.
+email:
+- norman@njclarke.com
+- p@arndt.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yardopts
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- friendly_id-globalize.gemspec
+- lib/friendly_id/globalize.rb
+- lib/friendly_id/globalize/version.rb
+- test/globalize_test.rb
+homepage: http://github.com/norman/friendly_id-globalize
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Globalize support for FriendlyId.
+test_files: []
+has_rdoc: