studium 0.16.9

data/lib/studium/toplevel_methods/lva_numbers.rb

@@ -0,0 +1,358 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file will collect methods related to dealing with the LVA-ID number
+# of different lectures. It may also include methods that may report when
+# a particular course was passed (if it was passed, that is).
+# =========================================================================== #
+# require 'studium/toplevel_methods/lva_numbers.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/constants/constants.rb'
+  require 'studium/colours/colours.rb'
+  require 'studium/toplevel_methods/sanitized_dataset_from_file_passed_exams_per_month.rb'
+  require 'studium/toplevel_methods/return_sanitized_dataset_from_the_file_lecture_information.rb'
+
+  # ========================================================================= #
+  # === Studium.return_lva_number_of_this_lecture_based_on_file_lecture_information
+  #
+  # This method will return the LVA number of a lecture.
+  #
+  # The goal is to have all useful lectures registered.
+  #
+  # As of February 2018, we will also include aliases from the file
+  # "lecture_aliases.yml".
+  # ========================================================================= #
+  def self.return_lva_number_of_this_lecture_based_on_file_lecture_information(
+      this_lecture                = 'Übungen I A - Mikrobiologie und Genetik',
+      optional_use_this_as_lva_id = nil
+    )
+    if this_lecture.is_a? Array
+      this_lecture = this_lecture.first
+    end
+    # ======================================================================= #
+    # Next, we must obtain the dataset that includes the full dataset
+    # including aliases.
+    # ======================================================================= #
+    dataset = Studium.return_sanitized_dataset_from_the_file_lecture_information_including_aliases
+    selection = dataset.select {|lva_id_and_name_of_the_lecture, inner_hash|
+      # ===================================================================== #
+      # The leading ' ' must be there, because lectures may be called like
+      # this:
+      #   "134.210 Molekulare Biophysik"
+      # And the \d{1} is because the LVA id must end with a number. And
+      # the end-anchor must also be used because some lectures may
+      # include sub-strings of the given input-name.
+      # ===================================================================== #
+      lva_id_and_name_of_the_lecture =~ /\d{1} #{Regexp.quote(this_lecture)}$/
+    }
+    if selection.empty?
+      e 'No result was found for `'+this_lecture+'`.'
+      nil
+    else
+      key_to_use = selection.keys.first
+      lva_number = key_to_use.split(' ').first
+      return lva_number
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium.already_solved_this_lva_number?
+  #
+  # This method will return true or false, depending on whether the
+  # given lecture was already solved or whether it was not.
+  #
+  # Note that you must input the LV-Number into this method.
+  #
+  # The method is limited in that it presently assumes that all LVA
+  # numbers are unique, but this does not necessarily have to be
+  # the case.
+  #
+  # The second argument is optional - if given then it should be the name
+  # of a lecture that you have passed.
+  #
+  # Usage examples:
+  #
+  #   Studium.already_solved_this_lva_number? 300211    # => true
+  #   Studium.already_solved_this_lva_number? 300131    # => true
+  #   Studium.already_solved_this_lva_number? 877817    # => true
+  #   Studium.already_solved_this_lva_number? "166.210" # => true
+  #   Studium.already_solved_this_lva_number? "899581"  # => true
+  #
+  # ========================================================================= #
+  def self.already_solved_this_lva_number?(
+      input_lecture_id             = '899581',
+      optional_name_of_the_lecture = nil
+    )
+    if input_lecture_id.is_a? Array # Convert Array into String.
+      input_lecture_id = input_lecture_id.join(' ').strip
+    end
+    # input_lecture_id = ensure_main_encoding(input_lecture_id.to_s)
+    # ======================================================================= #
+    # Grab the dataset with our exams and have it already sanitized for us.
+    # ======================================================================= #
+    original_dataset = Studium.sanitized_dataset_from_file_passed_exams_per_month
+    # ======================================================================= #
+    # Obtain all aliases to that dataset next.
+    # ======================================================================= #
+    dataset_lecture_aliases = YAML.load_file(Studium.file_lecture_aliases)
+    # ======================================================================= #
+    # In the past, we used to chop off '.' tokens, but this is not allowed
+    # anymore, as lectures at the TU Vienna may contain this '.' character.
+    # .delete('.') # We don't need a '.' character. # ^^^ see explanation
+    # ======================================================================= #
+    # ======================================================================= #
+    # Work on a copy of the dataset.
+    # ======================================================================= #
+    array_dataset = original_dataset.map {|line|
+      splitted = line.split('|')
+      # ===================================================================== #
+      # Next, we have to obtain the entry that contains the ID of the
+      # lecture. Note that the entry is hardcoded - if we ever change
+      # the format, we must change the number here as well.
+      # ===================================================================== #
+      lecture_name          = splitted[9].strip
+      lva_id_of_the_lecture = splitted[7].strip
+      [ lva_id_of_the_lecture, lecture_name ] # We also need the lecture name.
+    }
+    hash_dataset = {}
+    array_dataset.each {|lva_id_of_the_lecture, lecture_name|
+      if hash_dataset.has_key? lva_id_of_the_lecture
+        # In this case, simply append to the Array.
+        hash_dataset[lva_id_of_the_lecture] << lecture_name
+      else # else use a new Array.
+        hash_dataset[lva_id_of_the_lecture] = [lecture_name]
+      end
+    }
+    # ======================================================================= #
+    # We must also add the alias-keys to the above dataset.
+    # ======================================================================= #
+    dataset_lecture_aliases.each_pair {|name_of_the_lecture, inner_hash_dataset|
+      if inner_hash_dataset.has_key? :new_name
+        name_of_the_lecture = inner_hash_dataset[:new_name]
+      end
+      old_lva_id = inner_hash_dataset[:old_lva_id] # <- Needs no check as it is a mandatory entry.
+      if inner_hash_dataset.has_key? :new_lva_id
+        new_lva_id = inner_hash_dataset[:new_lva_id]
+      else
+        new_lva_id = old_lva_id.dup
+      end
+      if hash_dataset.has_key? new_lva_id
+        hash_dataset[new_lva_id] << name_of_the_lecture
+      else
+        hash_dataset[new_lva_id] = [name_of_the_lecture]
+      end
+    }
+    all_keys = hash_dataset.keys # <- The keys containing the solved LVA-IDs.
+    # ======================================================================= #
+    # Next, get rid of all '.' tokens in the dataset. This is no longer
+    # allowed as of February 2018.
+    # ======================================================================= #
+    # dataset.map! {|line| line.delete('.') }
+    already_solved_this_lva_number = false # <- Our return value.
+    # ======================================================================= #
+    # If the user supplied the name of the lecture, we have to use it;
+    # otherwise we can simply query on the LVA-id entry directly.
+    # ======================================================================= #
+    if optional_name_of_the_lecture
+      # ===================================================================== #
+      # Ok, we must check not only on the LVA-ID alone, but also on the
+      # name of the lecture. Additionally, we must also check on the
+      # alias-name, if one is registered.
+      # ===================================================================== #
+      # First, query whether the keys include the LVA number, via a selection.
+      # ===================================================================== #
+      if hash_dataset.has_key?(input_lecture_id)
+        subarray = hash_dataset[input_lecture_id]
+        already_solved_this_lva_number = (
+          subarray.include? optional_name_of_the_lecture
+        )
+      # else
+      end
+    else
+      # ===================================================================== #
+      # This clause here will be simpler. Here, if the Array above has
+      # the LVA-ID, and there is no optional name given, then we will
+      # return true. There is no logical alternative to this - if we
+      # passed the lecture, then we passed it. If a user wants more
+      # control over that, then he has to also pass in the name of
+      # the lecture.
+      # ===================================================================== #
+      if all_keys.include? input_lecture_id
+        already_solved_this_lva_number = true
+      end
+    end
+    return already_solved_this_lva_number
+  end
+
+  # ========================================================================= #
+  # === Studium.report_when_this_lecture_lvaid_was_passed
+  # ========================================================================= #
+  def self.report_when_this_lecture_lvaid_was_passed(
+      lvaid = ARGV
+    )
+    lvaid = lvaid.first if lvaid.is_a? Array
+    if Studium.already_solved_this_lva_number? lvaid
+      dataset = Studium.return_sanitized_dataset_from_the_file_lecture_information
+      matches = dataset.select {|name_of_the_lecture, value|
+        name_of_the_lecture.start_with? lvaid
+      }
+      if matches.empty?
+        e 'No match was found.'
+      else
+        first_match = matches.first
+        inner_dataset = first_match[1]
+        already_solved_at = inner_dataset[:already_solved_at].to_s
+        e 'The exam for the lecture ID '+lvaid.to_s+' has '\
+          'been successfully completed at:'
+        e
+        e '  '+::Colours.slateblue(already_solved_at)+
+          ' (name of the lecture: '+
+          ::Colours.gold(first_match[0].to_s)+
+          ')'
+        e
+      end
+    else
+      e "But the lecture LVA-ID of #{lvaid}"\
+        " has not been solved."
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium.return_lva_number_of_this_curriculum
+  #
+  # This method will return the LVA number of a particular curriculum.
+  #
+  # Pass in the name of the curriculum.
+  #
+  # Invocation example:
+  #
+  #   Studium.return_lva_number_of_this_curriculum 'Lebensmittel- und Biotechnologie'
+  #
+  # ========================================================================= #
+  def self.return_lva_number_of_this_curriculum(
+      i, be_verbose = true
+    )
+    case be_verbose
+    # ======================================================================= #
+    # === :be_quiet
+    # ======================================================================= #
+    when :be_quiet
+      be_verbose = false
+    end
+    # ======================================================================= #
+    # 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)
+    reverse_dataset = dataset.invert # Must get rid of two strings.
+    _ = {} # Build up a new hash here.
+    reverse_dataset.each_pair {|key, value|
+      # The following two lines were disabled as of 16.10.2020.
+      # key   = Studium.ensure_main_encoding(key)
+      # value = Studium.ensure_main_encoding(value)
+      # ===================================================================== #
+      # Get rid of two words from the key, aka "Bachelorcurriculum" and
+      # "Mastercurriculum".
+      # ===================================================================== #
+      key = key.first if key.is_a? Array
+      _[key.sub(/Bachelorcurriculum /,'').sub(/Mastercurriculum /,'')] = value
+    }
+    reverse_dataset = _ # Re-assign it to our dataset.
+    if i.is_a? Array
+      i.each {|entry| return_lva_number_of_this_curriculum(entry) }
+    else
+      # ===================================================================== #
+      # Next, we must find the corresponding entries in the curriculum.yml
+      # file. This file is not distributed with the studium project,
+      # since it is only useful for my own dataset.
+      #
+      # The file curricula.yml file comes bundled with the studium gem
+      # since as of February 2018. The format is a hash having
+      # key-value entries:
+      #
+      #   (1) first the number of the curriculum
+      #   (2) the full and complete name of the curriculum, at hand
+      #
+      # ===================================================================== #
+      if reverse_dataset.has_key? i
+        if be_verbose
+          e 'The curriculum '+Studium::Colours.simp(i)+' corresponds '\
+            'to the number `'+
+            Studium::Colours.sfancy(reverse_dataset[i])+'`.'
+        end
+        return reverse_dataset[i]
+      else
+        if be_verbose
+          e 'The curriculum for '+Studium::Colours.sfancy(i)+
+            ' does not appear to be registered.'
+          e '  '+Studium::Colours.sfile(Studium.file_curricula)
+        end
+        return nil
+      end
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'colours/colours_e_autoinclude.rb'
+  require 'cliner/autoinclude'
+  require 'verbose_truth'
+  # e "Input: '270090','Biomolekulare Nanotechnologie'"
+  # e Studium.already_solved_this_lva_number? '270090','Biomolekulare Nanotechnologie'
+  # e "Input: '166.156','Gentechnik und Industrielle Genomik'"
+  # e Studium.already_solved_this_lva_number? '166.156','Gentechnik und Industrielle Genomik'
+  # e "Input: '300707'"
+  # e Studium.already_solved_this_lva_number? '300707'
+  # e "Input: '300707','Molekulare Infektionsbiologie'"
+  # e Studium.already_solved_this_lva_number? '300707','Molekulare Infektionsbiologie'
+  # e Studium.already_solved_this_lva_number? '300150','Molekulare Infektionsbiologie'
+  # e Studium.already_solved_this_lva_number? '300150','Chromosomenbiologie und Cytogenetik'
+  # e Studium.already_solved_this_lva_number? '941327','Oncology for biotechnologists (in Eng.)'
+  # cliner
+  # e 'NUN Testen wir zwei inputs:'
+  # cliner
+  # e Studium.already_solved_this_lva_number?('791356')
+  # e Studium.already_solved_this_lva_number?('791356', 'Metabolic and Cell Engineering (in Eng.)')
+  # ========================================================================= #
+  # Next, we test whether aliases work. The following three/six tests
+  # must return true.
+  # ========================================================================= #
+  # e Studium.already_solved_this_lva_number? '300735'
+  # e Studium.already_solved_this_lva_number? '300735','Modellsysteme in der Molekularbiologie'
+  # e Studium.already_solved_this_lva_number? '301735','Modellsysteme in der Molekularbiologie'
+  # e Studium.already_solved_this_lva_number? '270005'
+  # e Studium.already_solved_this_lva_number? '270005','(Biochemie) Biologische Chemie I'
+  # e Studium.already_solved_this_lva_number? '270006','(Biochemie) Biologische Chemie I'
+  # e Studium.already_solved_this_lva_number? '300661'
+  # e Studium.already_solved_this_lva_number? '301171'
+  # e Studium.already_solved_this_lva_number? '301171','Übung III A - Molekularbiologische Laborarbeiten'
+  # e Studium.already_solved_this_lva_number? '500133'
+  # e Studium.already_solved_this_lva_number? '500133','Virologie für Biomediziner'
+  # e Studium.already_solved_this_lva_number? '500133','Virologie'
+  unless ARGV.empty?
+    result = Studium.already_solved_this_lva_number?(ARGV)
+    e ::Colours.rev+
+      'Has the passed LVA ID already been solved: '+
+      ::Colours.crimson(
+        VerboseTruth[result]
+      )
+    e
+    if Studium.is_on_roebe? and result
+      Studium.report_when_this_lecture_lvaid_was_passed
+    end
+  end
+  _ = Studium.return_lva_number_of_this_curriculum(ARGV)
+  e Studium.return_lva_number_of_this_lecture_based_on_file_lecture_information(_)
+end # already_solved_this_lva_number? 930105
+    # already_solved_this_lva_number? 300002
+    # already_solved_this_lva_number? "166.221"
+    # return_lva_number_of_this_curriculum 'Lebensmittel- und Biotechnologie'
+    # rb return_lva_number*lecture_information.rb 'Übungen I A - Mikrobiologie und Genetik'
+    # rb return_lva_number*lecture_information.rb 'Molekulare Evolution'
+    # rb return_lva_number*lecture_information.rb 'Molecular Evolution'

