cyberweb 0.12.35 → 0.13.12

data/lib/cyberweb/toplevel_methods/video.rb

@@ -12,8 +12,8 @@ module Cyberweb
   # ========================================================================= #
   # Constants specific to Video things go into this file as well.
   # ========================================================================= #
-  DEFAULT_VIDEO_WIDTH  = '380'
-  DEFAULT_VIDEO_HEIGHT = '260'
+  DEFAULT_VIDEO_WIDTH  = '480'
+  DEFAULT_VIDEO_HEIGHT = '340'
 
   # ========================================================================= #
   # === Cyberweb.youtube                                        (youtube tag)
@@ -414,6 +414,24 @@ EOF
     ee _
   end
 
+  # ========================================================================= #
+  # === Cyberweb.is_a_video_file?
+  #
+  # This method can be used to determine whether xyz is a video file or
+  # whether it is not.
+  #
+  # Usage example:
+  #
+  #   Cyberweb.is_a_video_file?('/tmp/foobar.avi')
+  #
+  # ========================================================================= #
+  def self.is_a_video_file?(
+      this_file = 'foobar.mp4'
+    )
+    array = %w( .avi .mp4 .mkv .webm )
+    array.include? File.extname(this_file)
+  end
+
   # ========================================================================= #
   # === imdb                                                       (imdb tag)
   #
@@ -423,7 +441,7 @@ EOF
       title,
       where_precisely
     )
-    base_url = 'http://www.imdb.com/title/'
+    base_url = 'https://www.imdb.com/title/'
     string_link(
       base_url+where_precisely,
       title

data/lib/cyberweb/toplevel_methods/write_what_into.rb

@@ -20,8 +20,8 @@ module Cyberweb
         file.write(what) # Write the new file here.
       }
     rescue Errno::EACCES => error # Need to rescue permission errors.
-      puts 'When trying to use Cyberweb.write_what_into() an '\
-           'access-error occurred:'
+      puts 'When trying to use the method Cyberweb.write_what_into() '\
+           'an access-error occurred:'
       pp error
       pp `whoami` # This line will only work on linux-like systems.
       exit

data/lib/cyberweb/utility_scripts/autogenerate_drop_shadow_rules/autogenerate_drop_shadow_rules.rb

@@ -7,16 +7,14 @@
 # This class is only useful on my home system really. It will generate
 # all drop-shadow CSS rules that are part of the cyberweb framework.
 # =========================================================================== #
-# require 'cyberweb/utility_scripts/images_to_html/images_to_html.rb'
+# require 'cyberweb/utility_scripts/autogenerate_drop_shadow_rules/autogenerate_drop_shadow_rules.rb'
 # webpage = Cyberweb::AutogenerateDropShadowRules.new
 # ============================================================================ #
 require 'cyberweb/base/base.rb'
 
 module Cyberweb
 
-class AutogenerateDropShadowRules < ::Cyberweb::Base
-
-  require 'cyberweb/utility_scripts/images_to_html/misc.rb'
+class AutogenerateDropShadowRules < ::Cyberweb::Base # === Cyberweb::AutogenerateDropShadowRules
 
   # ========================================================================= #
   # === initialize

data/lib/cyberweb/utility_scripts/booklet/booklet.rb

@@ -19,10 +19,6 @@ module Cyberweb
 
 class Booklet < Base # === Cyberweb::Booklet
 
-  alias e puts
-
-  require 'cyberweb/requires/require_the_html_template.rb'
-
   # ========================================================================= #
   # === initialize
   # ========================================================================= #

data/lib/cyberweb/utility_scripts/download_all_images_from_this_website.rb

@@ -12,7 +12,7 @@ module Cyberweb
 
 class DownloadAllImagesFromThisWebsite < Base # === Cyberweb::DownloadAllImagesFromThisWebsite
 
-  require 'cyberweb/toplevel_methods/misc.rb'
+  require 'cyberweb/toplevel_methods/toplevel_methods.rb'
   require 'cyberweb/toplevel_methods/sort_this_array_by_time.rb'
 
   require 'uri'

