ad_localize 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbef79aa4f801f810011f962ea28926e6518fd2e09b5471b83fe9ecf71a72638
-  data.tar.gz: 75f97c8dbf7e7e751f47fde0e3ae9e92eac06bd64d231fd0052acf7d6c19f2ab
+  metadata.gz: 9510eed71bfba2c01f047d80707eaaeffbe24d6fefc4f65927b1afe8e44c2a49
+  data.tar.gz: 3aba4a56d7f7b5fd0da6056471c55cf025a9133dd3d5a815fe06ac89a662d645
 SHA512:
-  metadata.gz: 7f49d154c8b682f0e17415703d220f254ecd5e4839b0969b2d75175d1e0617a2ad8dd5b41deab3ad616481c73a77160edf4700ee5baf89c7837a1c47e7ed789d
-  data.tar.gz: d022f56a3cc71552836c4c51c5418e5057aa4ee06e1b19ac5b7974bf8e3ce98311a67f608c11a8bf9aa01e31196075a3a8a22448638c0614814909589ee8883a
+  metadata.gz: b87614c092bd2c6fcee5deeba77add9035f01c4861d526081e91606e6613827f4199d2fccb1f69aa7149f6c7a2755536d7e7a2b5d50901455b519fc20a98d695
+  data.tar.gz: 22b0cc2b7b3a6290017b7cdd9e8bb0a7bb30b662bdeada9669d9fd10a670af0f3d4e99919fca9023b0cd289d0ad254d45e14dc7d7fdc20f0b6fac25f92017eca

data/CHANGELOG.md

@@ -4,6 +4,12 @@ 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.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)
+
 ## [3.0.0] - 2019-02-19
 TODO
 

data/README.md

@@ -97,10 +97,12 @@ exports/
 ├── ios
 │   ├── en.lproj
 │   │   ├── Localizable.strings
-│   │   └── Localizable.stringsdict
-│   └── fr.lproj
+│   │   ├── Localizable.stringsdict
+|   |   └── InfoPlist.strings
+│   └── fr.lproj
 │       ├── Localizable.strings
-│       └── Localizable.stringsdict
+│       ├── Localizable.stringsdict
+|       └── InfoPlist.strings
 ├── json
 │   ├── en.json
 │   └── fr.json
