studium 0.13.1

data/lib/studium/utility_scripts/regexes/generate_regex.rb

@@ -0,0 +1,300 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::GenerateRegex
+#
+# This class can generate a regex menu.
+# =========================================================================== #
+# require 'studium/utility_scripts/regexes/generate_regex.rb'
+# Studium::GenerateRegex.new(ARGV)
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class GenerateRegex < Base # === Studium::GenerateRegex
+
+  require 'studium/toplevel_methods/return_remote_moodle_link_of_this_lecture.rb'
+
+  # ========================================================================= #
+  # === 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
+    # ======================================================================= #
+    # === @use_this_as_the_toplevel_name_for_the_method
+    # ======================================================================= #
+    @use_this_as_the_toplevel_name_for_the_method = 'return_remote_homepage_of_this_lecture'
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = return_dataset_from_the_file_lecture_information
+    # ======================================================================= #
+    # === @store_into
+    # ======================================================================= #
+    @store_into =
+      "#{RUBY_STUDIUM_HOME_DIR}toplevel_methods/return_remote_homepage_of_this_lecture.rb"
+    # ======================================================================= #
+    # === @search_for_this_entry
+    #
+    # The following variable keeps track as to which entry we are
+    # selecting for. By default we may pick :homepage, but another
+    # useful entry is :moodle.
+    # ======================================================================= #
+    @search_for_this_entry = :homepage
+    # ======================================================================= #
+    # === @rf_or_moodle
+    # ======================================================================= #
+    @rf_or_moodle = 'rf'
+  end
+
+  # ========================================================================= #
+  # === generate_the_relevant_ruby_code               (generate tag, gen tag)
+  #
+  # This method will first generate the relevant ruby code, that can then
+  # be saved into a file.
+  # ========================================================================= #
+  def generate_the_relevant_ruby_code
+    @string = <<-EOF
+#!/usr/bin/ruby -w
+# Encoding: #{Studium.main_encoding?}
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/#{@use_this_as_the_toplevel_name_for_the_method}.rb'
+# =========================================================================== #
+module Studium
+
+  # ========================================================================= #
+  # === Studium.#{@use_this_as_the_toplevel_name_for_the_method}
+  #
+  # This method will take a given input, as String, and then return
+  # a corresponding remote URL. If the input is not registered then
+  # this method will return the original input String.
+  # ========================================================================= #
+  def self.#{@use_this_as_the_toplevel_name_for_the_method}(i)
+    case i # case tag
+EOF
+    @string = @string.dup # De-freeze it.
+    @dataset.each_pair {|name_of_the_lecture, remote_url|
+      # ===================================================================== #
+      # We have to convert the variable name_of_the_lecture into its
+      # regex-representation. In the past Regexp.quote() was used,
+      # but this was changed to a manual gsub-chain for more control.
+      # ===================================================================== #
+      replacement = name_of_the_lecture.gsub(/\//,'\/?').
+                                        gsub(/\(/,'\(?').
+                                        gsub(/\)/,'\)?').
+                                        gsub(/-/,'(-|_)?').
+                                        gsub(/,/,',?'). # ← Need ',' to be optional.
+                                        gsub(/ /,'(-|_| )?').
+                                        gsub(/\./,'\.?').
+                                        gsub(/"/,'"?') # ← This is necessary to make " optional, such as in "omics".
+      _ = '/^'+replacement+'$/i'.dup
+      # ===================================================================== #
+      # The next clause will also generate a slightly shorter "alias" to
+      # the lecture at hand, by omitting the leading number part such as
+      # "289252".
+      # ===================================================================== #
+      if name_of_the_lecture.include?(' ') and
+         name_of_the_lecture.start_with?(/\d/)
+        # =================================================================== #
+        # If there is a leading number and at the least one ' ' token:
+        # =================================================================== #
+        splitted = name_of_the_lecture.split(' ')
+        short_name = splitted[1..-1].join(' ').strip
+        replacement = short_name.gsub(/\//,'\/?').
+                                 gsub(/\(/,'\(?').
+                                 gsub(/\)/,'\)?').
+                                 gsub(/-/,'(-|_)?').
+                                 gsub(/,/,',?'). # ← Need ',' to be optional.
+                                 gsub(/ /,'(-|_| )?').
+                                 gsub(/\./,'\.?').
+                                 gsub(/"/,'"?') # ← This is necessary to make " optional, such as in "omics".
+        _ << ','+N
+        _ << '         /^'+replacement+'$/i'.dup
+      elsif name_of_the_lecture.include?(' ') and
+           !(name_of_the_lecture =~ /\d+/)
+        # =================================================================== #
+        # The clause here is for entries such as:
+        #
+        #   "Basiswissen Mathematik für die Bioinformatik"
+        #
+        # This entry has no number at all, so we will also omit the first
+        # word altogether, and add the rest as an assumed alias.
+        # =================================================================== #
+        splitted = name_of_the_lecture.split(' ')
+        short_name = splitted[1..-1].join(' ').strip
+        replacement = short_name.gsub(/\//,'\/?').
+                                 gsub(/\(/,'\(?').
+                                 gsub(/\)/,'\)?').
+                                 gsub(/ /,'(-|_| )?')
+        _ << ','+N
+        _ << '         /^'+replacement+'$/i'.dup
+      end
+      @string << '    # '+('='*71)+' #'+N
+      @string << "    # === #{@rf_or_moodle} \"#{name_of_the_lecture}\"#{N}"
+      @string << '    # '+('='*71)+' #'+N
+      # ===================================================================== #
+      # Next add the corresponding when-clause:
+      # ===================================================================== #
+      @string << '    when '+_.to_s+N
+      if remote_url.is_a? Array # This here is just debugging quickly.
+        # =================================================================== #
+        # An Array can be used for remote_url, indicating the current URL in 
+        # use, and older, outdated entries, e. g. 2019W and 2020W.
+        # =================================================================== #
+        remote_url = remote_url.first
+      end
+      @string << '      "'+remote_url.to_s+'"'+N
+    }
+    @string << '    else'+N
+    @string << '      i'+N
+    @string << '    end'+N
+    @string << '  end'
+    # ======================================================================= #
+    # The next is only valid for :homepage entries, not :moodle entries.
+    # ======================================================================= #
+    if @search_for_this_entry == :homepage
+      @string << "; self.instance_eval { alias "\
+               "return_remote_url_of_this_lecture #{@use_this_as_the_toplevel_name_for_the_method} } "\
+               "# === Studium.return_remote_url_of_this_lecture#{N}"
+      @string << "       self.instance_eval { alias "\
+               "return_url_from                   #{@use_this_as_the_toplevel_name_for_the_method} } "\
+               "# === Studium.return_url_from#{N}"
+      # ===================================================================== #
+      # Add an alias for:
+      #
+      #   Studium.return_homepage_of_this_lecture
+      #
+      # ===================================================================== #
+      @string << "       self.instance_eval { alias "\
+                 "return_homepage_of_this_lecture   #{@use_this_as_the_toplevel_name_for_the_method} } "\
+                 "# === Studium.return_remote_homepage_of_this_lecture#{N}"
+      # ===================================================================== #
+      # Add an alias for:
+      #
+      #   Studium.return_homepage_for
+      #
+      # ===================================================================== #
+      @string << "       self.instance_eval { alias "\
+                 "return_homepage_for               #{@use_this_as_the_toplevel_name_for_the_method} } "\
+                 "# === Studium.return_homepage_for#{N}"
+      # ===================================================================== #
+      # Add an alias for:
+      #
+      #   Studium.url_for?
+      #
+      # ===================================================================== #
+      @string << "       self.instance_eval { alias "\
+                 "url_for?                          #{@use_this_as_the_toplevel_name_for_the_method} } "\
+                 "# === Studium.url_for?#{N}"
+      # ===================================================================== #
+      # Next add a toplevel method that allows us to query whether the
+      # given input, assumed to be a remote URL, is included in the above
+      # case/when menu interface:
+      # ===================================================================== #
+      @string << N+'  # '+('='*71)+' #'+N
+      @string << '  # === Studium.is_this_url_registered?'+N
+      @string << '  #'+N
+      @string << '  # This method can be used to determine whether a given URL is registered'+N
+      @string << '  # within the Studium-namespace, or whether it is not.'+N
+      @string << '  # '+('='*71)+' #'+N
+      @string << '  def self.is_this_url_registered?(i)'+N
+      @string << '    remote_url = Studium.return_remote_url_of_this_lecture(i)'+N
+      @string << '    !(remote_url == i) # If both are the same, then the URL is NOT registered.'+N
+      @string << '  end'
+    # ======================================================================= #
+    # === :moodle
+    # ======================================================================= #
+    elsif @search_for_this_entry == :moodle
+      @string << "; self.instance_eval { alias "\
+                 "return_remote_moodle_link_of_this_lecture #{@use_this_as_the_toplevel_name_for_the_method} } "\
+                 "# === Studium.return_remote_moodle_link_of_this_lecture"
+    end
+    @string << "#{N}#{N}"
+    @string << 'end' # ← This is the trailing end.
+    return @string
+  end
+
+  # ========================================================================= #
+  # === determine_all_entries_that_include_the_desired_entry
+  # ========================================================================= #
+  def determine_all_entries_that_include_the_desired_entry
+    @dataset.select! {|key, inner_hash|
+      outdated_lecture = inner_hash[:outdated_lecture]
+      # ===================================================================== #
+      # Outdated lectures are ignored since as of April 2022.
+      # ===================================================================== #
+      inner_hash.has_key?(@search_for_this_entry) and !(outdated_lecture == true)
+    }
+  end
+
+  # ========================================================================= #
+  # === simplify_these_discovered_entries
+  #
+  # This method will simplify the @dataset, by keeping track only of
+  # the name of the lecture, and the remote URL to it.
+  # ========================================================================= #
+  def simplify_these_discovered_entries(
+      search_for_this_entry = @search_for_this_entry
+    )
+    _ = {}
+    @dataset.each_pair {|key, inner_hash|
+      _[key] = inner_hash[search_for_this_entry]
+    }
+    @dataset = _
+  end
+
+  # ========================================================================= #
+  # === store
+  #
+  # This method will store the generated string. It only works on is-roebe
+  # systems, though.
+  # ========================================================================= #
+  def store(
+      what,
+      into = @store_into
+    )
+    if is_on_roebe?
+      e "#{rev}Storing into the file `#{sfile(into)}` next."
+      write_what_into(what, into)
+    else
+      e 'We are not on a roebe-system, so we will not automatically'
+      e 'generate any files. We will, however had, display the'
+      e 'autogenerated string on these systems next:'
+      e
+      e slateblue(what)
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    determine_all_entries_that_include_the_desired_entry
+    simplify_these_discovered_entries
+    _ = generate_the_relevant_ruby_code
+    store(_)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::GenerateRegex.new
+end # GenerateRegex

data/lib/studium/utility_scripts/regexes/generate_regexes_for_the_available_moodle_links.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::GenerateRegexesForTheAvailableMoodleLinks
+#
+# The main purpose of this class is to simply generate a regexp-menu
+# from all available moodle-link entries from the file
+# 'lecture_information.yml'.
+#
+# This .rb file can then be used by the Studium-project to open associated
+# Moodle-URLs for the given lecture at hand.
+#
+# Usage example:
+#
+#   Studium::GenerateRegexesForTheAvailableMoodleLinks.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/regexes/generate_regexes_for_the_available_moodle_links.rb'
+# =========================================================================== #
+require 'studium/utility_scripts/regexes/generate_regex.rb'
+
+module Studium
+
+class GenerateRegexesForTheAvailableMoodleLinks < GenerateRegex # === Studium::GenerateRegexesForTheAvailableMoodleLinks
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @search_for_this_entry
+    # ======================================================================= #
+    @search_for_this_entry = :moodle
+    # ======================================================================= #
+    # === @store_into
+    # ======================================================================= #
+    @store_into =
+      "#{RUBY_STUDIUM_HOME_DIR}toplevel_methods/return_remote_moodle_link_of_this_lecture.rb"
+    # ======================================================================= #
+    # === @use_this_as_the_toplevel_name_for_the_method
+    # ======================================================================= #
+    @use_this_as_the_toplevel_name_for_the_method = 'return_remote_moodle_link_of_this_lecture'
+    # ======================================================================= #
+    # === @rf_or_moodle
+    # ======================================================================= #
+    @rf_or_moodle = 'moodle'
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::GenerateRegexesForTheAvailableMoodleLinks.new(ARGV)
+end # generateregexesfortheavailablemoodlelinks

data/lib/studium/utility_scripts/regexes/generate_regexes_for_the_registered_lectures.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::GenerateRegexesForTheRegisteredLectures
+#
+# The main purpose of this class is to simply generate a regexp-menu
+# from all available homepages in the file 'lecture_information.yml'.
+#
+# This .rb file can then be used by the Studium-project to open associated
+# URLs for the given lecture at hand.
+#
+# Usage example:
+#
+#   Studium::GenerateRegexesForTheRegisteredLectures.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/regexes/generate_regexes_for_the_registered_lectures/generate_regexes_for_the_registered_lectures.rb'
+# =========================================================================== #
+require 'studium/utility_scripts/regexes/generate_regex.rb'
+
+module Studium
+
+class GenerateRegexesForTheRegisteredLectures < GenerateRegex # === Studium::GenerateRegexesForTheRegisteredLectures
+
+  alias that_include_a_homepage_entry determine_all_entries_that_include_the_desired_entry # === that_include_a_homepage_entry
+
+  # ========================================================================= #
+  # === Studium::GenerateRegexesForTheRegisteredLecture[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.generate_regexes_for_the_registered_lectures
+# =========================================================================== #
+def self.generate_regexes_for_the_registered_lectures(i = ARGV)
+  Studium::GenerateRegexesForTheRegisteredLectures.new(i)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::GenerateRegexesForTheRegisteredLectures.new(ARGV)
+end # generateregexesfortheregisteredlectures

data/lib/studium/utility_scripts/report_outdated_timetable_entries/report_outdated_timetable_entries.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ReportOutdatedTimetableEntries
+#
+# This class will report which timetable-entries are obsolete.
+#
+# That way obsolete entries can be updated or removed.
+#
+# Usage example:
+#
+#   Studium::ReportOutdatedTimetableEntries.new
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/report_outdated_timetable_entries.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ReportOutdatedTimetableEntries < Base # === Studium::ReportOutdatedTimetabeEntries
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      run_already = true
+    )
+    reset
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    @array_lectures_that_have_an_outdated_entry = []
+    @today = Time.now
+    @dataset = dataset_from_file_lecture_information
+    sanitize_dataset
+  end
+
+  # ========================================================================= #
+  # === sanitize_dataset
+  #
+  # Select only lectures that actually have an exam entry.
+  # ========================================================================= #
+  def sanitize_dataset
+    @dataset.select! {|entry, inner_hash_dataset|
+      exams = inner_hash_dataset['exams']
+      !exams.nil?
+    }
+  end
+
+  # ========================================================================= #
+  # === check_for_outdated_exam_entries
+  # ========================================================================= #
+  def check_for_outdated_exam_entries
+    @dataset.each {|name_of_the_lecture, inner_hash_dataset|
+      exams = inner_hash_dataset['exams']
+      exams.each {|exam_date|
+        exam_date = remove_weekdays(exam_date)
+        if exam_date.include? 'Ort:'
+          exam_date = exam_date[0 .. (exam_date.index('Ort:')-1)]
+        end
+        exam_date.delete!(',')
+        exam_date.strip!
+        original_exam_date = exam_date
+        exam_date = Time.parse(exam_date)
+        if exam_date < @today
+          @array_lectures_that_have_an_outdated_entry << [
+            name_of_the_lecture, original_exam_date
+          ]
+        end
+      }
+    }
+  end
+
+  # ========================================================================= #
+  # === array_lectures_that_have_an_outdated_entry?
+  # ========================================================================= #
+  def array_lectures_that_have_an_outdated_entry?
+    @array_lectures_that_have_an_outdated_entry
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report(
+      i = @array_lectures_that_have_an_outdated_entry
+    )
+    if i.empty?
+      opnn; e 'No outdated entries could be found - all are up '\
+              'to date. '+yellow('\o/')
+    else
+      opnn; e 'The following entries are outdated:'
+      e
+      index = 0
+      i.each {|name_of_the_lecture, outdated_entry| index += 1
+        padded_index = index.to_s.rjust(4)+' '
+        colourized_and_padded_index = orange(padded_index)
+        e '  '+
+          colourized_and_padded_index+
+          slateblue(name_of_the_lecture.ljust(75))+
+          royalblue(outdated_entry)
+      }
+      e
+    end
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    check_for_outdated_exam_entries
+    report
+  end
+
+  # ========================================================================= #
+  # === Studium::ReportOutdatedTimetableEntries[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.report_outdated_timetable_entries
+# =========================================================================== #
+def self.report_outdated_timetable_entries(i = ARGV)
+  ::Studium::ReportOutdatedTimetableEntries.new(i)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ReportOutdatedTimetableEntries.new(ARGV)
+end # reportoutdatedtimetableentries

data/lib/studium/utility_scripts/report_total_amount_of_questions_and_answers_for.rb

@@ -0,0 +1,116 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ReportTotalAmountOfQuestionsAndAnswersFor
+#
+# This class will report how many questions are available for a given
+# topic at hand, and how many answers have already been answered for
+# that particular topic.
+#
+# Usage example:
+#
+#   Studium::ReportTotalAmountOfQuestionsAndAnswersFor.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/report_total_amount_of_questions_and_answers_for.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ReportTotalAmountOfQuestionsAndAnswersFor < ::Studium::Base # Studium::ReportTotalAmountOfQuestionsAndAnswersFor
+
+  require 'studium/exams/exam_question/exam_question.rb'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = [i] unless i.is_a? Array
+    i.flatten!
+    i.compact!
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === iterate_over_the_dataset
+  # ========================================================================= #
+  def iterate_over_the_dataset
+    n_total_questions = 0
+    n_questions_already_answered = 0
+    @input.each {|this_topic|
+      _ = Studium::Exams::ExamQuestion.new(this_topic, :do_not_run)
+      _.initialize_the_dataset
+      n_total_questions += _.n_questions?
+      n_questions_already_answered += _.n_questions_already_answered?.to_i
+    }
+    e rev+
+      'A total of '+
+      seagreen(n_total_questions.to_s)+
+      ' questions are '\
+      'available in these '+
+      lightblue(@input.size.to_s)+' topics '
+    e "(#{sandybrown(@input.join(', ').strip)}) at hand."
+    n_percent_answered = (
+      (n_questions_already_answered * 100.0 ) / n_total_questions).round(2
+    ).to_s
+    e 'Of these,  '+sfancy(n_questions_already_answered.to_s)+' '\
+      'questions were already answered. ('+
+      orchid(n_percent_answered+'% answered')+')'
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    iterate_over_the_dataset
+  end
+
+  # ========================================================================= #
+  # === Studium::ReportTotalAmountOfQuestionsAndAnswersFor[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  _ = ARGV
+  if _.empty? # Use a default assignment in case that we passed no arguments.
+    _ = %w(
+      bem1 bem2 aa meta strukt enz lipids proteomik
+      posttranslationale_modifikation_von_proteinen
+      strukturbiologie
+    ) 
+  end
+  Studium::ReportTotalAmountOfQuestionsAndAnswersFor.new(_)
+end # reporttotalamountofquestionsandanswersfor amg