cyberweb 0.4.174

data/lib/cyberweb/toplevel_methods/name_of_img_dir.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/name_of_img_dir.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/configuration/load_the_configuration_file.rb'
+
+  # ========================================================================= #
+  # === @name_of_img_dir
+  #
+  # This sets what name we will use for our image directory. It is
+  # determined by the yaml file that stores the configuration.
+  #
+  # If you wish to change this, make use of the method called
+  # Cyberweb.set_name_of_img_dir().
+  # ========================================================================= #
+  @name_of_img_dir = config?['default_image_directory']
+
+  # ========================================================================= #
+  # === Cyberweb.name_of_img_dir?
+  #
+  # This method will tell us the name of the img directory.
+  # ========================================================================= #
+  def self.name_of_img_dir?
+    @name_of_img_dir
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.set_name_of_img_dir
+  # ========================================================================= #
+  def self.set_name_of_img_dir(i)
+    @name_of_img_dir = i
+  end
+
+  # ========================================================================= #
+  # === name_of_img_dir?
+  #
+  # This method will return the name of the Image directory in question.
+  # ========================================================================= #
+  def name_of_img_dir?
+    ::Cyberweb.name_of_img_dir?
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Cyberweb.name_of_img_dir?
+end # rb name_of_img_dir.rb

data/lib/cyberweb/toplevel_methods/padlem_and_marlem.rb

@@ -0,0 +1,107 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/padlem_and_marlem.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === l1em
+  #
+  # This method essentially combines a <span> tag with a <br> tag following
+  # said <span> tag. It additionally makes use of "marl1em" by default,
+  # which is a shortcut for "margin-left: 1em".
+  #
+  # So essentially, you have a little formatter here, where text is a bit
+  # indented towards the right side, get a <span> tag that you can modify
+  # and a <br> tag that will be appended.
+  # ========================================================================= #
+  def l1em(
+      text,
+      css_class = '',
+      the_id    = '',
+      css_style = ''
+    )
+    use_newline = true
+    if block_given?
+      yielded = yield
+      case yielded
+      when :no_newline, :no_break
+        use_newline = false
+      end
+    end
+    ee string_span(text,'marl1em '+css_class, the_id, css_style)
+    br if use_newline
+  end; alias marl1em l1em # === marl1em
+       alias marlem  l1em # === marlem
+       alias lem     l1em # === lem (lem tag)
+       alias l1m     l1em # === l1m
+       alias le      l1em # === le
+       alias lem1    l1em # === lem1
+
+  # ========================================================================= #
+  # === lembre
+  #
+  # Wraps towards lem() but also calls a br(). The "e" I just added because
+  # it is kinda neat.
+  # ========================================================================= #
+  def lembre(
+      text, css_class = '', the_id = '', css_style = ''
+    )
+    lem text,css_class, the_id, css_style
+    br
+  end; alias lembr lembre # === lembre
+
+  # ========================================================================= #
+  # === l3em
+  # ========================================================================= #
+  def l3em(
+      text, css_class = '', the_id = '', css_style = ''
+    )
+    e text,"marl3em #{css_class}", the_id, css_style
+  end; alias marl3em l3em # === marl3em
+       alias l3      l3em # === l3
+       alias le3     l3em # === le3
+       alias leee    l3em # === leee
+       alias lem3    l3em # === lem3
+
+  # ========================================================================= #
+  # === lemspan
+  #
+  # This method is similar to l1em but it will not use a <br> tag.
+  # ========================================================================= #
+  def lemspan(
+      text, css_class = '', the_id = '', css_style = ''
+    )
+    lem(text, css_class, the_id, css_style) { :no_break }
+  end
+
+  # ========================================================================= #
+  # === padl2em
+  # ========================================================================= #
+  def padl2em(
+      text, css_class = '', the_id = '', css_style = ''
+    )
+    e text,'padl2em '+css_class, the_id, css_style
+  end; alias lem2 padl2em # === lem2
+
+  # ========================================================================= #
+  # === padl1em
+  # ========================================================================= #
+  def padl1em(
+      text, css_class = '', the_id = '', css_style = ''
+    )
+    e text,'padl1em '+css_class, the_id, css_style
+  end; alias padlem padl1em # === padlem
+
+  # ========================================================================= #
+  # === padl3em
+  # ========================================================================= #
+  def padl3em(
+      text, css_class = '', the_id = '', css_style = ''
+    )
+    e text,'padl3em '+css_class, the_id, css_style
+  end
+
+end

