studium 0.9.383

data/lib/studium/exams/show_backlog_of_exams.rb

@@ -0,0 +1,140 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ShowBacklogOfExams
+#
+# This class will simply show a back of the last some exams that we
+# have trained for. It's really just a tiny helper-class.
+#
+# Usage example:
+#
+#   Studium::ShowBacklogOfExams.new
+#
+# =========================================================================== #
+# require 'studium/exams/show_backlog_of_exams.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+require 'studium/toplevel_methods/return_n_percent_solved_from_this_topic.rb'
+require 'studium/toplevel_methods/is_on_roebe.rb'
+
+module Studium
+
+class ShowBacklogOfExams < Base # === Studium::ShowBacklogOfExams.new
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @show_the_percentage_value_of_n_questions_answered
+    #
+    # If the next instance variable is set to true then we will also
+    # display a percentage value of the questions answered.
+    # ======================================================================= #
+    @show_the_percentage_value_of_n_questions_answered = true
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_commandline_arguments(i = '')
+    i = [i].flatten.compact
+    @commandline_arguments = i
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments?
+  # ========================================================================= #
+  def commandline_arguments?
+    @commandline_arguments
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report(i)
+    e
+    i.each_with_index {|entry, index| index += 1
+      entry = ensure_main_encoding(entry)
+      result = slateblue(" #{entry.ljust(23)}")
+      if Studium.is_this_exam_topic_registered?(entry)
+        if @show_the_percentage_value_of_n_questions_answered
+          percentage_value = Studium.return_n_percent_solved_from_this_topic(entry).to_s
+          percentage_value = '%.2f' % percentage_value
+          percentage_value = percentage_value.to_s.rjust(6)
+          result << royalblue("#{percentage_value}%")
+        end
+      else
+        opnn; e crimson('Not registered topic `')+orange(entry)+crimson('`.')
+      end
+      # ===================================================================== #
+      # Pad the index a bit from the left-hand side:
+      # ===================================================================== #
+      left_padded_index = (index.to_s+')').rjust(4)
+      e "#{steelblue(left_padded_index)}#{result}"
+    }
+    e
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    rename_kde_konsole_tab('top')
+    array = YAML.load_file(FILE_BACKLOG_OF_EXAMS)
+    report(array)
+  end
+
+  # ========================================================================= #
+  # === Studium::ShowBacklogOfExams[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+  # ========================================================================= #
+  # === Studium::ShowBacklogOfExams.open_the_main_file
+  #
+  # To invoke this method properly, you can try this on the commandline:
+  #
+  #   studium --open-top
+  #
+  # ========================================================================= #
+  def self.open_the_main_file
+    _ = FILE_BACKLOG_OF_EXAMS
+    if Studium.is_on_roebe?
+      _ = RUBY_STUDIUM_HOME_DIR+'yaml/'+File.basename(_)
+    end
+    open_in_editor(_)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ShowBacklogOfExams.new(ARGV)
+end # show_backlog_of_exams

data/lib/studium/exams/show_next_exams_for.rb

