dotstrings 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7f215ea68d4b6ce65de6f15811800b976eb722b89a4618bce4503338508df51
-  data.tar.gz: 51a72c22c7233b00df29f97d876abb3e59517de4bf0b78797ab8897d122250fe
+  metadata.gz: 334f5c70b24599274f9e48180edc217e272305dc0880ceceb12588314ee29173
+  data.tar.gz: de469892a932333e2995b0b9ee8919fed43861186805f343f6f0ba43e70d2297
 SHA512:
-  metadata.gz: 0d9247c103eb79e3e908a55af5661de97cae316cc36660c7c872a869f077a9875060eab7bab7caa0a9aa8c2ef82d6ce7c5b9acede49fa1227790b4aad53b205d
-  data.tar.gz: af144c8d6b3f9f552fc71db2df31db95f1189575fa8eb9e2c5f97ab0a15234024bcd97692218be4bbd04f7352f6a3d63966b4ff4948df84379158733583920ad
+  metadata.gz: 17b42c2392f3bb05695e64c0d8f61134f9b78edb598ccefbd90ace096705cf871b4861fac378646ace56ebc545e88987dd46c5342bebfa8d3575e957a45423d7
+  data.tar.gz: eeabf73dfe816634936ebf46eba3e09e729842c2af5497674e7ee3d474c46b7e58f7838904cb60c6c075e4c42a64b48a8e9b99d1624e2a39202e601492ef615a

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [v0.5.0] - 2022-09-24
+* Added `strict` parameter to the parser to allow for more lenient parsing. This is useful in cases where we don't want the parser to raise an error when encountering multiple comments or escaped characters that don't need to be escaped.
+
+## [v0.4.0] - 2022-09-18
+### Added
+* Added `DotStrings::File#each`, `DotStrings::File#length`, `DotStrings::File#count`, and `DotStrings::File#empty?` methods.
+* Allow comparing `DotStrings::File` objects.
+
 ## [v0.3.0] - 2022-08-07
 ### Changed
 * Improved unicode code point parsing and validation.
@@ -19,6 +27,9 @@
 ### Added
 * Initial release.
 
+[v0.5.0]: https://github.com/raymondjavaxx/dotstrings/releases/tag/v0.5.0
+[v0.4.0]: https://github.com/raymondjavaxx/dotstrings/releases/tag/v0.4.0
+[v0.3.0]: https://github.com/raymondjavaxx/dotstrings/releases/tag/v0.3.0
 [v0.2.0]: https://github.com/raymondjavaxx/dotstrings/releases/tag/v0.2.0
 [v0.1.1]: https://github.com/raymondjavaxx/dotstrings/releases/tag/v0.1.1
 [v0.1.0]: https://github.com/raymondjavaxx/dotstrings/releases/tag/v0.1.0

data/README.md

@@ -36,15 +36,32 @@ file.items.each do |item|
 end
 ```
 
-## Examples
+## Strict Mode
+
+By default, the parser runs in *strict mode*. This means that it will raise a `DotStrings::ParsingError` if it encounters comments that are not tied to a key-value pair. For example, the following file will raise an error because the first comment is not followed by a key-value pair:
 
-### Listing keys
+```
+/* Spanish localizations */
+
+/* Title for a button for accepting something */
+"Accept" = "Aceptar";
+```
+
+In *strict mode*, the parser will also raise an error if it encounters escaped characters that don't need to be escaped. For example, the following file will raise an error because the `?` character doesn't need to be escaped:
+
+```
+/* Confirmation message */
+"Are you sure\?" = "¿Estás seguro\?";
+```
+
+If you want to disable *strict mode*, you can pass `strict: false` to the `DotStrings.parse_file()` method. This will match the behavior of Apple's own parser, which is more lenient.
 
 ```ruby
-puts file.keys
-# => ["key 1", "key 2", ...]
+file = DotStrings.parse_file('es-ES/Localizable.strings', strict: false)
 ```
 
+## Examples
+
 ### Accessing items by key
 
 ```ruby
