Module: JavaProperties

Defined in:
lib/java-properties.rb,
lib/java-properties/version.rb,
lib/java-properties/encoding.rb,
lib/java-properties/properties.rb,
lib/java-properties/parsing/parser.rb,
lib/java-properties/encoding/unicode.rb,
lib/java-properties/parsing/normalizer.rb,
lib/java-properties/encoding/separators.rb,
lib/java-properties/generating/generator.rb,
lib/java-properties/encoding/special_chars.rb

Overview

A module to read and write Java properties files

Defined Under Namespace

Modules: Encoding, Generating, Parsing Classes: Properties

Constant Summary collapse

VERSION =

Current version

Returns:

  • (String) 
"0.2.0".freeze

Class Method Summary collapse

Class Method Details

.generate(hash, options = {}) ⇒ String

Generates the content of a Java properties file

Parameters:

  • hash (Hash)
  • options (Hash) (defaults to: {}) —

    options for the generator

Returns:

  • (String)

See Also:



24
25
26
 
# File 'lib/java-properties.rb', line 24

def self.generate(hash, options = {})
  Generating::Generator.generate(hash, options)
end

.load(path) ⇒ Properties

Loads and parses a Java properties file

Parameters:

  • path (String)

Returns:

See Also:



32
33
34
35
36
 
# File 'lib/java-properties.rb', line 32

def self.load(path)
  File.open(path, "r:bom|utf-8") do |f|
    parse(f.read)
  end
end

.parse(text) ⇒ Properties

Parses the content of a Java properties file

Parameters:

  • text (String)

Returns:

See Also:



15
16
17
 
# File 'lib/java-properties.rb', line 15

def self.parse(text)
  Parsing::Parser.parse(text)
end

.write(hash, path, options = {}) ⇒ Object

Generates a Java properties file

Parameters:

  • hash (Hash)
  • path (String)
  • options (Hash) (defaults to: {}) —

    options for the generator

See Also:



43
44
45
 
# File 'lib/java-properties.rb', line 43

def self.write(hash, path, options = {})
  File.write(path, generate(hash, options))
end