better_translate 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 861e9d3d1401025d2e12487f5fb6aa4e81cd67b90aa08a0a022d135eb4b71371
-  data.tar.gz: 26ff1894216353f54a8e2f60e9563526ac42da9c9cdc0ae71c4b5bed73c8debc
+  metadata.gz: 1110968d8e49f85d5231775f9c05fcbca610021a33723999c75246b687f56b77
+  data.tar.gz: 255e51ff5e5105ebf314b703d9aa841c66eaa6b0ffb5ca1f631ea2cbe81ab6db
 SHA512:
-  metadata.gz: 4082ac26837e5adb8e9b96f2f8738b61219780df6234ce25646f7bcde53faa4848abfb0cb20e0d9063e4ffab789ede5f305ebeb0cf52d7898fb58c67cb68237c
-  data.tar.gz: 66d7e88dbcd40785676ce17168ce177e29a948b7ddc7aa741bca2ed852aeee90fe98e713e28e74b5008da92ad613f6306046fda81be59ac7491b966ef1fcb579
+  metadata.gz: b971940521bce1ad359990e13fe7d17a339f9d5e62fe5ea9b565fe1ffbd51fe2c2dd24789cd02b7e838a20a3ae88de919ed529adf325b3c11d7377c6bced68e5
+  data.tar.gz: 1d8d785607ba4439df35ceb70b0c302ba1944bfdd74e197d2686cbe7781cfab55bfc93ed7a2affa9ef50b5fc1a459034b1d3cdf6f60420cb2df1b0252d5e3ac5

data/README.md

@@ -22,6 +22,9 @@ Configuration is centralized via an initializer (for example, in a Rails app), w
 - **Rails Generators**: 
   - `rails generate better_translate:install` to generate the initializer.
   - `rails generate better_translate:translate` to trigger the translation process directly from your Rails app.
+- **Translation Helpers**: 
+  - `translate_text_to_languages` for translating a single text into multiple target languages.
+  - `translate_texts_to_languages` for translating an array of texts into multiple target languages.
 
 ## Installation
 
@@ -95,7 +98,7 @@ BetterTranslate.configure do |config|
   config.input_file = Rails.root.join("config", "locales", "en.yml").to_s
   
   # Translation mode: :override or :incremental
