ad_localize 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9510eed71bfba2c01f047d80707eaaeffbe24d6fefc4f65927b1afe8e44c2a49
-  data.tar.gz: 3aba4a56d7f7b5fd0da6056471c55cf025a9133dd3d5a815fe06ac89a662d645
+  metadata.gz: b67ba9ff725d7fbf76fd0d680b07573648ee51966fdbb8429e6a26a764fc5563
+  data.tar.gz: 7ce5a08e27d50cbedd1ca1f4ffac9af1817ee8c38e97eb088d6dd7bc6d8ec5d0
 SHA512:
-  metadata.gz: b87614c092bd2c6fcee5deeba77add9035f01c4861d526081e91606e6613827f4199d2fccb1f69aa7149f6c7a2755536d7e7a2b5d50901455b519fc20a98d695
-  data.tar.gz: 22b0cc2b7b3a6290017b7cdd9e8bb0a7bb30b662bdeada9669d9fd10a670af0f3d4e99919fca9023b0cd289d0ad254d45e14dc7d7fdc20f0b6fac25f92017eca
+  metadata.gz: 0eb0c873e0d27062cc4291baab1c330224997ef3085b7474424c50d0dff8f089c40ae9f668e91f5769ce6d7c69431892435ee65a5a3073815ddbbe9bcde539be
+  data.tar.gz: 7998404ef9a406c7421117d666fae0c3aa8bfa0f55a5fe4e5a207a7c6bc01d370de3158a47910d47205d73a266a35109ca819cf114b572fe848061454e5fad29

data/CHANGELOG.md

