studium 0.16.9

data/lib/studium/exams/upcoming_exams/upcoming_exams.rb

@@ -0,0 +1,556 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::UpcomingExams
+#
+# This class is able to show upcoming important exams, from the file
+# called 'important_exams.yml'. It has superceded the older .rb file
+# called upcoming_exams.rb.
+# =========================================================================== #
+# require 'studium/exams/upcoming_exams/upcoming_exams.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Exams
+
+class UpcomingExams < Base # === Studium::Exams::UpcomingExams
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @exit_on_problems
+    # ======================================================================= #
+    @exit_on_problems = false
+    # ======================================================================= #
+    # === @dataset
+    #
+    # This variable will eventually hold the lectures that we wish
+    # to display. It taps into the file "lecture_information.yml"
+    # originally.
+    # ======================================================================= #
+    @dataset = return_lectures_with_at_the_least_one_upcoming_exam
+    read_in_the_dataset_from_the_file_important_exams
+  end
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  #
+  # This method is to be used from the commandline. The user will be
+  # told how to use certain flags in combination with this class.
+  #
+  # Invocation example:
+  #
+  #   timetable --help
+  #
+  # ========================================================================= #
+  def show_help
+    e; opnn { :no_trailing_character }; e
+    e
+    e 'The following commandline-options are available:'
+    e
+    e '  '+steelblue('--check')+'           # check the format and validity '\
+      'of the file important_exams.yml'
+    e '  '+steelblue('--do-not-exit')+'     # do not exit if there is no registration '\
+      'in the project beautiful_url.'
+    e '  '+steelblue('--master')+'          # show only upcoming master-exams.'
+    e '  '+steelblue('--month=September')+' # show only exams in that month'
+    e
+    e "Additionally you can pass in #{orange('--open')} to "\
+      "open the yaml file."
+    e
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i
+      # ===================================================================== #
+      # === timetable --September
+      # === timetable --month=September
+      # === timetable --July
+      # ===================================================================== #
+      when /^-?-?(month=)?August$/i,
+           /^-?-?(month=)?September$/i,
+           /^-?-?(month=)?November$/i,
+           /^-?-?(month=)?October$/i,
+           /^-?-?(month=)?December$/i,
+           /^-?-?(month=)?January$/i,
+           /^-?-?(month=)?February$/i,
+           /^-?-?(month=)?March$/i,
+           /^-?-?(month=)?April$/i,
+           /^-?-?(month=)?May$/i,
+           /^-?-?(month=)?June$/i,
+           /^-?-?(month=)?July$/i
+        # =================================================================== #
+        # Next, we have to filter away all entries but the specific month.
+        # =================================================================== #
+        filter_away_all_but_these_months(i) # Do an in-place filter here.
+      # ===================================================================== #
+      # === timetable --check
+      # ===================================================================== #
+      when /^-?-?check$/i
+        check_whether_the_entries_in_the_file_important_exams_are_correct
+        exit
+      # ===================================================================== #
+      # === timetable --master
+      # ===================================================================== #
+      when /^-?-?master$/i
+        _ = main_dataset?.select {|name_of_the_lecture, b|
+          is_a_master_lecture?(name_of_the_lecture)
+        }
+        set_main_dataset(_)
+      # ===================================================================== #
+      # === timetable --do-not-exit
+      # ===================================================================== #
+      when /^-?-?do(-|_)?not(-|_)?exit$/i
+        do_not_exit
+      # ===================================================================== #
+      # === timetable --help
+      # ===================================================================== #
+      when /-?-?help$/i
+        show_help
+        exit
+      # ===================================================================== #
+      # === timetable --open
+      # ===================================================================== #
+      when /open$/i
+        open_all_important_files
+        exit
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === report
+  # ========================================================================= #
+  def report(
+      i = @dataset
+    )
+    if i and !i.empty?
+      opnn; e tomato("#{i.size} upcoming exams ")+
+              grey("were found. Displaying these upcoming exams next.")
+      e
+    end
+    i.each {|name_of_the_lecture, inner_hash|
+      exams = inner_hash['exams']
+      # ===================================================================== #
+      # === :homepage
+      #
+      # We also want to use the remote_url, so add it next. However had, for
+      # the time being, we require that this is registered in the project
+      # BeautifulUrl. And if it is not, then we will report this as an error.
+      # ===================================================================== #
+      if inner_hash.has_key? :homepage
+        use_this_remote_url = inner_hash[:homepage] # Get a handler first.
+        if use_this_remote_url.is_a? Array
+          use_this_remote_url = use_this_remote_url.first
+        end
+      else
+        notify_the_user_that_this_lecture_has_no_associated_remote_url(
+          name_of_the_lecture
+        )
+      end
+      # ===================================================================== #
+      # Tell the user on which lecture we are working right now.
+      # ===================================================================== #
+      _ = hh_mm_ss_dd_mm_yyyy(exams).split('-').reverse.join(', ')
+      e grey('Working on ')+
+        "#{steelblue(name_of_the_lecture)}"
+      e "  #{steelblue(rarrow?)} #{orange(use_this_remote_url)} "
+      e "  #{grey('Exam at: ')}#{tomato(_)}"
+    }
+  end; alias report_the_lectures_that_will_be_used report # === report_the_lectures_that_will_be_used
+
+  # ========================================================================= #
+  # === notify_the_user_that_this_lecture_has_no_associated_remote_url
+  # ========================================================================= #
+  def notify_the_user_that_this_lecture_has_no_associated_remote_url(
+      name_of_the_lecture_that_we_wish_to_display
+    )
+    opnn; e 'It seems as if "'+
+            sfancy(name_of_the_lecture_that_we_wish_to_display)+
+            '" does not have an associated'
+    opnn; e "remote URL. Please add this to the file "\
+            "#{sfile('university_menu.rb')}"
+    if @exit_on_problems
+      opnn; e 'Exiting now. (--do-not-exit can be bypassed to NOT exit)'
+      exit
+    end
+  end
+
+  # ========================================================================= #
+  # === check_for_entries_that_were_already_successfully_completed_and_report_these
+  # ========================================================================= #
+  def check_for_entries_that_were_already_successfully_completed_and_report_these
+    dataset_from_the_file_lecture_information = ::Studium.return_dataset_from_the_file_lecture_information
+    @dataset_from_the_file_important_exams.each {|this_lecture| # This variable will look like this: "134.202 Biomembranes"
+      if dataset_from_the_file_lecture_information.has_key? this_lecture
+        # Ok if it is there then we check if it has been completed already.
+        pointer = dataset_from_the_file_lecture_information[this_lecture]
+        already_solved = pointer[:already_solved]
+        is_an_outdated_lecture = pointer[:outdated_lecture]
+        if (is_an_outdated_lecture == true)
+          e 'Warning! Outdated lecture ('+tomato(this_lecture)+
+            '). Remove it from the'
+          e 'file '+sfile('important_exams.yml')
+        elsif (already_solved == true)
+          e tomato('The course ')+
+            steelblue(this_lecture)+
+            tomato(' has already been solved.')
+          e tomato('It can be removed from the file ')+
+            sfile('important_exams.yml')+
+            tomato('.')
+        end
+      else
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === check_for_duplicates
+  # ========================================================================= #
+  def check_for_duplicates
+    hash = {}
+    hash.default = 0
+    @dataset_from_the_file_important_exams.each {|entry|
+      splitted = entry.split('|')
+      # ===================================================================== #
+      # The name of the lecture is only the first part of the above variable.
+      # ===================================================================== #
+      name_of_the_lecture = splitted.first.strip
+      hash[name_of_the_lecture] += 1
+    }
+    # ======================================================================= #
+    # Next we will check for duplicates. If found, we will report them.
+    # ======================================================================= #
+    try_to_report_duplicate_entries_in_this_hash(hash)
+  end
+
+  # ========================================================================= #
+  # === try_to_report_duplicate_entries_in_this_hash
+  #
+  # This method will try to find duplicate entries in the given Hash.
+  # ========================================================================= #
+  def try_to_report_duplicate_entries_in_this_hash(
+      hash
+    )
+    potential_duplicates = hash.select {|key, value| value > 1 }
+    unless potential_duplicates.empty?
+      opnn; e "The file #{sfile(main_file?)} has at the "\
+              "least one duplicate entry."
+      potential_duplicates.each {|key, value|
+        opnn; e "A duplicate entry was found, called: `#{sfancy(key)}`"
+        opnn; e 'The file that holds this entry is `'+sfile(main_file?)+'`.'
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === do_not_exit
+  # ========================================================================= #
+  def do_not_exit
+    @exit_on_problems = false
+  end
+
+  # ========================================================================= #
+  # === prepare_and_then_return_main_dataset
+  # ========================================================================= #
+  def prepare_and_then_return_main_dataset
+    return read_in_the_dataset_from_the_file_important_exams
+  end
+
+  # ========================================================================= #
+  # === read_in_the_dataset_from_the_file_important_exams
+  # ========================================================================= #
+  def read_in_the_dataset_from_the_file_important_exams(
+      use_this_file = Studium.file_important_exams?
+    )
+    # ======================================================================= #
+    # === @dataset_from_the_file_important_exams
+    #
+    # Assign the dataset from the file important_exams.yml next.
+    # ======================================================================= #
+    @dataset_from_the_file_important_exams =
+      readlines_with_the_default_encoding(use_this_file).reject {|line|
+        line.strip.empty? or line.strip.start_with?('#')
+      }.map {|inner_line| # Process it a bit.
+        inner_line = inner_line.strip.squeeze(' ').dup
+        if inner_line.start_with? '- '
+          inner_line.delete_prefix!('- ')
+          inner_line.delete!('"')
+        end
+        if inner_line.include? ' #'
+          inner_line = inner_line.split(' #').first.strip
+        end
+        inner_line.strip!
+        inner_line
+      }
+    return @dataset_from_the_file_important_exams
+  end
+
+  # ========================================================================= #
+  # === filter_away_unimportant_exams
+  # ========================================================================= #
+  def filter_away_unimportant_exams
+    @dataset.select! {|a, b|
+      unless @dataset.has_key?(a)
+        opnn; e 'The key '+sfancy(a.strip)+' is not registered '\
+                'in the file lecture_information.yml'
+        opnn; e 'This is presently not allowed. '+
+                yellow('Exiting now.')
+        opnn; e 'The file that should include this lecture is `'+
+                sfile(
+                  File.basename(main_file?)
+                )+
+                '`.'
+        exit
+      end
+      @dataset_from_the_file_important_exams.include?(a)
+    }
+  end
+
+  # ========================================================================= #
+  # === sanitize_the_dataset
+  # ========================================================================= #
+  def sanitize_the_dataset
+    # ======================================================================= #
+    # First, filter away the unimportant exams.
+    # ======================================================================= #
+    filter_away_unimportant_exams
+    _ = @dataset.map {|a, inner_hash|
+      exams = inner_hash['exams']
+      if exams.is_a? Array
+        exams = exams.first
+      end
+      exams.strip!
+      exams.squeeze!(' ')
+      exams = remove_german_weekdays(exams)
+      if exams.include? '-'
+        exams = exams.split('-').first
+      end
+      inner_hash['exams'] = Time.parse(exams)
+      [a, inner_hash]
+    }
+    _ = _.sort_by {|a,b| b['exams'] }
+    _ = Hash[_]
+    @dataset = _
+  end
+
+  # ========================================================================= #
+  # === filter_away_all_but_these_months
+  #
+  # This method can be used to filter away all but the given input
+  # arguments months, such as 'September'.
+  #
+  # Invocation example:
+  #
+  #   upcoming_exams --September
+  #
+  # ========================================================================= #
+  def filter_away_all_but_these_months(i)
+    i = i.delete('-')
+    i.sub!(/month=/,'') if i.include? 'month='
+    i = return_month_fitting_to_this_input(i)
+    i = i.to_i # Don't want any '-' characters.
+    @dataset.select! {|a,b|
+      exams = b['exams']
+      if exams.is_a? Array
+        exams = exams.first
+      end
+      exams = remove_german_weekdays(exams).strip.delete(',')
+      exams.split('.')[1].to_i == i
+    }
+  end
+
+  # ========================================================================= #
+  # === check_whether_the_entries_in_the_file_important_exams_are_correct (check tag)
+  #
+  # Invocation example:
+  #
+  #   timetable --check
+  #
+  # ========================================================================= #
+  def check_whether_the_entries_in_the_file_important_exams_are_correct
+    dataset_from_the_file_lecture_information =
+      Studium.return_sanitized_dataset_from_the_file_lecture_information
+    everything_is_ok = true
+    _ = prepare_and_then_return_main_dataset
+    _.each {|line|
+      first = line
+      first = first.first if first.respond_to?(:first)
+      first = first.squeeze(' ').strip
+      if dataset_from_the_file_lecture_information.has_key?(first)
+        # Then all is fine
+      else
+        everything_is_ok = false
+        opnn; e 'The lecture '+sfancy(first)+' is not registered '\
+                'in the file '+sfancy('lecture_information.yml')
+      end
+    }
+    if everything_is_ok
+      opnn; e 'Everything is fine - the entries in the file '
+      opnn; e sfile('lecture_information.yml')+' all appear to be correct.'
+    end
+  end
+
+  # ========================================================================= #
+  # === main_file?
+  #
+  # This query-method will refer to the file called
+  # "studium/yaml/important_exams.yml".
+  # ========================================================================= #
+  def main_file?
+    Studium.file_important_exams?
+  end; alias important_exams? main_file? # === important_exams?
+
+  # ========================================================================= #
+  # === open_all_important_files                                   (open tag)
+  #
+  # It will open the file on my home system, rather than the one that is
+  # inside the distributed studium-gem.
+  #
+  # To invoke this, do:
+  #
+  #   timetable --open
+  #
+  # ========================================================================= #
+  def open_all_important_files
+    ::Studium.open_important_exams
+  end
+
+  # ========================================================================= #
+  # === notify_the_user_which_file_is_to_be_used
+  # ========================================================================= #
+  def notify_the_user_which_file_is_to_be_used
+    e
+    opnn; e 'Using the dataset from the file'
+    e
+    e "  #{sfile(main_file?)}"
+    e
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams::UpcomingExams.open_relevant_files
+  # ========================================================================= #
+  def self.open_relevant_files
+    ::Studium.open_important_exams
+  end
+
+  # ========================================================================= #
+  # === dataset?
+  # ========================================================================= #
+  def dataset?
+    @dataset
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    menu
+    notify_the_user_which_file_is_to_be_used
+    check_for_duplicates
+    check_for_entries_that_were_already_successfully_completed_and_report_these
+    sanitize_the_dataset
+    report
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams::UpcomingExams.in_this_curriculum
+  #
+  # This method will yield all upcoming exams for a specific curriculum.
+  # For instance, all upcoming exams for the Bachelorcurriculum
+  # Agrarwissenschaften.
+  #
+  # What exactly is an "upcoming exam"? Obviously this requires information
+  # about the time/date, so a future day where the exam will be held.
+  #
+  # Usage example:
+  #
+  #   Studium::Exams::UpcomingExams.in_this_curriculum(:bachelor_agrarwissenschaften)
+  #   Studium::Exams::UpcomingExams.in_this_curriculum(:bachelor_lbt)
+  #
+  # ========================================================================= #
+  def self.in_this_curriculum(
+      i = :bachelor_agrarwissenschaften
+    )
+    dataset = YAML.load_file(Studium.file_lecture_information)
+    # ======================================================================= #
+    # First, select only those entries that actually have an upcoming
+    # exam registered:
+    # ======================================================================= #
+    all_lectures_with_an_exams_entry = dataset.select {|a, b|
+      exams = b['exams']
+      exams and !exams.empty?
+    }
+    we_seek_this_curriculum_id = Studium.to_curriculum_id(i)
+    all_lectures_with_an_exams_entry_for_this_curriculum = all_lectures_with_an_exams_entry.select {|a, b|
+      curricula = b['curricula'] # This will now be an Array such as ['033225', '033227']
+      curricula.include?(we_seek_this_curriculum_id)
+    }
+    # ======================================================================= #
+    # Last but not least, we have to compare this with the current day.
+    # ======================================================================= #
+    today = ::Time.now
+    regex_for_the_exam_day = /(\d{2}\.\d{2}\.\d{4})/ # Match towards e. g. "30.01.2023".
+    all_lectures_with_an_upcoming_exams_entry_for_this_curriculum = all_lectures_with_an_exams_entry_for_this_curriculum.select {|a, b|
+      exams = b['exams'].map {|entry|
+        # =================================================================== #
+        # The entry may be like this:
+        #
+        #   "Dienstag   30.01.2023, 08:30-09:30, Ort: HS TÜWI01 TÜWI-U1/02"
+        #
+        # =================================================================== #
+        if (entry =~ regex_for_the_exam_day)
+          ::Time.parse($1.to_s.dup)
+        else
+          nil
+        end
+      }
+      exams.compact!
+      exams.any? {|inner_entry|
+        inner_entry > today
+      } # This means an upcoming exam.
+    }
+    return all_lectures_with_an_upcoming_exams_entry_for_this_curriculum
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams::UpcomingExams[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Exams::UpcomingExams.new(ARGV)
+end

data/lib/studium/exams/upcoming_exams_at_the_boku/constants.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/exams/upcoming_exams_at_the_boku/constants.rb'
+# =========================================================================== #
+module Studium
+
+module Exams
+
+class UpcomingExamsAtTheBoku < ::Studium::Base
+
+  # ========================================================================= #
+  # === SHALL_WE_OPEN_IN_THE_BROWSER
+  # ========================================================================= #
+  SHALL_WE_OPEN_IN_THE_BROWSER = true
+
+  # ========================================================================= #
+  # === BR
+  # ========================================================================= #
+  BR = '<br>'
+
+end; end; end

data/lib/studium/exams/upcoming_exams_at_the_boku/html.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/exams/upcoming_exams_at_the_boku/html.rb'
+# =========================================================================== #
+module Studium
+
+module Exams
+
+class UpcomingExamsAtTheBoku < ::Studium::Base
+
+  # ========================================================================= #
+  # === save_into_a_html_page
+  #
+  # This method will generate the actual .html file.
+  # ========================================================================= #
+  def save_into_a_html_page
+    _ = '<html>'.dup
+    # ======================================================================= #
+    # We need ISO encoding for now. Assuming HTML4 for now; HTML5 is
+    # probably backwards-compatible.
+    # ======================================================================= #
+    _ << '<meta http-equiv="Content-Type" content="text/html;charset=ISO-8859-1">'
+    _ << "#{N}<head><title>Upcoming Exams at the BOKU</title></head><body>#{N}"
+    counter = 0
+    hash_that_will_be_passed_into_the_timetable_div_creator = {}
+    @array_store_these_days.each {|title_of_the_lecture, hash_date|
+      counter += 1
+      # ===================================================================== #
+      # The Title of the lecture will be a <h3> tag.
+      # ===================================================================== #
+      _ << '<h3 style="margin-bottom:5px"><b>'+counter.to_s+')</b> '+
+            title_of_the_lecture+'</h3>'
+      # ===================================================================== #
+      # hash_date will look like this:
+      #   {"06.03.2017"=>"13:30-14:30"}
+      # ===================================================================== #
+      day_month_year   = hash_date.keys.first
+      time_on_this_day = hash_date.values.first
+      _ << '<b style="font-size: larger; color: crimson; margin-left:2em">'+day_month_year+'</b><br>'
+      _ << '<b style="color: darkgreen; margin-left:4em">'+time_on_this_day+'</b><br>'
+      remote_URL = return_exam_url_for_this_title_of_the_lecture(title_of_the_lecture)
+      _ << '<a style="margin-left:6em" href="'+remote_URL+'">'+remote_URL+'</a><br>'
+      hash_that_will_be_passed_into_the_timetable_div_creator[title_of_the_lecture] = {
+        next_exam:  day_month_year,
+        remote_url: remote_URL
+      }
+    }
+    # ======================================================================= #
+    # Next, add the timetable-div, from the other html.rb file.
+    # ======================================================================= #
+    timetable_div = ::Studium::StudiumSolved.return_div_timetable_of_upcoming_exams(
+      hash_that_will_be_passed_into_the_timetable_div_creator
+    )
+    _ << timetable_div
+    _ << '</body></html>'
+    what = _
+    @into = html_log_dir?+'Upcoming_Exams_at_the_BOKU.html'
+    e 'Saving into `'+sfile(@into)+'`.'
+    write_what_into(what, @into)
+  end
+
+end; end; end