data/lib/studium/toplevel_methods/main_dataset.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The code in this file here can be used to store any arbitrary dataset,
+# for the Studium project. Usually, that dataset keeps track of the
+# dataset coming from the file called "lecture_information.yml".
+#
+# The general idea is that the file is quite large, so it is easier to
+# load it up only once and then keep on re-using that same dataset across
+# different .rb files.
+# =========================================================================== #
+# Usage example:
+#
+#   require 'studium/toplevel_methods/main_dataset.rb'
+#   if ::Studium.main_dataset?
+#
+# =========================================================================== #
+module Studium
+
+  require 'studium/toplevel_methods/return_sanitized_dataset_from_the_file_lecture_information.rb'
+
+  # ========================================================================= #
+  # === @main_dataset
+  #
+  # Initially we must put @main_dataset to nil.
+  # ========================================================================= #
+  @main_dataset = nil
+
+  # ========================================================================= #
+  # === Studium.main_dataset?
+  # ========================================================================= #
+  def self.main_dataset?
+    @main_dataset
+  end; self.instance_eval { alias dataset? main_dataset? } # === Studium.dataset?
+
+  # ========================================================================= #
+  # === Studium.set_main_dataset
+  # ========================================================================= #
+  def self.set_main_dataset(i)
+    @main_dataset = i
+  end; self.instance_eval { alias main_dataset= set_main_dataset } # === Studium.main_dataset=
+
+  # ========================================================================= #
+  # === Studium.initialize_main_dataset
+  #
+  # This method will always initialize the main dataset - call it only
+  # when you wish to keep that assignment on the toplevel, as the
+  # dataset is fairly big and may incur a bit of a "speed-penalty"
+  # due to that.
+  # ========================================================================= #
+  def self.initialize_main_dataset
+    @main_dataset =
+      return_sanitized_dataset_from_the_file_lecture_information
+  end
+
+  # ========================================================================= #
+  # === Studium.initialize_the_main_dataset_unless_it_was_already_initialized
+  # ========================================================================= #
+  def self.initialize_the_main_dataset_unless_it_was_already_initialized
+    if @main_dataset.nil?
+      initialize_main_dataset
+    end
+    return @main_dataset
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pp Studium.main_dataset?.class
+  Studium.initialize_main_dataset
+  pp Studium.main_dataset?.class
+end