studium 0.13.1

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

@@ -0,0 +1,403 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/curricula/determine_curricula/misc.rb'
+# =========================================================================== #
+module Studium
+
+class DetermineCurricula < Base # === Studium::DetermineCurricula
+
+  # ========================================================================= #
+  # === append_entries_from_this_curriculum
+  #
+  # Input to this method should be a file containing the lectures
+  # of the given individual curriculum.
+  # ========================================================================= #
+  def append_entries_from_this_curriculum(
+      i = :bachelor_vektoren
+    )
+    dataset = ''.dup
+    use_these_files = curriculum_location_of(i)
+    case i
+    # ======================================================================= #
+    # === :indi3
+    # ======================================================================= #
+    when :indi3,
+         :master_bioinformatics_and_nanobiotechnology_in_molecular_medicine,
+         :master_bioinformatics_and_molecular_biotechnology,
+         :master_informatik_und_molekulare_biologie
+      use_these_files = curriculum_location_of(:indi3)
+    # ======================================================================= #
+    # === :indi2
+    # ======================================================================= #
+    when :indi2,
+         :bachelor_bioinformatik_und_biotechnologie
+      use_these_files = curriculum_location_of(:bachelor_bioinformatik_und_biotechnologie)
+    # ======================================================================= #
+    # === :master_dummy
+    # ======================================================================= #
+    when :master_dummy,
+         :mdummy
+      use_these_files = curriculum_location_of(:master_dummy_curriculum)
+    # ======================================================================= #
+    # === :dummy
+    # ======================================================================= #
+    when :dummy,
+         :bachelor_dummy
+      use_these_files = curriculum_location_of(:bachelor_dummy_curriculum)
+    # ======================================================================= #
+    # === :indi4
+    # ======================================================================= #
+    when :indi4,
+         :bachelor_biologische_informatik
+      use_these_files = curriculum_location_of(:indi4)
+    # ======================================================================= #
+    # === :bachelor_master_vektoren
+    # ======================================================================= #
+    when :bachelor_master_vektoren
+      if @show_only_master_curricula
+        use_these_files = curriculum_location_of(:master_vektoren)
+      elsif @show_only_bachelor_curricula
+        use_these_files = curriculum_location_of(:bachelor_vektoren)
+      else
+        use_these_files = [
+          curriculum_location_of(:bachelor_vektoren),
+          curriculum_location_of(:master_vektoren)
+        ]
+      end
+    end
+    unless use_these_files.is_a? Array # Ensure that we work on an Array.
+      use_these_files = [use_these_files]
+    end
+    use_these_files.flatten!
+    notify_the_user_that_these_files_will_be_used(use_these_files)
+    # ======================================================================= #
+    # Now that we have notified the user which files will be used,
+    # we can read in these files.
+    # ======================================================================= #
+    use_these_files.each {|this_file|
+      content_from_this_file = read_this_file(this_file)
+      set_title_from_this_file(content_from_this_file)
+      dataset << content_from_this_file
+    }
+    # ======================================================================= #
+    # Next, get rid of all lines that start with '#' or that are completely
+    # empty. We will apply .strip prior to checking for '#' because there
+    # may also be entries such as '             # === STEOP END'.
+    # ======================================================================= #
+    dataset = dataset.split(N).reject {|line|
+      line.strip.empty? or line.strip.start_with? '#'
+    }
+    dataset.map! {|line|
+      if line.include? '#'
+        line = line[0 .. (line.index('#') - 1)]
+      end
+      line.strip!
+      line.squeeze(' ')
+    }
+    @dataset = dataset
+  end
+
+  # ========================================================================= #
+  # === main_file?
+  # ========================================================================= #
+  def main_file?
+    Studium.file_lecture_information
+  end
+
+  # ========================================================================= #
+  # === colourize_this_file_with_two_colours
+  # ========================================================================= #
+  def colourize_this_file_with_two_colours(i)
+    if i.include? '/'
+      i = sfile(i)
+      splitted = i.split('/')
+      last_part = splitted.last
+      splitted[-1] = paleturquoise(last_part)
+      i = splitted.join('/')
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === is_this_curriculum_an_individual_curriculum?
+  # ========================================================================= #
+  def is_this_curriculum_an_individual_curriculum?(
+      i = @title
+    )
+    ARRAY_TITLE_OF_THE_INDIVIDUAL_CURRICULA.include?(i)
+  end
+
+  # ========================================================================= #
+  # === is_it_a_bachelor_curriculum?
+  #
+  # Here we assume that a bachelor curriculum will have 180.0 ECTS points
+  # in total.
+  # ========================================================================= #
+  def is_it_a_bachelor_curriculum?
+    @total_ects_points == 180.0
+  end
+
+  # ========================================================================= #
+  # === bachelor?
+  # ========================================================================= #
+  def bachelor?
+    @show_only_bachelor_curricula
+  end
+
+  # ========================================================================= #
+  # === master?
+  # ========================================================================= #
+  def master?
+    @show_only_master_curricula
+  end
+
+  # ========================================================================= #
+  # === find_entry_corresponding_to_this_line
+  # ========================================================================= #
+  def find_entry_corresponding_to_this_line(line)
+    @dataset_from_file_lecture_information[line]
+  end
+
+  # ========================================================================= #
+  # === dataset_from_file_lecture_information?
+  # ========================================================================= #
+  def dataset_from_file_lecture_information?
+    @dataset_from_file_lecture_information
+  end
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  # ========================================================================= #
+  def set_commandline_arguments(
+      i = :default
+    )
+    if i.is_a? Array and i.empty?
+      i << :default
+    end
+    @commandline_arguments = i
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments?
+  # ========================================================================= #
+  def commandline_arguments?
+    @commandline_arguments
+  end; alias input? commandline_arguments? # === input?
+
+  # ========================================================================= #
+  # === remove_leading_numbers
+  # ========================================================================= #
+  def remove_leading_numbers(i)
+    i.sub(/^\d{1,7}\.?[A-Z]{0,1}\d{1,4} /,'') # <- Must also check for "185.A47" entries.
+  end
+
+  # ========================================================================= #
+  # === consider_using_a_default_curriculum_if_no_other_instructions_were_issued
+  #
+  # This method ensures that we can work on a default curriculum, if
+  # no other dataset has been provided.
+  # ========================================================================= #
+  def consider_using_a_default_curriculum_if_no_other_instructions_were_issued
+    append_entries_from_this_curriculum(
+      :bachelor_master_vektoren
+    ) if @dataset.nil?
+  end
+
+  # ========================================================================= #
+  # === set_title_from_this_file
+  # ========================================================================= #
+  def set_title_from_this_file(i)
+    i = i.split(N)[1].delete('#=').strip
+    @title = i
+  end
+
+  # ========================================================================= #
+  # === do_these_curricula_contain_at_the_least_one_bachelor_course?
+  #
+  # This method will return true if any of the input-array starts
+  # with the string '033'.
+  # ========================================================================= #
+  def do_these_curricula_contain_at_the_least_one_bachelor_course?(i)
+    i.any? {|line| line.start_with? '033' }
+  end
+
+  # ========================================================================= #
+  # === do_show_only_master_curricula
+  # ========================================================================= #
+  def do_show_only_master_curricula
+    @show_only_master_curricula = true
+  end
+
+  # ========================================================================= #
+  # === do_show_only_bachelor_curricula
+  #
+  # Use this method if you only want to show bachelor-curricula.
+  # ========================================================================= #
+  def do_show_only_bachelor_curricula
+    @show_only_bachelor_curricula = true
+  end
+
+  # ========================================================================= #
+  # === add_30_ects_points
+  #
+  # This method can be used to add the "Masterarbeit".
+  # ========================================================================= #
+  def add_30_ects_points
+    @total_ects_points += 30
+  end
+
+  # ========================================================================= #
+  # === notify_the_user_that_these_files_will_be_used            (notify tag)
+  # ========================================================================= #
+  def notify_the_user_that_these_files_will_be_used(i)
+    if may_we_report?
+      opnn; e 'The following file(s) will be used:'
+      result = ''.dup
+      result << N
+      i.each_with_index {|this_file, index| index += 1
+        result << "   (#{index}) "\
+                  "#{colourize_this_file_with_two_colours(this_file)}#{N}#{N}"
+      }
+      result.chomp!
+      result << N
+      e result
+    end
+  end
+
+  # ========================================================================= #
+  # === lectures?
+  # ========================================================================= #
+  def lectures?
+    @dataset
+  end
+
+  # ========================================================================= #
+  # === may_we_report?
+  # ========================================================================= #
+  def may_we_report?
+    @may_we_report
+  end
+
+  # ========================================================================= #
+  # === iterate_over_the_main_dataset
+  #
+  # This method is the main powerhorse method of this class. In order for
+  # it to work, the variable @dataset must exist.
+  # ========================================================================= #
+  def iterate_over_the_main_dataset
+    if may_we_report?
+      e lime("#{@title}:")+N+N # In lime colour.
+    end
+    @dataset.each_with_index {|line, index| index += 1
+      line.squeeze!(' ')
+      _ = find_entry_corresponding_to_this_line(line)
+      if _
+        n_ects_points = _[:ects]
+        if n_ects_points.nil?
+          opnn; e "#{swarn('DEBUG:')} Something went wrong with the entry `"\
+                  "#{sfancy(entry)}`: No ects points were found."
+        end
+        curricula = _['curricula']
+        # =================================================================== #
+        # === Intercept erroneous curricula-entries (nil or empty)
+        #
+        # Note that the above variable can still be nil, so we must
+        # handle these cases.
+        # =================================================================== #
+        if curricula.nil? or curricula.empty? 
+          opnn; e "No entry appears to be registered for the "\
+                  "lecture #{simp(line)}"
+        end
+        unless curricula.is_a? Array
+          curricula = [curricula]
+        end
+        @total_ects_points += n_ects_points
+        curriculum_number = turquoise('[Curricula used: ')+
+                            springgreen(
+                              curricula.join(', ').to_s
+                            )+turquoise(']:')
+        padded_this_lecture = remove_leading_numbers(
+          line
+        ).ljust(88)
+        # =================================================================== #
+        # Report the lecture here.
+        # =================================================================== #
+        if may_we_report?
+          e "#{orange((index.to_s+')').rjust(4))} "\
+            "#{sfancy(padded_this_lecture)} #{curriculum_number}"
+        end
+        curricula.each {|this_curriculum|
+          @hash_storing_all_curricula[this_curriculum] += n_ects_points
+        }
+        # =================================================================== #
+        # Next, add a random entry to the university at hand:
+        # =================================================================== #
+        sample = curricula.sample
+        this_university = from_curriculum_id_to_university(sample)
+        if this_university.nil?
+          # ================================================================= #
+          # We have two ways: first we determine the university from
+          # the variable @dataset_from_file_lecture_information;
+          # and if this still does not work then we will simply
+          # report to the user that something is wrong.
+          # ================================================================= #
+          if @dataset_from_file_lecture_information.has_key?(line)
+            this_university = @dataset_from_file_lecture_information[line][:university]
+            case this_university
+            when /^TU Vienna$/
+              this_university = 'TU Wien'
+            end
+          else
+            opnn; e 'Careful - a nil value has been obtained for '+sfancy(sample)+'.'
+            opnn; e 'Right now this means that the program will stop here, so'
+            opnn; e 'that this error can be corrected.'
+            opnn; e 'The curricula used here were:'
+            pp curricula
+            e steelblue(padded_this_lecture)
+            exit
+          end
+        end
+        @hash_n_ects_at_this_university[this_university] += n_ects_points.to_f
+      else
+        opnn; e "No entry was found for `#{sfancy(line.to_s)}`."
+        opnn; e 'This must be corrected before we can continue.'
+        opnn; e "Have a look at the file `#{sfile(main_file?)}`."
+        if line.to_s.empty?
+          opnn; e 'As the line was empty, we will show the whole '\
+                  '@dataset variable next:'
+          e
+          pp @dataset
+          e
+        end
+        opnn; e 'Exiting now.'
+        exit
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === Studium::DetermineCurricula[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.determine_curricula
+# =========================================================================== #
+def self.determine_curricula(i = ARGV)
+  Studium::DetermineCurricula.new(i)
+end
+
+# =========================================================================== #
+# === Studium.load_this_yaml_file
+# =========================================================================== #
+def self.load_this_yaml_file(i = :indi2)
+  Studium::DetermineCurricula.new(i) { :do_not_report }.lectures?
+end
+
+end

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

@@ -0,0 +1,143 @@
+#!/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.rb'
+
+  # ========================================================================= #
+  # === 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}"
+    index = 0
+    sorted.each {|id_number_of_the_curriculum, n_ects_points| index += 1
+      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 lightgreen(
+            index.to_s.rjust(2)+
+            ') '
+          )+
+          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
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= # 
+  def report
+    report_curricula_used
+  end
+
+  # ========================================================================= #
+  # === 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
+
+end; end

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

@@ -0,0 +1,59 @@
+#!/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()
+    infer_the_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
+    # ======================================================================= #
+    # === @show_only_bachelor_curricula
+    # ======================================================================= #
+    @show_only_bachelor_curricula = false
+    # ======================================================================= #
+    # === @show_only_master_curricula
+    # ======================================================================= #
+    @show_only_master_curricula = false
+    # ======================================================================= #
+    # === @hash_n_ects_at_this_university
+    # ======================================================================= #
+    @hash_n_ects_at_this_university = {}
+    @hash_n_ects_at_this_university.default = 0
+  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