studium 0.18.7

data/lib/studium/utility_scripts/scrape_remote_university_url.rb

@@ -0,0 +1,138 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ScrapeRemoteUniversityUrl
+#
+# The idea behind this class is to scrape university websites, in particular
+# websites hosted at the University of Vienna, which is using dynamic
+# JavaScript (yikes) to populate results displayed to the visitor.
+#
+# The class here has different ways to operate on remote data. For example,
+# if the given input to this class does NOT contain the substring 'http'
+# then the BeautifulUrl module will be queried for the remote URL.
+#
+# Note that the class works on an Array as given input - so if you give
+# it a really large Array, the class will batch-process that Array.
+#
+# Usage example:
+#
+#   Studium::ScrapeRemoteUniversityUrl.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/scrape_remote_university_url.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ScrapeRemoteUniversityUrl < Studium::Base # === WebObject::ScrapeRemoteUniversityUrl
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_name_of_the_lectures(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @location_to_the_local_html_file
+    # ======================================================================= #
+    @location_to_the_local_html_file = nil # Will be nil on startup.
+    # ======================================================================= #
+    # === @remote_url
+    # ======================================================================= #
+    @remote_url = nil
+  end
+
+  # ========================================================================= #
+  # === set_name_of_the_lectures
+  # ========================================================================= #
+  def set_name_of_the_lectures(i)
+    i = [i].flatten.compact
+    @name_of_the_lectures = i
+  end
+
+  # ========================================================================= #
+  # === determine_remote_url
+  # ========================================================================= #
+  def determine_remote_url(
+      from_this_url_here
+    )
+    _ = BeautifulUrl[from_this_url_here]
+    _ = _.first if _.is_a? Array
+    @remote_url = _
+  end
+
+  # ========================================================================= #
+  # === remote_url?
+  # ========================================================================= #
+  def remote_url?
+    @remote_url
+  end
+
+  # ========================================================================= #
+  # === name_of_the_lectures?
+  # ========================================================================= #
+  def name_of_the_lectures?
+    @name_of_the_lectures
+  end; alias main_array? name_of_the_lectures? # === main_array?
+
+  # ========================================================================= #
+  # === obtain_the_remote_dataset_and_delegate_to_the_creation_of_the_html_file
+  # ========================================================================= #
+  def obtain_the_remote_dataset_and_delegate_to_the_creation_of_the_html_file
+    begin
+      require 'web_object/web_scraper/scrape_this_url.rb'
+      # ===================================================================== #
+      # Batch-process the given input next.
+      # ===================================================================== #
+      main_array?.each {|entry|
+        set_name_of_the_lecture(entry)
+        determine_remote_url(entry) # Determine the main URL first.
+        Cyberweb::ScrapeThisUrl.set_start_urls(remote_url?)
+        store_here = '/Depot/Information/'+
+          entry.tr(' :,','_').squeeze('_')+
+          '.html'
+        opne 'The .html file can be found at `'+sfile(store_here)+'`.'
+        Cyberweb::ScrapeThisUrl.set_store_into(
+          store_here
+        )
+        Cyberweb::ScrapeThisUrl.start!
+      }
+    rescue LoadError => error
+      e 'Some file appears to be missing.'
+      pp error
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    obtain_the_remote_dataset_and_delegate_to_the_creation_of_the_html_file
+  end
+
+  # ========================================================================= #
+  # === Studium::ScrapeRemoteUniversityUrl[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ScrapeRemoteUniversityUrl.new(ARGV)
+end # scraperemoteuniversityurl "Human Evolutionary Genetics: genomic, genes, diseases"

data/lib/studium/utility_scripts/semester_schedule_creator/semester_container.rb

@@ -0,0 +1,144 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::SemesterContainer
+#
+# This class can hold all lectures that belong to a particular semester.
+#
+# Usage example:
+#
+#   Studium::SemesterContainer.new
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/semester_schedule_creator/semester_container.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class SemesterContainer < Base # === Studium::SemesterContainer
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @array_storing_all_lectures
+    # ======================================================================= #
+    @array_storing_all_lectures = []
+    @we_can_store_n_ects_points = 30.0
+    @semester_number = 1 # This number can be e. g. 1, 2, 3, 4, 5 or 6.
+  end
+
+  # ========================================================================= #
+  # === add_this_lecture                                            (add tag)
+  #
+  # Use this method if you want to add a lecture to the semester-container.
+  #
+  # Three argumetns are required.
+  # ========================================================================= #
+  def add_this_lecture(
+      name_of_the_lecture, n_ects_points, lecture_id
+    )
+    @array_storing_all_lectures << [
+      name_of_the_lecture, n_ects_points, lecture_id
+    ]
+  end; alias add add_this_lecture # === add
+
+  # ========================================================================= #
+  # === cap?
+  # ========================================================================= #
+  def cap?
+    @we_can_store_n_ects_points
+  end
+
+  # ========================================================================= #
+  # === full?
+  #
+  # If all ECTS points have been filled already then the container is
+  # full - otherwise it is not full.
+  # ========================================================================= #
+  def full?
+    return_storing_n_ects_points_right_now >= cap?
+  end
+
+  # ========================================================================= #
+  # === can_accomodate_n_more_ects_points?
+  #
+  # This method queries whether our semester-container can still store
+  # more lectures.
+  # ========================================================================= #
+  def can_accomodate_n_more_ects_points?(
+      n_ects_points = 3.0
+    )
+    boolean_result = !(
+      (return_n_ects_points_are_stored_in_this_container + n_ects_points) > cap?
+    )
+    return boolean_result
+  end
+
+  # ========================================================================= #
+  # === report_how_many_ects_points_are_stored
+  # ========================================================================= #
+  def report_how_many_ects_points_are_stored
+    e simp(return_n_ects_points_are_stored_in_this_container.to_s)+
+      ' ECTS points are stored in this semester.'
+  end
+
+  # ========================================================================= #
+  # === return_n_ects_points_are_stored_in_this_container
+  # ========================================================================= #
+  def return_n_ects_points_are_stored_in_this_container
+    total_amount_of_ects_points_currently_stored = 0
+    @array_storing_all_lectures.each {|_a, inner_n_ects_points,_c|
+      total_amount_of_ects_points_currently_stored += inner_n_ects_points
+    }
+    return total_amount_of_ects_points_currently_stored
+  end; alias return_storing_n_ects_points_right_now return_n_ects_points_are_stored_in_this_container # === return_storing_n_ects_points_right_now
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+  end
+
+  # ========================================================================= #
+  # === report_all_lectures
+  #
+  # This method will simply report all lectures contained in this
+  # semester.
+  # ========================================================================= #
+  def report_all_lectures
+    @array_storing_all_lectures.each {|name_of_the_lecture, n_ects_points, lecture_id|
+      e '  '+lightgreen(name_of_the_lecture.ljust(83))+
+        simp(n_ects_points.to_s.rjust(5))+' ECTS points '\
+        '(Lecture id: '+powderblue(lecture_id.to_s)+')'
+    }
+  end
+
+  # ========================================================================= #
+  # === Studium::SemesterContainer[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::SemesterContainer.new(ARGV)
+end # semester_container

data/lib/studium/utility_scripts/semester_schedule_creator/semester_schedule_creator.rb

@@ -0,0 +1,373 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::SemesterScheduleCreator
+#
+# This class will create a semester schedule for a curriculum. Bachelor
+# curricula have 180.0 ECTS points, and each semester has 30.0 ECTS
+# points, so we will divide the amount of ECTS to fit into these
+# 30.0 ECTS point.
+#
+# Usage example:
+#
+#   Studium::SemesterScheduleCreator.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/semester_schedule_creator/semester_schedule_creator.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class SemesterScheduleCreator < Base # === Studium::SemesterScheduleCreator.new
+
+  require 'studium/utility_scripts/semester_schedule_creator/semester_container.rb'
+
+  # ========================================================================= #
+  # === FILE_MODULES_BACHELOR_CURRICULUM
+  # ========================================================================= #
+  FILE_MODULES_BACHELOR_CURRICULUM = nil
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @hash_storing_semester_containers
+    # ======================================================================= #
+    @hash_storing_semester_containers = {}
+    @hash_containing_information_about_every_lecture = {}
+    @which_semester_is_active = 1 # First semester is the start semester.
+    @array_lectures_that_could_not_be_stored_anywhere = []
+    @n_ects_points_leftover = nil
+  end
+
+  # ========================================================================= #
+  # === sanitize_curriculum_dataset
+  #
+  # Presently, this method will only ensure that the Strings are in
+  # the main encoding of the project.
+  # ========================================================================= #
+  def sanitize_curriculum_dataset
+    @curriculum_dataset.map! {|entry|
+      entry
+    }
+  end
+
+  # ========================================================================= #
+  # === iterate_over_the_dataset
+  # ========================================================================= #
+  def iterate_over_the_dataset(
+      use_this_dataset = @curriculum_dataset
+    )
+    temp_hash = {}
+    dataset_holding_the_lecture_information = YAML.load_file(Studium.file_lecture_information)
+    dataset_holding_the_lecture_information.each_pair {|key, value|
+      temp_hash[key] = value
+    }
+    dataset_holding_the_lecture_information = temp_hash # Re-assign to the main Hash.
+    dataset_keys = dataset_holding_the_lecture_information.keys
+    # ======================================================================= #
+    # Let's first build up the temporary hash that holds all relevant
+    # information.
+    # ======================================================================= #
+    use_this_dataset.each {|this_lecture|
+      # ===================================================================== #
+      # If this_lecture is an Array, then we assume an entry such as:
+      #   ["Einführung in die Zellbiologie und Genetik", "941106"]=>4.0,
+      # ===================================================================== #
+      if this_lecture.is_a? Array
+        this_lecture = this_lecture.first
+      end
+      n_ects_points = Studium.return_n_ects_points_from_this_lecture(this_lecture)
+      lecture_id = nil
+      if dataset_keys.any? {|line| line.include? this_lecture }
+        # =================================================================== #
+        # Ok, in this case we know that the lecture is included. That means
+        # that we can obtain the lecture_id next.
+        # =================================================================== #
+        selection = dataset_keys.select {|inner_line|
+          inner_line =~ /#{Regexp.quote(this_lecture)}$/
+        }
+        # =================================================================== #
+        # Note that the above can result in more than one Array, such as for:
+        #
+        #   ["300661 Übung III A - Molekularbiologische Laborarbeiten",
+        #    "301171 Übung III A - Molekularbiologische Laborarbeiten"]
+        #
+        # For now, we will simply pick the first, and ignore the latter.
+        # This behaviour may change at a later time, though.
+        # =================================================================== #
+        lecture_number_and_name = selection.first
+        splitted = lecture_number_and_name.split(' ')
+        lecture_id = splitted.first
+      else
+        opne 'The lecture `'+sfancy(this_lecture)+'` is not included. Please add it.'
+        opne 'Exiting now as a consequence.'
+        exit
+      end
+      @hash_containing_information_about_every_lecture[this_lecture] = {
+        n_ects_points: n_ects_points,
+        lecture_id:    lecture_id
+      }
+    }
+    # ======================================================================= #
+    # Ok, we have now put everything together the Hash called
+    # @hash_containing_information_about_every_lecture. 
+    # ======================================================================= #
+  end
+
+  # ========================================================================= #
+  # === load_curriculum_dataset
+  # ========================================================================= #
+  def load_curriculum_dataset
+    _ = Studium::StudiumSolved::Constants::FILE_INDIVIDUAL_BACHELOR_CURRICULUM
+    if File.exist? _
+      @curriculum_dataset = YAML.load_file(_)
+      sanitize_curriculum_dataset
+    else
+      opne 'No file exists at `'+sfile(_)+'`.'
+    end
+  end
+
+  # ========================================================================= #
+  # === change_to_the_next_semester
+  # ========================================================================= #
+  def change_to_the_next_semester
+    case @which_semester_is_active
+    when 1, :first_semester
+      @which_semester_is_active = 2
+    when 2, :second_semester
+      @which_semester_is_active = 3
+    when 3, :third_semester
+      @which_semester_is_active = 4
+    when 4, :fourth_semester
+      @which_semester_is_active = 5
+    when 5, :fifth_semester
+      @which_semester_is_active = 6
+    end
+  end
+
+  # ========================================================================= #
+  # === populate_the_semester_containers
+  # ========================================================================= #
+  def populate_the_semester_containers
+    initialize_hash_storing_semester_containers
+    @hash_containing_information_about_every_lecture.each_pair {|name_of_the_lecture, hash_containing_ects_points_and_lecture_id|
+      n_ects     = hash_containing_ects_points_and_lecture_id[:n_ects_points]
+      lecture_id = hash_containing_ects_points_and_lecture_id[:lecture_id]
+      this_semester_container = @hash_storing_semester_containers[@which_semester_is_active]
+      if @n_ects_points_leftover
+        # =================================================================== #
+        # Ok, we can add something to the prior semester perhaps.
+        # =================================================================== #
+        if n_ects <= @n_ects_points_leftover
+          # In this case we can add it to the prior semester perhaps.
+          previous_semester_container = @hash_storing_semester_containers[@which_semester_is_active - 1]
+          if previous_semester_container.can_accomodate_n_more_ects_points?(n_ects)
+            previous_semester_container.add_this_lecture(
+              name_of_the_lecture, n_ects, lecture_id
+            )
+            @n_ects_points_leftover -= n_ects
+            n_ects = nil
+            if @n_ects_points_leftover <= 0
+              @n_ects_points_leftover = nil
+            end
+          end
+        end 
+      end
+      if n_ects
+        if this_semester_container.can_accomodate_n_more_ects_points?(n_ects)
+            this_semester_container.add_this_lecture(
+              name_of_the_lecture, n_ects, lecture_id
+            )
+        else
+          # =================================================================== #
+          # Else this semester container is already full, so move to the
+          # next one. We will, however had, have to remember that there
+          # are still missing slots in the prior semester container.
+          # =================================================================== #
+          if this_semester_container.full?
+            # ================================================================= #
+            # Then everything is ok; we don't have to do anything special,
+            # other than resetting one variable.
+            # ================================================================= #
+            @n_ects_points_leftover = nil
+          else
+            # ================================================================= #
+            # In this case we have to remember that we will have to store
+            # some more ECTS points for the previous semester.
+            # ================================================================= #
+            @n_ects_points_leftover = n_ects
+          end
+          change_to_the_next_semester # (next tag)
+          this_semester_container = @hash_storing_semester_containers[@which_semester_is_active]
+          # =================================================================== #
+          # And don't forget to add the lecture to this semester.
+          # =================================================================== #
+          if this_semester_container.can_accomodate_n_more_ects_points?(n_ects)
+            this_semester_container.add_this_lecture(
+            name_of_the_lecture, n_ects, lecture_id
+            )
+          else
+            register_lecture_that_could_not_be_stored_anywhere(name_of_the_lecture, n_ects, lecture_id)
+          end
+        end
+      end
+    }
+    # ======================================================================= #
+    # Also report missing lectures - but there should not be any
+    # missing, unassigned lectures there.
+    # ======================================================================= #
+    unless @array_lectures_that_could_not_be_stored_anywhere.empty? 
+      pp @array_lectures_that_could_not_be_stored_anywhere
+    end
+  end
+
+  # ========================================================================= #
+  # === register_lecture_that_could_not_be_stored_anywhere
+  # ========================================================================= #
+  def register_lecture_that_could_not_be_stored_anywhere(name_of_the_lecture, n_ects, lecture_id)
+    @array_lectures_that_could_not_be_stored_anywhere << [
+      name_of_the_lecture, n_ects, lecture_id
+    ]
+  end
+
+  # ========================================================================= #
+  # === initialize_hash_storing_semester_containers
+  # ========================================================================= #
+  def initialize_hash_storing_semester_containers
+    @hash_storing_semester_containers[1] = SemesterContainer.new
+    @hash_storing_semester_containers[2] = SemesterContainer.new
+    @hash_storing_semester_containers[3] = SemesterContainer.new
+    @hash_storing_semester_containers[4] = SemesterContainer.new
+    @hash_storing_semester_containers[5] = SemesterContainer.new
+    @hash_storing_semester_containers[6] = SemesterContainer.new
+  end
+
+  # ========================================================================= #
+  # === prettify_this_semester_name
+  #
+  # Simply replace the symbol with a string.
+  # ========================================================================= #
+  def prettify_this_semester_name(i)
+    case i
+    when 1, :first_semester
+      '1. Semester'
+    when 2, :second_semester
+      '2. Semester'
+    when 3, :third_semester
+      '3. Semester'
+    when 4, :fourth_semester
+      '4. Semester'
+    when 5, :fifth_semester
+      '5. Semester'
+    when 6, :sixth_semester
+      '6. Semester'
+    end
+  end
+
+  # ========================================================================= #
+  # === report_the_ects_points_stored_per_semester_container     (report tag)
+  # ========================================================================= #
+  def report_the_ects_points_stored_per_semester_container
+    semester_containers?.each {|which_semester, semester_container|
+      e mediumslateblue(prettify_this_semester_name(which_semester)+':')
+      e
+      # ===================================================================== #
+      # Report how many ECTS points are stored here.
+      # ===================================================================== #
+      print '  '; semester_container.report_how_many_ects_points_are_stored
+      e; e 'The lectures that are part of this semester are:'; e
+      semester_container.report_all_lectures
+      e # And a pretty new line at the end.
+      seagreen_line
+      e
+    }
+  end
+
+  # ========================================================================= #
+  # === red_line
+  # ========================================================================= #
+  def seagreen_line
+    e seagreen('='*80)
+  end
+
+  # ========================================================================= #
+  # === semester_containers?
+  # ========================================================================= #
+  def semester_containers?
+    @hash_storing_semester_containers
+  end
+
+  # ========================================================================= #
+  # === sort_the_hash_containing_our_lectures_according_to_the_modules_in_use
+  # ========================================================================= #
+  def sort_the_hash_containing_our_lectures_according_to_the_modules_in_use
+    new_hash = {}
+    dataset = nil
+    # ======================================================================= #
+    # We only need the values of the ^^^ dataset. But first we get rid
+    # of any key that is "M0".
+    # ======================================================================= #
+    if dataset.has_key? 'M0'
+      dataset.delete('M0')
+    end
+    dataset = dataset.values
+    dataset_hash = {}
+    dataset.each {|inner_hash|
+      dataset_hash.update(inner_hash)
+    }
+    # ======================================================================= #
+    # The entries in the above dataset-hash will be like this:
+    #   "301350"=>"Quantitative Methoden in der Molekularbiologie",
+    # This actually gives us a better dataset already, so we can
+    # just use it.
+    # ======================================================================= #
+    dataset_hash.each_pair {|lecture_id, name_of_the_lecture|
+      new_hash[name_of_the_lecture] = {
+        lecture_id: lecture_id,
+        n_ects_points: Studium.return_n_ects_points_from_this_lecture(name_of_the_lecture) 
+      }
+    }
+    @hash_containing_information_about_every_lecture = new_hash
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    load_curriculum_dataset
+    iterate_over_the_dataset
+    sort_the_hash_containing_our_lectures_according_to_the_modules_in_use
+    populate_the_semester_containers
+    report_the_ects_points_stored_per_semester_container
+  end
+
+  # ========================================================================= #
+  # === Studium::SemesterScheduleCreator[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::SemesterScheduleCreator.new(ARGV)
+end # semester_schedule_creator