xdg 7.0.2 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97e985af713c47c149f2d5bd336401cfb68afbac4bc08c51af7cd7b0df07b0cd
-  data.tar.gz: 07f936d37e165c23935db2cfde3e1e3a261012fcd14069e80f0655831db8df3c
+  metadata.gz: ba35d3c6fb994dd6fe78559246713b0becaf734c1a041ab06d3a676ae7d27594
+  data.tar.gz: 42637de1bfe11259c973be52845bf458f5f865254ace39cd08fcd1e66c17e8a9
 SHA512:
-  metadata.gz: ec73085d2e22cc7c441b087a55b9de75907d42778fb1bb116d46d8bdb44afbf2711be0035a46bc8c88bbfc6c407be9d4ff0ba687ba26211d375e3879ed66ac97
-  data.tar.gz: a567f0e4dd2863a559c3fd8bb3c665d6f56f3554c7f98a471c5b7dcc807263c2fac2e3c0e29f33b1be50504f531be85d9364ede186881112eb0fcae126c42299
+  metadata.gz: 7a16e6afd1906a893bb92b92718c46109d520a1bab072a7adc44ba90e80e0ae6a38e10671c6f361473a45f2bf14b4e945e13512ff85e8acad1969913d24eb3d4
+  data.tar.gz: 904e7e87d2db00887562bd2df5c0af46757616a59f4547855bd4ea55c0cbf54caf3d8620d2bf299beeaacdced2a6bc5c8bbdbf68d1caa9ac659c50fb047d5ee5

data/README.adoc

@@ -4,22 +4,17 @@
 
 = XDG
 
-Provides a Ruby implementation of the
-https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html[XDG Base Directory
-Specification] for managing common configurations without polluting your dotfiles. XDG is great for
-command line interfaces or any application that needs a common configuration, cache, data, or
-runtime.
-
-💡 If you write a lot of Command Line Interfaces and would like additional/advanced syntactic sugar
-that includes what is found in this gem, make sure to check out the
+Provides a Ruby implementation of the link:https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html[XDG Base Directory
+Specification] for managing common configurations without polluting your dotfiles. XDG is great for command line interfaces or any application that needs a common configuration, cache, data, state, or runtime.
+
+💡 If you write a lot of Command Line Interfaces and would like additional/advanced syntactic sugar that includes what is found in this gem, make sure to check out the
 link:https://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:
