/ruby-hocon

Primary LanguageRubyApache License 2.0Apache-2.0

Build Status

ruby-hocon

This is a port of the Typesafe Config library to Ruby.

The library provides Ruby support for the HOCON configuration file format.

At present, the only features it supports are explicit parsing of config files (.conf/HOCON, .json, .properties) via ConfigFactory.parse_file, and rendering a parsed config object back to a String. Testing is minimal and not all data types are supported yet. It also does not yet support include or interpolated settings. PLEASE NOTE that as a result this project is in a very experimental state, and in some cases may not work properly, so please be wary when using it. If you find a problem, feel free to open a github issue.

The implementation is intended to be as close to a line-for-line port as the two languages allow, in hopes of making it fairly easy to port over new changesets from the Java code base over time.

Basic Usage

gem install hocon
require 'hocon/config_factory'

conf = Hocon::ConfigFactory.parse_file("myapp.conf")
conf_map = conf.root.unwrapped

Testing

bundle install
bundle exec rspec spec