studium 0.16.9

data/lib/studium/utility_scripts/course_registrations/course_registrations.rb

@@ -0,0 +1,98 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::CourseRegistrations
+#
+# This class will show all registered course registrations.
+#
+# Usage example:
+#
+#   Studium::CourseRegistrations.new
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/course_registrations.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class CourseRegistrations < ::Studium::Base # === Studium::CourseRegistrations
+
+  require 'studium/toplevel_methods/return_remote_homepage_of_this_lecture.rb'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+  end
+
+  # ========================================================================= #
+  # === return_all_courses_with_a_course_registration_time_limit
+  # ========================================================================= #
+  def return_all_courses_with_a_course_registration_time_limit
+    dataset = from_file_lecture_information
+    return dataset.select {|a, b|
+      b.has_key?(:course_registration_time_limit)
+    }
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    selection = return_all_courses_with_a_course_registration_time_limit
+    today = ::Time.now
+    opne 'Trying to display all courses with a registration date today:'
+    selection.each_pair {|a, inner_hash|
+      _ = inner_hash[:course_registration_time_limit]
+      if _.is_a? Array
+        _ = _.first
+      end
+      if _.include? '-'
+        splitted = _.split('-')
+        start_day = ::Time.parse(splitted.first)
+        end_day   = ::Time.parse(splitted.last)
+        # =================================================================== #
+        # today must be larger or equal compared to start day, but smaller
+        # or equal compared to end day.
+        # =================================================================== #
+        if today >= start_day and today <= end_day
+          e steelblue(a)
+          remote_URL = ::Studium.remote_URL_of(a)
+          e '  '+
+            lightgreen(_.to_s)+' '+
+            orange(right_arrow)+' '+
+            sfancy(remote_URL)
+          e
+        end
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === Studium::CourseRegistrations[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::CourseRegistrations.new(ARGV)
+end # courseregistrations

data/lib/studium/utility_scripts/courses/courses.rb

@@ -0,0 +1,177 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Courses
+#
+# This class was created in July 2023. The purpose is to bundle all
+# course-related functionality in general, on the commandline. 
+#
+# Usage example:
+#
+#   Studium::Courses.new
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/courses/courses.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class Courses < ::Studium::Base # === Studium::Courses
+
+  require 'studium/toplevel_methods/return_remote_homepage_of_this_lecture.rb'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = ARGV,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === :dataset
+    # ======================================================================= #
+    @internal_hash[:dataset] = return_dataset_from_file_lecture_information.reject {|a, b|
+      (b[:outdated_lecture] and (b[:outdated_lecture] == true))
+    }
+    # ======================================================================= #
+    # === :show_URL
+    # ======================================================================= #
+    @internal_hash[:show_URL] = false
+  end
+
+  # ========================================================================= #
+  # === set_show_URL
+  # ========================================================================= #
+  def set_show_URL(
+      i = true
+    )
+    @internal_hash[:show_URL] = i
+  end
+
+  # ========================================================================= #
+  # === show_URL?
+  # ========================================================================= #
+  def show_URL?
+    @internal_hash[:show_URL]
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report(
+      i = dataset?,
+      &block
+    )
+    show_URL = show_URL?
+    # ======================================================================= #
+    # === Handle blocks here
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :show_URL
+      # ===================================================================== #
+      when :show_URL
+        show_URL = true
+      end
+    end
+    index = 0
+    i.each {|name_of_the_lecture, inner_hash| index += 1
+      type   = inner_hash[:type]
+      n_ECTS = inner_hash[:ects].to_f
+      e royalblue(index.to_s.rjust(5))+
+        lightgreen(') ')+
+        steelblue(name_of_the_lecture)+
+        steelblue(', '+type.to_s)+
+        royalblue(' ('+n_ECTS.to_s+' ECTS)')
+      if show_URL
+        homepage = inner_hash[:homepage]
+        if homepage.is_a? Array
+          homepage = homepage.first
+        end
+        if homepage.nil? or homepage.empty?
+          opne tomato("No homepage registered for #{name_of_the_lecture}")
+        else
+          e
+          e olivedrab("  → #{homepage}")
+          e
+        end
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ====================================================================== #
+      # === courses --BOKU
+      # ====================================================================== #
+      when /-?-?BOKU/i
+        set_dataset(course_filter(dataset?, :BOKU))
+        set_show_URL
+      # ====================================================================== #
+      # === courses --prüfungsimmanent --BOKU
+      # ====================================================================== #
+      when /-?-?prüfungsimmanent$/i
+        new_dataset = course_filter(dataset?, :prüfungsimmanent)
+        set_dataset(new_dataset)
+        set_show_URL
+      # ====================================================================== #
+      # === courses --prüfungsimmanent --BOKU --winter
+      # ====================================================================== #
+      when /-?-?winter$/i
+        new_dataset = course_filter(dataset?, :winter)
+        set_dataset(new_dataset)
+        set_show_URL
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    menu
+    report
+  end
+
+  # ========================================================================= #
+  # === set_dataset
+  # ========================================================================= #
+  def set_dataset(i)
+    @internal_hash[:dataset] = i
+  end
+
+  # ========================================================================= #
+  # === Studium::Courses[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Courses.new(ARGV)
+end # courses

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

@@ -0,0 +1,2 @@
+This directory will keep classes that can be used to create (generate)
+files, such as local webpages.

data/lib/studium/utility_scripts/create/webpage_of_university.rb

@@ -0,0 +1,129 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Create::WebpageOfUniversity
+# =========================================================================== #
+# require 'studium/utility_scripts/create/webpage_of_university.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Create
+
+class WebpageOfUniversity < Studium::Base # === Studium::Create::WebpageOfUniversity
+
+  begin
+    require 'cyberweb/requires/require_the_html_template.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === FONT_SIZE_TO_USE
+  # ========================================================================= #
+  FONT_SIZE_TO_USE = '1.7em'
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = dataset_from_the_file_lecture_information
+    # ======================================================================= #
+    # === @into
+    # ======================================================================= #
+    @into = "#{log_dir?}all_webpages_at_the_university_TU.html"
+  end
+
+  # ========================================================================= #
+  # === append_onto_the_content_for_the_webpage
+  # ========================================================================= #
+  def append_onto_the_content_for_the_webpage
+    _ = ''.dup
+    sorted = sort_this_dataset(@dataset)
+    sorted.each {|name_of_the_lecture, hash|
+      homepage = hash[:homepage]
+      homepage = homepage.first.to_s if homepage.is_a? Array
+      is_outdated = hash[:outdated_lecture]
+      lecture_type = hash[:type]
+      # ===================================================================== #
+      # Next build up our content-string:
+      # ===================================================================== #
+      content_string = "<span style=\"font-weight: 600; margin-left:2em\">#{name_of_the_lecture}</span>".dup
+      content_string << ", <b>#{lecture_type}</b>"
+      sommer_or_winter = hash[:semester]
+      case sommer_or_winter.to_s
+      when 'winter'
+        sommer_or_winter = 'Winter'
+      when 'sommer','summer'
+        sommer_or_winter = 'Summer'
+      when 'both'
+        sommer_or_winter = 'Summer / Winter'
+      end
+      content_string << " <b>#{sommer_or_winter.to_s}</b>"
+      n_ECTS = hash[:ects]
+      content_string << ", <b>#{n_ECTS} ECTS</b>"
+      is_solved = hash[:already_solved]
+      if is_solved
+        content_string << '<img src="../../../../programming/ruby/src/studium/lib/studium/images/small_logos/solved.png">'
+      end
+      if is_outdated
+        content_string << '<img src="../../../../data/images/STD/outdated.png">'
+      end
+      _ << HtmlTags.a(homepage,
+        content: "#{content_string}<br>\n"
+      )
+    }
+    @content_for_the_webpage = _
+    return @content_for_the_webpage
+  end
+
+  # ========================================================================= #
+  # === select_all_correct_university_entries
+  # ========================================================================= #
+  def select_all_correct_university_entries(
+      i = :TU_Vienna
+    )
+    @dataset.select! {|key, hash|
+      university = hash[:university]
+      university.to_sym == i.to_s.
+                           tr('_',' ').to_sym
+    }
+  end
+
+  # ========================================================================= #
+  # === sort_this_dataset
+  # ========================================================================= #
+  def sort_this_dataset(
+      i = @dataset
+    )
+    sorted = i.sort_by {|a, b|
+      if a =~ /^\d{1,10}/ # If starts-with-a-number
+        if a.include? ' '
+          splitted = a.split(' ')
+          splitted.shift
+          work_on_these = splitted.join(' ').strip
+          a = work_on_these
+        end
+      end
+      a
+    }
+    return sorted
+  end
+
+  # ========================================================================= #
+  # === populate_the_html_template
+  # ========================================================================= #
+  def populate_the_html_template
+    @html_template = Cyberweb.rendered_template(
+      content: @content_for_the_webpage,
+      css_class: 'mars1em',
+      title: 'Lectures at the university',
+      body_css_style: 'font-size: '+FONT_SIZE_TO_USE+';'
+    )
+  end
+
+end; end; end

data/lib/studium/utility_scripts/create/webpage_of_university_BOKU.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Create::WebpageOfUniversityBOKU
+# =========================================================================== #
+require 'studium/utility_scripts/create/webpage_of_university.rb'
+
+module Studium
+
+module Create
+
+class WebpageOfUniversityBOKU < WebpageOfUniversity # === Studium::Create::WebpageOfUniversityBOKU
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = ARGV,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    @into = log_dir?+'all_webpages_at_the_university_BOKU.html'
+  end
+
+  # ========================================================================= #
+  # === do_create_the_local_webpage                              (create tag)
+  # ========================================================================= #
+  def do_create_the_local_webpage
+    append_onto_the_content_for_the_webpage
+    populate_the_html_template
+    opne "Storing into "+sfile(@into)+" next."
+    write_what_into(@html_template.html_string?, @into)
+    if is_on_roebe? and File.exist?(@into)
+      open_in_browser(@into)
+    end
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= # 
+  def run
+    select_all_correct_university_entries(:BOKU)
+    do_create_the_local_webpage
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Create::WebpageOfUniversityBOKU.new(ARGV)
+end # WebpageOfUniversityBOKU

data/lib/studium/utility_scripts/create/webpage_of_university_TU.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Create::WebpageOfUniversityTU
+# =========================================================================== #
+require 'studium/utility_scripts/create/webpage_of_university.rb'
+
+module Studium
+
+module Create
+
+class WebpageOfUniversityTU < WebpageOfUniversity # === Studium::Create::WebpageOfUniversityTU
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = ARGV,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+  end
+
+  # ========================================================================= #
+  # === do_create_the_local_webpage                              (create tag)
+  # ========================================================================= #
+  def do_create_the_local_webpage
+    append_onto_the_content_for_the_webpage
+    populate_the_html_template
+    opne "Storing into "+sfile(@into)+" next."
+    write_what_into(@html_template.html_string?, @into)
+    if is_on_roebe? and File.exist?(@into)
+      open_in_browser(@into)
+    end
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= # 
+  def run
+    select_all_correct_university_entries(:TU_Vienna)
+    do_create_the_local_webpage
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Create::WebpageOfUniversityTU.new(ARGV)
+end # webpageofuniversitytu

data/lib/studium/utility_scripts/create/webpage_of_university_UniWien.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Create::WebpageOfUniversityUniWien
+# =========================================================================== #
+require 'studium/utility_scripts/create/webpage_of_university.rb'
+
+module Studium
+
+module Create
+
+class WebpageOfUniversityUniWien < WebpageOfUniversity # === Studium::Create::WebpageOfUniversityUniWien
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = ARGV,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+  end
+
+  # ========================================================================= #
+  # === do_create_the_local_webpage                              (create tag)
+  # ========================================================================= #
+  def do_create_the_local_webpage
+    append_onto_the_content_for_the_webpage
+    populate_the_html_template
+    opne "Storing into "+sfile(@into)+" next."
+    write_what_into(@html_template.html_string?, @into)
+    if is_on_roebe? and File.exist?(@into)
+      open_in_browser(@into)
+    end
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= # 
+  def run
+    select_all_correct_university_entries('Uni Wien')
+    do_create_the_local_webpage
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Create::WebpageOfUniversityUniWien.new(ARGV)
+end # WebpageOfUniversityUniWien