studium 0.9.383

data/lib/studium/exams/new_questions_per_year.rb

@@ -0,0 +1,136 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::NewQuestionsPerYear
+#
+# This class will show some statistics about how many new exam questions
+# were added per year.
+#
+# Usage example:
+#   NewQuestionsPerYear.new
+# =========================================================================== #
+# require 'studium/exams/new_questions_per_year.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Exams
+
+class NewQuestionsPerYear < ::Studium::Base # === NewQuestionsPerYear.new
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    @namespace = NAMESPACE
+    @hash_storing_n_exam_questions_per_year = {}
+  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
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    _ = FILE_STATISTICS
+    if File.exist? _
+      # ===================================================================== #
+      # If the file exists, load it up. It is not a yaml file though.
+      # ===================================================================== #
+      dataset = File.readlines(_)
+      # ===================================================================== #
+      # Select the proper entries.
+      # ===================================================================== #
+      dataset = dataset[21 .. -1].select {|line|
+        line.include?('Am') and line.include?('waren es')
+      }
+      # ===================================================================== #
+      # Next, this dataset has to be turned into a hash that stores a
+      # year → n_question relationship. We simply do this via an iteration.
+      # ===================================================================== #
+      use_this_regex =
+        /Am \d{2}.\d{2}.(\d{4}) waren es\s+(\d{1,2}.\d{3})/ # See: http://rubular.com/r/WyBLovDatp
+      dataset.each {|line|
+        line =~ use_this_regex
+        year = $1.to_s.dup.to_i
+        n_questions = $2.to_s.dup.delete('.').to_i
+        @hash_storing_n_exam_questions_per_year[year] = n_questions
+      }
+      report
+    end
+  end
+
+  # ========================================================================= #
+  # === report
+  # ========================================================================= #
+  def report(
+      i = @hash_storing_n_exam_questions_per_year
+    )
+    if i.is_a? Hash
+      the_previous_year_had_n_exam_questions = 0
+      e; i.each_pair {|year, n_exam_questions|
+        # ==================================================================== #
+        # Keep track of the amount of new questions that were added.
+        # ==================================================================== #
+        unless the_previous_year_had_n_exam_questions == 0
+          n_new_questions_were_added = n_exam_questions - the_previous_year_had_n_exam_questions
+        end
+        result = '  '+slateblue(year.to_s+': ')+
+                 seagreen(n_exam_questions.to_s.rjust(5)+' exam questions').dup
+        unless the_previous_year_had_n_exam_questions == 0
+          result << swarn(' (')+
+                    orangered('+'+n_new_questions_were_added.to_s)+
+                    swarn(' new questions were added compared to the previous year)')
+        end
+        e result
+        the_previous_year_had_n_exam_questions = n_exam_questions
+      }; e
+    end
+  end
+
+  # ========================================================================= #
+  # === []
+  # ========================================================================= #
+  def self.[](i = '')
+    self.new(i)
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Exams::NewQuestionsPerYear.new(ARGV)
+end # new_questions_per_year

data/lib/studium/exams/next_exam.rb

@@ -0,0 +1,117 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::NextExam
+#
+# The purpose of this class is to tell us when the next (n) exam(s) will
+# happen.
+#
+# Note that this works on local data - if you wish to obtain information
+# from upcoming exams for a lecture at a specific university, then you
+# have to use another class/method, such as:
+#
+#   Studium::Exams::NextExams.from_this_url()
+#
+# Usage examples:
+#   Studium::Exams::NextExam.new
+#   Studium.next_exam
+# =========================================================================== #
+# require 'studium/exams/next_exam.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+require 'studium/exams/ask_exam_question/ask_exam_question.rb'
+require 'studium/toplevel_methods/return_theme_of_the_next_upcoming_exam.rb'
+
+module Studium
+
+module Exams
+
+class NextExam < Studium::Base # === Studium::Exams::NextExam.new
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === NextExam::CYAN
+  # ========================================================================= #
+  CYAN = ::Colours::CYAN
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    super()
+    reset
+    if i.is_a? Symbol
+      set_mode i # Set the @runmode thus.
+      i = nil
+    end
+    case run_already
+    when :dont_run_yet,
+         :do_not_run_yet
+      run_already = false
+    end
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    set_mode :commandline
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === report_results                              (report tag, display tag)
+  # ========================================================================= #
+  def report_result
+    e result?
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    # ======================================================================= #
+    # Find out the theme of the next exam:
+    # ======================================================================= #
+    theme = Studium.return_theme_of_the_next_upcoming_exam
+    # ======================================================================= #
+    # And then simply delegate towards AskQuestion
+    # ======================================================================= #
+    Studium.ask_question(theme)
+  end
+
+end; end
+
+# =========================================================================== #
+# === Studium.next_exam
+# =========================================================================== #
+def self.next_exam
+  ::Studium::Exams::NextExam.new
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  _ = Studium::Exams::NextExam.new(ARGV, :dont_run_yet) # We run in commandline mode.
+  _.set_mode :commandline
+  _.run
+end # nexam

