studium 0.13.1

data/lib/studium/utility_scripts/generate_spreadsheet/generate_spreadsheet.rb

@@ -0,0 +1,354 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::GenerateSpreadsheet
+#
+# This class can generate simple spreadsheets for use by individual
+# curricula.
+#
+# Usage example:
+#
+#   Studium::GenerateSpreadsheet.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/generate_spreadsheet/generate_spreadsheet.rb'
+# Studium::GenerateSpreadsheet.new(ARGV)
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class GenerateSpreadsheet < Base # === Studium::GenerateSpreadsheet
+
+  require 'studium/toplevel_methods/esystem.rb'
+  require 'studium/curricula/determine_curricula/determine_curricula.rb'
+  require 'studium/toplevel_methods/return_remote_homepage_of_this_lecture.rb'
+  require 'studium/utility_scripts/generate_spreadsheet/misc.rb'
+
+  begin
+    require 'caxlsx' # Or require 'simple_xlsx'
+  rescue LoadError
+    if false # Disabled since as of July 2022, due to jruby.
+      if ::Studium.is_on_roebe?
+        puts 'caxlsx is not installed - we will install '\
+             'it next, via gem install caxlsx.'
+        puts
+        ::Studium.esystem 'gem install caxlsx'
+        puts
+        begin
+          require 'caxlsx' # Silent rescue nonetheless.
+        rescue LoadError
+        end
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    sanitize_commandline_arguments
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @dataset_from_the_file_lecture_information
+    # ======================================================================= #
+    @dataset_from_the_file_lecture_information =
+      return_dataset_from_the_file_lecture_information
+    # ======================================================================= #
+    # === @generate_this_file
+    #
+    # Save into this file here.
+    # ======================================================================= #
+    @generate_this_file = 'studium.xlsx'
+    # ======================================================================= #
+    # === @dataset
+    #
+    # This variable will eventually keep track of the dataset that will
+    # be used in order to generate the dataset for the excel-file at
+    # hand.
+    # ======================================================================= #
+    @dataset = nil
+    # ======================================================================= #
+    # === @size_of_the_header_font
+    # ======================================================================= #
+    @size_of_the_header_font = 18
+    # ======================================================================= #
+    # === @can_we_continue
+    # ======================================================================= #
+    @can_we_continue = false
+  end
+
+  # ========================================================================= #
+  # === horizontal_center
+  # ========================================================================= #
+  def horizontal_center
+    return { horizontal: :center }
+  end
+
+  # ========================================================================= #
+  # === return_hash_for_the_courier_font
+  # ========================================================================= #
+  def return_hash_for_the_courier_font
+    {
+      b: true,
+      font_name: 'Courier',
+      sz: 15
+    }
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    menu
+    check_for_the_availability_of_the_main_gem
+    if @can_we_continue
+      consider_removing_the_old_file
+      # ======================================================================= #
+      # Trigger this via:
+      #
+      #   genspreadsheet --indi2
+      #
+      # ======================================================================= #
+      create_new_spreadsheet_instance
+      begin
+        require 'caxlsx'
+      rescue LoadError; end
+      # ======================================================================= #
+      # Instantiate a new Axlsx::Package next:
+      # ======================================================================= #
+      @p = Axlsx::Package.new
+      wb = @p.workbook
+      workbook_styles = wb.styles
+      # ======================================================================= #
+      # To use a font, use something like this:
+      #
+      #   add_style :b => false, :sz => 9,  :font_name => 'Courier'
+      #
+      # ======================================================================= #
+      # font_courier = workbook_styles.add_style(return_hash_for_the_courier_font)
+      wb.styles { |style|
+        # ===================================================================== #
+        # Next define some different styles that could be used.
+        # ===================================================================== #
+        _larger_font     = workbook_styles.add_style(sz: main_font_size?)
+        # ===================================================================== #
+        # === larger_font_and_centered_alignment_and_moccasin_background
+        # ===================================================================== #
+        _larger_font_and_centered_alignment_and_moccasin_background = wb.styles.add_style(
+          bg_color: rbg_to_hex(:moccasin),
+          sz: main_font_size?,
+          alignment: horizontal_center
+        )
+        larger_font_and_centered_alignment_with_lightsteelblue_background = wb.styles.add_style(
+          return_hash_for_the_courier_font.merge(
+            bg_color: rbg_to_hex(:lightsteelblue),
+            sz: main_font_size?,
+            alignment: horizontal_center
+          )
+        )
+        larger_font_and_centered_alignment = wb.styles.add_style(
+          return_hash_for_the_courier_font.merge(
+            sz: main_font_size?,
+            alignment: horizontal_center
+          )
+        )
+        # ===================================================================== #
+        # === centered_alignment_and_border_and_seashell_background
+        # ===================================================================== #
+        centered_alignment_and_border_and_seashell_background = wb.styles.add_style(
+          return_hash_for_the_courier_font.merge(
+            bg_color: rbg_to_hex(:seashell),
+            alignment: horizontal_center,
+            border: thin_border
+          )
+        )
+        # ===================================================================== #
+        # === larger_font_and_centered_alignment_and_border_and_seashell_background
+        # ===================================================================== #
+        _larger_font_and_centered_alignment_and_border_and_seashell_background = wb.styles.add_style(
+          return_hash_for_the_courier_font.merge(
+            bg_color: rbg_to_hex(:seashell),
+            sz: main_font_size?,
+            alignment: horizontal_center,
+            border: thin_border
+          )
+        )
+        # ===================================================================== #
+        # No longer in use since as of 07.06.2022. It was replaced
+        # via the ^^^ above entry.
+        # ===================================================================== #
+        _larger_font_and_centered_alignment_and_border = wb.styles.add_style(
+          return_hash_for_the_courier_font.merge(
+            sz: main_font_size?,
+            alignment: horizontal_center,
+            border: thin_border
+          )
+        )
+        _medium_font      = wb.styles.add_style(sz: 16)
+        # ===================================================================== #
+        # === highlighted_and_centered_cell
+        # ===================================================================== #
+        highlighted_and_centered_cell    = wb.styles.add_style(
+          return_hash_for_the_courier_font.merge(
+            bg_color: 'EFC376', # ← Set a background colour. This is ~beige.
+            alignment: horizontal_center,
+          )
+        )
+        _center_alignment = wb.styles.add_style(
+          { :alignment => horizontal_center }
+        )
+        _red_border = wb.styles.add_style(
+          :border => {
+            color: 'FF0000',
+            style: :thin
+          }
+        )
+        # ===================================================================== #
+        # Define the default style-Array next:
+        # ===================================================================== #
+        use_this_style_array = [
+          highlighted_and_centered_cell,
+          larger_font_and_centered_alignment_with_lightsteelblue_background,
+          centered_alignment_and_border_and_seashell_background,
+          larger_font_and_centered_alignment,
+          larger_font_and_centered_alignment,
+          larger_font_and_centered_alignment,
+          larger_font_and_centered_alignment # For "LVA Typ".
+        ]
+        wb.add_worksheet(name: 'Curriculum') {|sheet|
+          sheet.add_row(
+            [
+              '#',                             # 1)
+              'Universität',                   # 2)
+              'LVA ID',                        # 3)
+              'Name der Lehrveranstaltung',    # 4)
+              'Modul',                         # 5)
+              'n ECTS',                        # 6)
+              'LVA Typ'                        # 7)
+            ],
+            style: use_this_style_array,
+            sz: @size_of_the_header_font
+          )
+          sheet.add_row # Add two empty rows next.
+          sheet.add_row
+
+          index = 0
+          if @dataset.nil?
+            opnn
+            e 'No '+steelblue('@dataset')+' was found. Thus, no excel '\
+              'file can be generated.'
+            return
+          end
+          @dataset.each {|entry| index += 1
+            splitted = entry.split(' ')
+            lva_id = splitted.first.to_s # This must be a String.
+            name_of_the_lecture = splitted[1 .. -1].join(' ').strip
+            # =============================================================== #
+            # Determine the university next.
+            # =============================================================== #
+            this_university = @dataset_from_the_file_lecture_information[entry][:university].to_s.strip
+            n_ects          = @dataset_from_the_file_lecture_information[entry][:ects].to_s.strip
+            n_ects          = '%.1f' % n_ects.to_f
+            lva_typ         = @dataset_from_the_file_lecture_information[entry][:type].to_s.strip
+            sheet.add_row(
+              [
+                index.to_s,           # (1)
+                this_university,      # (2)
+                lva_id,               # (3) must be a String, aka :text.
+                name_of_the_lecture,  # (4)
+                '(unknown module)',   # (5) The module is currently not automatically obtain.
+                n_ects,               # (6) must be a float.
+                lva_typ               # (7)
+              ],
+              style: use_this_style_array,
+              types: [:text, :text, :text, :text, :text, :float, :text],
+              sz: 18
+            )
+            # =============================================================== #
+            # Add hyperlinks to the first entry.
+            # =============================================================== #
+            sheet.add_hyperlink(
+              location: Studium.return_url_from(entry).to_s,
+              ref:      sheet.rows.last.cells.first
+            )
+            sheet.add_hyperlink(
+              location: Studium.return_url_from(entry).to_s,
+              ref:      sheet.rows.last.cells[2] # And to the LV-number as well.
+            )
+            sheet.add_hyperlink(
+              location: Studium.return_url_from(entry).to_s,
+              ref:      sheet.rows.last.cells[3] # And to the description as well.
+            )
+            sheet.rows.last.cells.each {|this_cell|
+              this_cell.b = true
+            }
+            sheet.rows[-1].cells.each {|this_cell|
+              this_cell.b = true # Make the "n ECTS" bold as well.
+            }
+            #sheet.rows.last.cells[1].border = { :style => :thick, :color =>'FF0000FF' }
+            # cell_value_of_the_lva_type = sheet.rows.last.cells[5].value
+            # if is_prüfungsimmanent?(cell_value_of_the_lva_type)
+            #   # Modify prüfungsimmanente lectures next:
+            #   sheet.rows.last.cells[5].style = [red_border]
+            # end
+            # sheet.rows.last.cells[1].border_width = 10
+            # sheet.add_hyperlink(
+            #   location: Studium.return_url_from(entry),
+            #   target:   Studium.return_url_from(entry),
+            #   ref: "A#{index}"
+            # )
+          }
+        }
+      }
+      @p.serialize(main_file?)
+      if File.exist? @generate_this_file
+        opnn; e 'Saving into the file `'+
+                 sfile(@generate_this_file)+'`.'
+        consider_opening_the_generated_file
+      end
+    else
+      e 'The main gem (gem install axlsx) '\
+        'is not available - thus we can not continue.'
+      # if is_on_roebe?
+      #   esystem 'gem install axlsx'
+      # end
+    end
+  end
+
+  # ========================================================================= #
+  # === main_file?
+  # ========================================================================= #
+  def main_file?
+    @generate_this_file
+  end
+
+  # ========================================================================= #
+  # === Studium::GenerateSpreadsheet[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::GenerateSpreadsheet.new(ARGV)
+end # generatespreadsheet indi3
+    # generatespreadsheet indi1

