studium 0.13.1

data/lib/studium/ects/show_completed_ects_in_all_curricula.rb

@@ -0,0 +1,191 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ShowCompletedEctsInAllCurricula
+#
+# This class will show the completed ECTS per curriculum, sorted
+# by n ECTS first.
+#
+# Usage example:
+#
+#   Studium::ShowCompletedEctsInAllCurricula.new
+#
+# =========================================================================== #
+# require 'studium/ects/show_completed_ects_in_all_curricula.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ShowCompletedEctsInAllCurricula < Base # === Studium::ShowCompletedEctsInAllCurricula
+
+  # ========================================================================= #
+  # === CUTOFF_VALUE
+  #
+  # Below the following value we will not include these ECTS values.
+  #
+  # Not honoured if set to nil or false.
+  # ========================================================================= #
+  CUTOFF_VALUE = 5.0
+
+  # ========================================================================= #
+  # === 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()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @filter_away_lehramt_lectures
+    # ======================================================================= #
+    @filter_away_lehramt_lectures = true
+    @hash = {}
+    @hash.default = 0 # 0 ECTS by default.
+  end
+
+  # ========================================================================= #
+  # === notify_the_user_what_we_will_do
+  # ========================================================================= #
+  def notify_the_user_what_we_will_do
+    opnn; e "Showing all completed #{colourize_ects('ECTS')} in all curricula."
+  end
+
+  # ========================================================================= #
+  # === prepare_the_main_dataset
+  # ========================================================================= #
+  def prepare_the_main_dataset(
+      use_this_dataset = return_sanitized_dataset_from_file_lecture_information
+    )
+    @dataset = use_this_dataset
+    @dataset.each {|lecture_name, inner_hash_dataset|
+      already_solved = inner_hash_dataset[:already_solved]
+      next unless already_solved and (already_solved == true)
+      n_ects = obtain(:ects, inner_hash_dataset)
+      these_curricula = obtain(:curricula, inner_hash_dataset)
+      these_curricula.each {|this_curriculum_number|
+        unless this_curriculum_number.empty?
+          @hash[this_curriculum_number] += n_ects
+        end
+      }
+    }
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report(
+      i = @hash
+    )
+    sorted = i.sort_by {|curriculum_id, n_ects_points|
+      n_ects_points
+    }.reverse
+    e
+    sorted.each {|curriculum_id_number, n_ects_points|
+      padded_curriculum_id_number = curriculum_id_number.center(7)
+      padded_n_ects_points = n_ects_points.to_s.strip.rjust(8)
+      this_university = which_university?(curriculum_id_number)
+      name_of_the_curriculum = name_of_this_curriculum?(curriculum_id_number)
+      if name_of_the_curriculum.include?('Besuch einzelner Lehrveranstaltungen') or
+         name_of_the_curriculum.include?('Diplomstudium') or
+         name_of_the_curriculum.include?('Freie Wahlfächer')
+        next
+      end
+      if @filter_away_lehramt_lectures and name_of_the_curriculum.include?('Lehramt')
+        # =================================================================== #
+        # We will skip Lehramt-lectures in this case.
+        # =================================================================== #
+      else
+        # =================================================================== #
+        # Otherwise, we will report our findings to the user.
+        # =================================================================== #
+        # We must truncate the name if it is too long.
+        # =================================================================== #
+        if (name_of_the_curriculum.size > 79)
+          name_of_the_curriculum = name_of_the_curriculum[0 .. 74]+' [...]'
+        end
+        colourized_name_of_the_curriculum = steelblue(
+          name_of_the_curriculum.strip.ljust(82)
+        ) .dup
+        # =================================================================== #
+        # Next we will colourize Bachelorcurriculum and Mastercurriculum a
+        # bit differently.
+        # =================================================================== #
+        if colourized_name_of_the_curriculum.include? 'Mastercurriculum'
+          colourized_name_of_the_curriculum.sub!(
+            /Mastercurriculum/,
+            seagreen('Mastercurriculum')+
+            steelblue('')
+          )
+        elsif colourized_name_of_the_curriculum.include? 'Bachelorcurriculum'
+          colourized_name_of_the_curriculum.sub!(
+            /Bachelorcurriculum/,
+            deepskyblue('Bachelorcurriculum')+
+            steelblue('')
+          )
+        end
+        padded_this_university = this_university.ljust(11)
+        e '  '+
+          slateblue(padded_this_university)+
+          seagreen(' (')+
+          orange(padded_curriculum_id_number)+
+          mediumpurple(' - ')+ # <- A mini-spacer.
+          colourized_name_of_the_curriculum+
+          seagreen(') ')+
+          colourize_ects(padded_n_ects_points) # Colourize the amount of ECTS points.
+      end
+    }
+    e
+  end
+
+  # ========================================================================= #
+  # === colourize_ects
+  # ========================================================================= #
+  def colourize_ects(i)
+    royalblue(i)
+  end
+
+  # ========================================================================= #
+  # === consider_applying_the_cutoff_value
+  # ========================================================================= #
+  def consider_applying_the_cutoff_value
+    if CUTOFF_VALUE.is_a? Float
+      @hash.select! {|a,b| b >= CUTOFF_VALUE }
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    notify_the_user_what_we_will_do
+    prepare_the_main_dataset
+    consider_applying_the_cutoff_value
+    report
+  end
+
+  # ========================================================================= #
+  # === Studium::ShowCompletedEctsInAllCurricula[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ShowCompletedEctsInAllCurricula.new(ARGV)
+end # showcompletedectsinallcurricula

data/lib/studium/ects/show_passed_credits_per_curriculum.rb

@@ -0,0 +1,276 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ShowPassedCreditsPerCurriculum
+#
+# This class will tell us how many ECTS points have been passed per
+# registered (available) curriculum.
+#
+# Usage example:
+#
+#   Studium::ShowPassedCreditsPerCurriculum.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/ects/show_passed_credits_per_curriculum.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ShowPassedCreditsPerCurriculum < Base # === Studium::ShowPassedCreditsPerCurriculum.new
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @use_these_curricula
+    #
+    # Determine which curricula are to be checked by this class.
+    # ======================================================================= #
+    @use_these_curricula = ARRAY_REGISTERED_CURRICULA
+    # ======================================================================= #
+    # === @dataset_from_the_file_lecture_information
+    # ======================================================================= #
+    @dataset_from_the_file_lecture_information = return_dataset_from_file_lecture_information
+    # ======================================================================= #
+    # === @dataset_from_the_file_lecture_aliases
+    # ======================================================================= #
+    @dataset_from_the_file_lecture_aliases = YAML.load_file(Studium.file_lecture_aliases)
+    # ======================================================================= #
+    # === @already_showed_a_red_spacer
+    # ======================================================================= #
+    @already_showed_a_red_spacer = false
+    reset_ects_variables
+  end
+
+  # ========================================================================= #
+  # === reset_ects_variables
+  # ========================================================================= #
+  def reset_ects_variables
+    @n_ects_solved = 0
+    @total_ects_in_this_curriculum = 0
+  end
+
+  # ========================================================================= #
+  # === main_dataset?
+  # ========================================================================= #
+  def main_dataset?
+    @dataset_from_the_file_lecture_information
+  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
+
+  # ========================================================================= #
+  # === show_a_red_spacer
+  # ========================================================================= #
+  def show_a_red_spacer
+    e '  '+swarn('=' * 108)
+  end
+
+  # ========================================================================= #
+  # === iterate_over_the_curricula
+  # ========================================================================= #
+  def iterate_over_the_curricula
+    _ = @dataset_from_the_file_lecture_information
+    e
+    # ======================================================================= #
+    # The following instance variable, @use_these_curricula, has entries
+    # such as :master_vector.
+    # ======================================================================= #
+    e 'Removing some curricula next (but this should be reverted eventually):'
+
+    @use_these_curricula -= [ :bachelor_master_vektoren ]
+    @use_these_curricula -= [ :bachelor_vector ]
+    @use_these_curricula -= [ :bachelor_dummy_curriculum ]
+    @use_these_curricula -= [ :master_vector ]
+
+    @use_these_curricula.each {|this_curriculum|
+      if this_curriculum.to_s.start_with?('master_') and
+        !(@already_showed_a_red_spacer == true)
+        show_a_red_spacer
+        @already_showed_a_red_spacer = true
+      end
+      # ===================================================================== #
+      # Entries such as :bachelor_genetics are also conjugate, so we have
+      # to solve this at a later time.
+      # ===================================================================== #
+      array_curriculum_files = return_path_of_this_curriculum(this_curriculum)
+      array_curriculum_files = [array_curriculum_files] unless array_curriculum_files.is_a? Array
+      # ===================================================================== #
+      # Next, obtain the dataset.
+      # ===================================================================== #
+      dataset = []
+      array_curriculum_files.each {|this_curriculum_file|
+        file_content = read_file(this_curriculum_file)
+        dataset << sanitize_dataset(file_content)
+        dataset.flatten!
+      }
+      dataset.reject {|line| line.empty? }.each {|name_of_the_lecture|
+        pointer = _[name_of_the_lecture]
+        # =================================================================== #
+        # Next, since as of March 2022, we need to check whether an
+        # alias may exist for the lecture at hand. If so, and if the
+        # above pointer is nil, then we will ad-hoc change this,
+        # to account for the fact that some lectures may have another
+        # LVA id now.
+        # =================================================================== #
+        splitted = name_of_the_lecture.split(' ')
+        old_LVA_ID = splitted.first
+        short_name_of_the_lecture = splitted[1..-1].join(' ')
+        if pointer.nil? and @dataset_from_the_file_lecture_aliases.include?(short_name_of_the_lecture)
+          dataset_from_the_file_lecture_aliases = @dataset_from_the_file_lecture_aliases[short_name_of_the_lecture]
+          if dataset_from_the_file_lecture_aliases.has_key?(:old_lva_id) and
+            (dataset_from_the_file_lecture_aliases[:old_lva_id] == old_LVA_ID)
+            pointer = dataset_from_the_file_lecture_aliases[:new_lva_id]+' '+short_name_of_the_lecture
+            pointer = _[pointer]
+          end
+        end
+        if pointer.nil?
+          e steelblue(name_of_the_lecture)
+          opnn; e swarn('A problem was encountered.')
+          opnn; e swarn('Is the following lecture available? → ')+
+                  sfancy(name_of_the_lecture)
+          opnn; e crimson('We will also show the original dataset:')
+          e
+          pp dataset
+          e
+          exit # Exiting seems to be better in the long run.
+        else
+          if pointer.has_key? :ects
+            n_ects_points  = pointer[:ects]
+            already_solved = pointer[:already_solved]
+            if already_solved == true
+              @n_ects_solved += n_ects_points
+            end
+            @total_ects_in_this_curriculum += n_ects_points
+          else
+            e "No :ects entry for the lecture "\
+              "#{sfancy(name_of_the_lecture)}"
+          end
+        end
+      }
+      n_percentage = (
+        (@n_ects_solved.to_f * 100) / @total_ects_in_this_curriculum
+      ).round(2).to_s
+      # ===================================================================== #
+      # Padd it a bit to the right, so that percentage values below
+      # 10 will also be properly aligned.
+      # ===================================================================== #
+      n_percentage = n_percentage.rjust(5,' ')
+      n_percentage = n_percentage.ljust(5,'0')
+      n_percentage << '%'
+      prettier_name_of_the_curriculum = return_prettier_name_for(this_curriculum)
+      if this_curriculum.size > 36 # Check against the original name.
+        prettier_name_of_the_curriculum = prettier_name_of_the_curriculum[0 .. 33]+' [...]'
+      end
+      # ===================================================================== #
+      # Finally, display the result next.
+      # ===================================================================== #
+      n_ects_were_solved_padded_display = sfancy(@n_ects_solved.to_s.rjust(5))+' ECTS'
+      e '  '+sfancy(prettier_name_of_the_curriculum)+' '+
+        ' solved '+n_ects_were_solved_padded_display+'
+         out of '+
+        sfancy(@total_ects_in_this_curriculum.to_s.rjust(5))+
+        ' ECTS points in this '\
+        'curriculum. ('+slateblue(n_percentage)+')'
+      reset_ects_variables
+    }; e
+  end
+
+  # ========================================================================= #
+  # === return_prettier_name_for
+  # ========================================================================= #
+  def return_prettier_name_for(i)
+    i = i.to_s
+    if i.include? 'bachelor_'
+      i.sub!(/bachelor_/,'Bachelorcurriculum ')
+      i = i.split(' ').map(&:capitalize).join(' ')
+    elsif i.include? 'master_'
+      i.sub!(/master_/,'Mastercurriculum ')
+      i = i.split(' ').map(&:capitalize).join(' ')
+    end
+    if i.include? '_'
+      i = i.split('_').map(&:capitalize).join(' ')
+    end
+    i.ljust(40)
+  end
+
+  # ========================================================================= #
+  # === sanitize_dataset
+  # ========================================================================= #
+  def sanitize_dataset(i)
+    if i.is_a? String
+      i = i.split(N)
+    end
+    i.reject! {|entry|
+      entry.strip.empty? or entry.start_with?('#')
+    }
+    i.map! {|line|
+      if line.include?('#')
+        line = line[0 .. ( line.index('#') - 1)]
+      end
+      line.chomp
+    }
+    i.map! {|line| line.squeeze(' ') }
+    i.map!(&:strip)
+    i
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    iterate_over_the_curricula
+  end
+
+  # ========================================================================= #
+  # === Studium::ShowPassedCreditsPerCurriculum[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.show_passed_credits_per_curriculum
+# =========================================================================== #
+def self.show_passed_credits_per_curriculum(i = ARGV)
+  Studium::ShowPassedCreditsPerCurriculum.new(i)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ShowPassedCreditsPerCurriculum.new(ARGV)
+end # showpassedcreditspercurriculum

