studium 0.13.1

data/lib/studium/utility_scripts/attribute_lecture_to_curriculum/attribute_lecture_to_curriculum.rb

@@ -0,0 +1,238 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::AttributeLectureToCurriculum
+#
+# This class will correlate a curriculum-number to a particular
+# curriculum, such as 033217 being the Bachelor LBT curriculum. 
+#
+# Usage example:
+#
+#   Studium::AttributeLectureToCurriculum.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/attribute_lecture_to_curriculum/attribute_lecture_to_curriculum.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class AttributeLectureToCurriculum < ::Studium::Base # === Studium::AttributeLectureToCurriculum
+
+  require 'studium/toplevel_methods/when_was_this_lecture_passed.rb'
+
+  # ========================================================================= #
+  # === HASH_KEEP_TRACK_OF_ONLY_THESE_CURRICULA
+  #
+  # This Hash keeps track of the curricula in use.
+  # ========================================================================= #
+  HASH_KEEP_TRACK_OF_ONLY_THESE_CURRICULA = {
+    '033217' => 'Bachelorcurriculum Lebensmittel- und Biotechnologie              # BOKU Wien',
+    '033255' => 'Bachelorcurriculum Agrarwissenschaften                           # BOKU Wien',
+    '033290' => 'Bachelorcurriculum Technische Chemie                             # TU   Wien',
+    '033305' => 'Bachelorcurriculum Pharmazie                                     # Uni  Wien',
+    '033521' => 'Bachelorcurriculum Informatik                                    # Uni  Wien',
+    '033630' => 'Bachelorcurriculum Biologie                                      # Uni  Wien',
+    '033638' => 'Bachelorcurriculum Ernährungswissenschaften                      # Uni  Wien',
+    '033662' => 'Bachelorcurriculum Chemie                                        # Uni  Wien',
+    # ======================================================================= #
+    # Ab hier Master-Curricula die wir tracken möchten.
+    # ======================================================================= #
+    '066418' => 'Mastercurriculum Biotechnology                                   # BOKU Wien',
+    '066455' => 'Mastercurriculum Nutzpflanzenwissenschaften                      # BOKU Wien',
+    '066490' => 'Mastercurriculum Technische Chemie                               # TU   Wien',
+    '066605' => 'Mastercurriculum Pharmazie                                       # Uni  Wien',
+    '066830' => 'Mastercurriculum Molekulare Mikrobiologie, Mikrobielle Ökologie und Immunbiologie # Uni Wien',
+    '066832' => 'Mastercurriculum Botanik                                         # Uni  Wien',
+    '066834' => 'Mastercurriculum Molekulare Biologie                             # Uni  Wien',
+    '066838' => 'Mastercurriculum Ernährungswissenschaften                        # Uni  Wien',
+    '066862' => 'Mastercurriculum Chemie                                          # Uni  Wien',
+    '066863' => 'Mastercurriculum Biologische Chemie                              # Uni  Wien',
+    '066875' => 'Mastercurriculum Bioinformatik                                   # Uni  Wien',
+    '066877' => 'Mastercurriculum Genetik und Entwicklungsbiologie                # Uni  Wien',
+    '066910' => 'Mastercurriculum Computational Science                           # Uni  Wien',
+    '066921' => 'Mastercurriculum Informatik                                      # Uni  Wien'
+  }
+
+  # =========================================================================== #
+  # === reset
+  # =========================================================================== #
+  def reset
+    super()
+    # === @result
+    @result = nil
+    @dataset = nil # Default value.
+    @commandline = nil
+    @title = nil # Default.
+    @do_save_into_a_file = true # If this variable is true then we will store into a yaml file.
+    @use_this_encoding = main_encoding?
+  end
+
+  # =========================================================================== #
+  # === match_curriculum_name_to_curriculum_number
+  #
+  # This method will accept a given input name, and return the curriculum
+  # number, if it is registered in the above hash.
+  #
+  # This method should work quite ok, for both bachelor and master
+  # curricula.
+  #
+  # Invocation examples:
+  #
+  #   attribute --bachelor-biologie
+  #   attribute --master-biotech
+  #
+  # =========================================================================== #
+  def match_curriculum_name_to_curriculum_number(
+      search_for_this_curriculum_name
+    )
+    search_for_this_curriculum_name.delete!(' ') # We will not need these.
+    hash = HASH_KEEP_TRACK_OF_ONLY_THESE_CURRICULA
+    possible_matches = []
+    result = search_for_this_curriculum_name
+
+    hash.each_pair {|curriculum_number, curriculum_name|
+      splitted = search_for_this_curriculum_name.split('-')
+      last = splitted.last
+      curriculum_name = curriculum_name.downcase.delete(' ')
+      if curriculum_name.include? last
+        possible_matches << curriculum_number
+      end
+    }
+    # ======================================================================= #
+    # Next, everything has been stored in the variable possible_matches.
+    # ======================================================================= #
+    unless possible_matches.empty?
+      if    search_for_this_curriculum_name.include? 'bachelor'
+        possible_matches.select! {|entry|
+          entry.include? '033'
+        }
+      elsif search_for_this_curriculum_name.include? 'master'
+        possible_matches.select! {|entry|
+          entry.include? '066'
+        }
+      end
+      result = possible_matches.first # This here should be for bachelor
+    end
+    return result
+  end
+
+  # ========================================================================= #
+  # === set_url
+  # ========================================================================= #
+  def set_url(i = '')
+    if i.is_a? Array
+      determine_commandline_arguments(i)
+      i = i.first 
+    end
+    i = i.to_s.dup
+    i = nil if i.include? '--'
+    @url = i
+  end
+
+  # ========================================================================= #
+  # === curricula_assigned_exams?
+  #
+  # This will always return the dataset of the curricula-assigned exams
+  # that were passed already.
+  # ========================================================================= #
+  def curricula_assigned_exams?
+    new_hash = {}
+    dataset = YAML.load_file('/home/x/studium/YAML/curricula_assigned_exams.yml')
+    # ======================================================================= #
+    # Ensure that the values are all Strings.
+    # ======================================================================= #
+    dataset.each_pair {|key, array_value|
+      if array_value
+        array_value = array_value.map(&:to_s)
+        new_hash[key] = array_value
+      end
+    }
+    return new_hash
+  end
+
+  # ========================================================================= #
+  # === set_title
+  # ========================================================================= #
+  def set_title(i)
+    i = i.force_encoding(@use_this_encoding) # Ensure that we use the main Encoding.
+    # ======================================================================= #
+    # Ensure that the title is a valid ISO Encoding rather than an
+    # invalid UTF-8 encoding.
+    # ======================================================================= #
+    # i.gsub!(/ü/,'ü')    if i.include? "ü"    # Sanitize "ü" tokens.
+    # i.gsub!(/Ã\x9C/,'Ü') if i.include? "Ã\x9C" # Sanitize "Ü" tokens.
+    # i.gsub!(/\xDC/,'Ü')  if i.include? "\xDC" # Sanitize "Ü" tokens.
+    # i.gsub!(/ä/,'ä')    if i.include? "ä"    # Sanitize "ä" tokens.
+    # i.gsub!(/Ã\x96/,'Ö') if i.include? "Ã\x96" # Sanitize "Ö" tokens.
+    # i.gsub!(/ö/,'ö')    if i.include? "ö"    # Sanitize "ö" tokens.
+    @title = i
+  end
+
+  # ========================================================================= #
+  # === registered_curricula?
+  # ========================================================================= #
+  def registered_curricula?
+    HASH_KEEP_TRACK_OF_ONLY_THESE_CURRICULA.keys
+  end
+
+  # ========================================================================= #
+  # === assigned_exams?
+  # ========================================================================= #
+  def assigned_exams?
+    HASH_KEEP_TRACK_OF_ONLY_THESE_CURRICULA
+  end
+
+  # ========================================================================= #
+  # === title?
+  # ========================================================================= #
+  def title?
+    @title
+  end; alias name_of_the_lecture? title? # === name_of_the_lecture?
+
+  # ========================================================================= #
+  # === dataset?
+  # ========================================================================= #
+  def dataset?
+    @dataset
+  end
+
+  # ========================================================================= #
+  # === set_results
+  # ========================================================================= #
+  def set_results(i)
+    if i.is_a? Array # Sanitize the Encoding.
+      i.map! {|inner_array|
+        inner_array.map {|inner_inner_array| # <- Awful name but hey, better a long name than a short one.
+          inner_inner_array = inner_inner_array.dup.force_encoding(@use_this_encoding)
+        }
+      }
+    end unless i.empty? # Ignore empty Arrays.
+    @results = i
+  end
+
+  # ========================================================================= #
+  # === perform_the_main_task_of_this_class
+  # ========================================================================= #
+  def perform_the_main_task_of_this_class
+    obtain_dataset_from_the_remote_website
+    apply_regex
+    determine_title_of_the_lecture
+    save_into_a_file # Save it into the yaml file.
+    display_result if @result
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    menu
+    perform_the_main_task_of_this_class
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::AttributeLectureToCurriculum.new #('033217') # <- This is just for testing purposes.
+end

