studium 0.13.1

data/lib/studium/curricula/modules/display_on_the_commandline.rb

@@ -0,0 +1,319 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Curricula::Modules::DisplayOnTheCommandline
+#
+# This class will show all modules belonging to a particular
+# curriculum, on the commandline. The associated lectures
+# of these modules will also be shown.
+#
+# Thus, this class acts a bit like a pretty-printer for exam data.
+#
+# It was originally called Studium::ShowModulesOnTheCommandline,
+# but it was relocated in December 2019 to a separate location
+# and newly written code.
+#
+# Usage example:
+#
+#   Studium::Curricula::Modules::DisplayOnTheCommandline.new(ARGV)
+#
+# =========================================================================== #
+# require 'studium/curricula/modules/display_on_the_commandline.rb'
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+module Curricula
+
+module Modules
+
+class DisplayOnTheCommandline < ::Studium::Base # === Studium::Curricula::Modules::DisplayOnTheCommandline
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @we_seek_this_curriculum
+    # ======================================================================= #
+    @we_seek_this_curriculum = nil
+    # ======================================================================= #
+    # === @hash_containing_all_modules
+    # ======================================================================= #
+    @hash_containing_all_modules = {}
+    # ======================================================================= #
+    # === @total_n_ects_points
+    # ======================================================================= #
+    @total_n_ects_points = 0
+  end
+
+  # ========================================================================= #
+  # === set_we_seek_this_curriculum                                (menu tag)
+  #
+  # We need to treat the individual curricula in a special way here,
+  # because they are not defined in the yaml file 'curricula.yml'.
+  # ========================================================================= #
+  def set_we_seek_this_curriculum(i)
+    i = i.first if i.is_a? Array
+    case i # case tag, main tag
+    # ======================================================================= #
+    # === :indi1
+    # ======================================================================= #
+    when :indi1,
+         :default
+      i = return_title_from_this_curriculum_file(:indi1)
+    # ======================================================================= #
+    # === :indi2 :indi3 and :indi4.
+    # ======================================================================= #
+    when :indi2,
+         :indi3,
+         :indi4
+      i = return_title_from_this_curriculum_file(i)
+    else
+      i = return_name_of_this_curriculum(i)
+    end
+    @we_seek_this_curriculum = i.strip
+  end; alias set_seek_this_curriculum set_we_seek_this_curriculum # === set_seek_this_curriculum
+
+  # ========================================================================= #
+  # === name_of_the_curriculum?
+  # ========================================================================= #
+  def name_of_the_curriculum?
+    @we_seek_this_curriculum
+  end
+
+  # ========================================================================= #
+  # === determine_the_main_curriculum
+  # ========================================================================= #
+  def determine_the_main_curriculum(
+      _ = first_argument?
+    )
+    if _
+      set_we_seek_this_curriculum(_)
+    end
+  end
+
+  # ========================================================================= #
+  # === notify_the_user_what_will_be_done
+  # ========================================================================= #
+  def notify_the_user_what_will_be_done
+    opnn { :no_trailing }
+    e
+    e
+    _ = @we_seek_this_curriculum.dup
+    e "Working on the curriculum #{skyblue(_)} next."
+    e 'The file that was used, was: `'+sfile(
+        return_file_associated_with_this_curriculum(_)
+      )+'`'
+  end
+
+  # ========================================================================= #
+  # === report
+  # ========================================================================= #
+  def report(
+      i = @hash_containing_all_modules
+    )
+    @lecture_entry_number = 0
+    # ======================================================================= #
+    # And display it as well.
+    # ======================================================================= #
+    e
+    e
+    i.each_pair {|individual_curriculum_module, inner_dataset|
+      long_name_of_the_module = inner_dataset[:name_of_the_module]
+      lectures_in_this_module = inner_dataset[:lectures]
+      padded_module_number = "#{individual_curriculum_module}: ".ljust(5)
+      n_ects_in_this_module = lectures_in_this_module.map {|key, hash|
+        hash[:ects]
+      }.sum
+      depends_on_these_modules = inner_dataset[:this_module_depends_on_these_other_modules]
+      _ = ''.dup
+      if depends_on_these_modules.nil?
+        _ << ' This module depends on no other module.'
+      else
+        depends_on_these_modules.each {|this_module|
+          if this_module.include? 'None'
+            _ << 'This module depends on no other module.'
+          else
+            _ << crimson('→ ')
+            _ << springgreen(this_module)
+            _ << ' '
+          end
+        }
+      end
+      # ===================================================================== #
+      # Next strip on it:
+      # ===================================================================== #
+      _.strip!
+      # ===================================================================== #
+      # Display: "Module #nr"
+      # ===================================================================== #
+      colourized_n_ECTS_in_this_module = mediumorchid(
+        "[#{n_ects_in_this_module} ECTS in Module "\
+        "#{individual_curriculum_module}]"
+      )
+      e steelblue('-'*70)
+      e palegoldenrod('Module ')+
+        chocolate(padded_module_number)+
+        "#{steelblue(long_name_of_the_module.strip.ljust(58))} "+
+        colourized_n_ECTS_in_this_module
+      e mediumturquoise('            Module '+
+          long_name_of_the_module.to_s+' depends on: '+"\n"
+        )+
+        lightgreen(
+          _.rjust(50)
+        )
+      e
+      lectures_in_this_module.each_pair {|name_of_the_lecture, most_inner_dataset|
+        n_ects = most_inner_dataset[:ects]
+        @lecture_entry_number += 1 # Keep track of the lecture-number here.
+        e '  '+
+          olivedrab(
+            (
+              @lecture_entry_number.to_s+')'
+            ).rjust(3)+' '
+          )+
+          royalblue(name_of_the_lecture.ljust(65))+
+          slateblue(
+            " [#{n_ects.to_s} ECTS]"
+          )
+      }
+      e
+    }
+  end
+
+  # ========================================================================= #
+  # === report_how_many_ECTS_points_are_attributed
+  # ========================================================================= #
+  def report_how_many_ECTS_points_are_attributed
+    e 'This curriculum ('+steelblue(name_of_the_curriculum?)+
+      ') has a total of '+royalblue(@total_n_ects_points.to_s)+
+      ' ECTS points.'
+    e
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    determine_the_main_curriculum
+    notify_the_user_what_will_be_done
+    _ = return_dataset_from_this_curriculum(@we_seek_this_curriculum)
+    if @we_seek_this_curriculum.include?('ummy') # <- Ignore "dummy" curricula.
+      _.each_pair {|name_of_the_lecture, inner_hash|
+        @total_n_ects_points += inner_hash[:ects]
+        e "  #{steelblue(name_of_the_lecture)}"
+      }
+    else
+      _.each_pair {|name_of_the_lecture, inner_hash|
+        # =================================================================== #
+        # The first variable may look like this:
+        #
+        #   "187.A99 Bachelorarbeit für Informatik und Wirtschaftsinformatik"
+        #
+        # =================================================================== #
+        n_ects = inner_hash[:ects]
+        if inner_hash.has_key?(:individual_curricula)
+          # ================================================================= #
+          # First, obtain all individual curricula:
+          # ================================================================= #
+          all_individual_curricula = inner_hash[:individual_curricula]
+          # ================================================================= #
+          # Obtain the correct selection next:
+          # ================================================================= #
+          selection_of_the_correct_curriculum = all_individual_curricula.select {|key, value|
+            name_of_the_curriculum = key[:name_of_the_curriculum].strip
+            name_of_the_curriculum.include? @we_seek_this_curriculum.tr('_',' ')
+          }
+          if selection_of_the_correct_curriculum.is_a? Array
+            selection_of_the_correct_curriculum = selection_of_the_correct_curriculum.first
+          end
+          # ================================================================= #
+          # And rewrite that entry:
+          # ================================================================= #
+          inner_hash[:individual_curricula] = selection_of_the_correct_curriculum
+          @total_n_ects_points += n_ects
+          # ================================================================= #
+          # Add some info if we have a nil-value.
+          # ================================================================= #
+          if selection_of_the_correct_curriculum.nil?
+            e 'Some problem: no proper entry for the course '+
+              steelblue(name_of_the_lecture)
+            e lightgreen('Displaying more information about this problem next.')
+            e 'The curriculum was:'
+            e steelblue("  #{@we_seek_this_curriculum}")
+          end
+          # ================================================================= #
+          # Obtain the correct selection.
+          # ================================================================= #
+          individual_curriculum_module_name       = selection_of_the_correct_curriculum[:name_of_the_curriculum_module].strip #.tr('-','_')
+          individual_curriculum_module_depends_on = selection_of_the_correct_curriculum[:individual_curriculum_depends_on_these_modules]
+          individual_curriculum_module            = selection_of_the_correct_curriculum[:individual_curriculum_module]
+          # ================================================================= #
+          # Obtain the first entry of the Array next:
+          # ================================================================= #
+          first = individual_curriculum_module.flatten.first
+          if individual_curriculum_module.is_a? Array
+            individual_curriculum_module = individual_curriculum_module.first
+          end
+          unless @hash_containing_all_modules.has_key? first
+            @hash_containing_all_modules[first] = {}
+          end
+          @hash_containing_all_modules[first][:name_of_the_module] = individual_curriculum_module_name
+          # ================================================================= #
+          # Add the lecture to our big hash next:
+          # ================================================================= #
+          unless @hash_containing_all_modules[first].has_key? :lectures
+            @hash_containing_all_modules[first][:lectures] = {}
+          end
+          @hash_containing_all_modules[first][:lectures][name_of_the_lecture] = inner_hash
+          @hash_containing_all_modules[first][:this_module_depends_on_these_other_modules] =
+            individual_curriculum_module_depends_on
+        end
+      }
+      report(@hash_containing_all_modules)
+    end
+    report_how_many_ECTS_points_are_attributed
+  end
+
+  # ========================================================================= #
+  # === Studium::Curricula::Modules::DisplayOnTheCommandline[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end; end
+
+# =========================================================================== #
+# === Studium::ShowModulesOnTheCommandline
+#
+# Add an "alias" next.
+# =========================================================================== #
+ShowModulesOnTheCommandline = ::Studium::Curricula::Modules::DisplayOnTheCommandline
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Curricula::Modules::DisplayOnTheCommandline.new(ARGV)
+end # displaycommandline indi1
+    # displaycommandline indi3
+    # displaycommandline indi2

data/lib/studium/curricula/modules/return_n_ects_in_this_module.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/curricula/modules/return_n_ects_in_this_module.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/toplevel_methods/main_dataset.rb'
+  require 'studium/toplevel_methods/return_sanitized_dataset_from_the_file_lecture_information.rb'
+
+  # ========================================================================= #
+  # === Studium.return_n_ects_in_this_module
+  #
+  # This method will, if all things go well, return the number of
+  # ECTS points in a given module of an individual curriculum.
+  #
+  # The default is currently for the curriculum called
+  # "Bachelorcurriculum Informatik und molekulare Biologie".
+  # ========================================================================= #
+  def self.return_n_ects_in_this_module(
+      name_of_the_curriculum       = :default, # This is 'Bachelorcurriculum Informatik und molekulare Biologie'
+      individual_curriculum_module = 'M19',
+      use_this_dataset             = :use_what_is_best
+    )
+    n_ects_in_total = 0.0
+    case name_of_the_curriculum
+    when :default
+      name_of_the_curriculum = 'Bachelorcurriculum Informatik und molekulare Biologie'
+    end
+    case use_this_dataset
+    when :use_what_is_best
+      if main_dataset?
+        use_this_dataset = main_dataset?
+      else
+        use_this_dataset = return_sanitized_dataset_from_the_file_lecture_information
+      end
+    end
+    unless individual_curriculum_module.is_a? Array
+      individual_curriculum_module = [individual_curriculum_module]
+    end
+    use_this_dataset.each_pair {|key, inner_hash|
+      if inner_hash.has_key? :individual_curricula
+        array = inner_hash[:individual_curricula]
+        array.each {|most_inner_hash|
+          use_this_name_for_the_curriculum = most_inner_hash[:name_of_the_curriculum]
+          if use_this_name_for_the_curriculum.is_a? String
+            use_this_name_for_the_curriculum.strip!
+          end
+          if (use_this_name_for_the_curriculum == name_of_the_curriculum.strip) and
+             (most_inner_hash[:individual_curriculum_module] == individual_curriculum_module)
+            n_ects_in_total += inner_hash[:ects]
+          end
+        }
+      end
+    }
+    n_ects_in_total
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  if ARGV.empty?
+    %w(
+      M1   M2  M3  M4  M5  M6  M7  M8  M9 M10
+      M11 M12 M13 M14 M15 M16 M17 M18 M19 M20
+      M21
+    ).each {|this_module|
+      e Studium.return_n_ects_in_this_module(:default, this_module)
+    }
+  else
+    e Studium.return_n_ects_in_this_module(ARGV)
+  end  
+end # returnnectsinthismodule

data/lib/studium/curricula/n_percent_solved_in_this_curriculum.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/curricula/n_percent_solved_in_this_curriculum.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/toplevel_methods/e.rb'
+  require 'studium/toplevel_methods/curriculum_related_code.rb'
+  require 'studium/toplevel_methods/main_dataset.rb'
+  require 'studium/toplevel_methods/return_sanitized_dataset_from_the_file_lecture_information.rb'
+
+  # ========================================================================= #
+  # === Studium.n_percent_solved_in_this_curriculum
+  #
+  # This method will determine how many ECTS points have been solved
+  # in a particular curriculum, in n% (percentage). So, for example,
+  # the method may return the float value 75.0, which means "75%
+  # of all courses in this curriculum have been completed
+  # successfully".
+  # ========================================================================= #
+  def self.n_percent_solved_in_this_curriculum(i)
+    if i.is_a? Array
+      i.map {|entry|
+        n_percent_solved_in_this_curriculum(entry)
+      }
+    else
+      if ::Studium.main_dataset?
+        full_dataset = ::Studium.main_dataset? # In this case, re-use the main dataset.
+      else # else load up a new dataset
+        full_dataset = ::Studium.return_sanitized_dataset_from_the_file_lecture_information
+      end
+      # ======================================================================= #
+      # Next, obtain the dataset from a curriculum file:
+      # ======================================================================= #
+      dataset = Studium.read_dataset_from_a_curriculum_file(
+        i.to_sym, :remove_comments
+      )
+      total_ects_points = 0
+      n_ects_points_are_already_solved = 0
+      dataset.each {|name_of_the_lecture|
+        name_of_the_lecture.squeeze! ' '
+        name_of_the_lecture.strip!
+        if full_dataset.has_key? name_of_the_lecture
+          # =================================================================== #
+          # Ok, the entry is included, so get the hash dataset.
+          # =================================================================== #
+          pointer = full_dataset[name_of_the_lecture]
+          n_ects = pointer[:ects]
+          total_ects_points += n_ects
+          if (pointer[:already_solved] == true)
+            n_ects_points_are_already_solved += n_ects
+          end
+        else
+          e 'In the file `'+__FILE__+'`, method `'+__method__.to_s+'`:'
+          e "The entry `#{name_of_the_lecture}` is not included."
+        end
+      }
+      # ======================================================================= #
+      # Finally, calculate the percentage value, as a Float:
+      # ======================================================================= #
+      result = (n_ects_points_are_already_solved * 100.0) / total_ects_points
+      return result.round(2)
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Studium.n_percent_solved_in_this_curriculum(ARGV)
+end # npercentsolvedinthiscurriculum bachelor_vector
+    # npercentsolvedinthiscurriculum master_vector
+    # npercentsolvedinthiscurriculum Immuno
+    # npercentsolvedinthiscurriculum bachelor_vector master_vector