cyberweb 0.8.17 → 0.9.31

data/lib/cyberweb/utility_scripts/images_to_html/images_to_html.rb

@@ -49,58 +49,9 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
   require 'cyberweb/toplevel_methods/misc.rb'
   require 'cyberweb/toplevel_methods/jquery.rb'
   require 'cyberweb/html_template/html_template.rb'
+  require 'cyberweb/utility_scripts/images_to_html/constants.rb'
   require 'cyberweb/utility_scripts/images_to_html/misc.rb'
 
-  # ========================================================================= #
-  # === NAMESPACE
-  # ========================================================================= #
-  NAMESPACE = inspect
-
-  # ========================================================================= #
-  # === DEBUG
-  #
-  # Whether we debug this class or not.
-  # ========================================================================= #
-  DEBUG = false
-
-  # ========================================================================= #
-  # === ARRAY_IMAGES
-  # ========================================================================= #
-  ARRAY_IMAGES = %w( jpg png gif ) # All valid image-formats.
-
-  # ========================================================================= #
-  # === INFO_DIRECTORY
-  #
-  # This is the base directory where to store, unless we use Dir.pwd.
-  # ========================================================================= #
-  INFO_DIRECTORY = '/Depot/Information/'
-
-  # ========================================================================= #
-  # === BE_VERBOSE
-  # ========================================================================= #
-  BE_VERBOSE = true
-
-  # ========================================================================= #
-  # === HTML
-  # ========================================================================= #
-  HTML = '.html' # HTML File suffice comes here.
-
-  # ========================================================================= #
-  # === IMG_CSS_STYLE
-  #
-  # Determine the default css-rules for each <img> tag to be used.
-  # ========================================================================= #
-  IMG_CSS_STYLE =
-    'border:1px solid black;
-     margin-left: 4.5em;
-     padding-left: 5px;'.
-     delete("\n").squeeze(' ')
-
-  # ========================================================================= #
-  # === FONT_SIZE_TO_USE
-  # ========================================================================= #
-  FONT_SIZE_TO_USE = '1.3em'
-
   # ========================================================================= #
   # === initialize
   #  
@@ -119,7 +70,8 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
     # ======================================================================= #
     # === :do_not_run_yet
     # ======================================================================= #
-    when :do_not_run_yet
+    when :do_not_run_yet,
+         :dont_run_yet
       commandline_arguments = []
       run_already = false
     end
@@ -219,10 +171,22 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
     # ======================================================================= #
     @internal_hash[:use_HTML_table_layout] = false
     # ======================================================================= #
+    # === :use_no_size_value
+    # ======================================================================= #
+    @internal_hash[:use_no_size_value] = false
+    # ======================================================================= #
     # === :use_n_rows_for_the_html_table
     # ======================================================================= # 
     @internal_hash[:use_n_rows_for_the_html_table] = 3
     # ======================================================================= #
+    # === :display_top_header
+    #
+    # If the following variable is set to true then a top-header will
+    # be shown on the webpage, early on, just showing how many images
+    # are displayed, and how large these images are in total.
+    # ======================================================================= #
+    @internal_hash[:display_top_header] = false
+    # ======================================================================= #
     # === :use_jquery
     #
     # Whether we will use jquery by default or whether we will not.
@@ -251,6 +215,16 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
     # This is necessary for the jquery-drag operation.
     # ======================================================================= #
     @internal_hash[:registered_ids] = []
+    # ======================================================================= #
+    # === :display_width_and_height_of_the_image
+    #
+    # The next variable may lead to a slow-down of generating the .html
+    # file at hand, so if this is not acceptable to you, set it to
+    # false. The variable was added in February 2023 because I wanted to
+    # display the width x height, in px, of an image, which is quite
+    # convenient to see on a .html page as-is.
+    # ======================================================================= #
+    @internal_hash[:display_width_and_height_of_the_image] = true
   end
 
   # ========================================================================= #
@@ -260,6 +234,13 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
     @show_the_name_of_the_image_file
   end
 
+  # ========================================================================= #
+  # === this_directory_contains_all_images=
+  # ========================================================================= #
+  def this_directory_contains_all_images=(i = nil)
+    @this_directory_contains_all_images = i
+  end
+
   # ========================================================================= #
   # === clear_images
   # ========================================================================= #
@@ -267,6 +248,13 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
     @array_work_on_these_files.clear # Should always be an Array.
   end; alias clear_array clear_images # === clear_array
 
+  # ========================================================================= #
+  # === array_work_on_these_files?
+  # ========================================================================= #
+  def array_work_on_these_files?
+    @array_work_on_these_files
+  end; alias array_work_on_these_files array_work_on_these_files? # === array_work_on_these_files
+
   # ========================================================================= #
   # === apply_filter
   #
