studium 0.13.1

data/lib/studium/exams/solved/constants.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Studium
+
+module Exams
+
+class Solved < Base # === Studium::Exams::Solved
+
+  # ========================================================================= #
+  # === PUT_SOLVED_QUESTION_ON_TOP_OF_THE_FILE
+  #
+  # If this constant is set to true then we will, upon solving a question,
+  # relocate this question to the top of the file.
+  # ========================================================================= #
+  PUT_SOLVED_QUESTION_ON_TOP_OF_THE_FILE = true
+
+  # ========================================================================= #
+  # === SHALL_WE_ALSO_UPDATE_THE_TEN_MAIN_ALIASES
+  #
+  # The following constant is only honoured on "is_roebe?" systems, aka
+  # my home system. If true then the ten main aliases will also be updated,
+  # in regards to study-related questions (percentage value display).
+  #
+  # Currently (28.04.2019) this comes with a slight speed penalty, which is
+  # why it has been disabled for the time being. At a later time this may
+  # be revisited, though.
+  # ========================================================================= #
+  SHALL_WE_ALSO_UPDATE_THE_TEN_MAIN_ALIASES = false
+
+end; end; end

data/lib/studium/exams/solved/help.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Studium
+
+module Exams
+
+class Solved < ::Studium::Base # === Studium::Exams::Solved
+
+  # ========================================================================= #
+  # === show_help
+  # ========================================================================= #
+  def show_help
+    opnn; e 'This class will mark the given question/answer as solved.'
+    opnn; e
+    opnn; e 'If you want to show which question that is, pass '\
+            'this option:'
+    e
+    e yellow('  --simulate')
+    e
+  end
+
+end; end; end

data/lib/studium/exams/solved/initialize.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/exams/solved/initialize.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Exams
+
+class Solved < Base # === Studium::Exams::Solved
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already           = true,
+      &block
+    )
+    reset
+    menu(
+      commandline_arguments
+    ) if commandline_arguments
+    # ======================================================================= #
+    # === Handle blocks next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :be_verbose
+      # ===================================================================== #
+      when :be_verbose
+        set_be_verbose
+      # ===================================================================== #
+      # === :do_not_run_yet
+      # ===================================================================== #
+      when :do_not_run_yet
+        run_already = false
+      end
+    end
+    case run_already
+    # ======================================================================= #
+    # === :dont_run_yet
+    # ======================================================================= #
+    when :dont_run_yet
+      run_already = false
+    end
+    run if run_already
+  end
+
+end; end; end

data/lib/studium/exams/solved/menu.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Studium
+
+module Exams
+
+class Solved < Base
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(i)
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === solved --be-verbose
+      # ===================================================================== #
+      when /^-?-?be(-|_)?verbose?$/i,
+           /^-?-?verbose?$/i
+        set_be_verbose
+      # ===================================================================== #
+      # === solved --simulate
+      # ===================================================================== #
+      when /^-?-?simulate\??$/i
+        show_which_question_we_would_mark_as_solved
+        exit
+      # ===================================================================== #
+      # === solved --help
+      # ===================================================================== #
+      when /^-?-?help$/i
+        show_help
+        exit
+      end
+    end
+  end
+
+end; end; end

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

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/exams/solved/reset.rb'
+# =========================================================================== #
+module Studium
+
+module Exams
+
+class Solved < Base # === Studium::Exams::Solved
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @put_solved_question_on_top_of_the_file
+    # ======================================================================= #
+    @put_solved_question_on_top_of_the_file =
+      PUT_SOLVED_QUESTION_ON_TOP_OF_THE_FILE
+    set_which_question
+    set_be_quiet
+  end
+
+end; end; end

data/lib/studium/exams/solved/solved.rb

