studium 0.10.1

data/lib/studium/parsers/README.md

@@ -0,0 +1,2 @@
+This directory may include some classes that specifically parse
+content from a file/string.

data/lib/studium/parsers/custom_exam_results_parser.rb

@@ -0,0 +1,208 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::CustomExamResultsParser
+#
+# This class can be used to calculate e. g. the number of students and
+# the percentage values of people having passed exams, such as the
+# Steop exam "321002-1 Steop Biologie f�r PharmazeutInnen".
+#
+# Usage example:
+#
+#   Studium::CustomExamResultsParser.new
+#
+# =========================================================================== #
+# require 'studium/parsers/custom_exam_results_parser.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class CustomExamResultsParser < Studium::Base # === Studium::CustomExamResultsParser
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === DEFAULT_FILE
+  # ========================================================================= #
+  DEFAULT_FILE = '/Depot/j/test.md'
+
+  # ========================================================================= #
+  # === ROUND_TO_N_NUMBERS
+  # ========================================================================= #
+  ROUND_TO_N_NUMBERS = 1
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = DEFAULT_FILE,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # === @hash_storing_results
+    @hash_storing_results = {}
+    @hash_storing_results.default = 0
+    @available_grades = []
+    @n_students_have_positive_grades = 0
+  end
+
+  # ========================================================================= #
+  # === result?
+  # ========================================================================= #
+  def result?
+    @hash_storing_results
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(
+      i = DEFAULT_FILE
+    )
+    i = i.first if i.is_a? Array
+    i = DEFAULT_FILE if i.nil?
+    i = i.to_s.dup
+    if File.exist? i
+      i = read_file_with_default_encoding(i)
+    end
+    # ======================================================================= #
+    # Remove any entries that do NOT start with a number.
+    # ======================================================================= #
+    splitted = i.split(N).select {|line| line =~ /^\d+/ }
+    i = splitted.join(N)
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn
+    if block_given?
+      super(NAMESPACE) { yield }
+    else
+      super(NAMESPACE)
+    end
+  end
+
+  # ========================================================================= #
+  # === parse_the_main_string
+  # ========================================================================= #
+  def parse_the_main_string
+    _ = @input
+    if _.include? N
+      splitted = _.split(N)
+      e
+      opnn { :no_colon }
+      e
+      e
+      e 'There are '+lightgreen(splitted.size.to_s)+' exam '\
+        'results available, thus '+lightgreen(splitted.size.to_s)+
+        ' students participated.'
+      e
+      e 'The available grades are:'
+      @available_grades = splitted.map {|line|
+        line.split(' ').last
+      }
+      @available_grades.each {|this_grade|
+        @hash_storing_results[this_grade] += 1
+      }
+      e
+      report
+      e
+      # ===================================================================== #
+      # Display how many students passed this exam.
+      # ===================================================================== #
+      percentage = (
+        (@n_students_have_positive_grades.to_f * 100) / @available_grades.size
+      ).round(ROUND_TO_N_NUMBERS).to_s.rjust(5)
+      e crimson(@n_students_have_positive_grades.to_s)+
+        ' students passed this exam.'+yellow(
+          '   (Percentage: '+percentage+'%)'
+        )+N+N
+    end
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report
+    # ======================================================================= #
+    # The hash that we obtain here may look like this:
+    #
+    #   {"1"=>2, "3"=>4, "5"=>4, "4"=>8, "2"=>1}
+    #
+    # We have to sort that Hash thus, to display grade 1 first, before
+    # grade 2, before grade 3 and so forth.
+    # ======================================================================= #
+    sorted_results = @hash_storing_results.sort_by {|grade_as_string, n_times_of_this_grade|
+      grade_as_string.to_i
+    }
+    # ======================================================================= #
+    # Now sorted_results may look like this:
+    #
+    #   [["1", 2], ["2", 1], ["3", 4], ["4", 8], ["5", 4]]
+    #
+    # We have to turn this into a Hash again.
+    # ======================================================================= #
+    sorted_results = Hash[*sorted_results.flatten]
+    sorted_results.each_pair {|this_grade, n_students_with_this_grade|
+      result = '  '+royalblue(n_students_with_this_grade.to_s.rjust(2))+' student'
+      if n_students_with_this_grade > 1
+        result << 's have'
+      else
+        result << '  has '
+      end
+      result << ' the grade '+slateblue(this_grade.to_s)+'.'
+      percentage_value = (
+        (n_students_with_this_grade * 100.0) / @available_grades.size
+      ).round(ROUND_TO_N_NUMBERS)
+      result << yellow(
+        ' (Percentage: '+percentage_value.to_s.rjust(5)+'%)'
+      )
+      if this_grade.to_i < 5
+        @n_students_have_positive_grades += n_students_with_this_grade
+      end
+      e result
+    }
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    parse_the_main_string
+  end
+
+  # ========================================================================= #
+  # === Studium::CustomExamResultsParser[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::CustomExamResultsParser.new(ARGV)
+end # custom_exam_results_parser

