studium 0.16.9

data/lib/studium/toplevel_methods/registered_for_this_exam.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/registered_for_this_exam.rb'
+# Studium.are_we_for_this_exam?
+# =========================================================================== #
+module Studium
+
+  require 'studium/requires/require_encoding.rb'
+  require 'studium/toplevel_methods/e.rb'
+  require 'studium/toplevel_methods/main_dataset.rb'
+  require 'studium/toplevel_methods/return_sanitized_dataset_from_the_file_lecture_information.rb'
+
+  # ========================================================================= #
+  # === Studium.registered_for_this_exam?
+  #
+  # This method will return true or false, depending as to whether we
+  # have registered for that particular exam or whether we have not.
+  #
+  # The lecture-id has to be passed into this Array as well.
+  #
+  # Usage examples:
+  #
+  #   Studium.registered_for_this_exam?("892104 Physik (LBT)") # => false
+  #   Studium.registered_for_this_exam?("163.107 Anorganische Chemie für VT") # => true
+  #
+  # ========================================================================= #
+  def self.registered_for_this_exam?(
+      this_exam,
+      dataset = ::Studium.main_dataset?
+    )
+    if this_exam.is_a? Array
+      this_exam.each {|entry| registered_for_this_exam?(entry) }
+    else
+      this_exam = this_exam.dup if this_exam.frozen?
+      # ===================================================================== #
+      # We will either obtain a new, fresh dataset - or re-use the existing 
+      # dataset assigned to an module-level instance variable.
+      # ===================================================================== #
+      if dataset.nil?
+        dataset = Studium.return_sanitized_dataset_from_the_file_lecture_information
+        # =================================================================== #
+        # And also assign it, in this case.
+        # =================================================================== #
+        ::Studium.set_main_dataset(dataset)
+      end
+      # ===================================================================== #
+      # Now that we have the dataset, attempt to obtain the corresponding
+      # entry.
+      # ===================================================================== #
+      # this_exam = ensure_main_encoding(this_exam)
+      # ===================================================================== #
+      # Get rid of german weeknames, just in case:
+      # ===================================================================== #
+      ARRAY_GERMAN_WEEKDAYS.each {|this_german_weekday|
+        this_exam.sub!(
+          /#{this_german_weekday}/,
+          ''
+        ) if this_exam.include?(this_german_weekday)
+      }
+      this_exam.strip!
+      if dataset.has_key? this_exam
+        pointer = dataset[this_exam]
+        pointer.has_key? 'registered'
+      else
+        e "No key registered for `#{this_exam}`."
+      end
+    end
+  end; self.instance_eval { alias registered_for_this_exam         registered_for_this_exam? } # === Studium.registered_for_this_exam
+       self.instance_eval { alias are_we_registered_for_this_exam? registered_for_this_exam? } # === Studium.are_we_registered_for_this_exam?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  if ARGV.empty?
+    e Studium.registered_for_this_exam?('320075 Pharmazeutische Bioanalytik')
+  else
+    e Studium.registered_for_this_exam?(ARGV.join(' ').strip)
+  end  
+end # registeredforthisexam
+    # registeredforthisexam "892104 Physik (LBT)"

data/lib/studium/toplevel_methods/remove_comments.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/remove_comments.rb'
+# =========================================================================== #
+module Studium
+
+  # ========================================================================= #
+  # === Studium.remove_comments
+  #
+  # This method will simply remove '#' comments from the input string. It
+  # was mostly thought of as a trivial convenience method.
+  # ========================================================================= #
+  def self.remove_comments(i)
+    if i.is_a? Array
+      i = i.join("\n")
+    end
+    return i.delete('#')
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  e Studium.remove_comments(ARGV)
+end # studiumremovecomments

data/lib/studium/toplevel_methods/remove_exam_topics_that_were_already_answered.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/remove_exam_topics_that_were_already_answered.rb'
+# Studium.remove_exam_topics_that_were_already_answered()
+# =========================================================================== #
+module Studium
+
+  require 'studium/toplevel_methods/return_n_questions_were_answered_for_this_topic.rb'
+
+  # ========================================================================= #
+  # === Studium.remove_exam_topics_that_were_already_answered
+  # ========================================================================= #
+  def self.remove_exam_topics_that_were_already_answered(i)
+    if i.is_a? Array
+      i.reject! {|entry|
+        n_answers = ::Studium::Exams.return_n_questions_in_this_topic(
+          entry, :also_return_n_answers
+        )
+        n_answers[0] == n_answers[1]
+      }
+    end
+    return i
+  end
+
+end

