studium 0.18.7

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

@@ -0,0 +1,479 @@
+#!/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
+
+  # ========================================================================= #
+  # === 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 = 25
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = ARGV,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    set_dataset(nil) # Make the variable known here.
+    show_n_last_exams(:default) # Make it known how many last-exams we'll show.
+    # ======================================================================= #
+    # === :total_n_ects
+    # ======================================================================= #
+    @internal_hash[:total_n_ects] = 0
+    obtain_dataset # Initialize the dataset once. This will remain the same.
+  end
+
+  # ========================================================================= #
+  # === obtain_dataset
+  #
+  # This method will obtain the dataset but also do some sanitizing.
+  # ========================================================================= #
+  def obtain_dataset(
+      i = Studium.file_passed_exams_per_month
+    )
+    _ = readlines_from_this_input_file(i).select {|line|
+      line =~ /^\d+/ # Only entries that start with a number.
+    }
+    set_dataset(_)
+  end
+
+  # ========================================================================= #
+  # === total_n_ects?
+  # ========================================================================= #
+  def total_n_ects?
+    @internal_hash[:total_n_ects]
+  end
+
+  # ========================================================================= #
+  # === set_dataset
+  # ========================================================================= #
+  def set_dataset(i = nil)
+    @internal_hash[:dataset] = i
+  end
+
+  # ========================================================================= #
+  # === dataset?
+  # ========================================================================= #
+  def dataset?
+    @internal_hash[:dataset]
+  end
+
+  # ========================================================================= #
+  # === show_n_last_exams?
+  # ========================================================================= #
+  def show_n_last_exams?
+    @internal_hash[:show_n_last_exams]
+  end; alias n_lectures? show_n_last_exams? # === n_lectures?
+
+  # ========================================================================= #
+  # === show_n_last_exams
+  #
+  # Invocation examples:
+  #
+  #   last_exams --12
+  #   last_exams --15
+  #
+  # ========================================================================= #
+  def show_n_last_exams(
+      i = :default
+    )
+    i = i.first if i.is_a? Array
+    i = :default if i.nil?
+    i = i.to_s.delete('-') if i.is_a?(String) # Eliminate any '-'.
+    case i
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default
+      i = DEFAULT_N_LAST_EXAMS
+    end
+    i = i.to_i # Must remain an Integer past this point..
+    @internal_hash[:show_n_last_exams] = i
+  end; alias set_n_lectures   show_n_last_exams # === set_n_lectures
+       alias set_show_n_exams show_n_last_exams # === set_show_n_exams
+
+  # ========================================================================= #
+  # === show_main_file_in_use
+  #
+  # Invocation example:
+  #
+  #   last_exams --file?
+  #
+  # ========================================================================= #
+  def show_main_file_in_use(
+      this_file = Studium.file_passed_exams_per_month
+    )
+    e sfile(this_file)
+  end
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  # ========================================================================= #
+  def show_help
+    opne '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
+
+  # ========================================================================= #
+  # === col2
+  # ========================================================================= #
+  def col2(i)
+    sfancy(i)
+  end
+
+  # ========================================================================= #
+  # === col1
+  # ========================================================================= #
+  def col1(i)
+    mediumaquamarine(i)
+  end
+
+  # ========================================================================= #
+  # === colour_for_ects_points
+  # ========================================================================= #
+  def colour_for_ects_points(i)
+    lightcoral(i)
+  end
+
+  # ========================================================================= #
+  # === return_all_passed_exams
+  # ========================================================================= #
+  def return_all_passed_exams(
+      i = Studium.file_passed_exams_per_month
+    )
+    dataset_from_the_file = File.readlines(i)
+    dataset = dataset_from_the_file.select! {|line|
+      line =~ /^d+/ # Only select the variants that start with a number.
+    }
+    return dataset
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # (case tag, menu tag)
+      # ===================================================================== #
+      # === Only show a specific year
+      #
+      # Invocation example:
+      #
+      #   last_exams --in-this-year=2022
+      #
+      # ===================================================================== #
+      when /^-?-?in(-|_)?this(-|_)?year=(\d+)$/i, # === $3
+           /^-?-?year=(\d+)$/i                    # === $1
+        which_year = $1.to_s.to_i
+        which_year = $3.to_s.to_i if $3
+        dataset = return_all_passed_exams
+        set_show_n_exams(dataset.size)
+        filter_away_all_but_this_year(which_year)
+      # ======================================================================= #
+      # === :show_all_passed_exams
+      #
+      # This variant is if you wish to show all the passed exams.
+      # ======================================================================= #
+      when :show_all_passed_exams,
+           /^-?-?all$/ # lastexams --all
+        dataset = return_all_passed_exams
+        set_show_n_exams(dataset.size)
+      # ===================================================================== #
+      # === last_exams --5
+      #
+      # Handle only numbers given next.
+      # ===================================================================== #
+      when /^-?-?\d{1,50}$/
+        set_n_lectures(i)
+      # ===================================================================== #
+      # === last_exams --uniwien
+      # ===================================================================== #
+      when /-?-?uni-?wien/i
+        _ = dataset?.select {|line| line.include? '| UniWien |' }
+        report_this_dataset(_)
+        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
+        }
+        set_dataset(dataset_mapped_to_the_grade)
+      # ===================================================================== #
+      # === last_exams --vetmed
+      # ===================================================================== #
+      when /-?-?vetmed/i
+        _ = dataset?.select {|line| line.include? '|  Vetmed |' }
+        report_this_dataset(_)
+        exit
+      # ===================================================================== #
+      # === 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
+      # ===================================================================== #
+      # === last_exams --file?
+      # ===================================================================== #
+      when /-?-?file\??/
+        show_main_file_in_use
+        exit
+      # ===================================================================== #
+      # === last_exams --help
+      # ===================================================================== #
+      when /-?-?help/
+        show_help
+        exit
+      end
+    end    
+  end
+
+  # ========================================================================= #
+  # === filter_away_all_but_this_year
+  # ========================================================================= #
+  def filter_away_all_but_this_year(this_year)
+    _ = dataset?.select {|line|
+      splitted = line.split('|')
+      first = splitted.first.strip
+      splitted_again = first.split('.')
+      this_year.to_s == splitted_again[2].to_s
+    }
+    set_dataset(_)
+  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_match
+  # ========================================================================= #
+  def report_match
+    # ======================================================================= #
+    # We first have to obtain the proper dataset.
+    # ======================================================================= #
+    _ = dataset?[0.. (show_n_last_exams? - 1)]
+    set_n_lectures(_.size)
+    report_this_dataset(_)
+  end; alias report report_match # === report (report tag)
+
+  # ========================================================================= #
+  # === report_summary
+  #
+  # This method is called from within report_this_dataset().
+  # ========================================================================= #
+  def report_summary
+    e
+    e rosybrown(
+        '      n ECTS in total: '.ljust(101)
+      )+
+      colour_for_ects_points(
+        total_n_ects?.to_s+' ECTS points'
+      )+
+      "#{rev} (among #{n_lectures?.to_s} lectures)"
+  end
+
+  # ========================================================================= #
+  # === report_this_dataset                                      (report tag)
+  # ========================================================================= #
+  def report_this_dataset(
+      i = dataset?
+    )
+    left_just = 84
+    e
+    i = i[0 .. (n_lectures? - 1)] # Shorten it here.
+    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.
+      @internal_hash[: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))}"\
+        "#{rev}) #{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
+
+  # ========================================================================= #
+  # === 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}")
+      e (' ' * 5)+olivedrab('→ '+remote_url)
+    }
+    e (' ' * 89)+colourize_ects("#{sum_of_ects} ECTS")
+    e
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    menu
+    report
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams::LastExams[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium::Exams.show_passed_exams
+#
+# Simply show all passed exams, in a colourful manner.
+# =========================================================================== #
+def self.show_passed_exams(
+    i = ARGV, &block
+  )
+  if i.empty?
+    Studium.show_n_last_exams(:show_all_passed_exams)
+  else
+    Studium::Exams::LastExams.new(i, &block)
+  end
+end
+
+end
+
+# =========================================================================== #
+# === Studium.show_passed_exams
+#
+# We want to have it reside on the main-namespace level as well.
+# =========================================================================== #
+def self.show_passed_exams(i = ARGV)
+  ::Studium::Exams.show_passed_exams(i)
+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)
+  # Studium.show_passed_exams
+end # lastexams 12
+    # lastexams --vetmed
+    # lastexams --grade=1

data/lib/studium/exams/lectures_without_exam_entry.rb

@@ -0,0 +1,137 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::LecturesWithoutExamEntry
+#
+# Usage example:
+#
+#   Studium::Exams::LecturesWithoutExamEntry.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/exams/lectures_without_exam_entry.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Exams
+
+class LecturesWithoutExamEntry < ::Studium::Base # === LecturesWithoutExamEntry
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = lecture_information_dataset
+    # ======================================================================= #
+    # === @lectures_that_have_no_upcoming_exam_entry
+    # ======================================================================= #
+    @lectures_that_have_no_upcoming_exam_entry = nil
+    # ======================================================================= #
+    # === @use_a_priority_filter_and_filter_at_this_priority
+    # ======================================================================= #
+    @use_a_priority_filter_and_filter_at_this_priority = 2
+  end
+
+  # ========================================================================= #
+  # === notify_the_user_how_many_entries_are_in_the_file_lecture_information
+  # ========================================================================= #
+  def notify_the_user_how_many_entries_are_in_the_file_lecture_information
+    opnn; e 'The file '+sfile('lecture_information.yml')+' has a '\
+            'total of '+sfancy(@dataset.keys.size.to_s)+' registered lectures.'
+  end
+
+  # ========================================================================= #
+  # === obtain_the_lectures_that_have_no_upcoming_exam_entry
+  #
+  # This method will return all lectures that have no registered
+  # exam entry. Lectures that were already passed successfully, or
+  # have a priority of less than 5, will be ignored.
+  # ========================================================================= #
+  def obtain_the_lectures_that_have_no_upcoming_exam_entry
+    _ = @dataset.select {|name_of_the_lecture, inner_dataset|
+      this_lecture_is_missing_an_exam_entry = true
+      priority       = inner_dataset[:priority]
+      already_solved = inner_dataset[:already_solved]
+      if already_solved # We skip all the lectures that are already solved.
+        this_lecture_is_missing_an_exam_entry = false
+      end
+      if priority > 5
+        this_lecture_is_missing_an_exam_entry = false
+      end
+      if inner_dataset.has_key?('exams') and !(inner_dataset['exams'].nil?)
+        this_lecture_is_missing_an_exam_entry = false
+      end
+      # ===================================================================== #
+      # If the following instance variable is set, then we will
+      # also filter for a certain priority value.
+      # ===================================================================== #
+      if @use_a_priority_filter_and_filter_at_this_priority
+        if priority > @use_a_priority_filter_and_filter_at_this_priority
+          this_lecture_is_missing_an_exam_entry = false
+        end
+      end
+     this_lecture_is_missing_an_exam_entry
+    }
+    @lectures_that_have_no_upcoming_exam_entry = _ 
+  end
+
+  require 'studium/toplevel_methods/return_remote_homepage_of_this_lecture.rb'
+  # ========================================================================= #
+  # === notify_the_user_as_to_which_lectures_have_no_upcoming_exam_entry
+  # ========================================================================= #
+  def notify_the_user_as_to_which_lectures_have_no_upcoming_exam_entry
+    _ = @lectures_that_have_no_upcoming_exam_entry
+    index = 0
+    opnn; e "The following lectures have no upcoming "\
+            "#{slateblue(':exam')} entry:"
+    e; _.each {|name, inner_dataset| index += 1
+      colourized_index = (index.to_s+')').rjust(5)
+      e "#{brown(colourized_index)} #{sfancy(name)}"
+      # ===================================================================== #
+      # Also try to obtain the URL next.
+      # ===================================================================== #
+      remote_url = Studium.return_remote_homepage_of_this_lecture(name)
+      e "        rf \"#{lightgreen(remote_url)}\""
+    }; e
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    notify_the_user_how_many_entries_are_in_the_file_lecture_information
+    obtain_the_lectures_that_have_no_upcoming_exam_entry
+    notify_the_user_as_to_which_lectures_have_no_upcoming_exam_entry
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams::LecturesWithoutExamEntry[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Exams::LecturesWithoutExamEntry.new(ARGV)
+end # lectureswithoutexamentry