roebe 0.5.191 → 0.6.3

data/lib/roebe/classes/books/books.rb

@@ -56,6 +56,9 @@ class Books < Base # === Roebe::Books
     set_commandline_arguments(
       commandline_arguments
     )
+    # ======================================================================= #
+    # === Handle blocks given to the method next
+    # ======================================================================= #
     if block_given?
       yielded = yield
       case yielded
@@ -93,7 +96,7 @@ class Books < Base # === Roebe::Books
     # === :store_the_timestamps_into_this_local_file
     # ======================================================================= #
     @internal_hash[:store_the_timestamps_into_this_local_file] =
-      roebe_log_directory?+'stored_timestamps_of_all_opened_pdf_books.yml'
+      the_stored_timestamps_of_all_opened_pdf_books_are_where?
     consider_loading_and_sanitizing_the_timestamps_from_a_local_yaml_file
     try_to_require_the_open_gem
   end
@@ -293,13 +296,6 @@ class Books < Base # === Roebe::Books
     end
   end
 
-  # ========================================================================= #
-  # === into?
-  # ========================================================================= #
-  def into?
-    "#{log_dir?}roebe/favourite_books.yml"
-  end; alias yaml_location? into? # === yaml_location?
-
   # ========================================================================= #
   # === show_help                                                  (help tag)
   # ========================================================================= #
@@ -313,7 +309,7 @@ class Books < Base # === Roebe::Books
     eparse '  books --open=2            # open only the .pdf file at entry #2'
     eparse '  books --real              # show the real path to the .pdf files'
     eparse '  books --reopen            # reopen all .pdf files that are '\
-           'registered'
+           'registered; --open-all is an alias to this'
     eparse '  books --store             # store the favourites'
     eparse '  books --restore           # restore the default from the '+
            steelblue('.yml')+
@@ -362,13 +358,13 @@ class Books < Base # === Roebe::Books
     unless @internal_hash[:favourite_books].include? i
       if File.exist? i
         if be_verbose
-          opne "Adding the file"
+          opne "#{rev}Adding the file"
           opne "#{sfancy(i)} #{rev}to the favourites."
         end
         @internal_hash[:favourite_books] << i
         store_the_favourites
       else
-        opne "No file exists at #{sfile(i)}."
+        opnn; no_file_exists_at(i)
       end
     end
   end; alias add                        add_to_the_favourites # === add
@@ -385,6 +381,8 @@ class Books < Base # === Roebe::Books
       YAML.load_file(i).each {|entry|
         open_this_pdf_file(entry)
       }
+    else
+      no_file_exists_at(i)
     end
   end
 
@@ -447,111 +445,6 @@ class Books < Base # === Roebe::Books
     show_the_favourites(nil, i)
   end
 
