studium 0.16.9

data/lib/studium/constants/standalone_constants.rb

@@ -0,0 +1,372 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/constants/standalone_constants.rb'
+# =========================================================================== #
+module Studium
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === USERS_X
+  # ========================================================================= #
+  USERS_X = '/home/x/'
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n" # Define the newline for easier changes.
+
+  # ========================================================================= #
+  # === T
+  # ========================================================================= #
+  T = "\t"
+
+  # ========================================================================= #
+  # === THRESHOLD_VALUE_N_EXAMS_AT_MAXIMUM
+  #
+  # The following constant will only be honoured if the above-defined constant
+  # WARN_THE_USER_IF_THERE_ARE_TOO_MANY_QUESTIONS_REGISTERED_IN_AN_EXAM_TOPIC
+  # has been set to true.
+  #
+  # The current threshold is set to 1000, meaning that if an exam-topic
+  # has more than 1000 registered questions/answers, the user will be
+  # notified of this, if the above constant was set to true.
+  # ========================================================================= #
+  THRESHOLD_VALUE_N_EXAMS_AT_MAXIMUM = 1000
+
+  # ========================================================================= #
+  # === CHECK_FOR_INCORRECT_ENTRIES_IN_THE_QUESTION_ANSWER_FILE_THAT_SHOULD_BE_COMMENTS
+  #
+  # If the following constant is set to true, then a certain method will
+  # check whether lines start with e. g. "t#" rather than "#". This is
+  # an indication that some typo is in that exam-questions file, which
+  # we then can auto-correct.
+  # ========================================================================= #
+  CHECK_FOR_INCORRECT_ENTRIES_IN_THE_QUESTION_ANSWER_FILE_THAT_SHOULD_BE_COMMENTS =
+    true
+
+  # ========================================================================= #
+  # === DEFAULT_TOPIC
+  #
+  # What is our default topic? We define it here. This may be used in
+  # the file dataset.rb
+  # ========================================================================= #
+  DEFAULT_TOPIC = 'rand'
+
+  # ========================================================================= #
+  # === WARN_THE_USER_IF_THERE_ARE_TOO_MANY_QUESTIONS_REGISTERED_IN_AN_EXAM_TOPIC
+  # ========================================================================= #
+  WARN_THE_USER_IF_THERE_ARE_TOO_MANY_QUESTIONS_REGISTERED_IN_AN_EXAM_TOPIC = true
+
+  # ========================================================================= #
+  # === CHEERING_PERSON
+  #
+  # This ASCII "symbol" is repeated in many classes of the Studium namespace,
+  # indicating a success (via a cheering person who throws up the arms).
+  # ========================================================================= #
+  CHEERING_PERSON = '\\o/'
+
+  # ========================================================================= #
+  # === RIGHT_ARROW
+  # ========================================================================= #
+  RIGHT_ARROW = '→'
+    UNICODE_RIGHT_ARROW = RIGHT_ARROW # === UNICODE_RIGHT_ARROW
+  
+  # ========================================================================= #
+  # === UNICODE_CHECKMARK
+  # ========================================================================= #
+  UNICODE_CHECKMARK = '✓'
+
+  # ========================================================================= #
+  # === ONE_WEEK
+  # ========================================================================= #
+  ONE_WEEK = 7
+
+  # ========================================================================= #
+  # === APPEND_THIS
+  # ========================================================================= #
+  APPEND_THIS = '[]'
+
+  # ========================================================================= #
+  # === DEFAULT_DELAY
+  # ========================================================================= #
+  DEFAULT_DELAY = 3.0
+
+  # ========================================================================= #
+  # === Studium::ONE_MINUTE
+  # ========================================================================= #
+  ONE_MINUTE = 60 # 60 seconds.
+
+  # ========================================================================= #
+  # === Studium::ONE_HOUR
+  # ========================================================================= #
+  ONE_HOUR = ONE_MINUTE * 60
+
+  # ========================================================================= #
+  # === Studium::ONE_DAY
+  # ========================================================================= #
+  ONE_DAY = ONE_HOUR * 24
+
+  # ========================================================================= #
+  # === Studium::TWO_DAYS
+  # ========================================================================= #
+  TWO_DAYS = ONE_DAY * 2
+
+  # ========================================================================= #
+  # === Studium::THREE_DAYS
+  # ========================================================================= #
+  THREE_DAYS = ONE_DAY * 3
+
+  # ========================================================================= #
+  # === Studium::FOUR_DAYS
+  # ========================================================================= #
+  FOUR_DAYS = ONE_DAY * 4
+
+  # ========================================================================= #
+  # === Studium::FIVE_DAYS
+  # ========================================================================= #
+  FIVE_DAYS = ONE_DAY * 5
+
+  # ========================================================================= #
+  # === Studium::SIX_DAYS
+  # ========================================================================= #
+  SIX_DAYS = ONE_DAY * 6
+
+  # ========================================================================= #
+  # === FILE_EXAM_TOPICS_ARCHIVE
+  # ========================================================================= # 
+  FILE_EXAM_TOPICS_ARCHIVE = 'exam_topics.tar.xz'
+
+  # ========================================================================= #
+  # === Studium::ARRAY_LECTURE_TYPES_THAT_ARE_MANDATORY_CONTINUOUS_ASSESSMENT
+  #
+  # Alle prüfungsimmanenten Lehrveranstaltungen (courses with "mandatory
+  # presence") werden im folgenden Array gesammelt.
+  #
+  # PS stands for "Projektarbeit", aka "Bachelorarbeiten" usually.
+  #
+  # "SK" stands for seminar+praktikum, aka seminar-presentation and
+  # practical course work.
+  #
+  # Please use a new line for every individual entry in the following
+  # constant.
+  # ========================================================================= #
+  ARRAY_LECTURE_TYPES_THAT_ARE_MANDATORY_CONTINUOUS_ASSESSMENT = %w(
+    UE
+    SE
+    KV
+    EX
+    SK
+    LU
+    VU
+    PA
+    PJ
+    PP
+    PR
+    PS
+    KO
+    KU
+    KV
+    VS
+    VX
+    OL
+    VL
+    VO+UE
+    SE+UE
+    VO+SE  
+  )
+
+  # ========================================================================= #
+  # === MAKE_USE_OF_UNICODE_SYMBOLS_WHENEVER_POSSIBLE
+  #
+  # The following constant determines whether we will make use of
+  # Unicode symbols when that is possible, on the commandline.
+  #
+  # Unicode symbols in this context primarily refer to the unicode-checkmark
+  # "icon".
+  # ========================================================================= #
+  MAKE_USE_OF_UNICODE_SYMBOLS_WHENEVER_POSSIBLE = true
+
+  # ========================================================================= #
+  # === Studium.shall_we_make_use_of_unicode_symbols?
+  # ========================================================================= #
+  def self.shall_we_make_use_of_unicode_symbols?
+    MAKE_USE_OF_UNICODE_SYMBOLS_WHENEVER_POSSIBLE
+  end
+
+  # ========================================================================= #
+  # === Studium::ARRAY_GERMAN_WEEKDAYS
+  #
+  # All weekdays. This one is kept in german, though.
+  # ========================================================================= #
+  ARRAY_GERMAN_WEEKDAYS = %w(
+    Montag
+    Dienstag
+    Mittwoch
+    Donnerstag
+    Freitag
+    Samstag
+    Sonntag
+  ); ARRAY_WEEKDAYS = ARRAY_GERMAN_WEEKDAYS # === ARRAY_WEEKDAYS
+
+  # ========================================================================= #
+  # === Studium::HASH_SHORT_TO_LONG_WEEKDAYS
+  # ========================================================================= #
+  HASH_SHORT_TO_LONG_WEEKDAYS = {
+    'Mon' => 'Monday',
+    'Tue' => 'Tuesday',
+    'Wed' => 'Wednesday',
+    'Thu' => 'Thursday',
+    'Fri' => 'Friday',
+    'Sat' => 'Saturday',
+    'Sun' => 'Sunday'
+  }
+
+  # ========================================================================= #
+  # === Studium::ENGLISH_TO_GERMAN_WEEKDAYS
+  # ========================================================================= #
+  ENGLISH_TO_GERMAN_WEEKDAYS = {
+    'Monday'    => 'Montag',
+    'Tuesday'   => 'Dienstag',
+    'Wednesday' => 'Mittwoch',
+    'Thursday'  => 'Donnerstag',
+    'Friday'    => 'Freitag',
+    'Saturday'  => 'Samstag',
+    'Sunday'    => 'Sonntag'
+  }
+
+  # ========================================================================= #
+  # === GERMAN_TO_ENGLISH_WEEKDAYS
+  # ========================================================================= #
+  GERMAN_TO_ENGLISH_WEEKDAYS = ENGLISH_TO_GERMAN_WEEKDAYS.invert
+
+  # ========================================================================= #
+  # === ARRAY_ENGLISH_WEEKDAYS
+  # ========================================================================= #
+  ARRAY_ENGLISH_WEEKDAYS = ENGLISH_TO_GERMAN_WEEKDAYS.keys
+
+  # ========================================================================= #
+  # === Studium.array_english_weekdays?
+  # ========================================================================= #
+  def self.array_english_weekdays?
+    ARRAY_ENGLISH_WEEKDAYS
+  end
+
+  # ========================================================================= #
+  # === BOKU_N_ECTS_REGEX
+  #
+  # This regex can be used to determine the amount of ECTS points from
+  # BOKU-lectures. This is presently used in at the least two different
+  # rb.files.
+  #
+  # Also see:
+  #
+  #   https://rubular.com/r/3hWI5p2f6G
+  #
+  # ========================================================================= #
+  BOKU_N_ECTS_REGEX =
+    /<span class="bold">(\d{1},?\d{0,1})<\/span> ECTS-Credits<\/td><\/tr>/
+
+  # ========================================================================= #
+  # === GERMAN_WEEK_NAMES
+  # ========================================================================= #
+  GERMAN_WEEK_NAMES = {
+    'Mo' => 'Montag',
+    'Di' => 'Dienstag',
+    'Mi' => 'Mittwoch',
+    'Do' => 'Donnerstag',
+    'Fr' => 'Freitag',
+    'Sa' => 'Samstag',
+    'So' => 'Sonntag'
+  }
+
+  # ========================================================================= #
+  # === ARRAY_AVAILABLE_WEEKDAYS
+  #
+  # This will be an Array that has ['montag', 'dienstag' etc..]
+  # ========================================================================= #
+  ARRAY_AVAILABLE_WEEKDAYS = GERMAN_WEEK_NAMES.values.map(&:downcase)
+
+  # ========================================================================= #
+  # === REVERSE_GERMAN_WEEK_NAMES
+  # ========================================================================= #
+  REVERSE_GERMAN_WEEK_NAMES = GERMAN_WEEK_NAMES.invert
+
+  # ========================================================================= #
+  # === Studium::MONTH_NUMBER_TO_MONTH_NAME
+  #
+  # This constant maps from the month-number, such as 3, to the corresponding
+  # name of that month, such as 'March'.
+  # ========================================================================= #
+  MONTH_NUMBER_TO_MONTH_NAME = {
+     1 => 'January',
+     2 => 'February',
+     3 => 'March',
+     4 => 'April',
+     5 => 'May',
+     6 => 'June',
+     7 => 'July',
+     8 => 'August',
+     9 => 'September',
+    10 => 'October',
+    11 => 'November',
+    12 => 'December'
+  }
+
+  # ========================================================================= #
+  # === Studium.file_passwords
+  #
+  # This is only useful on my home system. It should probably be moved
+  # into its own file, such as roebe.rb.
+  # ========================================================================= #
+  def self.file_passwords
+    '/home/x/data/personal/yaml/passwords/passwords.yml'
+  end
+
+  # ========================================================================= #
+  # === UNICODE_HORIZONTAL_BAR
+  # ========================================================================= #
+  UNICODE_HORIZONTAL_BAR = '―'
+
+  # ========================================================================= #
+  # === Studium.unicode_horizontal_bar
+  #
+  # This method should be combined with 
+  # Studium.shall_we_make_use_of_unicode_symbols?, but this is
+  # not mandatory and more of a recommendation instead.
+  # ========================================================================= #
+  def self.unicode_horizontal_bar
+    UNICODE_HORIZONTAL_BAR
+  end
+
+  # ========================================================================= #
+  # === ARRAY_ALL_KNOWN_DAYS_OF_THE_WEEK
+  # ========================================================================= #
+  ARRAY_ALL_KNOWN_DAYS_OF_THE_WEEK = [
+    :mo,
+    :di,
+    :mi,
+    :do,
+    :fr,
+    :sa,
+    :so
+  ]
+
+  # ========================================================================= #
+  # === MONTH_NAME_TO_MONTH_NUMBER
+  #
+  # And reverse the above Array as well.
+  # ========================================================================= #
+  MONTH_NAME_TO_MONTH_NUMBER = MONTH_NUMBER_TO_MONTH_NAME.invert
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  e Studium.unicode_horizontal_bar*20
+end

data/lib/studium/constants/web_constants.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/constants/web_constants.rb'
+# Studium::WebConstants::TIMETABLE_DIV
+# =========================================================================== #
+module Studium
+
+module WebConstants # === Studium::WebConstants
+
+  # ========================================================================= #
+  # === Studium::WebConstants::TIMETABLE_DIV
+  # ========================================================================= #
+  TIMETABLE_DIV =
+    '<div style="font-family: monospace; '\
+    'padding:0.25em; '\
+    'border: 4px dotted slateblue; '\
+    'margin-bottom: 1.75em;">'
+
+  # ========================================================================= #
+  # === BR
+  #
+  # This simply refers to <br> aka the breakline tag.
+  # ========================================================================= #
+  BR = '<br>'
+
+end; end

data/lib/studium/css/project.css

@@ -0,0 +1,267 @@
+/*
+ * Style the tooltips uniformly.
+ */
+tooltip {
+  padding:      8px;
+  margin:       5px;
+  border-width: 8px;
+  border-style: solid;
+  border-color: steelblue;
+  font-size:    22px;
+}
+
+/*
+ * Gtk::Grid has a steelblue border.
+ */
+grid {
+  border:  2px solid steelblue;
+  padding: 15px;
+  margin:   5px;
+}
+
+menu {
+  border:  2px solid mediumslateblue;
+  padding: 3px;
+  margin:  3px;
+}
+
+#button_question {
+  background-color: #f00;
+}
+
+#mediumpurple     { color: mediumpurple; }
+
+#BG_white_and_mediumpurple {
+  color: mediumpurple;
+  background: white;
+}
+
+.aliceblue      { color: aliceblue }
+.antiquewhite   { color: antiquewhite }
+.aqua           { color: aqua }
+.aquamarine     { color: aquamarine }
+.azure          { color: azure }
+.beige          { color: beige }
+.bisque         { color: bisque }
+.black          { color: black }
+.blanchedalmond { color: blanchedalmond }
+.blue           { color: blue }
+.blueviolet     { color: blueviolet }
+.brown          { color: brown }
+.burlywood      { color: burlywood }
+.cadetblue      { color: cadetblue }
+.chartreuse     { color: chartreuse }
+.chocolate      { color: chocolate }
+.coral          { color: coral }
+.cornflowerblue { color: cornflowerblue }
+.cornsilk       { color: cornsilk }
+.crimson        { color: crimson }
+.cyan           { color: cyan }
+.darkblue       { color: darkblue }
+.darkcyan       { color: darkcyan }
+.darkgoldenrod  { color: darkgoldenrod }
+.darkgray       { color: darkgray }
+.darkgreen      { color: darkgreen }
+.darkgrey       { color: darkgrey }
+.darkkhaki      { color: darkkhaki }
+.darkmagenta    { color: darkmagenta }
+.darkolivegreen { color: darkolivegreen }
+.darkorange     { color: darkorange }
+.darkorchid     { color: darkorchid }
+.darkred        { color: darkred }
+.darksalmon     { color: darksalmon }
+.darkseagreen   { color: darkseagreen }
+.darkslateblue  { color: darkslateblue }
+.darkslategray  { color: darkslategray }
+.darkslategrey  { color: darkslategrey }
+.darkturquoise  { color: darkturquoise }
+.darkviolet     { color: darkviolet }
+.deeppink       { color: deeppink }
+.deepskyblue    { color: deepskyblue }
+.dimgray        { color: dimgray }
+.dimgrey        { color: dimgrey }
+.dodgerblue     { color: dodgerblue }
+.firebrick   { color: firebrick }
+.floralwhite { color: floralwhite }
+.forestgreen { color: forestgreen }
+.fuchsia     { color: fuchsia }
+.gainsboro   { color: gainsboro }
+.ghostwhite  { color: ghostwhite }
+.gold { color: gold }
+.goldenrod { color: goldenrod }
+.gray { color: gray }
+.grey { color: grey }
+.green { color: green }
+.greenyellow { color: greenyellow }
+.honeydew { color: honeydew }
+.hotpink { color: hotpink }
+.indianred { color: indianred }
+.indigo { color: indigo }
+.ivory { color: ivory }
+.khaki { color: khaki }
+.lavender { color: lavender }
+.lavenderblush { color: lavenderblush }
+.lawngreen { color: lawngreen }
+.lemonchiffon { color: lemonchiffon }
+.lightblue { color: lightblue }
+.lightcoral { color: lightcoral }
+.lightcyan { color: lightcyan }
+.lightgoldenrodyellow { color: lightgoldenrodyellow }
+.lightgray { color: lightgray }
+.lightgrey { color: lightgrey }
+.lightgreen { color: lightgreen }
+.lightpink { color: lightpink }
+.lightsalmon { color: lightsalmon }
+.lightseagreen { color: lightseagreen }
+.lightskyblue { color: lightskyblue }
+.lightslategray { color: lightslategray }
+.lightslategrey { color: lightslategrey }
+.lightsteelblue { color: lightsteelblue }
+.lightyellow { color: lightyellow }
+.lime { color: lime }
+.limegreen { color: limegreen }
+.linen { color: linen }
+.magenta { color: magenta }
+.maroon { color: maroon }
+.mediumaquamarine { color: mediumaquamarine }
+.mediumblue { color: mediumblue }
+.mediumorchid { color: mediumorchid }
+.mediumpurple { color: mediumpurple }
+.mediumseagreen { color: mediumseagreen }
+.mediumslateblue { color: mediumslateblue }
+.mediumspringgreen { color: mediumspringgreen }
+.mediumturquoise { color: mediumturquoise }
+.mediumvioletred { color: mediumvioletred }
+.midnightblue { color: midnightblue }
+.mintcream { color: mintcream }
+.mistyrose { color: mistyrose }
+.moccasin { color: moccasin }
+.navajowhite { color: navajowhite }
+.navy { color: navy }
+.oldlace { color: oldlace }
+.olive { color: olive }
+.olivedrab { color: olivedrab }
+.orange { color: orange }
+.orangered { color: orangered }
+.orchid { color: orchid }
+.palegoldenrod { color: palegoldenrod }
+.palegreen { color: palegreen }
+.paleturquoise { color: paleturquoise }
+.palevioletred { color: palevioletred }
+.papayawhip { color: papayawhip }
+.peachpuff { color: peachpuff }
+.peru { color: peru }
+.pink { color: pink }
+.plum { color: plum }
+.powderblue { color: powderblue }
+.purple { color: purple }
+.red { color: red }
+.rosybrown { color: rosybrown }
+.royalblue { color: royalblue }
+.saddlebrown { color: saddlebrown }
+.salmon { color: salmon }
+.sandybrown { color: sandybrown }
+.seagreen { color: seagreen }
+.seashell { color: seashell }
+.sienna { color: sienna }
+.silver { color: silver }
+.skyblue { color: skyblue }
+.slateblue { color: slateblue }
+.slategray { color: slategray }
+.slategrey { color: slategrey }
+.snow { color: snow }
+.springgreen { color: springgreen }
+.steelblue { color: steelblue }
+.tan { color: tan }
+.teal       { color: teal }
+.thistle    { color: thistle }
+.tomato     { color: tomato }
+.turquoise  { color: turquoise }
+.violet { color: violet }
+.wheat { color: wheat }
+.white { color: white }
+.whitesmoke { color: whitesmoke }
+.yellow { color: yellow }
+.yellowgreen { color: yellowgreen }
+
+popover {
+  border:  2px solid darkblue;
+  padding: 8px;
+  margin:  5px;
+}
+
+.bblack1 { border: 1px solid black; }
+.bblack2 { border: 2px solid black; }
+.bblack3 { border: 3px solid black; }
+
+.small_text_shadow {
+  text-shadow: 2px 2px 2px lightblue;
+}
+
+#textview1 text {
+  color:         midnightblue;
+  border-radius: 3px;
+  border-width:  2px 2px 2px 2px;
+  border-style:  solid;
+  border-color:  teal;
+  padding:       8px;
+  margin:        5px;
+  font-family:   'Hack';
+}
+
+#textview2 text {
+  color:         darkgreen;
+  border-radius: 3px;
+  border-width:  2px 2px 2px 2px;
+  border-style:  solid;
+  border-color:  teal;
+  padding:       8px;
+  margin:        5px;
+  font-family:   'Hack';
+}
+
+#textview3 text {
+  color:         midnightblue;
+  border-radius: 6px;
+  border-width:  3px 3px 3px 3px;
+  border-style:  solid;
+  border-color:  mediumpurple;
+  padding:       6px;
+  margin:        5px;
+  font-family:   'Hack';
+}
+
+.pad4px  { padding:   4px; }
+.pad10px { padding:  10px; }
+.mar8px  { margin:    8px; }
+
+#BG_palegoldenrod { background: palegoldenrod; }
+#BG_cadetblue     { background: cadetblue; }
+#BG_thistle       { background: thistle; }
+#BG_black         { background: black; }
+#BG_darkkhaki     { background-color: darkkhaki; }
+#BG_bisque        { background-color: bisque; }
+.BG_black         { background-color: black; }
+
+/*
+ * Notebook-specific CSS rules are designated next.
+ */
+.notebook_for_ask_exam_question header {
+  background: none; /* reset it here */
+  border:  2px solid black;
+  padding: 5px;
+  background-color: rgb(222, 232, 245); /* very_light_lightsteelblue; */
+}
+
+/*
+ * Show a small transition-effect. Not too terribly useful,
+ * just some fancy GUI effect applied there.
+ */
+#button_hover_transition:hover {
+  transition:       5000ms linear;
+  background-color: lightblue;
+}
+
+#button_hover_transition {
+  background-color: palegoldenrod;
+}