cyberweb 0.4.174 → 0.5.225

data/lib/cyberweb/toplevel_methods/internal_hash.rb

@@ -0,0 +1,173 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/internal_hash.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === @internal_hash
+  # ========================================================================= #
+  @internal_hash = {}
+
+  # ========================================================================= #
+  # === Cyberweb.initialize_internal_hash
+  #
+  # This hash contains some special variables used by various parts of
+  # the cyberweb framework.
+  # ========================================================================= #
+  def self.initialize_internal_hash
+    # ======================================================================= #
+    # Populate it with some default values. This was 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.
+    # ======================================================================= #
+    @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
+    @internal_hash[:question] = 'gold'         # For questions
+    @internal_hash[:answer]   = 'marl1em cyan' # For answers
+    @internal_hash[:col_cmd]  = 'slateblue marl1em'
+    @internal_hash[:counter_for_the_dynamic_circle] = 1 # To keep track of dynamic circle CSS-centric <div> tags.
+  end; initialize_internal_hash # And call it at once.
+
+  # ========================================================================= #
+  # === Cyberweb.cmd1=
+  #
+  # Modify the Hash that stores which css classes we shall use, for
+  # :cmd1.
+  # ========================================================================= #
+  def self.cmd1=(i)
+    @internal_hash[: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)
+    @internal_hash[:cmd2] = i
+  end; self.instance_eval { alias style_cmd2 cmd2= } # === Cyberweb.style_cmd2
+
+  # ========================================================================= #
+  # === Cyberweb.cmd1?
+  # ========================================================================= #
+  def self.cmd1?
+    @internal_hash[:cmd1]
+  end; self.instance_eval { alias command1? cmd1? } # === Cyberweb.command1?
+       self.instance_eval { alias cmd?      cmd1? } # === Cyberweb.cmd?
+
+  # ========================================================================= #
+  # === cmd?
+  #
+  # This method also has a constant as an "alias" to its value.
+  # ========================================================================= #
+  def cmd?
+    ::Cyberweb.cmd1?
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.cmd2?
+  # ========================================================================= #
+  def self.cmd2?
+    @internal_hash[:cmd2]
+  end; self.instance_eval { alias command2? cmd2? } # === Cyberweb.command2?
+
+  # ========================================================================= #
+  # === command2?
+  # ========================================================================= #
+  def command2?
+    ::Cyberweb.command2?
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.cmd3?
+  # ========================================================================= #
+  def self.cmd3?
+    @internal_hash[:cmd3]
+  end; self.instance_eval { alias command3? cmd3? } # === Cyberweb.command3?
+
+  # ========================================================================= #
+  # === Cyberweb.internal_hash?
+  # ========================================================================= #
+  def self.internal_hash?
+    @internal_hash
+  end; self.instance_eval { alias css_class_to_use       internal_hash? } # === Cyberweb.css_class_to_use
+       self.instance_eval { alias hash_css_class_to_use? internal_hash? } # === Cyberweb.hash_css_class_to_use?
+
+  # ========================================================================= #
+  # === Cyberweb.empty_cmd1
+  #
+  # This method can be used to quickly "empty" cmd1.
+  # ========================================================================= #
+  def self.empty_cmd1
+    @internal_hash[:cmd1].clear
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.append_to_cmd1
+  #
+  # This method can be used to append to "cmd1" aka :command1.
+  #
+  # Usage example:
+  #
+  #   Cyberweb.append_to_cmd1 :slateblue
+  #
+  # ========================================================================= #
+  def self.append_to_cmd1(i = 'marl2em')
+    old_content = cmd1?
+    old_content = old_content.dup if old_content.frozen?
+    old_content << (" #{i.to_s.strip}").squeeze(' ')
+    internal_hash?[:cmd1] = old_content
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.append_to_cmd2
+  # ========================================================================= #
+  def self.append_to_cmd2(i = 'marl2em')
+    old_content = cmd2?
+    old_content = old_content.dup if old_content.frozen?
+    old_content << (" #{i.to_s.strip}").squeeze(' ')
+    internal_hash?[:cmd2] = old_content
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.append_to_cmd3
+  # ========================================================================= #
+  def self.append_to_cmd3(i = 'marl2em')
+    old_content = cmd3?
+    old_content = old_content.dup if old_content.frozen?
+    old_content << (" #{i.to_s.strip}").squeeze(' ')
+    internal_hash?[:cmd3] = old_content
+  end
+
+  # ========================================================================= #
+  # === append_to_cmd1
+  #
+  # This method will append to cmd1.
+  # ========================================================================= #
+  def append_to_cmd1(
+      i = 'marl2em'
+    )
+    ::Cyberweb.append_to_cmd1(i)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pp Cyberweb.cmd1?
+  Cyberweb.append_to_cmd1('yodel')
+  pp Cyberweb.cmd1?
+end

data/lib/cyberweb/{io → toplevel_methods}/io.rb

@@ -2,7 +2,7 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# require 'cyberweb/io/io.rb'
+# require 'cyberweb/toplevel_methods/io.rb'
 # =========================================================================== #
 module Cyberweb
 

data/lib/cyberweb/toplevel_methods/javascript.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/javascript.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/project/project.rb'
+
+  # ========================================================================= #
+  # === Cyberweb.return_javascript_code_of_this_file
+  #
+  # The task of this method is to load a corresponding .js file. This
+  # .js file must be part of the cyberweb-project - thus it is an
+  # internal file only.
+  #
+  # If the file is found then this method will load its content and
+  # return it, as a String. Otherwise an empty String '' is returned.
+  # ========================================================================= #
+  def self.return_javascript_code_of_this_file(
+      this_file = 'simulate_a_dice.js'
+    )
+    this_file = this_file.first if this_file.is_a? Array
+    if this_file.frozen?
+      this_file = this_file.dup
+    end
+    assumed_path = ::Cyberweb.project_base_directory?+
+                   'javascript_code/'+
+                   this_file.to_s
+    if File.exist? assumed_path
+      return File.read(assumed_path)
+    else
+      return ''
+    end
+  end; self.instance_eval { alias javascript_code return_javascript_code_of_this_file } # === Cyberweb.javascript_code
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Cyberweb.return_javascript_code_of_this_file
+end

data/lib/cyberweb/toplevel_methods/jquery.rb

@@ -13,6 +13,14 @@ module Cyberweb
 
   # ========================================================================= #
   # === Cyberweb.path_to_jquery_dir?
+  #
+  # This method will return the path, as a String, to the jquery-directory
+  # within the Cyberweb gem.
+  #
+  # Usage example:
+  #
+  #   Cyberweb.path_to_jquery_dir? # => "/home/Programs/Ruby/3.1.2/lib/ruby/site_ruby/3.1.0/cyberweb/javascript_code/jquery/"
+  # 
   # ========================================================================= #
   def self.path_to_jquery_dir?
     "#{project_base_dir?}javascript_code/jquery/"

data/lib/cyberweb/toplevel_methods/last_modified.rb

@@ -3,6 +3,7 @@
 # frozen_string_literal: true
 # =========================================================================== #
 # require 'cyberweb/toplevel_methods/last_modified.rb'
+# Cyberweb.last_modified?
 # =========================================================================== #
 module Cyberweb
 
