rcfiles 1.2.46

data/lib/rcfiles/toplevel_methods/misc.rb

@@ -0,0 +1,341 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/misc.rb'
+# =========================================================================== #
+module Rcfiles
+
+  require 'fileutils'
+  require 'rcfiles/project/project.rb'
+  require 'rcfiles/files/file_aliases.rb'
+  require 'rcfiles/files/file_cd_aliases.rb'
+  require 'rcfiles/files/file_programs_aliases.rb'
+  require 'rcfiles/files/file_system_settings.rb'
+  require 'rcfiles/files/file_pkgconfig.rb'
+  require 'rcfiles/files/file_ls_colours.rb'
+  require 'rcfiles/files/file_path_variable.rb'
+  require 'rcfiles/files/file_ps1.rb'
+  require 'rcfiles/constants/constants.rb'
+  # ========================================================================= #
+  # Add the colours next:
+  # ========================================================================= #
+  require 'rcfiles/colours/colours.rb'
+
+  # ========================================================================= #
+  # Next, require the toplevel-methods of the rcfiles project:
+  # ========================================================================= #
+  require 'rcfiles/toplevel_methods/change_directory.rb'
+  require 'rcfiles/toplevel_methods/convert.rb'
+  require 'rcfiles/toplevel_methods/e.rb'
+  require 'rcfiles/toplevel_methods/is_on_roebe.rb'
+  require 'rcfiles/toplevel_methods/main_directory.rb'
+  require 'rcfiles/toplevel_methods/no_file_exists_at.rb'
+  require 'rcfiles/toplevel_methods/return_standard_header.rb'
+  require 'rcfiles/toplevel_methods/verbosity.rb'
+
+  # ========================================================================= #
+  # === Rcfiles::ARRAY_MAIN_ALIASES_FILE
+  # ========================================================================= #
+  ARRAY_MAIN_ALIASES_FILE = [
+    file_cd_aliases?,
+    file_aliases?,
+    file_programs_aliases?,
+    file_system_settings?
+  ]
+
+  # ========================================================================= #
+  # === Rcfiles.do_use_custom_rcfiles_home_directory_as_target
+  #
+  # This presently uses a hardcoded path.
+  #
+  # In the long run this method ought to become more flexible.
+  # ========================================================================= #
+  def self.do_use_custom_rcfiles_home_directory_as_target
+    @store_into_this_directory =
+      RUBY_SRC_DIR_AT_HOME+'rcfiles/lib/rcfiles/rcfiles/'
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.run_default_action
+  #
+  # If the argument to this method is true then we will also install
+  # the rcfiles project.
+  # ========================================================================= #
+  def self.run_default_action(
+      also_install_the_rcfiles_project = is_on_roebe?
+    ) 
+    # ======================================================================= #
+    # If we are on roebe then we will also run rinstall2 first.
+    # ======================================================================= #
+    if also_install_the_rcfiles_project
+      install_the_rcfiles_project
+    end
+    generate_the_most_important_rcfiles
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.generate_custom_roebe_rcfiles
+  #
+  # The following method is mostly useful only on my home system, as there
+  # are some .yml files that are not distributed with this project, mostly
+  # because other people will not really benefit from these custom 
+  # definitions, whereas they might benefit from e. g. the cd-aliases
+  # or shortcuts (aliased names) to programs, such as "gi" for "gimp"
+  # and so forth.
+  # ========================================================================= #
+  def self.generate_custom_roebe_rcfiles(
+      hash       = HASH_CUSTOM_FILES,
+      be_verbose = ::Rcfiles.be_verbose?
+    )
+    case be_verbose
+    when :be_quiet, :be_silent
+      be_verbose = false
+    end
+    if be_verbose
+      opn(namespace: NAMESPACE); e "Next generating #{teal('custom roebe rcfiles')}:"
+    end
+    hash.each_pair {|path_to_the_yaml_file, type_to_use|
+      unless File.exist? path_to_the_yaml_file
+        # =================================================================== #
+        # The file does not exist, but it may exist in the main directory
+        # where these .yml files are typically stored on my home system.
+        # =================================================================== #
+        target = "#{LINUX_YAML_BASE_DIRECTORY}#{path_to_the_yaml_file}"
+        if File.exist? target
+          path_to_the_yaml_file = target
+        end
+      end
+      # ===================================================================== #
+      # Now we can begin to autogenerate the new rc-file, if the file exists:
+      # ===================================================================== #
+      _ = path_to_the_yaml_file
+      if File.exist? _
+        require 'yaml'
+        require 'rcfiles/toplevel_methods/convert.rb'
+        case type_to_use
+        # =================================================================== #
+        # === :export
+        #
+        # Handle files that must use export= settings next.
+        # =================================================================== #
+        when :export
+          new_dataset = convert_this_hash_to_export_file(
+            YAML.load_file(path_to_the_yaml_file)
+          )
+        # =================================================================== #
+        # Handle files that must use alias settings next:
+        # =================================================================== #
+        when :aliases
+          new_dataset = convert_this_hash_to_alias_file(
+            YAML.load_file(path_to_the_yaml_file)
+          )
+        end
+        into = main_directory?+
+               File.basename(path_to_the_yaml_file).sub(/\.yml$/,'')+'_rc'
+        new_dataset.prepend(
+          standard_header?(into)
+        )
+        write_what_into(new_dataset, into)
+        if be_verbose
+          opn(namespace: NAMESPACE); e "Storing into the file `#{sfile(into)}`."
+        end
+      else
+        no_file_exists_at(_) if be_verbose
+      end
+    }
+    return hash.keys.map {|entry|
+      File.basename(entry).delete_suffix('.yml').to_sym
+    }
+  end
+
+  # ========================================================================= #
+  # === generate_the_main_rcfiles_without_the_custom_roebe_rcfiles
+  # ========================================================================= #
+  def self.generate_the_main_rcfiles_without_the_custom_roebe_rcfiles
+    generate_system_settings_rcfile
+    generate_cd_aliases_rcfile
+    generate_aliases_rcfile
+    generate_programs_aliases_rcfile
+    generate_pkgconfig_rcfile
+    generate_ls_colours_rcfile
+    generate_path_variable_rcfile
+    generate_ps1_rcfile
+    return [
+      :system_settings,
+      :cd_aliases,
+      :aliases,
+      :programs_aliases,
+      :pkgconfig,
+      :ls_colours,
+      :path_variable,
+      :ps1
+    ]
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.copy_rcfiles_to_the_current_directory
+  #
+  # This method can be used to quickly copy the rc-files into a
+  # (local) directory. It is especially important when some
+  # error prevents the user from being able to autogenerate
+  # these rc-files.
+  # ========================================================================= #
+  def self.copy_rcfiles_to_the_current_directory
+    target = "#{project_base_dir?}rcfiles/*rc"
+    e "Trying to copy the rc-files from #{sdir(target)}"
+    e 'into the current directory next:'
+    available_files = Dir[target]
+    available_files.each {|this_file|
+      if File.exist?(this_file) and
+         File.file?(this_file) and
+         this_file.end_with?('_rc')
+        target = (
+          Dir.pwd+'/'+File.basename(this_file)
+        ).squeeze '/'
+        e "Copying `#{sfile(this_file)}` to the current working directory next:"
+        FileUtils.cp(this_file, target)
+      end
+    }
+  end; self.instance_eval { alias copy_the_rcfiles copy_rcfiles_to_the_current_directory } # === Rcfiles.copy_the_rcfiles
+       self.instance_eval { alias copy_rcfiles     copy_rcfiles_to_the_current_directory } # === Rcfiles.copy_rcfiles
+
+  # =========================================================================== #
+  # === Rcfiles.aliases?
+  #
+  # This method will return all aliases, as a Hash.
+  # =========================================================================== #
+  def self.aliases?
+    hash = {}
+    _ = file_aliases?
+    if File.exist? _
+      hash.merge!(YAML.load_file(_))
+    end
+    _ = file_cd_aliases?
+    if File.exist? _
+      hash.merge!(YAML.load_file(_))
+    end
+    _ = file_programs_aliases?
+    if File.exist? _
+      hash.merge!(YAML.load_file(_))
+    end
+    return hash
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.install_the_rcfiles_project
+  #
+  # This method is evidently only useful on my home system.
+  # ========================================================================= #
+  def self.install_the_rcfiles_project
+    target = ENV['USERS'].to_s.dup
+    target = '/home' if target.nil? or target.empty?
+    cd target+'/x/programming/ruby/src/rcfiles/'
+    begin
+      require 'roebe/toplevel_methods/rinstall2.rb'
+      Roebe.rinstall2
+    rescue LoadError; end
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.generate_the_most_important_rcfiles
+  #
+  # Presently, the main rc-files are:
+  #
+  #   (1) cd-aliases rcfile
+  #   (2) aliases rcfile
+  #   (3) programs aliases rcfile
+  #   (4) system settings rcfile
+  #   (5) pkgconfig rcfile
+  #   (6) ls_colours rcfile
+  #   (7) path variable rcfile
+  #
+  # Keep in mind that the method may also be invoked in these ways:
+  #
+  #   Rcfiles.run { :disable_colours }
+  #   Rcfiles.run { :be_quiet }
+  #
+  # ========================================================================= #
+  def self.generate_the_most_important_rcfiles(
+      generate_which_files = :all,
+      &block
+    )
+    be_verbose = true
+    if block_given?
+      yielded = yield
+      case yielded
+      when :be_quiet
+        be_verbose = false
+        ::Rcfiles.set_be_verbose(false)
+      when :disable_colours
+        disable_colours
+      end
+    end
+    case generate_which_files
+    # ======================================================================= #
+    # === :all
+    # ======================================================================= #
+    when :all,
+         :default
+      array = generate_the_main_rcfiles_without_the_custom_roebe_rcfiles
+      if is_on_roebe?
+        # =================================================================== #
+        # Next generate roeberia on my home system:
+        # =================================================================== #
+        if is_on_roebe? and File.exist?(FILE_ROEBERIA_SETTINGS)
+          into = main_directory?+'roeberia_settings_rc'
+          if be_verbose
+            opn(namespace: NAMESPACE) 
+            e 'Also generating the rc-file from '+
+              sfile(FILE_ROEBERIA_SETTINGS)+' into `'+sfile(into)+'` next.'
+          end
+          what = convert_this_hash_to_export_file(
+            YAML.load_file(FILE_ROEBERIA_SETTINGS)
+          )
+          write_what_into(what, into)
+          array.insert(1, :roeberia_settings) # Must be at the second position.
+        end
+        # =================================================================== #
+        # The following subsection is entered only on "roebe-systems",
+        # aka my home-systems. Other users do not really need this
+        # subsection at all.
+        # =================================================================== #
+        array << generate_custom_roebe_rcfiles
+        array.flatten!
+        # =================================================================== #
+        # Next create a new master.sh file.
+        # =================================================================== #
+        into = ::Rcfiles.main_dir?+'source_all_the_rc_files.sh'
+        what = ''.dup
+        array.each {|entry|
+          what << "source "+::Rcfiles.main_dir?+"#{entry}_rc\n"
+        }
+        opn(namespace: NAMESPACE); e 'Storing into the file `'+sfile(into)+'`.'
+        write_what_into(what, into)
+        # =================================================================== #
+        # Designate another directory as the main target directory:
+        # =================================================================== #
+        do_use_custom_rcfiles_home_directory_as_target
+        generate_the_main_rcfiles_without_the_custom_roebe_rcfiles
+        generate_custom_roebe_rcfiles
+        @store_into_this_directory = nil
+      end
+    else
+      case generate_which_files
+      # ===================================================================== #
+      # === :cd_aliases
+      # ===================================================================== #
+      when :cd_aliases
+        generate_cd_aliases_rcfile(&block)
+      end
+    end
+  end; self.instance_eval { alias []             generate_the_most_important_rcfiles } # === Rcfiles[]
+       self.instance_eval { alias generate_files generate_the_most_important_rcfiles } # === Rcfiles.generate_files
+       self.instance_eval { alias run            generate_the_most_important_rcfiles } # === Rcfiles.run
+       self.instance_eval { alias new            generate_the_most_important_rcfiles } # === Rcfiles.new
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pp Rcfiles.aliases?.keys.size
+end

