studium 0.10.1

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

@@ -0,0 +1,131 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The file here just deals with report/show/display-related aspects
+# of class Studium::DetermineCurricula.
+# =========================================================================== #
+# require 'studium/curricula/determine_curricula/report_curricula.rb'
+# =========================================================================== #
+module Studium
+
+class DetermineCurricula < Base
+
+  require 'studium/toplevel_methods/report_n_ects_per_university.rb'
+
+  # ========================================================================= #
+  # === report_n_ects_per_university
+  #
+  # This method will report the ECTS attribution per university, e. g.
+  # 20.0 ECTS at the BOKU, 10.0 ECTS at the TU Vienna, and so forth.
+  #
+  # The input Hash should look like this:
+  #
+  #   {"TU Wien"=>115.5, "Uni Wien"=>30.0, "BOKU Wien"=>26.0, "Vetmed Wien"=>8.5}
+  #
+  # ========================================================================= #
+  def report_n_ects_per_university
+    Studium.report_n_ects_per_university(
+      @hash_n_ects_at_this_university,
+      @total_ects_points
+    )
+  end
+
+  # ========================================================================= #
+  # === report_curricula_used                                    (report tag)
+  # ========================================================================= #
+  def report_curricula_used
+    golden_arrow = gold(" #{right_arrow?} ")
+    # ======================================================================= #
+    # We must first sort the Hash.
+    # The entries it uses are: "033630" => 61.5
+    # ======================================================================= #
+    sorted = @hash_storing_all_curricula.sort_by {|name_of_the_curriculum, n_ects_points|
+      n_ects_points
+    }.reverse
+    e
+    e "This curriculum has a total of "\
+      "#{orange(@total_ects_points.to_s)} ECTS points. "\
+      "The percentage value will be shown as well.#{N}#{N}"
+    sorted.each {|id_number_of_the_curriculum, n_ects_points|
+      if @show_only_bachelor_curricula and
+         id_number_of_the_curriculum.start_with?('066','800','990')
+        next # The above entries ^^^ are not really bachelor-courses, so we skip them.
+      end
+      if @show_only_master_curricula and
+         id_number_of_the_curriculum.start_with?('033','193','198')
+        next # Here we skip "Lehramt".
+      end
+      name_of_the_curriculum = return_name_of_this_curriculum_based_on_its_id_number(id_number_of_the_curriculum)
+      next if name_of_the_curriculum.nil? or name_of_the_curriculum.include? 'Lehramt'
+      if name_of_the_curriculum.nil?
+        opnn; e "No name could be found for curriculum number "\
+                "#{sfancy(id_number_of_the_curriculum)}"
+      end
+      if id_number_of_the_curriculum and !id_number_of_the_curriculum.empty?
+        this_university = from_curriculum_id_to_university(id_number_of_the_curriculum)
+      else
+        this_university = "Unregistered curriculum-id "\
+                          "(#{id_number_of_the_curriculum})."
+      end
+      properly_formatted_and_colourized_string_showing_the_respective_university =
+        seagreen(
+          ' ['+this_university.to_s.center(12)+']'
+        )
+      # ===================================================================== #
+      # The amount of ECTS points will be shown on the right hand side.
+      # ===================================================================== #
+      colourized_and_padded_n_ects_points = mediumseagreen(
+        n_ects_points.to_s.rjust(4)+' ECTS points'
+      )
+      # ===================================================================== #
+      # Next we will colourizing the ID of the curriculum. The last three
+      # letters will be in a slightly lighter colour tone.
+      # ===================================================================== #
+      id_number_of_the_curriculum = id_number_of_the_curriculum.center(6)
+      first_part = id_number_of_the_curriculum[0 .. -4]
+      last_part  = id_number_of_the_curriculum[-3,3]
+      colourized_id_of_the_curriculum = sfancy(' (')+
+        mediumslateblue(first_part)+
+        mediumpurple(last_part)+ 
+        sfancy(')')
+      n_percent = (
+        ( n_ects_points * 100 ) / @total_ects_points
+      ).round(1)
+      percentage_string = springgreen(
+        ' ['+n_percent.to_s.rjust(4)+'%]'
+      )
+      if is_this_curriculum_an_individual_curriculum? and
+         is_it_a_bachelor_curriculum? and
+         !name_of_the_curriculum.include?('Bachelorcurriculum ')
+        # ===================================================================== #
+        # In this case simply pass-through, but notify the user about this
+        # at a later time.
+        # ===================================================================== #
+      else
+        # ===================================================================== #
+        # Finally report our findings to the user:
+        # ===================================================================== #
+        e slateblue(
+            name_of_the_curriculum.ljust(82)
+          )+
+          colourized_id_of_the_curriculum+
+          golden_arrow+ # A cute, golden "arrow".
+          colourized_and_padded_n_ects_points+
+          properly_formatted_and_colourized_string_showing_the_respective_university+
+          percentage_string
+      end
+    }; e
+    if is_this_curriculum_an_individual_curriculum? and
+       is_it_a_bachelor_curriculum?
+      e coral('   This is an individual bachelor-curriculum, so master-lectures')
+      e coral('   have not been shown in the above commandline-table.')
+      e
+    end
+    # ======================================================================= #
+    # Next show how many ECTS points are allotted to each university.
+    # ======================================================================= #
+    report_n_ects_per_university
+  end; alias report report_curricula_used # === report
+
+end; end

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