data/lib/studium/utility_scripts/generate_spreadsheet/misc.rb

@@ -0,0 +1,144 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/utility_scripts/generate_spreadsheet/misc.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class GenerateSpreadsheet < Base # === Studium::GenerateSpreadsheet
+
+  # ========================================================================= #
+  # === size_of_the_header_font?
+  # ========================================================================= #
+  def size_of_the_header_font?
+    @size_of_the_header_font
+  end; alias main_font_size? size_of_the_header_font? # === main_font_size?
+
+  # ========================================================================= #
+  # === sanitize_commandline_arguments
+  # ========================================================================= #
+  def sanitize_commandline_arguments
+    if @commandline_arguments.empty? and is_on_roebe?
+      @commandline_arguments << :indi2
+    end
+  end
+
+  # ========================================================================= #
+  # === consider_opening_the_generated_file                        (open tag)
+  # ========================================================================= #
+  def consider_opening_the_generated_file
+    if is_on_roebe?
+      begin
+        require 'open'
+        Open.in_editor(@generate_this_file)
+      rescue LoadError; end
+    end
+  end
+
+  # ========================================================================= #
+  # === consider_removing_the_old_file
+  # ========================================================================= #
+  def consider_removing_the_old_file(
+      i = @generate_this_file
+    )
+    if File.exist?(i) and i.end_with?('.xlsx')
+      e "#{rev}Deleting the file #{sfile(i)} next." if is_on_roebe?
+      File.delete(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === create_new_spreadsheet_instance
+  # ========================================================================= #
+  def create_new_spreadsheet_instance
+    @p = Axlsx::Package.new
+  end
+
+  # ========================================================================= #
+  # === check_for_the_availability_of_the_main_gem
+  # ========================================================================= #
+  def check_for_the_availability_of_the_main_gem
+    if Object.const_defined? :Axlsx
+      @can_we_continue = true
+    end
+  end
+
+  # ========================================================================= #
+  # === rbg_to_hex
+  # ========================================================================= #
+  def rbg_to_hex(i = :lightsteelblue)
+    return ::Colours.to_hex(
+      ::Colours.to_rgb(i.to_s)
+    )
+  end
+
+  # ========================================================================= #
+  # === thin_border
+  # ========================================================================= #
+  def thin_border
+    Axlsx::STYLE_THIN_BORDER
+  end
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  # ========================================================================= #
+  def show_help
+    e 'Available options are:'
+    e
+    e '  --indi1'
+    e '  --indi2'
+    e '  --indi3'
+    e '  --indi4'
+    e
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  #
+  # Don't forget to add new entries to this menu.
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i.to_s
+      # ===================================================================== #
+      # === genspreadsheet --help
+      # ===================================================================== #
+      when /^-?-?help/i
+        show_help
+        exit
+      # ===================================================================== #
+      # === genspreadsheet --indi1
+      # ===================================================================== #
+      when /^-?-?Bachelorcurriculum(-|_| )?Informatik(-|_| )?und(-|_| )?molekulare(-|_| )?Biologie$/i,
+           /^-?-?indi1$/i
+        @dataset = Studium.load_this_yaml_file(:indi1)
+      # ===================================================================== #
+      # === genspreadsheet --indi2
+      # ===================================================================== #
+      when /^-?-?indi2$/i
+        @dataset = Studium.load_this_yaml_file(:indi2)
+      # ===================================================================== #
+      # === genspreadsheet --indi3
+      # ===================================================================== #
+      when /^-?-?indi3$/i,
+           /^-?-?Bachelorcurriculum(-|_| )?Informatik(-|_| )?und(-|_| )?molekulare(-|_| )?Biologie$/i
+        @dataset = Studium.load_this_yaml_file(:indi3)
+      # ===================================================================== #
+      # === genspreadsheet --indi4
+      # ===================================================================== #
+      when /^-?-?indi4$/i,
+           /^-?-?Mastercurriculum(-|_| )?\(?Bio\)?Informatics(-|_| )?and(-|_| )?molecular(-|_| )?biotechnology(-|_| )?including(-|_| )?aspects(-|_| )?from(-|_| )?molecular(-|_| )?medicine$/i,
+           /^-?-?Mastercurriculum(-|_| )?Informatik(-|_| )?und(-|_| )?molekulare(-|_| )?Biologie$/i
+        @dataset = Studium.load_this_yaml_file(:indi4)
+      end
+    end
+  end
+
+end; end

data/lib/studium/utility_scripts/holidays/holidays.rb

@@ -0,0 +1,150 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Holidays
+#
+# This class has two main functions:
+#
+#   (1) store all university-related holidays
+#   (2) output that information if necessary
+#
+# By default, this class will NOT output the holidays, but the .rb file 
+# here will use a switch to do an output nonetheless.
+# =========================================================================== #
+# require 'studium/utility_scripts/holidays/holidays.rb'
+# Studium.is_this_day_a_holiday?
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class Holidays < Studium::Base # === Studium::Holidays
+
+  require 'studium/toplevel_methods/time.rb'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      optional_commandline_arguments = nil,
+      run_already                    = true
+    )
+    reset
+    if block_given?
+      yielded = yield
+      if optional_commandline_arguments.nil?
+        optional_commandline_arguments = yielded
+      end
+    end
+    case optional_commandline_arguments
+    when :do_not_report_anything, :be_silent
+      @report_the_findings = false
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    super()
+    load_the_dataset
+    # ======================================================================= #
+    # === @report_the_findings
+    # ======================================================================= #
+    @report_the_findings = true
+  end
+
+  # ========================================================================= #
+  # === load_the_dataset
+  # ========================================================================= #
+  def load_the_dataset
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = YAML.load_file(Studium.file_holidays) # bl $RUBY_STUDIUM/yaml/holidays.yml
+  end
+
+  # ========================================================================= #
+  # === pretty_university_name
+  # ========================================================================= #
+  def pretty_university_name(i)
+    case i
+    when 'boku'
+      i = 'Universität für Bodenkultur'
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === report_all_holidays
+  # ========================================================================= #
+  def report_all_holidays
+    if @report_the_findings
+      e 'These holidays are known:'
+      e
+      @dataset.each_pair {|name_of_the_university, holiday_dates|
+        e
+        e "University: #{sfancy(pretty_university_name(name_of_the_university))}"
+        e
+        holiday_dates.each {|this_holiday_date|
+          e lightgreen(
+              '  '+this_holiday_date+' ('+
+              return_name_for_this_day(this_holiday_date, :german).ljust(10)+' / '+
+              return_name_for_this_day(this_holiday_date, :english).ljust(9)+
+              ')'
+            )
+        }
+      }
+      e
+    end
+  end; alias report report_all_holidays # === report
+
+  # ========================================================================= #
+  # === is_this_day_a_holiday?
+  #
+  # This method will return true if the given input-day is a holiday.
+  # ========================================================================= #
+  def is_this_day_a_holiday?(i = '01.04.2018')
+    values.include? i
+  end; alias include?                   is_this_day_a_holiday? # === include?
+       alias is_this_day_a_holiday_day? is_this_day_a_holiday? # === is_this_day_a_holiday_day?
+
+  # ========================================================================= #
+  # === values
+  # ========================================================================= #
+  def values
+    @dataset.values.flatten
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    report if @report_the_findings
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.is_this_day_a_holiday?
+# =========================================================================== #
+def self.is_this_day_a_holiday?(i)
+  _ = ::Studium::Holidays.new(:do_not_report_anything)
+  _.is_this_day_a_holiday?(i)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'colours/colours_e_autoinclude.rb'
+  _ = Studium::Holidays.new { :be_silent }
+  #_.report_all_holidays
+  e _.is_this_day_a_holiday?
+  e 'Holiday? 28.05.2020 → '+
+    _.is_this_day_a_holiday?('28.05.2020').to_s
+  e Studium.is_this_day_a_holiday?('28.05.2018')
+  e 'Next, we check whether today is a holiday:'
+  e Studium.is_this_day_a_holiday?(Studium.dd_mm_yyyy?)
+end # holidays