cyberweb 0.4.174

data/lib/cyberweb/colours/colour_chart.rb

@@ -0,0 +1,117 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Require the html_colours, as the method all_colours() needs it.
+# =========================================================================== #
+# require 'cyberweb/colours/colour_chart.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/html_tags/span.rb'
+
+  # ========================================================================= #
+  # === Cyberweb.colour_chart         (colour code chart, ct tag, cs tag .cs,
+  #                                    colour tag, col tag color tag)
+  #
+  # This method will show a colour chart.
+  #
+  # Use it like so like:
+  #
+  #   ct
+  #   colour_table
+  #
+  # or better yet, combined with a div tag:
+  #
+  #   div('pad12px mar2px'); ct; cdiv
+  #
+  # If you wish to limit the amount of colours to be shown, do this here:
+  #
+  #   colour_table show: 20
+  #
+  # ========================================================================= #  
+  def self.colour_chart(
+      background_colour = '000000'
+    )
+    result = ''.dup
+    use_div = false
+    use_this_css_style = ''
+    the_colours = Colours.html_colours # Obtain all colours.
+    # ======================================================================= #
+    # Next check in the event that the user gave us a Hash.
+    # ======================================================================= #
+    if background_colour.is_a? Hash
+      if background_colour.has_key? :css_style
+        use_div = true
+        use_this_css_style = background_colour.delete :css_style
+      end
+      if background_colour.has_key? :show # This one must come after the above.
+        the_colours = the_colours.sample(background_colour.delete(:show).to_i)
+        background_colour = '000000'
+      end
+    end
+    if use_div
+      result << string_div('','',use_this_css_style)
+    end
+    the_colours.each {|key|
+      result << string_ebr(key, background_colour,'','color:'+key)
+    }
+    result << string_cdiv if use_div
+    return result
+  end; self.instance_eval { alias colour_table colour_chart } # === Cyberweb.colour_table
+       self.instance_eval { alias ct           colour_chart } # === Cyberweb.ct
+
+  # ========================================================================= #
+  # === Cyberweb.show_html_colour_chart
+  #
+  # Take note that this method is significantly more sophisticated than
+  # the older method called Cyberweb.colour_chart; it also has a slightly
+  # different use case. The method here is ready-for-use, that is,
+  # for display in a webpage.
+  # ========================================================================= #
+  def self.show_html_colour_chart(
+      use_this_css_style = 'margin-left: 2.5em; margin-right: 2.5em;'\
+                           'padding-left: 1.5em; padding-right: 1.5em',
+      width_of_the_box   = '75px',
+      height_of_the_box  = '35px'
+    )
+    p('','',use_this_css_style){
+      ee '<table style="margin-left: 0.75em; margin-right: 0.75em;">'
+      Colours.html_colours.each {|this_html_colour|
+        ee '<tr>'
+        ee '<td>'
+        ee '<div class="marl2em bblack1 pad4px mar2px" style="width:'+
+           width_of_the_box+'; height:'+height_of_the_box+'; background-color: '+this_html_colour+'">'
+        ee '</div>'
+        ee '</td>'
+        ee '<td>'
+        ee '<b>'+this_html_colour+'</b>'
+        ee '</td>'
+        ee '<td><b>Hex value</b>: <b>'
+        ee Colours.html_colour_to_hex_value(this_html_colour)
+        ee '</b></td>'
+        ee '<td>'
+        # ===================================================================== #
+        # Next we will also show the RGB value.
+        # ===================================================================== #
+        ee '<b>RGB value</b>: <b>'+
+           Colours.html_colour_to_rgb_value(this_html_colour).
+           tr(';',',')+'
+           </b>'
+        ee '</td>'
+        ee '</tr>'
+        ee "\n"
+      }
+      c :table
+    }
+  end
+
+  # ========================================================================= #
+  # === colour_chart
+  # ========================================================================= #
+  def colour_chart(i)
+    ::Cyberweb.colour_chart(i)
+  end; alias colour_table colour_chart # === colour_table
+       alias ct           colour_chart # === ct
+
+end

data/lib/cyberweb/colours/colours.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Require the html_colours, as the method all_colours() needs it.
+# =========================================================================== #
+# require 'cyberweb/colours/colours.rb'
+# =========================================================================== #
+module Cyberweb
+
+  begin
+    require 'colours'
+  rescue LoadError; end
+
+  require 'cyberweb/colours/colour_chart.rb'
+  require 'cyberweb/colours/random_colour.rb'
+
+  # ========================================================================= #
+  # === Cyberweb.show_all_colours
+  #
+  # This will print a HTML colour table.
+  #
+  # Usage example:
+  #
+  #   Cyberweb.show_all_colours(:super_colourize)
+  #
+  # ========================================================================= #
+  def self.show_all_colours(
+      also_display_them_in_colours = false
+    )
+    if also_display_them_in_colours == :super_colourize
+      also_display_them_in_colours = true
+    end
+    if also_display_them_in_colours
+      all_colours.each { |colour| e colour,'','','color:'+colour }
+    else
+      all_colours.each { |colour| e colour }
+    end
+  end; self.instance_eval { alias colours? show_all_colours } # === Cyberweb.colours?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'colours/colours_e_autoinclude.rb'
+  pp Cyberweb.all_colours
+  e
+  Cyberweb.show_all_colours
+  e
+  e Cyberweb.return_random_colour
+end

data/lib/cyberweb/colours/random_colour.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/colours/random_colour.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === Cyberweb.all_colours
+  #
+  # This will return all available colours. We make use of project
+  # HtmlColours for this.
+  # ========================================================================= #
+  def self.all_colours
+    Colours.html_colours
+  end; self.instance_eval { alias all_html_colours all_colours } # === Cyberweb.all_html_colours
+
+  # ========================================================================= #
+  # === Cyberweb.return_random_colour
+  #
+  # This method will return a String such as "mediumslateblue".
+  # ========================================================================= #
+  def self.return_random_colour
+    all_colours.sample
+  end; self.instance_eval { alias random_colour? return_random_colour } # === Cyberweb.random_colour?
+
+end

data/lib/cyberweb/colours/sanitize_for_colours.rb

@@ -0,0 +1,95 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/colours/sanitize_for_colours.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/constants/standalone_constants.rb'
+  require 'cyberweb/colours/random_colour.rb'
+  # ========================================================================= #
+  # === Cyberweb.sanitize_for_colours
+  #
+  # This method can be used to scan a string for the keyword RAND or
+  # other similar keywords. If such a keyword is found, it will be
+  # replaced with the proper colour(s). RANDOM_COLOUR would thus
+  # become a real, random colour.
+  #
+  # This method here is called from return_css_style().
+  #
+  # It will also check for the keyword BACKGROUND.
+  # ========================================================================= #
+  def self.sanitize_for_colours(
+      i = ''
+    )
+    i = i.to_s.dup # Dup so that we don't work on a frozen string.
+    # ======================================================================= #
+    # === RANDOM_COLOUR
+    # ======================================================================= #
+    if i.include? 'RANDOM_COLOUR'
+      i.gsub!(/RANDOM_COLOUR/, return_random_colour)
+    end
+    # ======================================================================= #
+    # Handle macro entries for BACKGROUND next:
+    #   background: url(images/menu7.gif)
+    #   BACKGROUND: BG_COLOURBAR_LIGHT.jpg
+    # ======================================================================= #
+    if i.include? 'BACKGROUND'
+      i.gsub!(/BACKGROUND: (\w+\.\w+)/, 
+        'background: url(../../../../../IMG/WALLPAPERS/\1); 
+         background-repeat: no-repeat;')
+    end
+    i.gsub!(/RBORDER1/,  return_random_border ) if i.include? 'RBORDER1'
+    i.gsub!(/RBORDER/,   return_random_border ) if i.include? 'RBORDER1'
+    # ======================================================================= #
+    # If the following input includes at least the substring 'RCOL'.
+    # ======================================================================= #
+    if i.include? 'RCOL'
+      i.gsub!(/RCOLOUR/, return_random_colour )
+      i.gsub!(/RCOL/,    return_random_colour )
+    end
+    # ======================================================================= #
+    # Cut off UPCASED PX. From this point no PX is possible within
+    # the string. This may fail for images that have PX as part of
+    # their name though, hence why this check is a bit more complicated.
+    # ======================================================================= #
+    if i.include? 'PX'
+      unless i.include?('.png') or i.include?('.jpg')
+        i.gsub!(/PX/,'')
+      end
+    end
+    if i.include? 'RAND'
+      i.gsub!(/RANDOM/,'RAND') # exchange RANDOM with RAND
+      i.gsub!(/BORDER_RAND/,'RAND_BORDER') # want proper names
+      i.gsub!(/RAND/,         return_random_colour )
+      # ======================================================================= #
+      # From this point forward, we invoke the method return_random_colour()
+      # RAND_BORDER_1 means "create a random border here" with 1 px
+      # ======================================================================= #
+      i.gsub!(/RAND_BORDER_(.+)/,    return_random_border('\\1') )
+      # ======================================================================= #
+      # Create: border-left: 1 px RANDOM_COLOUR
+      # ======================================================================= #
+      i.gsub!(/BORD_LEFT_RAND_(.+)/, return_random_border('\\1') )
+      i.gsub!(/RAND_BORD_(.+)/,      return_random_border('\\1') )
+      i.gsub!(/RAND_COLOUR/,         return_random_colour )
+    elsif i.include? 'BORD'
+      # ======================================================================= #
+      # As above but with shorter BORD_ notation.
+      # ======================================================================= #
+      i.gsub!(/BORD_(.+)PX/,
+        'border: \\1px '+ARRAY_CSS_BORDER_STYLES.sample(1).first+
+        ' '+return_random_colour+';')
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === sanitize_for_colours
+  # ========================================================================= #
+  def sanitize_for_colours(i = '')
+    ::Cyberweb.sanitize_for_colours(i)
+  end
+
+end

data/lib/cyberweb/commandline/commandline_interface.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Code in this file here provides a commandline-interface to the 
+# bin/cyberweb file.
+# =========================================================================== #
+# require 'cyberweb/commandline/commandline_interface.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/utility_scripts/download_balloon_css.rb'
+  require 'cyberweb/toplevel_methods/edit_configuration_file.rb'
+
+  # ========================================================================= #
+  # === Cyberweb.menu                                              (menu tag)
+  # ========================================================================= #
+  def self.menu(i)
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i
+      # ===================================================================== #
+      # === cyberweb --systemsettings
+      # ===================================================================== #
+      when /^-?-?systemsettings$/
+         require 'roebe/classes/generate_system_values.rb'
+         Roebe::GenerateSystemValues.new
+        exit
+      # ===================================================================== #
+      # === cyberweb --edit
+      # ===================================================================== #
+      when 'EDIT',/^-?-?edit/,'ed','bearbeite','e' # Allow user the edit the configuration file.
+        ::Cyberweb.edit_configuration_file # Invoke this via: 'cyberweb edit'
+        exit
+      # ===================================================================== #
+      # === cyberweb --download-balloon
+      # ===================================================================== #
+      when /^-?-?download(-|_)?balloon$/
+        ::Cyberweb::DownloadBalloonCss.new
+      end
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Cyberweb.menu(ARGV)
+end

data/lib/cyberweb/configuration/configuration.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Note that this is the base-code for configuration-related parts of the
+# Cyberweb project. In other words - it has no requires.
+# =========================================================================== #
+# require 'cyberweb/configuration/configuration.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === @configuration
+  #
+  # This constant keeps a copy to the @config object.
+  # It should be a Hash.
+  #
+  # The file configuration.rb will load it with the proper data.
+  # ========================================================================= #
+  @configuration = {} # Cyberweb.config?
+
+  # ========================================================================= #
+  # === Cyberweb.set_configuration_object
+  # ========================================================================= #
+  def self.set_configuration_object(i)
+    @configuration = i
+  end; self.instance_eval { alias set_config_object set_configuration_object } # === Cyberweb.set_config_object
+       self.instance_eval { alias set_configuration set_configuration_object } # === Cyberweb.set_configuration
+
+  # ========================================================================= #
+  # === Cyberweb.config?
+  # ========================================================================= #
+  def self.config?
+    @configuration
+  end; self.instance_eval { alias config                config? } # === Cyberweb.config
+       self.instance_eval { alias configuration_object? config? } # === Cyberweb.configuration_object?
+       self.instance_eval { alias config_object?        config? } # === Cyberweb.config_object?
+       self.instance_eval { alias configuration?        config? } # === Cyberweb.configuration?
+
+  # ========================================================================= #
+  # === Cyberweb.use_in_dir_images?
+  # ========================================================================= #
+  def self.use_in_dir_images?
+    @configuration['use_in_dir_images']
+  end
+
+  # ========================================================================= #
+  # === config?
+  #
+  # Query the configuration for Cyberweb to use.
+  # ========================================================================= #
+  def config?
+    Cyberweb.config?
+  end
+
+  # ========================================================================= #
+  # === config_file?
+  #
+  # Wrapper method over Cyberweb.config_file? to determine where the
+  # configuration file exactly is.
+  # ========================================================================= #
+  def config_file?
+    Cyberweb.config_file?
+  end
+
+end

data/lib/cyberweb/configuration/load_the_configuration_file.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Code in this file here will load the .yml file. It depends on the
+# skeleton defined in the file "cyberweb/configuration/configuration.rb".
+# =========================================================================== #
+# require 'cyberweb/configuration/load_the_configuration_file.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'yaml'
+  require 'cyberweb/constants/configuration_file.rb'
+  require 'cyberweb/configuration/configuration.rb'
+  require 'cyberweb/images/path_to_images.rb' # Because we set the path to images here.
+
+  # ========================================================================= #
+  # === Cyberweb.load_the_configuration_file
+  #
+  # This method is used to load the configuration file (and thus
+  # initialize the dataset for the configuration).
+  # ========================================================================= #
+  def self.load_the_configuration_file
+    _ = config_file?
+    if File.exist?(_)
+      # ===================================================================== #
+      # Load up the config dataset:
+      # ===================================================================== #
+      config = YAML.load_file(_)
+      # ===================================================================== #
+      # Next, sanitize 'default_font_size' and 'default_smaller_font_size'.
+      # ===================================================================== #
+      if config.has_key? 'default_font_size'
+        config['default_font_size'] = config['default_font_size'].tr(' ','')
+      end
+      if config.has_key? 'default_smaller_font_size'
+        config['default_smaller_font_size'] = config['default_smaller_font_size'].tr(' ','')
+      end
+      config = config_object?.merge(config)
+      # ===================================================================== #
+      # The above code will ensure that the configuration dataset is loaded
+      # properly into the toplevel variable called @configuration.
+      #
+      # This is then copied by Cyberweb when it gets instantiated.
+      # ===================================================================== #
+      set_configuration_object(config)
+      # ===================================================================== #
+      # Next, we set the image base directory to the given default.
+      # This can be overruled lateron.
+      # ===================================================================== #
+      set_image_base_directory
+      config # And return the data here as well.
+    else
+      puts 'Error from `'+__FILE__+'`: NOT EXISTING CONFIG FILE!'
+      puts 'We did assume this file to exist at the following location:'
+      puts
+      puts '  -> '+_
+      puts
+      puts 'We will thus exit now.'
+      exit
+    end
+  end
+
+  # ========================================================================= #
+  # For now, it is initialized whenever this file here is loaded.
+  # ========================================================================= #
+  load_the_configuration_file
+  
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pp Cyberweb.configuration_object?
+end

data/lib/cyberweb/constants/array_images.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/constants/array_images.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === ARRAY_IMAGES
+  #
+  # 4 image-types are defined in the following constant.
+  # ========================================================================= #
+  ARRAY_IMAGES = %w(
+    png
+    gif
+    jpg
+    jpeg
+  )
+
+end

data/lib/cyberweb/constants/array_local_css_files.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/constants/array_local_css_files.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === Cyberweb::ARRAY_LOCAL_CSS_FILES
+  #
+  # Local .css files can be stored in this constant.
+  #
+  # On my home system these .css files may reside here:
+  #
+  #   /home/x/programming/ruby/src/cyberweb/lib/cyberweb/cascading_style_sheets/colours.css
+  #
+  # ========================================================================= #
+  ARRAY_LOCAL_CSS_FILES = %w(
+    border
+    code
+    colours
+    default
+    div
+    fonts
+    links
+    margin
+    message_boxes
+    misc
+    popup
+    ruby_regexes
+    template2
+  )
+
+end

data/lib/cyberweb/constants/array_predefined_constants.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/array_predefined_constants.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === @array_predefined_constants
+  #
+  # The following array defines which constants are available predefined.
+  # ========================================================================= #
+  @array_predefined_constants = []
+
+  # ========================================================================= #
+  # === Cyberweb.array_predefined_constants?
+  # ========================================================================= #
+  def self.array_predefined_constants?
+    @array_predefined_constants
+  end
+
+end

data/lib/cyberweb/constants/configuration_file.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/constants/configuration_file.rb'
+# Cyberweb.config_file?
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/project/project.rb'
+
+  # ========================================================================= #
+  # ==== Cyberweb.configuration_file?
+  #
+  # This helper method keeps track as to where the main configuration
+  # file for the cyberweb-project resides.
+  #
+  # For this to work, PROJECT_YAML_DIRECTORY must have been defined before,
+  # which is the case when we load the file 'project_yaml_directory.rb'.
+  #
+  # We may do this in this file here - see above.
+  #
+  # Usage example:
+  #
+  #   Cyberweb.config_file?
+  #
+  # ========================================================================= #
+  def self.configuration_file?
+    "#{PROJECT_YAML_DIRECTORY}project_configuration.yml"
+  end; self.instance_eval { alias config_file?                  configuration_file? } # === Cyberweb.config_file?
+       self.instance_eval { alias file_web_object_configuration configuration_file? } # === Cyberweb.file_web_object_configuration
+
+end

data/lib/cyberweb/constants/constants.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/constants/constants.rb'
+# =========================================================================== #
+require 'cyberweb/requires/require_the_constants.rb'
+
+Cyberweb.require_the_constants

data/lib/cyberweb/constants/file_constants.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/constants/file_constants.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/project/project.rb'
+
+  # ========================================================================= #
+  # === FILE_WEB_IMAGES
+  # ========================================================================= #
+  FILE_WEB_IMAGES = "#{yaml_directory?}web_images.yml"
+
+end

data/lib/cyberweb/constants/http_status_codes.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/constants/http_status_codes.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === HTTP_STATUS_CODES
+  #
+  # HTTP status codes are defined here. OK (200) and Not Found (404) are
+  # probably the two most common status codes here.
+  #
+  # They can be used through this hash here such as:
+  #
+  #   HTTP_STATUS['OK'] # gives '200 OK'.
+  #
+  # ========================================================================= #
+  HTTP_STATUS_CODES = {
+    'OK'                  => '200 OK',
+    'PARTIAL_CONTENT'     => '206 Partial Content',
+    'MULTIPLE_CHOICES'    => '300 Multiple Choices',
+    'MOVED'               => '301 Moved Permanently',
+    'REDIRECT'            => '302 Found',
+    'NOT_MODIFIED'        => '304 Not Modified',
+    'BAD_REQUEST'         => '400 Bad Request',
+    'AUTH_REQUIRED'       => '401 Authorization Required',
+    'FORBIDDEN'           => '403 Forbidden',
+    'NOT_FOUND'           => '404 Not Found',
+    'METHOD_NOT_ALLOWED'  => '405 Method Not Allowed',
+    'NOT_ACCEPTABLE'      => '406 Not Acceptable',
+    'LENGTH_REQUIRED'     => '411 Length Required',
+    'PRECONDITION_FAILED' => '412 Precondition Failed',
+    'SERVER_ERROR'        => '500 Internal Server Error',
+    'NOT_IMPLEMENTED'     => '501 Method Not Implemented',
+    'BAD_GATEWAY'         => '502 Bad Gateway',
+    'VARIANT_ALSO_VARIES' => '506 Variant Also Negotiates'
+  }
+  HTTP_STATUS = HTTP_STATUS_CODES # === HTTP_STATUS
+
+end