cyberweb 0.4.174

data/lib/cyberweb/toplevel_methods/listing.rb

@@ -0,0 +1,96 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/listing.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === @listing_css_object
+  # ========================================================================= #
+  @listing_css_object = nil
+
+  # ========================================================================= #
+  # === Cyberweb.listing_css_object
+  # ========================================================================= #
+  def self.listing_css_object
+    @listing_css_object
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.listing_css_object=
+  # ========================================================================= #
+  def self.listing_css_object=(i)
+    @listing_css_object = i
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.listing
+  #
+  # This can be used as simple means to do a listing.
+  #
+  # Like for instance:
+  #
+  #   (1) Hi
+  #   (2) How do you do?
+  #
+  # Note that via the method clear_list() you can reset the counter used
+  # in this method again.
+  #
+  # Also note that, since Aug 2012, we will try to let this method
+  # behave differently depending on the optional_css supplied.
+  # ========================================================================= #
+  def self.listing(
+      i,
+      optional_css = listing_css_object,
+      optional_id  = '',
+      make_newline = true
+    )
+    s2 '(<b>'+return_counter+'</b>) <b>'+i+'</b>',
+       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)
+
+  # ========================================================================= #
+  # === listing
+  # ========================================================================= #
+  def listing(
+      i,
+      optional_css = listing_css_object,
+      optional_id  = '',
+      make_newline = true
+    )
+    ::Cyberweb.listing(i, optional_css, optional_id, make_newline)
+  end; alias list  listing # === list
+       alias count listing # === count (count tag)
+
+  # ========================================================================= #
+  # === Cyberweb.return_counter
+  #
+  # Handle the counters stored in the web-object. We increment by +1.
+  # (Weird name, I admit this.)
+  # ========================================================================= #
+  def self.return_counter
+    web_object?.listing_counter += 1
+    return web_object?.listing_counter.to_s
+  end; self.instance_eval { alias counter  return_counter } # === Cyberweb.counter
+       self.instance_eval { alias counter? return_counter } # === Cyberweb.counter?
+
+  # ========================================================================= #
+  # === Cyberweb.listing_counter?
+  # ========================================================================= #
+  def self.listing_counter?
+    web_object?.listing_counter
+  end
+
+  # ========================================================================= #
+  # === return_counter
+  # ========================================================================= #
+  def return_counter
+    Cyberweb.return_counter
+  end; alias counter  return_counter # === counter
+       alias counter? return_counter # === counter?
+
+end

data/lib/cyberweb/toplevel_methods/localhost.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'web_cyberweb_methods/localhost.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === Cyberweb.localhost?
+  #
+  # This tiny convenience-method only shows the leading localhost-string.
+  # ========================================================================= #
+  def self.localhost?
+    'http://localhost'
+  end
+
+end

data/lib/cyberweb/toplevel_methods/log_directory.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/log_directory.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/toplevel_methods/temp_directory.rb'
+
+  # ========================================================================= #
+  # === @log_directory
+  #
+  # We log into that directory.
+  #
+  # In the past there was a constant called LOG_DIRECTORY, but it is
+  # better to use a toplevel instance variable since that allows us
+  # to easily change it at a later time again.
+  #
+  # An example target for this variable may be:
+  #
+  #   /tmp/web_object/
+  # 
+  # ========================================================================= #
+  @log_directory = "#{@temp_directory}cyberweb/"
+
+  # ========================================================================= #
+  # === Cyberweb.set_log_directory
+  # ========================================================================= #
+  def self.set_log_directory(
+      i = "#{@temp_directory}cyberweb/"
+    )
+    case i
+    # ======================================================================= #
+    # === :classic_FHS_structure
+    # ======================================================================= #
+    when :classic_FHS_structure
+      i = '/tmp/'
+    # ======================================================================= #
+    # === :depot_temp_dir
+    # ======================================================================= #
+    when :depot_temp_dir
+      i = '/Depot/Temp/'
+    # ======================================================================= #
+    # === :depot_temp_dir_cyberweb
+    # ======================================================================= #
+    when :depot_temp_dir_cyberweb,
+         :depot_temp_dir_web_object
+      i = '/Depo/Temp/cyberweb/'
+    end
+    unless i.end_with? '/'
+      i = i.dup if i.frozen?
+      i << '/'
+    end
+    @log_directory = i.freeze
+  end; self.instance_eval { alias set_log_dir set_log_directory } # === Cyberweb.set_log_dir
+
+  # ========================================================================= #
+  # === Cyberweb.log_directory?
+  # ========================================================================= #
+  def self.log_directory?
+    @log_directory
+  end
+
+  # ========================================================================= #
+  # === log_directory?
+  # ========================================================================= #
+  def log_directory?
+    ::Cyberweb.log_directory?
+  end; alias log_dir? log_directory? # === log_dir?
+
+  # ========================================================================= #
+  # === MISSING_IMAGES_ARE_STORED_HERE
+  #
+  # Where to store missing images.
+  # ========================================================================= #
+  MISSING_IMAGES_ARE_STORED_HERE =
+    "#{@log_directory}web_object_errors.log"
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Cyberweb.log_directory?
+end

