rcfiles 1.2.46

data/lib/rcfiles/directory_aliases/toplevel_stored_dataset.rb

@@ -0,0 +1,177 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/directory_aliases/toplevel_stored_dataset.rb'
+# =========================================================================== #
+module Rcfiles
+
+class DirectoryAliases # === Rcfiles::DirectoryAliases
+
+  require 'yaml'
+  require 'rcfiles/directory_aliases/yaml_file_used_by_class_directory_aliases.rb'
+  require 'rcfiles/toplevel_methods/e.rb'
+  require 'rcfiles/toplevel_methods/no_file_exists_at.rb'
+  require 'rcfiles/toplevel_methods/save_file.rb'
+
+  # ========================================================================= #
+  # === @toplevel_stored_dataset
+  #
+  # This variable will hold the whole cd-aliases dataset. It should be
+  # kept as a Hash at all times. It also should be empty, initially.
+  #
+  # In the event that it is filled with content it will be copied
+  # onto any new instance of DirectoryAliases. That way we can
+  # use a substitute hash, or allow the user to fill it up on
+  # his or her own.
+  #
+  # Note that before May 2022 this was called @cd_aliases, but
+  # I think the new name is more logical.
+  # ========================================================================= #
+  @toplevel_stored_dataset = {}
+
+  # ========================================================================= #
+  # === Rcfiles::DirectoryAliases.toplevel_stored_dataset?
+  #
+  # Main getter over the cd-aliases. This will be our main datastructure.
+  # ========================================================================= #
+  def self.toplevel_stored_dataset?
+    @toplevel_stored_dataset
+  end; self.instance_eval { alias cd_aliases?       toplevel_stored_dataset? } # === Rcfiles::DirectoryAliases.cd_aliases?
+       self.instance_eval { alias toplevel_dataset? toplevel_stored_dataset? } # === Rcfiles::DirectoryAliases.toplevel_dataset?
+
+  # ========================================================================= #
+  # === Rcfiles::DirectoryAliases.n_entries?
+  #
+  # How many entries can be found in class DirectoryAliases is answered
+  # by this toplevel method.
+  # ========================================================================= #
+  def self.n_entries?
+    toplevel_stored_dataset?.keys.size
+  end
+
+  # ========================================================================= #
+  # === Rcfiles::DirectoryAliases.set_toplevel_stored_dataset (set_cd_aliases tag)
+  #
+  # The @toplevel_stored_dataset should always be a Hash. This is an
+  # explicit setter here, though, so the user could always assign a
+  # non-Hash. No error will be raised in this case.
+  # ========================================================================= #
+  def self.set_toplevel_stored_dataset(i = {})
+    @toplevel_stored_dataset = i
+  end; self.instance_eval { alias set_cd_aliases  set_toplevel_stored_dataset } # === Rcfiles::DirectoryAliases.set_cd_aliases=
+       self.instance_eval { alias set_cd_aliases= set_toplevel_stored_dataset } # === Rcfiles::DirectoryAliases.set_cd_aliases=
+
+  # ========================================================================= #
+  # === Rcfiles::DirectoryAliases.clear
+  #
+  # Reset the main Hash again.
+  # ========================================================================= #
+  def self.clear
+    @toplevel_stored_dataset.clear
+  end
+
+  # ========================================================================= #
+  # === Rcfiles::DirectoryAliases.load_dataset_from_main_file
+  #
+  # Load up the dataset next
+  #
+  # This determines the main cd-aliases file.
+  # ========================================================================= #
+  def self.load_dataset_from_main_file(
+      i = yaml_file?
+    )
+    if File.exist? i
+      dataset = YAML.load_file(i) # This may be UTF-8 encoding.
+      # ===================================================================== #
+      # Assign the cd-aliases via a toplevel method next:
+      # ===================================================================== #
+      set_toplevel_stored_dataset(dataset)
+    else # Else use an empty dataset instead.
+      if is_on_roebe?
+        ::Rcfiles.no_file_exists_at(i)
+      end
+      set_toplevel_stored_dataset({})
+    end
+  end
+
+  # ========================================================================= #
+  # === Rcfiles::DirectoryAliases.initialize_main_hash
+  # ========================================================================= #
+  def self.initialize_main_hash
+    clear # First empty the old dataset, should it be non-empty.
+    if toplevel_dataset?.empty?
+      load_dataset_from_main_file
+    end
+  end; self.instance_eval { alias initialize_main_dataset initialize_main_hash } # === Rcfiles::DirectoryAliases.initialize_main_dataset
+       self.instance_eval { alias run                     initialize_main_hash } # === Rcfiles::DirectoryAliases.run
+  # ======================================================================= #
+    # Initialize the main dataset if it has not been loaded up yet.
+    # ======================================================================= #
+    if ::Rcfiles::DirectoryAliases.cd_aliases?.empty?
+      ::Rcfiles::DirectoryAliases.load_dataset_from_main_file
+    end
+  # ========================================================================= #
+  # === Rcfiles::DirectoryAliases.register_sigint
+  # ========================================================================= #
+  def self.register_sigint
+    Signal.trap('SIGINT') { exit }
+  end
+
+  register_sigint # ← And call it at once.
+
+  # ========================================================================= #
+  # === Rcfiles::DirectoryAliases.save_into_ruby_file
+  #
+  # This method will store the hash in a CONSTANT, into a file (normally
+  # a .rb file).
+  #
+  # The first argument to this method denotes where to store this file,
+  # so you have the possibility to save into some special location
+  # instead.
+  #
+  # The name of the hash is provided via the the second argument to
+  # this method.
+  # ========================================================================= #
+  def self.save_into_ruby_file(
+      store_into_this_file  = '/Depot/j/expand_cd_aliases_hash.rb',
+      name_of_the_main_hash = 'EXPAND_CD_ALIASES_HASH'
+    )
+    _ = ::Rcfiles::DirectoryAliases.new
+    dataset = _.cd_aliases?
+    # ======================================================================= #
+    # First add the header:
+    # ======================================================================= #
+    what = '#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+'.dup
+    what << "#{name_of_the_main_hash} = {\n"
+    what = ::Rcfiles.ensure_main_encoding(what)
+    dataset.each_pair {|key, value|
+      key = key.to_s unless key.is_a? String
+      value = ConvertGlobalEnv.convert(value)
+      key = ::Rcfiles.ensure_main_encoding(key)
+      value = ::Rcfiles.ensure_main_encoding(value)
+      what << "  \"#{key}\": \"#{value}\",\n"
+    }
+    what << "}\n"
+    into = store_into_this_file
+    if block_given?
+      yielded = yield
+      case yielded
+      when :be_verbose
+        puts 'Storing into the file `'+into+'`.'
+      end
+    end
+    ::Rcfiles.write_what_into(what, into)
+  end; self.instance_eval { alias generate_cd_aliases save_into_ruby_file } # === Rcfiles::DirectoryAliases.generate_cd_aliases
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Rcfiles::DirectoryAliases.initialize_main_hash
+  pp Rcfiles::DirectoryAliases.n_entries?
+  # Rcfiles::DirectoryAliases.save_into_ruby_file
+end

