better_translate 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac3bc8d98853820f1c6367bbbe4fb36733a872de35eef7ff8bc47349fc9376e5
-  data.tar.gz: fa486ddb0bf587faee2792bbca54982ddbdffcc44b4b183e9c0de1c849f917b7
+  metadata.gz: 39116f70ea2683daa65f22e5acad342e91010465dc76b00046a34f3f369b471b
+  data.tar.gz: d2687a9e7ab0867894b56ae4563715aa06b61d7071755ef337f86d80fe72dfbd
 SHA512:
-  metadata.gz: 643e1688cc0171ddee6bfeb848aa1d555922bf2c44907afc56981ea0b5c9dd9ce8fa5788b509596eb53735cd4ce63e1adbccaeb1592f5cb3d1653da794a0c415
-  data.tar.gz: ea2451b736c946d2bead72f3bf36dab06fb38e2037662c160a400f73a1854919314bfecb0a5081b63add8b7a66b1402ae85b3cfa42af10149cb9faf9677fba90
+  metadata.gz: 41e2a36c986088a37612c72d692a2ca89e9fa6b5c52951f7b5a3e41201820baa49aa362213670d1f1d52c3735afb2e06bad94dcea640fdc35fe88c3e90a2d468
+  data.tar.gz: 35035a09d3f7088739ecc0b8cc46ef9e7863a546dbeaf2809ce6ef611417933fd30950ed226d297a770d38fda7c4d04e31e5a3be6219ebd7a89301739261a1d9

data/README.md

@@ -3,19 +3,20 @@
 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.
+- **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`).
 
 ## Installation
 
@@ -23,6 +24,7 @@ Add the gem to your Gemfile:
 
 ```ruby
 gem 'better_translate'
+```
 
 Then run:
 
@@ -50,38 +52,38 @@ 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)
   config.exclusions_per_language = {
     "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 +91,7 @@ end
 
 ## Usage
 
-### YAML File Translation
+### Translating YAML Files
 
 To start the translation process, simply call the `magic` method:
 
@@ -100,12 +102,33 @@ 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.
+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.
 
-## Contributing
+### Using Rails Generators
+
+The gem includes a generator to trigger the translation process. You can run:
+
+```bash
+rails generate better_translate:translate
+```
+
+This generator will call the translation process (via `BetterTranslate.magic`) and display the 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
+
+- **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
+
+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.
 
-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.
+For more details, please visit the [GitHub repository](https://github.com/alessiobussolari/better_translate).
 
 ## Changelog
 

data/lib/better_translate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BetterTranslate
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: better_translate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - alessio_bussolari
@@ -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