studium 0.13.1

data/lib/studium/toplevel_methods/return_sanitized_dataset_from_the_file_lecture_information.rb

@@ -0,0 +1,110 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Usage example:
+#
+#   require 'studium/toplevel_methods/return_sanitized_dataset_from_the_file_lecture_information.rb'
+#   Studium.return_sanitized_dataset_from_the_file_lecture_information
+#
+# =========================================================================== #
+module Studium
+
+  require 'studium/requires/require_encoding.rb'
+  require 'studium/requires/require_yaml.rb'
+  require 'studium/constants/constants.rb'
+  require 'studium/toplevel_methods/e.rb'
+
+  # ========================================================================= #
+  # === Studium.return_sanitized_dataset_from_the_file_lecture_information_including_aliases
+  #
+  # This method is like the other method defined in this file, but it also
+  # includes the aliases within the dataset itself.
+  #
+  # Note that this will radically modify the original dataset, which may
+  # not always be wanted.
+  # ========================================================================= #
+  def self.return_sanitized_dataset_from_the_file_lecture_information_including_aliases
+    main_dataset = Studium.return_sanitized_dataset_from_the_file_lecture_information
+    available_keys = main_dataset.keys
+    dataset_from_lecture_aliases = YAML.load_file(Studium.file_lecture_aliases)
+    dataset_from_lecture_aliases.each_pair {|key_name_of_the_lecture, value_hash|
+      old_lva_id = value_hash[:old_lva_id].to_s
+      if available_keys.any? {|inner_entry| # ← "840.007 Einführung in die Biostatistik"
+          inner_entry.include?(key_name_of_the_lecture) and inner_entry.include?(old_lva_id)
+        }
+        # =================================================================== #
+        # Next determine what to do, which depends on the dataset.
+        # =================================================================== #
+        if value_hash.has_key? :new_name
+          new_name = value_hash[:new_name]
+          old_entry = old_lva_id+' '+key_name_of_the_lecture
+          pointer = main_dataset[old_lva_id+' '+new_name]
+          main_dataset[old_entry] = pointer
+        end
+      elsif value_hash.has_key? :new_name
+        new_name = value_hash[:new_name]
+        if available_keys.any? {|inner_entry| # ← "840.007 Einführung in die Biostatistik"
+            inner_entry.include?(new_name) and inner_entry.include?(old_lva_id)
+          }
+          # In this case add it anyway, IF it is included.
+          pointer = main_dataset[old_lva_id+' '+new_name]
+          use_this_lva_id = old_lva_id
+          if value_hash.has_key? :new_lva_id
+            use_this_lva_id = value_hash[:new_lva_id]
+          end
+          main_dataset[use_this_lva_id+' '+key_name_of_the_lecture] = pointer
+        end
+      end
+    }
+    return main_dataset
+  end; self.instance_eval { alias dataset_from_file_lecture_information                  return_sanitized_dataset_from_the_file_lecture_information_including_aliases } # === Studium.dataset_from_file_lecture_information 
+       self.instance_eval { alias return_dataset_from_file_lecture_information           return_sanitized_dataset_from_the_file_lecture_information_including_aliases } # === Studium.return_dataset_from_file_lecture_information
+       self.instance_eval { alias return_dataset_from_the_file_lecture_information       return_sanitized_dataset_from_the_file_lecture_information_including_aliases } # === Studium.return_dataset_from_the_file_lecture_information
+       self.instance_eval { alias return_sanitized_dataset_from_file_lecture_information return_sanitized_dataset_from_the_file_lecture_information_including_aliases } # === Studium.return_sanitized_dataset_from_file_lecture_information
+
+  # ========================================================================= #
+  # === Studium.return_sanitized_dataset_from_the_file_lecture_information
+  #
+  # This method will return the dataset from the file
+  # 'lecture_information.yml'.
+  #
+  # Usage examples:
+  #
+  #   Studium.return_sanitized_dataset_from_the_file_lecture_information
+  #   dataset = Studium.return_sanitized_dataset_from_the_file_lecture_information
+  #
+  # ========================================================================= #
+  def self.return_sanitized_dataset_from_the_file_lecture_information
+    _ = ::Studium.file_lecture_information?
+    if File.exist? _
+      return YAML.load_file(_)
+    end
+    nil # Else we will return nil.
+  end; self.instance_eval { alias dataset_from_file_lecture_information     return_sanitized_dataset_from_the_file_lecture_information } # === Studium.dataset_from_file_lecture_information
+       self.instance_eval { alias dataset_from_the_file_lecture_information return_sanitized_dataset_from_the_file_lecture_information } # === Studium.dataset_from_the_file_lecture_information
+
+  # ========================================================================= #
+  # === Studium.return_dataset_from_the_file_lecture_information
+  #
+  # This method is different in that it will not do any modification.
+  # ========================================================================= #
+  def self.return_dataset_from_the_file_lecture_information(
+      use_this_file = Studium.file_lecture_information
+    )
+    if File.exist? use_this_file
+      return YAML.load_file(use_this_file) # ← This will have UTF-8 encoding.
+    end
+    nil
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pp Studium.return_sanitized_dataset_from_the_file_lecture_information
+  # _ = Studium.return_sanitized_dataset_from_the_file_lecture_information_including_aliases
+  # _ = Studium.return_sanitized_dataset_from_the_file_lecture_information
+  # result = _.select {|a,b|
+  #   a.include? 'Zelluläre und molekulare'.dup
+  # }
+end # returnsanitizeddatasetfromthefilelectureinformation