data/lib/rcfiles/directory_aliases/yaml_file_used_by_class_directory_aliases.rb

@@ -0,0 +1,67 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Rcfiles::DirectoryAliases
+# =========================================================================== #
+# require 'rcfiles/directory_aliases/yaml_file_used_by_class_directory_aliases.rb'
+# =========================================================================== #
+module Rcfiles
+
+class DirectoryAliases # === Rcfiles::DirectoryAliases
+
+  require 'rcfiles/files/file_cd_aliases.rb'
+
+  # ========================================================================= #
+  # === @yaml_file_used_by_class_directory_aliases
+  #
+  # This variable will keep track of the main yaml file, that is, the
+  # file that holds the dataset for "cd-aliases".
+  #
+  # It is nil initially here, but will be changed lateron through a method
+  # call.
+  # ========================================================================= #
+  @yaml_file_used_by_class_directory_aliases = nil
+
+  # ========================================================================= #
+  # === Rcfiles::DirectoryAliases.set_yaml_file_used_by_class_directory_aliases
+  #
+  # The user can modify which yaml file is to be used, via this method call.
+  # ========================================================================= #
+  def self.set_yaml_file_used_by_class_directory_aliases(
+      i = :default
+    )
+    case i
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default,
+         :default_yaml_file
+      i = ::Rcfiles.file_cd_aliases
+    end
+    @yaml_file_used_by_class_directory_aliases = i
+  end
+
+  # ========================================================================= #
+  # Define the main cd-aliases file next. The constant FILE_CD_ALIASES
+  # must be defined for this to work.
+  # ========================================================================= #
+  DirectoryAliases.set_yaml_file_used_by_class_directory_aliases(:default_yaml_file)
+
+  # ========================================================================= #
+  # === Rcfiles::DirectoryAliases.yaml_file?
+  #
+  # On my home system this defaults to:
+  #
+  #   /usr/lib/ruby/site_ruby/3.1.0/rcfiles/yaml/cd_aliases.yml
+  #
+  # ========================================================================= #
+  def self.yaml_file?
+    @yaml_file_used_by_class_directory_aliases
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Rcfiles::DirectoryAliases.yaml_file?
+end

