studium 0.10.1

data/lib/studium/yaml/n_total_questions.yml

@@ -0,0 +1 @@
+40381

data/lib/studium/yaml/participating_in_these_courses.yml

@@ -0,0 +1,50 @@
+# =========================================================================== #
+# === participating_in_these_courses.yml
+#
+# This file can be used to denote in which courses you participate
+# in, at the least, the current semester.
+#
+# The format is simple, but strict: ONE lecture per line, and that
+# line must be EXACTLY as the name is specified in the file called
+# "lecture_information.yml". The reason why this is strict here is
+# so that we can write simpler code at a later point, so it is a
+# good idea to be strict early on. The class that reads the dataset
+# and presents it to the user will be more flexible anyway; just
+# the dataset must be kept under strict control.
+#
+# Note that for these specified entries, it is assumed that additional
+# information is available in the file called "lecture_information.yml",
+# in particular the "lva_dates:" entries, which tell us when the next
+# unit is scheduled. That way we can write a "calendar"-like 
+# application.
+#
+# It is recommended to keep this in '' Strings, to avoid unwanted
+# Hash-creations.
+#
+# It is also recommended to keep this sorted in a way to have the
+# more important courses in this semester appear on top.
+# =========================================================================== #
+
+# =========================================================================== #
+# At the BOKU:
+# =========================================================================== #
+- '790045 Interactions of the (innate) immune system and viruses (in Eng.)'
+- '752344 Structure and function of proteins (in Eng.)'
+- '790397 Protein engineering (in Eng.)'
+- '752339 Protein engineering (in Eng.)'
+- '790390 Molecular evolution and phylogenetics (in Eng.)' 
+- '790391 Efficient microarray data analysis using R and FSPMA (in Eng.)'
+- '802300 Biological nanosciences and nanotechnology (in Eng.)'
+- '790037 Characterisation of blood stem cells as starting cells for biotechnology (in Eng.)'
+- '790044 Sicherheit am Arbeitsplatz'
+- '790383 Bioinformatics: Selected aspects (in Eng.)'
+- '790390 Molecular evolution and phylogenetics (in Eng.)'
+# - '790389 Modern bioinformatics (in Eng.)'
+# - '773113 Organische Chemie für Lebensmittel- und Biotechnologen'
+# - '940301 Structure and analysis of genomes (in Eng.)'
+
+# =========================================================================== #
+# At the TU Vienna:
+# =========================================================================== #
+# - '183.579 Technische Grundlagen der Informatik'
+# - '163.185 Feuerlöschübung'

data/lib/studium/yaml/rename_konsole_tab.yml

@@ -0,0 +1 @@
+false

data/lib/studium/yaml/show_topic.yml

@@ -0,0 +1 @@
+false

data/lib/studium/yaml/statistics.yml

@@ -0,0 +1,57 @@
+# =========================================================================== #
+# Diese Datei sammelt Daten über die Zahl der Prüfungsfragen und wieviele
+# davon bereits beantwortet wurden. Dies ist für die meisten anderen
+# Anwender relativ irrelevant, daher wird dies auch in der deutschen
+# Sprache festgehalten.
+# =========================================================================== #
+# Am 25.01.2017 wurde erstmals die 500.0 ECTS Punkte Marke gekratzt.
+# =========================================================================== #
+
+# =========================================================================== #
+# Am 01.02.2012 waren es  3.200 Fragen.
+#
+# Am 22.01.2013 waren es  5.989 Fragen, also fast doppelt so viele wie 2012. 
+# Am 01.08.2013 waren es  8.504 Fragen.
+# Am 16.10.2013 waren es  9.440 Fragen.
+# Am 30.11.2013 waren es 10.123 Fragen.
+# Am 14.12.2013 waren es 10.445 Fragen - davon waren  2746 beantwortet (26.29%) [128.5 ECTS]
+#
+# Am 09.02.2014 waren es 11.105 Fragen - davon waren  2899 beantwortet (26.11%)
+# Am 18.03.2014 waren es 11.807 Fragen - davon waren  3288 beantwortet (27.85%)
+# Am 26.04.2014 waren es 12.017 Fragen - davon waren  3671 beantwortet (30.55%)
+#
+# Am 31.05.2014 waren es 12.552 Fragen - davon waren  3695 beantwortet (29.44%)
+# Am 30.08.2014 waren es 13.634 Fragen - davon waren  4051 beantwortet (29.71%)
+# Am 27.11.2014 waren es 14.877 Fragen - davon waren  4431 beantwortet (29.78%)
+# Am 31.12.2014 waren es 15.484 Fragen - davon waren  4846 beantwortet (31.30%) [229.5 ECTS]
+#
+# Am 24.09.2015 waren es 17.507 Fragen - davon waren  5087 beantwortet (29.06%)
+# Am 31.10.2015 waren es 18.214 Fragen - davon waren  5250 beantwortet (28.82%)
+# Am 29.12.2015 waren es 18.903 Fragen - davon waren  5500 beantwortet (29.10%) [351.0 ECTS]
+#
+# Am 08.04.2016 waren es 19.569 Fragen - davon waren  5750 beantwortet (29.38%)
+# Am 25.04.2016 waren es 19.695 Fragen - davon waren  6000 beantwortet (30.46%)
+# Am 31.05.2016 waren es 20.000 Fragen - davon waren  6250 beantwortet (31.20%)
+# Am 13.07.2016 waren es 20.480 Fragen - davon waren  6500 beantwortet (31.74%)
+# Am 19.08.2016 waren es 20.882 Fragen - davon waren  7000 beantwortet (33.52%)
+# Am 20.10.2016 waren es 21.673 Fragen - davon waren  7250 beantwortet (33.45%)
+# Am 22.11.2016 waren es 22.054 Fragen - davon waren  7500 beantwortet (34.01%)
+# Am 01.12.2016 waren es 22.150 Fragen - davon waren  7750 beantwortet (34.99%)
+# Am 25.12.2016 waren es 22.572 Fragen - davon waren  8000 beantwortet (35.44%) [472.5 ECTS]
+#
+# Am 30.01.2017 waren es 23.054 Fragen - davon waren  8250 beantwortet (35.79%)
+# Am 12.02.2017 waren es 23.259 Fragen - davon waren  8500 beantwortet (36.54%)
+# Am 18.03.2017 waren es 23.628 Fragen - davon waren  8750 beantwortet (37.03%)
+# Am 21.09.2017 waren es 25.079 Fragen - davon waren  9000 beantwortet (35.89%) [566.0 ECTS]
+#
+# Am 04.09.2018 waren es 28.692 Fragen - davon waren  9250 beantwortet (32.24%)
+# Am 21.09.2018 waren es 28.975 Fragen - davon waren  8683 beantwortet (29.97%)
+# Am 11.12.2018 waren es 30.517 Fragen - davon waren  9500 beantwortet (31.13%) [677.5 ECTS]
+#
+# Am 07.04.2019 waren es 33.305 Fragen - davon waren  9750 beantwortet (29.27%)
+# Am 16.04.2019 waren es 33.607 Fragen - davon waren 10000 beantwortet (29.76%)
+# Am 16.07.2019 waren es 35.004 Fragen - davon waren 10218 beantwortet (29.19%)
+#
+# Am 02.02.2020 waren es 38.345 Fragen - davon waren 10750 beantwortet (28.03%) [778.5 ECTS]
+# Am 28.06.2020 waren es 40.052 Fragen - davon waren  5000 beantwortet (12.48%) [807.0 ECTS]
+# =========================================================================== #

data/lib/studium/yaml/use_colours.yml

@@ -0,0 +1 @@
+true

data/studium.gemspec

