ad_localize 5.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e367d46040937d12da9dabf34045b83a66a3e3a042833f96971c84621f326ff7
-  data.tar.gz: d6939a29627f1c1681525c5618dd2f68e78132de0d75d3208ad53c8495c346d3
+  metadata.gz: b70487e0e8087dbbdb3c6873b025748b9fc97e68ac2abc5c13a0fe71a1a1011c
+  data.tar.gz: c82fe7eeb8bc946411c094f51d69df40a35bc9b9e5c5805203a976c4d2aba9c0
 SHA512:
-  metadata.gz: d05c3855c3a3b1de045b7f808d8e7e1898ba6f1a65e27cb9cd1788578ae4c448abb6960b450a09c43416b8744c6ec8857b936889111ca10553daf17771b40692
-  data.tar.gz: c52f9eee3bab2dd91b8786ff6eb848c9da3b3ef3e0a9a3bccf0445783118432be8538ac3a12ef6639831ab920df37b98c7e8cbee0cbdf595a4e475e419a70261
+  metadata.gz: 8acdef650f29ede65b72fed96666be542f078337dd6e7b950a8be2ec18b1ff55ee65279dcd5736e5b4d229fed9796b30480cee9b72194ad1bdbba87fa388d81b
+  data.tar.gz: cad8b9ba73f3055cb7d000fdda14eb45f59a418d6e563a5d272855ff86000779c221282b07e8f33f07f793ecaec6e9150dc9b889c485e8a1496ee1839a5b9daa

data/.github/workflows/ruby.yml

@@ -7,15 +7,18 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: ['2.7.3', '3.0.1', '3.1.0']
+        ruby: ['3.0.6', '3.1.4', '3.2.0']
 
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - name: Build and test with Rake
+      - name: Build
         run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
-          bundle exec rake
+      - name: Run linter
+        run: bundle exec rubocop
+      - name: Run tests
+        run: bundle exec rake test

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable

data/.rubocop_todo.yml