data/lib/cyberweb/toplevel_methods/logging.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === Cyberweb.error_log
+  #
+  # Use this for error logging.
+  #
+  # The first argument is mandatory and shows which type of error we
+  # have here. We will store into whatever is provided to us through
+  # Cyberweb.logfile?.
+  #
+  # On my system, MISSING_IMAGES_ARE_STORED_HERE will default to the
+  # log directory + 'web_object_errors.log'.
+  # ========================================================================= #
+  def self.error_log(
+      error,
+      from_this_file = nil,
+      do_strip_html  = true
+    )
+    error = strip_html(error) if do_strip_html
+    _ =  'Error Logging'.dup
+    _ << ' from file <b>'+from_this_file+'</b>' if from_this_file
+    _ << ':'+N+error.to_s # This is the string that will contain the error (hopefully).
+    websave_what_to(_, logfile?)
+  end
+
+  # ========================================================================= #
+  # === error_log
+  # ========================================================================= #
+  def error_log(
+      error,
+      from_this_file = nil,
+      do_strip_html  = true
+    )
+    ::Cyberweb.error_log(error, from_this_file, do_strip_html)
+  end
+
+end

data/lib/cyberweb/toplevel_methods/logo.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/logo.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/toplevel_methods/server_base_directory.rb'
+
+  # ========================================================================= #
+  # === Cyberweb.logo?
+  #
+  # This method will return the path to the currently used Cyberweb logo.
+  #
+  # This method may return a String such as:
+  #
+  #   /home/x/programming/ruby/src/cyberweb/images/cyberweb_logo.png
+  #
+  # ========================================================================= #
+  def self.logo?
+    "#{server_base_directory?}programming/ruby/src/"\
+    "web_object/images/cyberweb_logo.png"
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Cyberweb.logo?  
+end

data/lib/cyberweb/toplevel_methods/markdown.rb

@@ -0,0 +1,112 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Enable kramdown for proper markup-formatting.
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/markdown.rb'
+# Cyberweb.markdown
+# =========================================================================== #
+module Cyberweb
+
+  begin
+    require 'kramdown'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === DEFAULT_MARKDOWN_FILE
+  #
+  # The default markdown file. Should be distributed when we publish
+  # a new instance of web_object though.
+  # ========================================================================= #
+  DEFAULT_MARKDOWN_FILE =
+    '/home/x/DATA/PC/MARKDOWN/example.md'
+
+  # ========================================================================= #
+  # === show_inhalt_as_markdown
+  #
+  # This will try to display the file called INHALT.
+  # ========================================================================= #
+  def show_inhalt_as_markdown(
+      css_to_use = ''
+    )
+    read_and_display markdown(:INHALT, :return_it), css_to_use
+  end
+
+  # ========================================================================= #
+  # === read_and_display_markdown_file
+  # ========================================================================= #
+  def read_and_display_markdown_file(
+      this_markdown_file  = '',
+      optional_css_to_use = ''
+    )
+    read_and_display(
+      markdown(this_markdown_file, :return_it), optional_css_to_use
+    )
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.markdown                                      (markdown tag)
+  #
+  # Use markdown via the markdown() function. The first argument specifies
+  # the location of the markdown file in question.
+  #
+  # The second argument specifies whether we return it or not.
+  #
+  # We will use the Kramdown gem for this.
+  #
+  # Several aliases exist to this method, such as:
+  #
+  #   markdown_display_this_file
+  #
+  # Use whatever suits your needs.
+  # ========================================================================= #.
+  def self.markdown(
+      i         = DEFAULT_MARKDOWN_FILE,
+      return_it = false
+    )
+    return_it = true if return_it == :return_it
+    case i
+    when :all # We try to find all markdown files in the dir.
+      i = Dir['*.md']
+      return
+    when :def
+      i = DEFAULT_MARKDOWN_FILE
+    end
+    if i.is_a? Array
+      i.each {|entry| markdown(entry, return_it) } # Recursive calling.
+    else
+      i = i.to_s.dup
+      unless File.exist? i
+        i << '.md' unless i.include? '.md' # Try to append .md in this case.
+      end
+      if File.exist? i
+        file = File.read(i)
+        kramdown_document = Kramdown::Document.new(file)
+        _ = kramdown_document.to_html
+        if return_it
+          return _
+        else
+          return _
+        end
+      end
+    end
+  end; self.instance_eval { alias markdown_display_this_file markdown } # === Cyberweb.markdown_display_this_file
+       self.instance_eval { alias read_and_display_markdown  markdown } # === Cyberweb.read_and_display_markdown
+       self.instance_eval { alias show_md                    markdown } # === Cyberweb.show_md
+       self.instance_eval { alias display_markdown           markdown } # === Cyberweb.display_markdown
+
+  # ========================================================================= #.
+  # === markdown
+  # ========================================================================= #.
+  def markdown(
+      i         = DEFAULT_MARKDOWN_FILE,
+      return_it = false
+    )
+    ::Cyberweb.markdown(i, return_it)
+  end; alias markdown_display_this_file markdown # === markdown_display_this_file
+       alias read_and_display_markdown  markdown # === read_and_display_markdown
+       alias show_md                    markdown # === show_md
+       alias display_markdown           markdown # === display_markdown
+
+end

