studium 0.13.1

data/lib/studium/utility_scripts/show_lectures_on_this_day.rb

@@ -0,0 +1,149 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ShowLecturesOnThisDay
+#
+# This class can report which lectures are on a given day xyz.
+#
+# Usage example:
+#
+#   Studium::ShowLecturesOnThisDay.new
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/show_lectures_on_this_day.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ShowLecturesOnThisDay < Base # === Studium::ShowOutdatedLvaDates
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      this_day    = nil,
+      run_already = true
+    )
+    reset
+    set_this_day(this_day)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = return_dataset_from_the_file_lecture_information
+  end
+
+  # ========================================================================= #
+  # === set_this_day
+  #
+  # The input format should be a String conforming to dd.mm.yyyy,
+  # such as "10.03.2018".
+  # ========================================================================= #
+  def set_this_day(i = '')
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    @this_day = i
+  end
+
+  # ========================================================================= #
+  # === this_day?
+  # ========================================================================= #
+  def this_day?
+    @this_day
+  end; alias searching_for_this_day this_day? # === searching_for_this_day
+       alias seek_which_day?        this_day? # === seek_which_day?
+
+  # ========================================================================= #
+  # === report
+  # ========================================================================= #
+  def report(
+      i = @dataset
+    )
+    seek_which_day = seek_which_day?
+    if i.empty?
+      opnn; e "No lectures are on the day "\
+              "`#{slateblue(seek_which_day)} "\
+              "#{skyblue(return_weekday_for(seek_which_day))}."
+    else
+      opnn; e 'The following '+orange(i.keys.size.to_s)+
+              ' lecture(s) were found to occur'
+      opnn; e 'on the day `'+slateblue(seek_which_day)+'` ('+
+              skyblue(return_weekday_for(seek_which_day))+'):'
+      e
+      index = 0
+      i.each {|name_of_the_lecture, inner_hash| index += 1
+        padded_index = (index.to_s+')').rjust(4)+' '
+        colourized_and_padded_index = seagreen(padded_index)
+        e "  #{colourized_and_padded_index}"\
+          "#{sfancy(name_of_the_lecture.ljust(84))}"
+      }
+      e
+    end
+  end
+
+  # ========================================================================= #
+  # === sanitize_the_main_dataset
+  # ========================================================================= #
+  def sanitize_the_main_dataset
+    # ======================================================================= #
+    # We are only interested in entries that have a lva_dates entry
+    # the key 'lva_dates' and among these days.
+    # ======================================================================= #
+    @dataset = @dataset.select {|key, value|
+      value.has_key? 'lva_dates'
+    }
+    @dataset.select! {|key, inner_hash|
+      lva_dates = inner_hash['lva_dates']
+      if lva_dates.nil?
+        e tomato('Debug: problem for '+key)
+      end
+      lva_dates.any? {|inner_line|
+        inner_line.include? searching_for_this_day
+      }
+    }
+    # ======================================================================= #
+    # Past this line, the @dataset is sanitized and will only contain
+    # lectures that have at the least one entry conforming to the
+    # given input date at hand.
+    # ======================================================================= #
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    sanitize_the_main_dataset
+    report
+  end
+
+  # ========================================================================= #
+  # === Studium::ShowLecturesOnThisDay[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.show_lectures_on_this_day
+# =========================================================================== #
+def self.show_lectures_on_this_day(i = ARGV)
+  Studium::ShowLecturesOnThisDay.new(i)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ShowLecturesOnThisDay.new(ARGV)
+end # showlecturesonthisday 04.10.2022

data/lib/studium/utility_scripts/show_lva_dates_of_this_lecture.rb

