studium 0.9.383

data/lib/studium/commandline/help.rb

@@ -0,0 +1,147 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/commandline/help.rb'
+# =========================================================================== #
+module Studium
+
+class FastCommandlineOptions < Base
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  #
+  # We will first build up an Array, then sort it, then display it.
+  #
+  # Invocation example:
+  #
+  #   studium --show-help
+  #
+  # ========================================================================= #
+  def show_help
+    e
+    e 'The following options are available:'
+    e
+    array = []
+    array << '  --exam-topics?                                           # feedback '\
+             'the location to the exam-topics in use'
+    array << '  --log-dir?                                               # feedback '\
+             'the log directory in use'
+    array << '  --n-topics?                                              # feedback '\
+             'how many topics are available'
+    array << '  --show_how_many_exams_were_passed                        # feedback '\
+             'how many exams were already passed'
+    array << '  --set-directory-to-the-exam-topics=/Depot/j/EXAM_TOPICS/ # set a '\
+             'specific directory target'
+    array << '  --best-months                                            # show '\
+             'the best month, that is, most ECTS points solved in any given month'
+    array << '  --set-dir=/dir                                           # shorter '\
+             'variant of the above; an alias'
+    array << '  --set-editor=vim                                         # set '\
+             'to use the editor called vim (or any other one of your choice)'
+    array << '  --show-curricula                                         # show '\
+             'all registered curricula'
+    array << '  --master-curricula                                       # show '\
+             'all lectures passed in a given master curriculum'
+    array << '  --upload-exam-questions                                  # uploads '\
+             'the exam questions'
+    array << '  --expand="15.10-22.10.2018"                              # expand '\
+             'the time range for this range'
+    array << '  --encoding=utf                                           # use '\
+             'this encoding for the Studium namespace'
+    array << '  --outdated                                               # show '\
+             'outdated lva- and exam-dates of registered lectures'
+    array << '  --collage?                                               # show '\
+             'which exams we are currently training'
+    array << '  --n-ects-from-this-file=ECTS.md                          # display '\
+             'how many ECTS points are in that file'
+    array << '  --ects-bachelor-master?                                  # show '\
+             'how many bachelor/master ECTS points were passed so far'
+    array << '  --passed-exams?                                          # show '\
+             'which exams were already completed successfully'
+    array << '  --start                                                  # note '\
+             'down the start time + how many exams were solved at this point'
+    array << '  --pristine                                               # this '\
+             'will create a new file called '+
+             'lecture_information.yml'+
+             ', without any already solved exams'
+    array << '  --colours?                                               # show '\
+             'whether we will use colours or whether we will not'
+    array << '  --passed-ects                                            # show '\
+             'how many ECTS were passed in the registered curricula'
+    array << '  --passed-exams=chemistry                                 # show '\
+             'passed exams belonging to the given theme (in this '\
+             'case, lectures related to chemistry)'
+    array << '  --statistics                                             # show '\
+             'some general statistics of this project'
+    array << '  --check-the-lecture-information-file                     # check '\
+             'whether all entries are correct, in the file called '+
+             sfile('lecture_information.yml')
+    array << '  --lectures-on-this-day=05.05.2018                        # show '\
+             'which lectures are on the given day'
+    array << '  --disable-colours                                        # this '\
+             'entry point allows you to permanently disable colours'
+    array << '  --solved?                                                # show '\
+             'whether whether that particular lecture ID was already solved or '\
+             'whether it was not'
+    array << '  --set-log-dir=/foo/bar/                                  # specify '\
+             'another log directory'
+    array << '  --exams-at-the-meduni                                    # show '\
+             'all exams at the meduni'
+    array << '  --n-entries-in-the-file-lecture-information?             # report '\
+             'how many courses are registered in the file '+
+             sfile('lecture_information.yml')
+    array << '  --max?                                                   # show '\
+             'how many exams were already passed'
+    array << '  --download-exam-dataset                                  # download '\
+             'the exam dataset from a remote website'
+    array << '  --gui                                                    # start '\
+             'the GUI component of the Studium project'
+    array << '  --timetable                                              # show '\
+             'upcoming possible exams, via a timetable'
+    array << '  --max-ever                                               # show '\
+             'the maximum amount of exam-questions ever answered'
+    array << '  --audio-stats                                            # show '\
+             'all locally available audio files in the study-directory'
+    array << '  --yearly-average-grades                                  # show '\
+             'the yearly average grades'
+    array << '  --percentage-achieved                                    # show '\
+             'how much percent of a given curriculum we have already passed'
+    array << '  --questions-per-year                                     # show '\
+             'how many questions were added per year'
+    array << '  --exams-at-the-uniwien                                   # show '\
+             'all exams at the uniwien (university of vienna)'
+    array << '  --open                                                   # open '\
+             'relevant study-specific files in the (default) editor'
+    array << '  /name_of_exams/                                          # regex '\
+             'search for an exam with that name'
+    array << '  --upcoming_exams_at_the_boku                             # show '\
+             'all upcoming exams at the BOKU. (This will also generate a .html page.)'
+    array << '  --upcoming-important-exams                               # show '\
+             'all upcoming exams in general. (This will also generate a .html page.)'
+    array << '  --examstats                                              # show '\
+             'the exam statistics, that is, how many exams you passed'
+    array << '  --use-this-colour-for-exam-questions=slateblue           # set '\
+             'to use this colour for exam-questions'
+    array << '  --use-this-colour-for-exam-answers=slateblue             # set '\
+             'to use this colour for exam-answers'
+    array << '  --set-delay=5                                            # set '\
+             'the delay between answering a question to n seconds, in this case 5'
+    array << '  --delay?                                                 # query '\
+             'the current delay in use'
+    array << '  --files?                                                 # show '\
+             'where some of the important files may be kept'
+    array << '  last-exams 15                                            # show '\
+             'the last 15 passed exams'
+    array << '  --update-max-questions                                   # update '\
+             'how many questions were asked'
+    e
+    # ======================================================================= #
+    # The above ^^^ can be added in any random order; the next line will
+    # sort this anyway.
+    # ======================================================================= #
+    array.sort.each {|entry| eparse entry }
+    e
+  end
+
+end; end

