hstore_translate 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: 3d045d9ab64030c7dfb5ff92821e38aa427d670a
-  data.tar.gz: 54d112f243c3bc7321bea17051e9c10281427ad7
-SHA512: 
-  metadata.gz: 04cacc0423c75b17e8162aef3c371eba9b9f7e71d9bb41f8d201a827446f04578d180056e6397a6899faafcdf426cc5e7ebae878c68c2d8512edd89e78e588bc
-  data.tar.gz: fef04d9b61e0023728cad3caa080ba6e3d00b194775101ca5476aee3ac1a3c42bee0660ba9bc2db844891d252ce84aa62d3c636be0aeea4ae81f0433b7fb4076
+---
+SHA1:
+  metadata.gz: 4ccf1814041417c6af7784b55f1cf09ec07acdcc
+  data.tar.gz: 45616c313c135fd6cdbc4c671d97dc57f08b0ea6
+SHA512:
+  metadata.gz: 7093f33b724267f415fd1508537d7a091709824d1c1cada5425ad09801bda7904d2e687bb7f11bf049b0a9f180a53fd7498c8f34a312a40ee8f3b9aa756f4cd3
+  data.tar.gz: fd1de0a6eaddc883d19e7b177e4b2b9d280a730c16ba7ce8eef0903ecda58ed2c3e2449b71b74cd0c09a54c3d34c4205276fa56d03f13e5700d6ec00fd6bc715

data/README.md

