utils 0.85.0 → 0.87.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fd913953f77f177caac61d9a98e615eaba79f5aad327b892a8728d510443b3f
-  data.tar.gz: d8f2937862ac26cffa7a4d3244155354b33e587d0fc6cecacedbf6539845bbf4
+  metadata.gz: 11c3f0c005743ebba2c7f6e88075ccf2b600c96a2a7a61fdbf71a3912ed167e7
+  data.tar.gz: 0a477a003d9d890075fd2f403eb0fbff26d7d4629af84a46862b5ec8b4f0d4fa
 SHA512:
-  metadata.gz: cc3e00dd0c01f36a2835f74c490f2b35cb8d64b7d4197d49d7c3ae09e247ea3d6067483d34facbdc40c19018516e7a368ddfeb4a38e26efc6d8cf460a8785e4a
-  data.tar.gz: 566f70210d3ff85d8798cc2876371e49c86d2ec959fa11f76a6ecc6e546819953878fcabc53e210de8c1b024dab9d61863f86f5c415fcb02551fe0f79420b8de
+  metadata.gz: 6149a5155835a3f6cc8acd7e20fd5ff931a4a45f3d26240937891e893a736376f8703d1cfcbca63d85369e7a06278bfe663d70c5454e54d9917ede6476b0538b
+  data.tar.gz: d12dc91177ada52d0dd1a0884bc975745791656f9058d4a01b95bf0b431355ab9102af178b9398bb34105fe3a1fa9b6e265052727d5ef248aab7927b755a2318

data/bin/changes

@@ -28,6 +28,7 @@
 require 'ollama'
 include Ollama
 require 'utils'
+include Utils::XDG
 
 # Executes a shell command and returns its output.
 #
@@ -101,13 +102,12 @@ def compute_change(range_from, range_to)
     EOT
   end
 
-  config = Utils::ConfigDir.new('changes', env_var: 'XDG_CONFIG_HOME')
-
+  config        = XDG_CONFIG_HOME + 'changes'
   base_url      = ENV['OLLAMA_URL'] || 'http://%s' % ENV.fetch('OLLAMA_HOST')
   model         = ENV.fetch('OLLAMA_MODEL', 'llama3.1')
-  system        = File.read("#{config}/system.txt")
-  prompt        = File.read("#{config}/prompt.txt") + "\n\n#{log}\n"
-  client_config = Client::Config.load_from_json("#{config}/client.json")
+  system        = config.read('system.txt')
+  prompt        = config.read('prompt.txt') + "\n\n#{log}\n"
+  client_config = Client::Config.load_from_json(config + 'client.json')
   client_config.base_url = base_url
 
   if ENV['DEBUG'].to_i == 1

data/bin/code_comment

@@ -32,6 +32,7 @@
 require 'ollama'
 include Ollama
 require 'utils'
