%%%,%%%%%%%
               ,'%% \\-*%%%%%%%
         ;%%%%%*%   _%%%%"
          ,%%%       \(_.*%%%%.
          % *%%, ,%%%%*(    '
        %^     ,*%%% )\|,%%*%,_
             *%    \/ #).-"*%%*
                 _.) ,/ *%,
         _________/)#(_____________

art by b'ger

Figtree

about

A parser and transformer for loading .ini files into Ruby dot notation accessible objects. .ini is not a standardized format. But the parser and transformer are easy to extend.

The goal of figtree is not to accept all .ini files generously, but more strictly define .ini files so we can make smarter guesses about how to convert your settings into objects.

What kinds of objects are supported? Currently we can recognize unix style filepaths into Pathname, ip4 and ip6 addresses into IPAddr, and most common Ruby types (String, Array, Boolean, Integer). If there's other types you'd like to see supported, please file an issue.

If the .ini file is invalid, an error will be raised, with the line and char position of the error. If you extend this gem to have more rules, and one of those rules fails to transform, you will have an error raised.

alternatives

If you want an industrial strength, pure Ruby solution, check out inifile gem. It is much looser about what it accepts as valid .ini files, and with no pesky dependencies! If you want to see exactly which cases figtree supports vs inifile, compare our spec files. Many of the cases in our invalid/ folder inifile will parse for you.

installation

gem install figtree

usage

require 'figtree'
config = Figtree::IniConfig.new('spec/support/settings.conf')
config.common.basic_size_limit
=> 26214400
# also good
config[:common]["paid_users_size_limit"]
=> 2147483648
# also also good :)
config.common[:paid_users_size_limit]
=> 2147483648
# and overrides? we got overrides
overridden_config = Figtree::IniConfig.new('spec/support/settings.conf', :production)
config.ftp.path
=> "/tmp/"
overridden_config.ftp.path
=> "/srv/var/tmp/"

disambiguation

Looking for the graphical viewer of phyllogenic trees? You want this other Figtree.

performance

A typical .ini file takes slightly less than 0.02s to be parsed, transformed, and loaded. Currently, the whole .ini file is read into memory at once. The assumption being these files should not typically be too big. But future minor versions might move to line by line ingestion.

development

helpers

bin/setup bin/console

While in console, you can use parse_ini_named name and as long as it's in spec/support/name.ini it'll parse it for you with helpful error output. Sometimes this is a faster feedback mechanism than going through the tests.

tests

rspec spec/

TODO

• more cleanup
• give char/line position of transformer failures