studium 0.10.1

data/lib/studium/utility_scripts/lva_nummer.rb

@@ -0,0 +1,440 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::LvaNummer
+#
+# This class will return and display, on the commandline, the particular
+# LVA number of a given lecture.
+# =========================================================================== #
+# require 'studium/utility_scripts/lva_nummer.rb'
+# =========================================================================== #
+require 'studium/base/prototype.rb'
+
+module Studium # === Studium
+
+class LvaNummer < Base # === Studium::LvaNummer
+
+  require 'studium/toplevel_methods/has_this_lecture_been_already_passed_but_the_id_was_changed_lateron.rb'
+  require 'socket'
+
+  begin
+    require 'xorg_buffer'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === MAIN_POSITION_IN_THE_ARRAY
+  #
+  # This constant should refer to the position of the .csv file that
+  # keeps our lecture ID.
+  # ========================================================================= #
+  MAIN_POSITION_IN_THE_ARRAY = 7
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # Note that the first argument may also be a Hash.
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already           = true
+    )
+    reset
+    set_find_this_lecture(commandline_arguments)
+    if block_given?
+      yielded = yield
+      case yielded
+      when :do_not_modify_the_xorg_buffer
+        @do_modify_the_xorg_buffer = false
+      end
+    end
+    case run_already
+    when :do_not_run_yet
+      run_already = false
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @dataset
+    #
+    # Obtain the dataset holding all the passed exams per month.
+    # ======================================================================= #
+    @dataset = File.readlines(
+      FILE_PASSED_EXAMS_PER_MONTH,
+      encoding: main_encoding?
+    )
+    # ======================================================================= #
+    # === @do_modify_the_xorg_buffer
+    # ======================================================================= #
+    @do_modify_the_xorg_buffer = true
+    # ======================================================================= #
+    # === @do_report_results
+    # ======================================================================= #
+    @do_report_results = true
+    # ======================================================================= #
+    # === @lva_number
+    # ======================================================================= #
+    @lva_number = 0 # Store the LVA Number here.
+    sanitize_dataset
+  end
+
+  # ========================================================================= #
+  # === set_find_this_lecture
+  # ========================================================================= #
+  def set_find_this_lecture(i)
+    i = i.join(' ').strip if i.is_a? Array
+    # ======================================================================= #
+    # Need to protect against frozen strings.
+    # ======================================================================= #
+    i = i.dup if i.frozen?
+    unless i.encoding.to_s.include? USE_THIS_ENCODING
+      i = i.force_encoding(USE_THIS_ENCODING)
+    end    
+    i.strip!
+    # ======================================================================= #
+    # The following constant is defined in studium/constants/constants.rb.
+    # Somehow this was changed .... hmmmm.
+    # ======================================================================= #
+    # if HASH_PASSED_LECTURES_THAT_WERE_LATERON_CHANGED.values.include?(i)
+    #   # ===================================================================== #
+    #   # "Re-wire" to the real name of the lecture.
+    #   # ===================================================================== #
+    #   lva_id = HASH_PASSED_LECTURES_THAT_WERE_LATERON_CHANGED.invert[i] # Now we have the LV-id.
+    #   lva_id = HASH_PASSED_LECTURES_THAT_WERE_LATERON_CHANGED_LV_ID_ALIASES[lva_id]
+    #   i = HASH_PASSED_LECTURES_THAT_WERE_LATERON_CHANGED_ALIAS_NAME[lva_id]
+    # end
+    @find_this_lecture = i
+  end
+
+  # ========================================================================= #
+  # === find_this_lecture?
+  # ========================================================================= #
+  def find_this_lecture?
+    @find_this_lecture
+  end; alias input? find_this_lecture? # === input?
+
+  # ========================================================================= #
+  # === set_lva_number
+  # ========================================================================= #
+  def set_lva_number(i)
+    @lva_number = i.to_s.strip # Is always a String.
+  end
+
+  # ========================================================================= #
+  # === lva_number?
+  # ========================================================================= #
+  def lva_number?
+    @lva_number
+  end; alias lva_number lva_number? # === lva_number
+       alias id?        lva_number? # === id?
+
+  # ========================================================================= #
+  # === do_not_report_results
+  # ========================================================================= #
+  def do_not_report_results
+    @do_report_results = false
+  end; alias do_not_report_the_results do_not_report_results # === do_not_report_the_results
+
+  # ========================================================================= #
+  # === set_results
+  # ========================================================================= #
+  def set_results(i)
+    @results = i
+  end
+
+  # ========================================================================= #
+  # === try_to_modify_the_xorg_buffer
+  # ========================================================================= #
+  def try_to_modify_the_xorg_buffer(i)
+    if Object.const_defined? :XorgBuffer
+      XorgBuffer[i]
+    end
+  end
+
+  # ========================================================================= #
+  # === return_all_numbers_as_array
+  # ========================================================================= #
+  def return_all_numbers_as_array
+    @results.map {|entry|
+      entry.split('|').first.strip
+    }
+  end
+
+  # ========================================================================= #
+  # === get_rid_of_the_dataset
+  #
+  # Get rid of @dataset again.
+  # ========================================================================= #
+  def get_rid_of_the_dataset
+    remove_instance_variable(:@dataset)
+  end
+
+  # ========================================================================= #
+  # === try_to_find_matches
+  #
+  # This method will try to find any matches.
+  # ========================================================================= #
+  def try_to_find_matches
+    _ = @dataset #.join(N) # Need to re-add the "\n" here.
+    # ======================================================================= #
+    # Next, we need to use a proper regex to find the correct entry.
+    # This is a critical step - if our regex finds invalid input, we would
+    # propagate this faulty input, hence why the regex needs to be very
+    # accurate.
+    # ======================================================================= #
+    use_this_input = input?
+    if use_this_input
+      unless use_this_input.encoding.to_s.include? USE_THIS_ENCODING
+        use_this_input = ensure_main_encoding(use_this_input)
+      end
+    end
+    # ======================================================================= #
+    # For the following regex, see here:
+    #   http://rubular.com/r/2xNaE5FXPe
+    # use_this_regex = /#{Regexp.quote(use_this_input)}\s*$/
+    # ======================================================================= #
+    use_this_regex = /(\| #{Regexp.quote(use_this_input)}$)/
+    scanned = _.select {|line|
+      line =~ use_this_regex
+    }
+    # ======================================================================= #
+    # Note that the variable _ may look like this:
+    #   "20.09.2013 | 1.0 |  2.0 | 4 | UniWien |  B/M | VO |   300150   | 2013S | Chromosomenbiologie und Cytogenetik"
+    #   "25.11.1997|2.0|xxx|4|UniWien|D|VO|300053|1997W|Physik für Biologinnen und Biologen und LA-BU"
+    # ======================================================================= #
+    # ======================================================================= #
+    # We need to keep in mind that the lecture is not registered in the
+    # "already passed exams" part yet. In this case, the variable scanned
+    # will be empty, which is a case we will handle next.
+    # ======================================================================= #
+    if scanned.empty?
+      # ===================================================================== #
+      # Ok. How do we proceed from here? Well, we have a few options.
+      #
+      # A simple one is to make use of the file called 'lecture_information.yml'
+      #
+      # This should ideally have our lecture registered.
+      #
+      # In the event that it ahs not, we will try to obtain the information
+      # from a remote URL. For this we will use the project BeautifulUrl -
+      # but keep in mind that BeautifulUrl must have registered that page
+      # prior before it could be found.
+      #
+      # Also, keep in mind that we can not get rid of '(' and ')', because
+      # some lectures may mandate this as part of their name.
+      # ===================================================================== #
+      keys_only = YAML.load_file(FILE_LECTURE_INFORMATION).keys
+      hash = {}
+      keys_only.each {|line|
+        line = ensure_main_encoding(line)
+        index = line.index(' ')
+        key = line[0,index]
+        value = line[index+1 .. -1]
+        hash[key] = value
+      }
+      _ = input?.delete(' ') # .delete('()') # Easier to get the input without any ' ' in it and without ( or ) either.
+      url = Studium.sanitize_url(_) # So that we do not depend on Studium::Base.
+      if hash.has_value?(input?)
+        this_lva_number = hash.key(input?)
+        set_lva_number(this_lva_number)
+        if @do_report_results
+          e lva_number?
+          try_to_modify_the_xorg_buffer(lva_number?) if @do_modify_the_xorg_buffer
+        end
+      elsif url.is_a? Array
+        target_url = url.first
+        # =================================================================== #
+        # Assign a default lecture_id value next.
+        # =================================================================== #
+        lecture_id = '000000' # Use a default, just in case.
+        # =================================================================== #
+        # Intercept nil values first.
+        # =================================================================== #
+        if target_url.nil?
+          e 'Found a nil value for target_url, on '+sfancy(_)+'.'
+          e 'Please fix this issue.'
+        elsif target_url.include? 'ufind.'
+          use_this_regex = # See: http://rubular.com/r/LsdAmVnOT1
+            /ufind.univie.ac.at\/de\/course.html\?lv=(\d{4,6})&semester=20\d\d/
+          target_url =~ use_this_regex
+          lecture_id = $1.to_s.dup
+        else
+          # ================================================================= #
+          # Get the content of the remote page. we assume this to be a
+          # BOKU lecture if we enter here.
+          # ================================================================= #
+          # ================================================================= #
+          # We must handle possible errors, as the URL may be non-existent,
+          # for instance.
+          # ================================================================= #
+          begin
+            remote_page_content = open(target_url)
+            remote_page_content = remote_page_content.read.delete(N) # Easier to work without newlines.
+            # =============================================================== #
+            # Next, find the proper match via a regex. For BOKU lectures
+            # this is the "Nummer" entry.
+            # =============================================================== #
+            use_this_regex = # See: http://rubular.com/r/07S71aEYEt
+              /class="Mask ">Nummer<\/label><\/td><td colspan="0" class=" MaskRenderer top"><table class=" MaskSpacing"><tr><td class=" MaskRenderer"><span class="bold ">(\d{1,6})<\/span>/
+            # =============================================================== #
+            # We need to grab the lecture_id next.
+            # =============================================================== #
+            if remote_page_content.include? 'Nummer</label>'
+              remote_page_content =~ use_this_regex
+              lecture_id = $1.to_s.dup
+            end
+          rescue OpenURI::HTTPError => error
+            opnn; e 'An error happened which will be shown next ('+
+                     swarn('OpenURI::HTTPError')+')'
+            pp error
+            opnn; e 'This means that a remote website is probably unavailable. '\
+                    '(target_url was: '+simp(target_url)+')'
+            opnn; e 'If this is for a lecture at the BOKU, then this usually '
+            opnn; e 'means that some maintenance work is currently ongoing.'
+            opnn; e 'We will thus exit for now as we can not access '\
+                    'the remote information anyway.'
+            exit
+          rescue SocketError => error # This here requires: require 'socket'
+            opnn; e 'An error happened:'
+            pp error
+            lecture_id = '0'
+          rescue Errno::ENOENT
+            lecture_id = '0'
+          rescue Net::OpenTimeout
+            opnn; e 'A Net::OpenTimeout was encountered. Your internet '\
+                    'connection may not be working or the remote site '\
+                    'may have a problem.'
+            lecture_id = 'Net::OpenTimeout'
+          rescue Interrupt
+            opnn; e 'Exiting upon user request.'
+            exit
+          rescue Exception => error
+            opnn; e 'Another error for the URL '+sfancy(target_url)+': '
+            pp error
+          end
+        end
+        set_lva_number(lecture_id) # Also keep a reference to the LVA number at hand.
+        report_results([lecture_id+'|'+target_url]) if @do_report_results
+      end
+    else # else still register the LVA number.
+      if lva_number?.to_s.empty? or
+        (lva_number?.to_s == '0')
+        first = scanned.first
+        _ = first.split('|')[MAIN_POSITION_IN_THE_ARRAY] # Obtain the LVA number here, position 8.
+        set_lva_number(_)
+      end
+    end
+    set_results(scanned)
+  end
+
+  # ========================================================================= #
+  # === report_results
+  #
+  # The input to this method will have results IF we already passed that
+  # particular exam.
+  #
+  # IF we have not yet passed that exam, the input may look like this:
+  #
+  #   ["931103|https://online.boku.ac.at/BOKUonline/wbLv.wbShowLVDetail?pStpSpNr=277659"] 
+  #
+  # Unfortunately, some exams may have already been passed, but may now have
+  # another id, so ideally we also need a way to determine the LVA-ID number
+  # in these cases.
+  #
+  # An alternative is to register the passed exams in a file called
+  # lecture_information.yml.
+  # ========================================================================= #
+  def report_results(
+      use_these_results = @results
+    )
+    if use_these_results.empty?
+      # opnn; e 'This lecture ('+sfancy(input?.to_s)+') is not registered/known.'
+    else
+      use_these_results.each {|line| # <- Assume an Array here.
+        # =================================================================== #
+        # For now we will always assume that the dataset given to this
+        # method will contain a '|' token. Do not forget that.
+        # =================================================================== #
+        splitted = line.split('|').map(&:strip)
+        lva_number = splitted[MAIN_POSITION_IN_THE_ARRAY] # Is at position number 7.
+        e lva_number if @do_report_results # This line is the "reporting" part. :)
+        try_to_modify_the_xorg_buffer(lva_number) if @do_modify_the_xorg_buffer
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === sanitize_dataset
+  # ========================================================================= #
+  def sanitize_dataset
+    @dataset.reject! {|entry| entry.strip.empty? }
+    @dataset.reject! {|entry| entry.strip.start_with? '#'}
+    # ======================================================================= #
+    # Some exams, in particular at the University of Vienna, are equivalent
+    # to other exams. For example, "Physik für Biologinnen und Biologen
+    # und LA-BU" has been imputed for "B-BIO 4 Biologische Physik (BIO 3)".
+    # Or the lecture "300006 VO Allgemeine und Molekulare Genetik Teil II"
+    # which is equivalent to "300132 VO Allgemeine und Molekulare Genetik
+    # II".
+    # This explains why some entries ought to be "corrected".
+    # The code that follows will do this.
+    # ======================================================================= #
+    split_token_to_use = '|'
+    @dataset.map! {|line|
+      line.chomp!
+      splitted = line.split(split_token_to_use).map(&:strip)
+      name_of_the_lecture = splitted.last
+      id_of_the_lecture   = splitted[7]
+      # ===================================================================== #
+      # The following method is defined in:
+      #   studium/toplevel_methods/has_this_lecture_been_already_passed_but_the_id_was_changed_lateron.rb
+      # ===================================================================== #
+      if ::Studium.has_this_lecture_been_already_passed_but_the_id_was_changed_lateron?(
+          id_of_the_lecture, name_of_the_lecture
+        )
+        # =================================================================== #
+        # In this case, since the ID has already been changed,
+        # re-write the dataset.
+        # =================================================================== #
+        id_of_the_lecture   = HASH_PASSED_LECTURES_THAT_WERE_LATERON_CHANGED_LV_ID_ALIASES[id_of_the_lecture]
+        name_of_the_lecture = HASH_PASSED_LECTURES_THAT_WERE_LATERON_CHANGED_ALIAS_NAME[id_of_the_lecture]
+        splitted[-1] = name_of_the_lecture
+        splitted[7]  = id_of_the_lecture
+        line = splitted.join(split_token_to_use)
+      end
+      line
+    }
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    try_to_find_matches
+    get_rid_of_the_dataset
+    report_results if @do_report_results
+  end
+
+  # ========================================================================= #
+  # === Studium::LvaNummer[]
+  # ========================================================================= #
+  def self.[](i)
+    new(i)
+  end
+
+end; end

data/lib/studium/utility_scripts/mandatory_lectures_in_this_month.rb

@@ -0,0 +1,321 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::MandatoryLecturesInThisMonth
+#
+# This class can be used to display which mandatory lectures are done
+# on a per-monthly basis.
+#
+# Usage example:
+#
+#   Studium::MandatoryLecturesInThisMonth.new
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/mandatory_lectures_in_this_month.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class MandatoryLecturesInThisMonth < ::Studium::Base # === Studium::MandatoryLecturesInThisMonth
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === AVAILABLE_MONTHS
+  # ========================================================================= #
+  AVAILABLE_MONTHS = Date::MONTHNAMES
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_show_mandatory_courses_in_this_month(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @check_against_this_year
+    #
+    # The following variable is important so that we know whether
+    # we shall check against the current year, or the next year.
+    # This depends on the input passed to the method
+    # set_show_mandatory_courses_in_this_month() ultimately.
+    # ======================================================================= #
+    @check_against_this_year = Time.now.year
+    if ::Studium.main_dataset?
+      @dataset = ::Studium.main_dataset?
+    else
+      @dataset = return_dataset_from_file_lecture_information
+    end
+  end
+
+  # ========================================================================= #
+  # === set_show_mandatory_courses_in_this_month
+  #
+  # This method determines on which month we will work.
+  #
+  # Note that we will store the month as a number.
+  # ========================================================================= #
+  def set_show_mandatory_courses_in_this_month(
+      i = return_current_month_as_a_number
+    )
+    if i.is_a? Array # We want a String past this point here.
+      if i.empty?
+        i << return_current_month_as_a_number
+      end
+      i = i.join(' ').strip
+    end
+    i = i.to_s # First a String, to check for month-names.
+    if MONTH_NAME_ALIASES_GERMAN_TO_ENGLISH.has_key? i.capitalize
+      i = MONTH_NAME_ALIASES_GERMAN_TO_ENGLISH[i.capitalize]
+    end
+    if MONTH_NAME_TO_MONTH_NUMBER.has_key? i.capitalize
+      # ===================================================================== #
+      # If the key is found in that number, we will use its value.
+      # ===================================================================== #
+      i = MONTH_NAME_TO_MONTH_NUMBER[i.capitalize]
+    end
+    i = i.to_i
+    @show_mandatory_courses_in_this_month = i
+    # ======================================================================= #
+    # Whenever the month has been assigned, we also need to consider
+    # updating the variable called @check_against_this_year.
+    # The logic for this is simple - if the number is below the current
+    # month, then we will add +1 to @check_against_this_year. 
+    # ======================================================================= #
+    if i < Time.now.month
+      @check_against_this_year += 1
+    end
+  end
+
+  # ========================================================================= #
+  # === show_mandatory_courses_in_this_month?
+  # ========================================================================= #
+  def show_mandatory_courses_in_this_month?
+    @show_mandatory_courses_in_this_month
+  end; alias searching_for_which_month? show_mandatory_courses_in_this_month? # === searching_for_which_month?
+
+  # ========================================================================= #
+  # === which_month?
+  #
+  # This method must return the name of a month.
+  # ========================================================================= #
+  def which_month?
+    AVAILABLE_MONTHS[@show_mandatory_courses_in_this_month]
+  end
+
+  # ========================================================================= #
+  # === determine_which_courses_are_run_in_this_month
+  # ========================================================================= #
+  def determine_which_courses_are_run_in_this_month
+    searching_for_this_month = searching_for_which_month?
+    searching_for_this_year  = searching_for_which_year?
+    _ = @dataset
+    # ======================================================================= #
+    # We must determine next which entries are in the month at hand.
+    # ======================================================================= #
+    _.select! {|name_of_the_lecture, inner_dataset|
+      lva_dates = inner_dataset['lva_dates']
+      if lva_dates
+        only_the_month = lva_dates.map {|entry|
+          entry = remove_weeknames(entry).strip
+          # ================================================================= #
+          # Invalidate entries that do not use the target year.
+          # ================================================================= #
+          unless entry.include? searching_for_this_year.to_s
+            entry = nil
+          end
+          if entry
+            if entry.include? ','
+              entry = entry.split(',').first
+            end
+            if entry.include? '.'
+              entry = entry.split('.')[1].to_i # This selects the month-entry. 
+            end
+          end
+          entry
+        }
+        only_the_month.compact!
+        only_the_month.include? searching_for_this_month
+      else
+        e swarn('No lva entry for `')+
+          slateblue(name_of_the_lecture)+
+          swarn('`.')
+      end
+    }
+    # ======================================================================= #
+    # Sort by priority first.
+    # ======================================================================= #
+    _ = _.sort_by {|a, b| priority = b[:priority]
+      priority # Sort by priority first.
+    }
+    @dataset = _
+    e
+    e "The following lectures are in the month #{orange(which_month?.to_s)}:"
+    e
+    report(@dataset)
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  #
+  # This is the general reporting-method of this class. Arrays and Hashes
+  # may be treated somewhat differently.
+  # ========================================================================= #
+  def report(
+      i = @dataset
+    )
+    result = ''.dup
+    if i.is_a? Hash
+      i.each_pair {|a, b|
+        result << "  #{powderblue(a)}#{N}"
+      }
+    elsif i.is_a? Array
+      counter = 0
+      i.each {|name_of_the_lecture, b| counter += 1
+        result << '  '+
+                  royalblue((counter.to_s+')').ljust(4))+
+                  powderblue(name_of_the_lecture)
+        lva_dates    = b['lva_dates']
+        lecture_type = obtain(:type, b)
+        if lva_dates.is_a? Array
+          lva_dates.map! {|inner_line|
+            inner_line.strip.delete(',')
+          }
+        end
+        if b.is_a?(Hash) and b.has_key?(:priority)
+          # ================================================================= #
+          # In this case append the priority. And the amount of ECTS too.
+          # ================================================================= #
+          result << +seagreen(
+            ' (Priority: '+b[:priority].to_s
+          )
+          if b.has_key?(:ects)
+            result << seagreen('; ')
+            result << mediumorchid(b[:ects].to_s+' ECTS')
+          end
+          result << "; Type: #{lecture_type}"
+          result << seagreen(')')
+        end
+        result << N
+        this_month = @show_mandatory_courses_in_this_month
+        unless lva_dates.empty?
+          result << N # A prettier newline before we will display the rest.
+        end
+        # =================================================================== #
+        # Next, also show the lectures in this month.
+        # =================================================================== #
+        lva_dates.each {|lva_date|
+          # ================================================================= #
+          # Only add it if it is the proper month.
+          # ================================================================= #
+          splitted = lva_date.split('.')
+          month = splitted[1].to_i
+          if month == this_month
+            weekday = return_weekday_from_this_input(lva_date, :use_german).ljust(10)
+            result << skyblue('    ')+
+                      mediumseagreen(weekday)+
+                      skyblue(' '+lva_date+N)
+          end
+        }
+        result << N # A prettier newline before we will display the rest.
+      }
+    end
+    result << N
+    e result
+  end
+
+  # ========================================================================= #
+  # === check_against_this_year?
+  # ========================================================================= #
+  def check_against_this_year?
+    @check_against_this_year
+  end; alias check_for_which_year?     check_against_this_year? # === check_for_which_year?
+       alias searching_for_which_year? check_against_this_year? # === check_against_this_year?
+
+  # ========================================================================= #
+  # === select_only_unfinished_mandatory_presence_courses_with_a_lva_dates_entry
+  #
+  # We will select only the following courses:
+  #
+  #   (1) Those that are "prüfungsimmanent", aka require "mandatory presence"
+  #   (2) Those that have NOT yet been solved
+  #   (3) Those that DO have a lva_dates entry.
+  #
+  # ========================================================================= #
+  def select_only_unfinished_mandatory_presence_courses_with_a_lva_dates_entry
+    @dataset.select! {|a, inner_dataset|
+      lecture_type = inner_dataset[:type]
+      already_solved = inner_dataset[:already_solved]
+      has_lva_dates_entry = inner_dataset.has_key?('lva_dates')
+      is_prüfungsimmanent?(lecture_type) and
+      (!already_solved) and
+      has_lva_dates_entry
+    }
+  end
+
+  # ========================================================================= #
+  # === show_introduction_header
+  # ========================================================================= #
+  def show_introduction_header
+    opnn { :no_colon }
+    e
+    e
+    e "All lectures that offer a date on the month #{teal(which_month?.to_s)}"\
+      " will be shown next."
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    show_introduction_header
+    # ======================================================================= #
+    # First, we will select mandatory-presence courses.
+    # ======================================================================= #
+    select_only_unfinished_mandatory_presence_courses_with_a_lva_dates_entry
+    determine_which_courses_are_run_in_this_month
+  end
+
+  # ========================================================================= #
+  # === Studium::MandatoryLecturesInThisMonth[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.mandatory_lectures_in_this_month
+# =========================================================================== #
+def self.mandatory_lectures_in_this_month(i)
+  Studium::MandatoryLecturesInThisMonth.new(i)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::MandatoryLecturesInThisMonth.new(ARGV)
+end # mandatory_lectures_in_this_month November
+    # mandatory_lectures_in_this_month März
+    # mandatory_lectures_in_this_month 10
+    # mandatorylecturesinthismonth