studium 0.16.9

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

@@ -0,0 +1,194 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::UpcomingExamsAtTheBoku
+#
+# This class will generate a .html file containing all relevant upcoming
+# exams at the BOKU University.
+#
+# Usage example:
+#
+#   Studium::Exams::UpcomingExamsAtTheBoku.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/exams/upcoming_exams_at_the_boku.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+require 'studium/exams/upcoming_exams_at_the_boku/constants.rb'
+require 'studium/exams/upcoming_exams_at_the_boku/html.rb'
+
+module Studium
+
+module Exams
+
+class UpcomingExamsAtTheBoku < ::Studium::Base # Studium::Exams::UpcomingExamsAtTheBoku
+
+  require 'studium/exams/next_exams.rb'
+
+  begin
+    require 'open_in_browser'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @array_store_these_days
+    # ======================================================================= #
+    @array_store_these_days = []
+    # ======================================================================= #
+    # === @into
+    # ======================================================================= #
+    @into = nil
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === merge_into_one_big_array
+  #
+  # All registered curricula will be specified here.
+  # ========================================================================= #
+  def merge_into_one_big_array
+    _ = YAML.load_file(FILE_BACHELOR_AGRARWISSENSCHAFTEN)+
+        YAML.load_file(FILE_BACHELOR_LMBT)+
+        YAML.load_file(FILE_MASTER_LMBT)
+    @dataset = _.flatten.sort
+  end
+
+  # ========================================================================= #
+  # === iterate_over_the_dataset
+  # ========================================================================= #
+  def iterate_over_the_dataset
+    @dataset.each {|title_of_the_lecture|
+      remote_url = sanitize_url(title_of_the_lecture)
+      if remote_url.is_a? Array
+        remote_url = remote_url.first
+      end
+      the_lva_number = ::Studium.return_lva_number_of_this_lecture(title_of_the_lecture)
+      already_solved_or_not = ::Studium.already_solved_this_lva_number?(the_lva_number)
+      remote_url =~ REGEX_FOR_BOKU_EXAMS
+      # ===================================================================== #
+      # Obtain the remote URL for the exam-dates, at the BOKU.
+      # ===================================================================== #
+      exam_dates_remote_url =
+        'https://online.boku.ac.at/BOKUonline/wbExamOffer.wbExamsOfCourse?pCourseNr='+
+        $1.to_s
+      e 'Now working on "'+orange(title_of_the_lecture)+'":'
+      e '  '+lightblue(remote_url)
+      e '  '+lightgreen(exam_dates_remote_url)
+      unless already_solved_or_not
+        upcoming_exams = ::Studium.obtain_next_exam_from_this_remote_url(exam_dates_remote_url)
+        unless upcoming_exams.empty?
+          pp upcoming_exams
+          report_that_we_did_not_solve_this_lecture_yet_so_we_will_store_it
+          @array_store_these_days << [ title_of_the_lecture, upcoming_exams] 
+        end
+      end
+      e
+    }
+    sort_the_main_array_that_stores_the_upcoming_exam_dates # Must sort it next.
+  end
+
+  # ========================================================================= #
+  # === sort_the_main_array_that_stores_the_upcoming_exam_dates
+  #
+  # Must sort the main Array. Once this is done, we can store it into a
+  # .html file as-is.
+  # ========================================================================= #
+  def sort_the_main_array_that_stores_the_upcoming_exam_dates
+    @array_store_these_days = @array_store_these_days.sort_by {|title_of_the_lecture, hash_date|
+      Time.parse(hash_date.keys.first)
+    }
+  end
+
+  # ========================================================================= #
+  # === considering_opening_the_html_page_in_the_browser
+  # ========================================================================= #
+  def considering_opening_the_html_page_in_the_browser
+    Open.in_browser(@into) if SHALL_WE_OPEN_IN_THE_BROWSER
+  end
+
+  # ========================================================================= #
+  # === return_exam_url_for_this_title_of_the_lecture
+  # ========================================================================= #
+  def return_exam_url_for_this_title_of_the_lecture(i)
+    remote_url = BeautifulUrl[i]
+    if remote_url.is_a? Array
+      remote_url = remote_url.first
+    end
+    remote_url =~ /pStpSpNr=(\d+)/
+    exam_dates_remote_url =
+      'https://online.boku.ac.at/BOKUonline/wbExamOffer.wbExamsOfCourse?pCourseNr='+
+       $1.to_s
+    return exam_dates_remote_url
+  end
+
+  # ========================================================================= #
+  # === report_that_we_did_not_solve_this_lecture_yet_so_we_will_store_it
+  # ========================================================================= #
+  def report_that_we_did_not_solve_this_lecture_yet_so_we_will_store_it
+    e turquoise('    We did not solve this lecture yet, so we will store it in the')
+    e turquoise('    potentially upcoming exams.')
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    merge_into_one_big_array
+    iterate_over_the_dataset
+    save_into_a_html_page
+    considering_opening_the_html_page_in_the_browser
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams::UpcomingExamsAtTheBoku[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+# =========================================================================== #
+# === Studium.show_upcoming_exams_at_the_boku
+# =========================================================================== #
+def self.show_upcoming_exams_at_the_boku
+  Studium::Exams::UpcomingExamsAtTheBoku.new
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Exams::UpcomingExamsAtTheBoku.new(ARGV)
+end # upcomingexamsattheboku

data/lib/studium/exams/upcoming_exams_dataset.rb

@@ -0,0 +1,247 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::UpcomingExamsDataset
+#
+# This class is mostly an "internal" class, that is - it should be used
+# if you need a helper class that acts as a wrapper over the upcoming
+# exams. In order to determine whether there are upcoming exams or
+# not, a file has to be used (thus, it must exist), which holds the
+# information as to which exams will be upcoming.
+#
+# In other words, objects instantiated from this class will have methods
+# that allow you to easily query which exams may be upcoming.
+#
+# For specific usage examples in ruby, see the end of this file.
+#
+# As of April 2018, this class here is no longer that important, largely
+# because we are transitioning away from exams.yml as a file that
+# will hold future exams. This functionality will instead be
+# provided by the file "lecture_information.yml" instead, where
+# upcoming exams will be properly registered.
+# =========================================================================== #
+# require 'studium/exams/upcoming_exams_dataset.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Exams
+
+class UpcomingExamsDataset < ::Studium::Base
+
+  # =========================================================================== #
+  # === REGEX_FOR_DD_MM_YYYY_NOTATION
+  # =========================================================================== #
+  REGEX_FOR_DD_MM_YYYY_NOTATION = /(\d{1,2}\.\d{1,2}\.\d{4}),/
+
+  # =========================================================================== #
+  # === REGEX_FOR_THE_EXACT_TIME_ON_THE_EXAM_DAY
+  #
+  # See this URL for checking:
+  #   http://rubular.com/r/82GZwIAkV9
+  # =========================================================================== #
+  REGEX_FOR_THE_EXACT_TIME_ON_THE_EXAM_DAY =
+    / (\d{1,2}:\d{1,2}-\d{1,2}:\d{1,2})/
+
+  # =========================================================================== #
+  # === initialize
+  # =========================================================================== #
+  def initialize(
+      run_already = true
+    )
+    reset
+    run if run_already
+  end
+
+  # =========================================================================== #
+  # === reset
+  # =========================================================================== #
+  def reset
+    super()
+    infer_the_namespace
+    # ========================================================================= #
+    # === @array_containing_exam_dates
+    # ========================================================================= #
+    @array_containing_exam_dates = []
+    # ========================================================================= #
+    # === @hash_exam_dates
+    # ========================================================================= #
+    @hash_exam_dates = {}
+  end
+
+  # =========================================================================== #
+  # === load_dataset_from_the_exams_file
+  #
+  # Note that this depends on the file
+  #
+  #   "/home/x/STUDIUM/YAML/exams.yml"
+  #
+  # =========================================================================== #
+  def load_dataset_from_the_exams_file
+    if File.exist? FILE_EXAMS
+      @dataset = read_file(FILE_EXAMS)
+    else
+      opnn; e "Can not load from file `#{sfile(FILE_EXAMS)}`."
+    end
+  end
+
+  # =========================================================================== #
+  # === purge_this_line
+  #
+  # This will remove the line from the Hash.
+  # =========================================================================== #
+  def purge_this_line(line)
+    if @hash_exam_dates.has_value?(line)
+      @hash_exam_dates.reject! {|key, value|
+        value == line
+      }
+    end
+  end
+
+  # =========================================================================== #
+  # === scan_for_exam_entries_in_the_exams_file
+  # =========================================================================== #
+  def scan_for_exam_entries_in_the_exams_file
+    use_this_regex = /^# === \(\d{1,2}\) .+$/ # See: http://rubular.com/r/UfwBiWDOqg
+    regex_for_inner_date = /\)? (\d{1,2}\.\d{1,2}\.\d{4,4}),/
+    scanned = @dataset.scan(use_this_regex)
+    # ========================================================================= #
+    # Next, determine on which day we will have exams, into an Array.
+    # ========================================================================= #
+    scanned.each {|line|
+      # ======================================================================= #
+      # The line can be:
+      #   "# === (3) 05.03.2018, Strukturbiologie I, 14:00-15:30, Ort: STB/Hörsaal A Campus Vienna Biocenter 5, 1030 Wien"
+      # ======================================================================= #
+      the_date = line.scan(regex_for_inner_date).flatten.first # See: http://rubular.com/r/h40qQ9a3Nv
+      @hash_exam_dates[the_date] = line
+      @array_containing_exam_dates << the_date
+      @array_containing_exam_dates.uniq!
+    }
+  end
+
+  # =========================================================================== #
+  # === exam_dates?
+  # =========================================================================== #
+  def exam_dates?
+    @hash_exam_dates
+  end
+
+  # =========================================================================== #
+  # === has_key?
+  # =========================================================================== #
+  def has_key?(this_key)
+    @hash_exam_dates.has_key?(this_key)
+  end
+
+  # =========================================================================== #
+  # === return_date_and_time_of
+  #
+  # This method shall return a String such as:
+  #
+  #   08.03.2018, 17:00-18:45
+  #
+  # =========================================================================== #
+  def return_date_and_time_of(line)
+    _ = ''.dup
+    # ========================================================================= #
+    # First, find the dd.mm.yyyy notation.
+    # ========================================================================= #
+    _ << line.scan(REGEX_FOR_DD_MM_YYYY_NOTATION).flatten.first.to_s
+    _ << ', '
+    # ========================================================================= #
+    # Next, find the exam-time on that particular day.
+    # ========================================================================= # 
+    _ << line.scan(REGEX_FOR_THE_EXACT_TIME_ON_THE_EXAM_DAY).flatten.first.to_s
+    _
+  end
+
+  # =========================================================================== #
+  # === []
+  # =========================================================================== #
+  def [](i)
+    @hash_exam_dates[i]
+  end
+
+  # =========================================================================== #
+  # === exam_on_this_day?
+  #
+  # This method will return a Boolean - thus either true or false.
+  #
+  # It must return true if there is any (at the least one) exam on the
+  # given date - otherwise it will return false.
+  #
+  # The recommended format is in the dd.mm.yyyy notation.
+  # =========================================================================== #
+  def exam_on_this_day?(i = '08.03.2018')
+    @array_containing_exam_dates.include? i
+  end
+
+  # =========================================================================== #
+  # === return_most_likely_lecture_name_from_this_line
+  #
+  # This method will try to return the most likely name of the lecture at hand.
+  #
+  # It will then be able to return a String such as
+  # "Molekulare Infektionsbiologie", which represents the name
+  # of the lecture.
+  # =========================================================================== #
+  def return_most_likely_lecture_name_from_this_line(
+      i = '# === (3) 16.03.2018, 300707, Freitag, Molekulare Infektionsbiologie, Ort: Hörsaal C1 UniCampus Hof 2,Spitalgasse 2,1090 Wien,Beginnzeit(zw. 15-18 Uhr) wird am Dienstag davor bekanntgegeben!'
+    )
+    most_likely_lecture_name = i.dup.delete('#').sub(/ === /,'')
+    # ========================================================================= #
+    # Chop off entries such as (3) or (11)
+    # ========================================================================= #
+    most_likely_lecture_name.sub!(/\(\d{1,2}\)/,'')
+    most_likely_lecture_name.strip!
+    most_likely_lecture_name.delete!(',')
+    most_likely_lecture_name.squeeze!(' ')
+    if most_likely_lecture_name.include? 'Ort'
+      most_likely_lecture_name = most_likely_lecture_name[0 .. (most_likely_lecture_name.index('Ort') -1)]
+      most_likely_lecture_name.strip!
+    end
+    most_likely_lecture_name = remove_weekname_from(most_likely_lecture_name)
+    # ========================================================================= #
+    # Remove the time on that day next, such as 15:00-18:00.
+    # ========================================================================= #
+    most_likely_lecture_name.sub!(/\d{1,2}:\d{1,2}-\d{1,2}:\d{1,2}/,'')
+    most_likely_lecture_name.squeeze!(' ')
+    # ========================================================================= #
+    # Next, remove date-information.
+    # ========================================================================= #
+    most_likely_lecture_name.sub!(/\d{1,2}\.\d{1,2}.\d{4}/,'')
+    most_likely_lecture_name.squeeze!(' ')
+    most_likely_lecture_name.strip!
+    # ========================================================================= #
+    # Now the input may look like this → "300707 Molekulare Infektionsbiologie"
+    # So we just have to get rid of the numbers and there we go. But some
+    # lectures may include a number as part of their name, so we can not
+    # remove all numbers easily.
+    # ========================================================================= #
+    most_likely_lecture_name.gsub!(/^\d{1,3}\.?\d{1,3}/,'')
+    most_likely_lecture_name.strip!
+    most_likely_lecture_name
+  end
+
+  # =========================================================================== #
+  # === run
+  # =========================================================================== #
+  def run
+    load_dataset_from_the_exams_file
+    scan_for_exam_entries_in_the_exams_file
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'verbose_truth'
+  upcoming_exams_dataset = Studium::Exams::UpcomingExamsDataset.new
+  puts 'Is there an exam upcoming on this day: 08.03.2018? '+
+       VerboseTruth[upcoming_exams_dataset.exam_on_this_day?('08.03.2018')].to_s
+  puts upcoming_exams_dataset.return_most_likely_lecture_name_from_this_line(
+'# === (4) 20.03.2018, 301585, Dienstag, Molekulare Medizin 1, 17:00-19:00, Ort: SR 1/BZB, Dr.Bohrgasse 9/6.Stock'
+)
+end # upcomingexamsdataset

