studium 0.16.9

data/lib/studium/exams/ask_exam_topic_question.rb

@@ -0,0 +1,112 @@
+#!/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'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_target_directory(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_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
+      opne "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,141 @@
+#!/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.
+#
+# This will be explained in the next section.
+#
+# In the file called '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/exam_question/exam_question.rb'
+
+  # ========================================================================= #
+  # === 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()
+    infer_the_namespace
+    try_to_require_the_rcfiles
+    # ======================================================================= #
+    # === @aliases_file
+    # ======================================================================= #
+    @aliases_file = Rcfiles.file_aliases
+    # ======================================================================= #
+    # === @report_available_topics
+    # ======================================================================= #
+    @report_available_topics = true
+  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
+    require 'studium/exams/exam_question/exam_question.rb'
+    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::Exams::ExamQuestion.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 nquestions1

data/lib/studium/exams/ask_question_from_any_of_the_still_missing_lectures.rb

@@ -0,0 +1,130 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::AskQuestionFromAnyOfTheStillMissingLectures
+#
+# This class will combine all exam topics found in the major individual
+# curriculum (both bachelor and master), from specific exam_topics.md
+# files, and then ask a question from this pool.
+#
+# So the job that has to be done for this class is this:
+#
+#   (1) Load the two main Curricula via Studium::Curriculum.new        [DONE]
+#   (2) Filter away all lectures that have already been solved         [DONE]
+#       via the method .filter_away_solved_lectures
+#   (3) Merge these two curricula classes together, via .merge()       [DONE]
+#       on one of the Studium::Curricula classes
+#   (4) Obtain a list of these unsolved lectures, via .lectures?       [DONE]
+#   (5) Determine which of these entries all have a exam_topics.md     [HALF-DONE]
+#       file in a local directory. Optionally report these
+#       findings to the user as well.
+#   (6) Pick one random exam topic and ask a random question
+#       from it. 
+# 
+# The basic idea is here to ask exam questions that belong to
+# the major topics that are not yet finished.
+#
+# Usage example:
+#
+#   Studium::Exams::AskQuestionFromAnyOfTheStillMissingLectures.new
+#
+# =========================================================================== #
+# require 'studium/exams/ask_question_from_any_of_the_still_missing_lectures.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Exams
+
+class AskQuestionFromAnyOfTheStillMissingLectures < Studium::Base # === Studium::Exams::AskQuestionFromAnyOfTheStillMissingLectures
+
+  require 'studium/curricula/curriculum.rb'
+  require 'studium/exams/exam_question/exam_question.rb'
+
+  # ========================================================================= #
+  # === 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()
+    infer_the_namespace
+  end
+
+  # ========================================================================= #
+  # === load_the_relevant_curricula
+  # ========================================================================= #
+  def load_the_relevant_curricula
+    bachelor = Studium::Curriculum.new(:bachelor_vektoren)
+    master   = Studium::Curriculum.new(:master_vektoren)
+    bachelor.filter_away_solved_lectures
+    master.filter_away_solved_lectures
+    # ========================================================================= #
+    # Now we should have significantly fewer lectures in the ^^^ above
+    # Curricula.
+    # ========================================================================= #
+    bachelor.merge(master)
+    whole_dataset = bachelor.lectures?
+    local_directories = whole_dataset.map {|this_lecture|
+      local_directory = Studium.determine_local_directory_of_this_lecture(this_lecture)
+      local_directory
+    }
+    array = []
+    local_directories.map! {|entry|
+      target = entry+'exam_topics.md'
+      if File.exist? target
+        array << File.readlines(target)
+      else
+        nil
+      end
+    }
+    local_directories.flatten!
+    local_directories.compact!
+    local_directories.map! {|entry|
+      entry.strip.delete('-').strip
+    }
+    local_directories.uniq!
+    sample = local_directories.sample
+    ask_an_exam_question_from_this_topic(sample)
+  end
+
+  # ========================================================================= #
+  # === ask_an_exam_question_from_this_topic
+  # ========================================================================= #
+  def ask_an_exam_question_from_this_topic(sample)
+    require 'studium/requires/require_the_exam_question_class.rb'
+    opnn; e 'Asking a question from the topic `'+orange(sample)+'` next.'
+    ExamQuestion.new(sample)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    load_the_relevant_curricula
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams::AskQuestionFromAnyOfTheStillMissingLectures[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Exams::AskQuestionFromAnyOfTheStillMissingLectures.new(ARGV)
+end # askquestionfromanyofthestillmissinglectures

data/lib/studium/exams/ask_question_from_grouped_themes.rb

@@ -0,0 +1,141 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::AskQuestionFromGroupedThemes
+#
+# Use this class to ask a question from the file grouped_themes.yml
+#
+# This file holds several aggregate-topics together. For instance,
+# biochemistry has sub-topics such as "aminoacids" or "lipids"
+# or "structural_biology" and so on.
+#
+# Usage example:
+#
+#   Studium::AskQuestionFromGroupedThemes.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/exams/ask_question_from_grouped_themes.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class AskQuestionFromGroupedThemes < Studium::Base # === Studium::AskQuestionFromGroupedThemes
+
+  require 'studium/exams/exam_question/exam_question.rb'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @use_this_topic
+    # ======================================================================= #
+    @use_this_topic = 'biochemistry' # This can be overruled on the commandline.
+  end
+
+  # ========================================================================= #
+  # === yaml_file?
+  # ========================================================================= #
+  def yaml_file?
+    Studium.file_grouped_themes
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    case i # Do some sanitizing here (case tag).
+    when /file/
+      e yaml_file?
+      exit
+    when 'bem','' # Empty entries also go in here.
+      i = 'biochemistry'
+    when 'amg'
+      i = 'genetics'
+    end
+    @input = i
+    set_use_this_topic(@input)
+  end
+
+  # ========================================================================= #
+  # === set_use_this_topic
+  # ========================================================================= #
+  def set_use_this_topic(i)
+    @use_this_topic = i
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === obtain_possible_topics
+  # ========================================================================= #
+  def obtain_possible_topics
+    @possible_topics = @dataset[@use_this_topic]
+  end
+
+  # ========================================================================= #
+  # === obtain_random_topic
+  # ========================================================================= #
+  def obtain_random_topic
+    @use_this_topic = @possible_topics.sample
+  end
+
+  # ========================================================================= #
+  # === do_ask_an_exam_question
+  # ========================================================================= #
+  def do_ask_an_exam_question
+    ::Studium::Exams.ask_question(@use_this_topic)
+  end
+
+  # ========================================================================= #
+  # === obtain_dataset
+  # ========================================================================= #
+  def obtain_dataset
+    @dataset = YAML.load_file(yaml_file?)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    obtain_dataset
+    obtain_possible_topics
+    obtain_random_topic
+    do_ask_an_exam_question
+  end
+
+  # ========================================================================= #
+  # === Studium::AskQuestionFromGroupedThemes[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::AskQuestionFromGroupedThemes.new(ARGV)
+end # askthemequestion amg
+    # askthemequestion bem

data/lib/studium/exams/ask_question_from_last_topic.rb

@@ -0,0 +1,91 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::AskQuestionFromLastTopic
+#
+# This class will ask a new question using the last exam-topic that
+# was used.
+#
+# Usage example:
+#
+#    Studium::AskQuestionFromLastTopic.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/exams/ask_question_from_last_topic.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class AskQuestionFromLastTopic < ::Studium::Base # === Studium::AskQuestionFromLastTopic
+
+  require 'studium/exams/exam_question/exam_question.rb'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @file_last_topic
+    # ======================================================================= #
+    @file_last_topic = Studium.file_last_topic?
+  end
+
+  # ========================================================================= #
+  # === last_topic?
+  # ========================================================================= #
+  def last_topic?(this_file = main_file?)
+    if File.exist? this_file
+      File.read(this_file).chomp
+    end
+  end; alias topic? last_topic? # === topic?
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    _ = main_file?
+    if File.exist? _
+      # ===================================================================== #
+      # Ok the file exists - let's continue.
+      # ===================================================================== #
+      ::Studium.ask_question(topic?)
+    else
+      opnn; e "No file exists at #{sfile(_)}."
+    end
+  end
+
+  # ========================================================================= #
+  # === main_file?
+  # ========================================================================= #
+  def main_file?
+    @file_last_topic
+  end
+
+  # ========================================================================= #
+  # === Studium::AskQuestionFromLastTopic[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::AskQuestionFromLastTopic.new(ARGV)
+end # askquestionfromlasttopic