loco_tool 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb7acfbf180e88ff2c907df0e3693b81a638b84b5496664405464f6896f6b43e
-  data.tar.gz: b0bcb5897fdb6ae131fa305be90c1ff6c495033c75ae893f098840f65b0b272f
+  metadata.gz: da05eb7a6a6e69b0becea3f9ac18b1621a582335e0e21dfbcce64122e1b1ec00
+  data.tar.gz: fc833dbe4c5c8c80da833f66b2bbc4a335e3fb6120d1887a9e2c472d0edfa158
 SHA512:
-  metadata.gz: 3563ec7bf3d3929600cd78c79877fbe0d1fa93246daf3d0a00787da567e1f5853c283afdc3215df31aa36cb176458b76146e1f8473e19356bd0425bbf65a9aca
-  data.tar.gz: b3e43a621bc994bc16cf8186392def9184dc85918c480c0bfa0fb5446bd52910524ca8e78c981f75da4ff09ca19855170527962ad3a5d3574a723136b21e7769
+  metadata.gz: f798c9e5cc051e06e17991f2fdf77e5be1c19fb44286f2fa7e8595f6c37eafb7fb9530966d81f404c733db016045cc1313872918f9b873dc46e3286f0e477717
+  data.tar.gz: a35c6c3a2b78c4e024b8e3470736918e6939d66f5eeb38cf6664d3af8bf6db1a74148c609282df0e2207798eeb6512fc764d029218c8124f34b22dfe3c3df348

data/README.md

@@ -10,6 +10,8 @@ LocoTool is a command-line tool for localization tasks, designed to simplify the
 - Find duplicate keys between localization files.
 - Sync and move missing strings between files.
 - Validate and verify localization files.
+- Transform localization files between different formats.
+- Identify oversized strings in localization files.
 
 ### TODO
 
@@ -59,6 +61,14 @@ $ locotool export [PATH_A] [PATH_B] -s [SORT] -c [CASE]
 
 This command transforms localization files from `PATH_A` to `PATH_B`. It can sort the keys in the output files (`SORT`) and change the case of the keys (`CASE`). The `SORT` parameter can be set to `asc`, or `desc`. The `CASE` parameter can be set to `lower`, or `upper`. Both parameters are optional.
 
+### Identify Oversized Strings
+
+```
+$ locotool oversize [PATH_A] [TARGET_LANG] [GAP]
+```
+
+This command identifies oversized strings in the localization files in the specified directory (`PATH_A`). It compares the length of the strings in the target language (`TARGET_LANG`) with the base language and reports the strings that exceed the specified gap (`GAP`).
+
 ## Examples
 
 Export Localization file from iOS to Android

data/bin/locotool

@@ -11,8 +11,8 @@ require_relative "../lib/helper"
 # Usage: locotool [command] [options]
 class Locotool < Thor
   desc "export FILE_A FILE_B", "Export keys from FILE_A to FILE_B"
-  method_option :sort, :aliases => "-s", :desc => "Sort keys by name. Values: asc, desc"
-  method_option :case, :aliases => "-c", :desc => "Transform case to type of case. Values: lowercase, upcase"
+  method_option :sort, aliases: "-s", desc: "Sort keys by name. Values: asc, desc"
+  method_option :case, aliases: "-c", desc: "Transform case to type of case. Values: lowercase, upcase"
   def export(file_a, file_b)
     sorted = Helper.sort(file_a, options[:sort])
     Logger.header("Exporting #{Paint[sorted.length.to_s, :green]} keys")
@@ -81,6 +81,15 @@ class Locotool < Thor
     Logger.lost_keys(lost_keys)
     strings_b_file.write
   end
+
+  desc "oversize FILE TARGET_LANG GAP", "Identify and flag translations exceeding the length of the original language"
+  def oversize(file, target_lang, gap)
+    unless file.end_with?("xcstrings")
+      Logger.error("File format not supported. Only .xcstrings files are supported")
+      return
+    end
+    Helper.oversize(LocoStrings.load(file), target_lang, gap.to_i)
+  end
 end
 
 Locotool.start(ARGV)

data/lib/helper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../lib/logger'
+require_relative "../lib/logger"
 
 # The Helper class provides utility methods for various tasks.
 class Helper
@@ -75,20 +75,20 @@ class Helper
   def self.sort(file, sort)
     strings = LocoStrings.load(file).read
     sorted = []
-    strings.each do |key, string|
+    strings.each do |_key, string|
       sorted << string
     end
-    if sort 
+    if sort
       if sort == "asc"
         sorted.sort! { |a, b| a.key <=> b.key }
       elsif sort == "desc"
         sorted.sort! { |a, b| b.key <=> a.key }
-      else 
+      else
         Logger.error("Invalid sort option")
         exit
       end
     end
-    return sorted
+    sorted
   end
 
   # Transforms the keys in the specified file
@@ -98,20 +98,37 @@ class Helper
   #
   # @return [void]
   def self.transform_keys(strings, transform_type)
-    if !transform_type
-      return
-    end
+    return unless transform_type
+
     strings.each do |string|
       old_key = string.key
       if transform_type == "lower"
         string.key = string.key.downcase
       elsif transform_type == "upper"
         string.key = string.key.upcase
-      else 
+      else
         Logger.error("Invalid transform type")
         exit
       end
       Logger.key_transform(old_key, string)
     end
   end
+
+  # Finds oversize strings in the specified file
+  #
+  # @param file [String] The file to check
+  # @param target_lang [String] The target language
+  # @param gap [Integer] The gap between the source length and target strings
+  #
+  # @return [void]
+  def self.oversize(file, target_lang, gap)
+    strings = file.read
+    strings.each do |key, string|
+      target_string = file.value(key, target_lang)
+      limit_length = string.value.length + gap
+      next unless limit_length < target_string.length
+
+      Logger.oversize(string, target_string)
+    end
+  end
 end

data/lib/logger.rb

@@ -27,6 +27,12 @@ class Logger
     puts "#{Formatter.string(string.key, string.value)} ↔ #{Paint[duplicate.value.to_s, :blue]}"
   end
 
+  def self.oversize(original, string)
+    length = original.value.length
+    puts "#{Formatter.string(original.key,
+                             original.value)} ↔ #{Paint[string[0...length], :blue]}#{Paint[string[length...], :red]}"
+  end
+
   # Prints a key transfom message.
   #
   # @param old_key [String] The old key.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loco_tool
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Aleksei Cherepanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-03 00:00:00.000000000 Z
+date: 2024-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loco_strings
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: A CLI tool for parsing and validating localization strings