studium 0.18.7

data/lib/studium/utility_scripts/wochenplanung/wochenplanung.rb

@@ -0,0 +1,267 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Wochenplanung
+#
+# This class will tell us which lectures or other courses are on each day.
+#
+# Usage example:
+#
+#   Studium::Wochenplanung.new
+#
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium # === Studium
+
+class Wochenplanung < ::Studium::Base # === Studium::Wochenplanung
+
+  # ========================================================================= #
+  # === GENERATE_SPREADSHEET
+  # ========================================================================= #
+  GENERATE_SPREADSHEET = false
+
+  # ========================================================================= #
+  # === USE_THIS_REGEX
+  # ========================================================================= #
+  USE_THIS_REGEX = /(\d\d:\d\d-\d\d:\d\d)/
+
+  # ========================================================================= #
+  # === SHALL_WE_DEBUG
+  # ========================================================================= #
+  SHALL_WE_DEBUG = false # Whether to debug or whether we won't.
+
+  # ========================================================================= #
+  # === WOCHENTAGE_DIRECTORY
+  # ========================================================================= #
+  WOCHENTAGE_DIRECTORY = "#{::Studium.yaml_directory?}week/"
+
+  # ========================================================================= #
+  # === ALL_WEEKDAYS
+  # ========================================================================= #
+  ALL_WEEKDAYS = Dir[WOCHENTAGE_DIRECTORY+'*.yml'].select {|entry|
+    modified_entry = File.basename(entry).delete_suffix('.yml')
+    if modified_entry.include?('_')
+      modified_entry = modified_entry.split('_').last
+    end
+    Studium.array_english_weekdays?.include?(modified_entry.capitalize)
+  }
+
+  # ========================================================================= #
+  # === Determine whether we can use spreadsheets
+  # ========================================================================= # 
+  begin
+    require 'spreadsheet'
+    CAN_USE_SPREADSHEET = true
+  rescue LoadError
+    CAN_USE_SPREADSHEET = false
+  end
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    set_input
+    infer_the_namespace
+    # ======================================================================= #
+    # === @hash_wochentage
+    # ======================================================================= #
+    @hash_wochentage = {}
+    try_to_require_the_open_gem
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup # We want a String.
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === load_weekdays
+  # ========================================================================= #
+  def load_weekdays
+    ALL_WEEKDAYS.each {|location|
+      name_of_the_weekday = File.basename(location).gsub(/\.yml$/,'')
+      begin
+        dataset = YAML.load_file(location)
+      rescue ArgumentError => error
+        opne 'The file at `'+sfile(location)+'` has a syntax error.'
+        pp error
+      end
+      # ===================================================================== #
+      # Here we will add the different weekdays into our @hash_wochentage.
+      # ===================================================================== #
+      @hash_wochentage[name_of_the_weekday] = dataset
+    }
+  end
+
+  # ========================================================================= #
+  # === available_weekdays
+  # ========================================================================= #
+  def available_weekdays
+    Studium.available_weekdays
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    load_weekdays
+    colour = :steelblue # We use this colour for now.
+    the_days = Studium::GERMAN_WEEK_NAMES.reject {|key, value| value == 'Sonntag' }
+    cliner # Initial cliner.
+pp input?
+    if available_weekdays.include? input? # This is the case when the user did input e. g. "dienstag".
+      the_days = the_days.select {|key, value|
+        value.downcase == input?
+      }
+    end
+    the_days.each_value {|week_day|
+      downcased = week_day.downcase
+      colourized_weekday = ::Colours.send(colour, week_day+':')
+      e colourized_weekday
+      e
+      if @hash_wochentage.has_key?(downcased)
+        dataset = @hash_wochentage[downcased]
+        # =================================================================== #
+        # Next, we must sort it based on the key.
+        # =================================================================== #
+        if dataset # Will be false if we have no date there.
+          dataset = Hash[dataset.sort_by {|key, value| Time.parse(key) }]
+          pp dataset if SHALL_WE_DEBUG
+          dataset.each_pair {|datum, course|
+            result = '  '+crimson(datum)+' -> '
+            # =============================================================== #
+            # First, handle Arrays for the given day.
+            # =============================================================== #
+            if course.is_a? Array
+              course.map! {|entry|
+                # =========================================================== #
+                # Colourize "Prüfung" in darkred.
+                # =========================================================== #
+                if entry.include? 'Prüfung'
+                  entry.gsub!(/(Prüfung)/, darkred('\1'))
+                end
+                # =========================================================== #
+                # Next, assume that we handle a specific time of the given
+                # day.
+                # =========================================================== #
+                if entry.count(':') > 1 and entry.include? '-'
+                  entry =~ USE_THIS_REGEX
+                  entry.gsub!(USE_THIS_REGEX, lightgreen('\1'))
+                end
+                entry
+              }
+              course.each_with_index {|entry, index| # Padded.
+                result << N+'                ' unless index == 0
+                result << slateblue(entry)
+              }
+            else
+              # =============================================================== #
+              # Next add the course, but first check if the course has "Uhrzeit"
+              # information. If so then we will colourize it.
+              # =============================================================== #
+              if course.count(':') > 1 and course.include? '-'
+                course =~ USE_THIS_REGEX
+                course.gsub!(USE_THIS_REGEX, lightgreen('\1'))
+              end
+              result << slateblue(course)
+            end
+            if datum == today? # Is today! Colourize in red.
+              result.prepend(red('TODAY '))
+            end
+            e result
+          }
+        end
+        cliner
+      end
+    }
+    consider_generating_spreadsheet_file
+  end
+
+  # ========================================================================= #
+  # === today?
+  # ========================================================================= #
+  def today?
+    Studium.today?
+  end
+
+  # ========================================================================= #
+  # === can_use_spreadsheet?
+  # ========================================================================= #
+  def can_use_spreadsheet?
+    CAN_USE_SPREADSHEET
+  end
+
+  # ========================================================================= #
+  # === consider_generating_spreadsheet_file
+  # ========================================================================= #
+  def consider_generating_spreadsheet_file
+    if can_use_spreadsheet? and GENERATE_SPREADSHEET
+      store_here = '/Wochenplanung_'+Studium.today?+'.xls'
+      # Create the rows to be inserted
+      the_weekdays = ['']+Studium.wochentage?
+      opn; e 'Next generating a spreadsheet file at `'+sfile(store_here)+'`.'
+      Spreadsheet.client_encoding = ::Studium.main_encoding?
+      book = Spreadsheet::Workbook.new
+      # Create the worksheet
+      book.create_worksheet name: 'Wochenplanung'
+      sheet = book.worksheet(0)
+      sheet.insert_row(1, the_weekdays)
+      format = Spreadsheet::Format.new :color => :green,
+                                       :weight => :bold,
+                                       :size => 13
+      sheet.row(1).default_format = format
+      sheet.insert_row(2, ['Uhrzeit'])
+      sheet.row(2).default_format = Spreadsheet::Format.new(
+        weight: :bold,
+        size:   11
+      )
+      sheet.insert_row( 4, ['08:00-09:00'])
+      sheet.insert_row( 5, ['09:00-10:00'])
+      sheet.insert_row( 6, ['10:00-11:00'])
+      sheet.insert_row( 7, ['11:00-12:00'])
+      sheet.insert_row( 8, ['12:00-13:00'])
+      sheet.insert_row( 9, ['13:00-14:00'])
+      sheet.insert_row(10, ['14:00-15:00'])
+      sheet.insert_row(11, ['15:00-16:00'])
+      sheet.insert_row(12, ['16:00-17:00'])
+      book.write(store_here)
+      # ===================================================================== #
+      # === Tap into class Open next
+      # ===================================================================== #
+      if Object.const_defined? :Open
+        Open.in_editor(store_here) if Open.respond_to? :in_editor
+      end
+    end
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Wochenplanung.new(ARGV)
+end # wochenplanung

