runcom 4.2.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c7c0be4497f00fc2624cde5560ce41eb9143cd558e7ffb3f97ec3bd11293d90
-  data.tar.gz: ce521e9beec0539e370106f03b8d20410c46f08c5f47934e72ad66ac8d74e923
+  metadata.gz: 82272e07352edbead21370bbb09735ae0488a8284b66c87aa6ffd9758b3b88ca
+  data.tar.gz: dfb604f014545b8f7e809e132bd53fec84ce555b79f2b42e80178ec0d145220b
 SHA512:
-  metadata.gz: bda3c2d9cf09d249fdc182473f5602011894bd3a39bf175f6fd13256efb143aa4c40d86c6edf416456612447bb40f644afcf290afed187140937b19f153df631
-  data.tar.gz: e20acd89a5454174a28217bb35608b55f8435b6146832794321ce33c519d86c7a9c5a4d1aaf005602eec4b986926210e0f8715a06e648144af14ea2ccbcdeeca
+  metadata.gz: 8748908614d8a56badb944120f49e8ae6c4817822d98f3f19a6e5163b4a6a7b721e4ed3588a0f8c7d8c667b5822b33ea1e091a0fe5a6e492942a2b9c8ff82f69
+  data.tar.gz: 4ac30ca2a5ce3b61afee3c4f1e3f4f7e4086a00134c57d2645342deec3efdd16d50298e0ab516814d45778499e9eafc66b4d4a2ff6872b34fff80bf26a31a3b5

checksums.yaml.gz.sig

@@ -1 +1 @@
-z�,�""���TG$?�]������`[pT\`˝0;v�������d������s T��ت�X�o/������Z�Z���x���I��,����&
�Ǝ�H'D�o�I��sG����,?�窿��
+}��>��Y��پ�S5�D"_��<V=&Wd-�׌�]g���M�XFP�a@�_����@�E�t��'P-����N*��}�/�}����A�n��l�˅�nv�6|jXJ�S�r�	��m]1���Dm\3���Ɲx�XP�Qϵ�[,Лx��L�Ґ�΋6�&W��\ۖ�����k�z�{�:�0y���K>�"AW��Y��9��p����'�ou���d����L�U�!7���|�ۀ|-��4ӹ�ڙ�

data/README.md

@@ -9,11 +9,11 @@
 [![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 (a.k.a. [Run Command](https://en.wikipedia.org/wiki/Run_commands)) provides common
+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). Read on for
-further details.
+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. -->
 
@@ -23,16 +23,8 @@ further details.
   - [Requirements](#requirements)
   - [Setup](#setup)
   - [Usage](#usage)
-    - [XDG](#xdg)
       - [Overview](#overview)
-      - [Variable Defaults](#variable-defaults)
-      - [Variable Behavior](#variable-behavior)
-        - [`$XDG_*_DIRS`](#xdg__dirs)
-        - [`$XDG_*_HOME`](#xdg__home)
       - [Variable Priority](#variable-priority)
-    - [Runcom](#runcom)
-      - [Overview](#overview-1)
-      - [Variable Priority](#variable-priority-1)
       - [Configuration Specialization](#configuration-specialization)
     - [Examples](#examples)
   - [Tests](#tests)
@@ -47,15 +39,15 @@ further details.
 
 ## Features
 
-- Provides an embedded `XDG::Environment` implementation that strictly adheres to the *XDG Base
-  Directory Specification* which provides access to the following environment settings:
+- 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`
-- Provides a developer friendly wrapping of the XDG implementation for cache, config, and data. For
-  the config, the following is supported:
+- 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.
@@ -76,142 +68,8 @@ Add the following to your Gemfile:
 
 ## Usage
 
