studium 0.9.383

data/lib/studium/curricula/mitteilungsbl/303/244tter.rb

@@ -0,0 +1,336 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Curricula::Mitteilungsblätter
+#
+# This class can display the URL to a "Mitteilungsblatt" for a curriculum
+# at a local university.
+#
+# Usage example:
+#
+#   Studium::Curricula::Mitteilungsblätter.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/curricula/mitteilungsblätter.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Curricula
+
+class Mitteilungsblätter < ::Studium::Base # === Studium::Curricula::Mitteilungsblätter
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === FILE_MITTEILUNGSBLÄTTER
+  #
+  #   bl $RSRC/studium/lib/studium/yaml/mitteilungsblätter.yml
+  #
+  # ========================================================================= #
+  FILE_MITTEILUNGSBLÄTTER = Studium.project_yaml_directory?+'mitteilungsblätter.yml'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    if commandline_arguments and commandline_arguments.empty?
+      show_all_mitteilungsblätter
+    else
+      set_commandline_arguments(
+        commandline_arguments
+      )
+      run if run_already
+    end
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @dataset
+    #
+    # This variable will contain the different "Mitteilungsblätter",
+    # or rather, the respective URL to them.
+    # ======================================================================= #
+    @dataset = nil
+    # ======================================================================= #
+    # === @use_this_language_for_the_class
+    #
+    # The following can be either :german or :english. If it is :english
+    # then the class will display information in english; otherwise it
+    # will display that information in german.
+    # ======================================================================= # 
+    @use_this_language_for_the_class = :german
+  end
+
+  # ========================================================================= #
+  # === use_german?
+  # ========================================================================= #
+  def use_german?
+    @use_this_language_for_the_class == :german
+  end
+
+  # ========================================================================= #
+  # === load_the_yaml_dataset
+  # ========================================================================= #
+  def load_the_yaml_dataset
+    _ = Studium.file_mitteilungsblätter
+    if File.exist? _
+      @dataset = YAML.load_file(_)
+    else
+      opnn; no_file_exists_at(_)
+    end
+  end
+
+  # ========================================================================= #
+  # === process_commandline_arguments
+  # ========================================================================= #
+  def process_commandline_arguments
+    @commandline_arguments.map! {|entry|
+      if entry.is_a?(String) and
+         entry.include?('Bachelorcurriculum') and
+         entry.include?(N) and
+         entry.include?('(') and
+         entry.include?(')')
+        # =================================================================== #
+        # Here we will seek all entries that are like this: (033282)
+        # =================================================================== #
+        splitted = entry.split(N)
+        entry = splitted.map {|inner_entry| inner_entry.scan(/\(\d{3,6}\)/) }
+      end
+      entry
+    }
+    @commandline_arguments.flatten!
+    @commandline_arguments.map! {|entry| entry.delete('()') }
+    sort_the_commandline_arguments
+    # ======================================================================= #
+    # Next pass them through the menu() interface.
+    # ======================================================================= #
+    menu(
+      @commandline_arguments
+    )
+  end
+
+  # ========================================================================= #
+  # === sort_the_commandline_arguments
+  # ========================================================================= #
+  def sort_the_commandline_arguments
+    @commandline_arguments.sort_by! {|entry| entry.to_i }
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  #
+  # Pass the commandline arguments into the menu() interface.
+  # ========================================================================= #
+  def menu(
+      i = @commandline_arguments
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      if i.start_with? '--'
+        # ===================================================================== #
+        # Leading '--' commands will be treated differently in that we will
+        # assume that this will be something like --indi3. This means that
+        # we will obtain all lectures, then obtain all individual curricula,
+        # and then display these curricula.
+        # ===================================================================== #
+        handle_this_curriculum(i)
+      else
+        # ===================================================================== #
+        # Define three important variables next.
+        # ===================================================================== #
+        this_university = from_curriculum_id_to_university(i)
+        name_of_the_curriculum = return_name_of_the_curriculum_based_on_this_curriculum_id(i)
+        url_to_the_remote_mitteilungsblatt = @dataset[i]
+        if url_to_the_remote_mitteilungsblatt.is_a? Array
+          if url_to_the_remote_mitteilungsblatt.size == 1
+            url_to_the_remote_mitteilungsblatt = url_to_the_remote_mitteilungsblatt.first
+          end
+        end
+        e steelblue(i)+': '+
+            royalblue(
+              name_of_the_curriculum.
+            ljust(60)
+            )+
+            mediumpurple(
+              " (#{this_university})"
+            )
+        if @dataset.has_key? i
+          if url_to_the_remote_mitteilungsblatt.is_a? Hash
+            url_to_the_remote_mitteilungsblatt.each_pair {|key, value|
+              if use_german?
+                e "  #{lightgreen('→')} #{lightgreen(value)} "\
+                  "(#{royalblue(key)})"
+              else
+                e "  #{lightgreen('→')} #{lightgreen(value)} "\
+                  "(from #{royalblue(key)})"
+              end
+            }
+          else
+            e lightgreen("  → #{url_to_the_remote_mitteilungsblatt}")
+          end
+        else
+          if use_german?
+            e crimson('  Nicht registrierter URL Eintrag: ')+
+              steelblue(i)
+          else
+            e crimson('  Not registered URL entry: ')+
+              steelblue(i)
+          end
+        end
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === show_all_mitteilungsblätter
+  # ========================================================================= #
+  def show_all_mitteilungsblätter
+    if @dataset.nil?
+      load_the_yaml_dataset
+    end
+    e 'Showing all available Mitteilungsblätter:'
+    e
+    @dataset.each_pair {|curriculum_id, value|
+      value = value.values.first if value.respond_to? :values
+      name_of_the_curriculum = turn_id_to_curriculum_name(curriculum_id)
+      e "  #{lightblue(name_of_the_curriculum.ljust(30))} "\
+        "(#{steelblue(curriculum_id)}):"
+      e "    #{olivedrab('→')} #{royalblue(value)}"
+    }
+    e
+  end
+
+  # ========================================================================= #
+  # === right_arrow
+  # ========================================================================= #
+  def right_arrow
+    '→'
+  end
+
+  # ========================================================================= #
+  # === show_the_mitteilungsblatt_for_this_curriculum
+  #
+  # Do note that the input to this method is assumed to be an Array, with
+  # entries such as ["066220", "066417", "066418", and so forth.
+  # ========================================================================= #
+  def show_the_mitteilungsblatt_for_this_curriculum(i)
+    if i.is_a? Array
+      i.each {|entry|
+        show_the_mitteilungsblatt_for_this_curriculum(entry)
+      }
+    else
+      # ===================================================================== #
+      # Ok - here we know that we can actually show the "Mitteilungsblatt".
+      # ===================================================================== #
+      pointer = @dataset[i]
+      name_of_the_curriculum = return_name_of_the_curriculum(i)
+      this_university        = from_curriculum_id_to_university(i)
+      e steelblue(i)+': '+
+        royalblue(
+          name_of_the_curriculum.ljust(60)
+        )+
+        mediumpurple(
+          " (#{this_university})"
+        )
+      if pointer
+        left_side = pointer.keys.first.to_s
+        e lightgreen(left_side)
+      end
+      # ===================================================================== #
+      # Next display all URLs associated with that curriculum. These
+      # URLs will have a right arrow, a UNICODE arrow.
+      # ===================================================================== #
+      if pointer.respond_to? :values
+        pointer.values.each {|this_url|
+          if this_url.is_a? String
+            e "  #{mediumaquamarine(right_arrow)} #{mediumorchid(this_url)}"
+          end
+        }
+      elsif pointer.is_a? Array
+        pointer.each {|this_url|
+          if this_url.is_a? String
+            e "  #{mediumaquamarine(right_arrow)} #{mediumorchid(this_url)}"
+          end
+        }
+      elsif pointer.is_a? String
+        e "  #{mediumaquamarine(right_arrow)} #{mediumorchid(pointer)}"
+      else
+        e 'Not known:'
+        pp pointer
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === handle_this_curriculum
+  #
+  # To enter this method, try:
+  #
+  #   mblatt --indi3
+  #   mblatt --indi4
+  #
+  # ========================================================================= #
+  def handle_this_curriculum(i)
+    i = i.dup if i.frozen?
+    if i.start_with? '--'
+      i.sub!(/^--/,'')
+    end
+    lectures_from_the_curriculum = return_this_curriculum(i)
+    # Next we must obtain all "Mitteilungsblätter".
+    _ = lectures_from_the_curriculum.map {|key, inner_hash|
+      inner_hash['curricula']
+    }
+    _.flatten!
+    _.uniq!
+    if i.include?('indi3') or i.include?('indi2')
+      # ===================================================================== #
+      # Reject master-curricula from the list, and entries that
+      # are too short.
+      # ===================================================================== #
+      _.reject! {|entry| entry.start_with?('066') or (entry.size == 3) }
+    end
+    _.sort!
+    e
+    show_the_mitteilungsblatt_for_this_curriculum(_)
+    e
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    load_the_yaml_dataset
+    process_commandline_arguments
+  end
+
+  # ========================================================================= #
+  # === Mitteilungsblätter[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Curricula::Mitteilungsblätter.new(ARGV)
+end # mitteilungsblätter 033282

data/lib/studium/curricula/modules/display_on_the_commandline.rb

@@ -0,0 +1,339 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Curricula::Modules::DisplayOnTheCommandline
+#
+# This class will show all modules belonging to a particular
+# curriculum, on the commandline. The associated lectures
+# of these modules will also be shown.
+#
+# Thus, this class acts a bit like a pretty-printer for exam data.
+#
+# It was originally called Studium::ShowModulesOnTheCommandline,
+# but it was relocated in December 2019 to a separate location
+# and newly written code.
+#
+# Usage example:
+#
+#   Studium::Curricula::Modules::DisplayOnTheCommandline.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/curricula/modules/display_on_the_commandline.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Curricula
+
+module Modules
+
+class DisplayOnTheCommandline < ::Studium::Base # === Studium::Curricula::Modules::DisplayOnTheCommandline
+
+  # ========================================================================= #
+  # === 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
+    # ======================================================================= #
+    # === @we_seek_this_curriculum
+    #
+    # Set a default curriculum to use on startup.
+    # ======================================================================= #
+    @we_seek_this_curriculum = set_seek_this_curriculum(:default)
+    # ======================================================================= #
+    # === @hash_containing_all_modules
+    # ======================================================================= #
+    @hash_containing_all_modules = {}
+    # ======================================================================= #
+    # === @total_n_ects_points
+    # ======================================================================= #
+    @total_n_ects_points = 0
+  end
+
+  # ========================================================================= #
+  # === set_we_seek_this_curriculum
+  #
+  # We need to treat the individual curricula in a special way here,
+  # because they are not defined in the yaml file 'curricula.yml'.
+  # ========================================================================= #
+  def set_we_seek_this_curriculum(i)
+    case i # case tag, main tag
+    # ======================================================================= #
+    # === :indi4
+    # ======================================================================= #
+    when :indi4,
+         :default
+      i = 'Mastercurriculum (Bio)Informatics and molecular biotechnology including aspects from molecular medicine'
+    # ======================================================================= #
+    # === :indi1
+    # ======================================================================= #
+    when :indi1
+      i = 'Bachelorcurriculum Vector-based strategies in Life Sciences, (Bio)Informatics, Molecular Medicine and Biotechnology'
+    # ======================================================================= #
+    # === :indi2
+    # ======================================================================= #
+    when :indi2
+      i = 'Bachelorcurriculum (Bio)Informatik und molekulare Biotechnologie, unter Berücksichtigung medizinisch-immunologischer Aspekte'
+    # ======================================================================= #
+    # === :indi3
+    # ======================================================================= #
+    when :indi3
+      i = 'Bachelorcurriculum Informatik und molekulare Biologie'
+    else
+      i = return_name_of_this_curriculum(i)
+    end
+    @we_seek_this_curriculum = i.strip
+  end; alias set_seek_this_curriculum set_we_seek_this_curriculum # === set_seek_this_curriculum
+
+  # ========================================================================= #
+  # === name_of_the_curriculum?
+  # ========================================================================= #
+  def name_of_the_curriculum?
+    @we_seek_this_curriculum
+  end
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  # ========================================================================= #
+  def set_commandline_arguments(i = '')
+    i = [i].flatten.compact
+    @commandline_arguments = i
+  end
+
+  # ========================================================================= #
+  # === determine_the_main_curriculum
+  # ========================================================================= #
+  def determine_the_main_curriculum
+    _ = first_argument?
+    if _
+      set_we_seek_this_curriculum(_)
+    end
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments?
+  # ========================================================================= #
+  def commandline_arguments?
+    @commandline_arguments
+  end
+
+  # ========================================================================= #
+  # === first_argument?
+  # ========================================================================= #
+  def first_argument?
+    @commandline_arguments.first
+  end
+
+  # ========================================================================= #
+  # === notify_the_user_what_will_be_done
+  # ========================================================================= #
+  def notify_the_user_what_will_be_done
+    opnn { :no_trailing }
+    e
+    e
+    e "Working on the curriculum "\
+      "#{skyblue(@we_seek_this_curriculum)} next."
+    e 'The file that was used, was: `'+sfile(
+        return_file_associated_with_this_curriculum(
+          @we_seek_this_curriculum
+        )
+      )+'`'
+  end
+
+  # ========================================================================= #
+  # === report
+  # ========================================================================= #
+  def report(
+      i = @hash_containing_all_modules
+    )
+    @lecture_entry_number = 0
+    # ======================================================================= #
+    # And display it as well.
+    # ======================================================================= #
+    e
+    e
+    i.each_pair {|individual_curriculum_module, inner_dataset|
+      long_name_of_the_module = inner_dataset[:name_of_the_module]
+      lectures_in_this_module = inner_dataset[:lectures]
+      padded_module_number = "#{individual_curriculum_module}: ".ljust(5)
+      n_ects_in_this_module = lectures_in_this_module.map {|key, hash|
+        hash[:ects]
+      }.sum
+      depends_on_these_modules = inner_dataset[:this_module_depends_on_these_other_modules]
+      _ = ''.dup
+      depends_on_these_modules.each {|this_module|
+        if this_module.include? 'None'
+          _ << 'This module depends on no other module.'
+        else
+          _ << crimson('→ ')
+          _ << springgreen(this_module)
+          _ << ' '
+        end
+      }
+      # ===================================================================== #
+      # Next strip on it:
+      # ===================================================================== #
+      _.strip!
+      # ===================================================================== #
+      # Display: "Module #nr"
+      # ===================================================================== #
+      colourized_n_ECTS_in_this_module = mediumorchid(
+        "[#{n_ects_in_this_module} ECTS in Module "\
+        "#{individual_curriculum_module}]"
+      )
+      e steelblue('-'*70)
+      e palegoldenrod('Module ')+
+        chocolate(padded_module_number)+
+        "#{steelblue(long_name_of_the_module.strip.ljust(58))} "+
+        colourized_n_ECTS_in_this_module
+      e mediumturquoise('            Module '+
+          long_name_of_the_module.to_s+' depends on: '+"\n"
+        )+
+        lightgreen(
+          _.rjust(50)
+        )
+      e
+      lectures_in_this_module.each_pair {|name_of_the_lecture, most_inner_dataset|
+        n_ects = most_inner_dataset[:ects]
+        @lecture_entry_number += 1 # Keep track of the lecture-number here.
+        e '  '+
+          olivedrab(
+            (
+              @lecture_entry_number.to_s+')'
+            ).rjust(3)+' '
+          )+
+          royalblue(name_of_the_lecture.ljust(65))+
+          slateblue(
+            " [#{n_ects.to_s} ECTS]"
+          )
+      }
+      e
+    }
+  end
+
+  # ========================================================================= #
+  # === report_how_many_ECTS_points_are_attributed
+  # ========================================================================= #
+  def report_how_many_ECTS_points_are_attributed
+    e 'This curriculum ('+steelblue(name_of_the_curriculum?)+
+      ') has a total of '+royalblue(@total_n_ects_points.to_s)+
+      ' ECTS points.'
+    e
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    determine_the_main_curriculum
+    notify_the_user_what_will_be_done
+    _ = return_dataset_from_this_curriculum(@we_seek_this_curriculum)
+    if @we_seek_this_curriculum.include?('ummy') # <- Ignore "dummy" curricula.
+      _.each_pair {|name_of_the_lecture, inner_hash|
+        @total_n_ects_points += inner_hash[:ects]
+        e "  #{steelblue(name_of_the_lecture)}"
+      }
+    else
+      _.each_pair {|name_of_the_lecture, inner_hash|
+        n_ects = inner_hash[:ects]
+        if inner_hash.has_key?(:individual_curricula)
+          # =================================================================== #
+          # First, obtain all individual curricula:
+          # =================================================================== #
+          all_individual_curricula = inner_hash[:individual_curricula]
+          # =================================================================== #
+          # Obtain the correct selection next:
+          # =================================================================== #
+          selection_of_the_correct_curriculum = all_individual_curricula.select {|key, value|
+            name_of_the_curriculum = key[:name_of_the_curriculum].strip.tr('-','_')
+            name_of_the_curriculum.include? @we_seek_this_curriculum
+          }
+
+          if selection_of_the_correct_curriculum.is_a? Array
+            selection_of_the_correct_curriculum = selection_of_the_correct_curriculum.first
+          end
+          # =================================================================== #
+          # And rewrite that entry:
+          # =================================================================== #
+          inner_hash[:individual_curricula] = selection_of_the_correct_curriculum
+          @total_n_ects_points += n_ects
+          # =================================================================== #
+          # Obtain the correct selection.
+          # =================================================================== #
+          individual_curriculum_module_name       = selection_of_the_correct_curriculum[:name_of_the_curriculum_module].strip.tr('-','_')
+          individual_curriculum_module_depends_on = selection_of_the_correct_curriculum[:individual_curriculum_depends_on_these_modules]
+          individual_curriculum_module            = selection_of_the_correct_curriculum[:individual_curriculum_module]
+          # =================================================================== #
+          # Obtain the first entry of the Array next:
+          # =================================================================== #
+          first = individual_curriculum_module.flatten.first
+          if individual_curriculum_module.is_a? Array
+            individual_curriculum_module = individual_curriculum_module.first
+          end
+          unless @hash_containing_all_modules.has_key? first
+            @hash_containing_all_modules[first] = {}
+          end
+          @hash_containing_all_modules[first][:name_of_the_module] = individual_curriculum_module_name
+          # =================================================================== #
+          # Add the lecture to our big hash next:
+          # =================================================================== #
+          unless @hash_containing_all_modules[first].has_key? :lectures
+            @hash_containing_all_modules[first][:lectures] = {}
+          end
+          @hash_containing_all_modules[first][:lectures][name_of_the_lecture] = inner_hash
+          @hash_containing_all_modules[first][:this_module_depends_on_these_other_modules] =
+            individual_curriculum_module_depends_on
+        end
+      }
+      report(@hash_containing_all_modules)
+    end
+    report_how_many_ECTS_points_are_attributed
+  end
+
+  # ========================================================================= #
+  # === Studium::Curricula::Modules::DisplayOnTheCommandline[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end; end
+
+# =========================================================================== #
+# === Studium::ShowModulesOnTheCommandline
+#
+# Add an "alias" next.
+# =========================================================================== #
+ShowModulesOnTheCommandline = ::Studium::Curricula::Modules::DisplayOnTheCommandline
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Curricula::Modules::DisplayOnTheCommandline.new(ARGV)
+end # display_commandline indi1
+    # display_commandline indi3