studium 0.16.9

data/lib/studium/curricula/show_lectures_of_this_curriculum_id/show_lectures_of_this_curriculum_id.rb

@@ -0,0 +1,554 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::ShowLecturesOfThisCurriculumId
+#
+# This class will output all lectures associated with a specific
+# curriculum. The input to this class may be either the specific
+# curriculum-id or the name of the curriculum at hand; the latter
+# must allow for some flexibility, logically.
+#
+# If the commandline flag --that-were-passed is passed then
+# this class will only show lectures that were successfully
+# passed, in a time-sorted manner.
+#
+# Usage example:
+#
+#   Studium::ShowLecturesOfThisCurriculumId.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/curricula/show_lectures_of_this_curriculum_id/show_lectures_of_this_curriculum_id.rb'
+# Studium::ShowLecturesOfThisCurriculumId.new(ARGV)
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ShowLecturesOfThisCurriculumId < Base # === Studium::ShowLecturesOfThisCurriculumId
+
+  # ========================================================================= #
+  # === 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()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @dataset_all_lectures
+    # ======================================================================= #
+    @dataset_all_lectures = return_all_lectures
+    _ = Studium.file_curricula
+    if File.exist? _
+      @all_curricula = YAML.load_file(_)
+    end
+    # ======================================================================= #
+    # === @total_ects
+    # ======================================================================= #
+    @total_ects = 0
+    # ======================================================================= #
+    # === @already_solved_n_ects_of_these
+    # ======================================================================= #
+    @already_solved_n_ects_of_these = 0
+    # ======================================================================= #
+    # === @show_remote_url
+    #
+    # If this variable is set to true then the remote URL will also be
+    # shown on the commandline.
+    # ======================================================================= #
+    @show_remote_url = true
+    # ======================================================================= #
+    # === @n_solved_lectures
+    # ======================================================================= #
+    @n_solved_lectures = 0
+    # ======================================================================= #
+    # === @filter_away_outdated_lectures
+    # ======================================================================= #
+    @filter_away_outdated_lectures = true
+    # ======================================================================= #
+    # === @hash_curricula_entries_to_curricula_id
+    #
+    # Next create an inverted hash that holds, as its keys, the names of
+    # the curricula-entries; and as values, the associated Curricula-id.
+    # ======================================================================= #
+    @hash_curricula_entries_to_curricula_id = {}
+    @all_curricula.each_pair {|key, value|
+      @hash_curricula_entries_to_curricula_id[value] = key
+    }
+    # ======================================================================= #
+    # === @show_the_date_when_the_lecture_was_solved
+    # ======================================================================= #
+    @show_the_date_when_the_lecture_was_solved = false
+    # ======================================================================= #
+    # === :shall_we_show_the_solved_lectures
+    # ======================================================================= #
+    @internal_hash[:shall_we_show_the_solved_lectures] = true
+    # ======================================================================= #
+    # === :curriculum_name
+    # ======================================================================= #
+    @internal_hash[:curriculum_name] = nil
+  end
+
+  # ========================================================================= #
+  # === do_only_show_unfinished_courses
+  # ========================================================================= #
+  def do_only_show_unfinished_courses
+    @internal_hash[:shall_we_show_the_solved_lectures] = false
+  end
+
+  # ========================================================================= #
+  # === shall_we_show_the_solved_lectures?
+  # ========================================================================= #
+  def shall_we_show_the_solved_lectures?
+    @internal_hash[:shall_we_show_the_solved_lectures]
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i
+      # ===================================================================== #
+      # === show_lectures_of_this_curriculum_id 033630 --that-were-passed
+      #
+      # This entry point can be used to apply a filter, selecting only 
+      # lectures that have been passed.
+      # ===================================================================== #
+      when /^-?-?that(-|_)?were(-|_)?passed$/i
+        select_only_the_lectures_that_were_passed_already
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === determine_curriculum_id
+  #
+  # This method will base everything on the first argument.
+  # ========================================================================= #
+  def determine_curriculum_id
+    _ = first_argument?
+    # ======================================================================= #
+    # Next, the given input may have to be sanitized a little bit.
+    # ======================================================================= #
+    if _.is_a?(String) and !(_ =~ /\d+/) # And if it does not have any number.
+      full_name = ::Studium.map_partial_input_to_full_curriculum_name(_) # => "Mastercurriculum Biotechnology"
+      @internal_hash[:curriculum_name] = full_name
+      if full_name.nil?
+        opne tomato('No entry found for ')+
+             steelblue(_)
+      end
+      # ===================================================================== #
+      # Next, translate from this name to the id at hand.
+      # ===================================================================== #
+      _ = Studium.map_curriculum_name_to_curriculum_number(full_name)
+    end
+    if _.is_a?(String) and _ =~ /^\d{3}$/ # Begins with 3 numbers - and has only 3 numbers.
+      _ = _.dup if _.frozen?
+      # ===================================================================== #
+      # It could be a Bachelor-Curriculum or a Master-Curriculum. We need
+      # some heuristic next to guess which one it'll be. Thus, first
+      # obtain an Array with all registered numbers:
+      # ===================================================================== #
+      if File.exist? Studium.file_curricula
+        dataset = YAML.load_file(Studium.file_curricula)
+        array = dataset.keys
+        possible_selection = array.select {|line|
+          line.end_with?(_)
+        }
+        if possible_selection and !possible_selection.empty?
+          _ = possible_selection.first # Simply grab the first entry here. May have to be adapted one day. 
+        end
+      end
+      if _.is_a?(String) and _ =~ /^\d{3}$/ # Still begins with 3 numbers. Assume Mastercurriculum in this event.
+        _ = _.dup if _.frozen?
+        _.prepend('066')
+      end
+    end
+    @curriculum_id = _
+    # ======================================================================= #
+    # Also remove this from the commandline-arguments.
+    # ======================================================================= #
+    commandline_arguments?.shift
+    sanitize_curriculum_id
+  end
+
+  # ========================================================================= #
+  # === curriculum_id?
+  # ========================================================================= #
+  def curriculum_id?
+    @curriculum_id
+  end; alias main_input?  curriculum_id? # === main_input?
+       alias search_term? curriculum_id? # === search_term?
+
+  # ========================================================================= #
+  # === determine_lectures_fitting_to_the_curriculum_id
+  #
+  # We will select lectures that have a fitting curriculum-id entry.
+  # ========================================================================= #
+  def determine_lectures_fitting_to_the_curriculum_id
+    @dataset = @dataset_all_lectures.select {|a, b|
+      array = obtain(:curriculum_id, b)
+      array.include? main_input?
+    }
+  end
+
+  # ========================================================================= #
+  # === translate_curriculum_id_into_name_of_the_curriculum
+  #
+  # This method can be used to map from the curriculum-id towards the
+  # name of the particular curriculum at hand.
+  # ========================================================================= #
+  def translate_curriculum_id_into_name_of_the_curriculum(id)
+    translated = @all_curricula[id]
+    if translated.is_a? Array
+      translated = translated.first
+    end
+    translated
+  end
+
+  # ========================================================================= #
+  # === sanitize_curriculum_id                                 (sanitize tag)
+  #
+  # We can input a String such as "Bioinformatik", which must be replaced
+  # with the proper curriculum id. Some curricula may lead to ambiguity,
+  # such as "Biologie", which could be both for the regular Biologie
+  # curriculum but also for "Biologie UF" or "Diplom Biologie".
+  #
+  # This has to be kept in mind in the following code.
+  # ========================================================================= #
+  def sanitize_curriculum_id
+    _ = @curriculum_id
+    unless _ =~ /\d+/
+      # ===================================================================== #
+      # Do some ad-hoc sanitizing next - these will be extended on a 
+      # case-by-case basis:
+      # ===================================================================== #
+      case _ # case tag
+      # ===================================================================== #
+      # === Master LMBT
+      # ===================================================================== #
+      when ':master_immuno',
+           /master(_|-)?immuno/i
+        set_curriculum_id '066830'
+      # ===================================================================== #
+      # === Master LMBT
+      # ===================================================================== #
+      when 'Master LMBT',
+           /master(_|-)?biotech/i
+        set_curriculum_id '066418'
+        return
+      # ===================================================================== #
+      # === MolBio
+      # ===================================================================== #
+      when 'MolBio'
+        _ = 'Molekulare Biologie'
+      # ===================================================================== #
+      # === Immuno
+      # ===================================================================== #
+      when 'Immuno',
+           'Immunobio'
+        _ = 'Immunbiologie'
+      end
+      all_keys = @hash_curricula_entries_to_curricula_id.keys
+      if all_keys.any? {|entry|
+          if entry
+            entry.first.downcase.include? _.downcase
+          end
+         }
+        # ===================================================================== #
+        # In this case we know that it is included.
+        # ===================================================================== #
+        selection = @hash_curricula_entries_to_curricula_id.select {|name_of_the_curriculum, this_university, remote_url, curriculum_id|
+          name_of_the_curriculum.downcase.include?(_.downcase) and
+         !name_of_the_curriculum.include?('Diplomstudium') # <- We ignore Diplomstudium.
+        }
+        set_curriculum_id(selection.values, :be_verbose)
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === set_curriculum_id
+  # ========================================================================= #
+  def set_curriculum_id(
+      i, be_verbose = :be_quiet
+    )
+    # ======================================================================= #
+    # If an Array is given to this method, then this method will always
+    # pick the first element of said Array.
+    # ======================================================================= #
+    i = i.first if i.is_a? Array
+    @curriculum_id = i
+    case be_verbose
+    when :be_verbose
+      opne "We will use the Curriculum ID #{sfancy(@curriculum_id)}."
+    end
+  end
+
+  # ========================================================================= #
+  # === select_only_the_lectures_that_were_passed_already
+  # ========================================================================= #
+  def select_only_the_lectures_that_were_passed_already
+    @dataset.select! {|name_of_the_lecture, inner_dataset|
+      already_solved = inner_dataset[:already_solved]
+      already_solved and (already_solved == true)
+    }
+    @show_the_date_when_the_lecture_was_solved = true
+    # ======================================================================= #
+    # We have to sort the @dataset too, by the date.
+    # ======================================================================= #
+    _ = @dataset.sort_by {|name_of_the_lecture, inner_dataset|
+       Time.parse(
+         inner_dataset[:already_solved_at]
+       )
+    }
+    @dataset = Hash[_]
+  end
+
+  # ========================================================================= #
+  # === report_title_of_this_curriculum_id
+  # ========================================================================= #
+  def report_title_of_this_curriculum_id(
+      i = main_input?
+    )
+    i = i.to_s
+    if @all_curricula.has_key? i
+      translated = @all_curricula[i]
+      name_of_the_curriculum = ''.dup
+      if translated.is_a? Array
+        this_university = translated[1] # It is no longer the last entry.
+        name_of_the_curriculum << translated[0]
+      end
+      e
+      e "#{rev}Reporting lectures belonging to the curriculum"
+      e slateblue(name_of_the_curriculum)+
+        ' (University: '+
+        orchid(this_university.to_s)+
+        '; Curriculum ID: '+orchid(i)+') next:'
+    else
+      e "#{rev}No entry found for #{royalblue(i)}."
+    end
+  end
+
+  # ========================================================================= #
+  # === consider_filtering_away_outdated_lectures                (filter tag)
+  # ========================================================================= #
+  def consider_filtering_away_outdated_lectures
+    if @filter_away_outdated_lectures
+      @dataset.reject! {|name_of_the_lecture, hash|
+        hash.has_key?(:outdated_lecture) and (hash[:outdated_lecture] == true)
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === report                                                   (report tag)
+  # ========================================================================= #
+  def report(
+      i = @dataset
+    )
+    if i.empty?
+      opne 'No matching entries found for '+sfancy(main_input?)+'.'
+      report_available_curricula_names
+    else
+      report_title_of_this_curriculum_id(main_input?)
+      e
+      solved_lectures = i.select {|name_of_the_lecture, inner_hash|
+        inner_hash.has_key?(:already_solved) and
+        (inner_hash[:already_solved] == true)
+      }
+      # ===================================================================== #
+      # Remove the lectures that were already passed, as they will be
+      # reported separately.
+      # ===================================================================== #
+      i = i.reject {|name_of_the_lecture, inner_hash|
+        inner_hash.has_key?(:already_solved) and
+          (inner_hash[:already_solved] == true)
+      }
+      # ===================================================================== #
+      # === Show the solved lectures next
+      #
+      # Show all solved lectures next, if there is at the least one that
+      # has been solved already.
+      # ===================================================================== #
+      if shall_we_show_the_solved_lectures?
+        unless solved_lectures.empty?
+          n_ECTS = 0
+          solved_lectures.each {|name_of_the_lecture, inner_hash|
+            n_ECTS += inner_hash[:ects]
+          }
+          e "The following #{sfancy(solved_lectures.size.to_s)}"\
+            " lectures (#{orchid(n_ECTS)} ECTS in total) "\
+            "were #{steelblue('already solved')}:"
+          e
+          index  = 0
+          n_ECTS = 0
+          solved_lectures.each {|name_of_the_lecture, inner_hash| index += 1
+            n_ECTS += inner_hash[:ects]
+            report_this_particular_lecture(name_of_the_lecture, inner_hash, index)
+          }
+          e ' '.rjust(65)+
+            ' The above ^^^ includes '+royalblue(n_ECTS.to_s+' ECTS')+
+            ' that were already solved.'
+          e
+        end
+      end
+      # ===================================================================== #
+      # Next, iterate over our main data-structure and report the
+      # remaining lectures..
+      # ===================================================================== #
+      if i and !i.empty?
+        total_ECTS_in_the_unsolved_lectures = i.map {|a, b| b[:ects] }.sum
+        e "The following #{steelblue(i.size.to_s)}"\
+          " lectures have not yet been passed, for a "\
+          "total of"
+        e "#{steelblue(total_ECTS_in_the_unsolved_lectures)} ECTS "\
+          "points to be attainable.\n\n"
+        i.each {|name_of_the_lecture, inner_hash|
+          report_this_particular_lecture(name_of_the_lecture, inner_hash)
+        }
+      end
+      e
+      e 'The curriculum id we are searching for '\
+        'is `'+mediumaquamarine(search_term?)+'` ('+
+        mediumseagreen(
+          translate_curriculum_id_into_name_of_the_curriculum(search_term?)
+        )+').'
+      e 'The above '+slateblue(i.size.to_s)+' lectures amount to a '\
+        'total of '+orange(@total_ects.to_s)+' ECTS points.'
+      if (@already_solved_n_ects_of_these > 0) and shall_we_show_the_solved_lectures?
+        e 'Of these, '+orange(@already_solved_n_ects_of_these.to_s)+
+          ' ECTS points '+
+            steelblue(
+              '('+((@already_solved_n_ects_of_these.to_f * 100) / @total_ects).round(2).to_s+'%)'
+            )+' in '+palevioletred(@n_solved_lectures.to_s)+
+          ' lectures were already solved.'
+      end
+      e
+    end
+  end
+
+  # ========================================================================= #
+  # === report_available_curricula_names
+  # ========================================================================= #
+  def report_available_curricula_names
+    e 'The available curricula names, for Bachelor and '\
+      'Master studies only, are these:'
+    _ = @all_curricula.sort_by {|a, array| array.first }
+    _.each {|a, array|
+      first = array.first
+      if first.include? 'Bachelor' or first.include? 'Master'
+        e "  #{slateblue(first)}" unless first.include? 'Lehramt' # I don't care about Lehramt.
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === report_this_particular_lecture
+  # ========================================================================= #
+  def report_this_particular_lecture(
+      name_of_the_lecture,
+      inner_hash,
+      optional_index = nil
+    )
+    if name_of_the_lecture.frozen?
+      name_of_the_lecture = name_of_the_lecture.dup
+    end
+    name_of_the_lecture.squeeze! ' '
+    padded_name_of_the_lecture = name_of_the_lecture.dup
+    padded_name_of_the_lecture = padded_name_of_the_lecture.ljust(82)
+    n_ects_points = obtain(:n_ects, inner_hash)
+    @total_ects += n_ects_points
+    # ======================================================================= #
+    # The remote_url will always be collected; whether it will
+    # be displayed is a separate consideration.
+    # ======================================================================= #
+    remote_url = return_the_remote_homepage_url(name_of_the_lecture.strip, inner_hash)
+    remote_url = remote_url.first if remote_url.is_a? Array
+    already_solved = obtain(:already_solved, inner_hash)
+    result = '  '.dup
+    if optional_index
+      result << seagreen(optional_index.to_s.rjust(2)+') ')
+    end
+    if already_solved
+      @n_solved_lectures += 1
+      @already_solved_n_ects_of_these += n_ects_points
+      result << steelblue(padded_name_of_the_lecture)
+    else
+      result << mediumslateblue(padded_name_of_the_lecture)
+    end
+    # ======================================================================= #
+    # Must format the n_ects_points past here:
+    # ======================================================================= #
+    n_ects_points = "[#{n_ects_points.to_s.rjust(4)}]"
+    result = result.dup if result.frozen?
+    result << royalblue(n_ects_points)+' '
+    if @show_the_date_when_the_lecture_was_solved
+      already_solved_at = inner_hash[:already_solved_at]
+      result << '(solved at: '+
+                 goldenrod(already_solved_at.to_s)+
+                 ') '
+    end
+    if @show_remote_url
+      result << lightgreen(remote_url.to_s)
+    end
+    e result
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    determine_curriculum_id
+    determine_lectures_fitting_to_the_curriculum_id
+    consider_filtering_away_outdated_lectures
+    menu
+    report(
+      @dataset
+    )
+  end
+
+  # ========================================================================= #
+  # === curriculum_name?
+  # ========================================================================= #
+  def curriculum_name?
+    @internal_hash[:curriculum_name]
+  end
+
+  # ========================================================================= #
+  # === Studium::ShowLecturesOfThisCurriculumId[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ShowLecturesOfThisCurriculumId.new(ARGV)
+end # showlecturesofthiscurriculumid 066875
+    # showlecturesofthiscurriculumid 033630 --that-were-passed
+    # showlecturesofthiscurriculumid MolBio
+    # showlecturesofthiscurriculumid Landschaftsplanung
+    # showlecturesofthiscurriculumid Biologie
+    # showlecturesofthiscurriculumid mvek
+    # showlecturesofthiscurriculumid Bioinformatik
+    # showlecturesofthiscurriculumid mbiotech

data/lib/studium/curricula/show_solved_percentage_among_the_registered_curricula.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === ShowSolvedPercentageAmongTheRegisteredCurricula
+#
+# This class will simply show how many % of the ECTS were solved in
+# the different registered curricula.
+#
+# Usage example:
+#
+#   ShowSolvedPercentageAmongTheRegisteredCurricula.new
+#
+# =========================================================================== #
+# require 'studium/show_solved_percentage_among_the_registered_curricula.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class ShowSolvedPercentageAmongTheRegisteredCurricula < Base # === Studium::ShowSolvedPercentageAmongTheRegisteredCurricula
+
+  require 'studium/curricula/n_percent_solved_in_this_curriculum.rb'
+
+  # ========================================================================= #
+  # === 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()
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    e "#{rev}Displaying all registered Curricula next and "\
+      "the total percentage of"
+    e "#{rev}associated solved lectures:"
+    e
+    return_all_registered_curricula.each {|this_curriculum|
+      padded_name_of_this_curriculum = this_curriculum.to_s.tr('_',' ').ljust(40)
+      # if padded_name_of_this_curriculum.include? ' '
+      #   index = padded_name_of_this_curriculum.index(' ')+1
+      #   padded_name_of_this_curriculum[index, 1] =
+      #     padded_name_of_this_curriculum[index,1].upcase
+      # end
+      colourized_and_padded_name_of_this_curriculum = steelblue(
+        padded_name_of_this_curriculum
+      )
+      e '  '+
+        colourized_and_padded_name_of_this_curriculum+
+        mediumseagreen(
+          Studium.n_percent_solved_in_this_curriculum(this_curriculum).to_s.rjust(5)
+        )+
+        mediumseagreen(
+          '%'
+        )
+    }
+    e
+  end
+
+  # ========================================================================= #
+  # === ShowSolvedPercentageAmongTheRegisteredCurricula[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ShowSolvedPercentageAmongTheRegisteredCurricula.new(ARGV)
+end # showsolvedpercentageamongtheregisteredcurricula