studium 0.16.9

data/lib/studium/parsers/parse_remote_lecture.rb

@@ -0,0 +1,331 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ParseRemoteLecture
+#
+# This class can analyse a remote lecture/course.
+#
+# Usage example:
+#
+#   Studium::ParseRemoteLecture.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/parsers/parse_remote_lecture.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ParseRemoteLecture < ::Studium::Base # === Studium::ParseRemoteLecture
+
+  require 'open-uri'
+
+  # ========================================================================= #
+  # === Studium::ParseRemoteLecture::REMOTE_URL_AT_THE_MEDUNI_VIENNA
+  # ========================================================================= #
+  REMOTE_URL_AT_THE_MEDUNI_VIENNA =
+    'https://campus.meduniwien.ac.at/med.campus/wbLv.wbShowLVDetail?pStpSpNr='
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    case i
+    # ======================================================================= #
+    # === :do_not_run_yet
+    # ======================================================================= #
+    when :do_not_run_yet
+      run_already = false
+    end
+    case run_already
+    # ======================================================================= #
+    # === :do_not_run_yet
+    # ======================================================================= #
+    when :do_not_run_yet
+      run_already = false
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @internal_hash
+    # ======================================================================= #
+    reset_the_internal_hash
+  end
+
+  # ========================================================================= #
+  # === summer_or_winter
+  #
+  # This method will determine whether the lecture is held in the summer or
+  # in the winter term.
+  # ========================================================================= #
+  def summer_or_winter(
+      i = '22S'
+    )
+    if i
+      last_char = i[-1, 1]
+      if i.include? 'semester ' # In this case we assume something like
+                                # "Sommersemester 2022 - wird nicht angeboten".
+        case i
+        when /Sommer/
+          :summer
+        when /Winter/
+          :winter
+        else
+          e 'Unhandled case: '+steelblue(i)
+        end
+      else
+        case last_char
+        when 'S'
+          :summer
+        when 'W'
+          :winter
+        else
+          e 'Unhandled case: '+steelblue(last_char)
+        end
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === report_that_this_course_does_not_exist
+  # ========================================================================= #
+  def report_that_this_course_does_not_exist
+    e tomato('This course does not exist.')
+  end
+
+  # ========================================================================= #
+  # === semester?
+  # ========================================================================= #
+  def semester?
+    @internal_hash[:semester]
+  end
+
+  # ========================================================================= #
+  # === semester_short_letter?
+  # ========================================================================= #
+  def semester_short_letter?
+    _ = semester?
+    case _
+    when /winter/i
+      'W'
+    when /summer/i
+      'S'
+    end
+  end
+
+  # ========================================================================= #
+  # === sws?
+  # ========================================================================= #
+  def sws?
+    @internal_hash[:sws]
+  end; alias n_sws? sws? # === n_sws?
+
+  # ========================================================================= #
+  # === lecture_id?
+  # ========================================================================= #
+  def lecture_id?
+    @internal_hash[:lecture_id]
+  end; alias course_id? lecture_id? # === course_id?
+
+  # ========================================================================= #
+  # === type?
+  # ========================================================================= #
+  def type?
+    @internal_hash[:type]
+  end
+
+  # ========================================================================= #
+  # === homepage?
+  # ========================================================================= #
+  def homepage?
+    @internal_hash[:homepage]
+  end
+
+  # ========================================================================= #
+  # === ects?
+  # ========================================================================= #
+  def ects?
+    @internal_hash[:ects]
+  end; alias n_ects? ects? # === n_ects?
+
+  # ========================================================================= #
+  # === lecture_name?
+  # ========================================================================= #
+  def lecture_name?
+    @internal_hash[:lecture_name]
+  end; alias name_of_the_lecture? lecture_name? # === name_of_the_lecture?
+
+  # ========================================================================= #
+  # === is_the_remote_homepage_available?
+  # ========================================================================= #
+  def is_the_remote_homepage_available?
+    !@remote_dataset.include?('Auf Grund eines Fehlers kann di')
+  end
+
+  # ========================================================================= #
+  # === obtain_the_remote_dataset
+  # ========================================================================= #
+  def obtain_the_remote_dataset(
+      from_this_URL = first_argument?
+    )
+    use_this_assembled_URL = from_this_URL.dup
+    unless use_this_assembled_URL.include? 'http'
+      use_this_assembled_URL.prepend(REMOTE_URL_AT_THE_MEDUNI_VIENNA)
+    end
+    @remote_dataset = URI.open(use_this_assembled_URL).read
+  end
+
+  # ========================================================================= #
+  # === remote_dataset?
+  # ========================================================================= #
+  def remote_dataset?
+    @remote_dataset
+  end
+
+  # ========================================================================= #
+  # === parse_this_result
+  # ========================================================================= #
+  def parse_this_result(i = @remote_dataset)
+    if i.include? 'Auf Grund eines Fehlers kann di'
+      e "Not registered and not available: #{steelblue(i)}"
+      report_that_this_course_does_not_exist
+      exit
+    end
+    i =~ /class="pageOwner"><span class="s">(.+)<\/span><\/td>/
+    result = $1.to_s.dup
+    # ======================================================================= #
+    # resut may now look like this:
+    #
+    #   "520.901 22S 1SSt VO Pharmakokinetik und Pharmakodynamik ausgewählter Zytostatika - Ansätze zur Therapieoptimierung"
+    #
+    # ======================================================================= #
+    splitted = result.split(' ')
+    @internal_hash[:lecture_id] = splitted.first
+    @internal_hash[:semester]   = summer_or_winter(splitted[1])
+    @internal_hash[:type]         = splitted[3]
+    @internal_hash[:lecture_name] = splitted[4 .. -1].join(' ').strip
+    # Next, parse the number of ECTS:
+    # <td class=" MaskRenderer">Freie Wahllehrveranstaltung: <span class="bold">1</span> ECTS-Credits</td></tr>
+    if i.include? 'ECTS-Credits'
+      i =~ /<span class="bold">(\d+)<\/span> ECTS-Credits<\/td><\/tr>/
+      @internal_hash[:ects] = $1.to_f
+    end
+    if i.include? 'Semesterstunden</label>'
+      i =~ /Semesterstunden<\/label><\/td><td colspan="0" class=" MaskRenderer top"><table class=" MaskSpacing">
+<tr>
+<td class=" MaskRenderer"><span class="bold ">(\d{1,2})<\/span><\/td>/
+      @internal_hash[:sws] = $1.to_f
+    end
+    @internal_hash[:homepage] = first_argument?
+  end
+
+  # ========================================================================= #
+  # === report
+  # ========================================================================= #
+  def report
+    pp @internal_hash
+    e
+    e 'The corresponding structure for the file called '\
+      'lecture_information.yml would look like this:'
+    e
+    e steelblue(return_the_copy_paste_format_for_the_file_lecture_information_yml)
+  end
+
+  # ========================================================================= #
+  # === return_the_copy_paste_format_for_the_file_lecture_information_yml
+  #
+  # This method will hold the dataset that can be used for the main
+  # yaml format.
+  # ========================================================================= #
+  def return_the_copy_paste_format_for_the_file_lecture_information_yml
+    copy_paste_this = <<-EOF
+"#{course_id?} #{name_of_the_lecture?}":
+ !ruby/symbol ects: #{n_ects?}
+ !ruby/symbol sws:  #{n_sws?}
+ !ruby/symbol university: Meduni
+ !ruby/symbol language: german
+ !ruby/symbol type: #{type?}
+ !ruby/symbol semester: #{semester?}
+ !ruby/symbol priority: 3
+ !ruby/symbol already_solved: false
+ !ruby/symbol currently_participating_in_this_course: false
+ !ruby/symbol homepage:
+ - #{homepage?} # #{current_year?}#{semester_short_letter?}
+ lecturers:
+ - 
+ themes:
+ - 
+ curricula:
+ - '' # Keine Zuordnung.
+EOF
+    return copy_paste_this
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    obtain_the_remote_dataset
+    if is_the_remote_homepage_available?
+      parse_this_result(@remote_dataset)
+      report
+    else
+      report_that_this_course_does_not_exist
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium::ParseRemoteLecture[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.parse_remote_lectures_via_batch_mode
+# =========================================================================== #
+def self.parse_remote_lectures_via_batch_mode(
+    start_position = 345_300, # 344_775
+    end_position   = 666_666
+  )
+  parse_remote_lecture = Studium::ParseRemoteLecture.new(:do_not_run_yet)
+  (start_position .. end_position).to_a.each {|entry|
+    entry = Studium::ParseRemoteLecture::REMOTE_URL_AT_THE_MEDUNI_VIENNA+
+            entry.to_s
+    e 'Working on the URL: '+
+      ::Studium.steelblue(entry.to_s)
+    parse_remote_lecture.set_first_argument(entry)
+    parse_remote_lecture.obtain_the_remote_dataset
+    if parse_remote_lecture.is_the_remote_homepage_available?
+      parse_remote_lecture.parse_this_result
+      store_this = parse_remote_lecture.return_the_copy_paste_format_for_the_file_lecture_information_yml
+      e store_this
+      e 'Also storing into the file '+sfile('big_fat_yaml_file.yml')
+      append_what_into(
+        store_this+"\n", 'big_fat_yaml_file.yml'
+      )
+    end
+    sleep 3
+  }
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ParseRemoteLecture.new(ARGV)
+end # parseremotelecture https://campus.meduniwien.ac.at/med.campus/wbLv.wbShowLVDetail?pStpSpNr=344761
+    # parseremotelecture https://ufind.univie.ac.at/de/course.html?lv=301463&semester=2023S

data/lib/studium/project/project.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file here does not depend on any other file, so you can safely
+# require it.
+# =========================================================================== #
+# require 'studium/project/project.rb'
+# =========================================================================== #
+module Studium
+
+  # ========================================================================= #
+  # === Studium.project_base_dir?
+  # ========================================================================= #
+  def self.project_base_dir?
+    File.absolute_path("#{__dir__}/..")+'/'
+  end; self.instance_eval { alias project_base_directory? project_base_dir? } # === Studium.project_base_directory?
+
+  # ========================================================================= #
+  # === PROJECT_YAML_DIRECTORY
+  #
+  # The yaml directory of the exams subcomponent of the studium project
+  # comes next. For this to work, we must pull in the file where
+  # the constant PROJECT_BASE_DIRECTORY is defined. See the top-level
+  # require for this.
+  #
+  # In June 2023 this constant was deprecated.
+  # ========================================================================= #
+  # PROJECT_YAML_DIRECTORY = "#{project_base_dir?}yaml/"
+
+  # ========================================================================= #
+  # === Studium.project_yaml_dir?
+  #
+  # This is the preferred way to query the content of the above constant.
+  #
+  # Please make use of it.
+  # ========================================================================= #
+  def self.project_yaml_dir?
+    "#{::Studium.project_base_dir?}yaml/"
+  end; self.instance_eval { alias project_yaml_directory? project_yaml_dir? } # === Studium.project_yaml_directory?
+       self.instance_eval { alias yaml_directory?         project_yaml_dir? } # === Studium.yaml_directory?
+       self.instance_eval { alias yaml_dir?               project_yaml_dir? } # === Studium.yaml_dir?
+
+  # ========================================================================= #
+  # === PROJECT_CURRICULA_YAML_DIRECTORY
+  #
+  # Specify where we keep curricula in this project.
+  # ========================================================================= #
+  # PROJECT_CURRICULA_YAML_DIRECTORY = "#{PROJECT_YAML_DIRECTORY}curricula/"
+
+  # ========================================================================= #
+  # === Studium.project_curricula_yaml_directory
+  # ========================================================================= #
+  def self.project_curricula_yaml_directory
+    "#{::Studium.project_yaml_dir?}curricula/"
+  end; self.instance_eval { alias project_curricula_yaml_directory? project_curricula_yaml_directory } # === Studium.project_curricula_yaml_directory?
+
+  # ========================================================================= #
+  # === Studium::Exams
+  #
+  # The Exams submodule has its own PROJECT_BASE_DIRECTORY constant.
+  # ========================================================================= #
+  module Exams # === Studium::Exams
+
+    # ======================================================================= #
+    # === Studium::Exams::PROJECT_BASE_DIRECTORY
+    # ======================================================================= #
+    PROJECT_BASE_DIRECTORY = "#{::Studium.project_base_directory?}exams/"
+
+    # ======================================================================= #
+    # === Studium::Exams.project_base_dir?
+    #
+    # Prefer to use this method if you need to find out the project base
+    # directory.
+    # ======================================================================= #
+    def self.project_base_dir?
+      ::Studium.project_base_dir?
+    end
+
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  e Studium.project_base_directory?
+  e Studium::Exams::PROJECT_BASE_DIRECTORY
+end # studiumproject

data/lib/studium/requires/common_popular_requires.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file shall not have project-internal requires, except for the file
+# called common_external_requires.rb, which merely pulls in two other
+# external .rb files.
+#
+# Only use "common external requires" here for this file. 
+# =========================================================================== #
+# require 'studium/requires/common_popular_requires.rb'
+# =========================================================================== #
+begin
+  require 'open-uri'
+rescue LoadError; end
+
+begin
+  require 'opn'
+rescue LoadError; end
+
+begin
+  require 'cliner'
+rescue LoadError; end
+
+begin
+  require 'xorg_buffer/module'
+rescue LoadError; end
+
+begin
+  require 'beautiful_url'
+rescue LoadError; end
+
+begin
+  require 'percentage'
+rescue LoadError; end
+
+require 'studium/requires/commonly_used_requires.rb'

data/lib/studium/requires/commonly_used_requires.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file will contain "commonly used requires", such as yaml,
+# or colours-specific code.
+# =========================================================================== #
+# require 'studium/requires/commonly_used_requires.rb'
+# =========================================================================== #
+require 'studium/requires/require_yaml.rb'
+
+begin
+  require 'colours/e/e.rb'
+rescue LoadError; end

data/lib/studium/requires/require_class_exams_solved.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/requires/require_class_exams_solved.rb'
+# =========================================================================== #
+require 'studium/exams/solved/solved.rb'

data/lib/studium/requires/require_ects_scripts.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/requires/require_ects_scripts.rb'
+# Studium.require_ects_scripts
+# =========================================================================== #
+module Studium
+
+  require 'studium/project/project.rb'
+
+  # ========================================================================= #
+  # === Studium.require_ects_scripts
+  #
+  # These files reside under studium/ects/.
+  # ========================================================================= #
+  def self.require_ects_scripts
+    _ = "#{project_base_dir?}ects/"
+    Dir["#{_}*.rb"].each {|file|
+      file = "studium/ects/#{File.basename(file)}"
+      require file
+    }
+    require 'studium/ects/solved_ects/solved_ects.rb'
+    require 'studium/ects/solved_ects_per_university/solved_ects_per_university.rb'
+  end
+
+end

data/lib/studium/requires/require_encoding.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/requires/require_encoding.rb'
+# =========================================================================== #
+require 'studium/encoding/encoding.rb'

data/lib/studium/requires/require_the_check_and_sanitize_files.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/requires/require_the_check_and_sanitize_files.rb'
+# Studium.require_the_check_and_sanitize_files
+# =========================================================================== #
+module Studium
+
+  require 'studium/project/project.rb'
+
+  # ========================================================================= #
+  # === Studium.require_the_check_and_sanitize_files
+  #
+  # Load up the module-method files, all of them. This has to be called
+  # manually, as-is.
+  # ========================================================================= #
+  def self.require_the_check_and_sanitize_files
+    name = 'check_and_sanitize/'
+    _ = "#{Studium.project_base_dir?}#{name}"
+    Dir["#{_}*.rb"].each {|file|
+      file = "studium/#{name}#{File.basename(file)}"
+      require file
+    }
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium.require_the_check_and_sanitize_files  
+end

data/lib/studium/requires/require_the_curricula_files.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/requires/require_the_curricula_files.rb'
+# Studium.require_the_curricula_files
+# =========================================================================== #
+module Studium
+
+  require 'studium/project/project.rb'
+
+  # ========================================================================= #
+  # === Studium.require_the_curricula_files
+  # ========================================================================= #
+  def self.require_the_curricula_files
+    _ = "#{Studium.project_base_dir?}curricula/"
+    Dir["#{_}*.rb"].each {|file|
+      file = "studium/curricula/#{File.basename(file)}"
+      require file
+    }
+    require 'studium/curricula/curriculum_module_displayer/curriculum_module_displayer.rb'
+    require 'studium/curricula/determine_curricula/determine_curricula.rb'
+    require 'studium/curricula/mitteilungsblätter/mitteilungsblätter.rb'
+    require 'studium/curricula/random_curriculum_creator/random_curriculum_creator.rb'
+    require 'studium/curricula/show_lectures_of_this_curriculum_id/show_lectures_of_this_curriculum_id.rb'
+  end
+
+end

data/lib/studium/requires/require_the_exam_question_class.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/requires/require_the_exam_question_class.rb'
+# =========================================================================== #
+require 'studium/exams/exam_question/exam_question.rb'

data/lib/studium/requires/require_the_exams_files.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/requires/require_the_exam_scripts.rb'
+# Studium.require_the_exam_scripts
+# =========================================================================== #
+module Studium
+
+  require 'studium/project/project.rb'
+
+  # ========================================================================= #
+  # === Studium.require_the_exams_files
+  #
+  # We will load all .rb files from the studium/exams/ subdirectory here.
+  # ========================================================================= #
+  def self.require_the_exams_files
+    _ = "#{Studium.project_base_dir?}exams/"
+    Dir["#{_}*.rb"].each {|file|
+      file = "studium/exams/#{File.basename(file)}"
+      require file
+    }
+    # require 'studium/exams/remote_ftp_url.rb'
+    require 'studium/requires/require_class_exams_solved.rb'
+    require 'studium/exams/exam_question/exam_question.rb'
+    require 'studium/exams/move_the_last_exam_question_to_the_top_of_the_file/move_the_last_exam_question_to_the_top_of_the_file.rb'
+    # ======================================================================= #
+    # And pull in the mandatory_continuous_assessment code as well.
+    # ======================================================================= #
+    require 'studium/exams/exam_registration_at/exam_registration_at.rb'
+    require 'studium/exams/mandatory_continuous_assessment/mandatory_continuous_assessment.rb'
+    require 'studium/exams/show_upcoming_exams/show_upcoming_exams.rb'
+    require 'studium/exams/designate_ten_random_exam_topics/designate_ten_random_exam_topics.rb'
+    require 'studium/exams/upcoming_exams/upcoming_exams.rb'
+    require 'studium/exams/questions_solved_from_day_to_day/questions_solved_from_day_to_day.rb'
+    require 'studium/exams/afterburn/afterburn.rb'
+    # ======================================================================= #
+    # And Studium::ExamsPerMonth next:
+    # ======================================================================= #
+    require 'studium/exams/exams_per_month/exams_per_month.rb'
+    require 'studium/exams/csv/create_csv_passed_exams_file.rb'
+    require 'studium/exams/exam/exam.rb'
+    require 'studium/exams/average_grade/average_grade.rb'
+  end
+
+end

data/lib/studium/requires/require_the_logging_files.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/requires/require_the_logging_files.rb'
+# Studium.require_the_logging_files
+# =========================================================================== #
+module Studium
+
+  require 'studium/project/project.rb'
+
+  # ========================================================================= #
+  # === Studium.require_the_logging_files
+  # ========================================================================= #
+  def self.require_the_logging_files
+    _ = "#{Studium.project_base_dir?}logging/"
+    Dir["#{_}*.rb"].each {|file|
+      file = "studium/logging/#{File.basename(file)}"
+      require file
+    }
+  end
+
+end