studium 0.10.1

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

@@ -0,0 +1,55 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Studium
+
+class WeekParser < Base # === Studium::WeekParser
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @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
+    @skip_low_priority_lectures = SKIP_LOW_PRIORITY_LECTURES
+    # ======================================================================= #
+    # === @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] = {} }
+    @n_days_into_the_future = 30
+    # ======================================================================= #
+    # @array_show_these_days tells this class which days to show (and
+    # thus, also, which ones to NOT show).
+    # ======================================================================= #
+    @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

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

@@ -0,0 +1,242 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Studium
+
+class WeekParser < Base # === Studium::WeekParser
+
+  # ========================================================================= #
+  # === report_weekly_lectures
+  # ========================================================================= #
+  def report_weekly_lectures
+    opnn; e "Next showing the #{mediumpurple('weekly lectures')}:"; e
+    _ = @hash_weekly_lectures
+    monday    = _[:monday]
+    tuesday   = _[:tuesday]
+    wednesday = _[:wednesday]
+    thursday  = _[:thursday]
+    friday    = _[:friday]
+    # ======================================================================= #
+    # Iterate over the days next.
+    # ======================================================================= #
+    if show_monday?
+      unless monday.empty?
+        show_this_weekday(monday, 'Monday')
+      end
+    end
+    if show_tuesday?
+      unless tuesday.empty?
+        show_this_weekday(tuesday, 'Tuesday')
+      end
+    end
+    if show_wednesday?
+      unless wednesday.empty?
+        show_this_weekday(wednesday, 'Wednesday')
+      end
+    end
+    if show_thursday?
+      unless thursday.empty?
+        show_this_weekday(thursday, 'Thursday')
+      end
+    end
+    if show_friday?
+      unless friday.empty?
+        show_this_weekday(friday, 'Friday')
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === show_monday?                                 (monday tag, montag tag)
+  # ========================================================================= #
+  def show_monday?
+    @array_show_these_days.include? :monday
+  end
+
+  # ========================================================================= #
+  # === show_tuesday?
+  # ========================================================================= #
+  def show_tuesday?
+    @array_show_these_days.include? :tuesday
+  end
+
+  # ========================================================================= #
+  # === show_wednesday?
+  # ========================================================================= #
+  def show_wednesday?
+    @array_show_these_days.include? :wednesday
+  end
+
+  # ========================================================================= #
+  # === show_thursday?
+  # ========================================================================= #
+  def show_thursday?
+    @array_show_these_days.include? :thursday
+  end
+
+  # ========================================================================= #
+  # === show_friday?
+  # ========================================================================= #
+  def show_friday?
+    @array_show_these_days.include? :friday
+  end
+
+  # ========================================================================= #
+  # === show_this_weekday
+  #
+  # Use this method to display all lectures on a given day.
+  # ========================================================================= #
+  def show_this_weekday(
+      hash_for_this_weekday,
+      name_of_the_day = 'Monday'
+    )
+    this_is_the_weekday = hash_for_this_weekday.sort_by {|name_of_the_lecture, inner_hash|
+      lva_dates  = inner_hash['lva_dates']
+      first_date = remove_leading_weekday_names_from(lva_dates.first)
+      Time.parse(first_date.delete(','))
+    }
+    # ======================================================================= #
+    # Next, display the name of the day - also in german.
+    # ======================================================================= #
+    result = sfancy(
+      name_of_the_day+
+      ' ('+
+      return_german_name_from_this_english_name(name_of_the_day)+
+      ')'+':' # Add the german name here.
+    ).dup
+    # ======================================================================= #
+    # Add, in red, the day that is today - if it is today.
+    # ======================================================================= #
+    if this_weekday_is_today?(name_of_the_day)
+      result << ' '+swarn("(This is today, the #{day_month_year})")
+    else # Just add when this is assumed to be in the future.
+      # ===================================================================== #
+      # We calculate the difference based on weekdays.
+      # ===================================================================== #
+      time_now = Time.now
+      n_days_difference = n_days_difference_from_today_to_this_day(
+        time_now, name_of_the_day
+      )
+      result << slateblue(" (in +#{n_days_difference} day")
+      result << slateblue('s') unless n_days_difference.to_i == 1
+      result << slateblue(')')
+      # ===================================================================== #
+      # Next, add the date when this will be:
+      # ===================================================================== #
+      future_time = (time_now - 1) + (n_days_difference * ONE_DAY)
+      future_time_in_dd_mm_yyyy = "(#{return_day_month_year(future_time)})"
+      colourized_future_time = sfancy(future_time_in_dd_mm_yyyy)
+      result << " #{colourized_future_time}"
+    end
+    e result; e # <- Display the weekday here.
+    is_a_holiday = false
+    if future_time_in_dd_mm_yyyy
+      upcoming_exams = exams_on_this_day(
+        future_time_in_dd_mm_yyyy.delete('()')
+      )
+    end
+    if upcoming_exams
+      # ===================================================================== #
+      # In this case, display the exams. However had, since as of June
+      # 2018, we will display only those exams for which we are
+      # registered.
+      # ===================================================================== #
+      leading_notifier = swarn('    [REGISTERED FOR THIS EXAM]')
+      upcoming_exams = upcoming_exams.select {|name_of_the_lecture, inner_hash|
+        inner_hash.has_key? 'registered_for_an_upcoming_exam_at'
+      }
+      upcoming_exams.each {|name_of_the_lecture, inner_hash|
+        exam_time = inner_hash['exams'].first.split(',').last.strip
+        this_university = inner_hash[:university]
+        colourized_this_university = powderblue(' '+this_university)
+        colourized_name_of_the_lecture = slateblue(
+          name_of_the_lecture.ljust(69)
+        )
+        e leading_notifier+' '+
+          colourized_name_of_the_lecture+' '+
+          mediumslateblue('['+exam_time+']')+
+          colourized_this_university
+      }
+    end
+    this_is_the_weekday.each {|name_of_the_lecture, inner_hash|
+      lva_dates    = inner_hash['lva_dates']
+      priority     = inner_hash[:priority]
+      lecture_type = "[#{inner_hash[:type]}]"
+      first_date   = lva_dates.first.strip # <- Depends on the variable lva_dates set before.
+      if priority.nil?
+        opnn; e swarn('No priority entry was found for ')+
+                sfancy(name_of_the_lecture)
+      end
+      # ===================================================================== #
+      # First display an exam, if there is one on this day.
+      # ===================================================================== #
+      dd_mm_yyyy = first_date
+      if dd_mm_yyyy.include? ', '
+        dd_mm_yyyy = dd_mm_yyyy.split(', ').first.strip
+      end
+      is_a_holiday = ::Studium.is_this_day_a_holiday? dd_mm_yyyy
+      # ===================================================================== #
+      # If it is already over then we will not display that lecture at
+      # all. The user is assumed to correct entries in the file
+      # lecture_information.yml on his/her own.
+      # ===================================================================== #
+      if (Time.now - (ONE_DAY - 1)) > Time.parse(dd_mm_yyyy)
+        next # Skip to the next entry in this case.
+      end
+      # ===================================================================== #
+      # === Handle upcoming exams first
+      #
+      # Look for upcoming exams from the file exams.yml. If found,
+      # process them and then delete that match.
+      # ===================================================================== #
+      # Currently disabled.
+      # orange_block = orange(
+      #    (try_to_infer_the_name_of_the_lecture_from_this_line(line)+
+      #     swarn(' [EXAM]')).ljust(PAD_TO_THE_RIGHT - 1)
+      #  )
+      # =================================================================== #
+      # We will display that exam-entry additionally.
+      # =================================================================== #
+      # e '  '+colourize_lecture_day(lecture_date, '1')+' '+
+      #  orange_block+' '+colourized_priority('1', :red)
+      # ===================================================================== #
+      # Next display the entry. The name of the lecture will be
+      # colourized in an orange colour. The beginning of that String,
+      # that is the very most left side, will be colourized in a
+      # greenish colour usually.
+      # ===================================================================== #
+      expanded_lecture_line = '  '.dup
+      if is_a_holiday
+        # =================================================================== #
+        # Then this is a holiday.
+        # =================================================================== #
+        official_holiday_string = '  [Official Holiday]'
+        expanded_lecture_line << crimson("#{official_holiday_string} ")
+      end
+      expanded_lecture_line << colourize_lecture_day(first_date, priority)+' '
+      # ===================================================================== #
+      # Build up the expanded lecture line here, based on priority.
+      # ===================================================================== #
+      case priority
+      when 1 # Only handle priority 1 in a different colour.
+        expanded_lecture_line << orange(
+          (name_of_the_lecture+' '+chocolate(lecture_type)).ljust(@pad_to_the_right)
+        )+' '+colourized_priority(priority, :honour_priority_value) 
+      else
+        expanded_lecture_line << darkorange(
+          (name_of_the_lecture+' '+chocolate(lecture_type)).ljust(@pad_to_the_right)
+        )+' '+colourized_priority(priority, :honour_priority_value) # <- Colourize the priority ranking.
+      end
+      e expanded_lecture_line
+    }; e
+  end
+
+  # ========================================================================= #
+  # === exams_on_this_day
+  # ========================================================================= #
+  def exams_on_this_day(i)
+    ::Studium.return_all_exams_on_this_day(i)
+  end
+
+end; end

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

@@ -0,0 +1,362 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::WeekParser
+#
+# This class will scan for weekly lectures, that is - lectures that
+# are upcoming.
+#
+# Usage example:
+#
+#   Studium::WeekParser.new
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/week_parser/week_parser.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+require 'studium/utility_scripts/week_parser/constants.rb'
+require 'studium/utility_scripts/week_parser/help.rb'
+require 'studium/utility_scripts/week_parser/menu.rb'
+require 'studium/utility_scripts/week_parser/misc.rb'
+require 'studium/utility_scripts/week_parser/reset.rb'
+require 'studium/utility_scripts/week_parser/run.rb'
+require 'studium/utility_scripts/week_parser/show.rb'
+
+module Studium
+
+class WeekParser < Base # === Studium::WeekParser
+
+  require 'studium/exams/upcoming_exams_dataset.rb'
+  require 'studium/utility_scripts/holidays.rb'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  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
+    lva_dates = dataset?.select {|name_of_the_lecture, hash_dataset|
+      if hash_dataset.nil?
+        opnn; e '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+$/
+        opnn; e '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
+        opnn; e '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'
+      #     opnn; e '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 > 5)
+        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
+
+  # ========================================================================= #
+  # === this_weekday_is_today?
+  # ========================================================================= #
+  def this_weekday_is_today?(name_of_the_day)
+    time_now = Time.now
+    weekday_today = time_now.wday
+    weekday_today = Time::RFC2822_DAY_NAME[weekday_today]
+    name_of_the_day.start_with?(weekday_today)
+  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?
+        opnn; e '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
+          opnn; e '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
+        opnn; e 'No key ('+orange('weekday-key')+') was found for `'+
+                 sfancy(name_of_the_lecture)+'`.'
+        opnn; e "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
+
+  # ========================================================================= #
+  # === Studium::WeekParser[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::WeekParser.new(ARGV)
+end # weekparser