data/lib/cyberweb/utility_scripts/{download_balloon_css.rb → download_balloon_css/download_balloon_css.rb}

@@ -11,7 +11,7 @@
 #   Cyberweb::DownloadBalloonCss.new
 #
 # =========================================================================== #
-# require 'cyberweb/utility_scripts/download_balloon_css.rb'
+# require 'cyberweb/utility_scripts/download_balloon_css/download_balloon_css.rb'
 # =========================================================================== #
 require 'cyberweb/base/base.rb'
 

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

@@ -264,6 +264,9 @@ class ImagesToHtml < ::Cyberweb::ObtainFilesAndDirectoriesFromThisPath # === Cyb
                                  '</b> <b>kb</b>'.dup
             end
             if display_width_and_height_of_the_image?
+              # ============================================================= #
+              # Add the width and height of the image next:
+              # ============================================================= #
               filesize_string << ', <b>'+width_of_the_image+'x'+
                                  height_of_the_image.to_s+'px</b>'
             end

data/lib/cyberweb/utility_scripts/obtain_files_and_directories_from_this_path/obtain_files_and_directories_from_this_path.rb

@@ -211,10 +211,6 @@ a:hover {
     # ======================================================================= #
     @internal_hash[:show_year_in_the_header] = true
     # ======================================================================= #
-    # === :be_verbose
-    # ======================================================================= #
-    @internal_hash[:be_verbose] = BE_VERBOSE
-    # ======================================================================= #
     # === :sort_how
     #
     # The next variable determines if, and how, we should sort on the
@@ -247,6 +243,13 @@ a:hover {
     # ======================================================================= #
     @internal_hash[:content_of_the_HTML_page] = ''.dup
     # ======================================================================= #
+    # === :add_date_in_the_lower_part_of_the_webpage
+    #
+    # Add dates in the lower part of the webpage, if the following
+    # variable is set to true. It will be false initially.
+    # ======================================================================= #
+    @internal_hash[:add_date_in_the_lower_part_of_the_webpage] = false
+    # ======================================================================= #
     # === :files
     #
     # This Array will contain all the different files that were found
@@ -278,12 +281,6 @@ a:hover {
     # ======================================================================= #
     @internal_hash[:make_use_of_a_go_down_one_level_link] = true
     # ======================================================================= #
-    # === :use_HTML_table_layout
-    #
-    # This variable will be true if we make use of a HTML table layout.
-    # ======================================================================= #
-    @internal_hash[:use_HTML_table_layout] = false
-    # ======================================================================= #
     # === :use_jquery
     #
     # This boolean variable will determine whether this class will use
@@ -323,6 +320,9 @@ a:hover {
     do_not_include_subdirectories
     # ======================================================================= #
     # === :add_hyperlinks_to_subdirectories
+    #
+    # This will determine the most bottom div - the one that may show
+    # various hyperlinks to the subdirectories in the working directory.
     # ======================================================================= #
     @internal_hash[:add_hyperlinks_to_subdirectories] = false
     # ======================================================================= #
@@ -334,6 +334,20 @@ a:hover {
     # ======================================================================= #
     @internal_hash[:use_german] = true
     # ======================================================================= #
+    # === :be_verbose
+    # ======================================================================= #
+    @internal_hash[:be_verbose] = BE_VERBOSE
+    # ======================================================================= #
+    # === :use_HTML_table_layout
+    #
+    # This variable will be true if we make use of a HTML table layout.
+    #
+    # This is currently used by pdf_to_html.rb, showing various .pdf files,
+    # as well as by images_to_html.rb, so we have to keep that in mind -
+    # it will do different things for each individual .rb file there.
+    # ======================================================================= #
+    @internal_hash[:use_HTML_table_layout] = false
+    # ======================================================================= #
     # === :save_into_this_local_file
     # ======================================================================= #
     set_save_into_this_local_file(
@@ -431,6 +445,26 @@ a:hover {
        alias save_file               do_store_the_content # === save_file
        alias append_everything       do_store_the_content # === append_everything
 
+  # ========================================================================= #
+  # === add_date_in_the_lower_part_of_the_webpage?
+  # ========================================================================= #
+  def add_date_in_the_lower_part_of_the_webpage?
+    @internal_hash[:add_date_in_the_lower_part_of_the_webpage]
+  end
+
+  # ========================================================================= #
+  # === return_the_pretty_name_of_the_webpage
+  #
+  # This method will return the pretty name of the webpage.
+  # ========================================================================= #
+  def return_the_pretty_name_of_the_webpage
+    _ = File.basename(save_into_this_local_file?).
+             delete_suffix('.html').
+             tr('_',' ')
+    _ = _.split(' ').map(&:capitalize).join(' ').strip if _.include?(' ')
+    return _
+  end
+
   # ========================================================================= #
   # === filter_for_these_files                                   (filter tag)
   #
@@ -463,7 +497,7 @@ a:hover {
         # =================================================================== #
         when :multimedia_files
           begin
-            require 'multimedia_paradise/toplevel_methods/is_a_multimedia_file.rb'
+            require 'multimedia_paradise/toplevel_methods/is_audio_file_is_video_file_is_image_file_is_multimedia_file.rb'
             ::MultimediaParadise.is_a_multimedia_file?(entry)
           rescue LoadError; end
         # =================================================================== #
@@ -538,15 +572,20 @@ a:hover {
     else
       case i # case tag
       # ===================================================================== #
-      # === cweb --do-not-include-subdirectories
-      # ===================================================================== #
-      when /^-?-?do(-|_)?not(-|_)?include(-|_)?subdirectories$/i
-        do_not_include_subdirectories
-      # ===================================================================== #
-      # === cweb --traverse
+      # === cweb --add-date-in-the-lower-part
+      #
+      # This will also add additional information in the lower part of
+      # the generated webpage, specifically showing the time range
+      # if possible, the years. Example: (2021 to 2024)
+      #
+      # Usage example:
+      #
+      #   pdf1  --add-date-in-the-lower-part
+      #
       # ===================================================================== #
-      when /^-?-?traverse$/i
-        @internal_hash[:do_traverse_into_subdirectories] = true
+      when /^-?-?add(-|_)?date(-|_)?in(-|_)?the(-|_)?lower(-|_)?part$/i,
+           /^-?-?lower(-|_)?part$/i
+        @internal_hash[:add_date_in_the_lower_part_of_the_webpage] = true
       # ===================================================================== #
       # === cweb --add-hyperlinks-to-subdirectories
       #
@@ -558,6 +597,25 @@ a:hover {
            /^-?-?bottom$/i # === cweb --bottom
         @internal_hash[:add_hyperlinks_to_subdirectories] = true
       # ===================================================================== #
+      # === cweb --tablelayout
+      # ===================================================================== #
+      when /^-?-?tablelayout$/i,
+           /^-?-?table$/i,
+           /^-?-?html(-|_)?tables?$/i,          # === cweb --html-table
+           /^-?-?use(-|_)?HTML(-|_)?tables?$/i, # === cweb --use-HTML-table
+           /^-?-?use(-|_)?HTML$/i
+        do_use_HTML_table_layout
+      # ===================================================================== #
+      # === cweb --do-not-include-subdirectories
+      # ===================================================================== #
+      when /^-?-?do(-|_)?not(-|_)?include(-|_)?subdirectories$/i
+        do_not_include_subdirectories
+      # ===================================================================== #
+      # === cweb --traverse
+      # ===================================================================== #
+      when /^-?-?traverse$/i
+        @internal_hash[:do_traverse_into_subdirectories] = true
+      # ===================================================================== #
       # === --do-include-subdirectories
       #
       # This option allows the use to include all files in all subdirectories
@@ -605,15 +663,6 @@ a:hover {
            /^-?-?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
-      # ===================================================================== #
       # === cweb --videos
       #
       # This entry point allows us to work on video-files only. If that
@@ -814,13 +863,6 @@ a:hover {
     @internal_hash[:use_jquery]
   end
 
-  # ========================================================================= #
-  # === do_use_HTML_table_layout
-  # ========================================================================= #
-  def do_use_HTML_table_layout
-    @internal_hash[:use_HTML_table_layout] = true
-  end
-
   # ========================================================================= #
   # === make_use_of_a_go_down_one_level_link?
   #
@@ -890,15 +932,6 @@ a:hover {
     e
   end
 
-  # ========================================================================= #
-  # === use_HTML_table_layout?
-  # ========================================================================= #
-  def use_HTML_table_layout?
-    @internal_hash[:use_HTML_table_layout]
-  end; alias use_html_table_layout? use_HTML_table_layout? # === use_html_table_layout?
-       alias use_html_table?        use_HTML_table_layout? # === use_html_table?
-       alias use_HTML_table?        use_HTML_table_layout? # === use_HTML_table?
-
   # ========================================================================= #
   # === add                                                         (add tag)
   #
@@ -1100,6 +1133,15 @@ a:hover {
     '<span style="color: gold; '+optional_css_style+'">'+i.to_s+'</span>'
   end
 
+  # ========================================================================= #
+  # === olivedrab
+  # ========================================================================= #
+  def olivedrab(
+      i, optional_css_style = ''
+    )
+    '<span style="color: olivedrab; '+optional_css_style+'">'+i.to_s+'</span>'
+  end
+
   # ========================================================================= #
   # === mediumorchid
   # ========================================================================= #
@@ -1110,21 +1152,21 @@ a:hover {
   end
 
   # ========================================================================= #
-  # === mediumseagreen
+  # === paleturquoise
   # ========================================================================= #
-  def mediumseagreen(
+  def paleturquoise(
       i, optional_css_style = ''
     )
-    '<span style="color: mediumseagreen; '+optional_css_style+'">'+i.to_s+'</span>'
+    '<span style="color: paleturquoise; '+optional_css_style+'">'+i.to_s+'</span>'
   end
 
   # ========================================================================= #
-  # === olivedrab
+  # === mediumseagreen
   # ========================================================================= #
-  def olivedrab(
+  def mediumseagreen(
       i, optional_css_style = ''
     )
-    '<span style="color: olivedrab; '+optional_css_style+'">'+i.to_s+'</span>'
+    '<span style="color: mediumseagreen; '+optional_css_style+'">'+i.to_s+'</span>'
   end
 
   # ========================================================================= #
@@ -1183,7 +1225,37 @@ a:hover {
   end
 
   # ========================================================================= #
-  # === add_the_footer_with_hyperlinks                           (footer tag)
+  # === colour_for_pdf_files
+  # ========================================================================= #
+  def colour_for_pdf_files(i)
+    mediumorchid(i)
+  end
+
+  # ========================================================================= #
+  # === do_not_use_HTML_table_layout
+  # ========================================================================= #
+  def do_not_use_HTML_table_layout
+    @internal_hash[:use_HTML_table_layout] = false
+  end
+
+  # ========================================================================= #
+  # === do_use_HTML_table_layout
+  # ========================================================================= #
+  def do_use_HTML_table_layout
+    @internal_hash[:use_HTML_table_layout] = true
+  end
+
+  # ========================================================================= #
+  # === use_HTML_table_layout?
+  # ========================================================================= #
+  def use_HTML_table_layout?
+    @internal_hash[:use_HTML_table_layout]
+  end; alias use_html_table_layout? use_HTML_table_layout? # === use_html_table_layout?
+       alias use_html_table?        use_HTML_table_layout? # === use_html_table?
+       alias use_HTML_table?        use_HTML_table_layout? # === use_HTML_table?
+
+  # ========================================================================= #
+  # === add_the_footer_with_hyperlinks               (footer tag, bottom tag)
   #
   # This method will add the footer, which by default is not used - the
   # user has to provide a commandline argument such as --footer to make
@@ -1208,6 +1280,7 @@ a:hover {
       all_subdirectories                               = :default,
       show_how_many_pdf_files_are_in_that_subdirectory = false
     )
+    add_date_in_the_lower_part_of_the_webpage = add_date_in_the_lower_part_of_the_webpage?
     case show_how_many_pdf_files_are_in_that_subdirectory
     # ======================================================================= #
     # === :count_the_pdf_files
@@ -1258,45 +1331,84 @@ a:hover {
             # in that subdirectory.
             # =============================================================== #
             use_this_description = use_this_description.dup if use_this_description.frozen?
-            n_pdf_files = Dir[File.dirname(this_html_file)+'/*.pdf']
+            # ================================================================= #
+            # Shorten the content if it exceeds a certain threshold:
+            # ================================================================= #
+            use_this_threshold_value = 80
+            if use_this_description.size > use_this_threshold_value
+              use_this_description = use_this_description[0 .. use_this_threshold_value]+' [...]'
+            end
+            n_pdf_files = Dir["#{File.dirname(this_html_file)}/*.pdf"]
             if use_german? # Currently we only do this if this class uses german.
-              case n_pdf_files
+              case n_pdf_files.size # Query how many .pdf files we have.
               when 1
                 use_this_description << colour_for_pdf_files(
-                  ' ('+n_pdf_files.size.to_s+' .pdf Datei)'
+                  ' ('+n_pdf_files.size.to_s+' .pdf Datei)' # Nur eine Datei.
                 )
               else
                 use_this_description << colour_for_pdf_files(
-                  ' ('+n_pdf_files.size.to_s+' .pdf Dateien)'
+                  ' ('+n_pdf_files.size.to_s+' .pdf Dateien)' # Mehrere Dateien.
                 )
               end
             end
+            # =============================================================== #
+            # Next, add the date-range, if this is enabled through the commandline.
+            # =============================================================== #
+            if add_date_in_the_lower_part_of_the_webpage
+              # ============================================================= #
+              # Next we must get the starting_year and the ending_year. We
+              # can do so by first getting an Array of all files in the
+              # subdirectory first.
+              # ============================================================= #
+              dirname_is = File.dirname(this_html_file)
+              files_in_that_directory = Dir["#{dirname_is}/*"].select {|entry|
+                is_a_file?(entry)
+              }
+              array = Cyberweb.return_time_range_based_on_this_array(files_in_that_directory)
+              starting_year = array.first.to_s
+              ending_year   = array.last.to_s
+              years_description = ''.dup
+              if (ending_year.to_i > starting_year.to_i) or # Then we have two entries.
+                 (starting_year.to_i > ending_year.to_i) 
+                years_description = ' (years: '+starting_year+' - '+ending_year+')'
+                years_description = ' (Jahre: '+starting_year+' - '+ending_year+')' if use_german?
+              else # else we have only one year.
+                years_description = ' (year: '+starting_year+')'
+                years_description = ' (Jahr: '+starting_year+')' if use_german?
+              end
+              use_this_description << olivedrab(
+                years_description
+              )
+            end
           end
+          # ================================================================= #
+          # Next add the href tag:
+          # ================================================================= #
           _ << HtmlTags.a(
                  this_html_file,
-                 css_class:   'marl2em BOLD',
+                 css_class:   'marl1_5em BOLD',
                  description: use_this_description
                )
           _ << "<br>\n"
         end
       }
     end
-    addnl(
-      HtmlTags.div(
-        _, 'common_border','div_footer_id',
-           'border:  4px dotted lightgreen;
-            margin:  1.5em;
-            padding: 8px;
-           '
-      )
-    ) unless _.nil? or _.empty?
-  end
-
-  # ========================================================================= #
-  # === colour_for_pdf_files
-  # ========================================================================= #
-  def colour_for_pdf_files(i)
-    mediumorchid(i)
+    unless _.nil? or _.empty?
+      # ===================================================================== #
+      # Build the <div> tag next:
+      # ===================================================================== #
+      div_tag_to_use = HtmlTags.div(
+          _, 'common_border',
+             'div_footer_id', # The id.
+             'border:        4px dotted lightgreen;
+              border-radius: 18px;
+              margin:        1.6em;
+              padding:       15px;
+              font-size:     1.1em;
+             '
+        )
+      addnl(div_tag_to_use)
+    end
   end
 
   # ========================================================================= #