studium 0.13.1

data/lib/studium/utility_scripts/show_lectures/misc.rb

@@ -0,0 +1,584 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/utility_scripts/show_lectures/misc.rb'
+# =========================================================================== #
+require 'studium/utility_scripts/show_lectures/help.rb'
+
+module Studium
+
+class ShowLectures < Base # === Studium::ShowLectures
+
+  # ========================================================================= #
+  # === parse_and_set_commandline
+  # ========================================================================= #
+  def parse_and_set_commandline(i = '')
+    if i.is_a?(String) and i.include?('--')
+      i = i.split('--').map {|line| "--#{line}" }.reject {|entry| entry == '--' }
+    end
+    unless i.is_a? Array # We want an Array.
+      i = [i]
+    end
+    use_this_theme = nil
+    # ======================================================================= #
+    # Sanitize the given input.
+    # ======================================================================= #
+    i.map! {|line|
+      line = line.to_s.dup
+      unless line.include? '--'
+        use_this_theme = line
+      end
+      line.delete!('-') # <- We don't need any '-' characters.
+      # ===================================================================== #
+      # The next line checks that C++ as a theme is valid still.
+      # ===================================================================== #
+      line.downcase! unless line.include? '+'
+      line = Studium.sanitize_this_theme_topic(line) # <- Correct the theme topic here.
+      line
+    }
+   use_this_theme = i.shift if use_this_theme.nil?
+    set_input_theme(use_this_theme) # First entry is the input_theme for now.
+    set_commandline_arguments(i)
+  end
+
+  # ========================================================================= #
+  # === set_input_theme
+  #
+  # Do some sanitizing of the theme here.
+  # ========================================================================= #
+  def set_input_theme(i)
+    case i # case tag
+    when 'bioprozesstechnik'
+      i = 'bioprocess engineering'
+    when 'immuno','immunologie'
+      i = 'immunology'
+    end
+    @input_theme = i
+  end
+
+  # ========================================================================= #
+  # === input_theme?
+  # ========================================================================= #
+  def input_theme?
+    @input_theme
+  end; alias searching_for_this_theme? input_theme? # === searching_for_this_theme?
+       alias theme?                    input_theme? # === theme?
+       alias which_theme?              input_theme? # === which_theme?
+
+  # ========================================================================= #
+  # === load_dataset_from_the_file_lecture_information
+  # ========================================================================= #
+  def load_dataset_from_the_file_lecture_information
+    @dataset_from_file_lecture_information = 
+      return_sanitized_dataset_from_the_file_lecture_information
+  end
+
+  # ========================================================================= #
+  # === do_show_only_unsolved_lectures
+  # ========================================================================= #
+  def do_show_only_unsolved_lectures
+    @show_these_lectures = :show_only_unsolved_lectures
+  end
+
+  # ========================================================================= #
+  # === main_dataset?
+  # ========================================================================= #
+  def main_dataset?
+    @selection
+  end
+
+  # ========================================================================= #
+  # === consider_showing_the_timetable
+  #
+  # To invoke this do, for example, the following:
+  #   timmuno --timetable
+  # ========================================================================= #
+  def consider_showing_the_timetable(
+      do_show_all_courses_belonging_to_this_theme = true
+    )
+    if @show_timetable
+      _ = Studium::ShowLecturesOnTheCommandline.new(:do_not_run_yet)
+      _.set_title('Theme: '+theme?.capitalize)
+      _.do_not_show_loaded_from_which_file
+      if do_show_all_courses_belonging_to_this_theme
+        # =================================================================== #
+        # In this case, we will show ALL of these courses.
+        # =================================================================== #
+        use_this_selection = @selection.keys
+      else
+        # =================================================================== #
+        # In that case, we will show only the courses that are yet
+        # to be passed.
+        # =================================================================== #
+        use_this_selection = @selection.select {|key, value|
+          value[:already_solved] == false
+        }.keys
+      end
+      _.set_all_lectures(use_this_selection)
+      _.do_generate_a_html_file
+    end
+  end
+
+  # ========================================================================= #
+  # === n_ects_were_successfully_passed_in_total?
+  # ========================================================================= #
+  def n_ects_were_successfully_passed_in_total? 
+    @n_ects_were_successfully_passed_in_total
+  end; alias n_ects_were_passed_in_this_curriculum n_ects_were_successfully_passed_in_total? # === n_ects_were_passed_in_this_curriculum
+
+  # ========================================================================= #
+  # === do_show_only_solved_lectures
+  # ========================================================================= #
+  def do_show_only_solved_lectures
+    @show_these_lectures = :only_solved_lectures
+  end
+
+  # ========================================================================= #
+  # === add_total_amount_of_ects_points_in_the_selected_lectures
+  # ========================================================================= #
+  def add_total_amount_of_ects_points_in_the_selected_lectures
+    # ======================================================================= #
+    # Next, also calculate how many ECTS point in total have been
+    # registered in the file 'lecture_information.yml' fitting to
+    # that particular topic at hand.
+    # ======================================================================= #
+    @result << "In total there are "\
+               "#{sfancy(@n_ects_in_total_of_the_selected_lectures)} ECTS "\
+               "points available in the "\
+               "#{slateblue(@n_lectures_are_registered)} lectures "\
+               "shown above.#{N}"
+  end
+
+  # ========================================================================= #
+  # === considering_showing_how_many_ects_points_were_successfully_passed_in_total
+  #
+  # This method will simply show how many ECTS points were passed fitting
+  # to the given theme at hand.
+  # ========================================================================= #
+  def considering_showing_how_many_ects_points_were_successfully_passed_in_total
+    if @n_ects_were_successfully_passed_in_total > 0
+      # ===================================================================== #
+      # The following .rjust() is only done to align it with the total
+      # amount of ECTS points displayed afterwards.
+      # ===================================================================== #
+      @result = "Passed a total of "\
+                "#{sfancy(@n_ects_were_successfully_passed_in_total.to_s.rjust(@n_ects_in_total_of_the_selected_lectures.to_s.size + 1))}"\
+                " ECTS points, in #{royalblue(@n_lectures_were_successfully_passed_in_total)} "\
+                "different courses, fitting "\
+                "to the theme\n".dup
+      @result << "`#{slategray(which_theme?)}`".dup
+      # ===================================================================== #
+      # Also calculate and add the average grade.
+      # ===================================================================== #
+      average_grade_is = (
+        @array_grades.sum / @array_grades.size
+      ).round(2)
+      @result << mediumslateblue(' (Average grade: ')+
+                 forestgreen(average_grade_is.to_s)+
+                 mediumslateblue(')')
+      @result << ".#{N}"
+    end
+  end
+
+  # ========================================================================= #
+  # === obtain_all_lectures_that_belong_to_the_given_theme_at_hand
+  #
+  # This is the method that will select all the lectures that fit to the
+  # target theme at hand.
+  # ========================================================================= #
+  def obtain_all_lectures_that_belong_to_the_given_theme_at_hand
+    _ = @dataset_from_file_lecture_information
+    # ======================================================================= #
+    # Determine the theme we are looking for next.
+    # ======================================================================= #
+    we_seek_this_theme = searching_for_this_theme?
+    we_seek_this_theme = we_seek_this_theme.first if we_seek_this_theme.is_a? Array
+    # ======================================================================= #
+    # Next handle only-unsolved lectures, and only-solved lectures.
+    # ======================================================================= #
+    case @show_these_lectures
+    # ======================================================================= #
+    # === :show_only_solved_lectures
+    # ======================================================================= #
+    when :show_only_solved_lectures,
+         :only_solved_lectures
+      # ===================================================================== #
+      # Weed out lectures we have not already solved yet.
+      # ===================================================================== #
+      _.select! {|name_of_the_lecture, hash_containing_lots_of_data|
+        already_solved = hash_containing_lots_of_data[:already_solved]
+        (already_solved == true)
+      }
+    # ======================================================================= #
+    # === :show_only_unsolved_lectures
+    # ======================================================================= #
+    when :show_only_unsolved_lectures,
+         :only_unsolved_lectures
+      # ===================================================================== #
+      # Weed out lectures we have not already solved yet.
+      # ===================================================================== #
+      _.select! {|name_of_the_lecture, hash_containing_lots_of_data|
+        already_solved = hash_containing_lots_of_data[:already_solved]
+        !already_solved
+      }
+    # else # else we will simply pass through.
+    end
+    # ======================================================================= #
+    # First, remove entries that are outdated, aka having the symbol
+    # :outdated_lecture set to true, UNLESS they were already solved.
+    # ======================================================================= #
+   selection = _.reject {|a, b|
+      b.has_key?(:outdated_lecture) and
+      (b[:outdated_lecture] == true) and
+      (b[:outdated_lecture] == true) and
+      !(b[:already_solved] == true)
+    }
+    @selection = selection.select {|name_of_the_lecture, hash_containing_lots_of_data|
+      # ===================================================================== #
+      # We must use .compact because some entries may contain
+      # a stray [nil] value.
+      # ===================================================================== #
+      if hash_containing_lots_of_data.has_key? 'themes'
+        themes = hash_containing_lots_of_data['themes'].compact
+        if themes.nil? or themes.empty?
+          opnn; e swarn('Warning:')+' the lecture '+sfancy(name_of_the_lecture)+
+                  ' has no logical "themes:" entry.'
+        end
+      end
+      # ===================================================================== #
+      # Map over the themes here next:
+      # ===================================================================== #
+      if themes
+        mapped_themes = themes.map {|inner_line|
+          if inner_line.nil?
+            e 'Nil value - something is wrong.'
+            e
+            e 'Showing themes next:'
+            e
+            pp themes
+            e
+            e 'Next showing @selection:'
+            e
+            @selection
+          end
+          inner_line.delete(' ')
+        }
+        if mapped_themes.include? we_seek_this_theme.to_s.delete('_ ')
+          name_of_the_lecture
+        end
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === show_this_hash_split_into_bachelor_and_master_lectures
+  # ========================================================================= #
+  def show_this_hash_split_into_bachelor_and_master_lectures(i)
+    # ======================================================================= #
+    # We must first create the hashes that hold e. g. bachelor and
+    # master lectures..
+    # ======================================================================= #
+    hash_holding_all_bachelor_lectures         = {}
+    hash_holding_all_master_lectures           = {}
+    hash_holding_all_non_unattributed_lectures = {}
+    i.each_pair {|name_of_the_lecture, inner_hash|
+      curricula = inner_hash['curricula']
+      if curricula.any? {|curriculum_number|
+          curriculum_number.start_with? '033' # In this case it is a Bachelor lecture.
+        }
+        hash_holding_all_bachelor_lectures[name_of_the_lecture] = inner_hash
+      elsif curricula.any? {|curriculum_number|
+          curriculum_number.start_with? '066' # In this case it is a Master lecture.
+        }
+        hash_holding_all_master_lectures[name_of_the_lecture] = inner_hash
+      else # else these are curricula that are not attributed at all.
+        hash_holding_all_non_unattributed_lectures[name_of_the_lecture] = inner_hash
+      end
+    }
+    case @show_what
+    # ======================================================================= #
+    # === :bachelor
+    # ======================================================================= #
+    when :bachelor
+      verbose_show_these_bachelor_lectures(hash_holding_all_bachelor_lectures)
+    # ======================================================================= #
+    # === :master
+    # ======================================================================= #
+    when :master
+      verbose_show_these_master_lectures(hash_holding_all_master_lectures)
+    # ======================================================================= #
+    # === :bachelor_and_master
+    # ======================================================================= #
+    when :bachelor_and_master
+      verbose_show_these_bachelor_lectures(hash_holding_all_bachelor_lectures)
+      verbose_show_these_master_lectures(hash_holding_all_master_lectures)
+    # ======================================================================= #
+    # === :bachelor_and_master_and_unattributed_lectures
+    # ======================================================================= #
+    when :bachelor_and_master_and_unattributed_lectures
+      verbose_show_these_bachelor_lectures(hash_holding_all_bachelor_lectures)
+      verbose_show_these_master_lectures(hash_holding_all_master_lectures)
+      verbose_show_these_unattributed_lectures(hash_holding_all_non_unattributed_lectures)
+    end
+  end
+
+  # ========================================================================= #
+  # === verbose_show_these_unattributed_lectures
+  # ========================================================================= #
+  def verbose_show_these_unattributed_lectures(i)
+    unless i.empty?
+      opnn; e "Next showing all #{khaki('unattributed-lectures')}:"
+      show_hash(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === verbose_show_these_master_lectures
+  # ========================================================================= #
+  def verbose_show_these_master_lectures(i)
+    opnn; e "Next showing all #{khaki('master-lectures')}:"
+    show_hash(i)
+  end
+
+  # ========================================================================= #
+  # === report_the_result_on_the_commandline
+  # ========================================================================= #
+  def report_the_result_on_the_commandline
+    e @result unless @result.empty?
+  end
+
+  # ========================================================================= #
+  # === notify_the_user_these_lectures_were_found_to_fit_to_the_theme_header
+  # ========================================================================= #
+  def notify_the_user_these_lectures_were_found_to_fit_to_the_theme_header
+    e; opnn; e 'These lectures were found to fit to the input-theme `'+
+                sfancy(input_theme?)+'`:'; e
+  end
+
+  # ========================================================================= #
+  # === show_this_hash
+  #
+  # The first argument to this method should be a Hash. This Hash will
+  # then be properly formatted and displayed.
+  #
+  # The second argument to this method is a controller - it can control
+  # whether we want to split up the display into, for example, Bachelor
+  # and Master-lectures. That is, lectures that are attributed to the
+  # corresponding bachelor or master curriculum. This allows us to
+  # group lectures to specific curricula.
+  # ========================================================================= #
+  def show_this_hash(
+      hash                                                   = @selection,
+      optional_argument_controlling_what_we_will_report_here = nil
+    )
+    case hash
+    when :default
+      hash = @selection
+    end
+    if hash.empty?
+      opnn; e 'No result was found for the given input-theme '+
+              '`'+sfancy(input_theme?.to_s)+'`'
+    else # else the Hash is NOT empty.
+      @n_lectures_are_registered = hash.keys.size
+      shall_we_make_use_of_unicode_symbols = Studium.shall_we_make_use_of_unicode_symbols?
+      if optional_argument_controlling_what_we_will_report_here
+        case optional_argument_controlling_what_we_will_report_here
+        when :split_into_bachelor_and_master_lectures
+          show_this_hash_split_into_bachelor_and_master_lectures(hash)
+        end
+      else # This clause is the default, actually.
+        hash.reject! {|name_of_the_lecture, inner_hash|
+          if @show_only_courses_at_this_university
+            this_university = inner_hash[:university].to_s.downcase.delete(' ')
+            !this_university.start_with?(@show_only_courses_at_this_university.to_s.downcase)
+          else
+            false
+          end
+        }
+        unless hash.empty?
+          notify_the_user_these_lectures_were_found_to_fit_to_the_theme_header
+        end
+        index = 0
+        hash.each_pair {|name_of_the_lecture, inner_hash| index += 1
+          splitted = name_of_the_lecture.split(' ')
+          lva_id = splitted.first
+          real_name = splitted[1..-1].join(' ')
+          n_ects_points = inner_hash[:ects].to_f
+          if inner_hash.has_key? :semester
+            which_semester = inner_hash[:semester]
+          else
+            # e 'No :semester entry for '+sfancy(name_of_the_lecture)+
+            #   '. Consider adding this information.'
+            which_semester = ''
+          end
+          # ================================================================= #
+          # Keep track of how many ECTS the selected lectures have.
+          # ================================================================= #
+          @n_ects_in_total_of_the_selected_lectures += n_ects_points
+          array_curricula = inner_hash['curricula']
+          lecture_type    = inner_hash[:type]
+          already_solved  = inner_hash[:already_solved]
+          if already_solved
+            # =============================================================== #
+            # This exam was already passed, so we add some useful
+            # information about it.
+            # =============================================================== #
+            passed_this_exam_on = inner_hash[:already_solved_at]
+            @n_lectures_were_successfully_passed_in_total += 1
+            @n_ects_were_successfully_passed_in_total += n_ects_points
+            @array_grades << inner_hash[:grade].to_f
+          else
+            passed_this_exam_on = nil
+          end
+          # ================================================================= #
+          # We also have to show the University.
+          # ================================================================= #
+          at_this_university = inner_hash[:university]
+          if array_curricula.nil?
+            opnn; e "The lecture #{sfancy(name_of_the_lecture)} has "\
+                    "no curricula-entry associated."
+            opnn; e 'The associated Hash will also be shown next.'
+            pp inner_hash
+          end
+          if passed_this_exam_on.nil? or (passed_this_exam_on == false)
+            colourized_index = orange(
+              ("(#{index.to_s})").rjust(4).ljust(5)
+            )
+          else
+            # =============================================================== #
+            # === colourized_index
+            #
+            # else we have already passed this exam, so use the colour tan()
+            # instead.
+            # =============================================================== #
+            colourized_index = tan(
+              ("(#{index.to_s})").rjust(4).ljust(5)
+            )
+          end
+          # ================================================================= #
+          # Determine in which semester the lecture will be held:
+          # ================================================================= #
+          case which_semester
+          when 'winter'
+            which_semester = 'WS'
+          when 'summer'
+            which_semester = 'SS'
+          when 'both'
+            which_semester = 'WS/SS'
+          end
+          # ================================================================= #
+          # Next, display some information about this lecture.
+          # ================================================================= #
+          result = "#{colourized_index} ".dup
+          if already_solved
+            result << darkolivegreen(name_of_the_lecture)
+          else
+            result << olivedrab(name_of_the_lecture)
+          end
+          result << ' '+plum('(n ECTS: '+n_ects_points.to_s+'; ')+
+                    forestgreen(lecture_type).dup
+          unless which_semester.empty?
+            result << "; #{orange(which_semester)}"
+          end
+          # ================================================================= #
+          # Add information about the university next:
+          # ================================================================= #
+          result << plum(')')+ # Add the lecture type here
+                    peru(' (Universität: ')+
+                    springgreen(at_this_university)+
+                    peru(')')
+          # ================================================================= #
+          # Finally, report our findings to the user.
+          # ================================================================= #
+          e result
+          # ================================================================= #
+          # Finally, check whether the lecture has already been completed.
+          # If so then display some red-box at the bottom.
+          # ================================================================= #
+          if already_solved.nil? or (already_solved == false)
+            # =============================================================== #
+            # In this case we'll check a module-method.
+            # =============================================================== #
+            already_solved = Studium.already_solved_this_lva_number?(lva_id, real_name)
+          end
+          if already_solved
+            # =============================================================== #
+            # This means that the lecture has been completed successfully.
+            #
+            # Now we have to determine the date at which this exam has
+            # been passed successfully. We can query this either from the
+            # file lecture_information, or from the .csv file.
+            # =============================================================== #
+            if passed_this_exam_on.nil? or (passed_this_exam_on == false)
+              passed_this_exam_on = Studium.passed_this_exam_on(name_of_the_lecture)
+            end
+            if passed_this_exam_on.nil? or (passed_this_exam_on == false) # <- In this case some error has occurred.
+              opnn; e swarn('An error occurred for the lecture called ')+
+                      sfancy(name_of_the_lecture)
+              opnn; e "#{swarn('It failed in the method ')}"\
+                      "#{sfancy('Studium.passed_this_exam_on(name_of_the_lecture)')}"
+              opnn; e swarn('Please correct this error. Different reasons can be')
+              opnn; e swarn('as to why this has failed. One may be trailing space')
+              opnn; e swarn('characters in the .csv that keeps your passed exams.')
+            else
+              # ============================================================= #
+              # Show that this lecture has been passed successfully:
+              # ============================================================= #
+              completed_successfully_msg = (' ' * 6).dup
+              # ============================================================= #
+              # The next line will show a unicode-symbol, a check box.
+              # This requires that the user is using e. g. UTF-8.
+              # ============================================================= #
+              if shall_we_make_use_of_unicode_symbols and
+                 Object.const_defined?(:Roebe) and
+                 Roebe.respond_to?(:to_unicode)
+                completed_successfully_msg << swarn(Roebe.to_unicode(:thick))
+              end
+              completed_successfully_msg << lightblue(' ☺ ')+ # Add a smiley here.
+                                            swarn('  ^^^ COMPLETED SUCCESSFULLY ON THE ')+
+                                            coral(passed_this_exam_on.to_s)+swarn(' ^^^')
+              e completed_successfully_msg # Display it here.
+            end
+          end
+          # ================================================================= #
+          # Next, since as of 21.07.2022, we will show the remote URL, UNLESS
+          # we have already passed this course.
+          # ================================================================= #
+          unless already_solved
+            e "      #{royalblue('→')}  rf \"#{royalblue(Studium.url_for?(name_of_the_lecture))}\""
+          end
+          # ================================================================= #
+          # Next show the curricula associated with this lecture.
+          # ================================================================= #
+          array_curricula.each {|this_curriculum|
+            name_of_the_curriculum = Studium.return_name_of_this_curriculum(this_curriculum)
+            # =============================================================== #
+            # Display the association with the corresponding curriculum next.
+            # =============================================================== #
+            e (' ' * 6)+'   '+
+              mediumaquamarine(this_curriculum.ljust(6))+
+              royalblue(' # ')+
+              slateblue(name_of_the_curriculum)
+          }
+        }; e
+      end
+    end
+  end; alias show_hash show_this_hash # === show_hash
+
+  # ========================================================================= #
+  # === verbose_show_these_bachelor_lectures
+  # ========================================================================= #
+  def verbose_show_these_bachelor_lectures(i)
+    opnn; e "First showing all #{khaki('bachelor-lectures')}:"
+    show_hash(i)
+  end
+
+  # ========================================================================= #
+  # === Studium::ShowLectures[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end

data/lib/studium/utility_scripts/show_lectures/reset.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/utility_scripts/show_lectures/reset.rb'
+# =========================================================================== #
+module Studium
+
+class ShowLectures < Base
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @n_lectures_are_registered
+    # ======================================================================= #
+    @n_lectures_are_registered = 0
+    # ======================================================================= #
+    # === @result
+    # ======================================================================= #
+    @result = ''.dup
+    # ======================================================================= #
+    # === @show_timetable
+    # ======================================================================= #
+    @show_timetable = false
+    # ======================================================================= #
+    # === @selection
+    # ======================================================================= #
+    @selection = nil
+    # ======================================================================= #
+    # === @dataset_from_file_lecture_information
+    # ======================================================================= #
+    @dataset_from_file_lecture_information = nil
+    # ======================================================================= #
+    # === @n_lectures_were_successfully_passed_in_total
+    #
+    # Keep track how many lectures were successfully passed:
+    # ======================================================================= #
+    @n_lectures_were_successfully_passed_in_total = 0
+    # ======================================================================= #
+    # === @n_ects_in_total_of_the_selected_lectures
+    # ======================================================================= #
+    @n_ects_in_total_of_the_selected_lectures = 0
+    # ======================================================================= #
+    # === @n_ects_were_successfully_passed_in_total
+    # ======================================================================= #
+    @n_ects_were_successfully_passed_in_total = 0
+    # ======================================================================= #
+    # === @show_only_courses_at_this_university
+    #
+    # This variable can be used to show only courses at a particular
+    # university. If nil then no restriction will occur.
+    # ======================================================================= #
+    @show_only_courses_at_this_university = nil
+    # ======================================================================= #
+    # === @array_grades
+    # ======================================================================= #
+    @array_grades = []
+    # ======================================================================= #
+    # === @show_these_lectures
+    #
+    # The following instance variable can have these three states:
+    #
+    #   :all
+    #   :show_only_solved_lectures
+    #   :show_only_unsolved_lectures
+    #
+    # The default is :all, which means that both solved and unsolved
+    # lectures will be shown.
+    # ======================================================================= #
+    @show_these_lectures = :all
+    # ======================================================================= #
+    # === @show_what
+    #
+    # The following variable can have one of these four states:
+    #
+    #   :bachelor
+    #   :master, or
+    #   :bachelor_and_master, or
+    #   :bachelor_and_master_and_unattributed_lectures
+    #
+    # ======================================================================= #
+    @show_what = :bachelor_and_master_and_unattributed_lectures # :bachelor_and_master
+  end
+
+end; end