roebe 0.5.191 → 0.6.5

data/lib/roebe/classes/create_file_skeleton/generate_ruby_string.rb

@@ -29,14 +29,14 @@ class CreateFileSkeleton < Roebe::Base
     _ '#'
     _ add_comment ''
 
-    # ======================================================================= #
+    # ======================================================================== #
     # Next, show how to require this file normally.
-    # ======================================================================= #
+    # ======================================================================== #
     _ "# require '"+real_filename?+".rb'"
     _ add_comment ''
-    # ======================================================================= #
+    # ======================================================================== #
     # Which libraries to require, will be handled next:
-    # ======================================================================= #
+    # ======================================================================== #
     ARRAY_REQUIRE_THESE_LIBRARIES_FOR_RB_FILES.sort.each {|entry|
       if entry.start_with? 'begin'
         _ entry
@@ -44,18 +44,18 @@ class CreateFileSkeleton < Roebe::Base
         _ "require '#{entry}'"
       end
     }
-    # ======================================================================= #
+    # ======================================================================== #
     # The comment in the following line begins at the '#' token.
-    # ======================================================================= #
+    # ======================================================================== #
     _ N+'class '+classname+" # < Base # === Foo::"+classname+N
-    # ======================================================================= #
+    # ======================================================================== #
     # Next come the various includes - sort this alphabetically please.
-    # ======================================================================= #
+    # ======================================================================== #
     _ '  include Colours'+N
     # _ '  include SaveFile' # If we want to add SaveFile functionality.'+N
-    _ '  # ========================================================================= #'
+    _ '  # ========================================================================== #'
     _ '  # === NAMESPACE'
-    _ '  # ========================================================================= #'
+    _ '  # ========================================================================== #'
     _ '  NAMESPACE = inspect'
 
     add_header :initialize
@@ -72,34 +72,34 @@ class CreateFileSkeleton < Roebe::Base
     add_header(:reset, pad: '(reset tag)') # reset tag
     _ '  def reset'
     _ '    super() if respond_to?(:super)' # Changed this in May 2023.
-    _ '    # ======================================================================= #'
+    _ '    # ======================================================================== #'
     _ '    # === @namespace'
-    _ '    # ======================================================================= #'
+    _ '    # ======================================================================== #'
     _ '    @namespace = NAMESPACE'
     _ '    # infer_the_namespace'
     _ '  end'
-    # ======================================================================= #
+    # ======================================================================== #
     # Add the method called set_commandline_arguments() next:
-    # ======================================================================= #
+    # ======================================================================== #
     add_header :set_commandline_arguments # Next, add the method set_commandline_arguments().
     _ "  def set_commandline_arguments(i = '')"
     _ '    i = [i].flatten.compact'
     _ '    @commandline_arguments = i'
     _ '  end'
-    # ======================================================================= #
+    # ======================================================================== #
     # === commandline_arguments?
     #
     # Add the commandline_arguments? method next:
-    # ======================================================================= #
+    # ======================================================================== #
     add_header :commandline_arguments?
     _ '  def commandline_arguments?'
     _ '    @commandline_arguments'
     _ '  end'
-    # ======================================================================= #
+    # ======================================================================== #
     # === first_argument?
     #
     # Add the first_argument? method next:
-    # ======================================================================= #
+    # ======================================================================== #
     add_header :first_argument?
     _ '  def first_argument?'
     _ '    @commandline_arguments.first'
@@ -108,9 +108,9 @@ class CreateFileSkeleton < Roebe::Base
     _ '  def run'
     _ 'pp self # For debugging. Should be removed / replaced.'
     _ '  end'
-    # ======================================================================= #
+    # ======================================================================== #
     # Add the [] method next:
-    # ======================================================================= #
+    # ======================================================================== #
     add_header classname+'[]'
     _ "  def self.[](i = '')"
     _ '    new(i)'

data/lib/roebe/classes/create_file_skeleton/reset.rb

@@ -8,45 +8,48 @@ module Roebe
 
 class CreateFileSkeleton < Roebe::Base
 
