cyberweb 0.4.174

data/lib/cyberweb/toplevel_methods/tag.rb

@@ -0,0 +1,237 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/tag.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'html_tags'
+  require 'cyberweb/colours/sanitize_for_colours.rb'
+  require 'cyberweb/toplevel_methods/random.rb'
+  require 'cyberweb/toplevel_methods/registered_ids.rb'
+
+  # ========================================================================= #
+  # === @last_tag_used
+  #
+  # This Array keeps track of the last tag used.
+  # ========================================================================= #
+  @last_tag_used = []
+
+  # ========================================================================= #
+  # === Cyberweb.string_tag                                        (stag tag)
+  #
+  # This is a very important, basic method. It is probably among the top
+  # ten most important methods within the Cyberweb namespace.
+  #
+  # This method will ultimately create a proper HTML tag, including css
+  # class, possible javascript, id, and css style, and then return that
+  # string. stag is an alias to this method; even "s" may be an alias,
+  # to allow for shorter code, but we need to be careful with short
+  # method names, as these can create problems for users trying to
+  # find documentation. So the "official" name is simply "string_tag()"
+  # for this method here.
+  #
+  # Specific Usage Example for this method:
+  #
+  #   stag('span','marl1em')
+  #
+  # or
+  #
+  #   stag 'span','marl1em'
+  #
+  # Would return:
+  #
+  #   <span class="marl1em">
+  #
+  # Further usage examples:
+  #
+  #   Cyberweb.string_tag(:button,'','','', 'onclick="myMove()"')
+  #
+  # ========================================================================= #
+  def self.string_tag(
+      which_tag       = 'span',
+      css_class       = '',
+      the_id          = '',
+      css_style       = '',
+      javascript_code = '',
+      &block
+    )
+    # ======================================================================= #
+    # Simply delegate towards HtmlTags here.
+    # ======================================================================= #
+    _ = ''.dup
+    case the_id
+    when :resize
+      the_id = 'resize_'
+      15.times { the_id << ALPHABET.sample } # Make a unique ID in this case.
+      if the_id.start_with? 'resize_'
+        javascript_resize_this_id(the_id)
+      end
+    when /resize_/ # If it starts with this.
+      javascript_resize_for_this_id(the_id)
+    end
+    register_this_id(the_id)
+    if the_id.is_a? Hash
+      if the_id.has_key? :css # We assume this means :css_style
+        css_style = the_id.delete(:css)
+        the_id = '' # And then delete it.
+      elsif the_id.has_key? :id
+        the_id = the_id.delete(:id)
+      end
+    end
+    # ======================================================================= #
+    # RANDOM_BORDER
+    # ======================================================================= #
+    if css_style.include? 'RANDOM_BORDER'
+      regex = /RANDOM_BORDER_(.+)/
+      match = css_style.match(regex)[1]
+      if css_style.frozen?
+        css_style = css_style.to_s.dup
+      end
+      css_style.gsub!(
+        regex, return_random_border(match)
+      )
+    end
+    css_style = sanitize_for_colours(css_style)
+    if css_class.is_a? Symbol
+      case css_class
+      when :bord_1px_random_dotted
+        css_class = ''
+        css_style = ::Cyberweb.return_random_border(1) { :dotted }
+      when :bord_1px_random
+        css_class = ''
+        css_style = ::Cyberweb.return_random_border(1)
+      end
+    end
+    # ======================================================================= #
+    # Next, keep track of which tag we used last.
+    # ======================================================================= #
+    set_last_tag_used(which_tag, the_id)
+    # ======================================================================= #
+    # Finally we delegate towards HtmlTags. We must be careful
+    # though - HtmlTags also modifies the given input.
+    # ======================================================================= #
+    _ << HtmlTags.stag(
+           which_tag,
+           css_class,
+           the_id,
+           css_style,
+           javascript_code,
+           &block
+         )
+    return _
+  end; self.instance_eval { alias stag        string_tag } # === Cyberweb.stag
+       self.instance_eval { alias make_tag    string_tag } # === Cyberweb.make_tag
+       self.instance_eval { alias string_stag string_tag } # === Cyberweb.string_stag
+       # alias s string_tag # Does not work - span() already has an alias called s().
+
+  # ========================================================================= #
+  # === Cyberweb.set_last_tag_used
+  #
+  # We keep track of the last tag that is used.
+  # ========================================================================= #
+  def self.set_last_tag_used(
+      i,
+      optional_id = nil
+    )
+    i = i.to_s.dup
+    if optional_id.is_a? String
+      optional_id = nil if optional_id.empty?
+    end
+    @last_tag_used = [i, optional_id] # Always manipulate only the first entry here.
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.last_tag_used?
+  # ========================================================================= #
+  def self.last_tag_used?
+    @last_tag_used
+  end
+
+  # ========================================================================= #
+  # === last_tag_used?
+  # ========================================================================= #
+  def last_tag_used?
+    ::Cyberweb.last_tag_used?
+  end
+
+  # ========================================================================= #
+  # === set_last_tag_used
+  # ========================================================================= #
+  def set_last_tag_used(
+      i, optional_id = nil
+    )
+    ::Cyberweb.set_last_tag_used(i, optional_id)
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.tag                                                (tag tag)
+  #
+  # Use this method to print an opening a tag. This should be the preferred
+  # way to print a tag with css markup, and we will make use of the
+  # method string_tag() for it.
+  #
+  # Usage examples:
+  #
+  #   tag 'b','FLR FS1em'
+  #   tag :div,'FLR FS1em'
+  #
+  # ========================================================================= #
+  def self.tag(
+      which_tag, # <- Is a mandatory entry.
+      css_class  = '',
+      the_id     = '',
+      css_style  = '',
+      javascript = ''
+    )
+    # ========================================================================= #
+    # Next, print the result, by sending it into the method Cyberweb.stag().
+    # ========================================================================= #
+    ee stag(
+      which_tag,
+      css_class,
+      the_id,
+      css_style,
+      javascript
+    )
+  end
+
+  # ========================================================================= #
+  # === tag
+  # ========================================================================= #
+  def tag(
+      a, b = '', c = '', d = '', e = ''
+    )
+    ::Cyberweb.tag(a, b, c, d, e)
+  end
+
+  # ========================================================================= #
+  # === string_tag
+  # ========================================================================= #
+  def string_tag(
+      which_tag       = 'span',
+      css_class       = '',
+      the_id          = '',
+      css_style       = '',
+      javascript_code = ''
+    )
+  end; alias stag     string_tag # === stag
+       alias make_tag string_tag # === make_tag
+
+  # ========================================================================= #
+  # === report_which_tag_was_used_last
+  # ========================================================================= #
+  def report_which_tag_was_used_last(
+      optional_css_class = ''
+    )
+    _ = last_tag_used?
+    div(optional_css_class) unless optional_css_class.empty?
+      e 'The last tag in use was `<b>'+_.first+'</b>`.'
+      if _.size > 1 and _.last # If a second entry exists.
+        e 'The id this tag has is `<b>'+_.last+'</b>`.'
+      end
+    cdiv unless optional_css_class.empty?
+  end
+
+end

data/lib/cyberweb/toplevel_methods/temp_directory.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/temp_directory.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/toplevel_methods/roebe.rb'
+
+  # ========================================================================= #
+  # === @temp_directory
+  #
+  # This is the temp directory.
+  #
+  # It allows us to store temporary files, such as log files, or
+  # a .html output file.
+  # ========================================================================= #
+  @temp_directory = nil
+
+  # ========================================================================= #
+  # === Cyberweb.set_temp_directory
+  # ========================================================================= #
+  def self.set_temp_directory(
+      i = :default
+    )
+    case i
+    # ======================================================================= #
+    # === :depot_temp
+    #
+    # This entry point will always default to /Depot/Temp.
+    # ======================================================================= #
+    when :depot_temp,
+         :depot_temp_dir
+      i = '/Depot/Temp/'
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default
+      if is_on_roebe?
+        i = '/home/Temp/'
+      else
+        i = '/tmp/' # This should be the default for most Linux variants.
+      end
+    end
+    unless i.end_with? '/'
+      i = i.dup if i.frozen?
+      i << '/'
+    end
+    @temp_directory = i.freeze
+  end; self.instance_eval { alias set_temp_dir set_temp_directory } # === Cyberweb.set_temp_dir
+
+  set_temp_directory # Set a default value here.
+
+  # ========================================================================= #
+  # === Cyberweb.temp_directory?
+  # ========================================================================= #
+  def self.temp_directory?
+    @temp_directory
+  end
+
+  # ========================================================================= #
+  # === temp_directory?
+  # ========================================================================= #
+  def temp_directory?
+    Cyberweb.temp_directory?
+  end; alias temp_dir? temp_directory? # === temp_dir?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Cyberweb.temp_directory?
+end

data/lib/cyberweb/toplevel_methods/test_css.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/test_css.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === Cyberweb.test_css
+  # ========================================================================= #
+  def self.test_css
+    puts 'h1 {
+  text-decoration: underline red;
+  text-decoration-thickness: 3px;
+  text-underline-offset: 6px;
+ }'
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Cyberweb.test_css
+end

data/lib/cyberweb/toplevel_methods/textile.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === Cyberweb.textile                                        (textile tag)
+  #
+  # This uses textile markup format.
+  # ========================================================================= #
+  def self.textile(
+      i         = '/home/x/DATA/PC/TEXTILE/test.textile',
+      return_it = false
+    )
+    begin
+      # ===================================================================== #
+      # Try to enable RedCloth, for textile documents.
+      # ===================================================================== #
+      require 'redcloth' unless Object.const_defined?(:Redcloth)
+    rescue LoadError; end
+    if i.empty? or (i == :default)
+      i = '/home/x/DATA/PC/TEXTILE/test.textile'
+    end
+    begin # rescue, in case RedCloth was not installed.
+      document = RedCloth.new(File.read(i))
+      _ = document.to_html
+      if return_it # Simply return it here.
+        _
+      else # Output and display it here.
+        ee _
+      end
+    rescue LoadError; end # But be silent about it.
+  end
+
+  # ========================================================================= #
+  # === textile
+  # ========================================================================= #
+  def textile(
+      i = :default, return_it = false
+    )
+    Cyberweb.textile(i, return_it)
+  end
+
+end

data/lib/cyberweb/toplevel_methods/title.rb

@@ -0,0 +1,125 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/title.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/toplevel_methods/tag.rb'
+
+  # ========================================================================= #
+  # === @title
+  #
+  # This ivar will store the title of a page. Initially it is set
+  # to a value of nil.
+  #
+  # You can query its current value by calling the method Cyberweb.title().
+  # ========================================================================= #
+  @title = nil
+
+  # ========================================================================= #
+  # === Cyberweb.set_title
+  #
+  # Set the title of the webpage in question, through this method.
+  #
+  # In plain HTML, this would be equivalent to:
+  #
+  #   <title>Hello World!</title>
+  #
+  # ========================================================================= #
+  def self.set_title(i)
+    @title = i
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.title?
+  #
+  # Query the module-stored value of @title.
+  # ========================================================================= #
+  def self.title?
+    @title
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.show_title
+  # ========================================================================= #
+  def self.show_title
+    puts @title
+  end
+
+  # ========================================================================= #
+  # === set_title
+  # ========================================================================= #
+  def set_title(i)
+    ::Cyberweb.set_title(i)
+  end
+
+  # ========================================================================= #
+  # === enable_title_for_reading_files
+  #
+  # Use this method to enable <fieldset> tags.
+  # ========================================================================= #
+  def enable_title_for_reading_files(
+      use_this_css = ''
+    )
+    @enable_title_for_reading_files = []
+    unless use_this_css.empty?
+      @enable_title_for_reading_files << use_this_css
+    end
+  end
+
+  # ========================================================================= #
+  # === string_combined_title
+  #
+  # Use this method to create a proper html-title.
+  #
+  # This method combines the following three methods:
+  #
+  #   string_html_start  # <html>
+  #   string_title       # <title>
+  #   string_body_start  # <body>
+  #
+  # Specific usage example:
+  #
+  #   Cyberweb.string_combined_title("Browser Viewer")
+  #
+  # ========================================================================= #
+  def string_combined_title(
+      input, css_class = '', css_style = ''
+    )
+    _ = string_html_start   +
+        string_title(input) + 
+        string_body_start(css_class, css_style)  
+  end
+
+  # ========================================================================= #
+  # === return_title
+  # ========================================================================= #
+  def return_title(i)
+    ::Cyberweb.return_title(i)
+  end; alias string_title   return_title # === string_title
+       alias title_complete return_title # === title_complete
+
+  # ========================================================================= #
+  # === Cyberweb.return_title                                     (title tag)
+  #
+  # Will simply return a html-valid title, and nothing else.
+  # ========================================================================= #
+  def self.return_title(
+      this_title
+    )
+    case this_title.downcase
+    when 'default',
+         'self'
+      this_title = Pathname.new(
+        $PROGRAM_NAME
+      ).basename.to_s.sub(/\.[^\.]+$/,'') # The regex kills any possible file ending.
+    end
+    return "#{stag('title').to_s}"\
+           "#{this_title.to_s}"\
+           "#{string_close('title')}#{NL}"
+  end; self.instance_eval { alias string_title   return_title } # === Cyberweb.string_title
+       self.instance_eval { alias title_complete return_title } # === Cyberweb.title_complete
+
+end

data/lib/cyberweb/toplevel_methods/umlaute.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file will handle e. g. german umlauts.
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/umlaute.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === @convert_umlaute
+  # ========================================================================= #
+  @convert_umlaute = false
+
+  # ========================================================================= #
+  # === Cyberweb.convert_umlaute
+  # ========================================================================= #
+  def self.convert_umlaute
+    @convert_umlaute
+  end; self.instance_eval {
+    alias convert_umlaute? convert_umlaute
+  } # Simply add a '?' here, so that we can use Cyberweb.convert_umlaute?
+
+  # ========================================================================= #
+  # === Cyberweb.do_convert_umlaute
+  #
+  # This method can be enabled to properly display umlauts in a webpage.
+  #
+  # For this, do something like:
+  #
+  #   Cyberweb.convert_umlaute
+  #
+  # ========================================================================= #
+  def self.do_convert_umlaute
+    @convert_umlaute = true
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.convert_back_german_umlauts
+  #
+  # This method will convert e. g. '%d6' back into 'Ö'.
+  #
+  # Other tokens should also, eventually, work correctly.
+  #
+  # Usage example:
+  #
+  #   Cyberweb.convert_back_german_umlauts "fragen über computer" # => "fragen über computer"
+  #
+  # ========================================================================= #
+  def self.convert_back_german_umlauts(i)
+    i.gsub(/%d6/, 'Ö').
+      gsub(/%f6n/,'ö').
+      gsub(/ü/,  'ü').
+      gsub(/Ö/,  'Ö').
+      gsub(/Ã/,   'Ü').
+      gsub(/Ã/,   'ss').
+      gsub(/ܶ/,  'ö').
+      gsub(/Ö¶/,  'ö').
+      gsub(/Ö¤/,  'ä').
+      gsub(/ܤ/,  'ä')
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.escape_umlauts
+  #
+  # This method can be used to escape certain umlauts.
+  #
+  # Keep in mind that not everything can be solved with this ad-hoc
+  # method; if you have control over the webserver, perhaps you can
+  # modify the Content type towards e. g.:
+  #
+  #   Content-Type: text/html; charset=utf-8\n\n
+  #
+  # ========================================================================= #
+  def self.escape_umlauts(i)
+    return i.gsub(/ä/, 'ä').
+             gsub(/ü/, 'ü').
+             gsub(/ö/, 'ö').
+             gsub(/ö/,  '%f6n')
+  end
+
+  # ========================================================================= #
+  # === escape_umlauts
+  # ========================================================================= #
+  def escape_umlauts(i)
+    ::Cyberweb.escape_umlauts
+  end
+
+end