RubyGems - fastlane-plugin-translate_gpt - Versions diffs - 0.1.8.2 → 0.1.10 - Mend

fastlane-plugin-translate_gpt 0.1.8.2 → 0.1.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

checksums.yaml +4 -4
data/README.md +2 -0
data/lib/fastlane/plugin/translate_gpt/actions/translate_gpt_action.rb +65 -44
data/lib/fastlane/plugin/translate_gpt/helper/translate_gpt_helper.rb +73 -25
data/lib/fastlane/plugin/translate_gpt/version.rb +1 -1
metadata +9 -13

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b892379c42264401fe57500783b0b8ab2ad3b84ab81a5cd68e0e3c16250f74e1
-  data.tar.gz: 35e9901ddf7a0435cebaefd55393e45800731f4a5eaba81b5c8d49e848cec070
+  metadata.gz: 853d06eecad9456f758e4dbdf4e766345d4a266d5d199608112c0947077dbee1
+  data.tar.gz: 7c3f0d6cda2bd029dcd0d5bb8313cc20c8bab024c6786571808fc9fd511af6c8
 SHA512:
-  metadata.gz: 83d0ba21ea5b3df1ae37084401525638efc6ed04535b460a204e90d572208eace9717e7bcc0252806b7fa74a00ed9d8479d8bdb0e5ba7899453cfa523f17c067
-  data.tar.gz: 03527622c722c86560a2d386053dabd1740087e57639c96cb622f3146fcd3b258254db95c420a970e2d9636310621c6011486832b14e4d59eca72e1fb14a7989
+  metadata.gz: 0f9ed56771f0e68f22c6325c2b6829036f38e31591d6d0c2b0b6dbc6ba1ff72665ed857daca1be73327f0e97b71e4c53b93d9449a9f0a81e9e1973da4b826a74
+  data.tar.gz: cb4812f57b1fa109a52534311bcd3d414d30f4c181ea3d927912ea0f810f86d9dc1a3a88b53f2afcf0aefd784e3d1201d66988518dae8437d1f12ac30229d3c3

data/README.md CHANGED Viewed

@@ -54,6 +54,8 @@ The following options are available for `translate-gpt`:
 | `target_file` | The path to the output file for the translated strings. | `GPT_TARGET_FILE` |
 | `context` | Common context for the translation | `GPT_COMMON_CONTEXT` |
 | `bunch_size` | Number of strings to translate in a single request.| `GPT_BUNCH_SIZE` |
+| `max_input_tokens` | Maximum number of tokens in the input string. `bunch_size` will be ignored | `GPT_MAX_INPUT_TOKENS` |
+| `mark_for_review` | If string has been translated by GPT, mark it for review | `GPT_MARK_FOR_REVIEW` |
 **Note:** __I advise using `bunch_size`. It will reduce the number of API requests and translations will be more accurate.__

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

@@ -1,5 +1,4 @@
 require 'fastlane/action'
-require 'openai'
 require_relative '../helper/translate_gpt_helper'
 require 'loco_strings'
@@ -8,15 +7,18 @@ module Fastlane
     class TranslateGptAction < Action
       def self.run(params)
         helper = Helper::TranslateGptHelper.new(params)
-        helper.prepare_hashes()
-        bunch_size = params[:bunch_size]
+        helper.prepare_hashes
+        bunch_size = params[:bunch_size]
+        max_input_tokens = params[:max_input_tokens]
         helper.log_input(bunch_size)
-        if bunch_size.nil? || bunch_size < 1
-          helper.translate_strings()
-        else
+        if !max_input_tokens.nil? && max_input_tokens > 0
+          helper.translate_bunch_with_tokenizer(max_input_tokens)
+        elsif bunch_size.nil? || bunch_size < 1
+          helper.translate_strings
+        else
           helper.translate_bunch_of_strings(bunch_size)
         end
-        helper.write_output()
+        helper.write_output
       end
       #####################################################
@@ -31,89 +33,108 @@ module Fastlane
         [
           FastlaneCore::ConfigItem.new(
             key: :api_token,
-            env_name: "GPT_API_KEY",
-            description: "API token for ChatGPT",
+            env_name: 'GPT_API_KEY',
+            description: 'API token for ChatGPT',
             sensitive: true,
             code_gen_sensitive: true,
-            default_value: ""
+            default_value: ''
           ),
           FastlaneCore::ConfigItem.new(
             key: :model_name,
-            env_name: "GPT_MODEL_NAME",
-            description: "Name of the ChatGPT model to use",
-            default_value: "gpt-3.5-turbo"
+            env_name: 'GPT_MODEL_NAME',
+            description: 'Name of the ChatGPT model to use',
+            default_value: 'gpt-3.5-turbo'
           ),
           FastlaneCore::ConfigItem.new(
             key: :request_timeout,
-            env_name: "GPT_REQUEST_TIMEOUT",
-            description: "Timeout for the request in seconds",
+            env_name: 'GPT_REQUEST_TIMEOUT',
+            description: 'Timeout for the request in seconds',
             type: Integer,
             default_value: 30
           ),
           FastlaneCore::ConfigItem.new(
             key: :temperature,
-            env_name: "GPT_TEMPERATURE",
-            description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic",
+            env_name: 'GPT_TEMPERATURE',
+            description: 'What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic',
             type: Float,
             optional: true,
             default_value: 0.5
           ),
           FastlaneCore::ConfigItem.new(
             key: :skip_translated,
-            env_name: "GPT_SKIP_TRANSLATED",
-            description: "Whether to skip strings that have already been translated",
+            env_name: 'GPT_SKIP_TRANSLATED',
+            description: 'Whether to skip strings that have already been translated',
             type: Boolean,
             optional: true,
             default_value: true
           ),
           FastlaneCore::ConfigItem.new(
             key: :source_language,
-            env_name: "GPT_SOURCE_LANGUAGE",
-            description: "Source language to translate from",
-            default_value: "auto"
+            env_name: 'GPT_SOURCE_LANGUAGE',
+            description: 'Source language to translate from',
+            default_value: 'auto'
           ),
           FastlaneCore::ConfigItem.new(
             key: :target_language,
-            env_name: "GPT_TARGET_LANGUAGE",
-            description: "Target language to translate to",
-            default_value: "en"
+            env_name: 'GPT_TARGET_LANGUAGE',
+            description: 'Target language to translate to',
+            default_value: 'en'
           ),
           FastlaneCore::ConfigItem.new(
             key: :source_file,
-            env_name: "GPT_SOURCE_FILE",
-            description: "The path to the Localizable.strings file to be translated",
+            env_name: 'GPT_SOURCE_FILE',
+            description: 'The path to the Localizable.strings file to be translated',
             verify_block: proc do |value|
               UI.user_error!("Invalid file path: #{value}") unless File.exist?(value)
               extension = File.extname(value)
-              available_extensions = [".strings", ".xcstrings"]
-              UI.user_error!("Translation file must have any of these extensions: #{available_extensions}") unless available_extensions.include? extension
+              available_extensions = ['.strings', '.xcstrings']
+              unless available_extensions.include? extension
+                UI.user_error!("Translation file must have any of these extensions: #{available_extensions}")
+              end
             end
           ),
           FastlaneCore::ConfigItem.new(
             key: :target_file,
-            env_name: "GPT_TARGET_FILE",
-            description: "Path to the translation file to update",
+            env_name: 'GPT_TARGET_FILE',
+            description: 'Path to the translation file to update',
             verify_block: proc do |value|
               UI.user_error!("Invalid file path: #{value}") unless File.exist?(value)
               extension = File.extname(value)
-              available_extensions = [".strings", ".xcstrings"]
-              UI.user_error!("Translation file must have any of these extensions: #{available_extensions}") unless available_extensions.include? extension
+              available_extensions = ['.strings', '.xcstrings']
+              unless available_extensions.include? extension
+                UI.user_error!("Translation file must have any of these extensions: #{available_extensions}")
+              end
             end
-          ),
+          ),
           FastlaneCore::ConfigItem.new(
             key: :context,
-            env_name: "GPT_COMMON_CONTEXT",
-            description: "Common context for the translation",
+            env_name: 'GPT_COMMON_CONTEXT',
+            description: 'Common context for the translation',
             optional: true,
             type: String
-          ),
+          ),
           FastlaneCore::ConfigItem.new(
             key: :bunch_size,
-            env_name: "GPT_BUNCH_SIZE",
-            description: "Number of strings to translate in a single request",
+            env_name: 'GPT_BUNCH_SIZE',
+            description: 'Number of strings to translate in a single request',
             optional: true,
             type: Integer
-          ),
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :max_input_tokens,
+            env_name: 'GPT_MAX_INPUT_TOKENS',
+            description: 'Maximum number of tokens in the input request',
+            type: Integer,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :mark_for_review,
+            env_name: 'GPT_MARK_FOR_REVIEW',
+            description: 'If string has been translated by GPT, mark it for review',
+            type: Boolean,
+            optional: true,
+            default_value: false
+          ),
         ]
       end
@@ -128,15 +149,15 @@ module Fastlane
       def self.return_value
         # This action doesn't return any specific value, so we return nil
         nil
-      end
+      end
       def self.authors
-        ["ftp27"]
+        ['ftp27']
       end
       def self.is_supported?(platform)
-        [:ios, :mac].include?(platform)
-      end
+        %i[ios mac].include?(platform)
+      end
     end
   end
 end

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

@@ -1,6 +1,7 @@
 require 'fastlane_core/ui/ui'
 require 'loco_strings/parsers/xcstrings_file'
 require 'json'
+require 'openai'
 # rubocop:disable all
 module Fastlane
@@ -106,32 +107,78 @@ module Fastlane
         number_of_bunches = (@translation_count / bunch_size.to_f).ceil
         @keys_associations = {}
         @to_translate.each_slice(bunch_size) do |bunch|
-          prompt = prepare_bunch_prompt bunch
-          if prompt.empty?
-            UI.important "Empty prompt, skipping bunch"
+          begin
+            progress = (bunch_index / number_of_bunches.to_f * 100).round
+            request_bunch(bunch, progress)
+            bunch_index += 1
+          rescue "Empty prompt"
             next
           end
-          max_retries = 10
-          times_retried = 0
+          if bunch_index < number_of_bunches - 1 then wait end
+        end
+      end
-          # translate the source string to the target language
-          begin
-            request_bunch_translate(bunch, prompt, bunch_index, number_of_bunches)
-            bunch_index += 1
-          rescue Net::ReadTimeout => error
-            if times_retried < max_retries
-              times_retried += 1
-              UI.important "Failed to request translation, retry #{times_retried}/#{max_retries}"
-              wait 1
-              retry
-            else
-              UI.error "Can't translate the bunch: #{error}"
+      def translate_bunch_with_tokenizer(max_tokens)
+        string_index = 0
+        @keys_associations = {}
+        current_bunch = {}
+        @to_translate.each do |key, string|
+          string_index += 1
+          tmp_bunch = current_bunch.clone
+          tmp_bunch[key] = string
+          prompt = prepare_bunch_prompt tmp_bunch
+          tokens = OpenAI.rough_token_count(prompt)
+          if tokens > max_tokens
+            if current_bunch.empty?
+              string_index -= 1
+              UI.error "Can't translate #{key}: string is too long"
+              next
             end
+            prompt = prepare_bunch_prompt current_bunch
+            progress = (string_index / @translation_count.to_f * 100).round
+            request_bunch(bunch, progress)
+            current_bunch = {}
+            current_bunch[key] = string
+            if progress < 100 then wait end
+          else
+            current_bunch = tmp_bunch
           end
-          if bunch_index < number_of_bunches - 1 then wait end
         end
+        if !current_bunch.empty?
+          prompt = prepare_bunch_prompt current_bunch
+          progress = (string_index / @translation_count.to_f * 100).round
+          request_bunch(current_bunch, progress)
+        end
       end
+      def request_bunch(bunch, progress)
+        UI.message "[#{progress}%] Translating #{bunch.size} strings..."
+        prompt = prepare_bunch_prompt bunch
+        if prompt.empty?
+          UI.important "Empty prompt, skipping bunch"
+          raise "Empty prompt"
+        end
+        max_retries = 10
+        times_retried = 0
+        # translate the source string to the target language
+        begin
+          request_bunch_translate(bunch, prompt, progress)
+        rescue Net::ReadTimeout => error
+          if times_retried < max_retries
+            times_retried += 1
+            UI.important "Failed to request translation, retry #{times_retried}/#{max_retries}"
+            wait 1
+            retry
+          else
+            UI.error "Can't translate the bunch: #{error}"
+          end
+        end
+      end
       # Prepare the prompt for the GPT API
       def prepare_prompt(string)
         prompt = "I want you to act as a translator for a mobile application strings. " + \
@@ -160,7 +207,7 @@ module Fastlane
         json_hash = []
         strings.each do |key, string|
-          UI.message "Translating #{key} - #{string}"
+          # UI.message "Translating #{key} - #{string.value}"
           next if string.nil?
           string_hash = {}
@@ -228,7 +275,7 @@ module Fastlane
         end
       end
-      def request_bunch_translate(strings, prompt, index, number_of_bunches)
+      def request_bunch_translate(strings, prompt, progress)
         response = @client.chat(
           parameters: {
             model: @params[:model_name],
@@ -242,7 +289,7 @@ module Fastlane
         error = response.dig("error", "message")
         #key_log = Colorizer::colorize(key, :blue)
-        index_log = Colorizer::colorize("[#{index + 1}/#{number_of_bunches}]", :white)
+        index_log = Colorizer::colorize("[#{progress}%]", :white)
         if error
           UI.error "#{index_log} Error translating: #{error}"
         else
@@ -267,12 +314,12 @@ module Fastlane
             if translated_string.is_a? Hash
               strings = {}
               translated_string.each do |pl_key, value|
-                UI.message "#{index_log} Translating #{real_key} > #{pl_key} - #{value}"
+                UI.message "#{index_log} #{real_key}: #{pl_key} - #{value}"
                 strings[pl_key] = LocoStrings::LocoString.new(pl_key, value, context)
               end
               string = LocoStrings::LocoVariantions.new(real_key, strings, context)
             elsif translated_string && !translated_string.empty?
-              UI.message "#{index_log} Translating #{real_key} - #{translated_string}"
+              UI.message "#{index_log} #{real_key}: #{translated_string}"
               string = LocoStrings::LocoString.new(real_key, translated_string, context)
             end
             @output_hash[real_key] = string
@@ -299,13 +346,14 @@ module Fastlane
           end
           file.write
         else
+          default_state = if :mark_for_review then "needs_review" else "translated" end
           @xcfile.update_file_path(@params[:target_file])
           @output_hash.each do |key, value|
             if value.is_a? LocoStrings::LocoString
-              @xcfile.update(key, value.value, value.comment, "translated", @params[:target_language])
+              @xcfile.update(key, value.value, value.comment, default_state, @params[:target_language])
             elsif value.is_a? LocoStrings::LocoVariantions
               value.strings.each do |pl_key, variant|
-                @xcfile.update_variation(key, pl_key, variant.value, variant.comment, "translated", @params[:target_language])
+                @xcfile.update_variation(key, pl_key, variant.value, variant.comment, default_state, @params[:target_language])
               end
             end
           end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module TranslateGpt
-    VERSION = "0.1.8.2"
+    VERSION = '0.1.10'
   end
 end

metadata CHANGED Viewed

@@ -1,43 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-translate_gpt
 version: !ruby/object:Gem::Version
-  version: 0.1.8.2
+  version: 0.1.10
 platform: ruby
 authors:
 - Aleksei Cherepanov
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-12 00:00:00.000000000 Z
+date: 2025-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ruby-openai
+  name: loco_strings
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 0.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 0.1.5
 - !ruby/object:Gem::Dependency
-  name: loco_strings
+  name: ruby-openai
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4.1
+        version: 7.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4.1
+        version: 7.3.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -178,7 +177,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email: ftp27host@gmail.com
 executables: []
 extensions: []
@@ -197,7 +195,6 @@ metadata:
   homepage_uri: https://github.com/ftp27/fastlane-plugin-translate_gpt
   source_code_uri: https://github.com/ftp27/fastlane-plugin-translate_gpt
   github_repo: https://github.com/ftp27/fastlane-plugin-translate_gpt
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -212,8 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: This fastlane plugin provides an easy way to use the OpenAI GPT language
   model to translate strings in your iOS application.