README.md in frise-0.3.0.pre vs README.md in frise-0.3.0
- old
+ new
@@ -1,14 +1,15 @@
# Frise
-[](https://travis-ci.org/ShiftForward/frise)
-[](https://coveralls.io/github/ShiftForward/frise?branch=master)
+[](https://travis-ci.org/velocidi/frise)
+[](https://coveralls.io/github/velocidi/frise?branch=master)
[](https://badge.fury.io/rb/frise)
Frise is a library for loading configuration files as native Ruby structures. Besides reading and
parsing the files themselves, it also:
-- Completes it with default values specified in another file or set of files;
+- Allows defining other files to be merged anywhere in the config, which can be used to provide default values specified
+ in another file or set of files;
- Interprets [Liquid](https://shopify.github.io/liquid) templates in configs and defaults;
- Validates the loaded config according to a schema file or set of files.
## Install
@@ -22,11 +23,10 @@
The simplest example would be to load [a simple configuration](example/config.yml) from a file:
```ruby
require 'frise'
-require 'pp'
loader = Frise::Loader.new
loader.load('example/config.yml')
# => {"movies"=>
# [{"title"=>"The Shawshank Redemption",
@@ -42,16 +42,15 @@
Currently Frise only supports YAML files, but it may support JSON and other formats in the future.
### Default values
-By defining directories where the files with default values can be found (in this example,
-[example/_defaults](example/_defaults)), Frise can handle its application internally on load time:
+By using the `$include` directive pointing to the files where default values can be found (in this example,
+[example/_defaults/config.yml](example/_defaults/config.yml)), Frise can handle its application internally on load time:
```ruby
-loader = Frise::Loader.new(defaults_load_paths: ['example/_defaults'])
-loader.load('example/config.yml')
+loader.load('example/config_with_defaults.yml')
# => {"movies"=>
# [{"title"=>"The Shawshank Redemption",
# "year"=>1994,
# "categories"=>["Crime", "Drama"],
# "rating"=>9.3,
@@ -73,19 +72,15 @@
config.
### Schemas
Additionally, configuration files can also be validated against a schema. By specifying
-`schema_load_paths`, users can provide directories where schema files such as
-[example/_schemas/config.yml](example/_schemas/config.yml) can be found:
+`$schema` in the config, users can provide schema files such as
+[example/_schemas/config.yml](example/_schemas/config.yml):
```ruby
-loader = Frise::Loader.new(
- schema_load_paths: ['example/_schemas'],
- defaults_load_paths: ['example/_defaults'])
-
-loader.load('example/config.yml')
+loader.load('example/config_with_defaults_and_schema.yml')
# {"movies"=>
# [{"title"=>"The Shawshank Redemption",
# "year"=>1994,
# "categories"=>["Crime", "Drama"],
# "rating"=>9.3,
@@ -104,19 +99,17 @@
If this config is loaded without the defaults instead, there are now required values that are
missing and Frise by default prints a summary of the errors and terminates the program:
```ruby
-loader = Frise::Loader.new(schema_load_paths: ['example/_schemas'])
-
-loader.load('example/config.yml')
+loader.load('example/config_with_schema.yml')
# 2 config error(s) found:
# - At movies.0.director: missing required value
# - At ui: missing required value
```
Once more, the structure of the schema mimics the structure of the config itself, making it easy to
-write schemas and to create a config scaffold from its schema later.
+write schemas first and create a config scaffold from its schema later.
Users can check a whole range of properties in config values besides their type: optional values,
hashes with validated keys, hashes with unknown keys and even custom validations are also supported.
The [specification](spec/frise/validator_spec.rb) of the validator provides various examples of
schemas and describes the behavior of each value (more documentation will be written soon).