studium 0.13.1

data/lib/studium/utility_scripts/show_lectures_on_the_commandline/misc.rb

@@ -0,0 +1,837 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/utility_scripts/show_lectures_on_the_commandline/misc.rb'
+# =========================================================================== #
+module Studium
+
+class ShowLecturesOnTheCommandline < Base
+
+  require 'studium/utility_scripts/show_lectures_on_the_commandline/konsole.rb'
+
+  # ========================================================================= #
+  # === 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_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
+
+  # ========================================================================= #
+  # === 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?
+
+  # ========================================================================= #
+  # === dataset?
+  # ========================================================================= #
+  def dataset?
+    @dataset
+  end; alias dataset_holding_all_lectures dataset? # === dataset_holding_all_lectures
+       alias all_lectures?                dataset? # === 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
+
+  # ========================================================================= #
+  # === consider_generating_a_spreadsheet
+  # ========================================================================= #
+  def consider_generating_a_spreadsheet(
+      i = @title
+    )
+    require 'studium/utility_scripts/generate_spreadsheet/generate_spreadsheet.rb'
+    Studium::GenerateSpreadsheet.new(i)
+  end
+
+  # ========================================================================= #
+  # === consider_generating_a_graphviz_image_displaying_the_modules
+  # ========================================================================= #
+  def consider_generating_a_graphviz_image_displaying_the_modules(
+      use_this_dataset
+    )
+    require 'image_paradise/graphviz/generate_graphviz_image.rb'
+    copy = use_this_dataset.dup
+    copy.map! {|entry|
+      if entry.include? '#'
+        entry = entry[0 .. ( entry.index('#') - 1 )]
+      end
+      entry.strip
+    }
+    copy = turn_this_array_into_the_full_dataset(
+      copy.flatten, @lecture_dataset
+    )
+    # ======================================================================= #
+    # Next, we will work on this modified dataset. 
+    # ======================================================================= #
+    hash_containing_the_module_dependencies = {}
+    copy.each_pair {|name_of_the_lecture, inner_hash|
+      if inner_hash
+        individual_curricula = inner_hash[:individual_curricula]
+        if individual_curricula
+          selection = individual_curricula.select {|most_inner_hash|
+            most_inner_hash[:name_of_the_curriculum].include? @title
+          }.first
+          if selection
+            individual_curriculum_module = selection[:individual_curriculum_module]
+            if individual_curriculum_module
+              individual_curriculum_module = individual_curriculum_module.first
+            end
+            individual_curriculum_depends_on_these_modules = selection[:individual_curriculum_depends_on_these_modules]
+            hash_containing_the_module_dependencies[individual_curriculum_module] =
+              individual_curriculum_depends_on_these_modules
+          end
+        end
+      end
+    }
+    # ======================================================================= #
+    # Next pass this Hash into class GenerateGraphvizImage.
+    # ======================================================================= #
+    ImageParadise::GenerateGraphvizImage.new(
+      hash_containing_the_module_dependencies
+    ) { :use_bold_font_and_german }
+  end
+
+  # ========================================================================= #
+  # === 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
+
+  # ========================================================================= #
+  # === read_in_dataset_from_this_file
+  #
+  # Input to this method should be a String, not an Array.
+  # ========================================================================= #
+  def read_in_dataset_from_this_file(i)
+    @dataset << obtain_sanitized_dataset_from(i)
+    @dataset.flatten!
+    check_for_title_entry_in_the_file(i)
+  end
+
+  # ========================================================================= #
+  # === report_the_average_grade
+  # ========================================================================= #
+  def report_the_average_grade
+    if @do_report
+      average_grade = return_the_average_grade
+      e "The #{gold('average grade')} is: #{sfancy(average_grade)}"
+      e
+    end
+  end
+
+  # ========================================================================= #
+  # === check_for_title_entry_in_the_file
+  #
+  # You can put a line within a curriculum such as:
+  #
+  #   @title Biologie Basisblock
+  #
+  # The method will check for this. However had, you can also avoid using
+  # such a title, by having a header section, as a comment, where the
+  # second line should contain the title of the lecture.
+  #
+  # The latter is the default (and recommended) mode.
+  # ========================================================================= #
+  def check_for_title_entry_in_the_file(
+      this_file = dataset?
+    )
+    temporary_dataset = Studium.read_dataset_from_a_curriculum_file(
+      this_file,
+      :retain_comments
+    )
+    # ======================================================================= #
+    # If the second line in the curriculum-file starts with '# === #'
+    #
+    # This is recommended for all registered curricula.
+    # ======================================================================= #
+    if temporary_dataset[1].start_with?('# === ')
+      use_this_title = temporary_dataset[1]
+      set_title(use_this_title)
+    # ======================================================================= #
+    # else check for a @title entry
+    # ======================================================================= #
+    elsif this_file.any? {|line|
+        line.start_with? '@title'
+      }
+      set_title(
+        dataset.select {|line| line.start_with? '@title ' }
+      )
+      # ===================================================================== #
+      # In this case, grab the title, and remove that line.
+      # So, we will reject all entries that include '@title '.
+      # ===================================================================== #
+      dataset.reject! {|line| line.start_with? '@title '}
+      dataset.compact!
+      set_dataset(dataset)
+    end
+  end
+
+  # ========================================================================= #
+  # === no_html_page7
+  # ========================================================================= #
+  def no_html_page
+    @generate_html_file = false
+  end; alias no_html no_html_page # === no_html
+
+  # ========================================================================= #
+  # === show_loaded_from_which_file?
+  # ========================================================================= #
+  def show_loaded_from_which_file?
+    @show_loaded_from_which_file
+  end
+
+  # ========================================================================= #
+  # === report_how_many_ects_points_are_in_this_curriculum
+  # ========================================================================= #
+  def report_how_many_ects_points_are_in_this_curriculum
+    if @do_report
+      e return_how_many_ects_points_this_curriculum_has_in_total
+      e
+    end
+  end
+
+  # ========================================================================= #
+  # === do_show_all_URLs
+  # ========================================================================= #
+  def do_show_all_URLs
+    @show_all_URLs = true
+  end
+
+  # ========================================================================= #
+  # === report_how_many_lectures_are_in_this_curriculum_and_how_many_of_them_are_already_solved
+  # ========================================================================= #
+  def report_how_many_lectures_are_in_this_curriculum_and_how_many_of_them_are_already_solved
+    array = return_how_many_lectures_are_in_this_curriculum_and_how_many_of_them_are_already_solved
+    if @do_report
+      e
+      e array[0]
+      e array[1]
+      e
+    end
+  end
+
+  # ========================================================================= #
+  # === lecture_dataset?
+  # ========================================================================= #
+  def lecture_dataset?
+    @lecture_dataset
+  end; alias main_dataset? lecture_dataset? # === main_dataset?
+
+  # ========================================================================= #
+  # === n_lectures_are_already_solved?
+  # ========================================================================= #
+  def n_lectures_are_already_solved?
+    @n_lectures_are_already_solved
+  end; alias n_lectures_completed? n_lectures_are_already_solved? # === n_lectures_completed?
+
+  # ========================================================================= #
+  # === n_total_lectures?
+  # ========================================================================= #
+  def n_total_lectures?
+    @dataset.size
+  end
+
+  # ========================================================================= #
+  # === is_this_lecture_a_practical_course?
+  # ========================================================================= #
+  def is_this_lecture_a_practical_course?(lecture_type)
+    ARRAY_LECTURE_TYPES_THAT_ARE_MANDATORY_CONTINUOUS_ASSESSMENT.include? lecture_type
+  end
+
+  # ========================================================================= #
+  # === type_of_the_curriculum?
+  # ========================================================================= #
+  def type_of_the_curriculum?
+    @type_of_the_curriculum
+  end; alias curriculum_type? type_of_the_curriculum? # === curriculum_type?
+
+  # ========================================================================= #
+  # === exclude_title_entries_from_the_main_dataset
+  # ========================================================================= #
+  def exclude_title_entries_from_the_main_dataset
+    @dataset.reject! {|line| line.start_with? '@title ' }
+  end
+
+  # ========================================================================= #
+  # === n_ects_were_passed_in_this_curriculum?
+  # ========================================================================= #
+  def n_ects_were_passed_in_this_curriculum?
+    @n_ects_were_passed_so_far
+  end; alias n_ects_were_passed_in_this_curriculum n_ects_were_passed_in_this_curriculum? # === n_ects_were_passed_in_this_curriculum
+       alias n_ects_were_passed_so_far             n_ects_were_passed_in_this_curriculum? # === n_ects_were_passed_so_far
+
+  # ========================================================================= #
+  # === n_ects_points_in_total?
+  # ========================================================================= #
+  def n_ects_points_in_total?
+    @this_curriculum_has_n_ects_points_in_total
+  end; alias total_ects_points? n_ects_points_in_total? # === total_ects_points?
+
+  # ========================================================================= #
+  # === prepend_this_to_dataset
+  #
+  # An Array can be given to this method. If a symbol is given, such as
+  # :bachelor_lbt, then that symbol will be treated in a special way as
+  # far as this method is concerned.
+  # ========================================================================= #
+  def prepend_this_to_dataset(
+      i = :bachelor_biologie_basisblock_curriculum
+    )
+    original_input = i.dup
+    if i.is_a? Symbol
+      # ===================================================================== #
+      # Here we will handle input such as :bachelor_lbt.
+      # ===================================================================== #
+      i = return_curriculum_file_based_on_this_input(i)
+    end
+    if i.is_a? Array
+      i.flatten.each {|entry| prepend_this_to_dataset(entry) }
+    else
+      if i.nil?
+        e 'A nil value was encountered, onto the method called '+
+          steelblue('prepend_this_dataset()')+'.'
+        e 'The original input was: '+
+          royalblue(original_input.to_s)
+      elsif File.exist? i # Read in existing files.
+        array = obtain_sanitized_dataset_from(i)
+        @dataset = array+@dataset
+        @dataset.flatten!
+        exclude_title_entries_from_the_main_dataset
+      # ===================================================================== #
+      # The next check is for ad-hoc addition of lectures, such as via:
+      #   ['892100 Physik (KTWW+HNT)']
+      # ===================================================================== #
+      elsif is_this_a_registered_lecture? i
+        @dataset << i
+      else
+        opnn; e "No file exists at #{sfile(i)}."
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === add_to_the_dataset_without_any_further_checks
+  # ========================================================================= #
+  def add_to_the_dataset_without_any_further_checks(i)
+    @dataset << i
+    @dataset.flatten!
+  end
+
+  # ========================================================================= #
+  # === obtain_sanitized_dataset_from
+  #
+  # This method combines two other methods - loading the dataset that
+  # belongs to a Curriculum; and sorting that dataset. 
+  # ========================================================================= #
+  def obtain_sanitized_dataset_from(i)
+    # ======================================================================= #
+    # Keep in mind that the following method also allows for optional
+    # arguments such as :remove_comments_and_title
+    #
+    # We do not need to do this for this file, though, as this file may
+    # probably make use of all the information it can get.
+    # ======================================================================= #
+    dataset = Studium.read_dataset_from_a_curriculum_file(i).map(&:chomp)
+    # ======================================================================= #
+    # Next, we must check for duplicate entries. For now we will work on
+    # the dataset obtained above ^^^ but if we need a more accurate 
+    # approach, we should work on the name + LVA-ID of the lecture at
+    # hand instead.
+    # ======================================================================= #
+    unless dataset == dataset.uniq
+      e 'We have found at the least one duplicate entry. This will be '\
+        'shown next:'
+      e
+      these_are_the_duplicates = {}
+      these_are_the_duplicates.default = 0
+      dataset.each {|this_entry|
+        these_are_the_duplicates[this_entry] += 1
+      }
+      these_are_the_duplicates.select {|key, value| value > 1 }.each {|duplicate, n_times|
+        e sfancy("  #{duplicate}")
+      }
+      e
+      e 'Please correct these entries before we can continue.'
+      exit
+    end
+    sort_dataset(dataset) if @shall_we_sort_the_dataset
+  end
+
+  # ========================================================================= #
+  # === clear_old_dataset
+  # ========================================================================= #
+  def clear_old_dataset
+    @dataset = []
+  end
+
+  # ========================================================================= #
+  # === do_not_show_the_next_exams
+  #
+  # Use this method if you do NOT want to show the next exams.
+  # ========================================================================= #
+  def do_not_show_the_next_exams
+    @show_next_exams = false
+  end
+
+  # ========================================================================= #
+  # === do_not_show_loaded_from_which_file
+  # ========================================================================= #
+  def do_not_show_loaded_from_which_file
+    @show_loaded_from_which_file = false
+  end
+
+  # ========================================================================= #
+  # === return_proper_logo_for_this_university
+  # ========================================================================= #
+  def return_proper_logo_for_this_university(
+      i
+    )
+    Studium.return_proper_university_image(i)
+  end
+
+  # ========================================================================= #
+  # === is_this_a_registered_lecture?
+  # ========================================================================= #
+  def is_this_a_registered_lecture?(i)
+    @lecture_dataset.has_key?(i.strip)
+  end
+
+  # ========================================================================= #
+  # === individual_curriculum?
+  # ========================================================================= #
+  def individual_curriculum?
+    @individual_curriculum
+  end; alias is_it_an_individual_curriculum? individual_curriculum? # === is_it_an_individual_curriculum?
+
+  # ========================================================================= #
+  # === is_not_an_individual_curriculum
+  # ========================================================================= #
+  def is_not_an_individual_curriculum
+    @individual_curriculum = false
+  end
+
+  # ========================================================================= #
+  # === is_an_individual_curriculum
+  # ========================================================================= #
+  def is_an_individual_curriculum
+    @individual_curriculum = true
+  end
+
+  # ========================================================================= #
+  # === title?
+  # ========================================================================= #
+  def title?
+    @title
+  end; alias return_name_of_the_curriculum title? # === return_name_of_the_curriculum
+       alias name_of_the_curriculum        title? # === name_of_the_curriculum
+       alias name_of_the_curriculum?       title? # === name_of_the_curriculum?
+
+  # ========================================================================= #
+  # === uniq_the_dataset
+  #
+  # This ad-hoc method will simply eliminate all the duplicates that
+  # may exist in the main dataset at hand. It is only called from
+  # within menu() right now (December 2019).
+  # ========================================================================= #
+  def uniq_the_dataset
+    @dataset.uniq!
+  end
+
+  # ========================================================================= #
+  # === sanitize_the_dataset
+  # ========================================================================= #
+  def sanitize_the_dataset
+    @dataset.map! {|entry|
+      entry = entry.dup if entry.frozen?
+      entry.squeeze!(' ')
+      if entry.include? '#'
+        entry = entry[0 .. (entry.index('#')-1)]
+      end
+      entry.strip!
+      entry
+    }
+  end
+
+  # ========================================================================= #
+  # === sort_dataset
+  #
+  # This method will sort the dataset, according to the name of the
+  # lecture rather than the leading ID number.
+  # ========================================================================= #
+  def sort_dataset(
+      i = @dataset
+    )
+    i.sort_by! {|line|
+      # ===================================================================== #
+      # The next line will split on ' ' tokens, take all but the first
+      # entry, rejoin, strip and delete '(' tokens. So essentially we
+      # will strip away the leading numbers from the line at hand.
+      # ===================================================================== #
+      line.split(' ')[1 .. -1].join(' ').strip
+    }
+  end
+
+  # ========================================================================= #
+  # === starts_with_a_lecture_id_entry?
+  # ========================================================================= #
+  def starts_with_a_lecture_id_entry?(i)
+    result = false
+    if i.include? ' '
+      splitted = i.split(' ')
+      first_entry = splitted.first
+      # ===================================================================== #
+      # See: https://rubular.com/r/EKEk3QuWRQ1s
+      # ===================================================================== #
+      if first_entry =~ /^\d+\.?[A-Z]*\d{1,4}$/
+        result = true
+      end
+    end
+    result
+  end
+
+  # ========================================================================= #
+  # === return_bachelor_or_master_logo
+  #
+  # Here we differ between bachelor-logo and the master-logo.
+  #
+  # By default, we will operate on @type_of_the_curriculum, but
+  # this can be wrong in a mixed bachelor-master curriculum.
+  # ========================================================================= #
+  def return_bachelor_or_master_logo(
+      this_lecture = nil
+    )
+    if this_lecture.nil?
+      case @type_of_the_curriculum
+      when :bachelor
+        BACHELOR_IMAGE
+      when :master
+        MASTER_IMAGE
+      end
+    else
+      # ===================================================================== #
+      # Else assume an Array was given.
+      # ===================================================================== #
+      if this_lecture.any? {|entry| entry.start_with?('033') }
+        BACHELOR_IMAGE
+      else
+        MASTER_IMAGE
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === report_title
+  #
+  # Use this method to report the title of the Curriculum at hand.
+  # ========================================================================= #
+  def report_title(
+      this_title = @title
+    )
+    if this_title
+      e; e springgreen(this_title); e
+    else
+      opnn; e 'No title was set via @title. This is '\
+              'currently disallowed, so we exit now.'
+      opnn; e "The file to read from was `"\
+              "#{sfancy(@read_from_this_file)}`."
+      exit
+    end
+  end; alias display_the_name_of_the_curriculum report_title # === display_the_name_of_the_curriculum
+
+  # ========================================================================= #
+  # === set_title
+  #
+  # The title of the Curriculum in question. Should be hardcoded
+  # in the file.
+  # ========================================================================= #
+  def set_title(i)
+    i = i.first if i.is_a? Array
+    i = i.dup.delete(N) # Want to work on a String really.
+    if i.start_with? '# ==='
+      i.sub!(/^# === /,'')
+    end
+    i.sub!(/^@title /,'') if i.include? '@title '
+    @title = i.strip.chomp
+  end; alias set_title_of_the_curriculum set_title # === set_title_of_the_curriculum
+
+  # ========================================================================= #
+  # === no_html_and_do_not_report_anything
+  # ========================================================================= #
+  def no_html_and_do_not_report_anything
+    no_html
+    do_not_report_anything
+  end
+
+  # ========================================================================= #
+  # === ja_oder_nein
+  #
+  # Input "true" will become "Ja" and input "false" will become "Nein".
+  # ========================================================================= #
+  def ja_oder_nein(
+      i = 'nein'
+    )
+    Studium.ja_oder_nein(i)
+  end
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn(i = namespace?)
+    if block_given?
+      super(i) { yield }
+    else
+      super(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === 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
+
+  # ========================================================================= #
+  # === report_the_university_attribution
+  #
+  # This method will report the university-attribution of that curriculum.
+  # ========================================================================= #
+  def report_the_university_attribution
+    require 'studium/toplevel_methods/report.rb'
+    # ======================================================================= #
+    # We must build up our main Hash next. That Hash should look e. g.
+    # like this:
+    #
+    #   {
+    #     "TU Wien"=>115.5,
+    #     "Uni Wien"=>30.0,
+    #     "BOKU Wien"=>26.0,
+    #     "Vetmed Wien"=>8.5
+    #   }
+    #
+    # ======================================================================= #
+    sanitize_the_dataset
+    hash = {}
+    @dataset.each {|entry|
+      pointer = @lecture_dataset[entry]
+      if pointer
+        n_ects = pointer[:ects]
+        this_university = pointer[:university]
+        if hash.has_key? this_university
+          hash[this_university] += n_ects
+        else
+          hash[this_university] = n_ects
+        end
+      else
+        e steelblue('No entry found for ')+
+          royalblue(entry.to_s)
+      end
+    }
+    Studium.report_n_ects_per_university(hash, n_ects_points_in_total?)
+  end
+
+end; end