cyberweb 0.8.17 → 0.9.32

data/lib/cyberweb/cmd/cmd.rb

@@ -0,0 +1,601 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb::Cmd
+#
+# Note that Cyberweb::Cmd is actually not used directly - the underlying
+# code will tap into Cyberweb::Cmd1, Cyberweb::Cmd2 and so forth, so
+# the sole purpose of Cyberweb::Cmd is to be used as a base-class.
+#
+# It is important that the toplevel-variant remains in a working state. 
+#
+# Note that the default values for the cmdlets, that is :cmd1, :cmd2
+# and so forth, were changed to start at "mars2em" in September
+# 2022. The reason is that we want to sometimes use "lem", and in
+# that case the subsequent cmd() calls don't align that well.
+#
+# Old code in use was this:
+#
+#    @internal_hash[:cmd1] = 'mars2em BOLD' # For command1
+#    @internal_hash[:cmd2] = 'mars3em BOLD' # For command2
+#    @internal_hash[:cmd3] = 'mars4em BOLD' # For command3
+#    @internal_hash[:cmd4] = 'mars5em BOLD' # For command4
+#    @internal_hash[:cmd5] = 'mars6em BOLD' # For command5
+#
+# There also was, historically viewed, another use case, as shown
+# next:
+#
+#   css.optional = 'oki dokie'
+#   cmd 'Test'
+#   css.optional = 'bla'
+#   cmd 'Test'
+#
+# This one does not seem to be hugely important anymore, though. But
+# perhaps we may want to re-add .optional= one day, so this is at
+# the least documented here.  
+# =========================================================================== #
+# require 'cyberweb/cmd/cmd.rb'
+# =========================================================================== #
+module Cyberweb
+
+class Cmd # === Cyberweb::Cmd
+
+  require 'html_tags/individual_tags/span.rb'
+
+  # ========================================================================= #
+  # === Cyberweb::Cmd::DEFAULT_VALUES
+  #
+  # The following Hash can be used to restore the default values again,
+  # should this be necessary.
+  # ========================================================================= #
+  DEFAULT_VALUES = {
+    cmd1: 'mars2em BOLD',
+    cmd2: 'mars3em BOLD',
+    cmd3: 'mars4em BOLD',
+    cmd4: 'mars5em BOLD',
+    cmd5: 'mars6em BOLD'
+  }
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize
+    reset
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @use_these_css_rules
+    # ======================================================================= #
+    @use_these_css_rules = ''
+  end
+
+  # ========================================================================= #
+  # === set_use_these_css_rules
+  # ========================================================================= #
+  def set_use_these_css_rules(i)
+    @use_these_css_rules = i
+  end; alias set set_use_these_css_rules # === set
+
+  # ========================================================================= #
+  # === use_these_css_rules?
+  # ========================================================================= #
+  def use_these_css_rules?
+    @use_these_css_rules
+  end; alias css_rules? use_these_css_rules? # === css_rules?
+
+  # ========================================================================= #
+  # === Cyberweb::Cmd.cmd1=
+  # ========================================================================= #
+  def self.cmd1=(i)
+    DEFAULT_VALUES[:cmd1] = i
+    Cyberweb::Cmd1.new # Overwrite it here as well.
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::Cmd.cmd2=
+  # ========================================================================= #
+  def self.cmd2=(i)
+    DEFAULT_VALUES[:cmd2] = i
+    Cyberweb::Cmd2.new # Overwrite it here as well.
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::Cmd.cmd3=
+  # ========================================================================= #
+  def self.cmd3=(i)
+    DEFAULT_VALUES[:cmd3] = i
+    Cyberweb::Cmd3.new # Overwrite it here as well.
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::Cmd.cmd4=
+  # ========================================================================= #
+  def self.cmd4=(i)
+    DEFAULT_VALUES[:cmd4] = i
+    Cyberweb::Cmd4.new # Overwrite it here as well.
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::Cmd.cmd5=
+  # ========================================================================= #
+  def self.cmd5=(i)
+    DEFAULT_VALUES[:cmd5] = i
+    Cyberweb::Cmd5.new # Overwrite it here as well.
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::Cmd.append_this_css
+  #
+  # This method will append the passed CSS rules to all of the CSS
+  # rules for Cmd1, Cmd2, Cmd3, Cmd4 and Cmd5 subsequently. So it
+  # is mostly a convenience-method.
+  # ========================================================================= #
+  def self.append_this_css(i)
+    ::Cyberweb.append_to_cmd1(i)
+    ::Cyberweb.append_to_cmd2(i)
+    ::Cyberweb.append_to_cmd3(i)
+    ::Cyberweb.append_to_cmd4(i)
+    ::Cyberweb.append_to_cmd5(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Cyberweb::Cmd1
+# =========================================================================== #
+class Cmd1 < Cmd
+  def initialize
+    set DEFAULT_VALUES[:cmd1]
+  end
+  def self.css_rules?
+    new.css_rules?
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::Cmd1.append
+  #
+  # This method can be used to append to the :cmd1 variable.
+  # ========================================================================= #
+  def self.append(i)
+    Cyberweb.append_to_cmd1(i)
+  end; self.instance_eval { alias append_this_css append } # === Cyberweb::Cmd1.append_this_css
+
+end
+
+# =========================================================================== #
+# === Cyberweb::Cmd2
+# =========================================================================== #
+class Cmd2 < Cmd
+  def initialize
+    set DEFAULT_VALUES[:cmd2]
+  end
+  def self.css_rules?
+    new.css_rules?
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::Cmd2.append
+  #
+  # This method can be used to append to the :cmd1 variable.
+  # ========================================================================= #
+  def self.append(i)
+    Cyberweb.append_to_cmd2(i)
+  end; self.instance_eval { alias append_this_css append } # === Cyberweb::Cmd2.append_this_css
+
+end
+
+# =========================================================================== #
+# === Cyberweb::Cmd3
+# =========================================================================== #
+class Cmd3 < Cmd
+  def initialize
+    set DEFAULT_VALUES[:cmd3]
+  end
+  def self.css_rules?
+    new.css_rules?
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::Cmd3.append
+  #
+  # This method can be used to append to the :cmd3 variable.
+  # ========================================================================= #
+  def self.append(i)
+    Cyberweb.append_to_cmd3(i)
+  end; self.instance_eval { alias append_this_css append } # === Cyberweb::Cmd3.append_this_css
+
+end
+
+# =========================================================================== #
+# === Cyberweb::Cmd4
+# =========================================================================== #
+class Cmd4 < Cmd
+  def initialize
+    set DEFAULT_VALUES[:cmd4]
+  end
+  def self.css_rules?
+    new.css_rules?
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::Cmd4.append
+  #
+  # This method can be used to append to the :cmd4 variable.
+  # ========================================================================= #
+  def self.append(i)
+    Cyberweb.append_to_cmd4(i)
+  end; self.instance_eval { alias append_this_css append } # === Cyberweb::Cmd4.append_this_css
+
+end
+
+# =========================================================================== #
+# === Cyberweb::Cmd5
+# =========================================================================== #
+class Cmd5 < Cmd
+  def initialize
+    set DEFAULT_VALUES[:cmd5]
+  end
+  def self.css_rules?
+    new.css_rules?
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::Cmd5.append
+  #
+  # This method can be used to append to the :cmd5 variable.
+  # ========================================================================= #
+  def self.append(i)
+    Cyberweb.append_to_cmd5(i)
+  end; self.instance_eval { alias append_this_css append } # === Cyberweb::Cmd5.append_this_css
+
+end
+
+# =========================================================================== #
+# === Cyberweb.cmd1
+# =========================================================================== #
+def self.cmd1(
+    content             = '',
+    use_these_css_rules = Cmd1.css_rules?,
+    optional_id        = '',
+    optional_css_style = '',
+    &block
+  )
+  return HtmlTags.span(
+    content,
+    use_these_css_rules,
+    optional_id,
+    optional_css_style
+  )
+end; self.instance_eval { alias cmd1?     cmd1 } # === Cyberweb.cmd1?
+     self.instance_eval { alias command1? cmd1 } # === Cyberweb.command1?
+     self.instance_eval { alias cmd?      cmd1 } # === Cyberweb.cmd?
+
+# =========================================================================== #
+# === Cyberweb.cmd2
+# =========================================================================== #
+def self.cmd2(
+    content             = '',
+    use_these_css_rules = Cmd2.css_rules?,
+    optional_id        = '',
+    optional_css_style = '',
+    &block
+  )
+  return HtmlTags.span(
+    content,
+    use_these_css_rules,
+    optional_id,
+    optional_css_style
+  )
+end; self.instance_eval { alias cmd2?     cmd2 } # === Cyberweb.cmd2?
+     self.instance_eval { alias command2? cmd2 } # === Cyberweb.command2?
+
+# =========================================================================== #
+# === Cyberweb.cmd3
+# =========================================================================== #
+def self.cmd3(
+    content             = '',
+    use_these_css_rules = Cmd3.css_rules?,
+    optional_id        = '',
+    optional_css_style = '',
+    &block
+  )
+  return HtmlTags.span(
+    content,
+    use_these_css_rules,
+    optional_id,
+    optional_css_style
+  )
+end; self.instance_eval { alias cmd3?     cmd3 } # === Cyberweb.cmd3?
+     self.instance_eval { alias command3? cmd3 } # === Cyberweb.command3?
+
+# =========================================================================== #
+# === Cyberweb.cmd4
+# =========================================================================== #
+def self.cmd4(
+    content             = '',
+    use_these_css_rules = Cmd4.css_rules?,
+    optional_id        = '',
+    optional_css_style = '',
+    &block
+  )
+  return HtmlTags.span(
+    content,
+    use_these_css_rules,
+    optional_id,
+    optional_css_style
+  )
+end
+
+# =========================================================================== #
+# === Cyberweb.cmd5
+# =========================================================================== #
+def self.cmd5(
+    content             = '',
+    use_these_css_rules = Cmd5.css_rules?,
+    optional_id        = '',
+    optional_css_style = '',
+    &block
+  )
+  return HtmlTags.span(
+    content,
+    use_these_css_rules,
+    optional_id,
+    optional_css_style
+  )
+end
+
+# =========================================================================== #
+# === Cyberweb.cmd1=
+#
+# Modify the Hash that stores which css classes we shall use, for :cmd1.
+# =========================================================================== #
+def self.cmd1=(i)
+  Cyberweb::Cmd.cmd1 = i
+end; self.instance_eval { alias cmd=         cmd1= } # === Cyberweb.cmd=
+     self.instance_eval { alias style_cmd1   cmd1= } # === Cyberweb.style_cmd1
+     self.instance_eval { alias css_for_cmd= cmd1= } # === Cyberweb.css_for_cmd=
+
+# =========================================================================== #
+# === Cyberweb.cmd2=
+#
+# This method allows the user to ad-hoc redefine cmd2.
+#
+# Usage example:
+#
+#   Cyberweb.cmd2 = 'mars2em tomato'
+#
+# =========================================================================== #
+def self.cmd2=(i)
+  Cyberweb::Cmd.cmd2 = i
+end; self.instance_eval { alias style_cmd2 cmd2= } # === Cyberweb.style_cmd2
+
+# =========================================================================== #
+# === Cyberweb.cmd3=
+# =========================================================================== #
+def self.cmd3=(i)
+  Cyberweb::Cmd.cmd3 = i
+end; self.instance_eval { alias style_cmd3 cmd3= } # === Cyberweb.style_cmd3
+
+# =========================================================================== #
+# === Cyberweb.cmd4=
+# =========================================================================== #
+def self.cmd4=(i)
+  Cyberweb::Cmd.cmd4 = i
+end; self.instance_eval { alias style_cmd4 cmd4= } # === Cyberweb.style_cmd4
+
+# =========================================================================== #
+# === Cyberweb.cmd5=
+# =========================================================================== #
+def self.cmd5=(i)
+  Cyberweb::Cmd.cmd5 = i
+end; self.instance_eval { alias style_cmd5 cmd5= } # === Cyberweb.style_cmd5
+
+# =========================================================================== #
+# === Cyberweb.empty_cmd1
+#
+# This method can be used to quickly "empty" cmd1.
+# =========================================================================== #
+def self.empty_cmd1
+  if Cyberweb::Cmd::DEFAULT_VALUES[:cmd1].frozen?
+    Cyberweb::Cmd::DEFAULT_VALUES[:cmd1] = Cyberweb::Cmd::DEFAULT_VALUES[:cmd1].dup
+  end
+  Cyberweb::Cmd::DEFAULT_VALUES[:cmd1].clear
+  Cyberweb::Cmd1.new # Overwrite it here as well.
+end
+
+# =========================================================================== #
+# === Cyberweb.empty_cmd2
+#
+# This method can be used to quickly "empty" cmd2.
+# =========================================================================== #
+def self.empty_cmd2
+  if Cyberweb::Cmd::DEFAULT_VALUES[:cmd2].frozen?
+    Cyberweb::Cmd::DEFAULT_VALUES[:cmd2] = Cyberweb::Cmd::DEFAULT_VALUES[:cmd2].dup
+  end
+  Cyberweb::Cmd::DEFAULT_VALUES[:cmd2].clear
+  Cyberweb::Cmd2.new # Overwrite it here as well.
+end
+
+# =========================================================================== #
+# === Cyberweb.empty_cmd3
+#
+# This method can be used to quickly "empty" cmd3.
+# =========================================================================== #
+def self.empty_cmd3
+  if Cyberweb::Cmd::DEFAULT_VALUES[:cmd3].frozen?
+    Cyberweb::Cmd::DEFAULT_VALUES[:cmd3] = Cyberweb::Cmd::DEFAULT_VALUES[:cmd3].dup
+  end
+  Cyberweb::Cmd::DEFAULT_VALUES[:cmd3].clear
+  Cyberweb::Cmd3.new # Overwrite it here as well.
+end
+
+# =========================================================================== #
+# === Cyberweb.empty_cmd4
+#
+# This method can be used to quickly "empty" cmd4.
+# =========================================================================== #
+def self.empty_cmd4
+  if Cyberweb::Cmd::DEFAULT_VALUES[:cmd4].frozen?
+    Cyberweb::Cmd::DEFAULT_VALUES[:cmd4] = Cyberweb::Cmd::DEFAULT_VALUES[:cmd4].dup
+  end
+  Cyberweb::Cmd::DEFAULT_VALUES[:cmd4].clear
+  Cyberweb::Cmd4.new # Overwrite it here as well.
+end
+
+# =========================================================================== #
+# === Cyberweb.empty_cmd5
+#
+# This method can be used to quickly "empty" cmd5.
+# =========================================================================== #
+def self.empty_cmd5
+  if Cyberweb::Cmd::DEFAULT_VALUES[:cmd5].frozen?
+    Cyberweb::Cmd::DEFAULT_VALUES[:cmd5] = Cyberweb::Cmd::DEFAULT_VALUES[:cmd5].dup
+  end
+  Cyberweb::Cmd::DEFAULT_VALUES[:cmd5].clear
+  Cyberweb::Cmd5.new # Overwrite it here as well.
+end
+
+# =========================================================================== #
+# === Cyberweb.append_to_cmd1
+#
+# This method can be used to append to "cmd1" aka :cmd1.
+#
+# Usage example:
+#
+#   Cyberweb.append_to_cmd1 :slateblue
+#
+# =========================================================================== #
+def self.append_to_cmd1(i = 'marl2em')
+  old_content = Cyberweb::Cmd::DEFAULT_VALUES[:cmd1]
+  old_content = old_content.dup # Always work on a copy past this point.
+  old_content << (" #{i.to_s.strip}").squeeze(' ')
+  Cyberweb.cmd1 = old_content.lstrip
+end
+
+# =========================================================================== #
+# === Cyberweb.append_to_cmd2
+# =========================================================================== #
+def self.append_to_cmd2(i = 'marl2em')
+  old_content = Cyberweb::Cmd::DEFAULT_VALUES[:cmd2]
+  old_content = old_content.dup # Always work on a copy past this point.
+  old_content << (" #{i.to_s.strip}").squeeze(' ')
+  Cyberweb.cmd2 = old_content.lstrip
+end
+
+# =========================================================================== #
+# === Cyberweb.append_to_cmd3
+# =========================================================================== #
+def self.append_to_cmd3(i = 'marl2em')
+  old_content = Cyberweb::Cmd::DEFAULT_VALUES[:cmd3]
+  old_content = old_content.dup # Always work on a copy past this point.
+  old_content << (" #{i.to_s.strip}").squeeze(' ')
+  Cyberweb.cmd3 = old_content.lstrip
+end
+
+# =========================================================================== #
+# === Cyberweb.append_to_cmd4
+# =========================================================================== #
+def self.append_to_cmd4(i = 'marl2em')
+  old_content = Cyberweb::Cmd::DEFAULT_VALUES[:cmd4]
+  old_content = old_content.dup # Always work on a copy past this point.
+  old_content << (" #{i.to_s.strip}").squeeze(' ')
+  Cyberweb.cmd4 = old_content.lstrip
+end
+
+# =========================================================================== #
+# === Cyberweb.append_to_cmd5
+# =========================================================================== #
+def self.append_to_cmd5(i = 'marl2em')
+  old_content = Cyberweb::Cmd::DEFAULT_VALUES[:cmd5]
+  old_content = old_content.dup # Always work on a copy past this point.
+  old_content << (" #{i.to_s.strip}").squeeze(' ')
+  Cyberweb.cmd5 = old_content.lstrip
+end
+
+# =========================================================================== #
+# === Cyberweb.cmd1_css_rules?
+#
+# This method also has one alias.
+# =========================================================================== #
+def self.cmd1_css_rules?
+  Cyberweb::Cmd::DEFAULT_VALUES[:cmd1]
+end; self.instance_eval { alias css_for_cmd? cmd1_css_rules? } # === Cyberweb.css_for_cmd?
+
+# =========================================================================== #
+# === Cyberweb.cmd2_css_rules?
+# =========================================================================== #
+def self.cmd2_css_rules?
+  Cyberweb::Cmd::DEFAULT_VALUES[:cmd2]
+end
+
+# =========================================================================== #
+# === Cyberweb.cmd3_css_rules?
+# =========================================================================== #
+def self.cmd3_css_rules?
+  Cyberweb::Cmd::DEFAULT_VALUES[:cmd3]
+end
+
+# =========================================================================== #
+# === Cyberweb.cmd4_css_rules?
+# =========================================================================== #
+def self.cmd4_css_rules?
+  Cyberweb::Cmd::DEFAULT_VALUES[:cmd4]
+end
+
+# =========================================================================== #
+# === Cyberweb.cmd5_css_rules?
+# =========================================================================== #
+def self.cmd5_css_rules?
+  Cyberweb::Cmd::DEFAULT_VALUES[:cmd5]
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  e Cyberweb.cmd1
+  e
+  e Cyberweb.cmd1('Hey there')
+  e
+  e Cyberweb.cmd2('This is for cmd2')
+  e
+  e Cyberweb.cmd3('And this is for cmd3')
+  e
+  e Cyberweb.cmd4('And this is for cmd4')
+  e
+  e Cyberweb.cmd5('And this is for cmd5')
+  e
+  e 'Next, it will be demonstrated how to overwrite these CSS classes:'
+  e
+  Cyberweb.cmd1 = 'mars8em'
+  e Cyberweb.cmd1('Hey there')
+  e
+  Cyberweb.cmd2 = 'mars5em BOLD yellow'
+  e Cyberweb.cmd2('Hey there')
+  e
+  e 'Next we empty cmd4 and see the effect of that. '\
+    'First, show cmd4 via "Hello world!" again:'
+  e
+  e Cyberweb.cmd4('Hello world!')
+  e
+  Cyberweb.empty_cmd4
+  e Cyberweb.cmd4('Hello world!')
+  e
+  e 'We will do the same for cmd1, as above:'
+  e
+  e Cyberweb.cmd1('Hello world!')
+  e
+  Cyberweb.empty_cmd1
+  e Cyberweb.cmd1('Hello world!')
+  e
+  e 'And now we append to :cmd1 again via '\
+    'Cyberweb.append_to_cmd1()'
+  Cyberweb.append_to_cmd1('mars2em yellow')
+  e
+  e Cyberweb.cmd1('Hello world!')
+end

data/lib/cyberweb/constants/constants.rb

@@ -9,6 +9,12 @@ module Cyberweb
   require 'yaml'
   require 'cyberweb/project/project.rb'
 
+  # ========================================================================= #
+  # === FILE_JS_FILES_TO_LOAD
+  # ========================================================================= #
+  FILE_JS_FILES_TO_LOAD = "#{::Cyberweb.project_yaml_directory?}"\
+                          "js_files_to_load.yml" # bl $WEB_FOUNDATION/yaml/js_files_to_load.yml
+
   # ========================================================================= #
   # === FILE_WEB_IMAGES
   # ========================================================================= #
@@ -575,6 +581,16 @@ module Cyberweb
     "#{Cyberweb.project_base_directory?}svg/standalone/amusement_park.svg"
   end
 
+  # ========================================================================= #
+  # === CURRENT_RUBY_VERSION
+  #
+  # This is synonymous to RUBY_VERSION, which may be a String such as
+  # "3.2.1". This, however had, is problematic in that the SITE_DIR
+  # is at "3.2.0" in such a case. So we need to keep in mind to
+  # NOT rely on the version for the path of local directories.
+  # ========================================================================= #
+  CURRENT_RUBY_VERSION = RUBY_VERSION  # e. g. 3.2.0.
+
   # ========================================================================= #
   # === RUBY_HEADER
   #

data/lib/cyberweb/generator/cgi.rb

@@ -54,10 +54,10 @@ created_on '#{Cyberweb.date_today}' # #{Cyberweb.return_current_weekday}.
 autoextend # ← This can be used to automatically do: include Cyberweb
 # title '#{use_this_title}' # Or use this as the title.
 ruby_favicon
-hyperlinks_template1 ''
+default_template ''
 body_css_class 'mar0px s2px padt2px VERDANAs'
 body_css_style 'background-color: #d3d2d1;'
-font_size 'def'
+font_size '1.2em'
 
 doc('#{USE_THESE_CSS_CLASSES_FOR_THE_MAIN_DIV_ELEMENT}') {
   h1 dot(106, 'marr8px')+