studium 0.9.383

data/lib/studium/exams/ask_exam_question/misc.rb

@@ -0,0 +1,846 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/exams/ask_exam_question/misc.rb'
+# =========================================================================== #
+require 'studium/log/store_last_question_asked_into_file.rb'
+
+module Studium
+
+module Exams
+
+class AskExamQuestion < ::Studium::Base
+
+  require 'studium/toplevel_methods/runmode.rb'
+
+  begin
+    require 'set_terminal_title'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === try_to_save_the_line                                       (save tag)
+  #
+  # This is called whenever we obtained a line. Note that we will
+  # save the original line.
+  #
+  # We will store into a file, which is kept at @store_where.
+  #
+  # It usually defaults to the file /Depot/Studium/last_question_asked.md
+  # or wherever else the base-directory has been defined.
+  # ========================================================================= #
+  def try_to_save_the_line(
+      i = @original_line
+    )
+    _ = store_where? # Where to store.
+    if File.exist?(File.dirname(_))
+      if debug?
+        opnn; e "Now saving: #{bold_blue(i)} into the file #{sfile(_)}"
+      end if commandline?
+      if File.writable?(File.dirname(_))
+        Studium.save_what_into(i, _) # Save it.
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === line?
+  # ========================================================================= #
+  def line?
+    @line
+  end; alias line                line? # === line
+       alias full_question_line? line? # === full_question_line?
+
+  # ========================================================================= #
+  # === set_line
+  #
+  # Set the line via this method. The line is a full line from the
+  # file that contains all questions and answers of a specific
+  # topic at hand.
+  #
+  # Note that this setter does NOT modify anything.
+  # ========================================================================= #
+  def set_line(i)
+    @line = i
+  end
+
+  # ========================================================================= #
+  # === try_to_determine_the_question_and_the_answer
+  # ========================================================================= #
+  def try_to_determine_the_question_and_the_answer
+    if main_file_exists?
+      determine_dataset
+      dataset = @dataset.dup # Keep a reference-copy.
+      # ===================================================================== #
+      # We weed out entries that end with a "[]\n" token. This behaviour
+      # can be modified by the user on the commandline.
+      # ===================================================================== #
+      if @reject_lines_that_end_with_a_done_token
+        dataset.reject! {|entry|
+          entry.end_with?("[]#{N}")
+        }
+      end
+      if dataset.empty?
+        notify_the_user_that_all_questions_have_been_answered_already
+        exit
+      else
+        # =================================================================== #
+        # Then we will pick a random entry. Here we have to keep in mind
+        # that ALL relevant entries may already have a trailing "[]\n",
+        # which means that all questions have already been answered.
+        # =================================================================== #
+        random_entry = dataset.sample
+        try_to_save_the_line(random_entry)
+        set_line(random_entry) # This line won't make any modifications.
+        determine_question_answer(@line)
+        # =================================================================== #
+        # Register the last file that was modified.
+        # =================================================================== #
+        register_last_modified_file
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === load_file_rename_konsole_tab
+  # ========================================================================= #
+  def load_file_rename_konsole_tab
+    YAML.load_file(FILE_RENAME_KONSOLE_TAB)
+  end
+
+  # ========================================================================= #
+  # === result?
+  # ========================================================================= #
+  def result?
+    @result
+  end; alias string? result? # === string?
+
+  # ========================================================================= #
+  # === may_we_show_the_topic?
+  # ========================================================================= #
+  def may_we_show_the_topic?
+    @may_we_show_the_topic
+  end; alias may_we_show_the_topic may_we_show_the_topic? # === may_we_show_the_topic
+
+  # ========================================================================= #
+  # === set_may_we_show_the_topic
+  # ========================================================================= #
+  def set_may_we_show_the_topic(i)
+    @may_we_show_the_topic = i
+  end; alias may_we_show_the_topic= set_may_we_show_the_topic # === may_we_show_the_topic=
+      alias set_show_topic          set_may_we_show_the_topic # === set_show_topic
+
+  # ========================================================================= #
+  # === enable_console_colours
+  # ========================================================================= #
+  def enable_console_colours
+    Studium.enable_colours
+  end
+
+  # ========================================================================= #
+  # === extra_options
+  #
+  # Certain extra options can be passed here.
+  # ========================================================================= #
+  def extra_options(i)
+    case i
+    # ======================================================================= #
+    # === SHOW_ALL
+    # ======================================================================= #
+    when /SHOW_?ALL/ # Invocation example: qa ethik SHOW_ALL
+      show_content_of_this_topic(topic?)
+      exit
+    end
+  end
+
+  # ========================================================================= #
+  # === set_exam_title
+  #
+  # The module-method will return the full title such as:
+  #   "Struktur und Funktion der Pflanzen"
+  # ========================================================================= #
+  def set_exam_title(i)
+    @exam_title = ::Studium.find_corresponding_exam_title(i, :be_quiet)
+  end
+
+  # ========================================================================= #
+  # === set_file
+  #
+  # The file location will be something like:
+  #
+  #   /Programs/Ruby/2.3.1/lib/ruby/site_ruby/2.3.0/studium/exam_topics/physiologie
+  #
+  # ========================================================================= #
+  def set_file(i)
+    @file = i
+  end
+
+  # ========================================================================= #
+  # === set_may_we_show_the_topic
+  # ========================================================================= #
+  def set_may_we_show_the_topic(i = true)
+    @may_we_show_the_topic = i
+  end
+
+  # ========================================================================= #
+  # === do_sleep
+  #
+  # Use this to sleep for the specified duration, stored in the ivar @delay.
+  #
+  # Since April 2012 we also handle SIGINT-events gracefully here.
+  # ========================================================================= #
+  def do_sleep
+    begin
+      sleep(delay?)
+    rescue Interrupt # We are silent here.
+      exit_program
+    end
+  end; alias default_sleep do_sleep # === default_sleep
+
+  # ========================================================================= #
+  # === store_into_rename_tab_file
+  # ========================================================================= #
+  def store_into_rename_tab_file(i)
+    i.sub!(/rename_tab:/,'')
+    i.strip!
+    into = FILE_RENAME_KONSOLE_TAB
+    case i
+    when 'true'
+      what = true
+    when 'false'
+      what = false
+    else
+      e "Incorrect input: #{i.to_s}"
+    end
+    e "Now storing into `#{sfile(into)}`."
+    write_what_into(what, into)
+    into = ROEBE_FILE_RENAME_KONSOLE_TAB
+    e 'Additionally storing into `'+sfile(into)+'`.'
+    write_what_into(what, into)
+  end
+
+  # ========================================================================= #
+  # === delay?
+  # ========================================================================= #
+  def delay?
+    @delay
+  end; alias delay delay? # === delay
+
+  # ========================================================================= #
+  # === add
+  # ========================================================================= #
+  def add(i)
+    @result << i
+  end
+  
+  # ========================================================================= #
+  # === file?
+  #
+  # This keeps the specific file at hand.
+  # ========================================================================= #
+  def file?
+    @file
+  end
+
+  # ========================================================================= #
+  # === determine_whether_we_will_rename_the_konsole_tab
+  # ========================================================================= #
+  def determine_whether_we_will_rename_the_konsole_tab
+    if is_on_roebe?
+      if File.exist? FILE_RENAME_KONSOLE_TAB
+        _ = load_file_rename_konsole_tab
+        if _ == true
+          do_rename_konsole_tab
+        else
+          do_not_rename_konsole_tab
+        end
+      else
+        do_not_rename_konsole_tab
+      end
+    else
+      do_not_rename_konsole_tab
+    end
+  end
+
+  # ========================================================================= #
+  # === report_how_many_topics_are_available
+  # ========================================================================= #
+  def report_how_many_topics_are_available
+    opnn; e 'There are exactly '+simp(Studium.available_topics?.size.to_s)+
+            ' topics available.'
+  end
+
+  # ========================================================================= #
+  # === exit_program                                               (exit tag)
+  #
+  # Use this method to exit from the program.
+  # ========================================================================= #
+  def exit_program(make_newline = false)
+    e(N) if make_newline
+    exit # Exit here.
+  end
+
+  # ========================================================================= #
+  # === report_the_delay
+  # ========================================================================= #
+  def report_the_delay
+    e "The delay is set to: #{sfancy(delay?.to_s)}"
+  end
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn
+    super(
+      namespace:   NAMESPACE,
+      use_colours: use_colours?
+    )
+  end
+
+  # ========================================================================= #
+  # === register_last_modified_file
+  # ========================================================================= #
+  def register_last_modified_file(i = @file)
+    ::Studium.set_last_file_for_exam_questions(i) # , :be_verbose
+  end
+
+  # ========================================================================= #
+  # === dataset?
+  # ========================================================================= #
+  def dataset?
+    @dataset
+  end
+
+  # ========================================================================= #
+  # === set_dataset
+  # ========================================================================= #
+  def set_dataset(i = nil)
+    @dataset = i
+  end; alias set_data set_dataset # === set_data
+
+  # ========================================================================= #
+  # === exam_title?
+  # ========================================================================= #
+  def exam_title?
+    @exam_title
+  end
+
+  # ========================================================================= #
+  # === main_file_exists?
+  # ========================================================================= #
+  def main_file_exists?
+    File.exist? @file
+  end
+
+  # ========================================================================= #
+  # === set_default_topic_for_the_gui
+  # ========================================================================= #
+  def set_default_topic_for_the_gui(what)
+    into = ::Studium.log_dir?+'use_this_exam_topic.yml'
+    opnn; e 'Now setting the default topic to `'+simp(what)+'`.'
+    write_what_into(what, into)
+  end
+
+  # ========================================================================= #
+  # === do_rename_konsole_tab
+  # ========================================================================= #
+  def do_rename_konsole_tab
+    AskExamQuestion.set_rename_konsole_tab(true)
+  end
+  
+  # ========================================================================= #
+  # === do_not_rename_konsole_tab
+  # ========================================================================= #
+  def do_not_rename_konsole_tab
+    AskExamQuestion.set_rename_konsole_tab(false)
+  end
+
+  # ========================================================================= #
+  # === tell_whether_we_will_rename_the_kde_konsole_tab
+  # ========================================================================= #
+  def tell_whether_we_will_rename_the_kde_konsole_tab
+    e 'Will we rename the KDE konsole tab? '+
+      simp(VerboseTruth[load_file_rename_konsole_tab.to_s])
+  end
+
+  # ========================================================================= #
+  # === edit_sanitize_topics_in_vim
+  #
+  # To trigger this, do:
+  #   qa --vim
+  # ========================================================================= #
+  def edit_sanitize_topics_in_vim
+    position_in_the_file = 445
+    file =
+      '/home/x/DATA/PROGRAMMING_LANGUAGES/RUBY/src/studium/lib/studium/toplevel_methods/find_corresponding_exam_topic.rb'
+    _ = 'vim '+file+' +'+position_in_the_file.to_s
+    esystem _
+  end
+
+  # ========================================================================= #
+  # === topic?
+  # ========================================================================= #
+  def topic? # Preferentially use this method.
+    @topic
+  end; alias topic     topic? # === topic
+       alias title     topic? # === title
+       alias title?    topic? # === title?
+       alias category? topic? # === category?
+
+  # ========================================================================= #
+  # === set_all_questions_from_the_topic_to_solved
+  #
+  # This will solve all questions from a given topic.
+  #
+  # Invocation example:
+  #   qa ALL_SOLVED
+  # ========================================================================= #
+  def set_all_questions_from_the_topic_to_solved
+    if commandline?
+      e 'Setting all questions from topic '+
+        sfancy(topic?)+' to solved.'
+      # dataset = DIRECTORY_EXAM_TOPICS+topic?
+      # This does not work right now. Not sure if it can work in the way
+      # that the above has suggested - perhaps add a separate class that
+      # does this.
+      # TODO:
+      # all_topics.each
+      # if line.include? '- '
+      #   line << ' []' unless line.end_with? ' []'
+      # data = File.readlines(Exams.location_of_pruefungsfragen?)
+    end
+  end
+
+  # ========================================================================= #
+  # === report_whether_we_will_show_the_topic
+  # ========================================================================= #
+  def report_whether_we_will_show_the_topic
+    opnn; e 'Will we show the topic of the exams when asking a '\
+            'question: '+simp(VerboseTruth[may_we_show_the_topic?])
+  end
+
+  # ========================================================================= #
+  # === download_exam_topics
+  #
+  # You can use this method to download all exam topics.
+  #
+  # To call this, do:
+  #   qa --dexamtopics
+  # ========================================================================= #
+  def download_exam_topics
+    ::Studium.download_exam_topics
+  end
+
+  # ========================================================================= #
+  # === n_questions_already_answered?
+  # ========================================================================= #
+  def n_questions_already_answered?
+    @dataset.reject {|entry| entry.end_with?('[]'+N) }.size
+  end
+
+  # ========================================================================= #
+  # === default_delay?
+  # ========================================================================= #
+  def default_delay?
+    DEFAULT_DELAY
+  end
+
+  # ========================================================================= #
+  # === read_delay_from_file                                     (load delay)
+  #
+  # Use this method here, read_delay_from_file(), to read in the
+  # default delay from a stored file.
+  # ========================================================================= #
+  def read_delay_from_file
+    if File.exist? DELAY_CONSTANT_STORED_HERE
+      _ = YAML.load_file(DELAY_CONSTANT_STORED_HERE)
+      result = _['delay']
+    else # Else the file does not exist, so we use the default delay.
+      result = DEFAULT_DELAY
+    end
+    return result
+  end
+
+  # ========================================================================= #
+  # === set_original_input
+  # ========================================================================= #
+  def set_original_input(i)
+    @original_input = i
+  end
+
+  # ========================================================================= #
+  # === original_input?
+  # ========================================================================= #
+  def original_input?
+    @original_input
+  end
+
+  # ========================================================================= #
+  # === set_topic
+  #
+  # Assign to the @topic instance variable here.
+  # ========================================================================= #
+  def set_topic(
+      i, optional_argument = nil
+    )
+    case optional_argument
+    when :sanitize_the_given_input # Here, try to find the "real" topic.
+      i = ::Studium.find_corresponding_exam_topic(i, :be_quiet)
+    end
+    @topic = i
+  end
+
+  # ========================================================================= #
+  # === set_delay
+  #
+  # Set the default delay here via this method.
+  # ========================================================================= #
+  def set_delay(
+      i = default_delay?
+    )
+    i = default_delay? if i.nil?
+    @delay = i
+  end; alias delay= set_delay # === delay=
+
+  # ========================================================================= #
+  # === store_delay                                               (store tag)
+  #
+  # This method will store/save the delay into a file.
+  # ========================================================================= #
+  def store_delay(i)
+    ::Studium.save_this_delay_between_questions_and_answers(i)
+  end
+
+  # ========================================================================= #
+  # === set_question
+  # ========================================================================= #
+  def set_question(i)
+    @question = i
+  end
+
+  # ========================================================================= #
+  # === set_and_store_delay
+  #
+  # Combine two methods in one here.
+  # ========================================================================= #
+  def set_and_store_delay(i)
+    set_delay(i)
+    store_delay(i)
+  end
+
+  # ========================================================================= #
+  # === generate_statistical_webpage
+  #
+  # Invoke like so:
+  #   qa --www
+  # ========================================================================= #
+  def generate_statistical_webpage
+    ::Studium::Statistics::ReportHowManyExamQuestionsWereAnswered.generate_webpage
+  end
+
+  # ========================================================================= #
+  # === n_questions?
+  #
+  # Return how many questions are available in the given dataset at hand.
+  # ========================================================================= #
+  def n_questions?
+    @dataset.size
+  end
+
+  # ========================================================================= #
+  # === notify_the_user_that_all_questions_have_been_answered_already
+  # ========================================================================= #
+  def notify_the_user_that_all_questions_have_been_answered_already
+    opnn; e 'All questions have already been answered '
+    opnn; e "for the topic `#{orange(topic?)}`. #{slateblue(cheering_person?)}"
+  end
+
+  # ========================================================================= #
+  # === find_corresponding_file_for_roebe
+  #
+  # Find the file at my home system as well. This should obviously
+  # only be done at home.
+  # ========================================================================= #
+  def find_corresponding_file_for_roebe(i = @file)
+    ::Studium.directory_to_my_exam_topics+File.basename(i)
+  end
+
+  # ========================================================================= #
+  # === exam_topics?
+  # ========================================================================= #
+  def exam_topics?
+    directory_to_the_exam_topics?
+  end
+
+  # ========================================================================= #
+  # === topic?
+  # ========================================================================= #
+  def topic?
+    @topic
+  end; alias input? topic? # === input?
+
+  # ========================================================================= #
+  # === filter_away_invalid_questions
+  # ========================================================================= #
+  def filter_away_invalid_questions(i)
+    ::Studium.filter_away_invalid_questions(i)
+  end
+
+  # ========================================================================= #
+  # === set_store_where
+  # ========================================================================= #
+  def set_store_where(i)
+    @store_where = i.to_s
+  end
+
+  # ========================================================================= #
+  # === store_where?
+  # ========================================================================= #
+  def store_where?
+    @store_where
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments?
+  # ========================================================================= #
+  def commandline_arguments?
+    @commandline_arguments
+  end
+
+  # ========================================================================= #
+  # === determine_dataset
+  #
+  # This will determine the dataset of ONE particular topic at hand - the
+  # one that this class deals with when it is invoked.
+  # ========================================================================= #
+  def determine_dataset(i = @file)
+    set_dataset File.readlines(i)
+    # ======================================================================= #
+    # Filter away all invalid questions. These are lines that, for
+    # example, start with a '#' character. Note that the method that is
+    # called here, can also warn about invalid questions - at the least
+    # for entries that start like "t#" or so, when it was clearly meant
+    # to be a "#" comment.
+    # ======================================================================= #
+    @dataset = ::Studium.filter_away_invalid_questions(@dataset, i)
+  end
+
+  # ========================================================================= #
+  # === report_file_does_not_exist
+  # ========================================================================= #
+  def report_file_does_not_exist
+    opnn; e 'No file at `'+sfile(@file)+'` exists.'
+  end
+
+  # ========================================================================= #
+  # === store_last_topic_into_file
+  #
+  # By default we will not report this activity.
+  # ========================================================================= #
+  def store_last_topic_into_file
+    what = topic?
+    into = FILE_LAST_TOPIC
+    write_what_into(what, into)
+  end
+
+  # ========================================================================= #
+  # === set_use_this_topic
+  #
+  # Note that whenever we set a new topic, we will also store this
+  # in a file. This allows us to then query what the last topic
+  # was, e. g. via "qa --last_topic?".
+  # ========================================================================= #
+  def set_use_this_topic(i = '')
+    i = i.first if i.is_a? Array
+    # ======================================================================= #
+    # If a Hash is given then we will try to find a specific key in that
+    # Hash.
+    # ======================================================================= #
+    if i.is_a?(Hash) and i.has_key?(:use_this_topic)
+      i = i[:use_this_topic]
+    end
+    i = i.to_s.dup # Work with a String here anyway.
+    # ======================================================================= #
+    # If the input has a '|', we assume that the user wants to randomly
+    # pick one entry.
+    # ======================================================================= #
+    if i.include? '|'
+      i = i.split('|').shuffle
+    end
+    i.downcase! # Convention is to store the file downcased.
+    # ======================================================================= #
+    # Before we do the real assignment, we will sanitize this through
+    # the Studium.find_corresponding_exam_topic "filter".
+    # ======================================================================= #
+    case i # Here, we check for compound-exams, such as "qa molbio".
+    # ======================================================================= #
+    # === OLAST
+    # ======================================================================= #
+    when /^qlast$/i,
+         /^olast$/i # === olast tag
+      _ = FILE_LAST_TOPIC
+      if File.exist? _
+        i = File.read(FILE_LAST_TOPIC).strip
+      else
+        opnn; no_file_exists_at(_)
+      end
+    # ======================================================================= #
+    # === random
+    # ======================================================================= #
+    when 'fetch_a_random_topic','random_topic','random',
+         'rand' #  We fetch a random topic.
+      i = ::Studium::Exams.random_short_name_topic # This is allowed, for random topics.
+    # ======================================================================= #
+    # === molbio
+    # ======================================================================= #
+    when 'molbio','molekularbiologie','molbio?'
+      i = 'amg|amg2|genex1|gentech1|gentech2|pcr'
+    else # This here is actually the default.
+      i = ::Studium.find_corresponding_exam_topic(i, :be_quiet)
+    end
+    set_topic(i)
+    store_last_topic_into_file
+    set_exam_title(i)
+  end; alias set_this_topic set_use_this_topic # === set_this_topic
+
+  # ========================================================================= #
+  # === open_the_last_file_via_your_editor
+  # ========================================================================= #
+  def open_the_last_file_via_your_editor(
+      this_file = last_file?
+    )
+    open_this_file_in_editor(this_file)
+  end
+
+  # ========================================================================= #
+  # === open_this_file_in_editor
+  #
+  # Open this file in the editor.
+  # ========================================================================= #
+  def open_this_file_in_editor(
+      this_file = __FILE__
+    )
+    use_this_editor = ::Studium.editor?
+    # ======================================================================= #
+    # Since as of December 2017, on my home system, I will use nano
+    # instead.
+    # ======================================================================= #
+    use_this_editor = 'nano -w' if is_on_roebe?
+    _ = "#{use_this_editor} #{this_file}" #&
+    esystem _
+  end
+
+  # ========================================================================= #
+  # === consider_renaming_konsole_tab
+  #
+  # We will delegate to class SetTerminalTitle in order to rename the KDE
+  # konsole title.
+  # ========================================================================= #
+  def consider_renaming_konsole_tab
+    if AskExamQuestion.rename_konsole_tab?
+      rename_kde_konsole_tab(topic?)
+    end
+  end
+
+  # ========================================================================= #
+  # === determine_file
+  #
+  # This method will determine the path to the question-answer file at hand,
+  # such as:
+  #
+  #   /home/x/DATA/PROGRAMMING_LANGUAGES/RUBY/src/studium/lib/studium/exam_topics/fortgeschrittene_genetik
+  #
+  # ========================================================================= #
+  def determine_file(
+      path_to_the_directory_holding_the_exam_topics = directory_to_the_exam_topics?
+    )
+    the_topic = topic?.to_s
+    _ = path_to_the_directory_holding_the_exam_topics+the_topic
+    if _ == false # Debug.
+      pp path_to_the_directory_holding_the_exam_topics
+      pp topic?
+      pp self
+    end
+    set_file(_)
+  end
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  # ========================================================================= #
+  def set_commandline_arguments(i)
+    i = [i].flatten.compact
+    if i.any? {|line| line.respond_to?(:start_with?) and line.start_with?('--') }
+      selection = i.select {|entry| entry.start_with?('--') }
+      @commandline_arguments = selection
+      i.reject! {|entry| entry.start_with?('--') }
+    end
+    i # And we must return the original input as well.
+  end
+
+  # ========================================================================= #
+  # === determine_question_answer
+  #
+  # This will determine the question and answer. The job here will be done
+  # by class QuestionAnswer.
+  # ========================================================================= #
+  def determine_question_answer(
+      i = @line
+    )
+    question_answer = QuestionAnswer.new(i)
+    set_question(question_answer.question)
+    set_answer(question_answer.answer)
+  end
+
+  # ========================================================================= #
+  # === ask_question_then_show_the_answer_after_a_delay
+  # ========================================================================= #
+  def ask_question_then_show_the_answer_after_a_delay
+    ask_the_question # ask_question
+    do_sleep
+    show_answer
+  end; alias show_question_then_sleep_then_show_answer ask_question_then_show_the_answer_after_a_delay # === ask_question_then_show_the_answer_after_a_delay
+       alias ask_sleep_show                            ask_question_then_show_the_answer_after_a_delay # === ask_question_then_show_the_answer_after_a_delay
+       alias ask_the_question_then_reveal_the_answer   ask_question_then_show_the_answer_after_a_delay # === ask_the_question_then_reveal_the_answer
+
+  # ========================================================================= #
+  # === do_log_related_and_backup_related_actions
+  # ========================================================================= #
+  def do_log_related_and_backup_related_actions
+    unless ::Studium.is_in_www_mode?
+      ::Studium.backup_this_exam_file(file?)
+      hash = {}
+      hash[:question_was_asked_when] = Time.now
+      hash[:question_full_line]      = line?
+      ::Studium::Log::StoreLastQuestionAskedIntoFile.new(hash)
+    end
+  end
+
+  # ========================================================================= #
+  # === consider_warning_the_user_if_there_are_too_many_exams_registered
+  # ========================================================================= #
+  def consider_warning_the_user_if_there_are_too_many_exams_registered
+    if WARN_THE_USER_IF_THERE_ARE_TOO_MANY_QUESTIONS_REGISTERED_IN_AN_EXAM_TOPIC
+      # ===================================================================== #
+      # Check if we have more questions than we are allowed to have.
+      # ===================================================================== #
+      if n_questions? > THRESHOLD_VALUE_N_EXAMS_AT_MAXIMUM
+        e
+        opnn; e swarn('Do note that there are too many exam questions '\
+                'registered in the file:')
+        e
+        e "  #{sfile(@file)}"
+        e
+      end
+    end
+  end
+
+end; end
+
+# =========================================================================== #
+# === Studium::AskQuestionFromThisTopic
+#
+# Next, set an "alias" to the constant Studium::Exams::AskExamQuestion.
+# =========================================================================== #
+AskQuestionFromThisTopic = Exams::AskExamQuestion
+
+end