studium 0.10.1

data/lib/studium/exams/exams_this_week.rb

@@ -0,0 +1,179 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ExamsThisWeek
+#
+# Usage example:
+#
+#   Studium::ExamsThisWeek.new
+#
+# =========================================================================== #
+# require 'exams_this_week.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ExamsThisWeek < Base # === Studium::ExamsThisWeek
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = return_dataset_from_file_lecture_information
+    # ======================================================================= #
+    # === @starting_time_to_use
+    #
+    # This variable determines which week to show.
+    # ======================================================================= #
+    @starting_time_to_use = Time.now
+    # ======================================================================= #
+    # === @horizontal_bar
+    #
+    # This is just for a horizontal bar, a unicode character.
+    # ======================================================================= #
+    @horizontal_bar = horizontal_bar?
+    sanitize_the_main_dataset
+  end
+
+  # ========================================================================= #
+  # === sanitize_the_main_dataset
+  #
+  # This method will sanitize the main dataset.
+  # ========================================================================= #
+  def sanitize_the_main_dataset
+    # ======================================================================= #
+    # First, we select only entries that have an exam entry.
+    # ======================================================================= #
+    @dataset.select! {|a,b|
+      b.has_key?('exams')
+    }
+  end
+
+  # ========================================================================= #
+  # === display_all_exams_in_this_week
+  #
+  # This is the main method that will show all exams in this week.
+  # ========================================================================= #
+  def display_all_exams_in_this_week
+    # ======================================================================= #
+    # First we must build a time range. The time range typically begins
+    # today, and ends at the next Sunday. The start time can be chosen,
+    # though, by setting the variable @starting_time_to_use.
+    # ======================================================================= #
+    n_days = return_n_days_until_sunday(@starting_time_to_use)
+    time_until_sunday = (Date.today + n_days)
+    hash = {} # Collect the results here.
+    @dataset.each {|a, b|
+      exams = b['exams']
+      if exams.any? {|entry|
+        parsed_time = Time.parse(entry)
+        (parsed_time < time_until_sunday.to_time) and
+        (parsed_time > @starting_time_to_use)
+      }
+        hash[a] = b
+      end
+    }
+    if hash and !hash.empty?
+      report(hash)
+    else
+      e 'No exam is registered for the current week.'
+    end
+  end
+
+  # ========================================================================= #
+  # === report
+  #
+  # The input to this method should be our Hash.
+  # ========================================================================= #
+  def report(i)
+    # ======================================================================= #
+    # We must sort these based on the time-stamp of the first exam.
+    # ======================================================================= #
+    sorted = i.sort_by {|a, b|
+      exams = b['exams']
+      first_exam = exams.first
+      Time.parse(first_exam)
+    }
+    e "#{rev}The following #{lightgreen(sorted.size)} "\
+      "exams will happen in #{royalblue('this week')}:"
+    e
+    index = 0
+    cliner
+    sorted.each {|name_of_the_course, b| index += 1
+      exams = b['exams']
+      remote_url = obtain_from(:remote_url, b) # Obtain the remote url here.
+      first_exam = exams.first
+      first_exam_time_parsed = Time.parse(first_exam)
+      # ===================================================================== #
+      # Get the time of the exam:
+      # ===================================================================== #
+      time_of_the_exam = return_hour_from_this(first_exam)
+      english_weekday = translate_dd_mm_yyyy_to_weekday(first_exam.to_s)
+      german_weekday  = english_to_german_weekday(english_weekday)
+      german_dd_mm_yyyy_format = german_formatting_for_the_date(first_exam_time_parsed)
+      # ===================================================================== #
+      # First display the index, to the left side.
+      # ===================================================================== #
+      e "  #{lightgreen(index)}) #{steelblue(name_of_the_course).ljust(90)} "+\
+        mediumpurple("[#{english_weekday}]")
+      e "       → #{springgreen(remote_url)}"
+      result = royalblue('         The exam will be at:')+
+        darkkhaki("       #{german_weekday} "\
+                  "#{german_dd_mm_yyyy_format}"
+        )+crimson(' [Uhrzeit: '+time_of_the_exam.to_s+']')
+      if is_this_day_today?(german_dd_mm_yyyy_format)
+        result << lightsteelblue(' ← ist heute \o/')
+      end
+      e result
+      e
+      cliner
+    }
+    e
+  end
+
+  # ========================================================================= #
+  # === cliner
+  # ========================================================================= #
+  def cliner
+    e saddlebrown(@horizontal_bar * 90)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    display_all_exams_in_this_week
+  end
+
+  # ========================================================================= #
+  # === Studium::ExamsThisWeek[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ExamsThisWeek.new(ARGV)
+end # examsthisweek

data/lib/studium/exams/fix_exam_dates.rb

@@ -0,0 +1,129 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::FixExamDates
+#
+# This class can fix wrong (incomplete) exam date entries in the file
+# "lecture_information.yml".
+#
+# This class was created on the 29.03.2020.
+#
+# Usage example:
+#
+#   Studium::FixExamDates.new
+#
+# =========================================================================== #
+# require 'studium/exams/fix_exam_dates.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class FixExamDates < Base # === Studium::FixExamDates
+
+  # ========================================================================= #
+  # === 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
+    # ======================================================================= #
+    # === @new_dataset
+    # ======================================================================= #
+    @new_dataset = ''.dup
+  end
+
+  # ========================================================================= #
+  # === read_in_the_dataset_from_the_file_lecture_information
+  # ========================================================================= #
+  def read_in_the_dataset_from_the_file_lecture_information
+    @dataset = File.readlines(file_lecture_information?)
+  end
+
+  # ========================================================================= #
+  # === fix_all_discovered_erroneous_entries
+  # ========================================================================= #
+  def fix_all_discovered_erroneous_entries
+    use_this_regex =
+      /^ - "(\d{2}\.\d{2}\.\d{4}), \d{2}:\d{2}-\d{2}:\d{2}/
+      # See: https://rubular.com/r/CpWu9KIhOSUTDk
+    @dataset.each {|line|
+      if line.include?(' - "') and line.include?('-') and
+         line.include?(', ')
+        # =================================================================== #
+        # This condition is valid, for example, for:
+        #
+        #   - "07.05.2020, 08:15-11:15"
+        #
+        # =================================================================== #
+        # Now: entries that do not have a german weekday, are by definition
+        # wrong aka incomplete. So check for that.
+        # =================================================================== #
+        if does_this_line_include_a_german_weekday?(line)
+        else
+          if line =~ use_this_regex
+            _ = return_german_weekday_of?($1.to_s.dup).ljust(10)
+            line = line.sub(/- "/, '- "'+_+' ')
+          end 
+        end
+      end
+      @new_dataset << line
+    }
+  end
+
+  # ========================================================================= #
+  # === store_the_new_dataset
+  #
+  # This method will store the new dataset.
+  # ========================================================================= #
+  def store_the_new_dataset
+    what = @new_dataset
+    into = rds(log_dir?+'/foo.yml')
+    opnn; e rev+'Storing into the file `'+sfile(into)+'`.'
+    write_what_into(what, into)
+    if is_on_roebe?
+      opnn; e 'Since we are on roebe, we will automatically overwrite the'
+      opnn; e 'old file.'
+      move_file(
+        into,
+        '/home/x/DATA/PROGRAMMING_LANGUAGES/RUBY/src/studium/'\
+        'lib/studium/yaml/lecture_information.yml'
+      )
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    read_in_the_dataset_from_the_file_lecture_information
+    fix_all_discovered_erroneous_entries
+    store_the_new_dataset
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::FixExamDates.new(ARGV)
+end # fixexamdates

data/lib/studium/exams/last_exams/last_exams.rb

@@ -0,0 +1,381 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::LastExams
+#
+# This class will show the last 12 exams that were solved, by default.
+#
+# Alternatively you can also pass in a number, which we will then interprete
+# as a query to show n exams. The input :show_all_passed_exams means that
+# we will show all passed exams.
+#
+# Another way to call this class is via --grade=1. In that event it will
+# simply show all exams passed where the grade was a "1".
+#
+# Usage example:
+#
+#   Studium::Exams::LastExams.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/exams/last_exams/last_exams.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Exams
+
+class LastExams < Studium::Base # === Studium::Exams::LastExams
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === DEFAULT_N_LAST_EXAMS
+  #
+  # Determine how many exams are to be shown by default, if no other
+  # arguments are passed to this class.
+  # ========================================================================= #
+  DEFAULT_N_LAST_EXAMS = 12
+
+  # ========================================================================= #
+  # === 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 = NAMESPACE
+    # ======================================================================= #
+    # === @total_n_ects
+    # ======================================================================= #
+    @total_n_ects = 0
+    # ======================================================================= #
+    # === @n_lectures
+    # ======================================================================= #
+    @n_lectures = 0
+    obtain_dataset # Initialize the dataset once. This will remain the same.
+  end
+
+  # ========================================================================= #
+  # === set_input
+  #
+  # Invocation examples:
+  #
+  #   last_exams --12
+  #   last_exams --15
+  #
+  # ========================================================================= #
+  def set_input(
+      i = DEFAULT_N_LAST_EXAMS
+    )
+    i = i.first if i.is_a? Array
+    i = DEFAULT_N_LAST_EXAMS if i.nil?
+    case i # case tag, menu tag
+    # ======================================================================= #
+    # === last_exams --for-this-curriculum=033630
+    # ======================================================================= #
+    when /^-?-?for(-|_)?this(-|_)?curriculum=(.+)$/i # === $3
+      this_curriculum = $3.to_s.dup
+      report_this_hash(
+        return_all_passed_exams_belonging_to_this_curriculum(this_curriculum)
+      )
+      exit
+    # ======================================================================= #
+    # === --grade=1
+    # ======================================================================= #
+    when /^-?-?grade=(.+)/
+      seek_this_grade = $1.to_s.to_i
+      dataset = @dataset.map {|inner_entry|
+        inner_entry.split('|').map(&:strip)
+      }
+      dataset_mapped_to_the_grade = dataset.select {|inner_array|
+        grade = inner_array[3].to_i
+        grade == seek_this_grade
+      }
+      @dataset = i = dataset_mapped_to_the_grade
+    # ======================================================================= #
+    # === :show_all_passed_exams
+    #
+    # This variant is if you wish to show all the passed exams.
+    # ======================================================================= #
+    when :show_all_passed_exams
+      dataset_from_the_file = File.readlines(FILE_PASSED_EXAMS_PER_MONTH)
+      dataset = dataset_from_the_file.select! {|line|
+        line =~ /^d+/ # Only select the variants that start with a number.
+      }
+      i = dataset.size
+    # ======================================================================= #
+    # === last_exams --uniwien
+    # ======================================================================= #
+    when /-?-?uni-?wien/i
+      _ = @dataset.select {|line| line.include? '| UniWien |' }
+      report_this_dataset(_)
+      exit
+    # ======================================================================= #
+    # === last_exams --vetmed
+    # ======================================================================= #
+    when /-?-?vetmed/i
+      _ = @dataset.select {|line| line.include? '|  Vetmed |' }
+      report_this_dataset(_)
+      exit
+    # ======================================================================= #
+    # === last_exams --file?
+    # ======================================================================= #
+    when /-?-?file\??/
+      show_main_file_in_use
+      exit
+    # ======================================================================= #
+    # === last_exams --help
+    # ======================================================================= #
+    when /-?-?help/
+      show_help
+      exit
+    end
+    i = i.to_s.delete('-')
+    i = i.to_i # Must remain an Integer.
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === show_main_file_in_use
+  #
+  # Invocation example:
+  #
+  #   last_exams --file?
+  #
+  # ========================================================================= #
+  def show_main_file_in_use
+    e sfile(FILE_PASSED_EXAMS_PER_MONTH)
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === report_match
+  # ========================================================================= #
+  def report_match
+    # ======================================================================= #
+    # We first have to obtain the proper dataset.
+    # ======================================================================= #
+    _ = @dataset[0.. (input? - 1)]
+    set_n_lectures(_.size)
+    report_this_dataset(_)
+  end; alias report report_match # === report (report tag)
+
+  # ========================================================================= #
+  # === set_n_lectures
+  # ========================================================================= #
+  def set_n_lectures(i)
+    @n_lectures = i
+  end
+
+  # ========================================================================= #
+  # === n_lectures?
+  # ========================================================================= #
+  def n_lectures?
+    @n_lectures
+  end
+
+  # ========================================================================= #
+  # === report_summary
+  # ========================================================================= #
+  def report_summary
+    e
+    e rosybrown(
+        '      n ECTS in total: '.ljust(101)
+      )+
+      colour_for_ects_points(
+        @total_n_ects.to_s+' ECTS points'
+      )+
+      ' (among '+n_lectures?.to_s+' lectures)'
+  end
+
+  # ========================================================================= #
+  # === colour_for_ects_points
+  # ========================================================================= #
+  def colour_for_ects_points(i)
+    lightcoral(i)
+  end
+
+  # ========================================================================= #
+  # === obtain_dataset
+  #
+  # This method will obtain the dataset but also do some sanitizing.
+  # ========================================================================= #
+  def obtain_dataset(
+      i = FILE_PASSED_EXAMS_PER_MONTH
+    )
+    _ = readlines_from_this_input_file(i).select {|line|
+      line =~ /^\d+/ # Only entries that start with a number.
+    }
+    @dataset = _
+  end
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  # ========================================================================= #
+  def show_help
+    opnn; e 'These options are available for the class:'
+    e
+    eparse '  --file?   # show which file we will use as our dataset'
+    eparse '  --grade=1 # show only exams that were passed with a '\
+           'certain grade'
+    eparse ' --for-this-curriculum=033630 # show only '\
+           'passed exams belonging to this curriculum'
+    e
+  end
+
+  # ========================================================================= #
+  # === report_this_dataset                                      (report tag)
+  # ========================================================================= #
+  def report_this_dataset(i)
+    left_just = 84
+    e
+    i.each_with_index {|line, index|
+      index += 1
+      # ===================================================================== #
+      # The dataset is stored in the splitted variable next:
+      # ===================================================================== #
+      if line.is_a? Array
+        splitted = line
+      else
+        splitted = line.split('|').map(&:strip)
+      end
+      # ===================================================================== #
+      # Keep in mind that a line may look like this:
+      #   03.03.2003 | 2.0 |  xxx | 4 | UniWien |   D  |   VO  |   801567   | 2003W | Einführung in die Paläobiologie
+      # ===================================================================== #
+      name_of_the_lecture = splitted.last
+      date = splitted.first
+      n_ects_points = splitted[2].to_f # Yes, this is n_ects_points.
+      @total_n_ects += n_ects_points
+      grade_of_the_passed_exam = splitted[3].to_s
+      which_university = splitted[4].to_s.strip
+      colourized_and_padded_which_university =
+        royalblue(which_university.center(7))
+      # ===================================================================== #
+      # Colourize the grade, aka "Note".
+      # ===================================================================== #
+      colourized_note = olivedrab("Note: #{grade_of_the_passed_exam}")
+      # ===================================================================== #
+      # Output the colourized result next.
+      # ===================================================================== #
+      e "#{col1(index.to_s.rjust(4))}"\
+        ") #{col2(name_of_the_lecture.ljust(left_just))} "\
+        "#{orangered(date)} "\
+        "#{colour_for_ects_points(n_ects_points.to_s.rjust(4)+' ECTS points')} "\
+        "#{colourized_and_padded_which_university} "\
+        "#{colourized_note}"
+    }
+    report_summary
+    e
+  end; alias report report_this_dataset # === report
+
+  # ========================================================================= #
+  # === col2
+  # ========================================================================= #
+  def col2(i)
+    sfancy(i)
+  end
+
+  # ========================================================================= #
+  # === col1
+  # ========================================================================= #
+  def col1(i)
+    mediumaquamarine(i)
+  end
+
+  # ========================================================================= #
+  # === return_all_passed_exams_belonging_to_this_curriculum
+  # ========================================================================= #
+  def return_all_passed_exams_belonging_to_this_curriculum(
+      i = '033630'
+    )
+    i = i.to_s
+    passed_courses = return_passed_courses
+    selection = passed_courses.select {|key, hash|
+      hash.has_key?('curricula') and
+      hash['curricula'].include? i
+    }
+    return selection
+  end
+
+  # ========================================================================= #
+  # === report_this_hash
+  # ========================================================================= #
+  def report_this_hash(i)
+    sum_of_ects = 0
+    index = 0
+    e
+    i.each_pair {|name_of_the_lecture, inner_hash| index += 1
+      n_ects     = obtain(:ects, inner_hash)
+      solved_at  = obtain(:solved_at, inner_hash)
+      remote_url = obtain(:remote_url, inner_hash)
+      sum_of_ects += n_ects
+      e rev+
+        col1(
+          index.to_s.rjust(3)+')'
+        )+' '+
+        col2(name_of_the_lecture.strip.ljust(84))+' '+
+        colourize_ects(n_ects.to_s.rjust(4)+' ECTS')+' '+
+        slateblue('Bestanden am: '+solved_at.to_s)
+      e (' ' * 5)+olivedrab('→ '+remote_url)
+    }
+    e (' ' * 89)+colourize_ects(sum_of_ects.to_s+' ECTS')
+    e
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    report_match
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams::LastExams[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+# =========================================================================== #
+# === Studium.show_n_last_exams
+#
+# The namespace Studium.last_exams is already registered elsewhere.
+# =========================================================================== #
+def self.show_n_last_exams(i = ARGV)
+  Studium::Exams::LastExams.new(i)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium.show_n_last_exams(ARGV)
+end # last_exams 12
+    # last_exams --vetmed
+    # lastexams --grade=1