dotstrings 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 605ff8ed35fcfcbd91f2fc33a4b53e69b614aab962de1c32c1d616f957ee1916
-  data.tar.gz: dddf00d461a893a4ff4e97c04fcc87617241e42189d0284b22e4ab98313ed25a
+  metadata.gz: e9c320ba9bef4d63af10c9c9fd3d91ad41da99b3663538f0b89ebdc6fc780d31
+  data.tar.gz: 24e762927cd739f3475a8a550a751f808dd81d73292e47f7449c657edeaa88db
 SHA512:
-  metadata.gz: a47fbb334a228e6642d7d6b3250b81ab7c7e239be8fb6ca92ba7877dfe9eb6ac0d3ba2bebe4176477afa9b825e4ce61af4a8d555b83e2a29ed6c176a6d392c90
-  data.tar.gz: fa824b2c3c59bee05bb64d59508a6bff112a551d37d6bbc198913433fc8b332a75a17af84a5524a944126fd6e38df8bef008615df303565e729556169eb21bc8
+  metadata.gz: f24ad0efde29b52a33f28cd0e434970bde12556d9236c632495eebdfd089ed550e54a41f67fb844c70677c53bbdaccdbb93f593cafd535062532f062297ab7b4
+  data.tar.gz: d61a17f762188162a431c6289b96e23d4374ca2a29a82e84b58e92bf097d79746a352418859e12c2d1dcf13c8844a53a9975360be6c0a98f65d046c16aba45cc

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [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.
+* Added `DotStrings::File#sort`, `DotStrings::File#sort!`, and `DotStrings::File#delete_if` methods.
+* Improved documentation.
+
 ## [v0.2.0] - 2022-07-17
 ### Changed
 * Made some state transitions more strict.
@@ -13,6 +24,8 @@
 ### Added
 * Initial release.
 
+[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

@@ -7,6 +7,7 @@ A parser for Apple *strings* files (`.strings`) written in Ruby. Some of the fea
 * An API for creating strings files programmatically.
 * Handles Unicode and escaped characters.
 * Helpful error messages: know which line and column fail to parse and why.
+* Well [tested](test) and [documented](https://www.rubydoc.info/gems/dotstrings/DotStrings).
 
 ## Installing
 
@@ -19,12 +20,12 @@ $ gem install dotstrings
 Or by adding the following entry to your [Gemfile](https://guides.cocoapods.org/using/a-gemfile.html), then running `$ bundle install`.
 
 ```ruby
-gem "dotstrings"
+gem 'dotstrings'
 ```
 
 ## Usage
 
-You can load `.strings` files using the `DotString.parse()` utility method. This method returns a `DotStrings::File` object or raises an exception if the file is invalid.
+You can load `.strings` files using the `DotString.parse()` utility method. This method returns a `DotStrings::File` object or raises an exception if the file cannot be parsed.
 
 ```ruby
 file = DotStrings.parse_file('en-US/Localizable.strings')

data/lib/dotstrings/errors.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module DotStrings
+  ##
+  # Class for errors raised by the parser.
   class ParsingError < RuntimeError
   end
 end

data/lib/dotstrings/file.rb

@@ -5,13 +5,48 @@ require 'dotstrings/errors'
 require 'dotstrings/item'
 
 module DotStrings
+  ##
+  # Represents a .strings file.
+  #
+  # It provides methods to parse .strings, as well as methods for accessing and
+  # manipulating localized string items.
   class File
+    ##
+    # All items in the file.
     attr_reader :items
 
     def initialize(items = [])
       @items = items
     end
 
+    ##
+    # Returns a new File with the items sorted using the given comparator block.
+    #
+    # If no block is given, the items will be sorted by key.
+    def sort(&block)
+      new_file = dup
+      new_file.sort!(&block)
+    end
+
+    ##
+    # Sort the items using the given block.
+    #
+    # If no block is given, the items will be sorted by key.
+    def sort!(&block)
+      @items.sort!(&block || ->(a, b) { a.key <=> b.key })
+      self
+    end
+
+    ##
+    # Parses a file from the given IO object.
+    #
+    # @example
+    #   io = Zlib::GzipReader.open('path/to/en.lproj/Localizable.strings.gz')
+    #   file = DotStrings::File.parse(io)
+    #
+    # @param io [IO] The IO object to parse.
+    # @return [DotStrings::File] The parsed file.
+    # @raise [DotStrings::ParsingError] if the file could not be parsed.
     def self.parse(io)
       items = []
 
@@ -22,32 +57,130 @@ module DotStrings
       File.new(items)
     end
 
+    ##
+    # Parses the file at the given path.
+    #
+    # @example
+    #   file = DotStrings::File.parse_file('path/to/en.lproj/Localizable.strings')
+    #
+    # @param path [String] The path to the file to parse.
+    # @return [DotStrings::File] The parsed file.
+    # @raise [DotStrings::ParsingError] if the file could not be parsed.
     def self.parse_file(path)
       ::File.open(path, 'r') do |file|
         parse(file)
       end
     end
 
+    ##
+    # Returns all keys in the file.
     def keys
       @items.map(&:key)
     end
 
+    ##
+    # Returns an item by key, if it exists, otherwise nil.
+    #
+    # @example
+    #   item = file['button.title']
+    #   unless item.nil?
+    #     puts item.value # => 'Submit'
+    #   end
+    #
+    # @param key [String] The key of the item to return.
+    # @return [DotStrings::Item] The item, if it exists.
     def [](key)
       @items.find { |item| item.key == key }
     end
 
+    ##
+    # Appends an item to the file.
+    #
+    # @example
+    #   file << DotStrings::Item.new(key: 'button.title', value: 'Submit')
+    #
+    # @param item [DotStrings::Item] The item to append.
+    # @return [DotStrings::Item] The item that was appended.
     def <<(item)
       @items << item
+      self
     end
 
+    ##
+    # Appends an item to the file.
+    #
+    # @example
+    #   file.append(DotStrings::Item.new(key: 'button.title', value: 'Submit'))
     def append(item)
       self << item
     end
 
+    ##
+    # Deletes an item by key.
     def delete(key)
       @items.delete_if { |item| item.key == key }
     end
 
+    ##
+    # Deletes all items for which the block returns true.
+    #
+    # @example
+    #   file.delete_if { |item| item.key.start_with?('button.') }
+    def delete_if(&block)
+      @items.delete_if(&block)
+      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.
+    #
+    # @param escape_single_quotes [Boolean] whether to escape single quotes.
+    # @param comments [Boolean] whether to include comments.
     def to_s(escape_single_quotes: false, comments: true)
       result = []
 

data/lib/dotstrings/item.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module DotStrings
+  ##
+  # Represents a localized string item.
   class Item
     attr_reader :comment, :key, :value
 
@@ -10,6 +12,22 @@ 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.
+    #
+    # @param escape_single_quotes [Boolean] Whether to escape single quotes.
+    # @param include_comment [Boolean] Whether to include the comment.
     def to_s(escape_single_quotes: false, include_comment: true)
       result = []
 

data/lib/dotstrings/parser.rb

@@ -4,6 +4,9 @@ require 'dotstrings/errors'
 
 module DotStrings
   # rubocop:disable Metrics/ClassLength
+
+  ##
+  # Parser for .strings files.
   class Parser
     # Special tokens
     TOK_SLASH        = '/'
@@ -36,8 +39,6 @@ module DotStrings
     STATE_UNICODE_SURROGATE   = 11
     STATE_UNICODE_SURROGATE_U = 12
 
-    attr_reader :items
-
     def initialize
       @state = STATE_START
       @temp_state = nil
@@ -59,11 +60,16 @@ module DotStrings
       @column = 1
     end
 
+    ##
+    # Specifies a block to be called when a new item is parsed.
     def on_item(&block)
       @item_block = block
     end
 
     # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/BlockLength
+
+    ##
+    # Feeds data to the parser.
     def <<(data)
       data.each_char do |ch|
         case @state
@@ -157,6 +163,7 @@ module DotStrings
         update_position(ch)
       end
     end
+
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/BlockLength
 
     private
@@ -203,30 +210,51 @@ module DotStrings
       end
     end
 
-    # rubocop:disable Style/GuardClause
+    # 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
 
       @unicode_buffer << ch
 
-      if @unicode_buffer.length == 4
-        codepoint = @unicode_buffer.join.hex
+      # Check if we have enough digits to form a codepoint.
+      return if @unicode_buffer.length < 4
 
-        if codepoint >= 0xD800 && codepoint <= 0xDBFF
-          @high_surrogate = codepoint
-          @state = STATE_UNICODE_SURROGATE
-        elsif codepoint >= 0xDC00 && codepoint <= 0xDFFF
-          character = ((@high_surrogate - 0xD800) * 0x400) + (codepoint - 0xDC00) + 0x10000
-          block.call(character.chr('UTF-8'))
-        else
-          block.call(codepoint.chr('UTF-8'))
+      codepoint = @unicode_buffer.join.hex
+
+      if codepoint >= 0xD800 && codepoint <= 0xDBFF
+        unless @high_surrogate.nil?
+          raise_error(
+            'Found a high surrogate code point after another high surrogate'
+          )
         end
 
-        # Clear buffer after codepoint is parsed
-        @unicode_buffer.clear
+        @high_surrogate = codepoint
+        @state = STATE_UNICODE_SURROGATE
+      elsif codepoint >= 0xDC00 && codepoint <= 0xDFFF
+        if @high_surrogate.nil?
+          raise_error(
+            'Found a low surrogate code point before a high surrogate'
+          )
+        end
+
+        character = ((@high_surrogate - 0xD800) * 0x400) + (codepoint - 0xDC00) + 0x10000
+        @high_surrogate = nil
+
+        block.call(character.chr('UTF-8'))
+      else
+        unless @high_surrogate.nil?
+          raise_error(
+            "Invalid unicode codepoint '\\U#{codepoint.to_s(16).upcase}' after a high surrogate code point"
+          )
+        end
+
+        block.call(codepoint.chr('UTF-8'))
       end
+
+      # Clear buffer after codepoint is parsed
+      @unicode_buffer.clear
     end
-    # rubocop:enable Style/GuardClause
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     def update_position(ch)
       @offset += 1

data/lib/dotstrings/version.rb

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

data/lib/dotstrings.rb

@@ -6,10 +6,24 @@ require 'dotstrings/item'
 require 'dotstrings/errors'
 
 module DotStrings
+  ##
+  # Parses a file from the given IO object.
+  #
+  # This is a convenience method for {DotStrings::File.parse}.
+  #
+  # @param io [IO] The IO object to parse.
+  # @return [DotStrings::File] The parsed file.
   def self.parse(io)
     File.parse(io)
   end
 
+  ##
+  # Parses a .strings file at the given path.
+  #
+  # This is a convenience method for {DotStrings::File.parse_file}.
+  #
+  # @param path [String] The path to the .strings file to parse.
+  # @return [DotStrings::File] The parsed file.
   def self.parse_file(path)
     File.parse_file(path)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotstrings
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ramon Torres
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-17 00:00:00.000000000 Z
+date: 2022-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Parse and create .strings files used in localization of iOS and macOS
   apps.
 email:
@@ -102,39 +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/utf16be_bom.strings
-- test/fixtures/utf16le_bom.strings
-- test/fixtures/utf8_bom.strings
-- test/fixtures/valid.strings
-- test/helper.rb
-- test/test_dotstrings.rb
-- test/test_file.rb
-- test/test_item.rb
 homepage: https://github.com/raymondjavaxx/dotstrings
 licenses:
 - MIT
@@ -155,24 +145,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubyforge_project:
+rubygems_version: 2.7.6
 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/utf16be_bom.strings
-- test/fixtures/utf16le_bom.strings
-- test/fixtures/utf8_bom.strings
-- test/fixtures/valid.strings
-- test/helper.rb
-- test/test_dotstrings.rb
-- test/test_file.rb
-- test/test_item.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,2 +0,0 @@
-pkg
-.vscode

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,49 +0,0 @@
-PATH
-  remote: .
-  specs:
-    dotstrings (0.2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    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)
-    unicode-display_width (2.2.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  dotstrings!
-  minitest (~> 5.14)
-  rake
-  rubocop
-  rubocop-minitest
-  rubocop-rake
-
-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,28 +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.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/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/helper.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-gem 'minitest'
-
-require 'minitest/pride'
-require 'minitest/autorun'
-
-require_relative '../lib/dotstrings'

data/test/test_dotstrings.rb

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '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_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,94 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'helper'
-
-class TestFile < MiniTest::Test
-  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_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_item.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '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