ios_polyglot_cli 2.6.3 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbf65168fa336647874134dad8a81a0554b7bd98ee674a7a7eb1764d611b3d94
-  data.tar.gz: 1ee9b4e11181b47de8486e68e8ca3e055a1100e2d5997ba7a79ad8b5ba781322
+  metadata.gz: 4be5207295850180cb1f52a18f3506470d04835c814f149785521ddc00e1b6e0
+  data.tar.gz: 5b4b4b0747330f635752b940098d914929185e5980c3b38e0b785b7bfa819596
 SHA512:
-  metadata.gz: 893f8c0f382084b2d4d520854c68a598584a823fa6072ab78f552b96dcc90267f7e4b2613c755cb705481de60969ae9e9105517fca28fa8f239674e0707d4c69
-  data.tar.gz: eb2b12f270a44f675f6d01374212a5b94cfaf39714bd3d41178757951065c1577e1608a1d4c99a9a3631188c8ad6c2f51bd57b527ed35889c178ba54a0ddab88
+  metadata.gz: 0c103fce180c3bc47dd740b54e09eff019ee3a1fe5323bb89b8231e5f4c02350dc50a7f631f0b8bcee0d1e5c6e420a975f8988b03abcb04957a02b5e18ed10a9
+  data.tar.gz: 9cc61da2a0e77ebaaede23ed13599673ce96c59385de3cf80f5644ac8de6f87efae589208f51cc68b5ac46759333fd34fec5641c7496877501afb7bc7adf8a10

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ios_polyglot_cli (2.6.3)
+    ios_polyglot_cli (2.7.0)
       activesupport
       commander
       json_api_client
@@ -11,69 +11,58 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.1.3.2)
-      activesupport (= 7.1.3.2)
-    activesupport (7.1.3.2)
+    activemodel (7.2.2)
+      activesupport (= 7.2.2)
+    activesupport (7.2.2)
       base64
+      benchmark (>= 0.3)
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     base64 (0.2.0)
-    bigdecimal (3.1.7)
+    benchmark (0.4.0)
+    bigdecimal (3.1.8)
     byebug (11.1.3)
     coderay (1.1.3)
     commander (5.0.0)
       highline (~> 3.0.0)
-    concurrent-ruby (1.2.3)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     drb (2.2.1)
-    faraday (1.10.3)
-      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)
-      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)
-    faraday_middleware (1.2.0)
-      faraday (~> 1.0)
+    faraday (2.12.1)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-gzip (2.0.1)
+      faraday (>= 1.0)
+      zlib (~> 3.0)
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
     highline (3.0.1)
-    i18n (1.14.4)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
-    json_api_client (1.22.0)
-      activemodel (>= 3.2.0)
-      activesupport (>= 3.2.0)
+    json (2.8.2)
+    json_api_client (1.23.0)
+      activemodel (>= 6.0.0)
+      activesupport (>= 6.0.0)
       addressable (~> 2.2)
-      faraday (>= 0.15.2, < 2.0)
-      faraday_middleware (>= 0.9.0, < 2.0)
+      faraday (>= 1.10, < 3.0)
+      faraday-gzip (>= 1.0, < 3.0)
       rack (>= 0.2)
-    method_source (1.0.0)
-    minitest (5.22.3)
-    multipart-post (2.4.0)
-    mutex_m (0.2.0)
-    parallel (1.24.0)
+    logger (1.6.1)
+    method_source (1.1.0)
+    minitest (5.25.2)
+    net-http (0.5.0)
+      uri
+    parallel (1.26.3)
     pastel (0.8.0)
       tty-color (~> 0.5)
     pry (0.14.2)
@@ -82,10 +71,10 @@ GEM
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
-    public_suffix (5.0.4)
-    rack (3.0.9.1)
-    rake (13.1.0)
-    ruby2_keywords (0.0.5)
+    public_suffix (6.0.1)
+    rack (3.1.8)
+    rake (13.2.1)
+    securerandom (0.3.2)
     tty-color (0.6.0)
     tty-cursor (0.7.1)
     tty-prompt (0.23.1)
