studium 0.10.1

data/lib/studium/lectures/show_lectures_on_the_commandline/reset.rb

@@ -0,0 +1,120 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Studium
+
+class ShowLecturesOnTheCommandline < Base
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    super()
+    is_bachelor_curriculum # ← This is just to set a default.
+    # ======================================================================= #
+    # === @lecture_dataset
+    #
+    # This variable keeps track of all registered lectures at the
+    # universities.
+    # ======================================================================= #
+    @lecture_dataset = return_dataset_from_the_file_lecture_information
+    # ======================================================================= #
+    # === @this_curriculum_has_n_ects_points_in_total
+    # ======================================================================= #
+    @this_curriculum_has_n_ects_points_in_total = 0
+    # ======================================================================= #
+    # === @n_ects_were_passed_so_far
+    # ======================================================================= #
+    @n_ects_were_passed_so_far = 0
+    # ======================================================================= #
+    # === @shall_we_sort_the_dataset
+    # ======================================================================= #
+    @shall_we_sort_the_dataset = true # ← Whether to sort the dataset or not.
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = []
+    # ======================================================================= #
+    # === @title
+    #
+    # Which title to use for this curriculum.
+    # ======================================================================= #
+    @title = nil
+    # ======================================================================= #
+    # === @hash_containing_the_lectures_for_this_curriculum
+    #
+    # The following hash will contain the lectures that are used for
+    # the curriculum. Specifically it will be used to autogenerate the
+    # .html file.
+    # ======================================================================= #
+    @hash_containing_the_lectures_for_this_curriculum = {}
+    # ======================================================================= #
+    # === @individual_curriculum
+    #
+    # The following variable determines whether this lecture is an
+    # individual curriculum or whether it is not.
+    # ======================================================================= #
+    @individual_curriculum = false
+    # ======================================================================= #
+    # === @show_next_exams
+    # ======================================================================= #
+    @show_next_exams = true
+    # ======================================================================= #
+    # === @n_lectures_are_already_solved
+    # ======================================================================= #
+    @n_lectures_are_already_solved = 0
+    # ======================================================================= #
+    # Next, determine from which files we will read.
+    # ======================================================================= #
+    determine_from_which_files_to_read
+    # ======================================================================= #
+    # === @array_storing_the_grades
+    # ======================================================================= #
+    @array_storing_the_grades = []
+    # ======================================================================= #
+    # === @generate_html_file
+    #
+    # If the following variable is true then this class will additionally
+    # generate a .html file.
+    # ======================================================================= #
+    @generate_html_file = true
+    # ======================================================================= #
+    # === @mode
+    #
+    # The @mode can be :commandline or :www.
+    # ======================================================================= #
+    @mode = :commandline
+    # ======================================================================= #
+    # === @show_loaded_from_which_file
+    # ======================================================================= #
+    @show_loaded_from_which_file = true
+    # ======================================================================= #
+    # === @do_report
+    # ======================================================================= #
+    @do_report = true
+    # ======================================================================= #
+    # === @show_all_URLs
+    # ======================================================================= #
+    @show_all_URLs = false
+    # ======================================================================= #
+    # === @html_string
+    # ======================================================================= #
+    @html_string = nil
+    # ======================================================================= #
+    # === @show_to_which_universities_the_lectures_belong_to
+    #
+    # By default we will not show to which university the given lectures
+    # belong to.
+    # ======================================================================= #
+    @show_to_which_universities_the_lectures_belong_to = false
+    # ======================================================================= #
+    # === @append_this_string_onto_the_html_string
+    #
+    # The following instance variable can be used to append more onto
+    # the main HTML string.
+    # ======================================================================= #
+    @append_this_string_onto_the_html_string = ''.dup
+  end
+
+end; end

