java-properties 0.0.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fa01303d1449ae0f74ddd1a56b9da076f232335e
-  data.tar.gz: 9704efbe011c991ddede20ea11cc5d63da9897d1
+SHA256:
+  metadata.gz: 5c361bfd271f8672e0b30fc875cfeb546e4750d76663109821abaa16712b7d4d
+  data.tar.gz: fa5a4a45d2f9df8d04cab3a3a64b5a0442a742de890b1dbeb9ec7f7148e32038
 SHA512:
-  metadata.gz: c4df80543ad68a53c37dd7cc6aea82b256591c11813e30737a2a65ee340ec1c4eb877436f265466f47f93b1ac68c46a0c7b9fa77529cc061cb4965b5ce38f960
-  data.tar.gz: ea06f6daad8d178218f6bb227f080263c3b7341b1c2d128993b8b9b5734e00f2e9eee85b87a51f240dbd2f4aa35780f6c2e8add55d004fb1affb5c8e40e4a54a
+  metadata.gz: 34950a3536aa41fb22e18a207343bff2a9f159047326f2340e013d86f648e0c9edd0769cb500e2fab13566c95a04cda7015f0a06d14480b2b17abd7a698012d6
+  data.tar.gz: a26f13baf630740d763672041c638c3c9af16202a4b9746cfffbb7260d04655f41c3fbec48bb4bff638c5bbf57e3e306b0c0b8427e6787abad824a0507c8650b

data/README.md

@@ -1,9 +1,10 @@
 # JavaProperties
 
