json_translate 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 18109ecd716fe83a685fba1c452278e24c292d88
-  data.tar.gz: 23188ebe9a7a00efc712a3ee7945911eae0137bb
+SHA256:
+  metadata.gz: 98c9caf9ca99da1bac3fdecdfa8c5249536b9f23fa7f16071efeddd7ad9cd97d
+  data.tar.gz: 13eb7ef35a9f5f322d5798c07cad3373bd7f403980a9edaeb0072e2a70350db2
 SHA512:
-  metadata.gz: b38e84f20f8c74bd68cd8cf18149fdc54c55b5b514d491056b177c1cacc9372289235d11f4bc954395e25dbf7aa1d6eb533fe23d26fd01fa616c2e0724147c07
-  data.tar.gz: bb93cce1c20f30bcc460e59c53f80fda46e6f5232ef4f7c43c7344dafc618a26b424bb60ac7320d9be1d5849e7bf1a13f007d23d869181408d35145f7d8d72ee
+  metadata.gz: cf87995f6e6295943f366be9e486f9c8abb2334c238d89d5cc7796e2e58a61e0f28b8b2e18172602de3dd312a0eda99adef29aa51f8a2bb172f6db3d638a358c
+  data.tar.gz: 2c0b99f0e3c2b02c5db293a6e8831fcea11a2afe74d0c8b3e0048f1ffc48962424db88c1e81320382845b73de4b90099c09baa2c9a6bb0d9cfb0a64f1b2a9db4

data/README.md

