runcom 6.0.1 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51f9eacd1ade03026ed02aeab5d127350283311280cba07cc985a26ae107b6f2
-  data.tar.gz: 580f96f8545ff05151a903d0abf5c36892ac08112017389f283fd0b356063445
+  metadata.gz: 2744bb4a297fabb6617fdfc71e1e14e8ef62b0cffb76eecbd09290122424ce45
+  data.tar.gz: 6f6f0164ce8921ae35fd1cd3a9090e62cdb16d10e09ec9337d92f815b51f9595
 SHA512:
-  metadata.gz: 56b7a3708f994b9734d961aeaa27062cb03657ecc42f63a2372429db1bbf9ed5f3cc1e2b3c67ab79dd8527bb79bcdc0e4797e00b4724a88678c2f67d8d831296
-  data.tar.gz: a369b0ca63f6e994ef44e377ee8cf0cec4bd7d79d6b1e5dc62002e1196ee44dedd2515d0944c89d1664f4f08f1154406912fa6f984efa30881d468343dd22abf
+  metadata.gz: 624831faadf016b4115cb1a61b8fd6b504fa44044661f219b36fdf6a3fd4504b8532ff15b3d5892adfd84a4dcb66d55ea3b3a097bd37e977bae75d9a8ebe0e49
+  data.tar.gz: b7b7a8421f3e8d0e32beb79922afebc32f6d9b32e4b11db4f0c5c211838981602941afa916835ce7aa5fa31b8f91c702fd2586d5de4940d5a9ad7867a110ea06

data/{LICENSE.md → LICENSE.adoc}

@@ -1,4 +1,4 @@
-# Apache License
+= Apache License
 
 Version 2.0, January 2004
 
@@ -6,7 +6,7 @@ http://www.apache.org/licenses
 
 TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-## 1. Definitions
+== 1. Definitions
 
 "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by
 Sections 1 through 9 of this document.
@@ -54,14 +54,14 @@ Contribution."
 "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a
 Contribution has been received by Licensor and subsequently incorporated within the Work.
 
-## 2. Grant of Copyright License
+== 2. Grant of Copyright License
 
 Subject to the terms and conditions of this License, each Contributor hereby grants to You a
 perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to
 reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and
 distribute the Work and such Derivative Works in Source or Object form.
 
-## 3. Grant of Patent License
+== 3. Grant of Patent License
 
 Subject to the terms and conditions of this License, each Contributor hereby grants to You a
 perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
@@ -74,39 +74,38 @@ a Contribution incorporated within the Work constitutes direct or contributory p
 then any patent licenses granted to You under this License for that Work shall terminate as of the
 date such litigation is filed.
 
-## 4. Redistribution
+== 4. Redistribution
 
 You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with
 or without modifications, and in Source or Object form, provided that You meet the following
 conditions:
 
-1. You must give any other recipients of the Work or Derivative Works a copy of this License; and
+. You must give any other recipients of the Work or Derivative Works a copy of this License; and
 
-2. You must cause any modified files to carry prominent notices stating that You changed the
-   files; and
+. You must cause any modified files to carry prominent notices stating that You changed the files;
+  and
 
-3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
-   patent, trademark, and attribution notices from the Source form of the Work, excluding those
-   notices that do not pertain to any part of the Derivative Works; and
+. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
+  patent, trademark, and attribution notices from the Source form of the Work, excluding those
+  notices that do not pertain to any part of the Derivative Works; and
 
-4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative
-   Works that You distribute must include a readable copy of the attribution notices contained
-   within such NOTICE file, excluding those notices that do not pertain to any part of the
-   Derivative Works, in at least one of the following places: within a NOTICE text file
-   distributed as part of the Derivative Works; within the Source form or documentation, if
-   provided along with the Derivative Works; or, within a display generated by the Derivative
-   Works, if and wherever such third-party notices normally appear. The contents of the NOTICE
-   file are for informational purposes only and do not modify the License. You may add Your own
-   attribution notices within Derivative Works that You distribute, alongside or as an addendum to
-   the NOTICE text from the Work, provided that such additional attribution notices cannot be
-   construed as modifying the License.
+. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works
+  that You distribute must include a readable copy of the attribution notices contained within such
+  NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in
+  at least one of the following places: within a NOTICE text file distributed as part of the
+  Derivative Works; within the Source form or documentation, if provided along with the Derivative
+  Works; or, within a display generated by the Derivative Works, if and wherever such third-party
+  notices normally appear. The contents of the NOTICE file are for informational purposes only and
+  do not modify the License. You may add Your own attribution notices within Derivative Works that
+  You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such
+  additional attribution notices cannot be construed as modifying the License.
 
 You may add Your own copyright statement to Your modifications and may provide additional or
 different license terms and conditions for use, reproduction, or distribution of Your modifications,
 or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of
 the Work otherwise complies with the conditions stated in this License.
 