@@ -4,9 +4,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.2.0] - 2019-12-10
+### Added
+  - Add tests to compare reference exports by [@felginep](https://github.com/felginep)
+  - [iOS only] Handle [adaptive strings](https://developer.apple.com/documentation/foundation/nsstring/1413104-variantfittingpresentationwidth) by [@felginep](https://github.com/felginep)
+
+### Changed
+  - Fix issue with Info.plist format by [@felginep](https://github.com/felginep)
+  - Do not export plurals for android when there are no values by [@felginep](https://github.com/felginep)
+
 ## [3.1.0] - 2019-09-30
 ### Added
   - [iOS only] Info.plist generation support by [@felginep](https://github.com/felginep)
+
 ### Changed
   - No more warning log for empty lines by [@felginep](https://github.com/felginep)
 
@@ -27,4 +37,3 @@ TODO
 
 ## [0.1.0] - 2016-04-25
 TODO
-

data/ad_localize.gemspec

@@ -42,6 +42,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.11'
   spec.add_development_dependency 'byebug', '~> 11.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.3'
+  spec.add_development_dependency 'diffy', '~> 3.3'
 
   spec.add_dependency 'activesupport', '~> 4.2' ,'>= 4.2.10' # Fastlane does not support activesupport 5
   spec.add_dependency 'nokogiri', '~> 1.8', '>= 1.8.2'

data/lib/ad_localize/constant.rb

@@ -2,6 +2,7 @@ module AdLocalize
   module Constant
     SUPPORTED_PLATFORMS = %w(ios android yml json)
     PLURAL_KEY_SYMBOL = :plural
+    ADAPTIVE_KEY_SYMBOL = :adaptive
     SINGULAR_KEY_SYMBOL = :singular
     COMMENT_KEY_SYMBOL = :comment
     INFO_PLIST_KEY_SYMBOL = :info_plist

data/lib/ad_localize/csv_parser.rb

@@ -1,7 +1,8 @@
 module AdLocalize
   class CsvParser
     CSV_WORDING_KEYS_COLUMN = "key"
-    PLURAL_KEY_REGEXP = /\#\#\{(\w+)\}/
+    PLURAL_KEY_REGEXP = /\#\#\{([A-Za-z]+)\}/
+    ADAPTIVE_KEY_REGEXP = /\#\#\{(\d+)\}/
     INFO_PLIST_KEY_REGEXP = /(NS.+UsageDescription)|(CF.+Name)/ # see https://developer.apple.com/documentation/bundleresources/information_property_list
 
     attr_accessor :locales
@@ -78,6 +79,11 @@ module AdLocalize
             "[#{locale.upcase}] Plural key ---> plural_identifier : #{key_infos.dig(:plural_identifier)}, key : #{current_key}",
             "[#{locale.upcase}] Missing translation for #{current_key} (#{key_infos.dig(:plural_identifier)})")
           value = { key_infos.dig(:plural_identifier) => row[locale] || default_wording(locale, "#{current_key} (#{key_infos.dig(:plural_identifier)})") }
+        elsif key_infos.dig(:numeral_key) == Constant::ADAPTIVE_KEY_SYMBOL
+          trace_wording(row[locale],
+            "[#{locale.upcase}] Adaptive key ---> adaptive_identifier : #{key_infos.dig(:adaptive_identifier)}, key : #{current_key}",
+            "[#{locale.upcase}] Missing translation for #{current_key} (#{key_infos.dig(:adaptive_identifier)})")
+          value = { key_infos.dig(:adaptive_identifier) => row[locale] || default_wording(locale, "#{current_key} (#{key_infos.dig(:adaptive_identifier)})") }
         elsif key_infos.dig(:numeral_key) == Constant::INFO_PLIST_KEY_SYMBOL
           trace_wording(row[locale], "[#{locale.upcase}] Info.plist key ---> #{current_key}", "[#{locale.upcase}] Missing translation for #{current_key}")
           value = row[locale] || default_wording(locale, current_key)
@@ -98,22 +104,31 @@ module AdLocalize
       plural_identifier = nil
       invalid_plural = false
 
-      if plural_prefix.nil?
-        if key.match(INFO_PLIST_KEY_REGEXP).nil?
-          numeral_key = Constant::SINGULAR_KEY_SYMBOL
-        else
-          numeral_key = Constant::INFO_PLIST_KEY_SYMBOL
-        end
-      else
+      adaptive_prefix = key.match(ADAPTIVE_KEY_REGEXP)
+      adaptive_identifier = nil
+      invalid_adaptive = false
+
+      if plural_prefix != nil
         numeral_key = Constant::PLURAL_KEY_SYMBOL
         key = plural_prefix.pre_match
         plural_identifier = plural_prefix.captures&.first
         LOGGER.log(:debug, :red, "Invalid key #{key}") if key.nil?
         LOGGER.log(:debug, :red, "Empty plural prefix!") if plural_identifier.nil?
         invalid_plural = plural_identifier.nil?
+      elsif adaptive_prefix != nil
+        numeral_key = Constant::ADAPTIVE_KEY_SYMBOL
+        key = adaptive_prefix.pre_match
+        adaptive_identifier = adaptive_prefix.captures&.first
+        LOGGER.log(:debug, :red, "Invalid key #{key}") if key.nil?
+        LOGGER.log(:debug, :red, "Empty adaptive prefix!") if adaptive_identifier.nil?
+        invalid_adaptive = adaptive_identifier.nil?
+      elsif key.match(INFO_PLIST_KEY_REGEXP) != nil
+        numeral_key = Constant::INFO_PLIST_KEY_SYMBOL
+      else
+        numeral_key = Constant::SINGULAR_KEY_SYMBOL
       end
 
-      (key.nil? or invalid_plural) ? nil : { key: key.to_sym, numeral_key: numeral_key, plural_identifier: plural_identifier&.to_sym }
+      (key.nil? or invalid_plural or invalid_adaptive) ? nil : { key: key.to_sym, numeral_key: numeral_key, plural_identifier: plural_identifier&.to_sym, adaptive_identifier: adaptive_identifier&.to_sym }
     end
 
     def default_wording(locale, key)

data/lib/ad_localize/platform/android_formatter.rb

@@ -57,7 +57,7 @@ module AdLocalize::Platform
             add_wording_text_to_xml(plural_text, xml)
           }
         end
-      }
+      } unless plural_hash.values.all? &:empty?
     end
 
     def add_wording_text_to_xml(wording_text, xml)

data/lib/ad_localize/platform/ios_formatter.rb

@@ -6,7 +6,13 @@ module AdLocalize::Platform
 
     def export(locale, data, export_extension = nil, substitution_format = nil)
       create_locale_dir(locale)
-      [AdLocalize::Constant::PLURAL_KEY_SYMBOL, AdLocalize::Constant::SINGULAR_KEY_SYMBOL, AdLocalize::Constant::INFO_PLIST_KEY_SYMBOL].each do |numeral_key|
+      all_symbols = [
+        AdLocalize::Constant::PLURAL_KEY_SYMBOL,
+        AdLocalize::Constant::ADAPTIVE_KEY_SYMBOL,
+        AdLocalize::Constant::SINGULAR_KEY_SYMBOL,
+        AdLocalize::Constant::INFO_PLIST_KEY_SYMBOL
+      ]
+      all_symbols.each do |numeral_key|
         numeral_data = data.select {|key, wording| wording.dig(locale.to_sym)&.key? numeral_key}
         if numeral_data.empty?
           AdLocalize::LOGGER.log(:info, :black, "[#{locale.upcase}] no #{numeral_key.to_s} keys were found to generate the file")
@@ -36,6 +42,54 @@ module AdLocalize::Platform
       )
     end
 
+    def write_plural(locale, plurals)
+      locale = locale.to_sym
+
+      append_to_localizable_plist(locale) do |xml|
+        plurals.each do |wording_key, translations|
+          xml.key wording_key
+          xml.dict {
+            xml.key "NSStringLocalizedFormatKey"
+            xml.string "%\#@key@"
+            xml.key "key"
+            xml.dict {
+              xml.key "NSStringFormatSpecTypeKey"
+              xml.string "NSStringPluralRuleType"
+              xml.key "NSStringFormatValueTypeKey"
+              xml.string "d"
+              translations[locale][AdLocalize::Constant::PLURAL_KEY_SYMBOL].each do |wording_type, wording_value|
+                xml.key wording_type
+                xml.string wording_value
+              end
+            }
+          }
+        end
+      end
+      AdLocalize::LOGGER.log(:debug, :black, "iOS plural [#{locale}] ---> DONE!")
+    end
+
+    def write_adaptive(locale, adaptives)
+      locale = locale.to_sym
+
+      append_to_localizable_plist(locale) do |xml|
+        adaptives.each do |wording_key, translations|
+          xml.key wording_key
+          xml.dict {
+            xml.key "NSStringVariableWidthRuleType"
+            xml.dict {
+              translations[locale][AdLocalize::Constant::ADAPTIVE_KEY_SYMBOL].each do |wording_type, wording_value|
+                xml.key wording_type
+                xml.string wording_value
+              end
+            }
+          }
+        end
+      end
+      AdLocalize::LOGGER.log(:debug, :black, "iOS adaptive [#{locale}] ---> DONE!")
+    end
+
+    private
+
     def write_localizable(locale:, singulars:, wording_type:, filename:)
       locale = locale.to_sym
 
@@ -43,7 +97,12 @@ module AdLocalize::Platform
         value = locales_wording.dig(locale, wording_type)
         comment = locales_wording.dig(locale, AdLocalize::Constant::COMMENT_KEY_SYMBOL)
         export_dir(locale).join(filename).open("a") do |file|
-          line =  "\"#{key}\" = \"#{value}\";"
+          line = ""
+          if wording_type == AdLocalize::Constant::INFO_PLIST_KEY_SYMBOL
+            line = %(#{key} = "#{value}";)
+          else
+            line = %("#{key}" = "#{value}";)
+          end
           line << " // #{comment}" unless comment.nil?
           line << "\n"
           file.puts line
@@ -52,37 +111,28 @@ module AdLocalize::Platform
       AdLocalize::LOGGER.log(:debug, :black, "iOS #{wording_type} [#{locale}] ---> DONE!")
     end
 
-    def write_plural(locale, plurals)
-      locale = locale.to_sym
-
-      xml_doc = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
-        xml.plist {
-          xml.dict {
-            plurals.each do |wording_key, translations|
-              xml.key wording_key
-              xml.dict {
-                xml.key "NSStringLocalizedFormatKey"
-                xml.string "%\#@key@"
-                xml.key "key"
-                xml.dict {
-                  xml.key "NSStringFormatSpecTypeKey"
-                  xml.string "NSStringPluralRuleType"
-                  xml.key "NSStringFormatValueTypeKey"
-                  xml.string "d"
-                  translations[locale][AdLocalize::Constant::PLURAL_KEY_SYMBOL].each do |wording_type, wording_value|
-                    xml.key wording_type
-                    xml.string wording_value
-                  end
-                }
-              }
-            end
+    def append_to_localizable_plist(locale)
+      filename = export_dir(locale).join(AdLocalize::Constant::IOS_PLURAL_EXPORT_FILENAME)
+      xml_doc = nil
+      if File.exist?(filename)
+        xml_content = Nokogiri::XML(open(filename)) do |config|
+          config.default_xml.noblanks # minimify xml
+        end
+        xml_doc = Nokogiri::XML::Builder.with(xml_content.css('plist>dict').first) do |xml|
+          yield(xml)
+        end
+      else
+        xml_doc = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+          xml.plist {
+            xml.dict {
+              yield(xml)
+            }
           }
-        }
+        end
       end
-      export_dir(locale).join(AdLocalize::Constant::IOS_PLURAL_EXPORT_FILENAME).open("w") do |file|
+      filename.open("w") do |file|
         file.puts xml_doc.to_xml(indent: 4)
       end
-      AdLocalize::LOGGER.log(:debug, :black, "iOS plural [#{locale}] ---> DONE!")
     end
   end
 end

data/lib/ad_localize/version.rb

@@ -1,3 +1,3 @@
 module AdLocalize
-  VERSION = "3.1.0"
+  VERSION = "3.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ad_localize
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Edouard Siegel
@@ -96,6 +96,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement