studium 0.18.7

data/lib/studium/statistics/report_how_many_exam_questions_were_answered.rb

@@ -0,0 +1,473 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Statistics::ReportHowManyExamQuestionsWereAnswered
+#
+# This class will give us statistical information about how many exam
+# questions were answered for each topic at hand.
+#
+# It will, by default, sort the entries.
+# =========================================================================== #
+# require 'studium/statistics/report_how_many_exam_questions_were_answered.rb'
+# Studium::Statistics::ReportHowManyExamQuestionsWereAnswered.new
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Statistics
+
+class ReportHowManyExamQuestionsWereAnswered < ::Studium::Base # === Studium::Statistics::ReportHowManyExamQuestionsWereAnswered
+
+  require 'studium/toplevel_methods/toplevel_methods.rb'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      optional_commandline_arguments = ARGV,
+      run_already                    = true
+    )
+    reset
+    if optional_commandline_arguments
+      menu(optional_commandline_arguments)
+    end
+    if block_given?
+      yielded = yield
+      case yielded
+      when :do_not_show_result,
+           :do_not_show_the_result,
+           :do_not_display_the_result,
+           :be_quiet
+        @output_result = false
+      end
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @hash
+    # ======================================================================= #
+    @hash = {} # This is the main hash - it stores the dataset for every topic at hand.
+    # ======================================================================= #
+    # === @string_to_save_into_file
+    # ======================================================================= #
+    @string_to_save_into_file = ''.dup
+    # ======================================================================= #
+    # === @n_total_questions
+    # ======================================================================= #
+    @n_total_questions = 0
+    # ======================================================================= #
+    # === @n_total_answers
+    # ======================================================================= #
+    @n_total_answers   = 0
+    # ======================================================================= #
+    # === @output_result
+    # ======================================================================= #
+    @output_result     = true
+  end
+
+  # ========================================================================= #
+  # === menu
+  # ========================================================================= #
+  def menu(i)
+    if i.is_a? Array
+      i.flatten.each {|entry| menu(entry) }
+    else
+      case i.to_s.delete('-') # case tag
+      # ===================================================================== #
+      # === examstatistics --generate-webpage
+      # ===================================================================== #
+      when /^-?-?generate(_|-)?homepage$/,
+           'www',
+           /webpage/ # The last variant also includes --generate-webpage
+         generate_webpage
+      # ===================================================================== #
+      # === be_quiet_and_no_colours
+      # ===================================================================== #
+      when 'be_quiet_and_no_colours'
+        be_quiet
+        no_colours
+      # ===================================================================== #
+      # === be_quiet
+      # ===================================================================== #
+      when /^-?-?be_?quiet/,
+           /^-?-?be_?silent/
+        be_quiet
+      # ===================================================================== #
+      # === shorten
+      # ===================================================================== #
+      when /^-?-?shorten$/,'short','shor','sho','sh','s'
+        @shorten_result = true
+      # ===================================================================== #
+      # === 5
+      # ===================================================================== #
+      when /\d+/ # Else if input is a number. We will display only x categories.
+        @keep_only_n_results = i.to_i - 1
+      # else
+        # pp _ # Be silent for now.
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === hash?
+  # ========================================================================= #
+  def hash?
+    @hash
+  end; alias internal_dataset hash? # === internal_dataset
+
+  # ========================================================================= #
+  # === string_to_save_into_file?
+  # ========================================================================= #
+  def string_to_save_into_file?
+    @string_to_save_into_file
+  end; alias text?    string_to_save_into_file? # === text?
+       alias dataset? string_to_save_into_file? # === dataset?
+
+  # ========================================================================= #
+  # === output_result?
+  # ========================================================================= #
+  def output_result?
+    @output_result
+  end
+
+  # ========================================================================= #
+  # === save_dataset_into_file
+  # ========================================================================= #
+  def save_dataset_into_file(
+      into = "#{::Studium.log_dir?}exam_statistics"
+    )
+    write_what_into(@string_to_save_into_file, into)
+  end
+ 
+  # ========================================================================= #
+  # === n_questions?
+  # ========================================================================= #
+  def n_questions?
+    @n_total_questions
+  end
+
+  # ========================================================================= #
+  # === n_answers?
+  # ========================================================================= #
+  def n_answers?
+    @n_total_answers
+  end; alias n_questions_answered n_answers? # === n_questions_answered
+
+  # ========================================================================= #
+  # === sort_main_hash_by_percentages
+  # ========================================================================= #
+  def sort_main_hash_by_percentages
+    _ = @hash.sort_by {|key, value|
+      value[:percentage_of_questions_answered].to_f # Need to work on Floats. 
+    }
+    new_hash = Hash[_.reverse]
+    @hash = new_hash # Now the Hash is sorted.
+  end
+
+  # ========================================================================= #
+  # === considering_renaming_kde_konsole_tab
+  # ========================================================================= #
+  def considering_renaming_kde_konsole_tab(
+      use_this_title = 'Exam Statistics'
+    )
+    if Object.const_defined?(:Roebe) and
+       Roebe.respond_to?(:rename_konsole_tab) and
+       konsole_support? and
+       rename_konsole_tab?
+      begin
+        require 'roebe/classes/kde/kde_konsole/kde_konsole.rb'
+      rescue LoadError; end
+      Roebe.rename_konsole_tab(use_this_title, :be_quiet)
+    end
+  end
+
+  # ========================================================================= #
+  # === display_dataset
+  # ========================================================================= #
+  def display_dataset
+    if output_result? and be_verbose?
+      e @string_to_save_into_file # Display the main string.
+      save_how_many_questions_we_have_registered_so_far
+      save_dataset_into_file
+    end
+  end; alias display display_dataset # === display
+
+  # ========================================================================= #
+  # === initialize_main_dataset
+  #
+  # This will populate @hash with the proper entries.
+  # ========================================================================= #
+  def initialize_main_dataset
+    all_topics = ::Studium::Exams.all_topics_as_short_name
+    directory_to_the_exam_topics = directory_to_the_exam_topics?
+    @hash.clear
+    # ======================================================================= #
+    # Iterate over the full dataset next.
+    # ======================================================================= #
+    all_topics.each {|filename|
+      # ===================================================================== #
+      # We will obtain the path to the filename. In the past we also
+      # applied .downcase on this, but some files may contain upcased
+      # characters, such as the file 'RNAi_siRNA_and_miRNA'.
+      # ===================================================================== #
+      path = "#{directory_to_the_exam_topics}#{filename}"
+      if File.file? path
+        dataset = default_readlines(path)
+        dataset = ::Studium.filter_away_invalid_questions(dataset, path)
+        n_total_questions = dataset.size
+        n_questions_answered = dataset.select {|entry| entry.include? ' []' }.size
+        # ===================================================================== #
+        # We must be careful when we calculate the percentage. We
+        # should not divide by 0.
+        # ===================================================================== #
+        if n_total_questions == 0
+          percentage_of_questions_answered = 0
+        else
+          percentage_of_questions_answered = (
+            (n_questions_answered * 100.0) / n_total_questions
+          ).round(2)
+        end
+        @hash[filename.to_sym] = {
+          n_total_questions:                n_total_questions,
+          n_questions_answered:             n_questions_answered,
+          percentage_of_questions_answered: percentage_of_questions_answered
+        }
+      else
+        opne no_file_at(path)
+      end
+    } # At this point, we have initialized our dataset properly.
+    sort_main_hash_by_percentages
+    populate_main_string
+    add_statistical_information_to_the_main_string
+  end
+
+  # ========================================================================= #
+  # === populate_main_string
+  #
+  # This is the method that will fill up the main String that is to be
+  # displayed to the user.
+  # ========================================================================= #
+  def populate_main_string
+    index = 0
+    # ======================================================================= #
+    # We can now display the relevant entries from our main Hash. We will
+    # sort the entries by n total questions. If this is unwanted, we can
+    # remove it again at a later time.
+    # We have to sort on two criteria at the same time - first, how
+    # many questions; and then, how many answers to these questions.
+    # ======================================================================= #
+    sorted = @hash.sort_by {|key, value|
+      [
+        value[:n_total_questions],
+        value[:n_questions_answered]
+      ]
+    }.reverse
+    if use_unicode_symbols? and !www_mode?
+      @string_to_save_into_file << N
+      @string_to_save_into_file << return_unicode_line
+      @string_to_save_into_file << N
+    end
+    sorted.each {|key, value| # value is a hash as well
+      index += 1
+      name_of_the_topic_at_hand = ::Studium.find_corresponding_exam_title(key.to_s)
+      if name_of_the_topic_at_hand.nil?
+        opne 'No topic was found for '+orange(key.to_s)
+        opne 'Considering adding this topic into '+
+              orange('Studium.find_corresponding_exam_title()')
+      else
+        n_total_questions    = value.fetch(:n_total_questions)
+        @n_total_questions  += n_total_questions
+        n_questions_answered = value.fetch(:n_questions_answered)
+        @n_total_answers    += n_questions_answered
+        _  = ''.dup
+        inner_index = index.to_s.rjust(3)
+        if is_on_www? # Handle www-situation.
+          _ << '<span style="color: sandybrown">'+inner_index+'</span>) '
+        else
+          _ << sandybrown(inner_index)+paleturquoise(') ')
+        end
+        # =================================================================== #
+        # Next add the name of the exam-topic at hand. This used to
+        # be colourized in slateblue, but is now handled via royalblue.
+        # =================================================================== #
+        _ << royalblue(name_of_the_topic_at_hand.ljust(52))
+        # =================================================================== #
+        # Next, add how many questions exist for this particular topic.
+        # The .rjust() value must be at the least 4, because right now the
+        # maximum amount of questions allowed for a given topic is '1000'.
+        # =================================================================== #
+        if n_total_questions.to_i == 1000 # When this topic has 1000 questions, another colour is used.
+          _ << "#{lawngreen(n_total_questions.to_s.rjust(4))} questions in total."
+        else 
+          # ================================================================= #
+          # Colourize in lightslategray by default.
+          # ================================================================= #
+          _ << "#{lightslategray(n_total_questions.to_s.rjust(4))} questions in total."
+        end
+        _ << sfancy(n_questions_answered.to_s.rjust(4))+' answered yet.'
+        # =================================================================== #
+        # Next, add the percentage value here.
+        # =================================================================== #
+        the_percentage = '0.0'
+        unless n_total_questions.to_i == 0
+          the_percentage = (n_questions_answered * 100 / n_total_questions).round(2).to_s
+        end
+        _ << ' (That is '+colourize_percentage(
+          the_percentage.to_i.to_s.rjust(3)+'%'
+        )+')'+N
+        @string_to_save_into_file << _
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === add_statistical_information_to_the_main_string
+  #
+  # The task of this method is to add how many questions and
+  # answered to these questions we have.
+  # ========================================================================= #
+  def add_statistical_information_to_the_main_string
+    _ = ''.dup
+    if use_unicode_symbols? and !www_mode?
+      _ << N
+      _ << return_unicode_line
+    end
+    _ << N
+    _ << 'n questions available: '+sfancy(n_questions?.to_s)+N
+    _ << 'n answers given:       '+
+          sfancy(n_questions_answered.to_s.rjust(5))+N
+    @string_to_save_into_file << _
+  end
+
+  # ========================================================================= #
+  # === return_unicode_line
+  # ========================================================================= #
+  def return_unicode_line
+    ' '+unicode_blocks_line(:steelblue, 115)+' '
+  end
+
+  # ========================================================================= #
+  # === save_how_many_questions_we_have_registered_so_far
+  #
+  # This method saves how many total questions we have already
+  # registered so far.
+  # ========================================================================= #
+  def save_how_many_questions_we_have_registered_so_far
+    what = @n_total_questions
+    into = FILE_N_TOTAL_QUESTIONS
+    write_what_into(what, into)
+    into = base_dir?+File.basename(FILE_N_TOTAL_QUESTIONS)
+    write_what_into(what, into)
+    if is_on_roebe?
+      into = RUBY_SRC_DIR+'studium/lib/studium/yaml/'+
+             File.basename(FILE_N_TOTAL_QUESTIONS)
+      e "Also storing in #{sfile(into)} as we are on roebe."
+      write_what_into(what, into)
+    end
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    considering_renaming_kde_konsole_tab
+    initialize_main_dataset
+    display_dataset
+  end
+
+  # ========================================================================= #
+  # === generate_webpage
+  #
+  # This method will generate a webpage.
+  #
+  # Invocation example:
+  #
+  #   examstatistics --generate-webpage
+  #
+  # ========================================================================= #
+  def generate_webpage
+    set_runmode(:www)
+    disable_colours
+    initialize_main_dataset
+    use_this_regex = /\(That is (\d*.\d+) %\)/ # See: http://rubular.com/r/I3r4ryPFfw
+    use_this_css_style = 'background-color: black; padding: 0.5em; color: white; font-size:1.2em;'
+    _ = dataset?.gsub(/\n/, "\n<br>")
+    _ =~ use_this_regex
+    _.gsub!(use_this_regex, '(That is <span style="color: red">\1</span> %)')
+    what = '<html><title>Statistics</title><body style="'+use_this_css_style+'">'+_+'</body></html>'
+    into = "#{html_log_directory?}statistics.html"
+    write_what_into(what, into)
+    opne "Storing into file `#{sfile(into)}`."
+  end
+
+  # ========================================================================= #
+  # === Studium::Statistics::ReportHowManyExamQuestionsWereAnswered[]
+  #
+  # This is the variant that will not display the result.
+  # ========================================================================= #
+  def self.[](*args) # Accepts arguments.
+    object = new(args) { :do_not_display_the_result }
+    return object
+  end
+
+  # ========================================================================= #
+  # === Studium::Statistics::ReportHowManyExamQuestionsWereAnswered.generate_webpage
+  # ========================================================================= #
+  def self.generate_webpage
+    new('generate_webpage')
+  end
+
+  # ========================================================================= #
+  # === Studium::Statistics::ReportHowManyExamQuestionsWereAnswered.show_stats
+  # ========================================================================= #
+  def self.show_stats
+    new
+  end
+
+  # ========================================================================= #
+  # === Studium::Statistics::ReportHowManyExamQuestionsWereAnswered[]
+  # ========================================================================= #
+  def [](key)
+    # ======================================================================= #
+    # If the key is :random_topic then we will treat it in a special
+    # manner.
+    # ======================================================================= #
+    if key == :random_topic
+      key = @hash.keys.sample
+    end
+    @hash[key.to_sym]
+  end
+
+end
+
+# =========================================================================== #
+# === Studium::Statistics.show_stats
+# =========================================================================== #
+def self.show_stats
+  Studium::Statistics::ReportHowManyExamQuestionsWereAnswered.show_stats
+end
+
+end
+
+# =========================================================================== #
+# === Studium.statistics
+# =========================================================================== #
+def self.statistics(i = nil)
+  Statistics::ReportHowManyExamQuestionsWereAnswered.new(i)
+end; self.instance_eval { alias stats_about_exam_questions statistics } # === Studium.stats_about_exam_questions
+     self.instance_eval { alias show_stats                 statistics } # === Studium.show_stats
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Statistics::ReportHowManyExamQuestionsWereAnswered.new(ARGV)
+end # examstats

data/lib/studium/statistics/show_exam_statistics.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/statistics/show_exam_statistics.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/constants/constants.rb'
+  require 'studium/colours/colours.rb'
+  require 'studium/toplevel_methods/e_and_esystem.rb'
+  require 'studium/toplevel_methods/toplevel_methods.rb'
+
+  # ========================================================================= #
+  # === Studium.show_exam_statistics
+  # ========================================================================= #
+  def self.show_exam_statistics(
+      _ = FILE_STATISTICS
+    )
+    if File.exist? _
+      e
+      opnn; e "Reading from the file `#{Colours.sfile(_)}`."
+      dataset = File.readlines(_).select {|line|
+        line.start_with?('# Am') 
+      }.join
+      # ===================================================================== #
+      # Now we have the dataset - let's colourize the answers in crimson().
+      # ===================================================================== #
+      use_this_regex = /davon waren (\d{1,5}) beantwortet/
+      dataset.gsub!(
+        use_this_regex,
+        rev+'davon waren '+crimson('\\1')+
+        rev+' beantwortet'
+      )
+      use_this_regex =
+        /(Am \d{1,2}.\d{1,2}.\d{4} waren es\s+)(\d{1,2}\.\d{1,5}) Fragen/
+      # ===================================================================== #
+      # Colourize "n Fragen" next.
+      # ===================================================================== #
+      dataset.gsub!(
+        use_this_regex, '\\1'+lightgreen('\\2')+rev+' Fragen'
+      )
+      # ===================================================================== #
+      # Colourize the date.
+      # ===================================================================== #
+      use_this_regex = /Am (\d{1,2}.\d{1,2}.\d{4}) /
+      dataset.gsub!(
+        use_this_regex, rev+'Am '+slateblue('\\1')+rev+' '
+      )
+      # ===================================================================== #
+      # Next, modify the % percentage value.
+      # ===================================================================== #
+      use_this_regex = /(\d{1,2}\.\d{1,2}%)/
+      dataset.gsub!(use_this_regex, turquoise('\\1')+rev)
+      # ===================================================================== #
+      # Next, colourize the "davon waren xyz beantwortet".
+      # ===================================================================== #
+      use_this_regex = /(davon waren\s{0,2})(\d{1,7})( beantwortet)/ # See: https://rubular.com/r/6Z5ACALQvdTief
+      dataset.gsub!(use_this_regex, rev+'\\1'+lightsalmon('\\2')+rev+'\\3')
+      # ===================================================================== #
+      # Next, modify entries such as: [229.5 ECTS]
+      # ===================================================================== #
+      use_this_regex = /(\[\d{1,3}\.\d{0,2}\sECTS\])/ # See: https://rubular.com/r/izyKPj1o2ZKXlS
+      dataset.gsub!(use_this_regex, orangered('\\1')+rev)
+      e; e dataset; e
+    else
+      e "No file exists at #{Colours.sfile(_)}"
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium.show_exam_statistics  
+end # showexamstatistics

data/lib/studium/statistics/show_which_courses_are_in_a_bachelor_or_master_curriculum_respectively.rb

@@ -0,0 +1,104 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Statistics::ShowWhichCoursesAreInABachelorOrMasterCurriculumRespectively
+#
+# This class will report how many courses are in a bachelor or master
+# curricula, or both.
+#
+# Usage example:
+#
+#   Studium::Statistics::ShowWhichCoursesAreInABachelorOrMasterCurriculumRespectively.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/top_stats.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Statistics
+
+class ShowWhichCoursesAreInABachelorOrMasterCurriculumRespectively < ::Studium::Base # === Studium::Statistics::ShowWhichCoursesAreInABachelorOrMasterCurriculumRespectively
+
+  # ========================================================================= #
+  # === 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 = return_dataset_from_the_file_lecture_information
+    # ======================================================================= #
+    # === @inner_hash
+    # ======================================================================= #
+    @inner_hash = {}
+    @inner_hash[:n_bachelor_courses]                 = 0
+    @inner_hash[:n_master_courses]                   = 0
+    @inner_hash[:n_combined_bachelor_master_courses] = 0
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    @dataset.each_pair {|name_of_the_course, inner_hash|
+      curricula = inner_hash['curricula']
+      if    has_a_bachelor_and_a_master_curriculum?(curricula)
+        @inner_hash[:n_combined_bachelor_master_courses] += 1
+      elsif has_a_bachelor_curriculum?(curricula)
+        @inner_hash[:n_bachelor_courses] += 1
+      elsif has_a_master_curriculum?(curricula)
+        @inner_hash[:n_master_courses] += 1
+      else
+        # e 'Neither bachelor or master curriculum.'
+      end
+    }
+    report(@inner_hash)
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report(i = @inner_hash)
+    if i.is_a? Hash
+      e rev+'n bachelor courses:                   '+steelblue(i[:n_bachelor_courses].to_s)
+      e rev+'n master courses:                     '+steelblue(i[:n_master_courses].to_s)
+      e rev+'n combined bachelor/master courses:   '+steelblue(i[:n_combined_bachelor_master_courses].to_s)
+      e 'Total number of lectures attributed above: '+
+        royalblue(
+          i[:n_bachelor_courses]+
+          i[:n_master_courses]+
+          i[:n_combined_bachelor_master_courses]
+        )
+    end
+  end
+
+  # ========================================================================= #
+  # === Studium::Statistics::ShowWhichCoursesAreInABachelorOrMasterCurriculumRespectively[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Statistics::ShowWhichCoursesAreInABachelorOrMasterCurriculumRespectively.new(ARGV)
+end # ShowWhichCoursesAreInABachelorOrMasterCurriculumRespectively