-  # ========================================================================= #
-  # === show_the_favourites
-  #
-  # This method will show all favourite books.
-  # ========================================================================= #
-  def show_the_favourites(
-      optional_arguments = nil, # or :full_path
-      _                  = favourite_books?
-    )
-    n_favourite_books = _.size
-    if _.empty?
-      opne tomato('No .pdf books are available for the current library.')
-      opne tomato("Normally these would be found at the following location:")
-      e
-      e "  #{sfile(yaml_location?)}"
-      e
-      if is_on_roebe?
-        e "#{rev}You can also use:"
-        e
-        e '  books --restore'
-        e
-        e 'To copy the old books.' # In fact, we will do this now, anyway.'
-        e
-        # do_restore_the_original_yaml_file
-      end
-    else
-      n_pdf_pages_in_total = 0
-      e "#{rev}#{grey('The following ')}#{royalblue(_.size)} #{rev}"\
-        "#{grey('books are stored as favourites:')}"
-      e
-      if SHOW_HOW_MANY_PAGES_ARE_IN_THAT_PDF_FILE
-        e skyblue('-'*80)
-      end
-      # ===================================================================== #
-      # Iterate over all entries next:
-      # ===================================================================== #
-      _.each_with_index {|this_book, index| index += 1
-        absolute_path = File.absolute_path(this_book)
-        if @internal_hash[:hash_store_the_timestamps].has_key?(absolute_path)
-        else # else must create a new entry.
-          @internal_hash[:hash_store_the_timestamps][absolute_path] = []
-          # ================================================================= #
-          # First add when it was last modified:
-          # ================================================================= #
-          if File.exist? absolute_path
-            @internal_hash[:hash_store_the_timestamps][absolute_path] <<
-              File.mtime(absolute_path)
-          end
-        end
-        if SHOW_HOW_MANY_PAGES_ARE_IN_THAT_PDF_FILE
-          current_array = @internal_hash[:hash_store_the_timestamps][absolute_path]
-          if current_array.size > 1 # In this case we assume a page.
-            first = current_array.first # n pages in this pdf file.
-            if first.is_a?(String) # Do nothing in this case.
-            else
-              # =============================================================== #
-              # Here, we must compare the File.mtime data.
-              # =============================================================== #
-              if File.exist? absolute_path
-                modification = File.mtime(absolute_path) - first
-              end
-              if modification and modification > 1
-                n_pages = ::PdfParadise.n_pages_in_this_pdf_file(this_book) { :be_quiet }
-              else
-                n_pages = current_array.last
-              end
-            end
-          else
-            n_pages = ::PdfParadise.n_pages_in_this_pdf_file(this_book) { :be_quiet }
-            @internal_hash[:hash_store_the_timestamps][absolute_path] << n_pages
-          end
-        end
-        n_pdf_pages_in_total += n_pages.to_i
-        case optional_arguments
-        # =================================================================== #
-        # === :full_path
-        # =================================================================== #
-        when :full_path
-        else
-          this_book = File.basename(this_book)
-        end
-        result = ''.dup
-        result << ' ' if (n_favourite_books > 9) and (index < 10)
-        result << "#{green('(')}"\
-                  "#{steelblue(index)}"\
-                  "#{green(')')} "\
-                  "#{sfancy(this_book)}".dup
-        result << lightsteelblue(
-          " (#{n_pages} pages)"
-        ) if SHOW_HOW_MANY_PAGES_ARE_IN_THAT_PDF_FILE
-        result.prepend(' ')
-        e result
-      }
-      if SHOW_HOW_MANY_PAGES_ARE_IN_THAT_PDF_FILE
-        e skyblue('-'*80)
-        e royalblue(
-            (n_pdf_pages_in_total.to_s+' pages in total').
-            rjust(66)
-          )
-      end
-      e
-    end
-    store_the_timestamps_into_a_local_yaml_file
-  end; alias do_query_favourites show_the_favourites # === do_query_favourites
-
   # ========================================================================= #
   # === restore_the_original_yaml_file
   #  
@@ -562,7 +455,11 @@ class Books < Base # === Roebe::Books
     new_target = '/home/x/Temp/roebe/favourite_books.yml'
     mkdir(File.dirname(new_target))
     original_file = "#{project_base_dir?}yaml/books/favourite_books.yml"
-    opnn; copy_file(original_file, new_target) { :be_verbose }
+    if File.exist? original_file
+      opnn; copy_file(original_file, new_target) { :be_verbose }
+    else
+      opnn; no_file_exists_at(original_file)
+    end
   end; alias do_restore_the_original_yaml_file restore_the_original_yaml_file # === do_restore_the_original_yaml_file
 
   # ========================================================================= #
@@ -770,6 +667,151 @@ class Books < Base # === Roebe::Books
     }
   end; alias open_in_pdf_viewer open_this_pdf_file # === open_in_pdf_viewer
 