data/lib/studium/toplevel_methods/remove_tags.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/remove_tags.rb'
+# =========================================================================== #
+module Studium
+
+  # ========================================================================= #
+  # === Studium.remove_tags_from_this_input
+  # ========================================================================= #
+  def self.remove_tags_from_this_input(i = '')
+    i = i.first if i.is_a? Array
+    if i
+      begin
+        return i.gsub(/<\/?[^>]*>/, '')
+      rescue ArgumentError
+        return i
+      end
+    end
+    return i
+  end; self.instance_eval { alias remove_tags           remove_tags_from_this_input } # === Studium.remove_tags
+       self.instance_eval { alias remove_html_tags_from remove_tags_from_this_input } # === Studium.remove_html_tags_from
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  #_ = 'Ein <one>NH</one>-<two>Molekül</two>. Eine -NH₂ Gruppe wird entfernt, ein H wird jedoch an ein anderes N Atom angelagert.'
+  _ = 'To <one>activate translation of proteins</one>.'
+  e 'Comparing the size - if it is not the same then the'
+  e 'method Studium.remove_tags_from_this_input() worked.'
+  e _.size
+  e Studium.remove_tags_from_this_input(_).size
+end # rb remove_tags.rb

data/lib/studium/toplevel_methods/report.rb

@@ -0,0 +1,439 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Report-related functionality that exists on the toplevel will be stored
+# here in this file. All report-related activities, such as reporting how
+# many exams were already solved from the whole given dataset at hand.
+# =========================================================================== #
+# require 'studium/toplevel_methods/report.rb'
+# Studium::Exams.report_how_many_exam_questions_were_already_solved
+# Studium.return_n_questions_solved_in_total
+# =========================================================================== #
+module Studium
+
+module Exams # === Studium::Exams
+
+  require 'studium/colours/colours.rb'
+  require 'studium/constants/constants.rb'
+  require 'studium/exams/dataset/dataset.rb'
+  require 'studium/toplevel_methods/available_topics.rb'
+  require 'studium/toplevel_methods/e.rb'
+  require 'studium/toplevel_methods/find_exam_topic_and_exam_title.rb'
+  require 'studium/toplevel_methods/filter_away_invalid_questions.rb'
+  require 'studium/toplevel_methods/methods_related_to_files_and_directories.rb'
+  require 'studium/toplevel_methods/return_sanitized_dataset_from_the_file_lecture_information.rb'
+  require 'studium/toplevel_methods/time.rb'
+  require 'studium/toplevel_methods/write_into_file_related_functionality.rb'
+  require 'studium/logging/ensure_that_the_log_directory_exists.rb'
+
+  extend Studium::Colours
+
+  # ========================================================================= #
+  # === Studium::Exams.return_n_questions_in_this_topic
+  #
+  # This method will return a number (Integer) that tells us how many
+  # questions are part of the given topic at hand.
+  #
+  # If the optional second argument is set to true, then we will
+  # also keep track of how many of these questions have been
+  # answered. The last entry then tells us how many of these
+  # questions have been answered already.
+  #
+  # The second argument can be used to also return how many questons
+  # were answered as of yet.
+  #
+  # Invocation examples:
+  #
+  #   Studium::Exams.return_n_questions_in_this_topic 'amg1' # => 1000
+  #   Studium::Exams.return_n_questions_in_this_topic "advanced_biotechnology" # => 94
+  #
+  # ========================================================================= #
+  def self.return_n_questions_in_this_topic(
+      topic, also_return_n_answers = false
+    )
+    case also_return_n_answers
+    when :also_return_n_answers
+      also_return_n_answers = true
+    end
+    return_value = 0
+    topic = ::Studium.find_corresponding_exam_topic(topic)
+    path  = "#{::Studium.directory_to_the_exam_topics?}#{topic}"
+    # ======================================================================= #
+    # Ok, now we have the path, we can find out how many questions
+    # are registered there.
+    # ======================================================================= #
+    if File.exist? path
+      dataset = ::Studium.default_readlines(path)
+      dataset = ::Studium.filter_away_invalid_questions(dataset)
+      return_value = dataset.size
+      n_answers = dataset.count {|line| line.chomp.end_with? ' []' }
+    end
+    if also_return_n_answers
+      return [return_value, n_answers]
+    else
+      return return_value
+    end
+  end; self.instance_eval { alias n_exam_questions_in_this_topic return_n_questions_in_this_topic } # === Studium::Exams.n_exam_questions_in_this_topic
+
+  # ========================================================================= #
+  # === Studium::Exams.return_n_exam_questions_were_already_solved
+  # ========================================================================= #
+  def self.return_n_exam_questions_were_already_solved
+    # ======================================================================= #
+    # Determine the questions that are available, in total:
+    # ======================================================================= #
+    dataset = ::Studium::Exams::Dataset[].select {|entry|
+      entry.end_with?("[]\n")
+    }
+    n_total_answers   = dataset.size
+    return n_total_answers
+  end
+
+  # ========================================================================= #
+  # === Studium.report_all_lectures_matching_this_lecture_type
+  # ========================================================================= #
+  def self.report_all_lectures_matching_this_lecture_type(i)
+    if i.is_a? Array
+      i.each {|entry| report_all_lectures_matching_this_lecture_type(entry) }
+    else
+      dataset = Studium.dataset_from_file_lecture_information
+      selection = dataset.select {|name, inner_hash|
+        type = inner_hash[:type]
+        type == i
+      }
+      if selection.empty?
+        e "No lectures match towards #{i}."
+      else
+        e
+        e Colours.rev+
+          'The following '+
+          +Studium::Colours.sfancy(selection.keys.size.to_s)+
+          ' entries match towards the lecture type '+
+           Studium::Colours.sfancy(i)+':'
+        e
+        selection.each_pair  {|name, inner_hash|
+          # ================================================================= #
+          # Report these entries next:
+          # ================================================================= #
+          e "  #{name.ljust(20)}"
+        }; e
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams.report_how_many_exam_questions_were_already_solved
+  #
+  # The first argument tells us which language we should use.
+  #
+  # By default, we will report on the commandline, in english.
+  # ========================================================================= #
+  def self.report_how_many_exam_questions_were_already_solved(
+      report_in_which_language = :default,
+      report_or_return         = :report
+    )
+    n_total_questions = ::Studium.n_total_questions_available?
+    n_total_answers = return_n_exam_questions_were_already_solved
+    percentage = ((n_total_answers * 100.0) / n_total_questions).round(2)
+    percentage = Studium::Colours.deepskyblue("#{percentage}%")
+    # ======================================================================= #
+    # Next, add proper '.' token into the n_total_questions variable,
+    # which helps a bit in reading.
+    # ======================================================================= #
+    n_total_questions = n_total_questions.to_s.reverse.scan(/.{3}|.+/).join('.').reverse
+    n_total_answers = n_total_answers.to_s
+    colourized_n_total_answers = ::Colours::AllColourMethods.deepskyblue(n_total_answers)
+    result = ''.dup
+    result << ::Colours::AllColourMethods.grey('')
+    case report_in_which_language # case tag
+    # ======================================================================= #
+    # === :english
+    # ======================================================================= #
+    when :english,
+         :default # Use the english language here, which is the default.
+      result << ::Colours::AllColourMethods.grey('We already solved ')+
+                colourized_n_total_answers+
+                ::Colours::AllColourMethods.grey(' of ')+
+                ::Studium::Colours.sfancy(n_total_questions.to_s)+
+                ::Colours::AllColourMethods.grey(' available questions ('+percentage)+
+                ::Colours::AllColourMethods.grey(' solved, on the ')+
+                ::Colours::AllColourMethods.darkolivegreen(::Studium.dd_mm_yyyy)+
+                ::Colours::AllColourMethods.grey(').')
+    # ======================================================================= #
+    # === :german
+    # ======================================================================= #
+    when :german # Use the german language here.
+      result << 'Am '+::Studium.datum?+' waren es '+
+                Studium::Colours.simp(n_total_questions.to_s)+
+                ' Fragen - davon waren '+colourized_n_total_answers+
+                ' beantwortet. '+'('+percentage+')'
+    end
+    # ======================================================================= #
+    # Since as of December 2016, we will also save this information in
+    # a file. We have to ensure that the base-directory exists, though.
+    # ======================================================================= #
+    save_into_this_file = "#{Studium.log_dir?}nsolved.md"
+    Studium.ensure_that_the_log_directory_exists
+    Studium.save_what_into(
+      n_total_answers.to_s, save_into_this_file
+    )
+    if report_or_return == :report
+      Studium.e result
+    else
+      return report_or_return
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams.return_n_questions_solved_in_total
+  #
+  # This method will return a number, telling us how many questions
+  # were solved in total.
+  #
+  # Example:
+  #
+  #   Studium::Exams.return_n_questions_solved_in_total # => 116
+  #
+  # ========================================================================= #
+  def self.return_n_questions_solved_in_total
+    dataset = ::Studium::Exams::Dataset[]
+    n_total_questions = dataset.size # We have that many questions.
+    dataset.reject! {|entry| entry.end_with?("[]\n") }
+    n_total_unsolved_questions = dataset.size
+    n_questions_solved = n_total_questions - n_total_unsolved_questions
+    return n_questions_solved
+  end; self.instance_eval { alias n_answers_answered? return_n_questions_solved_in_total } # === Studium::Exams.n_answers_answered?
+       self.instance_eval { alias n_answers?          return_n_questions_solved_in_total } # === Studium::Exams.n_answers?
+       self.instance_eval { alias n_answers           return_n_questions_solved_in_total } # === Studium::Exams.n_answers  
+
+  # ========================================================================= #
+  # === Studium::Exams.report_nquestions_of
+  #
+  # This method can be used to report, on the commandline, how many
+  # questions are in the specific topic at hand.
+  # ========================================================================= # 
+  def self.report_nquestions_of(i)
+    i = [i] unless i.is_a? Array
+    i.flatten!
+    i.map! {|topic|
+      Studium::Exams.return_n_questions_in_this_topic(topic, :also_return_n_answers)
+    }
+    # ======================================================================= #
+    # The variable i may now look like this here:
+    #   [[752, 204], [800, 223], [265, 143], [228, 78], [271, 262], [60, 25], [85, 20]]
+    # ======================================================================= #
+    n_questions = i.flatten.select.with_index {|entry, index| entry if index % 2 == 0 }.sum
+    n_answers   = i.flatten.select.with_index {|entry, index| entry if index % 2 != 0 }.sum
+    ::Studium.e ::Colours.rev+
+      'We have a total of '+Colours.sfile(n_questions.to_s)+' questions in '\
+      'these '+Colours.sfile((i.flatten.size / 2).to_s)+' topics at hand.'
+    ::Studium.e Colours.simp(n_answers.to_s)+' of these questions have '\
+      'already been answered. ('+
+      Colours.simp((n_answers.to_f * 100 / n_questions).round(2).to_s+'%')+')'
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.report_solved_topics
+#
+# This method will simply report which topics are completely (100%) solved.
+# =========================================================================== #
+def self.report_solved_topics
+  require 'studium/toplevel_methods/return_n_percent_solved_from_this_topic.rb'
+  array_these_topics_are_completely_solved = []
+  available_topics = ::Studium::Exams.all_topics_as_short_name
+  directory_to_the_exam_topics = directory_to_the_exam_topics?
+  available_topics.each {|filename|
+    path = "#{directory_to_the_exam_topics}#{filename}"
+    if File.file? path
+      dataset = File.readlines(path)
+      dataset = ::Studium.filter_away_invalid_questions(dataset, path)
+      n_total_questions = dataset.size
+      n_questions_answered = dataset.select {|entry| entry.include? ' []' }.size
+      if n_questions_answered == n_total_questions
+        array_these_topics_are_completely_solved << filename
+      end
+    else
+      opnn; e no_file_at(path)
+    end
+  }
+  if array_these_topics_are_completely_solved.empty?
+    e 'No topic is completely solved yet.'
+  else
+    e ::Studium::Colours.rev+
+      ::Studium::Colours.grey('The following ')+
+      ::Studium::Colours.steelblue(
+        array_these_topics_are_completely_solved.size.to_s
+      )+
+      ::Studium::Colours.grey(' topics are completely solved:')
+    e
+    
+    array_these_topics_are_completely_solved.each {|this_topic|
+      n_exam_questions = ::Studium.return_n_exam_questions_in_this_topic(this_topic)
+      e "  #{Colours.steelblue(this_topic.ljust(24))} #{Colours.gold('#')} "+
+        ::Colours.mediumpurple(
+          "#{n_exam_questions.to_s.rjust(3)} exam questions in that topic"
+        )
+    }
+    e
+  end
+end
+
+# =========================================================================== #
+# === Studium.report_n_ects_per_university
+#
+# The first argument to this method should be a Hash. This Hash should
+# contain key→value pairs that have the university associated with
+# the corresponding n ECTS points.
+#
+# The input Hash should look like this:
+#
+#   {"TU Wien"=>115.5, "Uni Wien"=>30.0, "BOKU Wien"=>26.0, "Vetmed Wien"=>8.5}
+#
+# =========================================================================== #
+def self.report_n_ects_per_university(
+    hash,
+    total_ects_points = 180.0
+  )
+  n_ects_in_total = 0
+  sorted_hash = hash.sort_by {|a, ects_points| ects_points.to_f }.reverse
+  use_this_as_total_ects_points = total_ects_points
+  if use_this_as_total_ects_points == 120.0
+    use_this_as_total_ects_points = 90 # Ad-hoc change this.
+  end
+  # ========================================================================= #
+  # Iterate over the sorted Hash next.
+  # ========================================================================= #
+  sorted_hash.each {|this_university, n_ects_points_at_that_university|
+    percentage_value = (
+      (n_ects_points_at_that_university * 100 ) / use_this_as_total_ects_points
+    ).round(1)
+    n_ects_in_total += n_ects_points_at_that_university
+    padded_this_university = this_university.to_s.ljust(15)
+    e '                            '+
+      sfancy(padded_this_university)+
+      colour_for_ects_points(
+        n_ects_points_at_that_university.to_s.rjust(5)+' ECTS points'
+      )+
+      darkgreen(
+        ' ('+percentage_value.to_s.rjust(4)+'%)'
+      )
+  }
+  e colour_for_ects_points(
+      n_ects_in_total.to_s.rjust(48)+' ECTS points'
+    )
+  e
+end
+
+# =========================================================================== #
+# === Studium.return_n_questions_in_this_topic
+# =========================================================================== #
+def self.return_n_questions_in_this_topic(i)
+  ::Studium::Exams.report_nquestions_of(i)
+end; self.instance_eval { alias n_exam_questions_in_this_topic return_n_questions_in_this_topic } # === Studium.n_exam_questions_in_this_topic
+
+# =========================================================================== #
+# === Studium.return_n_questions_solved_in_total
+#
+# This convenient method will return a number, which denotes how many
+# questions were already solved in total.
+#
+# Usage example and associated result:
+#
+#   Studium.return_n_questions_solved_in_total # => 8829
+#
+# =========================================================================== #
+def self.return_n_questions_solved_in_total
+  ::Studium::Exams.return_n_questions_solved_in_total
+end; self.instance_eval { alias n_questions_solved          return_n_questions_solved_in_total } # === Studium.n_questions_solved
+     self.instance_eval { alias n_questions_solved_in_total return_n_questions_solved_in_total } # === Studium.n_questions_solved_in_total 
+
+# =========================================================================== #
+# === Studium.report_how_many_exam_questions_were_already_solved
+#
+# Easier report-method.
+# =========================================================================== #
+def self.report_how_many_exam_questions_were_already_solved
+  Studium::Exams.report_how_many_exam_questions_were_already_solved
+end
+
+# =========================================================================== #
+# === Studium.n_percent_of_the_exam_questions_are_answered_already?
+# =========================================================================== #
+def self.n_percent_of_the_exam_questions_are_answered_already?
+  n_total_questions = ::Studium.n_total_questions_available?
+  n_total_answers = return_n_exam_questions_were_already_solved
+  percentage = ((n_total_answers * 100.0) / n_total_questions).round(2)
+  return percentage
+end
+
+# =========================================================================== #
+# === Studium.return_n_exam_questions_were_already_solved
+#
+# This method will return a number, such as 6330, denoting how many
+# exam-questions were already solved (already answered).
+# =========================================================================== #
+def self.return_n_exam_questions_were_already_solved
+  Studium::Exams.return_n_exam_questions_were_already_solved
+end; self.instance_eval { alias return_n_questions_were_answered return_n_exam_questions_were_already_solved } # === Studium.return_n_questions_were_answered
+
+# =========================================================================== #
+# === Studium.n_lectures_registered?
+# =========================================================================== #
+def self.n_lectures_registered?
+  dataset = Studium.return_sanitized_dataset_from_the_file_lecture_information
+  n_keys = dataset.keys.size
+  return n_keys
+end
+
+# =========================================================================== #
+# === Studium.report_n_entries_in_the_file_lecture_information
+# =========================================================================== #
+def self.report_n_entries_in_the_file_lecture_information
+  n_keys = n_lectures_registered?
+  e "#{Colours.rev}There are #{::Studium::Colours.sfancy(n_keys)} "\
+    "registered courses in the file "\
+    "#{::Studium::Colours.sfile('lecture_information.yml')}."
+end
+
+# =========================================================================== #
+# === Studium.report_attributed_lectures_to_universities
+#
+# The input to this method should be a Hash like so:
+#
+#   {"Uni Wien"=>70.0, "BOKU"=>18.0, "TU Vienna"=>2.0}
+#
+# =========================================================================== #
+def self.report_attributed_lectures_to_universities(hash)
+  e 'The attributed lectures are as follows:'
+  e
+  hash.each_pair {|this_university, n_ects_points|
+    e royalblue('  '+this_university.ljust(50))+
+      ' '+
+      ::Studium::Colours.orange(n_ects_points.to_s.rjust(4))+' ECTS points'
+  }; e
+end
+
+# =========================================================================== #
+# === Studium.return_n_exam_questions_in_this_topic
+# =========================================================================== #
+def self.return_n_exam_questions_in_this_topic(i)
+  ::Studium::Exams.return_n_questions_in_this_topic(i)
+end
+  
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium.report_n_ects_per_university(ARGV)  
+  Studium::Exams.report_nquestions_of(ARGV)
+  Studium::Exams.report_how_many_exam_questions_were_already_solved
+  Studium.report_solved_topics
+  Studium.report_n_entries_in_the_file_lecture_information
+  Studium.report_all_lectures_matching_this_lecture_type(ARGV)
+  # n_questions_in_total = Studium::Exams.return_n_questions_solved_in_total
+  # puts n_questions_in_total
+end # reporthowmanyexamquestionswerealreadysolved
+    # reportnquestionsof bem1 bem2 meta
+    # reportalllecturesmatchingthislecturetype VO+SE

