xdg 6.3.3 → 6.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f743d4c33425b9faee440f4fc818cb97ffb352860aea21e1ec590ab6c3e842c7
-  data.tar.gz: 5071b91c337b342c90e307c47d68b6c5fce9a99a34239aa68108aa61eea2fa6c
+  metadata.gz: f1a337c5649d81e8d7421794ff85c904aef168e84dc713ddb146a5959f8f7e7e
+  data.tar.gz: 8e5d15918077dff3d4bb0b1edd70ae413a9f975a559fb72dd6d10b2126ac4bad
 SHA512:
-  metadata.gz: ef0ad8bb2c923c21ab2f6ddd052589365f1713cd2966b874f0c7905930f65f4768c9796004149626c96ca4bb9148f1341bfd3d1e4d6e741e19e874f77320d319
-  data.tar.gz: 1982eded991e16bb3db371fdca99442e9cb6e61238e557669e0c8b8583205a22197e63906a4266c96d438535ca18dc72786438092200e3183831a3377576119f
+  metadata.gz: b84800060d723b7e06449223341be67a8d67832ceec513076873835c9d00c2f92c3f3f0938d9ffe4edad8818896526f62c179718d2ad0db86898ac7ca3821926
+  data.tar.gz: b12a448e2950a982a7d9254401de2231a7537354f3f587221baea25c2e988c46c49ec08f025ecc1b4c5be5b186984a9f79fcd9cb9c49295ac43f8f069b6ed09f

data/README.adoc

@@ -25,6 +25,7 @@ access to the following environment settings:
 ** `$XDG_CONFIG_DIRS`
 ** `$XDG_DATA_HOME`
 ** `$XDG_DATA_DIRS`
+** `$XDG_STATE_HOME`
 
 == Requirements
 
@@ -48,20 +49,21 @@ gem "xdg"
 
 == Usage
 
-The following describes how to use this XDG implementation.
+The following describes how to use this implementation.
 
-=== Overview
+=== Objects
 
 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.
+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.
+xdg.state_home   # Answers computed `$XDG_STATE_HOME` value.
 ----
 
 The _computed_ value, in this case, is either the user-defined value of the key or the default
@@ -76,9 +78,10 @@ want to load the entire environment:
 cache = XDG::Cache.new
 config = XDG::Config.new
 data = XDG::Data.new
+state = XDG::State.new
 ----
 
-The `cache`, `config`, and `data` objects share the same API which means you can ask each the
+The `cache`, `config`, `data`, and `state` 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.
@@ -100,31 +103,38 @@ environment = XDG::Environment.new
 cache = XDG::Cache.new
 config = XDG::Config.new
 data = XDG::Data.new
+state = XDG::State.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"
+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 XDG_STATE_HOME=/Users/bkuhlmann/.local/state"
+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"
+state.inspect            # "XDG_STATE_HOME=/Users/bkuhlmann/.local/state"
 
 # 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>]
+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>]
+environment.state_home   # #<Pathname:/Users/bkuhlmann/.local/state>
+
+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>]
+
+state.home               # #<Pathname:/Users/bkuhlmann/.local/state>
+state.directories        # []
+state.all                # [#<Pathname:/Users/bkuhlmann/.local/state>]
 ----
 
 As you can see from above, each XDG object answers back a `Pathname` which means you have the full
@@ -142,6 +152,7 @@ objects:
 * `$XDG_DATA_HOME="$HOME/.local/share"`
 * `$XDG_DATA_DIRS="/usr/local/share/:/usr/share/"`
 * `$XDG_RUNTIME_DIR`
+* `$XDG_STATE_HOME="$HOME/.local/state"`
 
 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
@@ -173,12 +184,12 @@ memory and cannot necessarily be swapped out to disk.
 
 The behavior of most XDG environment variables can be lumped into two categories:
 
-* `$XDG_*_HOME`
 * `$XDG_*_DIRS`
+* `$XDG_*_HOME`
 
 Each is described in detail below.
 
-==== `$XDG_*_DIRS`
+==== Directories
 
 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
@@ -203,7 +214,7 @@ Yields the following, colon delimited, array:
 In the above example, the `"/example/one/.config"` path takes _highest_ priority since it was
 defined first.
 
-==== `$XDG_*_HOME`
+==== Homes
 
 These variables take precedence over the corresponding `$XDG_*_DIRS` environment variables. Using
 a modified version of the `$XDG_*_DIRS` example, shown above, we could have the following setup:

data/lib/xdg/cache.rb

@@ -3,6 +3,7 @@
 require "forwardable"
 
 module XDG
+  # Provides cache support.
   class Cache
     extend Forwardable
 

data/lib/xdg/config.rb

@@ -3,6 +3,7 @@
 require "forwardable"
 
 module XDG
+  # Provides configuration support.
   class Config
     extend Forwardable
 

data/lib/xdg/data.rb

@@ -3,6 +3,7 @@
 require "forwardable"
 
 module XDG
+  # Provides data support.
   class Data
     extend Forwardable
 

data/lib/xdg/environment.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 module XDG
+  # A convenience wrapper to all XDG functionality.
   class Environment
     def initialize home: Paths::Home, directories: Paths::Directory, environment: ENV
       @cache = Cache.new(home:, directories:, environment:)
       @config = Config.new(home:, directories:, environment:)
-      @data = Data.new home:, directories:, environment:
+      @data = Data.new(home:, directories:, environment:)
+      @state = State.new home:, directories:, environment:
     end
 
     def cache_home = cache.home
@@ -18,10 +20,12 @@ module XDG
 
     def data_dirs = data.directories
 
-    def inspect = "#{cache.inspect} #{config.inspect} #{data.inspect}"
+    def state_home = state.home
+
+    def inspect = "#{cache.inspect} #{config.inspect} #{data.inspect} #{state.inspect}"
 
     private
 
-    attr_reader :cache, :config, :data
+    attr_reader :cache, :config, :data, :state
   end
 end

data/lib/xdg/state.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module XDG
+  # Provides state support.
+  class State
+    extend Forwardable
+
+    HOME_PAIR = Pair["XDG_STATE_HOME", ".local/state"].freeze
+
+    delegate %i[home directories all inspect] => :combined
+
+    def initialize home: Paths::Home, directories: Paths::Directory, environment: ENV
+      @combined = Paths::Combined.new home.new(HOME_PAIR, environment),
+                                      directories.new(Pair.new, environment)
+    end
+
+    private
+
+    attr_reader :combined
+  end
+end

data/lib/xdg.rb

@@ -7,4 +7,5 @@ require "xdg/paths/combined"
 require "xdg/config"
 require "xdg/data"
 require "xdg/cache"
+require "xdg/state"
 require "xdg/environment"

data/xdg.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "xdg"
-  spec.version = "6.3.3"
+  spec.version = "6.6.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://www.alchemists.io/projects/xdg"
@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
     "bug_tracker_uri" => "https://github.com/bkuhlmann/xdg/issues",
     "changelog_uri" => "https://www.alchemists.io/projects/xdg/versions",
     "documentation_uri" => "https://www.alchemists.io/projects/xdg",
+    "funding_uri" => "https://github.com/sponsors/bkuhlmann",
     "label" => "XDG",
     "rubygems_mfa_required" => "true",
     "source_code_uri" => "https://github.com/bkuhlmann/xdg"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xdg
 version: !ruby/object:Gem::Version
-  version: 6.3.3
+  version: 6.6.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
   RFE=
   -----END CERTIFICATE-----
-date: 2022-04-23 00:00:00.000000000 Z
+date: 2022-09-10 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -50,6 +50,7 @@ files:
 - lib/xdg/paths/combined.rb
 - lib/xdg/paths/directory.rb
 - lib/xdg/paths/home.rb
+- lib/xdg/state.rb
 - xdg.gemspec
 homepage: https://www.alchemists.io/projects/xdg
 licenses:
@@ -58,6 +59,7 @@ metadata:
   bug_tracker_uri: https://github.com/bkuhlmann/xdg/issues
   changelog_uri: https://www.alchemists.io/projects/xdg/versions
   documentation_uri: https://www.alchemists.io/projects/xdg
+  funding_uri: https://github.com/sponsors/bkuhlmann
   label: XDG
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/bkuhlmann/xdg
@@ -76,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.12
+rubygems_version: 3.3.22
 signing_key:
 specification_version: 4
 summary: Provides an implementation of the XDG Base Directory Specification.