fastlane-plugin-translate_gpt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d61950fe5af16ec1511687b4cab646b8397be0d4870a5e7c2a8d7f22adc06687
+  data.tar.gz: a04a4b37ba73505bdfea8d6ca7a1b6b0b63cd95f8e2856c9d237a21f513d0a91
+SHA512:
+  metadata.gz: 15b62929364a8be8f709c950d728a22ee72179a65aeffcb7a1156a23d3883404daf36219101b9aab8c2f0c8b12e22316d93a60407c9addaa72fdac5a1a68ca42
+  data.tar.gz: 6ac27ed65e2acca6a533ada325f1fe3e0756befd2fb803429b79864092a66eadaefff681a1eefd5fcd74e3f2b65bb87b301ded820a6541e628183df816a2a8ee

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Aleksei Cherepanov <ftp27host@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+![logo](images/logo.png)
+
+# translate-gpt plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-translate_gpt)
+[![Gem Version](https://badge.fury.io/rb/fastlane-plugin-translate_gpt.svg)](https://badge.fury.io/rb/fastlane-plugin-translate_gpt)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-translate_gpt`, add it to your project by running:
+
+```bash
+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.
+
+
+## Features
+
+- Automatically detects the source language and translates to the desired target language.
+- Can take contextual information, such as comments in your code, into account to improve translation accuracy.
+- Can automatically skip strings that are already translated, improving performance and reducing costs.
+
+## Example
+
+The following example demonstrates how to use `translate-gpt` in a `Fastfile` to translate an app's strings from English to French:
+
+```ruby
+lane :translate_strings do
+  translate_gpt(
+    api_key: 'YOUR_API_KEY',
+    target_language: 'fr'
+  )
+end
+```
+
+## Options
+
+The following options are available for `translate-gpt`:
+
+| Key | Description | Environment Variable |
+| --- | --- | --- |
+| `api_key` | The API key for your OpenAI GPT account. | `GPT_API_KEY` |
+| `model_name` | Name of the ChatGPT model to use | `GPT_MODEL_NAME` |
+| `temperature` | 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. Defaults to 0.5 | `GPT_TEMPERATURE` |
+| `request_timeout` | Timeout for the request in seconds. Defaults to 30 seconds | `GPT_REQUEST_TIMEOUT` |
+| `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` |
+
+## Authentication
+
+`translate-gpt` supports multiple authentication methods for the OpenAI GPT API:
+
+### API Key
+
+You can provide your API key directly as an option to `translate-gpt`:
+
+```ruby
+translate-gpt(
+  api_key: 'YOUR_API_KEY',
+  target_language: 'fr'
+)
+```
+
+### Environment Variable
+
+Alternatively, you can set the `GPT_API_KEY` environment variable with your API key:
+
+```bash
+export GPT_API_KEY='YOUR_API_KEY'
+```
+
+And then call `translate-gpt` without specifying an API key:
+
+```ruby
+translate-gpt(
+  target_language: 'fr'
+)
+```
+
+## Issues and Feedback
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide. For any other issues and feedback about this plugin, please submit it to this repository or contact the maintainers on [Twitter](https://twitter.com/ftp27host).
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).
+
+## Contributing
+
+If you'd like to contribute to this plugin, please fork the repository and make your changes. When you're ready, submit a pull request explaining your changes.
+
+## License
+
+This action is released under the [MIT License](LICENSE).

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

@@ -0,0 +1,167 @@
+require 'fastlane/action'
+require 'openai'
+require_relative '../helper/translate_gpt_helper'
+
+module Fastlane
+  module Actions
+    class TranslateGptAction < Action
+      def self.run(params)
+        client = OpenAI::Client.new(
+          access_token: params[:api_token],
+          request_timeout: params[:request_timeout]
+        )
+        
+        input_hash = Helper::TranslateGptHelper.get_strings(params[:source_file])
+        output_hash = Helper::TranslateGptHelper.get_strings(params[:target_file])
+
+        if params[:skip_translated]
+          to_translate = input_hash.reject { |k, v| output_hash[k] }
+        else 
+          to_translate = input_hash
+        end
+
+        UI.message "Translating #{input_hash.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)
+          if context && !context.empty?
+            prompt += "\n\nAdditional context:\n#{context}"
+          end
+          # translate the source string to the target language
+          response = client.chat(
+            parameters: {
+              model: params[:model_name], 
+              messages: [{ role: "user", content: prompt}], 
+              temperature: params[:temperature],
+            }
+          )
+          #puts response
+          # extract the translated string from the response
+          error = response.dig("error", "message")
+          if error
+            UI.error "Error translating #{key}: #{error}"
+          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
+            else
+              UI.warning "Unable to translate #{key} - #{value}"
+            end
+          end
+          Helper::TranslateGptHelper.timeout params[:request_timeout]
+        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
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Translate a strings file using OpenAI's GPT API"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :api_token,
+            env_name: "GPT_API_KEY",
+            description: "API token for ChatGPT",
+            sensitive: true,
+            code_gen_sensitive: true,
+            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"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :request_timeout,
+            env_name: "GPT_REQUEST_TIMEOUT",
+            description: "Timeout for the request in seconds",
+            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",
+            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",
+            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"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :target_language,
+            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",
+            verify_block: proc do |value|
+              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: :target_file,
+            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)
+              UI.user_error!("Translation file must have .strings extension") unless File.extname(value) == ".strings"
+            end
+          ),                         
+        ]
+      end
+
+      def self.output
+        [
+          ['TRANSLATED_STRING', 'The translated string'],
+          ['SOURCE_LANGUAGE', 'The source language of the string'],
+          ['TARGET_LANGUAGE', 'The target language of the translation']
+        ]
+      end
+
+      def self.return_value
+        # This action doesn't return any specific value, so we return nil
+        nil
+      end      
+
+      def self.authors
+        ["ftp27"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end      
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class TranslateGptHelper
+      # Read the strings file into a hash
+      # @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
+      end
+
+      # Get the context associated with a localization key
+      # @param localization_file [String] The path to the strings file
+      # @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
+      end
+
+      # Sleep for a specified number of seconds, displaying a progress bar
+      # @param seconds [Integer] The number of seconds to sleep
+      def self.timeout(total)
+        sleep_time = 0
+        while sleep_time < total
+          percent_complete = (sleep_time.to_f / total.to_f) * 100.0
+          progress_bar_width = 20
+          completed_width = (progress_bar_width * percent_complete / 100.0).round
+          remaining_width = progress_bar_width - completed_width
+          print "\rTimeout ["
+          print "=" * completed_width
+          print " " * remaining_width
+          print "] %.2f%%" % percent_complete
+          $stdout.flush
+          sleep(1)
+          sleep_time += 1
+        end
+        print "\r"
+        $stdout.flush
+      end
+    end
+  end
+end

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

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

data/lib/fastlane/plugin/translate_gpt.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/translate_gpt/version'
+
+module Fastlane
+  module TranslateGpt
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::TranslateGpt.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-translate_gpt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aleksei Cherepanov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.212.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.212.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: ftp27host@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/translate_gpt.rb
+- lib/fastlane/plugin/translate_gpt/actions/translate_gpt_action.rb
+- lib/fastlane/plugin/translate_gpt/helper/translate_gpt_helper.rb
+- lib/fastlane/plugin/translate_gpt/version.rb
+homepage: https://github.com/ftp27/fastlane-plugin-translate_gpt
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+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.
+test_files: []