java-properties 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 574e7ba19cb13bc15df2a6adbe13d7980568d441
-  data.tar.gz: 91a7367ff442648a2761b29c0d74ea7cc5457f0e
+  metadata.gz: fa01303d1449ae0f74ddd1a56b9da076f232335e
+  data.tar.gz: 9704efbe011c991ddede20ea11cc5d63da9897d1
 SHA512:
-  metadata.gz: 2f7def4045006710af040db297a36b065c24e82d727101cf2a48917362e7a5822757534d957c9a453821a3abd394187f8562c54e608897756b190e33f33a092d
-  data.tar.gz: 1d4808985ac4a0b5c3a5e631b484a1c5d03f9feeca981e01cc296d1c44fcbeed7e4f73dd0892909bbc3f4c65b44f3f7331fd77cdd82cd52b9ce181c2a62608a7
+  metadata.gz: c4df80543ad68a53c37dd7cc6aea82b256591c11813e30737a2a65ee340ec1c4eb877436f265466f47f93b1ac68c46a0c7b9fa77529cc061cb4965b5ce38f960
+  data.tar.gz: ea06f6daad8d178218f6bb227f080263c3b7341b1c2d128993b8b9b5734e00f2e9eee85b87a51f240dbd2f4aa35780f6c2e8add55d004fb1affb5c8e40e4a54a

data/README.md