-  config.translation_method = :override
+  config.translation_mode = :override
 end
 ```
 
@@ -134,13 +137,66 @@ The gem includes generators to simplify tasks:
 
   The `better_translate:translate` generator will trigger the translation process (via `BetterTranslate.magic`) and display progress in the terminal.
 
-## Contact & Feature Requests
+### Translation Helpers
 
-For suggestions, bug reports, or to request new features, please reach out via email at: **alessio.bussolari@pandev.it**.
+BetterTranslate provides helper methods to simplify translation tasks.
+
+#### Single Text Translation
+
+The `translate_text_to_languages` helper allows you to translate a single text into multiple target languages in one call.
+
+**Example Usage:**
+
+```ruby
+text = "Hello world!"
+target_languages = [
+  { short_name: "it", name: "Italian" },
+  { short_name: "fr", name: "French" }
+]
+
+translated = BetterTranslate::TranslationHelper.translate_text_to_languages(
+  text,
+  target_languages,
+  "en",       # source language code
+  :chatgpt    # provider: can be :chatgpt or :gemini
+)
+
+puts translated
+# Expected output:
+# { "it" => "Ciao mondo!", "fr" => "Bonjour le monde!" }
+```
 
-## Upcoming Features
+#### Multiple Texts Translation
 
-- **Helper Methods**: Additional helper methods to integrate BetterTranslate as a translation system for dynamic content.
+The `translate_texts_to_languages` helper extends the functionality to translate an array of texts into multiple target languages. It returns a hash where each key is a target language code and the value is an array of translated texts.
+
+**Example Usage:**
+
+```ruby
+texts = ["Hello world!", "How are you?"]
+target_languages = [
+  { short_name: "it", name: "Italian" },
+  { short_name: "fr", name: "French" }
+]
+
+translated_texts = BetterTranslate::TranslationHelper.translate_texts_to_languages(
+  texts,
+  target_languages,
+  "en",       # source language code
+  :chatgpt    # provider: can be :chatgpt or :gemini
+)
+
+puts translated_texts
+# Expected output:
+# {
+#   "it" => ["Ciao mondo!", "Come stai?"],
+#   "fr" => ["Bonjour le monde!", "Comment ça va?"]
+# }
+```
+
+## Contact & Feature Requests
+
+For suggestions, bug reports, or to request new features, please reach out via email at: **alessio.bussolari@pandev.it**.
 
 ## Conclusions
 
@@ -150,4 +206,4 @@ For more details, please visit the [GitHub repository](https://github.com/alessi
 
 ## License
 
-BetterTranslate is distributed under the MIT license. See the [LICENSE](LICENSE) file for more details.
+BetterTranslate is distributed under the MIT license. See the [LICENSE](LICENSE) file for more details.

data/lib/better_translate/helper.rb

@@ -0,0 +1,75 @@
+module BetterTranslate
+  class Helper
+    class << self
+      # Translates a given text into multiple target languages.
+      #
+      # @param text [String] The text to be translated.
+      # @param target_languages [Array<Hash>] Array of target language hashes,
+      #   e.g. [{ short_name: "it", name: "Italian" }, { short_name: "fr", name: "French" }]
+      # @param source_language [String] The source language code (e.g., "en").
+      # @param provider_name [Symbol] The provider to use (e.g., :chatgpt or :gemini).
+      # @return [Hash] A hash where each key is a target language code and the value is the translated text.
+      #
+      # Example:
+      #   translated = BetterTranslate::Helpers.translate_text_to_languages(
+      #     "Hello world!",
+      #     [{ short_name: "it", name: "Italian" }, { short_name: "fr", name: "French" }],
+      #     "en",
+      #     :chatgpt
+      #   )
+      #   # => { "it" => "Ciao mondo!", "fr" => "Bonjour le monde!" }
+      def translate_text_to_languages(text, target_languages, source_language, provider_name)
+        provider_instance = case provider_name
+                            when :chatgpt
+                              Providers::ChatgptProvider.new(BetterTranslate.configuration.openai_key)
+                            when :gemini
+                              Providers::GeminiProvider.new(BetterTranslate.configuration.google_gemini_key)
+                            else
+                              raise "Provider not supported: #{provider_name}"
+                            end
+
+        result = {}
+        target_languages.each do |lang|
+          # Optionally, you could also pass the source_language if needed by your provider.
+          translated_text = provider_instance.translate(text, lang[:short_name], lang[:name])
+          result[lang[:short_name]] = translated_text
+        end
+        result
+      end
+
+      # Translates an array of texts into multiple target languages using the translate_text_to_languages helper.
+      #
+      # @param texts [Array<String>] An array of texts to translate.
+      # @param target_languages [Array<Hash>] Array of target language hashes,
+      #   e.g. [{ short_name: "it", name: "Italian" }, { short_name: "fr", name: "French" }].
+      # @param source_language [String] The source language code (e.g., "en").
+      # @param provider_name [Symbol] The provider to use (e.g., :chatgpt or :gemini).
+      # @return [Hash] A hash where each key is a target language code and the value is an array of translated texts.
+      #
+      # Example:
+      #   texts = ["Hello world!", "How are you?"]
+      #   result = BetterTranslate::TranslationHelper.translate_texts_to_languages(
+      #     texts,
+      #     [{ short_name: "it", name: "Italian" }, { short_name: "fr", name: "French" }],
+      #     "en",
+      #     :chatgpt
+      #   )
+      #   # => { "it" => ["Ciao mondo!", "Come stai?"], "fr" => ["Bonjour le monde!", "Comment ça va?"] }
+      def translate_texts_to_languages(texts, target_languages, source_language, provider_name)
+        result = {}
+        target_languages.each do |lang|
+          # For each target language, translate each text and collect translations into an array.
+          result[lang[:short_name]] = texts.map do |text|
+            translation_hash = translate_text_to_languages(text, [lang], source_language, provider_name)
+            translation_hash[lang[:short_name]]
+          end
+        end
+        result
+      end
+    end
+  end
+end
+
+__END__
+
+translated = BetterTranslate::Helper.translate_text_to_languages("Hello world!",[{ short_name: "it", name: "Italian" }, { short_name: "fr", name: "French" }],"en",:chatgpt)

data/lib/better_translate/utils.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# lib/better_seeder/utils.rb
+#
+# = BetterSeeder::Utils
+#
+# Questo modulo fornisce metodi di utilità per la gestione dei seed. In particolare,
+# consente di trasformare i nomi delle classi in formato snake_case con il suffisso "_structure.rb",
+# gestire i messaggi di log e configurare il livello del logger per ActiveRecord.
+
+module BetterTranslate
+  class Utils
+    class << self
+      ##
+      # Registra un messaggio usando il logger di Rails se disponibile, altrimenti lo stampa su standard output.
+      #
+      # ==== Parametri
+      # * +message+ - Il messaggio da loggare (può essere una stringa o nil).
+      #
+      # ==== Ritorno
+      # Non ritorna un valore significativo.
+      #
+      def logger(message: nil)
+        if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
+          Rails.logger.info message
+        else
+          puts message
+        end
+      end
+    end
+  end
+end

data/lib/better_translate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BetterTranslate
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/better_translate.rb

@@ -2,9 +2,11 @@
 require "ruby-progressbar"
 
 require "better_translate/version"
+require "better_translate/utils"
 require "better_translate/translator"
 require "better_translate/service"
 require "better_translate/writer"
+require "better_translate/helper"
 
 require 'better_translate/providers/base_provider'
 require 'better_translate/providers/chatgpt_provider'
@@ -23,7 +25,8 @@ module BetterTranslate
     # Metodo install per generare il file di configurazione (initializer)
     def install
       unless defined?(Rails) && Rails.respond_to?(:root)
-        puts "Il metodo install è disponibile solo in un'applicazione Rails."
+        message = "Il metodo install è disponibile solo in un'applicazione Rails."
+        BetterTranslate::Utils.logger(message: message)
         return
       end
 
@@ -32,19 +35,23 @@ module BetterTranslate
       destination = File.join(Rails.root, "config", "initializers", "better_translate.rb")
 
       if File.exist?(destination)
-        puts "Il file initializer esiste già: #{destination}"
+        message = "Il file initializer esiste già: #{destination}"
+        BetterTranslate::Utils.logger(message: message)
       else
         FileUtils.mkdir_p(File.dirname(destination))
         FileUtils.cp(source, destination)
-        puts "Initializer creato in: #{destination}"
+        message = "Il file initializer esiste già: #{destination}"
+        BetterTranslate::Utils.logger(message: message)
       end
     end
 
     def magic
-      puts "Metodo magic invocato: eseguirò la traduzione dei file..."
+      message = "Metodo magic invocato: eseguirò la traduzione dei file..."
+      BetterTranslate::Utils.logger(message: message)
 
       BetterTranslate::Translator.work
-      puts "Metodo magic invocato: Traduzione completata con successo!"
+      message = "Metodo magic invocato: Traduzione completata con successo!"
+      BetterTranslate::Utils.logger(message: message)
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: better_translate
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - alessio_bussolari
@@ -80,15 +80,14 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-description: "\nBetterTranslate è una gemma che consente di tradurre file YAML partendo
-  da una lingua sorgente verso una o più lingue target.\nLa gemma supporta differenti
-  provider di traduzione, attualmente ChatGPT (OpenAI) e Google Gemini, e permette
-  di scegliere\nla modalità di traduzione: \"override\" per rigenerare tutte le traduzioni
-  oppure \"incremental\" per aggiornare solo le chiavi mancanti.\n\nLa configurazione
-  della gemma è centralizzata tramite un initializer, dove è possibile definire API
-  key, lingue target, lingua sorgente,\nesclusioni di chiavi e la cartella di output.
-  BetterTranslate integra inoltre il monitoraggio del progresso della traduzione tramite
-  una progress bar.\n  "
+description: "\nBetterTranslate is a gem that allows you to translate YAML files from
+  a source language into one or more target languages.\nThe gem supports different
+  translation providers, currently ChatGPT (OpenAI) and Google Gemini, and allows
+  you to choose\nthe translation mode: \"override\" to regenerate all translations
+  or \"incremental\" to update only the missing keys.\n\nThe gem's configuration is
+  centralized via an initializer, where you can define API keys, target languages,
+  source language,\nkey exclusions, and the output folder. BetterTranslate also integrates
+  translation progress tracking using a progress bar.\n  "
 email:
 - alessio.bussolari@pandev.it
 executables: []
@@ -98,11 +97,13 @@ files:
 - LICENSE.txt
 - README.md
 - lib/better_translate.rb
+- lib/better_translate/helper.rb
 - lib/better_translate/providers/base_provider.rb
 - lib/better_translate/providers/chatgpt_provider.rb
 - lib/better_translate/providers/gemini_provider.rb
 - lib/better_translate/service.rb
 - lib/better_translate/translator.rb
+- lib/better_translate/utils.rb
 - lib/better_translate/version.rb
 - lib/better_translate/writer.rb
 - lib/generators/better_translate/install_generator.rb
@@ -135,5 +136,6 @@ requirements: []
 rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: Gemma per tradurre file YAML in più lingue tramite provider (ChatGPT e Gemini)
+summary: Gem for translating YAML files into multiple languages using providers (ChatGPT
+  and Gemini)
 test_files: []