@@ -73,3 +90,5 @@ file << DotStrings::Item(
 ```ruby
 File.write('en-US/Localizable.strings', file.to_s)
 ```
+
+For more examples, consult the [documentation](https://www.rubydoc.info/gems/dotstrings/DotStrings) or the [test suite](test).

data/lib/dotstrings/file.rb

@@ -45,12 +45,13 @@ module DotStrings
     #   file = DotStrings::File.parse(io)
     #
     # @param io [IO] The IO object to parse.
+    # @param strict [Boolean] Whether to parse in strict mode.
     # @return [DotStrings::File] The parsed file.
     # @raise [DotStrings::ParsingError] if the file could not be parsed.
-    def self.parse(io)
+    def self.parse(io, strict: true)
       items = []
 
-      parser = Parser.new
+      parser = Parser.new(strict: strict)
       parser.on_item { |item| items << item }
       parser << normalize_encoding(io.read)
 
@@ -64,11 +65,12 @@ module DotStrings
     #   file = DotStrings::File.parse_file('path/to/en.lproj/Localizable.strings')
     #
     # @param path [String] The path to the file to parse.
+    # @param strict [Boolean] Whether to parse in strict mode.
     # @return [DotStrings::File] The parsed file.
     # @raise [DotStrings::ParsingError] if the file could not be parsed.
-    def self.parse_file(path)
+    def self.parse_file(path, strict: true)
       ::File.open(path, 'r') do |file|
-        parse(file)
+        parse(file, strict: strict)
       end
     end
 
@@ -131,6 +133,51 @@ module DotStrings
       self
     end
 
+    ##
+    # Calls the given block once for each item in the file.
+    #
+    # @param block [Proc] The block to call.
+    # @example
+    #   file.each do |item|
+    #     puts "#{item.key} > #{item.value}"
+    #   end
+    def each(&block)
+      @items.each(&block)
+      self
+    end
+
+    ##
+    # Returns the number of items in the file.
+    def length
+      @items.length
+    end
+
+    ##
+    # Returns the number of items in the file.
+    #
+    # If a block is given, it will count the number of items for which the block returns true.
+    #
+    # @example
+    #   file.count # => 10
+    #   file.count { |item| item.key.start_with?('button.') } # => 3
+    def count(&block)
+      @items.count(&block)
+    end
+
+    ##
+    # Returns `true` if the file doen't contain any items.
+    def empty?
+      @items.empty?
+    end
+
+    def ==(other)
+      eql?(other)
+    end
+
+    def eql?(other)
+      other.is_a?(self.class) && @items.eql?(other.items)
+    end
+
     ##
     # Serializes the file to a string.
     #

data/lib/dotstrings/item.rb

@@ -12,6 +12,17 @@ module DotStrings
       @value = value
     end
 
+    def ==(other)
+      eql?(other)
+    end
+
+    def eql?(other)
+      other.is_a?(Item) &&
+        comment == other.comment &&
+        key == other.key &&
+        value == other.value
+    end
+
     ##
     # Serializes the item to string.
     #

data/lib/dotstrings/parser.rb

@@ -7,6 +7,9 @@ module DotStrings
 
   ##
   # Parser for .strings files.
+  #
+  # You can use this class directly, but it is recommended to use
+  # {File.parse} and {File.parse_file} wrappers instead.
   class Parser
     # Special tokens
     TOK_SLASH        = '/'
@@ -39,7 +42,13 @@ module DotStrings
     STATE_UNICODE_SURROGATE   = 11
     STATE_UNICODE_SURROGATE_U = 12
 
-    def initialize
+    ##
+    # Returns a new Parser instance.
+    #
+    # @param strict [Boolean] Whether to parse in strict mode.
+    def initialize(strict: true)
+      @strict = strict
+
       @state = STATE_START
       @temp_state = nil
 
@@ -101,11 +110,7 @@ module DotStrings
             @buffer << ch
           end
         when STATE_COMMENT_END
-          if ch == TOK_QUOTE
-            @state = STATE_KEY
-          else
-            raise_error("Unexpected character '#{ch}'") unless whitespace?(ch)
-          end
+          comment_end(ch)
         when STATE_KEY
           parse_string(ch) do |key|
             @current_key = key
@@ -188,6 +193,8 @@ module DotStrings
       end
     end
 
+    # rubocop:disable Metrics/CyclomaticComplexity
+
     def parse_escaped_character(ch)
       @escaping = false
 
@@ -206,11 +213,15 @@ module DotStrings
       when TOK_ZERO
         @buffer << "\0"
       else
-        raise_error("Unexpected character '#{ch}'")
+        raise_error("Unexpected character '#{ch}'") if @strict
+        @buffer << ch
       end
     end
 
+    # rubocop:enable Metrics/CyclomaticComplexity
+
     # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
     def parse_unicode(ch, &block)
       raise_error("Unexpected character '#{ch}', expecting a hex digit") unless ch =~ TOK_HEX_DIGIT
 
@@ -267,19 +278,33 @@ module DotStrings
       end
     end
 
-    def start_value(ch)
+    def start_value(ch, resets: true)
       case ch
       when TOK_SLASH
         @state = STATE_COMMENT_START
-        reset_state
+        reset_state if resets
       when TOK_QUOTE
         @state = STATE_KEY
-        reset_state
+        reset_state if resets
       else
         raise_error("Unexpected character '#{ch}'") unless whitespace?(ch)
       end
     end
 
+    def comment_end(ch)
+      if @strict
+        # In strict mode, we expect a key to follow the comment.
+        if ch == TOK_QUOTE
+          @state = STATE_KEY
+        else
+          raise_error("Unexpected character '#{ch}'") unless whitespace?(ch)
+        end
+      else
+        # In lenient mode, we allow comments to be followed by anything.
+        start_value(ch, resets: false)
+      end
+    end
+
     def reset_state
       @current_comment = nil
       @current_key = nil

data/lib/dotstrings/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DotStrings
-  VERSION = '0.3.0'
+  VERSION = '0.5.0'
 end

data/lib/dotstrings.rb

@@ -12,9 +12,10 @@ module DotStrings
   # This is a convenience method for {DotStrings::File.parse}.
   #
   # @param io [IO] The IO object to parse.
+  # @param strict [Boolean] Whether to parse in strict mode.
   # @return [DotStrings::File] The parsed file.
-  def self.parse(io)
-    File.parse(io)
+  def self.parse(io, strict: true)
+    File.parse(io, strict: strict)
   end
 
   ##
@@ -23,8 +24,9 @@ module DotStrings
   # This is a convenience method for {DotStrings::File.parse_file}.
   #
   # @param path [String] The path to the .strings file to parse.
+  # @param strict [Boolean] Whether to parse in strict mode.
   # @return [DotStrings::File] The parsed file.
-  def self.parse_file(path)
-    File.parse_file(path)
+  def self.parse_file(path, strict: true)
+    File.parse_file(path, strict: strict)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotstrings
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ramon Torres
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-07 00:00:00.000000000 Z
+date: 2022-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,44 +116,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".rubocop.yml"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
-- Rakefile
-- dotstrings.gemspec
 - lib/dotstrings.rb
 - lib/dotstrings/errors.rb
 - lib/dotstrings/file.rb
 - lib/dotstrings/item.rb
 - lib/dotstrings/parser.rb
 - lib/dotstrings/version.rb
-- test/fixtures/escaped_backslashes.strings
-- test/fixtures/escaped_carriage_returns.strings
-- test/fixtures/escaped_new_lines.strings
-- test/fixtures/escaped_nil.strings
-- test/fixtures/escaped_quotes.strings
-- test/fixtures/escaped_single_quotes.strings
-- test/fixtures/escaped_tabs.strings
-- test/fixtures/escaped_unicode.strings
-- test/fixtures/escaped_unicode~bad_surrogate_order.strings
-- test/fixtures/escaped_unicode~duplicated_high_surrogate.strings
-- test/fixtures/escaped_unicode~incomplete_surrogate_pair.strings
-- test/fixtures/escaped_unicode~non_surrogate_after_high_surrogate.strings
-- test/fixtures/utf16be_bom.strings
-- test/fixtures/utf16le_bom.strings
-- test/fixtures/utf8_bom.strings
-- test/fixtures/valid.strings
-- test/test_dotstrings.rb
-- test/test_file.rb
-- test/test_helper.rb
-- test/test_item.rb
-- test/test_parser.rb
 homepage: https://github.com/raymondjavaxx/dotstrings
 licenses:
 - MIT
@@ -174,29 +145,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Parse and create .strings files used in localization of iOS and macOS apps.
-test_files:
-- test/fixtures/escaped_backslashes.strings
-- test/fixtures/escaped_carriage_returns.strings
-- test/fixtures/escaped_new_lines.strings
-- test/fixtures/escaped_nil.strings
-- test/fixtures/escaped_quotes.strings
-- test/fixtures/escaped_single_quotes.strings
-- test/fixtures/escaped_tabs.strings
-- test/fixtures/escaped_unicode.strings
-- test/fixtures/escaped_unicode~bad_surrogate_order.strings
-- test/fixtures/escaped_unicode~duplicated_high_surrogate.strings
-- test/fixtures/escaped_unicode~incomplete_surrogate_pair.strings
-- test/fixtures/escaped_unicode~non_surrogate_after_high_surrogate.strings
-- test/fixtures/utf16be_bom.strings
-- test/fixtures/utf16le_bom.strings
-- test/fixtures/utf8_bom.strings
-- test/fixtures/valid.strings
-- test/test_dotstrings.rb
-- test/test_file.rb
-- test/test_helper.rb
-- test/test_item.rb
-- test/test_parser.rb
+test_files: []

data/.editorconfig

@@ -1,13 +0,0 @@
-# EditorConfig is awesome: https://EditorConfig.org
-
-# top-most EditorConfig file
-root = true
-
-[*]
-end_of_line = lf
-insert_final_newline = true
-
-[{*.rb,Gemfile,Rakefile,*.yml}]
-charset = utf-8
-indent_style = space
-indent_size = 2

data/.github/workflows/ci.yml

@@ -1,33 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: "*"
-  pull_request:
-    branches: "*"
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version:
-          - "2.5"
-          - "2.6"
-          - "2.7"
-          - "3.0"
-          - "3.1"
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Lint
-      run: bundle exec rake rubocop
-    - name: Run tests
-      run: bundle exec rake
-    - name: Install
-      run: bundle exec rake install

data/.gitignore

@@ -1,5 +0,0 @@
-pkg
-.vscode
-coverage
-doc
-.yardoc

data/.rubocop.yml

@@ -1,41 +0,0 @@
-require:
-  - rubocop-rake
-  - rubocop-minitest
-
-AllCops:
-  TargetRubyVersion: 2.5
-  NewCops: enable
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: single_quotes
-
-Layout/FirstHashElementIndentation:
-  Enabled: true
-  EnforcedStyle: consistent
-
-Layout/FirstArrayElementIndentation:
-  Enabled: true
-  EnforcedStyle: consistent
-
-Metrics/ClassLength:
-  Enabled: true
-  Max: 150
-
-Naming/MethodParameterName:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/ParallelAssignment:
-  Enabled: false
-
-Minitest/AssertInDelta:
-  Enabled: false

data/Gemfile

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec

data/Gemfile.lock

@@ -1,57 +0,0 @@
-PATH
-  remote: .
-  specs:
-    dotstrings (0.3.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    docile (1.4.0)
-    minitest (5.15.0)
-    parallel (1.22.1)
-    parser (3.1.2.0)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.5.0)
-    rexml (3.2.5)
-    rubocop (1.28.2)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.17.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.0)
-      parser (>= 3.1.1.0)
-    rubocop-minitest (0.19.1)
-      rubocop (>= 0.90, < 2.0)
-    rubocop-rake (0.6.0)
-      rubocop (~> 1.0)
-    ruby-progressbar (1.11.0)
-    simplecov (0.21.2)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    unicode-display_width (2.2.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  dotstrings!
-  minitest (~> 5.14)
-  rake
-  rubocop
-  rubocop-minitest
-  rubocop-rake
-  simplecov
-
-BUNDLED WITH
-   2.2.18

data/Rakefile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-require 'rubocop/rake_task'
-
-Rake::TestTask.new
-RuboCop::RakeTask.new
-
-task default: :test

data/dotstrings.gemspec

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require './lib/dotstrings/version'
-
-Gem::Specification.new do |s|
-  s.name = 'dotstrings'
-  s.version = DotStrings::VERSION
-  s.platform = Gem::Platform::RUBY
-  s.authors = ['Ramon Torres']
-  s.email = ['raymondjavaxx@gmail.com']
-  s.homepage = 'https://github.com/raymondjavaxx/dotstrings'
-  s.description = s.summary = 'Parse and create .strings files used in localization of iOS and macOS apps.'
-  s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-  s.require_paths = ['lib']
-  s.license = 'MIT'
-
-  s.add_development_dependency 'bundler'
-  s.add_development_dependency 'minitest', '~> 5.14'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rubocop'
-  s.add_development_dependency 'rubocop-minitest'
-  s.add_development_dependency 'rubocop-rake'
-  s.add_development_dependency 'simplecov'
-
-  s.required_ruby_version = '>= 2.5.0'
-  s.metadata['rubygems_mfa_required'] = 'true'
-end

data/test/fixtures/escaped_backslashes.strings

@@ -1,2 +0,0 @@
-/* Escaped carriage backslashes */
-"some\\key" = "some\\value";

data/test/fixtures/escaped_carriage_returns.strings

@@ -1,2 +0,0 @@
-/* Escaped carriage returns */
-"some\rkey" = "some\rvalue";

data/test/fixtures/escaped_new_lines.strings

@@ -1,2 +0,0 @@
-/* Escaped new lines */
-"some\nkey" = "some\nvalue";

data/test/fixtures/escaped_nil.strings

@@ -1,2 +0,0 @@
-/* Escaped nil */
-"key\0" = "value\0";

data/test/fixtures/escaped_quotes.strings

@@ -1,2 +0,0 @@
-/* Escaped quotes */
-"some \"key\"" = "some \"value\"";

data/test/fixtures/escaped_single_quotes.strings

@@ -1,2 +0,0 @@
-/* Escaped quotes */
-"some \'key\'" = "some \'value\'";

data/test/fixtures/escaped_tabs.strings

@@ -1,2 +0,0 @@
-/* Escaped tabs */
-"some\tkey" = "some\tvalue";

data/test/fixtures/escaped_unicode.strings

@@ -1,2 +0,0 @@
-/* Unicode characters. Key is a dollar sign, value is: ⚡👻 */
-"\U0024" = "\U26A1\UD83D\UDC7B";

data/test/fixtures/escaped_unicode~bad_surrogate_order.strings

@@ -1 +0,0 @@
-"key" = "\UDC7B\UD83D";

data/test/fixtures/escaped_unicode~duplicated_high_surrogate.strings

@@ -1 +0,0 @@
-"key" = "\UD83D\UD83D";

data/test/fixtures/escaped_unicode~incomplete_surrogate_pair.strings

@@ -1 +0,0 @@
-"key" = "\UD83D";

data/test/fixtures/escaped_unicode~non_surrogate_after_high_surrogate.strings

@@ -1 +0,0 @@
-"key" = "\UD83D\U26A1";

data/test/fixtures/utf8_bom.strings

@@ -1,2 +0,0 @@
-/* Comment */
-"key" = "value";

data/test/fixtures/valid.strings

@@ -1,8 +0,0 @@
-// Single line comment
-"key 1" = "value 1";
-
-/* Multi line
-comment */
-"key 2" = "value 2";
-
-"key 3" = "value 3";

data/test/test_dotstrings.rb

@@ -1,126 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'test_helper'
-
-class TestDotStrings < MiniTest::Test
-  def test_parse_can_parse_valid_files
-    file = DotStrings.parse_file('test/fixtures/valid.strings')
-
-    assert_equal 3, file.items.size
-
-    assert_equal 'Single line comment', file.items[0].comment
-    assert_equal 'key 1', file.items[0].key
-    assert_equal 'value 1', file.items[0].value
-
-    assert_equal "Multi line\ncomment", file.items[1].comment
-    assert_equal 'key 2', file.items[1].key
-    assert_equal 'value 2', file.items[1].value
-  end
-
-  def test_can_parse_file_with_escaped_quotes
-    file = DotStrings.parse_file('test/fixtures/escaped_quotes.strings')
-
-    assert_equal 1, file.items.size
-    assert_equal 'some "key"', file.items[0].key
-    assert_equal 'some "value"', file.items[0].value
-  end
-
-  def test_can_parse_file_with_escaped_single_quotes
-    file = DotStrings.parse_file('test/fixtures/escaped_single_quotes.strings')
-
-    assert_equal 1, file.items.size
-    assert_equal 'some \'key\'', file.items[0].key
-    assert_equal 'some \'value\'', file.items[0].value
-  end
-
-  def test_can_parse_file_with_escaped_tabs
-    file = DotStrings.parse_file('test/fixtures/escaped_tabs.strings')
-
-    assert_equal 1, file.items.size
-    assert_equal "some\tkey", file.items[0].key
-    assert_equal "some\tvalue", file.items[0].value
-  end
-
-  def test_can_parse_files_with_escaped_carriage_returns
-    file = DotStrings.parse_file('test/fixtures/escaped_carriage_returns.strings')
-
-    assert_equal 1, file.items.size
-    assert_equal "some\rkey", file.items[0].key
-    assert_equal "some\rvalue", file.items[0].value
-  end
-
-  def test_can_parse_files_with_escaped_nil
-    file = DotStrings.parse_file('test/fixtures/escaped_nil.strings')
-
-    assert_equal 1, file.items.size
-    assert_equal "key\0", file.items[0].key
-    assert_equal "value\0", file.items[0].value
-  end
-
-  def test_can_parse_files_with_escaped_new_lines
-    file = DotStrings.parse_file('test/fixtures/escaped_new_lines.strings')
-
-    assert_equal 1, file.items.size
-    assert_equal "some\nkey", file.items[0].key
-    assert_equal "some\nvalue", file.items[0].value
-  end
-
-  def test_can_parse_files_with_escaped_backslashes
-    file = DotStrings.parse_file('test/fixtures/escaped_backslashes.strings')
-
-    assert_equal 1, file.items.size
-    assert_equal 'some\\key', file.items[0].key
-    assert_equal 'some\\value', file.items[0].value
-  end
-
-  def test_can_parse_files_with_escaped_unicode
-    file = DotStrings.parse_file('test/fixtures/escaped_unicode.strings')
-
-    assert_equal 1, file.items.size
-    assert_equal '$', file.items[0].key
-    assert_equal '⚡👻', file.items[0].value
-  end
-
-  def test_raises_error_when_bad_surrogate_pair_is_found
-    # rubocop:disable Layout/LineLength
-    test_cases = {
-      'escaped_unicode~bad_surrogate_order.strings' => 'Found a low surrogate code point before a high surrogate at line 1, column 15 (offset: 14)',
-      'escaped_unicode~duplicated_high_surrogate.strings' => 'Found a high surrogate code point after another high surrogate at line 1, column 21 (offset: 20)',
-      'escaped_unicode~incomplete_surrogate_pair.strings' => 'Unexpected character \'"\', expecting another unicode codepoint at line 1, column 16 (offset: 15)',
-      'escaped_unicode~non_surrogate_after_high_surrogate.strings' => 'Invalid unicode codepoint \'\U26A1\' after a high surrogate code point at line 1, column 21 (offset: 20)'
-    }
-    # rubocop:enable Layout/LineLength
-
-    test_cases.each do |filename, error_message|
-      error = assert_raises DotStrings::ParsingError do
-        DotStrings.parse_file("test/fixtures/#{filename}")
-      end
-
-      assert_equal error_message, error.message
-    end
-  end
-
-  def test_can_parse_utf16le_files_with_bom
-    file = DotStrings.parse_file('test/fixtures/utf16le_bom.strings')
-
-    assert_equal 1, file.items.size
-    assert_equal 'key', file.items[0].key
-    assert_equal 'value', file.items[0].value
-  end
-
-  def test_can_parse_utf16be_files_with_bom
-    file = DotStrings.parse_file('test/fixtures/utf16be_bom.strings')
-
-    assert_equal 1, file.items.size
-    assert_equal 'key', file.items[0].key
-    assert_equal 'value', file.items[0].value
-  end
-
-  def test_can_parse_utf8_files_with_bom
-    file = DotStrings.parse_file('test/fixtures/utf8_bom.strings')
-
-    assert_equal 1, file.items.size
-    assert_equal 'key', file.items[0].key
-    assert_equal 'value', file.items[0].value
-  end
-end

data/test/test_file.rb

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'test_helper'
-
-class TestFile < MiniTest::Test
-  def test_sort
-    file = DotStrings::File.new([
-      DotStrings::Item.new(key: 'key 3', value: 'value 3'),
-      DotStrings::Item.new(key: 'key 2', value: 'value 2'),
-      DotStrings::Item.new(key: 'key 1', value: 'value 1')
-    ])
-
-    sorted = file.sort
-    assert_equal ['key 1', 'key 2', 'key 3'], sorted.keys
-  end
-
-  def test_delete
-    items = [
-      DotStrings::Item.new(key: 'key 1', value: 'value 1'),
-      DotStrings::Item.new(key: 'key 2', value: 'value 2'),
-      DotStrings::Item.new(key: 'key 3', value: 'value 3')
-    ]
-
-    file = DotStrings::File.new(items)
-
-    file.delete('key 2')
-    assert_equal 2, file.items.size
-    assert_equal ['key 1', 'key 3'], file.keys
-  end
-
-  def test_delete_if
-    file = DotStrings::File.new([
-      DotStrings::Item.new(key: 'key 1', value: 'value 1'),
-      DotStrings::Item.new(key: 'key 2', value: 'value 2'),
-      DotStrings::Item.new(key: 'key 3', value: 'value 3')
-    ])
-
-    file.delete_if { |item| item.key == 'key 2' }
-    assert_equal ['key 1', 'key 3'], file.keys
-  end
-
-  def test_access_by_key
-    items = [
-      DotStrings::Item.new(key: 'key 1', value: 'value 1'),
-      DotStrings::Item.new(key: 'key 2', value: 'value 2'),
-      DotStrings::Item.new(key: 'key 3', value: 'value 3')
-    ]
-
-    file = DotStrings::File.new(items)
-
-    assert_equal 'value 1', file['key 1'].value
-    assert_equal 'value 2', file['key 2'].value
-    assert_equal 'value 3', file['key 3'].value
-  end
-
-  def test_append
-    file = DotStrings::File.new
-    file.append(DotStrings::Item.new(key: 'key 1', value: 'value 1'))
-    assert_equal 1, file.items.size
-  end
-
-  def test_to_string
-    file = DotStrings::File.new([
-      DotStrings::Item.new(comment: 'Comment 1', key: 'key 1', value: 'value 1'),
-      DotStrings::Item.new(comment: 'Comment 2', key: 'key 2', value: 'value 2'),
-      DotStrings::Item.new(comment: 'Comment 3', key: 'key 3', value: '👻'),
-      DotStrings::Item.new(comment: 'Comment 4', key: "\"'\t\n\r\0", value: "\"'\t\n\r\0")
-    ])
-
-    expected = <<~'END_OF_DOCUMENT'
-      /* Comment 1 */
-      "key 1" = "value 1";
-
-      /* Comment 2 */
-      "key 2" = "value 2";
-
-      /* Comment 3 */
-      "key 3" = "👻";
-
-      /* Comment 4 */
-      "\"'\t\n\r\0" = "\"'\t\n\r\0";
-    END_OF_DOCUMENT
-
-    assert_equal expected, file.to_s
-  end
-
-  def test_to_string_no_comments
-    file = DotStrings::File.new([
-      DotStrings::Item.new(comment: 'Comment 1', key: 'key 1', value: 'value 1'),
-      DotStrings::Item.new(comment: 'Comment 2', key: 'key 2', value: 'value 2')
-    ])
-
-    expected = <<~'END_OF_DOCUMENT'
-      "key 1" = "value 1";
-
-      "key 2" = "value 2";
-    END_OF_DOCUMENT
-
-    assert_equal expected, file.to_s(comments: false)
-  end
-
-  def test_to_string_can_escape_single_quotes
-    items = [
-      DotStrings::Item.new(comment: 'Comment', key: "key'", value: "value'")
-    ]
-
-    file = DotStrings::File.new(items)
-
-    expected = <<~'END_OF_DOCUMENT'
-      /* Comment */
-      "key\'" = "value\'";
-    END_OF_DOCUMENT
-
-    assert_equal expected, file.to_s(escape_single_quotes: true)
-  end
-end

data/test/test_helper.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require 'simplecov'
-SimpleCov.start
-
-require 'minitest'
-require 'minitest/pride'
-require 'minitest/autorun'
-
-require_relative '../lib/dotstrings'

data/test/test_item.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'test_helper'
-
-class TestFile < MiniTest::Test
-  def test_to_s
-    item = DotStrings::Item.new(comment: 'Comment', key: 'key 1', value: 'value 1')
-    assert_equal "/* Comment */\n\"key 1\" = \"value 1\";", item.to_s
-  end
-
-  def test_to_s_with_nil_comment
-    item = DotStrings::Item.new(comment: nil, key: 'key 1', value: 'value 1')
-    assert_equal '"key 1" = "value 1";', item.to_s
-  end
-end

data/test/test_parser.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'test_helper'
-
-class TestParser < MiniTest::Test
-  def test_handles_extraneous_characters_at_start_of_file
-    error = assert_raises DotStrings::ParsingError do
-      parser = DotStrings::Parser.new
-      parser << '$'
-    end
-
-    assert_equal "Unexpected character '$' at line 1, column 1 (offset: 0)", error.message
-  end
-
-  def test_handles_malformed_comments
-    error = assert_raises DotStrings::ParsingError do
-      parser = DotStrings::Parser.new
-      parser << '/@ test'
-    end
-
-    assert_equal "Unexpected character '@' at line 1, column 2 (offset: 1)", error.message
-  end
-
-  def test_raises_error_when_escaping_invalid_character
-    error = assert_raises DotStrings::ParsingError do
-      parser = DotStrings::Parser.new
-      parser << '"\\z" = "value";'
-    end
-
-    assert_equal "Unexpected character 'z' at line 1, column 3 (offset: 2)", error.message
-  end
-
-  def test_raises_error_when_items_are_not_separated_by_semicolon
-    error = assert_raises DotStrings::ParsingError do
-      parser = DotStrings::Parser.new
-      parser << '"key_1" = "value_1" "key_2" = "value_2"'
-    end
-
-    assert_equal "Unexpected character '\"', expecting ';' at line 1, column 21 (offset: 20)", error.message
-  end
-
-  def test_raises_error_if_low_surrogate_is_not_formatted_correctly
-    error = assert_raises DotStrings::ParsingError do
-      parser = DotStrings::Parser.new
-      parser << '"key" = "\UD83D\$DC7B";'
-    end
-
-    assert_equal "Unexpected character '$', expecting 'U' at line 1, column 17 (offset: 16)", error.message
-  end
-end