studium 0.16.9

data/lib/studium/toplevel_methods/curriculum_related_code.rb

@@ -0,0 +1,1038 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/curriculum_related_code.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/requires/require_encoding.rb'
+  require 'studium/constants/constants.rb'
+  require 'studium/colours/colours.rb'
+  require 'studium/toplevel_methods/e.rb'
+  require 'studium/toplevel_methods/main_dataset.rb'
+  require 'studium/toplevel_methods/map_input_to_this_curriculum_filename.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'
+
+  # ========================================================================= #
+  # === Studium.map_partial_input_to_full_curriculum_name
+  #
+  # Note that this method will, if more than one match is found, always
+  # return the very first entry of an Array.
+  #
+  # Usage example:
+  #
+  #   Studium.map_partial_input_to_full_curriculum_name('master_biotech') # => "Mastercurriculum Biotechnology"
+  #   Studium.map_partial_input_to_full_curriculum_name(:bachelor_agrarwissenschaften) # => "Bachelorcurriculum Agrarwissenschaften"
+  #   Studium.map_partial_input_to_full_curriculum_name('mbiotech') # => "Bachelorcurriculum Agrarwissenschaften"
+  #
+  # ========================================================================= #
+  def self.map_partial_input_to_full_curriculum_name(
+      i = 'master_biotech'
+    )
+    # ======================================================================= #
+    # First, load all registered curricula entries:
+    # ======================================================================= #
+    _ = YAML.load_file(Studium.file_curricula)
+    i = i.dup if i.is_a? Array
+    copy = i.to_s.dup
+    if File.exist? i
+      i = Studium.from_filename_to_curriculum_name(i)
+    else
+      unless i =~ /^\d+$/ # Unless only numbers
+        try_to_find_a_local_file = Studium.return_file_for_this_curriculum(i)
+        if try_to_find_a_local_file.is_a? Array
+          try_to_find_a_local_file = try_to_find_a_local_file.last
+        end
+        if File.exist? try_to_find_a_local_file
+          return Studium.from_filename_to_curriculum_name(try_to_find_a_local_file)
+        end
+      end
+    end
+    inverted_dataset = _.invert.map {|key, value|
+      key.first # The first entry is e. g. "Bachelorcurriculum Geodäsie und Geoinformation".
+    }
+    if copy.include? 'master_'
+      copy.sub!(/master_/,'Mastercurriculum ')
+    elsif copy.include? 'bachelor_'
+      copy.sub!(/bachelor_/,'Bachelorcurriculum ')
+    end
+    selection = inverted_dataset.select {|entry|
+      entry.downcase.start_with?(copy.downcase) or
+      entry.downcase.include?(copy.downcase)
+    }
+    if selection
+      if selection.size > 1
+        selection = selection.first # Obtain the first entry.
+      end
+      selection = selection.first if selection.is_a? Array
+      return selection
+    else
+      return i # else return the original input unmodified.
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium.name_of_this_curriculum
+  #
+  # Note that we will assume that the curricula-files, which are yaml
+  # files, will have the name of the curriculum at hand on the first
+  # line.
+  # ========================================================================= #
+  def self.name_of_this_curriculum(i)
+    i = i.first if i.is_a? Array
+    i = Studium.return_file_for_this_curriculum(i)
+    i = i.last if i.is_a? Array
+    if File.exist? i
+      dataset = File.readlines(i, encoding: ::Studium.encoding?)
+      first_line = dataset.select {|line| line.start_with? '# === ' }.first.strip
+      i = first_line.sub(/^# === /,'').
+                     sub(/Bachelorcurriculum /,'').
+                     sub(/Mastercurriculum /,'')
+    end
+    return i.strip
+  end
+
+  # ========================================================================= #
+  # === Studium::ARRAY_ALL_AVAILABLE_CURRICULA
+  #
+  # The following Array has to be populated manually for now.
+  #
+  # In theory we could perhaps move this into its own file and its own
+  # sub-namespace, but for now, let's do the manual thing.
+  #
+  # Since as of December 2022 we will use Dir[] to dynamically find
+  # all curricula there.
+  # ========================================================================= #
+  ARRAY_ALL_AVAILABLE_CURRICULA = Dir[
+    "#{Studium.project_yaml_dir?}curricula/**/**.yml"
+  ].reject {|line| line.include? 'curricula/outdated/' }
+  # .map {|line| Studium.return_file_for_this_curriculum(line) }
+
+  # ========================================================================= #
+  # === Studium.map_curriculum_name_to_curriculum_number
+  #
+  # This method will map from a curriculum name to the corresponding
+  # curriculum number.
+  #
+  # This method will return a String such as "033630".
+  #
+  # You can also provide a partial input such as:
+  #
+  #   Studium.map_curriculum_name_to_curriculum_number('master_biotech')
+  #   Studium.map_curriculum_name_to_curriculum_number(:bachelor_agrarwissenschaften) # => "033255"
+  #   Studium.map_curriculum_name_to_curriculum_number(:bachelor_lbt)
+  #
+  # ========================================================================= #
+  def self.map_curriculum_name_to_curriculum_number(
+      this_curriculum_name
+    )
+    if this_curriculum_name.is_a? Symbol
+      # ===================================================================== #
+      # Here we try to find a substitute, if the input is a Symbol.
+      # ===================================================================== #
+      this_curriculum_name = Studium.map_input_to_this_curriculum_filename(this_curriculum_name)
+      if File.exist? this_curriculum_name
+        this_curriculum_name = Studium.from_filename_to_curriculum_name(this_curriculum_name)
+      end
+    end
+    this_curriculum_name = this_curriculum_name.to_s
+    _ = YAML.load_file(Studium.file_curricula)
+    inverted_dataset = _.invert
+    # ======================================================================= #
+    # The entries to the above dataset may be like this:
+    #
+    #   ["Mastercurriculum Lehramt UF Biologie und Umweltkunde", "Uni Wien"]=>
+    #    "199502"
+    # ======================================================================= #
+    # We will build a new Hash, using only the first element of the above
+    # key.
+    # ======================================================================= #
+    new_hash = Hash[inverted_dataset.map {|array, curriculum_number|
+      [array.first, curriculum_number]
+    }]
+    unless new_hash.has_key? this_curriculum_name
+      # ===================================================================== #
+      # In this case we try to match the curriculum name.
+      # ===================================================================== #
+      possible_curriculum_name = Studium.map_partial_input_to_full_curriculum_name(this_curriculum_name)
+      if new_hash.has_key? possible_curriculum_name
+        this_curriculum_name = possible_curriculum_name
+      end
+    end
+    # ======================================================================= #
+    # Do some ad-hoc sanitizing next:
+    # ======================================================================= #
+    case this_curriculum_name
+    when /Bachelorcurriculum(_|-| )?Mikrobiologie(_|-| )?und(_|-| )?Genetik$/i,
+         /Biologie(_|-| )?Basisblock$/i
+      this_curriculum_name = 'Bachelorcurriculum Biologie'
+    end
+    this_curriculum = new_hash[this_curriculum_name]
+    unless this_curriculum
+      e "No result for `#{this_curriculum_name}`." # Notify the user in this case.
+    end
+    return this_curriculum
+  end; self.instance_eval { alias to_curriculum_id map_curriculum_name_to_curriculum_number } # === Studium.to_curriculum_id
+
+  # ========================================================================= #
+  # === Studium.from_filename_to_curriculum_name
+  #
+  # This method will translate from the filename to the curriculum name.
+  #
+  # Usage example:
+  #
+  #   Studium.from_filename_to_curriculum_name('/usr/lib/ruby/site_ruby/3.2.0/studium/yaml/curricula/bachelor/bachelor_lmbt_033217.yml')
+  #
+  # ========================================================================= #
+  def self.from_filename_to_curriculum_name(i)
+    if i and File.exist? i
+      _ = File.readlines(i)
+      # ===================================================================== #
+      # We assume the second line is the one containing the real name.
+      # ===================================================================== #
+      i = _[1].delete('#=').strip
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === Studium.map_curriculum_number_to_curriculum_name
+  #
+  # This method will take a curriculum number and convert it into
+  # the long name of the curriculum at hand.
+  #
+  # This method will return a String.
+  #
+  # Usage examples:
+  #
+  #   Studium.map_curriculum_number_to_curriculum_name('033255') # => "Bachelorcurriculum Agrarwissenschaften"
+  #   Studium.map_curriculum_number_to_curriculum_name('/home/x/programming/ruby/src/studium/lib/studium/yaml/curricula/bachelor/bachelor_agrarwissenschaften_033255.yml') # => "Bachelorcurriculum Agrarwissenschaften"
+  #
+  # ========================================================================= #
+  def self.map_curriculum_number_to_curriculum_name(
+      this_curriculum_number,
+      reverse_order = false
+    )
+    # ======================================================================= #
+    # === Load the main dataset next, the file that keeps all curricula
+    #
+    # We need the proper encoding for the dataset from the
+    # curricula-yaml file. This is no longer necessary since
+    # as of June 2021. The old code was:
+    #
+    #   _ = ensure_main_encoding(YAML.load_file(Studium.file_curricula))
+    #
+    # In the future this comment will probably be removed.
+    # ======================================================================= #
+    _ = YAML.load_file(Studium.file_curricula)
+    this_curriculum_number = this_curriculum_number.to_s
+    # ======================================================================= #
+    # Before we perform the actual conversion we will check whether the
+    # input is a .yml file. If it is, and such a file can be found to
+    # exist locally, we will apply a regex onto it to extract the real
+    # curriculum number. This will not work in all cases, but for simple
+    # input this should work fine.
+    # ======================================================================= #
+    if this_curriculum_number and this_curriculum_number.end_with?('.yml') and
+      File.exist?(this_curriculum_number)
+      # ===================================================================== #
+      # Apply the regex next:
+      # ===================================================================== #
+      use_this_regex = /_(\d{6,6}).yml$$/
+      this_curriculum_number =~ use_this_regex
+      this_curriculum_number = $1.to_s.dup if $1
+    end
+    # ======================================================================= #
+    # Perform the conversion next:
+    # ======================================================================= #
+    this_curriculum = _[this_curriculum_number]
+    # ======================================================================= #
+    # We must ensure that the main encoding is used. This is no longer
+    # as important.
+    # ======================================================================= #
+    # this_curriculum = ensure_main_encoding(this_curriculum)
+    if this_curriculum.is_a? Array
+      this_curriculum = this_curriculum.first
+    end
+    return this_curriculum
+  end; self.instance_eval { alias return_name_of_this_curriculum   map_curriculum_number_to_curriculum_name } # === Studium.return_name_of_this_curriculum
+       self.instance_eval { alias curriculum_id_to_curriculum_name map_curriculum_number_to_curriculum_name } # === Studium.curriculum_id_to_curriculum_name
+
+  # ========================================================================= #
+  # === Studium.is_a_master_lecture?
+  #
+  # This method is supposed to return true if the given input is a
+  # master course, and false otherwise.
+  # ========================================================================= #
+  def self.is_a_master_lecture?(this_lecture)
+    if ::Studium.main_dataset?
+      dataset_to_use = Studium.main_dataset?
+    else
+      dataset_to_use = Studium.return_sanitized_dataset_from_the_file_lecture_information
+      Studium.main_dataset = dataset_to_use
+    end
+    if dataset_to_use.has_key?(this_lecture)
+      # ===================================================================== #
+      # Ok we have found this lecture registered. Now we grab the entry
+      # and pass it into has_a_master_curriculum?().
+      # ===================================================================== #
+      pointer = dataset_to_use[this_lecture]
+      these_curricula = pointer['curricula']
+      has_a_master_curriculum?(these_curricula)
+    else
+      false
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium.lectures_without_attribution_to_any_curriculum
+  #
+  # This method will return all entries in the file lecture_information.yml
+  # that have no attribution to any official curriculum.
+  # ========================================================================= #
+  def self.lectures_without_attribution_to_any_curriculum
+    dataset = Studium.return_sanitized_dataset_from_the_file_lecture_information
+    dataset.select! {|a, inner_hash|
+      curricula = inner_hash['curricula']
+      # ===================================================================== #
+      # Find empty curricula next:
+      # ===================================================================== #
+      curricula.any? {|entry|
+        entry.is_a?(String) and entry.empty?
+      }
+    }
+  end
+
+  # ========================================================================= #
+  # === Studium.return_lectures_belonging_to_this_curriculum
+  #
+  # Usage example:
+  #
+  #   i = Studium.return_lectures_belonging_to_this_curriculum(:bachelor_vector)
+  #
+  # ========================================================================= #
+  def self.return_lectures_belonging_to_this_curriculum(
+      i = :bachelor_vector
+    )
+    if i.is_a? Array
+      i = i.first
+    end
+    if i.is_a? String
+      i = i.tr(' ','_').to_sym # We do not allow ' ' characters right now.
+    end
+    dataset = return_dataset_from_this_curriculum_file(i)
+    result = dataset.keys
+    return result
+  end
+
+  # ========================================================================= #
+  # === Studium.return_random_curriculum
+  #
+  # This method will return a random curriculum.
+  # ========================================================================= #
+  def self.return_random_curriculum
+    ARRAY_REGISTERED_CURRICULA_FILES.sample
+  end
+
+  # ========================================================================= #
+  # === Studium.return_this_curriculum_as_a_string
+  # ========================================================================= #
+  def self.return_this_curriculum_as_a_string(i)
+    require 'studium/utility_scripts/show_lectures_on_the_commandline/show_lectures_on_the_commandline.rb'
+    i = i.join(' ').strip if i.is_a? Array
+    i = i.to_s.downcase.tr(' ','_')
+    _ = Studium::ShowLecturesOnTheCommandline.new(i) { :www }
+    string = _.html_string?
+    string
+  end
+
+  # ========================================================================= #
+  # === Studium.sanitize_dataset_derived_from_a_curriculum_file
+  #
+  # This method will sanitize the default dataset registered in a
+  # curriculum file. In particular, '#' comments will be removed.
+  #
+  # You should ideally use this method if you need to load up
+  # the dataset from a curriculum file.
+  # ========================================================================= #
+  def self.sanitize_dataset_derived_from_a_curriculum_file(dataset)
+    dataset.reject {|entry|
+      entry.strip.empty? or entry.strip.start_with?('#') # Remove comments as well.
+    }.map {|inner_entry|
+      if inner_entry.include? '#'
+        inner_entry = inner_entry[0 .. (inner_entry.index('#') - 1)].strip
+      end
+      inner_entry.strip.squeeze(' ')
+    }
+  end
+
+  # ========================================================================= #
+  # === Studium.return_dataset_from_this_curriculum_file
+  #
+  # This method will return the dataset of a curriculum file. This means
+  # that it will have all registered lectures already as-is, and return
+  # that complete dataset.
+  #
+  # The input should be the path to an existing file. Alternatively we
+  # will also sanitize a few special symbols given here, such as
+  # :default.
+  # ========================================================================= #
+  def self.return_dataset_from_this_curriculum_file(
+      i = :default_path
+    )
+    dataset_from_the_file_lecture_information =
+      return_sanitized_dataset_from_the_file_lecture_information
+    full_dataset = {}
+    if i.is_a? Array
+      i = i.first
+    end
+    i = return_file_for_this_curriculum(i)
+    unless i.is_a? Array
+      i = [i].flatten.compact
+    end
+    i.each {|file|
+      if file and File.exist?(file)
+        dataset = File.readlines(file, encoding: ::Studium.encoding?)
+        dataset = sanitize_dataset_derived_from_a_curriculum_file(dataset)
+        # =================================================================== #
+        # Next we'll have to obtain the proper dataset from the main Hash.
+        # This may fail, though, so we need to check for that and notify
+        # the user as well, in the event that failure will occur.
+        # =================================================================== #
+        dataset.each {|entry|
+          if dataset_from_the_file_lecture_information.has_key? entry
+            pointer = dataset_from_the_file_lecture_information[entry]
+            full_dataset[entry] = pointer
+          end
+        }
+      else
+        e "No file exists at `#{i}`."
+      end
+    }
+    return full_dataset
+  end
+
+  # ========================================================================= #
+  # === Studium.is_this_lecture_part_of_the_vector_curriculum
+  #
+  # This method will return true or false, depending on whether the
+  # lecture at hand is part of the Vector curriculum or whether it
+  # is not.
+  #
+  # The second argument determines whether this method will be strict,
+  # and return only true if the input-name (first argument) is exactly
+  # as registered; or whether it may :be_lenient, which means that
+  # it will try to find a similarly-named lecture. In the latter case,
+  # tokens such as ',' will be ignored.
+  #
+  # Presently leading numbers are ignored.
+  # ========================================================================= #
+  def self.is_this_lecture_part_of_the_vector_curriculum(
+      this_lecture   = ARGV,
+      modus_operandi = :be_strict # The modus can be strict or lenient.
+    )
+    this_lecture = this_lecture.first if this_lecture.is_a? Array
+    this_lecture = this_lecture.to_s.rstrip # Don't want any ' ' characters on the right hand side.
+    # unless this_lecture.encoding.to_s.include? ::Studium.main_encoding?
+    #   this_lecture = ensure_main_encoding(this_lecture)
+    # end
+    this_lecture.delete!('()')
+    # ======================================================================= #
+    # If the input starts with a number and has at the least one ' ', we chop
+    # the number part away.
+    # ======================================================================= #
+    if this_lecture.start_with?(/\d+/) and this_lecture.include?(' ')
+      this_lecture = this_lecture.split(' ')[1 .. -1].join(' ')
+    end
+    # ======================================================================= #
+    # First, load up the two .yml files of the individual curriculum.
+    # ======================================================================= #
+    dataset = Studium.read_dataset_from_a_curriculum_file(
+      :bachelor_vektor, :remove_comments_and_title
+    )+
+    Studium.read_dataset_from_a_curriculum_file(
+      :master_vektor, :remove_comments_and_title
+    )
+    dataset.flatten!
+    # ======================================================================= #
+    # Sanitize all lectures there. To simplify, we will also get rid of all
+    # '(' and ')' tokens.
+    # ======================================================================= #
+    dataset = dataset.map {|entry|
+      entry = entry.to_s
+      # unless entry.encoding.to_s.include? ::Studium.main_encoding?
+      #   entry = ensure_main_encoding(entry)
+      # end
+      entry = entry.dup if entry.frozen?
+      entry.delete!('()') # Remove both '(' and ')' tokens.
+      case modus_operandi
+      when :be_lenient
+        entry.delete!(',:') # We get rid of ',' and ':' tokens.
+      end
+      entry.chop! if entry.end_with? '.' # Get rid of trailing '.'
+      if (entry =~ /^\d{1}/) and
+        entry.include?(' ')
+        entry = entry.split(' ')[1..-1].join(' ')
+      end
+      entry
+    }
+    # ======================================================================= #
+    # By default we do a "hard" check, without any lenience.
+    # ======================================================================= #
+    is_included_or_is_not_included = dataset.include? this_lecture
+    case modus_operandi
+    when :be_lenient
+      # ===================================================================== #
+      # In this case we will be more tolerant.
+      # ===================================================================== #
+      is_included_or_is_not_included = dataset.any? {|line|
+        line.start_with?(this_lecture) or (line =~ /#{this_lecture}$/)
+      }
+    end
+    return is_included_or_is_not_included
+  end; self.instance_eval { alias is_this_lecture_part_of_the_vektor_curriculum? is_this_lecture_part_of_the_vector_curriculum } # === Studium.is_this_lecture_part_of_the_vektor_curriculum?
+       self.instance_eval { alias is_part_of_the_vektor_curriculum?              is_this_lecture_part_of_the_vector_curriculum } # === Studium.is_part_of_the_vektor_curriculum?
+
+  # ========================================================================= #
+  # === Studium.return_curriculum_of_this_lva_number
+  #
+  # This method will return the LVA number of a particular curriculum.
+  #
+  # Pass in the name of the curriculum.
+  #
+  # Invocation example:
+  #
+  #   Studium.return_curriculum_of_this_lva_number '033521'
+  #
+  # ========================================================================= #
+  def self.return_curriculum_of_this_lva_number(i)
+    # ======================================================================= #
+    # First, sanitize strings if they include at the least two newlines:
+    # ======================================================================= #
+    if i.is_a?(String) and i.count("\n") > 1
+      i = i.split("\n").flatten
+    end
+    dataset = YAML.load_file(Studium.file_curricula)
+    _ = {}
+    dataset.each_pair {|key, value|
+      # key   = Studium.ensure_main_encoding(key)
+      # value = Studium.ensure_main_encoding(value)
+      # ===================================================================== #
+      # Get rid of two words from the key.
+      # ===================================================================== #
+      _[key.sub(/Bachelorcurriculum /,'').sub(/Mastercurriculum /,'')] = value
+    }
+    dataset = _ # Re-assign it to our dataset.
+    if i.is_a? Array
+      i.each {|entry| return_curriculum_of_this_lva_number(entry) }
+    else
+      # ===================================================================== #
+      # Next, we must find the corresponding entries in the curriculum.yml
+      # file.
+      #
+      # The dataset from the curricula.yml file is a hash having
+      # key-value entries, with the value being an Array:
+      #
+      #   (1) first comes the number of the curriculum, as key
+      #   (2) the full and complete name of the curriculum, at
+      #       hand comes as the first element of the Array
+      #   (3) the university at which the lecture is held, comes
+      #       as last element of the Array.
+      #
+      # ===================================================================== #
+      if dataset.has_key? i
+        name_of_the_curriculum = dataset[i]
+        if name_of_the_curriculum.is_a? Array
+          name_of_the_curriculum = name_of_the_curriculum.first
+        end
+        e ::Colours.rev+
+          'The name of the curriculum associated with the LVA '\
+          'ID '+Studium::Colours.simp(i)+' is '\
+          '`'+Studium::Colours.sfancy(name_of_the_curriculum)+'`.'
+      else
+        e 'The curriculum for '+Studium::Colours.sfancy(i)+' does not '\
+          'appear to be registered.'
+        e '  '+Studium::Colours.sfile(Studium.file_curricula)
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium.from_curriculum_id_to_university
+  #
+  # This method will translate from the curriculum-id to the corresponding
+  # university.
+  # ========================================================================= #
+  def self.from_curriculum_id_to_university(
+      i, report_unregistered_keys = true
+    )
+    if i.is_a? Array
+      i = i.flatten.join(' ').strip
+    end
+    result = nil
+    dataset_from_the_yaml_file = YAML.load_file(Studium.file_curricula)
+    i = i.to_s.dup
+    # i = ensure_main_encoding(i.to_s.dup)
+    if dataset_from_the_yaml_file.has_key? i
+      array_pointer = dataset_from_the_yaml_file[i]
+      # ===================================================================== #
+      # The name of the university is presently hardcoded at the second
+      # position. In the past the following code used .last, but since
+      # as of October 2019, the particular .yml file format was changed.
+      # ===================================================================== #
+      name_of_the_university = array_pointer[1]
+      result = name_of_the_university
+    else # Else report that the key is not registered.
+      if report_unregistered_keys
+        e "Key `#{i}` is not registered."
+      end
+    end
+    result
+  end; self.instance_eval { alias curriculum_id_to_university from_curriculum_id_to_university } # === Studium.curriculum_id_to_university
+
+  # ========================================================================= #
+  # === Studium.show_passed_ects_in_the_individual_bachelor_and_master_curricula
+  # ========================================================================= #
+  def self.show_passed_ects_in_the_individual_bachelor_and_master_curricula
+    hash = {}
+    hash.default = 0
+    dataset = return_dataset_from_file_lecture_information
+    dataset.select! {|name_of_the_lecture, inner_dataset|
+      inner_dataset.has_key?(:already_solved) and
+      (inner_dataset[:already_solved] == true)
+    }
+    # ======================================================================= #
+    # Next we can build up a Hash storing the n_ects.
+    # ======================================================================= #
+    dataset.each_pair {|name, inner_dataset|
+      n_ects = inner_dataset[:ects]
+      curricula = inner_dataset['curricula']
+      if has_a_master_curriculum?(curricula)
+        bachelor_or_master = :master
+      elsif has_a_bachelor_curriculum?(curricula)
+        bachelor_or_master = :bachelor
+      elsif has_a_bachelor_curriculum?(curricula) and
+            has_a_master_curriculum?(curricula)
+        bachelor_or_master = :bachelor
+        hash[bachelor_or_master] += n_ects
+        bachelor_or_master = :master # <- Will be set lateron.
+      else
+        bachelor_or_master = :bachelor
+      end
+      hash[bachelor_or_master] += n_ects
+    }
+    n_ects_in_total = hash.values.sum
+    sorted = hash.sort_by {|name, inner_dataset| name }
+    e
+    e ::Studium::Colours.lightgreen(
+        'We passed this amount of ECTS in bachelor/master lectures:'
+      )
+    e; sorted.each {|bachelor_or_master, n_ects_points|
+      # ===================================================================== #
+      # Determine the percentage value as %.
+      # ===================================================================== #
+      percentage_value = (
+        (n_ects_points * 100) / n_ects_in_total
+      ).round(2).to_s+'%'
+      e '  '+
+        ::Studium::Colours.royalblue(
+          (bachelor_or_master.to_s+': ').ljust(12)
+        )+
+        ::Studium::Colours.slateblue(
+          n_ects_points.to_s+' ECTS points'
+        )+' '+::Studium::Colours.crimson(percentage_value)
+    }
+    e
+    e ::Studium::Colours.gold(
+        '  (Note that this will include lectures that are dual-registered'
+      )
+    e ::Studium::Colours.gold(
+        '  in both a bachelor and a master curriculum.)'
+      )
+    e
+  end
+
+  # ========================================================================= #
+  # === Studium.array_available_curricula
+  # ========================================================================= #
+  def self.array_available_curricula
+    ARRAY_ALL_AVAILABLE_CURRICULA.flatten.map {|entry|
+      result = File.basename(entry).sub(/\.yml$/,'')
+      if result =~ /_\d{6}$/
+        result[-7, 7] = ''
+      end
+      result
+    }
+  end
+
+  # ========================================================================= #
+  # === Studium.is_a_registered_curriculum?
+  #
+  # The input to this method must be as accurate as possible for the time
+  # being, as the _.any? check is very simplistic.
+  #
+  # The input to this method can be an Array.
+  #
+  # Usage example:
+  #
+  #   Studium.is_a_registered_curriculum?('agrar')
+  #
+  # ========================================================================= #
+  def self.is_a_registered_curriculum?(i)
+    # ======================================================================= #
+    # If the input is an Array, such as:
+    #
+    #  ["/usr/lib/ruby/site_ruby/3.1.0/studium/yaml/curricula/bachelor/bachelor_biologie_basisblock_033630.yml",
+    #   "/usr/lib/ruby/site_ruby/3.1.0/studium/yaml/curricula/bachelor/bachelor_biologie_mikrobiologie_und_genetik_033630.yml"]
+    #
+    # then we will need to make use of another check.
+    # ======================================================================= #
+    array = Studium.return_array_location_of_all_registered_curricula.
+            compact.uniq
+    if i.is_a? Array
+      i.each {|inner_entry|
+        return true if array.any? {|line| line.include?(inner_entry) } 
+      }
+      return false
+    else
+      return array.any? {|line| line.include?(i) }
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium.return_array_location_of_all_registered_curricula
+  #
+  # This method will return the location to the (local) curricula. On
+  # my home system, this means at the least 20 entries (Apr 2018).
+  #
+  # An Array will be returned.
+  # ========================================================================= #
+  def self.return_array_location_of_all_registered_curricula
+    ARRAY_ALL_AVAILABLE_CURRICULA
+  end; self.instance_eval { alias array_location_of_all_registered_curricula return_array_location_of_all_registered_curricula }
+
+  # ========================================================================= #
+  # === Studium.read_dataset_from_a_curriculum_file
+  #
+  # This method will read in a dataset from a curriculum file, without
+  # depending on YAML.load_file().
+  #
+  # It had to be added in February 2018 because I transitioned away from
+  # using YAML, into my own custom format, which is not only simpler but
+  # also more fault-tolerant - in the sense that fewers mistakes will
+  # happen. Plus - I get to easily control the Encoding in use as well.
+  #
+  # A symbol can also be passed into this method. This will then be
+  # expanded to the corresponding curriculum-file.
+  #
+  # Examples for this:
+  #
+  #   Studium.read_dataset_from_a_curriculum_file(:bachelor_vektorx)
+  #   Studium.read_dataset_from_a_curriculum_file(:bachelor_vektorx, :remove_comments)
+  #
+  # More usage examples:
+  #
+  #   dataset = Studium.read_dataset_from_a_curriculum_file(:bachelor_genetik)
+  #
+  # ========================================================================= #
+  def self.read_dataset_from_a_curriculum_file(
+      i,
+      optional_commands      = nil,
+      do_flatten_the_dataset = true
+    )
+    # ======================================================================= #
+    # === Handle blocks next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :remove_comments
+      # ===================================================================== #
+      when :remove_comments
+        optional_commands = :remove_comments # <- Sync towards this variable.
+      end
+    end
+    dataset = [i].flatten.compact
+    dataset.map! {|entry|
+      if entry.is_a?(Symbol) or
+        (entry.is_a?(String)) # and entry.start_with?('--')) # Commented this out in December 2022.
+        # =================================================================== #
+        # Next we will try to find the proper name, if a Symbol is used here.
+        # =================================================================== #
+        entry = ::Studium.return_file_for_this_curriculum(entry)
+      end
+      if entry.is_a? Array
+        entry = entry.map {|inner_line|
+          File.readlines(
+            inner_line, encoding: ::Studium.main_encoding?
+          )
+        }
+      else
+        if File.exist? entry.to_s
+          entry = File.readlines(
+            entry, encoding: ::Studium.main_encoding?
+          )
+        else
+          e 'From the '+
+            Colours.steelblue('file')+
+            ': '+
+            sfile('studium/toplevel_methods/curriculum_related_code.rb')
+          e "No file could be found at `#{sfile(entry)}`."
+          e
+          e 'The caller() backtrace was:'
+          e
+          pp caller()
+          e
+        end
+      end
+      # ===================================================================== #
+      # The .flatten operation has to be optional, since we may also have
+      # two different curricula combined, in a bachelor-master setup.
+      # ===================================================================== #
+      if entry.is_a? Array
+        entry.flatten! if do_flatten_the_dataset
+        entry.reject! {|line|
+          if line.is_a? String
+            line.strip.empty?
+          elsif line.is_a? Array
+            line.select {|inner_line| inner_line.strip.empty? }
+          end
+        }
+        unless optional_commands == :retain_comments
+          entry.reject! {|line|
+            line.strip.start_with?('#')
+          }
+        end
+      else
+        e 'The input is not an Array - this may indicate an error. '\
+          '(reported from the file '+__FILE__+')'
+      end
+      entry
+    }
+    dataset.flatten!
+    if optional_commands
+      case optional_commands
+      # ===================================================================== #
+      # === :remove_comments_and_title
+      #
+      # This entry point chops away any comments and also entries with
+      # @title.
+      # ===================================================================== #
+      when :remove_comments_and_title
+        dataset.map! {|line|
+          if line and line.include?('#')
+            line = line[0 .. (line.index('#') - 1)]
+            line.strip!
+          end
+          line = nil if line and line.include?('@title ') # Remove it here then.
+          line
+        }
+        dataset.compact!
+      # ===================================================================== #
+      # This entry point chops away any comments.
+      # ===================================================================== #
+      when :remove_comments
+        dataset.map! {|line|
+          if line.include? '#'
+            line = line[0 .. (line.index('#') - 1)]
+            line.strip!
+          end
+          line
+        }
+      end
+    end
+    return dataset # And return the dataset here finally.
+  end
+
+  # ========================================================================= #
+  # === Studium.return_title_from_this_curriculum_file
+  #
+  # Do note that for this method to work, the curriculum-file at hand
+  # has to exist locally.
+  #
+  # The special entries called :indi1, :indi2, :indi3 and at the least
+  # also :indi4 should remain single, individual entries in the following
+  # case/when menu. The reason for this is so that we can always pinpoint
+  # to the individual curriculum number 1, number 2, number 3 and so
+  # forth.
+  #
+  # Usage examples:
+  #
+  #   Studium.return_title_from_this_curriculum_file(:bachelor_vektor) # => "Bachelorcurriculum Vector-based strategies in Life Sciences, (Bio)Informatics, Molecular Medicine and Biotechnology"
+  #   Studium.return_title_from_this_curriculum_file(:indi2)           # => "Bachelorcurriculum Informatik und Biotechnologie unter Berücksichtigung immunanalytisch-molekularmedizinischer Aspekte"
+  #
+  # ========================================================================= #
+  def self.return_title_from_this_curriculum_file(
+      i                                                        = :default_input_file,
+      also_remove_the_bachelor_master_attribution_at_the_start = false
+    )
+    if i.is_a? Array # Handle the situation when an Array is given here.
+      # ===================================================================== #
+      # Since as of December 2022 we will simply assume that the last
+      # element is the most important entry. This assumption may change
+      # at a later point in time, though.
+      # ===================================================================== #
+      i = i.last
+    end
+    case also_remove_the_bachelor_master_attribution_at_the_start
+    # ======================================================================= #
+    # === :shorter
+    # ======================================================================= #
+    when :shorter
+      also_remove_the_bachelor_master_attribution_at_the_start = true
+    end
+    # ======================================================================= #
+    # Handle nil-values given as input next.
+    # ======================================================================= #
+    i = :default_input_file if i.nil?
+    unless i.is_a?(String) and File.exist?(i)
+      i = ::Studium.return_file_for_this_curriculum(i.to_sym)
+    end
+    if i.is_a? Array
+      i = i.last
+    end
+    if i.is_a?(String) and File.exist?(i)
+      # ===================================================================== #
+      # If the file exists, we can read it in.
+      # ===================================================================== #
+      dataset = readlines_with_the_default_encoding(i)
+      if dataset[1].start_with? '# === '
+        title = dataset[1].strip.delete('#=').strip
+        if also_remove_the_bachelor_master_attribution_at_the_start
+          title.sub!(/^Bachelorcurriculum/,'')
+          title.sub!(/^Mastercurriculum/,'')
+          title.strip!
+        end
+        return title # We assume this to be the title, and hence return it.
+      end
+    else
+      # e "No file exists at `#{i}`. Thus, no title of "\
+      #   "the curriculum can be determined."
+    end
+    nil # Default return-value.
+  end
+
+  # ========================================================================= #
+  # === Studium.has_a_bachelor_curriculum?
+  #
+  # A bachelor curriculum most commonly starts with the three numbers
+  # '033'.
+  # ========================================================================= #
+  def self.has_a_bachelor_curriculum?(array)
+    if array.is_a? String
+      array = [array] # Ad-hoc change here.
+    end
+    array.any? {|line|
+      line.to_s.start_with?('033') # or
+      # line.to_s.start_with?('196') # or # For diploma-curricula. Actually 196041 is Mastercurriculum Lehramt Biologie.
+      # line.to_s.start_with?('199') # This is incorrect, though. See: Master Lehramt UF Chemie (199 504)
+    } if array
+  end; self.instance_eval { alias is_a_bachelor_lecture?           has_a_bachelor_curriculum? } # === Studium.is_a_bachelor_curriculum?
+       self.instance_eval { alias has_a_bachelor_curriculum_entry? has_a_bachelor_curriculum? } # === Studium.has_a_bachelor_curriculum_entry?
+       self.instance_eval { alias is_this_a_bachelor_curriculum?   has_a_bachelor_curriculum? } # === Studium.is_this_a_bachelor_curriculum?
+
+  # ========================================================================= #
+  # === Studium.has_a_master_curriculum?
+  #
+  # This method expects the input-argument to be an Array.
+  #
+  # Since April 2020, if the input is a String then it will be converted
+  # into an Array.
+  # ========================================================================= #
+  def self.has_a_master_curriculum?(array)
+    if array.is_a? String
+      array = [array]
+    end
+    array.any? {|line|
+      line.to_s.start_with?('066') or
+      line.to_s.start_with?('196') or # For diploma-curricula.
+      line.to_s.start_with?('199')
+    }
+  end; self.instance_eval { alias has_a_master_lecture?                              has_a_master_curriculum? } # === Studium.has_a_master_lecture?
+       self.instance_eval { alias has_a_master_curriculum_entry?                     has_a_master_curriculum? } # === Studium.has_a_master_curriculum_entry?
+       self.instance_eval { alias is_this_lecture_registered_in_a_master_curriculum? has_a_master_curriculum? } # === Studium.is_this_lecture_registered_in_a_master_curriculum?
+       self.instance_eval { alias is_this_a_master_curriculum?                       has_a_master_curriculum? } # === Studium.is_this_a_master_curriculum?
+       self.instance_eval { alias is_a_master_curriculum?                            has_a_master_curriculum? } # === Studium.is_a_master_curriculum?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'colours/colours_e_autoinclude.rb'
+  require 'verbose_truth'
+  _ = '300019 Computational methods in microbial ecology'
+  e Colours.rev
+  unless ARGV.empty?
+    _ = ARGV.join(' ').strip
+  end
+  e "Is #{_} a master lecture? "\
+    "#{VerboseTruth[Studium.is_a_master_lecture?(_).to_s]}"
+  Studium.return_array_location_of_all_registered_curricula.each {|entry|
+    if entry.is_a? String
+      e entry
+    else
+      pp entry
+    end
+  }
+  # ========================================================================= #
+  # === From curriculum-ID to university:
+  # ========================================================================= #
+  e Studium.from_curriculum_id_to_university(ARGV)
+  e
+  pp Studium.read_dataset_from_a_curriculum_file
+  e
+  e Studium.map_curriculum_number_to_curriculum_name('033602')
+  e Studium.map_curriculum_name_to_curriculum_number('Bachelorcurriculum Pferdewissenschaften')
+  e Studium.map_curriculum_name_to_curriculum_number('Bachelorcurriculum Biologie')
+  e
+  pp Studium.return_lectures_belonging_to_this_curriculum
+  e
+  pp Studium.return_this_curriculum_as_a_string(ARGV)
+  e
+  pp Studium.return_dataset_from_this_curriculum_file # (ARGV)
+  e '(1) First showing the result of Studium.return_title_from_this_curriculum_file(ARGV)'
+  e
+  e steelblue(Studium.return_title_from_this_curriculum_file(ARGV))
+  e
+  e '(2) Next showing the result of Studium.return_title_from_this_curriculum_file(ARGV, true)'
+  e '    which will be shorter.'
+  e
+  e steelblue(Studium.return_title_from_this_curriculum_file(ARGV, :shorter))
+  e
+  e Studium.return_curriculum_of_this_lva_number(ARGV)
+  e
+  if ARGV.empty?
+    Studium.is_this_lecture_part_of_the_vector_curriculum(ARGV, :be_lenient)
+  else
+    e Studium.is_this_lecture_part_of_the_vector_curriculum(ARGV, :be_lenient)
+  end
+
+  result = Studium.lectures_without_attribution_to_any_curriculum
+  e
+  result.each {|name, hash|
+    remote_url = hash[:homepage].to_s
+    e '  '+slateblue(name.ljust(25))+
+      ' '+lightblue(remote_url)
+  }
+  e
+  Studium.show_passed_ects_in_the_individual_bachelor_and_master_curricula  
+  e
+  e Studium.name_of_this_curriculum(ARGV)
+end # no_attribution
+    # hasamastercurriculum 301284 Biochemie
+    # rb return_this_curriculum_as_a_string.rb Bachelor genetik
+    # rb return_dataset_from_this_curriculum_file
+    # returntitlefromthiscurriculumfile mvec
+    # returncurriculumofthislvanumber 033521
+    # isthislecturepartofthevectorcurriculum "Molekulare Medizin 2"
+    # isthislecturepartofthevectorcurriculum "Molekulare Medizin 1"
+    # isthislecturepartofthevectorcurriculum "Biochemie für Biologen"
+    # isthislecturepartofthevectorcurriculum "Methods in ultrastructure research in Eng"
+    # isthislecturepartofthevectorcurriculum "153.075 Chemie für TPH"
+    # isthislecturepartofthevectorcurriculum "362.111 Biophysik"
+    # isthislecturepartofthevectorcurriculum "Laboratory course in molecular biology II (in Eng.)"
+    # isthislecturepartofthevectorcurriculum "Ausgewählte Kapitel aus der KTWW"
+    # showpassedectsintheindividualbachelorandmastercurricula
+    # nameofthiscurriculum indi2