+* Provides a `XDG` 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`
@@ -33,18 +28,34 @@ access to the following environment settings:
 
 == Setup
 
-To install, run:
+To install _with_ security, run:
+
+[source,bash]
+----
+# 💡 Skip this line if you already have the public certificate installed.
+gem cert --add <(curl --compressed --location https://alchemists.io/gems.pem)
+gem install xdg --trust-policy HighSecurity
+----
+
+To install _without_ security, run:
 
 [source,bash]
 ----
 gem install xdg
 ----
 
-Add the following to your Gemfile:
+You can also add the gem directly to your project:
+
+[source,bash]
+----
+bundle add xdg
+----
+
+Once the gem is installed, you only need to require it:
 
 [source,ruby]
 ----
-gem "xdg"
+require "xdg"
 ----
 
 == Usage
@@ -53,11 +64,11 @@ The following describes how to use this implementation.
 
 === Objects
 
-To get up and running quickly, use `+XDG::Environment+` as follows:
+To get up and running quickly, use `XDG.new` as follows:
 
 [source,ruby]
 ----
-xdg = XDG::Environment.new
+xdg = XDG.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.
@@ -66,12 +77,7 @@ 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
-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:
+Behinds the scenes, use of `XDG.new` provides a convenient wrapper of `XDG::Environment.new` which, in turn, provides a unified API to the following objects:
 
 [source,ruby]
 ----
@@ -81,14 +87,15 @@ data = XDG::Data.new
 state = XDG::State.new
 ----
 
-The `cache`, `config`, `data`, and `state` objects share the same API which means you can ask each the
-following messages:
+Generally, use of `XDG.new` is all you need but knowing you can create a specialized instance of any aspect of the XDG specification can be handy for specific use cases. Additionally, the `cache`, `config`, `data`, and `state` objects share the same API which means you can send 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).
 
+The _computed_ value of each method 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.
+
 === Examples
 
 The following are examples of what you would see when playing around with the XDG objects within an
@@ -99,42 +106,42 @@ IRB console (taken from my own environment):
 require "xdg"
 
 # Initialization
-environment = XDG::Environment.new
+xdg = XDG.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 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"
+xdg.inspect         # "XDG_CACHE_HOME=/Users/demo/.cache XDG_CONFIG_HOME=/Users/demo/.config XDG_CONFIG_DIRS=/etc/xdg XDG_DATA_HOME=/Users/demo/.local/share XDG_DATA_DIRS=/usr/local/share:/usr/share XDG_STATE_HOME=/Users/demo/.local/state"
+cache.inspect       # "XDG_CACHE_HOME=/Users/demo/.cache"
+config.inspect      # "XDG_CONFIG_HOME=/Users/demo/.config XDG_CONFIG_DIRS=/etc/xdg"
+data.inspect        # "XDG_DATA_HOME=/Users/demo/.local/share XDG_DATA_DIRS=/usr/local/share:/usr/share"
+state.inspect       # "XDG_STATE_HOME=/Users/demo/.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>]
-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>]
+xdg.cache_home      # #<Pathname:/Users/demo/.cache>
+xdg.config_home     # #<Pathname:/Users/demo/.config>
+xdg.config_dirs     # [#<Pathname:/etc/xdg>]
+xdg.data_home       # #<Pathname:/Users/demo/.local/share>
+xdg.data_dirs       # [#<Pathname:/usr/local/share>, #<Pathname:/usr/share>]
+xdg.state_home      # #<Pathname:/Users/demo/.local/state>
+
+cache.home          # #<Pathname:/Users/demo/.cache>
+cache.directories   # []
+cache.all           # [#<Pathname:/Users/demo/.cache>]
+
+config.home         # #<Pathname:/Users/demo/.config>
+config.directories  # [#<Pathname:/etc/xdg>]
+config.all          # [#<Pathname:/Users/demo/.config>, #<Pathname:/etc/xdg>]
+
+data.home           # #<Pathname:/Users/demo/.local/share>
+data.directories    # [#<Pathname:/usr/local/share>, #<Pathname:/usr/share>]
+data.all            # [#<Pathname:/Users/demo/.local/share>, #<Pathname:/usr/local/share>, #<Pathname:/usr/share>]
+
+state.home          # #<Pathname:/Users/demo/.local/state>
+state.directories   # []
+state.all           # [#<Pathname:/Users/demo/.local/state>]
 ----
 
 As you can see from above, each XDG object answers back a `Pathname` which means you have the full
@@ -253,7 +260,7 @@ To contribute, run:
 
 [source,bash]
 ----
-git clone https://github.com/bkuhlmann/xdg
+git clone https://github.com/demo/xdg
 cd xdg
 bin/setup
 ----

data/lib/xdg/environment.rb

@@ -22,7 +22,7 @@ module XDG
 
     def state_home = state.home
 
-    def inspect = "#{cache.inspect} #{config.inspect} #{data.inspect} #{state.inspect}"
+    def inspect = [cache, config, data, state].map(&:inspect).join " "
 
     private
 

data/lib/xdg/paths/combined.rb

@@ -17,7 +17,7 @@ module XDG
 
       def all = directories.prepend(*home)
 
-      def inspect = [initial_home.inspect, initial_directories.inspect].reject(&:empty?).join(" ")
+      def inspect = [initial_home.inspect, initial_directories.inspect].reject(&:empty?).join " "
 
       private
 

data/lib/xdg/paths/directory.rb

@@ -22,15 +22,15 @@ module XDG
                                 .map { |path| expand path }
       end
 
-      def inspect = [key, dynamic.join(DELIMITER)].reject(&:empty?).join(XDG::DELIMITER)
+      def inspect = [key, dynamic.join(DELIMITER)].reject(&:empty?).join XDG::DELIMITER
 
       private
 
       attr_reader :pair, :environment
 
-      def key = String(pair.key)
+      def key = String pair.key
 
-      def value = String(pair.value)
+      def value = String pair.value
 
       def expand(path) = Pathname(path).expand_path
     end

data/lib/xdg/paths/home.rb

@@ -18,11 +18,11 @@ module XDG
         @environment = environment
       end
 
-      def default = expand(String(value))
+      def default = expand String(value)
 
       def dynamic = String(environment[key]).then { |path| path.empty? ? default : expand(path) }
 
-      def inspect = [pair.key, dynamic].compact.join(XDG::DELIMITER)
+      def inspect = [pair.key, dynamic].compact.join XDG::DELIMITER
 
       private
 
@@ -30,7 +30,7 @@ module XDG
 
       def expand(path) = home.join(path).expand_path
 
-      def home = Pathname(environment.fetch(KEY))
+      def home = Pathname environment.fetch(KEY)
     end
   end
 end

data/lib/xdg.rb

@@ -10,6 +10,9 @@ require "xdg/paths/directory"
 require "xdg/paths/home"
 require "xdg/state"
 
+# Main namespace.
 module XDG
   DELIMITER = "="
+
+  def self.new = Environment.new
 end

data/xdg.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |spec|
   spec.name = "xdg"
-  spec.version = "7.0.2"
+  spec.version = "7.1.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/xdg"
-  spec.summary = "Provides an implementation of the XDG Base Directory Specification."
+  spec.summary = "An XDG Base Directory Specification implementation."
   spec.license = "Hippocratic-2.1"
 
   spec.metadata = {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xdg
 version: !ruby/object:Gem::Version
-  version: 7.0.2
+  version: 7.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2023-06-11 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -85,8 +85,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.9
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
-summary: Provides an implementation of the XDG Base Directory Specification.
+summary: An XDG Base Directory Specification implementation.
 test_files: []