data/lib/rcfiles/toplevel_methods/n_registered_aliases_in_total.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/n_registered_aliases_in_total.rb'
+# Rcfiles.n_registered_aliases_in_total?
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/n_registered_aliases_in_total.rb'
+# =========================================================================== #
+require 'rcfiles/files/file_aliases.rb'
+require 'rcfiles/files/file_cd_aliases.rb'
+require 'rcfiles/files/file_programs_aliases.rb'
+
+module Rcfiles
+
+  # ========================================================================= #
+  # === Rcfiles.n_registered_aliases_in_total?
+  #
+  # This method will return, as a Number, how many aliases are registered
+  # in total in this project.
+  #
+  # We will only consider three files for the purpose of this method:
+  #
+  #   aliases.yml
+  #   cd_aliases.yml
+  #   programs_aliases.yml
+  #
+  # ========================================================================= #
+  def self.n_registered_aliases_in_total?
+    require 'yaml'
+    # ======================================================================= #
+    # We will store into the variable n_aliases how many entries are
+    # registered in total.
+    # ======================================================================= #
+    n_aliases = 0
+    _ = file_aliases?
+    if File.exist? _
+      n_aliases += YAML.load_file(_).keys.size # === aliases.yml
+    end
+    _ = file_cd_aliases?
+    if File.exist? _
+      n_aliases += YAML.load_file(_).keys.size # === cd_aliases.yml
+    end
+    _ = file_programs_aliases?
+    if File.exist? _
+      n_aliases += YAML.load_file(_).keys.size # === programs_aliases.yml
+    end
+    n_aliases
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Rcfiles.n_registered_aliases_in_total?
+end # n_registered_aliases_in_total

