proper_properties 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0e73ae3fb455d335998b9ced5a388d03e923384
-  data.tar.gz: 174890d5265606617411593f037279ef2bbc9c81
+  metadata.gz: ded64a75f7f400f69264e135dcc370f07b252e25
+  data.tar.gz: 984275d92225e8b14861b2a393dbffb908ddb5fc
 SHA512:
-  metadata.gz: b402ae7a76d56183cf457ce71e97ce8f5f68dae4fd64afecb130abdfcf7aa493214a2bc65d56138f48991bd8193643bd2826953c1a22cf7d11134a7b3cc9213e
-  data.tar.gz: 711cf90f60b7ee205cfe3f921155b3ae3b0fdfb8545b3e886d8a5e717ab2cb62d48a81105ec2afe6ad176ade4e9ce300f6de8b2bbc3b156cd05568b071e7c778
+  metadata.gz: 0be5d7ecbe24ebe704ebc8f76ece60cfe8cf467d0b4e1ac13af45859010fd9ef71ff6dad5c026f6cf243abee1d30d4a1e6a46f8984e5c97b658bdbd3862b3e7a
+  data.tar.gz: d84a9d989339e7ac198fcab17275da556566fd3e16835a0f58d48b618e213acd2c5b2035e31fe901b6121db33fdee74befc081beec3c79ea40e45a532e4c9eb6

data/README.md