@@ -315,15 +303,6 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
        alias scan_from     scan_for_images_in_this_directory # === scan_from
        alias use_this_dir= scan_for_images_in_this_directory # === use_this_dir=
 
-  # ========================================================================= #
-  # === the_three_main_actions
-  # ========================================================================= #
-  def the_three_main_actions
-    look_for_the_images
-    build_up_the_HTML_string
-    do_create_the_html_page
-  end
-
   # ========================================================================= #
   # === use_HTML_table_layout?
   # ========================================================================= #
@@ -454,9 +433,23 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
       into = save_into_which_file?
     )
     # ======================================================================= #
-    # Make the title a bit cleaner next:
-    # ======================================================================= #
-    use_this_title = File.basename(title?).delete_suffix('.html')
+    # Make the title a bit cleaner next - as well as replace all '_':
+    # ======================================================================= #
+    raw_title_to_use = File.basename(title?).
+                       tr('_',' ').
+                       delete_suffix('.html')
+    if raw_title_to_use.include?(' ')
+      splitted = raw_title_to_use.split(' ')
+      first_word = splitted[0]
+      first_word[0, 1] = first_word[0, 1].capitalize
+      if splitted[1]
+        second_word = splitted[1]
+        second_word[0, 1] = second_word[0, 1].capitalize
+        splitted[1] = second_word
+      end
+      raw_title_to_use = splitted.join(' ')
+    end
+    use_this_title = raw_title_to_use
     # ======================================================================= #
     # Build the .html file via the HtmlTemplate class next:
     # ======================================================================= #
@@ -620,100 +613,12 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
   end
 
   # ========================================================================= #
-  # === menu                                                       (menu tag)
+  # === report_not_registered_commandline_argument
   # ========================================================================= #
-  def menu(
-      i = commandline_arguments?
-    )
-    if i.is_a? Array
-      i.each {|entry| menu(entry) }
-    else
-      case i # case tag
-      # ===================================================================== #
-      # === cweb --tablelayout
-      # ===================================================================== #
-      when /^-?-?tablelayout$/i,
-           /^-?-?table$/i,
-           /^-?-?html(-|_)?tables?$/i,
-           /^-?-?use(-|_)?HTML(-|_)?tables?$/i
-        do_use_HTML_table_layout
-      # ===================================================================== #
-      # === cweb --table=4 # 4 rows
-      #
-      # This entry point allows the user to set another number of rows
-      # for the generated HTML table.
-      # ===================================================================== #
-      when /^-?-?table=(.+)$/i
-        n_rows = $1.to_s.to_i
-        @internal_hash[:use_n_rows_for_the_html_table] = n_rows
-        do_use_HTML_table_layout
-      # ===================================================================== #
-      # === --pwd
-      # ===================================================================== #
-      when /^-?-?pwd$/i, # This means we store in the current directory.
-           :return_pwd
-        set_this_directory_contains_the_images(:pwd)
-        set_store_where(:infer)
-        clear_images
-        scan_for_images_in_this_directory
-        the_three_main_actions
-        exit
-      # ===================================================================== #
-      # === cweb --videos
-      #
-      # This entry point allows us to work on video-files only. If that
-      # is the case then the sorting-mode will be changed - aka to not
-      # sort at all.
-      # ===================================================================== #
-      when /^-?-?videos$/i,
-           /^-?-?videos(-|_)?only$/i
-        @work_on_video_files_only = true
-        @internal_hash[:sort_how] = :do_not_sort_at_all
-      # ===================================================================== #
-      # === cweb --do-not-traverse
-      #
-      # This will NOT check for any images in a subdirectory.
-      # ===================================================================== #
-      when /^-?-?do(-|_)?not(-|_)?traverse$/i,
-           /^-?-?simple$/i # cweb --simple
-        @do_traverse_into_subdirectories = false
-      # ===================================================================== #
-      # === --help
-      # ===================================================================== #
-      when /^-?-?help$/i
-        show_help
-        exit
-      # ===================================================================== #
-      # === ?
-      # ===================================================================== #
-      when '?'
-        opnn; e 'The file in question will be:'
-        e
-        e "  #{sfile(store_where?)}"
-        e
-        exit
-      # ===================================================================== #
-      # === --njoy
-      # ===================================================================== #
-      when /-?-?njoy$/i,
-           :njoy
-        e 'We will use the excellent images from a special directory.'
-        scan_there :njoy
-      else
-        if i.is_a?(String) and File.directory?(i)
-          # ================================================================= #
-          # (1) Assign a new main directory.
-          # ================================================================= #
-          set_this_directory_contains_all_images(i)
-          # ================================================================= #
-          # (2) Infer a new name for the locally saved file.
-          # ================================================================= #
-          set_save_into_this_local_file(
-            :use_the_directory_containing_all_images_as_base
-          )
-        end
-      end
-    end
+  def report_not_registered_commandline_argument(i)
+    opnn; e tomato('The commandline argument `')+
+            steelblue(i)+
+            tomato('` is not registered.')
   end
 
   # ========================================================================= #
@@ -728,9 +633,16 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
     e steelblue('  NJOY')
     e steelblue('  PWD')
     e steelblue('  ?')
-    e steelblue('  --videos-only     ')+lightgreen('# to work on video-files only')
-    e steelblue('  --do-not-traverse ')+lightgreen('# do not obtain images from any subdirectory')
-    e steelblue('  --use-HTML-table  ')+lightgreen('# display via a HTML table; currently hardcoded to 3 images per row')
+    e steelblue('  --videos-only        ')+
+      lightgreen('# to work on video-files only')
+    e steelblue('  --do-not-traverse    ')+
+      lightgreen('# do not obtain images from any subdirectory')
+    e steelblue('  --use-HTML-table     ')+
+      lightgreen('# display via a HTML table; currently hardcoded to 3 images per row')
+    e steelblue('  --table=2            ')+
+      lightgreen('# use a HTML table, but 2 images per row, so you can change this setting actually')
+    e steelblue('  --use-no-size-value  ')+
+      lightgreen('# do not use explicit width and height setting; the images will appear as-is')
     e
   end
 
@@ -745,13 +657,21 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
   # some time before that day. 
   # ========================================================================= #
   def return_image(i)
+    if i.is_a? Array # Arrays should not be passed into this method.
+      e 'An array was passed to .return_image(). This is presently not allowed.'
+      e
+      pp caller()
+      e
+      raise Exception
+    end
     result = ''.dup
     i = rds(i)
     if show_the_name_of_the_image_file? and !use_html_table?
       result <<
         '<h2 style="color:orange; font-style: italic; padding: 5px">'+i+'</h2>'+NBR
     end
-    new_filename = File.basename(i).gsub(/#{File.extname(i)}/, '')
+    new_filename = File.basename(i).
+                   sub(/#{File.extname(i)}/, '')
     id = 'drag_'+
          Cyberweb.sanitize_this_id(new_filename)
     # ======================================================================= #
@@ -760,7 +680,7 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
     @internal_hash[:registered_ids] << id
     result << '<img id="'+id+'" style="'+IMG_CSS_STYLE+'" src="'+i+'"'.dup
     if use_HTML_table?
-      result << ' width="440"'
+      result << ' width="440"' unless use_no_size_value?
     end
     result << '>'+NBR
     if use_jquery?
@@ -770,9 +690,17 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
   });
   </script>'
     end
+    # puts "Debug: we return #{result}"
     return result
   end
 
+  # ========================================================================= #
+  # === use_no_size_value?
+  # ========================================================================= #
+  def use_no_size_value?
+    @internal_hash[:use_no_size_value]
+  end
+
   # ========================================================================= #
   # === build_up_the_HTML_string
   #
@@ -788,6 +716,38 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
     if use_jquery?
       _ << return_jquery
     end
+    # ======================================================================= #
+    # We have to determine whether the user wants to show a HTML-header,
+    # via a special <div> element. If so then this will be shown first.
+    # ======================================================================= #
+    if display_top_header?
+_ << '
+<style>
+#rounded_corners {
+  border: 2px solid #73AD21;
+  border-radius: 22px;
+  padding:  18px; 
+  width:   500px;
+  height:  100px;
+  margin-bottom: 1.5em;
+  margin-left:  8%;
+  width:       60%;
+}
+</style>
+'
+
+_ << '<div id="rounded_corners">'
+_ << '<b style="color: gold">'+
+      array.size.to_s+' images</b> will be shown next. '
+
+total_file_size = array.map {|entry| File.size(entry) }.sum
+n_kb            = (total_file_size / 1000.0).round(1)
+n_mb            = (n_kb / 1000.0).round(1)
+
+_ << 'These images have a collective (total) file size of <b style="color: lightblue">'+
+     n_mb.to_s+' MB</b>.'
+_ << '</div>'
+    end
     if use_HTML_table_layout?
       _ << "<table style=\"table-layout: fixed\">\n" # This will force equally spaced cells.
     end
@@ -816,14 +776,22 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
           _ << "</div>\n"
         else
           # ================================================================= #