+  # ========================================================================= #
+  # === inform_the_user_how_to_restore_the_books
+  # ========================================================================= #
+  def inform_the_user_how_to_restore_the_books
+    e "#{rev}You can also use:"
+    e
+    e '  books --restore'
+    e
+    e 'To copy the old books.' # In fact, we will do this now, anyway.'
+    e
+    # do_restore_the_original_yaml_file
+  end
+
+  # ========================================================================= #
+  # === elegantly_show_all_favourites
+  #
+  #
+  # This method will show all favourite books.
+  #
+  # This method, rewritten in January 2024, will make use of unicode
+  # horizontal bars, and also show more information than the old
+  # method did.
+  # ========================================================================= #
+  def elegantly_show_all_favourites(
+      optional_arguments = nil, # or :full_path
+      _                  = favourite_books?
+    )
+    n_favourite_books = _.size
+    if _.empty? # No books were found.
+      opne tomato('No .pdf books are available for the current library.')
+      opne tomato("Normally these would be found at the following location:")
+      e
+      e "  #{sfile(yaml_location?)}"
+      e
+      if is_on_roebe?
+        inform_the_user_how_to_restore_the_books
+      end
+    else
+      n_pdf_pages_in_total = 0
+      unicode_horizontal_bar = EmojiParadise.unicode_horizontal_bar
+      e "#{rev}#{grey('The following ')}#{royalblue(_.size)} #{rev}"\
+        "#{grey('books are stored as favourites:')}"
+      e
+      e olivedrab(' Index | Title'\
+       '                                                                                  '\
+       '| n pages')
+      if SHOW_HOW_MANY_PAGES_ARE_IN_THAT_PDF_FILE
+        e olivedrab(unicode_horizontal_bar * 108)
+      end
+      # ===================================================================== #
+      # Iterate over all entries next:
+      # ===================================================================== #
+      _.each_with_index {|this_book, index| index += 1
+        absolute_path = File.absolute_path(this_book)
+        if @internal_hash[:hash_store_the_timestamps].has_key?(absolute_path)
+        else # else must create a new entry.
+          @internal_hash[:hash_store_the_timestamps][absolute_path] = []
+          # ================================================================= #
+          # First add when it was last modified:
+          # ================================================================= #
+          if File.exist? absolute_path
+            @internal_hash[:hash_store_the_timestamps][absolute_path] <<
+              File.mtime(absolute_path)
+          end
+        end
+        if SHOW_HOW_MANY_PAGES_ARE_IN_THAT_PDF_FILE
+          current_array = @internal_hash[:hash_store_the_timestamps][absolute_path]
+          if current_array.size > 1 # In this case we assume a page.
+            first = current_array.first # n pages in this pdf file.
+            if first.is_a?(String) # Do nothing in this case.
+            else
+              # =============================================================== #
+              # Here, we must compare the File.mtime data.
+              # =============================================================== #
+              if File.exist? absolute_path
+                modification = File.mtime(absolute_path) - first
+              end
+              begin
+                if modification and modification > 1
+                  n_pages = ::PdfParadise.n_pages_in_this_pdf_file(this_book) { :be_quiet }
+                else
+                  n_pages = current_array.last
+                end
+              rescue ArgumentError => error
+                pp error
+                e sfile(yaml_file?)
+                e sfile(the_stored_timestamps_of_all_opened_pdf_books_are_where?)
+              end
+            end
+          else
+            n_pages = ::PdfParadise.n_pages_in_this_pdf_file(this_book) { :be_quiet }
+            @internal_hash[:hash_store_the_timestamps][absolute_path] << n_pages
+          end
+        end
+        n_pdf_pages_in_total += n_pages.to_i
+        case optional_arguments
+        # =================================================================== #
+        # === :full_path
+        # =================================================================== #
+        when :full_path
+        else
+          this_book = File.basename(this_book)
+        end
+        result = ' '.dup
+        result << ' ' if (n_favourite_books > 9) and (index < 10)
+        result << "#{green('(')}"\
+                  "#{steelblue(index)}"\
+                  "#{green(')')}  #{olivedrab('|')} "\
+                  "#{sfancy(this_book.ljust(86, ' '))}".dup
+        if SHOW_HOW_MANY_PAGES_ARE_IN_THAT_PDF_FILE
+          result << olivedrab(' |')+lightsteelblue(
+            " #{n_pages.to_s.rjust(3,' ')} pages"
+          )
+        end
+        result.prepend(' ')
+        e result # Display the result.
+      }
+      if SHOW_HOW_MANY_PAGES_ARE_IN_THAT_PDF_FILE
+        e olivedrab(unicode_horizontal_bar * 108)
+        e royalblue(
+            (n_pdf_pages_in_total.to_s+' pages in total').
+            rjust(108)
+          )
+      end
+      e
+      store_the_timestamps_into_a_local_yaml_file
+    end
+  end; alias do_query_favourites elegantly_show_all_favourites # === do_query_favourites
+       alias show_the_favourites elegantly_show_all_favourites # === do_query_favourites
+
+  # ========================================================================= #
+  # === into?
+  # ========================================================================= #
+  def into?
+    "#{log_dir?}roebe/favourite_books.yml"
+  end; alias yaml_location? into? # === yaml_location?
+       alias yaml_file?     into? # === yaml_file?
+
+  # ========================================================================= #
+  # === the_stored_timestamps_of_all_opened_pdf_books_are_where?
+  # ========================================================================= #
+  def the_stored_timestamps_of_all_opened_pdf_books_are_where?
+    roebe_log_directory?+'stored_timestamps_of_all_opened_pdf_books.yml'
+  end
+
   # ========================================================================= #
   # === run                                                         (run tag)
   # ========================================================================= #

data/lib/roebe/classes/books/menu.rb