data/lib/studium/exams/next_exams.rb

@@ -0,0 +1,375 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::NextExams
+#
+# This class will obtain (and also optionally display) which exams will be
+# upcoming for a given URL next. Since different universities use different
+# systems, this has to be done in different ways.
+#
+# As of May 2017, if the input does not include "http", then we will assume
+# that the user wants to query the inormation from a local file instead,
+# by using the name of a lecture. For this to work, you must have this
+# lecture registered locally.
+#
+# Usage example:
+#   Studium::Exams::NextExams.new
+# =========================================================================== #
+# require 'studium/exams/next_exams.rb'
+# =========================================================================== #
+require 'open-uri'
+require 'studium/base/base.rb'
+
+module Studium
+
+module Exams
+
+class NextExams < Studium::Base # === Studium::Exams::NextExams.new
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === DEFAULT_REMOTE_URL
+  #
+  # Example URL:
+  #   https://online.boku.ac.at/BOKUonline/wbExamOffer.wbExamsOfCourse?pCourseNr=278031
+  # ========================================================================= #
+  DEFAULT_REMOTE_URL =
+    'https://online.boku.ac.at/BOKUonline/wbExamOffer.wbExamsOfCourse?pCourseNr=278031'
+
+  # ========================================================================= #
+  # === USE_THIS_REGEX_FOR_EXAMS_AT_THE_BOKU
+  #
+  # This regex is specifically for exams at the BOKU.
+  #
+  # See: http://rubular.com/r/Lza6qKILrA
+  # ========================================================================= #
+  USE_THIS_REGEX_FOR_EXAMS_AT_THE_BOKU =
+    /<span><span class="ExamDate\s{0,1}">(\d?\d.\d\d.\d\d\d\d)<\/span><br\/><span class="NoWarpTime\s{0,1}">(\d?\d:\d\d\s{0,1}-\s{0,1}\d?\d:\d\d)<\/span><\/span><\/div>/
+
+  # ========================================================================= #
+  # === USE_THIS_REGEX_FOR_EXAMS_AT_THE_TU_VIENNA
+  #
+  # Use a regex for exams at the TU Vienna.
+  #
+  # See: http://rubular.com/r/UoLvMHGLai
+  # ========================================================================= #
+  USE_THIS_REGEX_FOR_EXAMS_AT_THE_TU_VIENNA =
+    /\s+<th>Anmeldefrist<\/th>\s+<th>Anmeldung<\/th>\s+<th>Prüfung<\/th>\s+<\/tr>\s+<\/thead>\s+<tr>\s+<td>.+\s+<\/td>\s+<td>\s+-?\s+<\/td>\s+<td>(\d\d.\d\d.\d\d\d\d)\s+<\/td>\s+<td>/
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_remote_url(i)
+    if block_given?
+      yielded = yield
+      case yielded
+      when :be_quiet
+        do_be_quiet
+      end
+    end 
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    @remote_url = nil
+    @exam_dates = nil # This will eventually become a Hash.
+    @do_report_the_result = true
+    # ======================================================================= #
+    # Which regex to use - defaults to regexes at the BOKU.
+    # ======================================================================= #
+    @use_this_regex = USE_THIS_REGEX_FOR_EXAMS_AT_THE_BOKU
+  end
+
+  # ========================================================================= #
+  # === set_remote_url
+  # ========================================================================= #
+  def set_remote_url(i = '')
+    i = i.first if i.is_a? Array
+    i = DEFAULT_REMOTE_URL if i.nil?
+    i = i.to_s.dup
+    # ======================================================================= #
+    # The default is matching exams at the BOKU.
+    # ======================================================================= #
+    if i.include? 'tiss.tuwien.ac.at'
+      do_use_tu_vienna_regex
+    end
+    if i.include? 'http'
+      @remote_url = i
+    else # else assume local dataset and thus short-circuit here.
+      try_to_find_this_local_exam(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === local_file_with_upcoming_exams?
+  # ========================================================================= #
+  def local_file_with_upcoming_exams?
+    nil
+  end; alias main_file? local_file_with_upcoming_exams? # === main_file?
+
+  # ========================================================================= #
+  # === notify_which_remote_url_we_will_use
+  # ========================================================================= #
+  def notify_which_remote_url_we_will_use(i = remote_url?)
+    if i
+      opnn; e 'We will use the remote URL `'+sfancy(i)+'`.'
+    else
+      opnn; e 'Trying to use the local dataset (from file: '+sfile(
+        local_file_with_upcoming_exams?
+      )+')'
+    end
+  end
+
+  # ========================================================================= #
+  # === regex?
+  # ========================================================================= #
+  def regex?
+    @use_this_regex
+  end
+
+  # ========================================================================= #
+  # === do_use_regex_for_tu_vienna
+  # ========================================================================= #
+  def do_use_regex_for_tu_vienna
+    @use_this_regex = USE_THIS_REGEX_FOR_EXAMS_AT_THE_TU_VIENNA
+  end; alias do_use_tu_vienna_regex do_use_regex_for_tu_vienna # === do_use_tu_vienna_regex
+
+  # ========================================================================= #
+  # === Studium::Exams::NextExams.regex?
+  # ========================================================================= #
+  def self.regex?
+    USE_THIS_REGEX_FOR_EXAMS_AT_THE_BOKU
+  end
+
+  # ========================================================================= #
+  # === remote_url?
+  # ========================================================================= #
+  def remote_url?
+    @remote_url
+  end
+
+  # ========================================================================= #
+  # === exam_dates?
+  # ========================================================================= #
+  def exam_dates?
+    @exam_dates
+  end
+
+  # ========================================================================= #
+  # === sanitize_exam_dates
+  # ========================================================================= #
+  def sanitize_exam_dates
+    # ======================================================================= #
+    # Keep the exam dates sorted in reverse-manner. This means that you can
+    # obtain the first element of the hash and it will be the very next
+    # exam upcoming entry.
+    # ======================================================================= #
+    _ = @exam_dates.reverse # <--- This is an Array.
+    _.map! {|inner_array|
+      last = inner_array.last
+      if last.include? ' - '
+        last.delete!(' ')
+      end
+      inner_array[-1] = last
+      inner_array
+    }
+    hash = Hash[*_.flatten] # Turn it into a Hash again.
+    # ======================================================================= #
+    # Next, reject all invalid dates - that is, days from the past.
+    # ======================================================================= #
+    hash.reject! {|key, value|
+      Time.parse(key) < Time.now 
+    }
+    @exam_dates = hash # And re-assign it again. This time it is a Hash.
+  end
+
+  # ========================================================================= #
+  # === next_exam?
+  #
+  # Simply return the next exam.
+  # ========================================================================= #
+  def next_exam?
+    if @exam_dates
+      _ = @exam_dates.first # Use only the very next exam (singular entry) 
+      return Hash[*_]
+    end
+  end
+
+  # ========================================================================= #
+  # === do_be_quiet
+  # ========================================================================= #
+  def do_be_quiet
+    @do_report_the_result = false
+  end
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn
+    super(NAMESPACE)
+  end
+
+  # ========================================================================= #
+  # === apply_main_regex_to_find_all_exam_dates
+  #
+  # Apply our main regex here to find all the upcoming exam dates.
+  # ========================================================================= #
+  def apply_main_regex_to_find_all_exam_dates
+    if is_connected_to_the_www?
+      @exam_dates = @dataset.scan(regex?)
+      sanitize_exam_dates # Convert it into a Hash.
+    end
+  end
+
+  # ========================================================================= #
+  # === obtain_dataset
+  # ========================================================================= #
+  def obtain_dataset(i = remote_url?)
+    if i
+      begin
+        @dataset = open(i).read
+      rescue OpenSSL::SSL::SSLError => error
+        pp error
+        www_connection_is_unavailable
+      rescue SocketError => error
+        pp error
+        www_connection_is_unavailable
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === report_exam_dates                                        (report tag)
+  #
+  # This method will simply report the upcoming exam dates.
+  #
+  # The input to this method should be a Hash. It can be an Array too,
+  # though, but the default is a Hash.
+  # ========================================================================= #
+  def report_exam_dates(i = @exam_dates)
+    if i.is_a? Hash
+      i.each_pair {|date, hour_time|
+        e date+': '+hour_time.to_s
+      }
+    else # Else assume an Array in this case.
+      # In this case, we additionally assume that the entry
+      # must be sanitized.
+      # ===================================================================== #
+      i.each {|line|
+        splitted = line.split(',')
+        date = splitted.first
+        hour_time = splitted.last
+        e date+': '+hour_time.to_s
+      }
+    end
+  end; alias report report_exam_dates # === report
+
+  # ========================================================================= #
+  # === try_to_find_this_local_exam
+  # ========================================================================= #
+  def try_to_find_this_local_exam(i)
+    opnn; e 'We will assume that the given input '+simp(i)
+    opnn; e 'is a locally registered exam.'
+    _ = main_file?
+    if File.exist? _
+      dataset = YAML.load_file(_)
+      if dataset.has_key? i # Ok has it registered.
+        possible_entries = dataset[i]
+        # =================================================================== #
+        # In this case, we have found something, and thus we
+        # will report that we have found something.
+        # =================================================================== #
+        opnn; e 'We have at the least one upcoming exam for this lecture.'
+        report(possible_entries)
+      else
+        opnn; e 'No registered entry called '+sfancy(i)+' was found.'
+      end
+      exit # Exit in any case.
+    else
+      opnn; e 'No file exists at '+sfile(_)+' - thus, we can not continue.'
+      opnn; e 'Exiting now as a consequence.'
+      exit
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    notify_which_remote_url_we_will_use if @do_report_the_result
+    obtain_dataset
+    apply_main_regex_to_find_all_exam_dates
+    report_exam_dates if @do_report_the_result
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams::NextExams.from_this_url()
+  #
+  # Use this method to find out all upcoming exams from a particular
+  # remote URL.
+  #
+  # The first argument is the URL - see below for such a specific example.
+  # ========================================================================= #
+  def self.from_this_url(
+      # remote_url = 'https://ufind.univie.ac.at/de/course.html?lv=300195&semester=2016W'
+      remote_url = DEFAULT_REMOTE_URL
+    )
+    object = self.new(remote_url)
+    return object
+  end
+
+  # ========================================================================= #
+  # === []
+  # ========================================================================= #
+  def self.[](i = '')
+    self.new(i)
+  end
+
+end; end
+
+# =========================================================================== #
+# === Studium.obtain_upcoming_exams_from_this_remote_url
+#
+# This method will return a Hash holding all the upcoming exams
+# for a given lecture. You must provide the URL to the lecture.
+# =========================================================================== #
+def self.obtain_upcoming_exams_from_this_remote_url(i)
+  object = Studium::Exams::NextExams.new(i) { :be_quiet }
+  return object.exam_dates?
+end
+
+# =========================================================================== #
+# === Studium.obtain_next_exam_from_this_remote_url
+#
+# This method will only return the next, upcoming exam. The input to
+# it should be the remote URL that has registered the exams.
+#
+# Usage examples:
+#   result = Studium.obtain_next_exam_from_this_remote_url("https://online.boku.ac.at/BOKUonline/wbExamOffer.wbExamsOfCourse?pCourseNr=278031")
+#   result = Studium.obtain_next_exam_from_this_remote_url("https://tiss.tuwien.ac.at/course/courseDetails.xhtml?dswid=4999&dsrid=824&courseNr=164178&semester=2017S")
+# =========================================================================== #
+def self.obtain_next_exam_from_this_remote_url(i)
+  object = Studium::Exams::NextExams.new(i) { :be_quiet }
+  return object.next_exam?
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Exams::NextExams.from_this_url(ARGV)
+end # next_exams "https://online.boku.ac.at/BOKUonline/wbExamOffer.wbExamsOfCourse?pCourseNr=278031&"
+    # next_exams "Grundlagen der Physiologie: von Mikroorganismen zu Pflanzen und Tieren"