@@ -145,3 +145,34 @@ post.enable_fallback do
   post.title_nl # => This database rocks!
 end
 ```
+
+## Enable blank value translations
+
+By default, empty String values are not stored, instead the locale is deleted.
+
+```ruby
+class Post < ActiveRecord::Base
+  translates :title
+end
+
+post.title_translations # => { en: 'Hello', fr: 'Bonjour' }
+post.title_en = ""
+post.title_translations # => { fr: 'Bonjour' }
+```
+
+Activating `allow_blank: true` enables to store empty String values.
+```ruby
+class Post < ActiveRecord::Base
+  translates :title, allow_blank: true
+end
+
+post.title_translations # => { en: 'Hello', fr: 'Bonjour' }
+post.title_en = ""
+post.title_translations # => { en: '', fr: 'Bonjour' }
+```
+
+`nil` value delete the locale key/value anyway.
+```ruby
+post.title_en = nil
+post.title_translations # => { fr: 'Bonjour' }
+```

data/lib/json_translate/translates.rb

@@ -3,7 +3,7 @@ module JSONTranslate
     SUFFIX = "_translations".freeze
     MYSQL_ADAPTERS = %w[MySQL Mysql2 Mysql2Spatial]
 
-    def translates(*attrs)
+    def translates(*attrs, allow_blank: false)
       include InstanceMethods
 
       class_attribute :translated_attribute_names, :permitted_translated_attributes
@@ -19,22 +19,22 @@ module JSONTranslate
 
       attrs.each do |attr_name|
         define_method attr_name do |**params|
-          read_json_translation(attr_name, params)
+          read_json_translation(attr_name, **params)
         end
 
         define_method "#{attr_name}=" do |value|
-          write_json_translation(attr_name, value)
+          write_json_translation(attr_name, value, allow_blank: allow_blank)
         end
 
         I18n.available_locales.each do |locale|
           normalized_locale = locale.to_s.downcase.gsub(/[^a-z]/, '')
 
           define_method :"#{attr_name}_#{normalized_locale}" do |**params|
-            read_json_translation(attr_name, locale, false, params)
+            read_json_translation(attr_name, locale: locale, fallback: false, **params)
           end
 
           define_method "#{attr_name}_#{normalized_locale}=" do |value|
-            write_json_translation(attr_name, value, locale)
+            write_json_translation(attr_name, value, locale: locale, allow_blank: allow_blank)
           end
         end
 

data/lib/json_translate/translates/instance_methods.rb

@@ -23,7 +23,7 @@ module JSONTranslate
         end
       end
 
-      def read_json_translation(attr_name, locale = I18n.locale, fallback = true, **params)
+      def read_json_translation(attr_name, locale: I18n.locale, fallback: true, **params)
         translations = public_send("#{attr_name}#{SUFFIX}") || {}
 
         selected_locale = locale
@@ -45,11 +45,11 @@ module JSONTranslate
         translation
       end
 
-      def write_json_translation(attr_name, value, locale = I18n.locale)
-        value = value.presence
+      def write_json_translation(attr_name, value, locale: I18n.locale, allow_blank:)
+        value = allow_blank ? value : value.presence
         translation_store = "#{attr_name}#{SUFFIX}"
         translations = public_send(translation_store) || {}
-        public_send("#{translation_store}_will_change!") unless translations[locale.to_s] == value
+        translation_store_will_change!(translation_store) unless translations[locale.to_s] == value
         if value
           translations[locale.to_s] = value
         else
@@ -59,6 +59,10 @@ module JSONTranslate
         value
       end
 
+      def translation_store_will_change!(translation_store)
+        public_send("#{translation_store}_will_change!")
+      end
+
       def toggle_fallback(enabled)
         if block_given?
           old_value = @enabled_fallback

data/lib/json_translate/version.rb

@@ -1,3 +1,3 @@
 module JSONTranslate
-  VERSION = "4.0.0"
+  VERSION = "4.0.1"
 end

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

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 gemspec :path => './../..'
 
-gem 'pg', '< 1.0.0'
+gem 'pg', '~> 1.0.0'
 gem 'mysql2'
 gem 'activerecord', '~> 5.0.0'

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

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

data/test/test_helper.rb

@@ -11,7 +11,7 @@ class Post < ActiveRecord::Base
 end
 
 class PostDetailed < Post
-  translates :comment
+  translates :comment, allow_blank: true
 end
 
 class JSONTranslate::Test < Minitest::Test
@@ -40,8 +40,7 @@ class JSONTranslate::Test < Minitest::Test
     end
 
     def create_database
-      system_config = db_config
-      connection = establish_connection(system_config)
+      connection = establish_connection(db_config)
       connection.create_database(db_config['database']) rescue nil
     end
 
@@ -61,6 +60,8 @@ class JSONTranslate::Test < Minitest::Test
   def setup
     I18n.available_locales = ['en', 'en-US', 'fr']
     I18n.config.enforce_available_locales = true
+    I18n::Backend::Simple.include(I18n::Backend::Fallbacks)
+    I18n.fallbacks = I18n.available_locales
     DatabaseCleaner.start
   end
 

data/test/translates_test.rb

@@ -13,18 +13,15 @@ class TranslatesTest < JSONTranslate::Test
   def test_retrieves_in_current_locale
     p = Post.new(
       :title_translations => { "en" => "English Title", "fr" => "Titre français" },
-      :body_1_translations => { "en" => "English Body", "fr" => "Corps anglais" }
+      :body_1_translations => { "en" => "English Body", "fr" => "Corps français" }
     )
     I18n.with_locale(:fr) do
       assert_equal("Titre français", p.title)
-      assert_equal("Corps anglais", p.body_1)
+      assert_equal("Corps français", p.body_1)
     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"}, :body_1_translations => { "en" => "English Body" })
     I18n.with_locale(:fr) do
       assert_equal("English Title", p.title)
@@ -42,6 +39,31 @@ class TranslatesTest < JSONTranslate::Test
     end
   end
 
+  def test_assigns_nil_value_as_standard
+    I18n.with_locale(:en) do
+      p = Post.new(:title_translations => { "en" => "English Title" })
+      p.title_fr = ""
+      p.title = ""
+      assert_nil(p.title_translations["fr"])
+      assert_nil(p.title_translations["en"])
+    end
+  end
+
+  def test_assigns_blank_value_when_active
+    # when allow_blank: true option is active
+    I18n.with_locale(:en) do
+      p = PostDetailed.new(:comment_translations => { "en" => "English Comment" }, :title_translations => { "en" => "English Comment" })
+      p.comment_fr = ""
+      p.comment = ""
+      p.title_en = nil
+      p.title = nil
+      assert_equal("", p.comment_translations["fr"])
+      assert_equal("", p.comment_translations["en"])
+      assert_nil(p.title_translations["en"])
+      assert_nil(p.title_translations["en"])
+    end
+  end
+
   def test_persists_changes_in_specified_locale
     I18n.with_locale(:en) do
       p = Post.create!(:title_translations => { "en" => "Original Text" }, :body_1_translations => { "en" => "Original Body" })
@@ -64,9 +86,6 @@ class TranslatesTest < JSONTranslate::Test
   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" }, :body_1_translations => { "en" => "English Body" })
     I18n.with_locale(:fr) do
       assert_equal("English Title", p.title)
@@ -79,9 +98,6 @@ class TranslatesTest < JSONTranslate::Test
   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" => "" }, :body_1_translations => { "en" => "English Body", "fr" => "" })
     I18n.with_locale(:fr) do
       assert_equal("English Title", p.title)
@@ -94,9 +110,6 @@ class TranslatesTest < JSONTranslate::Test
   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" }, :body_1_translations => { "en" => "English Body" })
     p.disable_fallback
     I18n.with_locale(:fr) do
@@ -106,9 +119,6 @@ class TranslatesTest < JSONTranslate::Test
   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" }, :body_1_translations => { "en" => "English Body" })
     p.enable_fallback
 
@@ -133,9 +143,6 @@ class TranslatesTest < JSONTranslate::Test
   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" }, :body_1_translations => { "en" => "English Body" })
     p.disable_fallback
     p.enable_fallback
@@ -150,9 +157,6 @@ class TranslatesTest < JSONTranslate::Test
   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" }, :body_1_translations => { "en" => "English Body" })
     p.disable_fallback
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_translate
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Rob Worley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-26 00:00:00.000000000 Z
+date: 2021-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -84,6 +84,7 @@ files:
 - test/database.yml
 - test/gemfiles/Gemfile.rails-4.2.x
 - test/gemfiles/Gemfile.rails-5.0.x
+- test/gemfiles/Gemfile.rails-6.0.x
 - test/test_helper.rb
 - test/translates_test.rb
 homepage: https://github.com/cfabianski/json_translate
@@ -105,13 +106,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Rails I18n library for ActiveRecord model/data translation using PostgreSQL's
   JSONB datatype.
 test_files:
+- test/gemfiles/Gemfile.rails-6.0.x
 - test/gemfiles/Gemfile.rails-5.0.x
 - test/gemfiles/Gemfile.rails-4.2.x
 - test/database.yml