studium 0.10.1

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

@@ -0,0 +1,77 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/exams/ask_exam_question/ask_exam_question.rb'
+# =========================================================================== #
+module Studium
+
+module Exams
+
+class AskExamQuestion < Base # === Studium::Exams::AskExamQuestion
+
+  # ========================================================================= #
+  # === set_question
+  # ========================================================================= #
+  def set_question(i)
+    @question = i
+  end
+
+  # ========================================================================= #
+  # === question?
+  # ========================================================================= #
+  def question?
+    @question
+  end; alias question question? # === question
+       alias first    question? # === first
+
+  # ========================================================================= #
+  # === ask_this_question                             (ask tag, question tag)
+  #
+  # Simply display the question via this method.
+  # ========================================================================= #
+  def ask_this_question(i = question?)
+    i = i.dup if i.frozen?
+    i.strip! # Get rid of trailing newlines.
+    # i << '?' unless i.end_with? '?','.'
+    i[0,2] = '' if i.start_with? '- '
+    # ======================================================================= #
+    # Next, remove html-numbers such as <one> and html-colours such as
+    # <steelblue>.
+    # ======================================================================= #
+    if ::Colours.does_this_string_include_a_html_number?(i) or
+       ::Colours.does_this_line_include_a_html_colour?(i)
+      i = ::Colours.away_with_html_colours_and_special_numbers(i, :steelblue, :default_hash)
+    end
+    # ======================================================================= #
+    # First, handle the commandline situation:
+    # ======================================================================= #
+    if commandline?
+      consider_renaming_konsole_tab # Consider renaming the konsole tab first.
+      e return_either_grey_or_the_custom_colour_for_questions
+      print seagreen(''); cliner('*', :mediumaquamarine)
+      add i
+      # ===================================================================== #
+      # Output the result finally.
+      # ===================================================================== #
+      e i.strip+return_either_grey_or_the_custom_colour_for_questions.strip
+      print seagreen(''); cliner('*', :mediumaquamarine)
+      e
+    else # else tag
+      # ===================================================================== #
+      # === WWW mode
+      #
+      # Else we assume that this class is used on the web.
+      # ===================================================================== #
+      result  = ''.dup
+      result << "#{i}#{N}<br><br>"
+      add result
+      # ===================================================================== #
+      # Next, show the question, unless we operate in WWW mode.
+      # ===================================================================== #
+      e result unless www_mode?
+    end
+  end; alias show_question    ask_this_question # === show_question
+       alias ask_the_question ask_this_question # === ask_the_question
+
+end; end; end

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