data/lib/rcfiles/files/file_aliases.rb

@@ -0,0 +1,78 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/files/file_aliases.rb'
+# =========================================================================== #
+module Rcfiles
+
+  require 'rcfiles/project/project.rb'
+  require 'rcfiles/toplevel_methods/is_on_roebe.rb'
+  require 'rcfiles/toplevel_methods/convert.rb'
+  require 'rcfiles/toplevel_methods/notifications.rb'
+
+  # ========================================================================= #
+  # === Rcfiles.set_file_aliases
+  # ========================================================================= #
+  def self.set_file_aliases(
+      i = :default
+    )
+    case i
+    when :default, nil
+      if is_on_roebe? and File.exist?('/Depot/aliases.yml')
+        i = '/Depot/aliases.yml'
+      else
+        i = "#{project_yaml_dir?}aliases.yml"
+      end
+    end
+    @file_aliases = i
+  end
+
+  # ========================================================================= #
+  # === @file_aliases
+  #
+  # On my home system, the value of the toplevel @file_aliases instance
+  # variable points to a file path such as:
+  #
+  #   /Programs/Ruby/2.5.0/lib/ruby/site_ruby/2.5.0/rcfile_generator/yaml/aliases.yml
+  #
+  # It may also point to another target location, though.
+  # ========================================================================= #
+  @file_aliases = nil
+
+  # ========================================================================= #
+  # And set it at once.
+  # ========================================================================= #
+  set_file_aliases
+
+  # ========================================================================= #
+  # === Rcfiles.file_aliases?
+  # ========================================================================= #
+  def self.file_aliases?
+    @file_aliases
+  end; self.instance_eval { alias file_aliases file_aliases? } # === Rcfiles.file_aliases
+
+  # ========================================================================= #
+  # === Rcfiles.generate_aliases_rcfile
+  # ========================================================================= #
+  def self.generate_aliases_rcfile
+    _ = @file_aliases
+    if File.exist? _
+      into = "#{main_directory?}aliases_rc"
+      notify_the_user_that_this_file_will_be_generated_from_that_existing_file(into, _)
+      what = return_standard_header(into).dup
+      hash_dataset = YAML.load_file(_)
+      hash_dataset.each_pair {|key, value|
+        if @use_quotes
+          what << "alias '#{key}'=\"#{value}\"\n"
+        else
+          what << "alias #{key}=#{value}\n"
+        end
+      }
+      write_what_into(what, into)
+    else
+      no_file_exists_at(_)
+    end
+  end
+
+end

data/lib/rcfiles/files/file_cd_aliases.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/files/file_cd_aliases.rb'
+# Rcfiles.file_cd_aliases?
+# =========================================================================== #
+module Rcfiles
+
+  require 'rcfiles/project/project.rb'
+  require 'rcfiles/toplevel_methods/is_on_roebe.rb'
+  require 'rcfiles/toplevel_methods/convert.rb'
+  require 'rcfiles/toplevel_methods/notifications.rb'
+
+  # ========================================================================= #
+  # === Rcfiles.set_cd_aliases
+  # ========================================================================= #
+  def self.set_cd_aliases(
+      i = :default
+    )
+    case i
+    when :default, nil
+      if is_on_roebe? and File.exist?('/Depot/cd_aliases.yml')
+        i = '/Depot/cd_aliases.yml'
+      else
+        i = "#{project_yaml_dir?}cd_aliases.yml"
+      end
+    end
+    @file_cd_aliases = i
+  end
+
+  # ========================================================================= #
+  # === Rcfiles::@file_cd_aliases
+  # ========================================================================= #
+  @file_cd_aliases = nil
+
+  set_cd_aliases
+
+  # ========================================================================= #
+  # === Rcfiles.file_cd_aliases?
+  #
+  # This method will keep the location to the cd_aliases.yml file (or
+  # the substitute for it, if the user specified another cd_aliases.yml
+  # file).
+  # ========================================================================= #
+  def self.file_cd_aliases?
+    @file_cd_aliases
+  end; self.instance_eval { alias file_cd_aliases file_cd_aliases? } # === Rcfiles.file_cd_aliases
+       self.instance_eval { alias cd_aliases      file_cd_aliases? } # === Rcfiles.cd_aliases
+       self.instance_eval { alias cd_aliases?     file_cd_aliases? } # === Rcfiles.cd_aliases?
+
+  # ========================================================================= #
+  # === Rcfiles.generate_cd_aliases_rcfile
+  # ========================================================================= #
+  def self.generate_cd_aliases_rcfile(
+      be_verbose = ::Rcfiles.be_verbose?
+    )
+    _ = @file_cd_aliases
+    if File.exist? _
+      if block_given?
+        yielded = yield
+        if yielded.has_key? :be_verbose
+          be_verbose = yielded.delete(:be_verbose)
+        end
+      end
+      into = "#{main_directory?}cd_aliases_rc"
+      if be_verbose
+        notify_the_user_that_this_file_will_be_generated_from_that_existing_file(into, _)
+      end
+      what = return_standard_header(into).dup
+      hash_dataset = YAML.load_file(_)
+      hash_dataset.each_pair {|key, value|
+        if @use_quotes
+          what << "alias '#{key}'=\"#{value}\"\n"
+        else
+          what << "alias #{key}=#{value}\n"
+        end
+      }
+      write_what_into(what, into)
+    else
+      no_file_exists_at(_) if be_verbose
+    end
+  end
+
+end

