studium 0.16.9

data/lib/studium/exams/timetable/constants.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/exams/timetable/constants.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Exams
+
+class Timetable < Base # === Studium::Exams::Timetable
+
+  # ========================================================================= #
+  # === RIGHT_ARROW
+  # ========================================================================= #
+  RIGHT_ARROW = '→'
+
+  # ========================================================================= #
+  # === CSS_STYLE_TO_USE                                            (CSS tag)
+  #
+  # You can style the default HTML table for use of a timetable via the
+  # following constant.
+  #
+  # Right now the font-family is monospace, largely in order to make
+  # padding and alignment easier.
+  # ========================================================================= #
+  CSS_STYLE_TO_USE = '
+#timetable_id {
+  border-spacing: 10px;
+  padding: 0 1em 0.5em 0;
+  border-collapse: collapse;
+  font-family: monospace;
+  font-size:     1.2em;
+  margin-bottom: 1px;
+}
+
+.TAC {
+  text-align: center;
+}
+
+.use_this_font_size_for_the_larger_font {
+  font-size: 2.0em;
+}
+
+.use_this_font_size_for_the_somewhat_larger_font {
+  font-size: 1.6em;
+}
+
+.centered {
+  text-align: center; 
+  vertical-align: middle;
+}
+
+.left_aligned {
+  text-align: left;
+}
+.bold,
+.BOLD {
+  font-weight: bold;
+}
+
+a,
+a:link {
+  text-decoration: none;
+}
+
+a:hover {
+  text-decoration: underline;
+}
+
+a.link_in_the_timetable:link { /* unvisited link */
+  color: darkblue;
+  text-decoration: none;
+}
+
+a.link_in_the_timetable:visited { /* visited link */
+  color: darkblue;
+  text-decoration: none;
+}
+
+a.link_in_the_timetable:hover { /* mouse over link */
+  color: darkgreen;
+  text-decoration: underline;
+}
+
+a.link_in_the_timetable:active { /* selected link */
+  color: royalblue;
+  text-decoration: none;
+}
+.min_width_for_the_header {
+  min-width: 200px;
+}
+.increased_min_width_for_the_header {
+  min-width: 320px;
+}
+
+.tooltip {
+  position: relative;
+  display: inline-block;
+  border-bottom: 1px dotted black;
+}
+
+.tooltip .tooltiptext {
+  visibility: hidden;
+  width: 120px;
+  background-color: black;
+  color: #fff;
+  text-align: center;
+  border-radius: 6px;
+  padding:  4px 0;
+
+  /* Position the tooltip */
+  position: absolute;
+  z-index: 1;
+}
+
+.tooltip:hover .tooltiptext {
+  visibility: visible;
+}
+
+.s5px {
+  padding-left:  5px;
+  padding-right: 5px;
+}
+
+.pad10px {
+  padding: 10px;
+}
+
+.pad8px {
+  padding: 8px;
+}
+
+.italic {
+  font-style: italic;
+}
+
+  '
+
+end; end; end

data/lib/studium/exams/timetable/timetable.rb

@@ -0,0 +1,450 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::Timetable
+#
+# The primary task for this class is to create a (reusable) timetable,
+# in HTML/CSS. It refactored out the old code found in class
+# UpcomingExams. It must be able to show all upcoming exams.
+#
+# Usage example:
+#
+#   Studium::Exams::Timetable.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/exams/timetable/timetable.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Exams
+
+class Timetable < Base # === Studium::Exams::Timetable
+
+  begin
+    require 'cyberweb/requires/require_the_html_template.rb'
+  rescue LoadError; end
+
+  require 'studium/constants/image_constants.rb'
+  require 'studium/constants/web_constants.rb'
+  require 'studium/toplevel_methods/registered_for_this_exam.rb'
+  require 'studium/toplevel_methods/return_remote_homepage_of_this_lecture.rb'
+  require 'studium/university_course/university_course.rb'
+  require 'studium/exams/timetable/constants.rb'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true,
+      &block
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :do_not_create_a_HTML_page
+      # ===================================================================== #
+      when :do_not_create_a_HTML_page
+        do_not_create_a_HTML_page
+      end
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === :university_course
+    # ======================================================================= #
+    @internal_hash[:university_course] = Studium::UniversityCourse.new
+    # ======================================================================= #
+    # === :dataset_from_the_file_lecture_information
+    # ======================================================================= #
+    @internal_hash[:dataset_from_the_file_lecture_information] = 
+      dataset_from_the_file_lecture_information
+    # ======================================================================= #
+    # === :sorted_exams_dataset
+    # ======================================================================= #
+    @internal_hash[:sorted_exams_dataset] = {}
+    # ======================================================================= #
+    # === :create_a_HTML_file
+    #
+    # By default this class will create a .html file. This is not always
+    # wanted, such as when we want to embed the HTML table into another
+    # class/website.
+    # ======================================================================= #
+    @internal_hash[:create_a_HTML_file] = true
+  end
+
+  # ========================================================================= #
+  # === dataset_from_the_file_lecture_information?
+  # ========================================================================= #
+  def dataset_from_the_file_lecture_information?
+    @internal_hash[:dataset_from_the_file_lecture_information]
+  end
+
+  # ========================================================================= #
+  # === upcoming_exams?
+  # ========================================================================= #
+  def upcoming_exams?
+    @internal_hash[:university_course].upcoming_exams?
+  end
+
+  # ========================================================================= #
+  # === raw_result?
+  # ========================================================================= #
+  def raw_result?
+    @internal_hash[:result]
+  end
+
+  # ========================================================================= #
+  # === create_a_HTML_file?
+  # ========================================================================= #
+  def create_a_HTML_file? 
+    @internal_hash[:create_a_HTML_file]
+  end
+
+  # ========================================================================= #
+  # === do_not_create_a_HTML_page
+  # ========================================================================= #
+  def do_not_create_a_HTML_page
+    @internal_hash[:create_a_HTML_file] = false
+  end
+
+  # ========================================================================= #
+  # === do_create_the_html_table
+  # ========================================================================= #
+  def do_create_the_html_table(
+      optional_commands = nil
+    )
+    entries_with_an_upcoming_exam = dataset_from_the_file_lecture_information?.select {|a,b|
+      exams = b['exams']
+      exams and !exams.empty?
+    }
+    today = ::Time.parse(::Time.now.strftime('%d.%m.%Y')) # Get a reference to the current day here.
+    _ = ''.dup # This will contain the main String.
+    _ << Studium::WebConstants::TIMETABLE_DIV
+    _ << '<table id="timetable_id">'.dup
+    # ======================================================================= #
+    # Create the table header next:
+    # ======================================================================= #
+    _ << '<tr>
+          <th class="centered bold pad8px">#number</th>
+          <th class="increased_min_width_for_the_header use_this_font_size_for_the_larger_font bold left_aligned pad8px">Name of the course</th>
+          <th class="pad2px">n ECTS</th>
+          <th class="pad2px" style="width: 100px">priority</th>
+          <th class="min_width_for_the_header use_this_font_size_for_the_larger_font bold left_aligned pad10px">Exam day</th>
+          <th class="min_width_for_the_header use_this_font_size_for_the_larger_font bold bold pad10px">Exam time</th>
+          <th class="min_width_for_the_header bold pad10px" style="font-size: 1.2em; color: darkgreen;">Exam location</th>
+          <th class="min_width_for_the_header use_this_font_size_for_the_larger_font bold pad10px">Remote URL</th>
+          </tr>'
+    sorted = entries_with_an_upcoming_exam.sort_by {|a, b|
+      exams = b['exams']
+      first_exams = exams.first
+      if first_exams.include?(', Ort:')
+        first_exams = first_exams.split(', Ort:').first
+      end
+      ::Time.parse(first_exams) # Time-parse the entries here, then return it.
+    }
+    @internal_hash[:sorted_exams_dataset] = Hash[sorted]
+    index = 0
+    n_ECTS_in_total = 0
+    n_ECTS_in_total_for_the_registered_courses = 0
+    @internal_hash[:sorted_exams_dataset].each_pair {|a, b| index += 1
+      # ===================================================================== #
+      # Let @internal_hash[:university_course] handle the course at hand
+      # next - this will simplify dealing with the dataset:
+      # ===================================================================== #
+      @internal_hash[:university_course].parse(
+        {
+          a => b
+        }
+      )
+      name_of_the_course       = a # Keep track of the name of the course here.
+      case optional_commands
+      # ===================================================================== #
+      # === :remove_leading_lva_id_entries
+      # ===================================================================== #
+      when :remove_leading_lva_id_entries
+        if name_of_the_course.include? ' '
+          name_of_the_course = name_of_the_course.
+                               split(' ')[1..-1].join(' ').strip
+        end
+      end
+      lva_id                   = name_of_the_course.split(' ').first.to_s
+      remote_URL_of_the_course = Studium.url_for?(name_of_the_course)
+      exams                    = b['exams']
+      priority                 = b[:priority].to_s
+      registered               = b['registered']
+      is_an_outdated_lecture   = @internal_hash[:university_course].outdated_lecture?
+      are_we_registered        = false
+      orte                     = @internal_hash[:university_course].orte?
+      if registered and !registered.empty?
+        are_we_registered      = true 
+      end
+      case priority
+      when '1'
+        # ============================================================= #
+        # High priority entries get the colour blue.
+        # ============================================================= #
+        priority = '<b><span class="TAC s5px" style="font-size:xx-large; color: darkblue; text-align: center;">'+
+                   priority.to_s+
+                   '</span></b>'+N
+      else
+        priority = '<b><span class="TAC" style="font-size:large; text-align: center;">'+
+                   priority.to_s+
+                   '</span></b>'+N
+      end
+      first_element            = exams.first.to_s # We only care for the first exam time.
+      splitted                 = first_element.split(',')
+      n_ECTS                   = b[:ects]
+      at_this_university       = b[:university]
+      the_exam_time            = splitted[1].to_s # This is the o'clock time, on that given day.
+      if the_exam_time.include?('-')
+        the_exam_time = the_exam_time.split('-').join(' - ')
+      end
+      the_exam_date            = splitted.first
+      time_parsed_the_exam_date = ::Time.parse(the_exam_date)
+      if today > time_parsed_the_exam_date
+        is_this_lecture_outdated = true
+      else
+        is_this_lecture_outdated = false
+      end
+      use_an_outdated_image = ''.dup
+      # ===================================================================== #
+      # Next add in how many days the exam will happen:
+      # ===================================================================== #
+      n_days_difference = time_parsed_the_exam_date - today
+      n_days_difference = 0 if n_days_difference < 0 # Handle "negative" days here.
+      n_days_difference = n_seconds_to_n_days(n_days_difference).to_i
+      use_an_outdated_image << '<br><b class="italic royalblue">(in '+n_days_difference.to_s+' days)</b><br>'
+      if is_this_lecture_outdated
+        # =================================================================== #
+        # Add the outdated image next.
+        # =================================================================== #
+        use_an_outdated_image << '<img src="../../../programming/ruby/src/studium/lib/studium/images/outdated.png">'
+      end
+      if is_an_outdated_lecture
+        use_an_outdated_image << '<br><b style="color: red">This is an outdated lecture and should be removed.</b>'
+      end
+      # ===================================================================== #
+      # Add an "invisible" LVA ID entry next. This will come after the
+      # baloon-tooltip.
+      # ===================================================================== #
+      colourized_lva_id =
+        '<span style="color:white; font-weight: bold"> '+lva_id+'</span>'
+      # ===================================================================== #
+      # '<a href ="'+remote_url+'">'+
+      # Studium.return_logo_for_this_university(at_this_university).to_s+
+      # '</a>'+N
+      # ===================================================================== #
+      university_logo = Studium.return_logo_for_this_university(
+        at_this_university
+      ).to_s.sub(
+        Regexp.quote('/home/x/data/'),
+        '../../../data/'
+      )
+      n_ECTS_in_total += n_ECTS.to_f
+      if are_we_registered
+        n_ECTS_in_total_for_the_registered_courses += n_ECTS.to_f
+      end
+      the_exam_date = the_exam_date.to_s
+      upcoming_exams = upcoming_exams?
+      if Studium.are_we_registered_for_this_exam?(name_of_the_course, @internal_hash[:sorted_exams_dataset])
+        # =================================================================== #
+        # Next, we get rid of upcoming exams that we have already
+        # registered for.
+        # =================================================================== #
+        if !upcoming_exams.empty?
+          first_exam_date = upcoming_exams.first
+          parsed_time = ::Time.parse(
+                          first_exam_date.day.to_s+'.'+
+                          first_exam_date.month.to_s+'.'+
+                          first_exam_date.year.to_s
+                        )
+          scanned = the_exam_date.scan(/\d{2}\.\d{2}\.\d{4}/)
+          time_parsed_exam_date = ::Time.parse(scanned.flatten.first)
+          if time_parsed_exam_date == parsed_time
+            upcoming_exams.shift # Remove it here.
+          end
+        end
+        the_exam_date      = '<b style="color: orangered">'+the_exam_date+'</b>'
+        name_of_the_course = '<b style="color: orangered">'+name_of_the_course+'</b>'
+      end
+      upcoming_exams_as_string = ''.dup
+      unless upcoming_exams.empty?
+        upcoming_exams_as_string << '<br><br><span style="font-size: smaller">The following exams are coming up next:<br>'
+        upcoming_exams.each {|entry|
+          upcoming_exams_as_string << '<br><span style="color: midnightblue; margin-left: 0.80em;">'+
+                                       entry.to_s+'</span>'
+        }
+        upcoming_exams_as_string << '</span><br>'
+      end
+      # ===================================================================== #
+      # Add the new row finally:
+      # ===================================================================== #
+      if (parse_dd_mm_yyyy(the_exam_date) == parse_dd_mm_yyyy(today)) or
+         (parse_dd_mm_yyyy(the_exam_date) > parse_dd_mm_yyyy(today))
+        if _.include?('<tr id="today">')
+          _ << '<tr>'
+        else
+          _ << '<tr id="today">' # This will be today's exam date.
+        end
+      else
+        _ << '<tr>'
+      end
+      if orte
+        joined_orte = '<b>'+orte.join("<br>\n")+'</b>'
+      else
+        joined_orte = ''
+      end
+      _ << '<td class="centered">'+
+           HtmlTags.a(
+             remote_URL_of_the_course,
+             content: university_logo,
+             css_style: 'margin-right: 10px'
+           )+'<b style="color: darkorchid; font-size: larger;">'+
+           index.to_s+'</b>'+ # The index comes first.
+           '</td><td class="bold" style="width: 480px;
+           border-top:    2px dotted royalblue;
+           border-bottom: 2px dotted royalblue;
+           border-left:   2px dotted royalblue;
+           border-right:  2px dotted royalblue;
+           padding:       2px;
+           margin-left:   2px;
+           margin-right:  2px;
+           margin-bottom: 5px;
+           ">'+
+           name_of_the_course+ # Here is the name of the course.
+           HtmlTags.a(
+             remote_URL_of_the_course,
+             content: '<b>[→ Link]</b>',
+             css_style: 'margin-left: 8px',
+             open_in_new_tab: true
+           )+
+           upcoming_exams_as_string+
+           colourized_lva_id+
+           '</td><td>'+
+           '<b>'+n_ECTS.to_s+'</b>'+ # n ECTS
+           '</td><td class="TAC s5px">'+
+           priority+
+           '</td><td><b>'+
+           the_exam_date+ # This is the exam-day (exam day).
+           '</b> '+use_an_outdated_image+ 
+           '</td><td><b class="TAC center darkblue">'+
+           the_exam_time+                # And here exam time.
+           '</b></td><td><span style="font-size: 1.0em; color: darkgreen;">'+
+           joined_orte+                  # Next, show the "Orte", aka locations of the exam at hand. (Exam location)
+           '</span></td><td>'+
+           HtmlTags.a(
+             remote_URL_of_the_course,
+             css_class: 'BOLD link_in_the_timetable',
+             content: "#{RIGHT_ARROW} #{remote_URL_of_the_course}"
+           )+
+           "</td></tr>\n"
+    }
+    _ << "</table>\n"
+    _ << '<div style="padding: 6px; border: 2px dotted darkgreen; font-family: monospace;">'\
+         '<h2>Statistics</h2>'
+    _ << '<span style="margin-left: 2em">'+
+         'ECTS in total in the above courses: </span>'+
+         '<b>'+n_ECTS_in_total.to_s+"</b><br>\n"
+    # ======================================================================= #
+    # Report how many ECTS points can be attained through the registered
+    # exams listed above.
+    # ======================================================================= #
+    _ << '<span style="margin-left: 2em; font-family: monospace; '\
+         'font-size:1.1em">A total of <b style="color:darkblue">'+
+         n_ECTS_in_total_for_the_registered_courses.to_s+' ECTS points</b> '\
+         'can be attained through the above <b>registered</b> exams.</span>'+N
+    _ << '</div>'
+    _ << '</div>' # This closes the most outer <div> tag.
+    @internal_hash[:result] = _
+    do_store_the_HTML_content_into_a_file(_) if create_a_HTML_file?
+  end
+
+  # ========================================================================= #
+  # === result?
+  #
+  # This variant will always return the result as a full HTML page.
+  #
+  # If this is unwanted then .raw_result? should be used instead.
+  # ========================================================================= #
+  def result?(
+      i = raw_result?
+    )
+    return Cyberweb.rendered_template(
+      content:     raw_result?,
+      title:       'Timetable',
+      css_classes: 'TAC center royalblue darkblue darkgreen',
+      css_style:   CSS_STYLE_TO_USE
+    ).result?
+  end
+
+  # ========================================================================= #
+  # === do_store_the_HTML_content_into_a_file
+  # ========================================================================= #
+  def do_store_the_HTML_content_into_a_file(
+      i    = raw_result?,
+      into = "#{html_log_dir?}timetable.html" # Decide where to store this.
+    )
+    what = result?(i)
+    ensure_that_a_base_directory_exists_for_this_file(into)
+    opne "Storing into `#{sfile(into)}` next."
+    write_what_into(what, into)
+    if File.exist?(into) and is_on_roebe?
+      full_target = "#{into}#today"
+      silently_open_in_browser(full_target) # Open it in the browser.
+    end
+  end; alias create_the_html_file do_store_the_HTML_content_into_a_file # === create_the_html_file
+       alias create_html_file     do_store_the_HTML_content_into_a_file # === create_html_file
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    do_create_the_html_table
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams::Timetable[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end
+
+# ========================================================================= #
+# === Studium.return_div_timetable_of_upcoming_exams
+#
+# This method can be used to create a timetable <div>, which can then
+# be embedded/displayed into a .html or .cgi page.
+#
+# Usage example:
+#
+#   x = Studium.return_div_timetable_of_upcoming_exams
+#
+# ========================================================================= #
+def self.return_div_timetable_of_upcoming_exams
+  '<style>'+CSS_STYLE_TO_USE+'</style>'+
+  Studium::Exams::Timetable.new { :do_not_create_a_HTML_page }.raw_result?
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Exams::Timetable.new(ARGV)
+end # examstimetable