data/lib/rcfiles/toplevel_methods/no_file_exists_at.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/no_file_exists_at.rb'
+# =========================================================================== #
+require 'rcfiles/colours/colours.rb'
+require 'rcfiles/toplevel_methods/e.rb'
+
+module Rcfiles
+
+  # ========================================================================= #
+  # === Rcfiles.no_file_exists_at
+  # ========================================================================= #
+  def self.no_file_exists_at(i)
+    e "No file exists at `#{sfile(i)}`."
+  end
+
+end

data/lib/rcfiles/toplevel_methods/notifications.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The purpose of this file is to bundle code that can be used to notify
+# the user, for example, when a file is generated. Before this file was
+# created there was a lot of redundancy in different files; now we have
+# unified this under this new .rb file here (November 2019:
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/notifications.rb'
+# =========================================================================== #
+module Rcfiles
+
+  require 'yaml'
+
+  require 'rcfiles/colours/colours.rb'
+  require 'rcfiles/toplevel_methods/main_directory.rb'
+  require 'rcfiles/toplevel_methods/no_file_exists_at.rb'
+  require 'rcfiles/toplevel_methods/return_standard_header.rb'
+
+  # ========================================================================= #
+  # === Rcfiles.notify_the_user_that_this_file_will_be_generated_from_that_existing_file
+  #
+  # This method only notifies the user. It does not generate any file on
+  # its own.
+  # ========================================================================= #
+  def self.notify_the_user_that_this_file_will_be_generated_from_that_existing_file(
+      this_file,
+      that_existing_file
+    )
+    opn(namespace: NAMESPACE); e "#{rev}Now generating `#{sfile(this_file)}`, from "
+    opn(namespace: NAMESPACE); e "#{sfile(that_existing_file)}."
+  end
+
+end

