studium 0.13.1

data/lib/studium/ects/boku_ects_splitter.rb

@@ -0,0 +1,128 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::BokuEctsSplitter
+#
+# The input to this class should be in the form of:
+#
+#   ECTS %Technik %Naturwissenschaften %WiSoRe
+#
+# A specific example follows for commandline usage:
+#
+#   boku_ects_splitter 4.5 10 80 10
+#
+# Usage example:
+#
+#   Studium::BokuEctsSplitter.new
+#
+# =========================================================================== #
+# require 'studium/ects/boku_ects_splitter.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class BokuEctsSplitter < ::Studium::Base # === Studium::BokuEctsSplitter
+
+  begin
+    require 'percentage'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      n_ects                        = ARGV[0],
+      n_percent_technik             = ARGV[1],
+      n_percent_naturwissenschaften = ARGV[2],
+      n_percent_wisore              = ARGV[3],
+      run_already                   = true
+    )
+    reset
+    if n_ects.is_a? Array and n_ects.size > 1
+      # ===================================================================== #
+      # In this case we assume that all the values passed are
+      # found in this variable.
+      # ===================================================================== #
+      n_percent_technik             = n_ects[1]
+      n_percent_naturwissenschaften = n_ects[2]
+      n_percent_wisore              = n_ects[3]
+      n_ects                        = n_ects.first
+    end
+    set_n_ects(n_ects)
+    @technik_percentage = n_percent_technik.to_f
+    @naturwissenschaften_percentage = n_percent_naturwissenschaften.to_f
+    @wisore_percentage = n_percent_wisore.to_f
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+  end
+
+  # ========================================================================= #
+  # === ects_punkte
+  # ========================================================================= #
+  def ects_punkte(i = ' ECTS Punkte')
+    salmon(i)
+  end
+
+  # ========================================================================= #
+  # === set_n_ects
+  # ========================================================================= #
+  def set_n_ects(i)
+    @n_ects = i.to_f # Must be a float because we may also have 4.5 ECTS points.
+  end
+
+  # ========================================================================= #
+  # === n_ects?
+  # ========================================================================= #
+  def n_ects?
+    @n_ects
+  end
+
+  # ========================================================================= #
+  # === report
+  # ========================================================================= #
+  def report
+    opnn; e 'So viele ECTS Punkte erhalten wir jeweils:'
+    ljust = 22
+    format_specifier_to_use = '%.3f'
+    _ = (@n_ects * @technik_percentage) / 100
+    _ = format_specifier_to_use % _
+    e orchid('Technik: '.ljust(ljust))+
+      ects_punkte(_).to_s.rjust(4)+ects_punkte
+    _ = ( (@n_ects * @naturwissenschaften_percentage) / 100)
+    _ = format_specifier_to_use % _
+    e orchid('Naturwissenschaften: '.ljust(ljust))+
+      ects_punkte(_.to_s.rjust(4))+ects_punkte
+    _ = (@n_ects * @wisore_percentage) / 100
+    _ = format_specifier_to_use % _
+    e orchid('WiSoRe: '.ljust(ljust))+
+      ects_punkte((_).to_s.rjust(4))+ects_punkte
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    report
+  end
+
+  # ========================================================================= #
+  # === Studium::BokuEctsSplitter[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::BokuEctsSplitter.new(ARGV)
+end # bokuectssplitter 4.5 10 80 10

data/lib/studium/ects/ects_per_university.rb

