i18nize 0.4.5 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 554c7500faf755b35e18493fdb4f69b2a14e3554448644979c8065f5e8ba4d3e
-  data.tar.gz: 50c639f8e40929e7376ecc207e6a422e071c5526de8c100ee01c10c03e6cefc9
+  metadata.gz: ecaecd54d2f036282dddadfefe26591090c54272cf6a5646fb12d53367509795
+  data.tar.gz: '08adc947c1a7b46f2f7e3dc486d3429bb9e404ed9d7b61ab683a6813ee45cbd2'
 SHA512:
-  metadata.gz: e3430a473e47b1d4837d1f0f5343c461695ac1be8ca8225e6a02be4326754dae424ccb6477555e258487aaffef0d7e389b1873908c27bd67f0f8f9995fb3811e
-  data.tar.gz: be813068492685523dd09fa531fe174642a7850f193b9c36082448744764350e45ff1d14ff49386a7d04dd06afc302b8c4073ddcf0ee4c6c57a4f81ced6160fe
+  metadata.gz: 0a32cac5c9df881264c7ae1688345410efa5ed64d8a3481526f83d2f4ef84f888af4e83fdce0af2da09f9f2594918d2606ffe31bd3c66e4a7af84f823c2443eb
+  data.tar.gz: 68fa3a1028e87cf9965e20be6ab5b663c438b0b27ec3269fc8fc7a4543a59551f832d206e416cf79784e38cca474be09aa9ddc47d208bd581cf0aa830f0d4ce5

data/CHANGELOG.md

@@ -1,5 +1,96 @@
+# Changelog
+
 ## [Unreleased]
 
-## [0.1.0] - 2025-07-30
+---
+
+### Added
+### Changed
+### Removed
+### Fixed
+
+---
+
+---
+
+## [0.5.0] - 2025-09-08
+### Added
+- **Conflict policy**: source locale is now treated as the source of truth.  
+  If the target locale has a scalar where a nested hash is required, the scalar is **overwritten** with the correct structure from the source.
+- **Pluralization support**: automatic handling of `one`, `other`, and related plural keys. Scalars can be coerced into plural hashes.
+- **Placeholder preservation**: `%{count}` and other I18n-style placeholders are protected from being altered by DeepL.
+- Improved file name detection for `.yml` and `.yaml` formats, including names like `app.en.yml`.
+
+### Changed
+- Default behaviour: conflicts are no longer skipped or raise errors, but are resolved by overwriting with source locale values.
+
+### Removed
+- **Rake task `i18nize:translate`** has been removed.  
+  Use the CLI instead:
+  ```bash
+  i18nize cs
+  i18nize cs --from en
+  i18nize cs --missing
+  ```
+
+### Fixed
+
+* Eliminated `IndexError: string not matched` errors when attempting to insert into scalar values.
+
+---
+
+## \[0.4.4] - 2025-09-08
+
+### Added
+
+* CLI option `--missing [FROM]` to list missing keys without translating.
+
+    * `i18nize cs --missing` → shows missing Czech keys (from English).
+    * `i18nize cs --missing de` → shows missing Czech keys (from German).
+
+---
+
+## \[0.4.2.1] - 2025-09-08
+
+### Fixed
+
+* Correct requires for `Translator` and `Inserter` inside CLI (prevented `NameError`).
+
+---
+
+## \[0.4.2] - 2025-09-08
+
+### Added
+
+* `.env` file support (via `dotenv` if present).
+* Improved CLI error messages.
+
+---
+
+## \[0.4.1] - 2025-09-08
+
+### Fixed
+
+* File path normalization for top-level locales (`en.yml` → `cs.yml`).
+* Safer regex for file name replacement.
+
+---
+
+## \[0.4.0] - 2025-08-25
+
+### Added
+
+* Standalone CLI (`i18nize <locale>`) — no need to call only via Rake.
+* Basic `--from` option for source language.
+
+---
+
+## \[0.1.0] - 2025-07-30
+
+### Added
 
