xdg 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf4e3a9583ae082cb4669e116317b6445d6d716bc87fee323e5a3edc3d9ff0c1
-  data.tar.gz: 15412eab2d3cffde140b178cf30daaf78db3abcb934d1fd82ae884d64e5c51b4
+  metadata.gz: 323797e110d0fba7f1e71c2d372a6c0e76faa36f285a994fc88b197bbe30f200
+  data.tar.gz: 50c924347d52fee0cd56c5c7ee74d533bed66a8b21f58e846dfcd6ec3a07f178
 SHA512:
-  metadata.gz: ba341827e250f0ce016a096a97fd84ad7b6fe1a3213448501f57f1dd153b9ba4ae6829c6823d3826638c437ac30493cec2ff61ebbb62d288cffbb77b2661427b
-  data.tar.gz: 69aed37da57f947abd3d578c73d2f90f20c41b315305cc7192a839e36f30ee4a544cce911beb1d01e786899dddf0891b9e522c5a2a1b9875a71430a9325dcfa3
+  metadata.gz: 7a4b611fc28735bc5abff558cde0d78165746e298038c05d5a5df6ee882a9d7c4c14428bd5d058a0dca4b719f2a5d5c34edaa2000dcf11bfc467d9e4a07cdd84
+  data.tar.gz: 7a47317e926d088b29f214c43dafca23b24ad9bdd5f7d5cc51ed744c228e4037aef18e13055bab52b3d26dc85251bec79b5efe96d8502033d70e44bb1caaeba9

data/README.md

@@ -25,6 +25,7 @@ sugar that includes what is found in this gem, make sure to check out the
   - [Setup](#setup)
   - [Usage](#usage)
       - [Overview](#overview)
+      - [Examples](#examples)
       - [Variable Defaults](#variable-defaults)
       - [Variable Behavior](#variable-behavior)
         - [`$XDG_*_DIRS`](#xdg__dirs)
@@ -52,7 +53,7 @@ sugar that includes what is found in this gem, make sure to check out the
 
 ## Requirements
 
-1. [Ruby 2.6.3](https://www.ruby-lang.org)
+1. [Ruby 2.6.4](https://www.ruby-lang.org)
 
 ## Setup
 
@@ -98,6 +99,47 @@ following messages:
 - `#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

data/lib/xdg/cache.rb

@@ -8,7 +8,7 @@ module XDG
 
     HOME_PAIR = Pair["XDG_CACHE_HOME", ".cache"].freeze
 
-    delegate %i[home directories all] => :combined
+    delegate %i[home directories all inspect] => :combined
 
     def initialize home: Paths::Standard, directories: Paths::Directory, environment: ENV
       @combined = Paths::Combined.new home.new(HOME_PAIR, environment),

data/lib/xdg/config.rb

@@ -9,7 +9,7 @@ module XDG
     HOME_PAIR = Pair["XDG_CONFIG_HOME", ".config"].freeze
     DIRS_PAIR = Pair["XDG_CONFIG_DIRS", "/etc/xdg"].freeze
 
-    delegate %i[home directories all] => :combined
+    delegate %i[home directories all inspect] => :combined
 
     def initialize home: Paths::Standard, directories: Paths::Directory, environment: ENV
       @combined = Paths::Combined.new home.new(HOME_PAIR, environment),

data/lib/xdg/data.rb

@@ -9,7 +9,7 @@ module XDG
     HOME_PAIR = Pair["XDG_DATA_HOME", ".local/share"].freeze
     DIRS_PAIR = Pair["XDG_DATA_DIRS", "/usr/local/share:/usr/share"].freeze
 
-    delegate %i[home directories all] => :combined
+    delegate %i[home directories all inspect] => :combined
 
     def initialize home: Paths::Standard, directories: Paths::Directory, environment: ENV
       @combined = Paths::Combined.new home.new(HOME_PAIR, environment),

data/lib/xdg/environment.rb

@@ -28,6 +28,10 @@ module XDG
       data.directories
     end
 
+    def inspect
+      "#{cache.inspect} #{config.inspect} #{data.inspect}"
+    end
+
     private
 
     attr_reader :cache, :config, :data

data/lib/xdg/identity.rb

@@ -12,7 +12,7 @@ module XDG
     end
 
     def self.version
-      "3.0.2"
+      "3.1.0"
     end
 
     def self.version_label

data/lib/xdg/pair.rb

@@ -1,10 +1,30 @@
 # frozen_string_literal: true
 
 module XDG
+  PAIR_DELIMITER = "="
+
   # A generic key-value pair (KVP).
   Pair = Struct.new :key, :value do
     def to_env
       Hash[*values]
     end
+
+    def key?
+      key.to_s.size.positive?
+    end
+
+    def value?
+      value.to_s.size.positive?
+    end
+
+    def empty?
+      !(key? && value?)
+    end
+
+    def inspect
+      return "" unless key? || value?
+
+      "#{key}#{PAIR_DELIMITER}#{value}"
+    end
   end
 end

data/lib/xdg/paths/combined.rb

@@ -23,6 +23,10 @@ module XDG
         directories.prepend home
       end
 
+      def inspect
+        [initial_home.inspect, initial_directories.inspect].reject(&:empty?).join " "
+      end
+
       private
 
       attr_reader :initial_home, :initial_directories

data/lib/xdg/paths/directory.rb

@@ -18,13 +18,24 @@ module XDG
       end
 
       def dynamic
-        environment.fetch(pair.key, paths).split(DELIMITER).uniq.map(&method(:expand))
+        String(environment[key]).then { |env_paths| env_paths.empty? ? paths : env_paths }
+                                .split(DELIMITER)
+                                .uniq
+                                .map(&method(:expand))
+      end
+
+      def inspect
+        [key, dynamic.join(DELIMITER)].reject(&:empty?).join XDG::PAIR_DELIMITER
       end
 
       private
 
       attr_reader :pair, :environment
 
+      def key
+        String pair.key
+      end
+
       def paths
         String pair.value
       end

data/lib/xdg/paths/standard.rb

@@ -19,23 +19,27 @@ module XDG
       end
 
       def default
-        expand_home_for String(value)
+        expand String(value)
       end
 
       def dynamic
-        String(environment[key]).then { |path| path.empty? ? default : expand_home_for(path) }
+        String(environment[key]).then { |path| path.empty? ? default : expand(path) }
+      end
+
+      def inspect
+        [pair.key, dynamic].compact.join XDG::PAIR_DELIMITER
       end
 
       private
 
       attr_reader :pair, :environment
 
-      def home
-        Pathname environment.fetch(HOME_KEY)
+      def expand path
+        home.join(path).expand_path
       end
 
-      def expand_home_for path
-        home.join(path).expand_path
+      def home
+        Pathname environment.fetch(HOME_KEY)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xdg
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   dKvURM+1PwDCzC5tvRwjhUJIizau6+MtkFCvJHmaAj1aZL3odcPejHj5Hxt/0CUW
   y84=
   -----END CERTIFICATE-----
-date: 2019-09-01 00:00:00.000000000 Z
+date: 2019-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit