cyberweb 0.4.174

data/lib/cyberweb/toplevel_methods/read_and_display.rb

@@ -0,0 +1,284 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/read_and_display.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/encoding/encoding.rb'
+
+  # ========================================================================= #
+  # === read_and_display
+  #
+  # You can pass a block to this method. If passed, we will remove the 
+  # character in a gsub.
+  #
+  # Please note that we will already check whether the file exists, so
+  # you do not have to manually call File.exist? on your own before
+  # calling this method here.
+  #
+  # If the sixth argument `do_escape_html` is true then we will replace
+  # HTML via the method escape_html(), which will delegate towards
+  # class RemoveHtml.
+  #
+  # The first argument shall specify which file we wish to read it.
+  # Note that this is a string which can include special instructions
+  # after a # character.
+  #
+  # For instance:
+  #
+  #   read_display 'FEATURES#USE_REGEX1'
+  #
+  # This would try to read in a file called FEATURES, and apply a 
+  # regex filter on it.
+  #
+  # Usage examples for this method:
+  #
+  #   read_display 'FEATURES#USE_REGEX1','d1em smaller','',BORDER
+  #                 ^^^ specifies name of file, then the filter.
+  #
+  #   read_and_display 'USAGE#colourize_in_ruby','pad1em bigger'
+  # ========================================================================= #
+  def read_and_display(
+      this_file          = 'USAGE.md',
+      css_to_use         = 'bblack2',
+      optional_id        = '',
+      optional_css_style = '',
+      colourize_me       = false,
+      do_escape_html     = true,
+      &block
+    )
+    case css_to_use
+    when :default
+      css_to_use         = 'bblack2'
+    end
+    web_object = ::Cyberweb.web_object?
+    unless web_object.enable_title_for_reading_files.empty?
+      fieldset web_object.enable_title_for_reading_files.first
+      the_title_to_use = File.basename(this_file)
+      if the_title_to_use.include? '#'
+        the_title_to_use[ the_title_to_use.index('#'), the_title_to_use.size ] = ''
+      end
+      legend(the_title_to_use,'s8px')
+    end
+    this_file = this_file.to_s # We need a string here.
+    original_file = this_file.dup
+    # ======================================================================= #
+    # If '#' is a part of this_file, then we assume that we wish to use
+    # a regex or a filter.
+    # ======================================================================= #
+    use_a_regex_or_a_filter = nil
+    if this_file.include? '#'
+      splitted = this_file.split '#'
+      this_file = splitted.first
+      use_a_regex_or_a_filter = splitted[1]
+    end
+    if File.exist?(this_file)
+      _ = read_file(this_file) # Read in the file here.
+      # ===================================================================== #
+      # Mandatory bblack2 is not good, IMO. (Sep 2013)
+      # ===================================================================== #
+      # if ! css_to_use.include? 'bblack2'
+      #   css_to_use << ' bblack2' unless css_to_use.empty?
+      # end
+      # ===================================================================== #
+      # Since Jul 2011 we replace some of Ruby's keywords.
+      # ===================================================================== #
+      _ = _.join unless _.is_a? String
+      if colourize_me # Only use this when colourize_me is true.
+        # =================================================================== #
+        # If the file is a ruby file or a cgi file, we replace some keywords.
+        # =================================================================== #
+        case File.extname(this_file).delete('.')
+        when 'rb','cgi'
+          _ = colourize_ruby_code(_) # Colourize ruby code here.
+        when 'nim'
+          _ = colourize_nim_code(_)
+        end
+      end
+      # ===================================================================== #
+      # If we pass a block, we gsub on that result.
+      # ===================================================================== #
+      if block_given?
+        gsub_this = yield
+        if gsub_this.is_a? Symbol
+          case gsub_this
+          when :no_border
+            if optional_css_style and optional_css_style.include?('border: ')
+              # ============================================================= #
+              # See: https://rubular.com/r/oUEw5OSzUwTawH
+              # ============================================================= #
+              regex_to_use = /(border: \d{0,1}[a-z ]+)/
+              optional_css_style = optional_css_style.dup if optional_css_style.frozen?
+              optional_css_style.sub!(regex_to_use,'')
+            end
+          end
+        else
+          _.gsub!(/#{gsub_this}/,'')
+        end 
+      end
+      if do_escape_html
+        _ = escape_html(_) # Mandatory since Aug 2011. However, this will break
+                           # when we use <pre> tags. As a compromise, another 
+                           # option exists now.
+      end
+      # ===================================================================== #
+      # Scan for a regex to use. Must come after escape_html() as we insert 
+      # colour specific things into it.
+      # ===================================================================== #
+      if use_a_regex_or_a_filter # This variable is determined internally.
+        use_a_regex_or_a_filter = use_a_regex_or_a_filter.to_s.downcase # We downcase since Dec 2011. This is easier.
+        case use_a_regex_or_a_filter # case tag
+        when 'colourize_in_ruby'
+          _ = colourize_ruby_code(_)
+        when 'replace_hyphen_with_li'
+          # _ = _.split("\n").map {|entry| entry << '<br>'+N }.join(N)
+          _.gsub!(/- /,'<li style="color:black"> ')
+        when 'use_regex1' # This is the default, first Regex. Added Sep 2011.
+          regex = /^(\w+ ?\w*?\??):/ # Define the regex here.
+          _.gsub!(regex, sg(:pfeil1,'marr4px')+'<span class="FI crimson BO">\1:</span>')
+        when 'replace_urls'
+          _.gsub!(/^(http.*)$/,'<a href="\\1">\\1</a>')
+        end
+      end
+      # ===================================================================== #
+      # === Handle Hash
+      #
+      # Next, the user may pass a hash as third argument, which might
+      # include a key called show_title. Or the user may pass in a
+      # Symbol such as :colourize_ruby_code.
+      # ===================================================================== #
+      if optional_id.is_a? Hash
+        if optional_id.has_key? :show_title
+          h4('File: <span class="ud">'+this_file.to_s+'</span>'+
+            sg(:blue_head,'marl1em'),
+            'orangered smaller mart2px marb2px')
+          optional_id = ''
+        end
+      elsif optional_id.is_a? Symbol
+        case optional_id
+        when :colourize_ruby_code
+          _ = colourize_ruby_code(_)
+          optional_id = '' # And reset it again in this case.
+        end
+      end
+      # ===================================================================== #
+      # === Display the result finally
+      #
+      # Use a <pre> tag to display that content.
+      # ===================================================================== #
+      unless File.zero?(original_file) # unless it is empty.
+        pre(
+          _, css_to_use, optional_id, optional_css_style
+        )
+      end
+    else
+      warn 'WARNING - can not display the file `'+this_file+
+           '` as it does not exist in the directory `'+Dir.pwd+'`!'
+    end
+    cfieldset unless web_object.enable_title_for_reading_files.empty?
+  end; alias display      read_and_display # === display (display tag)
+       alias read_display read_and_display # === read_display
+
+  # ========================================================================= #
+  # === Cyberweb.embed_links_file
+  #
+  # This method can be used to embed the LINKS.md file - or alternatively,
+  # whatever you supply to this method as input.
+  #
+  # The first argument to this method should be a local file - and that
+  # file should exist.
+  # ========================================================================= #
+  def self.embed_links_file(
+      i = 'LINKS.md'
+    )
+    if File.exist? i
+      dataset = File.read(
+        i, encoding: DEFAULT_PROJECT_ENCODING[:encoding]
+      )
+      dataset = dataset.split(N)
+      dataset.select! {|entry| entry.start_with? 'http' }
+      dataset.each {|this_link|
+        abr(this_link, content: 'SELF', css_class: 'marl1em')
+      }
+    else
+      warn 'No file called '+i+' exists, thus we can not display anything.'
+    end
+  end; self.instance_eval { alias embed_links embed_links_file } # === Cyberweb.embed_links
+
+  # ========================================================================= #
+  # === embed_links_file
+  # ========================================================================= #
+  def embed_links_file(
+      i = 'LINKS.md'
+    )
+    ::Cyberweb.embed_links_file(i)
+  end; alias embed_links embed_links_file # === embed_links
+
+  # ========================================================================= #
+  # === read_and_display_file_if_it_exists
+  #
+  # A slight modification of read_and_display.
+  #
+  # Note that we should pass the absolute path to the file in question
+  # as the first input argument.
+  # ========================================================================= #
+  def read_and_display_file_if_it_exists(
+      i,
+      css_to_use       = 'pad0_5em',
+      css_style_to_use = 'border: 3px dotted slateblue',
+      &block
+    )
+    the_file_exists = false
+    the_file_exists = File.exist?(i)
+    if the_file_exists
+      read_and_display(
+        i,
+        css_to_use,
+        '',
+        css_style_to_use,
+        &block
+      )
+    else
+      e 'Warning from the method <b class="FI">'+__method__.to_s+'</b>: '\
+        'The file `<b>'+i.to_s+'</b>` was not found.'
+    end
+  end; alias show_file                   read_and_display_file_if_it_exists # === show_file
+       alias display_file                read_and_display_file_if_it_exists # === display_file
+       alias show_this_file              read_and_display_file_if_it_exists # === show_this_file
+       alias read_content_from_this_file read_and_display_file_if_it_exists # === read_content_from_this_file
+       alias display_this_file           read_and_display_file_if_it_exists # === display_this_file
+       alias read_and_display_this_file  read_and_display_file_if_it_exists # === read_and_display_this_file
+       alias embed_this_file             read_and_display_file_if_it_exists # === embed_this_file
+
+  begin
+    require 'beautiful_url/toplevel_methods/local_menu.rb'
+  rescue LoadError; end
+  # ========================================================================= #
+  # === Cyberweb.read_file
+  #
+  # To test this method, try something like:
+  #
+  #   x = Cyberweb.read_file('/home/x/programming/ruby/src/libui/README.md')
+  #   x = Cyberweb.read_file(:tales)
+  #
+  # ========================================================================= #
+  def self.read_file(
+      this_file
+    )
+    if this_file.is_a? Symbol
+      this_file = BeautifulUrl.local_menu(this_file)
+    end
+    if File.exist? this_file
+      use_this_encoding = DEFAULT_PROJECT_ENCODING[:encoding]
+      return File.read(
+        this_file, 
+        encoding: use_this_encoding
+      )
+    else
+      puts 'No file exists at '+this_file.to_s
+    end
+  end
+
+end

data/lib/cyberweb/toplevel_methods/readlines.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/readlines.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/encoding/encoding.rb'
+
+  # ========================================================================= #
+  # === Cyberweb.readlines
+  #
+  # Preferrentially use this method when you read files, because we
+  # will use the right encoding as we go.
+  # ========================================================================= #
+  def self.readlines(i)
+    File.readlines(
+      i,
+      encoding: ::Cyberweb::Encoding::MAIN_ENCODING_TO_USE
+    )
+  end
+
+  # ========================================================================= #
+  # === readlines
+  # ========================================================================= #
+  def readlines(file)
+    Cyberweb.readlines(file)
+  end
+
+end

data/lib/cyberweb/toplevel_methods/redirect.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/redirect.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === Cyberweb.return_meta_redirect
+  #
+  # You may use this method to meta-redirect html pages.
+  # ========================================================================= #
+  def self.return_meta_redirect(
+      to_this_url
+    )
+    '<meta http-equiv="Refresh" content="1; URL="'+to_this_url.to_s+'">'
+  end
+
+  # ========================================================================= #
+  # === return_meta_redirect
+  #
+  # You may use this to meta-redirect html pages.
+  # ========================================================================= #
+  def return_meta_redirect(to_this_url)
+    Cyberweb.return_meta_redirect(to_this_url)
+  end
+
+end

data/lib/cyberweb/toplevel_methods/registered_ids.rb

@@ -0,0 +1,178 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/registered_ids.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/encoding/encoding.rb'
+
+  # ========================================================================= #
+  # === @array_registered_ids
+  #
+  # Collect all IDs here into this Array. An ID is the tag-identifier that
+  # can be given to HTML elements.
+  # ========================================================================= #
+  @array_registered_ids = []
+
+  # ========================================================================= #
+  # === Cyberweb.all_ids?
+  # ========================================================================= #
+  def self.all_ids?
+    @array_registered_ids
+  end; self.instance_eval { alias array_registered_ids  all_ids? } # === Cyberweb.array_registered_ids
+       self.instance_eval { alias array_registered_ids? all_ids? } # === Cyberweb.array_registered_ids?
+
+  # ========================================================================= #
+  # === return_the_id
+  # ========================================================================= #
+  def return_the_id(
+      the_id = ''
+    )
+    ::Cyberweb.return_the_id(the_id)
+  end; alias turn_into_html_id return_the_id # === turn_into_html_id
+
+  # ========================================================================= #
+  # === all_ids?
+  #
+  # Preferrably use this method when you wish to show all ids.
+  # ========================================================================= #
+  def all_ids?
+    ::Cyberweb.all_ids?
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.show_all_ids?
+  # ========================================================================= #
+  def self.show_all_ids?
+    all_ids?.each {|entry|
+      e " - #{entry}"
+    }
+  end
+
+  # ========================================================================= #
+  # === show_all_ids?
+  # ========================================================================= #
+  def show_all_ids?
+    ::Cyberweb.show_all_ids?
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.return_the_id                                       (id tag)
+  #
+  # Returns an empty string if the_id is empty.
+  #
+  # Since Sep 2011 we also remove all html tags from the input.
+  #
+  # Since Jan 2012 we also get rid of all ' ' characters - these would
+  # be invalid anyway.
+  # ========================================================================= #
+  def self.return_the_id(
+      the_id = ''
+    )
+    the_id = the_id.to_s.dup # We need it in string format.
+    result = ''.dup
+    if the_id.is_a? Hash
+      if the_id.has_key? :id
+        the_id = the_id.delete(:id)
+      end
+    end
+    unless the_id.empty?
+      the_id = sanitize_id(the_id)
+      append_this_id_to_all_ids(the_id)
+      result << ' id="'
+      result << the_id # Perform no more modification to the ID here.
+      result << '"'
+    end
+    return result 
+  end; self.instance_eval { alias turn_into_html_id return_the_id } # === Cyberweb.turn_into_html_id
+
+  # ========================================================================= #
+  # === Cyberweb.append_this_id_to_all_ids
+  #
+  # This method will register the ID into the instance variable
+  # returned by Cyberweb.array_registered_ids?
+  # ========================================================================= #
+  def self.append_this_id_to_all_ids(i)
+    i = i.to_s
+    unless i.empty?
+      # ===================================================================== #
+      # Enable drag support next. The key phrase to enable drag and drop
+      # support is to have an ID that starts either with 'drag_' or
+      # via 'enable_drag_'.
+      # ===================================================================== #
+      if i.start_with?('drag_') or
+         i.start_with?('enable_drag_')
+        # =================================================================== #
+        # We also have to check if the web_object has been initialized.
+        # =================================================================== #
+        if ::Cyberweb.respond_to?(:web_object?) and ::Cyberweb.web_object?
+          ::Cyberweb.web_object?.drag(i)
+        end 
+      end
+      ::Cyberweb.array_registered_ids? << i # We only append when the ID in question exists.
+    end
+  end; self.instance_eval { alias register_this_id append_this_id_to_all_ids } # === Cyberweb.register_this_id
+
+  # ========================================================================= #
+  # === append_this_id_to_all_ids
+  # ========================================================================= #
+  def append_this_id_to_all_ids
+    ::Cyberweb.append_this_id_to_all_ids
+  end; alias register_this_id append_this_id_to_all_ids # === register_this_id
+
+  # ========================================================================= #
+  # === print_the_id
+  #
+  # Prints a html id.
+  # ========================================================================= #
+  def print_the_id(the_id)
+    ee return_the_id(the_id)
+  end
+
+  require 'cyberweb/toplevel_methods/umlaute.rb'
+  # ========================================================================= #
+  # === Cyberweb.sanitize_id
+  #
+  # Use this method when you want to sanitize the given id.
+  #
+  # We will generate a valid HTML id through this method.
+  #
+  # Usage example:
+  #
+  #    Cyberweb.sanitize_id(' hey there')
+  #
+  # ========================================================================= #
+  def self.sanitize_id(i)
+    i = convert_back_german_umlauts(i)
+    # ======================================================================= #
+    # If we have two '#' tokens, check here:
+    # ======================================================================= #
+    if i.count('#') > 1 # Example: 'drag_#NAME#'
+      if i.include? '#NAME#'
+        filename = ::Cyberweb.filename?
+        new_name = File.basename(filename, File.extname(filename)).downcase
+        i = i.gsub(/#NAME#/, new_name)
+      end
+    end
+    i.strip! # Get rid of leading and trailing ' ' tokens.
+    i.gsub!(/ /,'_') if i.include? ' '
+    case i
+    when 'DEF' # Overrule.
+      filename = $0
+      filename = ensure_main_encoding(filename)
+      i = File.basename(filename).downcase.gsub(/\..*$/,'')
+    end
+    i = no_html(i) if i.include? '>' # We assume a HTML tag here.
+    return i
+  end
+
+  # ========================================================================= #
+  # === sanitize_id
+  # ========================================================================= #
+  def sanitize_id(i)
+    ::Cyberweb.sanitize_id(i)
+  end
+
+end

data/lib/cyberweb/toplevel_methods/remove_html.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/remove_html.rb'
+# Cyberweb.remove_html(ARGV)
+# =========================================================================== #
+module Cyberweb
+
+  begin
+    require 'roebe/modules/remove_html.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === Cyberweb.remove_html
+  #
+  # This method will attempt to get rid of all html found in a String.
+  # ========================================================================= #
+  def self.remove_html(i)
+    if Object.const_defined?(:Roebe) and
+       Roebe.respond_to?(:remove_html)
+      return Roebe.remove_html(i)
+    else
+      i # Else return it unmodified.
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Cyberweb.remove_html(ARGV)
+end # rb remove_html.rb 'string with <h2>some</h2> html here'

data/lib/cyberweb/toplevel_methods/remove_newlines.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/remove_newlines.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === Cyberweb.remove_newlines
+  #
+  # This simple method will get rid of newlines from the given input
+  # String. The argument to this method should hence be a String. 
+  # ========================================================================= #
+  def self.remove_newlines(i = '')
+    i.delete("\n")
+  end; self.instance_eval { alias remove_newline       remove_newlines } # === Cyberweb.remove_newline
+       self.instance_eval { alias remove_newlines_from remove_newlines } # === Cyberweb.remove_newlines_from
+
+  # ========================================================================= #
+  # === remove_newlines
+  # ========================================================================= #
+  def remove_newlines(i = '')
+    ::Cyberweb.remove_newlines(i)
+  end; alias remove_newline       remove_newlines # === remove_newline
+       alias remove_newlines_from remove_newlines # === remove_newlines_from
+
+end

data/lib/cyberweb/toplevel_methods/return_head_start.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/return_head_start.rb'
+# =========================================================================== #
+module Cyberweb
+
+  begin
+    require 'html_tags/individual_tags/head.rb'
+  rescue LoadError; end
+
+  require 'cyberweb/constants/nl.rb'
+
+  # ========================================================================= #
+  # === Cyberweb.return_head_start
+  #
+  # We will also append a newline to it.
+  #
+  # Thus, this method will essentially return this String:
+  #
+  #   "<head>\n"
+  #
+  # ========================================================================= #
+  def self.return_head_start
+    "#{HtmlTags.head}#{N}" # Delegate towards HtmlTags.
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Cyberweb.return_head_start
+end

data/lib/cyberweb/toplevel_methods/return_html_fin.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/return_html_fin.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'html_tags'
+  require 'cyberweb/constants/standalone_constants.rb'
+
+  # ========================================================================= #
+  # === Cyberweb.return_html_fin
+  #
+  # This method combines '</body>' and '</html>'.
+  # ========================================================================= #
+  def self.return_html_fin
+    "#{HtmlTags.cbody}#{NL}#{HtmlTags.chtml}#{NL}"
+  end
+
+  # ========================================================================= #
+  # === return_html_fin
+  #
+  # Use this to close the HTML document properly.
+  # ========================================================================= #
+  def return_html_fin
+    ::Cyberweb.return_html_fin # Invoke the method defined on top.
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Cyberweb.return_html_fin
+end

data/lib/cyberweb/toplevel_methods/return_html_header.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/return_html_header.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/constants/nl.rb'
+  require 'cyberweb/constants/standalone_constants.rb'
+
+  # ========================================================================= #
+  # === return_html_header
+  # ========================================================================= #
+  def self.return_html_header
+    ::Cyberweb::CONTENT_TYPE_HTML
+  end
+
+  # ========================================================================= #
+  # === return_html_header
+  # ========================================================================= #
+  def return_html_header
+    ::Cyberweb.return_html_header
+  end
+
+  # ========================================================================= #
+  # === print_html_header
+  #
+  # This prints our html header.
+  # ========================================================================= #
+  def print_html_header
+    ee return_html_header
+  end
+
+end