data/lib/rcfiles/files/file_ls_colours.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/files/file_ls_colours.rb'
+# =========================================================================== #
+module Rcfiles
+
+  require 'rcfiles/project/project.rb'
+  require 'rcfiles/toplevel_methods/is_on_roebe.rb'
+  require 'rcfiles/toplevel_methods/convert.rb'
+  require 'rcfiles/toplevel_methods/notifications.rb'
+
+  # ========================================================================= #
+  # === Rcfiles.set_file_ls_colours
+  # ========================================================================= #
+  def self.set_file_ls_colours(
+      i = :default
+    )
+    case i
+    when :default, nil
+      if is_on_roebe? and File.exist?('/Depot/ls_colours.yml')
+        i = '/Depot/ls_colours.yml'
+      else
+        i = "#{project_yaml_dir?}ls_colours.yml"
+      end
+    end
+    @file_ls_colours = i
+  end
+
+  # ========================================================================= #
+  # === @file_ls_colours
+  #
+  # On my home system, the value of the toplevel @file_ls_colours instance
+  # variable points to a file path such as:
+  #
+  #   /Programs/Ruby/2.5.0/lib/ruby/site_ruby/2.5.0/rcfile_generator/yaml/ls_colours.yml
+  #
+  # It may also point to another target location, though.
+  # ========================================================================= #
+  @file_ls_colours = nil
+
+  # ========================================================================= #
+  # And set it at once.
+  # ========================================================================= #
+  set_file_ls_colours
+
+  # ========================================================================= #
+  # === Rcfiles.file_ls_colours?
+  # ========================================================================= #
+  def self.file_ls_colours?
+    @file_ls_colours
+  end; self.instance_eval { alias file_ls_colours file_ls_colours? } # === Rcfiles.file_ls_colours
+
+  # ========================================================================= #
+  # === Rcfiles.generate_ls_colours_rcfile
+  # ========================================================================= #
+  def self.generate_ls_colours_rcfile
+    _ = @file_ls_colours
+    if File.exist? _
+      into = "#{main_directory?}ls_colours_rc"
+      notify_the_user_that_this_file_will_be_generated_from_that_existing_file(into, _)
+      hash = YAML.load_file(_)
+      dataset = hash.map {|key, value| "#{key}=#{value}"}.join(':')
+      # ^^^ dataset is now a String past this point.
+      what = return_standard_header(into).dup
+      what << convert_this_input_to_export_file(
+        dataset, 'LS_COLORS'
+      )
+      write_what_into(what, into)
+    else
+      no_file_exists_at(_)
+    end
+  end
+
+end

data/lib/rcfiles/files/file_path_variable.rb