-## 5. Submission of Contributions
+== 5. Submission of Contributions
 
 Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the
 Work by You to the Licensor shall be under the terms and conditions of this License, without any
@@ -114,13 +113,13 @@ additional terms or conditions. Notwithstanding the above, nothing herein shall
 the terms of any separate license agreement you may have executed with Licensor regarding such
 Contributions.
 
-## 6. Trademarks
+== 6. Trademarks
 
 This License does not grant permission to use the trade names, trademarks, service marks, or product
 names of the Licensor, except as required for reasonable and customary use in describing the origin
 of the Work and reproducing the content of the NOTICE file.
 
-## 7. Disclaimer of Warranty
+== 7. Disclaimer of Warranty
 
 Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each
 Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -129,7 +128,7 @@ TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. Y
 responsible for determining the appropriateness of using or redistributing the Work and assume any
 risks associated with Your exercise of permissions under this License.
 
-## 8. Limitation of Liability
+== 8. Limitation of Liability
 
 In no event and under no legal theory, whether in tort (including negligence), contract, or
 otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or
@@ -139,7 +138,7 @@ License or out of the use or inability to use the Work (including but not limite
 loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial
 damages or losses), even if such Contributor has been advised of the possibility of such damages.
 
-## 9. Accepting Warranty or Additional Liability
+== 9. Accepting Warranty or Additional Liability
 
 While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee
 for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights
@@ -151,11 +150,11 @@ additional liability.
 
 END OF TERMS AND CONDITIONS
 