data/lib/cyberweb/toplevel_methods/mathml.rb

@@ -0,0 +1,130 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This code here providers a wrapper around MathML.
+#
+# MathML is "XML describing mathematical notations".
+#
+# It aims at integrating mathematical formulae into World Wide Web pages
+# and other documents. It is a recommendation of the W3C math working
+# group and part of HTML5.
+#
+# MathML 1 was released as a W3C recommendation in April 1998.
+#
+# More information can be obtained from the following page:
+#
+#   https://www.w3.org/Math/
+#
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/mathml.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === Cyberweb.mathml_start
+  #
+  # Open up the math XML tag.
+  # ========================================================================= #
+  def self.mathml_start(optional_css_class = '')
+    if optional_css_class.empty?
+      _ =  '<math xmlns="&mathml;">'
+    else
+      _ =  '<math xmlns="&mathml;" class="'+optional_css_class+'">'
+    end
+    # _ << '<mstyle mathvariant="bold">'
+    _
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.power_to
+  #
+  # This is the power_to() method.
+  #
+  # In ruby this corresponds to: a ** b
+  #
+  # Usage example:
+  #
+  #   ee power_to('a', 5)
+  #
+  # ========================================================================= #
+  def self.power_to(
+      a = 'y',
+      b = '3'
+    )
+    _ = ''.dup
+    _ << mathml_start
+    _ << '<msup>'
+    _ << '<mi>'+a.to_s+'</mi>'
+    _ << '<mn>'+b.to_s+'</mn>'
+    _ << '</msup>'
+    _ << mathml_end
+    return _
+  end; self.instance_eval { alias n_power_to power_to } # === Cyberweb.n_power_to
+
+  # ========================================================================= #
+  # === power_to
+  # ========================================================================= #
+  def power_to(a = 'y', b = '3')
+    ::Cyberweb.power_to(a,b)
+  end; alias n_power_to power_to # === n_power_to
+
+  # ========================================================================= #
+  # === mtag
+  # ========================================================================= #
+  def mtag
+    hash = {
+     '+' => 'mo' 
+    }
+    return hash
+  end
+
+  # ========================================================================= #
+  # === e_power_to
+  # ========================================================================= #
+  def e_power_to(a,b)
+    ee power_to(a,b)
+  end
+
+  # ========================================================================= #
+  # === test_mathml
+  # ========================================================================= #
+  def test_mathml
+    mathml_start+power_to+mathml_end
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.mathml_end
+  #
+  # Properly close the Mathml Tag again.
+  # ========================================================================= #
+  def self.mathml_end
+    _ = ''.dup
+    # _ <<  '</mstyle>' # Disabled as of Jul 2016.
+    _ << '</math>'
+  end
+
+  # ========================================================================= #
+  # === mathml_end
+  # ========================================================================= #
+  def mathml_end
+    ::Cyberweb.mathml_end
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.mathml
+  #
+  # This is a simplified way to use mathml in a webpage.
+  # ========================================================================= #
+  def self.mathml(
+      optional_css_class = ''
+    )
+    result = ::Cyberweb.mathml_start(optional_css_class).dup
+    if block_given?
+      result << yield
+    end
+    result << mathml_end
+    return result
+  end
+
+end