@@ -0,0 +1,313 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::Solved
+#
+# This class can be used to mark the last exam-question as solved.
+#
+# This class should be run from either the commandline or via the WWW.
+#
+# This class may respond to a very few commandline instructions given,
+# such as --simulate, which will simply tell us which question will
+# be marked as solved next.
+# =========================================================================== #
+require 'studium/base/base.rb'
+# =========================================================================== #
+# Next require other components of the Studium::Exams::Solved namespace.
+# =========================================================================== #
+require 'studium/exams/solved/constants.rb'
+require 'studium/exams/solved/help.rb'
+require 'studium/exams/solved/initialize.rb'
+require 'studium/exams/solved/menu.rb'
+require 'studium/exams/solved/reset.rb'
+
+module Studium
+
+module Exams
+
+class Solved < Base # === Studium::Exams::Solved
+
+  require 'studium/toplevel_methods/report.rb'
+  require 'studium/constants/constants.rb'
+
+  begin
+    require 'find_line_in_file'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === put_solved_question_on_top_of_the_file?
+  # ========================================================================= #
+  def put_solved_question_on_top_of_the_file?
+    @put_solved_question_on_top_of_the_file
+  end
+
+  # ========================================================================= #
+  # === return_the_topic
+  # ========================================================================= #
+  def return_the_topic
+    _ = which_topic?
+    _ = ' (Topic: '+simp(_.capitalize.tr('_',' '))+')' unless _.empty?
+    return _
+  end
+
+  # ========================================================================= #
+  # === directory_to_the_exam_topics?
+  # ========================================================================= #
+  def directory_to_the_exam_topics?
+    ::Studium.directory_to_the_exam_topics?
+  end
+
+  # ========================================================================= #
+  # === consider_updating_exam_questions_solved_today
+  #
+  # The purpose of this method is to keep track of how many questions
+  # were solved per day. This can then be used by other scripts to 
+  # compare how many questions were solved from one day to another,
+  # e. g. to get some realistic "real" measurement of how many questions
+  # can be solved per day.
+  #
+  # In order to achieve this, we will save the minimum number per given
+  # day. Or actually, much simpler, to store the first amount of
+  # questions solved, obtained on any given time for the FIRST time
+  # on THAT day, into a file. In other words, if I woke up and ask
+  # a question and manage to solve it, this class here will also
+  # keep track of that.
+  # ========================================================================= #
+  def consider_updating_exam_questions_solved_today(
+      into = FILE_DAILY_QUESTIONS_SOLVED # This is a yaml file. We will store into this file.
+    )
+    # ======================================================================= #
+    # Store as a Hash.
+    # ======================================================================= #
+    today = today?
+    hash = {
+      today => ::Studium.n_questions_solved_in_total # Obtain how many questions were solved yet.
+    }
+    if File.exist? into
+      dataset = YAML.load_file(into) # This is the existing dataset.
+      unless dataset.has_key? today
+        dataset.merge!(hash)
+        write_what_into(YAML.dump(dataset), into)
+      end
+      return
+    end
+    write_what_into(YAML.dump(hash), into) # Else create it anew here.
+  end
+
+  # ========================================================================= #
+  # === which_topic?
+  #
+  # This method will determine which topic was the last one that was
+  # asked.
+  # ========================================================================= #
+  def which_topic?
+    _ = ::Studium.last_topic?
+    if File.exist? _
+      return File.read(_).chomp.split('/').last
+    else
+      if is_on_roebe?
+        opnn; no_file_exists_at(_)
+      end
+      ''
+    end
+  end
+
+  # ========================================================================= #
+  # === set_which_question
+  # ========================================================================= #
+  def set_which_question(
+      i = Studium.file_last_question_asked? # This may be "/root/Studium/last_question_asked.md".
+    )
+    if File.exist? i
+      i = File.read(i).chomp
+    else
+      opnn; no_file_exists_at(i)
+    end
+    @which_question = i
+  end
+
+  # ========================================================================= #
+  # === run_everything
+  # ========================================================================= #
+  def run_everything
+    # ======================================================================= #
+    # First, we need to identify what the line is that we want to find.
+    # ======================================================================= #
+    line = @which_question.dup.rstrip
+    unless line.start_with? '- '
+      line.prepend('- ')
+    end
+    # ======================================================================= #
+    # Now we have the line in question. We must determine the target file
+    # next. First, the regular one; but also the one on my home system
+    # if is_on_roebe? is true.
+    # ======================================================================= #
+    _ = path_to_exam_topic?.to_s+
+        Studium.find_corresponding_exam_topic(Studium.last_topic?).to_s
+    # ======================================================================= #
+    # target_file  = YAML.load_file(_).chomp
+    # ======================================================================= #
+    target_file    = _
+    target_at_home = "#{directory_to_the_exam_topics?}"\
+                     "#{File.basename(target_file)}"
+    if be_verbose?
+      opnn; e 'The target file is at:'
+      e
+      e "  #{sfile(target_file)}"
+      e
+    end
+    # ======================================================================= #
+    # Obtain the line-number next:
+    # ======================================================================= #
+    line_number = FindLineInFile.new(
+      this_file: target_file,
+      this_line: line
+    ).line_number?
+    if be_verbose?
+      opnn; e 'The line number is at: '+sfancy(line_number.to_s)
+      opnn; e 'The line to be sought after is exactly this, '\
+              'between the ``:'
+      e
+      e "`#{steelblue(line)}`"
+      e
+    end
+    if line_number # Need to be sure that we have found a number at all.
+      # ===================================================================== #
+      # Now we have the target file as well as the line number. We can
+      # thus modify this file next.
+      # ===================================================================== #
+      dataset = File.readlines(
+        target_file, encoding: main_encoding_to_use?
+      )
+      old_content = dataset[line_number - 1]
+      new_line = "#{old_content.rstrip} #{APPEND_THIS}#{N}"
+      # ===================================================================== #
+      # Append [] unless it already has that at the end of the line.
+      # ===================================================================== #
+      unless old_content.chomp.end_with? APPEND_THIS
+        dataset[line_number - 1] = new_line
+        # =================================================================== #
+        # Next, honour a certain constant set at the top, IF it is true.
+        # This will put the solved question on top of the exam-file at hand.
+        # =================================================================== #
+        if put_solved_question_on_top_of_the_file?
+          dataset[line_number - 1] = nil # Delete it first.
+          # ================================================================= #
+          # Next, find the first line that starts with a '-' token, then
+          # subtract one from it since Arrays in ruby start at 0.
+          # ================================================================= #
+          line_number = dataset.find_index { |inner_line|
+            inner_line =~ /^- / # Note that this requires the same Encoding.
+          }
+          # ================================================================= #
+          # Guard against nil-entries:
+          # ================================================================= #
+          if line_number.nil?
+            etomato 'The variable line_number was nil. This may be the case'
+            etomato 'when all questions have already been answered.'
+            etomato 'The old target file was:'
+            e
+            e sfile("  #{target_file}")
+            e
+          end
+          line_number -= 1 if line_number # Subtract 1 due to reason given above.
+          dataset[line_number] = "\n#{new_line}" # Set it to the new value here.
+          dataset.compact! # Chop away any possible .nil values.
+        end
+        # =================================================================== #
+        # Store it next.
+        # =================================================================== #
+        if be_verbose?
+          opnn; e 'Writing into the file '+sfile(target_file)+'.'
+        end
+        write_what_into(dataset, target_file)
+        # =================================================================== #
+        # And also register as to where we saved it. This may be important
+        # if we wish to ftp-upload it, or for a similar purpose.
+        # =================================================================== #
+        into = ::Studium::LAST_SAVED_INTO_THIS_FILE
+        write_what_into(target_file, into)
+        if is_on_roebe? # Simply copy the dataset here.
+          write_what_into(dataset, target_at_home)
+          # ================================================================= #
+          # Also update the studium-project in this case.
+          # ================================================================= #
+          cd RUBY_SRC_DIR
+          opnn; e 'Since we are on roebe, we will also store into:'
+          e "  #{sfile(target_at_home)}"
+          rinstall2
+        end
+        # =================================================================== #
+        # If we are on roebe, then try to load up a certain class in the
+        # roebe project, and generate an updated .yml file for the
+        # exam questions. This behaviour can be toggled via a constant.
+        # =================================================================== #
+        if is_on_roebe? and
+           File.exist?(Studium::FILE_TEN_ALIASES_YML) and
+           SHALL_WE_ALSO_UPDATE_THE_TEN_MAIN_ALIASES
+          begin
+            require 'roebe/classes/show_ten_aliases.rb'
+            Roebe::ShowTenAliases.new { :be_quiet_and_ignore_existing_file }
+          rescue LoadError
+            opnn; e 'roebe/classes/show_ten_aliases.rb is unavailable.'
+          end              
+        end
+        consider_updating_exam_questions_solved_today
+        invoke_max_stats_class
+      end
+    else
+      not_found = "#{NAMESPACE} Not found a line number "\
+                  "for #{sfancy(@which_question)}".dup
+      not_found << '.' unless @which_question.end_with? '.'
+      e not_found
+    end
+  end
+
+  # ========================================================================= #
+  # === invoke_max_stats_class
+  # ========================================================================= #
+  def invoke_max_stats_class
+    require 'studium/statistics/max_stats.rb'
+    Studium::Statistics::MaxStats.new { :be_quiet }
+  end
+
+  # ========================================================================= #
+  # === which_question?
+  # ========================================================================= #
+  def which_question?
+    @which_question
+  end; alias which_question which_question? # === which_question
+
+  # ========================================================================= #
+  # === show_which_question_we_would_mark_as_solved
+  #
+  # This method is feedback from when we pass --simulate to this class.
+  # ========================================================================= #
+  def show_which_question_we_would_mark_as_solved
+    opnn; e 'The question that we would next mark as '\
+            'solved, is the following one:'
+    e
+    e "#{sfancy(which_question?)}#{return_the_topic}"
+    e
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    run_everything
+  end
+
+  # ========================================================================= #
+  # === Studium::Exams::Solved[]
+  # ========================================================================= #
+  def self.[]
+    new
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Exams::Solved.new
+end # solved --help

