studium 0.10.1

data/lib/studium/sinatra/misc.rb

@@ -0,0 +1,111 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/sinatra/misc.rb'
+# =========================================================================== #
+module Studium
+
+class Sinatra < WebObject::Sinatra
+
+  require 'studium/curricula/curriculum_as_string.rb'
+  require 'studium/exams/questions_solved_from_day_to_day.rb'
+
+  # ========================================================================= #
+  # === /n_ects_points_passed
+  #
+  # Determine how many ECTS points were passed so far.
+  # ========================================================================= #
+  get('/n_ects_points_passed'){
+    title('n ECTS points were passed')+
+    p(
+      "<b>#{Studium.n_ects_points_were_passed?}</b>"
+    )
+  }
+
+  # ========================================================================= #
+  # === http://localhost:4567/questions_solved_from_day_to_day
+  # ========================================================================= #
+  get('/questions_solved_from_day_to_day') {|this_topic|
+    title('questions solved from day to day')+
+    Studium::Exams::QuestionsSolvedFromDayToDay.return_maximum_amount_of_questions_ever_answered.to_s
+  }
+
+  # ========================================================================= #
+  # === create_index_of_hyperlinks
+  #
+  # Create our index of hyperlinks next.
+  # ========================================================================= #
+  def create_index_of_hyperlinks
+    @index_of_hyperlinks = a(
+      '/n_ects_points_passed',
+      css_style: USE_THIS_UNIFORM_CSS_STYLE
+    )+
+    '<br>'+
+    a(
+      '/curricula',
+      css_style: USE_THIS_UNIFORM_CSS_STYLE
+    )+
+    '<br>'.dup
+    # ======================================================================= #
+    # Keep the exam-topics sorted.
+    # ======================================================================= #
+    sorted_exam_topics?.each {|this_topic|
+      @index_of_hyperlinks << a('/'+this_topic, css_style: USE_THIS_UNIFORM_CSS_STYLE)+
+      '<br>'.dup
+    }
+    @index_of_hyperlinks << a('/questions_solved_from_day_to_day', css_style: USE_THIS_UNIFORM_CSS_STYLE)
+  end
+
+  # ========================================================================= #
+  # === http://localhost:4567/amg1
+  #
+  # This will ask an exam question.
+  #
+  # http://localhost:4567/genex
+  # ========================================================================= #
+  get('/:this_exam_topic') {|this_topic|
+    this_topic = this_topic.downcase.tr(' ','_')
+    return_html_code_for_this_exam_topic(this_topic)
+  }
+
+  # ========================================================================= #
+  # === title
+  # ========================================================================= #
+  def title(i)
+    HtmlTags.title(i)
+  end
+
+  # ========================================================================= #
+  # === /curricula
+  # ========================================================================= #
+  get('/curricula'){
+    p(
+      'Click on the curriculum that ought to be displayed next.'
+    )
+  }
+
+  # ========================================================================= #
+  # === http://localhost:4567/curricula/indi2
+  #
+  # This entry point can be used to display a specific curriculum.
+  #
+  # Another example:
+  #
+  #   http://localhost:4567/curricula/indi3
+  #
+  # ========================================================================= #
+  get('/curricula/*') {
+    _ = params[:splat]
+    _ = _.first if _.is_a? Array
+    if _.end_with? '.yml'
+      _ = _.dup if _.frozen?
+      _.sub!(/\.yml$/,'')
+    end
+    # ======================================================================= #
+    # Delegate towards class Studium::Curricula::CurriculumAsString next.
+    # ======================================================================= #
+    return Studium::Curricula::CurriculumAsString.new(_).result?
+  }
+
+end; end

data/lib/studium/statistics/README.md

@@ -0,0 +1,4 @@
+The subdirectory statistics/ and its associated namespace
+Studium::Statistics are bundling together code that relates
+to providing statistical information about studies, exams,
+performance, percentages and so forth.

data/lib/studium/statistics/best_exam_months.rb