+include Utils::XDG
 require 'context_spook'
 
 META_METHOD = /(
@@ -184,7 +185,7 @@ end
 filename_linenumber = ARGV.shift or fail "require file_name as second argument"
 $config = Utils::ConfigFile.new
 $config.configure_from_paths
-$config_dir         = Utils::ConfigDir.new('code_comment', env_var: 'XDG_CONFIG_HOME')
+$config_dir         = XDG_CONFIG_HOME + 'code_comment'
 base_url            = ENV['OLLAMA_URL'] || 'http://%s' % ENV.fetch('OLLAMA_HOST')
 model               = ENV.fetch('OLLAMA_MODEL', 'llama3.1')
 construct, construct_type = fetch_construct(filename_linenumber)

data/bin/commit_message

@@ -26,10 +26,11 @@
 # - prompt.txt: Commit message template, contains %{branch} and %{stdin}
 
 require 'utils'
+include Utils::XDG
 
-config = Utils::ConfigDir.new('commit_message', env_var: 'XDG_CONFIG_HOME')
+config = XDG_CONFIG_HOME + 'commit_message'
 
 branch = `git rev-parse --abbrev-ref HEAD`.chomp
-exec 'ollama_cli', '-c', "#{config}/client.json",
-  '-M', "#{config}/options.json", '-P', "branch=#{branch}",
-  '-s', "#{config}/system.txt", '-p', "#{config}/prompt.txt"
+exec 'ollama_cli', '-c', config + 'client.json',
+  '-M', config + 'options.json', '-P', "branch=#{branch}",
+  '-s', config + 'system.txt', '-p', config + 'prompt.txt'

data/bin/discover

@@ -85,7 +85,7 @@ Options are
   -n NUMBER   the first NUMBER of matches is returned
   -s          search by interactively inputting PATTERN
   -l          list all paths in cache relative to current directory
-  -L          list all paths in cahce as absolute pathes from root
+  -L          list all paths in cache as absolute pathes from root
   -h          display this help
 
 Version is #{File.basename($0)} #{Utils::VERSION}.

data/bin/search

@@ -206,7 +206,7 @@ def usage
       -B NUMBER   displays NUMBER lines of context before the match
       -C NUMBER   displays NUMBER lines of context around the match
       -f          just list the paths of the files that would be searched
-      -F          just consider real files when searching
+      -F          follow symlinks when searching
       -l          just list the paths of the files with matches
       -L          list only the path:linenumber of the files with matches
       -pX         interpret PATTERN argument as X=f fuzzy or X=r for regexp

data/lib/utils/config_file/block_config.rb

@@ -0,0 +1,110 @@
+class Utils::ConfigFile
+  # Base class for defining configuration blocks with DSL accessors.
+  #
+  # This class provides a foundation for creating configuration classes that
+  # support dynamic attribute definition through DSL-style accessor methods. It
+  # includes functionality for registering configuration settings and
+  # generating Ruby code representations of the configuration state.
+  class BlockConfig
+    class << self
+      # The inherited method extends the module with DSL accessor functionality
+      # and calls the superclass implementation.
+      #
+      # @param modul [ Module ] the module that inherited this class
+      def inherited(modul)
+        modul.extend DSLKit::DSLAccessor
+        super
+      end
+
+      # The config method sets up a configuration accessor with the specified
+      # name and options.
+      #
+      # This method registers a new configuration setting by adding it to the
+      # list of configuration settings and then creates an accessor for it
+      # using the dsl_accessor method, allowing for easy retrieval and
+      # assignment of configuration values.
+      #
+      # @param name [ Object ] the name of the configuration setting
+      # @param r [ Array ] additional arguments passed to the dsl_accessor method
+      #
+      # @yield [ block ] optional block to be passed to the dsl_accessor method
+      #
+      # @return [ Object ] returns self to allow for method chaining
+      def config(name, *r, &block)
+        self.config_settings ||= []
+        config_settings << name.to_sym
+        dsl_accessor name, *r, &block
+        self
+      end
+
+      # The lazy_config method configures a lazy-loaded configuration option
+      # with a default value.
+      #
+      # This method registers a new configuration setting that will be
+      # initialized lazily, meaning the default value or the set value is only
+      # computed when the configuration is actually accessed. It adds the
+      # setting to the list of configuration settings and creates a lazy
+      # accessor for it.
+      #
+      # @param name [ Object ] the name of the configuration setting to define
+      # @yield [ default ] optional block that provides the default value for
+      # the configuration
+      #
+      # @return [ Object ] returns self to allow for method chaining
+      def lazy_config(name, &default)
+        self.config_settings ||= []
+        config_settings << name.to_sym
+        dsl_lazy_accessor(name, &default)
+        self
+      end
+
+      # The config_settings method provides access to the configuration
+      # settings.
+      #
+      # This method returns the configuration settings stored in the instance
+      # variable, allowing for reading and modification of the object's
+      # configuration state.
+      #
+      # @return [ Object ] the current configuration settings stored in the
+      # instance variable
+      attr_accessor :config_settings
+    end
+
+    # The initialize method sets up the instance by evaluating the provided
+    # block in the instance's context.
+    #
+    # This method allows for dynamic configuration of the object by executing
+    # the given block within the instance's scope, enabling flexible
+    # initialization patterns.
+    #
+    # @param block [ Proc ] the block to be evaluated for instance setup
+    def initialize(&block)
+      block and instance_eval(&block)
+    end
+
+    # The to_ruby method generates a Ruby configuration block representation by
+    # recursively processing the object's configuration settings and their
+    # values.
+    # It creates a nested structure with proper indentation and formatting
+    # suitable for configuration files.
+    #
+    # @param depth [ Integer ] the current nesting depth for indentation purposes
+    #
+    # @return [ String ] a formatted Ruby string representing the configuration block
+    def to_ruby(depth = 0)
+      result = ''
+      result << ' ' * 2 * depth <<
+        "#{self.class.name[/::([^:]+)\z/, 1].underscore} do\n"
+      for name in self.class.config_settings
+        value = __send__(name)
+        if value.respond_to?(:to_ruby)
+          result << ' ' * 2 * (depth + 1) << value.to_ruby(depth + 1)
+        else
+          result << ' ' * 2 * (depth + 1) <<
+            "#{name} #{Array(value).map(&:inspect) * ', '}\n"
+        end
+      end
+      result << ' ' * 2 * depth << "end\n"
+    end
+  end
+end

data/lib/utils/config_file.rb

@@ -1,4 +1,5 @@
 require 'tins'
+require 'utils/config_file/block_config'
 
 # Configuration file manager for Utils library.
 #
@@ -93,115 +94,6 @@ class Utils::ConfigFile
     self
   end
 
-  # Base class for defining configuration blocks with DSL accessors.
-  #
-  # This class provides a foundation for creating configuration classes that
-  # support dynamic attribute definition through DSL-style accessor methods. It
-  # includes functionality for registering configuration settings and
-  # generating Ruby code representations of the configuration state.
-  class BlockConfig
-    class << self
-      # The inherited method extends the module with DSL accessor functionality
-      # and calls the superclass implementation.
-      #
-      # @param modul [ Module ] the module that inherited this class
-      def inherited(modul)
-        modul.extend DSLKit::DSLAccessor
-        super
-      end
-
-      # The config method sets up a configuration accessor with the specified
-      # name and options.
-      #
-      # This method registers a new configuration setting by adding it to the
-      # list of configuration settings and then creates an accessor for it
-      # using the dsl_accessor method, allowing for easy retrieval and
-      # assignment of configuration values.
-      #
-      # @param name [ Object ] the name of the configuration setting
-      # @param r [ Array ] additional arguments passed to the dsl_accessor method
-      #
-      # @yield [ block ] optional block to be passed to the dsl_accessor method
-      #
-      # @return [ Object ] returns self to allow for method chaining
-      def config(name, *r, &block)
-        self.config_settings ||= []
-        config_settings << name.to_sym
-        dsl_accessor name, *r, &block
-        self
-      end
-
-      # The lazy_config method configures a lazy-loaded configuration option
-      # with a default value.
-      #
-      # This method registers a new configuration setting that will be
-      # initialized lazily, meaning the default value or the set value is only
-      # computed when the configuration is actually accessed. It adds the
-      # setting to the list of configuration settings and creates a lazy
-      # accessor for it.
-      #
-      # @param name [ Object ] the name of the configuration setting to define
-      # @yield [ default ] optional block that provides the default value for
-      # the configuration
-      #
-      # @return [ Object ] returns self to allow for method chaining
-      def lazy_config(name, &default)
-        self.config_settings ||= []
-        config_settings << name.to_sym
-        dsl_lazy_accessor(name, &default)
-        self
-      end
-
-      # The config_settings method provides access to the configuration
-      # settings.
-      #
-      # This method returns the configuration settings stored in the instance
-      # variable, allowing for reading and modification of the object's
-      # configuration state.
-      #
-      # @return [ Object ] the current configuration settings stored in the
-      # instance variable
-      attr_accessor :config_settings
-    end
-
-    # The initialize method sets up the instance by evaluating the provided
-    # block in the instance's context.
-    #
-    # This method allows for dynamic configuration of the object by executing
-    # the given block within the instance's scope, enabling flexible
-    # initialization patterns.
-    #
-    # @param block [ Proc ] the block to be evaluated for instance setup
-    def initialize(&block)
-      block and instance_eval(&block)
-    end
-
-    # The to_ruby method generates a Ruby configuration block representation by
-    # recursively processing the object's configuration settings and their
-    # values.
-    # It creates a nested structure with proper indentation and formatting
-    # suitable for configuration files.
-    #
-    # @param depth [ Integer ] the current nesting depth for indentation purposes
-    #
-    # @return [ String ] a formatted Ruby string representing the configuration block
-    def to_ruby(depth = 0)
-      result = ''
-      result << ' ' * 2 * depth <<
-        "#{self.class.name[/::([^:]+)\z/, 1].underscore} do\n"
-      for name in self.class.config_settings
-        value = __send__(name)
-        if value.respond_to?(:to_ruby)
-          result << ' ' * 2 * (depth + 1) << value.to_ruby(depth + 1)
-        else
-          result << ' ' * 2 * (depth + 1) <<
-            "#{name} #{Array(value).map(&:inspect) * ', '}\n"
-        end
-      end
-      result << ' ' * 2 * depth << "end\n"
-    end
-  end
-
   # A configuration class for test execution settings.
   #
   # This class manages the configuration options related to running tests,

data/lib/utils/finder.rb

@@ -19,6 +19,7 @@ require 'mize'
 class Utils::Finder
   include Tins::Find
   include Utils::Patterns
+  include Utils::XDG
   include Term::ANSIColor
 
   # The initialize method sets up the finder instance with the provided options.
@@ -91,7 +92,7 @@ class Utils::Finder
       end
       true
     }
-    find(*@roots, visit: visit) do |filename|
+    find(*@roots, visit:) do |filename|
       filename.stat.directory? and filename << ?/
       paths << filename
     end
@@ -110,11 +111,8 @@ class Utils::Finder
   # @return [ String ] the full file path where finder results should be stored
   def index_path
     roots = @roots.map { |r| File.expand_path(r) }.uniq.sort
-    filename = "finder-paths-" +
-      Digest::MD5.new.update(roots.inspect).hexdigest
-    dirname = File.join(Dir.tmpdir, File.basename($0))
-    FileUtils.mkdir_p dirname
-    File.join(dirname, filename)
+    filename = "finder-paths-" + Digest::MD5.new.update(roots.inspect).hexdigest
+    XDG_CACHE_HOME.sub_dir_path('utils') + filename
   end
 
   # The create_paths method generates and stores path information by building a

data/lib/utils/grepper.rb

@@ -249,7 +249,7 @@ class Utils::Grepper
       if !s ||
           s.directory? && @config.search.prune?(bn) ||
           (s.file? || s.symlink?) && @config.search.skip?(bn) ||
-          @args[?F] && s.symlink?
+          !@args[?F] && s.symlink?
       then
         @args[?v] and warn "Pruning #{filename.inspect}."
         prune

