studium 0.18.7

data/lib/studium/utility_scripts/mandatory_lectures_in_this_month/mandatory_lectures_in_this_month.rb

@@ -0,0 +1,316 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::MandatoryLecturesInThisMonth
+#
+# This class can be used to display which mandatory lectures are done
+# on a per-monthly basis.
+#
+# Usage example:
+#
+#   Studium::MandatoryLecturesInThisMonth.new
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/mandatory_lectures_in_this_month/mandatory_lectures_in_this_month.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class MandatoryLecturesInThisMonth < ::Studium::Base # === Studium::MandatoryLecturesInThisMonth
+
+  # ========================================================================= #
+  # === AVAILABLE_MONTHS
+  # ========================================================================= #
+  AVAILABLE_MONTHS = Date::MONTHNAMES
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_show_mandatory_courses_in_this_month(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @check_against_this_year
+    #
+    # The following variable is important so that we know whether
+    # we shall check against the current year, or the next year.
+    # This depends on the input passed to the method
+    # set_show_mandatory_courses_in_this_month() ultimately.
+    # ======================================================================= #
+    @check_against_this_year = Time.now.year
+    if ::Studium.main_dataset?
+      @dataset = ::Studium.main_dataset?
+    else
+      @dataset = return_dataset_from_file_lecture_information
+    end
+  end
+
+  # ========================================================================= #
+  # === set_show_mandatory_courses_in_this_month
+  #
+  # This method determines on which month we will work.
+  #
+  # Note that we will store the month as a number.
+  # ========================================================================= #
+  def set_show_mandatory_courses_in_this_month(
+      i = return_current_month_as_a_number
+    )
+    if i.is_a? Array # We want a String past this point here.
+      if i.empty?
+        i << return_current_month_as_a_number
+      end
+      i = i.join(' ').strip
+    end
+    i = i.to_s # First a String, to check for month-names.
+    if MONTH_NAME_ALIASES_GERMAN_TO_ENGLISH.has_key? i.capitalize
+      i = MONTH_NAME_ALIASES_GERMAN_TO_ENGLISH[i.capitalize]
+    end
+    if MONTH_NAME_TO_MONTH_NUMBER.has_key? i.capitalize
+      # ===================================================================== #
+      # If the key is found in that number, we will use its value.
+      # ===================================================================== #
+      i = MONTH_NAME_TO_MONTH_NUMBER[i.capitalize]
+    end
+    i = i.to_i
+    @show_mandatory_courses_in_this_month = i
+    # ======================================================================= #
+    # Whenever the month has been assigned, we also need to consider
+    # updating the variable called @check_against_this_year.
+    # The logic for this is simple - if the number is below the current
+    # month, then we will add +1 to @check_against_this_year. 
+    # ======================================================================= #
+    if i < Time.now.month
+      @check_against_this_year += 1
+    end
+  end
+
+  # ========================================================================= #
+  # === show_mandatory_courses_in_this_month?
+  # ========================================================================= #
+  def show_mandatory_courses_in_this_month?
+    @show_mandatory_courses_in_this_month
+  end; alias searching_for_which_month? show_mandatory_courses_in_this_month? # === searching_for_which_month?
+
+  # ========================================================================= #
+  # === which_month?
+  #
+  # This method must return the name of a month.
+  # ========================================================================= #
+  def which_month?
+    AVAILABLE_MONTHS[@show_mandatory_courses_in_this_month]
+  end
+
+  # ========================================================================= #
+  # === determine_which_courses_are_run_in_this_month
+  # ========================================================================= #
+  def determine_which_courses_are_run_in_this_month
+    searching_for_this_month = searching_for_which_month?
+    searching_for_this_year  = searching_for_which_year?
+    _ = @dataset
+    # ======================================================================= #
+    # We must determine next which entries are in the month at hand.
+    # ======================================================================= #
+    _.select! {|name_of_the_lecture, inner_dataset|
+      lva_dates = inner_dataset['lva_dates']
+      if lva_dates
+        only_the_month = lva_dates.map {|entry|
+          entry = remove_weeknames(entry).strip
+          # ================================================================= #
+          # Invalidate entries that do not use the target year.
+          # ================================================================= #
+          unless entry.include? searching_for_this_year.to_s
+            entry = nil
+          end
+          if entry
+            if entry.include? ','
+              entry = entry.split(',').first
+            end
+            if entry.include? '.'
+              entry = entry.split('.')[1].to_i # This selects the month-entry. 
+            end
+          end
+          entry
+        }
+        only_the_month.compact!
+        only_the_month.include? searching_for_this_month
+      else
+        e swarn('No lva entry for `')+
+          slateblue(name_of_the_lecture)+
+          swarn('`.')
+      end
+    }
+    # ======================================================================= #
+    # Sort by priority first.
+    # ======================================================================= #
+    _ = _.sort_by {|a, b| priority = b[:priority]
+      priority # Sort by priority first.
+    }
+    @dataset = _
+    e
+    e "The following lectures are in the month #{orange(which_month?.to_s)}:"
+    e
+    report(@dataset)
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  #
+  # This is the general reporting-method of this class. Arrays and Hashes
+  # may be treated somewhat differently.
+  # ========================================================================= #
+  def report(
+      i = @dataset
+    )
+    result = ''.dup
+    if i.is_a? Hash
+      i.each_pair {|a, b|
+        result << "  #{powderblue(a)}#{N}"
+      }
+    elsif i.is_a? Array
+      counter = 0
+      i.each {|name_of_the_lecture, b| counter += 1
+        result << '  '+
+                  royalblue((counter.to_s+')').ljust(4))+
+                  powderblue(name_of_the_lecture)
+        lva_dates    = b['lva_dates']
+        lecture_type = obtain(:type, b)
+        if lva_dates.is_a? Array
+          lva_dates.map! {|inner_line|
+            inner_line.strip.delete(',')
+          }
+        end
+        if b.is_a?(Hash) and b.has_key?(:priority)
+          # ================================================================= #
+          # In this case append the priority. And the amount of ECTS too.
+          # ================================================================= #
+          result << +seagreen(
+            ' (Priority: '+b[:priority].to_s
+          )
+          if b.has_key?(:ects)
+            result << seagreen('; ')
+            result << mediumorchid(b[:ects].to_s+' ECTS')
+          end
+          result << "; Type: #{lecture_type}"
+          result << seagreen(')')
+        end
+        result << N
+        this_month = @show_mandatory_courses_in_this_month
+        unless lva_dates.empty?
+          result << N # A prettier newline before we will display the rest.
+        end
+        # =================================================================== #
+        # Next, also show the lectures in this month.
+        # =================================================================== #
+        lva_dates.each {|lva_date|
+          # ================================================================= #
+          # Only add it if it is the proper month.
+          # ================================================================= #
+          splitted = lva_date.split('.')
+          month = splitted[1].to_i
+          if month == this_month
+            weekday = return_weekday_from_this_input(lva_date, :use_german).ljust(10)
+            result << skyblue('    ')+
+                      mediumseagreen(weekday)+
+                      skyblue(' '+lva_date+N)
+          end
+        }
+        result << N # A prettier newline before we will display the rest.
+      }
+    end
+    result << N
+    e result
+  end
+
+  # ========================================================================= #
+  # === check_against_this_year?
+  # ========================================================================= #
+  def check_against_this_year?
+    @check_against_this_year
+  end; alias check_for_which_year?     check_against_this_year? # === check_for_which_year?
+       alias searching_for_which_year? check_against_this_year? # === check_against_this_year?
+
+  # ========================================================================= #
+  # === select_only_unfinished_mandatory_presence_courses_with_a_lva_dates_entry
+  #
+  # We will select only the following courses:
+  #
+  #   (1) Those that are "prüfungsimmanent", aka require "mandatory presence"
+  #   (2) Those that have NOT yet been solved
+  #   (3) Those that DO have a lva_dates entry.
+  #
+  # ========================================================================= #
+  def select_only_unfinished_mandatory_presence_courses_with_a_lva_dates_entry
+    @dataset.select! {|a, inner_dataset|
+      lecture_type = inner_dataset[:type]
+      already_solved = inner_dataset[:already_solved]
+      has_lva_dates_entry = inner_dataset.has_key?('lva_dates')
+      # ===================================================================== #
+      # We will only select courses with a mandatory presence next:
+      # ===================================================================== #
+      is_prüfungsimmanent?(lecture_type) and
+      (!already_solved) and
+      has_lva_dates_entry
+    }
+  end
+
+  # ========================================================================= #
+  # === show_introduction_header
+  # ========================================================================= #
+  def show_introduction_header
+    opnn { :no_colon }
+    e
+    e
+    e "All lectures that offer a date on the month #{teal(which_month?.to_s)}"\
+      " will be shown next."
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    show_introduction_header
+    # ======================================================================= #
+    # First, we will select mandatory-presence courses.
+    # ======================================================================= #
+    select_only_unfinished_mandatory_presence_courses_with_a_lva_dates_entry
+    determine_which_courses_are_run_in_this_month
+  end
+
+  # ========================================================================= #
+  # === Studium::MandatoryLecturesInThisMonth[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.mandatory_lectures_in_this_month
+# =========================================================================== #
+def self.mandatory_lectures_in_this_month(i)
+  Studium::MandatoryLecturesInThisMonth.new(i)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::MandatoryLecturesInThisMonth.new(ARGV)
+end # mandatorylecturesinthismonth November
+    # mandatorylecturesinthismonth März
+    # mandatorylecturesinthismonth 10
+    # mandatorylecturesinthismonth 11

data/lib/studium/utility_scripts/moodle/moodle.rb

@@ -0,0 +1,214 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Moodle
+#
+# This class can be used to return URLs to different moodle-sites,
+# mostly university-related websites.
+#
+# Usage example:
+#
+#   Studium::Moodle.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/moodle.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class Moodle < Base # === Studium::Moodle
+
+  begin
+    require 'roebe/requires/failsafe_require_of_beautiful_url.rb'
+  rescue LoadError; end
+
+  begin
+    require 'studium/toplevel_methods/return_remote_moodle_link_of_this_lecture.rb'
+  rescue LoadError; end
+  
+  # ========================================================================= #
+  # === FILE_LINKS
+  # ========================================================================= #
+  FILE_LINKS = 'LINKS.md'
+
+  # ========================================================================= #
+  # === 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()
+    infer_the_namespace
+    try_to_require_the_open_gem
+  end
+
+  # ========================================================================= #
+  # === is_this_a_registered_moodle_link_of_a_lecture_course?
+  # ========================================================================= #
+  def is_this_a_registered_moodle_link_of_a_lecture_course?(i)
+    remote_moodle_link = Studium.return_remote_moodle_link_of_this_lecture(i)
+    !(remote_moodle_link == i) # If both are the same, then the URL is NOT registered.
+  end
+
+  # ========================================================================= #
+  # === open_uni_vienna_moodle
+  # ========================================================================= #
+  def open_uni_vienna_moodle
+    if Object.const_defined?(:BeautifulUrl)
+      url = BeautifulUrl[:uni_vienna_moodle]
+      url = url.first if url.is_a? Array
+      open_in_browser(url)
+    end
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      if i.empty?
+        # In this case let "rf" open the unimoodle page.
+        open_in_browser(:unimoodle)
+      else
+        i.each {|entry| menu(entry) }
+      end
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === moodle HERE
+      #
+      # This entry point handles the string-argument called 'HERE'.
+      # ===================================================================== #
+      when /^-?-?HERE$/i
+        _ = FILE_LINKS
+        if File.exist? _
+          original_dataset = File.readlines(_)
+          dataset = original_dataset.reject {|line|
+            line.strip.start_with? '#'
+          }.select {|line| # Try to find the moodle entry here.
+            line =~ /moodle/ or
+            line =~ /tuwel/ or # For support of TU Vienna's moodle variant.
+            line =~ /learn.boku.ac.at/
+          }
+          if dataset.empty?
+            e rev+
+              tomato('We did find a file called ')+
+              sfile(_)+
+              tomato(' in this directory, but this')
+            e tomato('file does not appear to contain any moodle-relevant content.')
+            # =============================================================== #
+            # Next we will obtain the number from the course, as that
+            # can be used to determine the real lecture's moodle entry
+            # dynamically, so we are no longer confined to a hardcoded
+            # entry in the file LINKS.md:
+            # =============================================================== #
+            number_of_the_lva = File.basename(return_pwd)
+            if number_of_the_lva.include?('_')
+              number_of_the_lva = number_of_the_lva.split('_').first
+            end
+            keys = all_lectures?.keys
+            selection = keys.select {|line| line.start_with?(number_of_the_lva) }
+            if selection.empty?
+              e
+              e 'We will next display this file:'
+              e
+              cliner(colour: :lightgreen) { :unicode }
+              e
+              e original_dataset.map {|entry| "  #{entry}" }.join
+              e
+              cliner(colour: :lightgreen) { :unicode }
+            else # here we know the selection is NOT empty, so we pick the first entry for now.
+              first_entry = selection.first.to_s
+              dataset = dataset_from_the_file_lecture_information
+              pointer = dataset[first_entry]
+              if pointer.has_key? :moodle
+                _ = pointer[:moodle]
+                _ = _.first if _.is_a? Array
+                open_in_browser(_)
+              else
+                opne 'No moodle-entry was found for '+steelblue(first_entry)
+              end
+            end
+          else
+            # =============================================================== #
+            # Since as of March 2023, we will narrow this down to the
+            # top-entry only, in order to avoid batch-opening outdated
+            # moodle entries.
+            # =============================================================== #
+            if dataset.is_a?(Array) and dataset.size > 1
+              dataset = dataset.first
+            end
+            open_in_browser(dataset)
+          end
+        else # else if the file does not exist
+          opne "#{rev}No file called `#{sfile(_)}#{rev}` exists in this directory."
+        end
+      else
+        # =================================================================== #
+        # Next check whether we have a registered moodle-link for that
+        # lecture course.
+        # =================================================================== #
+        if is_this_a_registered_moodle_link_of_a_lecture_course?(_)
+          open_in_browser(
+            Studium.return_remote_moodle_link_of_this_lecture(_)
+          )
+        # =================================================================== #
+        # Next check through the moodle-entry in BeautifulUrl:
+        # =================================================================== #
+        elsif BeautifulUrl.is_included_in_moodle?(_)
+          open_in_browser(BeautifulUrl.moodle(_))
+        else
+          # ================================================================= #
+          # Else we default towards the university of vienna moodle
+          # if we have not found anything.
+          # ================================================================= #
+          open_uni_vienna_moodle
+        end
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    menu
+  end
+
+  # ========================================================================= #
+  # === Studium::Moodle[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.moodle
+# =========================================================================== #
+def self.moodle(i = ARGV)
+  Studium::Moodle.new(i)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Moodle.new(ARGV)
+end # moodle 

data/lib/studium/utility_scripts/name_of_this_lva_id/name_of_this_lva_id.rb

@@ -0,0 +1,110 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::NameOfThisLvaId
+#
+# This class will simply return the name of the lecture at hand. If there
+# is more than one candidate, all results will be shown to the user.
+#
+# Usage example:
+#
+#   Studium::NameOfThisLvaId.new
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/name_of_this_lva_id.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class NameOfThisLvaId < ::Studium::Base # === Studium::NameOfThisLvaId
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @matches
+    # ======================================================================= #
+    @matches = nil # <- We will store our results here.
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = dataset_from_file_lecture_information
+  end
+
+  # ========================================================================= #
+  # === try_to_find_matches
+  # ========================================================================= #
+  def try_to_find_matches
+    search_for_this_lva_id = commandline_arguments_as_string
+    @matches = @dataset.select {|a, b|
+      a.start_with?(search_for_this_lva_id)
+    }
+  end
+
+  # ========================================================================= #
+  # === report
+  # ========================================================================= #
+  def report(
+      i = @matches
+    )
+    lva_id = commandline_arguments_as_string
+    if i
+      e
+      @matches.each {|name_of_the_lecture, b|
+        e '  '+
+          royalblue(
+            name_of_the_lecture.sub(/#{lva_id}/,'')
+          )
+      }
+      e
+    else
+      e 'No matches were found for `'+simp(lva_id)+'`.'
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    try_to_find_matches
+    report
+  end
+
+  # ========================================================================= #
+  # === Studium::NameOfThisLvaId[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.name_of_this_lva_id
+# =========================================================================== #
+def self.name_of_this_lva_id(i)
+  ::Studium::NameOfThisLvaId.new(i)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::NameOfThisLvaId.new(ARGV)
+end # nameofthislvaid 269004
+    # nameofthislvaid 269020