rcfiles 1.3.47

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

data/lib/rcfiles/files/file_programs_aliases.rb

@@ -0,0 +1,68 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/files/file_programs_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_programs_aliases
+  # ========================================================================= #
+  def self.set_programs_aliases(
+      i = :default
+    )
+    case i
+    when :default, nil
+      if is_on_roebe? and File.exist?('/Depot/programs_aliases.yml')
+        i = '/Depot/programs_aliases.yml'
+      else
+        i = "#{project_yaml_dir?}programs_aliases.yml"
+      end
+    end
+    @file_programs_aliases = i
+  end
+
+  # ========================================================================= #
+  # === Rcfiles::@file_programs_aliases
+  # ========================================================================= #
+  @file_programs_aliases = nil
+
+  set_programs_aliases
+
+  # ========================================================================= #
+  # === Rcfiles.file_programs_aliases?
+  # ========================================================================= #
+  def self.file_programs_aliases?
+    @file_programs_aliases
+  end; self.instance_eval { alias file_programs_aliases file_programs_aliases? } # === Rcfiles.file_programs_aliases
+
+  # ========================================================================= #
+  # === Rcfiles.generate_programs_aliases_rcfile
+  # ========================================================================= #
+  def self.generate_programs_aliases_rcfile
+    _ = @file_programs_aliases
+    if File.exist? _
+      into = "#{main_directory?}programs_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_ps1.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/files/file_ps1.rb'
+# Rcfiles.generate_ps1_rcfile
+# =========================================================================== #
+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'
+  require 'rcfiles/files/file_path_variable.rb'
+
+  # ========================================================================= #
+  # === Rcfiles.set_file_ps1
+  # ========================================================================= #
+  def self.set_file_ps1(
+      i = :default
+    )
+    case i
+    when :default, nil
+      if is_on_roebe? and File.exist?('/Depot/ps1.yml')
+        i = '/Depot/ps1.yml'
+      else
+        i = "#{project_yaml_dir?}ps1.yml"
+      end
+    end
+    @file_ps1 = i
+  end
+
+  # ========================================================================= #
+  # === @file_ps1
+  #
+  # On my home system, the value of the toplevel @file_ps1 instance
+  # variable points to a file path such as:
+  #
+  #   /Programs/Ruby/2.5.0/lib/ruby/site_ruby/2.5.0/rcfile_generator/yaml/ps1.yml
+  #
+  # It may also point to another target location, though.
+  # ========================================================================= #
+  @file_ps1 = nil
+
+  # ========================================================================= #
+  # === Rcfiles.file_ps1?
+  # ========================================================================= #
+  def self.file_ps1?
+    @file_ps1
+  end; self.instance_eval { alias file_ps1 file_path_variable? } # === Rcfiles.file_ps1
+
+  # ========================================================================= #
+  # And set it at once.
+  # ========================================================================= #
+  set_file_ps1
+
+  # ========================================================================= #
+  # === Rcfiles.generate_ps1_rcfile
+  # ========================================================================= #
+  def self.generate_ps1_rcfile
+    _ = @file_ps1
+    if File.exist? _
+      into = "#{main_directory?}ps1_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_hash_to_export_file(
+        dataset
+      )
+      write_what_into(what, into)
+    else
+      no_file_exists_at(_)
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Rcfiles.generate_ps1_rcfile  
+end

data/lib/rcfiles/files/file_system_settings.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/files/file_system_settings.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_system_settings
+  #
+  # On my home system the file system_settings.yml can be found here:
+  #
+  #   $RUBY_SRC/rcfiles/lib/rcfiles/yaml/system_settings.yml
+  #
+  # ========================================================================= #
+  def self.set_system_settings(
+      i = :default
+    )
+    case i
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default,
+         nil
+      if is_on_roebe? and File.exist?('/Depot/system_settings.yml')
+        i = '/Depot/system_settings.yml'
+      else
+        i = "#{project_yaml_dir?}system_settings.yml"
+      end
+    end
+    @file_system_settings = i.to_s
+  end
+
+  # ========================================================================= #
+  # === Rcfiles::@file_system_settings
+  # ========================================================================= #
+  @file_system_settings = nil
+
+  set_system_settings
+
+  # ========================================================================= #
+  # === Rcfiles.file_system_settings?
+  # ========================================================================= #
+  def self.file_system_settings?
+    @file_system_settings
+  end; self.instance_eval { alias file_system_settings file_system_settings? } # === Rcfiles.file_system_settings
+       self.instance_eval { alias system_settings      file_system_settings? } # === Rcfiles.system_settings
+       self.instance_eval { alias system_settings?     file_system_settings? } # === Rcfiles.system_settings?
+
+  # ========================================================================= #
+  # === Rcfiles.generate_system_settings_rcfile
+  # ========================================================================= #
+  def self.generate_system_settings_rcfile
+    _ = @file_system_settings
+    if File.exist? _
+      into = "#{main_directory?}system_settings_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|
+        what << "export #{key}=\"#{value}\"\n"
+      } if hash_dataset
+      write_what_into(what, into)
+    else
+      no_file_exists_at(_)
+    end
+  end
+
+end

data/lib/rcfiles/help/help.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/help/help.rb'
+# =========================================================================== #
+require 'rcfiles/colours/colours.rb'
+require 'rcfiles/toplevel_methods/e.rb'
+
+module Rcfiles
+
+  # ========================================================================= #
+  # === Rcfiles.show_help                                          (help tag)
+  #
+  # To invoke this help method, do this:
+  #
+  #   rcfiles --help
+  #
+  # ========================================================================= #
+  def self.show_help
+    result = <<EOF
+
+#{rev}The following options are available for the #{steelblue('Rcfiles namespace')}:
+
+  #{lightgreen('--directory?')}           # display which directory will be used to 
+                         # keep the generated rc-files
+  #{lightgreen('--set or --directory')}   # generate the rc-files into this directory
+  #{lightgreen('--no-quotes')}            # generate the files without any "" quotes
+  #{lightgreen('--utf8')}                 # generate UTF8-conforming yaml files
+  #{lightgreen('--copy-rcfiles')}         # copies the rcfiles into the current working directory
+                         # (note that --copy or just --cp would also work)
+  #{lightgreen('--windows-cd-aliases')}   # create a .bat file for the cd-aliases on the 
+                         # windows platform
+  #{lightgreen('--sitelibdir')}           # show where the sitelibdir is located
+  #{lightgreen('--n_aliases?')}           # return how many aliases are registered in the
+                         # rcfiles project
+
+Note that if you do not pass any options then the rc-files will
+be generated into the default directory.
+
+If you pass a .yml file as input, then we will generate rc-files
+based on the entries found within that yaml file.
+
+EOF
+    e result
+  end
+
+end

data/lib/rcfiles/no_colours.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file can be used to require the namespace Rcfiles, with colours
+# support already having been disabled.
+# =========================================================================== #
+# require 'rcfiles/no_colours.rb'
+# require 'rcfiles/no_colours.rb'; Rcfiles.run
+# =========================================================================== #
+require 'rcfiles/requires/require_the_rcfiles_project.rb'
+
+Rcfiles.no_colours