rbt 0.11.118 → 0.13.42

data/lib/rbt/utility_scripts/kernel_config_sanitizer/kernel_config_sanitizer.rb

@@ -0,0 +1,140 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === RBT::KernelConfigSanitizer
+#
+# This class will try to ensure that our kernel-configuration values are
+# part of the kernel.
+#
+# Usage example:
+#
+#   RBT::KernelConfigSanitizer.new(ARGV)
+#
+# =========================================================================== #
+# require 'rbt/utility_scripts/kernel_config_sanitizer.rb'
+# =========================================================================== #
+require 'rbt/base/base.rb'
+
+module RBT
+
+class KernelConfigSanitizer < Base # === RBT::KernelConfigSanitizer
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = nil
+  end
+
+  # ========================================================================= #
+  # === yaml_file?
+  # ========================================================================= #
+  def yaml_file?
+    "#{project_yaml_dir?}linux_kernel/default_kernel_options_to_be_used.yml"
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    _ = yaml_file?
+    if File.exist? _
+      @dataset = YAML.load_file(_)
+      proceed_with_the_main_task
+    else
+      no_file_exists_at(_)
+    end
+  end
+
+  # ========================================================================= #
+  # === proceed_with_the_main_task
+  #
+  # This will only be called if @dataset has been assigned - see above.
+  # ========================================================================= #
+  def proceed_with_the_main_task
+    the_file_has_been_modified = false
+    new_file_content = ''.dup # Store into this file.
+    content_of_the_config_file_as_array  = readlines('.config')
+    # content_of_the_config_file_as_string = content_of_the_config_file_as_array.join(N)
+    keys_that_have_to_be_sanitized = @dataset.keys
+    # Next append '=':
+    keys_that_have_to_be_sanitized.map! {|entry|
+      entry = entry.dup if entry.frozen?
+      entry << '='
+    }
+    opne "#{rev}Next attempting to sanitize the "\
+         "#{steelblue('Linux Kernel Configuration')}#{rev}."
+    opne "This is done by ensuring that #{keys_that_have_to_be_sanitized.size} "\
+         "entries exist in the way the .yml"
+    opne "file at #{sfancy(yaml_file?)}#{rev}"
+    opne "#{rev}has specified."
+    index_for_the_specified_keys_in_the_config_file = 0
+    content_of_the_config_file_as_array.each {|this_line|
+      unless this_line.start_with?('# ') # Ignore comments.
+        this_line.rstrip!
+        if keys_that_have_to_be_sanitized.any? {|inner_line| this_line.include?(inner_line) }
+          index_for_the_specified_keys_in_the_config_file += 1
+          # =================================================================== #
+          # In this case we will modify on the key.
+          # =================================================================== #
+          work_on_this_key_next = keys_that_have_to_be_sanitized.select {|most_inner_line| this_line.include?(most_inner_line) }.flatten
+          if work_on_this_key_next.is_a? Array
+            work_on_this_key_next = work_on_this_key_next.first
+          end
+          opne "#{royalblue(index_for_the_specified_keys_in_the_config_file.to_s+') ')}"\
+               "#{tomato('Now modifying')} #{lightgreen(this_line)}"\
+               "#{tomato(', for the key')} "\
+               "#{steelblue(work_on_this_key_next.delete('='))}"\
+               "#{rev}#{tomato('.')}"
+          the_file_has_been_modified = true
+          use_this_value = @dataset[work_on_this_key_next.delete('=')]
+          case use_this_value
+          when 'yes', true
+            use_this_value = 'y'
+          end
+          target = use_this_value
+          this_line = work_on_this_key_next+target
+        end
+        new_file_content << "#{this_line}#{N}"
+      end
+    }
+    if the_file_has_been_modified
+      into = File.absolute_path('.config')
+      opne "#{rev}Saving into the file #{sfancy(into)}#{rev} next."
+      what = new_file_content
+      write_what_into(what, into) 
+    end 
+  end
+
+  # ========================================================================= #
+  # === RBT::KernelConfigSanitizer[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  RBT::KernelConfigSanitizer.new(ARGV)
+end # kernelconfigsanitizer