@@ -13,6 +14,9 @@ module Cyberweb
   # ========================================================================= #
   def self.last_modified?
     div('pad4px','last_modified'){
+      # ===================================================================== #
+      # === Handle blocks given to this method next
+      # ===================================================================== #
       if block_given?
         yielded = yield
         case yielded

data/lib/cyberweb/toplevel_methods/links.rb

@@ -173,14 +173,20 @@ module Cyberweb
     # Next, act if SELF is present in a link.
     # ======================================================================= #
     case link_description.downcase
-    when /self/,/name/,/^def$/,/last/
+    when /self/,
+         /name/,
+         /last/,
+         /^def$/
       case link_description
       when 'SELF_SHORT','SELF_ONLY_NAME'
         link_description = link_description.to_s.gsub(/#{link_description}/,
           File.basename(link_hyperref.dup)
         )
-      when /^SELF_NAME$/,/SELF_BASENAME/,'SELF_NO_EXT',
-           'SELF_BASE', 'SELF NO EXT' # We use /SELF_BASENAME/ so that we can eliminate it.
+      when /^SELF_NAME$/,
+           /^SELF_BASENAME/,
+           /^SELF_NO_EXT/,
+           /^SELF_BASE/,
+           /^SELF NO EXT/ # We use /SELF_BASENAME/ so that we can eliminate it.
         regex = link_description
         regex = Regexp.new(regex) if regex.is_a? String
         link_description = link_description.to_s.gsub(
@@ -191,17 +197,27 @@ module Cyberweb
         end
       when 'StdLink' # since 16.04.2008
         link_description = File.basename(link_hyperref.dup)
-      when 'self?','self','SELF?','SELF','DEF','DEF?',
-           'COPY','def'
+      when 'self?',
+           'self',
+           'SELF?',
+           'SELF',
+           'DEF',
+           'DEF?',
+           'COPY',
+           'def'
         link_description = link_hyperref.dup
-      when 'LAST_NAME','LAST','NAME_ONLY' # last name
+      when 'LAST_NAME',
+           'LAST',
+           'NAME_ONLY' # last name
         link_description = link_hyperref.split('/').last
       when /^NAME$/
         link_description = link_description.to_s.gsub(/NAME/, File.basename(link_hyperref.dup))
         if link_description.include? '.' # get the first one if we include a .
           link_description = link_description.split('.').first
         end
-      when /^SELF$/,/SELF$/,/DEF$/
+      when /^SELF$/,
+           /SELF$/,
+           /DEF$/
         link_description = link_description.to_s.gsub(/#{link_description}/, link_hyperref.dup)
       end
     end

data/lib/cyberweb/toplevel_methods/listing.rb

@@ -48,7 +48,8 @@ module Cyberweb
       make_newline = true
     )
     s2 '(<b>'+return_counter+'</b>) <b>'+i+'</b>',
-       optional_css, optional_id
+       optional_css,
+       optional_id
     br if make_newline
   end; self.instance_eval { alias list  listing } # === Cyberweb.list
        self.instance_eval { alias count listing } # === Cyberweb.count (count tag)

data/lib/cyberweb/toplevel_methods/localhost.rb

@@ -10,6 +10,9 @@ module Cyberweb
   # === Cyberweb.localhost?
   #
   # This tiny convenience-method only shows the leading localhost-string.
+  #
+  # This can then be used by other methods to prefix for testing on
+  # the localhost.
   # ========================================================================= #
   def self.localhost?
     'http://localhost'

data/lib/cyberweb/toplevel_methods/markdown.rb

@@ -20,7 +20,7 @@ module Cyberweb
   # a new instance of web_object though.
   # ========================================================================= #
   DEFAULT_MARKDOWN_FILE =
-    '/home/x/DATA/PC/MARKDOWN/example.md'
+    '/home/x/programming/ruby/src/roebe/lib/roebe/www/markdown/example.md'
 
   # ========================================================================= #
   # === show_inhalt_as_markdown
@@ -65,6 +65,7 @@ module Cyberweb
       i         = DEFAULT_MARKDOWN_FILE,
       return_it = false
     )
+    require 'kramdown'
     return_it = true if return_it == :return_it
     case i
     when :all # We try to find all markdown files in the dir.
@@ -82,7 +83,7 @@ module Cyberweb
       end
       if File.exist? i
         file = File.read(i)
-        kramdown_document = Kramdown::Document.new(file)
+        kramdown_document = ::Kramdown::Document.new(file)
         _ = kramdown_document.to_html
         if return_it
           return _

data/lib/cyberweb/toplevel_methods/mathml.rb

@@ -26,11 +26,13 @@ module Cyberweb
   #
   # Open up the math XML tag.
   # ========================================================================= #
-  def self.mathml_start(optional_css_class = '')
+  def self.mathml_start(
+      optional_css_class = ''
+    )
     if optional_css_class.empty?
-      _ =  '<math xmlns="&mathml;">'
+      _ = '<math xmlns="&mathml;">'
     else
-      _ =  '<math xmlns="&mathml;" class="'+optional_css_class+'">'
+      _ = '<math xmlns="&mathml;" class="'+optional_css_class+'">'
     end
     # _ << '<mstyle mathvariant="bold">'
     _

data/lib/cyberweb/toplevel_methods/message_boxes.rb

@@ -105,7 +105,9 @@ module Cyberweb
   # ========================================================================= #
   # === error_box
   # ========================================================================= #
-  def error_box(a = '', b = '', the_id = __method__.to_s, d = '', &block)
+  def error_box(
+      a = '', b = '', the_id = __method__.to_s, d = '', &block
+    )
     the_id = __method__.to_s if the_id.empty?
     message_box(a,b,the_id,d,&block)
   end
@@ -124,7 +126,9 @@ module Cyberweb
   # ========================================================================= #
   # === success_box
   # ========================================================================= #
-  def success_box(a='',b='',the_id=__method__.to_s,d='',&block)
+  def success_box(
+      a='',b='',the_id=__method__.to_s,d='',&block
+    )
     the_id = __method__.to_s if the_id.empty?
     message_box(a,b,the_id,d,&block)
   end