@@ -11,46 +11,62 @@ A ruby library to read and write [Java properties files](http://en.wikipedia.org
 
 Install via Rubygems
 
-    gem install java-properties
+```bash
+$ gem install java-properties
+```
 
 ... or add to your Gemfile
 
-    gem "java-properties"
+```ruby
+gem "java-properties"
+```
 
 ## Loading files
 
 You can load a valid Java properties file from the file system using a path:
 
-    properties = JavaProperties.load("path/to/my.properties")
-    properties[:foo] # => "bar"
+```ruby
+properties = JavaProperties.load("path/to/my.properties")
+properties[:foo] # => "bar"
+```
 
 If have already the content of the properties file at hand than parse the content as:
 
-    properties = JavaProperties.load("foo=bar")
-    properties[:foo] # => "bar"    
+```ruby
+properties = JavaProperties.load("foo=bar")
+properties[:foo] # => "bar"
+```
 
 ## Writing files
 
 You can write any Hash-like structure as a properties file:
 
-    hash = {:foo => "bar"}
-    JavaProperties.write(hash, "path/to/my.properties")
+```ruby
+hash = {:foo => "bar"}
+JavaProperties.write(hash, "path/to/my.properties")
+```
 
 Or if you want to omit the file you can receive the content directly:
 
-    hash = {:foo => "bar"}
-    JavaProperties.generate(hash)  # => "foo=bar"
+```ruby
+hash = {:foo => "bar"}
+JavaProperties.generate(hash)  # => "foo=bar"
+```
 
 ## Encodings and special chars
 
 As Java properties files normally hold UTF-8 chars in their escaped representation this tool tries to convert them:
 
-    "ה" <=> "\u05d4"
+```
+"ה" <=> "\u05d4"
+```
 
 The tool also escaped every '=', ' ' and ':' in the name part of a property line:
 
-    JavaProperties.generate({"i : like=strange" => "bar"}) 
-    # => "i\ \:\ like\=strange=bar"
+```ruby
+JavaProperties.generate({"i : like=strange" => "bar"}) 
+# => "i\ \:\ like\=strange=bar"
+```
 
 ## Multi line and line breaks
 
@@ -58,12 +74,16 @@ In Java properties files a string can be multi line but line breaks have to be e
 
 Assume the following input:
 
-    my=This is a multi \
-       line content with only \n one line break
+```ini
+my=This is a multi \
+   line content with only \n one line break
+```
 
 The parses would read:
 
-    {:my => "This is a multi line content which only \n one line break"}
+```ruby
+{:my => "This is a multi line content which only \n one line break"}
+```
 
 In the opposite direction line breaks will be correctly escaped but the generator will never use multi line values.
 
@@ -85,4 +105,4 @@ For more information about the properties file format have a look at the [Java P
 
 ## License
 
-This gem is released under the MIT License. See the LICENSE file for further details.
+This gem is released under the MIT License. See the LICENSE file for further details.

data/lib/java-properties.rb

@@ -18,10 +18,11 @@ module JavaProperties
 
   # Generates the content of a Java properties file
   # @see Generating::Generator
-  # @param hash [Hash]
+  # @param hash [Hash] 
+  # @param options [Hash] options for the generator
   # @return [String]
-  def self.generate(hash)
-    Generating::Generator.generate(hash)
+  def self.generate(hash, options = {})
+    Generating::Generator.generate(hash, options)
   end
 
   # Loads and parses a Java properties file
@@ -36,8 +37,9 @@ module JavaProperties
   # @see Generating::Generator
   # @param hash [Hash]
   # @param path [String]
-  def self.write(hash, path)
-    File.write(path, generate(hash))
+  # @param options [Hash] options for the generator
+  def self.write(hash, path, options = {})
+    File.write(path, generate(hash, options))
   end
 
 end

data/lib/java-properties/generating/generator.rb

@@ -11,23 +11,45 @@ module JavaProperties
       # @return [String]
       KEY_VALUE_SEPARATOR = '='
 
+      # Default options
+      # @return [Hash]
+      DEFAULT_OPTIONS = {
+        :skip_encode_unicode       => false,
+        :skip_encode_separators    => false,
+        :skip_encode_special_chars => false
+      }.freeze
+
       # Generates a properties file content based on a hash
       # @param properties [Properties] or simple hash
+      # @param options    [Hash]
+      # @option options skip_encode_unicode [Boolean] Skip unicode encoding
+      # @option options skip_encode_separators [Boolean] Skip seperators encoding
+      # @option options skip_encode_special_chars [Boolean] Skip special char encoding
       # @return [String]
-      def self.generate(properties)
+      def self.generate(properties, options = {})
+        options = DEFAULT_OPTIONS.merge(options)
         lines = []
         properties.each do |key, value|
-          lines << build_line(key, value)
+          lines << build_line(key, value, options)
         end
         lines.join("\n")
       end
 
       private
 
-      def self.build_line(key, value = '')
-        Encoding.encode!(key.to_s.dup) +
-        KEY_VALUE_SEPARATOR +
-        Encoding.encode!(value.to_s.dup, Encoding::SKIP_SEPARATORS)
+      def self.build_line(key, value, options)
+        encoded_key   = Encoding.encode!(key.to_s.dup,   *encoding_skips(false, options))
+        encoded_value = Encoding.encode!(value.to_s.dup, *encoding_skips(true,  options))
+
+        encoded_key + KEY_VALUE_SEPARATOR + encoded_value
+      end
+
+      def self.encoding_skips(is_value, options)
+        skips = []
+        skips << Encoding::SKIP_SEPARATORS    if is_value || options[:skip_encode_separators]
+        skips << Encoding::SKIP_UNICODE       if options[:skip_encode_unicode]
+        skips << Encoding::SKIP_SPECIAL_CHARS if options[:skip_encode_special_chars]
+        skips
       end
     end
   end

data/lib/java-properties/version.rb

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

data/spec/fixtures/test_out_skip_separators.properties

@@ -0,0 +1,11 @@
+item0=
+item1=item1
+item2=item2
+item3=item3
+it em4=item4
+it=em5=item5
+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

data/spec/fixtures/test_out_skip_special_chars.properties

@@ -0,0 +1,14 @@
+item0=
+item1=item1
+item2=item2
+item3=item3
+it\ em4=item4
+it\=em5=item5
+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
+	test\u05d4 test
+	test test
+	test = test

data/spec/fixtures/test_out_skip_unicode.properties

@@ -0,0 +1,11 @@
+item0=
+item1=item1
+item2=item2
+item3=item3
+it\ em4=item4
+it\=em5=item5
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: java-properties
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jonas Thiel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2014-02-17 00:00:00.000000000 Z
 dependencies: []
 description: Tool for loading and writing Java properties files
 email:
@@ -21,21 +21,24 @@ files:
 - README.md
 - Rakefile
 - java-properties.gemspec
+- lib/java-properties.rb
+- lib/java-properties/encoding.rb
 - lib/java-properties/encoding/separators.rb
 - lib/java-properties/encoding/special_chars.rb
 - lib/java-properties/encoding/unicode.rb
-- lib/java-properties/encoding.rb
-- lib/java-properties/generating/generator.rb
 - lib/java-properties/generating.rb
+- lib/java-properties/generating/generator.rb
+- lib/java-properties/parsing.rb
 - lib/java-properties/parsing/normalizer.rb
 - lib/java-properties/parsing/parser.rb
-- lib/java-properties/parsing.rb
 - lib/java-properties/properties.rb
 - lib/java-properties/version.rb
-- lib/java-properties.rb
 - 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
 homepage: https://github.com/jnbt/java-properties
 licenses:
 - MIT
@@ -56,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Loader and writer for *.properties files
@@ -64,4 +67,7 @@ test_files:
 - 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: