studium 0.10.1

data/lib/studium/base/commandline_arguments.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/base/commandline_arguments.rb'
+# =========================================================================== #
+module Studium
+
+class Base # === Studium::Base
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  #
+  # The commandline arguments are always an Array.
+  # ========================================================================= #
+  def set_commandline_arguments(
+      i = ARGV
+    )
+    i = [i].flatten.compact
+    @commandline_arguments = i
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments?
+  # ========================================================================= #
+  def commandline_arguments?
+    @commandline_arguments
+  end; alias commandline? commandline_arguments? # === commandline?
+
+  # ========================================================================= #
+  # === first_argument?
+  # ========================================================================= #
+  def first_argument?
+    @commandline_arguments.first
+  end; alias first? first_argument? # === first?
+
+  # ========================================================================= #
+  # === commandline_arguments_with_hyphens?
+  #
+  # This method will select all the commandline arguments that begin with
+  # '--' hyphens.
+  # ========================================================================= #
+  def commandline_arguments_with_hyphens?
+    @commandline_arguments.select {|entry|
+      entry.start_with?('--')
+    }
+  end; alias return_commandline_arguments_with_leading_hyphens commandline_arguments_with_hyphens? # === return_commandline_arguments_with_leading_hyphens
+
+  # ========================================================================= #
+  # === commandline_arguments_joined
+  #
+  # This method will, essentially, return all commandline-arguments as
+  # a String.
+  # ========================================================================= #
+  def commandline_arguments_joined
+    @commandline_arguments.join(' ').strip
+  end; alias return_commandline_arguments_as_string commandline_arguments_joined # === return_commandline_arguments_as_string
+       alias commandline_arguments_as_string        commandline_arguments_joined # === commandline_arguments_as_string
+       alias commandline_arguments_as_string?       commandline_arguments_joined # === commandline_arguments_as_string?
+       alias commandline_string?                    commandline_arguments_joined # === commandline_string?
+       alias commandline_as_string                  commandline_arguments_joined # === commandline_as_string
+       alias return_original_input_as_string        commandline_arguments_joined # === return_original_input_as_string
+
+end; end

data/lib/studium/base/constants.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/base/constants.rb'
+# =========================================================================== #
+module Studium
+
+class Base
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === Base::LEFT_PADDING
+  #
+  # The default padding (for showing the answer to an exam question) is
+  # 4 spaces since as of July 2020.
+  # ========================================================================= #
+  LEFT_PADDING = '    ' # 4 spaces for now.
+
+  # ========================================================================= #
+  # === Base::N_CHARACTERS_PER_LINE
+  #
+  # If an answer exceeds the following threshold value, then we will chop
+  # some bits off of it. The reason why we have defined this here in
+  # class Base is because at the least two other classes that are
+  # part of the Exam namespace, require this.
+  # ========================================================================= #
+  N_CHARACTERS_PER_LINE = 78
+
+end; end

data/lib/studium/base/curriculum.rb

@@ -0,0 +1,329 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file will contain code related to "curriculum" stuff. This also
+# includes obtaining all lectures that belong to said curriculum.
+# =========================================================================== #
+# require 'studium/base/curriculum.rb'
+# =========================================================================== #
+module Studium
+
+class Base # === Studium::Base
+
+  require 'studium/toplevel_methods/has_a_bachelor_or_master_curriculum.rb'
+  require 'studium/toplevel_methods/main_dataset.rb'
+
+  # ========================================================================= #
+  # === lectures_from_the_bachelor_genetik_curriculum
+  # ========================================================================= #
+  def lectures_from_the_bachelor_genetik_curriculum
+    obtain_lectures_from_this_curriculum(:bachelor_genetik_curriculum)
+  end
+
+  # ========================================================================= #
+  # === return_lectures_from_bachelor_vektor_curriculum
+  # ========================================================================= #
+  def return_lectures_from_bachelor_vektor_curriculum
+    obtain_lectures_from_this_curriculum(:bachelor_vektor)
+  end
+
+  # ========================================================================= #
+  # === convert_this_array_of_lectures_into_the_full_dataset
+  #
+  # The purpose of this method is to turn an Array that holds Strings
+  # such as "941111 Genetische Ressourcen von Nutzpflanzen" into the
+  # corresponding dataset.
+  #
+  # This method will return a Hash if everything went fine.
+  # ========================================================================= #
+  def convert_this_array_of_lectures_into_the_full_dataset(i)
+    if i.is_a? Array
+      if Studium.main_dataset?.nil?
+        Studium.initialize_main_dataset
+      end
+      _ = Studium.main_dataset?
+      hash = {}
+      i.map {|course_id_and_course_name|
+        if _.has_key?(course_id_and_course_name)
+          hash[course_id_and_course_name] = _[course_id_and_course_name]
+        end
+      }
+      hash
+    else
+      raise 'This method only accepts an Array as input.'
+    end
+  end
+
+  # ========================================================================= #
+  # === bachelor_master_or_diploma
+  #
+  # For a given solved lecture, we will determine whether it belongs
+  # to a Bachelor (B), Master (M) or Diploma (D) curriculum.
+  #
+  # For the line:
+  #
+  #   13.05.2020 | 1.0 |  1.0 | 1 |   BOKU  |   M  |   SE  |   940003   | 2020S | Emerging Topics in RNA Biology (in Eng.)
+  #         0       1      2    3      4        5
+  #
+  # It would be at 5.
+  # ========================================================================= #
+  def bachelor_master_or_diploma(
+      this_lecture, dataset = nil
+    )
+    if dataset.nil? and File.exist? FILE_PASSED_EXAMS_PER_MONTH
+      dataset = File.readlines(FILE_PASSED_EXAMS_PER_MONTH).reject {|line|
+        line.strip.empty? or
+        line.strip.start_with?('#')
+      }
+    end
+    selection = dataset.select {|line|
+      splitted = this_lecture.split(' ')
+      lecture_id = splitted.first
+      course_name = splitted[1..-1].join(' ').strip
+      line.include?(lecture_id) and
+      line.include?(course_name)
+    }
+    if selection.empty?
+      '(unknown)'
+    else
+      selection = selection.first
+      return selection.split('|')[5].strip 
+    end
+  end
+
+  # ========================================================================= #
+  # === is_a_master_lecture?
+  # ========================================================================= #
+  def is_a_master_lecture?(i)
+    Studium.is_a_master_lecture?(i)
+  end
+
+  # ========================================================================= #
+  # === has_a_master_curriculum?
+  #
+  # This method will return true if the given Array has any master
+  # curriculum; and it will return false otherwise.
+  #
+  # Note that there is an alias called
+  # "is_this_lecture_registered_in_a_master_curriculum?". The name is a
+  # of a misnomer, since the input to this method should be an Array
+  # containing the IDs of the Curricula for which that lecture is
+  # registered. This may be subject for change one day, but for
+  # now (Sep 2018) we will keep it that way.
+  # ========================================================================= #
+  def has_a_master_curriculum?(array)
+    Studium.has_a_master_curriculum?(array)
+  end; alias is_a_master_curriculum?                            has_a_master_curriculum? # === is_a_master_curriculum?
+       alias has_a_master_lecture?                              has_a_master_curriculum? # === has_a_master_lecture?
+       alias has_a_master_curriculum_entry?                     has_a_master_curriculum? # === has_a_master_curriculum_entry?
+       alias is_this_lecture_registered_in_a_master_curriculum? has_a_master_curriculum? # === is_this_lecture_registered_in_a_master_curriculum?
+
+  require 'studium/constants/return_file_for_this_curriculum.rb'
+  # ========================================================================= #
+  # === return_file_for_this_curriculum
+  # ========================================================================= #
+  def return_file_for_this_curriculum(
+      i = :bachelor_basisblock_biologie
+    )
+    if i.is_a? Array
+      i.map {|line|
+        return_file_for_this_curriculum(line)
+      }
+    else
+      # ===================================================================== #
+      #
+      #   bl $RUBY_STUDIUM/constants/return_file_for_this_curriculum.rb
+      #
+      # ===================================================================== #
+      Studium.return_file_for_this_curriculum(i)
+    end
+  end; alias return_curriculum_file_based_on_this_input  return_file_for_this_curriculum # === return_curriculum_file_based_on_this_input
+       alias curriculum_location_of                      return_file_for_this_curriculum # === curriculum_location_of
+       alias return_path_of_this_curriculum              return_file_for_this_curriculum # === return_path_of_this_curriculum
+       alias return_file_associated_with_this_curriculum return_file_for_this_curriculum # === return_file_associated_with_this_curriculum
+       alias location_of_this_curriculum_file?           return_file_for_this_curriculum # === location_of_this_curriculum_file?
+
+  # ========================================================================= #
+  # === read_dataset_from_a_curriculum_file
+  # ========================================================================= #
+  def read_dataset_from_a_curriculum_file(
+      i,
+      optional_commands = :remove_comments
+    )
+    Studium.read_dataset_from_a_curriculum_file(i, optional_commands)
+  end
+
+  # ========================================================================= #
+  # === return_name_of_this_curriculum
+  #
+  # This method will return the official name of a curriculum. In order
+  # to achieve this, the method will read the file, and grab the second
+  # line, which should contain the name of the curriculum at hand.
+  #
+  # This method will NOT remove strings such as "Bachelorcurriculum"
+  # or "Mastercurriculum", due to the individual vector-curriculum
+  # having the very same name (Bachelor + Master).
+  # ========================================================================= #
+  def return_name_of_this_curriculum(i)
+    file = return_file_for_this_curriculum(i)
+    if file.nil?
+      e 'Something went wrong for the input '+steelblue(i)+'.'
+      e 'No match could be found for it. Are you sure that it must exist?'
+      exit
+    elsif File.exist? file
+      dataset = readlines_with_proper_encoding(file)
+      name = dataset[1].delete('#=').strip
+      return name
+    end
+  end; alias return_long_name_of_this_curriculum return_name_of_this_curriculum # === return_long_name_of_this_curriculum
+
+  require 'studium/toplevel_methods/return_dataset_from_this_curriculum_file.rb'
+  # ========================================================================= #
+  # === return_dataset_from_this_curriculum_file
+  # ========================================================================= #
+  def return_dataset_from_this_curriculum_file(i)
+    Studium.return_dataset_from_this_curriculum_file(i)
+  end; alias return_dataset_for_this_curriculum_file return_dataset_from_this_curriculum_file # === return_dataset_for_this_curriculum_file
+       alias return_dataset_from_this_curriculum     return_dataset_from_this_curriculum_file # === return_dataset_from_this_curriculum
+       alias return_this_curriculum                  return_dataset_from_this_curriculum_file # === return_this_curriculum
+
+  require 'studium/constants/misc.rb'
+  # ========================================================================= #
+  # === return_all_registered_curricula
+  # ========================================================================= #
+  def return_all_registered_curricula
+    Studium.return_registered_standalone_curricula
+  end
+
+  # ========================================================================= #
+  # === do_these_curricula_include_both_a_bachelor_and_a_master_curriculum?(i)
+  #
+  # The input to this method should be an Array.
+  # ========================================================================= #
+  def do_these_curricula_include_both_a_bachelor_and_a_master_curriculum?(i)
+    result = false
+    if i.any? {|entry| entry.start_with?('033')} and
+       i.any? {|entry| entry.start_with?('066')}
+      result = true
+    end
+    return result
+  end
+
+  require 'studium/toplevel_methods/from_curriculum_id_to_university.rb'
+  # ========================================================================= #
+  # === from_curriculum_id_to_university
+  #
+  # This method will translate from the curriculum-ID to the university.
+  # So it will return a String such as "BOKU".
+  # ========================================================================= #
+  def from_curriculum_id_to_university(id)
+    ::Studium.from_curriculum_id_to_university(id)
+  end; alias from_curriculum_number_to_university from_curriculum_id_to_university # === from_curriculum_number_to_university
+       alias which_university?                    from_curriculum_id_to_university # === which_university?
+
+  require 'studium/toplevel_methods/map_curriculum_number_to_curriculum_name.rb'
+  # ========================================================================= #
+  # === return_name_of_this_curriculum_based_on_its_id_number
+  #
+  # The input to this method should be the ID of a curriculum number,
+  # ideally as a String, such as '033290'.
+  # ========================================================================= #
+  def return_name_of_this_curriculum_based_on_its_id_number(i)
+    ::Studium.map_curriculum_number_to_curriculum_name(i)
+  end; alias from_curriculum_id_to_curriculum_name                     return_name_of_this_curriculum_based_on_its_id_number # === from_curriculum_id_to_curriculum_name
+       alias return_curriculum_name_of_this_curriculum_number          return_name_of_this_curriculum_based_on_its_id_number # === return_curriculum_name_of_this_curriculum_number
+       alias curriculum_number_to_curriculum_name                      return_name_of_this_curriculum_based_on_its_id_number # === curriculum_number_to_curriculum_name
+       alias name_of_this_curriculum?                                  return_name_of_this_curriculum_based_on_its_id_number # === name_of_this_curriculum?
+       alias return_name_of_the_curriculum_based_on_this_curriculum_id return_name_of_this_curriculum_based_on_its_id_number # === return_name_of_the_curriculum_based_on_this_curriculum_id
+       alias return_name_of_the_curriculum                             return_name_of_this_curriculum_based_on_its_id_number # === return_name_of_the_curriculum
+       alias turn_id_to_curriculum_name                                return_name_of_this_curriculum_based_on_its_id_number # === turn_id_to_curriculum_name
+
+  require 'studium/toplevel_methods/return_title_from_this_curriculum_file.rb'
+  # ========================================================================= #
+  # === return_title_from_this_curriculum_file
+  #
+  # The first argument to this method should be the abbreviation of
+  # that particular curriculum.
+  # ========================================================================= #
+  def return_title_from_this_curriculum_file(
+      i,
+      use_a_shorter_name = false
+    )
+    Studium.return_title_from_this_curriculum_file(i, use_a_shorter_name)
+  end; alias return_title_of return_title_from_this_curriculum_file # === return_title_of
+
+  # ========================================================================= #
+  # === has_a_bachelor_curriculum?
+  #
+  # This method will return true if the given Array has any bachelor
+  # curriculum; and it will return false otherwise.
+  # ========================================================================= #
+  def has_a_bachelor_curriculum?(array)
+    Studium.has_a_bachelor_curriculum?(array)
+  end; alias is_a_bachelor_lecture?           has_a_bachelor_curriculum? # === is_a_bachelor_curriculum?
+       alias has_a_bachelor_curriculum_entry? has_a_bachelor_curriculum? # === has_a_bachelor_curriculum_entry?
+       alias is_a_bachelor_curriculum?        has_a_bachelor_curriculum? # === is_a_bachelor_curriculum?
+
+  # ========================================================================= #
+  # === return_all_bachelor_lectures
+  #
+  # This method will simply return all bachelor-lectures.
+  # ========================================================================= #
+  def return_all_bachelor_lectures(
+      from_this_dataset = ::Studium.main_dataset?
+    )
+    if from_this_dataset.nil?
+      ::Studium.initialize_main_dataset
+      from_this_dataset = ::Studium.main_dataset?
+    end
+    from_this_dataset.select {|name_of_the_lecture, inner_hash|
+      array = inner_hash['curricula']
+      is_a_bachelor_lecture?(array)
+    }
+  end
+
+  # ========================================================================= #
+  # === lectures_from_the_individual_vektor_curricula
+  #
+  # This method is a convenience method, returning all the lectures that
+  # belong to the individual bachelor+master vektor-curriculum
+  # ========================================================================= #
+  def lectures_from_the_individual_vektor_curricula
+    (
+      obtain_lectures_from_this_curriculum(:bachelor_vektor)+
+      obtain_lectures_from_this_curriculum(:master_vektor)
+    ).flatten
+  end
+
+  # bl $RUBY_STUDIUM/toplevel_methods/read_dataset_from_a_curriculum_file.rb
+  require 'studium/toplevel_methods/read_dataset_from_a_curriculum_file.rb'
+  # ========================================================================= #
+  # === obtain_lectures_from_this_curriculum
+  #
+  # This method should be used whenever you wish to obtain all lectures
+  # that belong to a specific curriculum, without any comments.
+  #
+  # An Array will be returned by this method.
+  # ========================================================================= #
+  def obtain_lectures_from_this_curriculum(
+      i                     = :default,
+      do_flatten_the_result = true
+    )
+    Studium.read_dataset_from_a_curriculum_file(i, :remove_comments, do_flatten_the_result).map {|entry|
+      entry.squeeze(' ') # ← We don't want multiple ' ' in succession here.
+    }
+  end; alias return_lectures_from_this_curriculum      obtain_lectures_from_this_curriculum # === return_lectures_from_this_curriculum
+       alias return_lectures_of_this_curriculum        obtain_lectures_from_this_curriculum # === return_lectures_of_this_curriculum
+       alias return_lectures_from_this_curriculu       obtain_lectures_from_this_curriculum # === return_lectures_from_this_curriculu
+       alias return_lectures_from_this_curriculum_file obtain_lectures_from_this_curriculum # === return_lectures_from_this_curriculum_file
+
+  require 'studium/toplevel_methods/methods_related_to_curricula.rb'
+  # ========================================================================= #
+  # === return_random_curriculum
+  # ========================================================================= #
+  def return_random_curriculum
+    ::Studium.return_random_curriculum
+  end
+
+end; end

data/lib/studium/base/directory_to_the_exam_topics.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/base/directory_to_the_exam_topics.rb'
+# =========================================================================== #
+module Studium # === Studium
+
+class Base
+
+  require 'studium/constants/exam_topics.rb'
+
+  # ========================================================================= #
+  # === directory_to_the_exam_topics?
+  #
+  # This method will point to the directory where all exam topics
+  # are normally kept; it is simply a "wrapper-method".
+  # ========================================================================= #
+  def directory_to_the_exam_topics?
+    Studium.directory_to_the_exam_topics?
+  end; alias exam_topics_directory? directory_to_the_exam_topics? # === exam_topics_directory?
+
+end; end