data/lib/utils/irb/irb_server.rb

@@ -17,6 +17,8 @@ require 'fileutils'
 #   client.store_snippet('puts "Hello World"')
 #   result = server.eval_snippet('2 + 2')
 class Utils::IRB::IRBServer
+  include Utils::XDG
+
   # The initialize method sets up a new IRBServer instance with the specified
   # URL.
   #
@@ -172,10 +174,7 @@ class Utils::IRB::IRBServer
   # @return [ String ] the path to the log file that will be used for logging
   def setup_logger
     unless @log_out
-      xdg_dir  = File.expand_path(ENV.fetch('XDG_STATE_HOME', '~/.local/state'))
-      log_path = Pathname.new(xdg_dir) + 'utils'
-      FileUtils.mkdir_p log_path
-      log_path += 'irb-server.log'
+      log_path = XDG_STATE_HOME.sub_dir_path('utils') + 'irb-server.log'
       @log_out = File.new(log_path, ?a)
     end
     @log_out.sync = true

data/lib/utils/version.rb

@@ -1,6 +1,6 @@
 module Utils
   # Utils version
-  VERSION         = '0.85.0'
+  VERSION         = '0.87.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/lib/utils/xdg.rb

@@ -0,0 +1,165 @@
+require 'pathname'
+require 'fileutils'
+require 'stringio'
+
+# Module for handling XDG base directory specifications and application
+# directory management.
+#
+# Provides constants and methods for working with XDG (Cross-Desktop Group)
+# base directories including data home, configuration home, state home, and
+# cache home directories.
+#
+# The module defines standard XDG directory paths and includes functionality
+# for creating application-specific directories within these base locations.
+#
+# @example
+#   Utils::XDG::XDG_DATA_HOME # => Pathname object for the data home directory
+#   Utils::XDG::XDG_CONFIG_HOME # => Pathname object for the config home directory
+#   Utils::XDG::XDG_STATE_HOME # => Pathname object for the state home directory
+#   Utils::XDG::XDG_CACHE_HOME # => Pathname object for the cache home directory
+module Utils::XDG
+  # A Pathname subclass that provides additional XDG directory functionality
+  #
+  # This class extends the standard Pathname class to include methods for
+  # working with XDG (Cross-Desktop Group) base directory specifications. It
+  # adds capabilities for creating subdirectories, reading files, and handling
+  # path operations within the context of XDG-compliant directory structures.
+  #
+  # @example
+  #   pathname = XDGPathname.new('/home/user')
+  #   sub_dir = pathname.sub_dir_path('documents')
+  #   content = pathname.read('config.txt')
+  class XDGPathname < ::Pathname
+    # The sub_dir_path method creates a subdirectory path and ensures it exists
+    #
+    # This method takes a directory name, combines it with the current path to
+    # form a subdirectory path, and then checks if the path already exists. If
+    # the path exists but is not a directory, it raises an ArgumentError. If
+    # the path does not exist, it creates the directory structure using
+    # FileUtils.
+    #
+    # @param dirname [ String ] the name of the subdirectory to create or access
+    #
+    # @return [ Pathname ] the Pathname object representing the subdirectory path
+    #
+    # @raise [ ArgumentError ] if the path exists but is not a directory
+    def sub_dir_path(dirname)
+      path = self + dirname
+      if path.exist?
+        path.directory? or raise ArgumentError,
+          "path #{path.to_s.inspect} exists and is not a directory"
+      else
+        FileUtils.mkdir_p path
+      end
+      path
+    end
+
+    # The read method reads file contents or yields to a block for processing.
+    #
+    # This method attempts to read a file at the specified path, returning the
+    # file's contents as a string.
+    # If a block is provided, it opens the file and yields to the block with a
+    # File object.
+    # If the file does not exist and a default value is provided, it returns
+    # the default value.
+    # When a default value is provided along with a block, the block is invoked
+    # with a StringIO object containing the default value.
+    #
+    # @param path [ String ] the path to the file to read
+    # @param default [ String, nil ] the default value to return if the file
+    #   does not exist
+    #
+    # @yield [ file ] optional block to process the file
+    # @yieldparam file [ File ] the file object for processing
+    #
+    # @return [ String, nil ] the file contents if no block is given, the
+    #   result of the block if given, or the default value if the file does not
+    #   exist
+    def read(path, default: nil, &block)
+      full_path = join(path)
+      if File.exist?(full_path)
+        if block
+          File.new(full_path, &block)
+        else
+          File.read(full_path, encoding: 'UTF-8')
+        end
+      else
+        if default && block
+          block.(StringIO.new(default))
+        else
+          default
+        end
+      end
+    end
+
+    %i[
+      join + dirname basename realpath expand_path cleanpath
+      relative_path_from
+    ].each do |id|
+      define_method(id) do |*args, **kw, &block|
+        self.class.new(super(*args, **kw, &block))
+      end
+    end
+
+    alias to_str to_s
+  end
+
+  # Module for handling XDG application directories.
+  #
+  # This module provides methods for creating and managing application-specific
+  # directories within the XDG base directories.
+  module AppDir
+    # Converts a path string to a XDGPathname object with expanded path
+    #
+    # @param path [String] The path to convert
+    # @return [XDGPathname] A path as XDGPathname
+    def self.pathify(path)
+      XDGPathname.new(path).expand_path
+    end
+  end
+
+  class << self
+    private
+
+    # Retrieves an environment variable value or returns a default.
+    #
+    # @param name [String] The name of the environment variable
+    # @param default [String] The default value if the environment variable is not set
+    # @return [String] The value of the environment variable or the default
+    def env_for(name, default:)
+      ENV.fetch(name, default)
+    end
+  end
+
+  # XDG Data Home directory path.
+  #
+  # This is the base directory relative to which user-specific data files should be stored.
+  # The default value is `~/.local/share`.
+  #
+  # @return [Pathname] The data home directory path
+  XDG_DATA_HOME = AppDir.pathify(env_for('XDG_DATA_HOME', default: '~/.local/share'))
+
+  # XDG Configuration Home directory path.
+  #
+  # This is the base directory relative to which user-specific configuration files should be stored.
+  # The default value is `~/.config`.
+  #
+  # @return [Pathname] The configuration home directory path
+  XDG_CONFIG_HOME = AppDir.pathify(env_for('XDG_CONFIG_HOME', default: '~/.config'))
+
+  # XDG State Home directory path.
+  #
+  # This is the base directory relative to which user-specific state files should be stored.
+  # The default value is `~/.local/state`.
+  #
+  # @return [Pathname] The state home directory path
+  XDG_STATE_HOME  = AppDir.pathify(env_for('XDG_STATE_HOME', default: '~/.local/state'))
+
+  # XDG Cache Home directory path.
+  #
+  # This is the base directory relative to which user-specific non-essential cache files should be stored.
+  # The default value is `~/.cache`.
+  #
+  # @return [Pathname] The cache home directory path
+  XDG_CACHE_HOME  = AppDir.pathify(env_for('XDG_CACHE_HOME', default: '~/.cache'))
+end