@@ -5,13 +5,13 @@ hstore 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/robworley/hstore_translate.png)](https://travis-ci.org/robworley/hstore_translate)
+[![Build Status](https://api.travis-ci.org/cfabianski/hstore_translate.png)](https://travis-ci.org/cfabianski/hstore_translate)
 [![License](http://img.shields.io/badge/license-mit-brightgreen.svg)](COPYRIGHT)
-[![Code Climate](https://codeclimate.com/github/robworley/hstore_translate.png)](https://codeclimate.com/github/robworley/hstore_translate)
+[![Code Climate](https://codeclimate.com/github/robworley/hstore_translate.png)](https://codeclimate.com/github/cfabianski/hstore_translate)
 
 ## Requirements
 
-* ActiveRecord > 3.1.0 (4+ for JRuby)
+* ActiveRecord > 4.2.0
 * I18n
 
 ## Installation
@@ -25,16 +25,9 @@ source 'https://rubygems.org'
 
 gem 'activerecord'
 gem 'pg', :platform => :ruby
-gem 'activerecord-jdbcpostgresql-adapter', :platform => :jruby
 gem 'hstore_translate'
 ```
 
-For ActiveRecord < 4.0 you'll also want to add:
-
-```ruby
-gem 'activerecord-postgres-hstore', '~> 0.7.0'
-```
-
 ## Model translations
 
 Model translations allow you to translate your models' attribute values. E.g.

data/lib/hstore_translate.rb

@@ -1,6 +1,8 @@
-require 'active_record'
-require 'active_record/connection_adapters/postgresql_adapter'
-require 'hstore_translate/translates'
+require "active_record"
+require "active_record/connection_adapters/postgresql_adapter"
+require "hstore_translate/translates"
+require "hstore_translate/translates/instance_methods"
+require "hstore_translate/translates/active_record_with_hstore_translates"
 
 module HstoreTranslate
   def self.native_hstore?

data/lib/hstore_translate/translates.rb

@@ -1,14 +1,23 @@
 module HstoreTranslate
   module Translates
+    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
 
       attrs.each do |attr_name|
-        serialize "#{attr_name}_translations", ActiveRecord::Coders::Hstore unless HstoreTranslate::native_hstore?
+        serialize "#{attr_name}#{SUFFIX}", ActiveRecord::Coders::Hstore unless HstoreTranslate::native_hstore?
 
         define_method attr_name do
           read_hstore_translation(attr_name)
@@ -19,118 +28,16 @@ module HstoreTranslate
         end
 
         define_singleton_method "with_#{attr_name}_translation" do |value, locale = I18n.locale|
-          quoted_translation_store = connection.quote_column_name("#{attr_name}_translations")
+          quoted_translation_store = connection.quote_column_name("#{attr_name}#{SUFFIX}")
           where("#{quoted_translation_store} @> hstore(:locale, :value)", locale: locale, value: value)
         end
       end
 
-      alias_method_chain :respond_to?, :translates
-      alias_method_chain :method_missing, :translates
+      send(:prepend, ActiveRecordWithHstoreTranslate)
     end
 
-    # Improve compatibility with the gem globalize
     def translates?
       included_modules.include?(InstanceMethods)
     end
-
-    module InstanceMethods
-      def disable_fallback(&block)
-        toggle_fallback(enabled = false, &block)
-      end
-
-      def enable_fallback(&block)
-        toggle_fallback(enabled = true, &block)
-      end
-
-      protected
-
-      def hstore_translate_fallback_locales(locale)
-        return if @enabled_fallback == false || !I18n.respond_to?(:fallbacks)
-        I18n.fallbacks[locale]
-      end
-
-      def read_hstore_translation(attr_name, locale = I18n.locale)
-        translations = send("#{attr_name}_translations") || {}
-        translation  = translations[locale.to_s]
-
-        if fallback_locales = hstore_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_hstore_translation(attr_name, value, locale = I18n.locale)
-        translation_store = "#{attr_name}_translations"
-        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_hstore_translation(translated_attr_name, args.first, locale)
-        else
-          read_hstore_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, &block)
-        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/hstore_translate/translates/active_record_with_hstore_translates.rb

@@ -0,0 +1,22 @@
+module HstoreTranslate
+  module Translates
+    module ActiveRecordWithHstoreTranslate
+      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_hstore_translation(translated_attr_name, args.first, locale)
+        else
+          read_hstore_translation(translated_attr_name, locale)
+        end
+      end
+    end
+  end
+end

data/lib/hstore_translate/translates/instance_methods.rb

@@ -0,0 +1,97 @@
+module HstoreTranslate
+  module Translates
+    module InstanceMethods
+      def disable_fallback
+        toggle_fallback(false)
+      end
+
+      def enable_fallback
+        toggle_fallback(true)
+      end
+
+      protected
+
+      attr_reader :enabled_fallback
+
+      def hstore_translate_fallback_locales(locale)
+        return locale if enabled_fallback == false || !I18n.respond_to?(:fallbacks)
+        I18n.fallbacks[locale]
+      end
+
+      def read_hstore_translation(attr_name, locale = I18n.locale)
+        translations = public_send("#{attr_name}#{SUFFIX}") || {}
+        available = Array(hstore_translate_fallback_locales(locale)).detect do |available_locale|
+          translations[available_locale.to_s].present?
+        end
+
+        translations[available.to_s]
+      end
+
+      def write_hstore_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_hstore_translation(translated_attr_name, args.first, locale)
+        else
+          read_hstore_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 /(?<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/hstore_translate/version.rb

@@ -1,3 +1,3 @@
 module HstoreTranslate
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

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

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

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

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

data/test/test_helper.rb

@@ -4,12 +4,16 @@ require 'hstore_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 HstoreTranslate::Test < Minitest::Test
   class << self
     def prepare_database
@@ -55,6 +59,7 @@ class HstoreTranslate::Test < Minitest::Test
       connection = establish_connection(db_config)
       connection.create_table(:posts, :force => true) do |t|
         t.column :title_translations, 'hstore'
+        t.column :comment_translations, 'hstore'
       end
     end
   end

data/test/translates_test.rb

@@ -77,7 +77,7 @@ class TranslatesTest < HstoreTranslate::Test
     p = Post.new(:title_translations => { "en" => "English Title" })
     p.disable_fallback
     I18n.with_locale(:fr) do
-      assert_equal(nil, p.title_fr)
+      assert_nil p.title_fr
     end
   end
 
@@ -144,5 +144,28 @@ class TranslatesTest < HstoreTranslate::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,104 +1,120 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hstore_translate
-version: !ruby/object:Gem::Version 
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 2.0.0
 platform: ruby
-authors: 
+authors:
 - Rob Worley
+- Cédric Fabianski
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-04-10 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2017-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        version: 3.1.0
+      - !ruby/object:Gem::Version
+        version: 4.2.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id004 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
+  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"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: database_cleaner
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id004
+  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
-  version_requirements: *id005
-description: Rails I18n library for ActiveRecord model/data translation using PostgreSQL's hstore datatype. Translations are stored directly in the model table rather than shadow tables.
-email: robert.worley@gmail.com
+  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
+  hstore datatype. Translations are stored directly in the model table rather than
+  shadow tables.
+email: cfabianski@me.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - MIT-LICENSE
 - README.md
 - lib/hstore_translate.rb
 - lib/hstore_translate/translates.rb
+- lib/hstore_translate/translates/active_record_with_hstore_translates.rb
+- lib/hstore_translate/translates/instance_methods.rb
 - lib/hstore_translate/version.rb
 - test/database.yml
-- test/gemfiles/Gemfile.rails-3.1.x
-- test/gemfiles/Gemfile.rails-3.2.x
-- test/gemfiles/Gemfile.rails-4.0.x
-- test/gemfiles/Gemfile.rails-4.1.x
+- test/gemfiles/Gemfile.rails-4.2.x
+- test/gemfiles/Gemfile.rails-5.0.x
 - test/test_helper.rb
 - test/translates_test.rb
-homepage: https://github.com/robworley/hstore_translate
-licenses: 
+homepage: https://github.com/cfabianski/hstore_translate
+licenses:
 - MIT
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id004
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id004
+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.2.2
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: Rails I18n library for ActiveRecord model/data translation using PostgreSQL's hstore datatype.
-test_files: 
+summary: Rails I18n library for ActiveRecord model/data translation using PostgreSQL's
+  hstore 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
-- test/gemfiles/Gemfile.rails-3.1.x
-- test/gemfiles/Gemfile.rails-3.2.x
-- test/gemfiles/Gemfile.rails-4.0.x
-- test/gemfiles/Gemfile.rails-4.1.x

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

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-gemspec :path => './../..'
-
-gem 'pg'
-gem 'activerecord', '~> 3.1.0'
-gem 'activerecord-postgres-hstore', '~> 0.7.0'

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

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-gemspec :path => './../..'
-
-gem 'pg'
-gem 'activerecord', '~> 3.2.0'
-gem 'activerecord-postgres-hstore', '~> 0.7.0'

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

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-gemspec :path => './../..'
-
-gem 'activerecord', '~> 4.0.0'
-gem 'pg', :platform => :ruby
-gem 'activerecord-jdbcpostgresql-adapter', :platform => :jruby

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

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-gemspec :path => './../..'
-
-gem 'activerecord', '~> 4.1.0'
-gem 'pg', :platform => :ruby
-gem 'activerecord-jdbcpostgresql-adapter', :platform => :jruby