data/lib/studium/exams/upcoming_registered_exams/upcoming_registered_exams.rb

@@ -0,0 +1,257 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::UpcomingRegisteredExams
+#
+# This class will show the upcoming registered exams - and only those.
+# =========================================================================== #
+# require 'studium/exams/upcoming_registered_exams/upcoming_registered_exams.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Exams
+
+class UpcomingRegisteredExams < Base # === Studium::Exams::UpcomingRegisteredExams
+
+  begin
+    require 'cyberweb/requires/require_the_html_template.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === 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
+    reset_the_internal_hash
+    # ======================================================================= #
+    # === :dataset
+    # ======================================================================= #
+    @internal_hash[:dataset] = dataset_from_file_lecture_information
+    # ======================================================================= #
+    # === :shall_we_generate_a_HTML_file
+    # ======================================================================= #
+    @internal_hash[:shall_we_generate_a_HTML_file] = false
+    # ======================================================================= #
+    # === :html_content
+    # ======================================================================= #
+    @internal_hash[:html_content] = nil
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i
+      # ===================================================================== #
+      # === --help
+      # ===================================================================== #
+      when /^-?-?help$/i
+        show_help
+        exit
+      # ===================================================================== #
+      # === --html
+      # ===================================================================== #
+      when /^-?-?html$/i
+        @internal_hash[:shall_we_generate_a_HTML_file] = true
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === show_help
+  # ========================================================================= #
+  def show_help
+    e
+    e '  --html # generate a standalone .html file'
+    e
+  end
+
+  # ========================================================================= #
+  # === generate_a_HTML_file?
+  # ========================================================================= #
+  def generate_a_HTML_file?
+    @internal_hash[:shall_we_generate_a_HTML_file]
+  end
+
+  # ========================================================================= #
+  # === do_report_these_outdated_entries
+  # ========================================================================= #
+  def do_report_these_outdated_entries(i)
+    e tomato('The following exam entries are outdated:')
+    e
+    i.keys.each {|this_entry|
+      e "  #{lightblue(this_entry)}"
+    }
+    e
+  end
+
+  # ========================================================================= #
+  # === return_outdated_entries
+  # ========================================================================= #
+  def return_outdated_entries(i)
+    time_now = ::Time.now
+    # ======================================================================= #
+    # Now we have all valid entries. First check for outdated entries.
+    # ======================================================================= #
+    outdated_entries = i.select {|name_of_the_lecture, inner_hash|
+      registered = inner_hash['registered']
+      first_entry = registered.first
+      first_entry.delete!(',')
+      if first_entry.include? 'Ort:'
+        first_entry = first_entry.split('Ort:').first
+      end
+      first_entry.strip!
+      registered_time = ::Time.parse(first_entry)
+      registered_time < time_now
+    }
+    return outdated_entries
+  end
+
+  # ========================================================================= #
+  # === do_handle_all_outdated_entries_from
+  # ========================================================================= #
+  def do_handle_all_outdated_entries_from(i)
+    outdated_entries = return_outdated_entries(i)
+    unless outdated_entries.empty?
+      do_report_these_outdated_entries(outdated_entries)
+    end
+  end
+
+  # ========================================================================= #
+  # === return_registered_exam_entries
+  # ========================================================================= #
+  def return_registered_exam_entries(
+      i = @internal_hash[:dataset]
+    )
+    _ = i.select {|name_of_the_lecture, inner_hash|
+      inner_hash.has_key?('registered') and
+     !inner_hash['registered'].empty?
+    }
+    return _
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    menu
+    html_content = ''.dup if generate_a_HTML_file?
+    # ======================================================================= #
+    # First, we will select all entries with a "registered:" entry.
+    # ======================================================================= #
+    _ = return_registered_exam_entries
+    do_handle_all_outdated_entries_from(_)
+    unless generate_a_HTML_file?
+      e grey('The upcoming registered exams are:')
+      e
+    end
+    index = 0
+    # ======================================================================= #
+    # We must sort these entries based on time
+    # ======================================================================= #
+    sorted_entries = _.sort_by {|name_of_the_lecture, inner_hash|
+      exam_date = inner_hash['exams']
+      if exam_date.is_a? Array
+        exam_date = exam_date.first
+      end
+      if exam_date.include? 'Ort:'
+        exam_date = exam_date.split('Ort:').first
+      end
+      exam_date.delete!(',') if exam_date.include?(',')
+      ::Time.parse(exam_date)
+    }
+    sorted_entries.each {|name_of_the_lecture, inner_hash| index += 1
+      exam_date = inner_hash['exams']
+      remote_homepage = inner_hash[:homepage]
+      remote_homepage = remote_homepage.first if remote_homepage.is_a?(Array)
+      if exam_date.is_a? Array
+        exam_date = exam_date.first
+      end
+      exam_date = exam_date.to_s
+      if generate_a_HTML_file?
+        html_content << '<div><h2 style="margin-top: 5px">'+
+                        '<a href="'+remote_homepage.to_s+'">'+
+                        name_of_the_lecture+'</a></h2>'
+        html_content << '<span style="margin-left: 0.4em; color: darkblue; font-weight: bold;">'+
+                        exam_date+'</span><br>'
+        html_content << '</div>'
+      else # this is the default, aka verbose output on the commandline.
+        e "  #{lightblue(name_of_the_lecture.ljust(60))} "\
+          "#{grey('#')}#{lightgreen(index)}"
+        # =================================================================== #
+        # The exam date will be a bit reformatted:
+        # =================================================================== #
+        if exam_date.include?(' ')
+          splitted = exam_date.split(' ')
+          splitted[0] = mediumslateblue(splitted[0].ljust('Donnerstag '.size))
+          exam_date = splitted[0]+
+                      tomato(splitted[1 .. -1].join(' '))
+        end
+        e "    #{exam_date}"
+      end
+    } 
+    e
+    if generate_a_HTML_file?
+      @internal_hash[:html_content] = html_content
+      do_generate_a_HTML_file
+    end
+  end
+
+  # ========================================================================= #
+  # === do_generate_a_HTML_file
+  #
+  # This method can be used to generate a standalone .html file.
+  #
+  # Usage example:
+  #
+  #   upcomingregisteredexams --html
+  #
+  # ========================================================================= #
+  def do_generate_a_HTML_file
+    what = Cyberweb.html_template(
+      title: 'Upcoming registered exams',
+      body_css_style: 'padding: 4px; font-size: 1.4em;',
+      body:  @internal_hash[:html_content]
+    )
+    into = "#{log_dir?}upcoming_registered_exams.html"
+    write_what_into(what, into)
+    if is_on_roebe?
+      Open.in_browser(into)
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams::UpcomingRegisteredExams[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Exams::UpcomingRegisteredExams.new(ARGV)
+end # upcomingregisteredexams --html