data/lib/studium/version/version.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/version/version.rb'
+# =========================================================================== #
+module Studium
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '0.18.7'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  #
+  # The following constant denotes when this project has last been updated.
+  #
+  # Note that this constant is not very frequently updated, though, so
+  # consider this more as a general cue than something that is extremely
+  # reliable. I will, however had, update this every now and then.
+  #
+  # The format is: dd.mm.yyyy
+  # ========================================================================= #
+  LAST_UPDATE = '20.03.2024'
+
+  # ========================================================================= #
+  # === Studium.return_version_and_last_update
+  #
+  # This method will return a longer String that includes the current
+  # version, and when the project was last updated. This can then,
+  # in turn, be used by other methods if you quickly wish to show
+  # both information, such as when issuing the command
+  # "studium --version?".
+  # ========================================================================= #
+  def self.return_version_and_last_update
+    "#{VERSION} (Last update: #{LAST_UPDATE})"
+  end
+
+  # ========================================================================= #
+  # === Studium::URL_TO_THE_DOCUMENTATION
+  # ========================================================================= #
+  URL_TO_THE_DOCUMENTATION =
+    "https://www.rubydoc.info/gems/#{self.to_s.downcase}/#{VERSION}"
+
+end

data/lib/studium/www/exams/exams.cgi

@@ -0,0 +1,54 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# http://localhost/programming/ruby/src/studium/lib/studium/www/exams/exams.cgi
+# =========================================================================== #
+require 'cyberweb/autoinclude'
+require 'studium'
+
+BACKGROUND_COLOUR = 'background-color: #b4b0ac;'
+
+english('Upcoming exams') {
+default_template '
+#answer_div {
+  padding: 2em;
+  margin-left: 1em;
+  visibility: hidden;
+  border: 3px solid black;
+  width: 82%;
+  '+BACKGROUND_COLOUR+'
+}
+'
+ruby_favicon
+body_css_class 's10px padt4px marpad2px VERDANAs'
+body_css_style BACKGROUND_COLOUR
+default_font_size_and_hyperlinks
+
+javascript_reveal_this_id_after_n_seconds(
+  'answer_div',
+  Studium.delay_for_exam_questions?,
+  'reveal_the_answer()'
+)
+
+Studium.enable_www_mode
+Studium.disable_colours
+
+doc_preferred_width {
+  h2 sg(:monkey, 'bblack0 marr6px','drag_monkey')+
+     'Exams','ud mart1px'
+  this_topic = Studium.random_exam_topic
+  h3 'Topic: '+
+      this_topic.to_s.tr('_',' ').capitalize
+  p {
+    e 'Delay in use: '+Studium.delay_for_exam_questions?.to_s
+  }
+  exam = Studium.new_exam(this_topic, :dont_run_yet) { :no_colours }
+  exam.www_mode
+  exam.disable_colours
+  exam.set_delay(0) # This does not work well otherwise.
+  exam.run
+  ee exam.string?.gsub(/\n/, "<br>\n")
+  spacer
+  drag :answer_div
+}}

data/lib/studium/www/fast_ask_exam_question/fast_ask_exam_question.cgi

@@ -0,0 +1,156 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# http://localhost/programming/ruby/src/studium/lib/studium/www/fast_ask_exam_question/fast_ask_exam_question.cgi
+# =========================================================================== #
+require 'cyberweb/autoinclude'
+require 'studium'
+
+english('Fast Ask Exam Question') {
+autoextend
+ruby_favicon
+default_template '
+
+div, p {
+  padding: 0px;
+  margin:  1px;
+}
+
+.container {
+  display: flex;
+}
+.container > div {
+  flex: 1; /*grow*/
+}
+
+#button_hover_transition:hover {
+  transition:       5000ms linear;
+  background-color: lightblue;
+}
+
+#button_hover_transition {
+  background-color: palegoldenrod;
+}
+
+body {
+  font-family: Hack;
+}
+
+textarea {
+  font-family: Hack;
+  font-size: 1.2em;
+}
+
+'
+body_css_class 'mar0px s2px padt2px'
+body_css_style 'background-color: #d3d2d1;'
+default_font_size_and_hyperlinks
+
+# =========================================================================== #
+# === ARRAY_ALL_REMAINING_EXAM_QUESTIONS
+# =========================================================================== #
+ARRAY_ALL_REMAINING_EXAM_QUESTIONS = Studium.array_all_remaining_exam_questions
+
+doc('mar0px pad0px s0_3em ') {
+
+ejavascript '
+
+function sync_towards_the_entry_exam_topic() {
+  var i = document.getElementById("dropbox_containing_the_array_exam_topics").value;
+  button_hover_transition = document.getElementById("entry_for_the_current_exam_topic");
+  button_hover_transition.value = i;
+}
+
+const ARRAY_ALL_REMAINING_EXAM_QUESTIONS = [
+"'+
+ARRAY_ALL_REMAINING_EXAM_QUESTIONS.map {|entry|
+  entry.strip.tr('"', '\"')
+}.join('",'+"\n"+'"')
+'];'
+
+div('container marb1px') {
+  div('no_select BOLD pad8px center bblack2 BG_oldlace wid22',
+      '',
+      'font-size: 2em;') {
+    espan(
+      'Exam topic       → ',
+      '',
+      '-moz-user-select: none; -webkit-user-select: none; -ms-user-select:none; user-select:none;-o-user-select:none;'
+    )
+  }
+  div('wid100') {
+    ee '<input id="entry_for_the_current_exam_topic" class="bblack1 wid100" type="text" name="fname">'
+  }
+  # ========================================================================= #
+  # The drop-box.
+  # ========================================================================= #
+  div {
+    dropbox = html_dropbox(
+      Studium.array_exam_topics?
+    )
+    dropbox.id = "dropbox_containing_the_array_exam_topics"
+    dropbox.css_class = 'bblack1 pad8px'
+    dropbox.onchange = "sync_towards_the_entry_exam_topic()"
+    ee dropbox
+  }
+}
+
+div('container marb1px') {
+  div('BOLD pad8px center noselect wid22 mar0px',
+      '',
+      '') {
+    button = html_button('Ask a Question')
+    button.id = 'button_hover_transition'
+    button.class = 'rounded_border_8px wid100 bblack2'
+    button.style = 'font-size: 3em'
+    ee button
+  }
+  div('wid100') {
+    textarea = html_textarea
+    textarea.class = 'rounded_border_6px bblack1 FS2em pad8px'
+    textarea.id = 'ask_a_question'
+    textarea.name = 'ask_a_question'
+    textarea.rows = 6
+    textarea.cols = 90
+    textarea.set_content(ARRAY_ALL_REMAINING_EXAM_QUESTIONS.sample)
+    ee textarea
+  }
+}
+
+div('container marb1px') {
+  div('wid20',
+      '',
+      '') {
+    button = html_button('Reveal the Answer')
+    button.id = 'button_hover_transition'
+    button.class = 'rounded_border_8px wid100 bblack2'
+    button.style = 'font-size: 3em'
+    ee button
+  }
+  div('wid100') {
+    textarea = html_textarea
+    textarea.class = 'rounded_border_6px bblack1 FS2em pad8px'
+    textarea.id = 'reveal_the_answer'
+    textarea.name = 'reveal_the_answer'
+    textarea.rows = 6
+    textarea.cols = 90
+    ee textarea
+  }
+}
+
+e sg(:text_editor, 'marr8px', 'drag_text_editor1')+
+  'Below this text you can input your assumed answer:'+
+  sg(:text_editor, 'marl8px', 'drag_text_editor2')
+div('mars1em') {
+  textarea = html_textarea
+  textarea.class = 'rounded_border_6px bblack1 FS2em wid100 pad10px'
+  textarea.style = 'height: 20em'
+  textarea.id = 'reveal_the_answer'
+  textarea.name = 'reveal_the_answer'
+  textarea.rows = 5
+  textarea.cols = 80
+  ee textarea
+}
+
+}}

data/lib/studium/www/handle_curricula/handle_curricula.cgi

@@ -0,0 +1,154 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# http://localhost/programming/ruby/src/studium/lib/studium/www/handle_curricula/handle_curricula.cgi
+# =========================================================================== #
+require 'cyberweb/autoinclude'
+require 'studium/requires/www_mode.rb' # ← This automatically enables the www-mode.
+require 'studium/curricula/handle_curricula/handle_curricula.rb'
+
+english('Handle Curricula') {
+created_on '07.12.2022' # Wednesday.
+autoextend
+ruby_favicon
+default_template '
+ 
+img {
+  border: 1px solid black;
+  margin: 1px;
+  margin-right: 10px;
+}
+
+a.fancy_links         { color: #030c37; }
+a:link.fancy_links    { color: #030c37; }
+a:visited.fancy_links { color: #030c37; }
+a:hover.fancy_links   { color: #1c3086; text_decoration: none; } 
+
+a.link_for_lectures_not_yet_completed         { color: #c10606; }
+a:link.link_for_lectures_not_yet_completed    { color: #c10606; }
+a:visited.link_for_lectures_not_yet_completed { color: #c10606; }
+a:hover.link_for_lectures_not_yet_completed   { color: #dc4a4a; text_decoration: none; }
+
+.CSS_for_the_available_curricula {
+  font-size: 13px;
+  padding: 10px 8px 10px 14px;
+  background: #fff;
+  border: 1px solid #ccc;
+  border-radius: 6px;
+  position: relative;
+}
+
+input[type=text] {
+  padding: 25px;
+}
+
+'
+body_css_class 'mar0px pad0px VERDANAs'
+body_css_style ''
+default_font_size_and_hyperlinks
+
+@available_curricula = Studium.available_curricula?
+@available_curricula << :indi1
+@available_curricula << :indi2
+@available_curricula << :indi3
+@available_curricula << :indi4
+@available_curricula.flatten!
+
+# =========================================================================== #
+# === show_the_available_curricula
+#
+# We deduct -4 because of the four ":indi1" above.
+# =========================================================================== #
+def show_the_available_curricula
+  e 'The <b>available curricula</b> (<b>'+(@available_curricula.size-4).to_s+'</b>) are:'
+  _ = ''.dup
+  @available_curricula.sort.each_with_index {|this_curriculum, index| index += 1
+    _ << string_span(
+           index.to_s.rjust(2,' ')+
+           ') '+
+           this_curriculum.to_s.tr('_',' '),
+           'BOLD smaller marl5em',
+           '',
+           'font-family: monospace;'
+         )+"\n"
+  }
+  pre(_, '','','')
+  br
+end
+
+# =========================================================================== #
+# === display_the_main_www_form
+# =========================================================================== #
+def display_the_main_www_form
+  pretty_spacer
+  # ========================================================================= #
+  # Create the www-form next.
+  # ========================================================================= #
+  # Cyberweb.eform {{ action: File.basename($PROGRAM_NAME).to_s, type: :get }}
+  ee "<form action=\"#{File.basename($PROGRAM_NAME)}\" method=\"get\">"
+    selection {{
+      dataset_to_use: @available_curricula.sort_by {|entry| entry.to_s }.map {|entry|
+                        entry.to_s.tr('_',' ')
+                      },
+      name:      'selection_of_available_curricula',
+      css_class: 'bblack1 pad5px BOLD CSS_for_the_available_curricula',
+      css_style: 'background-color: gold;'
+    }}
+    input_submit {{ # ← Add the submit-button here.
+      text:      'submit',
+      css_class: 'bblack2 BOLD pad6px',
+      css_style: 'font-size: 2.0em'
+    }}
+  ee 'Include course descriptions '+
+     '<input type="checkbox" name="include_course_descriptions" id="" />'
+  cform
+  pretty_spacer
+end
+
+doc_smaller_width('mar0px pad0px s0_8em FS1_1em') {
+  # ========================================================================= #
+  # Next we may assign a default curriculum that is to be shown:
+  # ========================================================================= #
+  # _ = 'indi1' # This is the default.
+  _ = 'bagrar' # This is the default.
+  # _ = ''
+  # ========================================================================= #
+  # Work on the given params next:
+  # ========================================================================= #
+  if !params_as_string?.empty?
+    _ = params_as_string? # Use another value in this case.
+  end
+  include_course_descriptions = false
+  hash = params?
+  if hash.has_key?('selection_of_available_curricula') and
+    !hash['selection_of_available_curricula'].empty?
+    _ = hash['selection_of_available_curricula']
+    _ = _.first.to_s if _.is_a? Array
+  end
+  if hash.has_key?('include_course_descriptions')
+    case hash['include_course_descriptions'].first.to_s
+    when 'on'
+      include_course_descriptions = true
+    end
+  end
+  handle_curricula = Studium::Curricula::HandleCurricula.new(_) {{
+    include_course_descriptions: include_course_descriptions,
+    serve_mode:                  :serve_as_is 
+  }}
+  if _ and !_.empty?
+    if handle_curricula.content?
+      ee handle_curricula.content?.
+         sub(/<\/?html>/,'').
+         sub(/<html lang="en">/,'')
+    end
+  end
+  p_default_le {
+    e 'You can input in the following form which curriculum you '\
+      'wish to display.',
+      'darkgreen BOLD'
+    br
+    show_the_available_curricula
+    display_the_main_www_form
+  }
+}}