rbt 0.11.118 → 0.13.42

data/lib/rbt/utility_scripts/show_all_about.rb

@@ -100,8 +100,8 @@ class ShowAllAbout < RBT::Base # === RBT::ShowAllAbout
     i.delete!('.') if i.include? '.' # <- Trailing '.' are disallowed.
     i = RBT.return_alias_program_name_for(i)
     if original_input != i
-      opne "Using the alias name `#{sfancy(i)}` rather "\
-           "than `#{royalblue(original_input)}`."
+      opne "Using the alias name `#{sfancy(i)}#{rev}` rather "\
+           "than `#{royalblue(original_input)}#{rev}`."
     end
     # ======================================================================= #
     # Make use of Cookbook-aliases next, so that "libatomic" is a valid
@@ -190,6 +190,72 @@ class ShowAllAbout < RBT::Base # === RBT::ShowAllAbout
     @available_programs = available_programs?
   end
 
+  # ========================================================================= #
+  # === colourize_or_dont_colourize_in_steelblue
+  # ========================================================================= #
+  def colourize_or_dont_colourize_in_steelblue(i)
+    if use_colours?
+      i = steelblue(i).dup
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === return_n_headers
+  # ========================================================================= #
+  def return_n_headers
+    @cookbook_dataset.n_headers?
+  end
+
+  # ========================================================================= #
+  # === return_n_libraries
+  # ========================================================================= #
+  def return_n_libraries
+    @cookbook_dataset.n_libraries?
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    _ = program_name?.downcase # Must downcae it since as of Jan 2018.
+    determine_available_programs
+    if @available_programs.include? _
+      opne "Now showing all about `#{seagreen(_)}#{rev}`.#{N}#{N}"
+      cookbook_location = "#{individual_cookbooks_directory?}#{_}.yml"
+      # ===================================================================== #
+      # Check whether the cookbook .yml file exists.
+      # ===================================================================== #
+      if File.exist? cookbook_location
+        # =================================================================== #
+        # Since as of January 2018, we will also check this cookbook file
+        # for errors.
+        # =================================================================== #
+        if Object.const_defined?(:RBT) and
+           RBT.respond_to?(:does_this_cookbook_file_have_any_erroneous_entry?)
+          if RBT.does_this_cookbook_file_have_any_erroneous_entry?(cookbook_location)
+            opne "#{rev}Note that the file `#{sfile(cookbook_location)}#{rev}`"
+            opne "#{rev}has at the least one erroneous entry."
+            RBT.check_this_cookbook_file_for_errors(cookbook_location)
+          end
+        end
+      end
+      # ===================================================================== #
+      # Simply use File.readlines() rather than YAML.load_file() next.
+      # ===================================================================== #
+      _ = File.basename(cookbook_location).
+          delete_suffix('.yml')
+      @cookbook_dataset = ::RBT.load_this_cookbook(_)
+      dataset = readlines_with_proper_encoding(cookbook_location)
+      dataset = sanitize_this_dataset(dataset)
+      dataset = dataset.join
+      cliner { e dataset }
+    else
+      opne "#{rev}No program called `#{seagreen(_)}#{rev}` appears "\
+           "to be registered.#{N}"
+    end
+  end
+
   # ========================================================================= #
   # === sanitize_this_dataset
   #
@@ -208,13 +274,13 @@ class ShowAllAbout < RBT::Base # === RBT::ShowAllAbout
       if entry.chomp == ' headers:'
         entry.chomp!
         entry << colourize_or_dont_colourize_in_steelblue(
-          "  [#{return_n_headers} headers]\n".dup
-        )
+          "  [#{return_n_headers} headers]#{rev}\n".dup
+        )+rev
       elsif entry.chomp == ' libraries:'
         entry.chomp!
-        entry << colourize_or_dont_colourize_in_steelblue(
-          "  [#{return_n_libraries} headers]\n".dup
-        ) 
+        entry << rev+colourize_or_dont_colourize_in_steelblue(
+          "  [#{return_n_libraries} libraries]#{rev}\n".dup
+        )+rev
       end
       if entry.start_with?(' - ')
         # =================================================================== #
@@ -229,16 +295,17 @@ class ShowAllAbout < RBT::Base # === RBT::ShowAllAbout
               # Pass through.
             elsif @n_library_files_so_far == @limit_to_n_libraries
               add_this = "   [Truncated ... no more .so / .a files shown "\
-                         "past the #{@limit_to_n_libraries} .so / .a files limit.]\n".dup
+                         "past the #{@limit_to_n_libraries} .so / .a files limit.]#{rev}\n".dup
               if use_colours?
                 add_this = steelblue(add_this).dup
               end
-              next_line = "   [You can use --do-not-truncate to ignore the above limit.]\n" 
+              next_line = "   [You can use --do-not-truncate to ignore the above limit.]#{rev}\n" 
               if use_colours?
                 splitted = next_line.split('--do-not-truncate')
                 next_line = steelblue(splitted[0])+
                             tomato('--do-not-truncate')+
-                            steelblue(splitted[1])
+                            steelblue(splitted[1])+
+                            rev
               end
               add_this << next_line
               entry << add_this
@@ -259,7 +326,7 @@ class ShowAllAbout < RBT::Base # === RBT::ShowAllAbout
             elsif @n_header_files_so_far == @limit_to_n_headers
               add_this = "   [Truncated ... no more .h files shown "\
                          "past the #{@limit_to_n_headers} .h files limit.]\n".dup
-              add_this << "   [You can use --do-not-truncate to "\
+              add_this << "#{rev}   [You can use --do-not-truncate to "\
                           "ignore the above limit.]\n" 
               if use_colours?
                 add_this = steelblue(add_this)
@@ -278,12 +345,12 @@ class ShowAllAbout < RBT::Base # === RBT::ShowAllAbout
       # colourizing the homepage: entry in the colour orange.
       # ===================================================================== #
       elsif entry.start_with? ' homepage: '
-        entry = orange(entry)
+        entry = "#{orange(entry)}#{rev}"
       # ===================================================================== #
       # === git_url:
       # ===================================================================== #
       elsif entry.start_with? ' git_url: '
-        entry = mediumslateblue(entry)
+        entry = mediumslateblue(entry)+rev
       end
       # ===================================================================== #
       # Pad it with two ' ' on the left side a bit.
@@ -297,72 +364,6 @@ class ShowAllAbout < RBT::Base # === RBT::ShowAllAbout
     i
   end
 
-  # ========================================================================= #
-  # === colourize_or_dont_colourize_in_steelblue
-  # ========================================================================= #
-  def colourize_or_dont_colourize_in_steelblue(i)
-    if use_colours?
-      i = steelblue(i).dup
-    end
-    return i
-  end
-
-  # ========================================================================= #
-  # === return_n_headers
-  # ========================================================================= #
-  def return_n_headers
-    @cookbook_dataset.n_headers?
-  end
-
-  # ========================================================================= #
-  # === return_n_libraries
-  # ========================================================================= #
-  def return_n_libraries
-    @cookbook_dataset.n_libraries?
-  end
-
-  # ========================================================================= #
-  # === run
-  # ========================================================================= #
-  def run
-    _ = program_name?.downcase # Must downcae it since as of Jan 2018.
-    determine_available_programs
-    if @available_programs.include? _
-      opne "Now showing all about `#{seagreen(_)}`.#{N}#{N}"
-      cookbook_location = "#{individual_cookbooks_directory?}#{_}.yml"
-      # ===================================================================== #
-      # Check whether the cookbook .yml file exists.
-      # ===================================================================== #
-      if File.exist? cookbook_location
-        # =================================================================== #
-        # Since as of January 2018, we will also check this cookbook file
-        # for errors.
-        # =================================================================== #
-        if Object.const_defined?(:RBT) and
-           RBT.respond_to?(:does_this_cookbook_file_have_any_erroneous_entry?)
-          if RBT.does_this_cookbook_file_have_any_erroneous_entry?(cookbook_location)
-            opne "Note that the file `#{sfile(cookbook_location)}`"
-            opne 'has at the least one erroneous entry.'
-            RBT.check_this_cookbook_file_for_errors(cookbook_location)
-          end
-        end
-      end
-      # ===================================================================== #
-      # Simply use File.readlines() rather than YAML.load_file() next.
-      # ===================================================================== #
-      _ = File.basename(cookbook_location).
-          delete_suffix('.yml')
-      @cookbook_dataset = ::RBT.load_this_cookbook(_)
-      dataset = readlines_with_proper_encoding(cookbook_location)
-      dataset = sanitize_this_dataset(dataset)
-      dataset = dataset.join
-      cliner { e dataset }
-    else
-      opne "No program called `#{seagreen(_)}` appears "\
-           "to be registered.#{N}"
-    end
-  end
-
 end; end
 
 if __FILE__ == $PROGRAM_NAME

data/lib/rbt/utility_scripts/show_manual_steps.rb

@@ -0,0 +1,114 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === RBT::ShowManualSteps
+#
+# This small class will simply show the manual steps of a given program.
+#
+# In order for this to work, there has to be a manual_steps: entry in
+# the corresponding .yml file.
+#
+# Usage example:
+#
+#   RBT::ShowManualSteps.new(ARGV)
+#
+# =========================================================================== #
+# require 'rbt/utility_scripts/show_manual_steps.rb'
+# RBT::ShowManualSteps.new(ARGV)
+# =========================================================================== #
+require 'rbt/base/base.rb'
+
+module RBT
+
+class ShowManualSteps < Base # === RBT::ShowManualSteps
+
+  require 'rbt/requires/require_the_cookbook_class.rb'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    _ = first_argument?
+    cookbook = RBT.cookbook_for(_)
+    manual_steps = cookbook.manual_steps?
+    if manual_steps and !manual_steps.empty?
+      report_these_manual_steps(manual_steps, _)
+    else
+      opne 'No manual steps are known for '+sfancy(_)+'.'
+    end
+  end
+
+  # ========================================================================= #
+  # === report_these_manual_steps (report tag)
+  # ========================================================================= #
+  def report_these_manual_steps(i, this_program)
+    opne 'The following manual steps are known for the program '+
+         steelblue(this_program)+':'
+    if i.is_a? String
+      i = i.split(N)
+    end
+    compacted_array = [i].flatten.compact
+    compacted_array.shift if compacted_array.first.strip.empty? # Get rid of leading newlines here.
+    padded = compacted_array.map {|entry|
+      entry = entry.dup
+      entry.prepend('  ')
+      entry
+    }
+    e
+    padded.each {|line|
+      e steelblue(line)
+    }
+    e
+  end; alias report report_these_manual_steps # === report
+
+  # ========================================================================= #
+  # === RBT::ShowManualSteps.of
+  # ========================================================================= #
+  def self.of(i = ARGV)
+    new(i)
+  end; self.instance_eval { alias [] of } # === ShowManualSteps[]
+
+end
+
+# =========================================================================== #
+# === RBT.show_manual_steps
+#
+# Usage example:
+#
+#   RBT.show_manual_steps(:kde5_plasma)
+#
+# =========================================================================== #
+def self.show_manual_steps(of = ARGV)
+  [of].flatten.compact.each {|this_program|
+    new(this_program)
+  }
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  RBT::ShowManualSteps.new(ARGV)
+end # showmanualsteps glibc

data/lib/rbt/utility_scripts/symlink_from_to_current/symlink_from_to_current.rb

@@ -546,8 +546,8 @@ class SymlinkFromToCurrent < ::RBT::CompileBase # === RBT::SymlinkFromToCurrent
   # This method will enable that we only symlink the bin/ subdirectory.
   # ========================================================================= #
   def only_allow_bin_as_subdirectory
-    opne "Only the subdirectory at "\
-         "#{sdir('bin/')} will be symlinked next."
+    opne "#{rev}Only the subdirectory at "\
+         "#{sdir('bin/')} #{rev}will be symlinked next."
     @array_allowed_subdirectories.clear
     @array_allowed_subdirectories << 'bin'
     # ======================================================================= #
@@ -736,8 +736,11 @@ class SymlinkFromToCurrent < ::RBT::CompileBase # === RBT::SymlinkFromToCurrent
                    /lib64$/ # lib64 could be controversial - hmmm.
                 target = assumed_target_of(name_of_the_subdirectory)
                 if be_verbose?
-                  opnn if use_opn?; e 'Processing '+sfancy(name_of_the_subdirectory)+
-                                      ' for symlinking into `'+sdir(target)+'` next:'
+                  opnn if use_opn?
+                  notify_the_user_processing_this_directory_for_symlinking_into_that_target(
+                    name_of_the_subdirectory,
+                    target
+                  )
                 end
                 if will_we_symlink
                   symlink_from_to(name_of_the_subdirectory, target)
@@ -781,8 +784,11 @@ class SymlinkFromToCurrent < ::RBT::CompileBase # === RBT::SymlinkFromToCurrent
                    /Shared$/
                 target = assumed_target_of(name_of_the_subdirectory)
                 if be_verbose?
-                  opnn if use_opn?; e 'Processing '+sfancy(name_of_the_subdirectory)+
-                                      ' for symlinking into `'+sdir(target)+'` next:'
+                  opnn if use_opn?
+                  notify_the_user_processing_this_directory_for_symlinking_into_that_target(
+                    name_of_the_subdirectory,
+                    target
+                  )
                 end
                 symlink_from_to(name_of_the_subdirectory, target) if @will_we_symlink
               # =============================================================== #
@@ -791,8 +797,11 @@ class SymlinkFromToCurrent < ::RBT::CompileBase # === RBT::SymlinkFromToCurrent
               when /etc$/
                 target = assumed_target_of(name_of_the_subdirectory)
                 if be_verbose?
-                  opnn if use_opn?; e 'Processing '+sfancy(name_of_the_subdirectory)+
-                                      ' for symlinking into `'+sdir(target)+'` next:'
+                  opnn if use_opn?
+                  notify_the_user_processing_this_directory_for_symlinking_into_that_target(
+                    name_of_the_subdirectory,
+                    target
+                  )
                 end
                 symlink_from_to(name_of_the_subdirectory, target) if @will_we_symlink
               # =============================================================== #
@@ -801,8 +810,11 @@ class SymlinkFromToCurrent < ::RBT::CompileBase # === RBT::SymlinkFromToCurrent
               when /libexec$/
                 target = assumed_target_of(name_of_the_subdirectory)
                 if be_verbose?
-                  opnn if use_opn?; e 'Processing '+sfancy(name_of_the_subdirectory)+
-                                      ' for symlinking into `'+sdir(target)+'` next:'
+                  opnn if use_opn?
+                  notify_the_user_processing_this_directory_for_symlinking_into_that_target(
+                    name_of_the_subdirectory,
+                    target
+                  )
                 end
                 symlink_from_to(name_of_the_subdirectory, target) if @will_we_symlink
               # =============================================================== #
@@ -906,17 +918,29 @@ class SymlinkFromToCurrent < ::RBT::CompileBase # === RBT::SymlinkFromToCurrent
   def inform_the_user_what_will_be_done(
       program_name = program_name?
     )
-    _ = "Working on the program #{sfancy(program_name)}. ".dup
+    _ = "Working on the program #{sfancy(program_name)}#{rev}. ".dup
     if @array_allowed_subdirectories.size == 1
-      _ << "The subdirectory found at\n"
+      _ << "#{rev}The subdirectory found at\n"
     else
-      _ << "The subdirectories found at\n" 
+      _ << "#{rev}The subdirectories found at\n" 
     end
     opnn if use_opn?; e _
-    _ = "`#{sfancy(use_this_program?)}` will be symlinked."
+    _ = "#{rev}`#{sfancy(use_this_program?)}#{rev}` will be symlinked."
     opnn if use_opn?; e _
   end
 
+  # ========================================================================= #
+  # === notify_the_user_processing_this_directory_for_symlinking_into_that_target
+  # ========================================================================= #
+  def notify_the_user_processing_this_directory_for_symlinking_into_that_target(
+      name_of_the_subdirectory,
+      target
+    )
+    e "#{rev}Processing #{sfancy(name_of_the_subdirectory)}"\
+       "#{rev} for symlinking into `#{sdir(target)}"\
+       "#{rev}` next:"
+  end
+
   # ========================================================================= #
   # === run                                                         (run tag)
   # ========================================================================= #

data/lib/rbt/utility_scripts/symlink_pkgconfig_files.rb

@@ -87,9 +87,9 @@ class SymlinkPkgconfigFiles < Base # === RBT::SymlinkPkgconfigFiles
     # ===================================================================== #
     if File.directory? appdir_target_with_pc_files
       opne "Now attempting to symlink all #{slateblue('.pc files')} "\
-           "from"
+           "#{rev}from"
       opne "`#{sdir(appdir_target_with_pc_files)}"\
