studium 0.18.7

data/lib/studium/statistics/curriculum_comparer/curriculum_comparer.rb

@@ -0,0 +1,423 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Statistics::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::Statistics::CurriculumComparer.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/statistics/curriculum_comparer/curriculum_comparer.rb'
+# Studium::Statistics::CurriculumComparer.new(ARGV)
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Statistics
+
+class CurriculumComparer < Studium::Base # === Studium::Statistics::CurriculumComparer
+
+  # ========================================================================= #
+  # === 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           = ARGV,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === :show_only_master_curricula
+    # ======================================================================= #
+    @internal_hash[:show_only_master_curricula] = false
+    # ======================================================================= #
+    # === :show_only_bachelor_curricula
+    # ======================================================================= #
+    @internal_hash[:show_only_bachelor_curricula] = false
+    # ======================================================================= #
+    # === :skip_lehramt_curricula
+    # ======================================================================= #
+    @internal_hash[:skip_lehramt_curricula] = true # If true we ignore "Lehramt" curricula
+    # ======================================================================= #
+    # === :ignore_ects_below_this_threshold
+    # ======================================================================= #
+    @internal_hash[:ignore_ects_below_this_threshold] = THRESHOLD_N_ECTS # Less than this threshold in ECTS will be ignored.
+    # ======================================================================= #
+    # === :left_padding_to_use
+    #
+    # How much we will pad to the left side.
+    # ======================================================================= #
+    @internal_hash[:left_padding_to_use] = ' '.dup
+    # ======================================================================= #
+    # === :main_hash
+    # ======================================================================= #
+    @internal_hash[:main_hash] = {} # This Hash will contain information pertaining to the relevant lectures.
+    # ======================================================================= #
+    # Default to an empty Hash. One entry specifies the amount of ECTS points.
+    # ======================================================================= #
+    @internal_hash[:main_hash].default = {}
+  end
+
+  # ========================================================================= #
+  # === left_padding_to_use?
+  # ========================================================================= #
+  def left_padding_to_use?
+    @internal_hash[:left_padding_to_use]
+  end
+
+  # ========================================================================= #
+  # === skip_lehramt_curricula?
+  # ========================================================================= #
+  def skip_lehramt_curricula?
+    @internal_hash[:skip_lehramt_curricula]
+  end
+
+  # ========================================================================= #
+  # === ignore_ects_below_this_threshold?
+  # ========================================================================= #
+  def ignore_ects_below_this_threshold?
+    @internal_hash[:ignore_ects_below_this_threshold]
+  end
+
+  # ========================================================================= #
+  # === no_threshold
+  # ========================================================================= #
+  def no_threshold
+    @internal_hash[:ignore_ects_below_this_threshold] = 0
+  end
+
+  # ========================================================================= #
+  # === show_only_master_curricula?
+  # ========================================================================= #
+  def show_only_master_curricula?
+    @internal_hash[:show_only_master_curricula]
+  end
+
+  # ========================================================================= #
+  # === show_only_bachelor_curricula?
+  # ========================================================================= #
+  def show_only_bachelor_curricula?
+    @internal_hash[:show_only_bachelor_curricula]
+  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 '  --only-bachelor    # show only bachelor-lectures'
+    e '  --only-master      # show only master-lectures'
+    e
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i
+      # ===================================================================== #
+      # === supercurriculum --master
+      # ===================================================================== #
+      when /^-?-?master$/,
+           /^-?-?only(-|_)?master$/
+        @internal_hash[:show_only_master_curricula] = true
+      # ===================================================================== #
+      # === supercurriculum --master
+      # ===================================================================== #
+      when /^-?-?bachelor$/,
+           /^-?-?only(-|_)?bachelor$/
+        @internal_hash[:show_only_bachelor_curricula] = true
+      # ===================================================================== #
+      # === supercurriculum --help
+      # ===================================================================== #
+      when /^-?-?help$/
+        show_help
+        exit
+      # ===================================================================== #
+      # === supercurriculum --no-threshold
+      # ===================================================================== #
+      when /^-?-?no(-|_)?threshold$/i,
+           /^-?-?no(-|_)?limit$/i
+        no_threshold
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === do_notify_the_user_about_the_threshold_value_in_use
+  # ========================================================================= #
+  def do_notify_the_user_about_the_threshold_value_in_use
+    _ = ignore_ects_below_this_threshold?
+    e
+    if _ == 0
+      egrey 'There is no '+lime('threshold value')+grey(' in use currently.')
+    else
+      egrey "The #{lime('threshold value')}"+
+             grey(' is set so that only curricula with more than ')+
+             lightblue(_.to_s)+
+             grey(' ECTS points')
+      egrey 'will be listed below.'
+    end
+  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 grey('We will now run through the registered curricula (')+
+      slategray(i.size.to_s+' lectures')+
+      grey(' are registered).')
+    if ignore_ects_below_this_threshold?
+      do_notify_the_user_about_the_threshold_value_in_use
+    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
+    ) # Return the Hash that keeps track of all 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 @internal_hash[:main_hash][this_curriculum_number].has_key? :n_ects_points
+              hash[:n_ects_points] = @internal_hash[: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 @internal_hash[:main_hash][this_curriculum_number].has_key? :n_lectures_were_passed
+              hash[:n_lectures_were_passed] = @internal_hash[:main_hash][this_curriculum_number][:n_lectures_were_passed]
+            end
+            hash[:n_lectures_were_passed] += 1
+            @internal_hash[:main_hash][this_curriculum_number] = hash
+          end
+        }
+      end
+    }
+    sorted = @internal_hash[: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
+
+  # ========================================================================= #
+  # === main_colour
+  # ========================================================================= #
+  def main_colour
+    ::Colours.remove_trailing_ansii_escape_code(
+      ::Colours.send(COLOUR_FOR_THE_NAME_OF_THE_CURRICULA, '')
+    )
+  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?
+      egrey "Most lectures were passed in the "\
+            "following #{royalblue('curricula')}#{grey(':')}"
+      e
+      in_loop_colour = Colours.send(
+        COLOUR_FOR_THE_NAME_OF_THE_CURRICULA,
+        ''
+      ) { :omit_end }
+      in_loop_colour = in_loop_colour.dup
+      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
+        if show_only_bachelor_curricula? and !::Studium.is_this_a_bachelor_curriculum?(id_of_the_curriculum)
+          next # In this case we will not show it.
+        end
+        n_ects_points = hash[:n_ects_points] # Obtain n ECTS next.
+        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, past 84 chars
+        # =================================================================== #
+        if name_of_the_curriculum and name_of_the_curriculum.size > 84
+          name_of_the_curriculum = name_of_the_curriculum[0 .. 85]+' [...]'
+        end
+        if name_of_the_curriculum
+          splitted = name_of_the_curriculum.split(' ')
+          splitted[0] = splitted[0].ljust(20)
+          splitted[1 .. - 1] = splitted[1 .. -1].join(' ').strip.dup
+          splitted[1].rstrip!
+          splitted[1] = splitted[1].ljust(65) # Must be fairly high.
+        end
+        if name_of_the_curriculum and splitted[0].include?('curriculum')
+          # =================================================================== #
+          # === Colourize Mastercurriculum and Bachelorcurriculum strings next
+          # =================================================================== #
+          case splitted[0]
+          # =================================================================== #
+          # === Mastercurriculum
+          # =================================================================== #
+          when /Mastercurriculum/
+            splitted[0].sub!(
+              /Mastercurriculum/,    cornflowerblue('Mastercurriculum')+
+                                     in_loop_colour
+            )
+          # =================================================================== #
+          # === Bachelorcurriculum
+          # =================================================================== #
+          when /Bachelorcurriculum/
+            splitted[0].sub!(
+              /Bachelorcurriculum/,  mediumspringgreen('Bachelorcurriculum')+
+                                     in_loop_colour
+            )
+          # else
+          #  splitted[0] = Colours.send(in_loop_colour.to_sym, splitted[0])
+          end
+          splitted[1] = Colours.send(
+            COLOUR_FOR_THE_NAME_OF_THE_CURRICULA.to_sym, splitted[1]
+          )
+        else
+          splitted.map! {|entry|
+            Colours.send(
+              COLOUR_FOR_THE_NAME_OF_THE_CURRICULA.to_sym, entry
+            )
+          }
+        end
+        joined = splitted.join(' ').dup
+        left_side = left_padding_to_use?.dup
+        left_side << joined
+        # =================================================================== #
+        # Next add the id of the curriculum - this has to be padded,
+        # as some IDs are e. g. "990":
+        # =================================================================== #
+        left_side << teal(
+          " (#{id_of_the_curriculum}) ".rjust(10)
+        )
+        left_side.rstrip!
+        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)
+        # =================================================================== #
+        # Next add the ECTS points:
+        # =================================================================== #
+        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)
+        result << ' '+colourized_n_lectures_were_passed
+        e result
+      }; e
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    menu
+    iterate_over_the_registered_curricula
+  end
+
+  # ========================================================================= #
+  # === Studium::Statistics::CurriculumComparer[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Statistics::CurriculumComparer.new(ARGV)
+end # curriculumcomparer

