README.md in qonfig-0.23.0 vs README.md in qonfig-0.24.0
- old
+ new
@@ -101,10 +101,11 @@
- [Save to YAML file](#save-to-yaml-file) (`#save_to_yaml`)
- [Plugins](#plugins)
- [toml](#plugins-toml) (support for `TOML` format)
- [pretty_print](#plugins-pretty_print) (beautified/prettified console output)
- [Roadmap](#roadmap)
+- [Build](#build)
---
## Definition
- [Definition and Settings Access](#definition-and-access)
@@ -631,26 +632,25 @@
- [writing](#writing-by-setting-name-and-index-method-with-dot-notation-support-and-indifferent-access)
- [precitaes](#predicates-see-full-documentation)
---
-- `Qonfig::Compacted`: represents the compacted config object with setting readers and setting writers;
+- `Qonfig::Compacted`: represents the compacted config object with setting readers, setting writers and setting predicates only - and no any other useful instance-based functionality:
- setting keys are represented as direct instace methods (`#settings` invokation does not need);
-- no any other useful instance-based functionality - just setting readers, setting writers and setting predicates:
- support for index-like access methods (`[]`,`[]=`);
- full support of `Qonfig::DataSet` definition DSL commands:
- `setting`, `re_setting` [doc](#definition-and-access)
- `validate`, `add_validator` [doc](#validation)
- `load_from_self` [doc](#load-from-__end__), `load_from_yaml` [doc](#load-from-yaml-file), `load_from_json` [doc](#load-from-json-file), `load_from_toml` [doc](#plugins-toml);
- `expose_self` [doc](#expose-__end__), `expose_yaml` [doc](#expose-yaml), `expose_json` [doc](#expose-json), `expose_toml` [doc](#plugins-toml)
- `values_file` [doc](#default-setting-values-file)
- support for validation of potential setting values `.valid_with?` [documentation](#validation-of-potential-setting-values);
- can be instantiated by:
- by existing config object: `Qonfig::DataSet#compacted` or `Qonfig::Compacted.build_from(config, &configuration)`;
- - from existing `Qonfig::DataSet` class: ``Qonfig::DataSet.build_compacted`;
+ - from existing `Qonfig::DataSet` class: `Qonfig::DataSet.build_compacted`;
- by direct instantiation: `Qonfig::Compacted.new(settings_values = {}, &configuration)`;
- - by implicit instance building without explicit class definition `Qonfig::Compacted.build(&dsl_commands) # => instance of Qonfig::Compacted`;
+ - by implicit instance building without explicit class definition `Qonfig::Compacted.build(&dsl_commands)`;
- you can define your own instance methods too;
---
### Definition and instantiation
@@ -3211,9 +3211,16 @@
- cli toolchain;
- support for Rails-like secrets;
- support for persistent data storages (we want to store configs in multiple databases and files);
- Rails reload plugin;
- **Minor**:
+
+## Build
+
+```shell
+bin/rspec -w # test the core functionality and plugins
+bin/rspec -n # test only the core functionality
+```
## Contributing
- Fork it ( https://github.com/0exp/qonfig/fork )
- Create your feature branch (`git checkout -b feature/my-new-feature`)