studium 0.16.9

data/lib/studium/utility_scripts/week_parser/help.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Studium
+
+class WeekParser < Base
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  #
+  # To invoke this method, do:
+  #
+  #   weekparse --help
+  #
+  # ========================================================================= #
+  def show_help
+    result = <<EOF
+Presently, the following options are available:
+
+  --debug          # show additional (debug) information
+  --unrestricted   # do not limit showing lectures based on time
+                   # date (thus, +300 days into the future)
+
+You can also pass in the weekday such as "Montag", "Monday" or
+"--Monday". The default for @n_days_into_the_future is #{steelblue(@n_days_into_the_future)}.
+
+EOF
+    opnn; e result
+  end
+
+end; end

data/lib/studium/utility_scripts/week_parser/menu.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Studium
+
+class WeekParser < Base # === Studium::WeekParser.new
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === week_parser --unrestricted
+      # ===================================================================== #
+      when /^-?-?unrestricted$/,
+           /^-?-?infinity$/
+        opnn; e 'Showing many more lectures next.'
+        @n_days_into_the_future = 300
+      # ===================================================================== #
+      # === week_parser --debug
+      # ===================================================================== #
+      when /-?-?debug$/
+        @debug = true
+      # ===================================================================== #
+      # === week_parser --help
+      # ===================================================================== #
+      when /-?-?help/
+        show_help
+        exit
+      else # else tag
+        if is_a_weekday?(i.delete('-'))
+          # ================================================================= #
+          # In this case, only use that weekday.
+          # ================================================================= #
+          this_weekday = i.delete('-')
+          if GERMAN_TO_ENGLISH_WEEKDAYS.has_key? this_weekday
+            # =============================================================== #
+            # In this case we will assume that it is a german name for
+            # a weekday, thus we will convert it.
+            # =============================================================== #
+            this_weekday = GERMAN_TO_ENGLISH_WEEKDAYS[this_weekday]
+          end
+          this_weekday = this_weekday.downcase.to_sym
+          @array_show_these_days = [
+            this_weekday
+          ]
+        end
+      end
+    end
+  end
+
+end; end

data/lib/studium/utility_scripts/week_parser/misc.rb

@@ -0,0 +1,373 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Studium
+
+class WeekParser < Base # === Studium::WeekParser
+
+  # ========================================================================= #
+  # === exams_on_this_day
+  # ========================================================================= #
+  def exams_on_this_day(i)
+    ::Studium.return_all_exams_on_this_day(i)
+  end
+
+  # ========================================================================= #
+  # === remove_weekdays_from
+  # ========================================================================= #
+  def remove_weekdays_from(i)
+    remove_leading_weekday_names_from(i)
+  end
+
+  # ========================================================================= #
+  # === colourize_lecture_day
+  #
+  # The second argument is the priority of the lecture. Lectures with a
+  # higher priority will be brighter in colour (this is the part that
+  # will appear on the very left-hand side).
+  # ========================================================================= #
+  def colourize_lecture_day(
+      first_date, priority = 1
+    )
+    priority = priority.to_i
+    case priority
+    when 1
+      return yellowgreen(first_date)
+    when 4,5
+      return darkgreen(first_date)
+    else
+      return darkolivegreen(first_date)
+    end
+  end
+
+  # ========================================================================= #
+  # === return_german_name_from_this_english_name
+  # ========================================================================= #
+  def return_german_name_from_this_english_name(i)
+    case i.downcase
+    when 'monday'
+      'Montag'
+    when 'tuesday'
+      'Dienstag'
+    when 'wednesday'
+      'Mittwoch'
+    when 'thursday'
+      'Donnerstag'
+    when 'friday'
+      'Freitag'
+    end
+  end
+
+  # ========================================================================= #
+  # === select_entries_that_contain_lva_dates
+  #
+  # We will ONLY select entries that contain lva_dates and were NOT
+  # already solved.
+  # ========================================================================= #
+  def select_entries_that_contain_lva_dates
+    # ======================================================================= #
+    # Select the proper entries next.
+    # ======================================================================= #
+    lva_dates = dataset?.select {|name_of_the_lecture, hash_dataset|
+      if hash_dataset.nil?
+        opne "Error for the lecture #{sfancy(name_of_the_lecture)}"
+      end
+      priority = hash_dataset[:priority]
+      # ===================================================================== #
+      # Make sure that priority is a number.
+      # ===================================================================== #
+      unless priority.to_s =~ /^\d+$/
+        opne 'Not a number for '+orange('priority')+': '+sfancy(priority.to_s)+
+                ' (lecture: '+slateblue(name_of_the_lecture.to_s)+')'
+      end
+      already_solved = hash_dataset[:already_solved]
+      not_already_solved = !already_solved
+      if priority.nil? and not_already_solved
+        opne "The lecture #{sfancy(name_of_the_lecture)} "\
+                "has no registered :priority entry."
+      end
+      # unless hash_dataset.has_key?(:already_solved) and
+      #        (hash_dataset[:already_solved] == true)
+      #   unless hash_dataset.has_key? 'lva_dates'
+      #     opne 'The lecture '+sfancy(name_of_the_lecture)+' has no '\
+      #             'key called lva_dates.'
+      #   end
+      # end
+      # ^^^ this is mostly useful only for debugging
+      if @skip_low_priority_lectures and priority and (priority > 4)
+        false
+      else
+        hash_dataset.has_key?('lva_dates') and not_already_solved
+      end
+    }
+    populate_hash_weekly_lectures_with_these_lectures(lva_dates)
+  end
+
+  # ========================================================================= #
+  # === return_n_days
+  #
+  # Look n days into the future.
+  # ========================================================================= #
+  def return_n_days(i = 30)
+    Time.now + (ONE_DAY * i)
+  end
+
+  # ========================================================================= #
+  # === determine_the_weekday_from
+  # ========================================================================= #
+  def determine_the_weekday_from(
+      i = 'Mittwoch 14.03.2018'
+    )
+    return i unless i
+    if i.include? ' ' # In this case, use only the last part.
+      i = i.split(' ').last
+    end
+    parsed_time = Time.parse(i)
+    weekday = parsed_time.wday
+    case weekday
+    when 1
+      :monday
+    when 2
+      :tuesday
+    when 3
+      :wednesday
+    when 4
+      :thursday
+    when 5
+      :friday
+    when 6
+      :saturday
+    end
+  end
+
+  # ========================================================================= #
+  # === populate_hash_weekly_lectures_with_these_lectures
+  #
+  # We may reject entries that are not within the next e. g.
+  # 30 coming days.
+  #
+  # Additionally, entries that have old lva_dates should be disregarded
+  # as well. In these case, we may try to locate a new lva-date entry.
+  # ========================================================================= #
+  def populate_hash_weekly_lectures_with_these_lectures(hash)
+    hash_weekly_lectures = @hash_weekly_lectures
+    # ======================================================================= #
+    # How many days to peek into the future:
+    # ======================================================================= #
+    maximum_allowed_time_in_the_future = return_n_days(@n_days_into_the_future) # <- Is usually 30 days.
+    hash.each_pair {|name_of_the_lecture, inner_hash|
+      # ===================================================================== #
+      # First obtain a "pointer" to our main data structure, the lecture
+      # at hand with all the associated information.
+      # ===================================================================== #
+      pointer = { name_of_the_lecture => inner_hash }
+      # ===================================================================== #
+      # Retrieve the first lva_date.
+      # ===================================================================== #
+      all_lva_dates = inner_hash['lva_dates']
+      if all_lva_dates.nil?
+        opne 'No lva-entry found for '+sfancy(name_of_the_lecture)
+        next
+      end
+      first_lva_date = all_lva_dates.first.squeeze(' ')
+      splitted = first_lva_date.split(',').map(&:strip)
+      this_date = splitted.first
+      this_time_on_that_day = splitted.last # And keep a reference to the time on that day.
+      # ===================================================================== #
+      # Next we must identify where to add it, aka the week-day.
+      # ===================================================================== #
+      weekday_to_be_used_as_symbol = determine_the_weekday_from(this_date) # <- This must be a symbol.
+      this_date = remove_weekdays_from(this_date).strip # <- Clean it up a little.
+      # ===================================================================== #
+      # And obtain the time representation of that String next.
+      # ===================================================================== #
+      current_time = Time.now
+      begin
+        time_of_that_date = Time.parse("#{this_date} #{this_time_on_that_day}")
+      rescue Exception => error
+        e orange(name_of_the_lecture)
+        pp inner_hash
+        pp error
+        pp error.class
+        pp '^^^ TODO: add this exception specifically'
+      end
+      if time_of_that_date > maximum_allowed_time_in_the_future
+        # =================================================================== #
+        # In this case the lecture will be too far into the
+        # future, so we will skip it.
+        # =================================================================== #
+        next
+      end
+      # ===================================================================== #
+      # Ok, here we can use that entry in theory. But we will still have
+      # to check whether this is an outdated entry nonetheless. This will
+      # be the case when the time_of_that_day lags about a full day behind.
+      # ===================================================================== #
+      if (current_time - (ONE_DAY - 1) ) > time_of_that_date
+        if @debug
+          opne 'There is an old date entry at '+sfancy(this_date)+
+                  ' for '+simp(name_of_the_lecture)
+        end
+      end
+      if hash_weekly_lectures.has_key?(weekday_to_be_used_as_symbol)
+        # =================================================================== #
+        # Add the dataset next to the main Hash.
+        # =================================================================== #
+        hash_weekly_lectures[weekday_to_be_used_as_symbol].update(pointer)
+      else
+        opne 'No key ('+orange('weekday-key')+') was found for `'+
+                 sfancy(name_of_the_lecture)+'`.'
+        opne "The date entry was #{sfancy(this_date.to_s)}"
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === colourized_priority
+  #
+  # The priority 1 will be colourized via powderblue. The surrounding
+  # '(' and ')' will be in royalblue.
+  # ========================================================================= #
+  def colourized_priority(
+      priority, use_this_colour = :slateblue
+    )
+    result = royalblue('(Priorität: ').dup
+    case use_this_colour
+    when :honour_priority_value # <- This denotes special behaviour.
+      case priority.to_s
+      when '1'
+        result << lightseagreen(priority.to_s)
+      else
+        result << slateblue(priority.to_s)
+      end
+    when :slateblue
+      result << slateblue(priority.to_s)
+    when :red, :exam, :warning
+      result << crimson(priority.to_s)
+    end
+    result << royalblue(')')
+    return result
+  end
+
+  # ========================================================================= #
+  # === try_to_infer_the_name_of_the_lecture_from_this_line
+  #
+  # This method will attempt to guess the name of the lecture, based
+  # on a line that is stored in the file 'exams.yml'.
+  # ========================================================================= #
+  def try_to_infer_the_name_of_the_lecture_from_this_line(line)
+    result = ''.dup
+    # ======================================================================= #
+    # The following rexes also must match towards lines such as:
+    #   226.024, Chemie im Bauwesen
+    # ======================================================================= #
+    regex_for_lva_id = /\d{4}, (\d{1,3}\.?\d{1,3})/
+    line =~ regex_for_lva_id
+    lva_id = $1.to_s.dup
+    # ======================================================================= #
+    # Next search on the main dataset for the file lecture information.
+    # ======================================================================= #
+    scanned = dataset_lecture_information?.select {|name_of_the_lecture, inner_hash|
+      name_of_the_lecture.start_with? lva_id
+    }
+    if scanned.size == 1 # If we have exactly one match, add it.
+      result << scanned.keys.first
+    else
+      most_likely_lecture_name = @upcoming_exams_dataset.return_most_likely_lecture_name_from_this_line(line)
+      if lva_id[2,1] == '0' # Assume that this could be a lecture at the university of vienna.
+        new_lva_id = lva_id.dup
+        new_lva_id[2,1] = '1'
+        scanned = dataset_lecture_information?.select {|name_of_the_lecture, inner_hash|
+          name_of_the_lecture.start_with? new_lva_id
+        }
+        unless scanned.empty?
+          # ================================================================= #
+          # Ok so we found something, probably more than one result. We
+          # do another round of selection, against the naem of the lecture.
+          # ================================================================= #
+          scanned = dataset_lecture_information?.select {|name_of_the_lecture, inner_hash|
+            name_of_the_lecture.include? most_likely_lecture_name
+          }
+          result << scanned.keys.first unless scanned.empty?
+        end
+      else
+        if scanned.size == 0
+          e swarn('DEBUG! No results were found. This is not good.')
+          e 'The line that was faulty, was: '+sfancy(line)
+        else # Else we have at the least one more lecture.
+          new_selection = scanned.select {|key, value|
+            key.include? most_likely_lecture_name
+          }
+          if new_selection.empty?
+            e swarn('DEBUG! We found ')+sfancy(scanned.size.to_s)+
+              swarn(' results. This has to be NARROWED DOWN to '\
+                  'only one entry. (March 2018)')
+          else
+            result << new_selection.keys.first unless new_selection.empty?
+          end
+        end
+      end
+    end
+    return result.strip
+  end
+
+  # ========================================================================= #
+  # === dataset_lecture_information?
+  # ========================================================================= #
+  def dataset_lecture_information?
+    @dataset
+  end
+
+  # ========================================================================= #
+  # === dataset?
+  # ========================================================================= #
+  def dataset?
+    @dataset
+  end
+
+  # ========================================================================= #
+  # === return_exams_on_this_day
+  # ========================================================================= #
+  def return_exams_on_this_day(
+      dd_mm_yyyy = '23.04.2018'
+    )
+    start_date = Time.parse(dd_mm_yyyy)
+    end_date   = start_date + (ONE_DAY - 1)
+    range = start_date .. end_date
+    # ======================================================================= #
+    # First, obtain the registered entries that denote an (upcoming) exam.
+    # ======================================================================= #
+    selection = @dataset.select {|name, inner_hash|
+      if inner_hash.has_key?('registered')
+        upcoming_exam = inner_hash['registered'].first
+        upcoming_exam = remove_leading_weeknames(upcoming_exam)
+        if upcoming_exam.include? ', Ort'
+          upcoming_exam = upcoming_exam.split(', Ort').first.delete(',')
+        end
+        _ = Time.parse(upcoming_exam).to_i
+        range.cover? _
+      else
+        false
+      end
+    }
+    selection # And return the selection here.
+  end
+
+  # ========================================================================= #
+  # === this_weekday_is_today?
+  # ========================================================================= #
+  def this_weekday_is_today?(name_of_the_day)
+    # time_now = ::Time.now
+    weekday_today = english_weekday?
+    name_of_the_day.start_with?(weekday_today)
+  end
+
+  # ========================================================================= #
+  # === Studium::WeekParser[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end

data/lib/studium/utility_scripts/week_parser/reset.rb

@@ -0,0 +1,65 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Studium
+
+class WeekParser < Base # === Studium::WeekParser
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @n_days_into_the_future
+    # ======================================================================= #
+    @n_days_into_the_future = 36
+    # ======================================================================= #
+    # === @skip_low_priority_lectures
+    #
+    # This allows us to skip low-priority lectures. Right now this refers
+    # to priority 5 or higher.
+    # ======================================================================= #
+    @skip_low_priority_lectures = SKIP_LOW_PRIORITY_LECTURES
+    # ======================================================================= #
+    # === @pad_to_the_right
+    # ======================================================================= #
+    @pad_to_the_right = PAD_TO_THE_RIGHT
+    # ======================================================================= #
+    # Handle the upcoming exams via a specialized object next.
+    # ======================================================================= #
+    # @upcoming_exams_dataset = Studium::Exams::UpcomingExamsDataset.new
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = Studium.return_sanitized_dataset_from_file_lecture_information
+    # ======================================================================= #
+    # === @hash_weekly_lectures
+    # ======================================================================= #
+    @hash_weekly_lectures = {}
+    # ======================================================================= #
+    # === @debug
+    # ======================================================================= #
+    @debug = false
+    # ======================================================================= #
+    # Populate the variable @hash_weekly_lectures.
+    # ======================================================================= #
+    %i{
+      monday tuesday wednesday thursday friday saturday
+    }.each {|this_day| @hash_weekly_lectures[this_day] = {} }
+    # ======================================================================= #
+    # === @array_show_these_days
+    #
+    # @array_show_these_days tells this class which days to show (and
+    # thus, also, which ones to NOT show). Typically we omit saturday
+    # and sunday here, but on some universities there may be lectures
+    # on a saturday. 
+    # ======================================================================= #
+    @array_show_these_days = %i(
+      monday tuesday wednesday thursday friday
+    )
+  end
+
+end; end

data/lib/studium/utility_scripts/week_parser/run.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Studium
+
+class WeekParser < Base # === Studium::WeekParser
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    menu
+    select_entries_that_contain_lva_dates
+    report_weekly_lectures
+  end
+
+end; end