@@ -98,10 +87,12 @@ GEM
     tty-screen (0.8.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    uri (1.0.2)
     wisper (2.0.1)
+    zlib (3.2.0)
 
 PLATFORMS
-  arm64-darwin-21
+  arm64-darwin-24
 
 DEPENDENCIES
   bundler
@@ -110,4 +101,4 @@ DEPENDENCIES
   rake
 
 BUNDLED WITH
-   2.3.26
+   2.3.3

data/README.md

@@ -84,6 +84,27 @@ projects:
     sourceFilesPath: ./ProjectTwo/Sources/Translations/
 ```
 
+### Documentation Language Configuration
+
+To enable `polyglot` to document translations in a specific language, add a new flag called `documentationLanguage` to your `polyglot.yaml` file under the project requiring documentation. The `documentationLanguage` value should follow a locale format (e.g., `en_GB` for `en`).
+
+When running `polyglot`, it will attempt to find an exact match for the specified locale. If no match is found, `polyglot` will **abort the pull operation** and output a list of all supported language variations to the console for reference.
+
+If the `documentationLanguage` flag is not set in the `polyglot.yaml` file, `polyglot` will default to using the `defaultLanguage`. If the `defaultLanguage` is also unavailable, `polyglot` will default to the first language listed among the available languages for documentation.
+
+
+#### Example:
+```yaml
+# polyglot.yaml
+...
+:projects:
+- :id: '[projectId]'
+  :path: "[translationPath]"
+  :sourceFilesPath: "[sourceFilePath]"
+  :documentationLanguage: "en_GB"
+...
+```
+
 ### Legacy projects
 
 New style translations will create file names `en_US.strings` for example, and some old projects still use old naming in the style of `en.strings`. To get around this issue, you either need to migrate your project to use the new naming (be mindful of the existing app's settings), or add this line under your path value:

data/lib/ios_polyglot_cli/commands/pull.rb

@@ -16,8 +16,9 @@ module PolyglotIos
 
       def call
         prompt.say("Fetching translations...")
-        generate_translations(project_configs, programming_language, skip_writing_language_struct)
-        success("Translations successfully generated!")
+        if generate_translations(project_configs, programming_language, skip_writing_language_struct)
+          success("Translations successfully generated!")
+        end
       end
 
       private
@@ -25,17 +26,98 @@ module PolyglotIos
       def generate_translations(projects, programming_language, skip_writing_language_struct)
         projects.each do |project|
           project_id = project[:id]
+          project_fetched = pull_project(project_id)
           languages = pull_languages(project_id)
           translation_keys = pull_translation_keys(project_id)
+          documentation_language = project[:documentationLanguage]
+          default_language = project_fetched[0][:default_language_id]
+
+          translations = {}
+
+          if !documentation_language.nil?
+            language = find_documentation_language(documentation_language, languages)
+            if language.nil? 
+              prompt.say("ABORTED with reason: DocumentationLanguage must be correctly defined in the project configuration")
+              return {}
+            end
+
+            prompt.say("Found DocumentationLanguage: #{language[:name]}, documenting...")
+            translations = extract_translations_for_language(translation_keys, language)
+
+            if translations.empty?
+              prompt.say("No translations found for DocumentationLanguage: #{language[:name]}, ABORTING!!!") 
+              return false
+            end
+          else
+            language = find_default_language(default_language, languages)
+            if !language.nil?
+              translations = extract_translations_for_language(translation_keys, language)
+            end
+
+            if translations.empty? 
+              translations = {}
+            end
+          end
 
           write_translations(translation_keys, languages, project[:path], project[:useOldNaming])
+
           if !skip_writing_language_struct
             write_languages(languages, project[:sourceFilesPath], programming_language)
           end
-          write_translation_sources(translation_keys, project[:sourceFilesPath], programming_language)
+
+          write_translation_sources(translation_keys, project[:sourceFilesPath], programming_language, translations)
+          return true
+        end
+      end
+
+      def extract_translations_for_language(translation_keys, language) 
+          return PolyglotIos::Serializer::Translation
+            .extract_translations(translation_keys, language)
+      end
+
+      def find_language_by_locale_prefix(languages, locale_prefix)
+        languages.find do |language|
+          language[:locale].start_with?(locale_prefix)
         end
       end
 
+      def find_documentation_language(documentation_language, languages) 
+
+          #find documentation language
+          language = find_language_by_locale_prefix(languages, documentation_language)
+
+          if language.nil? 
+            prompt.say("===========================")
+            prompt.say("ERROR: Documentation language not found with prefix: = #{documentation_language}")
+            prompt.say("Possible language locales are: \n")
+
+            languages.each do |language| 
+              prompt.say("#{language[:name]} => #{language[:locale]}")
+            end
+            prompt.say("===========================")
+            return nil
+          end
+
+          return language
+      end
+
+      def find_default_language(default_language, languages)
+          #find default language
+          prompt.say("Find default_language with id: = #{default_language}")
+          language = languages.find { |language| language[:id] == default_language }
+          if language.nil?
+            prompt.say('Default language not found using first language')
+            # use first language
+            language = languages[0]
+            prompt.say('Using first language')
+          else
+            prompt.say('Using default language')
+          end
+
+          return language
+      end
+
+
       # Serializing data
 
       def write_translations(translation_keys, languages, translations_path, use_old_naming = false)
@@ -57,13 +139,16 @@ module PolyglotIos
         serializer.new(languages).save(sources_path)
       end
 
-      def write_translation_sources(translation_keys, sources_path, programming_language)
+      def write_translation_sources(translation_keys, sources_path, programming_language, translations)
         return if sources_path.to_s.empty?
         case programming_language.downcase
         when "swift"
           serializer = PolyglotIos::Serializer::Source::Swift
+
+          prompt.say("pull::write_translation_sources")
+
           serializer
-            .new(translation_keys)
+            .new(translation_keys, translations)
             .save(sources_path)
         end
       end
@@ -78,6 +163,14 @@ module PolyglotIos
         @option_site_url = @options.__hash__.fetch(:url, nil) || url
       end
 
+      def pull_project(project_id)
+        PolyglotIos::Resource::Project
+          .api_url(option_site_url)
+          .token(option_token)
+          .find(project_id)
+         
+      end
+
       def pull_languages(project_id)
         PolyglotIos::Resource::Language
           .api_url(option_site_url)

data/lib/ios_polyglot_cli/serializers/sources/sources_serializer_swift.rb

@@ -7,8 +7,9 @@ module PolyglotIos
       class Swift
         include ERB::Util
         
-        def initialize(translation_keys)
+        def initialize(translation_keys, translations)
           @translation_keys = translation_keys
+          @translations = translations
         end
         
         def render()
@@ -58,8 +59,9 @@ TEMPLATE
           @translation_keys.each do |translation_key|
             key_name = translation_key.name
             next if key_name.nil?
-            components = key_name.split(".")
-            root_enum.insert(components, key_name)
+            components = key_name.split(".") 
+            translation = @translations[key_name]
+            root_enum.insert(components, key_name, translation)
           end
 
           return root_enum

data/lib/ios_polyglot_cli/serializers/sources/swift_helpers/translation_case.rb

@@ -6,10 +6,12 @@ module PolyglotIos
 
         attr_accessor :name
         attr_accessor :value
+        attr_accessor :translation
 
-        def initialize(name, value)
+        def initialize(name, value, translation = nil)
           @name = name
           @value = value
+          @translation = translation
         end
 
         def serialized()
@@ -17,6 +19,13 @@ module PolyglotIos
           "public static let #{clean_name}: Strings = \"#{value}\""
         end
         
+        def serializedDefaultTranslation()
+          if !translation.nil?
+            return "/// Value: #{translation}"
+          end
+          return ""
+        end
+
       end
     end
   end

data/lib/ios_polyglot_cli/serializers/sources/swift_helpers/translation_enum.rb

@@ -15,11 +15,11 @@ module PolyglotIos
           @child_enums = []
         end
 
-        def insert(components, key_name)
+        def insert(components, key_name, translation)
           if components.count > 1
             insert_to_nested_enum(components, key_name)
           elsif components.count == 1
-            translation_case = TranslationCase.new(components.first, key_name)
+            translation_case = TranslationCase.new(components.first, key_name, translation)
             translations.push(translation_case)
           end
         end
@@ -39,6 +39,8 @@ module PolyglotIos
             .sort_by { |translation| translation.name.downcase }
             .each do |translation|
               output
+                .concat(indent(indent_level + 1, translation.serializedDefaultTranslation()))
+                .concat("\n")
                 .concat(indent(indent_level + 1, translation.serialized()))
                 .concat("\n")
             end

data/lib/ios_polyglot_cli/version.rb

@@ -1,3 +1,3 @@
 module PolyglotIos
-  VERSION = '2.6.3'
+  VERSION = '2.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ios_polyglot_cli
 version: !ruby/object:Gem::Version
-  version: 2.6.3
+  version: 2.7.0
 platform: ruby
 authors:
 - Filip Gulan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-22 00:00:00.000000000 Z
+date: 2024-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler