xliff 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab1e4614db50aed2434bfb0dd40806e26d7316df9267ddc0214b53ac6ad282a4
+  data.tar.gz: fb97a9d1e8a95b06a625ca35f6d123c7438ca635b73e4f3df223655aeaa06170
+SHA512:
+  metadata.gz: 25adf170edb6cf6810feed9399adb423320a87a8f9ed01c7564e836b6a9b274c450f1c02f9c14ccdd78d1035c7f9cd2b44b1cfb24ce8299e1f5e4e6c34feb2e1
+  data.tar.gz: aac73d5358320549c165b6e6bbd0f7224a5e1215575c4de3ab120e45fd4483cd1cc6b47077f575c7bacdc3121ebbd881cdaed5b7d6aafdc12f2f12d80132052e

data/.buildkite/pipeline.yml

@@ -0,0 +1,95 @@
+# Nodes with values to reuse in the pipeline.
+common_params:
+  plugins:
+  - &docker_plugin
+    docker#v3.8.0:
+      image: &ruby_version "ruby:2.7.4"
+      propagate-environment: true
+      environment:
+        - "RUBYGEMS_API_KEY"
+  - &docker_plugin_with_danger_token
+    docker#v3.8.0:
+      image: *ruby_version
+      propagate-environment: true
+      environment:
+        - "DANGER_GITHUB_API_TOKEN"
+
+steps:
+  #################
+  # Build and Test
+  #################
+  - label: "🧪 Build and Test"
+    key: test
+    command: |
+      bundle install
+
+      echo "--- :rubocop: Run Tests"
+      bundle exec rspec
+    plugins: [*docker_plugin]
+
+  #################
+  # Lint (Code)
+  #################
+  - label: "🧹 Lint (Rubocop)"
+    key: rubocop
+    command: |
+      bundle install
+
+      echo "--- :rubocop: Run Rubocop"
+      bundle exec rubocop
+    plugins: [*docker_plugin]
+
+  #################
+  # Lint (Documentation)
+  #################
+  - label: "🧹 Lint (Yardstick)"
+    key: yardstick
+    command: |
+      bundle install
+      bundle exec rake yardstick_measure
+      bundle exec rake verify_measurements
+    plugins: [*docker_plugin]
+
+  #################
+  # Check Lockfile
+  #################
+  - label: "🧹 Check Lockfile"
+    key: lockfile
+    command: |
+      bundle install
+      bundle check
+    plugins: [*docker_plugin]
+
+  #################
+  # Danger
+  #################
+  - label: "⛔️ Danger"
+    key: danger
+    command: |
+      bundle install
+
+      echo "--- :rspec: Generate Code Coverage Data"
+      bundle exec rspec
+
+      echo "--- :warning: Run Danger"
+      bundle exec danger
+    plugins: [*docker_plugin_with_danger_token]
+
+  #################
+  # Push to RubyGems
+  #################
+  - label: ":rubygems: Publish to RubyGems"
+    key: "gem-push"
+    if: build.tag != null
+    depends_on:
+     - test
+     - rubocop
+     - danger
+     - lockfile
+    # Note: We intentionally call a separate `.sh` script here (as opposed to having all the
+    # commands written inline) to avoid leaking a key used in the process in clear in the
+    # BUILDKITE_COMMAND environment variable.
+    command: .buildkite/gem-push.sh
+    plugins: [*docker_plugin]
+    agents:
+      queue: "default"

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_PATH: "vendor/bundle"

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  TargetRubyVersion: 2.7.4
+  NewCops: enable
+
+# Don't fail for having too many tests
+Metrics/BlockLength:
+  AllowedMethods: ['describe']
+
+require:
+  - rubocop-rspec
+  - rubocop-rake

data/.ruby-version