@@ -0,0 +1,79 @@
+# =========================================================================== #
+# Gemspec for Project Studium.
+# =========================================================================== #
+require 'studium/version/version.rb'
+require 'studium/toplevel_methods/n_questions_available.rb'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'studium'
+  s.version = ::Studium::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+
+  DESCRIPTION = <<-EOF
+
+This project is called "studium", which is the german word for 
+"studies".
+
+The project attempts to be of help in study-related and 
+exam-related aspects, in particular for universities in
+central europe - although with a focus on the german-speaking
+areas, primarily; courses in english are available as well,
+but the focus is still on central europe at best, not
+elsewhere, out of necessity and proxomity reasons alone.
+
+An additional use case is to simply train your knowledge
+about different topics, independent of any university or
+high school.
+
+The studium-project presently contains
+#{Studium.n_questions_in_total?} question-answer entries.
+
+For additional documentation, please consider visiting the
+the following link directly:
+
+https://www.rubydoc.info/gems/studium/
+
+EOF
+
+  s.summary     = DESCRIPTION
+  s.description = DESCRIPTION
+
+  # ========================================================================= #
+  # Show this message when a user installs this project.
+  # ========================================================================= #
+  s.post_install_message = <<-EOF
+
+For a more complete documentation, look at the following URL:
+
+  #{Studium::URL_TO_THE_DOCUMENTATION}
+
+Thank you and may ruby be to your benefit.
+
+  EOF
+  
+  s.extra_rdoc_files = %w()
+
+  s.authors     = ['Robert A. Heiler']
+  s.email       = 'shevegen@gmail.com'
+  s.files       = Dir['**/*']
+  s.license     = 'GPL-2.0'
+  s.executables = Dir['bin/*'].map { |f| File.basename(f) }
+  s.homepage    = 'http://www.rubydoc.info/gems/studium/'
+
+  s.required_ruby_version     = '>= '+RUBY_VERSION
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  # ========================================================================= #
+  # External dependencies for the project:
+  # ========================================================================= #
+  s.add_dependency 'cliner'
+  s.add_dependency 'colours'
+  s.add_dependency 'find_line_in_file'
+  s.add_dependency 'html_tags'
+  s.add_dependency 'opn'
+  s.add_dependency 'prawn'
+  s.add_dependency 'xorg_buffer'
+
+}

data/test/testing_studium.rb