data/lib/studium/toplevel_methods/return_theme_of_the_next_upcoming_exam.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/return_theme_of_the_next_upcoming_exam.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/exams/show_upcoming_exams/show_upcoming_exams.rb' # <- This has Studium.next_exam?
+
+  # ========================================================================= #
+  # === Studium.return_theme_of_the_next_upcoming_exam
+  #
+  # This method will simply return the theme of the next upcoming
+  # exam, such as 'amg1' or 'mikrobielle_lebensgemeinschaften'.
+  #
+  # This requires some guess-work. Also, we will only return one
+  # exam-theme, which is the most likely one to be had.
+  # ========================================================================= #
+  def self.return_theme_of_the_next_upcoming_exam
+    _ = ::Studium.next_exam?.first.downcase
+    # ======================================================================= #
+    # Next remove all numbers.
+    # ======================================================================= #
+    _.gsub!(/\d/,'')
+    _.strip!
+    _.tr!(' ','_')
+    _.delete!('.')
+    _.delete!('(')
+    _.delete!(')')
+    return _
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Studium.return_theme_of_the_next_upcoming_exam
+end # returnthemeofthenextupcomingexam

data/lib/studium/toplevel_methods/rinstall2.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/rinstall2.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/constants/constants.rb'
+  require 'studium/toplevel_methods/e.rb'
+  require 'studium/toplevel_methods/methods_related_to_directories.rb'
+
+  # ========================================================================= #
+  # === Studium.rinstall2
+  #
+  # The following method will only work on my home system.
+  # ========================================================================= #
+  def self.rinstall2(&block)
+    cd ROEBE_STUDIUM_DIR
+    begin
+      require 'roebe/toplevel_methods/rinstall2.rb'
+      if Object.const_defined? :Roebe
+        Roebe.rinstall2(&block)
+      else
+        e 'Roebe is not available.'
+      end
+    rescue LoadError; end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium.rinstall2
+end

data/lib/studium/toplevel_methods/rti_conflict.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/rti_conflict.rb'
+# =========================================================================== #
+module Studium
+
+  # ========================================================================= #
+  # === Studium.rti_conflict
+  #
+  # This combines the "rename KDE konsole tab" via "show conflicting LVA
+  # lectures".
+  # ========================================================================= #
+  def self.rti_conflict(i)
+    if i.is_a? Array
+      i = i.first
+    end
+    # ======================================================================= #
+    # First rename the KDE konsole tab:
+    # ======================================================================= #
+    require 'roebe/requires/require_kde_konsole.rb'
+    Roebe.rename_kde_konsole_tab(i)
+    # ======================================================================= #
+    # Then show conflicting LVA lectures:
+    # ======================================================================= #
+    require 'studium/utility_scripts/show_conflicting_lva_lectures/show_conflicting_lva_lectures.rb'
+    Studium::ShowConflictingLvaLectures.new(i)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium.rti_conflict(ARGV)
+end # rticonflict

data/lib/studium/toplevel_methods/runmode.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The Studium::Base class requires the runmode-related information.
+# =========================================================================== #
+# require 'studium/toplevel_methods/runmode.rb'
+# Studium.is_in_www_mode?
+# =========================================================================== #
+module Studium
+
+  # ========================================================================= #
+  # === @runmode
+  # ========================================================================= #
+  @runmode = :commandline
+
+  # ========================================================================= #
+  # === Studium.runmode?
+  #
+  # There are three different runmodes for the Studium project:
+  #
+  #     :commandline
+  #     :www
+  #     :gui
+  #
+  # The default runmode will be :commandline. If you need to modify it,
+  # use the method called Studium.set_runmode()
+  # ========================================================================= #
+  def self.runmode?
+    @runmode
+  end; self.instance_eval { alias run_mode? runmode? } # === Studium.run_mode?
+       self.instance_eval { alias mode?     runmode? } # === Studium.mode?
+
+  # ========================================================================= #
+  # === Studium.used_on_the_www?
+  #
+  # Query whether the scripts are used on the www or in another context.
+  # ========================================================================= #
+  def self.used_on_the_www?
+    @runmode == :www
+  end; self.instance_eval { alias is_in_www_mode? used_on_the_www? } # === Studium.is_in_www_mode?
+
+  # ========================================================================= #
+  # === Studium.set_runmode
+  #
+  # Set the runmode through this method.
+  #
+  # Usage examples:
+  #
+  #   Studium.set_runmode :gui
+  #   Studium.set_runmode(@runmode)
+  #
+  # ========================================================================= #
+  def self.set_runmode(i = :www)
+    case i
+    # ======================================================================= #
+    # === :gui
+    # ======================================================================= #
+    when :gui
+      require 'studium/colours/colours.rb'
+      ::Studium.disable_colours # I don't think we need ansi-colours for the GUI part. 
+    end
+    @runmode = i
+  end
+
+  # ========================================================================= #
+  # === Studium.www_runmode
+  #
+  # This method will enable the www-runmode, that is to make use of
+  # the Studium project on the www, such as in .cgi scripts or 
+  # sinatra-applications.
+  # ========================================================================= #
+  def self.www_runmode
+    set_runmode(:www)
+  end; self.instance_eval { alias use_www_mode    www_runmode } # === Studium.use_www_mode
+       self.instance_eval { alias run_in_www_mode www_runmode } # === Studium.run_in_www_mode
+       self.instance_eval { alias enable_www_mode www_runmode } # === Studium.enable_www_mode
+
+  # ========================================================================= #
+  # === Studium.use_www_mode_and_disable_colours
+  # ========================================================================= #
+  def self.use_www_mode_and_disable_colours
+    www_runmode
+    disable_colours
+  end
+
+end

data/lib/studium/toplevel_methods/sanitized_dataset_from_file_passed_exams_per_month.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Just some code to load the file "passed_exams_per_month.csv".
+#
+# Note that the Studium::Base class at base/base.rb already loads
+# up this file.
+# =========================================================================== #
+# require 'studium/toplevel_methods/sanitized_dataset_from_file_passed_exams_per_month.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/constants/constants.rb'
+  require 'studium/requires/require_encoding.rb'
+
+  # ========================================================================= #
+  # === Studium.sanitized_dataset_from_file_passed_exams_per_month
+  #
+  # Use this method in order to load up the proper dataset from the passed
+  # exams.
+  #
+  # The method will also ensure that the encoding is the one that
+  # we will (consistently) use for the whole project.
+  #
+  # Since as of 15.10.2020 the method will strip newlines too.
+  # ========================================================================= #
+  def self.sanitized_dataset_from_file_passed_exams_per_month(
+      i                 = FILE_PASSED_EXAMS_PER_MONTH,
+      use_this_encoding = ::Studium.main_encoding?
+    )
+    # ======================================================================= #
+    # Load up the exam-dataset next.
+    # ======================================================================= #
+    dataset = File.readlines(i, encoding: use_this_encoding).reject {|line|
+      # ===================================================================== #
+      # Lines that start with a '#' token will be rejected, as will lines
+      # that are empty and lines that are "| \n".
+      # ===================================================================== #
+      line.start_with?('#') or
+      line.strip.empty? or
+      (line == "| \n") # <- Such an entry would be an error.
+    }.map(&:strip)
+    return dataset
+  end; self.instance_eval { alias return_dataset_from_file_passed_exams_per_month sanitized_dataset_from_file_passed_exams_per_month } # === Studium.return_dataset_from_file_passed_exams_per_month
+       self.instance_eval { alias completed_exams?                                sanitized_dataset_from_file_passed_exams_per_month } # === Studium.completed_exams?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+ puts Studium.sanitized_dataset_from_file_passed_exams_per_month  
+end # rb sanitized_dataset_from_file*rb

data/lib/studium/toplevel_methods/set_last_file_for_exam_questions.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/set_last_file_for_exam_questions.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/colours/colours.rb'
+  require 'studium/constants/constants.rb'
+  require 'studium/toplevel_methods/runmode.rb'
+  require 'studium/toplevel_methods/write_into_file_related_functionality.rb'
+
+  # ========================================================================= #
+  # === Studium.set_last_file_for_exam_questions
+  #
+  # This method can be used to modify the .yml file that holds the
+  # location of the file that keeps our questions-answers.
+  #
+  # The only argument that this method accepts, shall be the local
+  # file path of a .rb file in question.
+  # ========================================================================= #
+  def self.set_last_file_for_exam_questions(
+      file_path,
+      be_verbose = false
+    )
+    into = FILE_FOR_EXAM_QUESTIONS # This is the file 'file_for_exam_questions.yml'.
+    # ======================================================================= #
+    # We will not store the last-file if we are being run in the www-mode.
+    # ======================================================================= #
+    unless Studium.used_on_the_www?
+      case be_verbose
+      when :be_verbose
+        be_verbose = true
+      end
+      if be_verbose
+        puts 'Storing `'+Colours.simp(file_path)+'` into'
+        puts "`#{Colours.simp(into)}`."
+      end
+      ::Studium.write_what_into(YAML.dump(file_path), into)
+      # ===================================================================== #
+      # And also store into ::Studium.log_dir?
+      # ===================================================================== #
+      into = ::Studium.log_dir?+File.basename(into)
+      if be_verbose
+        puts 'Storing `'+Colours.simp(file_path)+'` into'
+        puts '`'+Colours.simp(into)+'`.'
+      end
+      ::Studium.write_what_into(YAML.dump(file_path), into)
+      # ===================================================================== #
+      # Last but not least, on my system as well.
+      # ===================================================================== #
+      if ::Studium.is_on_roebe?
+        into = "#{RUBY_STUDIUM_HOME_DIR}yaml/file_for_exam_questions.yml"
+        if be_verbose
+          puts 'Storing `'+Colours.simp(file_path)+'` into'
+          puts '`'+Colours.simp(into)+'`.'
+        end
+        ::Studium.write_what_into(YAML.dump(file_path), into)
+      end
+    end
+  end; self.instance_eval { alias set_file_for_exam_questions set_last_file_for_exam_questions } # === Studium.set_file_for_exam_questions
+
+end

data/lib/studium/toplevel_methods/set_this_cd_alias_to.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/set_this_cd_alias_to.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/colours/colours.rb'
+  require 'studium/requires/require_encoding.rb'
+  require 'studium/constants/constants.rb'
+  require 'studium/toplevel_methods/e.rb'
+  require 'studium/toplevel_methods/methods_related_to_files.rb'
+
+  # ========================================================================= #
+  # === Studium.set_this_cd_alias_to
+  #
+  # This method is able to manipulate the 'cd_aliases.yml' file. I needed
+  # this (fairly) simple method because the old classes called NewStud
+  # and AutoStud were becoming fairly complicated.
+  #
+  # The format for this method is deliberately kept very simple:
+  #
+  #   - The first argument must be the existing (!) name of
+  #     the cd-alias at hand. So for example, 'pwdalias1:'.
+  #
+  #   - The second argument must simply be the new content 
+  #     of that alias.
+  #
+  # ========================================================================= #
+  def self.set_this_cd_alias_to(
+      this_cd_alias,
+      new_content,
+      be_verbose = :default
+    )
+    case be_verbose # By default, we will be verbose.
+    when :default
+      be_verbose = true
+    when :be_quiet
+      be_verbose = false
+    end
+    # ======================================================================= #
+    # First we must read in the old file content from the file cd_aliases.yml
+    # ======================================================================= #
+    data = File.readlines(
+      FILE_CD_ALIASES,
+      encoding: ::Studium.main_encoding?
+    )
+    proper_line = data.select {|line|
+      line.start_with? this_cd_alias
+    }
+    if proper_line.empty?
+      e "No result was found for #{this_cd_alias}."
+    else
+      # ===================================================================== #
+      # else a result was found, so we can continue.
+      # ===================================================================== #
+      new_string = ''.dup
+      data.each {|this_line|
+        if this_line.start_with? this_cd_alias
+          padding = this_line[
+            (this_cd_alias.size) .. (this_line.index('cd') - 1)
+          ]
+          new_line = this_cd_alias.dup
+          new_line << "#{padding.dup}cd #{new_content.dup}\n"
+          this_line = new_line.dup
+        end
+        new_string << this_line
+      }
+      into = FILE_CD_ALIASES
+      if be_verbose
+        e "Storing #{lightsteelblue(what)} into `#{sfile(into)}`."
+      end
+      what = new_string
+      ::Studium.write_what_into(what, into)
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium.set_this_cd_alias_to(
+    'pwdstud1:',
+     Studium.studium_directory_at_home?+'BOKU_WIEN/772114_Biochemie_des_Stoffwechsels/'
+  )  
+end # setthiscdaliasto

data/lib/studium/toplevel_methods/show_passed_exams_having_this_grade.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/show_passed_exams_having_this_grade.rb'
+# =========================================================================== #
+module Studium
+
+  require 'studium/toplevel_methods/e.rb'
+  require 'studium/exams/last_exams/last_exams.rb'
+  # ========================================================================= #
+  # === Studium.show_passed_exams_having_this_grade
+  #
+  # Pass in the grade to this method, such as 1,2,3,4 or 5. The method
+  # will then report all exams that were successfully passed with
+  # that particular grade at hand.
+  # ========================================================================= #
+  def self.show_passed_exams_having_this_grade(
+      i                                 = ARGV,
+      check_for_max_value_of_grade_four = true
+    )
+    i = i.first if i.is_a? Array
+    if check_for_max_value_of_grade_four and (i.to_i > 4) # We do not keep grade 5 or higher.
+      e 'No grade higher than 4 is currently kept.'
+    else
+      ::Studium::Exams::LastExams.new("--grade=#{i}")
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium.show_passed_exams_having_this_grade(ARGV)
+end # grade 3

data/lib/studium/toplevel_methods/spacer.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/toplevel_methods/spacer.rb'
+# =========================================================================== #
+module Studium
+
+  # ========================================================================= #
+  # === Studium.spacer
+  #
+  # This is similar to cliner() - but simpler.
+  # ========================================================================= #
+  def self.spacer
+    puts '-' * 80
+  end
+
+end