@@ -0,0 +1,179 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::EctsPerUniversity
+#
+# This class will tell us how many ECTS we have passed per university.
+#
+# We will only honour entries stored in the file lecture_information.yml,
+# though.
+#
+# Usage example:
+#
+#   Studium::EctsPerUniversity.new
+#
+# =========================================================================== #
+# require 'studium/ects/ects_per_university.rb'
+# Studium::EctsPerUniversity.new(ARGV) { :sort_by_highest_first_and_be_quiet }
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class EctsPerUniversity < ::Studium::Base # === Studium::EctsPerUniversity
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = ARGV,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    # ======================================================================= #
+    # === Handle blocks given
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :sort_by_highest_first
+      # ===================================================================== #
+      when :sort_by_highest_first
+        @sort = :sort_by_highest_first
+      # ===================================================================== #
+      # === :sort_by_highest_first_and_be_quiet
+      # ===================================================================== #
+      when :sort_by_highest_first_and_be_quiet
+        @sort = :sort_by_highest_first
+        set_be_quiet
+      # ===================================================================== #
+      # === :sort_by_highest_first_and_be_quiet_and_no_colours
+      # ===================================================================== #
+      when :sort_by_highest_first_and_be_quiet_and_no_colours
+        @sort = :sort_by_highest_first
+        set_be_quiet
+        disable_colours
+      end
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = return_solved_lectures # Obtain only solved lectures.
+    # ======================================================================= #
+    # === @sort
+    #
+    # If the following variable is NOT nil then we will sort in a certain
+    # way.
+    # ======================================================================= #
+    @sort = nil
+    # ======================================================================= #
+    # === @hash_n_ects_per_university
+    # ======================================================================= #
+    @hash_n_ects_per_university = {}
+    @hash_n_ects_per_university.default = 0
+  end
+
+  # ========================================================================= #
+  # === main_hash?
+  # ========================================================================= #
+  def main_hash?
+    @hash_n_ects_per_university
+  end
+
+  # ========================================================================= #
+  # === determine_ects_per_university
+  # ========================================================================= #
+  def determine_ects_per_university
+    @dataset.each {|name_of_the_lecture, inner_hash|
+      n_ects_points   = obtain(:n_ects_points, inner_hash)
+      this_university = obtain(:this_university, inner_hash)
+      @hash_n_ects_per_university[this_university] += n_ects_points
+    }
+  end
+
+  # ========================================================================= #
+  # === spacer
+  # ========================================================================= #
+  def spacer(
+      n_times = 32
+    )
+    cyan('-' * n_times)+N
+  end
+
+  # ========================================================================= #
+  # === return_total_amount_of_ects_points
+  # ========================================================================= #
+  def return_total_amount_of_ects_points
+    main_hash?.values.sum
+  end
+
+  # ========================================================================= #
+  # === generate_the_main_string
+  # ========================================================================= #
+  def generate_the_main_string
+    # ======================================================================= #
+    # We will build up onto the main string; this is the string that will
+    # be shown on the commandline as well.
+    # ======================================================================= #
+    @main_string = "\n".dup
+    case @sort
+    when :sort_by_highest_first
+      _ = @hash_n_ects_per_university.sort_by {|key, n_ECTS_points| n_ECTS_points }.reverse
+      @hash_n_ects_per_university = Hash[*_.flatten]
+    end
+    @hash_n_ects_per_university.each {|this_university, n_ects_points|
+      @main_string << '  '+royalblue((this_university+':').ljust(12))+' '+
+                      lightblue(n_ects_points.to_s.rjust(5)+' ECTS points')+N
+    }
+    @main_string << spacer
+    @main_string << royalblue('  Total:       ')+steelblue(
+                      return_total_amount_of_ects_points.to_s+' ECTS points'
+                    )+N+N
+  end
+
+  # ========================================================================= #
+  # === main_string?
+  # ========================================================================= #
+  def main_string?
+    @main_string
+  end; alias result? main_string? # === result?
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report
+    e @main_string if be_verbose?
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    determine_ects_per_university
+    generate_the_main_string
+    report
+  end
+
+  # ========================================================================= #
+  # === Studium::EctsPerUniversity[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::EctsPerUniversity.new(ARGV) { :sort_by_highest_first }
+end # ectsperuniversity

data/lib/studium/ects/ects_scanner.rb

@@ -0,0 +1,141 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::EctsScanner
+#
+# This class can scan a text for ECTS points, and then output some
+# statistics about that. It will make use of a Regex to determine
+# which parts are ECTS numbers.
+#
+# Usage example:
+#
+#   Studium::EctsScanner.new
+#
+# =========================================================================== #
+# require 'studium/ects/ects_scanner.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class EctsScanner < ::Studium::Base # === Studium::EctsScanner
+
+  # ========================================================================= #
+  # === USE_THIS_REGEX_TO_EXTRACT_THE_ECTS_VALUES
+  #
+  # This is the regex that is to be used in order to extract the values
+  # for the various ECTS points.
+  #
+  # See here for this regex: http://rubular.com/r/AVGbHGmngU
+  # ========================================================================= #
+  USE_THIS_REGEX_TO_EXTRACT_THE_ECTS_VALUES = /(\d{1,2}\.\d{1}\s*ECTS)/
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = nil # Initialize it here.
+  end
+
+  # ========================================================================= #
+  # === regex_to_use?
+  # ========================================================================= #
+  def regex_to_use?
+    USE_THIS_REGEX_TO_EXTRACT_THE_ECTS_VALUES
+  end; alias regex? regex_to_use? # === regex?
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    if i.is_a? Array # The input should be a String, not an Array.
+      i = i.join(' ').strip
+    end
+    case i
+    when 'file1'
+      i = Studium.studium_directory_at_home+'UNI_WIEN/Individuelles_Studium_an_der_Uni_Wien/'\
+          'Erklärungsschreiben_mit_geordneten_Unterpunkten/'\
+          '014_Lehrveranstaltungen_im_individuellen_Master_Curriculum_erklärt.md'
+    end unless File.exist?(i)
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === check_whether_the_input_is_a_file_then_read_it_in
+  # ========================================================================= #
+  def check_whether_the_input_is_a_file_then_read_it_in
+    if File.exist? @input
+      @dataset = file_read_with_proper_encoding(@input)
+    end
+  end
+
+  # ========================================================================= #
+  # === try_to_perform_a_regex_check
+  #
+  # Only do so if @dataset has been assigned.
+  # ========================================================================= #
+  def try_to_perform_a_regex_check
+    if @dataset
+      scanned_results = @dataset.scan(regex?).flatten
+      scanned_results.map! {|line|
+        line.sub(/ECTS/,'').strip.to_f
+      }
+      @dataset = scanned_results
+      calculate_and_report_the_sum
+    end
+  end
+
+  # ========================================================================= #
+  # === calculate_and_report_the_sum
+  # ========================================================================= #
+  def calculate_and_report_the_sum
+    sum = @dataset.sum
+    e 'We could find '+royalblue(sum.to_s)+
+      ' ECTS points and '+lightgreen(@dataset.size.to_s)+
+      ' entries.'
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    check_whether_the_input_is_a_file_then_read_it_in
+    try_to_perform_a_regex_check
+  end
+
+  # ========================================================================= #
+  # === Studium::EctsScanner[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::EctsScanner.new(ARGV)
+end # ectsscanner file1

