json_translate 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17ce402d321bc3d0032b0a3b746c7ba961e4136e
-  data.tar.gz: 17f938bd688e2c2e623362f8044233a2bcf2d14d
+  metadata.gz: c63d1189154bdd9a3c4f9b1d166010983eb6aa2b
+  data.tar.gz: 8d8a04e3acb55be9adee7b2256adb5efb6c87d97
 SHA512:
-  metadata.gz: 68aca958c304187679d5ac66b90b15d3eaa0d0a3096030b3d2054b19978e52bd239f8f52186e085c59564430e9ca4ffd805e03c650118a6aaa33ab08d1bc5a70
-  data.tar.gz: 35075fb936242cc9ced7917db628b7266cd5ab8d853b2268c6ac912bac3e2374dbcddd3edd074b942ed02bd0a3916b49d35e83fa86b15efaa49e6105ee309471
+  metadata.gz: eda1091080675c5e1f75a8b65448b8fb850534a666b0336a3933ef917dccdb446aaca89e644c0a976fa348685df80500cfb536d5e9b34e4b133071b4b064e459
+  data.tar.gz: 8ba0d7fcdabcc207dafa2e0cd7e9ee2408b5667653d8f2ea7946ae7dc9e0466365a5bdaf075e59b8ed6b2a0b9857f830ced0e50f03993bca0cd424b988fe68e4

data/README.md

@@ -11,7 +11,7 @@ maintain separate translation tables.
 
 ## Requirements
 
-* ActiveRecord > 5.0.0 (4+ for JRuby)
+* ActiveRecord >= 4.2.0
 * I18n
 
 ## Installation

data/lib/json_translate/translates/active_record_with_json_translates.rb

@@ -0,0 +1,22 @@
+module JSONTranslate
+  module Translates
+    module ActiveRecordWithJSONTranslate
+      def respond_to?(symbol, include_all = false)
+        return true if parse_translated_attribute_accessor(symbol)
+        super(symbol, include_all)
+      end
+
+      def method_missing(method_name, *args)
+        translated_attr_name, locale, assigning = parse_translated_attribute_accessor(method_name)
+
+        return super(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
+    end
+  end
+end

data/lib/json_translate/translates/instance_methods.rb

@@ -0,0 +1,98 @@
+module JSONTranslate
+  module Translates
+    module InstanceMethods
+      def disable_fallback
+        toggle_fallback(false)
+      end
+
+      def enable_fallback
+        toggle_fallback(true)
+      end
+
+      protected
+
+      attr_reader :enabled_fallback
+
+      def json_translate_fallback_locales(locale)
+        return locale if enabled_fallback == false || !I18n.respond_to?(:fallbacks)
+        I18n.fallbacks[locale]
+      end
+
+      def read_json_translation(attr_name, locale = I18n.locale)
+        translations = public_send("#{attr_name}#{SUFFIX}") || {}
+
+        available = Array(json_translate_fallback_locales(locale)).detect do |available_locale|
+          translations[available_locale.to_s].present?
+        end
+
+        translations[available.to_s]
+      end
+
+      def write_json_translation(attr_name, value, locale = I18n.locale)
+        translation_store = "#{attr_name}#{SUFFIX}"
+        translations = public_send(translation_store) || {}
+        public_send("#{translation_store}_will_change!") unless translations[locale.to_s] == value
+        translations[locale.to_s] = value
+        public_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 /\A(?<attribute>[a-z_]+)_(?<locale>[a-z]{2})(?<assignment>=?)\z/ =~ method_name
+
+        translated_attr_name = attribute.to_sym
+        return unless translated_attribute_names.include?(translated_attr_name)
+
+        locale    = locale.to_sym
+        assigning = assignment.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/translates.rb

@@ -1,13 +1,23 @@
 module JSONTranslate
   module Translates
-    SUFFIX = "_translations"
+    SUFFIX = "_translations".freeze
+
 
     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
+      class_attribute :translated_attribute_names, :permitted_translated_attributes
+
+      self.translated_attribute_names = attrs
+      self.permitted_translated_attributes = [
+        *self.ancestors
+          .select {|klass| klass.respond_to?(:permitted_translated_attributes) }
+          .map(&:permitted_translated_attributes),
+        *attrs.product(I18n.available_locales)
+          .map { |attribute, locale| :"#{attribute}_#{locale}" }
+      ].flatten.compact
+
+      puts "PermittedTranslatedAttributes #{permitted_translated_attributes}"
 
       attrs.each do |attr_name|
         define_method attr_name do
@@ -25,113 +35,11 @@ module JSONTranslate
         end
       end
 
-      alias_method_chain :respond_to?, :translates
-      alias_method_chain :method_missing, :translates
+      send(:prepend, ActiveRecordWithJSONTranslate)
     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

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

data/lib/json_translate.rb

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

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

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

data/test/test_helper.rb

@@ -4,12 +4,16 @@ require 'json_translate'
 require 'database_cleaner'
 DatabaseCleaner.strategy = :transaction
 
-MiniTest::Test = MiniTest::Unit::TestCase unless MiniTest.const_defined?(:Test) # Rails 4.0.x
+I18n.available_locales = [:en, :fr]
 
 class Post < ActiveRecord::Base
   translates :title
 end
 
+class PostDetailed < Post
+  translates :comment
+end
+
 class JSONTranslate::Test < Minitest::Test
   class << self
     def prepare_database
@@ -41,6 +45,7 @@ class JSONTranslate::Test < Minitest::Test
       connection = establish_connection(db_config)
       connection.create_table(:posts, :force => true) do |t|
         t.column :title_translations, 'jsonb'
+        t.column :comment_translations, 'jsonb'
       end
     end
   end

data/test/translates_test.rb

@@ -144,5 +144,28 @@ class TranslatesTest < JSONTranslate::Test
 
   def test_class_method_translates?
     assert_equal true, Post.translates?
+    assert_equal true, PostDetailed.translates?
+  end
+
+  def test_translate_post_detailed
+    p = PostDetailed.create!(
+      :title_translations => {
+        "en" => "Alice in Wonderland",
+        "fr" => "Alice au pays des merveilles"
+      },
+      :comment_translations => {
+        "en" => "Awesome book",
+        "fr" => "Un livre unique"
+      }
+    )
+
+    I18n.with_locale(:en) { assert_equal "Awesome book", p.comment }
+    I18n.with_locale(:en) { assert_equal "Alice in Wonderland", p.title }
+    I18n.with_locale(:fr) { assert_equal "Un livre unique", p.comment }
+    I18n.with_locale(:fr) { assert_equal "Alice au pays des merveilles", p.title }
+  end
+
+  def test_permitted_translated_attributes
+    assert_equal [:title_en, :title_fr, :comment_en, :comment_fr], PostDetailed.permitted_translated_attributes
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_translate
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Rob Worley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-22 00:00:00.000000000 Z
+date: 2017-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -79,8 +79,11 @@ files:
 - README.md
 - lib/json_translate.rb
 - lib/json_translate/translates.rb
+- lib/json_translate/translates/active_record_with_json_translates.rb
+- lib/json_translate/translates/instance_methods.rb
 - lib/json_translate/version.rb
 - test/database.yml
+- test/gemfiles/Gemfile.rails-4.2.x
 - test/gemfiles/Gemfile.rails-5.0.x
 - test/test_helper.rb
 - test/translates_test.rb
@@ -104,13 +107,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.10
 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-4.2.x
 - test/gemfiles/Gemfile.rails-5.0.x
 - test/test_helper.rb
 - test/translates_test.rb