studium 0.10.1

data/lib/studium/utility_scripts/auto_stud/auto_stud.rb

@@ -0,0 +1,253 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::AutoStud
+#
+# This class evolved out of class NewStud.
+#
+# In the past, NewStud had to be given the particular number of the
+# exam at hand, such as "stud5" or "stud6". This was superfluous, though,
+# as exams.yml already keeps track of the number, via the '(5)' or
+# '(6)' tag.
+#
+# This is where AutoStud comes in - it will parse the file exams.yml and
+# look for all entries that would match the given input number. Then, it
+# will attempt to automatically pick a variant that makes the most sense.
+#
+# You do not necessarily have to provide a number, though. If the input
+# is NOT a number, then AutoStud assumes that the information is contained
+# in the cwd (current working directory). It will then try to find the
+# corresponding number that matches to this working directory.
+#
+# This class also allows batch-operations, so "astud 1-14" may work,
+# being synonymous to the old "stud1", "stud2", "stud3" etc. commands. 
+#
+# Usage example in ruby code:
+#   Studium::Studium::AutoStud.new 
+# =========================================================================== #
+# require 'studium/utility_scripts/auto_stud/auto_stud.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+# =========================================================================== #
+# Require class-internal .rb files next.
+# =========================================================================== #
+require 'studium/utility_scripts/auto_stud/initialize.rb'
+require 'studium/utility_scripts/auto_stud/constants.rb'
+require 'studium/utility_scripts/auto_stud/misc.rb'
+
+module Studium
+
+class AutoStud < Base # === AutoStud
+
+  require 'studium/toplevel_methods/cd_stud.rb'
+  require 'studium/utility_scripts/new_stud.rb'
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = [i] unless i.is_a? Array
+    @input = i
+    sanitize_input
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    menu
+  end
+
+  # ========================================================================= #
+  # === try_to_find_a_match_comparing_it_to_the_cwd
+  #
+  # This will match against the current working directory (cwd).
+  # ========================================================================= #
+  def try_to_find_a_match_comparing_it_to_the_cwd
+    # ======================================================================= #
+    # First, check for the possible LVA number.
+    # ======================================================================= #
+    if user_provided_input_is_a_number?
+      possible_lva_number = guess_lva_number
+    else # else use the current working directory
+      _ = return_pwd
+      possible_lva_number = File.basename(_)
+      # ======================================================================= #
+      # Split it up on every '_' and then grab the first element. This does
+      # NOT have to be done if the user supplied only a number.
+      # ======================================================================= #
+      possible_lva_number = possible_lva_number.split('_').first
+    end
+    selection = @exams_dataset.select {|line| line.include? possible_lva_number }
+    unless selection.empty?
+      # ===================================================================== #
+      # This clause is entered when we have found at the least one match.
+      # In this case, the next step is to determine how many selections
+      # are matching. If we have only one match, then we can continue.
+      # ===================================================================== #
+      if selection.size > 1 # This is a more complicated case.
+        opnn; e 'Something seems to be wrong with the dataset '\
+                'as more than one result was found:'
+        pp selection 
+      elsif selection.size == 1
+        # =================================================================== #
+        # This here is the best outcome. Obtain the number.
+        # =================================================================== #
+        first = selection.first
+        first =~ REGEX_MATCH_INNER_NUMBER
+        number = $1.to_s.dup # <- This should be the correct number.
+        Studium::NewStud[number]
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end; alias user_input? input? # === user_input?
+
+  # ========================================================================= #
+  # === show_help                                                 (help tag)
+  # ========================================================================= #
+  def show_help
+    opnn; e 'This class currently has these available commandline options:'
+    e
+    e '  <number> # a number such as 1, 2, 3 and so forth. This will try to'
+    e '           # find the number in the exams.yml file accordingly'
+    e '           # You can also pass in a range set such as 1-15, which'
+    e '           # is synonymous to doing astud 1, astud 2, astud 3 and'
+    e '           # so forth. '+sfancy('--max')+' to use the maximum number'
+    e '           # possible'
+    e
+  end
+
+  # ========================================================================= #
+  # === guess_lva_number
+  #
+  # This method will try to guess the LVA number. Only call it if the
+  # user provided only numbers as input.
+  # ========================================================================= #
+  def guess_lva_number
+    result = @original_exams_dataset.scan(/^# === \(#{user_input?}\).+$/)
+    result = result.first # Grab the first entry there.
+    # ======================================================================= #
+    # Next we must identify the LVA number from the input above.
+    # This will be a line such as:
+    #   # === (2) 15.01.2018, 770152, 09:00-11:00, Montag, Allgemeine Chemie an der BOKU, Ort: somewhere
+    # ======================================================================= #
+    result = result.scan(/ (\d{2,3}\.?\d{2,3})( |,)/).flatten.first
+    return result 
+  end
+
+  # ========================================================================= #
+  # === user_provided_input_is_a_number?
+  # ========================================================================= #
+  def user_provided_input_is_a_number?
+    (user_input? =~ /^\d+$/)
+  end; alias only_numbers? user_provided_input_is_a_number? # === only_numbers?
+
+  # ========================================================================= #
+  # === work_through_the_given_input
+  # ========================================================================= #
+  def work_through_the_given_input
+    if @input.empty?
+      opnn; e 'Please provide a number to this class.'
+    else
+      @input.each {|number|
+        if number =~ /^\d+$/ # Really handle only numbers here.
+          target_directory = Studium.determine_exam_directory(number)
+          if target_directory.nil?
+            opnn; e 'No match has been found.'
+          elsif target_directory.is_a?(Array) and
+            !target_directory.empty?
+            cd_to_this_dir = target_directory.first
+            if File.directory? cd_to_this_dir
+              opnn; e "Changing directory into `#{sdir(cd_to_this_dir)}` next."
+              cd(cd_to_this_dir)
+              opnn; e 'Assuming the number `'+sfancy(number)+'`. '\
+                      'Passing this into '+yellow('Studium::NewStud[]')+'.'
+              Studium::NewStud[number]
+            else
+              opnn; e 'No directory exists at `'+sdir(cd_to_this_dir)+'`.'
+            end
+            if target_directory.size > 1
+              opnn; e 'Note that there were at the least two '\
+                      'entries for '+orange('target_directory')+'.'
+              pp target_directory
+            end
+          end
+        end
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = @input
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i
+      # ===================================================================== #
+      # === astud --max
+      # ===================================================================== #
+      when /^-?-?max$/
+        # =================================================================== #
+        # Assume that the user wants to have the max range in this case.
+        # =================================================================== #
+        max_value = return_max_entry_from_file_exams
+        opnn; e 'Assuming a max entry of `'+sfancy(max_value.to_s)+
+                '` upcoming appointments/exams.'
+        set_input('1-'+max_value.to_s)
+      # ===================================================================== #
+      # === astud --help
+      # ===================================================================== #
+      when /-?-?help/i
+        show_help
+        exit
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === sanitize_input
+  # ========================================================================= #
+  def sanitize_input
+    @input.compact!
+    @input.map! {|entry|
+      if entry.is_a?(String) and entry.include?('-') and
+        (entry.count('-') == 1) and (entry =~ /\d{1,2}-\d{1,2}/)
+        # =================================================================== #
+        # We assume that the user input a range-like object, e. g. "2-12".
+        # But only if there are two surrounding numbers.
+        # =================================================================== #
+        splitted = entry.split('-') # => ["2", "12"]
+        entry = Range.new(splitted.first, splitted.last).to_a
+      end
+      entry
+    }
+    @input.flatten!
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::AutoStud.new(ARGV)
+end # astud 3

data/lib/studium/utility_scripts/auto_stud/constants.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/utility_scripts/auto_stud/constants.rb'
+# =========================================================================== #
+module Studium
+
+class AutoStud < Base # === Studium::AutoStud
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === REGEX_MATCH_INNER_NUMBER
+  #
+  # Match the inner number, such as (5) or (6), from the file exams.yml.
+  # ========================================================================= #
+  REGEX_MATCH_INNER_NUMBER = /^# === \((\d{1,2})\)/
+
+end; end

data/lib/studium/utility_scripts/auto_stud/initialize.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/utility_scripts/auto_stud/initialize.rb'
+# =========================================================================== #
+module Studium
+
+class AutoStud < Base # === AutoStud.new
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+end; end

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

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/utility_scripts/auto_stud/misc.rb'
+# =========================================================================== #
+module Studium
+
+class AutoStud < Base # === Studium::AutoStud
+
+  # ========================================================================= #
+  # === Studium::AutoStud[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end

data/lib/studium/utility_scripts/autopurge_this_lecture_date.rb

@@ -0,0 +1,101 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::AutopurgeThisLectureDate
+#
+# This class can auto-purge obsolete lecture date entries.
+#
+# The input should be an Array or a String conforming to the format
+# dd.mm.yyyy such as "12.02.2018".
+#
+# Usage example:
+#
+#   Studium::AutopurgeThisLectureDate.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/autopurge_this_lecture_date.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class AutopurgeThisLectureDate < Base # === Studium::AutopurgeThisLectureDate
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @old_file
+    # ======================================================================= #
+    @old_file = read_file(FILE_LECTURE_INFORMATION)
+    # ======================================================================= #
+    # === @new_file_content
+    # ======================================================================= #
+    @new_file_content = ''.dup
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    input = commandline_arguments?
+    @old_file.split(N).each {|this_line|
+      # ===================================================================== #
+      # Work on every line next.
+      # ===================================================================== #
+      if input.any? {|line|
+          this_line =~ /#{line}.+"/ # A " is assumed to be always there.
+         }
+        this_line = nil # Empty this line in that case.
+      end
+      this_line = this_line.dup if this_line.frozen?
+      this_line << N unless this_line.nil?
+      @new_file_content << this_line unless this_line.nil?
+    }
+    what = @new_file_content
+    into = FILE_LECTURE_INFORMATION
+    opnn; e 'Now storing this new information into the file `'+sfile(into)+'`.'
+    write_what_into(what, into)
+    if is_on_roebe?
+      into = RUBY_STUDIUM_HOME_DIR+'yaml/'+File.basename(into)
+      opnn; e 'Now storing this new information into the file `'+sfile(into)+'`.'
+      write_what_into(what, into)
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium::AutopurgeThisLectureDate[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::AutopurgeThisLectureDate.new(ARGV)
+end # autopurgethislecturedate

data/lib/studium/utility_scripts/calendar/README.md

@@ -0,0 +1,2 @@
+Code in this directory will handle registered entries from the file
+called "participating_in_these_courses.yml".

data/lib/studium/utility_scripts/calendar/calendar.rb

@@ -0,0 +1,244 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Calendar
+#
+# The purpose of this class is to show which lectures are upcoming.
+# At some point in the future it is also planned to add support 
+# for automatically showing the date of holidays. 
+#
+# Usage example:
+#
+#   Studium::Calendar.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/calendar/calendar.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+require 'studium/utility_scripts/calendar/misc.rb'
+
+module Studium
+
+class Calendar < Base # === Studium::Calendar
+
+  # ========================================================================= #
+  # === 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()
+    # ======================================================================= #
+    # === @n_days_into_the_future
+    #
+    # How many days into the future we will "peek".
+    # ======================================================================= #
+    @n_days_into_the_future = 14
+    # ======================================================================= #
+    # === @dataset_from_the_file_participating_in_these_courses
+    #
+    # We must load the dataset stored in the file
+    # "participating_in_these_courses.yml"
+    # ======================================================================= #
+    @dataset_from_the_file_participating_in_these_courses = 
+      YAML.load_file(FILE_PARTICIPATING_IN_THESE_COURSES)
+    # ======================================================================= #
+    # === @dataset_from_the_file_lecture_information
+    # ======================================================================= #
+    @dataset_from_the_file_lecture_information = return_dataset_from_the_file_lecture_information
+  end
+
+  # ========================================================================= #
+  # === main_dataset?
+  # ========================================================================= #
+  def main_dataset?
+    @dataset_from_the_file_lecture_information
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === --help
+      # ===================================================================== #
+      when /help/
+        show_help
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === show_help
+  # ========================================================================= #
+  def show_help
+    e 'Currently no help-options are documented.'
+  end
+
+  # ========================================================================= #
+  # === Studium::Calendar[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+  # ========================================================================= #
+  # === show_the_courses_in_this_week
+  #
+  # This method will show the courses that are coming in this week - or,
+  # more accurately, the next 7 days.
+  # ========================================================================= #
+  def show_the_courses_in_this_week
+    _ = @dataset_from_the_file_lecture_information
+    today = Time.now
+    day1 = dd_mm_yyyy(today)
+    @hash_sorted_by_days = {}
+    @hash_sorted_by_days.default = []
+    @dataset_from_the_file_participating_in_these_courses.each {|this_lecture|
+      if _.has_key? this_lecture
+        pointer = _[this_lecture]
+      else
+        e 'No key found called '+steelblue(this_lecture.to_s)
+        exit
+      end
+      lva_dates = pointer['lva_dates']
+      if lva_dates
+        0.upto(@n_days_into_the_future).each {|day_number_n|
+          modify_this_hash_with_upcoming_lva_dates(
+            dd_mm_yyyy(
+              # ============================================================= #
+              # We refer to day1 as our starting-day:
+              # ============================================================= #
+              Time.parse(day1) + (ONE_DAY * day_number_n)
+            ),
+            lva_dates,
+            this_lecture
+          )
+        }
+      end
+    }
+    report(@hash_sorted_by_days)
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report(
+      i = @hash_sorted_by_days
+    )
+    e
+    if i.is_a? Hash
+      if i.empty?
+        e 'No lecture was found in the coming 7 days.'
+      else
+        sorted_hash = i.sort_by {|date_of_the_lecture, inner_array|
+          Time.parse(date_of_the_lecture) # We need it sorted via Time.
+        }
+        sorted_hash = Hash[sorted_hash]
+        sorted_hash.each_pair {|weekday, array_name_of_the_lectures| # weekday is something like: "13.10.2020"
+          # ================================================================= #
+          # The Array is not yet sorted by time, e. g. 14:00 versus
+          # 08:00 o'clock. Thus, we must first sort it based on
+          # time.
+          # ================================================================= #
+          array_name_of_the_lectures = sort_these_lecture_names_by_time(
+            array_name_of_the_lectures, weekday
+          )
+          array_name_of_the_lectures.each {|name_of_the_lecture|
+            result = '  '+
+                     steelblue(weekday)+' '+
+                     seagreen('→ ')+
+                     lightgreen(
+                       name_of_the_lecture.ljust(65) # Pad it a little here.
+                     )
+            # =============================================================== #
+            # Next, we need to fetch the time on that day, so we
+            # know when the course will be held.
+            # =============================================================== #
+            pointer    = main_dataset?[name_of_the_lecture]
+            lva_dates  = pointer['lva_dates']
+            priority   = pointer[:priority]
+            university = pointer[:university]
+            correct_entry = lva_dates.select {|line|
+              line.include? weekday
+            }
+            correct_entry = correct_entry.first if correct_entry.is_a? Array
+            result = result.dup if result.frozen?
+            extracted_time = extract_the_time_from(correct_entry)
+            # =============================================================== #
+            # Next, we will replace the n minutes part with unicode
+            # variants if we are on a roebe-system.
+            # =============================================================== #
+            if is_on_roebe?
+              # ============================================================= #
+              # extracted_time now may look like this: "14:30-17:45"
+              # ============================================================= #
+              _ = ''.dup
+              inner_split = extracted_time.split('-')
+              inner_split.each_with_index {|time_entry, index|
+                splitted = time_entry.split(':')
+                unicode_numbers = replace_regular_numbers_with_unicode_numbers(splitted[-1])
+                splitted[-1] = unicode_numbers
+                _ << '-' if (index % 2 == 1)
+                _ << splitted.join(':')
+              }
+              extracted_time = _.delete(':')
+            end
+            colourized_extracted_time = tomato(extracted_time) 
+            result << " #{colourized_extracted_time}"
+            # =============================================================== #
+            # Add the priority next.
+            # =============================================================== #
+            result << mediumpurple(" [Priority: #{priority}]")
+            # =============================================================== #
+            # Add the university next.
+            # =============================================================== #
+            result << mediumorchid(" #{university.center(10)}")
+            e result
+          }
+        }
+      end
+    end
+    e
+  end
+
+  # ========================================================================= #
+  # === modify_this_hash_with_upcoming_lva_dates
+  # ========================================================================= #
+  def modify_this_hash_with_upcoming_lva_dates(
+      this_day,
+      lva_dates,
+      this_lecture
+    )
+    if lva_dates.any? {|entry| entry.include? this_day }
+      unless @hash_sorted_by_days.has_key? this_day
+        @hash_sorted_by_days[this_day] = []
+      end
+      @hash_sorted_by_days[this_day] << this_lecture
+    end
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Calendar.new(ARGV)
+end # studiumcalendar