studium 0.13.1

data/lib/studium/curricula/curriculum_module_displayer/show_and_report.rb

@@ -0,0 +1,190 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/curricula/curriculum_module_displayer/show_and_report.rb'
+# =========================================================================== #
+module Studium
+
+class CurriculumModuleDisplayer < Studium::Base # === Studium::CurriculumModuleDisplayer
+
+  # ========================================================================= #
+  # === do_show_only_the_modules
+  #
+  # Invoke this method like so:
+  #
+  #   CurriculumModuleDisplayer --show-modules
+  #
+  # ========================================================================= #
+  def do_show_only_the_modules
+    e
+    @hash_keeping_the_modules.each {|this_name, array_these_lectures_are_part_of_that_module|
+      n_ects_points_in_this_module = 0
+      first_lecture = array_these_lectures_are_part_of_that_module.first
+      pointer = main_dataset?[first_lecture]
+      result  = slateblue(this_name.rjust(3)).dup
+      if pointer.has_key? :name_of_the_curriculum_module
+        array_these_lectures_are_part_of_that_module.each {|this_lecture|
+          n_ects_points = main_dataset?[this_lecture][:ects]
+          n_ects_points_in_this_module += n_ects_points
+        }
+        title = pointer[:name_of_the_curriculum_module].strip
+        result << ' '+royalblue(title)+' '+
+                  colour_for_ects_points(
+                    n_ects_points_in_this_module.to_s+' ECTS'
+                  )
+      end
+      e result
+    }
+    e
+  end
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  # ========================================================================= #
+  def show_help
+    e
+    e 'These curricula are especially important:'
+    e
+    e '  --genetik'
+    e '  --bvektor'
+    e '  --mvektor'
+    e '  --bmvektor'
+    e
+    e 'Furthermore, you can show a short summary over the modules, via:'
+    e
+    e '  --overview'
+    e
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  #
+  # This is the main report-method of this class. It will report the
+  # findings on the commandline to the end-user.
+  # ========================================================================= #
+  def report(
+      hash = @hash_keeping_the_modules
+    )
+    hash.each_pair {|name_of_the_module, array_these_lectures_are_part_of_that_module|
+      total_ects = return_n_ects_of_this_lecture(
+        array_these_lectures_are_part_of_that_module
+      )
+      # ===================================================================== #
+      # First, display the title of the module.
+      # ===================================================================== #
+      e
+      e gold('Modul: '+name_of_the_module.ljust(12))+
+        colour_for_ects_points('[zu '+total_ects.to_s+' ECTS Punkten]')+
+        steelblue(
+          ' ['+array_these_lectures_are_part_of_that_module.size.to_s+
+          ' Lehrveranstaltungen in diesem Modul]'
+        )
+      # ===================================================================== #
+      # Notify the user if we have too few entries in the module.
+      # ===================================================================== #
+      if @ensure_minimum_size_of_a_module
+        if total_ects.to_f < MINIMAL_AMOUNT_OF_ECTS_POINTS_PER_MODULE
+          notify_the_user_that_this_module_has_too_few_ects_points(
+            name_of_the_module,
+            total_ects
+          )
+          exit
+        end
+      end
+      # ===================================================================== #
+      # Also peek at the first lecture's dataset, in order to determine
+      # whether it has a key called :name_of_the_curriculum_module. 
+      # ===================================================================== #
+      first_lecture = array_these_lectures_are_part_of_that_module.first
+      pointer = main_dataset?[first_lecture]
+      if pointer.has_key? :name_of_the_curriculum_module
+        # =================================================================== #
+        # === Show the title of that particular module
+        #
+        # In this case a key was found, so we can display that title of
+        # the module at hand, such as "Advanced techniques in molecular
+        # biology".
+        # =================================================================== #
+        title = pointer[:name_of_the_curriculum_module]
+        e "       #{lightgreen('Name: ')}"\
+                 "#{lightgreen(title.chomp)}" # <- Show the name of the module here.
+      end
+      # ===================================================================== #
+      # Next, we will also show dependencies that this module has on other,
+      # prior modules. We do so only after checking for a certain instance
+      # variable - and only IF this module has at the least one dependency.
+      # ===================================================================== #
+      if @show_dependency_on_other_modules
+        if has_a_dependency_on_a_prior_module?(pointer)
+          # ================================================================= #
+          # Ok, this lecture has a dependency. We will show it at once,
+          # but only once.
+          # ================================================================= #
+          if pointer[return_the_proper_module_dependency_entry]
+            e mediumturquoise(
+                '       This module depends on these prior modules: '
+              )+
+              mediumseagreen(
+                pointer[return_the_proper_module_dependency_entry].join(', ').strip
+              )
+          end
+        end
+      end
+      e
+      array_these_lectures_are_part_of_that_module.each {|this_lecture|
+        n_ects = return_n_ects_of_this_lecture(this_lecture)
+        belongs_to_this_university = which_university?(this_lecture)
+        lecture_belongs_to_these_curricula = which_curricula?(this_lecture)
+        has_the_lecture_been_completed_already = already_solved?(this_lecture)
+        has_description = has_description?(this_lecture)
+        unless has_description
+          e crimson('No :description entry was found for ')+
+            sfancy(this_lecture)+crimson('.')
+        end
+        # =================================================================== #
+        # Ok, we will next add the amount of ECTS to the different
+        # curricula there.
+        # =================================================================== #
+        lecture_belongs_to_these_curricula.each {|this_curriculum_number|
+          @hash_ects_per_curriculum[this_curriculum_number] += n_ects
+        }
+        @n_ects_in_total += n_ects
+        @hash_universities[belongs_to_this_university] += n_ects
+        result = '  '+
+                 royalblue(
+                   this_lecture.ljust(90)
+                 )+
+                 colour_for_ects_points(
+                   n_ects.to_s.rjust(4)+' ECTS'
+                 ) # <- Add the ECTS here
+        # =================================================================== #
+        # Next, add the university to this.
+        # =================================================================== #
+        result << ' '+colour_for_university(
+          belongs_to_this_university.ljust(12)
+        )
+        # =================================================================== #
+        # == Colourize success or failure text
+        #
+        # We will also show a small text in red or green colour. Green will
+        # indicate that this exam has already been passed; and the red text
+        # will indicate that we have not yet passed that exam.
+        # =================================================================== #
+        if has_the_lecture_been_completed_already
+          result << lightgreen('[completed already]')
+        else
+          result << crimson('[not yet completed]')
+        end
+        e result
+      }
+    }
+    e
+    e "This curriculum has a total of "\
+      "#{colour_for_ects_points(@n_ects_in_total.to_s+' ECTS points')}."
+    e
+    report_average_module_size
+    report_university_attribution if @shall_we_report_university_attribution
+  end
+
+end; end

data/lib/studium/curricula/determine_curricula/constants.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/curricula/determine_curricula/constants.rb'
+# =========================================================================== #
+module Studium
+
+class DetermineCurricula < Base
+
+end; end

data/lib/studium/curricula/determine_curricula/determine_curricula.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::DetermineCurricula
+#
+# This class will determine in which curriculum/curricula any given
+# lecture is. This makes the most sense for individual curricula,
+# but it can also be applied to non-individual curricula.
+#
+# This functionality then allows us to automatically generate some
+# statistics about that.
+#
+# Usage example:
+#
+#   Studium::DetermineCurricula.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/curricula/determine_curricula/determine_curricula.rb'
+# x = Studium::DetermineCurricula.new('indi2')
+# =========================================================================== #
+require 'studium/base/base.rb'
+require 'studium/curricula/determine_curricula/constants.rb'
+require 'studium/curricula/determine_curricula/help.rb'
+require 'studium/curricula/determine_curricula/initialize.rb'
+require 'studium/curricula/determine_curricula/menu.rb'
+require 'studium/curricula/determine_curricula/misc.rb'
+require 'studium/curricula/determine_curricula/report.rb'
+require 'studium/curricula/determine_curricula/reset.rb'
+require 'studium/curricula/determine_curricula/run.rb'
+
+module Studium
+
+class DetermineCurricula < Base # === Studium::DetermineCurricula
+
+end; end

data/lib/studium/curricula/determine_curricula/help.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/curricula/determine_curricula/help.rb'
+# =========================================================================== #
+module Studium
+
+class DetermineCurricula < Base 
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  # ========================================================================= #
+  def show_help
+    result =<<EOF
+
+Several curricula are defined. Only a few will be highlighted here:
+ 
+  detcur --bvektoren
+  detcur --bachelor-vektoren
+  detcur --bvektor
+  detcur --master-vektoren
+  detcur --bachelor-master-vektoren
+  detcur --bachelor-genetik
+  detcur --bachelor-mikrobiologie                      # ← individual curriculum
+  detcur --bachelor-informatik-und-molekulare-biologie # ← individual curriculum
+  detcur --dummy                                       # ← generic individual curriculum
+
+If you only want to show courses registered in a bachelor-curriculum
+then you may want to use the option:
+ 
+  detcur --only-bachelor-curricula
+  detcur --only-master-curricula
+
+EOF
+    e result
+  end
+
+end; end

data/lib/studium/curricula/determine_curricula/initialize.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/curricula/determine_curricula/initialize.rb'
+# =========================================================================== #
+module Studium
+
+class DetermineCurricula < Base # === Studium::DetermineCurricula
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already           = true
+    )
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    reset
+    # ======================================================================= #
+    # === Handle blocks
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :do_not_run_yet
+      # ===================================================================== #
+      when :do_not_run_yet
+        run_already = false
+      # ===================================================================== #
+      # === :do_not_report
+      #
+      # Use this like so:
+      #
+      #   x = Studium::DetermineCurricula.new('indi2') { :do_not_report }
+      #
+      # ===================================================================== #
+      when :do_not_report
+        @may_we_report = false
+      end
+    end
+    run if run_already
+  end
+
+end; end

data/lib/studium/curricula/determine_curricula/menu.rb