data/lib/utils.rb

@@ -10,6 +10,7 @@ module Utils
   require 'utils/version'
   require 'utils/md5'
   require 'utils/patterns'
+  require 'utils/xdg'
   require 'utils/config_file'
   require 'utils/editor'
   require 'utils/finder'
@@ -17,7 +18,6 @@ module Utils
   require 'utils/probe'
   require 'utils/ssh_tunnel_specification'
   require 'utils/line_blamer'
-  require 'utils/config_dir'
 
   require 'utils/xt/source_location_extension'
   class ::Object

data/utils.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: utils 0.85.0 ruby lib
+# stub: utils 0.87.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "utils".freeze
-  s.version = "0.85.0".freeze
+  s.version = "0.87.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -12,12 +12,12 @@ Gem::Specification.new do |s|
   s.description = "This ruby gem provides some useful command line utilities".freeze
   s.email = "flori@ping.de".freeze
   s.executables = ["ascii7".freeze, "blameline".freeze, "changes".freeze, "classify".freeze, "code_comment".freeze, "code_indexer".freeze, "commit_message".freeze, "discover".freeze, "edit".freeze, "edit_wait".freeze, "enum".freeze, "git-empty".freeze, "git-versions".freeze, "irb_client".freeze, "json_check".freeze, "long_lines".freeze, "myex".freeze, "on_change".freeze, "path".freeze, "print_method".freeze, "probe".freeze, "rainbow".freeze, "rd2md".freeze, "search".freeze, "sedit".freeze, "serve".freeze, "ssh-tunnel".freeze, "strip_spaces".freeze, "sync_dir".freeze, "untest".freeze, "utils-utilsrc".freeze, "vcf2alias".freeze, "yaml_check".freeze]