data/lib/studium/commandline/menu.rb

@@ -0,0 +1,366 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Studium
+
+class Commandline < Base
+
+  require 'studium/toplevel_methods/copy_lecture_information_file_to_default_location.rb'
+  require 'studium/toplevel_methods/handle_archive_of_the_exam_questions.rb'
+  require 'studium/toplevel_methods/misc.rb'
+  require 'studium/toplevel_methods/note_down_the_start_time_and_how_many_exams_have_been_already_solved.rb'
+  require 'studium/toplevel_methods/pristine.rb'
+  require 'studium/toplevel_methods/report_n_entries_in_the_file_lecture_information.rb'
+  require 'studium/toplevel_methods/sanitized_dataset_from_file_passed_exams_per_month.rb'
+  require 'studium/toplevel_methods/try_to_report_exams_that_match_to_this_regexp.rb'
+  # =========================================================================== #
+  # Pull in some .rb files that reside under studium/exams next:
+  # =========================================================================== #
+  require 'studium/exams/new_questions_per_year.rb'
+  require 'studium/exams/show_themes/show_themes.rb'
+  require 'studium/requires/require_upcoming_exams.rb'
+  # =========================================================================== #
+  # Commandline-related files will be required next.
+  # =========================================================================== #
+  require 'studium/check/check_the_lecture_information_file.rb'
+  require 'studium/commandline/misc.rb'
+  require 'studium/statistics/curriculum_comparer.rb'
+    require 'studium/ects/return_n_ects_from_this_file.rb'
+  # =========================================================================== #
+  # Next, pull in .rb files that reside under the uility_scripts/ directory.
+  # =========================================================================== #
+  require 'studium/utility_scripts/expand_time_range.rb'
+  require 'studium/utility_scripts/passed_ects_per_year.rb'
+  require 'studium/utility_scripts/show_lva_dates_of_this_lecture.rb'
+  require 'studium/utility_scripts/show_lectures_on_this_day.rb'
+  require 'studium/pdf/create_pdf_file_for_this_exam_topic.rb'
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = input?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === studium --delay?
+      # ===================================================================== #
+      when /^-?-?delay\?/ # Query the delay in use.
+        require 'studium/toplevel_methods/read_delay_between_questions_from_file.rb'
+        e 'The delay is '+lightgreen(Studium::Exams.read_delay_from_file.to_s)+
+          ' seconds between individual question-answer sessions.'
+      # ===================================================================== #
+      # === studium --upload_pdf
+      # ===================================================================== #
+      when /^-?-?upload(-|_)?pdf$/i
+        Studium.upload_pdf
+      # ===================================================================== #
+      # === studium --open-important-exams
+      # ===================================================================== #
+      when /^-?-?open(-|_)?important(-|_)?exams$/i,
+           /^-?-?important(-|_)?exams$/i,
+           /^-?-?important$/i,
+           /^-?-?priorities$/i,
+           /^-?-?priority$/i,
+           /^-?-?open(-|_)?important(-|_)?lectures$/i # === studium --open-important-lectures
+        opnn; e 'Now opening the '+slateblue('important-exams')+
+                ' file in the editor.' 
+        ::Studium.open_important_exams
+      # ===================================================================== #
+      # === studium --nsolved
+      # ===================================================================== #
+      when /^-?-?nsolved$/
+        require 'studium/toplevel_methods/report_how_many_exam_questions_were_already_solved.rb'
+        Studium::Exams.report_how_many_exam_questions_were_already_solved
+      # ===================================================================== #
+      # === studium --vim
+      # ===================================================================== #
+      when /^-?-?vim$/i
+        Studium.permanently_set_this_editor(:vim)
+      # ===================================================================== #
+      # === studium --editor?
+      # ===================================================================== #
+      when /^-?-?editor\??$/i
+        e sfancy(Studium.editor?) 
+      # ===================================================================== #
+      # === studium --passed-ects
+      # ===================================================================== #
+      when /^-?-?passed(_|-)?ects\??$/i,
+           /^-?-?overview$/i,
+           /^-?-?performance$/i # studium --performance
+        require 'studium/ects/show_passed_credits_per_curriculum.rb'
+        Studium.show_passed_credits_per_curriculum
+      # ===================================================================== #
+      # === studium --create_a_clean_lecture_information_file
+      # ===================================================================== #
+      when /^-?-?create(-|_)?a(-|_)?clean(-|_)?lecture(-|_)?information(-|_)?file$/i
+        Studium.create_a_clean_lecture_information_file
+        exit
+      # ===================================================================== #
+      # === studium --upload-exam-questions
+      # ===================================================================== #
+      when /-?-?upload(_|-)?exam(_|-)?questions/,
+           /-?-?upload(_|-)?exams/,
+           /-?-?uexams/
+        Studium.upload_exam_questions { :be_verbose }
+      # ===================================================================== #
+      # === studium --upload-archive-of-the-exam-questions
+      # ===================================================================== #
+      when /^-?-?upload(-|_| )?archive(-|_| )?of(-|_| )?the(-|_| )?exam(-|_| )?questions$/,
+           /^-?-?upload(-|_| )?exam(-|_| )?archive$/,
+           /^-?-?upload(-|_| )?exam(-|_| )?topics$/
+        Studium.upload_archive_of_the_exam_questions
+      # ===================================================================== #
+      # === studium --create-an-archive-of-the-exam-questions
+      # ===================================================================== #
+      when /^-?-?create(-|_| )?an(-|_| )?archive(-|_| )?of(-|_| )?the(-|_| )?exam(-|_| )?questions$/i,
+           /^-?-?create(-|_| )?exam(-|_| )?topics(-|_| )?archive$/i
+        Studium.create_an_archive_of_the_exam_questions
+      # ===================================================================== #
+      # === studium --compare
+      # ===================================================================== #
+      when /^-?-?compare$/
+        Studium::CurriculumComparer.new
+      # ===================================================================== #
+      # === studium --start
+      # ===================================================================== #
+      when /^-?-?start$/i
+        ::Studium.note_down_the_start_time_and_how_many_exams_have_been_already_solved
+      # ===================================================================== #
+      # === studium --end
+      # ===================================================================== #
+      when /^-?-?end$/i,
+           /^-?-?end(-|_)?difference$/i
+        ::Studium.report_the_difference_to_the_start_time
+      # ===================================================================== #
+      # === studium --download-exam-dataset
+      # ===================================================================== #
+      when /^-?-?download(_|-)?exam(_|-)?dataset$/i,
+           /^-?-?download(_|-)?dataset$/i
+        ::Studium.download_exam_dataset
+      # ===================================================================== #
+      # === studium --open-upcoming-exams
+      # ===================================================================== #
+      when /^-?-?open(-|_)?upcoming(-|_)?exams$/i,
+           /^-?-?open(-|_)?important$/i
+        Studium::Exams::UpcomingImportantExams.open_relevant_files
+      # ===================================================================== #
+      # === studium --upcoming-important-exams
+      # ===================================================================== #
+      when /-?-?upcoming(-|_)?important(-|_)?exams/,
+           /-?-?upcoming(-|_)?exams/
+        Studium::Exams::UpcomingImportantExams.new
+      # ===================================================================== #
+      # === studium --use-this-colour-for-exam-answers=slateblue
+      # ===================================================================== #
+      when /^-?-?use(-|_)?this(-|_)?colour(-|_)?for(-|_)?exam(-|_)?answers=(.+)/i,
+           /^-?-?use(-|_)?this(-|_)?colour(-|_)?for(-|_)?answers=(.+)/i,
+           /^-?-?colour(-|_)?for(-|_)?answers=(.+)/i
+        _ = $3
+        _ = $5 if $5
+        _ = $6 if $6
+        ::Studium::Colours.use_this_colour_for_exam_answers(_.to_s.dup)
+      # ===================================================================== #
+      # === studium --use-this-colour-for-exam-questions=slateblue
+      # ===================================================================== #
+      when /^-?-?use(-|_)?this(-|_)?colour(-|_)?for(-|_)?exam(-|_)?questions=(.+)/i,
+           /^-?-?use(-|_)?this(-|_)?colour(-|_)?for(-|_)?questions=(.+)/i,
+           /^-?-?colour(-|_)?for(-|_)?questions=(.+)/i
+        _ = $3
+        _ = $5 if $5
+        _ = $6 if $6
+        ::Studium::Colours.use_this_colour_for_exam_questions(_.to_s.dup)
+      # ===================================================================== #
+      # === studium --encoding=utf
+      # === studium --encoding=iso1
+      # ===================================================================== #
+      when /^-?-?encoding=(.+)$/i
+        ::Studium.use_this_new_encoding($1.to_s.dup)
+        exit
+      # ===================================================================== #
+      # === studium --collage?
+      # ===================================================================== #
+      when /-?-?collage\??$/
+        show_collage_of_current_exams
+        exit
+      # ===================================================================== #
+      # === studium --passed-exams?
+      # ===================================================================== #
+      when /^-?-?passed(-|_)?exams\??$/i,
+           /^-?-?all(-|_)?passed(-|_)?exams\??$/i,
+           /^-?-?return(-|_)?passed(-|_)?exams\??$/i
+        require 'studium/exams/passed_exams.rb'
+        ::Studium.show_passed_exams
+      # ===================================================================== #
+      # === studium --lectures_without_exam_entry
+      # ===================================================================== #
+      when /^-?-?lectures(_|-)?without(_|-)?exam(_|-)?entry$/i
+        require 'studium/exams/lectures_without_exam_entry.rb'
+        ::Studium::Exams::LecturesWithoutExamEntry.new
+      # ===================================================================== #
+      # === studium --add-a-new-question
+      # ===================================================================== #
+      when /^-?-?add(-|_)?a(-|_)?new(-|_)?question$/i
+        require 'studium/exams/add_exam_question.rb'
+        Studium::Exams::AddExamQuestion.new
+      # ===================================================================== #
+      # === studium --current-studyset?
+      # ===================================================================== #
+      when /^-?-?current(-|_)?studyset\??$/i
+        this_exam_topic = YAML.load_file(FILE_FOR_EXAM_QUESTIONS).strip
+        e 'The current exam-topic is `'+
+          sfile(File.basename(this_exam_topic))+'`.'
+      # ===================================================================== #
+      # === studium --merge
+      # ===================================================================== #
+      when /^-?-?merge$/i
+        Studium.copy_lecture_information_file_to_default_location
+      # ===================================================================== #
+      # === studium --lectures-on-this-day=05.05.2018
+      # ===================================================================== #
+      when /^-?-?lectures(_|-)?on(_|-)?this(_|-)?day(_|-)?=(.+)$/,
+           /^(\d{2}.\d{2}.\d{4})$/
+        require 'studium/curricula/determine_curricula/determine_curricula.rb'
+        first_match_to_the_regex = $1.to_s.dup
+        i = $5.to_s.dup
+        if first_match_to_the_regex =~ /^\d+/
+          i = first_match_to_the_regex
+        end
+        Studium.show_lectures_on_this_day(i)
+      # ===================================================================== #
+      # === studium --outdated
+      # ===================================================================== #
+      when /^-?-?outdated$/
+        require 'studium/utility_scripts/show_outdated_lva_dates.rb'
+        Studium.show_outdated_lva_dates
+      # ===================================================================== #
+      # === studium --pristine
+      # ===================================================================== #
+      when /^-?-?pristine$/,
+           /^-?-?new(_|-)?lecture(_|-)?information$/
+        Studium.pristine
+      # ===================================================================== #
+      # === studium --master=vektorx
+      # ===================================================================== #
+      when /^-?-?master(=|-)(.+)$/
+        require 'studium/lectures/show_lectures_on_the_commandline/show_lectures_on_the_commandline.rb'
+        this_curriculum = "master-#{$2.to_s.dup}"
+        Studium::ShowLecturesOnTheCommandline.new(this_curriculum)
+      # ===================================================================== #
+      # === studium --bachelor=vektorx
+      # ===================================================================== #
+      when /^-?-?bachelor(=|-)(.+)$/
+        require 'studium/lectures/show_lectures_on_the_commandline/show_lectures_on_the_commandline.rb'
+        this_curriculum = "bachelor-#{$2.to_s.dup}"
+        Studium::ShowLecturesOnTheCommandline.new(this_curriculum)
+      # ===================================================================== #
+      # === studium --show-lva-dates-of-this-lecture="Primatologie"
+      # ===================================================================== #
+      when /^-?-?show(_|-)?lva(_|-)?dates(_|-)?of(_|-)?this(_|-)?lecture=(.+)/i
+        this_theme = $6.to_s.dup.delete('"')
+        Studium.show_lva_dates_of_this_lecture(this_theme)
+      # ===================================================================== #
+      # === studium --passed-exams=chemistry
+      # ===================================================================== #
+      when /^-?-?passed(_|-)?exams=(.+)/i,
+           /^-?-?report(_|-)?passed(_|-)?exams(_|-)?fitting(_|-)?to(_|-)?this(_|-)?theme=(.+)/i
+        this_theme = $2.to_s.dup
+        this_theme = $7.to_s.dup if $7
+        Studium.report_passed_exams_fitting_to_this_theme(this_theme)
+      # ===================================================================== #
+      # === studium --questions-per-year
+      # ===================================================================== #
+      when /^-?-?questions(_|-)?per(_|-)?year$/
+        Studium.show_questions_per_year
+      # ===================================================================== #
+      # === studium --gui
+      # ===================================================================== #
+      when /^-?-?gui$/
+        start_gui_component
+      # ===================================================================== #
+      # === studium "--solved? 300143"
+      # === studium "--already_solved_this_id 300143"
+      # ===================================================================== #
+      when /-?-?solved\?? (\d+)/,
+           /-?-?already(_|-)?solved(_|-)?this(_|-)?id (\d+)/
+        the_lva_number = $1.to_s.dup
+        the_lva_number = $4.to_s.dup if $4
+        yes_or_no = Studium.yes_or_no(
+          Studium.already_solved_this_lva_number?(the_lva_number).to_s
+        )
+        e 'Did we solve this lecture (ID: '+simp(the_lva_number)+') yet? '+
+          sfancy(yes_or_no)
+      # ===================================================================== #
+      # === set_directory_to_the_exam_topics
+      #
+      # Usage example:
+      #
+      #   studium --set-directory-to-the-exam-topics=/Depot/j/EXAM_TOPICS/
+      #
+      # ===================================================================== #
+      when /set(_|-)?directory(_|-)?to(_|-)?the(_|-)?exam(_|-)?topics=(.+)/
+        match = $6.to_s.dup
+        verbose_set_this_dir_to_exam_topics(match)
+      # ===================================================================== #
+      # === set_dir
+      # ===================================================================== #
+      when /set(_|-)?dir=(.+)/
+        match = $2.to_s.dup
+        verbose_set_this_dir_to_exam_topics(match)
+      else # else tag
+        # =================================================================== #
+        # === Handle Pseudo-Regexes                               (regex tag)
+        #
+        # Handle pseudo-regexes next. These are strings that start
+        # and end with a '/' character.
+        # =================================================================== #
+        if i.start_with?('/') and i.end_with?('/')
+          e "A pseudo-regex was discovered (#{sfancy(i)}). We "\
+            "will next query for any"
+          e 'exam matching to that regex.'
+          e
+          use_this_regexp = Regexp.new(i.delete('/'), Regexp::IGNORECASE) # <- is case-insensitive.
+          Studium.try_to_report_exams_that_match_to_this_regexp(use_this_regexp) { :also_show_the_grade }
+        # =================================================================== #
+        # === Handle lecture types
+        #
+        # This entry point will handle input such as the following:
+        #   studium --VO
+        #   studium VO+SE
+        # =================================================================== #
+        elsif ARRAY_LECTURE_TYPES_THAT_ARE_MANDATORY_CONTINUOUS_ASSESSMENT.include?(i.delete('-')) or
+              (i.delete('-') == 'VO')
+          Studium.report_all_lectures_matching_this_lecture_type(i.delete('-'))
+        end
+      end
+    end
+  end; alias check_the_input_against_the_menu menu # === check_the_input_against_the_menu
+
+  # ========================================================================= #
+  # === check_the_original_input_against_the_menu
+  # ========================================================================= #
+  def check_the_original_input_against_the_menu(i)
+    case i
+    # ======================================================================= #
+    # === studium lastexams 10
+    # ======================================================================= #
+    when /-?-?last-?exams (\d+)/
+      _ = $1.to_s.dup.to_i
+      Studium.show_n_last_exams(_) # Show the last n exams that were passed.
+    end
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.show_questions_per_year
+# =========================================================================== #
+def self.show_questions_per_year
+  Studium::Exams::NewQuestionsPerYear.new
+end
+  
+end