studium 0.10.1

data/lib/studium/colours/sfancy.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/colours/sfancy.rb'
+# =========================================================================== #
+module Studium
+
+module Colours # === Studium::Colours
+
+  # ========================================================================= #
+  # === Studium::Colours.sfancy
+  #
+  # To test this method e. g. in IRB, do:
+  #
+  #   puts Studium::Colours.sfancy("yo there")
+  #
+  # ========================================================================= #
+  def self.sfancy(i = '')
+    return ::Colours.sfancy(i) if Colours.use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === sfancy
+  # ========================================================================= #
+  def sfancy(i)
+    ::Studium::Colours.sfancy(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.sfancy
+# =========================================================================== #
+def self.sfancy(i)
+  ::Studium::Colours.sfancy(i)
+end
+
+end

data/lib/studium/colours/sfile.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/colours/sfile.rb'
+# =========================================================================== #
+module Studium
+
+module Colours # === Studium::Colours
+
+  # ========================================================================= #
+  # === Studium::Colours.sfile
+  # ========================================================================= #
+  def self.sfile(i = '')
+    return ::Colours.sfile(i) if Colours.use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === sfile
+  # ========================================================================= #
+  def sfile(i = '')
+    ::Studium::Colours.sfile(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.sfile
+# =========================================================================== #
+def self.sfile(i)
+  ::Studium::Colours.sfile(i)
+end
+
+end

data/lib/studium/colours/simp.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Studium
+
+module Colours # === Studium::Colours
+
+  # ========================================================================= #
+  # === Studium::Colours.simp
+  #
+  # To test this method e. g. in IRB, do:
+  #
+  #   puts Studium::Colours.simp("yo there")
+  #
+  # ========================================================================= #
+  def self.simp(i)
+    return ::Colours.simp(i) if Colours.use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === simp
+  # ========================================================================= #
+  def simp(i)
+    ::Studium::Colours.simp(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.simp
+# =========================================================================== #
+def self.simp(i)
+  ::Studium::Colours.simp(i)
+end
+
+end

data/lib/studium/colours/use_this_colour_for_exam_questions_and_exam_answers.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/colours/use_this_colour_for_exam_questions_and_exam_answers.rb'; include ::Studium::Colours
+# =========================================================================== #
+module Studium
+
+module Colours # === Studium::Colours
+
+  require 'studium/constants/file_constants.rb'
+  require 'studium/toplevel_methods/methods_related_to_files.rb'
+  require 'studium/toplevel_methods/is_on_roebe.rb'
+  require 'studium/toplevel_methods/save_file.rb'
+
+  # ========================================================================= #
+  # === Studium::Colours.use_this_colour_for_exam_answers
+  #
+  # This method can be used to modify the colours for exam-answers. It
+  # will write into the respective .yml file.
+  #
+  # Invocation example from the commandline:
+  #
+  #   studium --use-this-colour-for-exam-answers=slateblue
+  #
+  # ========================================================================= #
+  def self.use_this_colour_for_exam_answers(i)
+    into = FILE_CUSTOM_COLOURS
+    if File.exist? into
+      use_this_regex = /(colour_for_answers: )(.+)$/
+      dataset = ::Studium.file_read_with_proper_encoding(into)
+      dataset.sub!(use_this_regex, '\1'+i)
+      e "Now writing into the file `#{sfile(into)}`."
+      ::Studium.save_what_into(dataset, into)
+      if ::Studium.is_on_roebe?
+        into = "#{RUBY_SRC_STUDIUM_LIB}studium/yaml/"\
+               "#{File.basename(into)}"
+        e "Now also writing into the file `#{sfile(into)}`."
+        ::Studium.save_what_into(dataset, into)
+      end
+    else
+      e 'No file called '+into+' exists.'
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium::Colours.use_this_colour_for_exam_questions
+  #
+  # This method can be used to modify the colours for exam-questions. It
+  # will write into the respective .yml file.
+  #
+  # Invocation example from the commandline:
+  #
+  #   studium --use-this-colour-for-exam-questions=slateblue
+  #
+  # ========================================================================= #
+  def self.use_this_colour_for_exam_questions(i)
+    into = FILE_CUSTOM_COLOURS
+    if File.exist? into
+      use_this_regex = /(colour_for_questions: )(.+)$/
+      dataset = ::Studium.file_read_with_proper_encoding(into)
+      dataset.sub!(use_this_regex, '\1'+i)
+      e 'Now writing into the file `'+sfile(into)+'`.'
+      ::Studium.save_what_into(dataset, into)
+      if ::Studium.is_on_roebe?
+        into = "#{RUBY_SRC_STUDIUM_LIB}studium/yaml/"\
+               "#{File.basename(into)}"
+        e 'Now also writing into the file `'+sfile(into)+'`.'
+        ::Studium.save_what_into(dataset, into)
+      end
+    else
+      e "No file called #{into} exists."
+    end
+  end
+
+end; end

data/lib/studium/commandline/commandline.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Commandline
+#
+# This class handles input passed from the commandline, into the executable
+# called bin/studium, which acts as the "central entry point" to the
+# Studium project, if it is related to the commandline. 
+#
+# Usage example:
+#
+#   Studium::Commandline.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/commandline/commandline.rb'
+# =========================================================================== #
+require 'studium/commandline/initialize.rb'
+require 'studium/commandline/menu.rb'
+require 'studium/commandline/misc.rb'
+require 'studium/commandline/reset.rb'
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Commandline.new(ARGV)
+end # studiumcommandline --help

data/lib/studium/commandline/constants.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/commandline/constants.rb'
+# =========================================================================== #
+module Studium
+
+class Commandline < Base # === Studium::Commandline
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+end; end

data/lib/studium/commandline/help.rb

@@ -0,0 +1,152 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/commandline/help.rb'
+# =========================================================================== #
+module Studium
+
+class Commandline < Base # === Studium::Commandline
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  #
+  # We will first build up an Array, then sort it, then display it.
+  # That way we can just add to that Array without having to worry
+  # about whether it is sorted or not.
+  #
+  # Invocation example:
+  #
+  #   studium --show-help
+  #
+  # ========================================================================= #
+  def show_help
+    array = []
+    array << '  --exam-topics?                                           # feedback '\
+             'the location to the exam-topics in use'
+    array << '  --log-dir?                                               # feedback '\
+             'the log directory in use'
+    array << '  --n-topics?                                              # feedback '\
+             'how many topics are available'
+    array << '  --show_how_many_exams_were_passed                        # feedback '\
+             'how many exams were already passed'
+    array << '  --set-directory-to-the-exam-topics=/Depot/j/EXAM_TOPICS/ # set a '\
+             'specific directory target'
+    array << '  --best-months                                            # show '\
+             'the best month, that is, most ECTS points solved in any given month'
+    array << '  --set-dir=/dir                                           # shorter '\
+             'variant of the above; an alias'
+    array << '  --set-editor=vim                                         # set '\
+             'to use the editor called vim (or any other one of your choice)'
+    array << '  --show-curricula                                         # show '\
+             'all registered curricula'
+    array << '  --master-curricula                                       # show '\
+             'all lectures passed in a given master curriculum'
+    array << '  --upload-exam-questions                                  # uploads '\
+             'the exam questions'
+    array << '  --expand="15.10-22.10.2018"                              # expand '\
+             'the time range for this range'
+    array << '  --encoding=utf                                           # use '\
+             'this encoding for the Studium namespace'
+    array << '  --outdated                                               # show '\
+             'outdated lva- and exam-dates of registered lectures'
+    array << '  --collage?                                               # show '\
+             'which exams we are currently training'
+    array << '  --n-ects-from-this-file=ECTS.md                          # display '\
+             'how many ECTS points are in that file'
+    array << '  --ects-bachelor-master?                                  # show '\
+             'how many bachelor/master ECTS points were passed so far'
+    array << '  --passed-exams?                                          # show '\
+             'which exams were already completed successfully'
+    array << '  --start                                                  # note '\
+             'down the start time + how many exams were solved at this point'
+    array << '  --pristine                                               # this '\
+             'will create a new file called '+
+             'lecture_information.yml'+
+             ', without any already solved exams'
+    array << '  --colours?                                               # show '\
+             'whether we will use colours or whether we will not'
+    array << '  --passed-ects                                            # show '\
+             'how many ECTS were passed in the registered curricula'
+    array << '  --passed-exams=chemistry                                 # show '\
+             'passed exams belonging to the given theme (in this '\
+             'case, lectures related to chemistry)'
+    array << '  --statistics                                             # show '\
+             'some general statistics of this project'
+    array << '  --check-the-lecture-information-file                     # check '\
+             'whether all entries are correct, in the file called '+
+             sfile('lecture_information.yml')
+    array << '  --lectures-on-this-day=05.05.2018                        # show '\
+             'which lectures are on the given day'
+    array << '  --disable-colours                                        # this '\
+             'entry point allows you to permanently disable colours'
+    array << '  --solved?                                                # show '\
+             'whether whether that particular lecture ID was already solved or '\
+             'whether it was not'
+    array << '  --set-log-dir=/foo/bar/                                  # specify '\
+             'another log directory'
+    array << '  --exams-at-the-meduni                                    # show '\
+             'all exams at the meduni'
+    array << '  --n-entries-in-the-file-lecture-information?             # report '\
+             'how many courses are registered in the file '+
+             sfile('lecture_information.yml')
+    array << '  --max?                                                   # show '\
+             'how many exams were already passed'
+    array << '  --download-exam-dataset                                  # download '\
+             'the exam dataset from a remote website'
+    array << '  --gui                                                    # start '\
+             'the GUI component of the Studium project'
+    array << '  --timetable                                              # show '\
+             'upcoming possible exams, via a timetable'
+    array << '  --max-ever                                               # show '\
+             'the maximum amount of exam-questions ever answered'
+    array << '  --audio-stats                                            # show '\
+             'all locally available audio files in the study-directory'
+    array << '  --yearly-average-grades                                  # show '\
+             'the yearly average grades'
+    array << '  --percentage-achieved                                    # show '\
+             'how much percent of a given curriculum we have already passed'
+    array << '  --questions-per-year                                     # show '\
+             'how many questions were added per year'
+    array << '  --exams-at-the-uniwien                                   # show '\
+             'all exams at the uniwien (university of vienna)'
+    array << '  --open                                                   # open '\
+             'relevant study-specific files in the (default) editor'
+    array << '  /name_of_exams/                                          # regex '\
+             'search for an exam with that name'
+    array << '  --upcoming_exams_at_the_boku                             # show '\
+             'all upcoming exams at the BOKU. (This will also generate a .html page.)'
+    array << '  --upcoming-important-exams                               # show '\
+             'all upcoming exams in general. (This will also generate a .html page.)'
+    array << '  --examstats                                              # show '\
+             'the exam statistics, that is, how many exams you passed'
+    array << '  --use-this-colour-for-exam-questions=slateblue           # set '\
+             'to use this colour for exam-questions'
+    array << '  --use-this-colour-for-exam-answers=slateblue             # set '\
+             'to use this colour for exam-answers'
+    array << '  --set-delay=5                                            # set '\
+             'the delay between answering a question to n seconds, in this case 5'
+    array << '  --delay?                                                 # query '\
+             'the current delay in use'
+    array << '  --files?                                                 # show '\
+             'where some of the important files may be kept'
+    array << '  last-exams 15                                            # show '\
+             'the last 15 passed exams'
+    array << '  --update-max-questions                                   # update '\
+             'how many questions were asked'
+    array << '  --mandatory                                              # show '\
+             'upcoming mandatory courses in the next some days (40 days usually)'
+    e
+    e "#{rev}The following #{steelblue(array.size.to_s)} options "\
+      "are available and documented for #{royalblue('bin/studium')}:"
+    e
+    e
+    # ======================================================================= #
+    # The above ^^^ can be added in any random order; the next line will
+    # sort this anyway.
+    # ======================================================================= #
+    array.sort.each {|entry| eparse entry }
+    e
+  end
+
+end; end

data/lib/studium/commandline/initialize.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/commandline/initialize.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+require 'studium/commandline/run.rb'
+
+module Studium
+
+class Commandline < Base # === Studium::Commandline
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = ARGV,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    parse_commandline_arguments_as_a_full_string
+    run if run_already
+  end
+
+end; end

data/lib/studium/commandline/menu.rb

@@ -0,0 +1,760 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/commandline/menu.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+require 'studium/commandline/help.rb'
+
+module Studium
+
+class Commandline < Base # === Studium::Commandline
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === studium --start-a-new-exam-day
+      #
+      # This entry point can be used to "reset" the file that keeps track
+      # of which exams have been used.
+      # ===================================================================== #
+      when /-?-?start(_|-)?a(_|-)?new(_|-)?exam(_|-)?day$/i,
+           /-?-?clear(_|-)?last(_|-)?questions$/i,
+           /^-?-?clear(_|-)?old(_|-)?file$/i,
+           /^-?-?clear(_|-)?file$/i
+        start_a_new_exam_day
+        exit
+      # ===================================================================== #
+      # === studium --ects-per-university
+      # ===================================================================== #
+      when /^-?-?ects(-|_)?per(-|_)?university$/i
+        require 'studium/ects/ects_per_university.rb'
+        Studium::EctsPerUniversity.new
+      # ===================================================================== #
+      # === studium --mandatory
+      # ===================================================================== #
+      when /^-?-?mandatory$/i
+        show_upcoming_mandatory_presence_courses
+        exit
+      # ===================================================================== #
+      # === studium --create_a_clean_lecture_information_file
+      # ===================================================================== #
+      when /^-?-?create(-|_)?a(-|_)?clean(-|_)?lecture(-|_)?information(-|_)?file$/i
+        Studium.create_a_clean_lecture_information_file
+        exit
+      # ===================================================================== #
+      # === studium --upload-exam-questions
+      # ===================================================================== #
+      when /-?-?upload(_|-)?exam(_|-)?questions/,
+           /-?-?upload(_|-)?exams/,
+           /-?-?uexams/
+        Studium.upload_exam_questions { :be_verbose }
+      # ===================================================================== #
+      # === studium --compare
+      # ===================================================================== #
+      when /^-?-?compare$/
+        curriculum_comparer
+      # ===================================================================== #
+      # === studium --download-exam-dataset
+      # ===================================================================== #
+      when /^-?-?download(_|-)?exam(_|-)?dataset$/i,
+           /^-?-?download(_|-)?dataset$/i
+        ::Studium.download_exam_dataset
+      # ===================================================================== #
+      # === studium --use-this-colour-for-exam-answers=slateblue
+      # ===================================================================== #
+      when /^-?-?use(-|_)?this(-|_)?colour(-|_)?for(-|_)?exam(-|_)?answers=(.+)/i,
+           /^-?-?use(-|_)?this(-|_)?colour(-|_)?for(-|_)?answers=(.+)/i,
+           /^-?-?colour(-|_)?for(-|_)?answers=(.+)/i
+        _ = $3
+        _ = $5 if $5
+        _ = $6 if $6
+        ::Studium::Colours.use_this_colour_for_exam_answers(_.to_s.dup)
+      # ===================================================================== #
+      # === studium --passed-exams?
+      # ===================================================================== #
+      when /^-?-?passed(-|_)?exams\??$/i,
+           /^-?-?all(-|_)?passed(-|_)?exams\??$/i,
+           /^-?-?return(-|_)?passed(-|_)?exams\??$/i
+        show_passed_exams
+      # ===================================================================== #
+      # === studium --lectures-on-this-day=05.05.2018
+      # ===================================================================== #
+      when /^-?-?lectures(_|-)?on(_|-)?this(_|-)?day(_|-)?=(.+)$/,
+           /^(\d{2}.\d{2}.\d{4})$/
+        require 'studium/curricula/determine_curricula/determine_curricula.rb'
+        first_match_to_the_regex = $1.to_s.dup
+        i = $5.to_s.dup
+        if first_match_to_the_regex =~ /^\d+/
+          i = first_match_to_the_regex
+        end
+        Studium.show_lectures_on_this_day(i)
+      # ===================================================================== #
+      # === studium --master=vektorx
+      # ===================================================================== #
+      when /^-?-?master(=|-)(.+)$/
+        require 'studium/lectures/show_lectures_on_the_commandline/show_lectures_on_the_commandline.rb'
+        this_curriculum = "master-#{$2.to_s.dup}"
+        Studium::ShowLecturesOnTheCommandline.new(this_curriculum)
+      # ===================================================================== #
+      # === studium "--solved? 300143"
+      # === studium "--already_solved_this_id 300143"
+      # ===================================================================== #
+      when /-?-?solved\?? (\d+)/,
+           /-?-?already(_|-)?solved(_|-)?this(_|-)?id (\d+)/
+        the_lva_number = $1.to_s.dup
+        the_lva_number = $4.to_s.dup if $4
+        yes_or_no = Studium.yes_or_no(
+          Studium.already_solved_this_lva_number?(the_lva_number).to_s
+        )
+        e 'Did we solve this lecture (ID: '+simp(the_lva_number)+') yet? '+
+          sfancy(yes_or_no)
+      # ===================================================================== #
+      # === set_directory_to_the_exam_topics
+      #
+      # Usage example:
+      #
+      #   studium --set-directory-to-the-exam-topics=/Depot/j/EXAM_TOPICS/
+      #
+      # ===================================================================== #
+      when /set(_|-)?directory(_|-)?to(_|-)?the(_|-)?exam(_|-)?topics=(.+)/
+        match = $6.to_s.dup
+        verbose_set_this_dir_to_exam_topics(match)
+      # ===================================================================== #
+      # === set_dir
+      # ===================================================================== #
+      when /set(_|-)?dir=(.+)/
+        match = $2.to_s.dup
+        verbose_set_this_dir_to_exam_topics(match)
+      # ===================================================================== #
+      # === studium --pristine
+      # ===================================================================== #
+      when /^-?-?pristine$/,
+           /^-?-?new(_|-)?lecture(_|-)?information$/
+        pristine
+      # ===================================================================== #
+      # === studium --collage?
+      # ===================================================================== #
+      when /-?-?collage\??$/
+        show_collage_of_current_exams
+        exit
+      # ===================================================================== #
+      # === studium --passed-exams=chemistry
+      # ===================================================================== #
+      when /^-?-?passed(_|-)?exams=(.+)/i,
+           /^-?-?report(_|-)?passed(_|-)?exams(_|-)?fitting(_|-)?to(_|-)?this(_|-)?theme=(.+)/i
+        this_theme = $2.to_s.dup
+        this_theme = $7.to_s.dup if $7
+        report_passed_exams_fitting_to_this_theme(this_theme)
+      # ===================================================================== #
+      # === studium --outdated
+      # ===================================================================== #
+      when /^-?-?outdated$/
+        show_outdated_lva_dates
+      # ===================================================================== #
+      # === studium --gui
+      # ===================================================================== #
+      when /^-?-?gui$/
+        start_gui_component
+      # ===================================================================== #
+      # === studium --upload-archive-of-the-exam-questions
+      # ===================================================================== #
+      when /^-?-?upload(-|_| )?archive(-|_| )?of(-|_| )?the(-|_| )?exam(-|_| )?questions$/,
+           /^-?-?upload(-|_| )?exam(-|_| )?archive$/,
+           /^-?-?upload(-|_| )?exam(-|_| )?topics$/
+        upload_archive_of_the_exam_questions
+      # ===================================================================== #
+      # === studium --encoding=utf
+      # === studium --encoding=iso1
+      # ===================================================================== #
+      when /^-?-?encoding=(.+)$/i
+        Studium.use_this_new_encoding($1.to_s.dup)
+        exit
+      # ===================================================================== #
+      # === studium --lectures_without_exam_entry
+      # ===================================================================== #
+      when /^-?-?lectures(_|-)?without(_|-)?exam(_|-)?entry$/i
+        lectures_without_exam_entry
+      # ===================================================================== #
+      # === studium --use-this-colour-for-exam-questions=slateblue
+      # ===================================================================== #
+      when /^-?-?use(-|_)?this(-|_)?colour(-|_)?for(-|_)?exam(-|_)?questions=(.+)/i,
+           /^-?-?use(-|_)?this(-|_)?colour(-|_)?for(-|_)?questions=(.+)/i,
+           /^-?-?colour(-|_)?for(-|_)?questions=(.+)/i
+        _ = $3
+        _ = $5 if $5
+        _ = $6 if $6
+        ::Studium::Colours.use_this_colour_for_exam_questions(_.to_s.dup)
+      # ===================================================================== #
+      # === studium --nsolved
+      # ===================================================================== #
+      when /^-?-?nsolved$/
+        report_how_many_exam_questions_were_already_solved
+      # ===================================================================== #
+      # === studium --merge
+      # ===================================================================== #
+      when /^-?-?merge$/i
+        copy_lecture_information_file_to_default_location
+      # ===================================================================== #
+      # === studium --open-upcoming-exams
+      # ===================================================================== #
+      when /^-?-?open(-|_)?upcoming(-|_)?exams$/i,
+           /^-?-?open(-|_)?important$/i
+        open_relevant_files
+      # ===================================================================== #
+      # === studium --open-important-exams
+      # ===================================================================== #
+      when /^-?-?open(-|_)?important(-|_)?exams$/i,
+           /^-?-?important(-|_)?exams$/i,
+           /^-?-?important$/i,
+           /^-?-?priorities$/i,
+           /^-?-?priority$/i,
+           /^-?-?open(-|_)?important(-|_)?lectures$/i # === studium --open-important-lectures
+        verbose_open_important_exams
+      # ===================================================================== #
+      # === studium --create-an-archive-of-the-exam-questions
+      # ===================================================================== #
+      when /^-?-?create(-|_| )?an(-|_| )?archive(-|_| )?of(-|_| )?the(-|_| )?exam(-|_| )?questions$/i,
+           /^-?-?create(-|_| )?exam(-|_| )?topics(-|_| )?archive$/i
+        create_an_archive_of_the_exam_questions
+      # ===================================================================== #
+      # === studium --upcoming-important-exams
+      # ===================================================================== #
+      when /-?-?upcoming(-|_)?important(-|_)?exams/,
+           /-?-?upcoming(-|_)?exams/
+        upcoming_important_exams
+      # ===================================================================== #
+      # === studium --end
+      # ===================================================================== #
+      when /^-?-?end$/i,
+           /^-?-?end(-|_)?difference$/i
+        report_the_difference_to_the_start_time
+      # ===================================================================== #
+      # === studium --upload_pdf
+      # ===================================================================== #
+      when /^-?-?upload(-|_)?pdf$/i
+        upload_pdf
+      # ===================================================================== #
+      # === studium --vim
+      # ===================================================================== #
+      when /^-?-?vim$/i
+        permanently_set_this_editor(:vim)
+      # ===================================================================== #
+      # === studium --help
+      #
+      # Displaying help to the user must be a fast operation, so it is
+      # stored in the file here.
+      # ===================================================================== #
+      when /help$/i,
+           /-h$/i
+        show_help
+      # ===================================================================== #
+      # === studium --show-lva-dates-of-this-lecture="Primatologie"
+      # ===================================================================== #
+      when /^-?-?show(_|-)?lva(_|-)?dates(_|-)?of(_|-)?this(_|-)?lecture=(.+)/i
+        this_theme = $6.to_s.dup.delete('"')
+        show_lva_dates_of_this_lecture(this_theme)
+      # ===================================================================== #
+      # === studium --current-studyset?
+      # ===================================================================== #
+      when /^-?-?current(-|_)?studyset\??$/i
+        show_the_current_studyset
+      # ===================================================================== #
+      # === studium --colours?
+      # ===================================================================== #
+      when /-?-?colours\??/
+        e ::Colours.rev+
+          'Does the Studium project use colours, right now? '+
+          sfancy(Studium.yes_or_no(Studium.use_colours?.to_s))
+      # ===================================================================== #
+      # === studium --add-a-new-question
+      # ===================================================================== #
+      when /^-?-?add(-|_)?a(-|_)?new(-|_)?question$/i
+        add_new_exam_question
+      # ===================================================================== #
+      # === studium set-delay=5
+      # ===================================================================== #
+      when /set(_|-)?delay=(.+)/ # studium set-delay=2.6
+        ::Studium.save_this_delay_between_questions_and_answers($2.to_s.dup)
+      # ===================================================================== #
+      # === studium set_log_dir=/Depot/j/
+      # ===================================================================== #
+      when /-?-?set(_|-)?log(_|-)?dir=(.+)/
+        match = $3.to_s.dup
+        verbose_set_this_new_log_dir(match)
+      # ===================================================================== #
+      # === studium --last-question?
+      # ===================================================================== #
+      when /^-?-?last(_|-)?question\??$/i
+        require 'studium/constants/last_question_asked.rb'
+        _ = Studium.file_last_question_asked?
+        if File.exist? _
+          e File.read(_)
+        else
+          no_file_exists_at(_)
+        end
+      # ===================================================================== #
+      # === studium --update-max-questions
+      #
+      # This will also update the max questions ever.
+      # ===================================================================== #
+      when /^-?-?update(-|_)?max(-|_)?questions$/
+        require 'studium/statistics/report_how_many_exam_questions_were_answered.rb'
+        Studium::Statistics::ReportHowManyExamQuestionsWereAnswered.new
+        exit
+      # ===================================================================== #
+      # === studium --update--max-ever
+      #
+      # This entry point can be used to update various things, but most
+      # importantly, updating the "max-ever query".
+      # ===================================================================== #
+      when /^-?-?update(-|_)?max(-|_)?ever$/,
+           /^-?-?update$/,
+           /^-?-?update(-|_)?statistics$/,
+           /^-?-?record$/,
+           /^-?-?save$/,
+           /^-?-?update(-|_)?examstats$/         # === studium --update-examstats
+        verbose_update_max_ever
+        exit
+      # ===================================================================== #
+      # === studium --expand-time-range="15.10. - 2.11.2018,"
+      # === studium --expander="15.10. - 2.11.2018,"
+      # === studium --expander="02.02.2020-02.05.2020"
+      # ===================================================================== #
+      when /^-?-?expand(-|_)?time(-|_)?range=(.+)$/,
+           /^-?-?expander=(.+)$/
+        _ = $1.to_s.dup
+        _ = $3.to_s.dup if $3
+        unless Studium.respond_to? :expand_time_range
+          require 'studium/utility_scripts/expand_time_range.rb'
+        end
+        Studium.expand_time_range(_)
+      # ===================================================================== #
+      # === studium --generate-spreadsheet-for=indi3
+      #
+      # Another example:
+      #
+      #   studium --xls-for=indi3
+      #   xls3
+      #
+      # ===================================================================== #
+      when /^-?-?generate(_|-)?spreadsheet(_|-)?for=(.+)$/i, # === $3
+           /^-?-?xls(_|-)?for=(.+)$/i                        # === $2
+        require 'studium/utility_scripts/generate_spreadsheet.rb'
+        _ = $2.to_s.dup
+        _ = $3.to_s.dup if $3
+        Studium::GenerateSpreadsheet.new(_)
+      # ===================================================================== #
+      # === studium --use-this-curriculum=foo.md
+      # ===================================================================== #
+      when /^-?-?use(_|-)?this(_|-)?curriculum=(.+)$/i
+        require 'studium/lectures/show_lectures_on_the_commandline/show_lectures_on_the_commandline.rb'
+        _ = $3.to_s.dup
+        if File.exist? _
+          object = Studium::ShowLecturesOnTheCommandline.new { :do_not_run_yet }
+          dataset = File.readlines(_).reject {|line|
+            line.start_with?('#') or line.strip.empty?
+          }.map {|entry|
+            if entry.include?('#')
+              entry = entry[0 .. (entry.index('#')-1)]
+            end
+            entry.strip.squeeze(' ')
+          }
+          object.clear_old_dataset
+          object.add_to_the_dataset_without_any_further_checks(dataset)
+          object.sanitize_the_dataset
+          object.uniq_the_dataset
+          object.is_not_an_individual_curriculum
+          object.do_all_actions_after_the_main_dataset_was_read_in
+        else
+          e 'No file exists at '+sfile(_)+'.'
+        end
+      # ===================================================================== #
+      # === studium important_exams.yml
+      # ===================================================================== #
+      when /important(_|-)?exams\.?yml$/
+        target = ruby_src_dir_at_home?+'studium/lib/studium/yaml/important_exams.yml'
+        e sfile(target)
+        open_in_editor(target)
+      # ===================================================================== #
+      # === studium --version?
+      # ===================================================================== #
+      when /^-?-?version\??$/i
+        require 'studium/version/version.rb'
+        e sfancy(
+            Studium.return_version_and_last_update
+          )
+      # ===================================================================== #
+      # === studium --n-entries-in-the-file-lecture-information
+      # === studium --n-lectures
+      # ===================================================================== #
+      when /^-?-?n(_|-)?entries(_|-)?in(_|-)?the(_|-)?file(_|-)?lecture(_|-)?information\??$/i,
+           /^-?-?n(_|-)?entries\??$/i,
+           /^-?-?n(_|-)?lectures\??$/i,
+           /^-?-?n(_|-)?lectures(_|-)?registered$/i,
+           /^-?-?n(_|-)?registered(_|-)?lectures$/i,
+           /^-?-?n(_|-)?registered$/i
+        require 'studium/toplevel_methods/report_n_entries_in_the_file_lecture_information.rb'
+        Studium.report_n_entries_in_the_file_lecture_information
+      # ===================================================================== #
+      # === studium --open-top
+      # ===================================================================== #
+      when /^-?-?open(-|_)?top$/i,
+           /^-?-?open(-|_)?last$/i
+        require 'studium/exams/show_backlog_of_exams.rb'
+        Studium::ShowBacklogOfExams.open_the_main_file
+      # ===================================================================== #
+      # === studium --show-english-lectures
+      # === studium --show-german-lectures
+      # ===================================================================== #
+      when /^-?-?show(_|-)?(english)(_|-)?lectures$/,
+           /^-?-?show(_|-)?(german)(_|-)?lectures$/
+        require 'studium/utility_scripts/show_lectures_fitting_to_this_language.rb'
+        seek_lectures_for_this_language = $2.to_s.dup
+        ShowLecturesFittingToThisLanguage.new(seek_lectures_for_this_language)
+      # ===================================================================== #
+      # === studium --last-questions
+      # ===================================================================== #
+      when /^-?-?last(_|-)?questions$/i
+        require 'studium/log/store_last_question_asked_into_file.rb'
+        _ = Studium::Log::StoreLastQuestionAskedIntoFile.new {
+          :do_not_run_yet
+        }.return_path_to_the_file_all_exam_questions_asked
+        e File.read(_)
+      # ===================================================================== #
+      # === studium --files?
+      # === studium --show-important-files
+      # ===================================================================== #
+      when /^-?-?files\??$/i,
+           /^-?-?show(_|-)?important(_|-)?files\??$/i
+        require 'studium/toplevel_methods/show_important_files.rb'
+        ::Studium.show_important_files
+      # ===================================================================== #
+      # === studium --examstats
+      # ===================================================================== #
+      when /-?-?exam(_|-)?stats$/,
+           /-?-?exam(_|-)?statistics/,
+           /^-?-?statistics\??$/i,
+           /^-?-?statistik\??$/i,
+           /^-?-?stats$/i
+        require 'studium/toplevel_methods/show_exam_statistics.rb'
+        Studium.show_exam_statistics
+        exit
+      # ===================================================================== #
+      # === studium --exam_topics?
+      # ===================================================================== #
+      when /-?-?exam(_|-)?topics\??/
+        show_where_the_exam_topics_can_be_found
+      # ===================================================================== #
+      # === studium --generate-pdf-for=amg1
+      # === studium --pdf-for=pharma
+      # === studium --make-pdf-for=syszoo
+      # ===================================================================== #
+      when /^-?-?generate(-|_)?pdf(-|_)?for=(.+)$/i, # for $3
+           /^-?-?make(-|_)?pdf(-|_)?for=(.+)$/i,     # for $3
+           /^-?-?pdf(-|_)?for=(.+)$/i                # for $2
+        this_topic = $2.to_s.dup
+        this_topic = $3.to_s.dup if $3
+        Studium.create_pdf_file_for_this_exam_topic(this_topic) # bl $RUBY_STUDIUM/pdf/create_pdf_file_for_this_exam_topic.rb
+      # ===================================================================== #
+      # === studium --log-dir?
+      # ===================================================================== #
+      when /(_|-)?(_|-)?log(_|-)?dir\??/i
+        e
+        e "  #{sfile(FILE_LOG_DIR)}"
+        e
+      # ===================================================================== #
+      # === studium --statistics?
+      # ===================================================================== #
+      when /^-?-?statistics\??$/i,
+           /^-?-?stats\??$/i
+        require 'studium/curricula/determine_curricula/determine_curricula.rb'
+        Studium.determine_curricula
+      # ===================================================================== #
+      # === studium --open-statistics
+      # ===================================================================== #
+      when /^-?-?open(-|_)?the(-|_)?statistics$/,
+           /^-?-?open(-|_)?the(-|_)?statistics(-|_)?file$/,
+           /^-?-?open(-|_)?statistics$/,
+           /^-?-?open(-|_)?stats$/
+        open_the_statistics_file
+        exit
+      # ===================================================================== #
+      # === studium --n-topics-available?
+      # ===================================================================== #
+      when /^-?-?n(_|-)?topics(_|-)?available\??/,
+           /^-?-?n-?topics\??/
+        show_how_many_exam_topics_are_available
+      # ===================================================================== #
+      # === studium --max-per-topic?
+      # ===================================================================== #
+      when /^-?-?max(_|-)?per(_|-)?topic\??$/i,
+           /^-?-?max(_|-)?exams(_|-)?answered(_|-)?per(_|-)?topic\??$/i
+        show_max_exam_questions_answered_per_topic
+      # ===================================================================== #
+      # === studium --topics?
+      # ===================================================================== #
+      when /^-?-?topics\??$/i
+        show_available_topics
+      # ===================================================================== #
+      # === studium --max-ever
+      # ===================================================================== #
+      when /^-?-?max(-|_)?ever\??$/,
+           /^-?-?max(-|_)?answers\??$/,
+           /^-?-?max(-|_)?stats\??$/,
+           /^-?-?max(-|_)?statistics\??$/,
+           /^-?-?max(-|_)?questions(-|_)?answered\??$/, # studium --max-questions-answered
+           /^-?-?daily$/i
+        show_maximum_amount_of_questions_ever_answered
+        exit
+      # ===================================================================== #
+      # === studium --path-to-file-lecture-information
+      # ===================================================================== #
+      when /^-?-?path(-|_)?to(-|_)?file(-|_)?lecture(-|_)?information$/i
+        show_path_to_the_file_lecture_information
+      # ===================================================================== #
+      # === studium --open-timetable
+      # ===================================================================== #
+      when /-?-?open(-|_)?timetable$/i
+        open_timetable
+        exit
+      # ===================================================================== #
+      # === studium --upcoming_exams_at_the_boku
+      # ===================================================================== #
+      when /upcoming_?exams_?at_?the_?boku/
+        show_upcoming_exams_at_the_boku
+      # ===================================================================== #
+      # === studium --show_collage_of_current_exams
+      # ===================================================================== #
+      when /^-?-?show(_|-)?collage(_|-)?of(_|-)?current(_|-)?exams$/i
+        show_collage_of_current_exams
+      # ===================================================================== #
+      # === studium --open
+      # ===================================================================== #
+      when /^-?-?open$/i
+        open_useful_files_via_the_default_editor
+        exit
+      # ===================================================================== #
+      # === studium --base-dir?
+      # ===================================================================== #
+      when /^-?-?base(_|-)?dir\??/,
+           /^-?-?dir\??$/
+        show_the_base_dir
+      # ===================================================================== #
+      # === studium --ects-bachelor-master
+      # ===================================================================== #
+      when /^-?-?ects(_|-)?bachelor(_|-)?master$/,
+           /^-?-?bachelor(_|-)?master$/,
+           /^-?-?bm$/ # studium --bm
+        show_passed_ects_in_the_individual_bachelor_and_master_curricula
+      # ===================================================================== #
+      # === studium --check-the-lecture-information-file
+      # ===================================================================== #
+      when /-?-?check(-|_)?the(-|_)?lecture(-|_)?information(-|_)?file$/,
+           /-?-?check(-|_)?file(-|_)?information$/
+        check_the_lecture_information_file
+      # ===================================================================== #
+      # === studium --exams-at-the-meduni
+      # ===================================================================== #
+      when /(-|_)?(-|_)?exams(-|_)?at(-|_)?the(-|_)?(.+)$/
+        this_university = $6.to_s.dup.downcase
+        show_all_exams_at_this_university(this_university)
+      # ===================================================================== #
+      # === studium --best-month
+      # ===================================================================== #
+      when /^-?-?best-month$/,
+           /^-?-?best(_|-)?month(_|-)?stats$/,
+           /^-?-?show(_|-)?best(_|-)?months?$/,
+           /^-?-?best(_|-)?months?$/
+        show_best_month
+        exit
+      # ===================================================================== #
+      # === studium --max?
+      # ===================================================================== #
+      when /-?-?max\??$/,
+           /-?-?show(_|-)?how(_|-)?many(_|-)?exams(_|-)?were(_|-)?passed$/,
+           /^-?-?top$/i # ← This should always be on top of this file here.
+        show_how_many_exams_were_passed
+        exit
+      # ===================================================================== #
+      # === studium --n-ects-from-this-file=ECTS.md
+      # ===================================================================== #
+      when /^-?-?n(-|_)?ects(-|_)?from(-|_)?this(-|_)?file=(.+)$/i, # === $5
+           /^-?-?ects(-|_)?from=(.+)$/i # === $2
+        _ = $2.to_s.dup if $2
+        _ = $5.to_s.dup if $5
+        show_n_ects_from_this_file(_)
+      # ===================================================================== #
+      # === studium --audio-stats
+      # ===================================================================== #
+      when /^-?-?audio/
+        require 'studium/utility_scripts/audio_stats.rb'
+        Studium.audio_stats?
+      # ===================================================================== #
+      # === studium --sinatra
+      #
+      # This entry point starts the sinatra-part of the Studium project.
+      # ===================================================================== #
+      when /^-?-?sinatra$/
+        start_the_sinatra_interface
+        exit
+      # ===================================================================== #
+      # === studium --backlog-of-exams
+      # ===================================================================== #
+      when /^-?-?backlog(-|_)?of(-|_)?exams$/i
+        show_backlog_of_exams
+      # ===================================================================== #
+      # === studium --bachelor_curricula
+      # ===================================================================== #
+      when /^-?-?bachelor(-|_)?curricula$/i,
+           /^-?-?bachelor$/i
+        show_passed_lectures_in_a_bachelor_curriculum
+        exit
+      # ===================================================================== #
+      # === studium --disable-colours
+      # ===================================================================== #
+      when /^-?-?disable(_|-)?colours$/i,
+           /^-?-?permanently(_|-)?disable(_|-)?colours$/i
+        permanently_disable_colours
+      # ===================================================================== #
+      # === studium --average-grade
+      # ===================================================================== #
+      when /^-?-?average(-|_)?grade$/i
+        do_show_the_average_grade_of_all_passed_exams
+      # ===================================================================== #
+      # === studium --passed-ects-per-year
+      # ===================================================================== #
+      when /^-?-?passed(-|_)?ects(-|_)?per(-|_)?year$/i
+        show_passed_ects_per_year
+      # ===================================================================== #
+      # === studium --inskriptionsfrist
+      # ===================================================================== #
+      when /^-?-?inskriptionsfrist$/i
+        do_show_the_inscription_dates_at_the_different_universities
+      # ===================================================================== #
+      # === studium --master_curricula
+      # ===================================================================== #
+      when /^-?-?master(-|_)?curricula$/i,
+           /^-?-?master$/i
+        show_passed_lectures_in_a_master_curriculum
+        exit
+      # ===================================================================== #
+      # === studium --timetable
+      # ===================================================================== #
+      when /^-?-?timetable$/
+        show_timetable
+        exit
+      # ===================================================================== #
+      # === studium --set-editor=vim
+      # ===================================================================== #
+      when /^-?-?set(-|_)?editor=(.+)$/i
+        permanently_set_this_editor($2.to_s.dup)
+      # ===================================================================== #
+      # === studium --start
+      # ===================================================================== #
+      when /^-?-?start$/i
+        note_down_the_start_time_and_how_many_exams_have_been_already_solved
+      # ===================================================================== #
+      # === studium --curricula
+      # === studium --show-curricula
+      # ===================================================================== #
+      when /^-?-?curricula$/i,
+           /^-?-?show(-|_)?curricula$/i
+        show_curricula
+      # ===================================================================== #
+      # === studium --bachelor=vektorx
+      # ===================================================================== #
+      when /^-?-?bachelor(=|-)(.+)$/
+        require 'studium/lectures/show_lectures_on_the_commandline/show_lectures_on_the_commandline.rb'
+        this_curriculum = "bachelor-#{$2.to_s.dup}"
+        Studium::ShowLecturesOnTheCommandline.new(this_curriculum)
+      # ===================================================================== #
+      # === studium --questions-per-year
+      # ===================================================================== #
+      when /^-?-?questions(_|-)?per(_|-)?year$/
+        show_questions_per_year
+      # ===================================================================== #
+      # === studium --passed-ects
+      # ===================================================================== #
+      when /^-?-?passed(_|-)?ects\??$/i,
+           /^-?-?overview$/i,
+           /^-?-?performance$/i # studium --performance
+        show_passed_credits_per_curriculum
+      # ===================================================================== #
+      # === studium --universities
+      # ===================================================================== #
+      when /^-?-?universities$/i,
+           /^-?-?show(_|-)?ects(_|-)?passed(_|-)?per(_|-)?university$/i
+        show_ects_passed_per_university
+        exit
+      # ===================================================================== #
+      # === studium --yearly-average-grades
+      # ===================================================================== #
+      when /^-?-?yearly(_|-)?average(_|-)?grades$/,
+           /^-?-?grades$/i
+        show_yearly_average_grades
+        exit
+      # ===================================================================== #
+      # === studium --solved
+      # ===================================================================== #
+      when /^-?-?solved$/
+        require 'studium/exams/exams.rb'
+        _ = Studium::Exams::Solved.new(ARGV, :dont_run_yet)
+        _.set_commandline
+        _.run
+      # ===================================================================== #
+      # === studium --editor?
+      # ===================================================================== #
+      when /^-?-?editor\??$/i
+        e sfancy(Studium.editor?) 
+      # ===================================================================== #
+      # === studium --delay?
+      # ===================================================================== #
+      when /^-?-?delay\?/ # Query the delay in use.
+        require 'studium/toplevel_methods/read_delay_between_questions_from_file.rb'
+        e rev+
+          'The delay is '+lightgreen(
+            Studium::Exams.read_delay_from_file.to_s
+          )+
+          ' seconds between individual question-answer sessions.'
+      else # else tag
+        # =================================================================== #
+        # === Handle Pseudo-Regexes                               (regex tag)
+        #
+        # Handle pseudo-regexes next. These are strings that start
+        # and end with a '/' character.
+        # =================================================================== #
+        if i.start_with?('/') and i.end_with?('/')
+          e "A pseudo-regex was discovered (#{sfancy(i)}). We "\
+            "will next query for any"
+          e 'exam matching to that regex.'
+          e
+          use_this_regexp = Regexp.new(i.delete('/'), Regexp::IGNORECASE) # <- is case-insensitive.
+          Studium.try_to_report_exams_that_match_to_this_regexp(use_this_regexp) { :also_show_the_grade }
+        # =================================================================== #
+        # === Handle lecture types
+        #
+        # This entry point will handle input such as the following:
+        #
+        #   studium --VO
+        #   studium VO+SE
+        #
+        # =================================================================== #
+        elsif ARRAY_LECTURE_TYPES_THAT_ARE_MANDATORY_CONTINUOUS_ASSESSMENT.include?(i.delete('-')) or
+              (i.delete('-') == 'VO')
+          Studium.report_all_lectures_matching_this_lecture_type(i.delete('-'))
+        end
+      end
+    end
+  end
+
+end; end