data/lib/studium/ects/simple_total_ects_points.rb

@@ -0,0 +1,135 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::SimpleTotalEctsPoints
+#
+# This class will calculate the sum of all ECTS points. In order to do
+# this, it will make use of project roebe, the "sum_of_all_numbers.rb"
+# file. 
+#
+# Usage example:
+#
+#   Studium::SimpleTotalEctsPoints.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/ects/simple_total_ects_points.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class SimpleTotalEctsPoints < Base # === Studium::SimpleTotalEctsPoints
+
+  begin
+    require 'roebe/classes/sum_of_all_numbers.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = ARGV.first,
+      run_already = true
+    )
+    super(i, false) # false for "do not run yet".
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = return_dataset_from_file_lecture_information
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i)
+    i = i.first if i.is_a? Array
+    i = i.to_s
+    # ======================================================================= #
+    # Next, use some shortcuts for my home system.
+    # ======================================================================= #
+    case i
+    when 'file2'
+      unless File.exist? i
+        i = Studium.return_this_file(:bvektor)
+      end
+    end
+    if File.exist? i
+      i = File.read(i) # Read in the file if it exists.
+    end
+    if i.include? N # If we have a newline.
+      splitted = i.split(N)
+      # ===================================================================== #
+      # Here, we get rid of all lines that start with a '#' token, as
+      # we can assume that it is a comment.
+      # ===================================================================== #
+      splitted.reject! {|line| line.strip.start_with? '#' }
+      selection = splitted.select {|entry| entry.include? ' ECTS' }
+      i = selection.join(N)
+      consider_warning_the_user_if_there_is_no_ects_substring_in_this(i)
+    end
+    if i.is_a?(String) and i.count(',') > 1
+      # ===================================================================== #
+      # At the least two ',' characters:
+      # ===================================================================== #
+      i = i.split(',').map {|line|
+        line.strip!
+        unless line.include? 'ECTS'
+          if @dataset.has_key? line
+            result = @dataset[line]
+            n_ects = result[:ects]
+            line << " # #{n_ects} ECTS"
+          end
+        end
+        line
+      }
+    end
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === consider_warning_the_user_if_there_is_no_ects_substring_in_this
+  # ========================================================================= #
+  def consider_warning_the_user_if_there_is_no_ects_substring_in_this(i)
+    unless i.include? 'ECTS'
+      opnn; e 'Note that no "ECTS" substring is in the given input.'
+      opnn; e 'We presently require this information.'
+    end
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    # ======================================================================= #
+    # Delegate to class SumOfAllNumbers next, which is part of the
+    # Roebe namespace.
+    # ======================================================================= #
+    if Object.const_defined? :Roebe
+      _ = Roebe::SumOfAllNumbers.new(input?) { :use_only_ects_points }
+    else
+      e 'The namespace Roebe (from gem roebe) is not available.'
+      e
+      e 'Please install the gem roebe:'
+      e
+      e sfancy('  gem install roebe')
+      e
+    end
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::SimpleTotalEctsPoints.new(ARGV)
+end # simpletotalectspoints 