data/lib/cyberweb/toplevel_methods/params.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file will collect parameter-related methods and code parts.
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/params.rb'
+# Cyberweb.params?
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === show_params
+  # ========================================================================= #
+  def show_params
+    pre(cgi_params?)
+  end
+
+  # ========================================================================= #
+  # === cgi_params?
+  #
+  # Obtain all params through this method if a .cgi page is used.
+  # ========================================================================= #
+  def cgi_params?
+    ::Cyberweb.params?
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.params?
+  # ========================================================================= #
+  def self.params?
+    require 'cyberweb/cgi/cgi.rb'
+    ::Cyberweb::CGI.new.params # Delegate towards CGI.new here.
+    # cgi = ::CGI.new
+    # cgi.params
+  end; self.instance_eval { alias params      params? } # === Cyberweb.params
+       self.instance_eval { alias web_params? params? } # === Cyberweb.web_params?
+
+  # ========================================================================= #
+  # === webobject_params?
+  #
+  # This method will display the params in a little <div>-tag.
+  # ========================================================================= #
+  def webobject_params?
+    div {
+      # ===================================================================== #
+      # params? is defined below.
+      # ===================================================================== #
+      params?.each_pair {|key, value|
+        e "#{key} : #{value}",
+          'marl1em bblack1'
+      }
+    }
+  end; alias web_object_params webobject_params? # === web_object_params
+       alias params_with_a_div webobject_params? # === params_with_a_div
+
+end

data/lib/cyberweb/toplevel_methods/path.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/path.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/toplevel_methods/server_base_directory.rb'
+  require 'cyberweb/toplevel_methods/return_pwd.rb'
+
+  # ========================================================================= #
+  # === Cyberweb.converted_path
+  #
+  # This method will always return the correct path to the server base
+  # directory.
+  #
+  # It can be overruled on a per-directory setting, using a yaml file.
+  # ========================================================================= #
+  def self.converted_path(
+      result = '../' * ::Cyberweb.n_slashes_towards_the_server_base_directory
+    )
+    return result
+  end; self.instance_eval { alias cyberweb_fixed_path? converted_path } # === Cyberweb.cyberweb_fixed_path?
+       self.instance_eval { alias fixed_path?          converted_path } # === Cyberweb.fixed_path?
+       self.instance_eval { alias path?                converted_path } # === Cyberweb.path?
+       self.instance_eval { alias local_base?          converted_path } # === Cyberweb.local_base?
+
+  # ========================================================================= #
+  # === Cyberweb.converted_path_to_data
+  # ========================================================================= #
+  def self.converted_path_to_data
+    "#{converted_path}DATA/"
+  end; self.instance_eval { alias path_to_data? converted_path_to_data } # === Cyberweb.path_to_data?
+ 
+  # ========================================================================= #
+  # === Cyberweb.n_slashes_towards_the_server_base_directory
+  #
+  # This method will count how many '/' differences exist to the server
+  # base directory.
+  # ========================================================================= #
+  def self.n_slashes_towards_the_server_base_directory
+    result = (
+      ::Cyberweb.sanitized_pwd?.count('/') -
+      ::Cyberweb.server_base_directory?.count('/')
+    )
+    result = 0 if result < 0
+    result
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.absolute_path
+  #
+  # Use this to output the absolute path. For now it uses Dir.pwd,
+  # which will be prefixed.
+  # ========================================================================= #
+  def self.absolute_path(i)
+    ::Cyberweb.sanitized_pwd?+i
+  end
+
+  # ========================================================================= #
+  # === cyberweb_fixed_path?
+  # ========================================================================= #
+  def cyberweb_fixed_path?
+    ::Cyberweb.converted_path
+  end; alias converted_path        cyberweb_fixed_path? # === converted_path
+       alias webobject_fixed_path? cyberweb_fixed_path? # === webobject_fixed_path?
+
+end

data/lib/cyberweb/toplevel_methods/pdf.rb

@@ -0,0 +1,103 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/pdf.rb'
+# Cyberweb.embed_this_pdf
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/toplevel_methods/return_pwd.rb'
+
+  # ========================================================================= #
+  # === Cyberweb.embed_this_pdf
+  #
+  # Use this method to embed a .pdf file into your page. Using width
+  # and height values is recommended.
+  #
+  # It will generate a string such as this one here:
+  #
+  #   <object data="../../../../../STUDIUM/EXAMS_RESULT/AAA_EXAM_RESULTS.pdf" type="application/pdf" width="100%" height="100%">
+  #   </object> 
+  #
+  # For more documentation, see these resources:
+  #
+  #   http://pdfobject.com/markup/
+  #
+  # ========================================================================= #
+  def self.embed_this_pdf(
+      i,
+      also_enable_link = false
+    )
+    case also_enable_link
+    when :also_enable_link
+      also_enable_link = true
+    end
+    if also_enable_link
+      pdf_image = sg(:pdf,'marr6px','','width:28px') # The pdf image.
+      link(i, content: pdf_image+'SELF_BASENAME')
+      br
+    end
+    return '<object data="'+i.to_s+'" type="application/pdf" width="100%" height="100%">'+N+
+           '</object>'
+  end; self.instance_eval { alias embed_pdf embed_this_pdf } # === Cyberweb.embed_pdf
+       self.instance_eval { alias add_pdf   embed_this_pdf } # === Cyberweb.add_pdf
+
+  # ========================================================================= #
+  # === @path_to_last_generated_pdf_document
+  # ========================================================================= #
+  @path_to_last_generated_pdf_document = nil
+
+  # ========================================================================= #
+  # === Cyberweb.path_to_last_generated_pdf_document
+  # ========================================================================= #
+  def self.path_to_last_generated_pdf_document
+    @path_to_last_generated_pdf_document
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.set_path_to_last_generated_pdf_document
+  # ========================================================================= #
+  def self.set_path_to_last_generated_pdf_document(i)
+    @path_to_last_generated_pdf_document
+  end
+
+  # ========================================================================= #
+  # === display_pdfs                                      (pdfs tag, pdf tag)
+  #
+  # Use this method when you wish to display pdfs. The input argument
+  # should be a directory.
+  #
+  # You can also pass a hash as input - in this case we assume it
+  # may follow a structure like this here:
+  #
+  #   show_all_pdf_files css: 's2em'
+  #
+  # ========================================================================= #
+  def display_pdfs(
+      this_dir     = ::Cyberweb.return_pwd,
+      optional_css = ''
+    )
+    pdf_image = sg(:pdf,'marr6px','','width:28px') # The pdf image.
+    if this_dir.is_a? Hash
+      if this_dir.has_key? :css
+        optional_css = this_dir.delete :css
+        this_dir = ::Cyberweb.return_pwd
+      end
+    end
+    this_dir = ::Cyberweb.return_pwd if this_dir.empty? # Safeguard.
+    this_dir << '/' unless this_dir.end_with? '/'
+    _ = get_files_from(this_dir)
+    _.reject! {|entry| entry !~ /pdf$/ } if _ # Reject non pdf files.
+    _.each {|my_link|
+      abr(
+        my_link,
+        content: pdf_image+'SELF_BASENAME',
+        css_class: optional_css
+      )
+    } if _
+  end; alias show_pdf_files     display_pdfs # === show_pdf_files
+       alias show_all_pdf_files display_pdfs # === show_all_pdf_files
+       alias show_pdf           display_pdfs # === show_pdf
+
+end

data/lib/cyberweb/toplevel_methods/process_content.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/process_content.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/predefined_and_freeform_methods/predefined_methods.rb'
+  require 'cyberweb/toplevel_methods/umlaute.rb'
+
+  # ========================================================================= #
+  # === Cyberweb.process_content
+  #
+  # We check for some special <> tags here. Right now we will only
+  # replace i.e. <red>foo</> with <span class="red">red</span>
+  #
+  # Since as of July 2014, we will try to pass this towards NewTags.
+  #
+  # To test whether this works, do this:
+  #
+  #    e  Cyberweb.process_content "<red>foo</>"
+  #    ee Cyberweb.process_content "<red>foo<>"
+  #    ee Cyberweb.process_content "<ruby>foo<>"
+  #    ee Cyberweb.process_content "Ein Vorteil von <darkgreen>Cmake</> ist es, das das <b>Kompilieren schneller geht</b>."
+  #
+  # ========================================================================= #
+  def self.process_content(input)
+    begin
+      require 'new_tags' # Required for method process_content().
+      if NewTags.is_included? input
+        input = NewTags.convert(input)
+      end if Object.const_defined? :NewTags
+    rescue LoadError
+    end
+    # ======================================================================= #
+    # Next, we will process special tags, such as <ud>, which are custom
+    # rather than officially defined.
+    # ======================================================================= #
+    ARRAY_INTERNAL_TAGS.each { |tag|
+      real_tag_name = '<'+tag+'>'
+      if input.include? real_tag_name
+        # =================================================================== #
+        #   <ud>foobar</>
+        # will become:
+        #   <span class="ud">foobar</>
+        # This will also work for:
+        #   <ud>foobar</ud>
+        # =================================================================== #
+        # See: https://rubular.com/r/V50T61CGplsK1Q
+        # =================================================================== #
+        regex = /\<(.+)\>(.+)\<\/#{tag}\>/
+        _ = regex.match(input)
+        new = '<span class="'+_[1]+'">'+_[2]+'</span>'
+        input = input.gsub(regex, new)
+      end
+    }
+    if input.include? '</>' or input.include? '<>' # Assume we have a closing tag
+      regex_to_use = /<(\w+)>(.+)<\/?>/
+      match_data_object = regex_to_use.match(input)
+
+      which_tag_to_use = 'span' # right now hardcoded
+
+      if match_data_object
+        class_to_use = match_data_object[1]
+        content      = match_data_object[2]
+
+        # ===================================================================== #
+        # If it is a special tag registered inside
+        #   bl $RUBY_WWW/linguistic_web.rb
+        # ===================================================================== #
+        if hash_registered_extra_tags?.keys.include? class_to_use.to_sym
+          # Then we will fetch its content from that Hash:
+          class_to_use = hash_registered_extra_tags?[class_to_use.to_sym]
+        end
+        input = match_data_object.pre_match+'<'+
+                which_tag_to_use+' class="'+
+                class_to_use+'">'+
+                content+'</'+
+                which_tag_to_use+
+                '>'+match_data_object.post_match
+      end
+    end
+    # ======================================================================= #
+    # A dual tag is a tag like this:
+    #   <b red>
+    # But it seems as if we no longer make use of it.
+    # ======================================================================= #
+    if ::Cyberweb.convert_umlaute?
+      input = ::Cyberweb.escape_umlauts(input)
+    end
+    return input
+  end
+
+  # ========================================================================= #
+  # === process_content
+  # ========================================================================= #
+  def process_content(i)
+    ::Cyberweb.process_content(i)
+  end
+
+end

data/lib/cyberweb/toplevel_methods/progress.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/progress.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === progress
+  #
+  # This method will display a cute little progress "bar".
+  #
+  # Usage examples:
+  #
+  #   progress :rand
+  #   progress [55,22,11,5,2,2,2,35]
+  #
+  # ========================================================================= #
+  def progress(
+      percentage = '77'
+    )
+    percentage = rand(100)+1 if percentage.to_s == 'rand'
+    div(:progress_container) {
+      if percentage.is_a? Array
+        percentage.each {|member| real_progress_bar(member.to_s) }
+      else 
+        real_progress_bar percentage.to_s
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === real_progress_bar
+  # ========================================================================= #
+  def real_progress_bar(percentage)
+    div('','','width:'+percentage+'%; font-size:0.8em;font-weight:bold;margin:4px;background-color:RANDOM_COLOUR'){
+      ee percentage
+    }
+  end; alias rpb real_progress_bar # rpb
+
+end

data/lib/cyberweb/toplevel_methods/quote.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/quote.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === Cyberweb.quote
+  #
+  # The <q> tag defines a short quotation.
+  #
+  # Browsers normally insert quotation marks around the quotation,
+  # realized through q:before and q:after.
+  #
+  # Documentation for the quote-tag can be found at:
+  #
+  #   https://www.w3.org/TR/html-markup/q.html
+  #   https://www.w3schools.com/tags/tag_q.asp
+  #
+  # ========================================================================= #
+  def self.quote(
+      text,
+      css_class = '',
+      the_id    = '',
+      css_style = ''
+    )
+    stag(text,'q',css_class, the_id, css_style)
+  end
+
+  # ========================================================================= #
+  # === quote
+  # ========================================================================= #
+  def quote(
+      text,
+      css_class = '',
+      the_id    = '',
+      css_style = ''
+    )
+    ::Cyberweb.quote(text, css_class, the_id, css_style)
+  end
+
+end

data/lib/cyberweb/toplevel_methods/random.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/random.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/constants/standalone_constants.rb'
+
+  # ========================================================================= #
+  # === Cyberweb.return_random_border
+  #
+  # This method here will return a random border.
+  #
+  # For this to work, ARRAY_CSS_BORDER_STYLES must have been defined.
+  #
+  # The first argument to this method, called `border_size_in_n_pixels`,
+  # tells us how many pixels to use for this border.
+  # ========================================================================= #
+  def self.return_random_border(
+      border_size_in_n_pixels = 1,
+      available_borders       = ARRAY_CSS_BORDER_STYLES
+    )
+    border_size_in_n_pixels = border_size_in_n_pixels.to_s.dup
+    border_size_in_n_pixels.gsub!('PX','')
+    random_style = available_borders.sample.to_s
+    random_style = random_style.first.to_s if random_style.is_a? Array
+    if block_given?
+      yielded = yield
+      case yielded
+      when :dotted
+        random_style = 'dotted'
+      end
+    end
+    # ======================================================================= #
+    # Now build up the "border:" string.
+    # ======================================================================= #
+    result = 'border: '.dup
+    result << border_size_in_n_pixels
+    result << 'px '
+    result << random_style.to_s+' '
+    result << return_random_colour+';'
+    return result
+  end
+
+  # ========================================================================= #
+  # === return_random_border
+  # ========================================================================= #
+  def return_random_border(
+      border_size_in_n_pixels = 1,
+      available_borders       = ARRAY_CSS_BORDER_STYLES
+    )
+    ::Cyberweb.return_random_border(
+      border_size_in_n_pixels, available_borders
+    )
+  end
+
+  # ========================================================================= #
+  # === random_image
+  #
+  # This method will return a random image.
+  # ========================================================================= #
+  def random_image
+    string_img(
+      ::Cyberweb::ARRAY_LISTING_ALL_PROJECT_IMAGES.sample
+    )
+  end
+
+end

data/lib/cyberweb/toplevel_methods/rds.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/rds.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === Cyberweb.rds
+  #
+  # The name "rds" is an appreviation for "remove double slash".
+  # ========================================================================= #
+  def self.rds(
+      i = '/home/x//'
+    )
+    if i.respond_to? :squeeze
+      i.squeeze('/')
+    else
+      pp caller()
+      raise "The given input (class #{i.class}) does "\
+            "not respond to the method .squeeze()."
+    end
+  end; self.instance_eval { alias remove_double_slash rds } # === Cyberweb.remove_double_slash
+
+  # ========================================================================= #
+  # === remove_double_slash
+  #
+  # A helper method to remove double slashes from a string.
+  # ========================================================================= #
+  def remove_double_slash(i)
+    Cyberweb.rds(i)
+  end; alias rds remove_double_slash # === rds
+
+end