data/lib/studium/parsers/parse_lva_dates.rb

@@ -0,0 +1,190 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ParseLvaDates
+#
+# This class can be used to sanitize copy/pasted lva-dates e. g. from
+# lectures at the BOKU. We can then paste the sanitized result into
+# the file "lecture_information.yml".
+#
+# Usage example:
+#
+#   Studium::ParseLvaDates.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/parsers/parse_lva_dates.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ParseLvaDates < ::Studium::Base # === Studium::ParseLvaDates
+
+  # ========================================================================= #
+  # === REGEX_INCORRECT_YEAR
+  # ========================================================================= #
+  REGEX_INCORRECT_YEAR = /\d{1,2}\.\d{1,2}\.\d{6}/
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @pad_in_quotes
+    #
+    # If the following instance variable is set to true then we will pad
+    # the dates reported in "", in a format that can be copy/pasted into
+    # the yaml file called "lecture_information.yml".
+    # ======================================================================= #
+    @pad_in_quotes = true
+  end
+
+  # ========================================================================= #
+  # === pad_in_quotes?
+  # ========================================================================= #
+  def pad_in_quotes?
+    @pad_in_quotes
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report
+    commandline_arguments_joined.split(N).each {|line|
+      line.rstrip!
+      line.delete!('()')
+      if line =~ REGEX_INCORRECT_YEAR
+        line.sub!(/(\d{1,2}\.\d{1,2}\.\d{4})(\d{2}.+)$/, '\1, \2')
+      end
+      unless line.include? 'Ort:'
+        if line.include?('MUG1')
+          line.sub!(/MUG1/, '" # Ort: MUG1')
+        elsif line.include?(' Audimax')
+          line.sub!(/ Audimax/, '" # Ort: Audimax')
+        elsif line.include? ' Hörsaal 2 UZA 1'
+          line.sub!(/ Hörsaal 2 UZA 1/, '" # Ort: Hörsaal 2 UZA 1')
+        end
+      end
+      if line =~ /\d{1,2}:\d{4}:\d{1,2}/ # Valid for strings such as "10:1511:45".
+        line.sub!(/(\d{1,2}:\d{2})(\d{2}:\d{1,2})/,'\1-\2')
+      end
+      e line
+    }
+  end
+
+  # ========================================================================= #
+  # === sanitize_input
+  # ========================================================================= #
+  def sanitize_input
+    @input = commandline_arguments_joined.to_s.dup
+    @input.tr!(T ,' ')
+    @input.gsub!(/Abhaltungfix/, '')
+    # ======================================================================= #
+    # Condense ' - ' tokens.
+    # ======================================================================= #
+    if @input.include? ' - '
+      @input.gsub!(/ - /, '-')
+    end
+    if @input.include? '(' # We don't need '(' and ')'.
+      @input.delete!('()')
+    end
+    # ======================================================================= #
+    # Next, check weekday-names:
+    # ======================================================================= #
+    if @input =~ /^Montag \d{1}/
+      @input.gsub!(/^Montag (\d{1})/,   'Montag     \1')
+    end
+    if @input =~ /^Dienstag \d{1}/
+      @input.gsub!(/^Dienstag (\d{1})/, 'Dienstag   \1')
+    end
+    if @input =~ /^Mittwoch \d{1}/
+      @input.gsub!(/^Mittwoch (\d{1})/, 'Mittwoch   \1')
+    end
+    # ======================================================================= #
+    # Donnerstag is excluded because it is already the longest name among
+    # the weekdays.
+    # ======================================================================= #
+    if @input =~ /^Freitag \d{1}/
+      @input.gsub!(/^Freitag (\d{1})/,  'Freitag    \1')
+    end
+    # ======================================================================= #
+    # Expand weekend-names next:
+    # ======================================================================= #
+    @input.gsub!(/^Mo\n/, ' - "Montag     ')
+    @input.gsub!(/^Di\n/, ' - "Dienstag   ')
+    @input.gsub!(/^Mi\n/, ' - "Mittwoch   ')
+    @input.gsub!(/^Do\n/, ' - "Donnerstag ')
+    @input.gsub!(/^Fr\n/, ' - "Freitag    ')
+    check_for_year_entries_on_each_line(@input)
+    if @input.include?(' UZA2') and !@input.include?(' Ort: ')
+      if @pad_in_quotes
+        @input.gsub!(/ UZA2/, '" # Ort: UZA2')
+      else
+        @input.gsub!(/ UZA2/, ' # Ort: UZA2')
+      end
+    end
+    if pad_in_quotes?
+      @input.gsub!(/^/, ' - "')
+    end
+    # ======================================================================= #
+    # Next, sanitize any wrong dates.
+    # ======================================================================= #
+    # use_this_regex = /\d{1,2}\.\d{1,2}\.d{6}/
+    # if @input =~ use_this_regex
+    #   @input.gsub!(
+    #     /^(.+)(\d{1,2}\.\d{1,2}\.)(d{6})(.+)$/,
+    #     '\1\2\3\4'
+    #   )
+    # end
+  end
+
+  # ========================================================================= #
+  # === check_for_year_entries_on_each_line
+  # ========================================================================= #
+  def check_for_year_entries_on_each_line(
+      i = @input
+    )
+    array = i.split(N)
+    array.map! {|line|
+      if !has_year_entry?(line)
+        line = add_proper_year_entry_to_this_line(line)
+      end
+      line
+    }
+    @input = array.join(N)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    sanitize_input
+    report
+  end
+
+  # ========================================================================= #
+  # === Studium::ParseLvaDates[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ParseLvaDates.new(ARGV)
+end # parselvadates

