rcfiles 1.1.1137

data/lib/rcfiles/toplevel_methods/is_on_roebe.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/is_on_roebe.rb'
+# =========================================================================== #
+module Rcfiles
+
+  # ========================================================================= #
+  # === Rcfiles.is_on_roebe?
+  # ========================================================================= #
+  def self.is_on_roebe?
+    ENV['IS_ROEBE'].to_s == '1'
+  end
+
+end

data/lib/rcfiles/toplevel_methods/main_directory.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The purpose of the file is to designate our main target directory -
+# that is, the directory in which we will store the rc-generated files.
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/main_directory.rb'
+# Rcfiles.main_directory?
+# =========================================================================== #
+require 'rcfiles/constants/misc.rb'
+require 'rcfiles/toplevel_methods/e.rb'
+require 'rcfiles/toplevel_methods/no_file_exists_at.rb'
+require 'rcfiles/toplevel_methods/save_file.rb'
+
+module Rcfiles
+
+  # ========================================================================= #
+  # === @store_into_this_directory
+  # ========================================================================= #
+  @store_into_this_directory = nil
+
+  # ========================================================================= #
+  # === Rcfiles.main_directory?
+  #
+  # This method will return e. g. "/AUTOGENERATED/".
+  #
+  # Note that you can modify this value, via the method stored in this
+  # file here, called Rcfiles.set_store_into_this_directory().
+  # ========================================================================= #
+  def self.main_directory?(
+      i = FILE_STORE_INTO_THIS_DIRECTORY
+    )
+    # ======================================================================= #
+    # The toplevel instance variable @store_into_this_directory will
+    # have priority. (Ideally this should be the only way how to
+    # query which directory is the current main one.)
+    # ======================================================================= #
+    if @store_into_this_directory
+      return @store_into_this_directory
+    elsif File.exist? i
+      result = YAML.load_file(i)
+      if result == false
+        result = CREATE_RCFILES_WHERE
+      end
+      result = result.to_s.chomp
+      return result
+    else
+      no_file_exists_at(i)
+    end
+  end; self.instance_eval { alias store_at? main_directory? } # === Rcfiles.store_at?
+       self.instance_eval { alias main_dir? main_directory? } # === Rcfiles.main_dir?
+
+  # ========================================================================= #
+  # === Rcfiles.store_at=
+  # ========================================================================= # 
+  def self.store_at=(i)
+    unless i.end_with? '/'
+      i = i.dup if i.frozen?
+      i << '/'
+    end
+    @store_into_this_directory = i
+  end; self.instance_eval { alias store_at store_at= } # === Rcfiles.store_at
+
+  # ========================================================================= #
+  # === Rcfiles.set_store_into_this_directory
+  #
+  # If the second argument to this method is true then we will also
+  # save this information into a local file.
+  # ========================================================================= #
+  def self.set_store_into_this_directory(
+      i              = :pwd,
+      save_into_file = true
+    )
+    case i
+    when 'pwd',
+         'Dir.pwd',
+         :pwd
+      i = Dir.pwd
+    end
+    i << '/' unless i.end_with? '/'
+    self.store_at = i
+    what = i
+    into = FILE_STORE_INTO_THIS_DIRECTORY
+    if save_into_file
+      e "We will store into the directory `#{sdir(what.to_s)}` from now on."
+      e "This will be saved into the file `#{sfile(into)}`."
+      write_what_into(what, into)
+    end
+    # ======================================================================= #
+    # Also save it on my home system.
+    # ======================================================================= #
+    this_dir =
+      "#{RUBY_SRC_DIR_AT_HOME}rcfiles/lib/rcfiles/yaml/"
+    if (ENV['IS_ROEBE'].to_s == '1') and
+        File.directory?(this_dir) and
+        save_into_file
+      into = "#{this_dir}store_into_this_directory.yml" # <- Save into this file here.
+      e "And also into the file `#{sfile(into)}`."
+      write_what_into(what, into)
+    end
+  end; self.instance_eval { alias set_main_directory set_store_into_this_directory } # === Rcfiles.set_main_directory
+       self.instance_eval { alias set_path           set_store_into_this_directory } # === Rcfiles.set_path
+       self.instance_eval { alias set_store_here     set_store_into_this_directory } # === Rcfiles.set_store_here
+       self.instance_eval { alias set_store_into     set_store_into_this_directory } # === Rcfiles.set_store_into
+       self.instance_eval { alias base_dir=          set_store_into_this_directory } # === Rcfiles.base_dir=
+
+end

data/lib/rcfiles/toplevel_methods/misc.rb

@@ -0,0 +1,304 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/misc.rb'
+# =========================================================================== #
+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/custom_files.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'
+
+module Rcfiles
+
+  # ========================================================================= #
+  # === Rcfiles::ARRAY_MAIN_ALIASES_FILE
+  # ========================================================================= #
+  ARRAY_MAIN_ALIASES_FILE = [
+    file_cd_aliases?,
+    file_aliases?,
+    file_programs_aliases?,
+    file_system_settings?
+  ]
+
+  # ========================================================================= #
+  # === 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.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/DATA/PROGRAMMING_LANGUAGES/RUBY/src/rcfiles/'
+    begin
+      require 'roebe/toplevel_methods/rinstall2.rb'
+      Roebe.rinstall2
+    rescue LoadError; end
+  end
+
+  # ========================================================================= #
+  # === 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 =
+      '/home/x/DATA/PROGRAMMING_LANGUAGES/RUBY/src/rcfiles/lib/rcfiles/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
+    e "Next generating #{teal('custom roebe rcfiles')}:" if be_verbose
+    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)
+        e "Storing into the file `#{sfile(into)}`." if be_verbose
+      else
+        no_file_exists_at(_) if be_verbose
+      end
+    } 
+  end
+
+  # ========================================================================= #
+  # === generate_the_main_rcfiles_without_the_custom_roebe_rcfiles
+  # ========================================================================= #
+  def self.generate_the_main_rcfiles_without_the_custom_roebe_rcfiles
+    generate_cd_aliases_rcfile
+    generate_aliases_rcfile
+    generate_programs_aliases_rcfile
+    generate_system_settings_rcfile
+    generate_pkgconfig_rcfile
+    generate_ls_colours_rcfile
+    generate_path_variable_rcfile
+    generate_ps1_rcfile
+  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
+    when :all,
+         :default
+      generate_the_main_rcfiles_without_the_custom_roebe_rcfiles
+      if is_on_roebe?
+        # =================================================================== #
+        # First 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
+            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)
+        end
+        # =================================================================== #
+        # The following subsection is entered only on "roebe-systems",
+        # aka my home-systems. Other users do not really need this
+        # subsection at all.
+        # =================================================================== #
+        generate_custom_roebe_rcfiles
+        # =================================================================== #
+        # 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
+      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
+
+  # ========================================================================= #
+  # === 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
+    
+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