roebe 0.5.120 → 0.5.121

data/lib/roebe/pdf/README.md

@@ -0,0 +1 @@
+pdf-specific code may reside in this directory.

data/lib/roebe/pdf/prawn/all_in_one_showcasing_prawn.rb

@@ -0,0 +1,160 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === AllInOneShowcasingPrawn
+#
+# Usage examples:
+#   AllInOneShowcasingPrawn.new
+# =========================================================================== #
+require 'opn'
+require 'prawn'
+require 'beautiful_url'
+
+class AllInOneShowcasingPrawn # require 'all_in_one_showcasing_prawn'; AllInOneShowcasingPrawn.new
+
+  # require 'prawn/table'
+  require 'pdf_paradise/prawn_addons/prawn_addons.rb'
+
+  require 'colours'
+  include Colours
+
+  require 'esystem'
+  include Esystem
+
+  THIS_PDF_FILE = '/hello.pdf'
+
+  # ========================================================================= #
+  # === MAIN_PDF
+  # ========================================================================= #
+  MAIN_PDF = '/home/x/programming/ruby/src/roebe/lib/roebe/yaml/main_pdf.yml'
+
+  # ========================================================================= #
+  # Colour-related constants - these are currently wrong.
+  # ========================================================================= #
+  SLATEBLUE = '6A5ACD'
+  CRIMSON   = 'DC143C'
+  RED       = 'FF0000' 
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      run_already = true
+    )
+    reset
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    @pdf_file = THIS_PDF_FILE
+  end
+
+  # ========================================================================= #
+  # === report_what_we_will_do
+  # ========================================================================= #
+  def report_what_we_will_do
+    opn; e 'Now generating file `'+sfile(pdf_file?)+
+           '` (Filesize: '+simp(File.size(pdf_file?).to_s)+' Bytes).'
+  end
+
+  # ========================================================================= #
+  # === AllInOneShowcasingPrawn.return_random_image
+  # ========================================================================= #
+  def self.return_random_image # Right now we just return a hardcoded entry.
+    '/home/x/data/images/NJOY/Torrie_Wilson.jpg' 
+  end
+
+  # ========================================================================= #
+  # === generate_the_pdf_document
+  # ========================================================================= #
+  def generate_the_pdf_document(
+      path_to_image = '/home/x/data/images/NJOY/Susanne_01.jpg'
+    )
+    Prawn::Document.generate(pdf_file?, page_size: 'A4') {
+      font 'Times-Roman'
+      text 'Hello Prawn!'
+      # pdf.image(path_to_dir, :width => 197, :height => 91)
+      image path_to_image
+      draw_text 'Hello World 1', :at => [200,720], :size => 32
+      draw_text 'Hello World 2', :at => [400,920], :size => 28
+      text 'Ruby in Red', :color => 'FF0000'
+      text 'Ruby in Red', :color => '#FF0000'
+      text 'Test', :align => :center, :color => SLATEBLUE
+      text 'Test', :align => :center, :color => CRIMSON
+      text 'Test', :align => :center, :color => RED
+      indent(20) { text('yo') }
+      indent(50) { text('yo') }
+      start_new_page
+      text 'Test', :align => :center, :color => RED
+      text 'Test', :align => :center, :color => RED
+      move_down 70
+      text 'Test', :align => :center, :color => RED
+      text_box 'Your Text Here', :align => :right
+      add_page
+      text_box 'Your Text Here', :align => :right
+      image( AllInOneShowcasingPrawn.return_random_image, :width => 100, :height => 100 )
+      add_page :layout => :portrait
+      text_box 'Your Text Here', :align => :right
+      bounding_box [100, 600], :width => 200 do
+        move_down 15
+        text 'the rain in spain ' * 5
+        move_down 15
+        stroke {
+          line bounds.top_left, bounds.top_right
+          line bounds.bottom_left, bounds.bottom_right
+        }
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === consider_deleting_old_pdf_file
+  # ========================================================================= #
+  def consider_deleting_old_pdf_file
+    File.delete(pdf_file?) if File.exist? pdf_file?
+  end
+
+  # ========================================================================= #
+  # === open_in_pdf_viewer
+  # ========================================================================= #
+  def open_in_pdf_viewer
+    esystem use_this_pdf_viewer+' '+@pdf_file+' &' if File.exist? pdf_file?
+  end
+
+  # ========================================================================= #
+  # === use_this_pdf_viewer
+  # ========================================================================= #
+  def use_this_pdf_viewer
+    _ = 'okular'
+    if File.exist? MAIN_PDF
+      _ = File.read(MAIN_PDF).chomp
+    end
+    return _
+  end
+
+  # ========================================================================= #
+  # === pdf_file?
+  # ========================================================================= #
+  def pdf_file?
+    @pdf_file
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    consider_deleting_old_pdf_file
+    generate_the_pdf_document
+    report_what_we_will_do
+    open_in_pdf_viewer
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  AllInOneShowcasingPrawn.new
+end # pdftest

data/lib/roebe/requires/require_the_run_class.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'roebe/requires/require_the_run_class.rb'
+# =========================================================================== #
+require 'roebe/classes/run/run.rb'

data/lib/roebe/shell/shell/class_methods.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'roebe/shell/shell/class_methods.rb'
+# =========================================================================== #
+require 'roebe/base/base.rb'
+
+module Roebe
+
+class Shell < Base # === Roebe::Shell
+
+  # ========================================================================= #
+  # === Roebe::Shell.file_menu
+  # ========================================================================= #
+  def self.file_menu
+    Roebe.project_base_directory?+'shell/shell/menu.rb'
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Roebe::Shell.file_menu
+  puts File.exist?(Roebe::Shell.file_menu)
+end

data/lib/roebe/shell/shell/core/browser.rb

@@ -79,6 +79,9 @@ class Shell < Base # === Roebe::Shell
     end
   end
 
+  begin
+    require 'open'
+  rescue LoadError; end
   # ========================================================================= #
   # === open_in_browser                                         (browser tag)
   #
@@ -209,7 +212,7 @@ class Shell < Base # === Roebe::Shell
         #   _ << ' &' # This line is not absolutely required.
         # end
         # esystem(_)
-        if Object.const_defined? :Open
+        if Object.const_defined?(:Open)
           if is_on_roebe?
             i = prettify_this_url(i)
           end

data/lib/roebe/shell/shell/core/cat.rb

@@ -75,8 +75,37 @@ class Shell < Base # === Roebe::Shell
       # ===================================================================== #
       this_file = convert_global_env(this_file) if this_file.include? '$'
       if File.file? this_file
-        result = ::Roebe.get_file_content(this_file)
+        # =================================================================== #
+        # Obtain the file content of the target file next:
+        # =================================================================== #
+        result = Roebe.get_file_content(this_file)
         result = result.join if result.is_a? Array
+        extname = File.extname(this_file).delete('.')
+        # =================================================================== #
+        # Enter the following only if we may use colours, among other checks.
+        # =================================================================== #
+        if use_colours? and use_coderay? and defined?(CodeRay)
+          case extname # Won't have leading '.'
+          # ================================================================= #
+          # === cgi, rb
+          # ================================================================= #
+          when 'cgi',
+               'rb'
+            result = CodeRay.scan(result, :ruby).term
+          # ================================================================= #
+          # === py
+          #
+          # This entry point is specifically for python files (aka .py).
+          # ================================================================= #
+          when 'py'
+            result = CodeRay.scan(result, :python).term
+          # ================================================================= #
+          # === php, xml
+          # ================================================================= #
+          when 'php','xml'
+            result = CodeRay.scan(result, extname.to_sym).term
+          end
+        end
         e result 
       else
         e 'File at '+sfile(this_file)+' does not exist.'
@@ -86,7 +115,7 @@ class Shell < Base # === Roebe::Shell
        alias display_file cat # === display_file
        # alias cat        get_file_content # Since Nov 2011 cat is no longer a 1:1 alias.
 
-  def cat2
+  def cat2_DEPRECATED
     if i.is_a? Array
       # ===================================================================== #
       # === Handle redirections next
@@ -126,30 +155,7 @@ class Shell < Base # === Roebe::Shell
         # Ok, first check if the file exists.
         # ===================================================================== #
         if File.exist? i
-          # ================================================================= #
-          # Enter the following only if we may use colours.
-          # ================================================================= #
-          if use_colours?
-            extname = File.extname(i).to_s[1..-1]
-            case extname # Won't have leading '.'
-            # =============================================================== #
-            # === cgi, rb
-            # =============================================================== #
-            when 'cgi',
-                 'rb'
-              result = CodeRay.scan(result, :ruby).term
-            # =============================================================== #
-            # === py
-            # =============================================================== #
-            when 'py' # To test this, do: cat $PROGL/PYTHON/SRC/GAMES/GODMODE/arena.py
-              result = CodeRay.scan(result, :python).term
-            # =============================================================== #
-            # === php, xml
-            # =============================================================== #
-            when 'php','xml'
-              result = CodeRay.scan(result, extname.to_sym).term
-            end if defined?(CodeRay) and use_coderay?
-          end
+          # CHECK FOR CODERAY 111
           # ================================================================= #
           # Next, we scan for HTTP Links if possible.
           # All discovered HTTP-like links will be registered.
@@ -168,9 +174,9 @@ class Shell < Base # === Roebe::Shell
           if result.nil?
             e "Empty file at #{sfile(i.to_s)} (no file content)."
           else
-            # =============================================================== #
+            # ================================================================= #
             # Show the result next. This constitutes the "cat-functionality".
-            # =============================================================== #
+            # ================================================================= #
             e result, :do_not_parse_this
           end
           # ================================================================= #

data/lib/roebe/shell/shell/core/disable.rb

@@ -19,8 +19,19 @@ class Shell < Base # === Roebe::Shell
   # ========================================================================= #
   def disable_colours(
       also_save_config = true,
-      be_verbose       = true
+      be_verbose       = true,
+      &block
     )
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :be_quiet
+      # ===================================================================== #
+      when :be_quiet
+        be_verbose = false
+      end
+    end
     case be_verbose
     # ======================================================================= #
     # === :be_quiet

data/lib/roebe/shell/shell/core/esystem.rb

@@ -97,7 +97,7 @@ class Shell < Base # === Roebe::Shell
       # Next, delegate towards IO.popen. In the past we used system()
       # instead. We will still show the command that will be run.
       # ===================================================================== #
-      e orchid(cmd_to_run)
+      ecolsystem(cmd_to_run)
       begin
         io_object = IO.popen(cmd_to_run, :err => [:child, :out]).each { |line|
           ee line # Output here.
@@ -119,4 +119,13 @@ class Shell < Base # === Roebe::Shell
     end
   end
 
+  # ========================================================================= #
+  # === ecolsystem
+  #
+  # This method can be used to colourize a system command.
+  # ========================================================================= #
+  def ecolsystem(cmd_to_run = 'ls')
+    e orchid(cmd_to_run)
+  end
+
 end; end

data/lib/roebe/shell/shell/core/help.rb

@@ -277,27 +277,6 @@ ROEBE_SUBSECTION
     register_this_help_option
   end
 
-  # ========================================================================= #
-  # === show_help_options_intro
-  #
-  # This method will show the generic header for the available help options
-  # of the Roebe::Shell.
-  # ========================================================================= #
-  def show_help_options_intro
-    e N+'=============================================  '+
-      yel('Roebe::Shell Help Options')+rev+N
-    e 'Shortcuts are available for most inbuilt-commands.'
-    e "  (Note: You can omit the _ and ? in all shortcuts, if you want to.)#{N}" 
-    e 'For a more complete explanation, with all available options, please '\
-      'refer to'
-    e 'the Roebe::Shell tutorial, which can be found here:'
-    e
-    e mediumseagreen('  https://www.rubydoc.info/gems/roebe')
-    e
-    e "The following inbuilt #{pink('help options')} are documented:"
-    e
-  end
-
   # ========================================================================= #
   # === return_sanitized_help_menu
   # ========================================================================= #
@@ -445,4 +424,28 @@ ROEBE_SUBSECTION
     Roebe::Shell.return_help_menu
   end
 
+  # ========================================================================= #
+  # === show_help_options_intro
+  #
+  # This method will show the generic header for the available help options
+  # of the Roebe::Shell.
+  # ========================================================================= #
+  def show_help_options_intro
+    e N+'=============================================  '+
+      yel('Roebe::Shell Help Options', use_colours?)+
+      rev+N
+    e 'Shortcuts are available for most inbuilt-commands.'
+    e "  (Note: You can omit the _ and ? in all shortcuts, if you want to.)#{N}" 
+    e 'For a more complete explanation, with all available options, please '\
+      'refer to'
+    e 'the Roebe::Shell tutorial, which can be found here:'
+    e
+    e mediumseagreen('  https://www.rubydoc.info/gems/roebe', use_colours?)
+    e
+    e "The following inbuilt "+
+      pink('help options', use_colours?)+
+      " are documented:"
+    e
+  end
+
 end; end

data/lib/roebe/shell/shell/core/queries.rb

@@ -10,6 +10,13 @@ module Roebe
 
 class Shell < Base # === Roebe::Shell
 
+  # ========================================================================= #
+  # === last_result?
+  # ========================================================================= #
+  def last_result?
+    @internal_hash[:last_result]
+  end
+
   # ========================================================================= #
   # === open_in_background?
   # ========================================================================= #
@@ -140,13 +147,6 @@ class Shell < Base # === Roebe::Shell
     config? and config?.autoconvert_numbers
   end
 
-  # ========================================================================= #
-  # === last_result?
-  # ========================================================================= #
-  def last_result?
-    @internal_hash[:last_result]
-  end
-
   # ========================================================================= #
   # === hash_file_positions?
   # ========================================================================= #

data/lib/roebe/shell/shell/core/set.rb

@@ -12,6 +12,21 @@ module Roebe
 
 class Shell < Base # === Roebe::Shell
 
+  # ========================================================================= #
+  # === clear_last_result
+  # ========================================================================= #
+  def clear_last_result
+    @internal_hash[:last_result].clear # This should work, as it is a String.
+  end
+
+  # ========================================================================= #
+  # === set_last_result
+  # ========================================================================= #
+  def set_last_result(i)
+    @internal_hash[:last_result] = i
+    return @internal_hash[:last_result]
+  end; alias set_result set_last_result # === set_result
+
   # ========================================================================= #
   # === set_shall_we_try_to_use_readline_for_the_user_input
   # ========================================================================= #

data/lib/roebe/shell/shell/core/show_display_feedback_and_report.rb

@@ -54,6 +54,16 @@ class Shell < Base # === Roebe::Shell
     end
   end
 
+  # ========================================================================= #
+  # === report_return_date
+  # ========================================================================= #
+  def report_return_date
+    _ = return_date
+    e simp(_)
+    set_result(_)
+    return _
+  end
+
   # ========================================================================= #
   # === show_configuration                                       (config tag)
   #
@@ -207,6 +217,7 @@ class Shell < Base # === Roebe::Shell
       _.run
       # _.display # This is no longer necessary as of May 2022.
     end
+    set_result(_.result?) if _.result?
   end; alias display_directory_content show_directory_content # === display_directory_content
 
   # ========================================================================= #
@@ -384,13 +395,6 @@ class Shell < Base # === Roebe::Shell
        alias show_setpoints            show_jumpers # === show_setpoints
        alias setpoints?                show_jumpers # === setpoints?
 
-  # ========================================================================= #
-  # === report_return_date
-  # ========================================================================= #
-  def report_return_date
-    e simp(return_date)
-  end
-
   # ========================================================================= #
   # === show_modules
   #

data/lib/roebe/shell/shell/core/stat.rb

@@ -35,7 +35,10 @@ class Shell < Base # === Roebe::Shell
     end
     if File.exist? this_file
       if Object.const_defined? :StatFile
-        StatFile.new(this_file) # bl $RSRC/stat_file/lib/stat_file/stat_file.rb
+        stat_file = StatFile.new(this_file) # bl $RSRC/stat_file/lib/stat_file/stat_file.rb
+        set_result(
+          stat_file.text?
+        ) # This ^^^ is done specifically to support GUIs.
       else
         e 'The class StatFile is not available. Please install the gem called '\
           'stat_file.'