cyberweb 0.5.225 → 0.6.17

data/lib/cyberweb/html_template/html_template.rb

@@ -36,6 +36,10 @@ module Cyberweb
 
 class HtmlTemplate < ::Cyberweb::Base # === Cyberweb::HtmlTemplate
 
+  require 'cyberweb/jquery_module/jquery_module.rb'
+  require 'cyberweb/modules/favicon.rb'
+  require 'cyberweb/modules/css_style.rb'
+
   begin
     require 'rack'
   rescue LoadError; end
@@ -109,20 +113,6 @@ class HtmlTemplate < ::Cyberweb::Base # === Cyberweb::HtmlTemplate
     # ======================================================================= #
     @internal_hash = {}
     # ======================================================================= #
-    # === :title
-    # ======================================================================= #
-    @internal_hash[:title] = nil
-    # ======================================================================= #
-    # === :body
-    #
-    # This variable will contain the body of the new HTML page.
-    # ======================================================================= #
-    @internal_hash[:body] = nil
-    # ======================================================================= #
-    # === :special_actions
-    # ======================================================================= #
-    @internal_hash[:special_actions] = nil
-    # ======================================================================= #
     # === :body_css_style
     # ======================================================================= #
     @internal_hash[:body_css_style] = nil
@@ -139,13 +129,48 @@ class HtmlTemplate < ::Cyberweb::Base # === Cyberweb::HtmlTemplate
     # ======================================================================= #
     @internal_hash[:css_style] = nil
     # ======================================================================= #
+    # === :title
+    # ======================================================================= #
+    @internal_hash[:title] = nil
+    # ======================================================================= #
+    # === :body
+    #
+    # This variable will contain the body of the new HTML page.
+    # ======================================================================= #
+    @internal_hash[:body] = nil
+    # ======================================================================= #
+    # === :special_actions
+    # ======================================================================= #
+    @internal_hash[:special_actions] = nil
+    # ======================================================================= #
     # === :javascript_code
     # ======================================================================= #
     @internal_hash[:javascript_code] = nil
     # ======================================================================= #
+    # === :favicon
+    #
+    # By default we will not use a favicon.
+    # ======================================================================= #
+    @internal_hash[:favicon] = nil
+    # ======================================================================= #
     # === :use_jquery
     # ======================================================================= #
-    @internal_hash[:use_jquery] = false
+    pull_in_the_jquery_module
+    @internal_hash[:use_jquery] = false # But we have to disable it.
+  end
+
+  # ========================================================================= #
+  # === css_classes?
+  # ========================================================================= #
+  def css_classes?
+    @internal_hash[:css_classes]
+  end
+
+  # ========================================================================= #
+  # === pull_in_the_jquery_module
+  # ========================================================================= #
+  def pull_in_the_jquery_module
+    extend(Cyberweb::JqueryModule)
   end
 
   # ========================================================================= #
@@ -162,13 +187,6 @@ class HtmlTemplate < ::Cyberweb::Base # === Cyberweb::HtmlTemplate
     @internal_hash[:title]
   end
 
-  # ========================================================================= #
-  # === use_jquery?
-  # ========================================================================= #
-  def use_jquery?
-    @internal_hash[:use_jquery]
-  end
-
   # ========================================================================= #
   # === html_title?
   # ========================================================================= #
@@ -185,72 +203,6 @@ class HtmlTemplate < ::Cyberweb::Base # === Cyberweb::HtmlTemplate
     @internal_hash[:body]
   end
 
