studium 0.16.9

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

@@ -0,0 +1,236 @@
+#!/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 = result.ljust(48)
+      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
+
+end; end

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

@@ -0,0 +1,49 @@
+#!/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/holidays.rb'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::WeekParser.new(ARGV)
+end # weekparser

data/lib/studium/utility_scripts/weekday_parser.rb

@@ -0,0 +1,155 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::WeekdayParser
+#
+# This class will parse all lectures that are on a given day such
+# as monday, tuesday and so on. By default it will simply tell me
+# which lectures will be on the current day.
+#
+# Note that in order for this class to work, the yaml file MUST be
+# "correctly" formatted. If the yaml file is incorrect, then this
+# class must, by definition, FAIL.
+#
+# Usage example:
+#
+#   Studium::WeekdayParser.new
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/weekday_parser.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class WeekdayParser < ::Studium::Base # === Studium::WeekdayParser
+
+  # ========================================================================= #
+  # === DIRECTORY_WOCHENTAGE
+  # ========================================================================= #
+  DIRECTORY_WOCHENTAGE = "#{ROEBE_STUDIUM_DIR}YAML/wochentage/"
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_weekday(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @time_object
+    # ======================================================================= #
+    @time_object = ::Time.now
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = nil
+  end
+
+  # ========================================================================= #
+  # === set_weekday
+  # ========================================================================= #
+  def set_weekday(i = :today)
+    i = i.first if i.is_a? Array
+    case i
+    when :today, :default, nil
+      i = @time_object.wday
+    end
+    i = i.to_s.dup
+    case i # Sanitize it here. (case tag)
+    when '1'
+      i = 'montag'
+    when '2'
+      i = 'dienstag'
+    when '3'
+      i = 'mittwoch'
+    when '4'
+      i = 'donnerstag'
+    when '5'
+      i = 'freitag'
+    when '6'
+      i = 'samstag'
+    when '7','0'
+      i = 'sonntag'
+    end
+    @weekday = i
+  end
+
+  # ========================================================================= #
+  # === weekday?
+  # ========================================================================= #
+  def weekday?
+    @weekday
+  end
+
+  # ========================================================================= #
+  # === determine_the_subsections
+  #
+  # The subsections are the properly formatted entries in the file.
+  # ========================================================================= #
+  def determine_the_subsections
+    @dataset = @dataset.split(N) if @dataset
+  end
+
+  # ========================================================================= #
+  # === determine_which_yaml_file_to_use
+  # ========================================================================= #
+  def determine_which_yaml_file_to_use
+    @use_this_yaml_file = DIRECTORY_WOCHENTAGE+@weekday+'.yml'
+  end
+
+  # ========================================================================= #
+  # === read_in_the_dataset
+  # ========================================================================= #
+  def read_in_the_dataset
+    _ = @use_this_yaml_file
+    if File.exist? _
+      @dataset = File.read(_)
+    else
+      opnn; e 'No file exists at `'+sfile(_)+'`.'
+    end
+  end
+
+  # ========================================================================= #
+  # === sanitize_dataset
+  # ========================================================================= #
+  def sanitize_dataset
+    @dataset.reject! {|line|
+      line.strip.start_with? '# ======='
+    } if @dataset
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    determine_which_yaml_file_to_use
+    read_in_the_dataset
+    sanitize_dataset
+    determine_the_subsections
+  end
+
+  # ========================================================================= #
+  # === Studium::WeekdayParser[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::WeekdayParser.new(ARGV)
+end # weekdayparser

data/lib/studium/utility_scripts/weekly_schedule.rb

@@ -0,0 +1,198 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::WeeklySchedule
+#
+# This script will display a full week. As of October 2020 it is no longer
+# that important; perhaps it may be removed one day.
+#
+# Usage example:
+#
+#   Studium::WeeklySchedule.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/weekly_schedule.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class WeeklySchedule < ::Studium::Base # === Studium::WeeklySchedule
+
+  begin
+    require 'roebe/classes/wochentag_anzeiger.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === BASE_DIR
+  # ========================================================================= #
+  BASE_DIR = '/home/x/STUDIUM/YAML/WS2016/'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    @hash = {}
+  end
+
+  # ========================================================================= #
+  # === hash?
+  # ========================================================================= #
+  def hash?
+    @hash
+  end; alias dataset? hash? # === dataset?
+
+  # ========================================================================= #
+  # === return_all_yaml_files
+  # ========================================================================= #
+  def return_all_yaml_files
+    Dir[BASE_DIR+'*.yml']
+  end
+
+  # ========================================================================= #
+  # === base_dir?
+  # ========================================================================= #
+  def base_dir?
+    BASE_DIR
+  end
+
+  # ========================================================================= #
+  # === load_the_yaml_dataset
+  # ========================================================================= #
+  def load_the_yaml_dataset
+    return_all_yaml_files.each {|file|
+      hash = {}
+      splitted = File.basename(file).gsub(/\.yml$/,'').split('_')
+      id, *name_of_the_lecture = splitted
+      name_of_the_lecture = name_of_the_lecture.flatten.join('_')
+      dataset = YAML.load_file(file)
+      # ===================================================================== #
+      # We must turn the key and value pairs into ISO Encoding.
+      # ===================================================================== #
+      dataset.dup.each_pair {|key, value|
+        key.capitalize! if key == 'tage'
+        hash[key] = value
+      }
+      hash['Titel'] = name_of_the_lecture
+      _ = {}
+      id = id.to_s # The ID must be a String because some IDs are like "950.222"
+      _[id] = hash
+      @hash.update(_) 
+    }
+  end
+
+  # ========================================================================= #
+  # === notify_the_user_about_the_base_directory
+  # ========================================================================= #
+  def notify_the_user_about_the_base_directory
+    opnn; e 'We will use the base directory:'
+    e
+    e '    '+sdir(base_dir?)
+    e
+  end
+
+  # ========================================================================= #
+  # === display_the_week
+  # ========================================================================= #
+  def display_the_week
+    show_all_lectures_on(:monday)
+    show_all_lectures_on(:tuesday)
+    show_all_lectures_on(:wednesday)
+    show_all_lectures_on(:thursday)
+    show_all_lectures_on(:friday)
+    show_all_lectures_on(:saturday)
+  end
+
+  # ========================================================================= #
+  # === today?
+  # ========================================================================= #
+  def today?
+    ::Studium.today?
+  end
+
+  # ========================================================================= #
+  # === show_all_lectures_on
+  #
+  # We will show all lectures on the given day.
+  # ========================================================================= #
+  def show_all_lectures_on(this_day = :monday)
+    dataset = dataset?
+    this_day = this_day.to_s.capitalize
+    the_lecture_id = nil
+    titel = ''
+    priority = 0
+    report_this_array = []
+    dataset.each_pair {|lecture_id, inner_hash|
+      the_lecture_id = lecture_id
+      titel = dataset[lecture_id].fetch('Titel')
+      priority = dataset[lecture_id].fetch('Priorität')
+      tage = inner_hash.fetch('Tage') # Fetch the days here.
+      results = tage.select {|entry|
+        _ = Roebe::WochentagAnzeiger.return_english_weekday(entry)
+        _ == this_day
+      }
+      if results.empty?
+        # Found nothing.
+      else # else append it to the main array
+        report_this_array << [
+          the_lecture_id, titel, priority
+        ]
+      end
+    }
+    report_all_lectures_for_this_dataset(this_day, report_this_array)
+  end
+
+  # ========================================================================= #
+  # === report_all_lectures_for_this_dataset
+  # ========================================================================= #
+  def report_all_lectures_for_this_dataset(this_day, report_this_array)
+    if report_this_array.empty?
+      e 'No lectures on '+simp(this_day)+'.'
+    else
+      # ===================================================================== #
+      # Ok, we did find entries on this day.
+      # ===================================================================== #
+      e 'There are lectures on `'+simp(this_day)+'`.'
+      report_this_array.each {|the_lecture_id, titel, priority|
+        e '  The ID is '+
+           limegreen(the_lecture_id.to_s)+' '+khaki(titel)+
+           ', Priority: '+simp(priority.to_s)
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    load_the_yaml_dataset
+    notify_the_user_about_the_base_directory
+    display_the_week
+  end
+
+  # ========================================================================= #
+  # === Studium::WeeklySchedule[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::WeeklySchedule.new(ARGV)
+end # weeklyschedule