-  # ========================================================================= #
+  # ========================================================================== #
   # === reset                                                     (reset tag)
-  # ========================================================================= #
+  # ========================================================================== #
   def reset
     super()
     infer_the_namespace
+    # ======================================================================== #
+    # === @editor
+    # ======================================================================== #
     if ENV['EDITOR']
       @editor = ENV['EDITOR'].dup
     else
       @editor = 'vim'
     end
-    # ======================================================================= #
+    # ======================================================================== #
+    # === @padding
+    # ======================================================================== #
+    @padding = '  '
+    # ======================================================================== #
     # === @use_colours
-    # ======================================================================= #
+    # ======================================================================== #
     @use_colours = true
-    # ======================================================================= #
+    # ======================================================================== #
     # === @shall_we_also_open_the_created_file
-    # ======================================================================= #
+    # ======================================================================== #
     @shall_we_also_open_the_created_file = 
       SHALL_WE_ALSO_OPEN_THE_CREATED_FILE
-    # ======================================================================= #
-    # === @padding
-    # ======================================================================= #
-    @padding = '  '
-    # ======================================================================= #
+    # ======================================================================== #
     # === @save_file
-    # ======================================================================= #
+    # ======================================================================== #
     @save_file = true
-    # ======================================================================= #
+    # ======================================================================== #
     # === @use_this_encoding
     #
     # This can be 'UTF-8' or 'ISO-8859-1'.
-    # ======================================================================= #
+    # ======================================================================== #
     @use_this_encoding = 'UTF-8'
-    # ======================================================================= #
+    # ======================================================================== #
     # === @use_this_encoding
     #
     # Specify which encoding to use, when autogenerating a file.
-    # ======================================================================= #
+    # ======================================================================== #
     @use_this_encoding = USE_THIS_ENCODING
     empty_main_string
     set_be_verbose

data/lib/roebe/classes/create_my_directories.rb

@@ -69,21 +69,23 @@ class CreateMyDirectories < Base # === Roebe::CreateMyDirectories
   #
   # The input should be an Array.
   # ========================================================================= #
-  def create_these_directories(these_directories)
+  def create_these_directories(
+      these_directories
+    )
     if these_directories
       these_directories.each { |directory|
         # =================================================================== #
         # Only create directories if they do not yet exist.
         # =================================================================== #
-        this_dir = (@base_prefix+directory).squeeze('/')
+        this_dir = ("#{@base_prefix}#{directory}").squeeze('/')
         unless File.exist?(this_dir)
           if File.directory?(this_dir)
             # =============================================================== #
             # Be quiet in this case, as the directory already exists.
             # =============================================================== #
           elsif File.file?(this_dir)
-            opne "Can not create a directory a #{sfile(this_dir)}"
-            opne 'as a file already exists at that location.'
+            opne "#{rev}Can not create a directory a #{sfile(this_dir)}"
+            opne "#{rev}as a file already exists at that location."
           else
             begin
               opne "#{rev}Creating a directory at `#{sdir(this_dir)}#{rev}`."
@@ -101,11 +103,12 @@ class CreateMyDirectories < Base # === Roebe::CreateMyDirectories
   end
 
   # ========================================================================= #
-  # === show_help
+  # === show_help                                                  (help tag)
   # ========================================================================= #
   def show_help
     e
-    e 'You can also specify the location where to create the directory layout.'
+    e 'You can also specify the location where to create '\
+      'the directory layout.'
     e
     e 'Example:'
     e
@@ -133,9 +136,8 @@ class CreateMyDirectories < Base # === Roebe::CreateMyDirectories
   # === menu                                                       (menu tag)
   # ========================================================================= #
   def menu(
-      i = @commandline_arguments
+      i = commandline_arguments?
     )
-pp i
     if i.is_a? Array
       i.each {|entry| menu(entry) }
     else
@@ -164,7 +166,7 @@ pp i
   # ========================================================================= #
   def consider_notifying_the_user_how_many_directories_have_been_created
     if @created_n_directories == 0
-      e 'No directory has been created, which usually means that all'
+      e "#{rev}No directory has been created, which usually means that all"
       e 'directories already exist. '+slateblue(cheerful_guy)
     end
   end
@@ -177,7 +179,7 @@ pp i
     menu
     my_directories = nil # Safeguard.    
     file_directory_structure = @use_this_file
-    e 'Creating my directories next by loading the dataset from'
+    e "#{rev}Creating my directories next by loading the dataset from"
     e
     e "  #{sdir(file_directory_structure)}"
     e

data/lib/roebe/classes/dhcpcd/{dhcpcd.rb → dhcpcd_wrapper.rb}

@@ -2,47 +2,58 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# === Roebe::Dhcpcd
+# === Roebe::DhcpcdWrapper
+#
+# This class was added on the 14.02.2024. It replaced the old dhcpcd wrapper
+# class that was confusing me before.
 #
 # This is the base class for all dhcpcd-related activities - a small
 # wrapper over dhcpcd.
 #
 # Usage example:
 #
-#   Roebe::Dhcpcd.new(ARGV)
+#   Roebe::DhcpcdWrapper.new(ARGV)
 #
 # =========================================================================== #
-# require 'roebe/classes/dhcpcd/dhcpcd.rb'
+# require 'roebe/classes/dhcpcd/dhcpcd_wrapper.rb'
+# Roebe::DhcpcdWrapper.new(ARGV)
 # =========================================================================== #
 require 'roebe/base/base.rb'
 
 module Roebe
 
-class Dhcpcd < Base # === Roebe::Dhcpcd
+class DhcpcdWrapper < Base # === Roebe::DhcpcdWrapper
 
   # ========================================================================= #
-  # === BASE_DIRECTORY
+  # === DIRECTORY_CONTAINING_THE_PID_OF_DHCPCD
   #
   # This is the directory where we may find the .pid of dhcpcd.
   # ========================================================================= #
-  BASE_DIRECTORY = '/var/run/'
+  DIRECTORY_CONTAINING_THE_PID_OF_DHCPCD = '/var/run/'
 
   # ========================================================================= #
   # === ALL_PIDS
   #
   # The full name may be 'dhcpcd-enp5s0.pid'.
   # ========================================================================= #
-  ALL_PIDS       = BASE_DIRECTORY+'dhcpcd*.pid'
+  ALL_PIDS       = "#{DIRECTORY_CONTAINING_THE_PID_OF_DHCPCD}dhcpcd*.pid"
+
+  # ========================================================================= #
+  # === KILLALL_DHCPCD
+  # ========================================================================= #
+  KILLALL_DHCPCD = 'killall dhcpcd'
 
   # ========================================================================= #
   # === initialize
   # ========================================================================= #
   def initialize(
-      i           = ARGV,
-      run_already = true
+      commandline_arguments = nil,
+      run_already           = true
     )
     reset
-    set_commandline_arguments(i)
+    set_commandline_arguments(
+      commandline_arguments
+    )
     run if run_already
   end
 
@@ -52,36 +63,62 @@ class Dhcpcd < Base # === Roebe::Dhcpcd
   def reset
     super()
     infer_the_namespace
-    @target_device = nil
+    infer_the_target_device
   end
 
   # ========================================================================= #
-  # === set_target_device
+  # === the_target_device?
+  # ========================================================================= #
+  def the_target_device?
+    @internal_hash[:the_target_device]
+  end; alias target_device? the_target_device? # === target_device?
+
+  # ========================================================================= #
+  # === set_the_target_device
   # ========================================================================= #
-  def set_target_device(i = 'enp5s0')
+  def set_the_target_device(
+      i = 'enp5s0'
+    )
     i = i.join(' ').strip if i.is_a? Array
-    @target_device = i
+    if i.is_a?(String) and i.frozen?
+      i = i.dup
+    end
+    i.tr!('ß','0') if i.is_a?(String) and i.include?('ß')
+    @internal_hash[:the_target_device] = i.to_sym
+  end; alias set_target_device set_the_target_device # === set_target_device
+
+  # ========================================================================= #
+  # === process_id_of_dhcpcd?
+  #
+  # This method will yield the process-id of dhcpcd; or "unknown" if
+  # dhcpcd is not running.
+  # ========================================================================= #
+  def process_id_of_dhcpcd?
+    result = `ps ax #{ERROR_LINE}`
+    result = result.split(N).select {|line|
+      line.include?('dhcpcd: ')
+    }
+    if result and result.is_a?(Array)
+      result = result.first
+      if result.is_a?(String) and result.include?(' ')
+        return result.split(' ').first.to_s
+      end
+    end
+    return 'unknown' # Default return value.
   end
 
   # ========================================================================= #
-  # === target_device?
+  # === use_enp5s0
   # ========================================================================= #
-  def target_device?
-    @target_device
+  def use_enp5s0
+    set_the_target_device('enp5s0') # Hardcoded default works fine here.
   end
 
   # ========================================================================= #
-  # === sanitize_the_commandline
+  # === infer_the_target_device
   # ========================================================================= #
-  def sanitize_the_commandline
-    if commandline_arguments?.empty?
-      set_target_device('enp5s0') # Hardcoded default for now.
-    end
-    commandline_arguments?.map! {|entry|
-      entry = entry.dup if entry.frozen?
-      entry.tr!('ß','0') if entry.include? 'ß'
-      entry
-    }
+  def infer_the_target_device
+    set_the_target_device(:eth0)
   end
 
   # ========================================================================= #
@@ -94,12 +131,26 @@ class Dhcpcd < Base # === Roebe::Dhcpcd
     result.include? ' dhcpcd' # We must exclude 'ruby_dhcpcd' here.
   end
 
+  # ========================================================================= #
+  # === verbose_is_dhcpcd_running?
+  # ========================================================================= #
+  def verbose_is_dhcpcd_running?
+    case is_dhcpcd_running?
+    when true
+      opne 'dhcpcd is currently running.'
+    when false
+      opne 'dhcpcd is currently NOT running.'
+    end
+  end
+
   # ========================================================================= #
   # === kill_the_old_dhcpcd_processes
+  #
+  # This method will kill any running dhcpcd process.
   # ========================================================================= #
   def kill_the_old_dhcpcd_processes
     if is_dhcpcd_running?
-      esystem('killall dhcpcd') { :do_colourize_and_pad_the_system_command }
+      esystem(KILLALL_DHCPCD) { :do_colourize_and_pad_the_system_command }
     end
   end; alias kill_old_dhcpcd_processes kill_the_old_dhcpcd_processes # === kill_old_dhcpcd_processes
        alias kill_dhcpcd               kill_the_old_dhcpcd_processes # === kill_dhcpcd
@@ -112,37 +163,65 @@ class Dhcpcd < Base # === Roebe::Dhcpcd
     return Dir[ALL_PIDS]
   end
 
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  # ========================================================================= #
+  def show_help
+    e
+    e 'No help options are documented so far for this class.'
+    e
+  end
+
+  # ========================================================================= #
+  # === start_the_dhcpcd_command                                  (start tag)
+  #
+  # This method will start the actual dhcpcd command.
+  #
+  # The argument that should be passed to this method is the actual
+  # target device, such as 'enp5s0'.
+  # ========================================================================= #
+  def start_the_dhcpcd_command(
+      i = target_device?
+    )
+    opne "#{rev}Now starting the #{steelblue('dhcpcd')} #{rev}command "\
+         "at #{sfancy(i)}#{rev}."
+    _ = "  dhcpcd #{i}"
+    e
+    e steelblue(_)
+    e
+    system _
+  end; alias start_dhcpcd start_the_dhcpcd_command # === start_dhcpcd
+
   # ========================================================================= #
   # === purge_old_entries
   # ========================================================================= #
-  def purge_old_entries
-    get_matches.each {|entry|
+  def purge_old_entries(
+      matches = get_matches
+    )
+    matches.each {|entry|
       if File.exist? entry
-        opne "Purging old entry `#{sfile(entry)}"\
-             "` (Filesize: #{sfancy(File.size(entry).to_s)})."
+        opne "#{rev}Purging the old entry at `#{sfile(entry)}"\
+             "#{rev}` (Filesize: #{sfancy(File.size(entry).to_s)}#{rev})#{rev}."
         delete(entry)
       end
     }
   end
 
   # ========================================================================= #
-  # === process_id_of_dhcpcd?
-  #
-  # This method will yield the process-id of dhcpcd; or "unknown" if
-  # dhcpcd is not running.
+  # === do_run_the_default_actions
   # ========================================================================= #
-  def process_id_of_dhcpcd?
-    result = `ps ax #{ERROR_LINE}`
-    result = result.split(N).select {|line|
-      line.include?('dhcpcd: ')
-    }
-    if result and result.is_a?(Array)
-      result = result.first
-      if result and result.include?(' ')
-        return
-      end
-    end
-    return 'unknown'
+  def do_run_the_default_actions
+    kill_old_dhcpcd_processes
+    purge_old_entries
+    start_the_dhcpcd_command
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    menu
+    do_run_the_default_actions
   end
 
   # ========================================================================= #
@@ -153,12 +232,15 @@ class Dhcpcd < Base # === Roebe::Dhcpcd
     )
     if i.is_a? Array
       if i.empty?
-        do_run_the_default_actions
+        show_help
       else
         i.each {|entry| menu(entry) }
       end
     else
       case i # case tag
+      # ===================================================================== #
+      # === mydhcpcd --help
+      # ===================================================================== #
       when /help$/i
         show_help
       end
@@ -166,47 +248,7 @@ class Dhcpcd < Base # === Roebe::Dhcpcd
   end
 
   # ========================================================================= #
-  # === show_help                                                  (help tag)
-  # ========================================================================= #
-  def show_help
-    e 'No help options are documented so far for this class.'
-  end
-
-  # ========================================================================= #
-  # === do_run_the_default_actions
-  # ========================================================================= #
-  def do_run_the_default_actions
-    kill_old_dhcpcd_processes
-    purge_old_entries
-    start_the_dhcpcd_command
-  end
-
-  # ========================================================================= #
-  # === start_the_dhcpcd_command
-  #
-  # This method will start the actual dhcpcd command.
-  #
-  # The argument that should be passed to this method is the actual
-  # target device, such as 'enp5s0'.
-  # ========================================================================= #
-  def start_the_dhcpcd_command(
-      i = target_device?
-    )
-    opne "Now starting the #{steelblue('dhcpcd')} command at #{sfancy(i)}."
-    _ = "  dhcpcd #{i}"
-    esystem _, :do_colourize
-  end; alias start_dhcpcd start_the_dhcpcd_command # === start_dhcpcd
-
-  # ========================================================================= #
-  # === run                                                         (run tag)
-  # ========================================================================= #
-  def run
-    sanitize_the_commandline
-    menu
-  end
-
-  # ========================================================================= #
-  # === Roebe::Dhcpcd[]
+  # === Roebe::DhcpcdWrapper[]
   # ========================================================================= #
   def self.[](i = ARGV)
     new(i)
@@ -218,15 +260,15 @@ end
 # === Roebe.dhcpcd
 # =========================================================================== #
 def self.dhcpcd(i = ARGV)
-  Dhcpcd.new(i)
-end
+  Roebe::DhcpcdWrapper.new(i)
+end; self.instance_eval { alias dhcpcd_wrapper dhcpcd } # === Roebe.dhcpcd_wrapper
 
 end
 
 if __FILE__ == $PROGRAM_NAME
   alias e puts
-  dhcpcd = Roebe::Dhcpcd.new(ARGV)
+  dhcpcd = Roebe.dhcpcd(ARGV)
   e 'Is dhcpcd running right now? '+
     dhcpcd.is_dhcpcd_running?.to_s
-end # my_dhcpcd eth0
-    # my_dhcpcd enp5s0
+end # mydhcpcd eth0
+    # mydhcpcd enp5s0

data/lib/roebe/classes/dhcpcd/kill_dhcpcd.rb

@@ -13,11 +13,11 @@
 # =========================================================================== #
 # require 'roebe/classes/dhcpcd/kill_dhcpcd.rb'
 # =========================================================================== #
-require 'roebe/classes/dhcpcd/dhcpcd.rb'
+require 'roebe/classes/dhcpcd/dhcpcd_wrapper.rb'
 
 module Roebe
 
-class KillDhcpcd < ::Roebe::Dhcpcd # === Roebe::KillDhcpcd
+class KillDhcpcd < ::Roebe::DhcpcdWrapper # === Roebe::KillDhcpcd
 
   # ========================================================================= #
   # === initialize

data/lib/roebe/classes/do_install.rb

@@ -22,7 +22,7 @@ module Roebe
 class DoInstall < ::Roebe::Base # === Roebe::DoInstall
 
   begin
-    require 'rbt/toplevel_methods/misc.rb'
+    require 'rbt/toplevel_methods/toplevel_methods.rb'
   rescue LoadError; end
 
   # ========================================================================= #
@@ -69,12 +69,13 @@ class DoInstall < ::Roebe::Base # === Roebe::DoInstall
       !can_we_use_meson_in_the_current_directory? and # If we can not run meson.
       !can_we_use_cmake_in_the_current_directory? and # If we can not run cmake either.
       !File.exist?('configure') # And there is no file called "configure" yet.
-      opne 'No file called '+sfile('configure')+' was found. Neither could a '\
-           'meson-file'
+      opne "#{rev}No file called #{sfile('configure')} #{rev}was found. "\
+           "Neither could a meson-file"
       opne 'or a cmake-file be found.'
-      opne 'Thus, since a file called '+sfile('autogen.sh')+' was '\
-           'actually found, it will be run next.'
-      opne 'If all goes well then a file called '+sfile('configure')+' will be'
+      opne 'Thus, since a file called '+sfile('autogen.sh')+rev+
+           ' was actually found, it will be run next.'
+      opne 'If all goes well then a file called '+sfile('configure')+rev+
+           ' will be'
       opne 'created, which can then be used to compile the given program.'
       do_invoke_autogen_sh
     end

data/lib/roebe/classes/done.rb

@@ -104,7 +104,7 @@ class Done < ::Roebe::Base # === Roebe::Done
          is_on_roebe? and
          is_in_studium_dir? and
          pdf_has_no_title?(i)
-        require 'pdf_paradise/toplevel_methods/automatic_pdf_title.rb'
+        require 'pdf_paradise/utility_scripts/automatic_pdf_title.rb'
         # =================================================================== #
         # Set an autotitle in this case.
         # =================================================================== #

data/lib/roebe/classes/downcase_extension.rb

@@ -55,8 +55,8 @@ class DowncaseExtension < Base # === Roebe::DowncaseExtension
     # ======================================================================= #
     i.map! {|entry|
       if File.directory? entry
-        opne 'Expanding the directory '+sdir(entry)+' to all '\
-                'files within that directory.'
+        opne 'Expanding the directory '+sdir(entry)+
+             rev+' to all files within that directory.'
         entry = Dir[(entry+'/*').squeeze('/')].select {|inner_entry|
           File.file? inner_entry
         }
@@ -93,8 +93,8 @@ class DowncaseExtension < Base # === Roebe::DowncaseExtension
       extension_type = File.extname(entry)
       new_name = entry.gsub(/#{extension_type}/,'')+extension_type.downcase
       unless new_name == entry
-        opne "Working now on `#{sfile(entry)}`. Its file extension"
-        opne "will be downcased towards #{sfile(new_name)}."
+        opne "#{rev}Working now on `#{sfile(entry)}#{rev}`. Its file extension"
+        opne "#{rev}will be downcased towards #{sfile(new_name)}#{rev}."
         rename(entry, new_name)
       end
     }