@@ -0,0 +1,62 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/curricula/determine_curricula/reset.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class DetermineCurricula < Base # === Studium::DetermineCurricula
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @dataset_from_file_lecture_information
+    # ======================================================================= #
+    @dataset_from_file_lecture_information = dataset_from_file_lecture_information
+    # ======================================================================= #
+    # === @may_we_report
+    # ======================================================================= #
+    @may_we_report = true
+    # ======================================================================= #
+    # === @total_ects_points
+    # ======================================================================= #
+    @total_ects_points = 0
+    # ======================================================================= #
+    # === @title
+    # ======================================================================= #
+    @title = nil
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = nil
+    # ======================================================================= #
+    # === @hash_storing_all_curricula
+    # ======================================================================= #
+    @hash_storing_all_curricula = {}
+    @hash_storing_all_curricula.default = 0
+    # ======================================================================= #
+    # === @hash_n_ects_at_this_university
+    # ======================================================================= #
+    @hash_n_ects_at_this_university = {}
+    @hash_n_ects_at_this_university.default = 0
+    # ======================================================================= #
+    # === @show_only_bachelor_curricula
+    # ======================================================================= #
+    @show_only_bachelor_curricula = false
+    # ======================================================================= #
+    # === @show_only_master_curricula
+    # ======================================================================= #
+    @show_only_master_curricula = false
+  end
+
+end; end

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

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Studium
+
+class DetermineCurricula < Base
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    menu
+    consider_using_a_default_curriculum_if_no_other_instructions_were_issued
+    iterate_over_the_main_dataset
+    report if @may_we_report
+  end
+
+end; end

data/lib/studium/curricula/determine_elective_courses_in_this_curriculum.rb

@@ -0,0 +1,112 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Curricula::DetermineElectiveCoursesInThisCurriculum
+#
+# This small class quickly determines the elective courses in a
+# given curriculum.
+#
+# Usage example:
+#
+#   Studium::Curricula::DetermineElectiveCoursesInThisCurriculum.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/curricula/determine_elective_courses_in_this_curriculum.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Curricula
+
+class DetermineElectiveCoursesInThisCurriculum < Base # === Studium::Curricula::DetermineElectiveCoursesInThisCurriculum
+
+  # ========================================================================= #
+  # === 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()
+    # ======================================================================= #
+    # === @dataset_from_the_file_lecture_information
+    # ======================================================================= #
+    @dataset_from_the_file_lecture_information = return_dataset_from_the_file_lecture_information
+  end
+
+  # ========================================================================= #
+  # === return_default_curriculum
+  #
+  # This can be toggled, to meet which curriculum you wish to
+  # query for "elective courses". 
+  # ========================================================================= #
+  def return_default_curriculum
+    :indi2
+  end
+
+  # ========================================================================= #
+  # === report
+  # ========================================================================= #
+  def report(
+      i = @array
+    )
+    n_ects = i.map {|key, value| key[:ects] }.sum
+    e rev+'A total of '+royalblue(i.size.to_s)+' courses '\
+      'are elective ("'+gold('Wahlfach')+'").'
+    e "These have a combined value of "\
+      "#{steelblue(n_ects.to_s)} ECTS credits."
+  end
+
+  # ========================================================================= #
+  # === select_proper_entries_from_this_dataset
+  # ========================================================================= #
+  def select_proper_entries_from_this_dataset(i)
+    @array = []
+    _ = @dataset_from_the_file_lecture_information
+    i.each {|name_of_the_lecture|
+      hash = _[name_of_the_lecture]
+      if hash.has_key?(:is_an_elective_course) and
+         (hash[:is_an_elective_course] == true)
+        @array << hash
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    if commandline_arguments?.empty?
+      @commandline_arguments << return_default_curriculum
+    end
+    work_on_this_curriculum = first?
+    dataset = return_lectures_from_this_curriculum(work_on_this_curriculum)
+    select_proper_entries_from_this_dataset(dataset)
+    report
+  end
+
+  # ========================================================================= #
+  # === DetermineElectiveCoursesInThisCurriculum[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Curricula::DetermineElectiveCoursesInThisCurriculum.new(ARGV)
+end # determineelectivecoursesinthiscurriculum

data/lib/studium/curricula/display_bachelor_curricula.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Curricula::DisplayBachelorCurricula
+#
+# Purpose of this small class is to simply display all Bachelor
+# curricula on the commandline, in a colourized manner.
+#
+# Usage example:
+#
+#   Studium::Curricula::DisplayBachelorCurricula.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/curricula/display_bachelor_curricula.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Curricula
+
+class DisplayBachelorCurricula < Base # === Studium::DisplayBachelorCurricula
+
+  # ========================================================================= #
+  # === 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()
+    # ======================================================================= #
+    # === @all_curricula
+    # ======================================================================= #
+    @all_curricula = YAML.load_file(FILE_CURRICULA) if File.exist? FILE_CURRICULA
+  end
+
+  # ========================================================================= #
+  # === obtain_all_bachelor_curricula
+  # ========================================================================= #
+  def obtain_all_bachelor_curricula
+    @dataset_to_display = @all_curricula.select {|key, inner_array|
+      key.start_with? '033'
+    }
+  end
+
+  # ========================================================================= #
+  # === report
+  # ========================================================================= #
+  def report(i = @dataset_to_display) 
+    i.each_pair {|key, inner_array|
+      name_of_the_curriculum = inner_array.first
+      e steelblue(key)+': '+
+        skyblue(name_of_the_curriculum)
+    }
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    obtain_all_bachelor_curricula
+    report
+  end
+
+  # ========================================================================= #
+  # === Studium::Curricula::DisplayBachelorCurricula[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Curricula::DisplayBachelorCurricula.new(ARGV)
+end # displaybachelorcurricula

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
+
+  # ========================================================================= #
+  # === Studium::Curricula::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