@@ -29,6 +29,14 @@ class Books < ::Roebe::Base # === Roebe::Books
     else
       case i # case tag
       # ===================================================================== #
+      # === books --reopen
+      # ===================================================================== #
+      when /^-?-?reopen/i,
+           /^-?-?restore/i,
+           /^-?-?open(-|_)?all/i
+        do_reopen_all_tracked_pdf_files
+        exit
+      # ===================================================================== #
       # === books 10
       # ===================================================================== #
       when /^\d+$/ # Input is only numbers.
@@ -171,13 +179,6 @@ class Books < ::Roebe::Base # === Roebe::Books
         renew_the_timestamps
         exit
       # ===================================================================== #
-      # === books --reopen
-      # ===================================================================== #
-      when /^-?-?reopen/i,
-           /^-?-?restore/i
-        do_reopen_all_tracked_pdf_files
-        exit
-      # ===================================================================== #
       # === books --exchange=6,1
       #
       # This entry point allows the user to exchange two positions

data/lib/roebe/classes/books/sanitize_this_book_path/sanitize_this_book_path.rb

@@ -16,7 +16,6 @@ module Roebe
 
 class SanitizeThisBookPath < ::Roebe::Base # === Roebe::SanitizeThisBookPath
 
-  require 'pdf_paradise/toplevel_methods/automatic_pdf_title.rb'
   require 'pdf_paradise/utility_scripts/automatic_pdf_title.rb'
 
   # ========================================================================= #

data/lib/roebe/classes/check_yaml.rb

@@ -44,23 +44,27 @@ class CheckYaml < Base # === Roebe::CheckYaml
   # ========================================================================= #
   def run
     _ = first_argument?
-    if File.exist? _
-      begin
-        _dataset = YAML.load_file(_)
-        e "#{rev}All appears to be fine with the file `#{sfile(_)}`."
-      rescue Exception => error
-        e sfile(_)
-        pp error
-      end
+    if _.nil?
+      opne "#{rev}Please supply the path to a locally existing .yml file."
     else
-      no_file_exists_at(_)
+      if File.exist? _
+        begin
+          _dataset = YAML.load_file(_)
+          e "#{rev}All appears to be fine with the file `#{sfile(_)}#{rev}`."
+        rescue Exception => error
+          e sfile(_)
+          pp error
+        end
+      else
+        no_file_exists_at(_)
+      end
     end
   end
 
   # ========================================================================= #
   # === Roebe::CheckYaml[]
   # ========================================================================= #
-  def self.[](i = '')
+  def self.[](i = ARGV)
     new(i)
   end
 
@@ -68,4 +72,4 @@ end; end
 
 if __FILE__ == $PROGRAM_NAME
   Roebe::CheckYaml.new(ARGV)
-end # check_yaml
+end # checkyaml

data/lib/roebe/classes/compile_kernel.rb

@@ -28,7 +28,9 @@ class CompileKernel < Base
 
   include FileUtils::Verbose
 
-  require 'rbt/toplevel_methods/archive_type.rb'
+  begin
+    require 'rbt/toplevel_methods/archive_related_code.rb'
+  rescue LoadError; end
 
   # ========================================================================= #
   # === SRC_DIR

data/lib/roebe/classes/copy_kernel_config.rb

@@ -38,15 +38,17 @@ class CopyKernelConfig < Base # === Roebe::CopyKernelConfig
   # === run
   # ========================================================================= #
   def run
-    opne steelblue('Copying')+' the old kernel-config towards '+
-         sfile('/usr/src/linux/.config')+' next.'
+    opne steelblue('Copying')+rev+
+         ' the old kernel-config towards '+
+         sfile('/usr/src/linux/.config')+
+         rev+' next.'
     if File.symlink? '/usr/src/linux'
        version = File.readlink('/usr/src/linux').split('-').last
        opne 'The linux kernel version is: '+
             royalblue(version)
     end
     esystem 'zcat /proc/config.gz > /usr/src/linux/.config'
-    e 'Now you could run:'
+    opne 'Now you could run:'
     e
     e royalblue('make oldconfig')
     e

data/lib/roebe/classes/create_desktop_file.rb

@@ -138,7 +138,7 @@ class CreateDesktopFile < Roebe::Base # === Roebe::CreateDesktopFile.new
   # ========================================================================= #
   def consider_creating_this_directory(i)
     unless File.exist? i
-      opne "Creating #{sdir(i)} next."
+      opne "#{rev}Creating #{sdir(i)} #{rev}next."
       FileUtils.mkdir_p(i)
     end
   end

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