@@ -0,0 +1,74 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/files/file_path_variable.rb'
+# =========================================================================== #
+module Rcfiles
+
+  require 'rcfiles/project/project.rb'
+  require 'rcfiles/toplevel_methods/is_on_roebe.rb'
+  require 'rcfiles/toplevel_methods/convert.rb'
+  require 'rcfiles/toplevel_methods/notifications.rb'
+
+  # ========================================================================= #
+  # === Rcfiles.set_file_path_variable
+  # ========================================================================= #
+  def self.set_file_path_variable(
+      i = :default
+    )
+    case i
+    when :default, nil
+      if is_on_roebe? and File.exist?('/Depot/path_variable.yml')
+        i = '/Depot/path_variable.yml'
+      else
+        i = "#{project_yaml_dir?}path_variable.yml"
+      end
+    end
+    @file_path_variable = i
+  end
+
+  # ========================================================================= #
+  # === @file_path_variable
+  #
+  # On my home system, the value of the toplevel @file_path_variable instance
+  # variable points to a file path such as:
+  #
+  #   /Programs/Ruby/2.5.0/lib/ruby/site_ruby/2.5.0/rcfile_generator/yaml/path_variable.yml
+  #
+  # It may also point to another target location, though.
+  # ========================================================================= #
+  @file_path_variable = nil
+
+  # ========================================================================= #
+  # And set it at once.
+  # ========================================================================= #
+  set_file_path_variable
+
+  # ========================================================================= #
+  # === Rcfiles.file_path_variable?
+  # ========================================================================= #
+  def self.file_path_variable?
+    @file_path_variable
+  end; self.instance_eval { alias file_path_variable file_path_variable? } # === Rcfiles.file_path_variable
+
+  # ========================================================================= #
+  # === Rcfiles.generate_path_variable_rcfile
+  # ========================================================================= #
+  def self.generate_path_variable_rcfile
+    _ = @file_path_variable
+    if File.exist? _
+      into = "#{main_directory?}path_variable_rc"
+      notify_the_user_that_this_file_will_be_generated_from_that_existing_file(into, _)
+      dataset = YAML.load_file(_)
+      what = return_standard_header(into).dup
+      what << convert_this_input_to_export_file(
+        dataset, 'PATH'
+      )
+      write_what_into(what, into)
+    else
+      no_file_exists_at(_)
+    end
+  end
+
+end

data/lib/rcfiles/files/file_pkgconfig.rb

@@ -0,0 +1,74 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/files/file_pkgconfig.rb'
+# =========================================================================== #
+module Rcfiles
+
+  require 'rcfiles/project/project.rb'
+  require 'rcfiles/toplevel_methods/is_on_roebe.rb'
+  require 'rcfiles/toplevel_methods/convert.rb'
+  require 'rcfiles/toplevel_methods/notifications.rb'
+
+  # ========================================================================= #
+  # === Rcfiles.set_file_pkgconfig
+  # ========================================================================= #
+  def self.set_file_pkgconfig(
+      i = :default
+    )
+    case i
+    when :default, nil
+      if is_on_roebe? and File.exist?('/Depot/pkgconfig.yml')
+        i = '/Depot/pkgconfig.yml'
+      else
+        i = "#{project_yaml_dir?}pkgconfig.yml"
+      end
+    end
+    @file_pkgconfig = i
+  end
+
+  # ========================================================================= #
+  # === @file_pkgconfig
+  #
+  # On my home system, the value of the toplevel @file_pkgconfig instance
+  # variable points to a file path such as:
+  #
+  #   /Programs/Ruby/2.5.0/lib/ruby/site_ruby/2.5.0/rcfile_generator/yaml/pkgconfig.yml
+  #
+  # It may also point to another target location, though.
+  # ========================================================================= #
+  @file_pkgconfig = nil
+
+  # ========================================================================= #
+  # === Rcfiles.file_pkgconfig?
+  # ========================================================================= #
+  def self.file_pkgconfig?
+    @file_pkgconfig
+  end; self.instance_eval { alias file_pkgconfig file_pkgconfig? } # === Rcfiles.file_pkgconfig
+
+  # ========================================================================= #
+  # And set it at once.
+  # ========================================================================= #
+  set_file_pkgconfig
+
+  # ========================================================================= #
+  # === Rcfiles.generate_pkgconfig_rcfile
+  # ========================================================================= #
+  def self.generate_pkgconfig_rcfile
+    _ = @file_pkgconfig
+    if File.exist? _
+      into = "#{main_directory?}pkgconfig_rc"
+      notify_the_user_that_this_file_will_be_generated_from_that_existing_file(into, _)
+      dataset = YAML.load_file(_)['pkg_config_path']
+      what = return_standard_header(into).dup
+      what << convert_this_input_to_export_file(
+        dataset, 'PKG_CONFIG_PATH'
+      )
+      write_what_into(what, into)
+    else
+      no_file_exists_at(_)
+    end
+  end
+
+end