data/lib/studium/toplevel_methods/return_all_exams_on_this_day.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/return_all_exams_on_this_day.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/colours/colours.rb'
+  require 'studium/toplevel_methods/e.rb'
+  require 'studium/toplevel_methods/main_dataset.rb'
+  require 'studium/toplevel_methods/return_sanitized_dataset_from_the_file_lecture_information.rb'
+  require 'studium/toplevel_methods/time.rb'
+
+  # ========================================================================= #
+  # === Studium.return_all_exams_on_this_day
+  #
+  # This method will simply return all exams on the given input day.
+  # ========================================================================= #
+  def self.return_all_exams_on_this_day(
+      this_day = '02.05.2022'
+    )
+    if this_day.is_a? Array
+      this_day = this_day.first
+    end
+    dataset = main_dataset?
+    if dataset.nil?
+      dataset = ::Studium.return_sanitized_dataset_from_the_file_lecture_information
+      set_main_dataset(dataset)
+    end
+    # ======================================================================= #
+    # First, select only entries that have an exam-entry.
+    # ======================================================================= #
+    selection = dataset.select {|name_of_the_lecture, inner_hash|
+      inner_hash.has_key? 'exams'
+    }
+    selection = selection.select {|name_of_the_lecture, inner_hash|
+      exams = inner_hash['exams']
+      exams = remove_leaking_weekdays(exams)
+      if exams
+        if exams.is_a? Array
+          exams.map! {|inner_line|
+            inner_line.strip
+          }
+        end
+      end
+      if exams
+        exams.any? {|entry|
+          entry.start_with?(this_day)
+        }
+      else
+        e 'Something strange with the course `'+
+           sfancy(name_of_the_lecture)+
+           '` - it does not have any registered weekdays.'
+        nil
+      end
+    }
+    # ======================================================================= #
+    # Work on the dataset next, to return only exam-entries that match
+    # to the given input day at hand.
+    # ======================================================================= #
+    selection
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pp Studium.return_all_exams_on_this_day(ARGV).keys
+end # returnallexamsonthisday 02.05.2022