@@ -0,0 +1,319 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-02-02 13:39:01 UTC using RuboCop version 1.43.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
+# Include: **/*.gemspec
+Gemspec/OrderedDependencies:
+  Exclude:
+    - 'ad_localize.gemspec'
+
+# Offense count: 1
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'ad_localize.gemspec'
+
+# Offense count: 86
+# This cop supports safe autocorrection (--autocorrect).
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
+Lint/UnusedBlockArgument:
+  Exclude:
+    - 'lib/ad_localize/mappers/locale_wording_to_hash.rb'
+
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/ad_localize/interactors/base_generate_files.rb'
+    - 'lib/ad_localize/serializers/templated_serializer.rb'
+
+# Offense count: 6
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 35
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 139
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 11
+
+# Offense count: 11
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 40
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 11
+
+# Offense count: 1
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/ad_localize/mappers/locale_wording_to_hash.rb'
+
+# Offense count: 10
+# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
+# NamePrefix: is_, has_, have_
+# ForbiddenPrefixes: is_, has_, have_
+# AllowedMethods: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/ad_localize/interactors/base_generate_files.rb'
+    - 'lib/ad_localize/interactors/generate_info_plist.rb'
+    - 'lib/ad_localize/interactors/generate_json.rb'
+    - 'lib/ad_localize/interactors/generate_localizable_strings.rb'
+    - 'lib/ad_localize/interactors/generate_localizable_strings_dict.rb'
+    - 'lib/ad_localize/interactors/generate_properties.rb'
+    - 'lib/ad_localize/interactors/generate_strings.rb'
+    - 'lib/ad_localize/interactors/generate_yaml.rb'
+    - 'lib/ad_localize/requests/export_request.rb'
+
+# Offense count: 28
+# Configuration parameters: EnforcedStyle, AllowedIdentifiers, AllowedPatterns.
+# SupportedStyles: snake_case, camelCase
+Naming/VariableName:
+  Exclude:
+    - 'lib/ad_localize/sanitizers/ios_to_android_sanitizer.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, IgnoredMethods, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# AllowedMethods: lambda, proc, it
+Style/BlockDelimiters:
+  Exclude:
+    - 'lib/ad_localize/parsers/csv_parser.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, SingleLineConditionsOnly, IncludeTernaryExpressions.
+# SupportedStyles: assign_to_condition, assign_inside_condition
+Style/ConditionalAssignment:
+  Exclude:
+    - 'lib/ad_localize/interactors/export_wording.rb'
+    - 'lib/ad_localize/sanitizers/ios_to_android_sanitizer.rb'
+
+# Offense count: 36
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+Style/ExpandPathArguments:
+  Exclude:
+    - 'ad_localize.gemspec'
+    - 'test/test_helper.rb'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: format, sprintf, percent
+Style/FormatString:
+  Exclude:
+    - 'lib/ad_localize/interactors/generate_info_plist.rb'
+    - 'lib/ad_localize/interactors/generate_localizable_strings.rb'
+    - 'lib/ad_localize/interactors/generate_localizable_strings_dict.rb'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: MaxUnannotatedPlaceholdersAllowed, AllowedMethods, AllowedPatterns, IgnoredMethods.
+# SupportedStyles: annotated, template, unannotated
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/GlobalStdStream:
+  Exclude:
+    - 'lib/ad_localize/ad_logger.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: MinBodyLength, AllowConsecutiveConditionals.
+Style/GuardClause:
+  Exclude:
+    - 'lib/ad_localize/repositories/drive_repository.rb'
+
+# Offense count: 57
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, EnforcedShorthandSyntax, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+# SupportedShorthandSyntax: always, never, either, consistent
+Style/HashSyntax:
+  Enabled: false
+
+# Offense count: 4
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/LineEndConcatenation:
+  Exclude:
+    - 'lib/ad_localize/entities/locale_wording.rb'
+
+# Offense count: 6
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: literals, strict
+Style/MutableConstant:
+  Exclude:
+    - 'lib/ad_localize/entities/platform.rb'
+    - 'lib/ad_localize/interactors/merge_wordings.rb'
+    - 'lib/ad_localize/option_handler.rb'
+    - 'lib/ad_localize/requests/export_request.rb'
+    - 'test/test_helper.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: both, prefix, postfix
+Style/NegatedIf:
+  Exclude:
+    - 'lib/ad_localize/interactors/generate_strings.rb'
+
+# Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns, IgnoredMethods.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/interactors/process_export_request_test.rb'
+    - 'test/repositories/drive_repository_test.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowedCompactTypes.
+# SupportedStyles: compact, exploded
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/RedundantAssignment:
+  Exclude:
+    - 'lib/ad_localize/parsers/csv_parser.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/RedundantBegin:
+  Exclude:
+    - 'lib/ad_localize/repositories/drive_repository.rb'
+
+# Offense count: 18
+# This cop supports safe autocorrection (--autocorrect).
+Style/RedundantFreeze:
+  Exclude:
+    - 'lib/ad_localize/interactors/generate_info_plist.rb'
+    - 'lib/ad_localize/interactors/generate_localizable_strings.rb'
+    - 'lib/ad_localize/interactors/generate_localizable_strings_dict.rb'
+    - 'lib/ad_localize/interactors/generate_strings.rb'
+    - 'lib/ad_localize/interactors/merge_wordings.rb'
+    - 'lib/ad_localize/parsers/csv_parser.rb'
+    - 'lib/ad_localize/parsers/key_parser.rb'
+    - 'lib/ad_localize/serializers/info_plist_serializer.rb'
+    - 'lib/ad_localize/serializers/localizable_strings_serializer.rb'
+    - 'lib/ad_localize/serializers/localizable_stringsdict_serializer.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Style/RedundantPercentQ:
+  Exclude:
+    - 'ad_localize.gemspec'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Style/RedundantRegexpEscape:
+  Exclude:
+    - 'lib/ad_localize/sanitizers/ios_sanitizer.rb'
+    - 'lib/ad_localize/sanitizers/ios_to_android_sanitizer.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowMultipleReturnValues.
+Style/RedundantReturn:
+  Exclude:
+    - 'lib/ad_localize/option_handler.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: implicit, explicit
+Style/RescueStandardError:
+  Exclude:
+    - 'lib/ad_localize/repositories/drive_repository.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/SelfAssignment:
+  Exclude:
+    - 'lib/ad_localize/sanitizers/ios_to_android_sanitizer.rb'
+
+# Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/SlicingWithRange:
+  Exclude:
+    - 'lib/ad_localize/interactors/merge_wordings.rb'
+    - 'lib/ad_localize/mappers/locale_wording_to_hash.rb'
+    - 'lib/ad_localize/parsers/csv_parser.rb'
+
+# Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Mode.
+Style/StringConcatenation:
+  Exclude:
+    - 'lib/ad_localize/serializers/properties_serializer.rb'
+    - 'lib/ad_localize/serializers/strings_serializer.rb'
+    - 'lib/ad_localize/serializers/templated_serializer.rb'
+
+# Offense count: 85
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Enabled: false
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+Style/SymbolLiteral:
+  Exclude:
+    - 'lib/ad_localize/mappers/options_to_export_request.rb'
+    - 'test/option_handler_test.rb'
+
+# Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/ZeroLengthPredicate:
+  Exclude:
+    - 'lib/ad_localize/mappers/locale_wording_to_hash.rb'
+    - 'test/repositories/drive_repository_test.rb'
+
+# Offense count: 10
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 153

