runcom 6.0.0 → 6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c36440a5f6b7c7e5e9bc63457ff04ce4f03a2bb888ebf5ddd3294b6fbb554ed
-  data.tar.gz: 7e15a92472a4ecf47e591e244965439b79337d17c98db9a651a626ec73adcc8d
+  metadata.gz: 51f9eacd1ade03026ed02aeab5d127350283311280cba07cc985a26ae107b6f2
+  data.tar.gz: 580f96f8545ff05151a903d0abf5c36892ac08112017389f283fd0b356063445
 SHA512:
-  metadata.gz: 36cb0e69cb446658acd3c812f21909b5dfbfb2e42c37b89b50f1bf8b0bfa910110768dc77ab1d5510c61d1c0e298b3ca4e926e62aaef14a569a520706a9b9bbd
-  data.tar.gz: a787c56d515d8462db7453a692e60031dee3e5e91109acb110619e7e76ad944962443fbf3b2873cf3db634bb401c629f7d671dcc654b8e4db6b68b3708a79ae8
+  metadata.gz: 56b7a3708f994b9734d961aeaa27062cb03657ecc42f63a2372429db1bbf9ed5f3cc1e2b3c67ab79dd8527bb79bcdc0e4797e00b4724a88678c2f67d8d831296
+  data.tar.gz: a369b0ca63f6e994ef44e377ee8cf0cec4bd7d79d6b1e5dc62002e1196ee44dedd2515d0944c89d1664f4f08f1154406912fa6f984efa30881d468343dd22abf

data/README.md

@@ -54,7 +54,7 @@ the [XDG](https://github.com/bkuhlmann/xdg) implementation.
 
 ## Requirements
 
-1. [Ruby 2.6.x](https://www.ruby-lang.org).
+1. [Ruby 2.7.x](https://www.ruby-lang.org).
 
 ## Setup
 
@@ -76,16 +76,32 @@ implementation.
 While there isn't an environment convenience object as found in the `XDG` namespace, you can
 instantiate each object individually:
 
-    cache = Runcom::Cache.new
-    config = Runcom::Config.new
-    data = Runcom::Data.new
+    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 basic API:
+Each of the above objects share the same API:
 
-- `#path` - Answers first *existing* file system path computed by `$XDG_*_HOME` followed
-  by each computed `$XDG_*_DIRS` path in order defined.
-- `#paths` - Answers all file system paths which is the combined `$XDG_*_HOME` and `$XDG_*_DIRS`
+- `#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
 
@@ -104,18 +120,13 @@ The `Runcom::Config` deserves additional highlighting as it provides support for
 configurations directly from the command line or from custom locations. It is meant to be used
 within your program(s).
 
-An object can be initialized as follows:
-
-    configuration = Runcom::Config.new "example"
-
-The default file name for a configuration is `configuration.yml` but a custom name can be used if
-desired:
+An object is initialized as follows:
 
-    configuration = Runcom::Config.new "example", file_name: "example.yml"
+    configuration = Runcom::Config.new "example/configuration.yml"
 
 Default settings can be initialized as well:
 
-    configuration = Runcom::Config.new "example", defaults: {name: "Example"}
+    configuration = Runcom::Config.new "example/configuration.yml", defaults: {name: "Example"}
 
 Once a configuration has been initialized, a hash representation can be obtained:
 
@@ -129,9 +140,9 @@ A configuration can also be merged with another configuration:
 
     updated_configuration = configuration.merge Runcom::Config.new("other", defaults: {a: 1})
 
-The computed path of the configuration can be asked for as well:
+The current path of the configuration can be asked for as well:
 
-    configuration.path # "~/.config/example/configuration.yml"
+    configuration.current # "~/.config/example/configuration.yml"
 
 For further details, study the public interface as provided by the
 [`Runcom::Config`](lib/runcom/config.rb) object.

data/lib/runcom/identity.rb

@@ -12,7 +12,7 @@ module Runcom
     end
 
     def self.version
-      "6.0.0"
+      "6.0.1"
     end
 
     def self.version_label

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runcom
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.0.1
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   dKvURM+1PwDCzC5tvRwjhUJIizau6+MtkFCvJHmaAj1aZL3odcPejHj5Hxt/0CUW
   y84=
   -----END CERTIFICATE-----
-date: 2020-01-01 00:00:00.000000000 Z
+date: 2020-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refinements
@@ -72,6 +72,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: gemsmith
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+- !ruby/object:Gem::Dependency
+  name: git-cop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -134,14 +162,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '5.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '5.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -162,14 +190,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.78'
+        version: '0.79'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.78'
+        version: '0.79'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -218,14 +246,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.18'
 description: 
 email:
 - brooke@alchemists.io

metadata.gz.sig

@@ -1 +1,2 @@
-3%	�
+[
��|�9v��2������I���ޞ�|���G�6�y�
`�9�O�z$J��f=��Dy�t�e��������x얧�,^u_�\;����.e��lVY�w��kT��n�
g�CG�Q
+�\������m)ky���0�d�g3&�R�R��G�����]eh0�;���df���l*?��'�U�0�1�'�l�Ծ*p`1��U�7�G{�)aA9�dJ������ĚY,���n�J�'�Pnz���O�&�V�]9