better_translate 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac3bc8d98853820f1c6367bbbe4fb36733a872de35eef7ff8bc47349fc9376e5
-  data.tar.gz: fa486ddb0bf587faee2792bbca54982ddbdffcc44b4b183e9c0de1c849f917b7
+  metadata.gz: 861e9d3d1401025d2e12487f5fb6aa4e81cd67b90aa08a0a022d135eb4b71371
+  data.tar.gz: 26ff1894216353f54a8e2f60e9563526ac42da9c9cdc0ae71c4b5bed73c8debc
 SHA512:
-  metadata.gz: 643e1688cc0171ddee6bfeb848aa1d555922bf2c44907afc56981ea0b5c9dd9ce8fa5788b509596eb53735cd4ce63e1adbccaeb1592f5cb3d1653da794a0c415
-  data.tar.gz: ea2451b736c946d2bead72f3bf36dab06fb38e2037662c160a400f73a1854919314bfecb0a5081b63add8b7a66b1402ae85b3cfa42af10149cb9faf9677fba90
+  metadata.gz: 4082ac26837e5adb8e9b96f2f8738b61219780df6234ce25646f7bcde53faa4848abfb0cb20e0d9063e4ffab789ede5f305ebeb0cf52d7898fb58c67cb68237c
+  data.tar.gz: 66d7e88dbcd40785676ce17168ce177e29a948b7ddc7aa741bca2ed852aeee90fe98e713e28e74b5008da92ad613f6306046fda81be59ac7491b966ef1fcb579

data/README.md

@@ -3,26 +3,33 @@
 BetterTranslate is a Ruby gem that enables you to translate YAML files from a source language into one or more target languages using translation providers such as ChatGPT (OpenAI) and Google Gemini. The gem supports two translation modes:
 
 - **Override**: Completely rewrites the translated file.