data/CHANGELOG.md

@@ -7,6 +7,37 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## 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
+- skip lines starting with a `#` character
+- new option `-l` or `--locales` to export only a subset or locales
+- Separate csv parse responsibility between key parser and csv parser
+- use Rubocop to detect coding style offenses (also in github workflow)
+- print warning log when a value is replaced during merge
+
+### Changed
+
+- parse csv in 2 steps : first analyze keys and keep them in a map, second add translations to keys
+- do not store empty values during parse if `-x` option is active
+- handle duplicate keys while parsing csv instead of while exporting for a platform
+- BREAKING CHANGE : the way to provide service account information is no longer to set GCLOUD_CLIENT_SECRET with the content of the service account configuration. Now you need to provide the path to the configuration using the environment variable GOOGLE_APPLICATION_CREDENTIALS
+- we no longer access to spreadsheet cells using GSheet v4. Now we downloaded all the relevant sheets and then we parse file contents like normal csv files. We use the exponentiel retry feature provided by google with a maximum of 3 attempts [more info here](https://github.com/googleapis/google-api-ruby-client/blob/377edf2ca4c1ef41a91de4176e5c7ad7df220007/google-apis-core/lib/google/apis/options.rb#L70). We noticed we had download error for 6 or more sheets in a spreadsheet.
+- locale wording stores separately each type of wording. This allows to export each wording type concurrently if you want to
+- no more plaform interactor. It has been replaced with generated file interactors. We still have an ios interactor because there are multiple files to export.
+- All templated serializers now share a common parent : `TemplatedSerializer`
+- Isolate the process to ensure a translation is correctly formatted for a platform in a new class type `sanitizers`. They can be tested separately.
+
+### Removed
+
+- no more GSpreadsheetOptions. It is handled directly in request
+
 ## [5.0.0] - 2022-07-26
 
 ### Added

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in ad_localize.gemspec

data/Gemfile.lock

@@ -1,53 +1,37 @@
 PATH
   remote: .
   specs:
-    ad_localize (5.0.0)
+    ad_localize (6.1.0)
       activesupport (>= 6.1.3.2, < 8.0)
       colorize (~> 0.8)
+      google-apis-drive_v3 (~> 0.33.0)
       google-apis-sheets_v4 (~> 0.9)
-      googleauth (~> 0.12)
-      nokogiri (~> 1.10)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3.1)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     ansi (1.5.0)
+    ast (2.4.2)
     builder (3.2.4)
     colorize (0.8.1)
     concurrent-ruby (1.1.10)
+    debug (1.7.1)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
     declarative (0.0.20)
     diffy (3.4.2)
-    faraday (1.10.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
+    faraday (2.7.2)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.4)
-      multipart-post (~> 2)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
-    google-apis-core (0.7.0)
+    faraday-net_http (3.0.2)
+    google-apis-core (0.9.4)
       addressable (~> 2.5, >= 2.5.1)
       googleauth (>= 0.16.2, < 2.a)
       httpclient (>= 2.8.1, < 3.a)
