dotstrings 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fc37db8d1dfc887f3bba22642ab731ca37e2ea3963a7e4998fa843f8b08a1d5
-  data.tar.gz: a8e82e134a26188fb4ac299cf5b5d02a437f90706844e72cdfe2d6b329681eb8
+  metadata.gz: 605ff8ed35fcfcbd91f2fc33a4b53e69b614aab962de1c32c1d616f957ee1916
+  data.tar.gz: dddf00d461a893a4ff4e97c04fcc87617241e42189d0284b22e4ab98313ed25a
 SHA512:
-  metadata.gz: c21229aef0c1188c8338b4478898d45e31e11a7413d71bb6a9e7200240bc15d15c69f500b9ae031636369c98a0ba912918c706a7f4b45f03eb35c6b30f5426b3
-  data.tar.gz: 5a1ef97552447cdf70cac24bf943af085fcf0ffd264435180764247f9cde38e8745e42d50254082db13402088a5d11930ca043a487e66bfb9155e7164236e5e0
+  metadata.gz: a47fbb334a228e6642d7d6b3250b81ab7c7e239be8fb6ca92ba7877dfe9eb6ac0d3ba2bebe4176477afa9b825e4ce61af4a8d555b83e2a29ed6c176a6d392c90
+  data.tar.gz: fa824b2c3c59bee05bb64d59508a6bff112a551d37d6bbc198913433fc8b332a75a17af84a5524a944126fd6e38df8bef008615df303565e729556169eb21bc8

data/.github/workflows/ci.yml

@@ -16,6 +16,7 @@ jobs:
           - "2.6"
           - "2.7"
           - "3.0"
+          - "3.1"
 
     steps:
     - uses: actions/checkout@v2

data/.rubocop.yml

@@ -14,6 +14,10 @@ Layout/FirstHashElementIndentation:
   Enabled: true
   EnforcedStyle: consistent
 
+Layout/FirstArrayElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
 Metrics/ClassLength:
   Enabled: true
   Max: 150

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## [v0.2.0] - 2022-07-17
+### Changed
+* Made some state transitions more strict.
+* Added option to ignore comments when serializing.
+
+## [v0.1.1] - 2022-07-12
+### Changed
+* Escaping single quotes is now optional.
+
+## [v0.1.0] - 2022-07-06
+### Added
+* Initial release.
+
+[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/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dotstrings (0.1.1)
+    dotstrings (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/dotstrings/file.rb

@@ -48,11 +48,15 @@ module DotStrings
       @items.delete_if { |item| item.key == key }
     end
 
-    def to_s(escape_single_quotes: false)
+    def to_s(escape_single_quotes: false, comments: true)
       result = []
 
       @items.each do |item|
-        result << item.to_s(escape_single_quotes: escape_single_quotes)
+        result << item.to_s(
+          escape_single_quotes: escape_single_quotes,
+          include_comment: comments
+        )
+
         result << ''
       end
 

data/lib/dotstrings/item.rb

@@ -10,10 +10,10 @@ module DotStrings
       @value = value
     end
 
-    def to_s(escape_single_quotes: false)
+    def to_s(escape_single_quotes: false, include_comment: true)
       result = []
 
-      result << "/* #{comment} */" unless comment.nil?
+      result << "/* #{comment} */" unless comment.nil? || !include_comment
       result << format('"%<key>s" = "%<value>s";', {
         key: serialize_string(key, escape_single_quotes: escape_single_quotes),
         value: serialize_string(value, escape_single_quotes: escape_single_quotes)

data/lib/dotstrings/parser.rb

@@ -95,19 +95,27 @@ module DotStrings
             @buffer << ch
           end
         when STATE_COMMENT_END
-          @state = STATE_KEY if ch == TOK_QUOTE
+          if ch == TOK_QUOTE
+            @state = STATE_KEY
+          else
+            raise_error("Unexpected character '#{ch}'") unless whitespace?(ch)
+          end
         when STATE_KEY
           parse_string(ch) do |key|
             @current_key = key
             @state = STATE_KEY_END
           end
         when STATE_KEY_END
-          @state = STATE_VALUE_SEPARATOR if ch == TOK_EQUALS
+          if ch == TOK_EQUALS
+            @state = STATE_VALUE_SEPARATOR
+          else
+            raise_error("Unexpected character '#{ch}', expecting '#{TOK_EQUALS}'") unless whitespace?(ch)
+          end
         when STATE_VALUE_SEPARATOR
           if ch == TOK_QUOTE
             @state = STATE_VALUE
           else
-            raise_error("Unexpected character '#{ch}'") unless ch.strip.empty?
+            raise_error("Unexpected character '#{ch}'") unless whitespace?(ch)
           end
         when STATE_VALUE
           parse_string(ch) do |value|
@@ -121,7 +129,11 @@ module DotStrings
             ))
           end
         when STATE_VALUE_END
-          @state = STATE_START if ch == TOK_SEMICOLON
+          if ch == TOK_SEMICOLON
+            @state = STATE_START
+          else
+            raise_error("Unexpected character '#{ch}', expecting '#{TOK_SEMICOLON}'") unless whitespace?(ch)
+          end
         when STATE_UNICODE
           parse_unicode(ch) do |unicode_ch|
             @buffer << unicode_ch
@@ -236,7 +248,7 @@ module DotStrings
         @state = STATE_KEY
         reset_state
       else
-        raise_error("Unexpected character '#{ch}'") unless ch.strip.empty?
+        raise_error("Unexpected character '#{ch}'") unless whitespace?(ch)
       end
     end
 
@@ -245,6 +257,10 @@ module DotStrings
       @current_key = nil
       @current_value = nil
     end
+
+    def whitespace?(ch)
+      ch.strip.empty?
+    end
   end
   # rubocop:enable Metrics/ClassLength
 end

data/lib/dotstrings/version.rb

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

data/test/test_file.rb

@@ -38,14 +38,12 @@ class TestFile < MiniTest::Test
   end
 
   def test_to_string
-    items = [
+    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")
-    ]
-
-    file = DotStrings::File.new(items)
+    ])
 
     expected = <<~'END_OF_DOCUMENT'
       /* Comment 1 */
@@ -64,6 +62,21 @@ class TestFile < MiniTest::Test
     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'")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotstrings
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ramon Torres
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2022-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,6 +106,7 @@ files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -154,8 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key:
 specification_version: 4
 summary: Parse and create .strings files used in localization of iOS and macOS apps.