@@ -165,6 +167,16 @@ Sample of iOS output in .stringsdict
 </plist>
 ```
 
+## InfoPlist.strings
+
+_Only for iOS._
+
+Every key that matches the following formats will be added to the `InfoPlist.strings` file instead of `Localizable.strings`:
+* `NS...UsageDescription`
+* `CF...Name`
+
+Source: https://developer.apple.com/documentation/bundleresources/information_property_list
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/ad_localize/constant.rb

@@ -4,6 +4,7 @@ module AdLocalize
     PLURAL_KEY_SYMBOL = :plural
     SINGULAR_KEY_SYMBOL = :singular
     COMMENT_KEY_SYMBOL = :comment
+    INFO_PLIST_KEY_SYMBOL = :info_plist
     COMMENT_KEY_COLUMN_IDENTIFIER = "comment"
     DEFAULT_CONFIG = {
       platforms: {
@@ -16,6 +17,7 @@ module AdLocalize
     CONFIG = YAML.load_file(Pathname::pwd + 'config.yml').deep_symbolize_keys rescue DEFAULT_CONFIG
     EXPORT_FOLDER = 'exports'
     IOS_SINGULAR_EXPORT_FILENAME = "Localizable.strings"
+    IOS_INFO_PLIST_EXPORT_FILENAME = "InfoPlist.strings"
     IOS_PLURAL_EXPORT_FILENAME = "Localizable.stringsdict"
     ANDROID_EXPORT_FILENAME = "strings.xml"
   end

data/lib/ad_localize/csv_parser.rb

@@ -2,6 +2,7 @@ module AdLocalize
   class CsvParser
     CSV_WORDING_KEYS_COLUMN = "key"
     PLURAL_KEY_REGEXP = /\#\#\{(\w+)\}/
+    INFO_PLIST_KEY_REGEXP = /(NS.+UsageDescription)|(CF.+Name)/ # see https://developer.apple.com/documentation/bundleresources/information_property_list
 
     attr_accessor :locales
 
@@ -15,8 +16,12 @@ module AdLocalize
       CSV.foreach(file_name, headers: true, skip_blanks: true) do |row|
         validity_status = check_row(row)
         if validity_status.zero?
+          keys_column_index = row.index(CSV_WORDING_KEYS_COLUMN)
+          fields = row.fields
+          LOGGER.log(:warn, :yellow, "Missing key in line #{$.}") unless fields[keys_column_index...fields.count].all?(&:nil?)
           next
         elsif validity_status == -1
+          LOGGER.log(:error, :red, "[CSV FORMAT] #{file_name} is not a valid file")
           exit
         else
           find_locales(row) if locales.empty?
@@ -35,10 +40,8 @@ module AdLocalize
       valid_row = 1
       # Check non empty row
       if row.field(CSV_WORDING_KEYS_COLUMN).nil?
-        LOGGER.log(:error, :red, "Missing key in line #{$.}") unless row.fields.all?(&:nil?)
         valid_row = 0
       elsif not row.headers.include?(CSV_WORDING_KEYS_COLUMN)
-        LOGGER.log(:error, :red, "[CSV FORMAT] #{file_name} is not a valid file")
         valid_row = -1
       end
       return valid_row
@@ -75,6 +78,9 @@ 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::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)
         else
           raise "Unknown numeral key #{key_infos.dig(:numeral_key)}"
         end
@@ -93,7 +99,11 @@ module AdLocalize
       invalid_plural = false
 
       if plural_prefix.nil?
-        numeral_key = Constant::SINGULAR_KEY_SYMBOL
+        if key.match(INFO_PLIST_KEY_REGEXP).nil?
+          numeral_key = Constant::SINGULAR_KEY_SYMBOL
+        else
+          numeral_key = Constant::INFO_PLIST_KEY_SYMBOL
+        end
       else
         numeral_key = Constant::PLURAL_KEY_SYMBOL
         key = plural_prefix.pre_match

data/lib/ad_localize/platform/ios_formatter.rb

@@ -6,7 +6,7 @@ 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].each do |numeral_key|
+      [AdLocalize::Constant::PLURAL_KEY_SYMBOL, AdLocalize::Constant::SINGULAR_KEY_SYMBOL, AdLocalize::Constant::INFO_PLIST_KEY_SYMBOL].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")
@@ -17,20 +17,39 @@ module AdLocalize::Platform
     end
 
     protected
+
     def write_singular(locale, singulars)
+      write_localizable(
+        locale: locale,
+        singulars: singulars,
+        wording_type: AdLocalize::Constant::SINGULAR_KEY_SYMBOL,
+        filename: AdLocalize::Constant::IOS_SINGULAR_EXPORT_FILENAME
+      )
+    end
+
+    def write_info_plist(locale, singulars)
+      write_localizable(
+        locale: locale,
+        singulars: singulars,
+        wording_type: AdLocalize::Constant::INFO_PLIST_KEY_SYMBOL,
+        filename: AdLocalize::Constant::IOS_INFO_PLIST_EXPORT_FILENAME
+      )
+    end
+
+    def write_localizable(locale:, singulars:, wording_type:, filename:)
       locale = locale.to_sym
 
       singulars.each do |key, locales_wording|
-        value = locales_wording.dig(locale, AdLocalize::Constant::SINGULAR_KEY_SYMBOL)
+        value = locales_wording.dig(locale, wording_type)
         comment = locales_wording.dig(locale, AdLocalize::Constant::COMMENT_KEY_SYMBOL)
-        export_dir(locale).join(AdLocalize::Constant::IOS_SINGULAR_EXPORT_FILENAME).open("a") do |file|
+        export_dir(locale).join(filename).open("a") do |file|
           line =  "\"#{key}\" = \"#{value}\";"
           line << " // #{comment}" unless comment.nil?
           line << "\n"
           file.puts line
         end
       end
-      AdLocalize::LOGGER.log(:debug, :black, "iOS singular [#{locale}] ---> DONE!")
+      AdLocalize::LOGGER.log(:debug, :black, "iOS #{wording_type} [#{locale}] ---> DONE!")
     end
 
     def write_plural(locale, plurals)

data/lib/ad_localize/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ad_localize
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Edouard Siegel