data/lib/studium/lectures/show_lectures_on_the_commandline/run.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Studium
+
+class ShowLecturesOnTheCommandline < Base
+
+  # ========================================================================= #
+  # === do_all_actions_after_the_main_dataset_was_read_in
+  # ========================================================================= #
+  def do_all_actions_after_the_main_dataset_was_read_in
+    iterate_over_the_lectures
+    consider_showing_to_which_universities_the_lectures_belong_to
+    # ======================================================================= #
+    # The next method will output something like:
+    #   "A total of 52 lectures are part of this Curriculum."
+    # ======================================================================= #
+    if commandline?
+      report_how_many_lectures_are_in_this_curriculum_and_how_many_of_them_are_already_solved
+      report_how_many_ects_points_have_been_passed_already
+      report_how_many_ects_points_are_in_this_curriculum
+      report_the_average_grade
+      report_the_university_attribution
+    end
+    consider_generating_a_html_file
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  #
+  # The menu() method has to come before any other methods here.
+  # ========================================================================= #
+  def run
+    menu # First, pass the commandline into the menu-method.
+    read_in_main_dataset_from_the_existing_files
+    if commandline?
+      try_to_rename_kde_konsole_tab
+      report_title
+    end
+    do_all_actions_after_the_main_dataset_was_read_in # Continue here.
+  end
+
+end; end

data/lib/studium/lectures/show_lectures_on_the_commandline/show.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/lectures/show_lectures_on_the_commandline/show.rb'
+# =========================================================================== #
+module Studium
+
+class ShowLecturesOnTheCommandline < Base
+
+  require 'studium/toplevel_methods/available_curricula.rb'
+  require 'studium/utility_scripts/lectures_attributed_to_universities.rb'
+
+  # ========================================================================= #
+  # === show_important_files
+  #
+  # This method will show the file that has all lectures registered.
+  #
+  # Usage example:
+  #
+  #   curriculum --files?
+  #
+  # ========================================================================= #
+  def show_important_files(
+      use_this_file = FILE_LECTURE_INFORMATION
+    )
+    e "The following file is the most important file by far:"
+    e
+    e "  #{sfile(use_this_file)}"
+    e
+  end
+
+  # ========================================================================= #
+  # === show_available_curricula
+  #
+  # This method will show the available Curricula.
+  #
+  # Invocation example:
+  #
+  #   studium_solved --show-available
+  #
+  # ========================================================================= #
+  def show_available_curricula
+    e 'These curricula are available:'
+    e
+    Studium.return_array_location_of_all_registered_curricula.each {|entry|
+      if entry.is_a? Array
+        entry.each {|inner_entry|
+          e "  #{sfancy(File.basename(inner_entry).sub(/\.yml$/,''))}"
+        }
+      else
+        e "  #{sfancy(File.basename(entry).sub(/\.yml$/,'').strip)}"
+      end
+    }; e
+  end
+
+  # ========================================================================= #
+  # === do_show_lecture_attribution_to_universities
+  # ========================================================================= #
+  def do_show_lecture_attribution_to_universities
+    @show_to_which_universities_the_lectures_belong_to = true
+  end
+
+  # ========================================================================= #
+  # === consider_showing_to_which_universities_the_lectures_belong_to
+  #
+  # We should only show as to which university a particular lecture
+  # belongs to if it is an individual curriculum. Other curricula
+  # all belong to one particular university, so showing the "table"
+  # on the commandline is useless.
+  # ========================================================================= #
+  def consider_showing_to_which_universities_the_lectures_belong_to
+    if @show_to_which_universities_the_lectures_belong_to
+      first_argument = @commandline_arguments
+      if first_argument.is_a? Array
+        first_argument = first_argument.first
+      end
+      first_argument = first_argument.to_s.delete('-')
+      if cmdline?
+        e
+        e 'The percentage-value of lectures attributed to '\
+          'the different'
+        e 'universities will be shown next:'
+      end
+      _ = Studium::LecturesAttributedToUniversities.new(first_argument) {
+        :do_not_show_the_title_and_do_not_report
+      }
+      splitted_html_string = _.html_string.split("\n")
+      # ===================================================================== #
+      # Also embed this into a little <div> container next:
+      # ===================================================================== #
+      @append_this_string_onto_the_html_string <<
+        '<div style="padding: 0.70em; background-color: black; '\
+        'font-size: 1.0em; font-family: monospace;">'
+        splitted_html_string.each {|line|
+          @append_this_string_onto_the_html_string << "<b>#{line.strip}</b><br>#{N}"
+        }
+        @append_this_string_onto_the_html_string << '</div>'
+      # ===================================================================== #
+      # And now we can report our findings, if we are on the commandline.
+      # ===================================================================== #
+      _.report if cmdline?
+    end
+  end
+
+end; end

data/lib/studium/lectures/show_lectures_on_the_commandline/show_lectures_on_the_commandline.rb

@@ -0,0 +1,491 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ShowLecturesOnTheCommandline
+#
+# This class will show the lectures that belong to a particular curriuclum.
+# It will also show how many exams have been solved already so far in
+# the given curriculum at hand.
+#
+# For now, we only work on the bachelor-curriculum.
+# =========================================================================== #
+# require 'studium/lectures/show_lectures_on_the_commandline/show_lectures_on_the_commandline.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+# =========================================================================== #
+# Next require .rb files that are specific to this class here.
+# =========================================================================== #
+require 'studium/lectures/show_lectures_on_the_commandline/constants.rb'
+require 'studium/lectures/show_lectures_on_the_commandline/determine.rb'
+require 'studium/lectures/show_lectures_on_the_commandline/help.rb'
+require 'studium/lectures/show_lectures_on_the_commandline/html.rb'
+require 'studium/lectures/show_lectures_on_the_commandline/initialize.rb'
+require 'studium/lectures/show_lectures_on_the_commandline/menu.rb'
+require 'studium/lectures/show_lectures_on_the_commandline/misc.rb'
+require 'studium/lectures/show_lectures_on_the_commandline/reset.rb'
+require 'studium/lectures/show_lectures_on_the_commandline/run.rb'
+require 'studium/lectures/show_lectures_on_the_commandline/show.rb'
+
+module Studium
+
+class ShowLecturesOnTheCommandline < Base # === Studium::ShowLecturesOnTheCommandline
+
+  require 'studium/toplevel_methods/lva_numbers.rb'
+  require 'studium/toplevel_methods/read_dataset_from_a_curriculum_file.rb'
+  require 'studium/toplevel_methods/return_sanitized_dataset_from_the_file_lecture_information.rb'
+  require 'studium/toplevel_methods/return_proper_university_image.rb'
+
+  # ========================================================================= #
+  # === return_how_many_ects_points_have_been_passed_already
+  # ========================================================================= #
+  def return_how_many_ects_points_have_been_passed_already(
+      use_for = @mode
+    )
+    n_percent = (
+      (@n_ects_were_passed_so_far.to_f * 100) / n_ects_points_in_total?
+    ).round(2)
+    # ======================================================================= #
+    # The next variable is not colourized by default, so that we can use
+    # it for the :use_for_html entry point that will come next. A similar
+    # reason is valid for the variable called `second_part`.
+    # ======================================================================= #
+    colourized_n_ECTS_points_were_passed = @n_ects_were_passed_so_far.to_s
+    second_part = "  <b>#{@title}</b>."
+    case use_for
+    when :use_for_html # (html tag, www tag)
+      first_part = "In total we have passed <b>#{colourized_n_ECTS_points_were_passed} ECTS "\
+                   "points</b> (<b>#{n_percent.to_s+'%'}</b>) so far in the"
+    when :commandline, :default # This is the default.
+      colourized_n_ECTS_points_were_passed = plum(
+        colourized_n_ECTS_points_were_passed
+      )
+      first_part = "In total we have passed #{colourized_n_ECTS_points_were_passed} ECTS "\
+                   "points (#{orangered(n_percent.to_s+'%')}) so far in the"
+      second_part = "  #{sfancy(@title)}."
+    end
+    [ first_part, second_part ]
+  end
+
+  # ========================================================================= #
+  # === report_how_many_ects_points_have_been_passed_already
+  # ========================================================================= #
+  def report_how_many_ects_points_have_been_passed_already
+    array = return_how_many_ects_points_have_been_passed_already
+    e array.first
+    e
+    e array.last
+    e
+  end
+
+  # ========================================================================= #
+  # === report_how_many_exams_have_been_passed_already
+  #
+  # To invoke this method try:
+  #
+  #   emo --agrarwissenschaften
+  #
+  # ========================================================================= #
+  def report_how_many_exams_have_been_passed_already
+    n_lectures_are_in_this_curriculum = n_lectures_in_this_curriculum?
+    opnn; e sfancy(@n_lectures_are_already_solved.to_s)+' lectures have '\
+            'already been passed out'
+    opnn; e 'of a total '+
+            slateblue(n_lectures_are_in_this_curriculum.to_s)+', in '\
+            'the curriculum '+simp(title?.to_s)+'.'
+  end
+
+  # ========================================================================= #
+  # === do_not_report_anything
+  # ========================================================================= #
+  def do_not_report_anything
+    @do_report = false
+  end; alias do_not_report do_not_report_anything # === do_not_report
+
+  # ========================================================================= #
+  # === n_lectures_in_this_curriculum?
+  # ========================================================================= #
+  def n_lectures_in_this_curriculum?
+    @dataset.size
+  end
+
+  # ========================================================================= #
+  # === iterate_over_the_lectures                               (iterate tag)
+  # ========================================================================= #
+  def iterate_over_the_lectures(
+      i = @dataset
+    )
+    i.each_with_index {|line, index| index += 1
+      result = ''.dup # This is the line that will be reported to the user.
+      # ===================================================================== #
+      # Since as of January 2018 the dataset has already been sanitized a
+      # bit before coming to this method, so there will no longer be any
+      # '#' characters. In the past, the variable line would look like
+      # this:
+      #
+      #   "754117 Mikrobiologie - Übungen (AW)              # 2.0 ECTS, UE\n"
+      #
+      # That is why the next line still checks for this.
+      # ===================================================================== #
+      if line and line.include?('#')
+        raw_line = line[0 .. (line.index('#') - 1)] # ← raw_line is like: "754117 Mikrobiologie - Übungen (AW)"
+      # ===================================================================== #
+      # The next code checks for a leading LVA-id entry, but it must also
+      # keep in mind that ID entries may be like this: "185.A47"
+      # ===================================================================== #
+      # elsif starts_with_a_lecture_id_entry?(line)
+      #   raw_line = line.split(' ')[1 .. -1].join(' ').strip.dup
+      else
+        raw_line = line.dup
+      end
+      raw_line.strip! # ← Added this in December 2019.
+      raw_line.squeeze!(' ') # ← Added this as of March 2018.
+      # ===================================================================== #
+      # Obtain the remote URL. Since as of 20.02.2018, this requires that
+      # the beautiful_url project also deals with leading numbers, so all
+      # entries must have that too, as an additional qualifier.
+      #
+      # On November 2019 support for BeautifulUrl was removed, and
+      # replaced with Studium.return_remote_url_of_this_lecture()
+      # instead.
+      # ===================================================================== #
+      remote_url = Studium.return_remote_url_of_this_lecture(raw_line)
+      if remote_url == raw_line
+        e crimson('No registered remote homepage for '+raw_line+'.')
+      end
+      splitted = raw_line.split(' ')
+      lecture_id = splitted.first # ← Obtain the lecture id.
+      name_of_the_lecture = splitted[1..-1].join(' ')
+      padded_index = ('('+index.to_s+')').rjust(5)
+      colourized_index = slategray(padded_index)
+      # ===================================================================== #
+      # Create a colourized string for the remote URL next.
+      # ===================================================================== #
+      colourized_remote_url = N+dodgerblue('      → ')+
+                                dodgerblue(remote_url)+
+                                dodgerblue(' ☚')
+      pointer_to_the_lecture = @lecture_dataset[raw_line]
+      if pointer_to_the_lecture and
+         pointer_to_the_lecture.has_key?(:already_solved)
+        already_solved = pointer_to_the_lecture[:already_solved]
+      else
+        opnn; e "#{swarn('Problem with `')}#{sfancy(raw_line)}#{swarn('`:')}"
+        opnn; e swarn('no registered key called :already_solved was found')
+        # =================================================================== #
+        # Also inform the user whether this lecture is registered at all.
+        # If not, notify the user about this.
+        # =================================================================== #
+        unless main_dataset?.has_key? raw_line
+          opnn; e swarn('The lecture ')+sfancy(raw_line)+swarn(' has not yet been')
+          opnn; e swarn('registered in the file `')+
+                  sfancy('lecture_information.yml')+swarn('`.')
+        end
+        pp pointer_to_the_lecture
+        already_solved = false
+      end
+      if pointer_to_the_lecture.nil?
+        opnn; e "Skipping this lecture (#{sfancy(raw_line)})"
+        opnn; e 'as it is not registered or otherwise missing.'
+        next
+      end
+      # ===================================================================== #
+      # Deconstruct the content of our hash-"pointer" next.
+      # ===================================================================== #
+      n_ects_points = pointer_to_the_lecture[:ects]
+      @this_curriculum_has_n_ects_points_in_total += n_ects_points
+      padded_name_of_the_lecture = name_of_the_lecture.ljust(76)
+      padded_n_ects_points = n_ects_points.to_s.rjust(5)
+      colourized_n_ects_points = steelblue(padded_n_ects_points)
+      expanded_ja_oder_nein = ja_oder_nein(already_solved)
+      case expanded_ja_oder_nein
+      when 'Ja'
+        colourized_ja_oder_nein  = lightgreen(expanded_ja_oder_nein.rjust(4))
+      when 'Nein' # Lectures that were not yet passed, will be highlighted in red.
+        colourized_ja_oder_nein  = crimson(expanded_ja_oder_nein.rjust(4))
+      end
+      fancified_already_solved = 'Bereits absolviert? '+colourized_ja_oder_nein+'. '
+      result << colourized_index+' '+
+                sfancy(padded_name_of_the_lecture)+' '+
+                fancified_already_solved+
+                '('+mediumseagreen('LVA Nummer: ')+
+                sfancy(lecture_id.rjust(7))
+      grade = nil
+      if already_solved
+        # =================================================================== #
+        # Obtain the grade of this lecture.
+        # =================================================================== #
+        if pointer_to_the_lecture.has_key? :grade
+          grade = pointer_to_the_lecture[:grade]
+          # ================================================================= #
+          # We must keep in mind that the grade can also be a '+' character.
+          # We can not calculate the average number from entries that are
+          # '+' Strings, so we will ignore these entries - but we will
+          # do so not here but lateron, when we calculate the average grade.
+          # ================================================================= #
+          @array_storing_the_grades << grade
+        end
+        @n_lectures_are_already_solved += 1
+        @n_ects_were_passed_so_far += n_ects_points
+        # =================================================================== #
+        # If the lecture was already solved then we will not show
+        # the remote URL.
+        # =================================================================== #
+        colourized_remote_url = ''
+      end
+      result << ', '+mediumseagreen('n ECTS: ')+colourized_n_ects_points
+      if grade
+        result << ', '+mediumseagreen('Grade: '+grade.to_s)
+      end
+      unless ALSO_SHOW_URL
+        colourized_remote_url = ''
+      end
+      if @do_report and cmdline? # We only report this on the commandline.
+        result << ') '+colourized_remote_url
+        e result
+      end
+    }
+    if @this_curriculum_has_n_ects_points_in_total >= 270.0
+      # ===================================================================== #
+      # This check is to avoid checking for combined bachelor-master
+      # individual curricula, as we can not show a correct module
+      # chain in this case really - or at the least not without
+      # additional code (23.12.2019).
+      # ===================================================================== #
+    else
+      if is_it_an_individual_curriculum? and is_on_roebe?
+        consider_generating_a_graphviz_image_displaying_the_modules(
+          i
+        )
+        consider_generating_a_spreadsheet
+      end
+    end
+  end; alias do_the_main_iteration iterate_over_the_lectures # === do_the_main_iteration
+
+  # ========================================================================= #
+  # === read_from_these_files?
+  # ========================================================================= #
+  def read_from_these_files?
+    @read_from_these_files # This also means to keep track of the position of the curriculum-file.
+  end; alias loaded_from_which_file?   read_from_these_files? # === loaded_from_which_file?
+       alias curriculum_file?          read_from_these_files? # === curriculum_file?
+       alias curriculum_file_location? read_from_these_files? # === curriculum_file_location?
+       alias curriculum_file_location  read_from_these_files? # === curriculum_file_location
+       alias curriculum?               read_from_these_files? # === curriculum?
+
+  # ========================================================================= #
+  # === return_how_many_lectures_are_in_this_curriculum_and_how_many_of_them_are_already_solved
+  #
+  # This method will return an Array with two members. The reason for this
+  # is that it is easier on the commandline to output two Arrays; and to
+  # also use this when we autogenerate a .html file.
+  # ========================================================================= #
+  def return_how_many_lectures_are_in_this_curriculum_and_how_many_of_them_are_already_solved(
+      optional_use_colours = true
+    )
+    n_percent = (
+      (@n_lectures_are_already_solved.to_i * 100) / @dataset.size.to_f
+    ).round(1)
+    case optional_use_colours # Use colours in this case.
+    when :use_for_html # (html tag, www tag)
+      colourized_n_percent_finished = ' (<b>'+n_percent.to_s+'% finished'+'</b>)'
+      first_part = "A total of <b>#{@dataset.size.to_s}</b> lectures are part of this Curriculum."
+      second_part = "<b>#{@n_lectures_are_already_solved.to_s}</b> of these "\
+                    "are already solved.#{colourized_n_percent_finished}"
+    when :no_colours, false
+      colourized_n_percent_finished = ' ('+n_percent.to_s+'% finished'+')'
+      first_part = "A total of #{@dataset.size.to_s} lectures are part of this Curriculum."
+      second_part = "#{@n_lectures_are_already_solved.to_s} of these "\
+                    "are already solved.#{colourized_n_percent_finished}"
+    else # This here is the default clause.
+      colourized_n_percent_finished = ' ('+orangered(n_percent.to_s+'% finished')+')'
+      first_part = "A total of #{springgreen(@dataset.size.to_s)} "\
+                   "lectures are part of this Curriculum."
+      second_part = "#{springgreen(@n_lectures_are_already_solved.to_s)} of these "\
+                    "are already solved.#{colourized_n_percent_finished}"
+    end
+    [ first_part, second_part ]
+  end
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  # ========================================================================= #
+  def set_commandline_arguments(i)
+    # ======================================================================= #
+    # We will handle empty Arrays a bit differently if we are on
+    # a roebe-system.
+    # ======================================================================= #
+    if i.is_a?(Array) and i.empty?
+      i << :bachelor_vektorx # Set a default value here.
+    end
+    @commandline_arguments = i
+  end
+
+  # ========================================================================= #
+  # === set_dataset
+  # ========================================================================= #
+  def set_dataset(i)
+    @dataset = i
+  end; alias set_all_lectures set_dataset # === set_all_lectures
+
+  # ========================================================================= #
+  # === return_the_average_grade
+  #
+  # This method will return the average grade. So for example, if we have
+  # passed three exams, with a grade of 2, 3 and 4, respectively, then
+  # the average grade will be 2 + 3 + 4 = 9 / 3 → 3.
+  # ========================================================================= #
+  def return_the_average_grade
+    # ======================================================================= #
+    # We must work on a copy, because some grades, such as '+', are not
+    # useful for calculating the average grade - hence we will have to
+    # weed these entries out, for the purpose of calculating the
+    # average grade through this method here.
+    # ======================================================================= #
+    array_storing_the_grades = @array_storing_the_grades.dup
+    array_storing_the_grades.reject! {|grade|
+      grade == '+' or grade == 'E' # Remove '+' and 'E' exam results.
+    }
+    average_grade = (
+      array_storing_the_grades.sum.to_f / array_storing_the_grades.size
+    ).round(2)
+    return average_grade
+  end
+
+  # ========================================================================= #
+  # === dataset?
+  # ========================================================================= #
+  def dataset?
+    @dataset
+  end; alias all_lectures?                dataset? # === all_lectures?
+       alias dataset_holding_all_lectures dataset? # === dataset_holding_all_lectures
+       alias lectures?                    dataset? # === lectures?
+
+  # ========================================================================= #
+  # === read_in_main_dataset_from_the_existing_files
+  #
+  # This method will read in from an Array, which is usually stored in
+  # the instance variables @read_from_these_files.
+  #
+  # Input to this method can be like this:
+  #
+  #   ["/Programs/Ruby/2.5.1/lib/ruby/site_ruby/2.5.0/studium/yaml/curricula/master_bioinformatik_066875.yml"]
+  #
+  # ========================================================================= #
+  def read_in_main_dataset_from_the_existing_files(
+      i = @read_from_these_files
+    )
+    if i
+      i.each {|this_file|
+        # =================================================================== #
+        # The next method will read into the variable @dataset.
+        # =================================================================== #
+        if File.exist? this_file.to_s
+          read_in_dataset_from_this_file(this_file) # Delegate to this method.
+        else
+          opnn; e "Can not read from non-existing file "\
+                  "`#{sfile(this_file)}`."
+          opnn; e 'The original input to the method '+
+                  sfancy(__method__.to_s)+' was '+
+                  sfancy(i)+' (class '+i.to_s+')'
+          opnn; e 'The '+orange('caller-stack')+' will be shown next:'
+          e
+          pp caller()
+          e
+          exit
+        end
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === return_how_many_ects_points_this_curriculum_has_in_total
+  # ========================================================================= #
+  def return_how_many_ects_points_this_curriculum_has_in_total(
+      use_colours = true
+    )
+    case use_colours
+    when :no_colours
+      use_colours = false
+    end
+    n_ects_points = @this_curriculum_has_n_ects_points_in_total
+    # ======================================================================= #
+    # Use colours, if issued to do so. On the commandline, this will
+    # be the tomato colour.
+    # ======================================================================= #
+    if use_colours
+      n_ects_points = tomato(n_ects_points)
+    else
+      n_ects_points = "<b>#{n_ects_points}</b>" # In this case we will assume www-use.
+    end
+    # ======================================================================= #
+    # Next, return the Strings that informs the user how many ECTS points
+    # the given curriculm has, in total. Since as of November 2019, we
+    # will also inform the user how many of these ECTS require a
+    # continuous mandatory assessment ("prüfungsimmanent").
+    # ======================================================================= #
+    n_ects_prüfungsimmanent = 0
+    @dataset.each {|line|
+      # ===================================================================== #
+      # A line may look like this:
+      #
+      #   182.711 Betriebssysteme                            # 2.0 ECTS, VO
+      #
+      # ===================================================================== #
+      name = line.dup
+      if name.include? '#'
+        name = name[0 .. (name.index('#') - 1)]
+        name.strip!
+        # =================================================================== #
+        # Must still squeeze a bit:
+        # =================================================================== #
+        name.squeeze!(' ')
+        if @lecture_dataset.has_key? name
+          pointer = @lecture_dataset[name]
+          n_ects  = pointer[:ects].to_f
+          type    = pointer[:type]
+          if is_prüfungsimmanent?(type)
+            n_ects_prüfungsimmanent += n_ects
+          end
+        end
+      end
+    }
+    n_percent_prüfungsimmanent = ((
+      n_ects_prüfungsimmanent.to_f * 100.0
+    ) / @this_curriculum_has_n_ects_points_in_total.to_f).round(1)
+    colourized_n_ects_prüfungsimmanent =
+      skyblue(n_percent_prüfungsimmanent.to_s.dup)
+    "This curriculum has #{n_ects_points} ECTS points "\
+    "in total, of which "\
+    "#{colourized_n_ects_prüfungsimmanent} ECTS "\
+    "("+n_percent_prüfungsimmanent.to_s+"%)\n"\
+    "require continuous mandatory assessment "\
+    "(#{orangered('prüfungsimmanent')})."
+  end
+
+  # ========================================================================= #
+  # === Studium::ShowLecturesOnTheCommandline[]
+  # ========================================================================= #
+  def self.[](commandline_arguments = ARGV, run_already = true)
+    new(commandline_arguments, run_already)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ShowLecturesOnTheCommandline.new(ARGV)
+end # show_lectures_on_the_commandline
+    # show_lectures_on_the_commandline individuell
+    # show_lectures_on_the_commandline bachelor_biologie
+    # show_lectures_on_the_commandline individuelles_bachelor_studium
+    # show_lectures_on_the_commandline LBT
+    # show_lectures_on_the_commandline agrarbiotechnologie
+    # show_lectures_on_the_commandline biologie
+    # show_lectures_on_the_commandline botanik
+    # show_lectures_on_the_commandline pharmazie
+    # show_lectures_on_the_commandline bachelor_pharmazie
+    # show_lectures_on_the_commandline tu_master_biotech
+    # show_lectures_on_the_commandline AW
+    # show_lectures_on_the_commandline immunbio
+    # show_lectures_on_the_commandline bachelor_mikrobiologie_und_genetik
+    # show_lectures_on_the_commandline master_molbio
+    # show_lectures_on_the_commandline bachelor_molbio