studium 0.10.1

data/lib/studium/utility_scripts/priority.rb

@@ -0,0 +1,126 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Priority
+#
+# This class can output lectures fitting to a specific (input) priority,
+# such as "show me all lectures that have a priority of 1".
+#
+# Usage example:
+#
+#   Studium::Priority.new
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/priority.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class Priority < ::Studium::Base # === Studium::Priority
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      search_for_this_priority = nil,
+      run_already              = true
+    )
+    reset
+    set_search_for_this_priority(
+      search_for_this_priority
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = return_dataset_from_the_file_lecture_information
+  end
+
+  # ========================================================================= #
+  # === set_search_for_this_priority
+  # ========================================================================= #
+  def set_search_for_this_priority(i = '')
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup.to_i
+    if i > 6
+      e 'Please use a priority-value below 7.'
+      exit
+    end
+    @search_for_this_priority = i
+  end
+
+  # ========================================================================= #
+  # === search_for_this_priority?
+  # ========================================================================= #
+  def search_for_this_priority?
+    @search_for_this_priority
+  end; alias search_for_this_priority search_for_this_priority? # === search_for_this_priority
+
+  # ========================================================================= #
+  # === select_entries_matching_to_this_priority
+  # ========================================================================= #
+  def select_entries_matching_to_this_priority(
+      priority_to_use = @search_for_this_priority
+    )
+    @dataset.select! {|key, hash|
+      priority = hash[:priority]
+      priority_to_use == priority
+    }
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report(
+      i = @dataset
+    )
+    if i
+      e
+      e 'The following lectures have a priority of 1:'
+      counter = 0
+      e
+      i.each_pair {|name_of_the_lecture, inner_dataset| counter += 1
+        n_ects = inner_dataset[:ects]
+        colourized_n_ects = seagreen(
+          ' (ECTS: '+n_ects.to_s+')'
+        )
+        colourized_counter = royalblue(
+          (counter.to_s+')').rjust(4)
+        )
+        e '  '+
+          colourized_counter+' '+
+          orange(name_of_the_lecture)+
+          colourized_n_ects
+      }; e
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    select_entries_matching_to_this_priority
+    report
+  end
+
+  # ========================================================================= #
+  # === Studium::Priority[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Priority.new(ARGV)
+end # priority 1

data/lib/studium/utility_scripts/priority_points.rb

@@ -0,0 +1,263 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::PriorityPoints
+#
+# This class will allow us to do some priority-rankings on very important
+# lectures. The idea here is to rank the importance of certain lectures.
+#
+# Usage example:
+#
+#   Studium::PriorityPoints.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/priority_points.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class PriorityPoints < ::Studium::Base # === Studium::PriorityPoints
+
+  require 'studium/toplevel_methods/report_attributed_lectures_to_universities.rb'
+
+  # ========================================================================= #
+  # === 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 = return_dataset_from_the_file_lecture_information
+    # ======================================================================= #
+    # === @show_ects_points
+    #
+    # If true we will show the associated ECTS points.
+    # ======================================================================= #
+    @show_ects_points = true
+    # ======================================================================= #
+    # === @n_ects_points
+    # ======================================================================= #
+    @n_ects_points = 0
+    @n_ects_points_as_mandatory_lecture = 0
+    # ======================================================================= #
+    # === @hash_ects_points_attributed_to_the_different_universities
+    # ======================================================================= #
+    @hash_ects_points_attributed_to_the_different_universities = {}
+    @hash_ects_points_attributed_to_the_different_universities.default = 0
+    @hash_attribute_ects_points_to_the_lectures_in_different_curricula = {}
+    @hash_attribute_ects_points_to_the_lectures_in_different_curricula.default = 0
+    # ======================================================================= #
+    # === @show_only_unsolved_lectures
+    #
+    # If the next instance variable is true, then we will only show those
+    # lectures that have not yet been passed successfully.
+    # ======================================================================= #
+    @show_only_unsolved_lectures = false
+  end
+
+  # ========================================================================= #
+  # === do_show_only_unsolved_lectures
+  # ========================================================================= #
+  def do_show_only_unsolved_lectures
+    @show_only_unsolved_lectures = true
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = [i].flatten # At this point we have an Array.
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    menu
+    display_all_ranked_lectures
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = @input
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i
+      # ===================================================================== #
+      # === ppriority --help
+      # ===================================================================== #
+      when /help/
+        show_help
+      # ===================================================================== #
+      # === ppriority --show-only-unsolved-lectures
+      # ===================================================================== #
+      when /^-?-?show(-|_)?only(-|_)?unsolved(-|_)?lectures$/
+        do_show_only_unsolved_lectures
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  # ========================================================================= #
+  def show_help
+    e
+    e '  ppriority --show-only-unsolved-lectures # show only lectures '\
+      'that were not yet completed successfully'
+    e
+  end
+
+  # ========================================================================= #
+  # === display_all_ranked_lectures
+  #
+  # This method will simply output all lectures that have specific
+  # priority points assigned.
+  # ========================================================================= #
+  def display_all_ranked_lectures
+    _ = @dataset.select {|a,b|
+      b.has_key?(:priority_points)
+    }.sort_by {|a,b|
+      b[:priority_points]
+    }.reverse
+    if _
+      counter = 0
+      e
+      # ===================================================================== #
+      # Next, honour the variable @show_only_unsolved_lectures if it is
+      # set to true.
+      # ===================================================================== #
+      if @show_only_unsolved_lectures
+        _.reject! {|a, inner_hash|
+          (inner_hash[:already_solved] == true)
+        }
+      end
+      # ===================================================================== #
+      # Iterate over the dataset:
+      # ===================================================================== #
+      _.each {|a, inner_hash| counter += 1
+        lecture_type = inner_hash[:type]
+        already_solved_or_not = inner_hash[:already_solved]
+        this_university = inner_hash[:university]
+        curricula = inner_hash['curricula']
+        index = (counter.to_s+') ').rjust(4)
+        result = royalblue(index)+seagreen(a)
+        if inner_hash.has_key? :priority_points
+          priority_points = inner_hash[:priority_points]
+        end
+        if @show_ects_points
+          n_ects_points = inner_hash[:ects]
+          curricula.each {|this_curriculum|
+            @hash_attribute_ects_points_to_the_lectures_in_different_curricula[this_curriculum] += n_ects_points
+          }
+          @n_ects_points += n_ects_points
+          @hash_ects_points_attributed_to_the_different_universities[this_university] += n_ects_points
+          if is_prüfungsimmanent? lecture_type
+            @n_ects_points_as_mandatory_lecture += n_ects_points
+          end
+          result = result.ljust(145)
+          result << ' '+colourize_ects_points(
+            n_ects_points.to_s.rjust(4)+' ECTS points'
+          )
+        end
+        # =================================================================== #
+        # Add the priority score next:
+        # =================================================================== #
+        result << crimson(
+          ' '+priority_points.to_s.rjust(4)+' priority score'
+        )
+        # =================================================================== #
+        # Already solved or not:
+        # =================================================================== #
+        if already_solved_or_not == true
+          result << lightgreen(' Already solved')
+        end
+        # =================================================================== #
+        # Next, output out findings.
+        # =================================================================== #
+        e result
+      }; e
+      if @show_ects_points
+        result = colourize_ects_points(@n_ects_points.to_s)+
+                 ' ECTS points in the ^^^ above lectures'
+        result << ' ('+
+                  colourize_ects_points(@n_ects_points_as_mandatory_lecture.to_s)+
+                  ' ECTS are "prüfungsimmanent")'
+        e result
+      end
+    end
+    e # Add a newline as spacer.
+    Studium.report_attributed_lectures_to_universities(
+      @hash_ects_points_attributed_to_the_different_universities
+    )
+    display_ects_points_in_different_curricula
+  end
+
+  # ========================================================================= #
+  # === display_ects_points_in_different_curricula
+  # ========================================================================= #
+  def display_ects_points_in_different_curricula
+    _ = @hash_attribute_ects_points_to_the_lectures_in_different_curricula
+    sorted = _.sort_by {|a, n_ects_points|
+      n_ects_points
+    }.reverse
+    e
+    e 'These lectures are attributed to the following curricula:'
+    e
+    sorted.each {|curriculum_number, n_ects_points|
+      curriculum_name = return_curriculum_name_of_this_curriculum_number(curriculum_number)
+      unless curriculum_name.include? 'Lehramt' # Ignore Lehramt-Curricula.
+        e '  '+
+          royalblue((curriculum_name).ljust(81))+
+          ' '+
+          slateblue(n_ects_points.to_s.rjust(4)+' ECTS points')
+      end
+    }
+    e
+  end
+
+  # ========================================================================= #
+  # === colourize_for_ects
+  # ========================================================================= #
+  def colourize_for_ects(i)
+    springgreen(i)
+  end; alias colourize_ects_points colourize_for_ects # === colourize_ects_points
+
+  # ========================================================================= #
+  # === Studium::PriorityPoints[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::PriorityPoints.new(ARGV)
+end # prioritypoints

data/lib/studium/utility_scripts/publish_my_exams.rb

@@ -0,0 +1,174 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Exams::PublishMyExams
+#
+# This class will publish all my exams to various remote sites,
+# so that these are available for other people to have a
+# look-at, and so forth.
+#
+# Usage example:
+#
+#   Studium::Exams::PublishMyExams.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/utility_scripts/publish_my_exams.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Exams
+
+class PublishMyExams < ::Studium::Base # === Studium::PublishMyExams
+
+  begin
+    require 'ftp_paradise'
+  rescue LoadError; end # Possibly not everyone needs ftp_paradise.
+
+  # ========================================================================= #
+  # === PublishMyExams::ZEUGNISSE
+  # ========================================================================= #
+  ZEUGNISSE = "#{REMOTE_PERSONAL_WEBSITE_URL}ZEUGNISSE/"
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+  end
+
+  # ========================================================================= #
+  # === PublishMyExams.run
+  # ========================================================================= #
+  def self.run
+    Studium::PublishMyExams[]
+  end
+
+  # ========================================================================= #
+  # === establish_ftp_connection
+  # ========================================================================= #
+  def establish_ftp_connection
+    @_ = FtpParadise.connect to: :shevy
+    @_.set_mode :binary # Now in binary mode.
+    @_.cd 'ZEUGNISSE' # Enter the ZEUGNISSE/ directory.
+  end
+
+  # ========================================================================= #
+  # === upload_the_specified_files
+  # ========================================================================= #
+  def upload_the_specified_files
+    @_.upload @upload_these_files
+  end
+
+  # ========================================================================= #
+  # === set_upload_these_files
+  # ========================================================================= #
+  def set_upload_these_files(*i)
+    i = [i] unless i.is_a? Array
+    i.flatten!
+    @upload_these_files = i
+  end
+
+  # ========================================================================= #
+  # === show_finished_message
+  # ========================================================================= #
+  def show_finished_message
+    e 'All finished.'
+  end
+
+  # ========================================================================= #
+  # === consider_applying_a_filter
+  #
+  # This filter will only allow entries that match to the given input at
+  # hand.
+  # ========================================================================= #
+  def consider_applying_a_filter(
+      input = commandline_arguments?
+    )
+    unless input.empty?
+      # ===================================================================== #
+      # Ok in this case, we will apply the input and select.
+      # ===================================================================== #
+      _ = @upload_these_files
+      _.select! {|entry|
+        entry.include? input.first unless input.first.start_with?('-') # Exception for -- instructions and so forth.
+      } if input # Only select some if a filter is passed.
+      set_upload_these_files(@upload_these_files)
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    # ======================================================================= #
+    # Establish the FTP connection next.
+    # ======================================================================= #
+    establish_ftp_connection
+    # ======================================================================= #
+    # Next we can define our BOKU Dokumente.
+    # ======================================================================= #
+    boku_dokumente = Dir["#{EXAMS_RESULT}BOKU_WIEN/*.pdf"]
+    # ======================================================================= #
+    # Next the TU Zeugnisse.
+    # ======================================================================= #
+    tu_dokumente = Dir[EXAMS_RESULT+'TU_WIEN/*']
+    # ======================================================================= #
+    # Next the UniWien Sammelzeugnis.
+    # ======================================================================= #
+    uniwien_dokumente = Dir[EXAMS_RESULT+'UNI_WIEN/*']
+    # ======================================================================= #
+    # Next we upload the MedUni Dokumente.
+    # ======================================================================= #
+    meduni = Dir[EXAMS_RESULT+'MEDUNI_WIEN/MeduniWien_Sammelzeugnis*.pdf']
+    # ======================================================================= #
+    # Finally, the exam results.
+    # ======================================================================= #
+    exam_results = EXAMS_RESULT+'AAA_EXAM_RESULTS.pdf'
+    set_upload_these_files(
+      boku_dokumente, tu_dokumente, uniwien_dokumente, meduni,exam_results
+    )
+    consider_applying_a_filter
+    # ======================================================================= #
+    # Now we can batch-upload these documents.
+    # ======================================================================= #
+    upload_the_specified_files
+    show_finished_message
+  end
+
+  # ========================================================================= #
+  # === PublishMyExams[]
+  # ========================================================================= #
+  def self.[](optional_argument = '')
+    PublishMyExams.new
+  end
+
+end; end
+
+# =========================================================================== #
+# === Studium.publish_my_exams
+# =========================================================================== #
+def self.publish_my_exams
+  Studium::Exams::PublishMyExams.new
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Exams::PublishMyExams.new(ARGV)
+end # pexam
+    # pexam Sammel