@@ -0,0 +1,169 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ShowLvaDatesOfThisLecture
+#
+# This class can display, on the commandline, the LVA dates of a given
+# lecture at hand. For this to work at the least two conditions have
+# to be met:
+#
+#   1) the lecture at hand is registered, and could be found
+#   2) the lecture at hand must have registered lva_dates entry 
+#      in the main .yml file (aka lecture_information.yml)
+#
+# Usage example:
+#
+#   Studium::ShowLvaDatesOfThisLecture.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/show_lva_dates_of_this_lecture.rb'
+# Studium::ShowLvaDatesOfThisLecture.new("802300 Biological nanosciences and nanotechnology (in Eng.)")
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ShowLvaDatesOfThisLecture < Base # === Studium::ShowLvaDatesOfThisLecture
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = ARGV,
+      run_already = true
+    )
+    reset
+    set_search_for_this_lecture(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = return_dataset_from_the_file_lecture_information
+    # ======================================================================= #
+    # === @possible_matches
+    # ======================================================================= #
+    @possible_matches = []
+  end
+
+  # ========================================================================= #
+  # === set_search_for_this_lecture
+  #
+  # This defines the search-term - aka which lecture to seek.
+  # ========================================================================= #
+  def set_search_for_this_lecture(i = '')
+    if i.is_a? Array
+      i = i.join(' ').strip
+    end
+    i = i.to_s.dup
+    @search_for_this_lecture = i
+  end
+
+  # ========================================================================= #
+  # === search_for_this_lecture?
+  # ========================================================================= #
+  def search_for_this_lecture?
+    @search_for_this_lecture
+  end; alias seeking_this_lecture_name search_for_this_lecture? # === seeking_this_lecture_name
+       alias input?                    search_for_this_lecture? # === input?
+
+  # ========================================================================= #
+  # === try_to_find_a_match
+  # ========================================================================= #
+  def try_to_find_a_match
+    search_for_this_lecture = search_for_this_lecture?
+    _ = @dataset.select {|name_of_the_lecture, inner_hash|
+      name_of_the_lecture.include? search_for_this_lecture
+    }
+    set_possible_matches(_)
+  end
+
+  # ========================================================================= #
+  # === set_possible_matches
+  # ========================================================================= #
+  def set_possible_matches(i)
+    @possible_matches = i
+  end
+
+  # ========================================================================= #
+  # === process_the_possible_matches
+  # ========================================================================= #
+  def process_the_possible_matches
+    _ = @possible_matches
+    if _.empty?
+      # ===================================================================== #
+      # In this case we could not find any match at all.
+      # ===================================================================== #
+      opnn; e "We were unable to find any result matching towards `"\
+              "#{sfancy(seeking_this_lecture_name)}`."
+    else
+      _.each_pair {|name_of_the_lecture, hash_dataset|
+        lva_dates = hash_dataset['lva_dates']
+        if lva_dates
+          e; e "#{rev}The lecture `#{royalblue(name_of_the_lecture)}"\
+               "` has the following #{orange('LVA dates')}:"
+          e; lva_dates.each {|this_lva_date|
+            e "  #{slateblue(this_lva_date)}"
+          }; e
+          report_remote_url(name_of_the_lecture)
+        else
+          e rev+
+            'The lecture `'+royalblue(name_of_the_lecture)+
+            '` has no registered lva_dates entry.'
+        end
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === report_remote_url
+  # ========================================================================= #
+  def report_remote_url(name_of_the_lecture)
+    remote_url = beautiful_url(name_of_the_lecture)
+    e "More information about this course:\n\n"\
+      "  #{sfancy(remote_url)}\n\n"
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    try_to_find_a_match
+    process_the_possible_matches
+  end
+
+  # ========================================================================= #
+  # === Studium::ShowLvaDatesOfThisLecture[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.show_lva_dates_of_this_lecture
+# =========================================================================== #
+def self.show_lva_dates_of_this_lecture(i)
+  if i.is_a? Array
+    i.each {|entry| show_lva_dates_of_this_lecture(entry) }
+  else
+    Studium::ShowLvaDatesOfThisLecture.new(i)
+  end
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ShowLvaDatesOfThisLecture.new(ARGV)
+end # show_lva_dates_of_this_lecture Primatologie
+    # lvadates Biotechnological products
+    # lvadates "802300 Biological nanosciences and nanotechnology (in Eng.)"

data/lib/studium/utility_scripts/show_mixed_bachelor_master_courses/show_mixed_bachelor_master_courses.rb

@@ -0,0 +1,91 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ShowMixedBachelorMasterCourses
+#
+# This class will display all courses that contain both an entry for
+# a Bachelor-curriculum as well as an entry for a Master-curriculum.
+#
+# Usage example:
+#
+#   Studium::ShowMixedBachelorMasterCourses.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/show_mixed_bachelor_master_courses/show_mixed_bachelor_master_courses.rb'
+# Studium::ShowMixedBachelorMasterCourses.new(ARGV)
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ShowMixedBachelorMasterCourses < Base # === Studium::ShowMixedBachelorMasterCourses
+
+  # ========================================================================= #
+  # === 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
+  end
+
+  # ========================================================================= #
+  # === report
+  # ========================================================================= #
+  def report(hash)
+    e 'The following courses each include a Bachelor and a Master curriculum:'
+    e
+    index = 0
+    hash.each_pair {|name_of_the_course, inner_hash| index += 1
+      curricula = inner_hash['curricula']
+      this_university = inner_hash[:university]
+      e tomato((index.to_s+')').rjust(4))+' '+
+        steelblue(name_of_the_course.ljust(80))+' '+
+        lightblue(curricula.join(', ').strip)+' '+
+        mediumseagreen('['+this_university+']')
+    }
+    e
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    dataset = return_dataset_from_lecture_information
+    # ======================================================================= #
+    # Filter for courses that include both B and M courses next:
+    # ======================================================================= #
+    selection = dataset.select {|name_of_the_course, inner_hash|
+      curricula = inner_hash['curricula']
+      does_this_include_a_bachelor_curriculum?(curricula) and
+      does_this_include_a_master_curriculum?(curricula)
+    }
+    report(selection)
+  end
+
+  # ========================================================================= #
+  # === Studium::ShowMixedBachelorMasterCourses[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ShowMixedBachelorMasterCourses.new(ARGV)
+end # showmixedbachelormastercourses

data/lib/studium/utility_scripts/show_outdated_lva_dates/show_outdated_lva_dates.rb

@@ -0,0 +1,210 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ShowOutdatedLvaDates
+#
+# This class will simply show which lva_dates are outdated. The user can
+# then correct these entries in the yaml-file.
+#
+# Usage example:
+#
+#   Studium::ShowOutdatedLvaDates.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/show_outdated_lva_dates/show_outdated_lva_dates.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ShowOutdatedLvaDates < Base # === Studium::ShowOutdatedLvaDates
+
+  require 'studium/utility_scripts/autopurge_this_lecture_date.rb'
+
+  # ========================================================================= #
+  # === AUTOPURGE_OUTDATED_ENTRIES
+  #
+  # If the following constant is set to true then we will also modify
+  # the file "lecture_information.yml".
+  # ========================================================================= #
+  AUTOPURGE_OUTDATED_ENTRIES = false
+
+  # ========================================================================= #
+  # === 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
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = return_dataset_from_the_file_lecture_information
+    # ======================================================================= #
+    # === @array_outdated_entries
+    # ======================================================================= #
+    @array_outdated_entries = []
+    # ======================================================================= #
+    # === @autopurge_outdated_entries
+    # ======================================================================= #
+    @autopurge_outdated_entries = AUTOPURGE_OUTDATED_ENTRIES
+  end
+
+  # ========================================================================= #
+  # === do_not_autopurge
+  # ========================================================================= #
+  def do_not_autopurge
+    @autopurge_outdated_entries = false
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(i)
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === outdated --do-not-autopurge
+      # ===================================================================== #
+      when /^-?-?do(-|_)?not(-|_)?auto(-|_)?purge$/i,
+           /^-?-?do(-|_)?not(-|_)?auto(-|_)?update$/i
+        do_not_autopurge
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === sanitize_the_main_dataset
+  # ========================================================================= #
+  def sanitize_the_main_dataset
+    # ======================================================================= #
+    # We are only interested in entries that have the key 'lva_dates'.
+    # ======================================================================= #
+    @dataset.select! {|key, value|
+      value.has_key? 'lva_dates'
+    } 
+  end
+
+  # ========================================================================= #
+  # === iterate_over_the_main_dataset_and_report_outdated_entries
+  # ========================================================================= #
+  def iterate_over_the_main_dataset_and_report_outdated_entries
+    time_right_now = Time.now
+    @dataset.each_pair {|name_of_the_lecture, value|
+      lva_dates = value['lva_dates']
+      if lva_dates.nil?
+        opnn; e swarn('A nil value was encountered for ')+
+                sfancy(name_of_the_lecture)+
+                swarn('.') 
+      else
+        first_entry = lva_dates.first
+        first_entry = remove_weekdays(first_entry).delete(',').squeeze(' ').strip
+        time_entry_of_that_lecture = Time.parse(first_entry)
+        if time_entry_of_that_lecture < (time_right_now - (ONE_DAY - 1))
+          # ================================================================= #
+          # Append two relevant entries to our array, which will store
+          # which lectures have outdated entries.
+          # ================================================================= #
+          @array_outdated_entries << [
+            name_of_the_lecture, first_entry
+          ]
+        end
+      end
+    }
+    report_the_outdated_entries
+  end
+
+  # ========================================================================= #
+  # === report_the_outdated_entries
+  # ========================================================================= #
+  def report_the_outdated_entries(
+      i = @array_outdated_entries
+    )
+    if i.empty?
+      opnn; e 'All entries are up-to-date. This is great! '+orange('\\o/')
+    else
+      opnn; e 'The following entries are outdated:'
+      e
+      i.each {|name_of_the_lecture, time_entry_of_that_lecture|
+        e '  '+sfancy(name_of_the_lecture.ljust(84))+
+          lightskyblue(' ('+time_entry_of_that_lecture.to_s+')')
+      }
+      e
+    end
+  end
+
+  # ========================================================================= #
+  # === consider_autopurging_obsolete_entries
+  # ========================================================================= #
+  def consider_autopurging_obsolete_entries
+    if @autopurge_outdated_entries
+      if @array_outdated_entries.empty?
+        # =================================================================== #
+        # In this case do nothing.
+        # =================================================================== #
+      else
+        # =================================================================== #
+        # In this case, do auto-purge the obsolete entries.
+        # =================================================================== #
+        these_dates = @array_outdated_entries.map {|inner_array|
+          last = inner_array.last
+          last = last.split(' ').first
+        }.uniq
+        autopurge_these_dates(these_dates)
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === autopurge_these_dates
+  # ========================================================================= #
+  def autopurge_these_dates(i)
+    AutopurgeThisLectureDate.new(i)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    sanitize_the_main_dataset
+    iterate_over_the_main_dataset_and_report_outdated_entries
+    consider_autopurging_obsolete_entries
+  end
+
+  # ========================================================================= #
+  # === Studium::ShowOutdatedLvaDates[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.show_outdated_lva_dates
+# =========================================================================== #
+def self.show_outdated_lva_dates
+  Studium::ShowOutdatedLvaDates.new
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ShowOutdatedLvaDates.new(ARGV)
+end # showoutdatedlvadates