dot-properties 0.1.0 → 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fd35e7534f70196e5b8a263cdeb5874b9e6bb394d9e623c5a1e301384f1932fa
+  data.tar.gz: 9077f79007f9588eb42896917bef78828a3ca536a97d28dadd33000d3c9db9c9
+SHA512:
+  metadata.gz: 0c71ed6de04cb4db7ee34b67b64707f092e339b041ba788270b6085e0007a279966f66ff77899788027c75a913e830fca9bc69c790988414579b645fbc0aa231
+  data.tar.gz: ed8cb7d21c7148237b9afd497f979d1aa5b2e4558a895de98663cc68cd5398942ca0d4832f4212912de7972392b772f5f2b333b069239028ef62c0bb455318c0

data/.travis.yml

@@ -1,6 +1,9 @@
 language: ruby
+before_install:
+  - gem install bundler
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
-  - jruby-19mode
+  - 2.1.5
+  - 2.2.3
+  - jruby

data/README.md

@@ -13,7 +13,7 @@ Reads and writes [Java .properties files](http://en.wikipedia.org/wiki/.properti
 
 Add this line to your application's Gemfile:
 
-    gem 'dot_properties'
+    gem 'dot-properties'
 
 And then execute:
 
@@ -28,7 +28,7 @@ Or install it yourself as:
     require 'dot_properties'
 
     # Load a .properties file
-    props = DotProperties.new('sample.properties')
+    props = DotProperties.load('sample.properties')
 
     # Get a value
     props['foo']
@@ -58,9 +58,12 @@ See the spec tests and fixture data for more examples.
 
 ## History
 
+- <b>0.1.4</b> - Update bundler dependency due to [CVE-2019-3881](https://github.com/advisories/GHSA-g98m-96g9-wfjq)
+- <b>0.1.3</b> - Explicitly require 'forwardable' (jruby / mri2.x compat) (from @billdueber)
+- <b>0.1.2</b> - Improved escaping and Unicode (\uXXXX) support
+- <b>0.1.1</b> - Fix mishandled keys with leading whitespace (#1)
 - <b>0.1.0</b> - Initial release
 
 ## Copyright
 
 Copyright (c) 2013 Michael B. Klein. See LICENSE.txt for further details.
-

data/dot-properties.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_dependency "bundler", ">= 2.2.33"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rdoc", ">= 2.4.2"

data/lib/dot_properties/version.rb

@@ -1,3 +1,3 @@
 class DotProperties
-  VERSION = "0.1.0"
+  VERSION = "0.1.4"
 end

data/lib/dot_properties.rb

@@ -1,4 +1,5 @@
 require "dot_properties/version"
+require 'forwardable'
 
 class DotProperties
   extend Forwardable
@@ -111,7 +112,7 @@ class DotProperties
       if item[:value].nil? or item[:value].empty?
         escape(item[:key])
       else
-        "#{escape(item[:key])}#{item[:delimiter]}#{item[:value]}"
+        "#{escape(item[:key])}#{item[:delimiter]}#{encode(item[:value])}"
       end
     else
       item[:value]
@@ -124,8 +125,8 @@ class DotProperties
     elsif item =~ /^\s*$/
       { type: :blank, value: item }
     else
-      key, delimiter, value = item.split /(\s*(?<!\\)[\s:=]\s*)/, 2
-      { type: :value, key: unescape(key), delimiter: delimiter, value: value.to_s.gsub(/\\\n\s*/,'') }
+      key, delimiter, value = item.strip.split /(\s*(?<!\\)[\s:=]\s*)/, 2
+      { type: :value, key: unescape(decode(key)), delimiter: delimiter, value: unescape(decode(value.to_s.gsub(/\\\n\s*/,''))) }
     end
   end
 
@@ -133,12 +134,20 @@ class DotProperties
     @content.find { |item| item[:type] == :value and item[:key] == key }
   end
 
-  def escape(key)
-    key.gsub(/[\s:=]/) { |m| "\\#{m}" }
+  def encode(v)
+    v.gsub(/[\r\n]/) { |m| "\\u#{'%4.4X' % m.codepoints.to_a}" }.gsub(/\\/,'\\'*3)
   end
 
-  def unescape(key)
-    key.gsub(/\\/,'')
+  def decode(v)
+    v.gsub(/\\u([0-9A-Fa-f]{4})/) { |m| $1.hex.chr('UTF-8') }
+  end
+
+  def escape(v)
+    v.gsub(/[\s:=\\]/) { |m| "\\#{m}" }
+  end
+
+  def unescape(v)
+    v.gsub(/(?<!\\)\\/,'')
   end
 
 end

data/spec/dot_properties_spec.rb

@@ -10,15 +10,15 @@ describe DotProperties do
   let(:propfile) { File.expand_path('../fixtures/sample.properties', __FILE__) }
   subject { DotProperties.load(propfile) }
 
-  let(:properties) { 16 }
-  let(:comments)   { 14 }
-  let(:blanks)     {  8 }
+  let(:properties) { 21 }
+  let(:comments)   { 16 }
+  let(:blanks)     { 11 }
 
   it { should be_an_instance_of(DotProperties) }
 
   describe "values" do
     it "should have the right number of properties" do
-      expect(subject.keys.length).to eq(16)
+      expect(subject.keys.length).to eq(properties)
     end
 
     it "should have the right values" do
@@ -32,6 +32,9 @@ describe DotProperties do
       expect(subject['foo bar:baz= quux']).to eq('this is getting ridiculous')
       expect(subject['lots of fruit']).to eq('apple, peach, kiwi, mango, banana, strawberry, raspberry')
       expect(subject['some.veggies']).to eq('carrot, potato, broccoli')
+      expect(subject['space.key1']).to eq('space.Value1')
+      expect(subject['space.key2']).to eq('space.Value2')
+      expect(subject['space.key3']).to eq('space.Multi word value')
       expect(subject['foo.empty']).to be_empty
       expect(subject['bar.empty']).to be_empty
       expect(subject['baz.empty']).to be_empty
@@ -107,6 +110,16 @@ describe DotProperties do
     end
   end
 
+  describe "content escapes" do
+    it "should parse Java-escaped unicode" do
+      expect(subject['unicode']).to eq("Command\t\u2318\nOption\t\u2325")
+    end
+
+    it "should unescape escaped entities" do
+      expect(subject['key with:several=escapes']).to eq('value with#several\escapes')
+    end
+  end
+
   describe "additional methods" do
     it "#<<" do
       subject << ""

data/spec/fixtures/sample.properties

@@ -31,12 +31,22 @@ some.veggies=carrot, \
              potato, \
         broccoli
 
+# Leading spaces
+
+ space.key1 = space.Value1
+        space.key2:space.Value2  
+ space.key3                  :space.Multi word value   
+
 # Empty values
 foo.empty
 bar.empty=
 baz.empty:
 quux.empty =
 
+# Escapes
+unicode=Command\u0009\u2318\u000AOption\u0009\u2325
+key\ with\:several\=es\c\apes:value\ with\#several\\escapes
+
 # References
 present = This value contains two resolvable references, ${foo.normal} and ${bar.extraspace}
 missing = This value contains one resolvable reference, ${foo.normal}, and one unresolvable reference, ${quux.missing}

metadata

@@ -1,94 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: dot-properties
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.4
 platform: ruby
 authors:
 - Michael B. Klein
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-11-27 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: 2.2.33
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.2.33
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.4.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Java-style .properties file manipulation with a light touch
@@ -98,8 +87,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -113,33 +102,25 @@ files:
 homepage: https://github.com/mbklein/dot-properties
 licenses:
 - APACHE2
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1306251061274732022
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1306251061274732022
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
-signing_key: 
-specification_version: 3
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
 summary: Read/write .properties files, respecting comments and existing formatting
   as much as possible
 test_files: