studium 0.10.1

data/lib/studium/ects/search_for_n_ects.rb

@@ -0,0 +1,540 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::SearchFor_nECTS
+#
+# This class will simply output which lectures have exactly n ECTS points,
+# such as "1.5".
+#
+# It will first show it for lectures that were completed successfully,
+# if applicable; and if not, the class here will search for other lectures
+# stored in the file "lecture_information". It will NOT report duplicate
+# entries, but it will in general show if a lecture is in bachelor
+# or master - but also bachelor AND master.
+#
+# Usage example from within Ruby code:
+#
+#   Studium::SearchFor_nECTS.new
+#
+# Usage example from the commandline:
+#
+#   nects 2.0 --prüfungsimmanent
+#
+# =========================================================================== #
+# require 'studium/ects/search_for_n_ects.rb'
+# Studium::SearchFor_nECTS[1.5]
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class SearchFor_nECTS < Base # === Studium::SearchFor_nECTS
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = 'SearchFor_nECTS'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    i = set_commandline_arguments_and_return_leftover(i)
+    set_select_for_n_ects_points(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @commandline_arguments
+    # ======================================================================= #
+    @commandline_arguments = []
+    # ======================================================================= #
+    # === @original_dataset
+    # ======================================================================= #
+    @original_dataset = Studium.dataset_from_file_lecture_information
+    # ======================================================================= #
+    # === @index_counter
+    # ======================================================================= #
+    @index_counter = 0 # ← Is valid for the whole class.
+    # ======================================================================= #
+    # === @have_we_found_any_lecture_that_fits
+    # ======================================================================= #
+    @have_we_found_any_lecture_that_fits = false
+    # ======================================================================= #
+    # === @apply_this_filter
+    # ======================================================================= #
+    @apply_this_filter = nil
+    # ======================================================================= #
+    # === @show_numbers
+    #
+    # If this variable is set to true then the leading LVA ID numbers
+    # will be shown as well on the commandline. This is especially
+    # useful if the user has to copy/paste these numbers to other
+    # programs.
+    #
+    # Since as of 31.01.2020 the default is to set this to true.
+    # ======================================================================= #
+    @show_numbers = true
+  end
+
+  # ========================================================================= #
+  # === set_select_for_n_ects_points
+  # ========================================================================= #
+  def set_select_for_n_ects_points(i = '')
+    i = [i] unless i.is_a? Array
+    i = i.first.to_s.to_f
+    @select_for_n_ects_points = i
+  end
+
+  # ========================================================================= #
+  # === set_commandline_arguments_and_return_leftover
+  # ========================================================================= #
+  def set_commandline_arguments_and_return_leftover(i)
+    if i.any? {|entry|
+        entry.to_s.start_with? '--'
+      }
+      selection = i.select {|inner_entry|
+        inner_entry.to_s.start_with? '--'
+      }
+      append_to_the_commandline(selection)
+      i.reject! {|unwanted_entries| unwanted_entries.to_s.start_with? '--' } 
+    end if i.respond_to? :any?
+    i
+  end
+
+  # ========================================================================= #
+  # === append_to_the_commandline
+  # ========================================================================= #
+  def append_to_the_commandline(i)
+    @commandline_arguments << i
+    @commandline_arguments.flatten!
+  end
+
+  # ========================================================================= #
+  # === dataset?
+  # ========================================================================= #
+  def original_dataset?
+    @original_dataset
+  end
+
+  # ========================================================================= #
+  # === current_dataset?
+  #
+  # This is the dataset we are working with.
+  # ========================================================================= #
+  def current_dataset?
+    @current_dataset
+  end
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  # ========================================================================= #
+  def show_help
+    e
+    e '  --only-bachelor      # show only bachelor-lectures'
+    e '  --only-master        # show only master-lectures'
+    e '  --prüfungsimmanent?  # show only "prüfungsimmanente" '\
+      'lectures (== mandatoy presence courses)'
+    e '  --show-numbers       # If this flag is used then the '\
+      'leading LVA ID numbers are shown as well.'
+    e
+  end
+
+  # ========================================================================= #
+  # === menu                                                      (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = @commandline_arguments
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === --show-numbers
+      # ===================================================================== #
+      when /^-?-?show(-|_)?numbers$/i,
+           /^-?-?numbers$/i
+        @show_numbers = true
+      # ===================================================================== #
+      # === --only-master
+      # ===================================================================== #
+      when /^-?-?only(-|_)?master$/,
+           /^-?-?master$/
+        @apply_this_filter = :only_master_lectures
+      # ===================================================================== #
+      # === nects 2.0 --prüfungsimmanent?
+      # ===================================================================== #
+      when /^-?-?prüfungsimmanent\??/i,
+           /^-?-?mandatory\??/i
+        # =================================================================== #
+        # Do another selection on the main dataset next:
+        # =================================================================== #
+        @current_dataset.select! {|name_of_the_lecture, inner_dataset|
+          type = inner_dataset[:type]
+          is_prüfungsimmanent? type
+        }
+      # ===================================================================== #
+      # === --only-bachelor
+      # ===================================================================== #
+      when /^-?-?only(-|_)?bachelor$/,
+           /^-?-?bachelor$/
+        @apply_this_filter = :only_bachelor_lectures
+      # ===================================================================== #
+      # === help
+      # ===================================================================== #
+      when /help/
+        show_help
+        exit
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === select_for_n_ects_points?
+  # ========================================================================= #
+  def select_for_n_ects_points?
+    @select_for_n_ects_points
+  end; alias seeking_n_ects_points? select_for_n_ects_points? # === seeking_n_ects_points?
+       alias n_ects_points?         select_for_n_ects_points? # === n_ects_points?
+
+  # ========================================================================= #
+  # === try_to_report_those_entries_first_that_were_already_passed
+  # ========================================================================= #
+  def try_to_report_those_entries_first_that_were_already_passed
+    _ = @current_dataset.select {|name, inner_hash|
+      inner_hash[:already_solved]
+    }
+    if _.empty?
+    else
+      @have_we_found_any_lecture_that_fits = true
+      e
+      # ===================================================================== #
+      # Apply a filter if the user set one.
+      # ===================================================================== #
+      if @apply_this_filter
+        case @apply_this_filter
+        when :only_master_lectures
+          _ = return_only_master_lectures_from_this_dataset(_)
+        when :only_bachelor_lectures
+          _ = return_only_bachelor_lectures_from_this_dataset(_)
+        end
+      end
+      # ===================================================================== #
+      # In this case, report these.
+      # ===================================================================== #
+      result = ("#{rev}The following #{sfancy(_.size.to_s)}").dup
+      if _.size > 1
+        result << ' lectures have '
+      else
+        result << ' lecture has '
+      end
+      result << lightskyblue(seeking_n_ects_points?.to_s)+' ECTS point '\
+                'and '
+      if _.size > 1
+        result << 'were'
+      else
+        result << 'was'
+      end
+      result << ' already passed:'
+      e result
+      e
+      _.each {|name, inner_hash| @index_counter += 1 # Increment the index counter.
+        colourized_display_of_this_matching_lecture(name, inner_hash)
+      }
+      e
+      # ===================================================================== #
+      # And get rid of them too, since we already reported them.
+      # ===================================================================== #
+      @current_dataset.reject! {|name, inner_hash|
+        inner_hash[:already_solved]
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === report_bachelor_or_master_curricula
+  #
+  # The input to this method should be an Array holding the
+  # dataset for the Curricula (Bachelor or Master).
+  #
+  # If it is part of a bachelor curriculum then a 'B' will be appended
+  # to the resulting string; if it is a master curriculum then a 'M'
+  # will be appended.
+  # ========================================================================= #
+  def report_bachelor_or_master_curricula(i)
+    result = ''.dup
+    if i
+      if i.any? {|entry|
+          entry.start_with?('033')
+        }
+        result << 'B'
+      end
+      if i.any? {|entry|
+          entry.start_with?('066')
+        }
+        unless result.empty?
+          result << '/' # Add a separator in this case.
+        end
+        result << 'M'
+      end
+    else
+      e 'No value was supplied. Call stack is:'
+      pp caller()
+    end
+    return result
+  end
+
+  # ========================================================================= #
+  # === try_to_report_unfinished_bachelor_entries_that_match
+  # ========================================================================= #
+  def try_to_report_unfinished_bachelor_entries_that_match
+    return if @apply_this_filter == :only_master_lectures
+    selection = @current_dataset.select {|name, inner_hash|
+      curricula = inner_hash['curricula']
+      is_a_bachelor_lecture?(curricula)
+    }
+    if selection.empty?
+    else
+      @have_we_found_any_lecture_that_fits = true
+      e rev+'The following '+sfancy(selection.size.to_s)+
+        ' '+return_lecture_is_or_lecture_are(selection.keys.size)+
+        ' part of a '+mediumpurple('bachelor curriculum')+'.'
+      e
+      selection.each {|name, inner_hash| @index_counter += 1 # Increment the index counter.
+        colourized_display_of_this_matching_lecture(name, inner_hash)
+      }
+      e
+      # ===================================================================== #
+      # Also remove these entries.
+      # ===================================================================== #
+      @current_dataset.reject! {|name, inner_hash|
+        curricula = inner_hash['curricula']
+        is_a_bachelor_lecture?(curricula)
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === return_lecture_is_or_lecture_are
+  # ========================================================================= #
+  def return_lecture_is_or_lecture_are(i)
+    if i > 1
+      'lectures are'
+    else
+      'lecture is'
+    end
+  end
+
+  # ========================================================================= #
+  # === colourize_the_lecture_type_in_crimson_or_in_brown
+  # ========================================================================= #
+  def colourize_the_lecture_type_in_crimson_or_in_brown(i)
+    case i.strip
+    when 'B'
+      crimson(i)
+    else
+      brown(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === try_to_report_unfinished_master_entries_that_match
+  # ========================================================================= #
+  def try_to_report_unfinished_master_entries_that_match
+    _ = @current_dataset
+    return if @apply_this_filter == :only_bachelor_lectures
+    if _.empty?
+    else
+      @have_we_found_any_lecture_that_fits = true
+      e "#{rev}The following #{sfancy(_.size.to_s)}"\
+        " #{return_lecture_is_or_lecture_are(_.size)}"\
+        " part of a #{mediumpurple('master curriculum')} only."
+      e
+      _.each {|name, inner_hash| @index_counter += 1 # Increment the index counter.
+        colourized_display_of_this_matching_lecture(name, inner_hash)
+      }
+      e
+    end
+  end
+
+  # ========================================================================= #
+  # === notify_the_user_if_we_have_not_found_any_lecture_that_fits
+  # ========================================================================= #
+  def notify_the_user_if_we_have_not_found_any_lecture_that_fits
+    unless @have_we_found_any_lecture_that_fits
+      e "No result was found for #{sfancy(n_ects_points?)} ECTS points."
+    end
+  end
+
+  # ========================================================================= #
+  # === select_all_entries_that_match_the_criterium
+  #
+  # This is a general filter where we obtain the lectures that can match
+  # to the given n ECTS criterium.
+  # ========================================================================= #
+  def select_all_entries_that_match_the_criterium
+    select_for_n_ects_points = select_for_n_ects_points?
+    @current_dataset = original_dataset?.select {|name_of_the_lecture, inner_hash|
+      n_ects_points = inner_hash[:ects]
+      curricula     = inner_hash['curricula']
+      # ===================================================================== #
+      # Apply another round of filtering, if the user instructed us to do so.
+      # ===================================================================== #
+      if    @apply_this_filter == :only_master_lectures
+        (select_for_n_ects_points == n_ects_points) and has_a_master_curriculum?(curricula)
+      elsif @apply_this_filter == :only_bachelor_lectures
+        (select_for_n_ects_points == n_ects_points) and has_a_bachelor_curriculum?(curricula)
+      else
+        select_for_n_ects_points == n_ects_points
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === is_a_bachelor_lecture?
+  #
+  # Input to this method must be an Array.
+  #
+  # This method will return a boolean depending on whether the given
+  # input is a bachelor-curriculum or whether it is not.
+  #
+  # The lecture is assumed to be a bachelor curriculum if it starts
+  # with any of the following input:
+  #
+  #   '033'
+  #   '193'
+  #   '198'
+  #
+  # ========================================================================= #
+  def is_a_bachelor_lecture?(i)
+    result = false
+    if i
+      result = i.any? {|entry|
+        entry.start_with?('033') or
+        entry.start_with?('193') or
+        entry.start_with?('198')
+      }
+    else
+      e 'No value was supplied. Call stack is:'; print '  '
+      pp caller()
+    end
+    return result
+  end; alias has_a_bachelor_lecture? is_a_bachelor_lecture? # === has_a_bachelor_lecture?
+
+  # ========================================================================= #
+  # === apply_filters_should_they_exist
+  # ========================================================================= #
+  def apply_filters_should_they_exist
+    if @apply_this_filter
+      case @apply_this_filter # case tag
+      when :only_master_lectures
+        @current_dataset = return_only_master_lectures_from_this_dataset(@current_dataset)
+      when :only_bachelor_lectures
+        @current_dataset = return_only_bachelor_lectures_from_this_dataset(@current_dataset)
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === return_only_master_lectures_from_this_dataset
+  # ========================================================================= #
+  def return_only_master_lectures_from_this_dataset(i)
+    i.select {|name, hash|
+      curricula = hash['curricula']
+      curricula.any? {|most_inner_entry|
+        most_inner_entry.start_with? '066'
+      }
+    }
+  end
+
+  # ========================================================================= #
+  # === return_only_bachelor_lectures_from_this_dataset
+  # ========================================================================= #
+  def return_only_bachelor_lectures_from_this_dataset(i)
+    i.select {|name, hash|
+      curricula = hash['curricula']
+      curricula.any? {|most_inner_entry|
+        most_inner_entry.start_with? '033'
+      }
+    }
+  end
+
+  # ========================================================================= #
+  # === colourized_display_of_this_matching_lecture
+  #
+  # The second argument to this method is the Hash that contains
+  # all the useful information from the file "lecture_information.yml". 
+  # ========================================================================= #
+  def colourized_display_of_this_matching_lecture(
+      name, inner_hash
+    )
+    curricula_entry    = inner_hash['curricula']
+    at_this_university = inner_hash[:university]
+    lecture_type       = inner_hash[:type]
+    # ======================================================================= #
+    # The shorter_name_of_the_lecture variable in particular does NOT
+    # include the leading LVA ID number.
+    # ======================================================================= #
+    shorter_name_of_the_lecture = name.split(' ')[1..-1].join(' ').strip
+    if @show_numbers
+      shorter_name_of_the_lecture = name
+    end
+    padded_index = ("#{@index_counter.to_s})").rjust(4)
+    colourized_and_padded_index = slateblue(padded_index)
+    # ======================================================================= #
+    # Next display that information to the user:
+    # ======================================================================= #
+    e colourized_and_padded_index+' '+
+      sfancy(shorter_name_of_the_lecture.ljust(88))+' '+ # <- Report the individual name.
+      colourize_the_lecture_type_in_crimson_or_in_brown(
+        report_bachelor_or_master_curricula(curricula_entry).ljust(5)
+      )+
+      mediumseagreen(at_this_university.center(12))+' '+
+      mediumturquoise("[#{lecture_type.to_s}]")
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    select_all_entries_that_match_the_criterium # <- First, obtain the entries that match.
+    menu
+    apply_filters_should_they_exist
+    try_to_report_those_entries_first_that_were_already_passed
+    try_to_report_unfinished_bachelor_entries_that_match
+    try_to_report_unfinished_master_entries_that_match
+    notify_the_user_if_we_have_not_found_any_lecture_that_fits
+  end
+
+  # ========================================================================= #
+  # === Studium::SearchFor_nECTS[]
+  #
+  # Usage example:
+  #
+  #   Studium::SearchFor_nECTS[1.5]
+  #
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::SearchFor_nECTS.new(ARGV)
+end # n_ECTS 1.5