@@ -0,0 +1,140 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ShowNextExamsFor
+#
+# This class will show all upcoming exams but only for ONE given
+# lecture at hand. Thus it is somewhat different to classes
+# such as class UpcomingExamsAtTheBoku.
+#
+# Usage example:
+#   Studium::ShowNextExamsFor.new
+# =========================================================================== #
+# require 'studium/exams/show_next_exams_for.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+require 'studium/exams/next_exams.rb'
+require 'studium/toplevel_methods/return_lva_number_of_this_lecture.rb'
+
+module Studium
+
+class ShowNextExamsFor < Base # === Studium::ShowNextExamsFor.new
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end; alias title_of_the_lecture? input? # === title_of_the_lecture?
+
+  # ========================================================================= #
+  # === determine_the_lva_number
+  #
+  # This method will determine the @lva_number of the lecture in question.
+  #
+  # Note that this is, of course, specific to the university at hand.
+  # ========================================================================= #
+  def determine_the_lva_number(i = input?)
+    @lva_number = ::Studium.return_lva_number_of_this_lecture(i)
+  end
+
+  # ========================================================================= #
+  # === notify_the_user_what_we_will_do
+  # ========================================================================= #
+  def notify_the_user_what_we_will_do
+    opnn; e 'We will show all upcoming exams for `'+sfancy(input?)+'`.'
+  end
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn
+    super(NAMESPACE)
+  end
+
+  # ========================================================================= #
+  # === []
+  # ========================================================================= #
+  def self.[](i = '')
+    self.new(i)
+  end
+
+  # ========================================================================= #
+  # === report_the_upcoming_exams
+  # ========================================================================= #
+  def report_the_upcoming_exams
+    _ = @upcoming_exams
+    if _.empty?
+      e 'No exam appears to be upcoming for `'+sfancy(input?)+'`.'
+    else # Yup, we found some entries here.
+      e
+      e 'These exams are upcoming for `'+sfancy(input?)+'`:'
+      e
+      _.each_pair {|datum, uhrzeit|
+        e '  '+orange(datum)+' '+lightblue(uhrzeit)
+      }; e
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    notify_the_user_what_we_will_do
+    determine_the_lva_number
+    # ======================================================================= #
+    # For now we will assume that the lecture will be held at the BOKU only.
+    # ======================================================================= #
+    remote_url = sanitize_url(title_of_the_lecture?)
+    remote_url = remote_url.first if remote_url.is_a? Array
+    remote_url =~ /pStpSpNr=(\d+)/
+    exam_dates_remote_url =
+      'https://online.boku.ac.at/BOKUonline/wbExamOffer.wbExamsOfCourse?pCourseNr='+$1.to_s+'&pStDegreeProgNr=&pCsNodeNr='
+    e "Now working on #{orange(title_of_the_lecture?)} - showing relevant "\
+      "URLs for this lecture:"
+    e "  #{lightblue(remote_url)}"
+    e "  #{lightgreen(exam_dates_remote_url)}"
+    @upcoming_exams = ::Studium.obtain_upcoming_exams_from_this_remote_url(exam_dates_remote_url)
+    report_the_upcoming_exams
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ShowNextExamsFor.new(ARGV)
+end # show_next_exams_for Tierzucht
+    # show_next_exams_for "Bodenkunde (AW)"

data/lib/studium/exams/show_themes/constants.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/exams/show_themes/constants.rb'
+# =========================================================================== #
+module Studium
+
+module Exams
+
+class ShowThemes < Base # === Studium::Exams::ShowThemes
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === SHOW_NAMESPACE_IN_HELP_SECTION
+  #
+  # If this constant is true, then we will show the namespace in the
+  # help section of this class.
+  # ========================================================================= #
+  SHOW_NAMESPACE_IN_HELP_SECTION = false
+ 
+  # ========================================================================= #
+  # === PAD_TO_THE_RIGHT_FOR_INDIVIDUAL_ECTS_POINTS
+  #
+  # How much to pad, via ' ', to the right side.
+  # ========================================================================= #
+  PAD_TO_THE_RIGHT_FOR_INDIVIDUAL_ECTS_POINTS = 72
+
+end; end; end

data/lib/studium/exams/show_themes/menu.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/exams/show_themes/menu.rb'
+# =========================================================================== #
+module Studium
+
+module Exams
+
+class ShowThemes < Base # === Studium::Exams::ShowThemes
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments_with_hyphens?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # =================================================================== #
+      # === showthemes --highest
+      # =================================================================== #
+      when /^-?-?biggest/,
+           /^-?-?highest/, # Invoke this like so: themes cellbiology --highest
+           /^-?-?sort(-|_)?by(-|_)?ects/
+        @sort_how = :highest_ects_first
+      # =================================================================== #
+      # === showthemes --help
+      # =================================================================== #
+      when /^-?-?help$/i,
+           /^-?-?show(-|_)?help$/i
+        show_help(:then_exit)
+      # =================================================================== #
+      # === showthemes --open
+      # =================================================================== #
+      when /^-?-?open$/i
+        open_csv_file
+        exit
+      # =================================================================== #
+      # === showthemes --available_themes?
+      # =================================================================== #
+      when /-?-?available(_|-)?themes\??/,
+           /-?-?athemes?/,
+           /-?-?available/,
+           /-?-?overview/
+        show_available_themes
+        exit
+      end
+    end    
+  end
+
+end; end; end

data/lib/studium/exams/show_themes/reset.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/exams/show_themes/reset.rb'
+# =========================================================================== #
+module Studium
+
+module Exams
+
+class ShowThemes < Base # === Studium::Exams::ShowThemes
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @left_padding_to_use
+    # ======================================================================= #
+    @left_padding_to_use = ' '
+    # ======================================================================= #
+    # === @allowed_themes_for_exams
+    # ======================================================================= #
+    @allowed_themes_for_exams = YAML.load_file(Studium.file_allowed_themes_for_exams).map {|line|
+      line.tr(' ','_')
+    }
+    # ======================================================================= #
+    # === @dataset_from_file_lecture_information
+    # ======================================================================= #
+    @dataset_from_file_lecture_information = return_dataset_from_file_lecture_information
+    # ======================================================================= #
+    # === @dataset
+    #
+    # This variable will contain our actual dataset that is ready for
+    # display.
+    # ======================================================================= #
+    @dataset = nil
+    # ======================================================================= #
+    # === @sort_how
+    #
+    # How to sort the dataset by default.
+    #
+    # A value of nil means that this class will not do any special
+    # sorting whatsoever.
+    # ======================================================================= #
+    @sort_how = :alphabetically
+    # ======================================================================= #
+    # === @average_grade
+    #
+    # This variable will keep track of the average grade.
+    # ======================================================================= #
+    @average_grade = []
+  end
+
+end; end; end

data/lib/studium/exams/show_themes/show_themes.rb

