studium 0.18.7

data/lib/studium/utility_scripts/expand_time_range/expand_time_range.rb

@@ -0,0 +1,521 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ExpandTimeRange
+#
+# This class is able to expand a time-range into a display that can be
+# used, specifically, to put into the file lecture_information.yml.
+#
+# I needed the class here so that I can find out the exact weekdays of
+# when practical courses happen.
+#
+# The main logic for this class is that it will parse the given input,
+# which can be oddly formatted too (derived from a copy/paste job, for
+# example); and then, based on this, determine the start_day, and the
+# end_day, which are instance variables of the class.
+#
+# Note that the class needs to be able to deal with slightly invalid
+# input too, such as "10.-28.7.2023". This will then be sanitized
+# towards the correct input being "10.07.2023-28.07.2023".
+#
+# Usage example:
+#
+#   Studium::ExpandTimeRange.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/expand_time_range/expand_time_range.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ExpandTimeRange < ::Studium::Base # === Studium::ExpandTimeRange
+
+  # ========================================================================= #
+  # === REGEX_FOR_A_CORRECT_DATE
+  # ========================================================================= #
+  REGEX_FOR_A_CORRECT_DATE = /\d{2}\.\d{2}\.\d{4}/ # e. g. "28.07.2023"
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = ARGV,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    # ======================================================================= #
+    # === Handle blocks
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :disable_colours
+      # ===================================================================== #
+      when :disable_colours
+        disable_colours
+      # ===================================================================== #
+      # === :do_not_report_anything
+      # ===================================================================== #
+      when :do_not_report_anything
+        do_not_report_anything
+      end
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @array_to_report
+    # ======================================================================= #
+    @array_to_report = []
+    # ======================================================================= #
+    # Define variables to keep track of our start and end day next.
+    # ======================================================================= #
+    @start_day = nil
+    # ======================================================================= #
+    # === @end_day
+    # ======================================================================= #
+    @end_day   = nil
+    # ======================================================================= #
+    # === @format_for_use_in_the_file_lecture_information
+    #
+    # If the following variable is set to true, then the generated display
+    # will conform to a yaml format (an Array), holding the time-data
+    # points as string.
+    # ======================================================================= #
+    @format_for_use_in_the_file_lecture_information = true
+    # ======================================================================= #
+    # === @append_this_string
+    # ======================================================================= #
+    @append_this_string = ', 09:00-18:00'
+    # ======================================================================= #
+    # === @report_the_result
+    # ======================================================================= #
+    @report_the_result = true
+    # ======================================================================= #
+    # === @show_only_the_raw_date
+    # ======================================================================= #
+    @show_only_the_raw_date = false
+  end
+
+  # ========================================================================= #
+  # === show_only_the_raw_date?
+  # ========================================================================= #
+  def show_only_the_raw_date?
+    @show_only_the_raw_date
+  end
+
+  # ========================================================================= #
+  # === do_not_report_anything
+  # ========================================================================= #
+  def do_not_report_anything
+    @report_the_result = false
+  end
+
+  # ========================================================================= #
+  # === process_commandline_arguments_without_leading_hyphens
+  #
+  # Example for different input:
+  #
+  #   " Donnerstag 04.10. bis Montag 15.10.2018 jeweils 9.30 bis 17.30 Uhr"
+  #
+  # ========================================================================= #
+  def process_commandline_arguments_without_leading_hyphens(
+      i = commandline_arguments_without_leading_hyphens?
+    )
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup.strip
+    i.chop! if i.end_with? ','
+    i.sub!(/ bis /,'-') if i.include? ' bis '
+    i = remove_weeknames_from(i)
+    i.strip!
+    if i.include? ' - '
+      i.sub!(/ - /, '-')
+    end
+    if i.include? '.- '
+      i.sub!(/\.- /,'.-')
+    end
+    if i.include? ' until '
+      i.sub!(/ until /,'-')
+    end
+    if i.include?('jeweils') and i.include?('Uhr')
+      splitted = i.split('jeweils').map(&:strip)
+      # ===================================================================== #
+      # The second part is the part that we can use for
+      # @append_this_string.
+      # ===================================================================== #
+      new_time = splitted.last.tr('.',':').sub(/ Uhr/,'').sub(/ bis /,'-')
+      if new_time =~ /^\d{1}:/
+        new_time.prepend('0')
+      end
+      @append_this_string = new_time
+      i = splitted.first
+    end
+    i.delete!(' ') # Trying this since as of 02.07.2018
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === try_to_determine_the_start_day_and_the_end_day
+  #
+  # This method also has to deal with invalid input, such as
+  # "10.-28.7.2023", which will have to be turned into
+  # "10.07.2023-28.07.2023".
+  # ========================================================================= #
+  def try_to_determine_the_start_day_and_the_end_day
+    _ = @input
+    if _.include? '-'
+      # ===================================================================== #
+      # In this case, it should be simple to determine the start and
+      # end day. Simply split on the '-' character.
+      # ===================================================================== #
+      splitted = _.split('-')
+      set_start_day(splitted[0]) { :try_to_sanitize_the_input }
+      set_end_day(splitted[1])   { :try_to_sanitize_the_input }
+    end
+  end
+
+  # ========================================================================= #
+  # === properly_space_out_date_format
+  #
+  # This method will mostly convert input such as "2.11.2018" towards
+  # "02.11.2018".
+  # ========================================================================= #
+  def properly_space_out_date_format(i)
+    _ = i.to_s.dup
+    if _ =~ /^\d{1}\./
+      _.prepend '0' # Prepend a leading '0' in these cases.
+    end
+    return _
+  end
+
+  # ========================================================================= #
+  # === ensure_proper_trailing_year
+  #
+  # We will try to ensure that there is a proper trailing year
+  # definition, to conform to the "dd.mm.yyyy" format which is
+  # commonly used in europe.
+  # ========================================================================= #
+  def ensure_proper_trailing_year(i)
+    _ = i.dup
+    unless _ =~ /\.\d{4}$/ # Unless it ends with a proper year
+      # ===================================================================== #
+      # First check on 'dd.mm.yy' format:
+      # ===================================================================== #
+      if _ =~ /\d{1,2}\.\d{1,2}\.\d{2}/
+        _.insert(_.rindex('.')+1, '20') # For example, for the year "2018".
+      else
+        _ << '.' unless _.end_with? '.'
+        _ << current_year?
+      end
+    end
+    return _
+  end
+
+  # ========================================================================= #
+  # === result?
+  # ========================================================================= #
+  def result?
+    @result
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report(
+      this_array = @array_to_report
+    )
+    show_only_the_raw_date = show_only_the_raw_date?
+    @result = ''.dup # We also store in this variable.
+    if @report_the_result
+      unless this_array.empty?
+        e; this_array.each {|entry|
+          weekday_entry = weekday_at(entry)
+          padded_and_colourized_weekday = turquoise(
+            weekday_entry.to_s.ljust(10)
+          )
+          result = ''.dup
+          if @format_for_use_in_the_file_lecture_information
+            result << mediumpurple(' - ')+
+                      return_colourized_quote_character unless show_only_the_raw_date
+          else
+            result << '  '
+          end
+          result << "#{padded_and_colourized_weekday} " unless show_only_the_raw_date
+          result << "#{steelblue(entry)}"
+          if @append_this_string and !show_only_the_raw_date
+            unless @append_this_string.start_with? ', '
+              @append_this_string.prepend(', ')
+            end
+            result << olivedrab(
+              @append_this_string
+            )
+          end
+          if @format_for_use_in_the_file_lecture_information and !show_only_the_raw_date
+            result << return_colourized_quote_character
+          end
+          result << "\n"
+          @result << result
+          print result
+        }; e
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === return_array_of_days_between_this_start_and_this_end_range
+  #
+  # This is the method that will return all days between the specified
+  # start-point and end-point.
+  # ========================================================================= #
+  def return_array_of_days_between_this_start_and_this_end_range(
+      a = @start_day,
+      b = @end_day
+    )
+    array = []
+    # ======================================================================= #
+    # First, split it up into components - day, month year. Note that we
+    # assume that @start_day and @end_day have already been sanitized
+    # prior to this.
+    # ======================================================================= #
+    splitted1 = a.split('.')
+    day1      = splitted1.first
+    month1    = splitted1[1].to_i
+    year      = splitted1[2]
+    # ======================================================================= #
+    # Determine how many days we shall be running.
+    # ======================================================================= #
+    diff      = Time.parse(b) - Time.parse(a)
+    n_days    = ((diff / ONE_DAY).ceil + 1)
+    counter   = 0
+    n_days.times {
+      day_to_use   = day1.to_i+counter.to_i
+      month_to_use = month1
+      n_days_in_this_month = this_month_has_n_days?(month_to_use)
+      # ===================================================================== #
+      # If we have already "run over" in that month, we will change
+      # to use a new month. We also have to keep track whether this
+      # may be a new year or not.
+      # ===================================================================== #
+      if day_to_use > n_days_in_this_month.to_i 
+        day_to_use = 1
+        day1 = 1
+        month1 += 1
+        month_to_use += 1
+        counter = 0
+      end
+      counter += 1
+      # ===================================================================== #
+      # Must format the months next, from e. g. "1" to "01".
+      # ===================================================================== #
+      month_to_use = month_to_use.to_s.rjust(2,'0')
+      array << properly_space_out_date_format(
+        day_to_use.to_i.to_s+'.'+
+        month_to_use.to_s+'.'+
+        year.to_s
+      )
+    }
+    # ======================================================================= #
+    # Next, we can remove weekends from that Array. Most lectures will
+    # not occur on saturday or sunday.
+    # ======================================================================= #
+    array = remove_weekends_from_this_array(array)
+    return array
+  end
+
+  # ========================================================================= #
+  # === expand_and_show_the_dates_in_between
+  # ========================================================================= #
+  def expand_and_show_the_dates_in_between
+    @array_to_report = return_array_of_days_between_this_start_and_this_end_range(
+      @start_day, @end_day
+    )
+    report(@array_to_report)
+  end
+
+  # ========================================================================= #
+  # === array_to_report?
+  # ========================================================================= #
+  def array_to_report?
+    @array_to_report
+  end; alias array? array_to_report? # === array?
+       alias array  array_to_report? # === array
+
+  # ========================================================================= #
+  # === return_colourized_quote_character
+  #
+  # The first argument shall be the colour that is to be used.
+  # ========================================================================= #
+  def return_colourized_quote_character(
+      use_this_colour = :darkslateblue
+    )
+    send(use_this_colour, '"')
+  end
+
+  # ========================================================================= #
+  # === remove_weekends_from_this_array
+  #
+  # This method will remove all weekend-days from the passed-in Array.
+  # ========================================================================= #
+  def remove_weekends_from_this_array(i)
+    i.reject {|entry|
+      weekday = return_weekday_of(entry)
+      (weekday == 'Saturday') or (weekday == 'Sunday')
+    }
+  end
+
+  # ========================================================================= #
+  # === set_start_day                                             (start tag)
+  #
+  # Note that we will also ensure that the year is in a correct format
+  # here, aka if we have a year such as '18' to become '2018' instead.
+  # ========================================================================= #
+  def set_start_day(i, &block)
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :try_to_sanitize_the_input
+      # ===================================================================== #
+      when :try_to_sanitize_the_input
+        unless (i =~ REGEX_FOR_A_CORRECT_DATE) # In this case we must sanitize.
+          i = i.dup if i.frozen?
+          n_dots = i.count('.')
+          if n_dots == 1 # Assume input such as "10.", but it can also be "06.03".
+            splitted = i.split('.')
+            if splitted.size < 2
+              i << '.' unless i.end_with?('.')
+              i << padded_current_month?(
+                     input?.split('-').last.split('.')[1]
+                   )
+            else
+              # Only modify the second entry in this case.
+              splitted[1] = padded_current_month?(splitted[1])
+              i = splitted.join('.')
+            end
+          end
+          current_year = current_year?
+          unless i.end_with? current_year
+            i << '.' unless i.end_with?('.')
+            i << current_year
+          end
+        end
+      end
+    end
+    i = ensure_proper_trailing_year(i)
+    i = properly_space_out_date_format(i)
+    @start_day = i
+  end
+
+  # ========================================================================= #
+  # === set_end_day
+  # ========================================================================= #
+  def set_end_day(i, &block)
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :try_to_sanitize_the_input
+      # ===================================================================== #
+      when :try_to_sanitize_the_input
+        unless (i =~ REGEX_FOR_A_CORRECT_DATE) # In this case we must sanitize.
+          i = i.dup if i.frozen?
+          current_year = current_year?
+          n_dots = i.count('.')
+          splitted = i.split('.')
+          splitted[1] = padded_current_month?(splitted[1])
+          i = splitted.join('.')
+          if n_dots == 1
+            i << '.' unless i.end_with?('.')
+            i << padded_current_month?
+          end
+
+          unless i.end_with? current_year
+            i << ".#{current_year}"
+          end
+        end
+      end
+    end
+    i = ensure_proper_trailing_year(i)
+    i = properly_space_out_date_format(i)
+    @end_day = i
+  end
+
+  # ========================================================================= #
+  # === menu
+  # ========================================================================= #
+  def menu(i = commandline_arguments?)
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === lva_epxander --only-raw-date
+      # ===================================================================== #
+      when /^-?-?only(-|_)?raw(-|_)?date$/i
+        @show_only_the_raw_date = true
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    menu
+    process_commandline_arguments_without_leading_hyphens
+    try_to_determine_the_start_day_and_the_end_day
+    expand_and_show_the_dates_in_between
+  end
+
+  # ========================================================================= #
+  # === Studium::ExpandTimeRange[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.expand_time_range
+#
+# Simpler accessor-method to the functionality made available through
+# class Studium::ExpandTimeRange.
+# =========================================================================== #
+def self.expand_time_range(i, &block)
+  Studium::ExpandTimeRange.new(i, &block)
+end; self.instance_eval { alias expander expand_time_range } # === Studium.expander
+
+# =========================================================================== #
+# === Studium.expand_these_lectures
+#
+# This will return an Array, rather than report anything.
+# =========================================================================== #
+def self.expand_these_lectures(i)
+  Studium::ExpandTimeRange.new(i) { :do_not_report_anything }.array?
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ExpandTimeRange.new(ARGV)
+end # expand_time_range
+    # expand_time_range "15.10. - 2.11.2018,"
+    # expand_time_range "15.10.2022-12.11.2022

data/lib/studium/utility_scripts/finished_exams_at_this_university/finished_exams_at_this_university.rb

@@ -0,0 +1,171 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::FinishedExamsAtThisUniversity
+#
+# This small class will show which exams were completed (finished) at
+# a given university.
+#
+# Usage example:
+#
+#   Studium::FinishedExamsAtThisUniversity.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/finished_exams_at_this_university.rb'
+# Studium::FinishedExamsAtThisUniversity.new(ARGV)
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class FinishedExamsAtThisUniversity < Base # === Studium::FinishedExamsAtThisUniversity
+
+  # ========================================================================= #
+  # === 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()
+    # ======================================================================= #
+    # === @use_this_dataset
+    #
+    # This is the default; menu() can change this.
+    # ======================================================================= #
+    @use_this_dataset = Studium.sanitized_dataset_from_file_passed_exams_per_month
+    # ======================================================================= #
+    # === @this_university
+    # ======================================================================= #
+    @this_university = nil
+  end
+
+  # ========================================================================= #
+  # === sanitize_university_name
+  # ========================================================================= #
+  def sanitize_university_name(i)
+    i.to_s.downcase.delete('-') # For now this is quite minimal.
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i
+      # ===================================================================== #
+      # === --alternative
+      # ===================================================================== #
+      when /-?-?alternative/,
+           /-?-?alt/
+        dataset = dataset_from_the_file_lecture_information.select {|a, b|
+          this_university = b[:university]
+          already_solved  = b[:already_solved]
+          already_solved and (this_university.to_s.downcase == @this_university)
+        }
+        @use_this_dataset = dataset
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    @this_university = sanitize_university_name(first_argument?)
+    menu
+    n_ects_points = 0
+    dataset = @use_this_dataset
+    if dataset.is_a? Array # This is the default entry point.
+      dataset.select! {|line|
+        splitted = line.split('|').map(&:strip)
+        university = splitted[4].downcase.strip
+        university.include? @this_university
+      }
+    end
+    e
+    if dataset.is_a? Hash
+      dataset = dataset.sort_by {|a, hash|
+        ::Time.parse(hash[:already_solved_at])
+      }.reverse
+      dataset = Hash[dataset]
+    end
+    dataset.each_with_index {|line, index| index += 1
+      if line.is_a?(Array) and line[1].is_a?(Hash)
+        _ = line[1]
+        passed_on_this_day = _[:already_solved_at]
+        ects_points        = _[:ects].to_f   # === n ECTS points
+        name_of_the_university_course = line.first.to_s
+        if name_of_the_university_course.include?(' ')
+          name_of_the_university_course = name_of_the_university_course.split(' ')[1 .. -1].join(' ')
+        end
+      else
+        splitted = line.split('|').map(&:strip)
+        passed_on_this_day = splitted[0] # === passed when exactly
+        ects_points = splitted[2].to_f   # === n ECTS points
+        name_of_the_university_course = splitted.last
+      end
+      n_ects_points += ects_points
+      report_index_name_of_the_university_course_and_passed_on_this_day(
+        index,
+        name_of_the_university_course,
+        passed_on_this_day
+      )
+    }; e
+    # ======================================================================= #
+    # Give the final report to the user here:
+    # ======================================================================= #
+    e crimson(dataset.size.to_s)+
+      lightblue(' exams were passed, for a total of ')+
+      mediumspringgreen(n_ects_points.to_s)+
+      lightblue(' ECTS points.')
+    e
+  end
+
+  # ========================================================================= #
+  # === report_index_name_of_the_university_course_and_passed_on_this_day
+  # ========================================================================= #
+  def report_index_name_of_the_university_course_and_passed_on_this_day(
+      index,
+      name_of_the_university_course,
+      passed_on_this_day
+    )
+    e '  '+
+      lightblue((index.to_s+')').rjust(4))+' '+
+      sfancy(name_of_the_university_course.ljust(72))+
+      mediumpurple(
+        ' (passed on the '+passed_on_this_day+')'
+      )
+  end
+
+  # ========================================================================= #
+  # === Studium::FinishedExamsAtThisUniversity[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::FinishedExamsAtThisUniversity.new(ARGV)
+end # finishedexamsatthisuniversity meduni
+    # finishedexamsatthisuniversity TU
+    # finishedexamsatthisuniversity uniwien
+    # finishedexamsatthisuniversity boku