xdg 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58171fc11c7f8b6555c6d67faa027f55279415a3d67a046840ad64918630a64a
-  data.tar.gz: aa52ded07fe8198a261bea437244a84d494c703c493d233fab675362712952e4
+  metadata.gz: d60ccee2cde7053f46ceec9c294a175e6834cf35075a88a58fc6a8ab1e44d971
+  data.tar.gz: a5a103d0c9d7f9316e6fc879aed226f6495e5075bb35e41d89d19d141cf4d9ff
 SHA512:
-  metadata.gz: 4fe50f804dc1d015a3afa38dcabc1db18a45a00d5eb8cfaf0e07b94dea24c1467386fd3f96ac9efdea5d491446b6daab6eaa95be59ae5c5c71676ff14deae277
-  data.tar.gz: 5a0208ea0a6bf2d0f053c1e0db0fbe26ddf4dab1e83a1036a7638d5ab4d799e8e0aeb9c4a2ecce05645f75bfb993b99cd3d0bffe5322b1aedd4e0c1068810520
+  metadata.gz: 872d932d6a12e319fc87cd684328167404849d1f799c6dcec9af9f8d163a268dd8a3a01f64399ac7dd16e091adcdeadca5df9ed6b158b5485e2ce4e50de559fb
+  data.tar.gz: fe7881085ec69c44e87e73b2ab1989707576e662453020745b7a9b3fd8043d34381d360c443e143d9a616863d1ea265229a741474f597fe48b1b273e6606737e

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 2019 [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,298 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+= XDG
+
+[link=http://badge.fury.io/rb/xdg]
+image::https://badge.fury.io/rb/xdg.svg[Gem Version]
+[link=https://circleci.com/gh/bkuhlmann/xdg]
+image::https://circleci.com/gh/bkuhlmann/xdg.svg?style=svg[Circle CI Status]
+
+Provides a Ruby implementation of the
+https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html[XDG Base Directory
+Specification].
+
+💡 If you write a lot of Command Line Interfaces and would like additional syntactic sugar that
+includes what is found in this gem, make sure to check out the
+link:https://www.alchemists.io/projects/runcom[Runcom] gem too.
+
+toc::[]
+
+== Features
+
+* Provides a `XDG::Environment` object that adheres to the _XDG Base Directory Specification_ with
+access to the following environment settings:
+** `$XDG_CACHE_HOME`
+** `$XDG_CONFIG_HOME`
+** `$XDG_CONFIG_DIRS`
+** `$XDG_DATA_HOME`
+** `$XDG_DATA_DIRS`
+
+== Requirements
+
+. https://www.ruby-lang.org[Ruby 2.7.x]
+
+== Setup
+
+=== Production
+
+To install, run:
+
+[source,bash]
+----
+gem install xdg
+----
+
+Add the following to your Gemfile:
+
+[source,ruby]
+----
+gem "xdg"
+----
+
+=== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/xdg.git
+cd xdg
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
+== Usage
+
+The following describes how to use this XDG implementation.
+
+=== Overview
+
+To get up and running quickly, use `+XDG::Environment+` as follows:
+
+[source,ruby]
+----
+xdg = 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 `XDG::Environment` wraps the following objects which can be used individually if you don’t
+want to load the entire environment:
+
+[source,ruby]
+----
+cache = XDG::Cache.new
+config = XDG::Config.new
+data = 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).
+
+=== Examples
+
+The following are examples of what you would see when playing around with the XDG objects within an
+IRB console (taken from my own environment):
+
+[source,ruby]
+----
+require "xdg"
+
+# Initialization
+environment = XDG::Environment.new
+cache = XDG::Cache.new
+config = XDG::Config.new
+data = XDG::Data.new
+
+# Inspection
+environment.inspect # => XDG_CACHE_HOME=/Users/bkuhlmann/.cache XDG_CONFIG_HOME=/Users/bkuhlmann/.config XDG_CONFIG_DIRS=/etc/xdg XDG_DATA_HOME=/Users/bkuhlmann/.local/share XDG_DATA_DIRS=/usr/local/share:/usr/share
+cache.inspect # => "XDG_CACHE_HOME=/Users/bkuhlmann/.cache"
+config.inspect # => "XDG_CONFIG_HOME=/Users/bkuhlmann/.config XDG_CONFIG_DIRS=/etc/xdg"
+data.inspect # => "XDG_DATA_HOME=/Users/bkuhlmann/.local/share XDG_DATA_DIRS=/usr/local/share:/usr/share"
+
+# Paths
+environment.cache_home # => #<Pathname:/Users/bkuhlmann/.cache>
+environment.config_home # => #<Pathname:/Users/bkuhlmann/.config>
+environment.config_dirs # => [#<Pathname:/etc/xdg>]
+environment.data_home # => #<Pathname:/Users/bkuhlmann/.local/share>
+environment.data_dirs # => [#<Pathname:/usr/local/share>, #<Pathname:/usr/share>]
+
+cache.home # => #<Pathname:/Users/bkuhlmann/.cache>
+cache.directories # => []
+cache.all # => [#<Pathname:/Users/bkuhlmann/.cache>]
+
+config.home # => #<Pathname:/Users/bkuhlmann/.config>
+config.directories # => [#<Pathname:/etc/xdg>]
+config.all # => [#<Pathname:/Users/bkuhlmann/.config>, #<Pathname:/etc/xdg>]
+
+data.home # => #<Pathname:/Users/bkuhlmann/.local/share>
+data.directories # => [#<Pathname:/usr/local/share>, #<Pathname:/usr/share>]
+data.all # => [#<Pathname:/Users/bkuhlmann/.local/share>, #<Pathname:/usr/local/share>, #<Pathname:/usr/share>]
+----
+
+As you can see from above, each XDG object answers back a `Pathname` which means you have the full
+`Pathname` API at your fingertips to build upon the output of these objects as needed.
+
+=== 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 `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:
+
+[source,bash]
+----
+XDG_CONFIG_DIRS="/example/one/.config:/example/two/.settings:/example/three/.configuration"
+----
+
+Yields the following, colon delimited, array:
+
+[source,ruby]
+----
+[
+  "/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:
+
+[source,bash]
+----
+XDG_CONFIG_HOME="/example/priority"
+XDG_CONFIG_DIRS="/example/one/.config:/example/two/.settings"
+----
+
+Yields the following, colon delimited, array:
+
+[source,ruby]
+----
+[
+  "/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):
+
+. `$XDG_*_HOME` - Will be used if defined. Otherwise, falls back to specification default.
+. `$XDG_*_DIRS` - Iterates through directories in order defined (with first taking highest
+  priority). Otherwise, falls back to specification default.
+
+== 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/xdg/identity.rb

@@ -3,20 +3,9 @@
 module XDG
   # Gem identity information.
   module Identity
-    def self.name
-      "xdg"
-    end
-
-    def self.label
-      "XDG"
-    end
-
-    def self.version
-      "4.0.1"
-    end
-
-    def self.version_label
-      "#{label} #{version}"
-    end
+    NAME = "xdg"
+    LABEL = "XDG"
+    VERSION = "4.1.0"
+    VERSION_LABEL = "#{LABEL} #{VERSION}"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xdg
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.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: bundler-audit
@@ -134,14 +134,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
@@ -232,11 +232,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/xdg.rb
 - lib/xdg/cache.rb
 - lib/xdg/config.rb
@@ -247,13 +247,14 @@ files:
 - lib/xdg/paths/combined.rb
 - lib/xdg/paths/directory.rb
 - lib/xdg/paths/home.rb
-homepage: https://github.com/bkuhlmann/xdg
+homepage: https://www.alchemists.io/projects/xdg
 licenses:
 - Apache-2.0
 metadata:
-  source_code_uri: https://github.com/bkuhlmann/xdg
-  changelog_uri: https://github.com/bkuhlmann/xdg/blob/master/CHANGES.md
   bug_tracker_uri: https://github.com/bkuhlmann/xdg/issues
+  changelog_uri: https://www.alchemists.io/projects/xdg/changes.html
+  documentation_uri: https://www.alchemists.io/projects/xdg
+  source_code_uri: https://github.com/bkuhlmann/xdg
 post_install_message: 
 rdoc_options: []
 require_paths:

data/README.md

@@ -1,271 +0,0 @@
-<p align="center">
-  <img src="xdg.png" alt="XDG Icon"/>
-</p>
-
-# XDG
-
-[![Gem Version](https://badge.fury.io/rb/xdg.svg)](http://badge.fury.io/rb/xdg)
-[![Code Climate Maintainability](https://api.codeclimate.com/v1/badges/73c8f06ae65cbe663e1c/maintainability)](https://codeclimate.com/github/bkuhlmann/xdg/maintainability)
-[![Code Climate Test Coverage](https://api.codeclimate.com/v1/badges/73c8f06ae65cbe663e1c/test_coverage)](https://codeclimate.com/github/bkuhlmann/xdg/test_coverage)
-[![Circle CI Status](https://circleci.com/gh/bkuhlmann/xdg.svg?style=svg)](https://circleci.com/gh/bkuhlmann/xdg)
-
-Provides a Ruby implementation of the [XDG Base Directory
-Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html).
-
-:bulb: If you write a lot of Command Line Interfaces and would like additional syntactic
-sugar that includes what is found in this gem, make sure to check out the
-[Runcom](https://github.com/bkuhlmann/runcom) gem too.
-
-<!-- Tocer[start]: Auto-generated, don't remove. -->
-
-## Table of Contents
-
-  - [Features](#features)
-  - [Requirements](#requirements)
-  - [Setup](#setup)
-  - [Usage](#usage)
-      - [Overview](#overview)
-      - [Examples](#examples)
-      - [Variable Defaults](#variable-defaults)
-      - [Variable Behavior](#variable-behavior)
-        - [`$XDG_*_DIRS`](#xdg__dirs)
-        - [`$XDG_*_HOME`](#xdg__home)
-      - [Variable Priority](#variable-priority)
-  - [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
-
-- Provides a `XDG::Environment` object that adheres to the *XDG Base Directory Specification* with
-  access to the following environment settings:
-  - `$XDG_CACHE_HOME`
-  - `$XDG_CONFIG_HOME`
-  - `$XDG_CONFIG_DIRS`
-  - `$XDG_DATA_HOME`
-  - `$XDG_DATA_DIRS`
-
-## Requirements
-
-1. [Ruby 2.7.x](https://www.ruby-lang.org)
-
-## Setup
-
-To install, run:
-
-    gem install xdg
-
-Add the following to your Gemfile:
-
-    gem "xdg"
-
-## Usage
-
-The following describes how to use this XDG implementation.
-
-#### Overview
-
-To get up and running quickly, use `XDG::Environment` as follows:
-
-    xdg = 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 `XDG::Environment` wraps the following objects which can be used individually if you
-don't want to load the entire environment:
-
-    cache = XDG::Cache.new
-    config = XDG::Config.new
-    data = 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).
-
-#### Examples
-
-The following are examples of what you would see when playing around with the XDG objects within an
-IRB console (taken from my own environment):
-
-    require "xdg"
-
-    # Initialization
-    environment = XDG::Environment.new
-    cache = XDG::Cache.new
-    config = XDG::Config.new
-    data = XDG::Data.new
-
-    # Inspection
-    environment.inspect # => XDG_CACHE_HOME=/Users/bkuhlmann/.cache XDG_CONFIG_HOME=/Users/bkuhlmann/.config XDG_CONFIG_DIRS=/etc/xdg XDG_DATA_HOME=/Users/bkuhlmann/.local/share XDG_DATA_DIRS=/usr/local/share:/usr/share
-    cache.inspect # => "XDG_CACHE_HOME=/Users/bkuhlmann/.cache"
-    config.inspect # => "XDG_CONFIG_HOME=/Users/bkuhlmann/.config XDG_CONFIG_DIRS=/etc/xdg"
-    data.inspect # => "XDG_DATA_HOME=/Users/bkuhlmann/.local/share XDG_DATA_DIRS=/usr/local/share:/usr/share"
-
-    # Paths
-    environment.cache_home # => #<Pathname:/Users/bkuhlmann/.cache>
-    environment.config_home # => #<Pathname:/Users/bkuhlmann/.config>
-    environment.config_dirs # => [#<Pathname:/etc/xdg>]
-    environment.data_home # => #<Pathname:/Users/bkuhlmann/.local/share>
-    environment.data_dirs # => [#<Pathname:/usr/local/share>, #<Pathname:/usr/share>]
-
-    cache.home # => #<Pathname:/Users/bkuhlmann/.cache>
-    cache.directories # => []
-    cache.all # => [#<Pathname:/Users/bkuhlmann/.cache>]
-
-    config.home # => #<Pathname:/Users/bkuhlmann/.config>
-    config.directories # => [#<Pathname:/etc/xdg>]
-    config.all # => [#<Pathname:/Users/bkuhlmann/.config>, #<Pathname:/etc/xdg>]
-
-    data.home # => #<Pathname:/Users/bkuhlmann/.local/share>
-    data.directories # => [#<Pathname:/usr/local/share>, #<Pathname:/usr/share>]
-    data.all # => [#<Pathname:/Users/bkuhlmann/.local/share>, #<Pathname:/usr/local/share>, #<Pathname:/usr/share>]
-
-As you can see from above, each XDG object answers back a `Pathname` which means you have the
-full `Pathname` API at your fingertips to build upon the output of these objects as needed.
-
-#### 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
-`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.
-
-## 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 2019 [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).