json_translate 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17ce402d321bc3d0032b0a3b746c7ba961e4136e
+  data.tar.gz: 17f938bd688e2c2e623362f8044233a2bcf2d14d
+SHA512:
+  metadata.gz: 68aca958c304187679d5ac66b90b15d3eaa0d0a3096030b3d2054b19978e52bd239f8f52186e085c59564430e9ca4ffd805e03c650118a6aaa33ab08d1bc5a70
+  data.tar.gz: 35075fb936242cc9ced7917db628b7266cd5ab8d853b2268c6ac912bac3e2374dbcddd3edd074b942ed02bd0a3916b49d35e83fa86b15efaa49e6105ee309471

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Rob Worley
+
+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,138 @@
+# JSON Translate
+
+Rails I18n library for ActiveRecord model/data translation using PostgreSQL's
+JSONB datatype. It provides an interface inspired by
+[Globalize3](https://github.com/svenfuchs/globalize3) but removes the need to
+maintain separate translation tables.
+
+[![Build Status](https://api.travis-ci.org/cfabianski/json_translate.png)](https://travis-ci.org/cfabianski/json_translate)
+[![License](http://img.shields.io/badge/license-mit-brightgreen.svg)](COPYRIGHT)
+[![Code Climate](https://codeclimate.com/github/cfabianski/json_translate.png)](https://codeclimate.com/github/cfabianski/json_translate)
+
+## Requirements
+
+* ActiveRecord > 5.0.0 (4+ for JRuby)
+* I18n
+
+## Installation
+
+gem install json_translate
+
+When using bundler, put it in your Gemfile:
+
+```ruby
+source 'https://rubygems.org'
+
+gem 'activerecord'
+gem 'pg', :platform => :ruby
+gem 'activerecord-jdbcpostgresql-adapter', :platform => :jruby
+gem 'json_translate'
+```
+
+## Model translations
+
+Model translations allow you to translate your models' attribute values. E.g.
+
+```ruby
+class Post < ActiveRecord::Base
+  translates :title, :body
+end
+```
+
+Allows you to translate the attributes :title and :body per locale:
+
+```ruby
+I18n.locale = :en
+post.title # => This database rocks!
+
+I18n.locale = :he
+post.title # => אתר זה טוב
+```
+
+You also have locale-specific convenience methods from [easy_globalize3_accessors](https://github.com/paneq/easy_globalize3_accessors):
+
+```ruby
+I18n.locale = :en
+post.title # => This database rocks!
+post.title_he # => אתר זה טוב
+```
+
+To find records using translations without constructing JSONB queries by hand:
+
+```ruby
+Post.with_title_translation("This database rocks!") # => #<ActiveRecord::Relation ...>
+Post.with_title_translation("אתר זה טוב", :he) # => #<ActiveRecord::Relation ...>
+```
+
+In order to make this work, you'll need to define an JSONB column for each of
+your translated attributes, using the suffix "_translations":
+
+```ruby
+class CreatePosts < ActiveRecord::Migration
+  def up
+    create_table :posts do |t|
+      t.column :title_translations, 'jsonb'
+      t.column :body_translations,  'jsonb'
+      t.timestamps
+    end
+  end
+  def down
+    drop_table :posts
+  end
+end
+```
+
+## I18n fallbacks for missing translations
+
+It is possible to enable fallbacks for missing translations. It will depend
+on the configuration setting you have set for I18n translations in your Rails
+config.
+
+You can enable them by adding the next line to `config/application.rb` (or
+only `config/environments/production.rb` if you only want them in production)
+
+```ruby
+config.i18n.fallbacks = true
+```
+
+Sven Fuchs wrote a [detailed explanation of the fallback
+mechanism](https://github.com/svenfuchs/i18n/wiki/Fallbacks).
+
+## Temporarily disable fallbacks
+
+If you've enabled fallbacks for missing translations, you probably want to disable
+them in the admin interface to display which translations the user still has to
+fill in.
+
+From:
+
+```ruby
+I18n.locale = :en
+post.title # => This database rocks!
+post.title_nl # => This database rocks!
+```
+
+To:
+
+```ruby
+I18n.locale = :en
+post.title # => This database rocks!
+post.disable_fallback
+post.title_nl # => nil
+```
+
+You can also call your code into a block that temporarily disable or enable fallbacks.
+
+```ruby
+I18n.locale = :en
+post.title_nl # => This database rocks!
+
+post.disable_fallback do
+  post.title_nl # => nil
+end
+
+post.disable_fallback
+post.enable_fallback do
+  post.title_nl # => This database rocks!
+end
+```

data/lib/json_translate/translates.rb

@@ -0,0 +1,137 @@
+module JSONTranslate
+  module Translates
+    SUFFIX = "_translations"
+
+    def translates(*attrs)
+      include InstanceMethods
+
+      class_attribute :translated_attrs
+      alias_attribute :translated_attribute_names, :translated_attrs # Improve compatibility with the gem globalize
+      self.translated_attrs = attrs
+
+      attrs.each do |attr_name|
+        define_method attr_name do
+          read_json_translation(attr_name)
+        end
+
+        define_method "#{attr_name}=" do |value|
+          write_json_translation(attr_name, value)
+        end
+
+        define_singleton_method "with_#{attr_name}_translation" do |value, locale = I18n.locale|
+          quoted_translation_store = connection.quote_column_name("#{attr_name}#{SUFFIX}")
+          translation_hash = { "#{locale}" => value }
+          where("#{quoted_translation_store} @> :translation::jsonb", translation: translation_hash.to_json)
+        end
+      end
+
+      alias_method_chain :respond_to?, :translates
+      alias_method_chain :method_missing, :translates
+    end
+
+    # Improve compatibility with the gem globalize
+    def translates?
+      included_modules.include?(InstanceMethods)
+    end
+
+    module InstanceMethods
+      def disable_fallback
+        toggle_fallback(false)
+      end
+
+      def enable_fallback
+        toggle_fallback(true)
+      end
+
+      protected
+
+      def json_translate_fallback_locales(locale)
+        return if @enabled_fallback == false || !I18n.respond_to?(:fallbacks)
+        I18n.fallbacks[locale]
+      end
+
+      def read_json_translation(attr_name, locale = I18n.locale)
+        translations = send("#{attr_name}#{SUFFIX}") || {}
+        translation  = translations[locale.to_s]
+
+        if fallback_locales = json_translate_fallback_locales(locale)
+          fallback_locales.each do |fallback_locale|
+            t = translations[fallback_locale.to_s]
+            if t && !t.empty? # differs from blank?
+              translation = t
+              break
+            end
+          end
+        end
+
+        translation
+      end
+
+      def write_json_translation(attr_name, value, locale = I18n.locale)
+        translation_store = "#{attr_name}#{SUFFIX}"
+        translations = send(translation_store) || {}
+        send("#{translation_store}_will_change!") unless translations[locale.to_s] == value
+        translations[locale.to_s] = value
+        send("#{translation_store}=", translations)
+        value
+      end
+
+      def respond_to_with_translates?(symbol, include_all = false)
+        return true if parse_translated_attribute_accessor(symbol)
+        respond_to_without_translates?(symbol, include_all)
+      end
+
+      def method_missing_with_translates(method_name, *args)
+        translated_attr_name, locale, assigning = parse_translated_attribute_accessor(method_name)
+
+        return method_missing_without_translates(method_name, *args) unless translated_attr_name
+
+        if assigning
+          write_json_translation(translated_attr_name, args.first, locale)
+        else
+          read_json_translation(translated_attr_name, locale)
+        end
+      end
+
+      # Internal: Parse a translated convenience accessor name.
+      #
+      # method_name - The accessor name.
+      #
+      # Examples
+      #
+      #   parse_translated_attribute_accessor("title_en=")
+      #   # => [:title, :en, true]
+      #
+      #   parse_translated_attribute_accessor("title_fr")
+      #   # => [:title, :fr, false]
+      #
+      # Returns the attribute name Symbol, locale Symbol, and a Boolean
+      # indicating whether or not the caller is attempting to assign a value.
+      def parse_translated_attribute_accessor(method_name)
+        return unless method_name =~ /\A([a-z_]+)_([a-z]{2})(=?)\z/
+
+        translated_attr_name = $1.to_sym
+        return unless translated_attrs.include?(translated_attr_name)
+
+        locale    = $2.to_sym
+        assigning = $3.present?
+
+        [translated_attr_name, locale, assigning]
+      end
+
+      def toggle_fallback(enabled)
+        if block_given?
+          old_value = @enabled_fallback
+          begin
+            @enabled_fallback = enabled
+            yield
+          ensure
+            @enabled_fallback = old_value
+          end
+        else
+          @enabled_fallback = enabled
+        end
+      end
+    end
+  end
+end

data/lib/json_translate/version.rb

@@ -0,0 +1,3 @@
+module JSONTranslate
+  VERSION = "2.0.0"
+end

data/lib/json_translate.rb

@@ -0,0 +1,4 @@
+require 'active_record'
+require 'json_translate/translates'
+
+ActiveRecord::Base.extend(JSONTranslate::Translates)

data/test/database.yml

@@ -0,0 +1,6 @@
+test:
+  adapter:  postgresql
+  host:     localhost
+  database: json_translate_test
+  username: postgres
+  min_messages: warning

data/test/gemfiles/Gemfile.rails-5.0.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gemspec :path => './../..'
+
+gem 'pg'
+gem 'activerecord', '~> 5.0.0'

data/test/test_helper.rb

@@ -0,0 +1,59 @@
+require 'minitest/autorun'
+require 'json_translate'
+
+require 'database_cleaner'
+DatabaseCleaner.strategy = :transaction
+
+MiniTest::Test = MiniTest::Unit::TestCase unless MiniTest.const_defined?(:Test) # Rails 4.0.x
+
+class Post < ActiveRecord::Base
+  translates :title
+end
+
+class JSONTranslate::Test < Minitest::Test
+  class << self
+    def prepare_database
+      create_database
+      create_table
+    end
+
+    private
+
+    def db_config
+      @db_config ||= begin
+        filepath = File.join('test', 'database.yml')
+        YAML.load_file(filepath)['test']
+      end
+    end
+
+    def establish_connection(config)
+      ActiveRecord::Base.establish_connection(config)
+      ActiveRecord::Base.connection
+    end
+
+    def create_database
+      system_config = db_config.merge('database' => 'postgres', 'schema_search_path' => 'public')
+      connection = establish_connection(system_config)
+      connection.create_database(db_config['database']) rescue nil
+    end
+
+    def create_table
+      connection = establish_connection(db_config)
+      connection.create_table(:posts, :force => true) do |t|
+        t.column :title_translations, 'jsonb'
+      end
+    end
+  end
+
+  prepare_database
+
+  def setup
+    I18n.available_locales = ['en', 'en-US', 'fr']
+    I18n.config.enforce_available_locales = true
+    DatabaseCleaner.start
+  end
+
+  def teardown
+    DatabaseCleaner.clean
+  end
+end

data/test/translates_test.rb

@@ -0,0 +1,148 @@
+# -*- encoding : utf-8 -*-
+require 'test_helper'
+
+class TranslatesTest < JSONTranslate::Test
+  def test_assigns_in_current_locale
+    I18n.with_locale(:en) do
+      p = Post.new(:title => "English Title")
+      assert_equal("English Title", p.title_translations['en'])
+    end
+  end
+
+  def test_retrieves_in_current_locale
+    p = Post.new(:title_translations => { "en" => "English Title", "fr" => "Titre français" })
+    I18n.with_locale(:fr) do
+      assert_equal("Titre français", p.title)
+    end
+  end
+
+  def test_retrieves_in_current_locale_with_fallbacks
+    I18n::Backend::Simple.include(I18n::Backend::Fallbacks)
+    I18n.default_locale = :"en-US"
+
+    p = Post.new(:title_translations => {"en" => "English Title"})
+    I18n.with_locale(:fr) do
+      assert_equal("English Title", p.title)
+    end
+  end
+
+  def test_assigns_in_specified_locale
+    I18n.with_locale(:en) do
+      p = Post.new(:title_translations => { "en" => "English Title" })
+      p.title_fr = "Titre français"
+      assert_equal("Titre français", p.title_translations["fr"])
+    end
+  end
+
+  def test_persists_changes_in_specified_locale
+    I18n.with_locale(:en) do
+      p = Post.create!(:title_translations => { "en" => "Original Text" })
+      p.title_en = "Updated Text"
+      p.save!
+      assert_equal("Updated Text", Post.last.title_en)
+    end
+  end
+
+  def test_retrieves_in_specified_locale
+    I18n.with_locale(:en) do
+      p = Post.new(:title_translations => { "en" => "English Title", "fr" => "Titre français" })
+      assert_equal("Titre français", p.title_fr)
+    end
+  end
+
+  def test_retrieves_in_specified_locale_with_fallbacks
+    I18n::Backend::Simple.include(I18n::Backend::Fallbacks)
+    I18n.default_locale = :"en-US"
+
+    p = Post.new(:title_translations => { "en" => "English Title" })
+    I18n.with_locale(:fr) do
+      assert_equal("English Title", p.title_fr)
+    end
+  end
+
+  def test_fallback_from_empty_string
+    I18n::Backend::Simple.include(I18n::Backend::Fallbacks)
+    I18n.default_locale = :"en-US"
+
+    p = Post.new(:title_translations => { "en" => "English Title", "fr" => "" })
+    I18n.with_locale(:fr) do
+      assert_equal("English Title", p.title_fr)
+    end
+  end
+
+  def test_retrieves_in_specified_locale_with_fallback_disabled
+    I18n::Backend::Simple.include(I18n::Backend::Fallbacks)
+    I18n.default_locale = :"en-US"
+
+    p = Post.new(:title_translations => { "en" => "English Title" })
+    p.disable_fallback
+    I18n.with_locale(:fr) do
+      assert_equal(nil, p.title_fr)
+    end
+  end
+
+  def test_retrieves_in_specified_locale_with_fallback_disabled_using_a_block
+    I18n::Backend::Simple.include(I18n::Backend::Fallbacks)
+    I18n.default_locale = :"en-US"
+
+    p = Post.new(:title_translations => { "en" => "English Title" })
+    p.enable_fallback
+
+    assert_equal("English Title", p.title_fr)
+    p.disable_fallback { assert_nil p.title_fr }
+  end
+
+  def test_retrieves_in_specified_locale_with_fallback_reenabled
+    I18n::Backend::Simple.include(I18n::Backend::Fallbacks)
+    I18n.default_locale = :"en-US"
+
+    p = Post.new(:title_translations => { "en" => "English Title" })
+    p.disable_fallback
+    p.enable_fallback
+    I18n.with_locale(:fr) do
+      assert_equal("English Title", p.title_fr)
+    end
+  end
+
+  def test_retrieves_in_specified_locale_with_fallback_reenabled_using_a_block
+    I18n::Backend::Simple.include(I18n::Backend::Fallbacks)
+    I18n.default_locale = :"en-US"
+
+    p = Post.new(:title_translations => { "en" => "English Title" })
+    p.disable_fallback
+
+    assert_nil(p.title_fr)
+    p.enable_fallback { assert_equal("English Title", p.title_fr) }
+  end
+
+  def test_method_missing_delegates
+    assert_raises(NoMethodError) { Post.new.nonexistant_method }
+  end
+
+  def test_method_missing_delegates_non_translated_attributes
+    assert_raises(NoMethodError) { Post.new.other_fr }
+  end
+
+  def test_persists_translations_assigned_as_hash
+    p = Post.create!(:title_translations => { "en" => "English Title", "fr" => "Titre français" })
+    p.reload
+    assert_equal({"en" => "English Title", "fr" => "Titre français"}, p.title_translations)
+  end
+
+  def test_persists_translations_assigned_to_localized_accessors
+    p = Post.create!(:title_en => "English Title", :title_fr => "Titre français")
+    p.reload
+    assert_equal({"en" => "English Title", "fr" => "Titre français"}, p.title_translations)
+  end
+
+  def test_with_translation_relation
+    p = Post.create!(:title_translations => { "en" => "Alice in Wonderland", "fr" => "Alice au pays des merveilles" })
+    I18n.with_locale(:en) do
+      assert_equal p.title_en, Post.with_title_translation("Alice in Wonderland").first.try(:title)
+    end
+  end
+
+  def test_class_method_translates?
+    assert_equal true, Post.translates?
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: json_translate
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Rob Worley
+- Cédric Fabianski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: Rails I18n library for ActiveRecord model/data translation using PostgreSQL's
+  JSONB datatype. Translations are stored directly in the model table rather than
+  shadow tables.
+email: cfabianski@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/json_translate.rb
+- lib/json_translate/translates.rb
+- lib/json_translate/version.rb
+- test/database.yml
+- test/gemfiles/Gemfile.rails-5.0.x
+- test/test_helper.rb
+- test/translates_test.rb
+homepage: https://github.com/cfabiaski/json_translate
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Rails I18n library for ActiveRecord model/data translation using PostgreSQL's
+  JSONB datatype.
+test_files:
+- test/database.yml
+- test/gemfiles/Gemfile.rails-5.0.x
+- test/test_helper.rb
+- test/translates_test.rb