data/lib/studium/statistics/determine_exam_statistics_from_this_file.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Statistics::DetermineExamStatisticsFromThisFile
+#
+# This class will show "statistical-data" from a local file. That file
+# should be an exam-file, e. g. it should show the ID of the student,
+# and the grade, e. g. "48553 3" which means that grade 3 is given to
+# the id 48553.
+#
+# I needed this functionality so that I can compare the performance
+# and statistics for a given exam date.
+#
+# As input to this file, you can pass in one or more file(s). These
+# files will be batch-processed.
+#
+# Usage example:
+#
+#   Studium::Statistics::DetermineExamStatisticsFromThisFile.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/statistics/determine_exam_statistics_from_this_file.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Statistics
+
+class DetermineExamStatisticsFromThisFile < Base # === Studium::Statistics::DetermineExamStatisticsFromThisFile.new
+
+  # ========================================================================= #
+  # === 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()
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = []
+  end
+
+  # ========================================================================= #
+  # === determine_filename
+  # ========================================================================= #
+  def determine_filename(
+      from = first_argument?
+    )
+    @filename = from
+  end
+
+  # ========================================================================= #
+  # === try_to_read_in_the_filecontent
+  # ========================================================================= #
+  def try_to_read_in_the_filecontent(
+      _ = @filename
+    )
+    if File.exist? _
+      e
+      e 'Reading in the dataset from the file '+sfile(_)+'.'
+      e
+      @dataset = readlines_with_proper_encoding(_).map(&:strip)
+      obtain_statistics
+      report
+    else
+      e 'No file called '+sfile(_)+' exists.'
+    end
+  end
+
+  # ========================================================================= #
+  # === obtain_statistics
+  # ========================================================================= #
+  def obtain_statistics
+    @n_students = @dataset.size
+    @hash_grades = {}
+    @hash_grades.default = 0
+    @dataset.each {|data|
+      splitted = data.split(' ')
+      grade = splitted.last.to_s.strip.to_i
+      _student_id = splitted.first.to_s
+      @hash_grades[grade] += 1
+    }
+  end
+
+  # ========================================================================= #
+  # === report
+  #
+  # This method will report our findings to the user, on the commandline.
+  # ========================================================================= #
+  def report
+    total = @n_students.to_i
+    e 'A total of '+lightgreen(total.to_s)+' participated in the exam at '+
+      royalblue(@filename.sub(/\.md$/,''))+'.'
+    e
+    e 'The grades were as follows:'
+    e
+    @hash_grades.sort_by {|a, b| a.to_i
+    }.each {|this_grade, n_students|
+      percentage_value = ((n_students.to_i * 100) / total).round(2)
+      e '  '+skyblue(this_grade.to_s+': ')+
+        n_students.to_s.rjust(2)+' students '+
+        grey('('+percentage_value.to_s.rjust(2)+'%)')
+    }; e
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    @commandline_arguments.each {|this_file|
+      determine_filename(this_file)
+      try_to_read_in_the_filecontent(this_file)
+    }
+  end
+
+  # ========================================================================= #
+  # === Studium::Statistics::DetermineExamStatisticsFromThisFile[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Statistics::DetermineExamStatisticsFromThisFile.new(ARGV)
+end # determineexamstatisticsfromthisfile 26.06.2018