-          # This clause will be entered if we use a HTML table layout.
+          # This clause will be entered if we use a HTML table layout. We
+          # will show the filesize, in kb; and since as of February 2023
+          # we will also show the width_x_height value.
           # ================================================================= #
           if use_HTML_table_layout?
+            width_of_the_image  = ImageParadise.width_of_this_image?(this_entry).to_s
+            height_of_the_image = ImageParadise.height_of_this_image?(this_entry).to_s
             filesize_string = ' <span style="color: lightblue">'+
                               '(<b>filesize</b>: <b>'+
                               (File.size(this_entry).to_f / 1000.0).floor(0).to_s+
-                              '</b> <b>kb</b>)'+
-                              '</span>'
+                              '</b> <b>kb</b>'.dup
+            if @internal_hash[:display_width_and_height_of_the_image]
+              filesize_string << ', <b>'+width_of_the_image+'x'+
+                                 height_of_the_image.to_s+'px</b>'
+            end
+            filesize_string << ')</span>'
             # =============================================================== #
             # Determine the raw description for the image, based on the
             # filename itself.
@@ -865,6 +833,23 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
     set_content_of_the_html_page(_)
   end
 
+  # ========================================================================= #
+  # === the_three_main_actions
+  # ========================================================================= #
+  def the_three_main_actions
+    look_for_the_images
+    the_two_last_actions
+  end
+
+  # ========================================================================= #
+  # === the_two_last_actions
+  # ========================================================================= #
+  def the_two_last_actions
+    build_up_the_HTML_string
+    do_create_the_html_page
+    return save_into_this_local_file?
+  end
+
   # ========================================================================= #
   # === run
   # ========================================================================= #

data/lib/cyberweb/utility_scripts/images_to_html/misc.rb

@@ -51,6 +51,13 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
     super(namespace: NAMESPACE)
   end
 
+  # ========================================================================= #
+  # === display_top_header?
+  # ========================================================================= #
+  def display_top_header?
+    @internal_hash[:display_top_header]
+  end
+
   # ========================================================================= #
   # === debug
   # ========================================================================= #
@@ -59,4 +66,116 @@ class ImagesToHtml < ::Cyberweb::Base # === Cyberweb::ImagesToHtml
     pp store_where?
   end
 
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === cweb --display-top-header
+      # ===================================================================== #
+      when /^-?-?display(-|_| )?top(-|_| )?header$/i,
+           /^-?-?do(-|_| )?display(-|_| )?top(-|_| )?header$/i
+        @internal_hash[:display_top_header] = true
+      # ===================================================================== #
+      # === cweb --table=4 # 4 rows
+      #
+      # This entry point allows the user to set another number of rows
+      # for the generated HTML table.
+      # ===================================================================== #
+      when /^-?-?table=(.+)$/i
+        n_rows = $1.to_s.to_i
+        @internal_hash[:use_n_rows_for_the_html_table] = n_rows
+        do_use_HTML_table_layout
+      # ===================================================================== #
+      # === cweb --use-no-size-value
+      # ===================================================================== #
+      when /^-?-?use(-|_)?no(-|_)?size(-|_)?value$/i,
+           /^-?-?no(-|_)?special(-|_)?size$/i
+        @internal_hash[:use_no_size_value] = true
+      # ===================================================================== #
+      # === cweb --tablelayout
+      # ===================================================================== #
+      when /^-?-?tablelayout$/i,
+           /^-?-?table$/i,
+           /^-?-?html(-|_)?tables?$/i, # === cweb --html-table
+           /^-?-?use(-|_)?HTML(-|_)?tables?$/i,
+           /^-?-?use(-|_)?HTML$/i
+        do_use_HTML_table_layout
+      # ===================================================================== #
+      # === --pwd
+      # ===================================================================== #
+      when /^-?-?pwd$/i, # This means we store in the current directory.
+           :return_pwd
+        set_this_directory_contains_the_images(:pwd)
+        set_store_where(:infer)
+        clear_images
+        scan_for_images_in_this_directory
+        the_three_main_actions
+        exit
+      # ===================================================================== #
+      # === cweb --videos
+      #
+      # This entry point allows us to work on video-files only. If that
+      # is the case then the sorting-mode will be changed - aka to not
+      # sort at all.
+      # ===================================================================== #
+      when /^-?-?videos$/i,
+           /^-?-?videos(-|_)?only$/i
+        @work_on_video_files_only = true
+        @internal_hash[:sort_how] = :do_not_sort_at_all
+      # ===================================================================== #
+      # === cweb --do-not-traverse
+      #
+      # This will NOT check for any images in a subdirectory.
+      # ===================================================================== #
+      when /^-?-?do(-|_)?not(-|_)?traverse$/i,
+           /^-?-?simple$/i # cweb --simple
+        @do_traverse_into_subdirectories = false
+      # ===================================================================== #
+      # === --help
+      # ===================================================================== #
+      when /^-?-?help$/i
+        show_help
+        exit
+      # ===================================================================== #
+      # === ?
+      # ===================================================================== #
+      when '?'
+        opnn; e 'The file in question will be:'
+        e
+        e "  #{sfile(store_where?)}"
+        e
+        exit
+      # ===================================================================== #
+      # === --njoy
+      # ===================================================================== #
+      when /-?-?njoy$/i,
+           :njoy
+        e 'We will use the excellent images from a special directory.'
+        scan_there :njoy
+      else
+        if i.is_a?(String) and File.directory?(i)
+          # ================================================================= #
+          # (1) Assign a new main directory.
+          # ================================================================= #
+          set_this_directory_contains_all_images(i)
+          # ================================================================= #
+          # (2) Infer a new name for the locally saved file.
+          # ================================================================= #
+          set_save_into_this_local_file(
+            :use_the_directory_containing_all_images_as_base
+          )
+        elsif i.start_with?('--') # Report that this commandline argument is not registered.
+          report_not_registered_commandline_argument(i)
+        end
+      end
+    end
+  end
+
 end; end