data/lib/studium/pdf/README.md

@@ -0,0 +1,2 @@
+This directory will contain code that can be used to autogenerate
+some .pdf files.

data/lib/studium/pdf/create_pdf_file_for_this_exam_topic.rb

@@ -0,0 +1,277 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::CreatePdfFileForThisExamTopic
+#
+# This class will create a .pdf file of all the exam questions
+# of a given topic.
+#
+# Usage example:
+#
+#   Studium::CreatePdfFileForThisExamTopic.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/pdf/create_pdf_file_for_this_exam_topic.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class CreatePdfFileForThisExamTopic < Studium::Base # === Studium::CreatePdfFileForThisExamTopic
+
+  require 'studium/toplevel_methods/filter_away_invalid_questions.rb'
+  require 'studium/toplevel_methods/return_dataset_for_this_exam_topic.rb'
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === USE_THIS_FONT
+  #
+  # We have to pick an existing font.
+  #
+  # The following Array may be of help if you wish to pick another
+  # font:
+  #
+  #  ["Courier", "Courier-Bold", "Courier-BoldOblique", "Courier-Oblique",
+  #   "Helvetica", "Helvetica-Bold", "Helvetica-BoldOblique", "Helvetica-Oblique",
+  #   "Symbol", "Times-Bold", "Times-BoldItalic", "Times-Italic", "Times-Roman",
+  #   "ZapfDingbats", "Liberation"]
+  #
+  # ========================================================================= #
+  USE_THIS_FONT = 'Courier' # Helvetica-Bold' #  #'Times-Roman'
+
+  # ========================================================================= #
+  # === USE_THIS_FONT_SIZE
+  # ========================================================================= #
+  USE_THIS_FONT_SIZE = 11
+
+  # ========================================================================= #
+  # === Studium::CreatePdfFileForThisExamTopic.the_exam_topic?
+  # ========================================================================= #
+  def self.the_exam_topic?
+    @the_exam_topic
+  end
+
+  # ========================================================================= #
+  # === Studium::CreatePdfFileForThisExamTopic.set_the_exam_topic
+  # ========================================================================= #
+  def self.set_the_exam_topic(i)
+    @the_exam_topic = i
+  end
+
+  # ========================================================================= #
+  # === 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()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+  end
+
+  # ========================================================================= #
+  # === exam_topic?
+  # ========================================================================= #
+  def exam_topic?
+    _ = @commandline_arguments.first
+    _ = find_corresponding_exam_topic(_)
+  end
+
+  # ========================================================================= #
+  # === the_exam_topic?
+  # ========================================================================= #
+  def the_exam_topic?
+    Studium::CreatePdfFileForThisExamTopic.the_exam_topic?
+  end
+
+  # ========================================================================= #
+  # === open_the_pdf_file_after_it_has_been_created
+  #
+  # This will open the .pdf file that was generated, but only on systems
+  # that have is_on_roebe? enabled - aka my home system.
+  # ========================================================================= #
+  def open_the_pdf_file_after_it_has_been_created
+    if File.exist?(@store_the_pdf_file_here) and is_on_roebe?
+      open_this_pdf_file(@store_the_pdf_file_here)
+    end
+  end
+
+  # ========================================================================= #
+  # === open_this_pdf_file
+  # ========================================================================= #
+  def open_this_pdf_file(i)
+    require 'roebe'
+    ::Roebe.open(i)
+  end
+
+  # ========================================================================= #
+  # === consider_uploading_the_pdf_file
+  # ========================================================================= #
+  def consider_uploading_the_pdf_file
+    _ = @store_the_pdf_file_here
+    if is_on_roebe? and File.exist?(_)
+      Studium.upload_pdf(_)
+    end
+  end
+
+  # ========================================================================= #
+  # === do_require_prawn                                  (require prawn tag)
+  # ========================================================================= #
+  def do_require_prawn
+    begin
+      require 'prawn'
+      Prawn::Font::AFM.hide_m17n_warning = true
+    rescue LoadError
+      e 'prawn is not installed. Consider installing it via'
+      e
+      e '  gem install prawn'
+      e
+      exit
+    end
+  end
+
+  # ========================================================================= #
+  # === to_windows_1252_encoding
+  # ========================================================================= #
+  def self.to_windows_1252_encoding(i)
+    i.encode(
+      'Windows-1252', invalid: :replace, undef: :replace, replace: ''
+    )
+  end
+
+  # ========================================================================= #
+  # === to_windows_1252_encoding
+  # ========================================================================= #
+  def to_windows_1252_encoding(i)
+    i.encode(
+      'Windows-1252', invalid: :replace, undef: :replace, replace: ''
+    )
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    Studium::CreatePdfFileForThisExamTopic.set_the_exam_topic(exam_topic?)
+    dataset = return_dataset_for_this_topic(the_exam_topic?)
+    do_require_prawn
+    opnn; e 'The exam topic was: '+sfancy(the_exam_topic?)
+    @store_the_pdf_file_here = log_dir?+the_exam_topic?.to_s+'.pdf'
+    opnn; e 'We will store at:'
+    e
+    e "  #{sfile(@store_the_pdf_file_here)}"
+    e
+    Prawn::Document.generate(@store_the_pdf_file_here) {
+      font USE_THIS_FONT
+      font_size USE_THIS_FONT_SIZE
+      text(
+        Studium::CreatePdfFileForThisExamTopic.to_windows_1252_encoding(
+               'Exam topic: '+
+               ::Studium::CreatePdfFileForThisExamTopic.the_exam_topic?.tr('_',' ').capitalize+
+               N+N
+        )
+      )
+      # ===================================================================== #
+      # Iterate over our exam dataset next.
+      # ===================================================================== #
+      dataset.each {|this_exam_question_answer_line|
+        # =================================================================== #
+        # We will first modify this line a bit - remove trailing " []"
+        # for instance.
+        # =================================================================== #
+        this_exam_question_answer_line = this_exam_question_answer_line.strip
+        if this_exam_question_answer_line.end_with? ' []'
+          this_exam_question_answer_line.sub!(/ \[\]$/,'')
+        end
+        if this_exam_question_answer_line.include?('<ud>') or
+           this_exam_question_answer_line.include?('<u>') or
+           this_exam_question_answer_line.include?('</')
+          this_exam_question_answer_line = ::Studium.remove_tags(this_exam_question_answer_line)
+        end
+        _ = this_exam_question_answer_line
+        # =================================================================== #
+        # Handle URLs first, aka entries that include "http":
+        # =================================================================== #
+        if _.include? 'http'
+          _ =~ /URL: (http.+)/
+          match = $1.to_s.dup
+          text(
+            Studium::CreatePdfFileForThisExamTopic.to_windows_1252_encoding(
+              "<link href='#{match}'>#{match}</link>"
+            ),
+            inline_format: true,
+            style: :bold,
+          )
+        else
+          indent(8) {
+            text(
+              Studium::CreatePdfFileForThisExamTopic.to_windows_1252_encoding(_)
+            )
+          }
+        end
+      }
+    }
+    open_the_pdf_file_after_it_has_been_created
+    consider_uploading_the_pdf_file
+  end
+
+  # ========================================================================= #
+  # === Studium::CreatePdfFileForThisExamTopic[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.upload_pdf
+#
+# This method can be used to quickly upload the main exam-pdf file to
+# my remote website.
+#
+# The first argument to this method should be the (local) .pdf file
+# that you wish to upload
+# =========================================================================== #
+def self.upload_pdf(this_pdf_file)
+  require 'ftp_paradise'
+  opnn; e "Now uploading the file `#{Colours.sfile(this_pdf_file)}`."
+  FtpParadise.upload_this_binary_file(this_pdf_file) { :be_quiet } 
+end
+
+# =========================================================================== #
+# === Studium.create_pdf_file_for_this_exam_topic
+# =========================================================================== #
+def self.create_pdf_file_for_this_exam_topic(i = ARGV)
+  [i].flatten.compact.each {|this_pdf_file|
+    Studium::CreatePdfFileForThisExamTopic.new(this_pdf_file)
+  }
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::CreatePdfFileForThisExamTopic.new(ARGV)
+end # createpdffileforthisexamtopic geo
+    # createpdffileforthisexamtopic pharma
+    # createpdffileforthisexamtopic amg1
+    # createpdffileforthisexamtopic bem1