data/lib/studium/ects/ects_to_university_parser.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::EctsToUniversityParser
+#
+# This class can work through a file, calculate the respective ECTS
+# points for a given university, and then report how many ECTS are
+# part of this or that university.
+#
+# In order for this to work, the information about as to which
+# university some ECTS points belong to, has to be hardcoded
+# in that file.
+#
+# Usage example:
+#
+#   Studium::EctsToUniversityParser.new
+#
+# =========================================================================== #
+# require 'studium/etcs/ects_to_university_parser.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class EctsToUniversityParser < Base # === Studium::EctsToUniversityParser
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    @hash_storing_all_attributed_ects_points = {}
+    @hash_storing_all_attributed_ects_points.default = 0 # By default 0.
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = i.first if i.is_a? Array
+    if i.nil?
+      opnn; e 'Please provide a valid, '+slateblue('existing file')+
+              ' as input to this class.'
+      exit
+    end
+    i = i.to_s.dup
+    case i
+    # ========================================================================= #
+    # === ects_to_university_parser 1
+    # ========================================================================= #
+    when '1'
+      i = FILE_MASTER_VEKTORX
+    end
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === parse_lectures
+  # ========================================================================= #
+  def parse_lectures
+    _ = readlines_from_this_input_file(@input).reject {|line|
+      line.strip!
+      line.empty? or line.start_with?('#')
+    }
+    opnn; e 'There are '+sfancy(_.size)+' lectures in the dataset from'
+    opnn; e '  '+sfile(input?)
+    e
+    opnn; e 'These entries will all be parsed next.'
+    use_this_regex = /# (\d{0,2}\.?\d{0,2}) ECTS, ([A-Z_]{2,12}),/ # See: http://rubular.com/r/WjaVlKz7iy
+    _.each {|line|
+      # ===================================================================== #
+      # A line may look like this:
+      #  "- Gentechnik und Industrielle Genomik   # 3.0 ECTS, TU_WIEN, Priorität: 3, VO"
+      # For the purpose of this file here, we are only interested in the
+      # ECTS points, and the university. The regex defined above will take
+      # care of this.
+      # ===================================================================== #
+      line =~ use_this_regex
+      n_ects_point    = $1.to_s.to_f
+      this_university = $2.to_s.dup
+      @hash_storing_all_attributed_ects_points[this_university] += n_ects_point
+    }
+    e
+    opnn; e 'We have found the following universities involved in this curriculum:'
+    e
+    hash = @hash_storing_all_attributed_ects_points
+    # ======================================================================= #
+    # Next sort the Hash by n ECTS points.
+    # ======================================================================= #
+    hash = hash.sort_by {|key, n_ects_points|
+      n_ects_points
+    }.reverse
+    hash = Hash[*hash.flatten]
+    hash.each_pair {|university, n_ects_points|
+      e '  '+sfancy(university.to_s.ljust(10))+
+        ' → '+
+        simp(n_ects_points.to_s+' ECTS points')
+    }; e
+    opnn; e 'The total amount of ECTS points in this curriculum is: '+
+             simp(@hash_storing_all_attributed_ects_points.values.sum.to_s)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    parse_lectures
+  end
+
+  # ========================================================================= #
+  # === Studium::EctsToUniversityParser[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::EctsToUniversityParser.new(ARGV)
+end # ectstouniversityparser 1