-- Initial release
+* Initial release.
+* DeepL translation of missing keys.
+* Character count estimation and confirmation prompt.
+* Automatic creation of target locale files.
+* Rake task `i18nize:translate[locale]`.

data/README.md

@@ -1,19 +1,18 @@
 # i18nize
 
-🧠 Automatically fills in missing I18n YAML keys using DeepL translation API.  
+🧠 Automatically fills in missing I18n YAML keys using DeepL translation API.
 Designed to streamline multi-language support in Ruby and Rails projects.
 
-
 ## ✨ Features
 
-- Detects missing or empty translation keys in locale files
-- Supports multiple YAML files and nested directories (e.g. `config/locales/api/en.yml`)
-- Automatically translates from a source locale (default: `en`) to a target (e.g. `cs`)
-- Integrates with DeepL API (Free or Pro)
-- Safely merges translations into corresponding `*.yml` files
-- Includes character count check with confirmation
-- CLI via Rake task
-
+* Detects missing or empty translation keys in locale files
+* Supports multiple YAML files and nested directories (e.g. `config/locales/api/en.yml`)
+* Automatically translates from a source locale (**default: `en`**) to a target (e.g. `cs`)
+* Integrates with DeepL API (Free or Pro)
+* Safely merges translations into corresponding `*.yml` files
+* Handles structural conflicts by overwriting target with source truth
+* Character count check with confirmation prompt
+* CLI (`i18nize`)
 
 ## 🔧 Installation
 
@@ -21,7 +20,7 @@ Add this line to your application's Gemfile:
 
 ```ruby
 gem "i18nize"
-````
+```
 
 Then run:
 
@@ -35,61 +34,70 @@ Or install manually:
 gem install i18nize
 ```
 
-
 ## 🚀 Usage
 
 ### 1. Set your DeepL API key
 
-Create a `.env` or export it in your shell:
+Create a `.env` file (loaded automatically if you use `dotenv`) or export it in your shell:
 
 ```bash
 export DEEPL_API_KEY=your-api-key
 export DEEPL_ENDPOINT=https://api.deepl.com/v2/translate # Only if you are using a DeepL Pro account
 ```
 
-> You can use the [Free DeepL API](https://www.deepl.com/pro#developer)
-
-
+👉 You can use the [Free DeepL API](https://www.deepl.com/pro#developer).
 
-### 2. Run the translation task
+### 2. Run translations via CLI
 
 ```bash
-bundle exec rake "i18nize:translate[language]"
+# Translate from en → cs
+i18nize cs
+
+# Translate from de → fr
+i18nize fr --from de
 ```
 
 💬 This will:
 
-* Scan config/locales/**/*en.yml (English is the default source language)
-* Detect which `language.yml` files are missing keys
+* Scan `config/locales/**/*en.yml` (or your chosen source language)
+* Detect which `cs.yml` files are missing keys
 * Use DeepL to translate missing values
-* Write them to the appropriate files (e.g. `config/locales/errors/language.yml`)
+* Write them to the appropriate files (creating them if needed)
+
+### 3. Show missing keys only
+
+```bash
+# Missing cs keys (source en)
+i18nize cs --missing
+
+# Missing cs keys (source de)
+i18nize cs --missing de
+```
 
+This mode only lists missing keys, no translations are written.
 
 
 ## 🛡️ Character limit check
 
-Before translating, the task will:
+Before translating, the CLI:
 
-* Count the total number of characters to be translated
-* Warn if the count exceeds **500,000** (DeepL Free monthly limit)
-* Ask for confirmation:
+* Counts the total number of characters
+* Warns if the count exceeds **500,000** (DeepL Free monthly limit)
+* Asks for confirmation:
 
 ```text
 [i18nize] Estimated character count: 43125
 Proceed with translation? [y/N]:
 ```
 
-
-
 ## 🗂️ Locale file support
 
-* Files are grouped per folder and matched:
+* Files are matched by name:
 
-    * `config/locales/api/en.yml` → `config/locales/api/cs.yml`
-    * `config/locales/en.devise.yml` → `config/locales/cs.devise.yml`
+  * `config/locales/api/en.yml` → `config/locales/api/cs.yml`
+  * `config/locales/en.devise.yml` → `config/locales/cs.devise.yml`
 * Missing files are created automatically
-
-
+* If a scalar exists where a nested structure is required, **it is overwritten by source locale structure**
 
 ## 🧩 Example structure
 
@@ -102,7 +110,13 @@ config/locales/
 │   └── cs.yml
 ```
 