data/lib/studium/utility_scripts/attribute_lectures_to_university/attribute_lectures_to_university.rb

@@ -0,0 +1,375 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::AttributeLecturesToUniversity
+#
+# This class can be used to attribute lectures to universities (and
+# curricula, too). A summary will be reported on the commandline to
+# the user.
+#
+# Usage example:
+#
+#   Studium::AttributeLecturesToUniversity.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/attribute_lectures_to_university/attribute_lectures_to_university.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class AttributeLecturesToUniversity < Base # === Studium::AttributeLecturesToUniversity
+
+  # ========================================================================= #
+  # === IGNORE_LEHRAMT_CURRICULA
+  # ========================================================================= #
+  IGNORE_LEHRAMT_CURRICULA = true
+
+  # ========================================================================= #
+  # === IGNORE_MASTER_CURRICULA
+  # ========================================================================= #
+  IGNORE_MASTER_CURRICULA = true
+
+  # ========================================================================= #
+  # === DISPLAY_THE_NAME_OF_THE_LECTURES
+  # ========================================================================= #
+  DISPLAY_THE_NAME_OF_THE_LECTURES = false
+
+  # ========================================================================= #
+  # === 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
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = [] # Store stuff here.
+    # ======================================================================= #
+    # === @dataset_from_the_file_lecture_information
+    # ======================================================================= #
+    @dataset_from_the_file_lecture_information = lecture_information
+    @hash_storing_the_ects_per_university = {}
+    @hash_storing_the_ects_per_university.default = 0
+    @ignore_master_curricula = IGNORE_MASTER_CURRICULA
+    @n_ljust = 66
+    @n_ects_points_in_total = 180 # <- How many ECTS points are in this curriculum
+    @display_the_name_of_the_lectures = DISPLAY_THE_NAME_OF_THE_LECTURES
+  end
+
+  # ========================================================================= #
+  # === total_ects?
+  # ========================================================================= #
+  def total_ects?
+    @n_ects_points_in_total
+  end
+
+  # ========================================================================= #
+  # === set_120_ects_points
+  # ========================================================================= #
+  def set_120_ects_points
+    @n_ects_points_in_total = 120
+  end
+
+  # ========================================================================= #
+  # === set_300_ects_points
+  # ========================================================================= #
+  def set_300_ects_points
+    @n_ects_points_in_total = 300
+  end
+
+  # ========================================================================= #
+  # === set_180_ects_points
+  # ========================================================================= #
+  def set_180_ects_points
+    @n_ects_points_in_total = 180
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(
+      i = ''
+    )
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    case i # case tag
+    when ''
+      i = '--bachelor_vektor'
+    # ======================================================================= #
+    # === attribute_lectures_to_university file1
+    # ======================================================================= #
+    when 'file1'
+      i = Studium.return_this_file(:bvektor)
+    # ======================================================================= #
+    # === attribute_lectures_to_university file2
+    # ======================================================================= #
+    when 'file2'
+      i = studium_directory_at_home?+'TU_WIEN/yaml/'\
+          'master_individuelles_studium_nanobiotechnologische_informationssysteme.md'
+    end
+    if i.include? 'master_'
+      # ===================================================================== #
+      # In this case we will NOT ignore master-curricula entries.
+      # ===================================================================== #
+      @ignore_master_curricula = false
+    end
+    @input = i
+    if @input.include? '--'
+      menu(@input)
+    end
+  end
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  #
+  # To invoke this help-menu, do:
+  #
+  #   attribute_lecture --help
+  #
+  # For the available entry points, try:
+  #
+  #   attribute_lecture --bachelor
+  #
+  # ========================================================================= #
+  def show_help
+    opnn; e 'The following commandline-options are available for this class:'
+    e
+    e '  --bachelor  # show the attributed lectures for the bachelor curriculum'
+    e '  --master    # show the attributed lectures for the master curriculum'
+    e '  --combined  # show the attributed lectures for both curricula combined'
+    e
+  end
+
+  # ========================================================================= #
+  # === append_this_onto_the_main_dataset
+  # ========================================================================= #
+  def append_this_onto_the_main_dataset(i)
+    @dataset << i
+    @dataset.flatten!
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = @input
+    )
+    if i.is_a? Array
+      i.each {|entry|
+        menu(entry)
+      }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === attribute_lectures_to_university show_help
+      # ===================================================================== #
+      when /^-?-?help$/
+        show_help
+        exit
+      # ===================================================================== #
+      # === attribute_lectures_to_university --bachelor-master-vektor
+      # ===================================================================== #
+      when /-?-?bachelor(-|_)?master(-|_)?ve(c|k)torx?$/i,
+           /^-?-?combined$/i
+        set_300_ects_points
+        @input = return_file_for_this_curriculum(i.to_s.delete('-').to_sym)
+        @ignore_master_curricula = false
+        @n_ljust = 102
+      # ===================================================================== #
+      # === attribute_lectures_to_university --bachelor-vektor
+      # ===================================================================== #
+      when /-?-?bachelor(-|_)?ve(c|k)torx?$/i,
+           /^-?-?bachelor$/i
+        set_180_ects_points
+        @input = return_file_for_this_curriculum(i.to_s.delete('-').to_sym)
+        @ignore_master_curricula = true
+        @n_ljust = 82
+      # ===================================================================== #
+      # === attribute_lectures_to_university --master-vektor
+      # ===================================================================== #
+      when /-?-?master(-|_)?ve(c|k)torx?$/i,
+           /^-?-?master$/i
+        set_120_ects_points
+        @input = return_file_for_this_curriculum(i.to_s.delete('-').to_sym)
+        @ignore_master_curricula = false
+        @n_ljust = 82
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === check_for_an_existing_file
+  #
+  # This method can be used to check for an existing file. If it exists
+  # we will read in the dataset.
+  # ========================================================================= #
+  def check_for_an_existing_file(
+      i = @input
+    )
+    if i.is_a? Array
+      i.each {|entry| check_for_an_existing_file(entry) }
+    else
+      if File.exist? i
+        # ===================================================================== #
+        # We will do several things at once here:
+        #   (1) read the lines from the file, with the default encoding
+        #   (2) remove newlines
+        #   (3) remove empty strings on a per-line basis
+        #   (4) remove leading comments
+        #   (5) remove internal comments
+        # ===================================================================== #
+        dataset = remove_empty_strings(
+          remove_internal_comments(
+            remove_leading_comments(
+              remove_newlines(
+                readlines_with_proper_encoding(i)
+              )
+            )
+          )
+        ).map {|entry| entry.squeeze(' ') }
+        append_this_onto_the_main_dataset(dataset)
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === iterate_over_the_main_dataset
+  # ========================================================================= #
+  def iterate_over_the_main_dataset
+    if @dataset
+      @dataset.each {|entry|
+        pointer = @dataset_from_the_file_lecture_information[entry]
+        if pointer.nil?
+          e swarn('A problem was encountered (nil value) '\
+            'for the entry ')+sfancy(entry)
+            pp @dataset
+        end
+        curricula = obtain(:curricula, pointer)
+        n_ects    = obtain(:ects, pointer)
+        curricula.each {|this_curriculum|
+          @hash_storing_the_ects_per_university[this_curriculum] += n_ects
+        }
+      }
+      sorted = @hash_storing_the_ects_per_university.sort_by {|a, n_ects_points|
+        n_ects_points
+      }.reverse
+      report(sorted)
+    end
+  end
+
+  # ========================================================================= #
+  # === report
+  # ========================================================================= #
+  def report(i)
+    if i.is_a? Array
+      if IGNORE_LEHRAMT_CURRICULA or IGNORE_MASTER_CURRICULA
+        i.reject! {|a,b|
+          keep_or_reject = :keep
+          curriculum_name = curriculum_number_to_curriculum_name(a)
+          if curriculum_name.nil?
+            e "Unknown entry: #{crimson(a)}"
+            e 'This entry will be ignored.'
+            next
+          end
+          if IGNORE_LEHRAMT_CURRICULA
+            keep_or_reject = :reject if curriculum_name.include? 'Lehramt'
+          end
+          if @ignore_master_curricula
+            keep_or_reject = :reject if curriculum_name.include? 'Master'
+          end
+          if    keep_or_reject == :reject
+            true
+          elsif keep_or_reject == :keep
+            false
+          end
+        } # We don't want Lehramt-Curricula.
+      end
+      # ===================================================================== #
+      # Finally, report the number of ECTS per university.
+      # ===================================================================== #
+      e
+      opnn; e 'The following universities are involved with the given lectures:'
+      e
+      i.each {|curriculum_number, n_ects_points|
+        percentage = n_ects_points * 100 / total_ects?
+        full_name_of_the_curriculum = curriculum_number_to_curriculum_name(curriculum_number)
+        percentage_value = percentage.round(1).to_s.rjust(4)
+        colourized_percentage_value = mediumseagreen(
+          " (#{percentage_value}%)"
+        )
+        which_university = from_curriculum_number_to_university(curriculum_number)
+        which_university = royalblue(" [#{which_university.to_s.center(13)}]")
+        # =================================================================== #
+        # Report our findings next:
+        # =================================================================== #
+        e royalblue((full_name_of_the_curriculum.to_s+':').ljust(@n_ljust))+
+          colourize_ects_points(n_ects_points.to_s.rjust(5)+' ECTS')+
+          colourized_percentage_value+
+          which_university
+        if @display_the_name_of_the_lectures
+          selection = @dataset_from_the_file_lecture_information.select {|name_of_the_lecture, inner_hash|
+            curricula = obtain(:curricula, inner_hash)
+            curricula.include?(curriculum_number) and @dataset.include?(name_of_the_lecture)
+          }
+          # ================================================================= #
+          # Display the name of the lectures.
+          # ================================================================= #
+          selection.each_pair {|name_of_the_lecture, inner_hash|
+            n_ects_points = obtain(:n_ects_points, inner_hash)
+            e teal('  '+name_of_the_lecture.ljust(83)+
+              ' ['+n_ects_points.to_s+' ECTS]')
+          }
+        end
+      }; e
+    end
+  end
+
+  # ========================================================================= #
+  # === colourize_ects_points
+  # ========================================================================= #
+  def colourize_ects_points(i)
+    olivedrab(i)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    check_for_an_existing_file
+    iterate_over_the_main_dataset
+  end
+
+  # ========================================================================= #
+  # === Studium::AttributeLecturesToUniversity[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::AttributeLecturesToUniversity.new(ARGV)
+end # attributelecturestouniversity file1
+    # attributelecturestouniversity