rcfiles 1.2.150

data/lib/rcfiles/commandline/commandline.rb

@@ -0,0 +1,187 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Rcfiles.parse_commandline
+#
+# The code in this file here handles commandline-arguments. 
+#
+# Usage example:
+#
+#   Rcfiles.parse_commandline(ARGV)
+#
+# =========================================================================== #
+# require 'rcfiles/commandline/commandline.rb'
+# =========================================================================== #
+module Rcfiles
+
+  require 'rcfiles/help/help.rb'
+  require 'rcfiles/toplevel_methods/main_directory.rb'
+  require 'rcfiles/toplevel_methods/misc.rb'
+  require 'rcfiles/toplevel_methods/use_quotes.rb'
+  require 'rcfiles/toplevel_methods/create_windows_cd_aliases_bat_file.rb'
+
+  begin
+    require 'opn'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === Rcfiles.parse_commandline
+  # ========================================================================= #
+  def self.parse_commandline(
+      i = ARGV
+    )
+    if i.is_a? Array
+      if i.empty?
+        run_default_action
+      elsif i.join(' ').include?('set ')
+        i =~ /^-?-?set (.+)$/
+        set_store_into_this_directory($1.to_s.dup)
+      else
+        i.each {|entry| parse_commandline(entry)}
+      end
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === rcfiles --sitelibdir
+      # ===================================================================== #
+      when /^-?-?sitelibdir$/
+        require 'rbconfig'
+        e 'The sitelibdir can be found at:'
+        e
+        e "  #{RbConfig::CONFIG['sitelibdir']}"
+        e
+        exit
+      # ===================================================================== #
+      # === rcfiles --help
+      # ===================================================================== #
+      when /help$/
+        show_help
+      # ===================================================================== #
+      # === rcfiles --aggregate
+      # ===================================================================== #
+      when /^-?-?aggregate$/
+        require 'rcfiles/aggregate_all_rcfiles/aggregate_all_rcfiles.rb'
+        ::Rcfiles::AggregateAllRcfiles.new
+        exit
+      # ===================================================================== #
+      # === rcfiles --windows-cd-aliases
+      # ===================================================================== #
+      when /^-?-?windows(-|_)?cd(-|_)?aliases$/
+        create_windows_cd_aliases_bat_file
+      # ===================================================================== #
+      # === rcfiles --set foobar
+      #
+      # or
+      #
+      #    rcfiles --populate-this-dir=/Depot/Chroot/AUTOGENERATED/
+      #
+      # ===================================================================== #
+      when /^-?-?set (.+)$/,
+           /^-?-?populate-this-dir=(.+)$/
+        set_store_into_this_directory($1.to_s.dup)
+      # ===================================================================== #
+      # === rcfiles --copy-rcfiles
+      # === rcfiles --copy
+      # === rcfiles --cp
+      # ===================================================================== #
+      when /^-?-?copy(-|_)?rcfiles$/i,
+           /^-?-?copy$/i,
+           /^-?-?cp$/i
+        copy_the_rcfiles
+      # ===================================================================== #
+      # === rcfiles --n_aliases?
+      # ===================================================================== #
+      when /^-?-?n(-|_)?aliases\??$/i,
+           /^-?-?n(-|_)?entries\??$/i
+        show_how_many_aliases_are_registered_in_this_project_in_total
+      # ===================================================================== #
+      # === rcfiles --aliases
+      # ===================================================================== #
+      when /^-?-?aliases$/i
+        require 'rcfiles/files/file_aliases.rb'
+        generate_aliases_rcfile
+      # ===================================================================== #
+      # === rcfiles --programs-aliases
+      # ===================================================================== #
+      when /^-?-?programs(_|-)?aliases$/i
+        require 'rcfiles/files/file_programs_aliases.rb'
+        generate_programs_aliases_rcfile
+      # ===================================================================== #
+      # === rcfiles --ps1
+      # ===================================================================== #
+      when /^-?-?ps1$/i
+        require 'rcfiles/files/file_ps1.rb'
+        generate_ps1_rcfile
+      # ===================================================================== #
+      # === rcfiles --report
+      # ===================================================================== #
+      when /^-?-?report$/i
+        ::Rcfiles.report
+      # ===================================================================== #
+      # === rcfiles --utf8
+      # ===================================================================== #
+      when /^-?-?utf8$/
+        opn(namespace: 'Rcfiles')
+        e 'Will generate Unicode-conforming (UTF8) yaml files.'
+        set_use_this_encoding(:utf8)
+        generate_yaml_files
+      # ===================================================================== #
+      # === rcfiles --no-quotes
+      # ===================================================================== #
+      when /^-?-?no(-|_)?quotes$/
+        disable_quotes_then_generate_the_files
+      # ===================================================================== #
+      # === rcfiles --directory?
+      # ===================================================================== #
+      when /^-?-?directory\??$/ # yrcfile --directory?
+        e sdir(CREATE_RCFILES_WHERE)
+      # ===================================================================== #
+      # === rcfiles --cmder-target
+      # ===================================================================== #
+      when /^-?-?cmder(-|_)?target$/i,
+           /^-?-?cmder$/,
+           /^-?-?cmd$/
+        opn; e 'Generating cmder-conforming rc-files next.'
+        disable_quotes_then_generate_the_files
+      else # This is the default.
+        # =================================================================== #
+        # First, handle directly passing existing yaml files into the
+        # rcfiles project here.
+        #
+        # Usage example:
+        #
+        #   rcfiles cd_aliases.yml
+        #
+        # =================================================================== #
+        if File.exist?(i) and
+          (File.extname(i).delete('.') == 'yml')
+          autogenerate_rc_file_from_this_yaml_file(i)
+        # =================================================================== #
+        # Else, autogenerate all the various rc-files.
+        # =================================================================== #
+        else
+          run_default_action # === rcfiles
+        end
+      end
+    end
+  end; self.instance_eval { alias menu               parse_commandline } # === Rcfiles.menu
+       self.instance_eval { alias handle_commandline parse_commandline } # === Rcfiles.handle_commandline 
+
+  # ========================================================================= #
+  # === Rcfiles.show_how_many_aliases_are_registered_in_this_project_in_total
+  #
+  # To run this method, try:
+  #
+  #   rcfiles --n_aliases?
+  #
+  # ========================================================================= #
+  def self.show_how_many_aliases_are_registered_in_this_project_in_total
+    n_aliases = 0
+    n_aliases += YAML.load_file(file_aliases?).keys.size
+    n_aliases += YAML.load_file(file_cd_aliases?).keys.size
+    n_aliases += YAML.load_file(file_programs_aliases?).keys.size
+    e "#{n_aliases} aliases are available in this project."
+  end
+
+end

