studium 0.16.9

data/lib/studium/toplevel_methods/does_this_course_require_mandatory_presence.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/does_this_course_require_mandatory_presence.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/constants/standalone_constants.rb'
+
+  # =========================================================================== #
+  # === Studium.does_this_course_require_mandatory_presence
+  #
+  # The first argument should be the type of the lecture at hand, as
+  # String, such as 'VO' or 'VU' or 'SE'.
+  #
+  # The (optional) second argument can be used to ignore certain
+  # lecture types for the given query at hand.
+  # =========================================================================== #
+  def self.does_this_course_require_mandatory_presence(
+      i,
+      ignore_these_types = nil
+    )
+    i = i.first if i.is_a? Array
+    ignore_these_types = [ignore_these_types].flatten.compact
+    if ignore_these_types
+      array_copy = ARRAY_LECTURE_TYPES_THAT_ARE_MANDATORY_CONTINUOUS_ASSESSMENT.dup
+      ignore_these_types.each {|this_type|
+        array_copy.reject! {|line| line == this_type.to_s }
+      }
+      array_copy.include? i
+    else
+      ARRAY_LECTURE_TYPES_THAT_ARE_MANDATORY_CONTINUOUS_ASSESSMENT.include? i
+    end
+  end; self.instance_eval { alias is_prüfungsimmanent?                         does_this_course_require_mandatory_presence } # === Studium.is_prüfungsimmanent?
+       self.instance_eval { alias does_this_course_require_mandatory_presence? does_this_course_require_mandatory_presence } # === Studium.does_this_course_require_mandatory_presence?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  # ========================================================================= #
+  # This is the test-case actually.
+  # ========================================================================= #
+  e
+  print '  Input is: VU      '; e Studium.does_this_course_require_mandatory_presence('VU')
+  print '  Input is: VO      '; e Studium.does_this_course_require_mandatory_presence('VO')
+  print '  Input is: VL      '; e Studium.does_this_course_require_mandatory_presence('VL')
+  print '  Input is: SE      '; e Studium.does_this_course_require_mandatory_presence('SE')
+  print '  Input is: SE, :SE '; e Studium.does_this_course_require_mandatory_presence('SE', :SE)
+  e
+end # doesthiscourserequiremandatorypresence

data/lib/studium/toplevel_methods/download.rb

@@ -0,0 +1,161 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/download.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/colours/colours.rb'
+  require 'studium/constants/constants.rb'
+  require 'studium/logging/log_directory.rb'
+  require 'studium/toplevel_methods/e.rb'
+  require 'studium/toplevel_methods/esystem.rb' # Needed for wget here.
+  require 'studium/toplevel_methods/is_on_roebe.rb'
+  require 'studium/toplevel_methods/methods_related_to_files_and_directories.rb'
+  require 'studium/toplevel_methods/url.rb'
+
+  # ========================================================================= #
+  # === Studium.download_exam_topics
+  #
+  # This method can be used to download the exam_topics from the
+  # remote FTP host. This allows us to, for instance, populate the
+  # Studium dataset with these exam topics at hand.
+  #
+  # We do not actually need FtpParadise for this - we can just
+  # use open-uri instead.
+  # ========================================================================= #
+  def self.download_exam_topics(
+      i = ::Studium::Exams.remote_url? # This is "http://shevegen.square7.ch/exam_topics/"
+    )
+    regex_to_use = />(\w+)<\/a>/ # URL: http://rubular.com/r/jEjMHYQcHQ
+    require 'open-uri'
+    e 'Downloading the exam topics via open-uri() from this '\
+      'host next: '+simp(i)
+    # ======================================================================= #
+    # Open the remote files next.
+    # ======================================================================= #
+    dataset = URI.open(i).read.split("\n").select {|line|
+      line.include? '<img src="/icons-sys/unknown.png" alt="[   ]"> <a href="'
+    }
+    Dir.chdir(::Studium.log_dir?)
+    FileUtils.mkdir_p('exam_topics/') unless File.directory? 'exam_topics/'
+    Dir.chdir('exam_topics/')
+    e 'We will store into the directory `'+Dir.pwd+'`.'
+    dataset.each {|line|
+      line =~ regex_to_use
+      match = $1.to_s.dup
+      unless match.include? '.' # This checks for files such as "index.html".
+        the_remote_url = i+match
+        unless the_remote_url.end_with? '/'
+          puts 'Now downloading the exam-topic `'+simp(the_remote_url)+
+               '` into `'+Dir.pwd+'/`.'
+          local_file = match.to_s
+          File.delete(local_file) if File.exist? local_file
+          esystem("wget #{the_remote_url}")
+        end
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === Studium.download_exam_dataset
+  #
+  # This method can be used to download the exam dataset from a remote
+  # URL.
+  #
+  # Note that you may have to pass the proper remote URL into this
+  # method, as first argument if you do not want to make use of
+  # the default remote URL (which is tailored to my own use case of
+  # course).
+  #
+  # Alternatively, you could also invoke Studium::Exams.set_remote_exams_url()
+  # to set to another remote URL, which is then automatically passed to
+  # the first argument - see the below code for this.
+  #
+  # Presently this method requires "wget", but this could also be replaced 
+  # with a pure ruby solution. I just did not feel that it is needed for
+  # now, since this method will probably be used only very, very sparingly
+  # so, by only very few people.
+  #
+  # You can invoke this method from the commandline, by issuing a command
+  # such as:
+  #
+  #   studium --download-exam-dataset
+  #
+  # ========================================================================= #
+  def self.download_exam_dataset(
+      remote_url = ::Studium.remote_url?
+    )
+    # ======================================================================= #
+    # First, we will cd to the local exam-dir directory.
+    # ======================================================================= #
+    cd :exam_directory
+    e 'We will work in the directory '+
+      Colours.sdir((Dir.pwd+'/').squeeze('/'))+
+      ' next.'
+    # ======================================================================= #
+    # Next we will download the dataset from the remote URL:
+    # ======================================================================= #
+    e 'Now attempting to download all exams from the remote URL:'
+    e
+    e "  #{Colours.sfancy(remote_url)}"
+    e
+    remote_dataset = open(remote_url).read.split("\n")
+    use_this_regex = /<a href=".+">(.+)<\/a>/
+    remote_dataset.map! {|line|
+      line =~ use_this_regex
+      $1.to_s.dup
+    }
+    remote_dataset.compact!
+    remote_dataset.reject! {|line|
+      line.empty? or
+      (line.strip == 'Parent') or
+      line.include?('Parent Directory')
+    }
+    remote_dataset.each {|this_file|
+      complete_url = remote_url+this_file
+      cmd = "wget #{complete_url}"
+      e 'Now downloading the remote file `'+
+        Colours.sfile(complete_url)+'`'
+      e 'into the directory '+
+        ::Colours.sdir((Dir.pwd+'/').squeeze('/'))
+      File.delete(this_file) if File.exist?(this_file) and File.file?(this_file)
+      system cmd
+    }
+    # ======================================================================= #
+    # Next, we will copy the content of this directory to my home directory,
+    # before running a "r2" action on it.
+    # ======================================================================= #
+    if is_on_roebe?
+      target_dir_at_home =
+        ::Studium::RUBY_STUDIUM_HOME_DIR+'exam_topics/'
+      # ===================================================================== #
+      # Enter the ^^^ above defined directory.
+      # ===================================================================== #
+      if File.exist? target_dir_at_home
+        cd target_dir_at_home
+        remote_dataset.each {|name_of_the_file|
+          this_file = Studium.exam_topics_directory?+name_of_the_file
+          # ================================================================= #
+          # Get rid of files that already exist with the same name.
+          # ================================================================= #
+          File.delete(name_of_the_file) if File.exist? name_of_the_file
+          new_target = (Dir.pwd+'/'+File.basename(name_of_the_file)).squeeze '/'
+          copy_file(this_file, new_target)
+        }
+        cd RUBY_SRC_STUDIUM
+        begin
+          require 'roebe/toplevel_methods/rinstall2.rb'
+        rescue LoadError; end
+        Roebe.r2 # Do a r2-installation here.
+      end
+    end  
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium.download_exam_topics
+  Studium.download_exam_dataset
+end

data/lib/studium/toplevel_methods/e.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/e.rb'
+# =========================================================================== #
+module Studium
+
+  # ========================================================================= #
+  # === Studium.e
+  # ========================================================================= #
+  def self.e(i = '')
+    puts i
+  end
+
+end

data/lib/studium/toplevel_methods/ects_from_lectures.rb

@@ -0,0 +1,250 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The file here bundles together methods that will determine how many ECTS
+# points a given lecture has. We can query this either by the name of
+# the lecture, or by the LVA number (also optionally with the full name
+# of the lecture).
+# =========================================================================== #
+# require 'studium/toplevel_methods/ects_from_lectures.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/constants/constants.rb'
+  require 'studium/requires/require_encoding.rb'
+  require 'studium/toplevel_methods/already_solved_this_lecture.rb'
+  require 'studium/toplevel_methods/curriculum_related_code.rb'
+  require 'studium/toplevel_methods/lva_numbers.rb'
+  require 'studium/toplevel_methods/sanitized_dataset_from_file_passed_exams_per_month.rb'
+
+  # ========================================================================= #
+  # === Studium.return_ects_from_this_lva_number
+  #
+  # This method will return the amount of ECTS points from the given
+  # LVA number at hand, as a Float. This method does not deal with
+  # the name of a lecture.
+  #
+  # The input argument to this method should be the respective LVA number.
+  #
+  # === IMPORTANT ===
+  #
+  #   Note that this only works for already-registered exams, due to
+  #   the File.readlines() usage within the method body.
+  #
+  # The second optional argument can be the specific name of the lecture
+  # at hand. If you can, it is recommended that you always supply the
+  # name as well.
+  #
+  # Usage example:
+  #
+  #   Studium.return_ects_from_this_lva_number '330011' # => 6.0
+  #   Studium.return_ects_from_this_lva_number '330112'
+  #   Studium.return_ects_from_this_lva_number '300132' # => 1.5
+  #   Studium.return_ects_from_this_lva_number '300006'
+  #   Studium.return_ects_from_this_lva_number '166.210'
+  #   Studium.return_ects_from_this_lva_number('300006', name_of_the_lecture)
+  #
+  # ========================================================================= #
+  def self.return_ects_from_this_lva_number(
+      lva_id_number, # This is the lecture LVA number. It is mandatory.
+      optional_name_of_the_lecture = nil
+    )
+    if lva_id_number.is_a? Array # Convert Array into String.
+      lva_id_number = lva_id_number.flatten.join(' ')
+    end
+    lva_id_number = lva_id_number.to_s.strip
+    # ======================================================================= #
+    # Obtain the sanitized exam-dataset next.
+    # ======================================================================= #
+    dataset = Studium.return_dataset_from_file_passed_exams_per_month
+    # ======================================================================= #
+    # First, find the proper match, via a .select() statement. Note that
+    # the entry, that is the [7] part, is hardcoded.
+    # ======================================================================= #
+    selected = dataset.select {|line|
+      lecture_id = line.split('|')[7].to_s.strip # This is the lecture ID. 
+      lecture_id == lva_id_number
+    }
+    # ======================================================================= #
+    # If the user passed in the (optional) name of the lecture, then
+    # we will filter at once.
+    # The reason why this exists is that some lectures may have the same
+    # lecture ID. In this case, if the user also passed the name of the
+    # lecture into this method, then we will only consider to find any
+    # match IF it matches the name of the lecture. In order for this to
+    # work, your dataset of course must be correct.
+    # ======================================================================= # 
+    if optional_name_of_the_lecture
+      if optional_name_of_the_lecture.frozen?
+        optional_name_of_the_lecture = optional_name_of_the_lecture.dup
+      end
+      # unless optional_name_of_the_lecture.encoding.to_s.include? ::Studium.main_encoding?
+      #   # optional_name_of_the_lecture = optional_name_of_the_lecture.force_encoding(
+      #   #   ::Studium.main_encoding?
+      #   # )
+      # end
+      if optional_name_of_the_lecture.start_with? 'VO '
+        optional_name_of_the_lecture.sub!(/^VO /,'')
+      end
+      selected.select! {|line|
+        line.split('|').last.strip == optional_name_of_the_lecture
+      }
+    end
+    unless selected.empty?
+      selected.map! {|line|
+        splitted = line.split('|')
+        splitted[2].strip.to_f # <- This is the n_ECTS part.
+      }
+    end
+    result = selected.first
+    return result
+  end; self.instance_eval { alias return_ects_of_this_lva_number return_ects_from_this_lva_number } # === Studium.return_ects_of_this_lva_number
+
+  # ========================================================================= #
+  # === Studium.return_n_ects_points_of_this_lecture
+  #
+  # This method will return the amount of ECTS points for a given lecture
+  # at hand - at the least, it will attempt to determine this.
+  #
+  # The first input argument should be the name of the lecture at hand.
+  #
+  # The second argument should be the ID of the lecture. This argument
+  # is optional though.
+  #
+  # Note that for BOKU lectures, this works fairly well but it requires
+  # a working www connection.
+  #
+  # Specific usage example:
+  #
+  #   Studium.return_n_ects_points_of_this_lecture('Bioethik und Forschungsethik',300036)
+  #   Studium.return_n_ects_points_of_this_lecture('Einführung in die Chemie')
+  #   Studium.return_n_ects_points_of_this_lecture('LU Molekulare Biotechnologie')
+  #
+  # ========================================================================= #
+  def self.return_n_ects_points_of_this_lecture(
+      name_of_the_lecture,
+      optional_id_of_the_lecture = nil
+    )
+    n_ects_points = 0 # Set a default, rather than to return nil.
+    # ======================================================================= #
+    # Make use of aliases here.
+    # ======================================================================= #
+    dataset_from_the_file_lecture_aliases = YAML.load_file(Studium.file_lecture_aliases)
+    # ======================================================================= #
+    # First, we need to obtain the lva-id number of the lecture. This
+    # may yield the wrong result though, e. g. if you have the same
+    # named lecture passed, such as "Biochemie".
+    # ======================================================================= #
+    lva_number = Studium.return_lva_id_of_this_lecture(name_of_the_lecture)
+    if optional_id_of_the_lecture
+      optional_id_of_the_lecture = optional_id_of_the_lecture.to_s
+      if dataset_from_the_file_lecture_aliases.has_key? name_of_the_lecture
+        pointer = dataset_from_the_file_lecture_aliases[name_of_the_lecture]
+        if pointer.has_key?(:new_lva_id) and
+           (pointer[:old_lva_id] == optional_id_of_the_lecture)
+          optional_id_of_the_lecture = pointer[:new_lva_id]
+        end
+      end
+    end
+    if name_of_the_lecture.frozen?
+      name_of_the_lecture = name_of_the_lecture.dup
+    end
+    # ======================================================================= #
+    # Next, fix the encoding.
+    # ======================================================================= #
+    # if !name_of_the_lecture.encoding.to_s.include?(::Studium.main_encoding?)
+    #   # name_of_the_lecture = ensure_main_encoding(name_of_the_lecture)
+    # end
+    # The code below used to rename lectures.
+    # name_of_the_lecture = Studium::StudiumSolved.consider_renaming_this_lecture_to_its_alias_name(
+    #   name_of_the_lecture
+    # )
+    # ======================================================================= #
+    # For exams that were already passed, we can simply obtain their ECTS
+    # value from the local file. Easy-peasy.
+    # ======================================================================= #
+    if Studium.already_passed_this_exam?(name_of_the_lecture, lva_number)
+      n_ects_points = ::Studium.return_ects_from_this_lva_number(
+        lva_number, name_of_the_lecture
+      )
+      return n_ects_points
+    else
+      # ===================================================================== #
+      # Else we have to find out the amount of ECTS points.
+      #
+      # We have to handle different universities differently.
+      #
+      # For lectures at the BOKU university, we can locate them via the WWW.
+      # But actually, there is an even simpler method - for my own lectures,
+      # in a registered curriculum, we can simply locate the lecture in
+      # the local file, which will also include the information about the
+      # amount of ECTS.
+      #
+      # If it is, however had, really not part of any individual curriculum
+      # or anything like that, then we will have to query the amount of
+      # ECTS from a remote website.
+      # ===================================================================== #
+      # First, read all the files but only if they exist:
+      # ===================================================================== #
+      _ = Studium.return_array_location_of_all_registered_curricula
+      # ===================================================================== #
+      # Select only those that exist.
+      # ===================================================================== #
+      dataset = _.select {|entry| File.exist? entry }.map {|entry|
+        File.readlines(entry, encoding: ::Studium.main_encoding?)
+      }.flatten
+      dataset = dataset.reject {|line|
+        line = line.to_s.strip
+        line.empty? or line.start_with?('#') or (line == "- \n")
+      }.select {|line|
+        line.start_with? '-'
+      }.select {|line|
+        line.include? ' ECTS' # Must have ECTS, else it is useless for our case.
+      }
+      scanned = dataset.select {|line|
+        line.include? name_of_the_lecture
+      }
+      unless scanned.empty?
+        use_this_regex = /#\s+(\d{1,2}\.\d{1,2}) ECTS/ # See: http://rubular.com/r/kp5kHRSS52
+        scanned = scanned.first.scan(use_this_regex)
+        n_ects_points = scanned.flatten.first.to_f
+      end
+    end
+    return n_ects_points
+  end; self.instance_eval { alias determine_n_ects_points_of_this_lecture return_n_ects_points_of_this_lecture } # === Studium.determine_n_ects_points_of_this_lecture
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'colours/colours_e_autoinclude.rb'
+  alias ee print
+  if ARGV.empty? # In this case, we will run some tests.
+    e Studium.return_ects_from_this_lva_number('930105')
+    e 'We will also test: Studium.return_n_ects_points_of_this_lecture()'
+    _ = 'Einführung in die Chemie'; ee sfancy(_+': ')
+    e Studium.return_n_ects_points_of_this_lecture(_)
+    _ = 'Gemüse- und Zierpflanzenbau'; ee sfancy(_+': ')
+    e Studium.return_n_ects_points_of_this_lecture(_)
+    _ = 'Antibiotika im klinischen Einsatz'; ee sfancy(_+': ')
+    e Studium.return_n_ects_points_of_this_lecture(_)
+    e 'Next, the same lecture but it has another name.'
+    _ = 'Selected topics in biotechnology (in Eng.)'; ee sfancy(_+': ')
+    e Studium.return_n_ects_points_of_this_lecture(_)
+    _ = 'Allgemeine Biotechnologie'; ee sfancy(_+': ')
+    e Studium.return_n_ects_points_of_this_lecture(_)
+    _ = 'Molekulare Infektionsbiologie'; ee sfancy(_+': ')
+    e Studium.return_n_ects_points_of_this_lecture(_)
+    _ = 'Biochemie'; ee sfancy(_+': ')
+    e Studium.return_n_ects_points_of_this_lecture(_)
+    _ = 'Molekulare Evolution'; ee sfancy(_+': ')
+    e Studium.return_n_ects_points_of_this_lecture(_)
+    lecture_name = 'Genetik und Molekularbiologie'
+    lva_id       = '330046'
+    e 'Finally testing '+sfancy(lecture_name)+':'
+    e Studium.return_ects_from_this_lva_number(lva_id, lecture_name)
+  else
+    e Studium.return_ects_from_this_lva_number(ARGV)
+  end
+end # ectsfromlectures 930105
+    # ectsfromlectures 952119

data/lib/studium/toplevel_methods/editor.rb

@@ -0,0 +1,67 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/editor.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/constants/constants.rb'
+  require 'studium/toplevel_methods/e.rb'
+  require 'studium/toplevel_methods/write_into_file_related_functionality.rb'
+  
+  # ========================================================================= #
+  # === Studium.set_use_this_editor
+  # ========================================================================= #
+  def self.set_use_this_editor(
+      i = USE_THIS_EDITOR
+    )
+    case i
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default
+      i = USE_THIS_EDITOR
+    end
+    @use_this_editor = i
+  end
+
+  set_use_this_editor :default # Initialize the editor here.
+
+  # ========================================================================= #
+  # === Studium.editor?
+  # ========================================================================= #
+  def self.editor?
+    @use_this_editor
+  end
+
+  # ========================================================================= #
+  # === Studium.permanently_set_this_editor
+  #
+  # This method can be used to permanently set to a specific editor
+  # in use, for the whole Studium project.
+  # ========================================================================= #
+  def self.permanently_set_this_editor(i)
+    i = i.to_s # We really want a String past this point.
+    set_use_this_editor(i)
+    what = i
+    into = FILE_EDITOR
+    e "Storing #{what} into #{into} next."
+    write_what_into(what, into)
+  end
+
+  # ========================================================================= #
+  # === Studium.open_in_editor
+  # ========================================================================= #
+  def self.open_in_editor(i)
+    unless Object.const_defined? :Open
+      begin # Make OpenInEditor available.
+        require 'open'
+      rescue LoadError; end
+    end
+    [i].flatten.compact.each {|this_file|
+      Open.in_editor(this_file) {{ use_this_editor: @use_this_editor }}
+    }
+  end
+
+end

data/lib/studium/toplevel_methods/esystem.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/esystem.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/toplevel_methods/e.rb'
+
+  # ========================================================================= #
+  # === Studium.esystem
+  #
+  # This method essentially combines e, which is an alias to puts for
+  # the most part, and system(), into one new method called "esystem()" -
+  # or rather Studium.esystem().
+  # ========================================================================= #
+  def self.esystem(
+      i = ''
+    )
+    if i.is_a? Array
+      i.each {|entry| esystem(entry) }
+    else
+      e i
+      system i
+    end
+  end
+
+end

data/lib/studium/toplevel_methods/filter_away_invalid_questions.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/filter_away_invalid_questions.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/requires/require_encoding.rb'
+  require 'studium/toplevel_methods/e.rb'
+  require 'studium/toplevel_methods/is_on_roebe.rb'
+
+  # ========================================================================= #
+  # === Studium.filter_away_invalid_questions
+  #
+  # This method will filter away invalid questions - that is, lines
+  # that start with a '#' or lines that are completely empty.
+  #
+  # The input to this method should be an Array.
+  #
+  # This method will be re-used by several different classes.
+  #
+  # The second argument is optional. If given, it shall denote the
+  # name/path to the file.
+  # ========================================================================= #
+  def self.filter_away_invalid_questions(
+      i,
+      optional_argument_we_used_this_file = nil
+    )
+    require 'studium/colours/sfile.rb'
+    # ======================================================================= #
+    # Check the first entry for its encoding. This is necessary in the
+    # event that the local C library is broken.
+    # ======================================================================= #
+    # encoding_of_this_file = i.first.encoding.to_s
+    # if encoding_of_this_file.include? 'US-ASCII'
+    #   i = ensure_main_encoding(i)
+    # end
+    # ======================================================================= #
+    # We may also check for incorrect entries in that file, if we have
+    # set a certain constant to true. The next check ensures this.
+    # ======================================================================= #
+    if CHECK_FOR_INCORRECT_ENTRIES_IN_THE_QUESTION_ANSWER_FILE_THAT_SHOULD_BE_COMMENTS
+      if i.any? {|line|
+          line.start_with?(/[A-Za-z]{1}#/) # Exactly one character.
+        }
+        e 'Note that in the file'
+        e "  `#{optional_argument_we_used_this_file}`"
+        e 'there appears to be a wrong line/entry.'
+        # =================================================================== #
+        # Try to auto-correct it if we are on a Roebe-system.
+        # =================================================================== #
+        if is_on_roebe? and optional_argument_we_used_this_file
+          modified_dataset = i.map {|entry|
+            if entry.start_with?(/[A-Za-z]{1}#/)
+              entry[0,1] = '' unless entry.start_with?('#')
+            end
+            entry
+          }
+          e ::Colours.rev+
+            ::Colours.crimson('Autocorrecting')+
+            ' this erroneous file, as we are on a roebe-system.'
+          e "Saving into `#{sfile(optional_argument_we_used_this_file)}`."
+          write_what_into(
+            modified_dataset, optional_argument_we_used_this_file
+          )
+        end
+      end
+    end
+    array = i.reject {|line|
+      line.start_with?('#') or
+      line.strip.empty? # Get rid of empty lines.
+    } # Comments can not hold real questions.
+    array
+  end
+
+end