better_translate 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39116f70ea2683daa65f22e5acad342e91010465dc76b00046a34f3f369b471b
-  data.tar.gz: d2687a9e7ab0867894b56ae4563715aa06b61d7071755ef337f86d80fe72dfbd
+  metadata.gz: 861e9d3d1401025d2e12487f5fb6aa4e81cd67b90aa08a0a022d135eb4b71371
+  data.tar.gz: 26ff1894216353f54a8e2f60e9563526ac42da9c9cdc0ae71c4b5bed73c8debc
 SHA512:
-  metadata.gz: 41e2a36c986088a37612c72d692a2ca89e9fa6b5c52951f7b5a3e41201820baa49aa362213670d1f1d52c3735afb2e06bad94dcea640fdc35fe88c3e90a2d468
-  data.tar.gz: 35035a09d3f7088739ecc0b8cc46ef9e7863a546dbeaf2809ce6ef611417933fd30950ed226d297a770d38fda7c4d04e31e5a3be6219ebd7a89301739261a1d9
+  metadata.gz: 4082ac26837e5adb8e9b96f2f8738b61219780df6234ce25646f7bcde53faa4848abfb0cb20e0d9063e4ffab789ede5f305ebeb0cf52d7898fb58c67cb68237c
+  data.tar.gz: 66d7e88dbcd40785676ce17168ce177e29a948b7ddc7aa741bca2ed852aeee90fe98e713e28e74b5008da92ad613f6306046fda81be59ac7491b966ef1fcb579

data/README.md

@@ -15,15 +15,20 @@ Configuration is centralized via an initializer (for example, in a Rails app), w
   - **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.
+- **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.
-- **Generators**: Includes Rails generators to easily install the initializer and to trigger the translation process (e.g., via `rails generate better_translate:translate`).
+- **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:
@@ -76,8 +81,13 @@ BetterTranslate.configure do |config|
     "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" => []
   }
   
@@ -101,19 +111,28 @@ 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 into 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 a generator to trigger the translation process. You can run:
+The gem includes generators to simplify tasks:
 
-```bash
-rails generate better_translate:translate
-```
+- **Generate Initializer:**
+
+  ```bash
+  rails generate better_translate:install
+  ```
+
+- **Trigger Translation Process:**
 
-This generator will call the translation process (via `BetterTranslate.magic`) and display the progress in the terminal.
+  ```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
 
@@ -121,7 +140,6 @@ For suggestions, bug reports, or to request new features, please reach out via e
 
 ## Upcoming Features
 
-- **Selective YAML Key Exclusion**: Ability to exclude specific YAML keys for translation on a per-language basis.
 - **Helper Methods**: Additional helper methods to integrate BetterTranslate as a translation system for dynamic content.
 
 ## Conclusions
@@ -130,10 +148,6 @@ BetterTranslate aims to simplify the translation of YAML files in Ruby projects
 
 For more details, please visit the [GitHub repository](https://github.com/alessiobussolari/better_translate).
 
-## Changelog
-
-See the [CHANGELOG](https://github.com/alessiobussolari/better_translate/blob/main/CHANGELOG.md) for a summary of changes.
-
 ## License
 
 BetterTranslate is distributed under the MIT license. See the [LICENSE](LICENSE) file for more details.

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.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_translate
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  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