data/lib/studium/ects/solved_ects/constants.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/ects/solved_ects/constants.rb'
+# =========================================================================== #
+module Studium
+
+class SolvedEcts < ::Studium::Base # === Studium::SolvedEcts
+
+  # ========================================================================= #
+  # === DEFAULT_ECTS_POINTS_TO_SEARCH_FOR
+  #
+  # By default, we will look for n ECTS points - usually being 3.0 ECTS
+  # points. Most lectures conform to that number.
+  # ========================================================================= #
+  DEFAULT_ECTS_POINTS_TO_SEARCH_FOR = 3.0
+
+end; end

data/lib/studium/ects/solved_ects/reset.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/ects/reset.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class SolvedEcts < ::Studium::Base # === Studium::SolvedEcts
+
+  require 'studium/toplevel_methods/sanitized_dataset_from_file_passed_exams_per_month.rb'
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @search_for_n_ects_points
+    # ======================================================================= #
+    @search_for_n_ects_points = nil # Default value.
+    # ======================================================================= #
+    # === Ensure that our main file exists before trying to load it.
+    # ======================================================================= #
+    if File.exist? main_file?
+      @dataset = ::Studium.completed_exams?
+    else
+      e "No file called `#{sfile(main_file?)}` exists. We thus can "\
+        "not continue to work and will exit as a consequence."
+      exit
+    end
+    # ======================================================================= #
+    # === @also_show_themes
+    #
+    # If the following variable is set to true then we will also show
+    # the assorted theme.
+    # ======================================================================= #
+    @also_show_themes = false
+    # ======================================================================= #
+    # === @only_at_this_university
+    # ======================================================================= #
+    @only_at_this_university = nil
+    # ======================================================================= #
+    # === @bachelor_or_master
+    # ======================================================================= #
+    @bachelor_or_master = ''
+  end
+
+end; end