data/lib/cyberweb/version/version.rb

@@ -9,12 +9,12 @@ module Cyberweb
   # ========================================================================= #
   # === VERSION
   # ========================================================================= #
-  VERSION = '0.8.17'
+  VERSION = '0.9.31'
 
   # ========================================================================= #
   # === LAST_UPDATE
   # ========================================================================= #
-  LAST_UPDATE = '26.01.2023'
+  LAST_UPDATE = '18.03.2023'
 
   # ========================================================================= #
   # === URL_TO_THE_DOCUMENTATION

data/lib/cyberweb/web_images/array_listing_all_project_images.rb

@@ -12,7 +12,7 @@ module WebImages
 
   require 'yaml'
   # ========================================================================= #
-  # bl $RUBY_SRC/web_images/lib/web_images/yaml/web_images.yml
+  # bl $RUBY_CYBERWEB/yaml/web_images.yml
   # ========================================================================= #
   _ = FILE_WEB_IMAGES
   if File.exist? _

data/lib/cyberweb/web_images/map_symbol_to_image_location.rb

@@ -20,15 +20,16 @@ module WebImages
   # ========================================================================= #
   # === Cyberweb::WebImages::IMG_DIR
   #
-  # This constant points to the main image directory. In September 2020 I
-  # tried to bundle the images within the Cyberweb project, but I ran
+  # This constant points to the main image directory. In September 2020
+  # I tried to bundle the images within the Cyberweb project, but I ran
   # into problems so I had to revert this for now.
   #
   # At a later time I may re-evaluate this decision. The next line of code
   # will be retained as a reminder.
   # ========================================================================= #
   # IMG_DIR = "#{::Cyberweb.project_base_dir?}images/real/"
-  IMG_DIR = 'STD/'
+  # IMG_DIR = 'STD/'
+  IMG_DIR = "#{::Cyberweb.project_base_dir?}images/standard_images/"
 
   # ========================================================================= #
   # === Cyberweb::WebImages.map_symbol_to_image_location
@@ -867,7 +868,8 @@ module WebImages
     # ======================================================================= #
     # === :minibaum1
     # ======================================================================= #
-    when :minibaum1
+    when :minibaum1,
+         :baum1
       _ = "#{IMG_DIR}MINI_BAUM1.png"
     # ======================================================================= #
     # === :minibaum2
@@ -1067,7 +1069,11 @@ module WebImages
       _ = "#{IMG_DIR}PFEIL10.png"
     when :pfeil11
       _ = "#{IMG_DIR}PFEIL11.png"
-    when :pfeil12, :explanation
+    # ======================================================================= #
+    # === :pfeil12
+    # ======================================================================= #
+    when :pfeil12,
+         :explanation
       _ = "#{IMG_DIR}PFEIL12.png"
     # ======================================================================= #
     # === :pfeil_links_oben
@@ -1581,6 +1587,11 @@ module WebImages
     when :webserver
       _ = "#{IMG_DIR}WEBSERVER.png"
     # ======================================================================= #
+    # === :windows_key
+    # ======================================================================= #
+    when :windows_key
+      _ = "#{IMG_DIR}windows_key.png"
+    # ======================================================================= #
     # === :wings
     # ======================================================================= #
     when :wings