cyberweb 0.4.174

data/lib/cyberweb/predefined_and_freeform_methods/hash_css_class_to_use.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Cyberweb
+
+module PredefinedMethods # === Cyberweb::PredefinedMethods
+
+  # ========================================================================= #
+  # === @hash_css_class_to_use
+  #
+  # The following Hash will be used to "style" the various components 
+  # herein.
+  # ========================================================================= #
+  @hash_css_class_to_use = {}
+  # ========================================================================= #
+  # The Hash will have several pre-defined keys. These keys should be 
+  # "interpreted" as CSS style guides. So, for example, all questions
+  # will be in gold colour; all answers will be in cyan colour and
+  # will also have 'margin-left: 1em.'
+  # ========================================================================= #
+  @hash_css_class_to_use[:question] = 'gold'              # For questions
+  @hash_css_class_to_use[:answer]   = 'marl1em cyan'      # For answers
+  @hash_css_class_to_use[:command1] = 'marl1em BOLD'      # For command1
+  @hash_css_class_to_use[:command2] = 'marl2em BOLD'      # For command2
+  @hash_css_class_to_use[:command3] = 'marl3em BOLD'      # For command3
+  @hash_css_class_to_use[:command4] = 'marl4em BOLD'      # For command4
+  @hash_css_class_to_use[:col_cmd]  = 'slateblue marl1em'
+  H = @hash_css_class_to_use # Easier constant "alias" to this hash.
+  # ========================================================================= #
+  # To overrule the above hash in your project, you could do this:
+  # ========================================================================= #
+  #     H[:command1] = 'marl5em cyan'
+  #     H[:command2] = 'marl10em cyan'
+  #     H[:command3] = 'marl15em cyan'
+  #     H[:command4] = CMD
+  #
+  # Alternatively, you can also use Cmd2.append instead.
+
+  # ========================================================================= #
+  # === Cyberweb::PredefinedMethods.css_class_to_use?
+  # ========================================================================= #
+  def self.css_class_to_use?
+    @hash_css_class_to_use
+  end; self.instance_eval { alias css_class_to_use       css_class_to_use? } # === Cyberweb::PredefinedMethods.css_class_to_use
+       self.instance_eval { alias hash_css_class_to_use? css_class_to_use? } # === Cyberweb::PredefinedMethods.hash_css_class_to_use?
+
+  # ========================================================================= #
+  # === Cyberweb.cmd1?
+  # ========================================================================= #
+  def self.cmd1?
+    @hash_css_class_to_use[:command1]
+  end
+
+end; end

data/lib/cyberweb/predefined_and_freeform_methods/hash_registered_extra_tags.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/predefined_and_freeform_methods/hash_registered_extra_tags.rb'
+# =========================================================================== #
+module Cyberweb
+
+module PredefinedMethods # === Cyberweb::PredefinedMethods
+
+  # ========================================================================= #
+  # === @hash_registered_extra_tags
+  #
+  # The following Hash is used to register some predefined tags.
+  #
+  # This is used only for ruby and php so far.
+  # ========================================================================= #
+  @hash_registered_extra_tags = {}
+  @hash_registered_extra_tags[:ruby] = 'BO crimson FS1_2em'
+  @hash_registered_extra_tags[:php]  = 'BO blue'
+
+  # ========================================================================= #
+  # === Cyberweb::PredefinedMethods.hash_registered_extra_tags?
+  # ========================================================================= #
+  def self.hash_registered_extra_tags?
+    @hash_registered_extra_tags
+  end
+
+end; end

data/lib/cyberweb/predefined_and_freeform_methods/header.rb

@@ -0,0 +1,81 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/predefined_and_freeform_methods/header.rb'
+# =========================================================================== #
+module Cyberweb
+
+module PredefinedMethods
+
+class Header # === Cyberweb::PredefinedMethods::Header
+
+  # ========================================================================= #
+  # === DEFAULT_SIZE_FOR_HEADER
+  # ========================================================================= #
+  DEFAULT_SIZE_FOR_HEADER = :h1
+
+  # ========================================================================= #
+  # === @size
+  # ========================================================================= #
+  @size = DEFAULT_SIZE_FOR_HEADER
+
+  # ========================================================================= #
+  # === Cyberweb::Header.size?
+  # ========================================================================= #
+  def self.size?
+    @size
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::Header.clear
+  # ========================================================================= #
+  def self.clear
+    Header.size = DEFAULT_SIZE_FOR_HEADER
+  end; self.instance_eval { alias reset clear } # === Header.reset
+
+  # ========================================================================= #
+  # === Cyberweb::Header.run
+  # ========================================================================= #
+  def self.run(i)
+    send @size, i.to_s # Invoke .send(@size) here.
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::Header.size=
+  #
+  # Usage example:
+  #
+  #   Header.size = 'h2'
+  #
+  # ========================================================================= #
+  def self.size=(i = 1)
+    case i # Easier to work on Integers.
+    when 0, 1, 'h1'
+      i = :h1
+    when 2, 'h2'
+      i = :h2
+    when 3, 'h3'
+      i = :h3
+    when 4, 'h4'
+      i = :h4
+    when 5, 'h5'
+      i = :h5
+    when 6, 'h6'
+      i = :h6
+    end
+    @size = i
+  end
+
+end
+
+# =========================================================================== #
+# === header
+#
+# This will make a header. Currently this is done via a call to h1().
+# =========================================================================== #
+def header(i = '')
+  Header.run(i)
+end
+
+end; end

data/lib/cyberweb/predefined_and_freeform_methods/predefined_methods.rb

@@ -0,0 +1,413 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb::PredefinedMethods
+#
+# The code residing here can be called via the method
+# enable_predefined_methods(), or the alias maddons().
+# =========================================================================== #
+# require 'cyberweb/predefined/predefined_methods.rb'
+# Cyberweb::PredefinedMethods.command2?
+# =========================================================================== #
+module Cyberweb
+
+module PredefinedMethods # === Cyberweb::PredefinedMethods
+
+  require 'cyberweb/predefined_and_freeform_methods/header.rb'
+  require 'cyberweb/predefined_and_freeform_methods/hash_css_class_to_use.rb'
+  require 'cyberweb/predefined_and_freeform_methods/hash_registered_extra_tags.rb'
+  require 'cyberweb/predefined_and_freeform_methods/frage.rb' # bl $RUBY_CYBERWEB/predefined/frage.rb
+  require 'cyberweb/classes/simple_form.rb'
+
+  # ========================================================================= #
+  # Set the default once.
+  # ========================================================================= #
+  Cyberweb::PredefinedMethods.set_frage_css
+
+  # ========================================================================= #
+  # === ARRAY_FRAGEN
+  #
+  # Unsure whether this is required.
+  # ========================================================================= #
+  ARRAY_FRAGEN = []
+
+  # ========================================================================= #
+  # === Cyberweb::PredefinedMethods.cmd=
+  #
+  # Modify the Hash that stores which css classes we shall use.
+  # ========================================================================= #
+  def self.cmd=(i)
+    hash_css_class_to_use?[:command1] = i
+  end
+
+  # ========================================================================= #
+  # === answer
+  # ========================================================================= #
+  def answer(this_question)
+    e this_question,
+      ::Cyberweb::PredefinedMethods.css_class_to_use?[:answer]
+  end; alias antwort answer # === antwort
+
+  # ========================================================================= #
+  # === addon_header
+  # ========================================================================= #
+  def addon_header(
+      i                  = '',
+      optional_css_class = '',
+      optional_id        = '',
+      optional_css_style = ''
+    )
+    h1 i, optional_css_class, optional_id, optional_css_style
+  end
+
+  # ========================================================================= #
+  # === col_cmd
+  # ========================================================================= #
+  def col_cmd(
+      i = '', optional_id = ''
+    )
+    ee(
+      i, ::Cyberweb::PredefinedMethods.css_class_to_use?[:col_cmd], optional_id
+    )
+  end; alias col col_cmd # === col
+
+  # ========================================================================= #
+  # === frage                                                     (frage tag)
+  #
+  # Whenever we use this method, we will also store in the constant
+  # ARRAY_FRAGEN.
+  #
+  # Note that "frage" is german for "question", hence the alias below.
+  #
+  # Usage example for this method here:
+  #
+  #   frage 'What is this?'
+  #
+  # ========================================================================= #
+  def frage(
+      i,
+      optional_css = Frage.to_s,
+      use_dot      = true
+    )
+    ARRAY_FRAGEN << i
+    result = ''.dup
+    result << dot(101) if use_dot
+    result << i
+    h2(result, optional_css) # Or H[:question].
+  end; alias question frage # === question
+
+  # ========================================================================= #
+  # === Cmd
+  # ========================================================================= #
+  class Cmd
+
+    # ======================================================================= #
+    # === Cmd.append
+    #
+    # This method can be used to append to the H[:command1] hash.
+    #
+    # The ' ' will be mandatory for now.
+    # ======================================================================= #
+    def self.append(i)
+      if ::Cyberweb::PredefinedMethods.css_class_to_use?[:command1].frozen?
+        ::Cyberweb::PredefinedMethods.css_class_to_use?[:command1] =
+          ::Cyberweb::PredefinedMethods.css_class_to_use?[:command1].dup
+      end
+      ::Cyberweb::PredefinedMethods.css_class_to_use?[:command1] << " #{i}"
+    end; self.instance_eval { alias append_this_css append } # === Cmd.append_this_css
+
+  end
+
+  # ========================================================================= #
+  # === Cmd2
+  # ========================================================================= #
+  class Cmd2
+
+    # ======================================================================= #
+    # === Cmd2.append
+    #
+    # This method can be used to append to the H[:command2] hash.
+    #
+    # The ' ' will be mandatory for now.
+    # ======================================================================= #
+    def self.append(i)
+      ::Cyberweb::PredefinedMethods.css_class_to_use?[:command2] << " #{i}"
+    end; self.instance_eval { alias append_this_css append } # === Cmd2.append_this_css
+
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::PredefinedMethods.command2?
+  #
+  # Simpler query over the Hash dataset here. We will use this method
+  # to return the corresponding CSS-dataset.
+  # ========================================================================= #
+  def self.command2?
+    ::Cyberweb::PredefinedMethods.css_class_to_use?[:command2]
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::PredefinedMethods.command3?
+  # ========================================================================= #
+  def self.command3?
+    ::Cyberweb::PredefinedMethods.css_class_to_use?[:command3]
+  end
+
+  # ========================================================================= #
+  # === command2?
+  # ========================================================================= #
+  def command2?
+    ::Cyberweb::PredefinedMethods.command2?
+  end
+
+  # ========================================================================= #
+  # === CMD2
+  # ========================================================================= #
+  CMD2 = command2? # A reference to the above.
+
+  # ========================================================================= #
+  # === command3?
+  # ========================================================================= #
+  def command3?
+    ::Cyberweb::PredefinedMethods.css_class_to_use?[:command3] # We delegate towards HASH_CSS_CLASS_TO_USE here.
+  end
+
+  # ========================================================================= #
+  # === cmd2
+  #
+  # This method will require that the method command2? will work. 
+  # ========================================================================= #
+  def cmd2(
+      i = '', optional_id = ''
+    )
+    padl2em(i, command2?, optional_id) # The second argument here is the id.
+  end; alias rc2      cmd2 # === rc2
+       alias command2 cmd2 # === command2
+
+  # ========================================================================= #
+  # === cmdbold
+  # ========================================================================= #
+  def cmdbold(i = '')
+    cmd(i, 'BOLD mars1em')
+  end
+
+  # ========================================================================= #
+  # === cmd_pre
+  # ========================================================================= #
+  def cmd_pre(i)
+    splitted = i.split(N)
+    splitted.each {|entry| cmd(entry) }
+  end; alias pre_cmd cmd_pre # === pre_cmd
+
+  # ========================================================================= #
+  # === Cyberweb::PredefinedMethods.cmd?
+  #
+  # This method will "tap" into the predefined css_class, for the
+  # Symbol :command1. This is the one that will be used for CSS
+  # in the method cmd().
+  # ========================================================================= #
+  def self.cmd?
+    ::Cyberweb::PredefinedMethods.css_class_to_use?[:command1]
+  end
+
+  # ========================================================================= #
+  # === cmd?
+  #
+  # This method also has a constant as an "alias" to its value.
+  # ========================================================================= #
+  def cmd?
+    ::Cyberweb::PredefinedMethods.cmd?
+  end; CMD = cmd?
+
+  # ========================================================================= #
+  # === cmd                                                         (cmd tag)
+  #
+  # This is a predefined method, called cmd().
+  #
+  # It will call the method css.optional, which is defined in the file 
+  # cyberweb/toplevel_methods/css.rb.
+  #
+  # By default, the return value obtained from css.optional corresponds to
+  # 'marl1em BO' - in other words, be bold and use a "margin-left: 1em"
+  # style in CSS.
+  #
+  # Further usage example:
+  #
+  #   css.optional = 'oki dokie'
+  #   cmd 'Test'
+  #   css.optional = 'bla'
+  #   cmd 'Test'
+  #
+  # ========================================================================= #
+  def cmd(
+      i                  = '',
+      css_class          = cmd?, # <- This used to be css.optional but I am not sure if we will keep on using css.optional there.
+      optional_id        = '',
+      optional_css_style = ''
+    )
+    s2(i, css_class, optional_id, optional_css_style)
+    br
+  end; alias command cmd # === command
+       alias cmd1    cmd # === cmd1
+
+  # ========================================================================= #
+  # === cmd3
+  # ========================================================================= #
+  def cmd3(
+      i = '', optional_css = command3?, optional_id = ''
+    )
+    padl3em(i, optional_css, optional_id) # The second argument here is the id.
+  end; alias rc3      cmd3 # === rc3
+       alias command3 cmd3 # === command3
+
+  # ========================================================================= #
+  # === cmd4
+  # ========================================================================= #
+  def cmd4(i = '', optional_id = '')
+    marl4em(i, '', optional_id) # The second argument here is the id.
+  end; alias rc4 cmd4 # === rc4
+
+  # ========================================================================= #
+  # === cmd5
+  # ========================================================================= #
+  def cmd5(i = '', optional_id = '')
+    marl5em(i, '', optional_id) # The second argument here is the id.
+  end; alias rc5 cmd5 # === rc5
+
+end # (end tag)
+
+  # ========================================================================= #
+  # === Cyberweb.append_to_cmd1
+  #
+  # This method can be used to append to "cmd1" aka :command1.
+  #
+  # Usage example:
+  #
+  #   Cyberweb.append_to_cmd1 :slateblue
+  #
+  # ========================================================================= #
+  def self.append_to_cmd1(i = 'marl2em')
+    old_content = ::Cyberweb::PredefinedMethods.css_class_to_use[:command1]
+    old_content = old_content.dup if old_content.frozen?
+    old_content << (" #{i.to_s.strip}").squeeze(' ')
+    ::Cyberweb::PredefinedMethods.css_class_to_use[:command1] = old_content
+  end
+
+  # ========================================================================= #
+  # === append_to_cmd1
+  #
+  # This method will append to cmd1.
+  # ========================================================================= #
+  def append_to_cmd1(
+      i = 'marl2em'
+    )
+    ::Cyberweb.append_to_cmd1(i)
+  end
+
+  # ========================================================================= #
+  # === empty_cmd1
+  # ========================================================================= #
+  def empty_cmd1
+    ::Cyberweb::PredefinedMethods.css_class_to_use[:command1] = ''
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.cmd2=
+  #
+  # This allows us to ad-hoc redefine cmd2.
+  #
+  # For instance:
+  #
+  #   Cyberweb.cmd2 = CMD2
+  #
+  # ========================================================================= #
+  def self.cmd2=(i)
+    ::Cyberweb::PredefinedMethods.css_class_to_use[:command2] = i
+  end
+
+  # ========================================================================= #
+  # === return_form_object
+  #
+  # Create a form object.
+  # ========================================================================= #
+  def return_form_object
+    ::Cyberweb.simple_form ||= ::Cyberweb::SimpleForm.new # in simple_form/simple_form.rb
+  end; alias simple_form return_form_object # === simple_form
+
+  # ========================================================================= #
+  # === css
+  #
+  # Also make it easer to get a handle towards the global CSS object via the
+  # global css-handle. However, we do not seem to really use this at all.
+  # Seems indeed to not be used at all. What was the idea behind this anyway?
+  # No idea, and I did not write it down - so I commented it as of Sep 2014.
+  #
+  # This is used in e. g. foundation, for stuff like:
+  #
+  #   css.optional
+  #
+  # ========================================================================= #
+  def css(optional_but_irrelevant_argument = '')
+    ::Cyberweb.css_object = ::Cyberweb::Css.new if ::Cyberweb.css_object.nil? # Create a new one in this case.
+    ::Cyberweb.css_object
+  end # alias c css # <--- We can not use this because "c" is already aliased onto "close".
+
+  # ========================================================================= #
+  # === Cyberweb.hash_registered_extra_tags?
+  # ========================================================================= #
+  def self.hash_registered_extra_tags?
+    ::Cyberweb::PredefinedMethods.hash_registered_extra_tags?
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.style_cmd1
+  #
+  # This method can be used to globally re-"style" the CSS used for
+  # command.
+  # ========================================================================= #
+  def self.style_cmd1(i)
+    ::Cyberweb::PredefinedMethods.css_class_to_use[:command1] = i
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.css_for_cmd?
+  # ========================================================================= #
+  def self.css_for_cmd?
+    ::Cyberweb::PredefinedMethods.css_class_to_use[:command1]
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.css_for_cmd=
+  # ========================================================================= #
+  def self.css_for_cmd=(i)
+    ::Cyberweb::PredefinedMethods.css_class_to_use[:command1] = i
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.cmd?
+  # ========================================================================= #
+  def self.cmd?
+    ::Cyberweb::PredefinedMethods.cmd?
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.enable_predefined_methods
+  #
+  # This method will enable the predefined methods addon. For now we will
+  # require a definite enable action by the user to make use of this 
+  # method, but in the future we may initialize this on startup.
+  #
+  # Methods such as cmd() and similar will be enabled as a result.
+  #
+  # Note that these methods will reside in the file:
+  #
+  #   bl $CYBERWEB/predefined_methods/predefined_methods.rb
+  #
+  # ========================================================================= #
+  def self.enable_predefined_methods
+    include ::Cyberweb::PredefinedMethods
+  end; self.instance_eval { alias enable_addons enable_predefined_methods }
+       self.instance_eval { alias maddons       enable_predefined_methods } # === Cyberweb.maddons
+
+end

data/lib/cyberweb/project/project.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen-string-literal: true
+# =========================================================================== #
+# This file includes the primary constant called PROJECT_BASE_DIRECTORY.
+#
+# It also includes several "aliases" to this constant, and a query-method
+# to ask for its value.
+#
+# The constant PROJECT_BASE_DIRECTORY in itself refers to the
+# base-directory of this ruby project, which is called 'web_object'.
+# =========================================================================== #
+# require 'cyberweb/project/project.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === PROJECT_BASE_DIR                                        (project tag)
+  #
+  # Get a handle onto the main directory of the project. If possible, I
+  # recommend to use PROJECT_BASE_DIR consistently - but for various
+  # reasons, the alternatives are also used.
+  #
+  # This constant will be equivalent to a String such as:
+  #
+  #   "/usr/lib/ruby/site_ruby/2.5.0/web_object/"
+  #
+  # ========================================================================= #
+  PROJECT_BASE_DIRECTORY =
+    File.absolute_path("#{__dir__}/..")+'/'
+    PROJECT_BASE_DIR = PROJECT_BASE_DIRECTORY # === PROJECT_BASE_DIR 
+    MAIN_DIR         = PROJECT_BASE_DIR # MAIN_DIR is synonymous with PROJECT_BASE_DIR 
+
+  # ========================================================================= #
+  # === ABSOLUTE_PROJECT_BASE_DIRECTORY
+  # ========================================================================= #
+  ABSOLUTE_PROJECT_BASE_DIRECTORY = 
+    File.absolute_path("#{__dir__}/..")+'/lib/cyberweb/'
+
+  # ========================================================================= #
+  # === Cyberweb.project_base_directory?
+  #
+  # The location where our project will be installed to, on the user's
+  # machine, via a top-level query method.
+  # ========================================================================= #
+  def self.project_base_directory?
+    PROJECT_BASE_DIRECTORY
+  end; self.instance_eval { alias project_base_dir?       project_base_directory? } # === Cyberweb.project_base_dir?
+       self.instance_eval { alias main_dir?               project_base_directory? } # === Cyberweb.main_dir?
+       self.instance_eval { alias project_root_directory? project_base_directory? } # === Cyberweb.project_root_directory?
+       self.instance_eval { alias project_root_dir?       project_base_directory? } # === Cyberweb.project_root_dir?
+
+  # ========================================================================= #
+  # === base_dir?
+  # ========================================================================= #
+  def base_dir?
+    Cyberweb.project_base_dir?
+  end
+
+  # ========================================================================= #
+  # === PROJECT_YAML_DIRECTORY
+  #
+  # The constant PROJECT_YAML_DIRECTORY tells us where we can find the
+  # yaml/ directory for this project.
+  #
+  # You can use a method called Cyberweb.project_yaml_directory? instead.
+  # ========================================================================= #
+  PROJECT_YAML_DIRECTORY = "#{PROJECT_BASE_DIRECTORY}yaml/"
+
+  # ========================================================================= #
+  # ==== Cyberweb.yaml_directory?
+  #
+  # This method will simply return the yaml directory of this project.
+  # ========================================================================= #
+  def self.yaml_directory?
+    PROJECT_YAML_DIRECTORY
+  end; self.instance_eval { alias config_directory? yaml_directory? } # === Cyberweb.config_directory?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Cyberweb::PROJECT_BASE_DIRECTORY
+  puts Cyberweb.project_base_directory?
+  puts Cyberweb.yaml_directory?
+end # rb project.rb

data/lib/cyberweb/rack/README.md

@@ -0,0 +1 @@
+This directory will contain helper-code towards Rack.