-After running `rake i18nize:translate[cs]`, the gem will create:
+After running:
+
+```bash
+i18nize cs
+```
+
+the gem will create:
 
 ```
 config/locales/api/cs.yml
@@ -114,16 +128,19 @@ With keys translated from `api/en.yml`.
 
 ## 📦 Configuration
 
-For now, configuration is via method arguments and `ENV["DEEPL_API_KEY"]`.
-Optional future support: `.i18nize.yml`.
+For now, configuration is via CLI flags and environment variables:
 
+* `--from LANG` (default `en`)
+* `--missing [FROM]` (list missing keys only)
+* `DEEPL_API_KEY` (required)
+* `DEEPL_ENDPOINT` (optional, only for Pro)
 
+---
 
 ## 🔍 TODO
 
-* Test suite (RSpec)
-* YAML key sorting and format preservation
-* Smart overwrite protection
-* Changeable source language
-
+* RSpec test suite
+* YAML key sorting / format preservation
+* Richer conflict resolution strategies (configurable overwrite / skip)
+* Use custom char limit 
 

data/lib/i18nize/comparer.rb

@@ -15,15 +15,14 @@ module I18nize
         dirname  = File.dirname(from_path)
         filename = File.basename(from_path)
 
-        expected_to_filename =
-          filename.sub(/(^|[._])#{Regexp.escape(from_locale)}\.yml$/, "\\1#{to_locale}.yml")
-
-        to_path =
-          if dirname == "." || dirname.empty?
-            expected_to_filename
-          else
-            File.join(dirname, expected_to_filename)
-          end
+        locale_re = /(^|[._])#{Regexp.escape(from_locale)}\.(ya?ml)$/
+        expected_to_filename = filename.sub(locale_re) { "#{Regexp.last_match(1)}#{to_locale}.#{Regexp.last_match(2)}" }
+
+        to_path = if dirname == "." || dirname.empty?
+                    expected_to_filename
+                  else
+                    File.join(dirname, expected_to_filename)
+                  end
 
         to_keys = to_data[to_path] || {}
 

data/lib/i18nize/inserter.rb

@@ -6,32 +6,32 @@ require_relative "comparer"
 
 module I18nize
   class Inserter
+    CONFLICT_POLICY = :overwrite # :overwrite | :skip
+
     def self.insert_missing(from_locale: "en", to_locale:, base_path: "config/locales", translator: nil)
       missing_data = Comparer.missing_translations(from_locale: from_locale, to_locale: to_locale)
 
       if translator
         char_count = missing_data.character_count
         puts "\n\e[33m[i18nize] Estimated character count: #{char_count}\e[0m"
-
-        if char_count > 500_000
-          puts "\e[31m[i18nize] Warning: DeepL Free has a 500,000 character monthly limit.\e[0m"
-        end
-
+        puts "\e[31m[i18nize] Warning: DeepL Free has a 500,000 character monthly limit.\e[0m" if char_count > 500_000
         print "\e[36mProceed with translation? [y/N]: \e[0m"
-        answer = $stdin.gets.strip.downcase
-
+        answer = $stdin.gets.to_s.strip.downcase
         unless answer == "y"
           puts "\e[90m[i18nize] Aborted by user.\e[0m"
           return
         end
       end
 
+      overwrites = []
+
       missing_data.data.each do |from_rel_path, translations|
         dirname  = File.dirname(from_rel_path)
         filename = File.basename(from_rel_path)
 
-        new_filename = filename.sub(/^#{from_locale}\.yml$/, "#{to_locale}.yml")
-        to_rel_path = File.join(dirname, new_filename)
+        locale_re = /(^|[._])#{Regexp.escape(from_locale)}\.(ya?ml)$/
+        new_filename = filename.sub(locale_re) { "#{Regexp.last_match(1)}#{to_locale}.#{Regexp.last_match(2)}" }
+        to_rel_path = dirname == "." || dirname.empty? ? new_filename : File.join(dirname, new_filename)
         to_full_path = File.join(base_path, to_rel_path)
 
         existing = File.exist?(to_full_path) ? YAML.load_file(to_full_path) : {}
@@ -39,16 +39,16 @@ module I18nize
 
         translation_map =
           if translator
-            en_values = translations.values
-            translated_values = translator.translate_texts(en_values)
-            translations.keys.zip(translated_values.values).to_h
+            src_values = translations.values
+            translated_values = translator.translate_texts(src_values) # => pole!
+            translations.keys.zip(translated_values).to_h
           else
             translations
           end
 
-        translation_map.each do |key, value|
-          path = key.sub(/^#{from_locale}\./, "").split(".")
-          insert_nested(existing[to_locale], path, value)
+        translation_map.each do |full_key, value|
+          path = full_key.sub(/^#{Regexp.escape(from_locale)}\./, "").split(".")
+          insert_nested(existing[to_locale], path, value, overwrites, to_rel_path, to_locale, CONFLICT_POLICY)
         end
 
         FileUtils.mkdir_p(File.dirname(to_full_path))
@@ -56,16 +56,41 @@ module I18nize
 
         puts "\e[32m[i18nize] Inserted #{translation_map.size} keys into #{to_full_path}\e[0m"
       end
+
+      if overwrites.any?
+        puts "\n\e[33m[i18nize] Overwrote #{overwrites.size} scalar node(s) to create nested structure:\e[0m"
+        overwrites.each do |c|
+          puts "  \e[33m- #{c[:file]}: #{c[:locale]}.#{c[:path].join('.')}\e[0m (was: #{c[:existing_class]})"
+        end
+      end
     end
 
-    def self.insert_nested(base, keys, value)
+    # conflict_policy: :overwrite (replace scalar with {}), :skip (leave as is)
+    def self.insert_nested(base, keys, value, overwrites, file, locale, conflict_policy)
       key = keys.shift
-      base[key] ||= {}
 
       if keys.empty?
         base[key] = value
+        return true
+      end
+
+      cur = base[key]
+
+      case cur
+      when nil
+        base[key] = {}
+        insert_nested(base[key], keys, value, overwrites, file, locale, conflict_policy)
+      when Hash
+        insert_nested(cur, keys, value, overwrites, file, locale, conflict_policy)
       else
-        insert_nested(base[key], keys, value)
+        if conflict_policy == :overwrite
+          overwrites << { file: file, locale: locale, path: [key, *keys], existing_class: cur.class.to_s }
+          base[key] = {}
+          insert_nested(base[key], keys, value, overwrites, file, locale, conflict_policy)
+        else
+          # :skip
+          false
+        end
       end
     end
   end

data/lib/i18nize/translator.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-
 require "net/http"
 require "uri"
 require "json"
@@ -7,42 +6,44 @@ require "json"
 module I18nize
   class Translator
     ENDPOINT = ENV.fetch("DEEPL_ENDPOINT", "https://api-free.deepl.com/v2/translate")
+    PLACEHOLDER_RE = /%{\s*[^}]+\s*}/
 
     def initialize(auth_key:, from_lang: "EN", to_lang:)
-      @auth_key = auth_key
+      @auth_key  = auth_key
       @from_lang = from_lang
-      @to_lang = to_lang
+      @to_lang   = to_lang
     end
 
     def translate_texts(texts)
-      return {} if texts.empty?
+      return [] if texts.empty?
+
+      placeholders = []
+      protected = texts.map do |t|
+        t.to_s.gsub(PLACEHOLDER_RE) do |m|
+          idx = placeholders.size
+          placeholders << m
+          "__I18NIZE_PLH_#{idx}__"
+        end
+      end
 
       uri = URI(ENDPOINT)
-
-      # Opakující se text parametry
       body_params = [
         ["auth_key", @auth_key],
         ["source_lang", @from_lang],
         ["target_lang", @to_lang],
-      ] + texts.map { |text| ["text", text] }
+      ] + protected.map { |text| ["text", text] }
 
-      request = Net::HTTP::Post.new(uri)
-      request["Content-Type"] = "application/x-www-form-urlencoded"
-      request.body = URI.encode_www_form(body_params)
+      req = Net::HTTP::Post.new(uri)
+      req["Content-Type"] = "application/x-www-form-urlencoded"
+      req.body = URI.encode_www_form(body_params)
 
-      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
-        http.request(request)
-      end
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |h| h.request(req) }
+      raise "DeepL API Error: #{res.code} - #{res.body}" unless res.is_a?(Net::HTTPSuccess)
 
-      unless response.is_a?(Net::HTTPSuccess)
-        raise "DeepL API Error: #{response.code} - #{response.body}"
-      end
-
-      json = JSON.parse(response.body)
-      translated = json["translations"].map { |t| t["text"] }
+      json = JSON.parse(res.body)
+      out = json["translations"].map { |t| t["text"] }
 
-      Hash[texts.zip(translated)]
+      out.map { |s| s.gsub(/__I18NIZE_PLH_(\d+)__/) { placeholders[$1.to_i] } }
     end
   end
 end
-

data/lib/i18nize/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module I18nize
-  VERSION = "0.4.5"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,16 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: i18nize
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.1
 platform: ruby
 authors:
 - nikolas2145
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-08 00:00:00.000000000 Z
+date: 2025-09-09 00:00:00.000000000 Z
 dependencies: []
-description: ''
+description: "i18nize helps Ruby and Rails projects stay multilingual by automatically
+  filling in \nmissing translations in I18n YAML locale files. It scans for missing
+  or empty keys \nacross nested locale structures, and uses the DeepL API (Free or
+  Pro) to translate \nthem from a chosen source locale (default: en).\n\nFeatures:\n-
+  Detects and lists missing translation keys\n- Automatically translates and inserts
+  values into the correct YAML files\n- Supports nested directories and multiple locale
+  files (e.g. config/locales/api/en.yml)\n- Preserves I18n placeholders such as %{count}\n-
+  Handles pluralization branches (one, other, etc.)\n- Source locale is treated as
+  the single source of truth (conflicts are resolved by overwrite)\n- Simple CLI:
+  `i18nize <locale>` or `i18nize <locale> --missing`\n\nThis gem streamlines the translation
+  workflow, making it easier to maintain \nconsistent, up-to-date locale files across
+  large Ruby on Rails applications.\n"
 email:
 - nikolas2145@gmail.com
 executables:
@@ -18,11 +29,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".idea/.gitignore"
-- ".idea/git_toolbox_prj.xml"
-- ".idea/i18nize.iml"
-- ".idea/material_theme_project_new.xml"
-- ".idea/vcs.xml"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -66,5 +72,5 @@ requirements: []
 rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: Auto-translates missing I18n keys in YAML files using DeepL.
+summary: Automatic DeepL-powered translations for I18n YAML files
 test_files: []

data/.idea/.gitignore

@@ -1,8 +0,0 @@
-# Default ignored files
-/shelf/
-/workspace.xml
-# Editor-based HTTP Client requests
-/httpRequests/
-# Datasource local storage ignored files
-/dataSources/
-/dataSources.local.xml

data/.idea/git_toolbox_prj.xml

@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="GitToolBoxProjectSettings">
-    <option name="commitMessageIssueKeyValidationOverride">
-      <BoolValueOverride>
-        <option name="enabled" value="true" />
-      </BoolValueOverride>
-    </option>
-    <option name="commitMessageValidationEnabledOverride">
-      <BoolValueOverride>
-        <option name="enabled" value="true" />
-      </BoolValueOverride>
-    </option>
-  </component>
-</project>

data/.idea/i18nize.iml

@@ -1,53 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module version="4">
-  <component name="ModuleRunConfigurationManager">
-    <shared />
-  </component>
-  <component name="RakeTasksCache-v2">
-    <option name="myRootTask">
-      <RakeTaskImpl id="rake">
-        <subtasks>
-          <RakeTaskImpl description="Build i18nize-0.4.0.gem into the pkg directory" fullCommand="build" id="build" />
-          <RakeTaskImpl id="build">
-            <subtasks>
-              <RakeTaskImpl description="Generate SHA512 checksum of i18nize-0.4.0.gem into the checksums directory" fullCommand="build:checksum" id="checksum" />
-            </subtasks>
-          </RakeTaskImpl>
-          <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
-          <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
-          <RakeTaskImpl id="i18nize">
-            <subtasks>
-              <RakeTaskImpl description="Auto-translate missing I18n keys using DeepL (usage: rake 'i18nize:translate[cs]')" fullCommand="i18nize:translate[to_locale]" id="translate[to_locale]" />
-              <RakeTaskImpl description="" fullCommand="i18nize:translate" id="translate" />
-            </subtasks>
-          </RakeTaskImpl>
-          <RakeTaskImpl description="Build and install i18nize-0.4.0.gem into system gems" fullCommand="install" id="install" />
-          <RakeTaskImpl id="install">
-            <subtasks>
-              <RakeTaskImpl description="Build and install i18nize-0.4.0.gem into system gems without network access" fullCommand="install:local" id="local" />
-            </subtasks>
-          </RakeTaskImpl>
-          <RakeTaskImpl description="Create tag v0.4.0 and build and push i18nize-0.4.0.gem to https://rubygems.org" fullCommand="release[remote]" id="release[remote]" />
-          <RakeTaskImpl description="Run RuboCop" fullCommand="rubocop" id="rubocop" />
-          <RakeTaskImpl id="rubocop">
-            <subtasks>
-              <RakeTaskImpl description="Autocorrect RuboCop offenses (only when it's safe)" fullCommand="rubocop:autocorrect" id="autocorrect" />
-              <RakeTaskImpl description="Autocorrect RuboCop offenses (safe and unsafe)" fullCommand="rubocop:autocorrect_all" id="autocorrect_all" />
-              <RakeTaskImpl description="" fullCommand="rubocop:auto_correct" id="auto_correct" />
-            </subtasks>
-          </RakeTaskImpl>
-          <RakeTaskImpl description="Run RSpec code examples" fullCommand="spec" id="spec" />
-          <RakeTaskImpl description="" fullCommand="default" id="default" />
-          <RakeTaskImpl description="" fullCommand="release" id="release" />
-          <RakeTaskImpl id="release">
-            <subtasks>
-              <RakeTaskImpl description="" fullCommand="release:guard_clean" id="guard_clean" />
-              <RakeTaskImpl description="" fullCommand="release:rubygem_push" id="rubygem_push" />
-              <RakeTaskImpl description="" fullCommand="release:source_control_push" id="source_control_push" />
-            </subtasks>
-          </RakeTaskImpl>
-        </subtasks>
-      </RakeTaskImpl>
-    </option>
-  </component>
-</module>

data/.idea/material_theme_project_new.xml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="MaterialThemeProjectNewConfig">
-    <option name="metadata">
-      <MTProjectMetadataState>
-        <option name="migrated" value="true" />
-        <option name="pristineConfig" value="false" />
-        <option name="userId" value="-151e60b4:18eb353ec10:-7ffc" />
-      </MTProjectMetadataState>
-    </option>
-  </component>
-</project>

data/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>