loco_strings 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79d663be035e5b1ad273b17e729235204d0f38bbda6dcb69d55e6dd5077145f2
-  data.tar.gz: 41c2bf22dabec94904f27817d8da2fcf60787a569a7adf3708bb34eadf8a2512
+  metadata.gz: 567e3981149f49dd55a99138ca51993030011f886c227f3cd8809c5a0c1e48c5
+  data.tar.gz: d9424623eeb635a2798a4f858701be4fa1897714af4181caa5863dbcb8d4bf4d
 SHA512:
-  metadata.gz: de7b40862a9998f06ccf6473c5a7c17861d51693e7a6b788e779cfdc81350a313130ef36d4b8ff21f1693b4b76a1953d4f871a981677e28463055b3cc82b9d66
-  data.tar.gz: 815cc8a29514e75611d74a1b6824252b78171b89ea02eacfbdf6c84c040d27b334416d0d2abbc8251584b1d6e673331947fe2919d457fead8c38179394d1b8b5
+  metadata.gz: 50404d9b25812983c3b6f537d4220572f7df87c837b19411fd22293cc6c1abae4550ec3e630bc359853b8092802cf8324a2b4db8b753ba830d20e0d42bae82c3
+  data.tar.gz: f650a177e645204d68e6cd65fa87214976b5c258c266d90bcdf61a1061bd49466a442dd74d3bac22b1fe7a86b13ecacedb90a32bff5fbf0db3e4c70fc4dd63e4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    loco_strings (0.1.1)
+    loco_strings (0.1.3)
       nokogiri (~> 1.13, >= 1.13.8)
 
 GEM

data/README.md

@@ -10,6 +10,27 @@ That's where LocoStrings comes in. With LocoStrings, you can easily parse and ma
 
 In this README, we'll show you how to install and use LocoStrings in your Ruby projects. Let's get started!
 
+### Supported formats
+
+Here is the list of currently supported files, as well as files that are still on the to-do list. I am still working on the library, and I hope to eventually finish all the files on the list. Contributions are welcome.
+
+- [x] Android Resources
+- [x] Apple Strings
+- [ ] Gettext
+- [ ] Java Properties
+- [ ] Apple XLIFF
+- [ ] Objective-C/Cocoa Properties
+- [ ] .NET Resources
+- [ ] JavaScript Object
+- [ ] React Native (I18n library)
+- [ ] Symphony PHP XLIFF
+- [ ] Angular i18n XLIFF
+- [ ] Ruby YAML
+- [ ] Salesforce Translation
+- [ ] QT Linguist
+- [ ] Docx
+- [ ] Flutter ARB file
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:

data/lib/loco_strings/parsers/loco_file.rb

@@ -23,6 +23,7 @@ module LocoStrings
     end
 
     def update(key, value, comment = nil)
+      comment = @strings[key].comment if comment.nil? && @strings.has_key?(key)
       @strings[key] = LocoString.new key, value, comment
     end
 

data/lib/loco_strings/parsers/xcstrings_file.rb

@@ -0,0 +1,130 @@
+require_relative "loco_file"
+require "json"
+
+module LocoStrings
+  class XCStringsFile < LocoFile
+    def read
+      clean
+      return @strings unless File.exist?(@file_path)
+
+      comment = nil
+      file = File.read(@file_path)
+      json = JSON.parse(file)
+      extract_languages(json)
+      @language = json["sourceLanguage"]
+      @translations = {}
+      strings = json["strings"]
+      strings.each do |key, value|
+        comment = value["comment"]
+        translation = key
+        if value.has_key?("localizations") && value["localizations"].has_key?(@language)
+          loc = value["localizations"][@language]
+        end
+        translation = loc["stringUnit"]["value"] unless loc.nil?
+        @strings[key] = LocoString.new key, translation, comment unless translation.nil?
+        for language in @languages
+          next unless value.has_key?("localizations") && value["localizations"].has_key?(language)
+
+          loc = value["localizations"][language]
+          translation = loc["stringUnit"]["value"] unless loc.nil?
+          @translations[language] = {} unless @translations.has_key?(language)
+          @translations[language][key] = translation unless translation.nil?
+        end
+      end
+      @strings
+    end
+
+    def write
+      raise Error, "The base language is not defined" if @language.nil?
+
+      json = {}
+      json["sourceLanguage"] = @language
+      json["strings"] = {}
+      @strings.each do |key, value|
+        row = {}
+        row["comment"] = value.comment unless value.comment.nil?
+        localizations = {}
+        if value.value != key && !value.value.nil?
+          localizations[@language] = {
+            "stringUnit" => {
+              "state" => "translated",
+              "value" => value.value
+            }
+          }
+        end
+        @languages.each do |language|
+          next if language == @language
+          next unless @translations.has_key?(language) && @translations[language].has_key?(key)
+
+          localizations[language] = {
+            "stringUnit" => {
+              "state" => "translated",
+              "value" => @translations[language][key]
+            }
+          }
+        end
+        row["localizations"] = localizations unless localizations.empty?
+        json["strings"][key] = row
+      end
+      json["version"] = "1.0"
+      File.open(@file_path, "w") { |file| file.write(JSON.pretty_generate(json)) }
+    end
+
+    def update(key, value, comment = nil, language = @language)
+      raise Error, "The base language is not defined" if @language.nil?
+
+      if @language != language
+        @languages << language unless @languages.include?(language)
+        @translations[language] = {} unless @translations.has_key?(language)
+        @translations[language][key] = value
+        @strings[key] = LocoString.new key, key, comment unless @strings.has_key?(key)
+        return
+      end
+      comment = @strings[key].comment if @strings.has_key?(key) && (comment.nil? && @strings.has_key?(key))
+      @strings[key] = LocoString.new key, value, comment
+    end
+
+    def value(key, language = nil)
+      return @strings[key] if language.nil? || language == @language
+      return @translations[language][key] if @translations.has_key?(language) && @translations[language].has_key?(key)
+    end
+
+    def clean
+      @strings = {}
+      @translations = {}
+      @languages = []
+      @language = nil
+    end
+
+    def set_language(language)
+      raise Error, "The base language is aready defined" unless @language.nil?
+
+      @language = language
+    end
+
+    def to_s
+      result = ""
+      result += "Base language: #{@language}\n" unless @language.nil?
+      result += "Languages: #{@languages}\n" unless @languages.empty?
+      result += "Strings:\n"
+      @strings.each do |key, value|
+        result += "#{key}: #{value}\n"
+      end
+      result
+    end
+
+    private
+
+    def extract_languages(json)
+      @languages = []
+      json["strings"].each do |_key, value|
+        next unless value.has_key?("localizations")
+
+        value["localizations"].each do |lang, _loc|
+          @languages << lang
+        end
+      end
+      @languages.uniq!
+    end
+  end
+end

data/lib/loco_strings/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LocoStrings
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/loco_strings.rb

@@ -3,6 +3,7 @@
 require_relative "loco_strings/version"
 require_relative "loco_strings/parsers/android_file"
 require_relative "loco_strings/parsers/ios_file"
+require_relative "loco_strings/parsers/xcstrings_file"
 
 # LocoStrings is a Ruby gem for working with iOS and Android localization strings.
 module LocoStrings
@@ -12,17 +13,23 @@ module LocoStrings
     def initialize(key, value, comment = nil)
       super
     end
+
+    def to_s
+      "Key: #{key}, Value: #{value}, Comment: #{comment || "None"}"
+    end
   end
 
   def self.load(file_path)
     ext = File.extname(file_path)
-    raise Error, "Unsupported file format: #{ext}" unless [".strings", ".xml"].include? ext
+    raise Error, "Unsupported file format: #{ext}" unless [".strings", ".xml", ".xcstrings"].include? ext
 
     case ext
     when ".strings"
       IosFile.new file_path
     when ".xml"
       AndroidFile.new file_path
+    when ".xcstrings"
+      XCStringsFile.new file_path
     else
       raise Error, "Not implemented"
     end

data/loco_strings.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# rubocop:disable Layout/LineLength
+
+require_relative "lib/loco_strings/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "loco_strings"
+  spec.version = LocoStrings::VERSION
+  spec.authors = ["Aleksei Cherepanov"]
+  spec.email = ["ftp27host@gmail.com"]
+
+  spec.summary = "LocoStrings is a Ruby gem for working with iOS and Android localization strings."
+  spec.description = "LocoStrings is a powerful and easy-to-use Ruby gem that simplifies the process of managing localization strings for iOS and Android apps. With LocoStrings, you can easily extract, organize, and update your app's localized strings in one place, making it easy to maintain consistency across all of your app's translations. LocoStrings supports multiple file formats, including XLIFF and CSV, and provides a simple and intuitive API for working with your app's strings in code. Whether you're a solo developer or part of a team, LocoStrings makes managing your app's localization a breeze."
+  spec.homepage = "https://github.com/ftp27/loco_strings"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "nokogiri", "~> 1.13", ">= 1.13.8"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end
+
+# rubocop:enable Layout/LineLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loco_strings
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Aleksei Cherepanov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+date: 2023-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -56,7 +56,9 @@ files:
 - lib/loco_strings/parsers/android_file.rb
 - lib/loco_strings/parsers/ios_file.rb
 - lib/loco_strings/parsers/loco_file.rb
+- lib/loco_strings/parsers/xcstrings_file.rb
 - lib/loco_strings/version.rb
+- loco_strings.gemspec
 - sig/loco_strings.rbs
 homepage: https://github.com/ftp27/loco_strings
 licenses:
@@ -79,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: LocoStrings is a Ruby gem for working with iOS and Android localization strings.