data/lib/rbt/utility_scripts/purge_incorrect_yaml_directories_in_the_programs_hierarchy.rb

@@ -141,7 +141,7 @@ class PurgeIncorrectYamlDirectoriesInTheProgramsHierarchy < Base # === RBT::Purg
   # ========================================================================= #
   # === RBT::PurgeIncorrectYamlDirectoriesInTheProgramsHierarchy[]
   # ========================================================================= #
-  def self.[](i = '')
+  def self.[](i = ARGV)
     new(i)
   end
 

data/lib/rbt/utility_scripts/register_program_files_into_yaml_database.rb

@@ -244,8 +244,8 @@ class RegisterProgramFilesIntoYamlDatabase < Base # === RBT::RegisterProgramFile
         opne 'We will not store the registered files as'
         opne 'the dataset is empty.'
       else
-        opne "Storing the dataset (#{sfancy(registered_files.size.to_s)}"\
-             " files) into:"
+        opne "#{rev}Storing the dataset (#{sfancy(registered_files.size.to_s)}"\
+             " #{rev}files) into:"
         opne "  `#{sfile(registered_files)}`"
         _ = entries?.map {|entry|
           entry.sub(/#{@register_where}/,'')
@@ -272,7 +272,14 @@ class RegisterProgramFilesIntoYamlDatabase < Base # === RBT::RegisterProgramFile
   end
 
   # ========================================================================= #
-  # === report_files
+  # === entries?
+  # ========================================================================= #
+  def entries?
+    @internal_hash[:entries]
+  end; alias files? entries? # === files?
+
+  # ========================================================================= #
+  # === report_files                                             (report tag)
   # ========================================================================= #
   def report_files
     opnn
@@ -281,13 +288,6 @@ class RegisterProgramFilesIntoYamlDatabase < Base # === RBT::RegisterProgramFile
     }
   end
 
-  # ========================================================================= #
-  # === entries?
-  # ========================================================================= #
-  def entries?
-    @internal_hash[:entries]
-  end; alias files? entries? # === files?
-
   # ========================================================================= #
   # === run                                                         (run tag)
   # ========================================================================= #

data/lib/rbt/utility_scripts/remove_symlinks.rb

@@ -111,7 +111,8 @@ class RemoveSymlinks < Base # === RBT::RemoveSymlinks
     i.each {|entry|
       unless File.exist? entry
         if SHALL_WE_CREATE_MISSING_DIRECTORIES
-          opnwarn 'The directory `'+sdir(entry)+swarn('` does not exist.')
+          opnwarn rev+swarn('The directory `')+sdir(entry)+
+                  swarn('` does not exist.')
           opnwarn 'Thus, we will create it now.'
           create_directory(entry)
         end
@@ -124,8 +125,8 @@ class RemoveSymlinks < Base # === RBT::RemoveSymlinks
         if File.exist? inner_entry # File exist, this is good, passthrough.
         else # The file does not exist, so register it for removal.
           # e 'FILE DOES NOT EXIST '+sfile(inner_entry)
-          opne sfile(inner_entry)+' does not exist.'
-          opne "→ Thus we delete `#{sfile(inner_entry)}`."
+          opne "#{sfile(inner_entry)}#{rev} does not exist."
+          opne "#{rev}→ Thus we delete `#{sfile(inner_entry)}#{rev}`."
           register_broken_symlink_for_removal(inner_entry) # First register, then delete.
         end
       }
@@ -144,8 +145,8 @@ class RemoveSymlinks < Base # === RBT::RemoveSymlinks
     set_base_dir(i)
     _ = Dir["#{@base_dir}*"].reject {|file| ! File.symlink? file}
     if be_verbose
-      opne "There are #{sfancy(_.size.to_s.rjust(3))} symlinks "+
-           "listed in "+sdir(i)+'.'
+      opne "#{rev}There are #{sfancy(_.size.to_s.rjust(3))} "\
+           "#{rev}symlinks listed in "+sdir(i)+rev+'.'
     end
     return _
   end

data/lib/rbt/utility_scripts/replace_symlinks.rb

@@ -177,10 +177,11 @@ class ReplaceSymlinks < Base # === RBT::ReplaceSymlinks
       target_file = sysbin_directory?+File.basename(file)
       if File.exist? target_file
         if @remove_symlink
-          opn; e "Removing #{sfile(file)}."
+          opne "#{rev}Removing #{sfile(file)}#{rev}."
         else
-          opn; e 'Replacing '+sfile(file)+' with '+
-                  sfile(target_file)+'.' # Wanna remove /bin/unlink.
+          opne rev+'Replacing '+sfile(file)+
+               rev+' with '+
+               sfile(target_file)+rev+'.' # Wanna remove /bin/unlink.
         end
         if @simulate_only
         else
@@ -195,7 +196,7 @@ class ReplaceSymlinks < Base # === RBT::ReplaceSymlinks
   # === feedback_allowed_directories
   # ========================================================================= #
   def feedback_allowed_directories
-    opne "The #{salmon('allowed')} directories are:"
+    opne "#{rev}The #{salmon('allowed')} #{rev}directories are:"
     print '  '; pp ARRAY_ALLOWED_DIRS
   end
 

data/lib/rbt/utility_scripts/report_mate_desktop_version.rb

@@ -75,6 +75,9 @@ class ReportMateDesktopVersion < Base # === RBT::ReportMateDesktopVersion
 
   # ========================================================================= #
   # === add                                                         (add tag)
+  #
+  # This method will simply append onto the corresponding variable, stored
+  # in the primary Hash.
   # ========================================================================= #
   def add(
       i           = '',
@@ -109,8 +112,10 @@ class ReportMateDesktopVersion < Base # === RBT::ReportMateDesktopVersion
   # ========================================================================= #
   # === left_padded
   # ========================================================================= #
-  def left_padded
-    "#{grey}  "
+  def left_padded(
+      i = rev
+    )
+    "#{i}  " # This used to be "grey" rather than "rev", up until January 2024.
   end
 
   # ========================================================================= #
@@ -257,92 +262,6 @@ class ReportMateDesktopVersion < Base # === RBT::ReportMateDesktopVersion
     `#{i} #{ERROR_LINE}`.to_s.sub(/Version /,'')
   end
 
-  # ========================================================================= #
-  # === return_sanitized_sys_command
-  #
-  # This method will return the proper version of an installed
-  # mate-desktop component.
-  # ========================================================================= #
-  def return_sanitized_sys_command(
-      i = :caja
-    )
-    case i # case tag
-    when :mate_common
-      i = :mate_doc_common
-    when :mate_utils
-      i = :mate_screenshot
-    when :mate_desktop
-      i = :mate_about
-    end
-    # ======================================================================= #
-    # Next, some packages such as libmatekbd, only come with a .pc file
-    # rather than a commandline way to query its version, which we will
-    # determine first.
-    # ======================================================================= #
-    case i
-    # ======================================================================= #
-    # === :mate_keyboard
-    # ======================================================================= #
-    when :mate_keyboard
-      result = return_pkgconfig_result_for(:libmatekbd)
-    # ======================================================================= #
-    # === :mate_panel
-    # ======================================================================= #
-    when :mate_panel
-      result = return_pkgconfig_result_for('libmatepanelapplet-4.0')
-    # ======================================================================= #
-    # === :caja_extensions
-    # ======================================================================= #
-    when :caja_extensions
-      result = return_pkgconfig_result_for('libcaja-extension')
-    # ======================================================================= #
-    # === :mate_media
-    # ======================================================================= #
-    when :mate_media
-      result = return_mate_media_version
-    # ======================================================================= #
-    # === :mate_power_manager
-    # ======================================================================= #
-    when :mate_power_manager
-      result = run_safe_system_command('mate-power-manager --version').sub(/Version /,'')
-    # ======================================================================= #
-    # === :mate_mixer
-    # ======================================================================= #
-    when :mate_mixer
-      result = return_pkgconfig_result_for(:libmatemixer)
-    # ======================================================================= #
-    # === :mate_weather
-    # ======================================================================= #
-    when :mate_weather
-      result = return_pkgconfig_result_for(:mateweather)
-    # ======================================================================= #
-    # === :mate_applets
-    # ======================================================================= #
-    when :mate_applets
-      result = return_version_of_mate_applets
-    # ======================================================================= #
-    # === :mate_control_center
-    # ======================================================================= #
-    when :mate_control_center
-      result = return_pkgconfig_result_for('mate-default-applications')
-    else
-      i = i.to_s.tr('_','-')
-      result = `#{i} --version #{ERROR_LINE}`.split(N).first # system tag
-    end
-    result.to_s.
-           sub(/MATE /,'').
-           sub(/caja /,'').
-           sub(/marco /,'').
-           sub(/mate-screenshot /,'').
-           sub(/mate-doc-common \(mate-common\) /,''). 
-           sub(/Desktop Environment /,'').
-           sub(/Document Viewer /,'').
-           sub(/Eye of Image Viewer /,'').
-           sub(/pluma - Version /,'').
-           sub(/Engrampa Archive Manager /,'').
-           strip
-  end
-
   # ========================================================================= #
   # === report_mate_desktop_version
   # ========================================================================= #
@@ -357,13 +276,6 @@ class ReportMateDesktopVersion < Base # === RBT::ReportMateDesktopVersion
     add left_padded+'Mate-Utils: '.ljust(@n_ljust)+slateblue(mate_utils?)
   end
 
-  # ========================================================================= #
-  # === report
-  # ========================================================================= #
-  def report
-    e string_to_display? if @do_report
-  end
-
   # ========================================================================= #
   # === string_to_display?
   # ========================================================================= #
@@ -595,14 +507,125 @@ class ReportMateDesktopVersion < Base # === RBT::ReportMateDesktopVersion
     return_sanitized_sys_command(:engrampa)
   end; alias mate_engrampa_version? engrampav? # === mate_engrampa_version?
 
+  # ========================================================================= #
+  # === return_pkgconfig_result_for
+  # ========================================================================= #
+  def return_pkgconfig_result_for(
+      i = :libmatekbd
+    )
+    result = `pkg-config --modversion #{i} #{ERROR_LINE}`.strip
+    if result.include?('No package ') and result.include?(' found')
+      result = ''
+    end
+    return result
+  end
+
+  # ========================================================================= #
+  # === return_sanitized_sys_command
+  #
+  # This method will return the proper version of an installed
+  # mate-desktop component.
+  # ========================================================================= #
+  def return_sanitized_sys_command(
+      i = :caja
+    )
+    case i # case tag
+    when :mate_common
+      i = :mate_doc_common
+    when :mate_utils
+      i = :mate_screenshot
+    when :mate_desktop
+      i = :mate_about
+    end
+    # ======================================================================= #
+    # Next, some packages such as libmatekbd, only come with a .pc file
+    # rather than a commandline way to query its version, which we will
+    # determine first.
+    # ======================================================================= #
+    case i
+    # ======================================================================= #
+    # === :mate_keyboard
+    # ======================================================================= #
+    when :mate_keyboard
+      result = return_pkgconfig_result_for(:libmatekbd)
+    # ======================================================================= #
+    # === :mate_panel
+    # ======================================================================= #
+    when :mate_panel
+      result = return_pkgconfig_result_for('libmatepanelapplet-4.0')
+    # ======================================================================= #
+    # === :caja_extensions
+    # ======================================================================= #
+    when :caja_extensions
+      result = return_pkgconfig_result_for('libcaja-extension')
+    # ======================================================================= #
+    # === :mate_media
+    # ======================================================================= #
+    when :mate_media
+      result = return_mate_media_version
+    # ======================================================================= #
+    # === :mate_power_manager
+    # ======================================================================= #
+    when :mate_power_manager
+      result = run_safe_system_command('mate-power-manager --version').sub(/Version /,'')
+    # ======================================================================= #
+    # === :mate_mixer
+    # ======================================================================= #
+    when :mate_mixer
+      result = return_pkgconfig_result_for(:libmatemixer)
+    # ======================================================================= #
+    # === :mate_weather
+    # ======================================================================= #
+    when :mate_weather
+      result = return_pkgconfig_result_for(:mateweather)
+    # ======================================================================= #
+    # === :mate_applets
+    # ======================================================================= #
+    when :mate_applets
+      result = return_version_of_mate_applets
+    # ======================================================================= #
+    # === :mate_control_center
+    # ======================================================================= #
+    when :mate_control_center
+      result = return_pkgconfig_result_for('mate-default-applications')
+    else
+      i = i.to_s.tr('_','-')
+      result = `#{i} --version #{ERROR_LINE}`.split(N).first # system tag
+    end
+    result.to_s.
+           sub(/MATE /,'').
+           sub(/caja /,'').
+           sub(/marco /,'').
+           sub(/mate-screenshot /,'').
+           sub(/mate-doc-common \(mate-common\) /,''). 
+           sub(/Desktop Environment /,'').
+           sub(/Document Viewer /,'').
+           sub(/Eye of Image Viewer /,'').
+           sub(/pluma - Version /,'').
+           sub(/Engrampa Archive Manager /,'').
+           strip
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report(
+      i         = string_to_display?, # This is the full String to be displayed.
+      do_report = @do_report
+    )
+    if do_report
+      e lightgreen(i)
+    end
+  end
+
   # ========================================================================= #
   # === run                                                         (run tag)
   # ========================================================================= #
   def run
     add grey, :no_newline
-    add 'Reporting the installed versions of the '+
-        royalblue('mate-desktop components')+
-        grey(':')
+    add "#{rev}Reporting the installed versions of the "\
+        "#{royalblue('mate-desktop components')}"\
+        "#{rev}:"
     add_newline
     report_mate_desktop_version        # === mate-desktop
     report_mate_utils_version          # === mate-utils
@@ -631,23 +654,10 @@ class ReportMateDesktopVersion < Base # === RBT::ReportMateDesktopVersion
     report
   end
 
-  # ========================================================================= #
-  # === return_pkgconfig_result_for
-  # ========================================================================= #
-  def return_pkgconfig_result_for(
-      i = :libmatekbd
-    )
-    result = `pkg-config --modversion #{i} #{ERROR_LINE}`.strip
-    if result.include?('No package ') and result.include?(' found')
-      result = ''
-    end
-    return result
-  end
-
   # ========================================================================= #
   # === RBT::ReportMateDesktopVersion[]
   # ========================================================================= #
-  def self.[](i = '')
+  def self.[](i = ARGV)
     new(i)
   end
 

data/lib/rbt/utility_scripts/report_the_registered_programs.rb

@@ -87,9 +87,9 @@ class ReportTheRegisteredPrograms < ::RBT::Base # === RBT::Cookbooks::ReportTheR
   # ========================================================================= #
   def do_report_how_many_programs_are_registered
     opnn if show_class_name?
-    e "#{sfancy(RBT.n_programs_available?)} programs are "\
-      "registered in the #{orange('RBT project')} as of "\
-      "#{cadetblue(return_date)}."
+    e "#{sfancy(RBT.n_programs_available?)} #{rev}programs are "\
+      "registered in the #{orange('RBT project')} #{rev}as of "\
+      "#{cadetblue(return_date)}#{rev}."
   end
 
   # ========================================================================= #

data/lib/rbt/utility_scripts/report_xfce_version.rb

@@ -215,9 +215,9 @@ class ReportXfceVersion < Base # === RBT::ReportXfceVersion
   # ========================================================================= #
   def run
     add grey, :no_newline
-    add 'Reporting the installed versions of the '+
+    add rev+'Reporting the installed versions of the '+
         royalblue('xfce-desktop components')+
-        grey(':')
+        grey(':')+rev
     add_newline
     # ======================================================================= #
     # Next, add the programs that will be queried. These must all belong