-  s.extra_rdoc_files = ["README.md".freeze, "lib/utils.rb".freeze, "lib/utils/config_dir.rb".freeze, "lib/utils/config_file.rb".freeze, "lib/utils/editor.rb".freeze, "lib/utils/finder.rb".freeze, "lib/utils/grepper.rb".freeze, "lib/utils/irb.rb".freeze, "lib/utils/irb/irb_server.rb".freeze, "lib/utils/line_blamer.rb".freeze, "lib/utils/line_formatter.rb".freeze, "lib/utils/md5.rb".freeze, "lib/utils/patterns.rb".freeze, "lib/utils/probe.rb".freeze, "lib/utils/probe/probe_client.rb".freeze, "lib/utils/probe/probe_server.rb".freeze, "lib/utils/probe/process_job.rb".freeze, "lib/utils/probe/server_handling.rb".freeze, "lib/utils/ssh_tunnel_specification.rb".freeze, "lib/utils/version.rb".freeze, "lib/utils/xt/source_location_extension.rb".freeze]
-  s.files = ["Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "bin/ascii7".freeze, "bin/blameline".freeze, "bin/changes".freeze, "bin/classify".freeze, "bin/code_comment".freeze, "bin/code_indexer".freeze, "bin/commit_message".freeze, "bin/discover".freeze, "bin/edit".freeze, "bin/edit_wait".freeze, "bin/enum".freeze, "bin/git-empty".freeze, "bin/git-versions".freeze, "bin/irb_client".freeze, "bin/json_check".freeze, "bin/long_lines".freeze, "bin/myex".freeze, "bin/on_change".freeze, "bin/path".freeze, "bin/print_method".freeze, "bin/probe".freeze, "bin/rainbow".freeze, "bin/rd2md".freeze, "bin/search".freeze, "bin/sedit".freeze, "bin/serve".freeze, "bin/ssh-tunnel".freeze, "bin/strip_spaces".freeze, "bin/sync_dir".freeze, "bin/untest".freeze, "bin/utils-utilsrc".freeze, "bin/vcf2alias".freeze, "bin/yaml_check".freeze, "lib/utils.rb".freeze, "lib/utils/config_dir.rb".freeze, "lib/utils/config_file.rb".freeze, "lib/utils/editor.rb".freeze, "lib/utils/finder.rb".freeze, "lib/utils/grepper.rb".freeze, "lib/utils/irb.rb".freeze, "lib/utils/irb/irb_server.rb".freeze, "lib/utils/line_blamer.rb".freeze, "lib/utils/line_formatter.rb".freeze, "lib/utils/md5.rb".freeze, "lib/utils/patterns.rb".freeze, "lib/utils/probe.rb".freeze, "lib/utils/probe/probe_client.rb".freeze, "lib/utils/probe/probe_server.rb".freeze, "lib/utils/probe/process_job.rb".freeze, "lib/utils/probe/server_handling.rb".freeze, "lib/utils/ssh_tunnel_specification.rb".freeze, "lib/utils/version.rb".freeze, "lib/utils/xt/source_location_extension.rb".freeze, "tests/test_helper.rb".freeze, "tests/utils_test.rb".freeze, "utils.gemspec".freeze]
+  s.extra_rdoc_files = ["README.md".freeze, "lib/utils.rb".freeze, "lib/utils/config_file.rb".freeze, "lib/utils/config_file/block_config.rb".freeze, "lib/utils/editor.rb".freeze, "lib/utils/finder.rb".freeze, "lib/utils/grepper.rb".freeze, "lib/utils/irb.rb".freeze, "lib/utils/irb/irb_server.rb".freeze, "lib/utils/line_blamer.rb".freeze, "lib/utils/line_formatter.rb".freeze, "lib/utils/md5.rb".freeze, "lib/utils/patterns.rb".freeze, "lib/utils/probe.rb".freeze, "lib/utils/probe/probe_client.rb".freeze, "lib/utils/probe/probe_server.rb".freeze, "lib/utils/probe/process_job.rb".freeze, "lib/utils/probe/server_handling.rb".freeze, "lib/utils/ssh_tunnel_specification.rb".freeze, "lib/utils/version.rb".freeze, "lib/utils/xdg.rb".freeze, "lib/utils/xt/source_location_extension.rb".freeze]
+  s.files = ["Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "bin/ascii7".freeze, "bin/blameline".freeze, "bin/changes".freeze, "bin/classify".freeze, "bin/code_comment".freeze, "bin/code_indexer".freeze, "bin/commit_message".freeze, "bin/discover".freeze, "bin/edit".freeze, "bin/edit_wait".freeze, "bin/enum".freeze, "bin/git-empty".freeze, "bin/git-versions".freeze, "bin/irb_client".freeze, "bin/json_check".freeze, "bin/long_lines".freeze, "bin/myex".freeze, "bin/on_change".freeze, "bin/path".freeze, "bin/print_method".freeze, "bin/probe".freeze, "bin/rainbow".freeze, "bin/rd2md".freeze, "bin/search".freeze, "bin/sedit".freeze, "bin/serve".freeze, "bin/ssh-tunnel".freeze, "bin/strip_spaces".freeze, "bin/sync_dir".freeze, "bin/untest".freeze, "bin/utils-utilsrc".freeze, "bin/vcf2alias".freeze, "bin/yaml_check".freeze, "lib/utils.rb".freeze, "lib/utils/config_file.rb".freeze, "lib/utils/config_file/block_config.rb".freeze, "lib/utils/editor.rb".freeze, "lib/utils/finder.rb".freeze, "lib/utils/grepper.rb".freeze, "lib/utils/irb.rb".freeze, "lib/utils/irb/irb_server.rb".freeze, "lib/utils/line_blamer.rb".freeze, "lib/utils/line_formatter.rb".freeze, "lib/utils/md5.rb".freeze, "lib/utils/patterns.rb".freeze, "lib/utils/probe.rb".freeze, "lib/utils/probe/probe_client.rb".freeze, "lib/utils/probe/probe_server.rb".freeze, "lib/utils/probe/process_job.rb".freeze, "lib/utils/probe/server_handling.rb".freeze, "lib/utils/ssh_tunnel_specification.rb".freeze, "lib/utils/version.rb".freeze, "lib/utils/xdg.rb".freeze, "lib/utils/xt/source_location_extension.rb".freeze, "tests/test_helper.rb".freeze, "tests/utils_test.rb".freeze, "utils.gemspec".freeze]
   s.homepage = "http://github.com/flori/utils".freeze
   s.licenses = ["GPL-2.0".freeze]
   s.rdoc_options = ["--title".freeze, "Utils - Some useful command line utilities".freeze, "--main".freeze, "README.md".freeze]
-  s.rubygems_version = "4.0.2".freeze
+  s.rubygems_version = "4.0.3".freeze
   s.summary = "Some useful command line utilities".freeze
   s.test_files = ["tests/test_helper.rb".freeze, "tests/utils_test.rb".freeze]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utils
 version: !ruby/object:Gem::Version
-  version: 0.85.0
+  version: 0.87.0
 platform: ruby
 authors:
 - Florian Frank
@@ -315,8 +315,8 @@ extensions: []
 extra_rdoc_files:
 - README.md
 - lib/utils.rb
-- lib/utils/config_dir.rb
 - lib/utils/config_file.rb
+- lib/utils/config_file/block_config.rb
 - lib/utils/editor.rb
 - lib/utils/finder.rb
 - lib/utils/grepper.rb
@@ -333,6 +333,7 @@ extra_rdoc_files:
 - lib/utils/probe/server_handling.rb
 - lib/utils/ssh_tunnel_specification.rb
 - lib/utils/version.rb
+- lib/utils/xdg.rb
 - lib/utils/xt/source_location_extension.rb
 files:
 - Gemfile
@@ -373,8 +374,8 @@ files:
 - bin/vcf2alias
 - bin/yaml_check
 - lib/utils.rb
-- lib/utils/config_dir.rb
 - lib/utils/config_file.rb
+- lib/utils/config_file/block_config.rb
 - lib/utils/editor.rb
 - lib/utils/finder.rb
 - lib/utils/grepper.rb
@@ -391,6 +392,7 @@ files:
 - lib/utils/probe/server_handling.rb
 - lib/utils/ssh_tunnel_specification.rb
 - lib/utils/version.rb
+- lib/utils/xdg.rb
 - lib/utils/xt/source_location_extension.rb
 - tests/test_helper.rb
 - tests/utils_test.rb
@@ -417,7 +419,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Some useful command line utilities
 test_files:

data/lib/utils/config_dir.rb

@@ -1,128 +0,0 @@
-require 'pathname'
-require 'stringio'
-
-module Utils
-  # A configuration directory manager that handles path resolution and file
-  # operations within a specified directory structure.
-  #
-  # This class provides functionality for managing configuration directories by
-  # deriving paths based on a root directory and name, and offering methods to
-  # read files with optional default values and block handling. It supports
-  # environment variable-based root path resolution and uses Pathname for
-  # robust path manipulation.
-  #
-  # @example
-  #   config_dir = Utils::ConfigDir.new('myapp')
-  #   config_dir.to_s # => returns the string representation of the configuration directory path
-  #   config_dir.join('config.txt') # => returns a Pathname object for the joined path
-  #   config_dir.read('settings.rb') # => reads and returns the content of 'settings.rb' or nil if not found
-  #   config_dir.read('missing.txt', default: 'default content') # => returns 'default content' if file is missing
-  class ConfigDir
-    # Initializes a new ConfigDir instance with the specified name and optional
-    # root path or environment variable.
-    #
-    # @param name [ String ] the name of the directory to be used
-    # @param root_path [ String, nil ] the root path to use; if nil, the
-    #                                  default root path is used
-    # @param env_var [ String, nil ] the name of the environment variable to
-    #                                check for the root path
-    def initialize(name, root_path: nil, env_var: nil)
-      root_path ||= env_var_path(env_var)
-      @directory_path = derive_directory_path(name, root_path)
-    end
-
-    # Returns the string representation of the configuration directory path.
-    #
-    # @return [ String ] the path of the configuration directory as a string
-    def to_s
-      @directory_path.to_s
-    end
-
-    # Joins the directory path with the given path and returns the combined
-    # result.
-    #
-    # @param path [ String ] the path to be joined with the directory path
-    #
-    # @return [ Pathname ] the combined path as a Pathname object
-    def join(path)
-      @directory_path + path
-    end
-    alias + join
-
-    # Reads the content of a file at the given path within the configuration
-    # directory.
-    #
-    # If the file exists, it returns the file's content as a string encoded in
-    # UTF-8. If a block is given and the file exists, it opens the file and
-    # yields to the block.
-    # If the file does not exist and a default value is provided, it returns
-    # the default. If a block is given and the file does not exist, it yields a
-    # StringIO object containing
-    # the default value to the block.
-    #
-    # @param path [ String ] the path to the file relative to the configuration
-    # directory
-    # @param default [ String, nil ] the default value to return if the file
-    # does not exist
-    #
-    # @yield [ io ]
-    #
-    # @return [ String, nil ] the content of the file or the default value if
-    # the file does not exist
-    def read(path, default: nil, &block)
-      full_path = join(path)
-      if File.exist?(full_path)
-        if block
-          File.new(full_path, &block)
-        else
-          File.read(full_path, encoding: 'UTF-8')
-        end
-      else
-        if default && block
-          block.(StringIO.new(default))
-        else
-          default
-        end
-      end
-    end
-
-    private
-
-    # Derives the full directory path by combining the root path and the given
-    # name.
-    #
-    # @param name [ String ] the name of the directory to be appended to the root path
-    # @param root_path [ String, nil ] the root path to use; if nil, the default root path is used
-    #
-    # @return [ Pathname ] the combined directory path as a Pathname object
-    def derive_directory_path(name, root_path)
-      root = if path = root_path
-               Pathname.new(path)
-             else
-               Pathname.new(default_root_path)
-             end
-      root + name
-    end
-
-    # Returns the environment variable path if it is set and not empty.
-    #
-    # @param env_var [ String ] the name of the environment variable to check
-    # @return [ String, nil ] the value of the environment variable if it
-    # exists and is not empty, otherwise nil
-    def env_var_path(env_var)
-      env_var.full? { ENV[it].full? }
-    end
-
-    # Returns the default configuration directory path based on the HOME
-    # environment variable.
-    #
-    # This method constructs and returns a Pathname object pointing to the
-    # standard configuration directory location, which is typically
-    # $HOME/.config.
-    #
-    # @return [ Pathname ] the default configuration directory path
-    def default_root_path
-      Pathname.new(ENV.fetch('HOME') + '.config')
-    end
-  end
-end