@@ -0,0 +1,151 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/curricula/determine_curricula/menu.rb'
+# =========================================================================== #
+module Studium
+
+class DetermineCurricula < Base
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === detcur --indi1
+      #
+      # This is also known as indi1, at the TU Vienna. The name is
+      # "Bachelorcurriculum Informatik und molekulare Biologie".
+      # ===================================================================== #
+      when /^-?-?indi1$/i,
+           /^-?-?bachelor(-|_)?informatik(-|_)?und(-|_)?molekulare(-|_)?biologie$/i,
+           /^-?-?bachelor(-|_)?biologische(-|_)?informatik$/i
+        append_entries_from_this_curriculum(:bachelor_informatik_und_molekulare_biologie)
+      # ===================================================================== #
+      # === detcur --indi2
+      #
+      # This is also known as indi2. The title is "Bachelorcurriculum
+      # (Bio)Informatik und molekulare Biotechnologie, unter
+      # Berücksichtigung medizinisch-immunologischer Aspekte".
+      # ===================================================================== #
+      when /^-?-?indi2$/i,
+           /^-?-?bachelor(-|_)?bioinformatik(-|_)?und(-|_)?biotechnologie$/i
+        append_entries_from_this_curriculum(:indi2)
+      # ===================================================================== #
+      # === detcur --indi3
+      #
+      # This is known as "indi3" since as of June 2022.
+      # ===================================================================== #
+      when /^-?-?indi3$/i,
+           /^-?-?master(-|_)?boku(-|_)?individuell$/i,
+           '3'
+        # add_30_ects_points
+        append_entries_from_this_curriculum(:indi3)
+      # ===================================================================== #
+      # === detcur --bvektoren --only-bachelor
+      #
+      # This is also known as "indi3" since as of June 2022.
+      # ===================================================================== #
+      when /^-?-?bachelor(-|_)?vektoren$/i,
+           /^-?-?bachelor(-|_)?vektor$/i,
+           /^-?-?bvektoren$/i,
+           /^-?-?bvektor$/i,
+           /^-?-?indi5$/i,
+           /^-?-?indi$/i,
+           /^-?-?bvek$/i,
+           /^-?-?bvec$/i,
+           '5'
+        append_entries_from_this_curriculum(:bachelor_vektoren)
+      # ===================================================================== #
+      # === detcur --indi4
+      #
+      # This is also known as indi4, a master-curriculum.
+      # ===================================================================== #
+      when /^-?-?indi4$/i,
+           /^-?-?master(-|_)?bioinformatics(-|_)?and(-|_)?molecular(-|_)?biotechnology$/i,
+           /^-?-?master(-|_)?informatik(-|_)?und(-|_)?molekulare(-|_)?biologie$/i,
+           /^-?-?master(-|_)?biologische(-|_)?informatik$/i
+        append_entries_from_this_curriculum(:master_bioinformatics_and_molecular_biotechnology)
+      # ===================================================================== #
+      # === detcur --bachelor_dummy
+      # ===================================================================== #
+      when /^-?-?bachelor(-|_)?dummy?$/i,
+           /^-?-?dummy?$/i
+        append_entries_from_this_curriculum(:bachelor_dummy)
+      # ===================================================================== #
+      # === detcur --master_dummy
+      # ===================================================================== #
+      when /^-?-?master(-|_)?dummy?$/i,
+           /^-?-?mdummy?$/i
+        append_entries_from_this_curriculum(:master_dummy)
+      # ===================================================================== #
+      # === detcur --master-vektoren
+      # ===================================================================== #
+      when /^-?-?master(-|_)?vektoren$/i,
+           /^-?-?master(-|_)?vektorx?$/i,
+           /^-?-?mvek$/i,
+           /^-?-?mvec$/i,
+           /^-?-?mvektor$/i,
+           '4'
+        append_entries_from_this_curriculum(:master_vektoren)
+        add_30_ects_points
+      # ===================================================================== #
+      # === detcur --bachelor-master-vektoren
+      # ===================================================================== #
+      when /^-?-?bachelor(-|_)?master(-|_)?vektoren$/i,
+           '6',
+           :default # This is the default entry point.
+        append_entries_from_this_curriculum(:bachelor_master_vektoren)
+      # ===================================================================== #
+      # === detcur --only-bachelor-curricula
+      # ===================================================================== #
+      when /^-?-?only(-|_)?bachelor(-|_)?curricula$/i,
+           /^-?-?only(-|_)?bachelor$/i,
+           /^-?-?bachelor$/i,
+           /^-?-?b$/i
+        do_show_only_bachelor_curricula
+      # ===================================================================== #
+      # === detcur --bachelor-mikrobiologie
+      # ===================================================================== #
+      when /^-?-?bachelor(-|_)?mikrobiologie$/i
+        append_entries_from_this_curriculum(:bachelor_mikrobiologie)
+      # ===================================================================== #
+      # === detcur --only-master-curricula
+      # ===================================================================== #
+      when /^-?-?only(-|_)?master(-|_)?curricula$/i,
+           /^-?-?only(-|_)?master$/i,
+           /^-?-?master$/i
+        do_show_only_master_curricula
+      # ===================================================================== #
+      # === detcur --help
+      # ===================================================================== #
+      when /help/
+        show_help
+        exit
+      # ===================================================================== #
+      # === detcur ----bachelor-molbio
+      # ===================================================================== #
+      when /^-?-?bachelor(-|_)?mol(-|_)?bio$/i,
+           '7'
+        append_entries_from_this_curriculum(:bachelor_molbio)
+      # ===================================================================== #
+      # === detcur --bachelor-boku-individuell
+      # ===================================================================== #
+      when /^-?-?bachelor(-|_)?boku(-|_)?individuell$/i,
+           '8'
+        append_entries_from_this_curriculum(:bachelor_boku_individuell)
+      else
+        opnn; e "Input #{sfancy(i)} was not found. Is it registered?"
+        exit
+      end
+    end
+  end
+
+end; end