-           "` into `#{sdir(target_dir)}`."
+           "#{rev}` into `#{sdir(target_dir)}#{rev}`."
       symlink_all_files_from_this_directory_to_that_directory(
         appdir_target_with_pc_files,
         target_dir

data/lib/rbt/utility_scripts/update_entry/update_entry.rb

@@ -447,7 +447,7 @@ class UpdateEntry < Base # === RBT::UpdateEntry
       _.delete!('_') if _.include? '_' # Directories must not contain a '_' character.
       _.delete!('-') if _.include? '-'
       unless (Dir.pwd+'/').squeeze('/') == _ # Need the .squeeze to append a '/'.
-        output 'Now changing to the directory `'+sdir(_)+'`.'
+        output "#{rev}Now changing to the directory `#{sdir(_)}#{rev}`."
         cd _, :ensure_that_the_directory_exists
       end
     end
@@ -595,7 +595,7 @@ class UpdateEntry < Base # === RBT::UpdateEntry
            "# program_version: #{program_version?.to_s.rjust(10)} "\
            "#{current_timestamp}#{N}"
     into = "#{rbt_log_dir?}these_programs_were_updated.yml"
-    opne "Appending `#{sfancy(what.strip)}` into `#{sfile(into)}`."
+    opne "Appending `#{sfancy(what.strip)}#{rev}` into `#{sfile(into)}#{rev}`."
     append_what_into(what, into)
     # ======================================================================= #
     # === Generate a copy as well

data/lib/rbt/utility_scripts/url.rb

@@ -227,22 +227,57 @@ class Url < Base # === RBT::Cookbooks::Url
 
   # ========================================================================= #
   # === tell_the_user_what_we_seek
+  #
+  # This method notifies the user for which particular program this
+  # class will try to obtain the associated homepage.
   # ========================================================================= #
   def tell_the_user_what_we_seek(
       be_verbose = be_verbose?
     )
     if be_verbose
-      opne "Seeking URLs to `#{sfancy(search_for?)}` next."
+      opne "Seeking URLs to `#{sfancy(search_for?)}#{rev}` next."
     end
   end
 
+  # ========================================================================= #
+  # === determine_dataset
+  #
+  # This method will also set the @dataset variable.
+  # ========================================================================= #
+  def determine_dataset(
+      search_for = search_for?
+    )
+    if RBT.does_include?(search_for) # In this case, we can search for it.
+      @dataset = RBT::Cookbooks::SanitizeCookbook.new(search_for) { :fast }
+    else # Else it was not included.
+      opne "The search_term `#{sfancy(search_for)}` is not included."
+      exit
+    end
+  end
+
+  # ========================================================================= #
+  # === set_search_for
+  # ========================================================================= #
+  def set_search_for(i)
+    @internal_hash[:search_for] = i
+  end
+
+  # ========================================================================= #
+  # === use_this_as_xorg_buffer
+  #
+  # This method has to account for "xsel" existing or not.
+  # ========================================================================= #
+  def use_this_as_xorg_buffer(i)
+    set_xorg_buffer(i)
+  end
+
   # ========================================================================= #
   # === feedback_urls
   # ========================================================================= #
   def feedback_urls
     if url1?.nil? or url1?.empty?
       e "url.rb: We did not find `"+search_for?+"`." if be_verbose?
-    else 
+    else
       use_this_as_xorg_buffer(url1?)
       result = ''.dup
       if @show_leading_url_entry
@@ -296,36 +331,6 @@ class Url < Base # === RBT::Cookbooks::Url
     e
   end
 
-  # ========================================================================= #
-  # === determine_dataset
-  #
-  # This method will also set the @dataset variable.
-  # ========================================================================= #
-  def determine_dataset(
-      search_for = search_for?
-    )
-    if RBT.does_include?(search_for) # In this case, we can search for it.
-      @dataset = RBT::Cookbooks::SanitizeCookbook.new(search_for) { :fast }
-    else # Else it was not included.
-      opne "The search_term `#{sfancy(search_for)}` is not included."
-      exit
-    end
-  end
-
-  # ========================================================================= #
-  # === set_search_for
-  # ========================================================================= #
-  def set_search_for(i)
-    @internal_hash[:search_for] = i
-  end
-
-  # ========================================================================= #
-  # === use_this_as_xorg_buffer
-  # ========================================================================= #
-  def use_this_as_xorg_buffer(i)
-    set_xorg_buffer(i)
-  end
-
   # ========================================================================= #
   # === run
   # ========================================================================= #

data/lib/rbt/version/version.rb

@@ -13,7 +13,7 @@ module RBT
   # just an alias to it - stick to using VERSION instead "officially"
   # whenever possible.
   # ========================================================================= #
-  VERSION = '0.11.118'
+  VERSION = '0.13.42'
     RBT_VERSION_NUMBER = VERSION # === RBT_VERSION_NUMBER
     PROGRAM_VERSION    = VERSION # === PROGRAM_VERSION
 
@@ -23,7 +23,7 @@ module RBT
   # This specifies when the RBT project was last updated. It should be
   # updated whenever the VERSION constant changes.
   # ========================================================================= #
-  LAST_UPDATE = '29.05.2023' # ← Keep this constant in DD.MM.YYYY notation.
+  LAST_UPDATE = '10.02.2024' # ← Keep this constant in DD.MM.YYYY notation.
 
   # ========================================================================= #
   # === URL_TO_THE_DOCUMENTATION