data/lib/studium/statistics/exam_topics_that_are_about_to_be_completed.rb

@@ -0,0 +1,117 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Statistics::ExamTopicsThatAreAboutToBeCompleted
+#
+# This class will quickly show which exam-topics are about to be
+# completed, that is, to have reached 100%. This means that the
+# user has finished answering all exam topics for a particular
+# topic, such as "genetics1". Usually this means, at the least
+# for the larger topics, to be able to answer 1000 different or
+# slightly related exam topics.
+#
+# Usage example:
+#
+#   Studium::Statistics::ExamTopicsThatAreAboutToBeCompleted.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/top_stats.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Statistics
+
+class ExamTopicsThatAreAboutToBeCompleted < Base # === Studium::Statistics::ExamTopicsThatAreAboutToBeCompleted
+
+  # ========================================================================= #
+  # === 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
+    # ======================================================================= #
+    # === @hash
+    # ======================================================================= #
+    @hash = {}
+    # ======================================================================= #
+    # === @show_n_exam_topics
+    #
+    # Show n exam topics next. Without that limitation we may potentially
+    # show a few hundred exam topics, which is too much for the purpose
+    # of this class here.
+    # ======================================================================= #
+    @show_n_exam_topics = 25
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    exam_topics?.each {|this_topic|
+      percentage_value = ::Studium.return_percentage_of_solved_exam_questions_from_this_exam_topic(
+        this_topic
+      ).to_f
+      @hash[this_topic] = percentage_value
+      if percentage_value.to_f == 0.0
+        percentage_value = '0.00'
+      end
+    }
+    report(@hash)
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report(
+      i = @hash
+    )
+    if i and i.is_a?(Hash)
+      # ===================================================================== #
+      # Sort it first:
+      # ===================================================================== #
+      sorted_array = i.sort_by {|key, value| value }.reverse.reject {|key, value|
+        value == 100.0 # Exam topics that are completed, aka 100%, are skipped.
+      }
+      e
+      e "#{rev}The following #{@show_n_exam_topics} exam topics are about to be completed next:"
+      e
+      sorted_array[0 .. (@show_n_exam_topics - 1)].each {|this_topic, percentage_value|
+        e '  '+
+          steelblue(this_topic.ljust(58))+' '+
+          mediumorchid(
+            percentage_value.to_s.rjust(6, ' ')+'%'
+          )
+      }
+      e
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium::Statistics::ExamTopicsThatAreAboutToBeCompleted[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Statistics::ExamTopicsThatAreAboutToBeCompleted.new(ARGV)
+end # ExamTopicsThatAreAboutToBeCompleted