@@ -56,44 +40,63 @@ GEM
       retriable (>= 2.0, < 4.a)
       rexml
       webrick
-    google-apis-sheets_v4 (0.17.0)
-      google-apis-core (>= 0.7, < 2.a)
-    googleauth (0.17.1)
-      faraday (>= 0.17.3, < 2.0)
+    google-apis-drive_v3 (0.33.0)
+      google-apis-core (>= 0.9.1, < 2.a)
+    google-apis-sheets_v4 (0.21.0)
+      google-apis-core (>= 0.9.1, < 2.a)
+    googleauth (1.3.0)
+      faraday (>= 0.17.3, < 3.a)
       jwt (>= 1.4, < 3.0)
       memoist (~> 0.16)
       multi_json (~> 1.11)
       os (>= 0.9, < 2.0)
-      signet (~> 0.15)
+      signet (>= 0.16, < 2.a)
     httpclient (2.8.3)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    jwt (2.4.1)
+    io-console (0.6.0)
+    irb (1.6.2)
+      reline (>= 0.3.0)
+    json (2.6.3)
+    jwt (2.6.0)
     memoist (0.16.2)
     mini_mime (1.1.2)
-    mini_portile2 (2.8.0)
-    minitest (5.14.4)
-    minitest-reporters (1.4.2)
+    minitest (5.17.0)
+    minitest-reporters (1.5.0)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
     multi_json (1.15.0)
-    multipart-post (2.2.3)
-    nokogiri (1.13.8)
-      mini_portile2 (~> 2.8.0)
-      racc (~> 1.4)
     os (1.1.4)
-    public_suffix (4.0.7)
-    racc (1.6.0)
-    rake (12.3.3)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    reline (0.3.2)
+      io-console (~> 0.5)
     representable (3.2.0)
       declarative (< 0.1.0)
       trailblazer-option (>= 0.1.1, < 0.2.0)
       uber (< 0.2.0)
     retriable (3.1.2)
     rexml (3.2.5)