@@ -0,0 +1,244 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'cliner'
+require 'colours/colours_e_autoinclude.rb'
+require 'studium' # Do "include Studium" automatically.
+require 'verbose_truth/autoinclude'
+
+# =========================================================================== #
+# === crimson
+# =========================================================================== #
+def crimson(i)
+  ::Colours.crimson(i)
+end
+
+e 'Welcome to the Studium project.'
+e
+e 'Next, we will run some tests to ensure that the desired functionality'
+e 'is working.'
+e
+e 'We will start with two important constants:'
+e
+e orange('  Studium::PROJECT_BASE_DIRECTORY')
+e
+e 'The value for Studium::PROJECT_BASE_DIRECTORY is:'
+e
+e '  '+sfancy(Studium::PROJECT_BASE_DIRECTORY)
+e
+e orange('Studium::Exams::PROJECT_BASE_DIRECTORY')
+e
+e 'The value for Studium::Exams::PROJECT_BASE_DIRECTORY is:'
+e
+e '  '+sfancy(Studium::Exams::PROJECT_BASE_DIRECTORY)
+e
+cliner
+e
+e 'Next, we will test the value of '+sfancy('Studium::PROJECT_YAML_DIRECTORY')+':'
+e
+e orange('  '+Studium::PROJECT_YAML_DIRECTORY)
+e
+cliner
+e 'So far, so good!'
+e
+e 'Does the Studium project try to make use of colours?'
+e
+e sfancy("  #{VerboseTruth[Studium.use_colours?]}")
+e
+cliner
+e 'Next, we will test some module-methods on the '+
+   slateblue('Studium namespace')+'.'
+e
+cliner
+e 'The log directory is this one here:'+
+  sdir('  '+Studium.determine_log_directory)
+e
+cliner
+e 'How many ECTS points were passed? We can answer this with '\
+  'the method called '+orange('Studium.total_ects_points_passed')
+e
+e '  '+sfancy(Studium.total_ects_points_passed.to_s)+' ECTS points were passed so far.'
+cliner
+e 'The next component that will be tested is the "available exam topics".'
+e 'As this may output a very long list, we will show only 6 exam '\
+  'topics rather than many more.'
+# =========================================================================== #
+# Display the available topics.
+# =========================================================================== #
+cliner {
+  e ::Colours.royalblue('The available exam-topics are '\
+    '(showing only 6):')
+  Studium.display_available_topics(6)
+}
+e
+e 'We also have completed some exams. We will next display the 3 most'
+e 'recent exams that were passed.'
+e
+Studium.names_of_all_solved_exams(3).each {|exam| e '  '+sfancy(exam) }
+e
+e 'Alright! Next we will test the functionality of '+
+  orange('Studium.is_this_exam_topic_included?')+'.'
+e
+e 'Is the exam topic `amg` included? '+sfancy(
+  VerboseTruth[Studium.is_this_exam_topic_included?('amg')]
+)
+e
+e 'How many exam topics are available in total? '+
+  sfancy(Studium.n_exam_topics_available?.to_s)
+e
+e 'And how many questions are available? '+
+  sancy(Studium::Exams::Dataset[].size.to_s)
+e
+e 'The version of Studium is:'
+e '  '+crimson(Studium::VERSION.to_s)
+e
+e 'Next, we will test the functionality of `'+
+  orange('Studium.already_solved_this_lva_number?')+'` (LV-ID: 300211).'
+e
+e Studium.already_solved_this_lva_number? '300211'
+e
+e 'Next we will test the method '+orange('Studium.report_how_many_exam_questions_were_already_solved')+'.'
+e
+Studium.report_how_many_exam_questions_were_already_solved
+e
+# =========================================================================== #
+# Next querying how many exam questions were already solved.
+# =========================================================================== #
+cliner {
+  e 'Next querying how many exam questions were already solved:'
+  Studium::Exams.report_how_many_exam_questions_were_already_solved(
+    :default, :gui
+  )
+}
+e
+
+# =========================================================================== #
+# First, instantiate the main dataset.
+# =========================================================================== #
+dataset = Studium::Exams::Dataset[]
+
+# =========================================================================== #
+# Text question-answer parsing so that we can detect bugs more rapidly.
+# =========================================================================== #
+e 'Next testing question-answer parsing:'
+_ = '- Give an extreme example of introns in eukaryotic genes. A: The "pro-alpha-2 collagen" gene; it contains 50 introns. URL: http://www.ncbi.nlm.nih.gov/UniGene/clust.cgi?UGID=704301&TAXID=9606&SEARCH=pro-alpha-2%20collagen'
+pp Exams.question_answer(_)
+
+_ = '- F-Faktor hat n states? Beschreibe sie?. A: Der F-Fakter hat zwei states: den \"Plasmid state\" und den "Integrated state".'
+pp Exams.question_answer(_)
+
+_ = '- In genetics, what do we mean with "5-BrU"? 5-Bromouracil. URL: http://en.wikipedia.org/wiki/5-Bromouracil'
+pp Exams.question_answer(_)
+
+_ = '- Nenne 3 bekannte Vertreter der S��gr�ser (Poaceae). A: Alle Getreide wie "Weizen", "Gerste" und "Reis" z�hlen zu dieser Pflanzengruppe.'
+pp Exams.question_answer(_)
+
+_ = '- Def. Opine! A: Dies sind Kondensationsprodukte aus einer "Aminos�ure" und einer "Ketos�ure", oder einer "Aminos�ure" und einem "Zucker". Mit anderen Worten, die Aminos�ure ist immer ein Bestandteil eines Opin; der andere Bestandteil ist entweder eine Ketos�ure oder ein Zucker.'
+pp Exams.question_answer(_)
+
+#exit # Debug-exiting here for now.
+cliner
+pp dataset.class
+pp dataset
+
+p Exams.clinicalmicrobiology
+e crimson('This Array has '+Exams.clinicalmicrobiology.size.to_s+' entries.')
+p Exams.technische_chemie
+e crimson('This Array has '+Exams.technische_chemie.size.to_s+' entries.')
+e
+e 'We will next find out the encoding of the first element there:'
+e '  '+crimson(Exams.clinicalmicrobiology.first.encoding.to_s)
+e
+e 'Self-Encoding is:'
+e '  '+crimson(__ENCODING__.to_s)
+e
+# =========================================================================== #
+# Testing the runmodes:
+# =========================================================================== #
+cliner {
+  e ::Colours.slateblue('Testing Exams.runmode?'); e
+  e '  '+crimson(Exams.runmode?)
+  Exams.set_runmode :www
+  e '  '+crimson(Exams.runmode?)
+}; e
+# =========================================================================== #
+# Testing the current exams next:
+# =========================================================================== #
+cliner {
+  e ::Colours.slateblue('The current exams are:'); e
+  pp Exams.current_exams
+}; e
+cliner {
+  e 'Next showing all available topics:'
+  pp Exams.all_topics
+  e 'The encoding of entry [3] is: '+crimson(Exams.all_topics[3].encoding.to_s)
+}
+# =========================================================================== #
+# Testing Studium::Exams::SanitizeTopics next:
+# =========================================================================== #
+cliner {
+  e ::Colours.slateblue('We will next test Exams::SanitizeTopics:'); e
+  pp Studium::Exams::SanitizeTopics['amg1'] # The first entry will be the title, the second one the dataset.
+  e Studium::Exams::SanitizeTopics.sanitize_topic('amg2').first # Grab the title here.
+  e 'We also test whether SanitizeTopics can output something directly via SanitizeTopics.e'
+  Studium::Exams::SanitizeTopics.e 'Hello World!'
+}; e
+# =========================================================================== #
+# Testing whether we include several topics:
+# =========================================================================== #
+cliner {
+  e ::Colours.slateblue('We will next test whether we have '+
+    'several topics, via Exams.include_topic?'); e
+  e 'amg1 included?  '+vt(Studium::Exams.include_topic? 'amg1')
+  e 'cell included?  '+vt(Studium::Exams.include_topic? 'cell')
+  e 'amg2 included?  '+vt(Studium::Exams.include_topic? 'amg2')
+  e 'bech2 included? '+vt(Studium::Exams.include_topic? 'bech2')
+}; e
+pp SanitizedDataset.new 'invalid'
+pp SanitizedDataset.new 'amg1'
+pp SanitizedDataset.new('amg2').debug
+sanitized_dataset = SanitizedDataset.new('agrar�kologie')
+pp sanitized_dataset.n_questions?
+# We don't test AskExamQuestion here for now.
+# ask_question = Exams::AskExamQuestion.new 'agrar�ko'
+# pp ask_question
+# =========================================================================== #
+# We next test ExamQuestionsLine.
+# =========================================================================== #
+cliner {
+  e ::Colours.slateblue('Next testing Exams::ExamQuestionsLine'); e
+  _ = Exams::ExamQuestionsLine.new(:dont_run_yet)
+  _.run
+  _.report
+  e
+  e 'The last question asked was: '+crimson(_.last_question_asked)
+  e
+}; e
+# =========================================================================== #
+# Next testing Exams.include_topic?
+# =========================================================================== #
+cliner {
+  e 'Next testing '+::Colours.royalblue('.include_topic?')+' functionality:'
+  e 'Include `amg`?  '+crimson(vt(Studium::Exams.include_topic? :amg))    # Must give us back: "true"
+  e 'Include `test`? '+crimson(vt(Studium::Exams.include_topic? :test))   # Must give us back: "false"
+  e 'Include `genex`? '+crimson(vt(Studium::Exams.include_topic? :genex)) # Must give us back: "true"
+}; e
+# Next testing whether the disabling of colours works.
+Studium::Exams::AskExamQuestion.new
+cliner {
+  e 'Next, we will test whether disabling of colours actually works or not.'
+  Studium.disable_colours
+}; e
+Studium::Exams::AskExamQuestion.new
+
+dataset = Studium::Exams::Dataset[]
+pp dataset
+p Studium::Exams.clinicalmicrobiology # CLINICAL_MICROBIOLOGY 
+p Studium::Exams.test_question_answer '- Name a way to deal with complex pedigrees in population genetics. A: By making use of the "tabular method".'
+cliner
+# Display the directory to the exam-topics next:
+e 'The directory to the exam topics is at:'
+e
+e "  #{sfancy(Studium.exam_topics?)}"
+e

data/test/testing_time_component.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'studium'
+require 'cliner'
+require 'colours/colours_e_autoinclude.rb'
+e
+e 'Now testing the time-component (time-related functionality) of the'
+e sfancy('studium')+' project.'
+e
+
+test_this_time = '2020-11-30 15:00:00 -2000'
+cliner
+e test_this_time
+cliner
+
+string_as_result = Studium.return_dd_mm_yyyy(
+  Time.parse(
+    test_this_time
+  )
+)
+e string_as_result
+cliner
+parsed_time = Time.parse(string_as_result)
+pp parsed_time
+cliner
+pp Studium.normalize_time(parsed_time)
+cliner