studium 0.13.1

data/lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb

@@ -0,0 +1,217 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium:SyncStudiumRelevantEntriesOneLevelDownwards
+#
+# We will sync all (integer) entries from the file exams.yml downwards,
+# by -1.
+#
+# Before we will modify exams.yml, though, we will keep a reference backup
+# just in case something goes awry.
+#
+# Usage example:
+#
+#   Studium::SyncStudiumRelevantEntriesOneLevelDownwards.new(ARGV)
+#
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class SyncStudiumRelevantEntriesOneLevelDownwards < ::Studium::Base # require 'sync_studium_relevant_entries_one_level_downwards'; SyncStudiumRelevantEntriesOneLevelDownwards.new
+
+  require 'studium/utility_scripts/new_stud.rb'
+
+  # ========================================================================= #
+  # === CD_ALIASES
+  #
+  # Load up the cd_aliases.yml file.
+  # ========================================================================= #
+  if File.exist? FILE_CD_ALIASES
+    begin
+      CD_ALIASES = YAML.load_file(FILE_CD_ALIASES)
+    rescue Psych::SyntaxError => error
+      CD_ALIASES = {}
+      puts 'Problem with the file '+FILE_CD_ALIASES
+      pp error
+    end
+  else
+    if ::Studium.respond_to?(:is_on_roebe?) and ::Studium.is_on_roebe?
+      puts "No file called `#{FILE_CD_ALIASES}` exists."
+    end
+  end
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      run_already = true
+    )
+    reset
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @may_we_continue
+    # ======================================================================= #
+    @may_we_continue = true
+  end
+
+  # ========================================================================= #
+  # === report_what_we_will_do
+  # ========================================================================= #
+  def report_what_we_will_do
+    opnn; e 'Now syncing all older entries one level downwards.'
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run # (run tag)
+    report_what_we_will_do
+    _ 'tostud2'
+    _ 'newstud1'
+    _ 'tostud3'
+    _ 'newstud2'
+    _ 'tostud4'
+    _ 'newstud3'
+    _ 'tostud5'
+    _ 'newstud4'
+    _ 'tostud6'
+    _ 'newstud5'
+    _ 'tostud7'
+    _ 'newstud6'
+    _ 'tostud8'
+    _ 'newstud7'
+    _ 'tostud9'
+    _ 'newstud8'
+    report_that_we_have_finished
+    correct_the_entries_in_exams_yaml_file if on_roebe?
+  end
+
+  # ========================================================================= #
+  # === report_that_we_have_finished
+  # ========================================================================= #
+  def report_that_we_have_finished
+    opnn; e 'All done now.'
+  end
+
+  # ========================================================================= #
+  # === save_dataset
+  # ========================================================================= #
+  def save_dataset(dataset)
+    into = Studium.file_exams?
+    opnn; e "Now saving into #{sfile(into)}."
+    write_what_into(dataset, into)
+  end
+
+  # ========================================================================= #
+  # === backup_old_exams_file
+  # ========================================================================= #
+  def backup_old_exams_file
+    Studium.backup_old_exams_file
+  end
+
+  # ========================================================================= #
+  # === cd                                                           (cd tag)
+  # ========================================================================= #
+  def cd(i)
+    i = CD_ALIASES[i]
+    i = CD_ALIASES[i] # Try again.
+    i << '/' unless i.end_with? '/'
+    begin
+      i.gsub!(/^cd /,'') if i.include? 'cd '
+      i.gsub!(/; pwd/,'')
+    rescue; end
+    i.strip!
+    if Dir.exist?(i)
+      opnn; e "Now cd-ing into `#{sdir(i)}`."
+      cd(i)
+    else
+      opnn; e "We can not cd into `#{sdir(i)}` "\
+              "as that directory does not exist."
+      @may_we_continue = false
+    end
+  end
+
+  # ========================================================================= #
+  # === _
+  #
+  # This method will accept two instructions:
+  #
+  #   (1) tostud
+  #   (2) newstud
+  #
+  # tostud is just a cd-alias that will allow us to move to the respective
+  # directory.
+  #
+  # newstud will delegate to Studium::NewStud[], and set a new study
+  # point.
+  # ========================================================================= #
+  def _(i = '')
+    case i # case tag
+    when /^tostud/
+      cd(i) # We only go from here
+    when /newstud(\d+)/
+      if may_we_continue?
+        number = $1.to_s
+        Studium::NewStud[number]
+      else
+        opnn; e 'Some error happened. Please fix this error first before'
+        opnn; e 'we can continue.'
+        exit
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === may_we_continue?
+  # ========================================================================= #
+  def may_we_continue?
+    @may_we_continue
+  end
+
+  # ========================================================================= #
+  # === correct_the_entries_in_exams_yaml_file
+  # ========================================================================= #
+  def correct_the_entries_in_exams_yaml_file
+    _ = Studium.file_exams?
+    if File.exist? _
+      opnn; e 'Now reading in the dataset of '+sfile(_)+'.'
+      opnn; e 'We will replace all (number) entries with a '+simp('-1')+' entry.'
+      new_dataset = ''
+      # ===================================================================== #
+      # Next, read in the dataset into an Array.
+      # ===================================================================== #
+      dataset = File.readlines(_)
+      dataset.each {|line|
+        if line.include? '(' and line.include? ')'
+          regex_to_use = /(\(\d+\))/ # See http://rubular.com/r/tsol2UZ5jP
+          if line =~ regex_to_use
+            old_number = ($1.to_s.dup.delete('(').delete(')').to_i - 1)
+            if old_number == 0
+              old_number = '' # Will be purged.
+            end
+            line.gsub!(/#{$1.to_s.dup}/, old_number.to_s)
+            line.gsub!(/\(\)/, '') # And we also purge "()" entries.
+          end
+        end 
+        new_dataset << line
+      }
+      backup_old_exams_file
+      save_dataset(new_dataset)
+    end
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::SyncStudiumRelevantEntriesOneLevelDownwards.new
+end # cascade

data/lib/studium/utility_scripts/ufind/ufind.rb

@@ -0,0 +1,98 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Ufind
+#
+# This class will simply search at ufind (search site used by the
+# University of Vienna).
+#
+# Usage example:
+#
+#   Studium::Ufind.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/classes/ufind.rb'
+# Studium::Ufind.new(ARGV)
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class Ufind < Base # === Studium::Ufind
+
+  # ========================================================================= #
+  # === UFIND_BASE_URL
+  # ========================================================================= #
+  UFIND_BASE_URL = 'https://ufind.univie.ac.at/de/search.html?'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    try_to_require_the_open_gem
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @remote_url_to_use
+    #
+    # This is the remote URL that stores which URL is to be opened.
+    # ======================================================================= #
+    @remote_url_to_use = nil
+  end
+
+  # ========================================================================= #
+  # === sanitize_input
+  # ========================================================================= #
+  def sanitize_input
+    commandline_arguments?.map! {|entry|
+      if entry.end_with? ':'
+        entry = entry.dup if entry.frozen?
+        entry.chop!
+      end
+      entry
+    }
+  end
+
+  # ========================================================================= #
+  # === input_joined
+  # ========================================================================= #
+  def input_joined
+    commandline_arguments?.join('+')
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    sanitize_input
+    which_filter_type_to_use = 'courses' # ← Could be 'all' as well, via '&ief='.
+    @remote_url_to_use = UFIND_BASE_URL+'query='+input_joined+
+                         '&'+
+                         'filter='+which_filter_type_to_use
+    Open.in_browser(@remote_url_to_use)
+  end
+
+  # ========================================================================= #
+  # === Studium::Ufind[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Ufind.new(ARGV)
+end # ufind genetics

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

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/utility_scripts/upcoming_mandatory_presence_courses/constants.rb'
+# =========================================================================== #
+module Studium
+
+class UpcomingMandatoryPresenceCourses < Base # === Studium::UpcomingMandatoryPresenceCourses
+
+  # ========================================================================= #
+  # === ONE_HOUR
+  #
+  # 3600 seconds are in one hour.
+  # ========================================================================= #
+  ONE_HOUR = 3600
+
+  # ========================================================================= #
+  # === N_DAYS_INTO_THE_FUTURE
+  #
+  # Here you can decide how many days into the future this class will "look"
+  # into.
+  # ========================================================================= #
+  N_DAYS_INTO_THE_FUTURE = 40
+
+end; end

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

@@ -0,0 +1,20 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/utility_scripts/upcoming_mandatory_presence_courses/run.rb'
+# =========================================================================== #
+module Studium
+
+class UpcomingMandatoryPresenceCourses < Base # === Studium::UpcomingMandatoryPresenceCourses
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    menu
+    filter_for_the_proper_entries
+    report
+  end
+
+end; end

data/lib/studium/utility_scripts/upcoming_mandatory_presence_courses/upcoming_mandatory_presence_courses.rb

@@ -0,0 +1,181 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::UpcomingMandatoryPresenceCourses
+#
+# The main purpose for this class is to quickly show which mandatory
+# presence courses are upcoming/available in general, no matter
+# if the user is registered for this course or whether the user
+# is not registered.
+#
+# The idea behind this is to allow people to plan ahead for 
+# upcoming courses, so that they can participate in them.
+#
+# By default, the class will show upcoming courses in the next
+# 30 days.
+# =========================================================================== #
+# require 'studium/utility_scripts/upcoming_mandatory_presence_courses/upcoming_mandatory_presence_courses.rb'
+# Studium::UpcomingMandatoryPresenceCourses.new(ARGV)
+# =========================================================================== #
+require 'studium/base/base.rb'
+require 'studium/utility_scripts/upcoming_mandatory_presence_courses/constants.rb'
+require 'studium/utility_scripts/upcoming_mandatory_presence_courses/run.rb'
+
+module Studium
+
+class UpcomingMandatoryPresenceCourses < Base # === Studium::UpcomingMandatoryPresenceCourses
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = return_all_lectures
+    # ======================================================================= #
+    # === @threshold_value_n_days_into_the_future
+    #
+    # This variable determines how many days into the future we will look
+    # at.
+    # ======================================================================= #
+    @threshold_value_n_days_into_the_future = N_DAYS_INTO_THE_FUTURE
+  end
+
+  # ========================================================================= #
+  # === n_days_into_the_future?
+  # ========================================================================= #
+  def n_days_into_the_future?
+    @threshold_value_n_days_into_the_future
+  end
+
+  # ========================================================================= #
+  # === filter_for_the_proper_entries
+  # ========================================================================= #
+  def filter_for_the_proper_entries
+    # ======================================================================= #
+    # First, grab only those entries that are indeed "prüfungsimmanent"
+    # and that have at the least one 'lva_dates' entry:
+    # ======================================================================= #
+    @dataset.select! {|name_of_the_lecture, inner_hash|
+      type = inner_hash[:type]
+      is_this_a_prüfungsimment_course?(type) and
+      inner_hash.has_key?('lva_dates')
+    }
+    # ======================================================================= #
+    # Next, we should sort these entries.
+    # ======================================================================= #
+    _ = []
+    today = Time.now
+    n_seconds_in_the_future = @threshold_value_n_days_into_the_future * 24 * ONE_HOUR
+    future_day = today+n_seconds_in_the_future
+    @dataset.each_pair {|name_of_the_lecture, inner_hash|
+      lva_dates = inner_hash['lva_dates']
+      if lva_dates.nil?
+        e steelblue('No lva-dates found for ')+royalblue(name_of_the_lecture)
+      end
+      first_entry = lva_dates.first
+      first_entry = Time.parse(first_entry)
+      # ===================================================================== #
+      # Next we will determine whether this lecture will be added
+      # or not. We will compare this to the threshold value.
+      # ===================================================================== #
+      if (first_entry < future_day) and (first_entry > today)
+        _ << [first_entry, { name_of_the_lecture => inner_hash } ]
+      end
+    }
+    _.sort_by! {|array|
+      array.first
+    }
+    @dataset = _
+  end
+
+  # ========================================================================= #
+  # === report_how_many_dates_into_the_future_we_will_be_looking
+  # ========================================================================= #
+  def report_how_many_dates_into_the_future_we_will_be_looking
+    e "#{rev}Looking #{sfancy(n_days_into_the_future?)} days into the future."
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report(
+      i = @dataset
+    )
+    report_how_many_dates_into_the_future_we_will_be_looking
+    e
+    e "#{rev}Upcoming mandatory courses:"
+    e
+    index = 0
+    right_arrow = right_arrow?
+    i.each {|date_entry, inner_hash| index += 1
+      name_of_the_lecture = inner_hash.keys.first
+      e orange(index.to_s)+
+        royalblue(') ')+
+        steelblue(name_of_the_lecture)
+      e
+      e mediumturquoise("     #{right_arrow}")+
+        lightblue(" #{date_entry}")
+      e
+    }
+  end
+
+  # ========================================================================= #
+  # === right_arrow?
+  # ========================================================================= #
+  def right_arrow?
+    Roebe.right_arrow
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(i = @commandline_arguments)
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i
+      # ===================================================================== #
+      # === 30days or 60days or 120days
+      #
+      # Usage example:
+      #
+      #   UpcomingMandatoryPresenceCourses --120days
+      #
+      # ===================================================================== #
+      when /^-?-?(\d{1,3})days$/
+        set_n_days_into_the_future($1.to_s.dup)
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === set_n_days_into_the_future
+  # ========================================================================= #
+  def set_n_days_into_the_future(i)
+    @threshold_value_n_days_into_the_future = i.to_i
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::UpcomingMandatoryPresenceCourses.new(ARGV)
+end # UpcomingMandatoryPresenceCourses

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

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/utility_scripts/week_parser/constants.rb'
+# =========================================================================== #
+module Studium
+
+class WeekParser < Base # === Studium::WeekParser
+
+  # ========================================================================= #
+  # === SKIP_LOW_PRIORITY_LECTURES
+  #
+  # If true then we will skip low priority lectures.
+  # ========================================================================= #
+  SKIP_LOW_PRIORITY_LECTURES = true
+
+  # ========================================================================= #
+  # === PAD_TO_THE_RIGHT
+  # ========================================================================= #
+  PAD_TO_THE_RIGHT = 99
+
+end; end

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