cfg-config 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42d965189975d3e21172981161817be59fd20ee4dd0641d119626eeff3f451a7
+  data.tar.gz: 2176e90e4c01cd3990ec48a62a59bb166a924d68148c074ab4f04b208a106990
+SHA512:
+  metadata.gz: 35fd6448761324bbe04394ca8165d8c4613d4a8e82bcad27fb2cf0671c170f3c12be3417efc877464d3080d1c6e91ae049fefbc9f29901caa78fc57c2f3b636c
+  data.tar.gz: 9e47521770880b2522499b8c9237114dc19240d6db6b6201a5ae16f0e7593d50df0875f836e7baff99fb92b6a1d829dec8ca6526221887bf1f6fed3d40cfba58

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Change Log
+
+All notable changes for the new implementation should be documented in this file.
+
+## 0.1.0 - 2021-09-14
+### Added
+- [`30f0482`](https://github.com/vsajip/rb-cfg-lib/commit/30f0482)
+  Release new implementation.

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'minitest', '~> 5.0'
+gem 'rake', '~> 12.0'
+
+gem 'byebug', '~> 11.1', groups: %i[development test]

data/LICENSE.txt

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2018-2021, Vinay Sajip.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,131 @@
+# CFG::Config
+
+A Ruby library for working with the CFG configuration format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cfg-config'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cfg-config
+
+## Usage
+
+The CFG configuration format is a text format for configuration files which is similar to, and a superset of, the JSON format. It dates from before its first announcement in [2008](https://wiki.python.org/moin/HierConfig) and has the following aims:
+
+* Allow a hierarchical configuration scheme with support for key-value mappings and lists.
+* Support cross-references between one part of the configuration and another.
+* Provide a string interpolation facility to easily build up configuration values from other configuration values.
+* Provide the ability to compose configurations (using include and merge facilities).
+* Provide the ability to access real application objects safely, where supported by the platform.
+* Be completely declarative.
+
+It overcomes a number of drawbacks of JSON when used as a configuration format:
+
+* JSON is more verbose than necessary.
+* JSON doesn’t allow comments.
+* JSON doesn’t provide first-class support for dates and multi-line strings.
+* JSON doesn’t allow trailing commas in lists and mappings.
+* JSON doesn’t provide easy cross-referencing, interpolation, or composition.
+
+A simple example
+================
+
+With the following configuration file, `test0.cfg`:
+```text
+a: 'Hello, '
+b: 'world!'
+c: {
+  d: 'e'
+}
+'f.g': 'h'
+christmas_morning: `2019-12-25 08:39:49`
+home: `$HOME`
+foo: `$FOO|bar`
+```
+
+You can load and query the above configuration using, for example, [irb](https://ruby-doc.org/stdlib-2.4.0/libdoc/irb/rdoc/IRB.html):
+
+Loading a configuration
+-----------------------
+
+The configuration above can be loaded as shown below. In the REPL shell:
+```text
+2.7.1 :001 > require 'CFG/config'
+ => true
+2.7.1 :002 > include CFG
+ => Object
+2.7.1 :003 > cfg = CFG::Config::new("test0.cfg")
+```
+
+The successful `new()` call returns a `Config` instance which can be used to query the configuration.
+
+Access elements with keys
+-------------------------
+Accessing elements of the configuration with a simple key is not much harder than using a `Hash`:
+```text
+2.7.1 :004 > cfg['a']
+ => "Hello, "
+2.7.1 :005 > cfg['b']
+ => "world!"
+```
+
+Access elements with paths
+--------------------------
+As well as simple keys, elements can also be accessed using path strings:
+```text
+2.7.1 :006 > cfg['c.d']
+ => "e"
+```
+Here, the desired value is obtained in a single step, by (under the hood) walking the path `c.d` – first getting the mapping at key `c`, and then the value at `d` in the resulting mapping.
+
+Note that you can have simple keys which look like paths:
+```text
+2.7.1 :007 > cfg['f.g']
+ => "h"
+```
+If a key is given that exists in the configuration, it is used as such, and if it is not present in the configuration, an attempt is made to interpret it as a path. Thus, `f.g` is present and accessed via key, whereas `c.d` is not an existing key, so is interpreted as a path.
+
+Access to date/time objects
+---------------------------
+You can also get native Ruby date/time objects from a configuration, by using an ISO date/time pattern in a backtick-string:
+```text
+2.7.1 :008 > cfg['christmas_morning']
+ => #<DateTime: 2019-12-25T08:39:49+00:00 ((2458843j,31189s,0n),+0s,2299161j)>
+```
+Access to other Ruby objects
+----------------------------
+Access to other Ruby objects is also possible using the backtick-string syntax, provided that they are one of:
+* Environment variables
+* Public fields of public classes
+* Public static methods without parameters of public classes
+```text
+2.7.1 :009 > require 'date'
+ => false
+2.7.1 :010 > DateTime::now - cfg['now']
+ => (-148657/86400000000000)
+ ```
+
+Access to environment variables
+-------------------------------
+To access an environment variable, use a backtick-string of the form `$VARNAME`:
+```text
+2.7.1 :011 > cfg['home'] == ENV['HOME']
+ => true
+```
+You can specify a default value to be used if an environment variable isn’t present using the `$VARNAME|default-value` form. Whatever string follows the pipe character (including the empty string) is returned if the VARNAME is not a variable in the environment.
+```text
+2.7.1 :012 > cfg['foo']
+ => "bar"
+```
+
+For more information, see [the CFG documentation](https://docs.red-dove.com/cfg/index.html).

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+# task :default => :test
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'CFG/config'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cfg-config.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/CFG/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'cfg-config'
+  spec.version = CFG::VERSION
+  spec.authors = ['Vinay Sajip']
+  spec.email = ['vinay_sajip@yahoo.co.uk']
+
+  spec.summary = 'A Ruby library for working with the CFG configuration format.'
+  spec.description = 'A Ruby library for working with the CFG configuration format. See https://docs.red-dove.com/cfg/index.html for more information.'
+  spec.homepage = 'https://docs.red-dove.com/cfg/index.html'
+  spec.license  = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  # spec.metadata['source_code_uri'] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata['changelog_uri'] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir['README.md', 'LICENSE.txt',
+                   'CHANGELOG.md', 'lib/**/*.rb', 'bin/*',
+                   'cfg-config.gemspec', 'Gemfile', 'Rakefile']
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(/^exe\//) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end