studium 0.9.383

data/lib/studium/check/README.md

@@ -0,0 +1,7 @@
+This directory will contain code that will check on things pertaining
+to the studium-project as a whole, and the code quality and integrity
+of the project, such as checking that the dataset is correct or that
+the registered curricula contain only correct entries, and so forth.
+
+Thus, this directory contains validation-specific code.
+ 

data/lib/studium/check/check_curriculum_for_correct_separation_of_bachelor_and_master.rb

@@ -0,0 +1,149 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::CheckCurriculumForCorrectSeparationOfBachelorAndMaster
+#
+# This class can report erroneously attributed lectures in a curriculum.
+#
+# Usage example:
+#
+#   Studium::CheckCurriculumForCorrectSeparationOfBachelorAndMaster.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/check/check_curriculum_for_correct_separation_of_bachelor_and_master.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class CheckCurriculumForCorrectSeparationOfBachelorAndMaster < Base # === Studium::CheckCurriculumForCorrectSeparationOfBachelorAndMaster
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = return_lectures_from_file_lecture_information
+    # ======================================================================= #
+    # === @at_the_least_one_lecture_is_incorrectly_attributed
+    # ======================================================================= #
+    @at_the_least_one_lecture_is_incorrectly_attributed = false
+  end
+
+  # ========================================================================= #
+  # === report_overall_status
+  # ========================================================================= #
+  def report_overall_status
+    if @at_the_least_one_lecture_is_incorrectly_attributed
+    else
+      e 'Everything is fine in these curricula! '+gold(CHEERING_PERSON)
+    end
+  end
+
+  # ========================================================================= #
+  # === process_all_entries_in_this_master_curriculum
+  # ========================================================================= #
+  def process_all_entries_in_this_master_curriculum(
+      i = :master_vector
+    )
+    obtain_lectures_from_this_curriculum(i).each {|this_lecture|
+      this_lecture.squeeze!(' ')
+      this_lecture.strip!
+      pointer = @dataset[this_lecture]
+      curriculum_ids = obtain(:curricula_ids, pointer)
+      if has_a_master_curriculum_entry?(curriculum_ids)
+        # =================================================================== #
+        # In this case all is fine. We have found at the least one
+        # master-curriculum associated with this course.
+        # =================================================================== #
+      else
+        report_wrong_attribution_for_this_lecture(this_lecture)
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === process_all_entries_in_this_bachelor_curriculum
+  # ========================================================================= #
+  def process_all_entries_in_this_bachelor_curriculum(i = :bachelor_vector)
+    obtain_lectures_from_this_curriculum(i).each {|this_lecture|
+      this_lecture.squeeze!(' ')
+      pointer = @dataset[this_lecture]
+      curriculum_ids = obtain(:curricula_ids, pointer)
+      if has_a_bachelor_curriculum_entry?(curriculum_ids)
+        # In this case all is fine.
+      else
+        report_wrong_attribution_for_this_lecture(this_lecture)
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === report_wrong_attribution_for_this_lecture
+  # ========================================================================= #
+  def report_wrong_attribution_for_this_lecture(this_lecture)
+    @at_the_least_one_lecture_is_incorrectly_attributed = true
+    e swarn('Wrong attribution for ')+sfancy(this_lecture)+'.'
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    opnn { :no_semicolon }
+    e
+    e
+    e 'Currently this class will only check for the'
+    e 'Bachelor and the Master Vektor curricula.'
+    e
+    e '('+royalblue('1')+') First, it will be determined whether all lectures of the'
+    e 'vektor-curriculum are also part of a bachelor-curriculum.'
+    e
+    process_all_entries_in_this_bachelor_curriculum(:bachelor_vektor)
+    e
+    e '('+royalblue('2')+') Next, it will be determined whether all lectures of the'
+    e 'vektor-curriculum are also part of a master-curriculum.'
+    e
+    process_all_entries_in_this_master_curriculum(:master_vektor)
+    report_overall_status
+  end
+
+  # ========================================================================= #
+  # === Studium::CheckCurriculumForCorrectSeparationOfBachelorAndMaster[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::CheckCurriculumForCorrectSeparationOfBachelorAndMaster.new(ARGV)
+end # checkcurriculumforcorrectseparationofbachelorandmaster

data/lib/studium/check/check_for_all_exam_topics_being_registered.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::CheckForAllExamTopicsBeingRegistered
+#
+# Usage example:
+#
+#   Studium::CheckForAllExamTopicsBeingRegistered.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/check/check_for_all_exam_topics_being_registered.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class CheckForAllExamTopicsBeingRegistered < Base # === Studium::CheckForAllExamTopicsBeingRegistered
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @something_is_wrong
+    # ======================================================================= #
+    @something_is_wrong = false
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    all_exam_files = Dir["#{Studium.exam_topics?}*"]
+    all_exam_files.each {|this_file|
+      short_filename = File.basename(this_file)
+      # ===================================================================== #
+      # First check whether these are all registered in the
+      # main exam-topics file:
+      # ===================================================================== #
+      translated_result = find_corresponding_exam_topic(short_filename)
+      if translated_result == short_filename
+      else
+        e 'Something is wrong for '+sfile(short_filename)+
+          ': it is not registered.'
+        @something_is_wrong = true
+      end
+    }
+    unless @something_is_wrong
+      e steelblue('All is fine - the exam '\
+        'topics ('+all_exam_files.size.to_s+' of them) '\
+        'are all registered.')
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium::CheckForAllExamTopicsBeingRegistered[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::CheckForAllExamTopicsBeingRegistered.new(ARGV)
+end # checkforallexamtopicsbeingregistered

data/lib/studium/check/check_for_existing_description_of_this_lecture.rb

@@ -0,0 +1,194 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::CheckForExistingDescriptionOfThisLecture
+#
+# This class will check whether a particular registered lecture has a
+# :description_in_german tag or whether it does not.
+#
+# Usage example:
+#
+#   Studium::CheckForExistingDescriptionOfThisLecture.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/check_for_existing_description_of_this_lecture.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class CheckForExistingDescriptionOfThisLecture < Base # === Studium::CheckForExistingDescriptionOfThisLecture
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    # ======================================================================= #
+    # Next, we have to designate the full name of the lecture, including
+    # the LVA-ID entry.
+    # ======================================================================= #
+    set_full_name_of_the_lecture(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    @dataset = return_dataset_from_the_file_lecture_information
+    @report_only_missing_entries = true
+    # ======================================================================= #
+    # === @we_found_at_the_least_one_missing_entry
+    # ======================================================================= #
+    @we_found_at_the_least_one_missing_entry = false
+  end
+
+  # ========================================================================= #
+  # === we_did_find_at_the_least_one_missing_entry
+  # ========================================================================= #
+  def we_did_find_at_the_least_one_missing_entry
+    @we_found_at_the_least_one_missing_entry = true
+  end
+
+  # ========================================================================= #
+  # === set_full_name_of_the_lecture
+  # ========================================================================= #
+  def set_full_name_of_the_lecture(
+      i = '941106 Einführung in die Zellbiologie und Genetik'
+    )
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    @full_name_of_the_lecture = i
+  end; alias set_name set_full_name_of_the_lecture # === set_name
+
+  # ========================================================================= #
+  # === full_name_of_the_lecture?
+  # ========================================================================= #
+  def full_name_of_the_lecture?
+    @full_name_of_the_lecture
+  end; alias main_input? full_name_of_the_lecture? # === main_input?
+
+  # ========================================================================= #
+  # === do_report_all_entries
+  # ========================================================================= #
+  def do_report_all_entries
+    @report_only_missing_entries = false
+  end
+
+  # ========================================================================= #
+  # === report_how_many_entries_we_will_have
+  # ========================================================================= #
+  def report_how_many_entries_we_will_have(i)
+    opnn; e slateblue(i.size.to_s)+' lectures are part of this curriculum.'
+  end
+
+  # ========================================================================= #
+  # === consider_notifying_the_user_that_at_the_least_one_missing_description_was_found
+  # ========================================================================= #
+  def consider_notifying_the_user_that_at_the_least_one_missing_description_was_found
+    unless @we_found_at_the_least_one_missing_entry
+      opnn; e 'No missing description was found - this is good! '+
+              gold('\o/')
+    end
+  end
+
+  # ========================================================================= #
+  # === do_determine_whether_this_entry_has_a_description
+  #
+  # This method will also report our findings to the user.
+  # ========================================================================= #
+  def do_determine_whether_this_entry_has_a_description(
+      i = @full_name_of_the_lecture
+    )
+    if @dataset.has_key? i
+      pointer = @dataset[i]
+      if pointer.has_key? :description_in_german
+        unless @report_only_missing_entries
+          # ================================================================= #
+          # In this case, the lecture has an entry called
+          # :description_in_german.
+          # ================================================================= #
+          opnn; e 'The lecture '+sfancy(i)+' does have an '\
+                  'entry called :description_in_german, which is good. '+
+                  royalblue(cheering_person)
+        end
+      end
+      if pointer.has_key? :description_in_english
+        unless @report_only_missing_entries
+          # ================================================================= #
+          # In this case, the lecture has an entry called
+          # :description_in_english.
+          # ================================================================= #
+          opnn; e 'The lecture '+sfancy(i)+' does have an '\
+                  'entry called '+
+                  steelblue(':description_in_english')+, which is good. '+
+                  royalblue(cheering_person)
+        end
+      else
+        # =================================================================== #
+        # In this case, the lecture is missing an entry called :description.
+        # =================================================================== #
+        opnn; e 'The lecture '+sfancy(i)+' does '+
+                swarn('NOT')+' have an '\
+                'entry called '+steelblue(':description_in_german')+
+                ' or '+steelblue(':description_in_english')+'. '\
+                'Consider adding it.'
+        we_did_find_at_the_least_one_missing_entry # Keep track of at the least one missing entry.
+      end
+    else
+      opnn; e 'The key `'+sfancy(i)+'` has not been found. Is it registered?'
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    # ======================================================================= #
+    # Empty input means that the user supplied no argument, so we do
+    # batch-check in a hardcoded manner, towards bachelor-master vektoren.
+    # ======================================================================= #
+    if main_input?.empty?
+      array = return_dataset_from_this_curriculum_file(:bachelor_master_vektorx).keys
+    else
+      # ===================================================================== #
+      # This clause here is for regular user input.
+      # ===================================================================== #
+      array = [main_input?].flatten.compact
+      do_report_all_entries
+    end
+    report_how_many_entries_we_will_have(array)
+    array.each {|entry|
+      set_name(entry)
+      do_determine_whether_this_entry_has_a_description
+    }
+    consider_notifying_the_user_that_at_the_least_one_missing_description_was_found
+  end
+
+  # ========================================================================= #
+  # === Studium::CheckForExistingDescriptionOfThisLecture[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::CheckForExistingDescriptionOfThisLecture.new(ARGV)
+end # checkforexistingdescriptionofthislecture '941106 Einführung in die Zellbiologie und Genetik'

data/lib/studium/check/check_the_lecture_information_file.rb

@@ -0,0 +1,168 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::CheckTheLectureInformationFile
+#
+# This class will simply check whether all entries in the file called
+# "lecture_information.yml" are correct. If not then this will be
+# reported to the user.
+#
+# Usage example:
+#
+#   Studium::CheckTheLectureInformationFile.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/check_the_lecture_information_file.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class CheckTheLectureInformationFile < Studium::Base # === Studium::CheckTheLectureInformationFile
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === FILE_ARRAY_ALLOWED_ENTRIES
+  # ========================================================================= #
+  FILE_ARRAY_ALLOWED_ENTRIES = "#{Studium.yaml_dir?}"\
+    "array_allowed_entries_for_the_file_lecture_information.yml"
+    
+  # ========================================================================= #
+  # === ARRAY_ALLOWED_ENTRIES
+  #
+  # Allowed entries should be registered in this Array.
+  # ========================================================================= #
+  ARRAY_ALLOWED_ENTRIES = YAML.load_file(
+    FILE_ARRAY_ALLOWED_ENTRIES
+  )
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = return_dataset_from_the_file_lecture_information
+    @found_n_incorrect_entries = 0
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === report_whether_we_have_found_any_incorrect_entry_at_all
+  # ========================================================================= #
+  def report_whether_we_have_found_any_incorrect_entry_at_all
+    if @found_n_incorrect_entries == 0
+      opnn; e 'All is fine - no incorrect entry has been found. '+
+              lightgreen(CHEERING_PERSON)
+    end
+  end
+
+  # ========================================================================= #
+  # === iterate_over_the_main_dataset
+  # ========================================================================= #
+  def iterate_over_the_main_dataset(
+      i = @dataset
+    )
+    i.each_pair {|name_of_the_lecture, inner_hash|
+      # ===================================================================== #
+      # We only check on the keys of the inner_hash entry.
+      # ===================================================================== #
+      keys = inner_hash.keys
+      keys.each {|inner_key|
+        if is_valid_entry?(inner_key)
+          # ================================================================= #
+          # In this case, all is fine.
+          # ================================================================= #
+        else
+          @found_n_incorrect_entries += 1
+          opnn; e swarn('Not registered key called: ')+
+                  orange(inner_key.to_s)+' (type: '+
+                  steelblue(inner_key.class.to_s)+
+                  ') for the lecture '+
+                  royalblue(name_of_the_lecture)
+          opnn; e '(This key could be registered in the file '+
+                  sfile(
+                    FILE_ARRAY_ALLOWED_ENTRIES
+                  )+"`)"
+        end
+      }
+    }
+  end
+
+  # ========================================================================= #
+  # === is_valid_entry?
+  #
+  # This method will return true if the given input is part of the array
+  # of allowed entries, and it will return false otherwise.
+  # ========================================================================= #
+  def is_valid_entry?(i)
+    ARRAY_ALLOWED_ENTRIES.include? i
+  end; alias valid_entry? is_valid_entry? # === valid_entry?
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    iterate_over_the_main_dataset
+    report_whether_we_have_found_any_incorrect_entry_at_all
+  end
+
+  # ========================================================================= #
+  # === Studium::CheckTheLectureInformationFile[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.check_the_lecture_information_file
+# =========================================================================== #
+def self.check_the_lecture_information_file
+  Studium::CheckTheLectureInformationFile.new
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::CheckTheLectureInformationFile.new(ARGV)
+end # checkthelectureinformationfile