data/lib/rcfiles/toplevel_methods/rds.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/rds.rb'
+# =========================================================================== #
+module Rcfiles
+
+  # ========================================================================= #
+  # === Rcfiles.rds
+  # ========================================================================= #
+  def self.rds(i)
+    i.squeeze('/')
+  end
+
+end

data/lib/rcfiles/toplevel_methods/remove_newlines.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/remove_newlines.rb'
+# =========================================================================== #
+module Rcfiles
+
+  # ========================================================================= #
+  # === Rcfiles.remove_newlines
+  #
+  # This method will remove all newlines of the given input. The given
+  # input is the first argument to this method.
+  #
+  # The optional second input to this method can be used to also ensure
+  # that a proper encoding is used.
+  # ========================================================================= #
+  def self.remove_newlines(
+      i,
+      ensure_this_encoding = nil # 'ISO-8859-1' # <- or nil.
+    )
+    if ensure_this_encoding
+      i = i.force_encoding(ensure_this_encoding)
+    end
+    i.delete!("\n") if i.include?("\n")
+    return i
+  end
+
+end

data/lib/rcfiles/toplevel_methods/report.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/report.rb'
+# =========================================================================== #
+module Rcfiles
+
+  require 'rcfiles/toplevel_methods/e.rb'
+  require 'rcfiles/toplevel_methods/main_directory.rb'
+  require 'rcfiles/toplevel_methods/misc.rb'
+  require 'rcfiles/colours/colours.rb'
+  require 'rcfiles/files/file_aliases.rb'
+  require 'rcfiles/files/file_cd_aliases.rb'
+  require 'rcfiles/files/file_programs_aliases.rb'
+
+  # ========================================================================= #
+  # === Rcfiles.report
+  #
+  # This method will report some information about where the Rcfiles
+  # will collect information.
+  # ========================================================================= #
+  def self.report
+    e 'The main directory is at:'
+    e
+    e "  #{sdir(main_directory?)}"
+    unless File.directory? main_directory?
+      e 'This directory could, however had, NOT be found.'
+    end
+    e
+    e 'The three main .yml aliases paths are:'
+    e
+    e '  file aliases:          '+sfile(file_aliases?)
+    unless File.exist? file_aliases?
+      e 'This file could not be found.'
+    end
+    e '  file cd aliases:       '+sfile(file_cd_aliases?)
+    unless File.exist? file_cd_aliases?
+      e 'This file could not be found.'
+    end
+    e '  file programs aliases: '+sfile(file_programs_aliases?)
+    unless File.exist? file_programs_aliases?
+      e 'This file could not be found.'
+    end
+    e
+  end
+
+end
+
+
+if __FILE__ == $PROGRAM_NAME
+  Rcfiles.report  
+end