data/lib/rcfiles/constants/constants.rb

@@ -0,0 +1,253 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file contains a few encoding-specific constants as well. That way
+# we can quickly change the main encoding for the rcfiles-gem.
+#
+# This file here also contains some constants that are only useful on my
+# home system, e. g. for my home directory, aka when IS_ROEBE is set to
+# 1 (true).
+#
+# One goal of the rcfiles project is to auto-generate my various
+# shell-rc files, which is why the file here has been added. For other
+# uses this file is evidently not too terribly useful, so it will not
+# be used on these other systems.
+# =========================================================================== #
+# require 'rcfiles/constants/constants.rb'
+# Rcfiles.ensure_main_encoding
+# =========================================================================== #
+module Rcfiles
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  require 'rcfiles/project/project.rb'
+
+  begin
+    require 'roebe/project/project.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === HASH_CUSTOM_FILES
+  #
+  # The following Hash has two important entries:
+  #
+  #   (1) The file path where the file exists locally
+  #   (2) How to generate the rc-file at hand, e. g. if it is a file
+  #       with aliases (then the key :aliases should be used), or
+  #       whether it is a file that makes use of export-statements
+  #       (then :export should be used as second value).
+  #
+  # Do note that the first entry, aka file path, does not necessarily
+  # have to be the full path per se. Code has been added to allow
+  # me to just give the name, and let ruby search for the local
+  # file at hand instead.
+  # ========================================================================= #
+  HASH_CUSTOM_FILES = {
+    # ======================================================================= #
+    # Not sure if roeberia should be included. Guess it would have to
+    # be changed before it can be included, so it was removed on 10.04.2019
+    # 'roeberia_settings.yml'                      => :export,
+    # ======================================================================= #
+    # 'special_aliases.yml'                             => :aliases,
+    # ^^^ this was merged back on 04.07.2021 so it is no longer needed here.
+    # 'german_umlaute.yml'                           => :aliases,
+    # ^^^ this was merged back on 24.06.2021 because now unicode works
+    #     properly.
+    # 'colours.yml'                                => :aliases,
+    # ^^^ colours.yml is dysfunct since 2018 or so - I am not sure if
+    # it will make a comeback.
+    Roebe.project_yaml_directory?+'file_information.yml' => :export,
+    Roebe.project_yaml_directory?+'gnome/gnome.yml'      => :export,
+    Roebe.project_yaml_directory?+'kde/kde.yml'          => :export,
+    Roebe.project_yaml_directory?+'kernel/kernel.yml'    => :export,
+    Roebe.project_yaml_directory?+'system/system.yml'    => :export,
+    Roebe.project_yaml_directory?+'compile/compile.yml'  => :export,
+    '/home/x/data/personal/yaml/network/network.yml'     => :export,
+    '/home/x/programming/ruby/src/multimedia_paradise/lib/multimedia_paradise/yaml/video/video.yml' => :export,
+    # ======================================================================= #
+    # Next, entries under individual_environment_variables/
+    # ======================================================================= #
+    Roebe.project_yaml_directory?+'individual_environment_variables/ldflags.yml'    => :export,
+    Roebe.project_yaml_directory?+'individual_environment_variables/cflags.yml'     => :export,
+    Roebe.project_yaml_directory?+'individual_environment_variables/lang.yml'       => :export,
+    Roebe.project_yaml_directory?+'individual_environment_variables/term.yml'       => :export
+  } if Object.const_defined?(:Roebe)
+
+  # ========================================================================= #
+  # The following .yml file is special:
+  #   directory_layout.yml
+  # ========================================================================= #
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n"
+
+  # ========================================================================= #
+  # === HOME_DIR
+  # ========================================================================= #
+  HOME_DIR = '/home/'
+
+  # ========================================================================= #
+  # === DIRECTORY_CONTAINING_THE_RC_FILES_ON_MY_HOME_SYSTEM
+  #
+  # This constant is obviously not so useful for other people - it is
+  # for my home system only. The target is, in that case, hardcoded.
+  # ========================================================================= #
+  DIRECTORY_CONTAINING_THE_RC_FILES_ON_MY_HOME_SYSTEM =
+    "#{HOME_DIR}x/DATA/PC/OS/LINUX/yaml/"
+
+  # ========================================================================= #
+  # === LINUX_YAML_BASE_DIRECTORY
+  #
+  # Simply point to the environment variable $LINUX_YAML.
+  #
+  #   cd $LINUX_YAML
+  #
+  # ========================================================================= #
+  if ENV['LINUX_YAML']
+    LINUX_YAML_BASE_DIRECTORY = "#{ENV['LINUX_YAML']}/"
+  else
+    LINUX_YAML_BASE_DIRECTORY = DIRECTORY_CONTAINING_THE_RC_FILES_ON_MY_HOME_SYSTEM
+  end
+
+  # ========================================================================= #
+  # === Rcfiles::FILE_STORE_INTO_THIS_DIRECTORY
+  # ========================================================================= #
+  FILE_STORE_INTO_THIS_DIRECTORY =
+    "#{project_yaml_dir?}store_into_this_directory.yml"
+
+  # ========================================================================= #
+  # === CREATE_RCFILES_WHERE
+  #
+  # Where to put the RC files by default. Must be a directory. But,
+  # we must first check whether the file exists.
+  # ========================================================================= #
+  _ = FILE_STORE_INTO_THIS_DIRECTORY
+  if File.exist? _
+    # ======================================================================= #
+    # This clause is the default one.
+    # ======================================================================= #
+    CREATE_RCFILES_WHERE = File.read(_).strip # '/AUTOGENERATED/'
+  else
+    # ======================================================================= #
+    # This one is just a rescued-variant defaulting to the home directory
+    # as base-directory.
+    # ======================================================================= #
+    CREATE_RCFILES_WHERE = File.expand_path('~/AUTOGENERATED/')
+  end
+
+  # ========================================================================= #
+  # === RUBY_SRC_DIR_AT_HOME
+  # ========================================================================= #
+  RUBY_SRC_DIR_AT_HOME =
+    "#{HOME_DIR}x/programming/ruby/src/"
+
+  # ========================================================================= #
+  # === UTF_ENCODING
+  # ========================================================================= #
+  UTF_ENCODING = 'utf-8'
+    UTF8_ENCODING = UTF_ENCODING # === UTF8_ENCODING
+
+  # ========================================================================= #
+  # === ISO_ENCODING
+  # ========================================================================= #
+  ISO_ENCODING = 'ISO-8859-1'
+    ENCODING_ISO = ISO_ENCODING # === ENCODING_ISO
+
+  # ========================================================================= #
+  # === MAIN_ENCODING_TO_USE
+  #
+  # This constant is very important - it denotes which is the main
+  # encoding for the rcfiles-project.
+  # ========================================================================= #
+  MAIN_ENCODING_TO_USE = UTF_ENCODING # === MAIN_ENCODING_TO_USE
+  USE_THIS_ENCODING    = UTF_ENCODING # === USE_THIS_ENCODING
+ 
+  # ========================================================================= #
+  # === Rcfiles.set_use_this_encoding
+  #
+  # This toplevel-method can be used to assign to another encoding
+  # set that is to be used.
+  # ========================================================================= #
+  def self.set_use_this_encoding(
+      i = MAIN_ENCODING_TO_USE
+    )
+    case i
+    when :default
+      i = MAIN_ENCODING_TO_USE
+    when :utf, :utf8
+      i = UTF8_ENCODING
+    end
+    @use_this_encoding = i
+  end
+
+  # ========================================================================= #
+  # Initialize it to the default.
+  # ========================================================================= #
+  set_use_this_encoding(:default)
+
+  # ========================================================================= #
+  # === Rcfiles.use_this_encoding?
+  # ========================================================================= #
+  def self.use_this_encoding?
+    @use_this_encoding
+  end; self.instance_eval { alias use_this_encoding use_this_encoding? } # === Rcfiles.use_this_encoding
+       self.instance_eval { alias main_encoding?    use_this_encoding? } # === Rcfiles.main_encoding?
+
+  # ========================================================================= #
+  # === Rcfiles.ensure_main_encoding
+  #
+  # The second argument to this method specifies which encoding we will
+  # use by default.
+  # ========================================================================= #
+  def self.ensure_main_encoding(
+      i,
+      use_this_encoding = @use_this_encoding
+    )
+    i = i.dup if i.frozen?
+    case use_this_encoding
+    when :utf,
+         :utf8
+      use_this_encoding = UTF8_ENCODING
+    end
+    i = i.dup if i.frozen?
+    i.force_encoding(use_this_encoding) # Return this value here.
+  end; self.instance_eval { alias ensure_proper_encoding_for ensure_main_encoding } # === Rcfiles.ensure_proper_encoding_for
+
+  # ========================================================================= #
+  # === FILE_ROEBERIA_SETTINGS
+  #
+  # The next constant is only useful on my home setup:
+  # ========================================================================= #
+  FILE_ROEBERIA_SETTINGS =
+    "/home/x/data/personal/yaml/roeberia_settings.yml"
+
+  # ========================================================================= #
+  # === Rcfiles.file_global_variables
+  #
+  # On my home system, in May 2022, this method yielded the following
+  # String:
+  #
+  #   /usr/lib/ruby/site_ruby/3.1.0/rcfiles/yaml/global_variables/global_variables_extracted_from_the_file_cd_aliases.yml
+  #
+  # ========================================================================= #
+  def self.file_global_variables
+    "#{project_yaml_directory?}"\
+    "global_variables/global_variables_extracted_from_the_file_cd_aliases.yml"
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  e '='*80
+  p Rcfiles.constants.sort
+  e '='*80
+  pp Rcfiles::HASH_CUSTOM_FILES
+  e '='*80
+end

data/lib/rcfiles/directory_aliases/README.md

@@ -0,0 +1,2 @@
+This class was created on the 03.05.2022, as replacement to
+the old (and "aging") class called ExpandCdAliases.