@@ -0,0 +1,81 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Statistics::BestExamMonths
+#
+# This small class just handles calling the best-months.
+#
+# Usage example:
+#
+#   Studium::Statistics::BestExamMonths.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/statistics/best_exam_months.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+require 'studium/exams/exams_per_month/exams_per_month.rb'
+
+module Studium
+
+module Statistics
+
+class BestExamMonths < Base # === Studium::Statistics::BestExamMonths
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    set_show_n_months(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+  end
+
+  # ========================================================================= #
+  # === set_show_n_months
+  # ========================================================================= #
+  def set_show_n_months(i = '')
+    i = [i].flatten.compact.first.to_s.delete('-').to_i
+    @show_n_months = i
+  end
+
+  # ========================================================================= #
+  # === show_n_months?
+  # ========================================================================= #
+  def show_n_months?
+    @show_n_months
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    _ = Studium::ExamsPerMonth.new(:do_not_run_yet) # bl ExamsPerMonth
+    _.sanitize_dataset
+    _.show_best_months(@show_n_months)
+  end
+
+  # ========================================================================= #
+  # === Studium::Statistics::BestExamMonths[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Statistics::BestExamMonths.new(ARGV)
+end # bestmonths 12

data/lib/studium/statistics/curriculum_comparer.rb

@@ -0,0 +1,344 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::CurriculumComparer
+#
+# This class will systematically compare the amount of ECTS points passed
+# in the registered curricula, and then sort them by highest amount of
+# ECTS points solved being displayed first.
+#
+# Usage example:
+#
+#   Studium::CurriculumComparer.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/statistics/curriculum_comparer.rb'
+# Studium::CurriculumComparer.new(ARGV)
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class CurriculumComparer < Studium::Base # === Studium::CurriculumComparer
+
+  require 'studium/toplevel_methods/return_hash_of_already_solved_lectures.rb'
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === THRESHOLD_N_ECTS
+  # ========================================================================= #
+  THRESHOLD_N_ECTS = 8.0
+
+  # ========================================================================= #
+  # === COLOUR_FOR_THE_NAME_OF_THE_CURRICULA
+  # ========================================================================= #
+  COLOUR_FOR_THE_NAME_OF_THE_CURRICULA = :slategray
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @show_only_master_curricula
+    # ======================================================================= #
+    @show_only_master_curricula = false
+    # ======================================================================= #
+    # === @main_hash
+    # ======================================================================= #
+    @main_hash = {} # This Hash will contain all relevant snippets.
+    # ======================================================================= #
+    # Default to an empty Hash. One entry specifies the amount of ECTS points.
+    # ======================================================================= #
+    @main_hash.default = {}
+    # ======================================================================= #
+    # === @ignore_ects_below_this_threshold
+    # ======================================================================= #
+    @ignore_ects_below_this_threshold = THRESHOLD_N_ECTS # Less than this threshold in ECTS will be ignored.
+    # ======================================================================= #
+    # === @skip_lehramt_curricula
+    # ======================================================================= #
+    @skip_lehramt_curricula = true # If true we ignore "Lehramt" curricula
+    # ======================================================================= #
+    # === @left_padding_to_use
+    #
+    # How much we will pad to the left side.
+    # ======================================================================= #
+    @left_padding_to_use = ' '.dup
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    @input = i
+    menu
+  end
+
+  # ========================================================================= #
+  # === main_colour
+  # ========================================================================= #
+  def main_colour
+    ::Colours.remove_trailing_ansii_escape_code(
+      ::Colours.send(COLOUR_FOR_THE_NAME_OF_THE_CURRICULA, '')
+    )
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = @input
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i
+      # ===================================================================== #
+      # === supercurriculum --master
+      # ===================================================================== #
+      when /^-?-?master$/
+        @show_only_master_curricula = true
+      # ===================================================================== #
+      # === supercurriculum --help
+      # ===================================================================== #
+      when /^-?-?help$/
+        show_help
+        exit
+      # ===================================================================== #
+      # === supercurriculum --no-threshold
+      # ===================================================================== #
+      when /^-?-?no(-|_)?threshold$/
+        no_threshold
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  # ========================================================================= #
+  def show_help
+    e
+    e '  --no-threshold # this means to show all curricula where'
+    e '                 # at the least one lecture has been passed'
+    e '  --master       # show only master-lectures'
+    e
+  end
+
+  # ========================================================================= #
+  # === no_threshold
+  # ========================================================================= #
+  def no_threshold
+    @ignore_ects_below_this_threshold = 0
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === notify_the_user_what_we_will_do_next_on_the_commandline
+  # ========================================================================= #
+  def notify_the_user_what_we_will_do_next_on_the_commandline(i)
+    opnn { :no_colon }
+    e
+    e
+    e 'We will now run through the registered curricula ('+
+      slategray(i.size.to_s+' lectures')+' are registered).'
+    if @ignore_ects_below_this_threshold
+      e
+      e 'The '+lime('threshold value')+
+        ' is set so that only curricula with more '\
+        'than '+lightblue(@ignore_ects_below_this_threshold.to_s)+
+        ' ECTS points'
+      e 'will be listed.'
+    end
+    e
+  end
+
+  # ========================================================================= #
+  # === iterate_over_the_registered_curricula
+  #
+  # This is the powerhorse method of this class.
+  # ========================================================================= #
+  def iterate_over_the_registered_curricula
+    hash = Studium.return_hash_of_already_solved_lectures
+    notify_the_user_what_we_will_do_next_on_the_commandline(hash)
+    hash.each_pair {|name_of_the_lecture, inner_hash|
+      n_ects_points = inner_hash[:ects]
+      all_curricula = inner_hash['curricula']
+      # ===================================================================== #
+      # Proceed only if we have any curricula-id registered there:
+      # ===================================================================== #
+      if all_curricula
+        all_curricula.each {|this_curriculum_number|
+          unless this_curriculum_number.empty? # Ignore unassigned lectures.
+            hash = {}
+            # =============================================================== #
+            # First, add the ECTS points.
+            # =============================================================== #
+            hash[:n_ects_points] = 0
+            if @main_hash[this_curriculum_number].has_key? :n_ects_points
+              hash[:n_ects_points] = @main_hash[this_curriculum_number][:n_ects_points]
+            end
+            hash[:n_ects_points] += n_ects_points
+            # =============================================================== #
+            # Next add how many lectures were passed there.
+            # =============================================================== #
+            hash[:n_lectures_were_passed] = 0
+            if @main_hash[this_curriculum_number].has_key? :n_lectures_were_passed
+              hash[:n_lectures_were_passed] = @main_hash[this_curriculum_number][:n_lectures_were_passed]
+            end
+            hash[:n_lectures_were_passed] += 1
+            @main_hash[this_curriculum_number] = hash
+          end
+        }
+      end
+    }
+    sorted = @main_hash.sort_by {|key, values|
+      values[:n_ects_points]
+    }.reverse
+    # ======================================================================= #
+    # Determine a cut-off value below a certain threshold size.
+    # ======================================================================= #
+    if @ignore_ects_below_this_threshold
+      sorted.reject! {|key, value|
+        n_ects_points = value[:n_ects_points]
+        n_ects_points < @ignore_ects_below_this_threshold
+      }
+    end
+    report(sorted)
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  #
+  # This method will do the actual "reporting", that is, display stuff
+  # to the user, on the commandline.
+  #
+  # The input to this method may contain entries that look like this:
+  #
+  #   ["033658", {:n_ects_points=>13.5, :n_lectures_were_passed=>3}],
+  #
+  # ========================================================================= #
+  def report(i)
+    unless i.empty?
+      e "Most lectures were passed in the "\
+        "following #{royalblue('curricula')}:"
+      e
+      i.each {|id_of_the_curriculum, hash|
+        if @show_only_master_curricula and !::Studium.is_this_a_master_curriculum?(id_of_the_curriculum)
+          next # In this case we will not show it.
+        end
+        n_ects_points = hash[:n_ects_points]
+        n_lectures_were_passed = hash[:n_lectures_were_passed]
+        university = from_curriculum_id_to_university(id_of_the_curriculum)
+        name_of_the_curriculum = Studium.return_name_of_this_curriculum(
+          id_of_the_curriculum
+        )
+        # =================================================================== #
+        # Colourize the name of the curriculum next.
+        # =================================================================== #
+        if name_of_the_curriculum
+          if name_of_the_curriculum.include? 'Mastercurriculum'
+            name_of_the_curriculum.sub!(/Mastercurriculum/,'Mastercurriculum  ')
+          end
+        end
+        # =================================================================== #
+        # === Truncate too long curricula names next
+        # =================================================================== #
+        if name_of_the_curriculum.size > 84
+          name_of_the_curriculum = name_of_the_curriculum[0 .. 85]+' [...]'
+        end
+        colourized_name_of_the_curriculum = ::Colours.send(
+          COLOUR_FOR_THE_NAME_OF_THE_CURRICULA, name_of_the_curriculum
+        )
+        left_side = @left_padding_to_use+
+                    colourized_name_of_the_curriculum+
+                    teal(" (#{id_of_the_curriculum}) ")
+        left_side = left_side.ljust(144)
+        if @skip_lehramt_curricula
+          if left_side.include?('Lehramt') or
+             left_side.include?('Besuch einzelner Lehrveranstaltungen')
+            next
+          end
+        end
+        padded_university = university.to_s.ljust(11)
+        padded_n_lectures_were_passed = (
+          n_lectures_were_passed.to_s.rjust(2)+' lectures passed'
+        ).rjust(16)
+        colourized_n_ects_points = slateblue(n_ects_points.to_s.rjust(5)+' ECTS')
+        # =================================================================== #
+        # Prettify the result next.
+        # =================================================================== #
+        colourized_n_lectures_were_passed = darkslateblue(
+          padded_n_lectures_were_passed
+        )
+        result = left_side+
+                 colourized_n_ects_points+' '+
+                 royalblue(padded_university)
+        if result.include? 'Mastercurriculum'
+          # ================================================================= #
+          # Colourize the word 'Mastercurriculum' in this case.
+          # ================================================================= #
+          result.sub!(
+            /Mastercurriculum/,   cornflowerblue(   'Mastercurriculum')+
+            main_colour
+          )
+        elsif result.include? 'Bachelorcurriculum'
+          result.sub!(
+            /Bachelorcurriculum/, mediumspringgreen('Bachelorcurriculum')+
+            main_colour
+          )
+        end
+        result << ' '+colourized_n_lectures_were_passed
+        e result
+      }; e
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    iterate_over_the_registered_curricula
+  end
+
+  # ========================================================================= #
+  # === Studium::CurriculumComparer[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::CurriculumComparer.new(ARGV)
+end # curriculum_comparer