-    ruby-progressbar (1.10.1)
+    rubocop (1.43.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     signet (0.17.0)
       addressable (~> 2.8)
@@ -104,18 +107,21 @@ GEM
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     uber (0.1.0)
+    unicode-display_width (2.4.2)
     webrick (1.7.0)
 
 PLATFORMS
-  ruby
+  arm64-darwin-21
 
 DEPENDENCIES
   ad_localize!
   bundler (>= 1.12.0, < 3.0.0)
+  debug (>= 1.0.0, < 2.0)
   diffy (~> 3.3)
   minitest (~> 5.11)
   minitest-reporters (~> 1.3)
   rake (>= 12.3.0, < 14.0.0)
+  rubocop (~> 1.0)
 
 BUNDLED WITH
-   2.2.26
+   2.4.3

data/README.md

@@ -4,6 +4,11 @@ The purpose of this gem is to automatically generate wording files from a CSV in
 It supports iOS, Android, JSON, YAML and Java Properties.
 It is a useful tool when working on a mobile application or a SPA.
 
+## Migration from 5.x to 6.0.0
+
+When using the CLI replace `GCLOUD_CLIENT_SECRET=$(cat <path-to-client-secret.json>)` with `GOOGLE_APPLICATION_CREDENTIALS=<path-to-client-secret.json>`  
+When using the interactor refer to [ruby program usage section](###In-a-Ruby-program)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -43,12 +48,12 @@ $ ad_localize -k <your-spreadsheet-drive-key> -s <comma-separated-sheet-id-list>
 
 * Export wording from a private google spreadsheet. It requires a [Google Cloud Service Account](#using-a-google-cloud-service-account).
 ```
-$ GCLOUD_CLIENT_SECRET=$(cat <path-to-client-secret.json>) ad_localize -k <your-spreadsheet-drive-key>
+$ GOOGLE_APPLICATION_CREDENTIALS=<path-to-client-secret.json> ad_localize -k <your-spreadsheet-drive-key>
 ```
 
 * Export wording from all sheets in a google spreadsheet. It requires a [Google Cloud Service Account](#using-a-google-cloud-service-account).
 ```
-$ GCLOUD_CLIENT_SECRET=$(cat <path-to-client-secret.json>) ad_localize -k <your-spreadsheet-drive-key> -e
+$ GOOGLE_APPLICATION_CREDENTIALS=<path-to-client-secret.json> ad_localize -k <your-spreadsheet-drive-key> -e
 ```
 
 * Only generate wording files for the specified platforms
@@ -71,6 +76,16 @@ $ 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
+```
+
 ### In a Ruby program
 There are many possibilities when using AdLocalize in a ruby program. You can add support to your own wording format, support other platforms, select which locales you want to export, generate wording file content without writing on the disk and many more.
 
@@ -79,12 +94,22 @@ If you want more examples, please open a documentation issue.
 
 ```Ruby
     require 'ad_localize'
-    # create optional google spreasheet options
-    g_spreadsheet_options = AdLocalize::Requests::GSpreadsheetOptions.new(spreadsheet_id: 'some_id', sheet_ids: ['first', 'second'], service_account_config: ENV['GCLOUD_CLIENT_SECRET'])
     # create export request
-    export_request = AdLocalize::Requests::ExportRequest.new(g_spreadsheet_options: g_spreadsheet_options, verbose: true)
-    # execute request
-    AdLocalize::Interactors::ExecuteExportRequest.new.call(export_request: export_request)
+    export_request = Requests::ExportRequest.new
+    export_request.spreadsheet_id = 'some_id'
+    export_request.sheet_ids = %w[first second]
+    export_request.verbose = true
+    begin
+        # download files - be sure that GOOGLE_APPLICATION_CREDENTIALS is set if you use service account
+        export_request.downloaded_csvs = DownloadSpreadsheets.new.call(export_request: export_request)
+        # execute request
+        AdLocalize::Interactors::ExecuteExportRequest.new.call(export_request: export_request)
+    ensure
+        export_request.downloaded_csvs.each do |file|
+            file.close
+            file.unlink
+        end
+    end
 ```
 
 ## Accessing a google spreadsheet
@@ -106,12 +131,12 @@ To use a private google spreasheet you need to use a Google Cloud Service Accoun
     - In *IAM & Admin / Service Account*, the service account's email is listed. Invite it to the spreadsheet to export.
 
 ```
-$ GCLOUD_CLIENT_SECRET=$(cat <path-to-client-secrets>) ad_localize -k # one way
-$ GCLOUD_CLIENT_SECRET=$(cat <path-to-client-secrets>) ad_localize -k <your-spreadsheet-drive-key> -s <comma-separated-sheet-id-list> # another way
+$ GOOGLE_APPLICATION_CREDENTIALS=<path-to-client-secrets> ad_localize -k # one way
+$ GOOGLE_APPLICATION_CREDENTIALS=<path-to-client-secrets> ad_localize -k <your-spreadsheet-drive-key> -s <comma-separated-sheet-id-list> # another way
 ```
 
 ```
-$ export GCLOUD_CLIENT_SECRET=$(cat <path-to-client-secrets>)
+$ export GOOGLE_APPLICATION_CREDENTIALS=<path-to-client-secrets>
 $ ad_localize -k <your-spreadsheet-drive-key> # one way
 $ ad_localize -k <your-spreadsheet-drive-key> -s <comma-separated-sheet-id-list> # another way
 ```
@@ -121,6 +146,7 @@ $ ad_localize -k <your-spreadsheet-drive-key> -s <comma-separated-sheet-id-list>
 
 | key | fr | en |
 | --- | --- | --- |
+| # General |  |  |
 | agenda | agenda | events |
 | favorites | Mes favoris | My favorites |
 | from_to | du %1$@ au %2$@ | from %1$@ to %2$@ |
@@ -129,6 +155,7 @@ $ ad_localize -k <your-spreadsheet-drive-key> -s <comma-separated-sheet-id-list>
 - Keys should contain only letter, number, underscore and dot : [a-z0-9_.]+.
 - Format specifiers must be numeroted if there are more than one in a translation string (eg: `"%1$@ %2$@'s report"`).
 - _Only for Android_ keys without translation won't be considered
+- Lines starting with a comment will be ignored
 
 ### Comments
 

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "bundler/gem_tasks"
 require "rake/testtask"