-This gem provides an embedded XDG implementation along with a developer friendly wrapper
-implementation. Both of which are described in detail below.
-
-### XDG
-
-The following describes the embedded XDG implementation. It's worth noting there is a [XDG
-Gem](https://github.com/rubyworks/xdg) which also implements the *XDG Base Directory Specification*
-but hasn't been updated in ~6 years.
-
-#### Overview
-
-Provides an API that strictly adheres to the *XDG Base Directory Specification*. Usage:
-
-    xdg = Runcom::XDG::Environment.new
-    xdg.cache_home # <= Answers computed `$XDG_CACHE_HOME` value.
-    xdg.config_home # <= Answers computed `$XDG_CONFIG_HOME` value.
-    xdg.config_dirs # <= Answers computed `$XDG_CONFIG_DIRS` value.
-    xdg.data_home # <= Answers computed `$XDG_DATA_HOME` value.
-    xdg.data_dirs # <= Answers computed `$XDG_DATA_DIRS` value.
-
-The *computed* value, in this case, is either the user-defined value of the key or the default
-value, per specification, when the key is not defined or empty. For more on this, scroll down to the
-*Variable Defaults* section to learn more.
-
-The `Runcom::XDG::Environment` wraps the following objects which can be used individually if you
-don't want to load the entire environment:
-
-    cache = Runcom::XDG::Cache.new
-    config = Runcom::XDG::Config.new
-    data = Runcom::XDG::Data.new
-
-The `cache`, `config`, and `data` objects share the same API which means you can ask each the
-following messages:
-
-- `#home` - Answers the home directory as computed via the `$XDG_*_HOME` key.
-- `#directories` - Answers an array directories as computed via the `$XDG_*_DIRS` key.
-- `#all` - Answers an array of *all* directories as computed from the combined `$XDG_*_HOME` and
-  `$XDG_*_DIRS` values (with `$XDG_*_HOME` prefixed at the start of the array).
-
-#### Variable Defaults
-
-The *XDG Base Directory Specification* defines environment variables and associated default values
-when not defined or empty. The following defaults, per specification, are implemented by the
-`Runcom::XDG` objects:
-
-- `$XDG_CACHE_HOME="$HOME/.cache"`
-- `$XDG_CONFIG_HOME="$HOME/.config"`
-- `$XDG_CONFIG_DIRS="/etc/xdg"`
-- `$XDG_DATA_HOME="$HOME/.local/share"`
-- `$XDG_DATA_DIRS="/usr/local/share/:/usr/share/"`
-- `$XDG_RUNTIME_DIR`
-
-The `$XDG_RUNTIME_DIR` deserves special mention as it's not, *currently*, implemented as part of
-this gem because it is more user/environment specific. Here is how the `$XDG_RUNTIME_DIR` is meant
-to be used should you choose to use it:
-
-- *Must* reference user-specific non-essential runtime files and other file objects (such as
-  sockets, named pipes, etc.)
-- *Must* be owned by the user with *only* the user having read and write access to it.
-- *Must* have a Unix access mode of `0700`.
-- *Must* be bound to the user when logging in.
-- *Must* be removed when the user logs out.
-- *Must* be pointed to the same directory when the user logs in more than once.
-- *Must* exist from first login to last logout on the system and not removed in between.
-- *Must* not allow files in the directory to survive reboot or a full logout/login cycle.
-- *Must* keep the directory on the local file system and not shared with any other file systems.
-- *Must* keep the directory fully-featured by the standards of the operating system. Specifically,
-  on Unix-like operating systems AF_UNIX sockets, symbolic links, hard links, proper permissions,
-  file locking, sparse files, memory mapping, file change notifications, a reliable hard link count
-  must be supported, and no restrictions on the file name character set should be imposed. Files in
-  this directory *may* be subjected to periodic clean-up. To ensure files are not removed,
-  they should have their access time timestamp modified at least once every 6 hours of monotonic
-  time or the 'sticky' bit should be set on the file.
-- When not set, applications should fall back to a replacement directory with similar capabilities
-  and print a warning message. Applications should use this directory for communication and
-  synchronization purposes and should not place larger files in it, since it might reside in runtime
-  memory and cannot necessarily be swapped out to disk.
-
-#### Variable Behavior
-
-The behavior of most XDG environment variables can be lumped into two categories:
-
-- `$XDG_*_HOME`
-- `$XDG_*_DIRS`
-
-Each is described in detail below.
-
-##### `$XDG_*_DIRS`
-
-These variables are used to define a colon (`:`) delimited list of directories. Order is important
-as the first directory defined will take precedent over the following directory and so forth. For
-example, here is a situation where the `XDG_CONFIG_DIRS` key has a custom value:
-
-    XDG_CONFIG_DIRS="/example/one/.config:/example/two/.settings:/example/three/.configuration"
-
-    # Yields the following, colon delimited, array:
-    [
-      "/example/one/.config",
-      "/example/two/.settings",
-      "/example/three/.configuration"
-    ]
-
-In the above example, the `"/example/one/.config"` path takes *highest* priority since it was
-defined first.
-
-##### `$XDG_*_HOME`
-
-These variables take precidence over the corresponding `$XDG_*_DIRS` environment variables. Using a
-modified version of the `$XDG_*_DIRS` example, shown above, we could have the following setup:
-
-    XDG_CONFIG_HOME="/example/priority"
-    XDG_CONFIG_DIRS="/example/one/.config:/example/two/.settings"
-
-    # Yields the following, colon delimited, array:
-    [
-      "/example/priority",
-      "/example/one/.config",
-      "/example/two/.settings"
-    ]
-
-Due to `XDG_CONFIG_HOME` taking precidence over the `XDG_CONFIG_DIRS`, the path with the *highest*
-priority in this example is: `"/example/priority"`.
-
-#### Variable Priority
-
-Path precedence is determined in the following order (with the first taking highest priority):
-
-1. `$XDG_*_HOME` - Will be used if defined. Otherwise, falls back to specification default.
-1. `$XDG_*_DIRS` - Iterates through directories in order defined (with first taking highest
-   priority). Otherwise, falls back to specification default.
-
-### Runcom
-
-Provides wrapper objects around the `XDG` objects which extends and enhances beyond what is found in
-the *XDG Base Directory Specification*. This includes preference of local over global configurations
-by default as well as other conveniences.
+The following describes the enhancements built atop the [XDG](https://github.com/bkuhlmann/xdg)
+implementation.
 
 #### Overview
 
@@ -244,7 +102,7 @@ Path precedence is determined in the following order (with the first taking high
 
 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 CLI program(s).
+within your program(s).
 
 An object can be initialized as follows:
 
@@ -280,7 +138,7 @@ For further details, study the public interface as provided by the
 
 ### Examples
 
-If you need examples of gems that leverage this gem, see the following:
+Examples of gems built atop this gem are:
 
 - [Gemsmith](https://github.com/bkuhlmann/gemsmith) - A command line interface for smithing new Ruby
   gems.

data/lib/runcom.rb

@@ -1,17 +1,10 @@
 # frozen_string_literal: true
 
+require "xdg"
 require "runcom/identity"
 require "runcom/errors/base"
 require "runcom/errors/syntax"
-require "runcom/pair"
-require "runcom/paths/standard"
 require "runcom/paths/friendly"
-require "runcom/paths/directory"
-require "runcom/paths/combined"
-require "runcom/xdg/config"
-require "runcom/xdg/data"
-require "runcom/xdg/cache"
-require "runcom/xdg/environment"
 require "runcom/config"
 require "runcom/cache"
 require "runcom/data"

data/lib/runcom/identity.rb

@@ -12,7 +12,7 @@ module Runcom
     end
 
     def self.version
-      "4.2.1"
+      "5.0.0"
     end
 
     def self.version_label

data/lib/runcom/paths/friendly.rb

@@ -12,12 +12,13 @@ module Runcom
       delegate %i[key value default] => :standard
 
       def initialize pair, environment = ENV
-        @standard = Standard.new pair, environment
+        @standard = XDG::Paths::Standard.new pair, environment
       end
 
       def dynamic
-        path = String value
-        File.exist?(path) ? Pathname(path).expand_path : standard.dynamic
+        String(value).then do |path|
+          File.exist?(path) ? Pathname(path).expand_path : standard.dynamic
+        end
       end
 
       private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runcom
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   dKvURM+1PwDCzC5tvRwjhUJIizau6+MtkFCvJHmaAj1aZL3odcPejHj5Hxt/0CUW
   y84=
   -----END CERTIFICATE-----
-date: 2019-05-02 00:00:00.000000000 Z
+date: 2019-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refinements
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: xdg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -162,14 +176,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -190,42 +204,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.67'
+        version: '0.69'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.67'
+        version: '0.69'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.30'
+        version: '1.33'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.30'
+        version: '1.33'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -258,15 +272,7 @@ files:
 - lib/runcom/errors/base.rb
 - lib/runcom/errors/syntax.rb
 - lib/runcom/identity.rb
-- lib/runcom/pair.rb
-- lib/runcom/paths/combined.rb
-- lib/runcom/paths/directory.rb
 - lib/runcom/paths/friendly.rb
-- lib/runcom/paths/standard.rb
-- lib/runcom/xdg/cache.rb
-- lib/runcom/xdg/config.rb
-- lib/runcom/xdg/data.rb
-- lib/runcom/xdg/environment.rb
 homepage: https://github.com/bkuhlmann/runcom
 licenses:
 - Apache-2.0
@@ -292,5 +298,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: A run command manager for command line interfaces.
+summary: An XDG enhanced run command manager for command line interfaces (CLIs).
 test_files: []

data/lib/runcom/pair.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Runcom
-  # A generic key-value pair (KVP).
-  Pair = Struct.new :key, :value do
-    def to_env
-      Hash[*values]
-    end
-  end
-end

data/lib/runcom/paths/combined.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require "pathname"
-
-module Runcom
-  module Paths
-    # The combined home and directories for environment.
-    class Combined
-      def initialize initial_home, initial_directories
-        @initial_home = initial_home
-        @initial_directories = initial_directories
-      end
-
-      def home
-        initial_home.dynamic
-      end
-
-      def directories
-        initial_directories.dynamic
-      end
-
-      def all
-        directories.prepend home
-      end
-
-      private
-
-      attr_reader :initial_home, :initial_directories
-    end
-  end
-end

data/lib/runcom/paths/directory.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require "pathname"
-
-module Runcom
-  module Paths
-    # A collection of XDG directories with a strict adherence to the XDG specification.
-    class Directory
-      DELIMITER = ":"
-
-      def initialize pair, environment = ENV
-        @pair = pair
-        @environment = environment
-      end
-
-      def default
-        String(pair.value).split(DELIMITER).map { |path| Pathname(path).expand_path }
-      end
-
-      def dynamic
-        environment.fetch(pair.key, String(pair.value)).split(DELIMITER).uniq.map do |path|
-          Pathname(path).expand_path
-        end
-      end
-
-      private
-
-      attr_reader :pair, :environment
-    end
-  end
-end

data/lib/runcom/paths/standard.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require "forwardable"
-require "pathname"
-
-module Runcom
-  module Paths
-    # A XDG home path with a strict adherence to the XDG specification.
-    class Standard
-      extend Forwardable
-
-      HOME_KEY = "HOME"
-
-      delegate %i[key value] => :pair
-
-      def initialize pair, environment = ENV
-        @pair = pair
-        @environment = environment
-      end
-
-      def default
-        home.join(String(value)).expand_path
-      end
-
-      def dynamic
-        path = String environment[key]
-        path.empty? ? default : home.join(path).expand_path
-      end
-
-      private
-
-      attr_reader :pair, :environment
-
-      def home
-        Pathname environment.fetch(HOME_KEY)
-      end
-    end
-  end
-end

data/lib/runcom/xdg/cache.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require "forwardable"
-
-module Runcom
-  module XDG
-    # A XDG cache that adheres to specification defaults.
-    class Cache
-      extend Forwardable
-
-      HOME_PAIR = Pair.new("XDG_CACHE_HOME", ".cache").freeze
-
-      delegate %i[home directories all] => :combined
-
-      def initialize home: Paths::Standard, directories: Paths::Directory, environment: ENV
-        @combined = Paths::Combined.new home.new(HOME_PAIR, environment),
-                                        directories.new(Runcom::Pair.new, environment)
-      end
-
-      private
-
-      attr_reader :combined
-    end
-  end
-end

data/lib/runcom/xdg/config.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require "forwardable"
-
-module Runcom
-  module XDG
-    # A XDG configuration that adheres to specification defaults.
-    class Config
-      extend Forwardable
-
-      HOME_PAIR = Pair.new("XDG_CONFIG_HOME", ".config").freeze
-      DIRS_PAIR = Pair.new("XDG_CONFIG_DIRS", "/etc/xdg").freeze
-
-      delegate %i[home directories all] => :combined
-
-      def initialize home: Paths::Standard, directories: Paths::Directory, environment: ENV
-        @combined = Paths::Combined.new home.new(HOME_PAIR, environment),
-                                        directories.new(DIRS_PAIR, environment)
-      end
-
-      private
-
-      attr_reader :combined
-    end
-  end
-end

data/lib/runcom/xdg/data.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require "forwardable"
-
-module Runcom
-  module XDG
-    # XDG data that adheres to specification defaults.
-    class Data
-      extend Forwardable
-
-      HOME_PAIR = Pair.new("XDG_DATA_HOME", ".local/share").freeze
-      DIRS_PAIR = Pair.new("XDG_DATA_DIRS", "/usr/local/share:/usr/share").freeze
-
-      delegate %i[home directories all] => :combined
-
-      def initialize home: Paths::Standard, directories: Paths::Directory, environment: ENV
-        @combined = Paths::Combined.new home.new(HOME_PAIR, environment),
-                                        directories.new(DIRS_PAIR, environment)
-      end
-
-      private
-
-      attr_reader :combined
-    end
-  end
-end

data/lib/runcom/xdg/environment.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Runcom
-  module XDG
-    # A XDG environment that provides access to all variables.
-    class Environment
-      def initialize home: Paths::Standard, directories: Paths::Directory, environment: ENV
-        @cache = Cache.new home: home, directories: directories, environment: environment
-        @config = Config.new home: home, directories: directories, environment: environment
-        @data = Data.new home: home, directories: directories, environment: environment
-      end
-
-      def cache_home
-        cache.home
-      end
-
-      def config_home
-        config.home
-      end
-
-      def config_dirs
-        config.directories
-      end
-
-      def data_home
-        data.home
-      end
-
-      def data_dirs
-        data.directories
-      end
-
-      private
-
-      attr_reader :cache, :config, :data
-    end
-  end
-end