cyberweb 0.4.174

data/lib/cyberweb/web_object/sitemap.rb

@@ -0,0 +1,176 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/web_object/sitemap.rb'
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class WebObject < Base # === Cyberweb::WebObject
+
+  require 'cyberweb/toplevel_methods/sitemap.rb'
+
+  # ========================================================================= #
+  # === autogenerated_sitemap
+  #
+  # This method will autogenerate a default Sitemap (an intralink).
+  #
+  # If the second argument for `optional_id` is :sort, then we will sort
+  # the result first before displaying it.
+  # ========================================================================= #
+  def autogenerated_sitemap(
+      css_class          = '',
+      optional_id        = '',
+      optional_css_style = 'top: 2px; right: 2px; background-color: #eee;',
+      append_css         = true, # By default we will append more CSS rules.
+      &block
+    )
+    # ======================================================================= #
+    # Obtain the dataset first.
+    # ======================================================================= #
+    registered_sitemaps = ::Cyberweb.array_registered_sitemaps?
+    css_for_li_elements = 'marl1px darkblue'
+    default_css_class_to_use = 'pad5px bblack1 black posab'
+    if block_given?
+      yielded = yield
+      # ===================================================================== #
+      # === Handle Blocks next
+      # ===================================================================== #
+      if yielded.is_a? Hash
+        # =================================================================== #
+        # === :css_style
+        # =================================================================== #
+        if yielded.has_key? :css_style
+          _ = yielded.delete :css_style
+          default_css_class_to_use = ''
+          optional_css_style = _
+        end
+      end
+    end
+    case optional_id
+    # ======================================================================= #
+    # === :sort
+    # ======================================================================= #
+    when :sort
+      registered_sitemaps.sort!
+      optional_id = ''
+    end
+    if css_class.empty?
+      if append_css # This is the default.
+        css_class = css_class.dup if css_class.frozen?
+        css_class << " #{default_css_class_to_use}"
+      end
+    else # Else, user passed arguments here.
+      css_class = css_class.dup if css_class.frozen?
+      css_class << " #{default_css_class_to_use}"
+    end
+    # ======================================================================= #
+    # Next comes the <div> that will hold our sitemap. For now this
+    # will always be a <div> element.
+    # ======================================================================= #
+    div(css_class, optional_id, optional_css_style) {
+      ee html_comment('Sitemap tag')
+      h2 'Sitemap','black whi martb2px pad2px s4px yel mar1px',
+         'SitemapHeader',
+         'background-color:darkblue;'
+      # ===================================================================== #
+      # Build up the proper <ul> tag next.
+      # ===================================================================== #
+      ul(id: 'SitemapNavigation') {
+        registered_sitemaps.each { |sitemap_id|
+          li('',css_for_li_elements) {
+            a '#'+sanitize_id(sitemap_id),
+              content: sitemap_id,
+              css_class: 'darkblue'
+          }
+        }
+      }
+    }
+  end; alias show_sitemap    autogenerated_sitemap # === show_sitemap
+       alias display_sitemap autogenerated_sitemap # === display_sitemap
+       alias asitemap        autogenerated_sitemap # === asitemap
+       alias add_sitemap     autogenerated_sitemap # === add_sitemap
+
+  # ========================================================================= #
+  # === header_for_sitemap
+  #
+  # This is a header that can be used to generate a sitemap.
+  #
+  # Note that if it is used it will also automatically generate
+  # a sitemap on the top right of the page. This was one major
+  # reason why this method was created - I wanted to automatically
+  # use a sitemap if I use such a header.
+  # ========================================================================= #
+  def header_for_sitemap(i)
+    id = i.tr(' ','_').tr('⁺','')
+    register_sitemap(i, id)
+    h2(i, '',id)
+  end
+
+  # ========================================================================= #
+  # === register_sitemap
+  #
+  # Use only this method to register an id to a sitemap. This is
+  # done automatically when we invoke the method sitemap().
+  #
+  # This method will delegate towards the toplevel-method, on the Cyberweb
+  # namespace.
+  #
+  # If the second argument `modify_input` is set to true, we will
+  # replace all occurrences of '_' with ' '. The reason for this
+  # is that HTML ids should not contain ' ' characters.
+  # ========================================================================= #
+  def register_sitemap(
+      i, modify_input = false
+    )
+    # ======================================================================= #
+    # Next simply delegate onto the toplevel method called
+    # Cyberweb.register_sitemap().
+    # ======================================================================= #
+    ::Cyberweb.register_sitemap(i, modify_input)
+  end; alias add_to_sitemap register_sitemap # === register_sitemap
+       alias sitemap        register_sitemap # === sitemap
+
+  # ========================================================================= #
+  # === array_for_sitemap?
+  #
+  # Accessor-method towards the array-constant.
+  # ========================================================================= #
+  def array_for_sitemap?
+    ::Cyberweb.array_for_sitemap?
+  end; alias array_for_sitemap array_for_sitemap? # === array_for_sitemap
+
+  # ========================================================================= #
+  # === add_roebe_sitemap_link
+  #
+  # This method will add a link to my (local) sitemap. This is fairly
+  # useless for other people, so don't use this method really.
+  # ========================================================================= #
+  def add_roebe_sitemap_link(
+      optional_css_class = 'mars1em steelblue BOLD'
+    )
+    use_this_as_the_content = :self
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :right_arrow
+      # ===================================================================== #
+      when :right_arrow
+        use_this_as_the_content = '→ Local Sitemap'
+      end
+    end
+    abr :local_sitemap,
+        content: use_this_as_the_content,
+        css_class: optional_css_class
+  end; alias roebe_sitemap             add_roebe_sitemap_link # === roebe_sitemap
+       alias to_the_roebe_sitemap      add_roebe_sitemap_link # === to_the_roebe_sitemap
+       alias to_roebe_sitemap          add_roebe_sitemap_link # === to_roebe_sitemap
+       alias to_roebe                  add_roebe_sitemap_link # === to_roebe
+       alias back_to_sitemap           add_roebe_sitemap_link # === back_to_sitemap
+       alias to_the_sitemap            add_roebe_sitemap_link # === to_the_sitemap
+       alias link_to_the_local_sitemap add_roebe_sitemap_link # === link_to_the_local_sitemap
+
+end; end

data/lib/cyberweb/web_object/table.rb

@@ -0,0 +1,378 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/web_object/table.rb'
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class WebObject < Base # === Cyberweb::WebObject
+
+  require 'cyberweb/toplevel_methods/html_tables.rb'
+  require 'cyberweb/html_tags/table.rb'
+
+  # ========================================================================= #
+  # === table4
+  # ========================================================================= #
+  def table4(
+      css_class = '',
+      the_id    = '',
+      css_style = '',
+      *content,
+      &block
+    )
+    addn(
+      string_table4(
+        css_class,
+        the_id,
+        css_style,
+        content,
+        &block
+      )
+    )
+  end
+
+  # ========================================================================= #
+  # === string_table4
+  # ========================================================================= #
+  def string_table4(
+      css_class = '',
+      the_id    = '',
+      css_style = '',
+      *content,
+      &block
+    )
+    # ======================================================================= #
+    # To test, try:
+    #
+    #   puts ::Cyberweb.string_table4('','','',%w( ah asjhk avshvasjkh vajhksavjhk avsjhvashkjavs ))
+    #
+    # ======================================================================= #
+    ::Cyberweb.string_table4(
+      css_class,
+      the_id,
+      css_style,
+      content,
+      &block
+    )
+  end
+
+  # ========================================================================= #
+  # === string_table2
+  # ========================================================================= #
+  def string_table2(
+      css_class = '',
+      the_id    = '',
+      css_style = '',
+      *content,
+      &block
+    )
+    ::Cyberweb.string_table2(
+      css_class,
+      the_id,
+      css_style,
+      content,
+      &block
+    )
+  end
+
+  # ========================================================================= #
+  # === table2
+  #
+  # This variant maks a two-elements-per-row HTML table.
+  #
+  # The last variable is the content; keep it even, if possible, e. g
+  # 2 elements or 4 or 6 and so forth.
+  # ========================================================================= #
+  def table2(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content,
+      &block
+    )
+    addn(
+      string_table2(
+        css_class,
+        id,
+        css_style,
+        content.flatten,
+        &block
+      )
+    )
+  end
+
+  # ========================================================================= #
+  # === table7
+  # ========================================================================= #
+  def table7(
+      css_class = '', id = '', css_style = '', *content
+    )
+    addn(
+      string_table7(
+        css_class, id, css_style, content
+      )
+    )
+  end
+
+  # ========================================================================= #
+  # === string_table7
+  # ========================================================================= #
+  def string_table7(
+      css_class = '', id = '', css_style = '', *content
+    )
+    # ======================================================================= #
+    # To test, try:
+    #
+    #   puts ::Cyberweb.string_table5('','','',%w( ah asjhk avshvasjkh vajhksavjhk avsjhvashkjavs ))
+    #
+    # ======================================================================= #
+    ::Cyberweb.string_table7(
+      css_class, id, css_style, content
+    )
+  end
+
+  # ========================================================================= #
+  # === string_table5
+  # ========================================================================= #
+  def string_table5(
+      css_class = '', id = '', css_style = '', *content
+    )
+    # ======================================================================= #
+    # To test, try:
+    #
+    #   puts ::Cyberweb.string_table5('','','',%w( ah asjhk avshvasjkh vajhksavjhk avsjhvashkjavs ))
+    #
+    # ======================================================================= #
+    ::Cyberweb.string_table5(
+      css_class, id, css_style, content
+    )
+  end
+
+  # ========================================================================= #
+  # === table3
+  # ========================================================================= #
+  def table3(css_class = '', id = '', css_style = '', *content)
+    addn(
+      string_table3(
+        css_class, id, css_style, content
+      )
+    )
+  end
+
+  # ========================================================================= #
+  # === table
+  # ========================================================================= #
+  def table(
+      optional_css_class = '',
+      optional_the_id    = '',
+      optional_css_style = ''
+    )
+    addnl(
+      '<table'+
+      css_class_or_no_class(optional_css_class)+
+      id_or_no_id(optional_the_id)+
+      css_style_or_no_style(optional_css_style)+
+      '>'
+    )
+  end
+
+  # ========================================================================= #
+  # === table12_with_heading
+  # ========================================================================= #
+  def table12_with_heading(css_class = '', id = '', css_style = '', *content)
+    addn(
+      string_table12_with_heading(
+        css_class, id, css_style, content
+      )
+    )
+  end
+
+  # ========================================================================= #
+  # === table11_with_heading
+  # ========================================================================= #
+  def table11_with_heading(css_class = '', id = '', css_style = '', *content)
+    addn(
+      string_table11_with_heading(
+        css_class, id, css_style, content
+      )
+    )
+  end
+
+  # ========================================================================= #
+  # === string_table11_with_heading
+  # ========================================================================= #
+  def string_table11_with_heading(
+      css_class = '', id = '', css_style = '', *content
+    )
+    ::Cyberweb.string_table11_with_heading(
+      css_class, id, css_style,
+      content
+    )
+  end
+
+  # ========================================================================= #
+  # === string_table2_with_heading
+  # ========================================================================= #
+  def string_table2_with_heading(css_class = '', id = '', css_style = '', *content)
+    ::Cyberweb.string_table2_with_heading(
+      css_class, id, css_style,
+      content
+    )
+  end
+
+  # ========================================================================= #
+  # === string_table12_with_heading
+  # ========================================================================= #
+  def string_table12_with_heading(css_class = '', id = '', css_style = '', *content)
+    ::Cyberweb.string_table12_with_heading(
+      css_class, id, css_style,
+      content
+    )
+  end
+
+  # ========================================================================= #
+  # === string_table5_with_heading
+  # ========================================================================= #
+  def string_table5_with_heading(css_class = '', id = '', css_style = '', *content)
+    ::Cyberweb.string_table5_with_heading(
+      css_class, id, css_style,
+      content
+    )
+  end
+
+  # ========================================================================= #
+  # === table5_with_heading
+  # ========================================================================= #
+  def table5_with_heading(css_class = '', id = '', css_style = '', *content)
+    addn(
+      string_table5_with_heading(
+        css_class, id, css_style, content
+      )
+    )
+  end
+
+  # ========================================================================= #
+  # === table2_with_heading
+  # ========================================================================= #
+  def table2_with_heading(css_class = '', id = '', css_style = '', *content)
+    addn(
+      string_table2_with_heading(
+        css_class, id, css_style, content
+      )
+    )
+  end
+
+  # ========================================================================= #
+  # === table_set_css_class
+  # ========================================================================= #
+  def table_set_css_class(
+      i = 'marl2em'
+    )
+    ::Cyberweb::Table.set_css_class(i)
+  end
+
+  # ========================================================================= #
+  # === table_padding=
+  # ========================================================================= #
+  def table_padding=(i = 10)
+    ::Cyberweb::Table.padding = i
+  end
+
+  # ========================================================================= #
+  # === table_clear
+  # ========================================================================= #
+  def table_clear
+    ::Cyberweb::Table.clear
+  end
+
+  # ========================================================================= #
+  # === table_parse
+  # ========================================================================= #
+  def table_parse(*i)
+    addnl(
+      ::Cyberweb::Table.parse(i)
+    )
+  end
+
+  # ========================================================================= #
+  # === string_table3
+  #
+  # We will delegate towards Cyberweb.string_table3 for the
+  # functionality here.
+  # ========================================================================= #
+  def string_table3(
+      css_class = '',
+      id        = '',
+      css_style = '',
+      *content
+    )
+    ::Cyberweb.string_table3(
+      css_class,
+      id,
+      css_style,
+      content
+    )
+  end
+
+  # ========================================================================= #
+  # === table2_from_this_file
+  #
+  # This variant will read from an existing file, ideally a markdown file
+  # .md. One row in the HTML table corresponds to one line in the original
+  # markdown file.
+  #
+  # Note that currently we will split on ':' which is hardcoded; not
+  # sure whether this will change in the future or not.
+  # ========================================================================= #
+  def table2_from_this_file(
+      optional_css_class = '',
+      optional_the_id    = '',
+      optional_css_style = '',
+      this_file          = 'games_timeline.md'
+    )
+    if File.exist? this_file
+      dataset = File.readlines(this_file, encoding: 'UTF-8').reject {|line|
+        line.start_with?('#') or line.strip.empty? # Ignore comments and empty lines.
+      }
+      splitted_dataset = dataset.map {|entry|
+        if entry.include? ':'
+          splitted = entry.split(':')
+          entry = [
+            splitted[0 .. -2].join(':'),
+            splitted[-1].strip
+          ]
+        end
+        entry
+      }
+      dataset = splitted_dataset
+      table2(
+        optional_css_class,
+        optional_the_id,
+        optional_css_style,
+        *dataset
+      )
+    else
+      e 'No file exists at '+this_file
+    end
+  end
+
+  # ========================================================================= #
+  # === ctable
+  # ========================================================================= #
+  def ctable
+    close(:table)
+  end
+  
+  # ========================================================================= #
+  # === parse_table
+  # ========================================================================= #
+  def parse_table(*args)
+    addnl(
+      ::Cyberweb.parse_table(args)
+    )
+  end
+
+end; end

data/lib/cyberweb/web_object/web_object.rb

@@ -0,0 +1,126 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb::WebObject
+#
+# The purpose of the class WebObject is to represent a web-object,
+# an object which is able to output a full HTML page - as a long
+# string - to any client.
+#
+# This HTML dump is stored in the instance variable :result, which is
+# kept within @internal_hash. You can query its content via the method
+# result? or string?.
+#
+# The best way to use this class is to simply require it, firstly,
+# like by doing so:
+#
+#   require 'web_object'
+#   web_object = Cyberweb::WebObject.new
+#
+# Afterwards, you can set the specific slots that you want to use on
+# the object individually, or in a batch-variant by using a {} Hash.
+#
+# The alias "w" is the most common idiom to address this "web object"
+# (w: this is easy to remember, simply remember that w stands for
+#     "web object" here).
+#
+# Once you have initiated a new web-object, there are several different
+# ways how to use that web-object.
+# =========================================================================== #
+# The global CSS object follows this API here:
+#
+#   Cyberweb::WebObject.new {{
+#      div: 'padding: 20em; color: green;',
+#      p:   'margin: 10em;',
+#      h2:  'color: yellow; background-color:black;'
+#   }}
+#
+# If we are going to redo this, we will probably add a new key such as
+#
+#   :global_css_style
+#
+# =========================================================================== #
+# require 'cyberweb/web_object/web_object.rb'
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class WebObject < Base # === Cyberweb::WebObject
+
+  require 'stringio'
+  require 'html_tags/base/base_module.rb'
+  require 'cyberweb/constants/array_local_css_files.rb'
+  require 'cyberweb/constants/nl.rb'
+  require 'cyberweb/constants/standalone_constants.rb'
+  require 'cyberweb/configuration/load_the_configuration_file.rb'
+  require 'cyberweb/web_object/evaluate.rb'
+  require 'cyberweb/web_object/favicon.rb'
+  require 'cyberweb/web_object/html_related_tags.rb'
+  require 'cyberweb/web_object/images.rb'
+  require 'cyberweb/web_object/initialize.rb'
+  require 'cyberweb/web_object/input_related_functionality.rb'
+  require 'cyberweb/web_object/javascript.rb'
+  require 'cyberweb/web_object/languages.rb'
+  require 'cyberweb/web_object/misc.rb'
+  require 'cyberweb/web_object/params.rb'
+  require 'cyberweb/web_object/reset.rb'
+  require 'cyberweb/web_object/run.rb'
+  require 'cyberweb/web_object/sinatra_related_functionality.rb'
+  require 'cyberweb/web_object/sitemap.rb'
+  require 'cyberweb/web_object/table.rb'
+  require 'cyberweb/toplevel_methods/name_of_img_dir.rb'
+  require 'cyberweb/toplevel_methods/listing.rb'
+  require 'cyberweb/toplevel_methods/quote.rb'
+  require 'cyberweb/toplevel_methods/pdf.rb'
+  require 'cyberweb/toplevel_methods/misc.rb'
+  require 'cyberweb/toplevel_methods/sanitize_url.rb'
+  require 'cyberweb/toplevel_methods/title.rb'
+  require 'cyberweb/toplevel_methods/pdf.rb'
+  require 'cyberweb/toplevel_methods/svg.rb'
+  require 'cyberweb/toplevel_methods/css.rb'
+  require 'cyberweb/toplevel_methods/return_html_to_head_start.rb'
+  require 'cyberweb/toplevel_methods/show_configuration.rb'
+  require 'cyberweb/toplevel_methods/string_body_start.rb'
+  require 'cyberweb/toplevel_methods/web_object.rb'
+  require 'cyberweb/coloured_tags/coloured_tags.rb'
+  require 'cyberweb/debug/debug.rb'
+  require 'cyberweb/classes/tooltips.rb'
+  require 'cyberweb/predefined_and_freeform_methods/predefined_methods.rb'
+  require 'cyberweb/javascript/popup.rb'
+  require 'cyberweb/javascript/javascript_bundle.rb'
+  require 'cyberweb/javascript/drag_and_drop.rb'
+  require 'cyberweb/requires/require_web_images.rb'
+  require 'cyberweb/html_tags/img.rb'
+  require 'cyberweb/html_tags/form.rb'
+  require 'cyberweb/html_tags/textarea.rb'
+  require 'cyberweb/html_tags/fieldset.rb'
+  require 'cyberweb/javascript/drag_and_drop.rb'
+
+end
+
+# =========================================================================== #
+# === Cyberweb.new
+#
+# The toplevel method new, as in Cyberweb.new, will instantiate a
+# new WebObject-instance.
+# =========================================================================== #
+def self.new(
+    i = nil, &block
+  )
+  ::Cyberweb::WebObject.new(i, &block)
+end; self.instance_eval { alias initialize_web_object new } # === Cyberweb.initialize_web_object
+     self.instance_eval { alias create_web_object     new } # === Cyberweb.create_web_object
+     self.instance_eval { alias []                    new } # === Cyberweb[]
+     # ==================================================================== #
+     # Trying the next as well - but I am not sure if we
+     # should keep this.
+     # ==================================================================== #
+     self.instance_eval { alias w                     new } # === Cyberweb.w (this is the main alias, w()).
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Cyberweb::WebObject.new(ARGV)
+end # web_object.rb

data/lib/cyberweb/web_scraper/README.md

@@ -0,0 +1,8 @@
+The code in this directory relates to web-scraping, that is,
+to obtain data from a remote website - including content 
+that may be dynamically rendered through JavaScript.
+
+Presently (August 2018) only one .rb file deals with that,
+which is a simple class that can be used to download e. g.
+pages from a university (made available in yet another
+project, called "studium").