rcfiles 1.1.1137

data/lib/rcfiles/class/reset.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/class/reset.rb'
+# =========================================================================== #
+module Rcfiles
+
+class Rcfiles
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # By default this class will be verbose, aka it will "output its
+    # findings to the end user".
+    # ======================================================================= #
+    @be_verbose = true
+    set_create_rcfiles_where # Define where to store the rc-files.
+    set_current_date
+    clear_dataset
+    set_dataset
+  end
+
+end; end

data/lib/rcfiles/class/run.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Rcfiles
+
+class Rcfiles
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    check_whether_rcfiles_directory_exists
+    generate_the_most_important_rcfiles
+  end
+
+end; end

data/lib/rcfiles/colours/colours.rb

@@ -0,0 +1,107 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/colours/colours.rb'
+# =========================================================================== #
+module Rcfiles
+
+  begin
+    require 'colours'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === @use_colours
+  #
+  # Note that this will only TRY to use colours; the actual USING of
+  # colours depends on the availability of the gem called "colours".
+  # ========================================================================= #
+  @use_colours = true
+
+  # ========================================================================= #
+  # === Rcfiles.rev
+  # ========================================================================= #
+  def self.rev
+    if @use_colours
+      ::Colours.rev
+    else
+      ''
+    end
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.use_colours?
+  # ========================================================================= #
+  def self.use_colours?
+    @use_colours
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.enable_colours
+  # ========================================================================= #
+  def self.enable_colours
+    @use_colours = true
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.disable_colours
+  # ========================================================================= #
+  def self.disable_colours
+    @use_colours = false
+  end; self.instance_eval { alias no_colours disable_colours } # === Rcfiles.no_colours 
+
+  # ========================================================================= #
+  # === Rcfiles.sdir
+  # ========================================================================= #
+  def self.sdir(i = '')
+    if @use_colours and Object.const_defined?(:Colours)
+      return ::Colours.sdir(i)
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.sfancy
+  # ========================================================================= #
+  def self.sfancy(i = '')
+    if @use_colours and Object.const_defined?(:Colours)
+      return ::Colours.sfancy(i)
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.simp
+  # ========================================================================= #
+  def self.simp(i = '')
+    if @use_colours and Object.const_defined?(:Colours)
+      return ::Colours.simp(i)
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.teal
+  # ========================================================================= #
+  def self.teal(i = '')
+    if @use_colours and Object.const_defined?(:Colours) and
+       Colours.respond_to?(:teal)
+      return ::Colours.teal(i)
+    else
+      i
+    end
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.sfile
+  # ========================================================================= #
+  def self.sfile(i = '')
+    if @use_colours and Object.const_defined?(:Colours) and
+       Colours.respond_to?(:sfile)
+      return ::Colours.sfile(i)
+    else
+      i
+    end
+  end
+
+end

data/lib/rcfiles/commandline/commandline.rb

@@ -0,0 +1,170 @@
+#!/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 --windows-cd-aliases
+      # ===================================================================== #
+      when /^-?-?windows(-|_)?cd(-|_)?aliases$/
+        create_windows_cd_aliases_bat_file
+      # ===================================================================== #
+      # === rcfiles --help
+      # ===================================================================== #
+      when /help$/
+        show_help
+      # ======================================================================= #
+      # === 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/custom_files.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The content of this file is mostly 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/custom_files.rb'
+# =========================================================================== #
+require 'rcfiles/constants/misc.rb'
+
+module Rcfiles
+
+  # ========================================================================= #
+  # === 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,
+    # ======================================================================= #
+    'individual_environment_variables/term.yml'    => :export,
+    'special_aliases.yml'                          => :aliases,
+    'german_umlaute.yml'                           => :aliases,
+    # 'colours.yml'                                => :aliases,
+    # ^^^ colours.yml is dysfunct since 2018 or so - I am not sure if
+    # it will make a comeback.
+    'file_information.yml'                         => :export,
+    'gnome.yml'                                    => :export,
+    'kde.yml'                                      => :export,
+    'kernel.yml'                                   => :export,
+    'system.yml'                                   => :export,
+    'compile.yml'                                  => :export,
+    'network.yml'                                  => :export,
+    'video.yml'                                    => :export,
+    # ======================================================================= #
+    # Next, entries under individual_environment_variables/
+    # ======================================================================= #
+    'individual_environment_variables/ldflags.yml' => :export,
+    'individual_environment_variables/cflags.yml'  => :export,
+    'individual_environment_variables/lang.yml'    => :export
+  }
+
+  # ========================================================================= #
+  # The following .yml file is special:
+  #   directory_layout.yml
+  # ========================================================================= #
+
+  # ========================================================================= #
+  # === FILE_ROEBERIA_SETTINGS
+  #
+  # The next constant is only useful on my home setup:
+  # ========================================================================= #
+  FILE_ROEBERIA_SETTINGS =
+    "#{LINUX_YAML_BASE_DIRECTORY}roeberia_settings.yml"
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pp Rcfiles::HASH_CUSTOM_FILES
+end

data/lib/rcfiles/constants/encodings.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Specify some constants related to Encodings. That way, if we ever have
+# to, we can quickly change the main encoding for this project.
+# =========================================================================== #
+# require 'rcfiles/constants/encodings.rb'
+# Rcfiles.ensure_main_encoding
+# =========================================================================== #
+module Rcfiles
+
+  # ========================================================================= #
+  # === 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
+
+end