-Copyright 2016 [Alchemists](https://www.alchemists.io).
+Copyright link:https://www.alchemists.io[Alchemists].
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
-compliance with the License. You may obtain a [copy](http://www.apache.org/licenses/LICENSE-2.0) of
-the License.
+compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]
+of the License.
 
 Unless required by applicable law or agreed to in writing, software distributed under the License is
 distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or

data/README.adoc

@@ -0,0 +1,234 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+= Runcom
+
+[link=http://badge.fury.io/rb/runcom]
+image::https://badge.fury.io/rb/runcom.svg[Gem Version]
+[link=https://circleci.com/gh/bkuhlmann/runcom]
+image::https://circleci.com/gh/bkuhlmann/runcom.svg?style=svg[Circle CI Status]
+
+Runcom (short for link:https://en.wikipedia.org/wiki/Run_commands[Run Command]) provides common
+functionality for Command Line Interfaces (CLIs) in which to manage global, local, or multiple
+caches, configurations, or data in general. It does this by leveraging the
+https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html[XDG Base Directory
+Specification] built atop the link:https://www.alchemists.io/projects/xdg[XDG] implementation.
+
+toc::[]
+
+== Features
+
+* Wraps the link:https://www.alchemists.io/projects/xdg[XDG] implementation which provides access to
+  the following environment variables:
+** `+$XDG_CACHE_HOME+`
+** `+$XDG_CONFIG_HOME+`
+** `+$XDG_CONFIG_DIRS+`
+** `+$XDG_DATA_HOME+`
+** `+$XDG_DATA_DIRS+`
+* Enhances the XDG cache, config, and data implementation. For the config, the following is
+  supported:
+** Supports loading of CLI-specific http://yaml.org[YAML] configuration file.
+** Supports loading and merging of nested/complex configurations.
+** Supports hash representation of configuration.
+
+== Requirements
+
+. https://www.ruby-lang.org[Ruby 2.7.x].
+
+== Setup
+
+=== Production
+
+To install, run:
+
+[source,bash]
+----
+gem install runcom
+----
+
+Add the following to your Gemfile:
+
+[source,ruby]
+----
+gem "runcom"
+----
+
+=== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/runcom.git
+cd runcom
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
+== Usage
+
+The following describes the enhancements built atop the
+link:https://www.alchemists.io/projects/xdg[XDG] implementation.
+
+=== Overview
+
+While there isn’t an environment convenience object as found in the `+XDG+` namespace, you can
+instantiate each object individually:
+
+[source,ruby]
+----
+cache = Runcom::Cache.new "example/data.json"
+config = Runcom::Config.new "example/configuration.yml"
+data = Runcom::Data.new "example/store.dat"
+----
+
+Each of the above objects share the same API:
+
+* `#relative` - Answers the relative path from which the object was constructed.
+* `#namespace` - Answers the relative namespace as a pathname object from which the object was
+  constructed. The namespace must be identical across the cache, config, and data objects as this is
+  what uniquely identifies and organizes all files associated with your program.
+* `#file_name` - Answers the file name from which the object was constructed.
+* `#current` - Answers first _existing_ file system path computed by `$XDG_*_HOME` followed by each
+  computed `$XDG_*_DIRS` path in order defined. Otherwise, `nil` is answered back.
+* `#all` - Answers all file system paths which is the combined `$XDG_*_HOME` and
+  `$XDG_*_DIRS` values in order defined. These paths _may_ or _may not_ exist on the file system.
+* `#inspect` - Answers a string representation of default XDG home and directory paths for debugging
+  purposes.
+
+Using the `cache` object (created above) as an example, here is what each method answers back:
+
+[source,ruby]
+----
+cache.relative # => #<Pathname:example/data.json>
+cache.namespace # #<Pathname:example>
+cache.file_name # #<Pathname:data.json>
+cache.current # #<Pathname:/Users/bkuhlmann/.cache/example/data.json>
+cache.all # [#<Pathname:/Users/bkuhlmann/.cache/example/data.json>]
+cache.inspect # "XDG_CACHE_HOME=/Users/bkuhlmann/.cache"
+----
+
+=== Variable Priority
+
+Path precedence is determined in the following order (with the first taking highest priority):
+
+. *Local Configuration* - If a `$XDG_*_HOME` or `$XDG_*_DIRS` path relative to the
+  current working directory is detected, it will take precedence over the global configuration.
+  This is the same behavior as found in Git where the local `.git/config` takes precedence over the
+  global `$HOME/.gitconfig`.
+. *Global Configuration* - When a local configuration isn’t found, the global configuration is used
+  as defined by the _XDG Base Directory Specification_.
+
+=== Configuration Specialization
+
+The `Runcom::Config` deserves additional highlighting as it provides support for loading custom
+CLI configurations directly from the command line or from custom locations. It is meant to be used
+within your program(s).
+
+An object is initialized as follows:
+
+[source,ruby]
+----
+configuration = Runcom::Config.new "example/configuration.yml"
+----
+
+Default settings can be initialized as well:
+
+[source,ruby]
+----
+configuration = Runcom::Config.new "example/configuration.yml", defaults: {name: "Example"}
+----
+
+Once a configuration has been initialized, a hash representation can be obtained:
+
+[source,ruby]
+----
+configuration.to_h
+----
+
+A configuration can be merged with another hash (handy for runtime overrides):
+
+[source,ruby]
+----
+updated_configuration = configuration.merge {name: "Updated Name"}
+----
+
+A configuration can also be merged with another configuration:
+
+[source,ruby]
+----
+updated_configuration = configuration.merge Runcom::Config.new("other", defaults: {a: 1})
+----
+
+The current path of the configuration can be asked for as well:
+
+[source,ruby]
+----
+configuration.current # "~/.config/example/configuration.yml"
+----
+
+For further details, study the public interface as provided by the
+link:lib/runcom/config.rb[`Runcom::Config`] object.
+
+=== Examples
+
+Examples of gems built atop this gem are:
+
+* link:https://www.alchemists.io/projects/gemsmith[Gemsmith] - A command line interface for smithing
+  new Ruby gems.
+* link:https://www.alchemists.io/projects/git-cop[Git Cop] - Enforces consistent Git commits.
+* link:https://www.alchemists.io/projects/milestoner[Milestoner] - A command line interface for
+  releasing Git repository milestones.
+* link:https://www.alchemists.io/projects/pennyworth[Pennyworth] - A command line interface that
+  enhances and extends link:https://www.alfredapp.com[Alfred] with Ruby support.
+* link:https://www.alchemists.io/projects/pragmater[Pragmater] - A command line interface for
+  managing/formatting source file pragma comments.
+* link:https://www.alchemists.io/projects/sublime_text_kit[Sublime Text Kit] - A command line
+  interface for managing Sublime Text metadata.
+* link:https://www.alchemists.io/projects/tocer[Tocer] - A command line interface for generating
+  table of contents for Markdown files.
+
+== Tests
+
+To test, run:
+
+[source,bash]
+----
+bundle exec rake
+----
+
+== Versioning
+
+Read link:https://semver.org[Semantic Versioning] for details. Briefly, it means:
+
+* Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+* Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+* Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+
+== Code of Conduct
+
+Please note that this project is released with a link:CODE_OF_CONDUCT.adoc[CODE OF CONDUCT]. By
+participating in this project you agree to abide by its terms.
+
+== Contributions
+
+Read link:CONTRIBUTING.adoc[CONTRIBUTING] for details.
+
+== License
+
+Read link:LICENSE.adoc[LICENSE] for details.
+
+== History
+
+Read link:CHANGES.adoc[CHANGES] for details.
+
+== Credits
+
+Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann.html[Brooke Kuhlmann].

data/lib/runcom/identity.rb

@@ -3,20 +3,9 @@
 module Runcom
   # Gem identity information.
   module Identity
-    def self.name
-      "runcom"
-    end
-
-    def self.label
-      "Runcom"
-    end
-
-    def self.version
-      "6.0.1"
-    end
-
-    def self.version_label
-      "#{label} #{version}"
-    end
+    NAME = "runcom"
+    LABEL = "Runcom"
+    VERSION = "6.1.0"
+    VERSION_LABEL = "#{LABEL} #{VERSION}"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runcom
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -10,9 +10,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIC/jCCAeagAwIBAgIBAjANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
-  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0xOTAyMTcxNjAxMTFaFw0yMDAyMTcx
-  NjAxMTFaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
+  MIIC/jCCAeagAwIBAgIBAzANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
+  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0yMDAzMTUxNDQ1MzJaFw0yMTAzMTUx
+  NDQ1MzJaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
   IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6l1qpXTiomH1RfMRloyw7MiE
   xyVx/x8Yc3EupdH7uhNaTXQGyORN6aOY//1QXXMHIZ9tW74nZLhesWMSUMYy0XhB
   brs+KkurHnc9FnEJAbG7ebGvl/ncqZt72nQvaxpDxvuCBHgJAz+8i5wl6FhLw+oT
@@ -20,15 +20,15 @@ cert_chain:
   D5vkU0YlAm1r98BymuJlcQ1qdkVEI1d48ph4kcS0S0nv1RiuyVb6TCAR3Nu3VaVq
   3fPzZKJLZBx67UvXdbdicWPiUR75elI4PXpLIic3xytaF52ZJYyKZCNZJhNwfQID
   AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU0nzow9vc
-  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBANgfX7kPZkJvsbdWMvbe
-  DUUYxRTqTUzCDpLd2p3sQvgLMKjTNSKt6CFq/kh+98b6RCgO6DqiVfxvOEq02dvf
-  ebMN/ylQqan2FgiAs1rpP0/D4C0MlBjoDktsT+2IyLol1KmkDB20ExJ4Sf1GRNdA
-  hpWOtcgqHtmrc7xzgB6BuyoYufrKKUlCO3ewTM4C375D2qO7hIdKuMOO3CdPMtSk
-  OrWpbzCL+nbbXqeoqiHgZaUvcyyQrGj5sQRxMTzuMXzzQxtHnuTuKrcz16HMTX/O
-  dKvURM+1PwDCzC5tvRwjhUJIizau6+MtkFCvJHmaAj1aZL3odcPejHj5Hxt/0CUW
-  y84=
+  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBAIHhAlD3po4sTYqacXaQ
+  XI9jIhrfMy//2PgbHWcETtlJPBeNUbbSNBABcllUHKqYsVDlSvSmss034KSWNR8F
+  bF1GcloicyvcCC4y6IoW4it0COAcdeaaxkxiBSgKdQFpff9REnDlIKK4uQ9lLxIo
+  Y2G5xubiziKZkyfWFuSr67PIjW3Bu673D1JVBArhA1qbgQmYQcy1CkGOjo+iO8Nf
+  7u/QSfBHb+r/bXhKscDgPpnKwbUmvgO2+94zJG9KsrmIydlzYfsD09aXKx0t6Xy4
+  2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
+  QWc=
   -----END CERTIFICATE-----
-date: 2020-02-01 00:00:00.000000000 Z
+date: 2020-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refinements
@@ -162,14 +162,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.6'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.6'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -260,11 +260,11 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
-- LICENSE.md
+- README.adoc
+- LICENSE.adoc
 files:
-- LICENSE.md
-- README.md
+- LICENSE.adoc
+- README.adoc
 - lib/runcom.rb
 - lib/runcom/cache.rb
 - lib/runcom/config.rb
@@ -275,13 +275,14 @@ files:
 - lib/runcom/identity.rb
 - lib/runcom/paths/common.rb
 - lib/runcom/paths/home.rb
-homepage: https://github.com/bkuhlmann/runcom
+homepage: https://www.alchemists.io/projects/runcom
 licenses:
 - Apache-2.0
 metadata:
-  source_code_uri: https://github.com/bkuhlmann/runcom
-  changelog_uri: https://github.com/bkuhlmann/runcom/blob/master/CHANGES.md
   bug_tracker_uri: https://github.com/bkuhlmann/runcom/issues
+  changelog_uri: https://www.alchemists.io/projects/runcom/changes.html
+  documentation_uri: https://www.alchemists.io/projects/runcom
+  source_code_uri: https://github.com/bkuhlmann/runcom
 post_install_message: 
 rdoc_options: []
 require_paths:

data/README.md

@@ -1,204 +0,0 @@
-<p align="center">
-  <img src="runcom.png" alt="Runcom Icon"/>
-</p>
-
-# Runcom
-
-[![Gem Version](https://badge.fury.io/rb/runcom.svg)](http://badge.fury.io/rb/runcom)
-[![Code Climate Maintainability](https://api.codeclimate.com/v1/badges/129b7ea524a0f5a6a805/maintainability)](https://codeclimate.com/github/bkuhlmann/runcom/maintainability)
-[![Code Climate Test Coverage](https://api.codeclimate.com/v1/badges/129b7ea524a0f5a6a805/test_coverage)](https://codeclimate.com/github/bkuhlmann/runcom/test_coverage)
-[![Circle CI Status](https://circleci.com/gh/bkuhlmann/runcom.svg?style=svg)](https://circleci.com/gh/bkuhlmann/runcom)
-
-Runcom (short for [Run Command](https://en.wikipedia.org/wiki/Run_commands)) provides common
-functionality for Command Line Interfaces (CLIs) in which to manage global, local, or multiple
-caches, configurations, or data in general. It does this by leveraging the [XDG Base Directory
-Specification](https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html) built atop
-the [XDG](https://github.com/bkuhlmann/xdg) implementation.
-
-<!-- Tocer[start]: Auto-generated, don't remove. -->
-
-## Table of Contents
-
-  - [Features](#features)
-  - [Requirements](#requirements)
-  - [Setup](#setup)
-  - [Usage](#usage)
-      - [Overview](#overview)
-      - [Variable Priority](#variable-priority)
-      - [Configuration Specialization](#configuration-specialization)
-    - [Examples](#examples)
-  - [Tests](#tests)
-  - [Versioning](#versioning)
-  - [Code of Conduct](#code-of-conduct)
-  - [Contributions](#contributions)
-  - [License](#license)
-  - [History](#history)
-  - [Credits](#credits)
-
-<!-- Tocer[finish]: Auto-generated, don't remove. -->
-
-## Features
-
-- Wraps the [XDG](https://github.com/bkuhlmann/xdg) implementation which provides access to the
-  following environment variables:
-  - `$XDG_CACHE_HOME`
-  - `$XDG_CONFIG_HOME`
-  - `$XDG_CONFIG_DIRS`
-  - `$XDG_DATA_HOME`
-  - `$XDG_DATA_DIRS`
-- Enhances the XDG cache, config, and data implementation. For the config, the following is
-  supported:
-  - Supports loading of CLI-specific [YAML](http://yaml.org) configuration file.
-  - Supports loading and merging of nested/complex configurations.
-  - Supports hash representation of configuration.
-
-## Requirements
-
-1. [Ruby 2.7.x](https://www.ruby-lang.org).
-
-## Setup
-
-Type the following to install:
-
-    gem install runcom
-
-Add the following to your Gemfile:
-
-    gem "runcom"
-
-## Usage
-
-The following describes the enhancements built atop the [XDG](https://github.com/bkuhlmann/xdg)
-implementation.
-
-#### Overview
-
-While there isn't an environment convenience object as found in the `XDG` namespace, you can
-instantiate each object individually:
-
-    cache = Runcom::Cache.new "example/data.json"
-    config = Runcom::Config.new "example/configuration.yml"
-    data = Runcom::Data.new "example/store.dat"
-
-Each of the above objects share the same API:
-
-- `#relative` - Answers the relative path from which the object was constructed.
-- `#namespace` - Answers the relative namespace as a pathname object from which the object was
-  constructed. The namespace must be identical across the cache, config, and data objects as this is
-  what uniquely identifies and organizes all files associated with your program.
-- `#file_name` - Answers the file name from which the object was constructed.
-- `#current` - Answers first *existing* file system path computed by `$XDG_*_HOME` followed by each
-  computed `$XDG_*_DIRS` path in order defined. Otherwise, `nil` is answered back.
-- `#all` - Answers all file system paths which is the combined `$XDG_*_HOME` and `$XDG_*_DIRS`
-  values in order defined. These paths *may* or *may not* exist on the file system.
-- `#inspect` - Answers a string representation of default XDG home and directory paths for debugging
-  purposes.
-
-Using the `cache` object (created above) as an example, here is what each method answers back:
-
-    cache.relative # => #<Pathname:example/data.json>
-    cache.namespace # #<Pathname:example>
-    cache.file_name # #<Pathname:data.json>
-    cache.current # #<Pathname:/Users/bkuhlmann/.cache/example/data.json>
-    cache.all # [#<Pathname:/Users/bkuhlmann/.cache/example/data.json>]
-    cache.inspect # "XDG_CACHE_HOME=/Users/bkuhlmann/.cache"
-
-#### Variable Priority
-
-Path precedence is determined in the following order (with the first taking highest priority):
-
-1. **Local Configuration** - If a `$XDG_*_HOME` or `$XDG_*_DIRS` path relative to the current
-   working directory is detected, it will take precedence over the global configuration. This is the
-   same behavior as found in Git where the local `.git/config` takes precedence over the global
-   `~/.gitconfig`.
-1. **Global Configuration** - When a local configuration isn't found, the global configuration is
-   used as defined by the *XDG Base Directory Specification*.
-
-#### Configuration Specialization
-
-The `Runcom::Config` deserves additional highlighting as it provides support for loading custom CLI
-configurations directly from the command line or from custom locations. It is meant to be used
-within your program(s).
-
-An object is initialized as follows:
-
-    configuration = Runcom::Config.new "example/configuration.yml"
-
-Default settings can be initialized as well:
-
-    configuration = Runcom::Config.new "example/configuration.yml", defaults: {name: "Example"}
-
-Once a configuration has been initialized, a hash representation can be obtained:
-
-    configuration.to_h
-
-A configuration can be merged with another hash (handy for runtime overrides):
-
-    updated_configuration = configuration.merge {name: "Updated Name"}
-
-A configuration can also be merged with another configuration:
-
-    updated_configuration = configuration.merge Runcom::Config.new("other", defaults: {a: 1})
-
-The current path of the configuration can be asked for as well:
-
-    configuration.current # "~/.config/example/configuration.yml"
-
-For further details, study the public interface as provided by the
-[`Runcom::Config`](lib/runcom/config.rb) object.
-
-### Examples
-
-Examples of gems built atop this gem are:
-
-- [Gemsmith](https://github.com/bkuhlmann/gemsmith) - A command line interface for smithing new Ruby
-  gems.
-- [Git Cop](https://github.com/bkuhlmann/git-cop) - Enforces consistent Git commits.
-- [Milestoner](https://github.com/bkuhlmann/milestoner) - A command line interface for releasing Git
-  repository milestones.
-- [Pennyworth](https://github.com/bkuhlmann/pennyworth) - A command line interface that enhances and
-  extends [Alfred](https://www.alfredapp.com) with Ruby support.
-- [Pragmater](https://github.com/bkuhlmann/pragmater) - A command line interface for
-  managing/formatting source file pragma comments.
-- [Sublime Text Kit](https://github.com/bkuhlmann/sublime_text_kit) - A command line interface for
-  managing Sublime Text metadata.
-- [Tocer](https://github.com/bkuhlmann/tocer) - A command line interface for generating table of
-  contents for Markdown files.
-
-## Tests
-
-To test, run:
-
-    bundle exec rake
-
-## Versioning
-
-Read [Semantic Versioning](https://semver.org) for details. Briefly, it means:
-
-- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
-- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
-- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
-
-## Code of Conduct
-
-Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By
-participating in this project you agree to abide by its terms.
-
-## Contributions
-
-Read [CONTRIBUTING](CONTRIBUTING.md) for details.
-
-## License
-
-Copyright 2016 [Alchemists](https://www.alchemists.io).
-Read [LICENSE](LICENSE.md) for details.
-
-## History
-
-Read [CHANGES](CHANGES.md) for details.
-Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
-
-## Credits
-
-Developed by [Brooke Kuhlmann](https://www.alchemists.io) at
-[Alchemists](https://www.alchemists.io).