data/lib/studium/exams/unsolve_all_questions_from_this_topic.rb

@@ -0,0 +1,162 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::UnsolveAllQuestionsFromThisTopic
+#
+# This class will set all questions from the given input topic at hand
+# to "solved".
+#
+# Usage example:
+#
+#   Studium::UnsolveAllQuestionsFromThisTopic.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/exams/unsolve_all_questions_from_this_topic.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class UnsolveAllQuestionsFromThisTopic < Base # === Studium::UnsolveAllQuestionsFromThisTopic
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # The first argument should be the topic that we mark as "solved
+  # completely".
+  # ========================================================================= #
+  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
+    # ======================================================================= #
+    # === @this_topic
+    # ======================================================================= #
+    @this_topic = nil
+    set_file
+  end
+
+  # ========================================================================= #
+  # === this_topic?
+  # ========================================================================= #
+  def this_topic?
+    @this_topic
+  end; alias topic? this_topic? # === topic?
+
+  # ========================================================================= #
+  # === file?
+  # ========================================================================= #
+  def file?
+    @file
+  end
+
+  # ========================================================================= #
+  # === set_file
+  # ========================================================================= #
+  def set_file(i = '')
+    @file = i
+  end
+
+  # ========================================================================= #
+  # === return_long_topic
+  # ========================================================================= #
+  def return_long_topic
+    _ = topic?
+    return find_corresponding_exam_title(_)
+  end
+
+  # ========================================================================= #
+  # === set_this_topic
+  # ========================================================================= #
+  def set_this_topic(i = '')
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    # ======================================================================= #
+    # Must sanitize the topic at hand.
+    # ======================================================================= #
+    i = find_corresponding_exam_topic(i)
+    @this_topic = i
+  end
+
+  # ========================================================================= #
+  # === store_this_dataset
+  # ========================================================================= #
+  def store_this_dataset(what)
+    opnn; e 'Now unsolving ("'+steelblue('unanswering')+
+            '") all questions from the '\
+            'topic '+sfancy(return_long_topic)+'.'
+    what = what.join(N)+N
+    into = file?
+    write_what_into(what, into)
+    if is_on_roebe?
+      into = directory_to_my_exam_topics+File.basename(file?)
+      write_what_into(what, into)
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    # ======================================================================= #
+    # First, we must find the specific file at hand. Thus we have to
+    # perform some sanitizing.
+    # ======================================================================= #
+    set_this_topic(commandline_arguments_as_string?)
+    _ = directory_to_the_exam_topics?+@this_topic
+    set_file(_)
+    if File.exist? file?
+      dataset = File.readlines(file?).map(&:chomp)
+      dataset.map! {|entry|
+        unless entry.to_s.strip.empty? or entry.start_with?('#')
+          if entry.end_with? ' []'
+            entry = entry.dup if entry.frozen?
+            entry[-3,3] = ''
+          end
+        end
+        entry
+      }
+      store_this_dataset(dataset)
+    end
+  end
+
+  # ========================================================================= #
+  # === path_to_exam_topic
+  # ========================================================================= #
+  def path_to_exam_topic
+    path_to_exam_topic?+@this_topic
+  end
+
+  # ========================================================================= #
+  # === Studium::UnsolveAllQuestionsFromThisTopic[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium::Exams.unsolve_all_questions_from_this_topic
+# =========================================================================== #
+def self.unsolve_all_questions_from_this_topic(this_topic)
+  new(this_topic)
+end; self.instance_eval { alias unanswer unsolve_all_questions_from_this_topic } # === Studium.unanswer
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::UnsolveAllQuestionsFromThisTopic.new(ARGV)
+end # unsolveallquestionsfromthistopic theochem

data/lib/studium/exams/upcoming_exams/constants.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/exams/upcoming_exams/constants.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Exams
+
+class UpcomingExams < Base # === Studium::Exams::UpcomingExams
+
+end; end; end