-- **Incremental**: Updates the translated file only with new or modified keys while keeping existing ones.
+- **Incremental**: Updates the translated file only with new or modified keys while keeping the existing ones.
 
 Configuration is centralized via an initializer (for example, in a Rails app), where you can set API keys, the source language, target languages, key exclusions, the output folder, and the translation mode. Additionally, BetterTranslate integrates progress tracking using the [ruby-progressbar](https://github.com/jfelchner/ruby-progressbar) gem.
 
 ## Features
 
 - **Multi-language YAML Translation**: Translates YAML files from a source language into one or more target languages.
-- **Multiple Providers**: Supports ChatGPT (OpenAI) and Google Gemini (with potential for extending to other providers in the future).
-- **Translation Modes**:
-    - **Override**: Rewrites the file from scratch.
-    - **Incremental**: Updates only missing or modified keys.
+- **Multiple Providers**: Supports ChatGPT (OpenAI) and Google Gemini (with potential for extension to other providers in the future).
+- **Translation Modes**: 
+  - **Override**: Rewrites the file from scratch.
+  - **Incremental**: Updates only missing or modified keys.
 - **Centralized Configuration**: Configured via an initializer with settings for API keys, source language, target languages, exclusions (using dot notation), and the output folder.
-- **Progress Bar**: Displays the translation progress using ruby-progressbar.
+- **Two-Step Exclusion Filtering**: 
+  - **Global Exclusions**: Removes keys defined in `global_exclusions` from the entire YAML structure.
+  - **Language-Specific Exclusions**: Applies additional filtering using the `exclusions_per_language` map for each target language.
+- **Progress Bar**: Displays translation progress using ruby-progressbar.
+- **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.
 
 ## Installation
 
 Add the gem to your Gemfile:
 
 ```ruby
-gem 'better_translate'
+gem 'better_translate', '~> 0.1.0'
+```
 
 Then run:
 
@@ -50,38 +57,43 @@ This command creates the file `config/initializers/better_translate.rb` with a d
 BetterTranslate.configure do |config|
   # Choose the provider to use: :chatgpt or :gemini
   config.provider = :chatgpt
-
+  
   # API key for ChatGPT (OpenAI)
   config.openai_key = ENV.fetch("OPENAI_API_KEY") { "YOUR_OPENAI_API_KEY" }
-
+  
   # API key for Google Gemini
   config.google_gemini_key = ENV.fetch("GOOGLE_GEMINI_KEY") { "YOUR_GOOGLE_GEMINI_KEY" }
-
+  
   # Source language (e.g., "en" if the source file is in English)
   config.source_language = "en"
-
+  
   # Output folder where the translated files will be saved
   config.output_folder = Rails.root.join("config", "locales", "translated").to_s
-
+  
   # List of target languages (short_name and name)
   config.target_languages = [
     # Example:
     { short_name: "it", name: "italian" }
   ]
-
+  
   # Global exclusions (keys in dot notation) to exclude from translation
   config.global_exclusions = [
-    "key.child_key",
+    "key.child_key"
   ]
-
-  # Language-specific exclusions (optional)
+  
+  # Language-specific exclusions: keys to exclude only for specific target languages
   config.exclusions_per_language = {
+    "es" => [],
+    "it" => ["sample.valid"],
+    "fr" => [],
+    "de" => [],
+    "pt" => [],
     "ru" => []
   }
-
+  
   # Path to the input file (e.g., en.yml)
   config.input_file = Rails.root.join("config", "locales", "en.yml").to_s
-
+  
   # Translation mode: :override or :incremental
   config.translation_method = :override
 end
@@ -89,7 +101,7 @@ end
 
 ## Usage
 
-### YAML File Translation
+### Translating YAML Files
 
 To start the translation process, simply call the `magic` method:
 
@@ -99,17 +111,42 @@ BetterTranslate.magic
 
 This will execute the process that:
 1. Reads the input YAML file.
-2. Applies any filters (exclusions).
-3. Translates the strings from the source language to the configured target languages.
-4. Writes the translated files to the output folder, either in **override** or **incremental** mode based on the configuration.
+2. Applies the global exclusion filtering.
+3. Applies additional language-specific exclusion filtering for each target language.
+4. Translates the strings from the source language into the configured target languages.
+5. Writes the translated files to the output folder, either in **override** or **incremental** mode based on the configuration.
+
+### Using Rails Generators
+
+The gem includes generators to simplify tasks:
+
+- **Generate Initializer:**
+
+  ```bash
+  rails generate better_translate:install
+  ```
+
+- **Trigger Translation Process:**
+
+  ```bash
+  rails generate better_translate:translate
+  ```
+
+  The `better_translate:translate` generator will trigger the translation process (via `BetterTranslate.magic`) and display progress in the terminal.
+
+## Contact & Feature Requests
+
+For suggestions, bug reports, or to request new features, please reach out via email at: **alessio.bussolari@pandev.it**.
+
+## Upcoming Features
 
-## Contributing
+- **Helper Methods**: Additional helper methods to integrate BetterTranslate as a translation system for dynamic content.
 
-Pull requests are welcome! If you would like to suggest improvements or new features, please open an issue to discuss your ideas before submitting a pull request.
+## Conclusions
 
-## Changelog
+BetterTranslate aims to simplify the translation of YAML files in Ruby projects by providing a flexible, configurable, and extensible system. Whether you need a complete file rewrite or an incremental update, BetterTranslate streamlines the translation process using advanced providers like ChatGPT and Google Gemini. Contributions, feedback, and feature requests are highly encouraged to help improve the gem further.
 
-See the [CHANGELOG](https://github.com/alessiobussolari/better_translate/blob/main/CHANGELOG.md) for a summary of changes.
+For more details, please visit the [GitHub repository](https://github.com/alessiobussolari/better_translate).
 
 ## License
 

data/lib/better_translate/translator.rb

@@ -7,19 +7,24 @@ module BetterTranslate
         translations = read_yml_source
 
         # Rimuove le chiavi da escludere (global_exclusions) dalla struttura letta
-        filtered_translations = remove_exclusions(
+        global_filtered_translations = remove_exclusions(
           translations, BetterTranslate.configuration.global_exclusions
         )
 
         BetterTranslate.configuration.target_languages.each do |target_lang|
+
+          # Fase 2: Applica il filtro specifico per la lingua target
+          lang_exclusions = BetterTranslate.configuration.exclusions_per_language[target_lang[:short_name]] || []
+          filtered_translations = remove_exclusions(
+            global_filtered_translations, lang_exclusions
+          )
+
           puts "Inizio traduzione da #{BetterTranslate.configuration.source_language} a #{target_lang[:short_name]}"
           service = BetterTranslate::Service.new
           translated_data = translate_with_progress(filtered_translations, service, target_lang[:short_name], target_lang[:name])
           BetterTranslate::Writer.write_translations(translated_data, target_lang[:short_name])
           puts "Traduzione completata da #{BetterTranslate.configuration.source_language} a #{target_lang[:short_name]}"
         end
-
-        "Traduzione iniziata! #{filtered_translations.inspect}"
       end
 
       private
@@ -38,18 +43,18 @@ module BetterTranslate
         YAML.load_file(file_path)
       end
 
-      # Rimuove le chiavi specificate in exclusion_list dalla struttura dati,
+      # Rimuove le chiavi globali da escludere dalla struttura dati,
       # calcolando i percorsi a partire dal contenuto della lingua di partenza.
       #
       # Ad esempio, se il file YAML è:
-      # { "en" => { "sample" => { "valid" => "valid", "excluded" => "Excluded" } } }
-      # e exclusion_list = ["sample.excluded"],
+      #   { "en" => { "sample" => { "valid" => "valid", "excluded" => "Excluded" } } }
+      # e global_exclusions = ["sample.excluded"],
       # il risultato sarà:
-      # { "en" => { "sample" => { "valid" => "valid" } } }
+      #   { "en" => { "sample" => { "valid" => "valid" } } }
       #
       # @param data [Hash, Array, Object] La struttura dati da filtrare.
-      # @param exclusion_list [Array<String>] Lista dei percorsi (in dot notation) da escludere.
-      # @param current_path [Array] Il percorso corrente (usato in maniera ricorsiva).
+      # @param global_exclusions [Array<String>] Lista dei percorsi (in dot notation) da escludere globalmente.
+      # @param current_path [Array] Il percorso corrente (usato in maniera ricorsiva, default: []).
       # @return [Hash, Array, Object] La struttura dati filtrata.
       def remove_exclusions(data, exclusion_list, current_path = [])
         if data.is_a?(Hash)

data/lib/better_translate/version.rb

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

data/lib/generators/better_translate/translate_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+
+module BetterTranslate
+  module Generators
+    class TranslateGenerator < Rails::Generators::Base
+      desc "Lancia il processo di traduzione configurato in BetterTranslate"
+
+      def run_translation
+        say_status("Starting", "Esecuzione della traduzione con BetterTranslate...", :green)
+        BetterTranslate.magic
+        say_status("Done", "Traduzione completata.", :green)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_translate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - alessio_bussolari
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-10 00:00:00.000000000 Z
+date: 2025-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yaml
@@ -107,6 +107,7 @@ files:
 - lib/better_translate/writer.rb
 - lib/generators/better_translate/install_generator.rb
 - lib/generators/better_translate/templates/better_translate.rb
+- lib/generators/better_translate/translate_generator.rb
 homepage: https://github.com/alessiobussolari/better_translate
 licenses:
 - MIT