gem_hadar 1.25.0 → 1.27.0

data/lib/gem_hadar/utils.rb

@@ -1,13 +1,48 @@
+require 'pathname'
+
 module GemHadar::Utils
+  # The xdg_config_home method determines the path to the XDG configuration
+  # directory.
+  #
+  # It first checks if the XDG_CONFIG_HOME environment variable is set and not
+  # empty. If it is set, the method returns the value as a Pathname object. If
+  # XDG_CONFIG_HOME is not set, it defaults to using the HOME environment
+  # variable to construct the path within the standard .config directory.
+  #
+  # @return [ Pathname ] the Pathname object representing the XDG configuration directory
+  def xdg_config_home
+    ENV['XDG_CONFIG_HOME'].full? { Pathname.new(_1) } ||
+      Pathname.new(ENV.fetch('HOME')) + '.config'
+  end
+
+  # The xdg_config_filename method constructs the full path to a configuration
+  # file based on the XDG Base Directory specification.
+  #
+  # It first checks if the XDG_CONFIG_HOME environment variable is set and not
+  # empty. If it is set, the method joins this directory with the provided
+  # filename to form the complete path. If XDG_CONFIG_HOME is not set, it
+  # defaults to using the HOME environment variable to construct the path
+  # within the standard .config directory.
+  #
+  # @param name [ String ] the name of the configuration file
+  #
+  # @return [ String ] the full path to the configuration file
   def xdg_config_filename(name)
-    if xdg = ENV['XDG_CONFIG_HOME'].full?
-      File.join(xdg, name)
-    else
-      File.join(ENV.fetch('HOME'), '.config', name)
-    end
+    xdg_config_home + name
   end
 
   memoize method:
+  # The xdg_config method retrieves configuration data from a file following
+  # the XDG Base Directory specification.
+  #
+  # It checks for the existence of a configuration file using the
+  # xdg_config_filename method and returns its contents if found. If the file
+  # does not exist, it returns the provided default value instead.
+  #
+  # @param name [ String ] the name of the configuration file to retrieve
+  # @param default [ Object ] the default value to return if the configuration file is not found
+  #
+  # @return [ String ] the content of the configuration file or the default value
   def xdg_config(name, default)
     if File.exist?(xdg_config_filename(name))
       File.read(xdg_config_filename(name))

data/lib/gem_hadar/version.rb

@@ -1,6 +1,6 @@
 class GemHadar
   # GemHadar version
-  VERSION         = '1.25.0'
+  VERSION         = '1.27.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc: