fastlane-plugin-translate_gpt 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d61950fe5af16ec1511687b4cab646b8397be0d4870a5e7c2a8d7f22adc06687
-  data.tar.gz: a04a4b37ba73505bdfea8d6ca7a1b6b0b63cd95f8e2856c9d237a21f513d0a91
+  metadata.gz: d78d5a0107d725ae3b713c7e44f1b3aaca9eff005b1d5d2fb7e4ab75dbca40aa
+  data.tar.gz: 3b45a4747d8222ed5d0d9b7d04f178728e679609940e60dff556cbc7b65e1e99
 SHA512:
-  metadata.gz: 15b62929364a8be8f709c950d728a22ee72179a65aeffcb7a1156a23d3883404daf36219101b9aab8c2f0c8b12e22316d93a60407c9addaa72fdac5a1a68ca42
-  data.tar.gz: 6ac27ed65e2acca6a533ada325f1fe3e0756befd2fb803429b79864092a66eadaefff681a1eefd5fcd74e3f2b65bb87b301ded820a6541e628183df816a2a8ee
+  metadata.gz: e57f34690dea08a9eb24f7d1f975646c9500fccd983d933ff0b3a8809af91ce3b875e75691dfe7845f9aad88fcaeace425e8ead8dff3e09316c61d03ce5be682
+  data.tar.gz: e6e76c62b2ac4fe8b3b16d756bdd2acf4adb8d5ed35a626b9c0e5be3fb4e94511868e961f5261570af63640dafe714cf0d47fc8cc69f520b8e5b552ce27f67b2

data/README.md

@@ -15,7 +15,7 @@ fastlane add_plugin translate_gpt
 
 ## About translate-gpt
 
-`translate-gpt` is a fastlane plugin that allows you to easily translate your iOS app's strings using the OpenAI GPT API.
+`translate-gpt` is a fastlane plugin that allows you to easily translate your iOS and Android app's strings using the OpenAI GPT API.
 
 
 ## Features
@@ -50,8 +50,36 @@ The following options are available for `translate-gpt`:
 | `skip_translated` | Whether to skip strings that have already been translated. Defaults to `true`. | `GPT_SKIP_TRANSLATED` |
 | `source_language` | The source language of the strings to be translated. Defaults to auto-detection. | `GPT_SOURCE_LANGUAGE` |
 | `target_language` | The target language of the translated strings. Required. | `GPT_TARGET_LANGUAGE` |
-| `source_file` | The path to the `Localizable.strings` file to be translated. Defaults to `./Resources/Localizable.strings`. | `GPT_SOURCE_FILE` |
-| `target_file` | The path to the output file for the translated strings. Defaults to `./Resources/Localizable.strings.<target_language>`. | `GPT_TARGET_FILE` |
+| `source_file` | The path to the `Localizable.strings` or `strings.xml` file to be translated. | `GPT_SOURCE_FILE` |
+| `target_file` | The path to the output file for the translated strings. | `GPT_TARGET_FILE` |
+| `context` | Common context for the translation | `GPT_COMMON_CONTEXT` |
+
+## Providing context
+
+The `TranslateGptAction` allows you to provide additional context for your translation requests in two ways:
+
+### 1. Using a common context
+
+You can provide a common context for your project that will be used in all translation requests. This can be done by setting the `common` property when calling the `TranslateGptAction`. The `common` property should be a string that describes the context of your project.
+
+```ruby
+translate_gpt(
+  target_language: 'fr',
+  common: "This is a mobile app for ordering food online"
+)
+```
+
+### 2. Adding comments for specific keys
+
+You can also add comments to your Localizable.strings file for specific keys. These comments will be included in the translation request for that key. To add a comment for a specific key, simply include a comment before the key in your Localizable.strings file.
+
+```text
+/* This is a comment for KEY1 */
+"KEY1" = "Value for KEY1";
+```
+
+When you run the `TranslateGptAction`, the comment will be included in the translation request for `KEY1`.
+
 
 ## Authentication
 

data/lib/fastlane/plugin/translate_gpt/actions/translate_gpt_action.rb

@@ -1,6 +1,7 @@
 require 'fastlane/action'
 require 'openai'
 require_relative '../helper/translate_gpt_helper'
+require 'loco_strings'
 
 module Fastlane
   module Actions
@@ -20,14 +21,17 @@ module Fastlane
           to_translate = input_hash
         end
 
-        UI.message "Translating #{input_hash.size} strings..."
+        UI.message "Translating #{to_translate.size} strings..."
 
-        to_translate.each do |key, value|
-          prompt = "Translate the following string from #{params[:source_language]} to #{params[:target_language]}:\n#{value}"
-          context = Helper::TranslateGptHelper.get_context(params[:source_file], key)
+        to_translate.each_with_index do |(key, string), index|
+          prompt = "Translate the following string from #{params[:source_language]} to #{params[:target_language]}: #{string.value}"
+          context = string.comment
           if context && !context.empty?
             prompt += "\n\nAdditional context:\n#{context}"
           end
+          if params[:context] && !params[:context].empty?
+            prompt += "\n\nCommon context:\n#{params[:context]}"
+          end
           # translate the source string to the target language
           response = client.chat(
             parameters: {
@@ -36,7 +40,6 @@ module Fastlane
               temperature: params[:temperature],
             }
           )
-          #puts response
           # extract the translated string from the response
           error = response.dig("error", "message")
           if error
@@ -44,23 +47,26 @@ module Fastlane
           else
             target_string = response.dig("choices", 0, "message", "content")
             if target_string && !target_string.empty?
-              UI.message "Translating #{key} - #{value} -> #{target_string}"
-              output_hash[key] = target_string
+              UI.message "Translating #{key} - #{string.value} -> #{target_string}"
+              string.value = target_string
+              output_hash[key] = string
             else
-              UI.warning "Unable to translate #{key} - #{value}"
+              UI.warning "Unable to translate #{key} - #{string.value}"
             end
           end
-          Helper::TranslateGptHelper.timeout params[:request_timeout]
+          if index < to_translate.size - 1
+            Helper::TranslateGptHelper.timeout params[:request_timeout]
+          end
         end
 
         UI.message "Writing #{output_hash.size} strings to #{params[:target_file]}..."
 
-        # write the output hash to the output file
-        File.open(params[:target_file], "w") do |file|
-          output_hash.each do |key, value|
-            file.puts "\"#{key}\" = \"#{value}\";"
-          end
+        file = LocoStrings.load(params[:target_file])
+        file.read
+        output_hash.each do |key, value|
+          file.update(key, value.value, value.comment)
         end
+        file.write
       end
 
       #####################################################
@@ -138,7 +144,14 @@ module Fastlane
               UI.user_error!("Invalid file path: #{value}") unless File.exist?(value)
               UI.user_error!("Translation file must have .strings extension") unless File.extname(value) == ".strings"
             end
-          ),                         
+          ),    
+          FastlaneCore::ConfigItem.new(
+            key: :context,
+            env_name: "GPT_COMMON_CONTEXT",
+            description: "Common context for the translation",
+            optional: true,
+            type: String
+          )                     
         ]
       end
 

data/lib/fastlane/plugin/translate_gpt/helper/translate_gpt_helper.rb

@@ -1,4 +1,5 @@
 require 'fastlane_core/ui/ui'
+require 'loco_strings'
 
 module Fastlane
   UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
@@ -9,16 +10,8 @@ module Fastlane
       # @param localization_file [String] The path to the strings file
       # @return [Hash] The strings file as a hash
       def self.get_strings(localization_file)
-        # Read the strings file into a hash
-        strings_file = File.read(localization_file)
-        strings_hash = strings_file.split(/\n/).reduce({}) do |hash, line|
-          match = line.match(/^"(.+)" = "(.+)";$/)
-          if match
-            hash[match[1]] = match[2]
-          end
-          hash
-        end
-        return strings_hash
+        file = LocoStrings.load(localization_file)
+        return file.read
       end
 
       # Get the context associated with a localization key
@@ -26,20 +19,9 @@ module Fastlane
       # @param localization_key [String] The localization key
       # @return [String] The context associated with the localization key
       def self.get_context(localization_file, localization_key)
-        # read the localization file
-        content = File.read(localization_file)
-
-        # search for the comments associated with the localization key
-        regex = /\/\*\*\n\s*\* @key\s+#{localization_key}\n((\s*\*.*\n)+)\s*\*\/\n\s*"#{localization_key}"/
-        match = content.match(regex)
-
-        # return the comments, if found
-        if match && match.captures.size > 0
-          comments = match.captures[0].strip
-          return comments.gsub(/\n\s*\*\s?/, "\n").strip
-        else
-          return nil
-        end
+        file = LocoStrings.load(localization_file)
+        string = file.read[localization_key]
+        return string.comment
       end
 
       # Sleep for a specified number of seconds, displaying a progress bar

data/lib/fastlane/plugin/translate_gpt/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module TranslateGpt
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-translate_gpt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Aleksei Cherepanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-23 00:00:00.000000000 Z
+date: 2023-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: loco_strings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement