ad_localize 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c1c393dd716aa7f1306df1a86b7e166194efebe24d94e6f5c61628d62026a60
-  data.tar.gz: 4e1d02d8e92919e656c1fdb77efb620e9f5c812b4c59da5d6682269917886b00
+  metadata.gz: b70487e0e8087dbbdb3c6873b025748b9fc97e68ac2abc5c13a0fe71a1a1011c
+  data.tar.gz: c82fe7eeb8bc946411c094f51d69df40a35bc9b9e5c5805203a976c4d2aba9c0
 SHA512:
-  metadata.gz: 2a041906d4a7f138fc762be1dc4b30ef2b91fcb8419ad4a28c90c24689deb5eb684877671721156ff63c3044788116252789cd14bddefd968731625bb6766cb5
-  data.tar.gz: f9e3cc3ad69de48aa334471443a554562a2f9a7a47364737bfd5af6755dc5040eba68249dd37e9c5ae4445e7afd0e6259e5d97181c9feb4d4443696f2344bf36
+  metadata.gz: 8acdef650f29ede65b72fed96666be542f078337dd6e7b950a8be2ec18b1ff55ee65279dcd5736e5b4d229fed9796b30480cee9b72194ad1bdbba87fa388d81b
+  data.tar.gz: cad8b9ba73f3055cb7d000fdda14eb45f59a418d6e563a5d272855ff86000779c221282b07e8f33f07f793ecaec6e9150dc9b889c485e8a1496ee1839a5b9daa

data/CHANGELOG.md

@@ -6,6 +6,13 @@ 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).
 
 ## Unreleased
+
+## 6.1.0
+### Added
+
+- new option (iOS only) `--auto-escape-percent` that escapes % character in wording. This option should be used if the wording is intended to be used with `String(format:)`.
+
+## 6.0.0
 ### Added
 
 - Remove extra spaces before and after key/translation contents

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ad_localize (6.0.0)
+    ad_localize (6.1.0)
       activesupport (>= 6.1.3.2, < 8.0)
       colorize (~> 0.8)
       google-apis-drive_v3 (~> 0.33.0)

data/README.md

@@ -76,6 +76,11 @@ $ ad_localize -d
 $ ad_localize -x
 ```
 
+* Will escape % character present in wordings (iOS feature only), this is useful when using the wording through String(format:)
+```
+$ ad_localize --auto-escape-percent
+```
+
 * Only generate wording files for the specified locales
 ```
 $ ad_localize -l fr,en

data/lib/ad_localize/interactors/base_generate_files.rb

@@ -10,6 +10,7 @@ module AdLocalize
       end
 
       def call(wording:, export_request:)
+        @serializer.configure(export_request: export_request) if @serializer.respond_to?(:configure)
         wording.each do |locale, locale_wording|
           next unless has_wording?(locale_wording: locale_wording)
 

data/lib/ad_localize/mappers/options_to_export_request.rb

@@ -6,6 +6,7 @@ module AdLocalize
         request = Requests::ExportRequest.new
         request.locales = options[:locales]
         request.bypass_empty_values = options[:'non-empty-values']
+        request.auto_escape_percent = options[:'auto-escape-percent']
         request.csv_paths = options[:csv_paths]
         request.merge_policy = options[:'merge-policy']
         request.output_path = options[:'target-dir']

data/lib/ad_localize/option_handler.rb

@@ -4,6 +4,7 @@ module AdLocalize
     DEFAULT_OPTIONS = {
       locales: Requests::ExportRequest::DEFAULTS[:locales],
       :'non-empty-values' => Requests::ExportRequest::DEFAULTS[:bypass_empty_values],
+      :'auto-escape-percent' => Requests::ExportRequest::DEFAULTS[:auto_escape_percent],
       csv_paths: Requests::ExportRequest::DEFAULTS[:csv_paths],
       :'merge-policy' => Requests::ExportRequest::DEFAULTS[:merge_policy],
       :'target-dir' => Requests::ExportRequest::DEFAULTS[:output_path],
@@ -16,26 +17,10 @@ module AdLocalize
 
     def self.parse!(options)
       args = DEFAULT_OPTIONS
-      export_all_option = <<~DOC
-        Export all sheets from spreadsheet specified by --drive-key option.
-        \tBy default, generates one export directory per sheet (see -m|--merge-sheets option to merge them).
-        \tAn GCLOUD_CLIENT_SECRET environment variable containing the client_secret.json content is needed.
-      DOC
-      merge_policy_option = <<~DOC
-        Merge specified csv (or sheets from --export-all) instead of exporting each csv.
-        \treplace: if a key is already defined, replace its value.
-        \tkeep: if a key is already defined, keep the previous value.
-      DOC
-      platforms_option = <<~DOC
-        PLATFORMS is a comma separated list.
-        \tOnly generate localisation files for the specified platforms.
-        \tSupported platforms : #{Entities::Platform::SUPPORTED_PLATFORMS.to_sentence}
-      DOC
-
       OptionParser.new do |parser|
         parser.banner = 'Usage: exe/ad_localize [options] file(s)'
         parser.on("-d", "--debug", TrueClass, 'Run in debug mode')
-        parser.on("-e", "--export-all-sheets", TrueClass, export_all_option)
+        export_all_option(parser)
         parser.on("-h", "--help", 'Prints help') do
           puts parser
           exit
@@ -43,8 +28,8 @@ module AdLocalize
         parser.on("-k", "--drive-key SPREADSHEET_ID", String, 'Use google drive spreadsheets')
         parser.on("-l", "--locales LOCALES", Array,
                   'LOCALES is a comma separated list. Only generate localisation files for the specified locales')
-        parser.on("-m", "--merge-policy POLICY", Interactors::MergeWordings::MERGE_POLICIES, merge_policy_option)
-        parser.on("-o", "--only PLATFORMS", Array, platforms_option)
+        merge_policy_option(parser)
+        platforms_option(parser)
         parser.on("-s", "--sheets SHEET_IDS", Array,
                   'SHEET_IDS is a comma separated list. Use a specific sheet id for Google Drive spreadsheets with several sheets')
         parser.on("-t", "--target-dir PATH", String, 'Path to the target directory')
@@ -53,10 +38,38 @@ module AdLocalize
           exit
         end
         parser.on("-x", "--non-empty-values", TrueClass, 'Do not export keys with empty values (iOS only)')
+        parser.on("--auto-escape-percent", TrueClass, 'Add escaping for % symbol to support wording use with String formatting (iOS only)')
       end.parse!(options, into: args)
 
       args[:csv_paths] = options
       return args
     end
+
+    def self.export_all_option(parser)
+      export_all_option = <<~DOC
+        Export all sheets from spreadsheet specified by --drive-key option.
+        \tBy default, generates one export directory per sheet (see -m|--merge-sheets option to merge them).
+        \tAn GCLOUD_CLIENT_SECRET environment variable containing the client_secret.json content is needed.
+      DOC
+      parser.on("-e", "--export-all-sheets", TrueClass, export_all_option)
+    end
+
+    def self.merge_policy_option(parser)
+      merge_policy_option = <<~DOC
+        Merge specified csv (or sheets from --export-all) instead of exporting each csv.
+        \treplace: if a key is already defined, replace its value.
+        \tkeep: if a key is already defined, keep the previous value.
+      DOC
+      parser.on("-m", "--merge-policy POLICY", Interactors::MergeWordings::MERGE_POLICIES, merge_policy_option)
+    end
+
+    def self.platforms_option(parser)
+      platforms_option = <<~DOC
+        PLATFORMS is a comma separated list.
+        \tOnly generate localisation files for the specified platforms.
+        \tSupported platforms : #{Entities::Platform::SUPPORTED_PLATFORMS.to_sentence}
+      DOC
+      parser.on("-o", "--only PLATFORMS", Array, platforms_option)
+    end
   end
 end

data/lib/ad_localize/requests/export_request.rb

@@ -5,6 +5,7 @@ module AdLocalize
       DEFAULTS = {
         locales: [],
         bypass_empty_values: false,
+        auto_escape_percent: false,
         csv_paths: [],
         merge_policy: Interactors::MergeWordings::DEFAULT_POLICY,
         output_path: Pathname.new('exports'),
@@ -21,6 +22,7 @@ module AdLocalize
       attr_reader(
         :locales,
         :bypass_empty_values,
+        :auto_escape_percent,
         :csv_paths,
         :merge_policy,
         :output_path,
@@ -35,6 +37,7 @@ module AdLocalize
       def initialize
         @locales = DEFAULTS[:locales]
         @bypass_empty_values = DEFAULTS[:bypass_empty_values]
+        @auto_escape_percent = DEFAULTS[:auto_escape_percent]
         @csv_paths = DEFAULTS[:csv_paths]
         @merge_policy = DEFAULTS[:merge_policy]
         @output_path = DEFAULTS[:output_path]
@@ -56,6 +59,10 @@ module AdLocalize
         @bypass_empty_values = [true, 'true'].include?(value)
       end
 
+      def auto_escape_percent=(value)
+        @auto_escape_percent = [true, 'true'].include?(value)
+      end
+
       def csv_paths=(value)
         return unless value.is_a? Array
 
@@ -119,6 +126,7 @@ module AdLocalize
       def to_s
         "locales: #{locales}, " \
           "bypass_empty_values: #{bypass_empty_values}, " \
+          "auto_escape_percent: #{auto_escape_percent}, " \
           "csv_paths: #{csv_paths}, " \
           "merge_policy: #{merge_policy}, " \
           "output_path: #{output_path}, " \

data/lib/ad_localize/sanitizers/ios_sanitizer.rb

@@ -2,10 +2,21 @@
 module AdLocalize
   module Sanitizers
     class IOSSanitizer
+      attr_accessor :should_auto_escape_percent
+
+      def initialize
+        @should_auto_escape_percent = false
+      end
+
       def sanitize(value:)
         return if value.blank?
 
-        value.gsub(/(?<!\\)\"/, "\\\"")
+        processed_value = value.gsub(/(?<!\\)\"/, "\\\"")
+        if @should_auto_escape_percent
+          # we should escape % sign when not used as formatting function (see: https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/Strings/Articles/formatSpecifiers.html)
+          processed_value = processed_value.gsub(/%(?!((\d+\$)?([a-zA-Z]|@)))/, '%%')
+        end
+        processed_value
       end
     end
   end

data/lib/ad_localize/serializers/localizable_strings_serializer.rb

@@ -8,6 +8,10 @@ module AdLocalize
         super(sanitizer: Sanitizers::IOSSanitizer.new)
       end
 
+      def configure(export_request:)
+        @sanitizer.should_auto_escape_percent = export_request.auto_escape_percent
+      end
+
       private
 
       def template_path

data/lib/ad_localize/serializers/localizable_stringsdict_serializer.rb

@@ -8,6 +8,10 @@ module AdLocalize
         super(sanitizer: Sanitizers::IOSSanitizer.new)
       end
 
+      def configure(export_request:)
+        @sanitizer.should_auto_escape_percent = export_request.auto_escape_percent
+      end
+
       private
 
       def template_path

data/lib/ad_localize/serializers/templated_serializer.rb

@@ -13,6 +13,10 @@ module AdLocalize
         render_template(template_path: template_path, variable_binding: variable_binding)
       end
 
+      def configure(export_request:)
+        # override if you need flags from export_request
+      end
+
       protected
 
       TEMPLATES_DIRECTORY = __dir__ + "/../templates"

data/lib/ad_localize/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module AdLocalize
-  VERSION = "6.0.0"
+  VERSION = "6.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ad_localize
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.1.0
 platform: ruby
 authors:
 - Edouard Siegel
@@ -21,7 +21,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-17 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -302,7 +302,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: AdLocalize helps with mobile and web applications wording