@@ -0,0 +1,103 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/exams/ask_exam_question/reset.rb'
+# =========================================================================== #
+module Studium
+
+module Exams
+
+class AskExamQuestion < Base # === Studium::Exams::AskExamQuestion
+
+  require 'studium/exams/question_answer/question_answer.rb'
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    register_sigint
+    set_be_verbose # Be verbose, output lots of stuff to the user.
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @store_where
+    # ======================================================================= #
+    @store_where = STORE_LAST_QUESTION_ASKED_WHERE
+    # ======================================================================= #
+    # === @result
+    #
+    # This variable may store the output that is displayed on the
+    # commandline. The reason we have to store this into a string
+    # variable is because this class may also be used on the www.
+    # ======================================================================= #
+    @result = ''.dup
+    # ======================================================================= #
+    # === @exam_topic
+    #
+    # This variable keeps track as to which exam-topic is to be used.
+    # Typically the first argument will be used as the exam-topic at hand.
+    # ======================================================================= #
+    @exam_topic = nil
+    # ======================================================================= #
+    # === @question
+    #
+    # The next variable will store the particular question at hand.
+    # ======================================================================= #
+    @question = nil
+    # ======================================================================= #
+    # === @answer
+    #
+    # The next variable will store the particular answer at hand.
+    # ======================================================================= #
+    @answer = nil
+    # ======================================================================= #
+    # === @word_wrap_at
+    # ======================================================================= #
+    @word_wrap_at = DEFAULT_WORD_WRAP_AT_N_CHARACTERS_PER_LINE
+    # ======================================================================= #
+    # === @debug
+    # ======================================================================= #
+    @debug = SHALL_WE_DEBUG
+    # ======================================================================= #
+    # === @may_we_show_the_topic
+    # ======================================================================= #
+    @may_we_show_the_topic = MAY_WE_SHOW_THE_TOPIC
+    # ======================================================================= #
+    # === @reject_lines_that_end_with_a_done_token
+    #
+    # If this variable is set to true (which is the default) then all
+    # entries that end with [] will be removed.
+    # ======================================================================= #
+    @reject_lines_that_end_with_a_done_token = true
+    # ======================================================================= #
+    # === @exam_file
+    #
+    # This instance variable will keep track where the full path to the
+    # exam file can be found.
+    # ======================================================================= #
+    @exam_file = nil
+    # ======================================================================= #
+    # === @line
+    # ======================================================================= #
+    @line = nil
+    # ======================================================================= #
+    # === @question_answer
+    # ======================================================================= #
+    @question_answer = Studium::Exams::QuestionAnswer.new
+    # ======================================================================= #
+    # === Handle custom colours next
+    # ======================================================================= #
+    @custom_colours = nil
+    if File.exist?(FILE_CUSTOM_COLOURS)
+      @custom_colours = YAML.load_file(FILE_CUSTOM_COLOURS)
+      @question_answer.set_custom_colours(@custom_colours)
+    end
+    determine_the_default_delay
+    determine_whether_we_will_rename_the_konsole_tab
+  end
+
+end; end; end

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

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/exams/ask_exam_question/run.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Exams
+
+class AskExamQuestion < Base # === Studium::Exams::AskExamQuestion
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    menu_on_the_commandline_as_a_string
+    menu
+    if main_file_exists?
+      load_the_dataset_based_on_the_exam_topic_before_rejecting_invalid_entries
+      # ===================================================================== #
+      # === Show the topic if the user requested us to do so
+      # ===================================================================== #
+      if may_we_show_the_topic?
+        e
+        e steelblue('Topic: ')+
+          simp(exam_title?.capitalize)
+        e
+      end
+      consider_warning_the_user_if_there_are_too_many_exams_registered
+      do_ask_a_random_question_before_showing_the_answer
+      show_statistics
+      # ===================================================================== #
+      # Next, backup the exam file, and keep a log file about the last 
+      # question that was asked.
+      # ===================================================================== #
+      do_log_related_and_backup_related_actions
+      # ===================================================================== #
+      # Register the last file that was modified.
+      # ===================================================================== #
+      register_last_modified_file
+    else
+      report_file_does_not_exist
+    end
+  end
+
+end; end; end

data/lib/studium/exams/ask_exam_topic_question.rb

@@ -0,0 +1,120 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::AskExamTopicQuestion
+#
+# This class can ask questions from current exams. It also allows you to
+# pass a number, which we assume is to refer to some specific exam.
+#
+# For instance, the number 1 passed to this class means to ask a question
+# from the very next upcoming exam. This also depends on a file called
+# exam_topics.yml which must exist in the target directory. If it exists
+# then we will delegate towards class AskQuestionFromGroupedThemes.
+#
+# Usage example:
+#
+#    Studium::Exams::AskExamTopicQuestion.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/exams/ask_exam_topic_question.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Exams
+
+class AskExamTopicQuestion < ::Studium::Base# === Studium::AskExams::ExamTopicQuestion
+
+  require 'studium/exams/ask_question_from_grouped_themes.rb'
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_target_directory(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+  end
+
+  # ========================================================================= #
+  # === set_target_directory
+  # ========================================================================= #
+  def set_target_directory(i = '')
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    case i
+    when /\d+/ # If we have passed a number.
+      # ===================================================================== #
+      # Refer to the cd-aliases file next.
+      # ===================================================================== #
+      file_cd_aliases = YAML.load_file(Studium.file_cd_aliases)
+      key = 'pwdstud'+i.to_s
+      value = file_cd_aliases[key]
+      value = value.split(' ').last if value.include? ' '
+      i = value
+    end
+    i << '/' unless i.end_with? '/'
+    @target_directory = i
+  end
+
+  # ========================================================================= #
+  # === target_directory?
+  # ========================================================================= #
+  def target_directory?
+    @target_directory
+  end; alias input?      target_directory? # === input?
+       alias target_dir? target_directory? # === target_dir?
+
+  # ========================================================================= #
+  # === location_of_the_yaml_file?
+  # ========================================================================= #
+  def location_of_the_yaml_file?
+    "#{target_dir?}exam_topics.yml"
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    _ = location_of_the_yaml_file?
+    if File.exist? _
+      topic = YAML.load_file(_)
+      Studium::AskQuestionFromGroupedThemes.new(topic)
+    else
+      opnn; e "No file could be found at #{sfile(_)}."
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams::AskExamTopicQuestion[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Exams::AskExamTopicQuestion.new(ARGV)
+end # askexamtopicquestion 15

data/lib/studium/exams/ask_question_from_alias.rb

@@ -0,0 +1,151 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::AskQuestionFromAlias
+#
+# This class will ask a question from an "alias". In this context, an alias
+# actually refers to a yaml file that has stored these aliases.
+#
+# I'll soon explain this.
+#
+# In the file aliases.yml I have some aggregate-exam bundles, for example,
+# nquestion1. Here, we have grouped together several exam topics,
+# predominantly related to molecular and physiological biochemistry.
+#
+# Usage example:
+#
+#   Studium::AskQuestionFromAlias.new
+#
+# =========================================================================== #
+# require 'studium/exams/ask_question_from_alias.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class AskQuestionFromAlias < ::Studium::Base # === Studium::AskQuestionFromAlias
+
+  require 'studium/exams/ask_exam_question/ask_exam_question.rb'
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === DEFAULT_NAME_OF_THE_ALIAS
+  # ========================================================================= #
+  DEFAULT_NAME_OF_THE_ALIAS = 'nquestion1'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = DEFAULT_NAME_OF_THE_ALIAS,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # === @namespace
+    @namespace = NAMESPACE
+    try_to_require_the_rcfiles
+    # === @aliases_file
+    @aliases_file = Rcfiles.file_aliases
+    # === @report_available_topics
+    @report_available_topics = true
+  end
+
+  # ========================================================================= #
+  # === try_to_require_the_rcfiles
+  # ========================================================================= #
+  def try_to_require_the_rcfiles
+    begin
+      require 'rcfiles'
+    rescue LoadError; end
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = DEFAULT_NAME_OF_THE_ALIAS)
+    i = i.first if i.is_a? Array
+    i = DEFAULT_NAME_OF_THE_ALIAS if i.nil? # Use a default in this case.
+    i = i.to_s.dup
+    i = sanitize_input(i)
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === sanitize_input
+  #
+  # Designate some aliases to the input-given.
+  # ========================================================================= #
+  def sanitize_input(i)
+    case i
+    when 'nquestion1'
+      'nquestions1'
+    else
+      i
+    end
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    dataset = YAML.load_file(@aliases_file)
+    key = input?
+    if dataset.has_key? key
+      result = dataset[key]
+      # ===================================================================== #
+      # Next, get rid of leading "nquestions" part. 
+      # ===================================================================== #
+      if result.include? 'nquestions '
+        result.sub!(/^nquestions /,'')
+      end
+      # ===================================================================== #
+      # Then obtain the topics by splitting.
+      # ===================================================================== #
+      @available_topics = result.split(' ')
+      pick_this_topic = @available_topics.sample
+      if @report_available_topics
+        opnn; e 'The available topics are:'
+        e
+        e '  '+sfancy(@available_topics.join(', ').strip.chop)
+        e
+      end
+      opnn; e 'We will ask a question from the topic `'+sfancy(pick_this_topic)+'`.'
+      Studium::AskQuestionFromThisTopic.new(pick_this_topic)
+    else
+      opnn; e "No key called `#{sfancy(key)}` found."
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium::AskQuestionFromAlias[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::AskQuestionFromAlias.new(ARGV)
+end # askquestionfromalias nquestion1