loco_strings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b2e8a8916f1d69b0a109b7a17e68793cbe20eedaa762cc74653f4090048a3cd6
+  data.tar.gz: aa5bec6952605aacca4cf1c17a8e07cc10f998cb9192c6671eddbcb944236a0e
+SHA512:
+  metadata.gz: 5c2a073409fd64b8a2fc81de277729e73edaccd32889b9e9e63e7fb501d9929dd328451c9c1e6f304e188ac548284282ea26bc0e31154f27c1fa2cb71901b054
+  data.tar.gz: 539910989439ece0351c2afc033e53246b945716847884c5b292a0358abd6b191a8f53389de9d39f2d4bb0911d9d97a416474e666ea8516601bd87018db2056f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at ftp27host@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in loco_strings.gemspec
+gemspec
+
+gem "nokogiri", "~> 1.14", ">= 1.14.3"
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    loco_strings (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    nokogiri (1.14.3-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.14.3-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  loco_strings!
+  nokogiri (~> 1.14, >= 1.14.3)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.12

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Aleksei Cherepanov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,115 @@
+# LocoStrings
+
+LocoStrings is a Ruby gem that provides utilities for working with localization strings in iOS and Android applications.
+
+If you're an iOS or Android developer, you know how important it is to properly localize your apps for different languages and regions. However, managing localization files can be a tedious and error-prone task, especially as your app grows and supports more languages.
+
+That's where LocoStrings comes in. With LocoStrings, you can easily parse and manipulate localization strings in both iOS `.strings` and Android `strings.xml` formats, allowing you to automate common localization tasks and ensure the accuracy and consistency of your translations.
+
+In this README, we'll show you how to install and use LocoStrings in your Ruby projects. Let's get started!
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add loco_strings
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install loco_strings
+
+## Usage
+
+LocoStrings is a Ruby gem that can be used to manage and manipulate strings in iOS and Android applications. It supports two file formats: iOS strings files and Android XML files. The gem provides a simple and intuitive API to read, write, update, and delete strings.
+
+To use the gem in your project, you can install it by adding the following line to your Gemfile:
+
+```ruby
+gem 'loco_strings'
+```
+
+Then, run `bundle install` to install the gem.
+
+After installing the gem, you can use the `load` method to load a strings file. The method takes one argument, which is the path to the strings file.
+
+```ruby
+strings = LocoStrings.load("path/to/strings/file")
+```
+
+You can then use the `read` method to read the strings from the file. The method returns a hash where the keys are the string keys and the values are instances of the `LocoString` class.
+
+```ruby
+strings_hash = strings.read
+```
+
+You can access the values in the hash using the keys.
+
+```ruby
+value = strings_hash["key"]
+```
+
+You can update a string by using the `update` method. The method takes two or three arguments: the key, the new value, and optionally a new comment.
+
+```ruby
+strings.update("key", "new value", "new comment")
+```
+
+You can delete a string by using the `delete` method. The method takes one argument, which is the key.
+
+```ruby
+strings.delete("key")
+```
+
+You can write the changes back to the file using the `write` method.
+
+```ruby
+strings.write
+```
+
+LocoStrings supports two file formats: iOS strings files and Android XML files. When you load a file, LocoStrings automatically detects the file format and returns an instance of the appropriate class: `IosFile` or `AndroidFile`.
+
+Here is an example of how to use LocoStrings to manage an iOS strings file:
+
+```ruby
+strings = LocoStrings.load("path/to/Localizable.strings")
+# Read the strings
+strings_hash = strings.read
+# Update a string
+strings.update("key", "new value")
+# Delete a string
+strings.delete("key")
+# Write the changes back to the file
+strings.write
+```
+
+And here is an example of how to use LocoStrings to manage an Android XML file:
+
+```ruby
+strings = LocoStrings.load("path/to/strings.xml")
+# Read the strings
+strings_hash = strings.read
+# Update a string
+strings.update("key", "new value")
+# Delete a string
+strings.delete("key")
+# Write the changes back to the file
+strings.write
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/ftp27/loco_strings](). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ftp27/loco_strings/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the LocoStrings project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ftp27/loco_strings/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/loco_strings/parsers/android_file.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "loco_file"
+require "nokogiri"
+
+module LocoStrings
+  # AndroidFile is a class for working with Android localization strings.
+  class AndroidFile < LocoFile
+    def read
+      clean
+      return @strings unless File.exist?(@file_path)
+
+      comment = nil
+      doc = Nokogiri::XML(File.open(@file_path))
+      doc.xpath("//resources").first.children.each do |child|
+        comment = extract_comment(child) || comment
+        value = extract_string(child, comment)
+        comment = nil if value
+      end
+      @strings
+    end
+
+    def write
+      builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
+        xml.resources do
+          @strings.each do |key, value|
+            xml.comment value.comment if value.comment
+            xml.string(value.value, name: key)
+          end
+        end
+      end
+      File.open(@file_path, "w") { |file| file.write(builder.to_xml) }
+    end
+
+    private
+
+    def extract_comment(child)
+      child.text.strip if child.comment?
+    end
+
+    def extract_string(child, comment)
+      return unless child.name == "string"
+
+      name = child.attr("name")
+      value = child.text
+      @strings[name] = LocoString.new name, value, comment
+      @strings[name]
+    end
+  end
+end

data/lib/loco_strings/parsers/ios_file.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "loco_file"
+
+module LocoStrings
+  # IosFile is a class for working with iOS localization strings.
+  class IosFile < LocoFile
+    def read
+      clean
+      return @strings unless File.exist?(@file_path)
+
+      comment = nil
+      file = File.read(@file_path)
+      file.split("\n").each do |line|
+        comment = extract_comment(line) || comment
+        value = extract_string(line, comment)
+        comment = nil if value
+      end
+      @strings
+    end
+
+    def write
+      output = ""
+      @strings.each do |key, value|
+        output += "/* #{value.comment} */\n" if value.comment
+        output += "\"#{key}\" = \"#{value.value}\";\n"
+      end
+      File.open(@file_path, "w") { |file| file.write(output) }
+    end
+
+    private
+
+    def extract_comment(line)
+      comment_match = line.match(%r{^/\*[\s\S]*?(.+)[\s\S]*?\*/$})
+      comment_match[1].strip if comment_match
+    end
+
+    def extract_string(line, comment)
+      value_match = line.match(/^"(.+)" = "(.+)";$/)
+      return unless value_match
+
+      name = value_match[1]
+      value = value_match[2]
+      @strings[name] = LocoString.new name, value, comment
+      @strings[name]
+    end
+  end
+end

data/lib/loco_strings/parsers/loco_file.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module LocoStrings
+  # LocoFile is a class for working with localization strings.
+  class LocoFile
+    attr_reader :file_path
+
+    def initialize(file_path)
+      @file_path = file_path
+      clean
+    end
+
+    def read
+      raise Error, "Not implemented"
+    end
+
+    def write
+      raise Error, "Not implemented"
+    end
+
+    def update_file_path(file_path)
+      @file_path = file_path
+    end
+
+    def update(key, value, comment = nil)
+      @strings[key] = LocoString.new key, value, comment
+    end
+
+    def delete(key)
+      @strings.delete key
+    end
+
+    def value(key)
+      @strings[key]
+    end
+
+    def clean
+      @strings = {}
+    end
+  end
+end

data/lib/loco_strings/version.rb

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

data/lib/loco_strings.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "loco_strings/version"
+require_relative "loco_strings/parsers/android_file"
+require_relative "loco_strings/parsers/ios_file"
+
+# LocoStrings is a Ruby gem for working with iOS and Android localization strings.
+module LocoStrings
+  class Error < StandardError; end
+
+  LocoString = Struct.new(:key, :value, :comment) do
+    def initialize(key, value, comment = nil)
+      super
+    end
+  end
+
+  def self.load(file_path)
+    ext = File.extname(file_path)
+    raise Error, "Unsupported file format: #{ext}" unless [".strings", ".xml"].include? ext
+
+    case ext
+    when ".strings"
+      IosFile.new file_path
+    when ".xml"
+      AndroidFile.new file_path
+    else
+      raise Error, "Not implemented"
+    end
+  end
+end

data/sig/loco_strings.rbs

@@ -0,0 +1,4 @@
+module LocoStrings
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: loco_strings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aleksei Cherepanov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-02 00:00:00.000000000 Z
+dependencies: []
+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.
+email:
+- ftp27host@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/loco_strings.rb
+- lib/loco_strings/parsers/android_file.rb
+- lib/loco_strings/parsers/ios_file.rb
+- lib/loco_strings/parsers/loco_file.rb
+- lib/loco_strings/version.rb
+- sig/loco_strings.rbs
+homepage: https://github.com/ftp27/loco_strings
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ftp27/loco_strings
+  source_code_uri: https://github.com/ftp27/loco_strings
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: LocoStrings is a Ruby gem for working with iOS and Android localization strings.
+test_files: []