@@ -0,0 +1 @@
+2.7.4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-04-23
+
+- Initial release

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 1123407+jkmassel@users.noreply.github.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/Dangerfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Report Rubocop Violations
+github.dismiss_out_of_range_messages
+rubocop.lint(
+  inline_comment: true,
+  fail_on_inline_comment: true,
+  report_danger: true
+)
+
+# Report Test Coverage
+simplecov.individual_report('coverage/coverage.json', Dir.pwd)

data/Gemfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xliff.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.21'
+gem 'rubocop-rake', '~> 0.6.0'
+gem 'rubocop-rspec', '~> 2.10'
+
+gem 'simplecov', '~> 0.21.2'
+gem 'simplecov-json', '~> 0.2'
+
+gem 'danger', '~> 8.6'
+gem 'danger-rubocop', '~> 0.10'
+gem 'danger-simplecov_json', '~> 0.3'
+
+gem 'yard', '~> 0.9.27'
+gem 'yardstick', '~> 0.9.9'

data/Gemfile.lock

@@ -0,0 +1,177 @@
+PATH
+  remote: .
+  specs:
+    xliff (1.0.0)
+      nokogiri (~> 1.13)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    claide (1.1.0)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (8.6.1)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (>= 0.9.0, < 2.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (>= 1, < 4)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    danger-rubocop (0.12.0)
+      danger
+      rubocop (~> 1.0)
+    danger-simplecov_json (0.3.0)
+      danger-plugin-api (~> 1.0)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faraday (1.10.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-http-cache (2.5.1)
+      faraday (>= 0.8)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    git (1.19.1)
+      addressable (~> 2.8)
+      rchardet (~> 1.8)
+    json (2.7.1)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    language_server-protocol (3.17.0.3)
+    mini_portile2 (2.8.5)
+    multipart-post (2.3.0)
+    nap (1.1.0)
+    no_proxy_fix (0.1.2)
+    nokogiri (1.15.5)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    octokit (4.25.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
+    open4 (1.3.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rchardet (1.8.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    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.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.60.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.26.1)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov-json (0.2.3)
+      json
+      simplecov
+    simplecov_json_formatter (0.1.4)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.5.0)
+    yard (0.9.34)
+    yardstick (0.9.9)
+      yard (~> 0.8, >= 0.8.7.2)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-19
+  x86_64-darwin-20
+
+DEPENDENCIES
+  danger (~> 8.6)
+  danger-rubocop (~> 0.10)
+  danger-simplecov_json (~> 0.3)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.10)
+  simplecov (~> 0.21.2)
+  simplecov-json (~> 0.2)
+  xliff!
+  yard (~> 0.9.27)
+  yardstick (~> 0.9.9)
+
+BUNDLED WITH
+   2.3.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Jeremy Massel
+
+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/Makefile

@@ -0,0 +1,15 @@
+test:
+	docker run -v $(shell pwd):/app -w /app public.ecr.aws/docker/library/ruby:2.7.4-bullseye /bin/bash -c "bundle install && bundle exec rspec"
+
+lint:
+	docker run -v $(shell pwd):/app -w /app public.ecr.aws/docker/library/ruby:2.7.4-bullseye /bin/bash -c "bundle install && bundle exec rubocop"
+
+update-dependencies:
+	docker run -v $(shell pwd):/app -w /app public.ecr.aws/docker/library/ruby:2.7.4-bullseye /bin/bash -c "bundle update"
+
+bundle-check:
+	docker run -v $(shell pwd):/app -w /app public.ecr.aws/docker/library/ruby:2.7.4-bullseye /bin/bash -c "bundle install && bundle check"
+
+build:
+	docker run -v $(shell pwd):/app -w /app public.ecr.aws/docker/library/ruby:2.7.4-bullseye /bin/bash -c "gem build xliff.gemspec"
+

data/README.md

@@ -0,0 +1,62 @@
+# Xliff
+
+This gem is for parsing and building `xliff` files.
+
+## Usage
+
+The gem is meant to handle two tasks – reading `xliff` files and creating new ones. 
+
+### Reading `xliff` files
+
+```ruby
+bundle = Xliff::Bundle.from_path('path/to/my/file.xliff')
+bundle.files.each do |file|
+    puts "File: #{file.original}:"
+    file.entries.each do |entry|
+        puts "#{entry.source}:#{entry.target}"
+    end
+end
+```
+
+### Creating `xliff` files
+```ruby
+
+bundle = Xliff::Bundle.new(path: 'path/to/my/file.xliff')
+file = Xliff::File.new(original: 'info.plist', source_language: 'en', target_language: 'fr')
+entry = Xliff::Entry.new(id: 1234, source: 'hello', target: 'bounjour')
+file.add_entry(entry)
+bundle.add_file(file)
+
+xml = bundle.to_s
+```
+
+In the above example, `xml` reads:
+
+```xml
+<xliff>
+  <file original="info.plist" source-language="en" target-language="fr" datatype="plaintext">
+    <body>
+      <trans-unit id="1234" xml:space="default">
+        <source>hello</source>
+        <target>bounjour</target>
+      </trans-unit>
+    </body>
+  </file>
+</xliff>
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bundle exec console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/automattic/xliff. 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/automattic/xliff/blob/trunk/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 Xliff project's codebase and issue tracker is expected to follow the [code of conduct](https://github.com/automattic/xliff/blob/trunk/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+abort 'Please run rake using `bundle exec`' unless %w[BUNDLE_BIN_PATH BUNDLE_GEMFILE].any? { |k| ENV.key?(k) }
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[rubocop:auto_correct spec]
+
+## Documentation Coverage
+require 'yardstick/rake/measurement'
+require 'yardstick/rake/verify'
+
+Yardstick::Rake::Measurement.new(:yardstick_measure) do |measurement|
+  measurement.output = 'coverage/yard-coverage.txt'
+end
+
+Yardstick::Rake::Verify.new do |verify|
+  verify.threshold = 91.9
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# require 'bundler/setup'
+require 'xliff'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/lib/xliff/bundle.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+
+module Xliff
+  # Models a collection of files for translation
+  class Bundle
+    # An array of translated files in this bundle
+    # @return [Array<File>]
+    # @api public
+    # @example Retrieve the bundle's files
+    #   "bundle.files" #=> [{File}]
+    attr_reader :files
+
+    # The path on disk that this bundle was read from
+    # @!attribute [rw] path
+    # @return [String]
+    # @api public
+    # @example Retrieve the bundle path
+    #   "bundle.path" #=> /tmp/foo.xliff
+    attr_accessor :path
+
+    # Create a blank {Bundle} object, suitable for building an XLIFF file by hand
+    #
+    # @param [String] path An optional path to where the file should be stored on disk.
+    # @example Create an empty XLIFF bundle
+    #   bundle.new
+    # @example Create an empty XLIFF bundle with a pre-specified path
+    #   bundle.new(path: /path/to/my/output/file.xliff)
+    def initialize(path: nil)
+      @path = path
+      @files = []
+    end
+
+    # Add an additional {File} object to the bundle
+    #
+    # @param [File] file The file to be stored in the bundle.
+    # @example Add a new file to the bundle
+    #   file = File.new(...)
+    #   bundle.add_file(file)
+    # @return
+    def add_file(file)
+      @files << file
+    end
+
+    # Find a given file by name
+    #
+    # If two files exist with the same name, only the first will be returned.
+    #
+    # @param [String] name The name of the file to locate. If found it is returned.
+    # @example Look up an existing file
+    #   # Bundle contains two files: [foo.txt, bar.txt]
+    #   bundle.file_named('foo.txt') => {File}
+    # @example Look up a non-existent file
+    #   # Bundle contains two files: [foo.txt, bar.txt]
+    #   bundle.file_named('baz.txt') => nil
+    # @return [File, nil] The file, if found.
+    def file_named(name)
+      @files.find do |file|
+        file.original == name || ::File.basename(f.original) == name
+      end
+    end
+
+    # Encode this {Bundle} object as an XLIFF document
+    #
+    # @return [Nokogiri::XML::Document]
+    def to_xml
+      document = Nokogiri::XML::Document.new
+      document.encoding = 'UTF-8'
+
+      xliff_node = document.create_element('xliff')
+      attach_xliff_metadata(xliff_node)
+
+      return document if @files.empty?
+
+      @files.each do |file|
+        xliff_node.add_child(file.to_xml)
+      end
+
+      document.add_child(xliff_node)
+
+      document
+    end
+
+    # Encode this {Bundle} object as an XLIFF document string
+    #
+    # @return [String]
+    def to_s
+      to_xml.to_s.strip
+    end
+
+    # Parse the XLIFF file at the given `path` as an XLIFF {Bundle} object
+    #
+    # Raises for invalid input
+    #
+    # @param [String] path The path to an `xliff` file.
+    # @return [Bundle, nil]
+    def self.from_path(path)
+      xml = Nokogiri::XML(::File.open(path))
+      bundle = from_xml(xml)
+      bundle.path = path
+
+      bundle
+    end
+
+    # Parse the XLIFF file stored in the given `string` as an XLIFF {Bundle} object
+    #
+    # Raises for invalid input
+    #
+    # @param [String] string A string containing XLIFF data.
+    # @return [Xliff::Bundle, nil]
+    def self.from_string(string)
+      xml = Nokogiri::XML(string)
+      from_xml(xml)
+    end
+
+    # Parse the Nokogiri XML representation of an XLIFF file to a {Bundle} object
+    #
+    # Raises for invalid input
+    #
+    # @param [Nokogiri::XML::Element] xml A Nokogiri XML document containing XLIFF data.
+    # @return [Bundle, nil]
+    def self.from_xml(xml)
+      raise if xml.nil?
+
+      raise 'Invalid XLIFF file – the root node must be `<xliff>`' if xml.document.root.name != 'xliff'
+
+      bundle = Bundle.new
+
+      xml.document.root.element_children
+         .select { |node| node.name == 'file' }
+         .each { |node| bundle.add_file File.from_xml(node) }
+
+      bundle
+    end
+
+    private
+
+    # Attach the required XLIFF metadata to the given `node`
+    #
+    # Currently only supports XLIFF 1.2.
+    # @api private
+    # @return [void]
+    def attach_xliff_metadata(node)
+      node['xmlns'] = 'urn:oasis:names:tc:xliff:document:1.2'
+      node['xmlns:xsi'] = 'http://www.w3.org/2001/XMLSchema-instance'
+      node['version'] = '1.2'
+      node['xsi:schemaLocation'] = 'urn:oasis:names:tc:xliff:document:1.2 http://docs.oasis-open.org/xliff/v1.2/os/xliff-core-1.2-strict.xsd'
+    end
+  end
+end

data/lib/xliff/entry.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+
+module Xliff
+  # Models a single translation string
+  class Entry
+    # A unique identifier for this translation string
+    #
+    # This will often match the source language string, but can also be used for cases where the
+    # source translation is not a suitable unique identifier.
+    #
+    # @return [String]
+    attr_accessor :id
+
+    # The original text
+    # @return [String]
+    attr_accessor :source
+
+    # The translated text
+    # @return [String]
+    attr_accessor :target
+
+    # Documentation for translators understand the context of a string
+    # @return [String]
+    attr_accessor :note
+
+    # The XML whitespace processing behaviour
+    # @return [String]
+    attr_accessor :xml_space
+
+    # Create a blank Entry object
+    #
+    # Most often used to build an XLIFF file by hand.
+    #
+    # @param [String] id A unique identifier for this string.
+    # @param [String] source The original text.
+    # @param [String] target The translated text.
+    # @param [String] note Documentation for translators understand the context of a string.
+    # @param [String] xml_space The XML whitespace processing behaviour.
+    def initialize(id:, source:, target:, note: nil, xml_space: 'default')
+      @id = id
+      @source = source
+      @target = target
+      @note = note
+      @xml_space = xml_space
+    end
+
+    # Encode this `Entry` object to an Nokogiri XML Element Representation of a `<trans-unit>` element
+    #
+    # @return [Nokogiri::XML::Element]
+    def to_xml
+      fragment = Nokogiri::XML.fragment('<trans-unit />')
+      trans_unit_node = fragment.at('trans-unit')
+      trans_unit_node['id'] = @id
+      trans_unit_node['xml:space'] = @xml_space
+
+      trans_unit_node.add_leaf_node(element: 'source', content: @source)
+      trans_unit_node.add_leaf_node(element: 'target', content: @target)
+
+      return trans_unit_node if @note.nil?
+
+      trans_unit_node.add_leaf_node(element: 'note', content: @note)
+
+      trans_unit_node
+    end
+
+    # Encode this `Entry` object to an XML string
+    #
+    # @return [String]
+    def to_s
+      to_xml.to_s.strip
+    end
+
+    # Decode the given XML into an `Entry` object, if possible
+    #
+    # Raises for invalid input
+    #
+    # @return [Entry, nil]
+    def self.from_xml(xml)
+      validate_source_xml(xml)
+
+      Entry.new(
+        id: xml['id'],
+        source: xml.at('source').content,
+        target: xml.at('target').content,
+        note: xml.at('note').content || nil,
+        xml_space: xml['xml:space']
+      )
+    end
+
+    # Validate the given XML to ensure that it's a valid `<trans-unit>` element
+    #
+    # @return [void]
+    def self.validate_source_xml(xml)
+      raise 'Entry XML is nil' if xml.nil?
+      raise "Invalid Entry XML – must be a nokogiri object, got `#{xml.class}`" unless xml.is_a? Nokogiri::XML::Element
+      raise 'Invalid Entry XML – the root node must be `<trans-unit>`' if xml.name != 'trans-unit'
+    end
+  end
+end

data/lib/xliff/file.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module Xliff
+  # Models a single file for translation
+  class File
+    #  The file's headers
+    # @return [Array<Header>]
+    attr_reader :headers
+
+    # The file's translation entries
+    # @return [Array<Header>]
+    attr_reader :entries
+
+    # The file's name in the original project (used for reference when translating)
+    # @return [String]
+    attr_reader :original
+
+    # The locale code for the source language
+    #
+    # @return [String]
+    attr_reader :source_language
+
+    # The locale code for the translated language
+    #
+    # This usually matches the `source_language` for files to be translated – it will differ if the file has
+    # been translated.
+    #
+    # @return [String]
+    attr_reader :target_language
+
+    # The type of data represented
+    #
+    # There are a variety of programming languages that can be represented by the XLIFF spec. Defaults to `plaintext`.
+    # @return [String]
+    attr_reader :datatype
+
+    # Create a blank File object
+    #
+    # Most often used to build an XLIFF file by hand.
+    #
+    # @param [String] original The original file name.
+    # @param [String] source_language The locale code for the source language.
+    # @param [String] target_language The locale code for the translated language.
+    # @param [String] datatype The type of data represented.
+    def initialize(original:, source_language:, target_language:, datatype: 'plaintext')
+      @original = original
+      @source_language = source_language
+      @target_language = target_language
+      @datatype = datatype
+
+      @headers = []
+      @entries = []
+    end
+
+    # Add arbitrary header data to the file
+    #
+    # @param [Xliff::Header] header A translation file header.
+    # @return [void]
+    def add_header(header)
+      raise unless header.is_a? Xliff::Header
+
+      @headers << header
+    end
+
+    # Add a translation entry to the file
+    #
+    # @param [Xliff::Entry] entry A translation unit.
+    # @return [void]
+    def add_entry(entry)
+      raise unless entry.is_a? Xliff::Entry
+
+      @entries << entry
+    end
+
+    # Find the first entry with a given `id`, if present
+    #
+    # @param [String] entry The `id` to search for.
+    # @return [Xliff::Entry, nil]
+    def entry_with_id(id)
+      @entries.find do |entry|
+        entry.id == id
+      end
+    end
+
+    # Encode this {File} object as an XLIFF document fragment representing the {File}
+    #
+    # Also encodes any headers and translation strings as children of the `File` element.
+    #
+    # @return [Nokogiri::XML.fragment]
+    def to_xml
+      fragment = Nokogiri::XML.fragment('')
+      file_node = fragment.document.create_element('file')
+      file_node['original'] = @original
+      file_node['source-language'] = @source_language
+      file_node['target-language'] = @target_language
+      file_node['datatype'] = @datatype
+
+      add_headers_to_file(fragment, file_node)
+      add_entries_to_file(fragment, file_node)
+
+      file_node
+    end
+
+    # Encode this {File} object to an XML string
+    #
+    # @return [String]
+    def to_s
+      to_xml.to_xml
+    end
+
+    # Decode the given XML into an {Xliff::File} object, if possible
+    #
+    # Raises for invalid input, and parses all child translation entries.
+    #
+    # @param [Nokogiri::XML::Element, #read] xml An XLIFF `<file>` fragment.
+    # @return [File]
+    def self.from_xml(xml)
+      validate_source_xml(xml)
+
+      file = File.new(
+        original: xml['original'],
+        source_language: xml['source-language'],
+        target_language: xml['target-language'],
+        datatype: xml['datatype'] || nil
+      )
+
+      import_file_header(xml, file)
+      import_file_body(xml, file)
+
+      file
+    end
+
+    # Run a series of validations against the input XML
+    #
+    # Automatically run prior to attempting to parse using `from_xml`.
+    #
+    # @raise [ExceptionClass] Raises exceptions if the input XML does not match expectations.
+    # @return [void]
+    def self.validate_source_xml(xml)
+      raise 'File XML is nil' if xml.nil?
+      raise "Invalid File XML – must be a nokogiri object, got `#{xml.class}`" unless xml.is_a? Nokogiri::XML::Element
+      raise 'Invalid File XML – the root node must be `<file>`' if xml.name != 'file'
+    end
+
+    # Import File Header Tags from given XML
+    #
+    # Parses the `<header>` XML tag and imports any headers into the file.
+    #
+    # @api private
+    # @param [Nokogiri::XML::Element, #read] xml An XLIFF `<file>` fragment.
+    # @param [File] file The {File} object being created.
+    # @return [void]
+    private_class_method def self.import_file_header(xml, file)
+      return if xml.at('header').nil?
+
+      xml.at('header').element_children.each { |node| file.add_header Header.from_xml(node) }
+    end
+
+    # Import File <trans-unit> Tags from given XML
+    #
+    # Parses the `<body>` XML tag and imports any translation entries into the file.
+    #
+    # @api private
+    # @param [Nokogiri::XML::Element, #read] xml An XLIFF `<file>` fragment.
+    # @param [File] file The {File} object being created.
+    # @return [void]
+    private_class_method def self.import_file_body(xml, file)
+      return if xml.at('body').nil?
+
+      xml.at('body').element_children.each { |node| file.add_entry Entry.from_xml(node) }
+    end
+
+    private
+
+    # Encode the file headers into their XML representation
+    #
+    # @api private
+    # @return [void]
+    def add_headers_to_file(fragment, node)
+      return if @headers.empty?
+
+      header = Nokogiri::XML::Node.new('header', fragment.document)
+      @headers.each do |h|
+        header.add_child(h.to_xml)
+      end
+      node.add_child(header)
+    end
+
+    # Encode the file's translation entries into their XML representation
+    #
+    # @api private
+    # @return [void]
+    def add_entries_to_file(fragment, node)
+      return if @entries.empty?
+
+      body = Nokogiri::XML::Node.new('body', fragment.document)
+      @entries.each do |entry|
+        body.add_child(entry.to_xml)
+      end
+      node.add_child(body)
+    end
+  end
+end

data/lib/xliff/header.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+
+module Xliff
+  # Models a file header.
+  #
+  # Headers have an element and a set of key/value pairs encoded as XML attributes.
+  class Header
+    # This header's element
+    # @return [String]
+    attr_reader :element
+
+    # This header's element
+    # @return [Hash<String, String>]
+    attr_reader :attributes
+
+    # Create a blank Header object
+    #
+    # Most often used to build an XLIFF file by hand.
+    #
+    # @param [String] element The XML element to use.
+    # @param [String: String] attributes Any attributes that should be set on the header.
+    def initialize(element: nil, attributes: {})
+      @element = element
+      @attributes = attributes.transform_values(&:to_s)
+    end
+
+    # Encode this {Xliff::Header} object as an Nokogiri XML Element Representation of this header's expected element
+    #
+    # @return [Nokogiri::XML.fragment]
+    def to_xml
+      fragment = Nokogiri::XML.fragment('')
+      node = fragment.document.create_element(@element)
+
+      @attributes.each do |key, value|
+        node[key] = value
+      end
+
+      node
+    end
+
+    # Encode this {Header} object to an XML string
+    #
+    # @return [String]
+    def to_s
+      to_xml.to_xml
+    end
+
+    # Decode the given XML into an {Xliff::Header} object, if possible
+    #
+    # Raises for invalid input.
+    #
+    # @param [Nokogiri::XML::Element] xml An XLIFF header fragment.
+    # @return [Header]
+    def self.from_xml(xml)
+      raise 'Header XML is nil' if xml.nil?
+      raise "Invalid Header XML – must be a nokogiri object, got `#{xml.class}`" unless xml.is_a? Nokogiri::XML::Element
+
+      Header.new(
+        element: xml.name,
+        attributes: xml.keys.to_h { |k| [k, xml[k]] }
+      )
+    end
+  end
+end

data/lib/xliff/xml_extensions.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Extensions of the Nokogiri gem for use with this project.
+module Nokogiri
+  # Customizations to the Nokogiri XML namespace.
+  module XML
+    # Helpers for operating on XML Elements
+    class Element
+      # Adds a simple Text Node as a child element
+      #
+      # @param [String] element The XML tag name to use.
+      # @param [String] content The text contents of the XML tag.
+      # @example Look up an existing file
+      #   # To Generate <text>Hello World</text>:
+      #   xml.add_leaf_node(element: 'text', content: 'Hello World')
+      # @api private
+      # @return [Void]
+      def add_leaf_node(element:, content:)
+        node = document.create_element(element)
+        node.content = content
+        add_child(node)
+      end
+    end
+  end
+end

data/lib/xliff.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'xliff/bundle'
+require_relative 'xliff/entry'
+require_relative 'xliff/file'
+require_relative 'xliff/header'
+require_relative 'xliff/xml_extensions'
+
+# Namespace for classes and modules that handle building and parsing XLIFF files.
+# @api public
+module Xliff; end

data/sig/xliff.rbs

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

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: xliff
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Automattic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+description: Read and write xliff files
+email:
+- mobile@automattic.com
+executables:
+- console
+extensions: []
+extra_rdoc_files: []
+files:
+- ".buildkite/pipeline.yml"
+- ".bundle/config"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Dangerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- lib/xliff.rb
+- lib/xliff/bundle.rb
+- lib/xliff/entry.rb
+- lib/xliff/file.rb
+- lib/xliff/header.rb
+- lib/xliff/xml_extensions.rb
+- sig/xliff.rbs
+homepage: https://github.com/automattic/xliff
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/automattic/xliff
+  source_code_uri: https://github.com/automattic/xliff
+  changelog_uri: https://github.com/automattic/xliff/CHANGELOG.md
+  rubygems_mfa_required: 'false'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Manage xliff files from Ruby
+test_files: []