@@ -1,3 +1,5 @@
+[properties_documentation]: http://docs.oracle.com/javase/6/docs/api/java/util/Properties.html#load(java.io.Reader)
+
 # ProperProperties
 
 [![Build Status](http://img.shields.io/travis/tnarik/proper_properties.svg)](https://travis-ci.org/tnarik/proper_properties)
@@ -6,7 +8,7 @@
 [![RubyGems](http://img.shields.io/gem/v/proper_properties.svg)](http://rubygems.org/gems/proper_properties)
 [![Gemnasium](http://img.shields.io/gemnasium/tnarik/proper_properties.svg)](https://gemnasium.com/tnarik/proper_properties)
 
-A ruby library to read and write [Java properties files](http://en.wikipedia.org/wiki/.properties), which format is better describe [in the Java documentation](http://docs.oracle.com/javase/6/docs/api/java/util/Properties.html#load(java.io.Reader\)).
+A ruby library to read and write [Java properties files](http://en.wikipedia.org/wiki/.properties), which format is better describe [in the Java documentation][properties_documentation].
 
 ## Installation
 
@@ -23,6 +25,7 @@ You can load a valid Java properties file from the file system using a path:
 ```ruby
 properties = ProperProperties.load("path/to/my.properties")
 properties[:foo] # => "bar"
+properties['foo'] # => "bar"
 ```
 
 If have already the content of the properties file at hand than parse the content as:
@@ -30,14 +33,15 @@ If have already the content of the properties file at hand than parse the conten
 ```ruby
 properties = ProperProperties.load("foo=bar")
 properties[:foo] # => "bar"
+properties['foo'] # => "bar"
 ```
 
 ## Writing files
 
-You can write any Hash-like structure as a properties file:
+You can write any Hash-like structure (with symbol or string keys) as a properties file:
 
 ```ruby
-hash = {:foo => "bar"}
+hash = {:foo => "bar", "foobar" => "barfoo"}
 ProperProperties.write(hash, "path/to/my.properties")
 ```
 
@@ -93,11 +97,11 @@ In the opposite direction line breaks will be correctly escaped but the generato
 ## Author
 
 - Tnarik Innael (@tnarik)
-- Jonas Thiel (@jonasthiel) : [original project](https://github.com/jnbt/java-properties) from commit [1f2c4b008d69d0eae1084b1adfdea814e2b29899]
+- Jonas Thiel (@jonasthiel) : [original project](https://github.com/jnbt/java-properties) upto [1f2c4b008d69d0eae1084b1adfdea814e2b29899](https://github.com/tnarik/proper_properties/commit/1f2c4b008d69d0eae1084b1adfdea814e2b29899)
 
 ## References
 
-For a proper description about the properties file format have a look at the [Java Plattform documentation](http://docs.oracle.com/javase/6/docs/api/java/util/Properties.html#load(java.io.Reader\)).
+For a proper description about the properties file format have a look at the [Java Plattform documentation][properties_documentation].
 
 ## License
 

data/lib/proper_properties/properties.rb

@@ -1,6 +1,64 @@
 module ProperProperties
   # Simple representation of a properties file content
-  # by a simple ruby hash object
+  # by an extension of a Hash object a la ActiveSupport::HashWithIndifferentAccess, with underlying symbol keys
   class Properties < Hash
+
+    # Assigns a new value to the hash:
+    #
+    #   hash = ProperProperties::Properties.new
+    #   hash[:key] = 'value'
+    #
+    # This value can be later fetched using either +:key+ or +'key'+.
+    def []=(key, value)
+      super(convert_key(key), value)
+    end
+
+    # Checks the hash for a key matching the argument passed in:
+    #
+    #   hash = ProperProperties::Properties.new
+    #   hash['key'] = 'value'
+    #   hash.key?(:key)  # => true
+    #   hash.key?('key') # => true
+    def key?(key)
+      super(convert_key(key))
+    end
+
+    # Same as <tt>Hash#fetch</tt> where the key passed as argument can be
+    # either a string or a symbol:
+    #
+    #   counters = ProperProperties::Properties.new
+    #   counters[:foo] = 1
+    #
+    #   counters.fetch('foo')          # => 1
+    #   counters.fetch(:bar, 0)        # => 0
+    #   counters.fetch(:bar) {|key| 0} # => 0
+    #   counters.fetch(:zoo)           # => KeyError: key not found: "zoo"
+    def fetch(key, *extras)
+      super(convert_key(key), *extras)
+    end
+
+    # Returns an array of the values at the specified indices:
+    #
+    #   hash = ProperProperties::Properties.new
+    #   hash[:a] = 'x'
+    #   hash[:b] = 'y'
+    #   hash.values_at('a', 'b') # => ["x", "y"]
+    def values_at(*indices)
+      indices.collect {|key| self[convert_key(key)]}
+    end
+
+    # Removes the specified key from the hash.
+    def delete(key)
+      super(convert_key(key))
+    end
+
+    def [](key)
+      self.fetch(key)
+    end
+
+  	protected
+      def convert_key(key)
+        key.kind_of?(String) ? key.to_sym : key
+    end
   end
 end

data/lib/proper_properties/version.rb

@@ -1,3 +1,3 @@
 module ProperProperties
-  VERSION = "0.0.1"
-end
+  VERSION = "0.0.2"
+end

data/spec/proper_properties_spec.rb

@@ -4,29 +4,71 @@ require 'tempfile'
 describe ProperProperties do
   subject{ ProperProperties }
 
-  it "parses from string" do
+  it "parses from string to symbol hash" do
     subject.parse("item1=item1").must_equal({:item1 => "item1"})
   end
 
   it "generates from hash" do
     subject.generate({:item1 => "item1"}).must_equal("item1=item1")
+    subject.generate({"item2" => "item2"}).must_equal("item2=item2")
   end
 
-  it "loads from file" do
+  it "loads from file and create a hash" do
     with_temp_file do |file|
       file << "item1=item1"
       file.flush
 
       subject.load(file.path).must_equal({:item1 => "item1"})
+
+    end
+  end
+
+  it "loads from file and allows symbol/string access" do
+    with_temp_file do |file|
+      file << "item1=item1"
+      file.flush
+
+      properties = subject.load(file.path)
+      properties[:item1].must_equal("item1")
+      properties['item1'].must_equal("item1")
+    end
+  end
+
+  it "loads from file and allows manipulation" do
+    with_temp_file do |file|
+      file << "item1=item1\n"
+      file << "item2=item2\n"
+      file << "item3=item3\n"
+      file << "item4=item4"
+      file.flush
+
+      properties = subject.load(file.path)
+
+      properties.values_at(:item1, "item2", 'item3').must_equal(["item1", "item2", "item3"])
+
+
+      properties[:item2].must_equal("item2")
+      properties.delete(:item2).must_equal("item2")
+      proc{ properties[:item2] }.must_raise(KeyError)
+
+      properties['item3'].must_equal("item3")
+      properties.delete('item3').must_equal("item3")
+      proc{ properties['item3'] }.must_raise(KeyError)
+
+      properties.key?(:item4).must_equal(true)
+      properties.key?('item4').must_equal(true)
+
+      properties.key?(:item5).must_equal(false)
+      properties.key?('item5').must_equal(false)
     end
   end
 
   it "writes to file" do
     with_temp_file do |file|      
-      subject.write({:item1 => "item1"}, file.path)
+      subject.write({:item1 => "item1", "item2" => "item2"}, file.path)
 
       file.rewind
-      file.read.must_equal "item1=item1"
+      file.read.must_equal "item1=item1\nitem2=item2"
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proper_properties
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tnarik Innael
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-26 00:00:00.000000000 Z
+date: 2014-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake