studium 0.14.16

data/lib/studium/base/prototype.rb

@@ -0,0 +1,592 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Base
+# =========================================================================== #
+# The minimal-prototype here will not include a lot of things - but one thing
+# that it must definitely include is the e() method, for output, and the
+# various colour-related methods, such as sfancy, via the file studium/base/colours.rb.
+#
+# It will also include reset() as this will be commonly called in a subclass
+# as-is. Other than that, the no_file_at() method is also commonly needed,
+# so this will be included as well. exit_program() was also added into
+# this file, during the changes in October 2020.
+#
+# This class contains the "bare minimum" definition for class Studium::Base.
+#
+# The reason as to why this exists is because some other classes that
+# may want to subclass from Studium::Base, need only the definition 
+# and perhaps some method calls. Whereas other classes may require the
+# fully fledged Studium::Base class. Since we want to remain
+# flexible, this is one way to go about it.
+# =========================================================================== #
+# require 'studium/base/prototype.rb'
+# =========================================================================== #
+require 'studium/requires/commonly_used_requires.rb'
+
+module Studium
+
+class Base
+
+  require 'studium/colours/colours.rb' # This file will also pull in the "colours" project.
+  include ::Studium::Colours # Pulled in from the above file.
+
+  require 'studium/constants/constants.rb'
+
+  require 'studium/toplevel_methods/runmode.rb'
+
+  # ========================================================================= #
+  # === GRAY
+  # ========================================================================= #
+  GRAY = ::Colours::GRAY
+
+  # ========================================================================= #
+  # === COLOURS
+  #
+  # This could go into studium/base/constants.rb, but it seems to fit better
+  # here as a "pointer" towards colours.
+  # ========================================================================= #
+  COLOURS = ::Colours::AllColourMethods
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === ARRAY_HTML_COLOURS_IN_USE
+  #
+  # Next, we will define the html-colours.
+  # ========================================================================= #
+  ARRAY_HTML_COLOURS_IN_USE = %w(
+    aquamarine
+    brown
+    cadetblue
+    chocolate
+    coral
+    cornflowerblue
+    crimson
+    cyan
+    darkblue
+    darkcyan
+    darkgoldenrod
+    darkgreen
+    darkkhaki
+    darkolivegreen
+    darkorange
+    darkred
+    darkseagreen
+    darkslateblue
+    darkslategray
+    darkturquoise
+    deepskyblue
+    firebrick
+    forestgreen
+    gold
+    goldenrod
+    green
+    grey
+    indianred
+    khaki
+    lavender
+    lawngreen
+    lightblue
+    lightcoral
+    lightgreen
+    lightred
+    lightseagreen
+    lightskyblue
+    lightslategray
+    lightslategrey
+    lime
+    limegreen
+    mediumaquamarine
+    mediumblue
+    mediumpurple
+    mediumseagreen
+    mediumslateblue
+    mediumspringgreen
+    mediumturquoise
+    mediumvioletred
+    mintcream
+    moccasin
+    oldlace
+    olive
+    olivedrab
+    orange
+    orangered
+    orchid
+    palegoldenrod
+    palegreen
+    paleturquoise
+    palevioletred
+    peru
+    plum
+    powderblue
+    red
+    rosybrown
+    royalblue
+    saddlebrown
+    salmon
+    sandybrown
+    seagreen
+    sienna
+    silver
+    skyblue
+    slateblue
+    slategray
+    springgreen
+    steelblue
+    tan
+    teal
+    thistle
+    tomato
+    turquoise
+    violet
+    whitesmoke
+    yellow
+    yellowgreen
+  )
+
+  # ========================================================================= #
+  # === register_sigint
+  # ========================================================================= #
+  def register_sigint
+    Signal.trap('SIGINT') { exit }
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  #
+  # The @runmode variable can be any of these three values:
+  #
+  #   :www
+  #   :gui
+  #   :commandline
+  #
+  # If :commandline is used as its value, then this class may colourize via
+  # the Colours module - otherwise, it may colourize via "websafe" colours
+  # instead (such as the HTML colours).
+  #
+  # Note that :gui means GUI, that is, graphical user interface. These
+  # are traditional "oldschool" desktop applications.
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @be_verbose
+    # ======================================================================= #
+    @be_verbose = true
+    # ======================================================================= #
+    # === @use_opn
+    #
+    # By default we will use opn in the project. The name "opn" stands
+    # short for "output program name".
+    # ======================================================================= #
+    @use_opn = true
+    # ======================================================================= #
+    # === @debug
+    #
+    # The next variable determines whether we will debug or whether we
+    # will not. If @debug is set to true, then we won't make modifications -
+    # instead, we will give debug information to the user.
+    # ======================================================================= #
+    @debug = false
+    # ======================================================================= #
+    # === @no_connection_to_the_www
+    #
+    # If true then we have no connection to the WWW.
+    # ======================================================================= #
+    @no_connection_to_the_www = false
+    # ======================================================================= #
+    # Next, determine which "mode" is used, such as www-mode, commandline
+    # mode or similar.
+    # ======================================================================= #
+    set_mode :commandline  # The default mode is commandline.
+    # ======================================================================= #
+    # === @use_colours
+    #
+    # The next variable determines whether instances of this class will
+    # make use of colours. By default the value from a toplevel-variable
+    # will be used as default start value. Thus, initially, they have
+    # the same value.
+    # ======================================================================= #
+    @use_colours = ::Studium.use_colours?
+  end
+
+  # ========================================================================= #
+  # === initialize_the_internal_hash
+  # ========================================================================= #
+  def initialize_the_internal_hash
+    # ======================================================================= #
+    # === @internal_hash
+    # ======================================================================= #
+    @internal_hash = {}
+  end; alias reset_the_internal_hash initialize_the_internal_hash # === reset_the_internal_hash
+
+  # ========================================================================= #
+  # === internal_hash?
+  # ========================================================================= #
+  def internal_hash?
+    @internal_hash
+  end
+
+  # ========================================================================= #
+  # === e                                                             (e tag)
+  # ========================================================================= #
+  def e(i = '')
+    puts i
+  end
+
+  # ========================================================================= #
+  # === ee                                                           (ee tag)
+  #
+  # This is just a wrapper over print, essentially.
+  # ========================================================================= #
+  def ee(i = '')
+    print i
+  end
+
+  # ========================================================================= #
+  # === no_file_at
+  # ========================================================================= #
+  def no_file_at(i)
+    e "#{rev}No file exists at #{sfile(i)}."
+  end; alias no_file_exists_at no_file_at # === no_file_exists_at
+
+  require 'studium/project/project.rb'
+  # ========================================================================= #
+  # === yaml_dir?
+  # ========================================================================= #
+  def yaml_dir?
+    Studium.yaml_directory?
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments_joined
+  #
+  # This method will, essentially, return all commandline-arguments as
+  # a String.
+  # ========================================================================= #
+  def commandline_arguments_joined
+    @commandline_arguments.join(' ').strip
+  end; alias return_commandline_arguments_as_string commandline_arguments_joined # === return_commandline_arguments_as_string
+       alias commandline_arguments_as_string        commandline_arguments_joined # === commandline_arguments_as_string
+       alias commandline_arguments_as_string?       commandline_arguments_joined # === commandline_arguments_as_string?
+       alias commandline_string?                    commandline_arguments_joined # === commandline_string?
+       alias commandline_as_string                  commandline_arguments_joined # === commandline_as_string
+       alias return_original_input_as_string        commandline_arguments_joined # === return_original_input_as_string
+
+  # ========================================================================= #
+  # === commandline_arguments_with_hyphens?
+  #
+  # This method will select all the commandline arguments that begin with
+  # '--' hyphens.
+  # ========================================================================= #
+  def commandline_arguments_with_hyphens?
+    @commandline_arguments.select {|entry|
+      entry.start_with?('--')
+    }
+  end; alias return_commandline_arguments_with_leading_hyphens commandline_arguments_with_hyphens? # === return_commandline_arguments_with_leading_hyphens
+       alias return_hyphened_commandline_arguments             commandline_arguments_with_hyphens? # === return_hyphened_commandline_arguments
+
+  # ========================================================================= #
+  # === first_non_hyphen_argument?
+  # ========================================================================= #
+  def first_non_hyphen_argument?
+    @commandline_arguments.select {|entry|
+      !entry.start_with?('--')
+    }.first
+  end
+
+  # ========================================================================= #
+  # === return_pwd
+  # ========================================================================= #
+  def return_pwd
+    "#{Dir.pwd}/".squeeze('/')
+  end; alias pwd? return_pwd # === pwd?
+
+  # ========================================================================= #
+  # === use_colours?
+  # ========================================================================= #
+  def use_colours?
+    @use_colours
+  end
+
+  # ========================================================================= #
+  # === swarn
+  # ========================================================================= #
+  def swarn(i = '')
+    return ::Colours.swarn(i) if @use_colours
+    return i
+  end
+
+  # ========================================================================= #
+  # === rev                                                         (rev tag)
+  # ========================================================================= #
+  def rev
+    return ::Studium::Colours.rev if @use_colours
+    return ''
+  end; alias revert rev # === revert
+
+  # ========================================================================= #
+  # === erev
+  # ========================================================================= #
+  def erev(i)
+    e "#{rev}#{i}"
+  end
+
+  # ========================================================================= #
+  # === KDE colours
+  #
+  # Define the HTML colours in use next.
+  # ========================================================================= #
+  ARRAY_HTML_COLOURS_IN_USE.each {|this_colour|
+    define_method(this_colour.to_sym) {|i = ''|
+      if use_colours? # Must check whether we use colours or not.
+        return COLOURS.send(this_colour.to_sym, i)
+      end
+      i
+    }
+    if this_colour.to_s == 'yellow'
+      alias yel yellow
+    end
+  }
+
+  # ========================================================================= #
+  # === enable_colours_globally
+  # ========================================================================= #
+  def enable_colours_globally
+    ::Studium.enable_colours
+  end
+
+  # ========================================================================= #
+  # === disable_colours_globally
+  #
+  # Disable the colours globally, that is, on a per-project basis.
+  # ========================================================================= #
+  def disable_colours_globally
+    ::Studium.disable_colours # Delegate to the module-method here.
+  end
+
+  # ========================================================================= #
+  # === ecomment
+  # ========================================================================= #
+  def ecomment(i = '')
+    ::Colours.ecomment(i)
+  end
+
+  # ========================================================================= #
+  # === simp
+  # ========================================================================= #
+  def simp(i = '')
+    return ::Colours.simp(i) if use_colours? # Delegate to module Colours in this case.
+    return i
+  end
+
+  # ========================================================================= #
+  # === sfancy
+  # ========================================================================= #
+  def sfancy(i = '')
+    return ::Colours.sfancy(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === enable_colours
+  # ========================================================================= #
+  def enable_colours
+    @use_colours = true
+  end
+
+  # ========================================================================= #
+  # === disable_colours
+  # ========================================================================= #
+  def disable_colours
+    @use_colours = false
+  end; alias no_colours disable_colours # === no_colours
+
+  # ========================================================================= #
+  # === namespace?
+  # ========================================================================= #
+  def namespace?
+    @namespace
+  end
+
+  # ========================================================================= #
+  # === set_runmode
+  #
+  # This method will delegate towards Exams.set_runmode.
+  #
+  # We have three valid modes, which can be passed as argument to
+  # this method here, as a Symbol:
+  #
+  #   (1) :commandline
+  #   (2) :www
+  #   (3) :gui
+  #
+  # The default one is :commandline.
+  #
+  # We tap into the class-method Exams.runmode? by default, which will
+  # be equal to passing :commandline.
+  # ========================================================================= #
+  def set_runmode(
+      i = ::Studium::Exams.runmode?
+    )
+    @runmode = i
+    # ======================================================================= #
+    # Also synchronize it into the whole studium-project. For this, we
+    # require the toplevel-method called Studium.set_runmode().
+    # Disabled this as of July 2020 as it interfers with .cgi scripts.
+    # ======================================================================= #
+    # ::Studium.set_runmode(@runmode) unless ::Studium::Exams.frozen?
+    case @runmode
+    # ======================================================================= #
+    # === :www
+    # ======================================================================= #
+    when :www, :gui # WWW mode and GUI mode do not use the commandline-colours.
+      ::Studium.disable_colours # Disable colours in this case.
+    end
+  end; alias set_mode set_runmode # === set_mode
+
+  # ========================================================================= #
+  # === set_commandline_mode
+  # ========================================================================= #
+  def set_commandline_mode
+    set_mode :commandline
+  end; alias set_commandline set_commandline_mode # === set_commandline
+
+  # ========================================================================= #
+  # === commandline?
+  #
+  # Whether we run in commandline mode or not. Will return true or false.
+  # ========================================================================= #
+  def commandline?
+    runmode? == :commandline
+  end; alias cmdline?          commandline? # === cmdline?
+       alias commandline_mode? commandline? # === commandline_mode?
+
+  # ========================================================================= #
+  # === set_www_mode
+  #
+  # Set to :www runmode through this method.
+  # ========================================================================= #
+  def set_www_mode
+    set_runmode :www
+  end; alias www_mode set_www_mode # === www_mode
+
+  # ========================================================================= #
+  # === runmode?
+  # ========================================================================= #
+  def runmode?
+    @runmode
+  end; alias mode? runmode? # === mode?
+
+  # ========================================================================= #
+  # === www_mode?
+  #
+  # This method will return true if we run in www mode.
+  # ========================================================================= #
+  def www_mode?
+    runmode? == :www
+  end; alias is_on_www?          www_mode? # === is_on_www?
+       alias are_we_in_www_mode? www_mode? # === are_we_in_www_mode?
+       alias in_www_mode?        www_mode? # === in_www_mode?
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  #
+  # The commandline arguments are always an Array.
+  # ========================================================================= #
+  def set_commandline_arguments(
+      i = ARGV
+    )
+    i = [i].flatten.compact
+    @commandline_arguments = i
+  end
+
+  # ========================================================================= #
+  # === reset_the_commandline_arguments
+  # ========================================================================= #
+  def reset_the_commandline_arguments
+    if @commandline_arguments and @commandline_arguments.is_a?(Array)
+      @commandline_arguments.clear 
+    else
+      @commandline_arguments = []
+    end
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+  end
+
+  # ========================================================================= #
+  # === set_first_argument
+  # ========================================================================= #
+  def set_first_argument(i)
+    @commandline_arguments[0] = i
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments?
+  # ========================================================================= #
+  def commandline_arguments?
+    @commandline_arguments
+  end; alias commandline? commandline_arguments? # === commandline?
+
+  # ========================================================================= #
+  # === first_argument?
+  #
+  # This method will attempt to return the first commandline argument
+  # given.
+  # ========================================================================= #
+  def first_argument?
+    if @commandline_arguments
+      @commandline_arguments.first
+    else
+      nil
+    end
+  end; alias first? first_argument? # === first?
+
+  # ========================================================================= #
+  # === egrey
+  # ========================================================================= #
+  def egrey(i)
+    e grey(i)
+  end
+
+  # ========================================================================= #
+  # === current_month?
+  #
+  # Show us the current month, as Integer. For example, for April, this
+  # method would return the number 4.
+  # ========================================================================= #
+  def current_month?
+    return ::Time.now.strftime('%m').to_i
+  end; alias month?                           current_month? # === month?
+       alias return_current_month_as_a_number current_month? # === return_current_month_as_a_number
+
+  # ========================================================================= #
+  # === padded_current_month?
+  # ========================================================================= #
+  def padded_current_month?(
+      i = current_month?
+    )
+    _ = i.to_s
+    return ('%02d' % _)
+  end
+
+  # ========================================================================= #
+  # === file_important_exams?
+  # ========================================================================= #
+  def file_important_exams?
+    return ::Studium.file_important_exams?
+  end
+
+end; end

data/lib/studium/c/README.md

@@ -0,0 +1,2 @@
+This directory may contain code that could represent the
+variant of the studium gem in C.

data/lib/studium/c/obtain_random_entry.c

@@ -0,0 +1,11 @@
+#include <stdio.h>
+
+int main(int argc, char *argv[]) {
+
+
+printf("argc = %d\n", argc);
+
+  printf("Hey there\n");
+  return 0;
+
+}

data/lib/studium/check_and_sanitize/README.md

@@ -0,0 +1,15 @@
+This directory may contain code that is related to sanitize-events,
+and check-related events e. g. getting some dataset and processing
+it ("cleaning it up") and the code quality and integrity of the
+whole studium project, such as checking that the dataset is correct
+or that the registered curricula contain only correct entries, and
+so forth.
+
+An example for this is to take copy/pasted course information from
+courses at the BOKU, and removing tabs and wrong indents that
+are retained in that copy/paste data. Of course there are also
+more sophisticated checks - we wish to prevent errors or correct
+them, as quickly and easily as possible. Keep the project in 
+a good, "healthy" state.
+
+Thus, this directory contains validation-specific code.