-  # ========================================================================= #
-  # === css_classes?
-  # ========================================================================= #
-  def css_classes?
-    @internal_hash[:css_classes]
-  end
-
-  # ========================================================================= #
-  # === return_the_css_classes
-  #
-  # This method will identify the correct CSS class. In order for this
-  # to work, the class must have been defined in one of the default
-  # .css files. And these files have to be found by ruby as well -
-  # otherwise the method will not work properly.
-  # ========================================================================= #
-  def return_the_css_classes
-    css_classes = css_classes?
-    if css_classes
-      css_classes = [css_classes].flatten.map {|entry|
-        if entry.include? ' '
-          entry = entry.split(' ')
-        end
-        entry
-      }.flatten
-      _ = ''.dup
-      css_content = ''.dup
-      # ===================================================================== #
-      # Obtain the various .css files next and store them in `css_content`:
-      # ===================================================================== #
-      Dir[project_base_dir?+'cascading_style_sheets/*.css'].each {|entry|
-        css_content << File.read(entry)+N
-      }
-      css_classes.each {|this_css_class|
-        # =================================================================== #
-        # See: https://rubular.com/r/7LUM1vaN45GDQ6
-        # =================================================================== #
-        use_this_regex =
-          /(\.#{this_css_class}).+{(.+)}$/
-        css_content =~ use_this_regex
-        # ================================================================= #
-        # else, since as of December 2021, try to read in from a .css
-        # file if this one exists.
-        # ================================================================= #
-        assumed_path = ::Cyberweb.project_base_directory?+
-                       'cascading_style_sheets/'+
-                       this_css_class+'.css'
-        if File.exist?(assumed_path)
-          _ << File.read(assumed_path)
-        else
-          if $2
-            _ << $1.to_s.ljust(15)+' { '+$2.to_s.lstrip.squeeze(' ')+' }'+N
-          end
-        end
-      }
-      if _.to_s.empty?
-        return ''
-      else
-        return '<style>'+N+
-               _.to_s+N+
-               '</style>'+N
-      end
-    else
-      ''
-    end
-  end
-
   # ========================================================================= #
   # === main_string?
   # ========================================================================= #
@@ -260,6 +212,13 @@ class HtmlTemplate < ::Cyberweb::Base # === Cyberweb::HtmlTemplate
        alias string? main_string? # === string?
        # alias to_str main_string? # === to_str # This would imply "behaves like string".
 
+  # ========================================================================= #
+  # === clear_the_main_string
+  # ========================================================================= #
+  def clear_the_main_string
+    @internal_hash[:main_string].clear
+  end
+
   # ========================================================================= #
   # === return_assumed_javascript
   # ========================================================================= #
@@ -274,18 +233,6 @@ class HtmlTemplate < ::Cyberweb::Base # === Cyberweb::HtmlTemplate
     return _
   end
 
-  # ========================================================================= #
-  # === return_css_style
-  # ========================================================================= #
-  def return_css_style
-    _ = @internal_hash[:css_style]
-    if _ and !_.empty?
-      return "<style>\n#{_}\n</style>"
-    else
-      ''
-    end
-  end
-
   # ========================================================================= #
   # === parse_this_hash                                           (parse tag)
   #
@@ -314,6 +261,15 @@ class HtmlTemplate < ::Cyberweb::Base # === Cyberweb::HtmlTemplate
       @internal_hash[:css_style] = hash.delete(:style)
     end
     # ======================================================================= #
+    # === :favicon
+    #
+    # This entry point exists to support favicons for the
+    # HtmlTemplate.
+    # ======================================================================= #
+    if hash.has_key? :favicon
+      @internal_hash[:favicon] = hash.delete(:favicon)
+    end
+    # ======================================================================= #
     # === :title
     # ======================================================================= #
     if hash.has_key? :title
@@ -454,16 +410,20 @@ class HtmlTemplate < ::Cyberweb::Base # === Cyberweb::HtmlTemplate
       # ===================================================================== #
       # Begin to build the HTML result next.
       # ===================================================================== #
-      @internal_hash[:main_string] =
-        '<!DOCTYPE html>'+N+
-        '<html lang="en">'+N+
-        '<head>'+N+
-        Cyberweb.return_utf_charset+
-        html_title?+N+
-        return_the_css_classes+N+
-        return_css_style+N+
-        return_assumed_javascript+
-        '</head>'+N.dup # The <head> tag is now closed.
+      _ = ''.dup
+      _ << '<!DOCTYPE html>'+N+
+           '<html lang="en">'+N+
+           '<head>'+N+
+           Cyberweb.return_utf_charset+
+           html_title?+N+
+           return_the_css_classes+N+
+           return_css_style+N+
+           return_assumed_javascript
+      if use_favicon?
+        _ << '<link rel="icon" type="image/png" href="'+use_favicon?.to_s+'"/>'+"\n"
+      end
+      _ << '</head>'+N.dup # The <head> tag is now closed.
+      @internal_hash[:main_string] = _
       if use_jquery?
         require 'cyberweb/toplevel_methods/jquery.rb'
         # =================================================================== #
@@ -473,11 +433,102 @@ class HtmlTemplate < ::Cyberweb::Base # === Cyberweb::HtmlTemplate
           "<!-- Adding support for jquery next: -->\n"+
           Cyberweb.return_jquery_string
       end
+      # ===================================================================== #
+      # Append onto the main String:
+      # ===================================================================== #
       @internal_hash[:main_string] << body_string+
-      @internal_hash[:body].to_s+N+ # Add the body-content.
-      '</body>'+N+
-      '</html>'+N
+                                      @internal_hash[:body].to_s+N+ # Add the body-content.
+                                      '</body>'+N+
+                                      '</html>'+N
     end
+  end; alias rebuild_the_main_string generate_the_main_string # === rebuild_the_main_string
+
+  # ========================================================================= #
+  # === return_the_css_classes
+  #
+  # This method will identify the correct CSS class that should be used
+  # by the HtmlTemplate.
+  #
+  # In order for this to work, the class must have been defined in one
+  # of the default .css files. And these files have to be found by
+  # ruby as well - otherwise the method will not work properly.
+  # ========================================================================= #
+  def return_the_css_classes
+    css_classes = css_classes?
+    if css_classes
+      css_classes = [css_classes].flatten.map {|entry|
+        if entry.include? ' '
+          entry = entry.split(' ')
+        end
+        entry
+      }.flatten
+      _ = ''.dup
+      css_content = ''.dup
+      # ===================================================================== #
+      # Obtain the various .css files next and store them in `css_content`:
+      # ===================================================================== #
+      Dir["#{project_base_dir?}cascading_style_sheets/*.css"].each {|entry|
+        css_content << File.read(entry)+N
+      }
+      css_classes.each {|this_css_class|
+        # =================================================================== #
+        # See: https://rubular.com/r/7LUM1vaN45GDQ6
+        # =================================================================== #
+        use_this_regex =
+          /(\.#{this_css_class}).+{(.+)}$/
+        css_content =~ use_this_regex
+        # ================================================================= #
+        # else, since as of December 2021, try to read in from a .css
+        # file if this one exists.
+        # ================================================================= #
+        assumed_path = ::Cyberweb.project_base_directory?+
+                       'cascading_style_sheets/'+
+                       this_css_class+'.css'
+        if File.exist?(assumed_path)
+          _ << File.read(assumed_path)
+        else
+          if $2
+            _ << $1.to_s.ljust(15)+' { '+$2.to_s.lstrip.squeeze(' ')+' }'+N
+          end
+        end
+      }
+      if _.to_s.empty?
+        return ''
+      else
+        return '<style>'+N+
+               _.to_s+N+
+               '</style>'+N
+      end
+    else
+      ''
+    end
+  end
+
+  # ========================================================================= #
+  # === set_favicon
+  # ========================================================================= #
+  def set_favicon(i)
+    i = Cyberweb::Favicon.path_of?(i)
+    @internal_hash[:favicon] = i    
+  end; alias favicon= set_favicon # === favicon=
+
+  # ========================================================================= #
+  # === return_css_style
+  # ========================================================================= #
+  def return_css_style
+    _ = @internal_hash[:css_style]
+    if _ and !_.empty?
+      return Cyberweb::CssStyle.style(_)
+    else
+      ''
+    end
+  end
+
+  # ========================================================================= #
+  # === use_favicon?
+  # ========================================================================= #
+  def use_favicon?
+    @internal_hash[:favicon]
   end
 
   # ========================================================================= #
@@ -511,5 +562,12 @@ end
 end
 
 if __FILE__ == $PROGRAM_NAME
-  puts Cyberweb::HtmlTemplate.new(ARGV)
+  alias e puts
+  html_template = Cyberweb::HtmlTemplate.new(ARGV)
+  html_template.clear_the_main_string
+  # html_template.set_favicon('https://example.com/favicon.png')
+  # html_template.set_favicon(:package)
+  html_template.set_favicon('https://i.imgur.com/GR8pcxq.png')
+  html_template.rebuild_the_main_string
+  e html_template
 end # htmltemplate abc def

data/lib/cyberweb/javascript/javascript.rb

@@ -200,37 +200,6 @@ module Cyberweb
     ee ::Cyberweb.return_javascript(i)
   end; self.instance_eval { alias output_this_javascript ejavascript } # === Cyberweb.output_this_javascript
 
-  # ========================================================================= #
-  # === Cyberweb.return_default_javascript
-  #
-  # This will return the javascript stuff. Since JUN 2011 we add the 
-  # fixed_path variable only if we do not start with http. Apparently
-  # this breaks the javascript model... so I undid this in AUG 2011.
-  #
-  # If we redo it again, we must describe why!
-  #
-  # On 21 June 2014 I noticed that the W3C validator complained about
-  # "script element between head and body". That means we need to 
-  # either place it between <head> or <body> tags, and not in between.
-  # ========================================================================= #
-  def self.return_default_javascript(
-      use_this_path = ::Cyberweb.converted_path_to_data # We need the path to the DATA/ subdirectory.
-    )
-    array = ARRAY_DEFAULT_JAVASCRIPT_LIBRARIES
-    _ = ''.dup # This String will be returned.
-    array.each {|entry|
-      _ << '<script src="'
-      _ << use_this_path
-      _ << 'javascript_code/'
-      _ << entry
-      _ <<  '" '
-      _ = _.ljust(48)
-      _ << 'type="text/javascript"></script>'
-      _ << NL
-    } unless ARRAY_DEFAULT_JAVASCRIPT_LIBRARIES.empty?
-    _
-  end
-
   # ========================================================================= #
   # === ejavascript
   #
@@ -253,4 +222,38 @@ module Cyberweb
        alias embed_this_javascript      ejavascript # === embed_this_javascript_code
        alias javascript_code            ejavascript # === javascript_code # experimental as of Nov 2014.
 
+  # ========================================================================= #
+  # === Cyberweb.return_default_javascript
+  #
+  # This will return the javascript stuff. Since as of June 2011 we add
+  # the fixed_path variable only if we do not start with http. Apparently
+  # this breaks the javascript model... so this was undone again in
+  # August 2011.
+  #
+  # If we redo it again, we must describe why.
+  #
+  # On 21.06.2014 I noticed that the W3C validator complained about
+  # "script element between head and body". That means we need to 
+  # either place it between <head> or <body> tags, and not in between.
+  # ========================================================================= #
+  def self.return_default_javascript(
+      use_this_path =
+        # ::Cyberweb.converted_path_to_data # We need the path to the DATA/ subdirectory.
+        # ::Cyberweb.converted_path_to_project_base_dir
+        #Cyberweb.project_base_dir?
+        ::Cyberweb.converted_path_to_the_directory_containing_the_copied_javascript_files
+    )
+    use_this_path = use_this_path.dup
+    array = ARRAY_DEFAULT_JAVASCRIPT_LIBRARIES
+    _ = ''.dup # This String will be returned.
+    array.each {|entry|
+     full_path = "#{use_this_path}javascript_code/#{entry}".dup
+      _ << '<script src="'+full_path+'"'
+      _ = _.ljust(48)
+      _ << ' type="text/javascript"></script>'
+      _ << NL
+    } unless ARRAY_DEFAULT_JAVASCRIPT_LIBRARIES.empty?
+    _
+  end
+
 end

data/lib/cyberweb/javascript_code/copy_to_the_clipboard.js

@@ -0,0 +1,12 @@
+function copy_to_the_clipboard(id_to_use) {
+  // Get the text field
+  var x = document.getElementById(id_to_use);
+
+  x.select(); /* Select the text field */
+  /*
+  x.setSelectionRange(0, 99999); // For mobile devices
+  */
+
+   // Copy the text inside the text field
+  navigator.clipboard.writeText(x.value);
+}

data/lib/cyberweb/jquery_module/jquery_module.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb::JqueryModule
+#
+# This module bundles jquery-related functionality together.
+# =========================================================================== #
+# require 'cyberweb/jquery_module/jquery_module.rb'
+# include Cyberweb::JqueryModule
+# =========================================================================== #
+module Cyberweb
+
+module JqueryModule # === Cyberweb::JqueryModule
+
+  # ========================================================================= #
+  # === Cyberweb::JqueryModule.extended
+  # ========================================================================= #
+  def self.extended(i)
+    i.enable_jquery if i.respond_to?(:enable_jquery) # Enable it automatically when extending.
+    # puts "#{i} was included."
+  end
+
+  # ========================================================================= #
+  # === enable_jquery
+  # ========================================================================= #
+  def disable_jquery
+    @internal_hash[:use_jquery] = false
+  end
+
+  # ========================================================================= #
+  # === enable_jquery
+  # ========================================================================= #
+  def enable_jquery
+    @internal_hash[:use_jquery] = true
+  end
+
+  # ========================================================================= #
+  # === use_jquery?
+  # ========================================================================= #
+  def use_jquery?
+    @internal_hash[:use_jquery]
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  object = Object.new
+  object.extend(Cyberweb::JqueryModule)
+  object.test
+end # jquery_module.rb

data/lib/cyberweb/modules/css_style.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb::CssStyle
+# =========================================================================== #
+# require 'cyberweb/modules/css_style.rb'
+# Cyberweb::CssStyle.style
+# include Cyberweb::CssStyle
+# =========================================================================== #
+module Cyberweb
+
+module CssStyle # === Cyberweb::CssStyle
+
+  # ========================================================================= #
+  # === Cyberweb::CssStyle.style
+  #
+  # This method will return the <style> tag.
+  # ========================================================================= #
+  def self.style(i = '')
+    if i.is_a? Array
+      i = i.first
+    end
+    return "<style>\n#{i}\n</style>\n" # Trailing newline is mandatory.
+  end
+
+end; end