studium 0.10.1

data/lib/studium/exams/push_solved_questions_on_top.rb

@@ -0,0 +1,188 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::PushSolvedQuestionsOnTop
+#
+# This class will simply relocate all solved questions to the top of the
+# exam file at hand.
+#
+# Usage example:
+#
+#   Studium::Exams::PushSolvedQuestionsOnTop.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/exams/push_solved_questions_on_top.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Exams
+
+class PushSolvedQuestionsOnTop < ::Studium::Base # === Studium::Exams::PushSolvedQuestionsOnTop
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @work_on_this_file
+    #
+    # Specifies on which file we will be working.
+    # ======================================================================= #
+    @work_on_this_file = nil
+  end
+
+  # ========================================================================= #
+  # === overwrite_the_existing_file_with_this_content
+  #
+  # This method will overwrite the old file.
+  # ========================================================================= #
+  def overwrite_the_existing_file_with_this_content(content)
+    original_into = @work_on_this_file
+    opnn; e 'Storing the modified dataset into '+sfile(original_into)+'.'
+    write_what_into(content, original_into)
+    if is_on_roebe?
+      into = roebe_exam_directory?
+      if File.directory?(into)
+        into = into+File.basename(@work_on_this_file)
+        if into != original_into
+          opnn; e 'Storing the modified dataset into '+sfile(into)+' as well.'
+          write_what_into(content, into)
+        end
+      else
+        opnn; e 'No directory at '+sdir(into)+' exists.'
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === determine_on_which_file_to_work_on
+  #
+  # This method will determine on which file this class will be working on.
+  # ========================================================================= #
+  def determine_on_which_file_to_work_on
+    first_argument = first_argument?
+    if first_argument.nil?
+      opnn; e 'Please provide a valid exam topic, as input to this class.'
+      exit
+    else
+      location = return_file_associated_with_this_exam_topic(first_argument)
+      # ===================================================================== #
+      # Obtain the full path.
+      # ===================================================================== #
+      @work_on_this_file = "#{directory_to_the_exam_topics?}#{location}"
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    # ======================================================================= #
+    # First, determine on which file we want to work on.
+    # ======================================================================= #
+    determine_on_which_file_to_work_on
+    if @work_on_this_file and File.exist?(@work_on_this_file)
+      @dataset = proper_readlines(@work_on_this_file)
+      # ===================================================================== #
+      # Next check whether there is any line ending with ' []'. If so then
+      # we will do modifications; if not then not.
+      # ===================================================================== #
+      if @dataset.any? {|line| line.end_with? " []\n" }
+        do_modify_this_dataset(@dataset)
+      else
+        opnn; e 'This file does not contain any lines ending '\
+                'with '+steelblue(' []')
+      end
+    else
+      unless @work_on_this_file.nil?
+        opnn; e 'No file could be found at '+sfile(@work_on_this_file)+'.'
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === do_modify_this_dataset
+  #
+  # This method is the one that will actually modify the dataset at hand.
+  #
+  # We will simply build a new file, by moving all lines ending with
+  # " []\n" to another array.
+  # ========================================================================= #
+  def do_modify_this_dataset(i = @dataset)
+    _ = ''.dup
+    hash = {}
+    i.each {|this_line|
+      stripped_line = this_line.rstrip
+      if stripped_line.start_with?('#') or
+         stripped_line.empty? or
+         this_line.strip.empty?
+         this_line.empty?
+        # This is a comment or a newline, then.
+        unless hash.has_key? :comments
+          hash[:comments] = []
+        end
+        hash[:comments] << stripped_line
+      elsif stripped_line.end_with? ' []'
+        # This is a solved question, then.
+        unless hash.has_key? :solved_questions
+          hash[:solved_questions] = []
+        end
+        hash[:solved_questions] << stripped_line
+      else # Else we assume this must be an unsolved question.
+        unless hash.has_key? :unsolved_questions
+          hash[:unsolved_questions] = []
+        end
+        hash[:unsolved_questions] << stripped_line
+      end
+    }
+    hash[:comments].each {|line|
+      _ << "#{line}\n"
+    }
+    hash[:solved_questions].each {|line|
+      _ << "#{line}\n"
+    }
+    hash[:unsolved_questions].each {|line|
+      _ << "#{line}\n"
+    }
+    overwrite_the_existing_file_with_this_content(_)
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams::PushSolvedQuestionsOnTop[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Exams::PushSolvedQuestionsOnTop.new(ARGV)
+end # pushsolvedquestionsontop ab2

data/lib/studium/exams/question_answer/question_answer.rb

@@ -0,0 +1,842 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::QuestionAnswer
+#
+# This class accepts a question-answer line as its input. It will
+# then interprete this topic (aka the question-answer components)
+# and randomly determine a question and an answer.
+#
+# Usage examples in ruby code:
+#
+#   x = Studium::Exams::QuestionAnswer.new('- Wir können Melanome nach der "ABCDE" Regel beurteilen. Wofür stehen diese Abkürzungen? (1) A: Asymmetry (2) B: Border (3) C: Color (4) D: Diameter (5) E: Evolving')
+#   x = Studium::Exams::QuestionAnswer.new('- Nenne die beiden wichtigsten Mechanismen zur Verhinderung der Selbstbefruchtung. A: (1) physische Trennung von männlichen und weiblichen Gametophyten (2) genetisch, über die Selbst-Inkompatibilität')
+#   x = Studium::Exams::QuestionAnswer.new('- Nenne die Zucker des Calvin-Zyklus, beginnend von RUBISCO, im "Uhrzeigersinn"! A: (1) 3-Phosphoglycerat (2) 1,3-Bisphosphoglycerat (3) G3P (4) 5-G3P und Ribulose-1-5-Bisphosphat.')
+#   x = Studium::Exams::QuestionAnswer.new('- abc? def? ya')
+#
+# =========================================================================== #
+# require 'studium/exams/question_answer/question_answer.rb'
+# Studium::Exams::QuestionAnswer
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Exams
+
+class QuestionAnswer < ::Studium::Base # === Studium::Exams::QuestionAnswer
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === ALL_COLOUR_METHODS
+  # ========================================================================= #
+  ALL_COLOUR_METHODS = ::Colours::AllColourMethods
+
+  # ========================================================================= #
+  # === COLOUR_OLIVEDRAB
+  #
+  # We need the string-representation of the RGB values.
+  # ========================================================================= #
+  COLOUR_OLIVEDRAB = ::Colours.rgb_value_as_string('olivedrab')
+
+  # ========================================================================= #
+  # === EMPHASIZE_WORDS_IN_QUOTES_IN_A_GIVEN_ANSWER
+  # ========================================================================= #
+  EMPHASIZE_WORDS_IN_QUOTES_IN_A_GIVEN_ANSWER = false
+
+  # ========================================================================= #
+  # === EMPHASIZE_WORDS_IN_QUOTES_IN_A_GIVEN_QUESTION
+  #
+  # This constant is like the constant called
+  # EMPHASIZE_WORDS_IN_QUOTES_IN_A_GIVEN_ANSWER, except that here
+  # we work on double-quotes, aka '"' characters, in a question.
+  #
+  # As of November 2019, this defaults to false, since we already
+  # use many other colours at this point.
+  # ========================================================================= #
+  EMPHASIZE_WORDS_IN_QUOTES_IN_A_GIVEN_QUESTION = false
+
+  # ========================================================================= #
+  # === COLOURS
+  # ========================================================================= #
+  COLOURS = ::Colours::AllColourMethods
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # The first argument should contain the line that has both the
+  # particular question and the answer to said question.
+  # ========================================================================= #
+  def initialize(
+      use_this_line = nil,
+      run_already   = true
+    )
+    reset
+    set_line(use_this_line)
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :disable_colours
+      # ===================================================================== #
+      when :disable_colours
+        disable_colours
+        set_mode :www # ← Experimental as of 13.04.2019.
+      end 
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @use_colours
+    # ======================================================================= #
+    @use_colours = true
+    # ======================================================================= #
+    # === @question
+    # ======================================================================= #
+    @question = ''.dup
+    # ======================================================================= #
+    # === @line
+    # ======================================================================= #
+    @line = nil
+    # ======================================================================= #
+    # === @answer
+    # ======================================================================= #
+    @answer = ''.dup
+    # ======================================================================= #
+    # === @word_wrap_at
+    # ======================================================================= #
+    @word_wrap_at = 82
+    # ======================================================================= #
+    # The default colours will not be made available when we run in the www-mode.
+    # ======================================================================= #
+    if are_we_in_www_mode?
+      disable_colours
+    end
+    # ======================================================================= #
+    # === @custom_colours
+    # ======================================================================= #
+    @custom_colours = nil
+    # ======================================================================= #
+    # Next, honour custom colours that the user has defined, should these
+    # exist.
+    # ======================================================================= #
+    if File.exist?(FILE_CUSTOM_COLOURS)
+      @custom_colours = YAML.load_file(FILE_CUSTOM_COLOURS)
+    end
+  end
+
+  # ========================================================================= #
+  # === line_contains_italic_token?
+  # ========================================================================= #
+  def line_contains_italic_token?(i = @line)
+    (i.include?('<it>') and i.include?('</it>')) or
+    (i.include?('<i>')  and i.include?('</i>'))
+  end
+
+  # ========================================================================= #
+  # === colour_for_answers?
+  # ========================================================================= #
+  def colour_for_answers?
+    @custom_colours['colour_for_answers']
+  end
+
+  # ========================================================================= #
+  # === colour_for_questions?
+  # ========================================================================= #
+  def colour_for_questions?
+    @custom_colours['colour_for_questions']
+  end
+
+  # ========================================================================= #
+  # === line_contains_bold_token?
+  # ========================================================================= #
+  def line_contains_bold_token?(i = @line)
+    (i.include?('<b>') and i.include?('</b>'))
+  end
+
+  # ========================================================================= #
+  # === line_contains_underline_token?
+  # ========================================================================= #
+  def line_contains_underline_token?(i = @line)
+    (i.include?('<ud>') and i.include?('</ud>')) or
+    (i.include?('<u>')  and i.include?('</u>'))
+  end
+
+  # ========================================================================= #
+  # === assign_url
+  #
+  # Only call this method after making a line.include? 'URL:' check. The
+  # reason for this is that we will only apply this method on a line
+  # that has this substring representing a remote URL.
+  # ========================================================================= #
+  def assign_url(i)
+    if use_unicode_symbols?
+      nice_token = '➡' # We will use a slightly prettier symbol for Unicode in this case.
+    else
+      nice_token = '=>'
+    end
+    i =~ /URL:\s*(.*)( |)/
+    url = sanitize_url($1.to_s.dup) # URL is something like: "http://de.wikipedia.org/wiki/Ester"
+    url = url.first if url.is_a? Array
+    i = i.dup if i.frozen?
+    begin
+      # ===================================================================== #
+      # The next regex shall also check for input such as:
+      #   URL: https://en.wikipedia.org/wiki/2,4-Dinitrophenol
+      #   URL: https://en.wikipedia.org/wiki/File:Histidin_-_Histidine.svg
+      # Since as of 11.11.2018, we also include any other entry that
+      # starts with 'https:'.
+      # ===================================================================== #
+      if $1 # See: http://rubular.com/r/rNeLS2MH6f
+        i.gsub!(/URL:\s*(.*)( |)/, nice_token+' \1') # <- Also add a '=>' token.
+      end
+    rescue Exception => error
+      e 'Debugging for `'+sfancy(i.to_s)+'`:'
+      pp error
+      p url.class
+      e sfancy(url)
+    end
+  end
+
+  # ========================================================================= #
+  # === colourize_https_substring
+  #
+  # Input that passes into the following method, can look like this:
+  #
+  #   'Das "CDT-Toxin". => https://www.ncbi.nlm.nih.gov/pubmed/24253566'
+  #
+  # ========================================================================= #  
+  def colourize_https_substring(i)
+    if i.include? 'https://'
+      use_this_regex = /(https:\/\/.+)/ # See: http://rubular.com/r/4quDI8hKxS
+      i =~ use_this_regex
+      i = i.gsub(use_this_regex, slateblue('\1')) if $1
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === assign_url_or_colourize_https_substring
+  # ========================================================================= #
+  def assign_url_or_colourize_https_substring(i)
+    if i.include?(' URL:')
+      assign_url(i)
+    elsif i.include?('  https://')
+      colourize_https_substring(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === determine_the_split_position
+  #
+  # This method must determine the split-position, also called the
+  # "index" position.
+  #
+  # Example string:
+  #
+  #  - Name abc def. A: <one>DNA-Methylation</one>.
+  #
+  #
+  # ========================================================================= #
+  def determine_the_split_position(i = @line)
+    # ======================================================================= #
+    # Next, we must find the most important '?' token, then we can
+    # split on it. This is, by definition, the very last '?' that
+    # we can find, hence why we use .rindex() rather than .index().
+    # ======================================================================= #
+    if i.include?('?')
+      rindex = i.rindex('?')
+      # ===================================================================== #
+      # Some entries may have a '?' but also a 'A:' token. In this case,
+      # we have to change the index position. However had, we must be
+      # careful here, as a few answers will contain something like this
+      # here:
+      #
+      #   '(1) A: Asymmetry (2) B: Border (3) C: Color (4) D: Diameter (5) E: Evolving'
+      #
+      # ===================================================================== #
+      if i.include?('?') and i.include?(' A: ') and
+         !(i =~ /\d{1}\) A: /) # The last one here is explained above.
+        rindex = i.index(' A: ')
+      end
+      set_split_position rindex
+    elsif i.include?(' A: ')
+      set_split_position i.index(' A: ')
+    else
+      e 'No ? and no A: was found. Please check the line.'
+      e tomato(i)
+      e
+      report_this_error
+      e
+      exit
+    end
+  end; alias determine_index_position determine_the_split_position # === determine_index_position
+
+  # ========================================================================= #
+  # === report_this_error
+  # ========================================================================= #
+  def report_this_error(error = nil)
+    opnn; e 'We encountered an '+swarn('error')+'. The @index_position '\
+            'was probably out of range.'
+    opnn; e 'Feedbacking @line next:'
+    pp @line
+    opnn; e "Feedbacking #{royalblue('@split_position')} next:"
+    pp @split_position
+    if error
+      pp error
+      pp error.class
+    end
+  end
+
+  # ========================================================================= #
+  # === set_split_position
+  # ========================================================================= #
+  def set_split_position(i)
+    @split_position = i
+  end; alias set_index_position set_split_position # === set_index_position
+
+  # ========================================================================= #
+  # === determine_the_question_from_the_line
+  # ========================================================================= #
+  def determine_the_question_from_the_line
+    set_question(@line[0 .. @split_position])
+  end
+
+  # ========================================================================= #
+  # === set_question
+  # ========================================================================= #
+  def set_question(i)
+    i = i.dup if i.frozen?
+    i.strip! # ← Always chop off trailing newlines.
+    i[-2,2] = '' if i.end_with? '?A'
+    i[0,2] = '' if i.start_with? '- ' # Chop off leading '-' components.
+    # ======================================================================= #
+    # A question typically will have a trailing '?', thus we ensure this
+    # by appending a question mark '?' - unless the string already ends
+    # with '?', '.' or a '!'.
+    # ======================================================================= #
+    unless i.rstrip.end_with?('?','.','!')
+      i << '?'
+    end
+    i[-3,3] = '' if i.end_with? ' A?'
+    if i.end_with? '! ?' # Preserve the ! here.
+      i[-2,2] = ''
+    end
+    # ======================================================================= #
+    # i[-2,2] = '' if i.end_with? 'A?'
+    # ^^^ The above check is not good because the question may end like:
+    #   "T-DNA?". Perhaps we have to think of another way.
+    # ======================================================================= #
+    if i.end_with? '. ?' # This can not be correct - it must be a typo.
+      i[-2,2] = '' # Thus get rid of the last two entries.
+    end
+    if i.end_with? '.?','!?' # These two values can not be correct - it must thus be a typo.
+      i.chop! # Thus get rid of the last two entries.
+    end
+    # ======================================================================= #
+    # Next we will determine how many characters are in the given line.
+    # We need to exclude ANSII escape sequences, though, as they
+    # will not be shown on the commandline - they will be interpreted
+    # differently, such as displaying a red underline colour for the
+    # given text.
+    # ======================================================================= #
+    trimmed_sequence = remove_escape_sequences(
+      remove_tags_from_this_input(
+        i
+      )
+    )
+    n_characters_to_consider_in_the_line = trimmed_sequence.size
+    if n_characters_to_consider_in_the_line > @word_wrap_at
+      i = word_wrap(i, @word_wrap_at)
+    end
+    if @custom_colours and
+       @custom_colours.has_key?('colour_for_questions')
+      i = COLOURS.send(@custom_colours['colour_for_questions'], i)
+    else
+      # ===================================================================== #
+      # Use colours in this case. The hardcoded colour is olivedrab
+      # but since as of June 2018, we also allow custom colours.
+      # ===================================================================== #
+      i = olivedrab(i) # This used to be teal().
+    end
+    # ======================================================================= #
+    # === Handle entries that are between <u>foo</u> tags
+    # ======================================================================= #
+    if line_contains_underline_token?(i)
+      use_this_colour = grey('')
+      if @custom_colours and
+         @custom_colours.has_key?('colour_for_questions')
+        use_this_colour = COLOURS.send(@custom_colours['colour_for_questions']) { :omit_end }
+      end
+      # ===================================================================== #
+      # Colourize <ud> or <u> for underline next:
+      # ===================================================================== #
+      i = replace_underline_token_with_default_colour(i)+
+          use_this_colour
+    end
+    # ======================================================================= #
+    # === Handle entries that are between <i>foo</i> tags
+    # ======================================================================= #
+    if line_contains_italic_token?(i)
+      use_this_colour = grey('')
+      if @custom_colours and
+         @custom_colours.has_key?('colour_for_questions')
+        use_this_colour = COLOURS.send(@custom_colours['colour_for_questions']) { :omit_end }
+      end
+      # ===================================================================== #
+      # Colourize <i> for italic font-style next:
+      # ===================================================================== #
+      i = replace_italic_token_with_default_colour(i)+
+          use_this_colour
+    end
+    # ======================================================================= #
+    # === Handle entries that are between <b>foo</b> tags
+    # ======================================================================= #
+    if line_contains_bold_token?(i)
+      use_this_colour = grey('')
+      if @custom_colours and
+         @custom_colours.has_key?('colour_for_answers')
+        use_this_colour = COLOURS.send(@custom_colours['colour_for_questions']) { :omit_end }
+      end
+      # ===================================================================== #
+      # Colourize <b> for italic font-style next:
+      # ===================================================================== #
+      i = replace_bold_token_with_default_colour(i)+
+          use_this_colour
+    end
+    # ======================================================================= #
+    # Next, consider colourizing all questions that have at the least 2
+    # '"' characters. These will be colourized if a certain constant is
+    # set to true.
+    # ======================================================================= #
+    if EMPHASIZE_WORDS_IN_QUOTES_IN_A_GIVEN_QUESTION
+      if @use_colours and commandline? and (i.count('"') > 1)
+        use_this_regex = /"(.+?\s*.*?)"/ # See: https://rubular.com/r/6WK5NjMJld
+        # =================================================================== #
+        # Note that we have two possibilities to consider next:
+        #
+        #   (a) the user has not specified any special colour that he/she
+        #       prefers. In this case, we default to olivedrab as the colour.
+        #   (b) the user has specified a colour to be used for exam-questions.
+        #       In this case we will use that colour.
+        #
+        # =================================================================== #
+        if @custom_colours and @custom_colours.has_key?('colour_for_questions')
+          use_this_colour = ALL_COLOUR_METHODS.send(
+            @custom_colours['colour_for_questions']
+          ) { :omit_end }
+          i.gsub!(use_this_regex,
+            '"'+forestgreen('\1'.delete(N))+ # forestgreen is the hardcoded colour to be used for now.
+            use_this_colour+'"' 
+          )
+        else # else use the hardcoded olivedrab-colour.
+          i.gsub!(use_this_regex,
+            '"'+forestgreen('\1'.delete(N))+ # forestgreen is the hardcoded colour to be used for now.
+            COLOUR_OLIVEDRAB+'"'
+          )
+        end
+      end
+    end
+    @question = i
+  end
+
+  # ========================================================================= #
+  # === determine_the_question_and_the_answer
+  # ========================================================================= #
+  def determine_the_question_and_the_answer
+    determine_the_question_from_the_line
+    determine_the_answer_from_the_line
+  end
+
+  # ========================================================================= #
+  # === split_position?
+  # ========================================================================= #
+  def split_position?
+    @split_position
+  end
+
+  # ========================================================================= #
+  # === set_custom_colours
+  # ========================================================================= #
+  def set_custom_colours(i)
+    @custom_colours = i
+  end
+
+  # ========================================================================= #
+  # === determine_the_answer_from_the_line
+  # ========================================================================= #
+  def determine_the_answer_from_the_line
+    if @split_position.nil?
+      e crimson('Some error for this line:')
+      e steelblue(line?)
+      pp self
+    end
+    set_answer @line[(@split_position+1) .. -1]
+  end
+
+  # ========================================================================= #
+  # === line?
+  # ========================================================================= #
+  def line?
+    @line
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+  end
+
+  # ========================================================================= #
+  # === answer?
+  # ========================================================================= #
+  def answer?
+    @answer
+  end; alias answer answer? # === answer
+       alias last   answer? # === last
+
+  # ========================================================================= #
+  # === question?
+  # ========================================================================= #
+  def question?
+    @question
+  end; alias question question? # === question
+       alias first    question? # === first
+
+  # ========================================================================= #
+  # === set_answer
+  #
+  # This method will assign to @answer, but first it will do a LOT of
+  # parsing. Perhaps this should be factored out into a separate method,
+  # but for now it will remain as it is.
+  # ========================================================================= #
+  def set_answer(i)
+    # ======================================================================= #
+    # === include_numbers_in_parens
+    #
+    # The next variable keeps track as to whether we have numbers such
+    # as (2).
+    # ======================================================================= #
+    include_numbers_in_parens = false
+    # ======================================================================= #
+    # === Handle Array as input
+    #
+    # This can happen due to assign_url() returning an Array.
+    # ======================================================================= #
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup # Work on non-frozen Strings past this point here.
+    i[0,2] = '' if i.start_with? '- '
+    if i.start_with? 'A: '
+      i[0, 3] = ''
+    end
+    i.strip! # This also implies .chomp.
+    # ======================================================================= #
+    # Try to cut down at about 76 characters per line, or whatever the
+    # limit-per-line is. We have to ignore special tags, though, such
+    # as <u> or <orange>. We also have to call this BEFORE replacing
+    # these tags with the corresponding escape values.
+    # ======================================================================= #
+    unless include_numbers_in_parens
+      string_without_tags = remove_tags_from_this_input(i.dup)
+      n_characters_to_consider_in_the_line = string_without_tags.size
+      if n_characters_to_consider_in_the_line > @word_wrap_at
+        i = word_wrap(i, @word_wrap_at) # word-wrap is a value such as 85.
+        i.gsub!(/\n/, N+LEFT_PADDING) if i.include? N # Also pad these newlines.
+      end
+    end
+    # ======================================================================= #
+    # Next, remove html-numbers such as <one> or HTML colours such as
+    # <royalblue>. Thus, we query whether the line contains a valid
+    # HTML colour too.
+    # ======================================================================= #
+    if use_colours? and
+       (::Colours.does_this_string_include_a_html_number?(i) or
+        ::Colours.does_this_line_include_a_html_colour?(i))
+      use_this_as_replacement_hash = {
+        'one'   => :steelblue,
+        'two'   => :mediumseagreen,
+        'three' => :mediumpurple, # ← Used to be 'peru' up until 23.11.2019.
+        'four'  => :olivedrab,
+        'five'  => :lightgreen
+      }
+      i = ::Colours.away_with_html_colours_and_special_numbers(
+        i,
+        @custom_colours['colour_for_answers'],
+        use_this_as_replacement_hash
+      )
+    end
+    # ======================================================================= #
+    # === Get rid of ' A:' if they are in that string.
+    #
+    # At this point, we do no longer want to have 'A:' in our
+    # answer-string, so we get rid of it.
+    # ======================================================================= #
+    if i.include? ' A:'
+      i.sub!(/ A:/,'') unless i.include? ') A:' # The unless check exists to avoid rare cases.
+    end
+    if i.start_with? '?'
+      i.sub!(/^\?/,'') # Only chop it away at the beginning.
+    end
+    i[0,2] = '' if i.start_with? ': ','? ','?:'
+    i.strip! # Call .strip! again here, just in case.
+    # ======================================================================= #
+    # Assume () modifications. But this conflicts with entries that have
+    # a pure () as part of their answer, which may happen on computer
+    # related questions such as foobar(). Hence, on Dec 2014, I have
+    # disabled the next line.
+    # ======================================================================= #
+    # i.gsub!(/\(\)/, N+'- ') if i.include? '()'
+    # ======================================================================= #
+    if debug?
+      e "We will now set the answer to: #{sfancy(i)}" if commandline?
+    end
+    # ======================================================================= #
+    # Get rid of trailing [], just in case.
+    # ======================================================================= #
+    i[-2,2] = '' if i.end_with? '[]'
+    i[0,2] = '' if i.start_with? 'A:' # This here may be rare.
+    if i.include? '(a)' # Also assume (b) (c) etc..
+      i.gsub!(/\(a\)/, N+'  (a)')
+      i.gsub!(/\(b\)/, N+'  (b)') if i.include? '(b)'
+      i.gsub!(/\(c\)/, N+'  (c)') if i.include? '(c)'
+      i.gsub!(/\(d\)/, N+'  (d)') if i.include? '(d)'
+      i.gsub!(/\(e\)/, N+'  (e)') if i.include? '(e)'
+      i.gsub!(/\(f\)/, N+'  (f)') if i.include? '(f)'
+    end
+    # ======================================================================= #
+    # === Replace <br> tags, should they be part of the answer
+    # ======================================================================= #
+    i.gsub!(/<br>/, N) if i.include? '<br>'
+    # ======================================================================= #
+    # === Get rid of (2) and similar numbers
+    #
+    # We assume this to also include (1) and (3) and so forth here.
+    # ======================================================================= #
+    if i.include? '(2)'
+      include_numbers_in_parens = true
+      # ===================================================================== #
+      # Do a word wrap if the size range from the part up to the first
+      # '(' is larger than the allowed characters per line.
+      # Since as of August 2019 we will honour HTML colour-tags though
+      # and add that to the subrange size.
+      # ===================================================================== #
+      subrange = i[0 .. (i.index('(') - 1)].dup
+      subrange_size = subrange.size
+      if does_this_line_include_a_html_colour?(subrange)
+        subrange_size += return_this_line_has_n_characters_as_html_colour_tags(subrange)
+      end
+      if subrange_size > @word_wrap_at
+        i[0 .. (i.index('(')-1)] = ''.dup
+        subrange = word_wrap(subrange, @word_wrap_at).dup+N
+        i[0,0] = subrange
+      end
+      12.times { |iteration_number_n|
+        if @use_colours
+          # ================================================================= #
+          # Colourize the parens - and also add a leading newline.
+          # ================================================================= #
+          replace_with_this = N+
+                              '  '+
+                              rev+
+                              slategray('(')+
+                              skyblue(iteration_number_n.to_s.chomp)+
+                              slategray(')')
+          if use_colours? and
+             @custom_colours and
+             @custom_colours.has_key?('colour_for_answers')
+            use_this_colour = ::Colours.send(@custom_colours['colour_for_answers']) { :omit_end }
+            replace_with_this << use_this_colour
+          end
+          i.gsub!(/\(#{iteration_number_n}\)/,replace_with_this)
+        else
+          i.gsub!(/\(#{iteration_number_n}\)/,
+            N+'('+iteration_number_n.to_s+')') # Will add a leading newline.
+        end
+      } # The above is equivalent to the below, by the way:
+        # i.gsub!(/\(6\)/, N+'(6)')
+    end
+    # ======================================================================= #
+    # Colourize the answer as grey.
+    # ======================================================================= #
+    if @custom_colours and
+       @custom_colours.has_key?('colour_for_answers')
+      i = COLOURS.send(@custom_colours['colour_for_answers'], i)
+    else # else we will use grey as the colour.
+      i = grey(i)
+    end
+    # ======================================================================= #
+    # === Handle entries that are between <ud>foo</ud> tags
+    # ======================================================================= #
+    if line_contains_underline_token?(i)
+      use_this_colour = grey('')
+      if @custom_colours and
+         @custom_colours.has_key?('colour_for_answers')
+        use_this_colour = COLOURS.send(@custom_colours['colour_for_answers']) { :omit_end }
+      end
+      # ===================================================================== #
+      # Colourize <ud> for underline next:
+      # ===================================================================== #
+      i = replace_underline_token_with_default_colour(i)+
+          use_this_colour
+    end
+    # ======================================================================= #
+    # === Handle entries that are between <b>foo</b> tags
+    # ======================================================================= #
+    if line_contains_bold_token?(i)
+      use_this_colour = grey('')
+      if @custom_colours and
+         @custom_colours.has_key?('colour_for_answers')
+        use_this_colour = COLOURS.send(colour_for_answers?, '')
+      end
+      # ===================================================================== #
+      # Colourize <b> for italic font-style next:
+      # ===================================================================== #
+      i = replace_bold_token_with_default_colour(i)+
+          use_this_colour
+    end
+    # ======================================================================= #
+    # === Handle entries that are between <it>foo</it> tags
+    # ======================================================================= #
+    if line_contains_italic_token?(i)
+      use_this_colour = grey('')
+      if @custom_colours and
+         @custom_colours.has_key?('colour_for_answers')
+        use_this_colour = COLOURS.send(@custom_colours['colour_for_answers']) { :omit_end }
+      end
+      # ===================================================================== #
+      # Colourize <it> for italic font-style next:
+      # ===================================================================== #
+      i = replace_italic_token_with_default_colour(i)+
+          use_this_colour
+    end
+    # ======================================================================= #
+    # === Handle URLs next
+    # ======================================================================= #
+    if i.include? ' URL:' # This is the valid form.
+      i = assign_url(i)
+    # ======================================================================= #
+    # === Handle entries that include the substring ' https://'
+    # ======================================================================= #
+    elsif i.include? '  https://'
+      i = colourize_https_substring(i)
+    end
+    if i.include?(' URL:') or i.include?('  https://')
+      assign_url_or_colourize_https_substring(i)
+    end
+    # ======================================================================= #
+    # === Colourize words in quotes
+    #
+    # Next, consider colourizing all answers that have at the least 2
+    # '"' characters. These will be colourized.
+    # ======================================================================= #
+    if EMPHASIZE_WORDS_IN_QUOTES_IN_A_GIVEN_ANSWER
+      if @use_colours and commandline? and (i.count('"') > 1)
+        use_this_regex = /"(.+?\s*.*?)"/ # See: http://rubular.com/r/6WK5NjMJld
+        use_this_colour = GRAY
+        if @custom_colours and
+          @custom_colours.has_key?('colour_for_answers')
+          use_this_colour = ALL_COLOUR_METHODS.send(@custom_colours['colour_for_answers']) { :omit_end }
+        end
+        i.gsub!(
+          use_this_regex,
+          '"'+steelblue('\1'.delete(N))+
+          use_this_colour+'"'
+        )
+      end
+    end
+    @answer = i
+  end
+
+  # ========================================================================= #
+  # === set_line
+  #
+  # This method will assign to @line. A full @line is an exam-question
+  # containing a question, and the answer to this question.
+  # ========================================================================= #
+  def set_line(i)
+    if i
+      i = i.dup if i.frozen?
+      if i.start_with? '- '
+        i[0,2] = '' # Chop off leading '- ' tokens.
+      end
+    end
+    @line = i
+    if block_given?
+      case yield
+      # ===================================================================== #
+      # === :then_determine_the_split_position
+      # ===================================================================== #
+      when :then_determine_the_split_position
+        determine_the_split_position
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams::QuestionAnswer[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium::Exams.question_answer
+# =========================================================================== #
+def self.question_answer(topic = 'random_topic')
+  QuestionAnswer.new(topic)
+end
+
+end
+
+# =========================================================================== #
+# === Studium.question_answer
+# =========================================================================== #
+def self.question_answer(i = ARGV)
+  Studium::Exams::QuestionAnswer.new(i)
+end; self.instance_eval { alias parse_question_answer question_answer } # === Studium.parse_question_answer
+
+# =========================================================================== #
+# === Studium.return_question_answer_as_array
+#
+# This method will return the question-answer variant, as an Array.
+#
+# It will not make use of any colours; the reason for this is because
+# the method was added at 13.04.2019 to be used primarily on the www.
+#
+# Invocation example:
+#
+#   x = Studium.return_question_answer_as_array('amg1')
+#
+# =========================================================================== #
+def self.return_question_answer_as_array(topic = 'random_topic')
+  _ = ::Studium::Exams::QuestionAnswer.new(topic) { :disable_colours }
+  [_.question?, _.answer?]
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'colours/colours_e_autoinclude.rb'
+  require 'cliner'
+  dataset = Studium::Exams.question_answer(ARGV)
+  e dataset.question?
+  cliner
+  e dataset.answer?
+end # rb question_answer.rb amg