studium 0.10.1

data/lib/studium/utility_scripts/show_all_lectures.rb

@@ -0,0 +1,403 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ShowAllLectures
+#
+# This class will show all lectures on the commandline. This will be
+# extremely colourful.
+#
+# In 2017, the University of Vienna deprecated its old online-search
+# system. Quite annoying, as the new one makes heavy use of JavaScript.
+#
+# We can probably adapt this code, to URLs such as:
+# 
+#   https://ufind.univie.ac.at/en/search.html?filter=all&query=300631")
+#
+# Usage example:
+#
+#   Studium::ShowAllLectures.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/show_all_lectures.rb' 
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ShowAllLectures < Studium::Base # === Studium::ShowAllLectures
+
+  begin
+    require 'roebe/modules/remove_html.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === ALSO_SHOW_REMOTE_URL
+  #
+  # If true then we will also show the remote URL on the terminal.
+  # ========================================================================= #
+  ALSO_SHOW_REMOTE_URL = true
+  
+  # ========================================================================= #
+  # === SAVE_FILE
+  # ========================================================================= #
+  SAVE_FILE = Studium.html_log_directory?+'Vorlesungsverzeichnis.html'
+
+  # ========================================================================= #
+  # === CURRENT_YEAR
+  # ========================================================================= #
+  CURRENT_YEAR = Time.now.year.to_s
+
+  # ========================================================================= #
+  # === CURRENT_SEMESTER
+  # ========================================================================= #
+  CURRENT_SEMESTER = 'S'+CURRENT_YEAR
+
+  # ========================================================================= #
+  # === REMOTE_URL
+  # ========================================================================= #
+  REMOTE_URL = 'http://online.univie.ac.at/vlvz?kapitel=3001&semester='+CURRENT_SEMESTER
+
+  # ========================================================================= #
+  # === REGEX_FOR_IDS
+  #
+  # We need the ID of the lecture, the type of the lecture and the
+  # name of the lecture. This is what the following regex will obtain.
+  #
+  # For the following regex, see this link:
+  #
+  #   http://rubular.com/r/IrKZKqfRAh
+  #
+  # ========================================================================= #
+  REGEX_FOR_IDS =
+    /<div class="vlvz_langtitel">(\d+) <abbr title=".+">(.*{1,2})<\/abbr><span class="vlvz_titel">(.+)<\/span><\/div>/
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    @hash_for_ids = {}
+  end
+
+  # ========================================================================= #
+  # === remote_url?
+  # ========================================================================= #
+  def remote_url?
+    REMOTE_URL
+  end
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #    
+  def opnn
+    super(NAMESPACE)
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    @input = i
+    menu(@input)
+  end
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  # ========================================================================= #
+  def show_help
+    require 'class_docu_shower'
+    ClassDocuShower.new(__FILE__) { :do_not_report_the_filename }
+  end
+
+  # ========================================================================= #
+  # === menu                                                      (menu tag)
+  # ========================================================================= #
+  def menu(i)
+    case i # case tag
+    # ======================================================================= #
+    # === show_all_lectures --help
+    # ======================================================================= #
+    when /-?-?help/
+      show_help
+      exit
+    # ======================================================================= #
+    # === show_all_lectures --update
+    # ======================================================================= #
+    when /-?-?update/
+      opnn; e 'Updating main entry.'
+      do_update_save_file
+    end
+  end
+
+  # ========================================================================= #
+  # === do_update_save_file
+  # ========================================================================= #
+  def do_update_save_file(i = SAVE_FILE)
+    File.delete(i) if File.exist? i
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === download_remote_page
+  # ========================================================================= #
+  def download_remote_page
+    # ======================================================================= #
+    # Here, we either read from the already downloaded dataset, or we
+    # will download again.
+    # ======================================================================= #
+    if File.exist? SAVE_FILE
+      opnn; e 'We will read from the file `'+sfile(SAVE_FILE)+'`.'
+      @dataset = File.read(SAVE_FILE)
+    else
+      _ = remote_url?
+      opnn; e 'We will read from the remote URL `'+sfancy(_)+'`.'
+      @dataset = open(_).read
+    end
+    @original_dataset = @dataset.dup # Keep a reference copy.
+    # ======================================================================= #
+    # Also save the original dataset.
+    # ======================================================================= #
+    save_original_dataset
+  end
+
+  # ========================================================================= #
+  # === save_original_dataset
+  # ========================================================================= #
+  def save_original_dataset
+    write_what_into(@dataset, SAVE_FILE) 
+  end
+
+  # ========================================================================= #
+  # === dataset?
+  # ========================================================================= #
+  def dataset?
+    @dataset
+  end
+
+  # ========================================================================= #
+  # === scan_for_all_ids
+  # ========================================================================= #
+  def scan_for_all_ids
+    @dataset = @dataset.scan(REGEX_FOR_IDS)
+  end
+
+  # ========================================================================= #
+  # === sanitize_dataset
+  #
+  # Currently we only strip the second entry.
+  # ========================================================================= #
+  def sanitize_dataset
+    @dataset.map! {|entry|
+      entry[2].strip! # This is the right entry to strip.
+      entry
+    }
+  end
+
+  # ========================================================================= #
+  # === colourize_name_of_lecture
+  # ========================================================================= #
+  def colourize_name_of_lecture(i)
+    mediumorchid(i)
+  end
+
+  # ========================================================================= #
+  # === colourize_lecture_id
+  # ========================================================================= #
+  def colourize_lecture_id(i)
+    paleturquoise(i)
+  end
+
+  # ========================================================================= #
+  # === sanitize_encoding
+  # ========================================================================= #
+  def sanitize_encoding(i)
+    case i.encoding.to_s
+    when ENCODING_UTF
+      # ===================================================================== #
+      # Convert to ISO then.
+      # ===================================================================== #
+      i = i.force_encoding(ENCODING_ISO)
+    end
+    require 'cyberweb/toplevel_methods/umlaute.rb'
+    WebObject.convert_back_german_umlauts(i) # Cyberweb will handle this for us.
+  end
+
+  # ========================================================================= #
+  # === colourize_ects
+  # ========================================================================= #
+  def colourize_ects(i)
+    orange(i)
+  end
+
+  # ========================================================================= #
+  # === colourize_lecturers
+  # ========================================================================= #
+  def colourize_lecturers(i)
+    slateblue(i)
+  end
+
+  # ========================================================================= #
+  # === obtain_name_of_lecturer_amount_of_hours_and_ects_points
+  #
+  # Here we have to re-scan the dataset, in order to extract more
+  # information from the original dataset.
+  # ========================================================================= #
+  def obtain_name_of_lecturer_amount_of_hours_and_ects_points
+    @original_dataset.split(N).each {|line|
+      if line =~ REGEX_FOR_IDS
+        if @usher.open? # In this case it must be a new line.
+          analyze_big_lecture_chunk(@usher.string?)
+          @usher.reset
+        else # It must be in closed-state past here.
+          @usher.do_open
+        end
+        @usher << line
+      else
+        @usher << line
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === show_remote_url?
+  # ========================================================================= #
+  def show_remote_url?
+    ALSO_SHOW_REMOTE_URL
+  end
+
+  # ========================================================================= #
+  # === analyze_big_lecture_chunk
+  # ========================================================================= #
+  def analyze_big_lecture_chunk(i)
+    i.delete(N) if i.include? N # We don't like newlines here.
+    # ======================================================================= #
+    # Next, find out the name of the lecturer(s).
+    # ======================================================================= #
+    if i.include? '<div class="vlvz_vortragende">N.N.</div>'
+      name_of_lecturers = [ swarn('unknown lecturers') ]
+    else
+      name_of_lecturers =
+        #i.scan(/<div class="vlvz_vortragende">(<a href=".*">.* <\/a>)/).flatten.first
+        i.scan(/<div class="vlvz_vortragende"><a href="pers\?pkey=\d+">(.+) <\/a>/).flatten.first
+    end
+    # ======================================================================= #
+    # Next comes a slight hack. We will chop to the first '</a></div>'
+    # if it exists.
+    # ======================================================================= #
+    if name_of_lecturers.include? '</a></div>'
+      name_of_lecturers = name_of_lecturers[0..(name_of_lecturers.index('</a></div>')-1)]
+    end
+    name_of_lecturers = remove_html(name_of_lecturers)
+    name_of_lecturers = name_of_lecturers.split(',').map(&:strip)
+    regex_for_hours_and_ects_points = 
+      /<div class="vlvz_wochenstunden">(\d+ Stunde\(n\),\s+\d+,\d+ ECTS) credits<\/div>/
+    hours_and_ects_points  = i.scan(regex_for_hours_and_ects_points).flatten.first.squeeze(' ')
+    n_hours, n_ects_points = hours_and_ects_points.split('),').map(&:strip)  
+    lecture_id, lecture_type, name_of_lecture = i.scan(REGEX_FOR_IDS).flatten
+    original_lecture_id = lecture_id.to_s.dup
+    lecture_id          = lecture_id.center(10)
+    lecture_id          = colourize_lecture_id(lecture_id)
+    name_of_lecture     = sanitize_encoding(name_of_lecture).strip
+    name_of_lecturers   = name_of_lecturers.join(', ')
+    name_of_lecturers   = sanitize_encoding(name_of_lecturers)
+    name_of_lecturers   = name_of_lecturers.center(16)
+    lecture_type        = lecture_type.center(5)
+    lecture_type        = colourize_lecture_type(lecture_type)
+    n_hours             = n_hours.gsub(/Stunde\(n/,'').to_f.to_s.center(5)
+    n_hours             = colourize_hours_per_week(n_hours)
+    show_main_header # Show the main header first.
+    e lecture_id+' | '+lecture_type+' |   '+
+      colourize_name_of_lecture(name_of_lecture.ljust(50-2))+' | '+
+      colourize_lecturers(name_of_lecturers)+' | '+
+      n_hours+' | '+
+      colourize_ects(n_ects_points.gsub(/ECTS/,'').tr(',','.'))
+    if show_remote_url?
+      remote_url = '                     http://online.univie.ac.at/vlvz?&lvnr='+
+                   original_lecture_id+'&semester='+CURRENT_SEMESTER
+      e
+      e yellow(remote_url)
+      e
+    end
+  end
+
+  # ========================================================================= #
+  # === remove_html
+  # ========================================================================= #
+  def remove_html(i)
+    Roebe.remove_html(i)
+  end
+
+  # ========================================================================= #
+  # === display_main_header
+  #
+  # This method will display the header for a given lecture at hand.
+  # ========================================================================= #
+  def display_main_header
+    e colourize_lecture_id('Lecture ID')+
+      ' | '+
+      colourize_lecture_type('Type'.ljust(5))+
+      ' | '+
+      colourize_name_of_lecture('Name of Lecture'.ljust(50))+
+      ' | '+
+      colourize_lecturers('Lecturers'.center(16))+
+      ' | '+
+      colourize_hours_per_week('hours per week')+
+      ' | '+
+      colourize_ects('ECTS credits')
+  end; alias show_main_header display_main_header # === show_main_header
+
+  # ========================================================================= #
+  # === colourize_lecture_type
+  # ========================================================================= #
+  def colourize_lecture_type(i)
+    lawngreen(i)
+  end
+
+  # ========================================================================= #
+  # === colourize_hours_per_week
+  # ========================================================================= #
+  def colourize_hours_per_week(i)
+    dodgerblue(i)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    download_remote_page
+    scan_for_all_ids
+    sanitize_dataset
+    obtain_name_of_lecturer_amount_of_hours_and_ects_points
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ShowAllLectures.new(ARGV)
+end # showalllectures

data/lib/studium/utility_scripts/show_all_passed_master_lectures.rb

@@ -0,0 +1,127 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ShowAllPassedMasterLectures
+#
+# This class will display, on the commandline, all passed master lectures.
+#
+# Usage example:
+#
+#   Studium::ShowAllPassedMasterLectures.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/show_all_passed_master_lectures.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ShowAllPassedMasterLectures < Base # === Studium::ShowAllPassedMasterLectures
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = return_all_lectures
+  end
+
+  # ========================================================================= #
+  # === select_only_passed_master_lectures
+  # ========================================================================= #
+  def select_only_passed_master_lectures
+    @dataset.select! {|name_of_the_lecture, inner_dataset|
+      has_this_lecture_been_passed = obtain(:passed_successfully, inner_dataset)
+      curricula_ids                = obtain(:curricula_ids, inner_dataset)
+      belongs_to_a_master_curriculum = is_this_lecture_registered_in_a_master_curriculum?(curricula_ids)
+      has_this_lecture_been_passed and belongs_to_a_master_curriculum
+    }
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report(
+      i = @dataset
+    )
+    if i.empty?
+      opnn; e 'No master lecture appears to have been passed yet.'
+    else
+      sorted_by_exam_date = i.sort_by {|a, b|
+        Time.parse(b[:already_solved_at])
+      }.reverse
+      index = 0
+      n_ects_points_passed_in_total = sorted_by_exam_date.map {|a,b|
+        obtain(:n_ects, b)
+      }.sum
+      e
+      e "#{rev}The following lectures in a master "\
+        "curriculum have been"
+      e 'passed successfully (total: '+
+        orange(n_ects_points_passed_in_total)+
+        ' ECTS points):'
+      e
+      sorted_by_exam_date.each {|name_of_the_lecture, inner_dataset| index += 1
+        padded_index = index.to_s.rjust(4)+') '
+        colourized_index = yellowgreen(padded_index)
+        colourized_name_of_the_lecture = powderblue(
+          name_of_the_lecture.ljust(88)
+        )
+        n_ects = obtain(:n_ects, inner_dataset).to_s
+        colourized_n_ects = tomato(n_ects.to_s.rjust(5)+' ECTS').to_s.ljust(10)
+        passed_when = obtain(:passed_when, inner_dataset)
+        colourized_passed_when = slateblue(passed_when.ljust(8))
+        e "#{colourized_index}"\
+          "#{colourized_name_of_the_lecture}"\
+          "#{colourized_n_ects}"\
+          " "\
+          "#{colourized_passed_when}"\
+      }; e
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    select_only_passed_master_lectures
+    report
+  end
+
+  # ========================================================================= #
+  # === Studium::ShowAllPassedMasterLectures[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ShowAllPassedMasterLectures.new(ARGV)
+end # showallpassedmasterlectures