@@ -0,0 +1,527 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::ShowThemes
+#
+# This class can show exam-themes, that is, lectures that belong to
+# a particular theme.
+#
+# Usage example:
+#
+#   Studium::Exams::ShowThemes.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/exams/show_themes/show_themes.rb'
+# Studium::Exams::ShowThemes.new(ARGV)
+# =========================================================================== #
+require 'studium/base/base.rb'
+require 'studium/exams/show_themes/constants.rb'
+require 'studium/exams/show_themes/menu.rb'
+require 'studium/exams/show_themes/reset.rb'
+
+module Studium
+
+module Exams
+
+class ShowThemes < Base # === Studium::Exams::ShowThemes
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    register_sigint
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === search_for_this_theme?
+  # ========================================================================= #
+  def search_for_this_theme?
+    @search_for_this_theme
+  end; alias search_which_theme?     search_for_this_theme? # === search_which_theme?
+       alias search_term?            search_for_this_theme? # === search_theme?
+       alias search_for_which_theme? search_for_this_theme? # === search_for_which_theme?
+       alias which_theme?            search_for_this_theme? # === which_theme?
+       alias which_topic?            search_for_this_theme? # === which_topic?
+
+  # ========================================================================= #
+  # === dataset?
+  # ========================================================================= #
+  def dataset?
+    @dataset
+  end; alias dataset dataset? # === dataset
+
+  # ========================================================================= #
+  # === obtain_the_dataset_holding_matching_lectures_to_the_given_theme
+  #
+  # This method will obtain the dataset that holds all matching
+  # lectures to the given theme at hand.
+  # ========================================================================= #
+  def obtain_the_dataset_holding_matching_lectures_to_the_given_theme(
+      _ = search_for_which_theme?
+    )
+    @dataset = @dataset_from_file_lecture_information.select {|name, inner_hash|
+      themes = inner_hash['themes']
+      # =================================================================== #
+      # Note that "themes" will be an Array.
+      # =================================================================== #
+      ensure_that_the_themes_of_this_course_are_all_valid_or_exit(themes)
+      if themes and themes.include?(_)
+        true
+      else
+        false
+      end
+    }
+    if @dataset.empty?
+      report_no_result_was_found
+    end
+  end
+
+  # ========================================================================= #
+  # === ensure_that_the_themes_of_this_course_are_all_valid_or_exit
+  # ========================================================================= #
+  def ensure_that_the_themes_of_this_course_are_all_valid_or_exit(i)
+    if i.nil?
+      return
+    end
+    if i.all? {|line|
+        @allowed_themes_for_exams.include? line.tr(' ','_')
+      }
+    else
+      # =================================================================== #
+      # Ok we found at the least one faulty or missing entry. We must
+      # determine this entry and then notify the user about it. However
+      # had, we will only notify the user, but otherwise continue to
+      # work.
+      # =================================================================== #
+      not_included_entries = i.select {|inner_entry|
+        !@allowed_themes_for_exams.include? inner_entry
+      }
+      not_included_entries.each {|this_entry_is_not_included|
+        opnn; e "Note that the entry #{swarn(this_entry_is_not_included)}"\
+                " is not included in the"
+        opnn; e "file `#{sfile(Studium.file_allowed_themes_for_exams)}`."
+        opnn; e 'This should be remedied - please ensure that it '\
+                'is a'
+        opnn; e 'valid entry before adding it to that file.'
+      }
+      # exit unless not_included_entries.empty?
+      # ^^^ The above can be re-enabled.
+    end
+  end
+
+  # ========================================================================= #
+  # === report_that_the_dataset_is_empty
+  # ========================================================================= #
+  def report_that_the_dataset_is_empty
+    e "#{ropnn}#{rev}The dataset is empty. Please supply at "\
+      "the least one topic."
+  end
+
+  # ========================================================================= #
+  # === set_search_for_this_theme
+  # ========================================================================= #
+  def set_search_for_this_theme(i)
+    if i.nil? or i.empty?
+      report_that_the_dataset_is_empty
+      exit
+    end
+    if i.is_a? Array
+      if i.empty?
+        i = :display_all_themes
+      else
+        i = i.join(' ').strip
+      end
+    end
+    # ======================================================================= #
+    # Replace all ' ' with '_' characters next.
+    # ======================================================================= #
+    if i.is_a? String
+      i = i.dup if i.frozen?
+      i.tr!(' ','_')
+    end
+    case i
+    when :display_all_themes
+      i = return_available_topics
+    end
+    unless i.start_with? '--'
+      if i.is_a? Array
+        i = i.map {|entry| sanitize_this_topic(entry) }
+      else
+        i = sanitize_this_topic(i)
+      end
+    end
+    @search_for_this_theme = i
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report(
+      this_dataset = @dataset
+    )
+    @n_ects_completed = 0
+    index = 0
+    string = "#{N}#{ropnn}#{rev}Showing all matches fitting to ".dup
+    string << rev+'the theme '+steelblue(which_theme?)+':'+N+N
+    e string
+    e
+    if File.exist? FILE_PASSED_EXAMS_PER_MONTH
+      passed_exams_dataset = File.readlines(
+        FILE_PASSED_EXAMS_PER_MONTH
+      ).reject {|line|
+        line.strip.empty? or
+        line.strip.start_with?('#')
+      }
+    else
+      passed_exams_dataset = nil
+    end
+    this_dataset.each {|name, inner_hash| index += 1
+      padded_index = ("#{index}) ").rjust(5)
+      lecture_type = inner_hash[:type].to_s
+      n_ects       = inner_hash[:ects].to_s
+      already_solved = inner_hash[:already_solved]
+      if already_solved
+        grade = inner_hash[:grade]
+        unless grade == '+'
+          @average_grade << grade
+          @n_ects_completed += n_ects.to_f
+        end
+      end
+      # ===================================================================== #
+      # Determine next whether it is a Bachelor, Master or
+      # Diploma lecture.
+      # ===================================================================== #
+      bachelor_or_master_or_diploma = bachelor_master_or_diploma(
+        name, passed_exams_dataset
+      )
+      # ===================================================================== #
+      # Cap too-long names next:
+      # ===================================================================== #
+      if name.size > 68
+        name = name[0..68]
+      end
+      # ===================================================================== #
+      # Expand the type next:
+      # ===================================================================== #
+      case bachelor_or_master_or_diploma # case tag
+      when 'B/D'
+        bachelor_or_master_or_diploma = 'Bachelor/Diplom'
+      when 'B/M'
+        bachelor_or_master_or_diploma = 'Bachelor/Master'
+      when 'B'
+        bachelor_or_master_or_diploma = 'Bachelor'
+      when 'M'
+        bachelor_or_master_or_diploma = 'Master'
+      when 'D'
+        bachelor_or_master_or_diploma = 'Diplomstudium'
+      when '(unknown)'
+        bachelor_or_master_or_diploma = ''
+      end
+      bachelor_or_master_or_diploma = (
+        "[#{bachelor_or_master_or_diploma.center(17)}]"
+      )
+      # ===================================================================== #
+      # Re-format the ECTS points.
+      # ===================================================================== #
+      n_ects_points = " [#{n_ects.to_s.rjust(4)} ECTS]"
+      # ===================================================================== #
+      # Finally display it here.
+      # ===================================================================== #
+      e @left_padding_to_use+
+        darkseagreen(padded_index)+
+        steelblue(
+          name.strip.ljust(
+            PAD_TO_THE_RIGHT_FOR_INDIVIDUAL_ECTS_POINTS
+          )
+        )+
+        chocolate("[#{lecture_type}] ")+
+        colourize_ects(
+          n_ects_points
+        )+' '+
+        slateblue(bachelor_or_master_or_diploma)+ # ← Bachelor or Master or Diploma
+        N
+    }
+    report_how_many_ECTS_points_were_completed
+    # ======================================================================= #
+    # Report the average grade next: 
+    # ======================================================================= #
+    report_the_average_grade
+  end
+
+  # ========================================================================= #
+  # === report_how_many_ECTS_points_were_completed
+  # ========================================================================= #
+  def report_how_many_ECTS_points_were_completed
+    n_ects_completed = (
+      'Total ECTS points: '+
+      @n_ects_completed.to_s
+    ).ljust(25)
+    n_ects_completed = n_ects_completed.rjust(
+      PAD_TO_THE_RIGHT_FOR_INDIVIDUAL_ECTS_POINTS + 15
+    )+N
+    n_ects_completed.rstrip!
+    formatted_n_ects_completed = n_ects_completed
+    e formatted_n_ects_completed.sub(
+      /(Total ECTS points: )/,
+      orange('ECTS points completed: ')
+    ).sub(
+      /(\d{0,3}\.\d{0,1})/, colourize_ects('\1')
+    )
+  end
+
+  # ========================================================================= #
+  # === colourize_ects
+  # ========================================================================= #
+  def colourize_ects(i)
+    palevioletred(i)
+  end
+
+  # ========================================================================= #
+  # === report_the_average_grade
+  # ========================================================================= #
+  def report_the_average_grade
+    formatted_average_grade = (
+      @average_grade.sum / @average_grade.size.to_f
+    ).round(2).to_s
+    e
+    e 'The average grade among the '+
+      royalblue(@average_grade.size.to_s)+
+      ' passed exams for the topic '+
+      tomato(which_topic?)+' is: '+
+      steelblue(formatted_average_grade)
+    e
+  end
+
+  # ========================================================================= #
+  # === open_csv_file
+  #
+  # The first argument should be the path to the .csv file in question.
+  # ========================================================================= #
+  def open_csv_file(
+      i = csv_file?
+    )
+    open_in_editor(i)
+  end
+
+  # ========================================================================= #
+  # === return_available_topics
+  #
+  # This method will return all the available topics, in Array format.
+  # ========================================================================= #
+  def return_available_topics
+    hash = @dataset_from_file_lecture_information.values # .flatten.sort.uniq
+    result = hash.select {|key, value|
+      themes = key['themes']
+      if themes
+        true
+      else
+        false
+      end
+    }.map {|entry| entry['themes'] }.flatten.sort.uniq
+    return result
+  end
+
+  # ========================================================================= #
+  # === show_available_themes
+  #
+  # This method will show which themes are available, e. g. "cellbiology"
+  # and "genetics" and so on. The resulting Array will be sorted
+  # and output alphabetically.
+  #
+  # Invocation example:
+  #
+  #   showthemes --available?
+  #
+  # ========================================================================= #
+  def show_available_themes
+    _ = return_available_topics # Obtain the available topics.
+    e "#{ropnn}These #{sfancy(_.size.to_s)} themes are available:#{N}"
+    _.each {|topic|
+      e "  #{simp(topic)}#{N}"
+    }
+  end
+
+  # ========================================================================= #
+  # === return_opnn
+  # ========================================================================= #
+  def return_opnn
+    ::Colours::GREY+NAMESPACE+': '+::Colours::REVERT
+  end; alias ropnn return_opnn # === ropnn
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  #
+  # To invoke this method from the commandline, do:
+  #
+  #   themes --show-help
+  #
+  # For some more specific examples:
+  #
+  #   showexamthemes --available_themes?
+  #
+  # ========================================================================= #
+  def show_help(
+      optional_shall_we_also_exit = false
+    )
+    case optional_shall_we_also_exit
+    when true
+      optional_shall_we_also_exit = true
+    end
+    e
+    opnn
+    e
+    e
+    opnn_in_helpsection; e '  --available_themes? # Show an overview over all '\
+                           'available/registered themes'
+    opnn_in_helpsection; e '  --open              # Open the .csv file in your editor'
+    opnn_in_helpsection; e '  --bioinformatics    # Show all bioinformatics-related lectures.'
+    opnn_in_helpsection; e '  --cellbiology       # Show all cellbiology-related lectures.'
+    opnn_in_helpsection; e '  --genetics          # Show all genetics-related lectures.'
+    opnn_in_helpsection; e '  --highest           # Show highest entry (= most ECTS) first'
+    e
+    exit if optional_shall_we_also_exit
+  end
+
+  # ========================================================================= #
+  # === report_no_result_was_found
+  #
+  # The opn() that is normally used, becomes a String in this method,
+  # returned by a call to the method called return_opnn().
+  # ========================================================================= #
+  def report_no_result_was_found
+    e "#{return_opnn}#{rev}Not found any result for #{steelblue(search_term?)}."\
+      " Pass in #{sfancy('--help')} or #{sfancy('--available?')} for#{N}"
+    e "#{return_opnn}#{rev}how to use this class.#{N}"
+    e "#{return_opnn}#{rev}If you wish to add an alias, modify "\
+      "the method#{N}"
+    e "#{return_opnn}#{rev}#{yellow('sanitize_this_topic()')}."
+  end
+
+  # ========================================================================= #
+  # === opnn_in_helpsection
+  # ========================================================================= #
+  def opnn_in_helpsection
+    opnn if SHOW_NAMESPACE_IN_HELP_SECTION
+  end
+
+  # ========================================================================= #
+  # === check_whether_the_passed_theme_is_an_allowed_theme
+  #
+  # This method will check whether the given input at hand is a
+  # valid exam-theme.
+  #
+  # Invalid entries will be reported at once, so that the user has
+  # to correct them.
+  #
+  # We wish for our dataset to be correct at all times.
+  # ========================================================================= #
+  def check_whether_the_passed_theme_is_an_allowed_theme(
+      _ = search_which_theme?
+    )
+    if _
+      dataset = @allowed_themes_for_exams
+      if dataset.include? _
+        # In this case all is fine.
+      elsif _.start_with?('--') # These are exempt.
+      else
+        opnn; e 'No theme was found matching to `'+steelblue(_)+'`.'
+        report_no_result_was_found
+        exit
+      end
+    end
+  end
+
+  require 'studium/toplevel_methods/sanitize_this_theme_topic.rb'
+  # ========================================================================= #
+  # === sanitize_this_topic                         (sanitize tag, alias tag)
+  #
+  # This entry keeps all possible aliases to commonly used topics, in
+  # particular abbreviations.
+  # ========================================================================= #
+  def sanitize_this_topic(this_topic)
+    Studium.sanitize_this_theme_topic(this_topic)
+  end
+
+  # ========================================================================= #
+  # === consider_sorting_the_dataset                               (sort tag)
+  # ========================================================================= #
+  def consider_sorting_the_dataset
+    if @sort_how
+      case @sort_how
+      # ===================================================================== #
+      # === :default
+      #
+      # This defaults to alphabetical sorting.
+      # ===================================================================== #
+      when :default,
+           :alphabetically
+        # =================================================================== #
+        # Each key may look like this:
+        #
+        #   840.007 Einführung in die Biostatistik
+        #
+        # =================================================================== #
+        sorted = @dataset.sort_by {|name, inner_hash|
+          if name.include? ' '
+            name = name.split(' ')[1]
+          end
+          name
+        }
+        @dataset = Hash[sorted] # Turn it into a Hash again.
+      # ===================================================================== #
+      # === :highest_ects_first
+      # ===================================================================== #
+      when :highest_ects_first
+        sorted = @dataset.sort_by {|name, inner_hash|
+          inner_hash[:ects]
+        }.reverse
+        @dataset = Hash[sorted]
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    set_search_for_this_theme(first_argument?)
+    check_whether_the_passed_theme_is_an_allowed_theme
+    menu
+    obtain_the_dataset_holding_matching_lectures_to_the_given_theme
+    consider_sorting_the_dataset
+    report
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams::ShowThemes[]
+  #
+  # Simpler initializer for the class.
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+# =========================================================================== #
+# === Studium.report_passed_exams_fitting_to_this_theme
+# =========================================================================== #
+def self.report_passed_exams_fitting_to_this_theme(i = 'genetics')
+  Studium::Exams::ShowThemes.new(i)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  # Studium::Exams::ShowThemes.new(ARGV)
+  Studium.report_passed_exams_fitting_to_this_theme(ARGV)
+end # showthemes biochemistry