data/lib/cyberweb/toplevel_methods/message_boxes.rb

@@ -0,0 +1,140 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file holds various different CSS message boxes.
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/message_boxes.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === @counter_n_message_boxes_were_created
+  # ========================================================================= #
+  @counter_n_message_boxes_were_created = 0
+
+  # ========================================================================= #
+  # === Cyberweb.increment_n_message_boxes
+  #
+  # Use this method to increment the variable
+  # @counter_n_messages_were_created.
+  # ========================================================================= #
+  def self.increment_n_message_boxes(by_how_much = 1)
+    @counter_n_message_boxes_were_created += by_how_much
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.n_message_boxes_were_created?
+  # ========================================================================= #
+  def self.n_message_boxes_were_created?
+    @counter_n_message_boxes_were_created
+  end
+
+  # ========================================================================= #
+  # === message_box
+  #
+  # We have registered four different message boxes so far.
+  #
+  # The ID should never be changed.
+  #
+  # You can enable drag and drop if you pass the symbol
+  # :enable_drag_and_drop when invoking this method.
+  #
+  # An alternative to this would be to pass the identifier __drag__
+  # to the second method, as in this example:
+  #
+  #   info_box  'Hi there how do you do','__drag__','','width:30%'
+  #   error_box 'Hi there how do you do','__drag__','','width:30%'
+  #
+  # ========================================================================= #
+  def message_box(
+      content   = '',
+      css_class = '',
+      the_id    = 'success_box',
+      css_style = ''
+    )
+    extra_actions = nil
+    # ======================================================================= #
+    # extra_actions include specific extra instructions to this method.
+    # ======================================================================= #
+    extra_actions = yield if block_given?
+    css_class = '__drag__' if css_class == :drag
+    if css_class.to_s.include? '__drag__' # Enable drag and drop support.
+      css_class = css_class.to_s.dup
+      extra_actions = :enable_drag_and_drop
+      css_class.gsub!(/__drag__/,'')
+    end
+    _ = the_id.split('_').first
+    the_id << '_'+::Cyberweb.n_message_boxes_were_created?.to_s
+    css_class = _+' '+css_class.to_s # .to_s because it might be a Symbol.
+    # ======================================================================= #
+    # Designate a default image for the message_box next.
+    # ======================================================================= #
+    image = full_path_to_image_directory?+
+            WebImages['message_box_'+_] # image should now be, e. g., "STD/MESSAGE_BOX_ERROR.png"
+    case extra_actions
+    when :enable_drag_and_drop
+      drag the_id.to_sym # Enable drag and drop support here.
+    else
+      if extra_actions.is_a? Hash
+        if extra_actions.has_key? :use_this_as_image
+          image = extra_actions.delete :use_this_as_image
+          extra_actions = ''
+        end
+      end
+    end
+    increment_n_message_boxes # Increase the amount of used message boxes here.
+    # ======================================================================= #
+    # Next comes a short hack: if we pass in something that has a src="" entry,
+    # then we assume that this is not 100% what the user wanted to do here. Thus,
+    # we will extract the src="" component and use that instead.
+    # ======================================================================= #
+    if image.include? 'src="'
+      regex = /src="(.+?)"/ # This is non-greedy, see: http://rubular.com/r/rrc91XBJcI
+      image =~ regex
+      image = $1.to_s.dup
+    end
+    css_style = "background-image: url('"+
+      image+
+    "'); "+css_style
+    div(css_class.strip, the_id, css_style.strip) {
+      e content
+    }
+  end
+
+  # ========================================================================= #
+  # === error_box
+  # ========================================================================= #
+  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
+
+  # ========================================================================= #
+  # === info_box
+  #
+  # This makes a nice little message-box.
+  # ========================================================================= #
+  def info_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; alias anmerkung_box info_box # === anmerkung_box
+       alias information   info_box # === information
+
+  # ========================================================================= #
+  # === success_box
+  # ========================================================================= #
+  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
+
+  # ========================================================================= #
+  # === warning_box
+  # ========================================================================= #
+  def warning_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; alias warn_box warning_box # === warn_box
+
+end