data/lib/rcfiles/toplevel_methods/return_standard_header.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/return_standard_header.rb'
+# Rcfiles.return_standard_header('cd_aliases_rc')
+# =========================================================================== #
+module Rcfiles
+
+  # ========================================================================== #
+  # === Rcfiles.return_standard_header
+  #
+  # This adds a standard header to our RC-File in question.
+  #
+  # The first input argument to this method should be the name of the
+  # rc-file at hand.
+  # ========================================================================== #
+  def self.return_standard_header(
+      which_file   = '',
+      current_date = Time.now.strftime('%d.%m.%Y') 
+    )
+    _ = <<-EOF
+# =========================================================================== #
+# This file was automatically generated at: #{current_date}
+#
+# The filename is:
+#
+#   #{which_file}
+#
+# =========================================================================== #
+EOF
+    return _
+  end; self.instance_eval { alias add_header       return_standard_header } # === Rcfiles.add_header
+       self.instance_eval { alias standard_header? return_standard_header } # === Rcfiles.standard_header?
+
+end

data/lib/rcfiles/toplevel_methods/run_it.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The method in this file here is mostly a convenience-method.
+#
+# It will leverage the old setup.rb file to install a project written in
+# ruby. Of course "gem" is the more modern way to go about this, but
+# sometimes, due to various reasons, you may want to use setup.rb
+# instead, which explains why this file here has been created.
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/run_it.rb'
+# =========================================================================== #
+module Rcfiles
+
+  # ========================================================================= #
+  # === Rcfiles.run_it
+  # ========================================================================= #
+  def self.run_it(
+      optional_arguments = ARGV
+    )
+    require 'rcfiles/requires/require_the_rcfiles_project.rb'
+    require 'convert_global_env'
+    Dir.chdir(ConvertGlobalEnv['$RSRC/rcfiles/']) # cd to it.
+    begin
+      require 'roebe/toplevel_methods/setup.rb'
+      Roebe.copy_setup_file_to_pwd
+    rescue LoadError
+      puts 'Could not load the file roebe/toplevel_methods/setup.rb'
+    end
+    if File.exist? 'setup.rb'
+      system 'ruby setup.rb --quiet config'
+      system 'ruby setup.rb --quiet setup'
+      system 'ruby setup.rb --quiet install'
+      File.delete('setup.rb')       if File.exist? 'setup.rb'
+      File.delete('InstalledFiles') if File.exist? 'InstalledFiles'
+      File.delete('.config')        if File.exist? '.config'
+      ::Rcfiles[] { yield if block_given? }
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Rcfiles.run_it(ARGV)
+end # rcfile_run_it

data/lib/rcfiles/toplevel_methods/save_file.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/save_file.rb'
+# Rcfiles.write_what_into
+# =========================================================================== #
+module Rcfiles
+
+  require 'fileutils'
+
+  # ========================================================================= #
+  # === Rcfiles.write_what_into
+  #
+  # This method can be used to save data into a file.
+  # ========================================================================= #
+  def self.write_what_into(
+      what = '',
+      into = ''
+    )
+    unless File.directory? File.dirname(into)
+      FileUtils.mkdir_p(File.dirname(into))
+    end
+    File.open(into, 'w') { |file| file.write(what) }
+  end
+
+end