-[![Build Status](http://img.shields.io/travis/jnbt/java-properties.png)](https://travis-ci.org/jnbt/jnbt/java-properties)
-[![Code Climate](http://img.shields.io/codeclimate/github/jnbt/java-properties.png)](https://codeclimate.com/github/jnbt/java-properties)
-[![Coveralls](http://img.shields.io/coveralls/jnbt/java-properties.png)](https://coveralls.io/r/jnbt/java-properties)
-[![RubyGems](http://img.shields.io/gem/v/java-properties.png)](http://rubygems.org/gems/java-properties)
+[![Build Status](http://img.shields.io/travis/jnbt/java-properties)](https://travis-ci.org/jnbt/java-properties)
+[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/jnbt/java-properties)](https://codeclimate.com/github/jnbt/java-properties)
+[![Coveralls](http://img.shields.io/coveralls/jnbt/java-properties)](https://coveralls.io/r/jnbt/java-properties)
+[![RubyGems](http://img.shields.io/gem/v/java-properties)](http://rubygems.org/gems/java-properties)
+[![Inline docs](http://inch-ci.org/github/jnbt/java-properties.svg?style=shields)](http://inch-ci.org/github/jnbt/java-properties)
 
 A ruby library to read and write [Java properties files](http://en.wikipedia.org/wiki/.properties).
 
@@ -33,7 +34,7 @@ properties[:foo] # => "bar"
 If have already the content of the properties file at hand than parse the content as:
 
 ```ruby
-properties = JavaProperties.load("foo=bar")
+properties = JavaProperties.parse("foo=bar")
 properties[:foo] # => "bar"
 ```
 
@@ -59,18 +60,19 @@ As Java properties files normally hold UTF-8 chars in their escaped representati
 
 ```
 "ה" <=> "\u05d4"
+"𪀯"  <=> "\ud868\udc2f"
 ```
 
 The tool also escaped every '=', ' ' and ':' in the name part of a property line:
 
 ```ruby
-JavaProperties.generate({"i : like=strange" => "bar"}) 
+JavaProperties.generate({"i : like=strange" => "bar"})
 # => "i\ \:\ like\=strange=bar"
 ```
 
 ## Multi line and line breaks
 
-In Java properties files a string can be multi line but line breaks have to be escaped. 
+In Java properties files a string can be multi line but line breaks have to be escaped.
 
 Assume the following input:
 

data/java-properties.gemspec

@@ -1,23 +1,27 @@
-# coding: utf-8
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'java-properties/version'
+# frozen_string_literal: true
+
+require_relative 'lib/java-properties/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "java-properties"
+  spec.name          = 'java-properties'
   spec.version       = JavaProperties::VERSION.dup
-  spec.authors       = ["Jonas Thiel"]
-  spec.email         = ["jonas@thiel.io"]
+  spec.authors       = ['Jonas Thiel']
+  spec.email         = ['jonas@thiel.io']
   spec.summary       = %q{Loader and writer for *.properties files}
   spec.description   = %q{Tool for loading and writing Java properties files}
-  spec.homepage      = "https://github.com/jnbt/java-properties"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/jnbt/java-properties'
+  spec.license       = 'MIT'
 
   spec.files = %w(LICENSE README.md Rakefile java-properties.gemspec)
-  spec.files += Dir.glob("lib/**/*.rb")
-  spec.test_files = Dir.glob("spec/**/*.rb")
-  spec.test_files = Dir.glob("spec/fixtures/**/*.properties")
+  spec.files += Dir.glob('lib/**/*.rb')
+  spec.test_files = Dir.glob('spec/**/*.rb')
+  spec.test_files = Dir.glob('spec/fixtures/**/*.properties')
 
   spec.required_rubygems_version = '>= 1.3.5'
-end
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'inch', '~> 0.8'
+  spec.add_development_dependency 'minitest', '~> 5.14'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+end

data/lib/java-properties.rb

@@ -30,7 +30,9 @@ module JavaProperties
   # @param path [String]
   # @return [Properties]
   def self.load(path)
-    parse(File.read(path))
+    File.open(path, "r:bom|utf-8") do |f|
+      parse(f.read)
+    end
   end
 
   # Generates a Java properties file

data/lib/java-properties/encoding.rb

@@ -4,6 +4,18 @@ require 'java-properties/encoding/unicode'
 
 module JavaProperties
   # Module to encode and decode
+  #
+  # Usage:
+  #    encoded = Encoding.encode!("Some text to be encoded")
+  #    decoded = Encoding.decode!("Some text to be decoded")
+  #
+  # You can disable separate encoding (and decoding) steps,
+  # by passing in additional flags:
+  #
+  # * SKIP_SEPARATORS: Do not code the separators (space,:,=)
+  # * SKIP_UNICODE: Do not code unicode chars
+  # * SKIP_SPECIAL_CHARS: Do not code newlines, tab stops, ...
+  #
   module Encoding
 
     # Flag for skipping separators encodings / decoding
@@ -20,8 +32,8 @@ module JavaProperties
 
     # Encode a given text in place
     # @param text [String]
-    # @param flags [Symbol] Optional flags to skip encoding steps
-    # @return [String]
+    # @param *flags [Array] Optional flags to skip encoding steps
+    # @return [String] The encoded text for chaining
     def self.encode!(text, *flags)
       SpecialChars.encode!(text)  unless flags.include?(SKIP_SPECIAL_CHARS)
       Separators.encode!(text)    unless flags.include?(SKIP_SEPARATORS)
@@ -31,8 +43,8 @@ module JavaProperties
     
     # Decodes a given text in place
     # @param text [String]
-    # @param flags [Symbol] Optional flags to skip decoding steps
-    # @return [String]
+    # @param *flags [Array] Optional flags to skip decoding steps
+    # @return [String] The decoded text for chaining
     def self.decode!(text, *flags)
       Unicode.decode!(text)       unless flags.include?(SKIP_UNICODE)
       Separators.decode!(text)    unless flags.include?(SKIP_SEPARATORS)

data/lib/java-properties/encoding/separators.rb

@@ -1,6 +1,7 @@
 module JavaProperties
   module Encoding
     # Module to escape separators as : or =
+    # @see JavaProperties::Encoding
     module Separators
 
       # Marker for all separators
@@ -21,7 +22,7 @@ module JavaProperties
 
       # Escapes all not already escaped separators
       # @param text [text]
-      # @return [String]
+      # @return [String] The escaped text for chaining
       def self.encode!(text)
         buffer = StringIO.new
         last_token = ''
@@ -38,7 +39,7 @@ module JavaProperties
 
       # Removes escapes from escaped separators
       # @param text [text]
-      # @return [String]
+      # @return [String] The unescaped text for chaining
       def self.decode!(text)
         text.gsub!(DECODE_SEPARATOR_MARKER) do
           $1

data/lib/java-properties/encoding/special_chars.rb

@@ -1,6 +1,7 @@
 module JavaProperties
   module Encoding
     # Module to escape and unescape special chars
+    # @see JavaProperties::Encoding
     module SpecialChars
 
       # Lookup table for escaping special chars
@@ -9,7 +10,8 @@ module JavaProperties
         "\t" => '\\t',
         "\r" => '\\r',
         "\n" => '\\n',
-        "\f" => '\\f'
+        "\f" => '\\f',
+        "\\" => '\\\\',
       }.freeze
 
       # Lookup table to remove escaping from special chars
@@ -22,7 +24,7 @@ module JavaProperties
 
       # Encodes the content a text by escaping all special chars
       # @param text [String]
-      # @return [String]
+      # @return [String] The escaped text for chaining
       def self.encode!(text)
         buffer = StringIO.new
         text.each_char do |char|
@@ -34,7 +36,7 @@ module JavaProperties
 
       # Decodes the content a text by removing all escaping from special chars
       # @param text [String]
-      # @return [String]
+      # @return [String] The unescaped text for chaining
       def self.decode!(text)
         text.gsub!(DESCAPING_MARKER) do |match|
           DESCAPING.fetch(match, match)
@@ -44,4 +46,4 @@ module JavaProperties
 
     end
   end
-end
+end

data/lib/java-properties/encoding/unicode.rb

@@ -1,60 +1,105 @@
 module JavaProperties
   module Encoding
     # Module to encode and decode unicode chars
+    # This code is highly influced by Florian Frank's JSON gem
+    # @see https://github.com/flori/json/
     module Unicode
-      
-      # Marker for encoded unicode chars
-      # @return [Regexp]
-      UNICODE_MARKER  = /\\[uU]([0-9a-fA-F]{4,5}|10[0-9a-fA-F]{4})/
 
-      # Escape char for unicode chars
-      # @return [String]
-      UNICODE_ESCAPE = "\\u"
+      # @private
+      MAP = {
+        "\x0" => '\u0000',
+        "\x1" => '\u0001',
+        "\x2" => '\u0002',
+        "\x3" => '\u0003',
+        "\x4" => '\u0004',
+        "\x5" => '\u0005',
+        "\x6" => '\u0006',
+        "\x7" => '\u0007',
+        "\xb" => '\u000b',
+        "\xe" => '\u000e',
+        "\xf" => '\u000f',
+        "\x10" => '\u0010',
+        "\x11" => '\u0011',
+        "\x12" => '\u0012',
+        "\x13" => '\u0013',
+        "\x14" => '\u0014',
+        "\x15" => '\u0015',
+        "\x16" => '\u0016',
+        "\x17" => '\u0017',
+        "\x18" => '\u0018',
+        "\x19" => '\u0019',
+        "\x1a" => '\u001a',
+        "\x1b" => '\u001b',
+        "\x1c" => '\u001c',
+        "\x1d" => '\u001d',
+        "\x1e" => '\u001e',
+        "\x1f" => '\u001f',
+      }
+
+      # @private
+      EMPTY_8BIT_STRING = ''
+      EMPTY_8BIT_STRING.force_encoding(::Encoding::ASCII_8BIT)
 
       # Decodes all unicode chars from escape sequences in place
       # @param text [String]
-      # @return [String]
+      # @return [String] The encoded text for chaining
       def self.decode!(text)
-        text.gsub!(UNICODE_MARKER) do
-          unicode($1.hex)
+        string = text.dup
+        string = string.gsub(%r((?:\\[uU](?:[A-Fa-f\d]{4}))+)) do |c|
+          c.downcase!
+          bytes = EMPTY_8BIT_STRING.dup
+          i = 0
+          while c[6 * i] == ?\\ && c[6 * i + 1] == ?u
+            bytes << c[6 * i + 2, 2].to_i(16) << c[6 * i + 4, 2].to_i(16)
+            i += 1
+          end
+          bytes.encode("utf-8", "utf-16be")
         end
+        string.force_encoding(::Encoding::UTF_8)
+
+        text.replace string
         text
       end
 
       # Decodes all unicode chars into escape sequences in place
       # @param text [String]
-      # @return [String]
+      # @return [String] The decoded text for chaining
       def self.encode!(text)
-        buffer = StringIO.new
-        text.each_char do |char|
-          if char.ascii_only?
-            buffer << char
-          else
-            buffer << UNICODE_ESCAPE
-            buffer << hex(char.codepoints.first)
-          end
-        end
-        text.replace buffer.string
+        string = text.dup
+        string.force_encoding(::Encoding::ASCII_8BIT)
+        string.gsub!(/["\\\x0-\x1f]/n) { |c| MAP[c] || c }
+        string.gsub!(/(
+          (?:
+           [\xc2-\xdf][\x80-\xbf]    |
+           [\xe0-\xef][\x80-\xbf]{2} |
+           [\xf0-\xf4][\x80-\xbf]{3}
+          )+ |
+          [\x80-\xc1\xf5-\xff]       # invalid
+        )/nx) { |c|
+          c.size == 1 and raise "Invalid utf8 byte: '#{c}'"
+          s = c.encode("utf-16be", "utf-8").unpack('H*')[0]
+          s.force_encoding(::Encoding::ASCII_8BIT)
+          s.gsub!(/.{4}/n, '\\\\u\&')
+          s.force_encoding(::Encoding::UTF_8)
+        }
+        string.force_encoding(::Encoding::UTF_8)
+        text.replace string
         text
       end
 
       private
 
       def self.unicode(code)
-        [code].pack("U")
+        code.chr(::Encoding::UTF_8)
       end
 
       def self.hex(codepoint)
         hex  = codepoint.to_s(16)
-        size = hex.size
-        # padding the hex value for uneven digest
-        if (size % 2) == 1
-          "0#{hex}"
-        else
-          hex
-        end
+        size = [4, hex.size].max
+        target_size = size.even? ? size : size+1
+        hex.rjust(target_size, '0')
       end
 
     end
   end
-end
+end

data/lib/java-properties/version.rb

@@ -2,6 +2,6 @@ module JavaProperties
 
   # Current version
   # @return [String]
-  VERSION = "0.0.2".freeze
+  VERSION = "0.3.0".freeze
 
-end
+end

data/spec/fixtures/bom.properties

@@ -0,0 +1,2 @@
+pageTitle=Some ü text
+tagOther=Other

data/spec/fixtures/test.properties

@@ -1,16 +1,16 @@
 # Comment 1
 ! Comment 2
 item0
-item1 = item1 
-item2 : item2 
+item1 = item1
+item2 : item2
 item3   item3
 
  #Comment 3
  ! Comment 4
- 
+
  it\ em4=item4
- it\=em5:item5 
- item6 item6 
+ it\=em5:item5
+ item6 item6
 
 !Comment 4
 # Comment 5
@@ -31,3 +31,8 @@ item10=test\n\ttest\u0050 \
        test\n\ttest \
        test\n\ttest = test
 
+item11=a\u00e4b \ud868\udc2f
+
+item12=#no comment
+
+item13=with\\back\\nslash\\t

data/spec/fixtures/test_normalized.properties

@@ -8,4 +8,7 @@ item6=item6
 item7=line 1 line 2 line 3
 item8=line 1 line 2 line 3
 item9=line 1 line 2 line 3
-item10=test\n\ttest\u0050 test\n\ttest test\n\ttest = test
+item10=test\n\ttest\u0050 test\n\ttest test\n\ttest = test
+item11=a\u00e4b \ud868\udc2f
+item12=#no comment
+item13=with\\back\\nslash\\t

data/spec/fixtures/test_out.properties

@@ -8,4 +8,5 @@ it\:em6=item6
 item7=line 1 line 2 line 3
 item8=line 1 line 2 line 3
 item9=line 1 line 2 line 3
-item10=test\n\ttest\u05d4 test\n\ttest test\n\ttest = test
+item10=test\n\ttest\u05d4 test\n\ttest test\n\ttest\u00fc = test
+item11=a\u00e4b \ud868\udc2f

data/spec/fixtures/test_out_skip_separators.properties

@@ -8,4 +8,5 @@ it:em6=item6
 item7=line 1 line 2 line 3
 item8=line 1 line 2 line 3
 item9=line 1 line 2 line 3
-item10=test\n\ttest\u05d4 test\n\ttest test\n\ttest = test
+item10=test\n\ttest\u05d4 test\n\ttest test\n\ttest\u00fc = test
+item11=a\u00e4b \ud868\udc2f

data/spec/fixtures/test_out_skip_special_chars.properties

@@ -11,4 +11,5 @@ item9=line 1 line 2 line 3
 item10=test
 	test\u05d4 test
 	test test
-	test = test
+	test\u00fc = test
+item11=a\u00e4b \ud868\udc2f

data/spec/fixtures/test_out_skip_unicode.properties

@@ -8,4 +8,5 @@ it\:em6=item6
 item7=line 1 line 2 line 3
 item8=line 1 line 2 line 3
 item9=line 1 line 2 line 3
-item10=test\n\ttestה test\n\ttest test\n\ttest = test
+item10=test\n\ttestה test\n\ttest test\n\ttestü = test
+item11=aäb 𪀯

metadata

@@ -1,15 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: java-properties
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Jonas Thiel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-02-17 00:00:00.000000000 Z
-dependencies: []
+date: 2021-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: Tool for loading and writing Java properties files
 email:
 - jonas@thiel.io
@@ -33,6 +89,7 @@ files:
 - lib/java-properties/parsing/parser.rb
 - lib/java-properties/properties.rb
 - lib/java-properties/version.rb
+- spec/fixtures/bom.properties
 - spec/fixtures/test.properties
 - spec/fixtures/test_normalized.properties
 - spec/fixtures/test_out.properties
@@ -43,31 +100,30 @@ homepage: https://github.com/jnbt/java-properties
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.1
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Loader and writer for *.properties files
 test_files:
+- spec/fixtures/bom.properties
 - spec/fixtures/test.properties
 - spec/fixtures/test_normalized.properties
 - spec/fixtures/test_out.properties
 - spec/fixtures/test_out_skip_separators.properties
 - spec/fixtures/test_out_skip_special_chars.properties
 - spec/fixtures/test_out_skip_unicode.properties
-has_rdoc: