studium 0.9.383

data/lib/studium/exams/afterburn.rb

@@ -0,0 +1,259 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Afterburn
+#
+# This class will ask questions from the last exam topic assigned, kept
+# in the file called "main_topic.yml".
+#
+# The reason why the name "afterburn" is used here is quite simple:
+# - Say that you participated in an exam, for a given class. This exam is
+# now over, but you don't want to forget the content too quickly, so you
+# go through an "afterburn" stage to keep on memorizing the content for
+# a while.
+#
+# The file storing the old exams can be found here:
+#
+#   bl $RUBY_SRC/studium/lib/studium/yaml/main_topic.yml
+#
+# Usage example:
+#   Studium::Afterburn.new
+# =========================================================================== #
+# require 'studium/exams/afterburn.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+require 'studium/toplevel_methods/misc.rb'
+require 'studium/exams/ask_exam_question/ask_exam_question.rb'
+
+module Studium
+
+class Afterburn < ::Studium::Base # === Studium::Afterburn.new
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === FILE_MAIN_TOPIC_AT_ROEBE_HOME
+  # ========================================================================= #
+  FILE_MAIN_TOPIC_AT_ROEBE_HOME = RUBY_STUDIUM_HOME_DIR+'yaml/main_topic.yml'
+
+  # ========================================================================= #
+  # === 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()
+    reset_instance_variables
+    @namespace = NAMESPACE
+  end
+
+  # ========================================================================= #
+  # === reset_instance_variables
+  # ========================================================================= #
+  def reset_instance_variables
+    @dataset_containing_all_topics = ::Studium.main_topic?(:return_the_full_dataset) # Grab the main topic here.
+    @select_only_this_number = nil
+  end
+
+  # ========================================================================= #
+  # === add_this_entry                                              (add tag)
+  #
+  # This method can be used to add a new entry to the list of afterburn
+  # exams.
+  #
+  # Note that the method will prepend to the dataset, when a new entry
+  # is added. The reason for this behaviour is quite simple: if a user
+  # invokes this class via the --add flag, then the user most likely
+  # wanted to make the exam topic that he/she has added as the most
+  # important exam right now. In other words, the exam that the user
+  # wants to train for specifically.
+  #
+  # Invocation example:
+  #
+  #   aburn --add syszoo
+  #
+  # ========================================================================= #
+  def add_this_entry(i)
+    if i.is_a? Array
+      i = i.join(' ').strip
+    end
+    _ = FILE_MAIN_TOPIC
+    if File.exist? _
+      dataset = YAML.load_file(_)
+      case i
+      when /^-?-?add (.+)$/i
+        this_topic = $1.to_s.dup
+        if dataset.include? this_topic
+          opnn; e 'The topic '+sfancy(this_topic)+' is already included.'
+        else
+          opnn; e 'Adding the topic '+sfancy(this_topic)+' next.'
+          dataset.prepend(this_topic)
+          what = YAML.dump(dataset)
+          into = FILE_MAIN_TOPIC
+          opnn; e 'Storing into `'+sfile(into)+'`.'
+          write_what_into(what, into)
+          if is_on_roebe?
+            into = FILE_MAIN_TOPIC_AT_ROEBE_HOME
+            opnn; e 'Storing into `'+sfile(into)+'`.'
+            write_what_into(what, into)
+          end
+        end
+      end
+    else
+      opnn; no_file_exists_at(_) 
+    end
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = @commandline_arguments
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === aburn --add syszoo
+      # ===================================================================== #
+      when /^-?-?add$/i
+        add_this_entry(@commandline_arguments)
+        exit_program
+      # ===================================================================== #
+      # === aburn --overview
+      # ===================================================================== #
+      when /^-?-?overview$/i
+        _ = FILE_MAIN_TOPIC
+        if File.exist? _
+          e
+          YAML.load_file(_).each {|line|
+            e '  '+royalblue(line)
+          }
+          e
+        else
+          no_file_exists_at(_)
+        end
+        exit
+      # ===================================================================== #
+      # === aburn --open
+      # ===================================================================== #
+      when /^-?-?open$/
+        _ = RUBY_STUDIUM_HOME_DIR+'exams/afterburn.rb'
+        open_in_editor(_)
+        open_in_editor(FILE_MAIN_TOPIC_AT_ROEBE_HOME) if is_on_roebe?
+        exit
+      # ===================================================================== #
+      # === aburn --help
+      # ===================================================================== #
+      when /^-?-?help/
+        show_help
+        exit
+      else
+        if i =~ /^(-?\d+)$/
+          # ================================================================= #
+          # In this case we will delect a number from the dataset.
+          # ================================================================= #
+          select_only_this_number($1.to_s.dup)
+        end
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === determine_the_main_topic_in_use
+  # ========================================================================= #
+  def determine_the_main_topic_in_use
+    _ = @dataset_containing_all_topics
+    if _.is_a? Array
+      if @select_only_this_number
+        target_number = @select_only_this_number.to_i
+        if @select_only_this_number.start_with? '-'
+          _ = _.reverse[target_number - 1]
+        else
+          if target_number > _.size
+            target_number = _.size
+          end
+          _ = _[target_number - 1]
+        end
+      else
+        _ = _.first
+      end
+    end
+    @main_topic = _ # Assign to @main_topic here.
+  end
+
+  # ========================================================================= #
+  # === select_only_this_number
+  # ========================================================================= #
+  def select_only_this_number(i)
+    @select_only_this_number = i
+  end
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  #
+  # To invoke this method, try:
+  #
+  #   afterburn --help
+  #
+  # ========================================================================= #
+  def show_help
+    e
+    e 'You can pass in a number to this class, to select a specific'
+    e 'theme. This should ideally be a negative number '\
+      'such as '+royalblue('-1')
+    e
+    e gold('Example:')
+    e
+    e cadetblue('  afterburn -1')
+    e
+    e 'For an overview over the available afterburn-topics, use this option:'
+    e
+    e royalblue('  afterburn --overview')
+    e
+    e 'Last but not least, these are the available options:'
+    e
+    e '  --open      # open the file where the afterburn-exam topics are stored'
+    e '  --overview  # show which topics are registered currently'
+    e '  --add       # add a particular topic'
+    e
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    menu
+    determine_the_main_topic_in_use
+    Studium.ask_exam_question(use_this_topic: @main_topic)
+  end
+
+  # ========================================================================= #
+  # === Studium::Afterburn[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Afterburn.new(ARGV)
+end # afterburn

data/lib/studium/exams/ask_exam_from_the_upcoming_exams_pool.rb

@@ -0,0 +1,166 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::AskExamFromTheUpcomingExamsPool
+#
+# This class can be used to ask a random question from any of the
+# registered exam-topics, that is - upcoming exams.
+#
+# Usage example:
+#   Studium::Exams::AskExamFromTheUpcomingExamsPool.new
+# =========================================================================== #
+# require 'ask_exam_from_the_upcoming_exams_pool.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+require 'studium/toplevel_methods/map_meta_exam_theme_to_corresponding_exam_themes.rb'
+require 'studium/exams/show_upcoming_exams/show_upcoming_exams.rb'
+require 'studium/exams/ask_exam_topic_question.rb'
+require 'studium/exams/ask_exam_question/ask_exam_question.rb'
+
+module Studium
+
+module Exams
+
+class AskExamFromTheUpcomingExamsPool < ::Studium::Base # === Studium::Exams::AskExamFromTheUpcomingExamsPool.new
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    @all_exam_topics = [] # <- Must be kept as an Array at all times.
+    @namespace = NAMESPACE
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === obtain_all_exam_topics
+  #
+  # This method will grab all files called "exam_topics.md" and then
+  # pool together into the instance variable @all_exam_topics.
+  # ========================================================================= #
+  def obtain_all_exam_topics
+    look_for_this_file = 'exam_topics.md'
+    # ======================================================================= #
+    # Obtain all upcoming exams next.
+    # ======================================================================= #
+    all_registered_upcoming_exams = ::Studium.return_all_registered_upcoming_exams
+    # ======================================================================= #
+    # Next we must check on each target for a file called 'exam_topics.md',
+    # stored in the variable `look_for_this_file`.
+    # ======================================================================= #
+    all_registered_upcoming_exams.map! {|name_of_the_lecture, inner_dataset|
+      university = inner_dataset[:university]
+      target_directory = return_directory_for(
+        name_of_the_lecture, university
+      )
+      target_file = target_directory+look_for_this_file
+      # ===================================================================== #
+      # Check for 'exam_topics.md' next:
+      # ===================================================================== #
+      if File.exist?(target_file)
+        file_content = file_readlines_of_this_file(target_file).reject {|line|
+          line.strip.empty?
+        }.map {|inner_line|
+          inner_line.delete('-').strip
+        }
+        # =================================================================== #
+        # Next, append all exam topics onto the instance variable
+        # @all_exam_topics.
+        # =================================================================== #
+        @all_exam_topics << file_content 
+      else
+        opnn; e "The following file does not exist: "\
+                "#{sfile(target_file)}"
+      end
+    }
+    @all_exam_topics.flatten!
+    @all_exam_topics.uniq!
+    # ======================================================================= #
+    # And also replace all "meta_" entries.
+    # ======================================================================= #
+    @all_exam_topics.map! {|entry|
+      if entry.start_with? 'meta'
+        # =================================================================== #
+        # Replace the meta-entry there.
+        # =================================================================== #
+        entry = ::Studium.map_meta_exam_theme_to_corresponding_exam_themes(entry)
+      else
+        entry = find_corresponding_exam_topic(entry)
+      end
+      entry
+    }
+    @all_exam_topics.flatten!
+    @all_exam_topics.uniq!
+    @all_exam_topics.sort!
+  end
+
+  # ========================================================================= #
+  # === ask_a_question_from_a_random_exam_topic
+  # ========================================================================= #
+  def ask_a_question_from_a_random_exam_topic
+    # ======================================================================= #
+    # Pick a random topic from our available list:
+    # ======================================================================= #
+    random_topic = @all_exam_topics.sample
+    try_convert  = ::Studium.find_corresponding_exam_topic(random_topic)
+    unless random_topic == try_convert
+      random_topic = try_convert
+    end
+    e "The topic is: #{slateblue(random_topic)}"
+    AskExamQuestion.new(random_topic)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    obtain_all_exam_topics # Determine @all_exam_topics.
+    ask_a_question_from_a_random_exam_topic
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams::AskExamFromTheUpcomingExamsPool[]
+  # ========================================================================= #
+  def self.[](i = '')
+    self.new(i)
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Exams::AskExamFromTheUpcomingExamsPool.new(ARGV)
+end # ask_exam_from_the_upcoming_exams_pool

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

@@ -0,0 +1,103 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/exams/ask_exam_question/answer.rb'
+# =========================================================================== #
+module Studium
+
+module Exams
+
+class AskExamQuestion < ::Studium::Base # === Studium::Exams::AskExamQuestion.new
+
+  # ========================================================================= #
+  # === answer?
+  # ========================================================================= #
+  def answer?
+    @answer
+  end; alias answer answer? # === answer
+
+  # ========================================================================= #
+  # === set_answer                                               (answer tag)
+  #
+  # We need to assign to the instance variable @answer here.
+  #
+  # Every question has a corresponding answer.
+  #
+  # Note that this is the only method allowed to modify the @answer
+  #  variable.
+  # ========================================================================= #
+  def set_answer(i)
+    @answer = i
+  end
+
+  # ========================================================================= #
+  # === show_answer                                              (answer tag)
+  #
+  # This method will show the proper answer to an exam question.
+  #
+  # We have to build up the string that will be output. We will use
+  # the variable _ for this.
+  #
+  # A "proper" answer purposely has a leading padding, but only when
+  # the character that is to follow, is NOT a '(' token.
+  # ========================================================================= #
+  def show_answer
+    answer = answer?.lstrip
+    # ======================================================================= #
+    # === Handle Padding
+    #
+    # We will pad the answer string. For now, via 4 ' '.
+    # ======================================================================= #
+    if answer.start_with? '(' # Assume that at least two answers were given then.
+      # ===================================================================== #
+      # Batch-apply it on every answer.
+      # ===================================================================== #
+      answer = answer.split(N).map {|entry|
+        entry.prepend(LEFT_PADDING)
+      }.join(N)
+    end
+    # ======================================================================= #
+    # === Colourize <a> and <b> parts
+    # ======================================================================= #
+    if answer.include? '<a>' and answer.include? '<b>'
+      use_this_regex = /(<[a-z]{1}>)/
+      answer.gsub!(use_this_regex, '\\1')
+    end
+    _ = ''.dup
+    # ======================================================================= #
+    # Add <div> element if we run in www-mode.
+    # ======================================================================= #
+    _ << '<div id="answer_div">'+N if www_mode?
+    # ======================================================================= #
+    # === Colourize https-links, if we use colours.
+    #     This will also include wikipedia.
+    # ======================================================================= #
+    if use_colours?
+      if answer.include?('https://') 
+        use_this_regex =
+          /(https:\/\/.+)$/ # See: http://rubular.com/r/drYvZc4a91
+        answer.sub!(use_this_regex, mediumaquamarine('\\1'))
+      end
+    end
+    if commandline? and use_colours?
+      # ===================================================================== #
+      # We will delegate parsing the question towards class
+      # Studium::Exams::ParseQuestionAnswer.
+      # ===================================================================== #
+      parsed_result = @parse_question_answer.parse_this_answer(answer)
+      _ << parsed_result
+    else
+      _ << answer
+    end
+    _ << "</div>\n" if www_mode?
+    _ << N+N
+    unless answer?.strip.start_with?('(') # Prepend some padding.
+      _.prepend(LEFT_PADDING)
+    end
+    add(_) # Also store it in @result.
+    e _ unless www_mode?
+  end; alias reveal_the_answer show_answer # === reveal_the_answer (reveal tag)
+       alias show_the_answer   show_answer # === show_the_answer
+
+end; end; end