studium 0.18.7

data/lib/studium/www/next_generation_exam_question_trainer/next_generation_exam_question_trainer.cgi

@@ -0,0 +1,112 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This has been written from scratch after the other solutions were not
+# working at all whatsoever.
+# =========================================================================== #
+# http://localhost/programming/ruby/src/studium/lib/studium/www/next_generation_exam_question_trainer/next_generation_exam_question_trainer.cgi
+# =========================================================================== #
+require 'cyberweb/autoinclude'
+require 'studium'
+
+english('Next generation exam question trainer') {
+created_on '02.10.2022' # Sunday.
+autoextend
+ruby_favicon
+default_template '
+
+.drop_down_reveal_effect {
+  padding: 30px;
+  display: flex;
+  justify-content: left;
+}
+
+details {
+  width: 100%;
+  max-width: 1200px;
+  border: 3px solid darkgreen;
+  border-radius: 6px;
+}
+
+summary {
+  background: #f2f2f2;
+  cursor: pointer;
+  padding: 15px;
+}
+
+p {
+  padding: 15px;
+  margin: 0;
+  background: #f2f2f2;
+}
+p.answer_paragraph {
+  padding-left:  1.5em;
+  padding-right: 1em;
+  font-weight: bold;
+  color: darkblue;
+}
+'
+body_css_class 'mar0px s2px padt2px VERDANAs'
+body_css_style 'background-color: #d3d2d1;'
+default_font_size_and_hyperlinks
+
+Studium.use_www_mode_and_disable_colours
+
+doc_smaller_width('mar0px pad0px s0_6em') {
+  h1 sg(:monkey, 'bblack0 marr12px','drag_monkey')+
+     'Next generation exam question trainer',
+     'mart1px marb0_5em'
+  the_param = web_param?
+  if the_param.empty?
+    use_this_as_exam_topic = ::Studium.return_random_exam_topic
+  else
+    use_this_as_exam_topic = the_param.keys.first.to_s
+  end
+  h2 'Exam topic: '+
+     use_this_as_exam_topic
+  fancy_separator(:left, 'center')
+
+  array_question_answer_and_the_whole_exam_line = Studium.return_question_answer_and_the_whole_exam_line_as_array(
+    use_this_as_exam_topic.downcase
+  )
+  # ========================================================================= #
+  # Designate exam-question and exam-answer next:
+  # ========================================================================= #
+  question            = array_question_answer_and_the_whole_exam_line.first.to_s
+  answer              = array_question_answer_and_the_whole_exam_line[1].to_s
+  the_whole_exam_line = array_question_answer_and_the_whole_exam_line.last.to_s
+  into = Studium.file_last_question_asked?
+  write_what_into(the_whole_exam_line, into)
+  if answer.include?('URL: ')
+    regex_to_use = /URL: (http.+)/
+    answer.sub!(/#{regex_to_use}/,'<a href="\1">\1</a>')
+  end
+  div('drop_down_reveal_effect') {
+    ee return_details {
+      HtmlTags.summary(question)+
+      HtmlTags.p(answer, 'answer_paragraph')
+    }
+  }
+  #button 'Solved', id: 'solved_button, onclick: 'location.href="solved.cgi"
+  ee '<button class="bblack2 pad5px marl5em" onclick="location.href=\'solved.cgi\';" id="solved_button">Solved</button>'
+  # ========================================================================= #
+  # Add the "Refresh the page" button.
+  # ========================================================================= #
+  button {{
+    text:      'Refresh this page',
+    id:        'refresh_this_page',
+    css_class: 'bblack2 pad5px marl1em',
+    on_click:  :reload_this_page
+  }}
+  ejavascript "
+
+  refresh_this_page.addEventListener('click', function change_the_refresh_button() {
+
+    const button = document.getElementById('refresh_this_page');
+          button.style.backgroundColor= 'gold';
+  }
+  )
+  "
+  
+}}

data/lib/studium/www/next_generation_exam_question_trainer/solved.cgi

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# http://localhost/programming/ruby/src/studium/lib/studium/www/next_generation_exam_question_trainer/solved.cgi
+# =========================================================================== #
+require 'cyberweb/autoinclude'
+require 'studium/exams/solved/solved.rb'
+require 'studium/toplevel_methods/runmode.rb'
+
+english('Solved') {
+created_on '21.06.2023' # Wednesday
+autoextend
+ruby_favicon
+default_template ''
+body_css_class 'mar0px s2px padt2px VERDANAs'
+body_css_style 'background-color: #d3d2d1;'
+default_font_size_and_hyperlinks
+
+Studium.use_www_mode_and_disable_colours
+
+doc_smaller_width('mar0px pad0px s0_6em') {
+  e 'Solving the last exam question now.'
+  Studium::Exams::Solved.new
+  aself 'next_generation_exam_question_trainer.cgi'
+}}

data/lib/studium/www/sinatra/app.rb

@@ -0,0 +1,231 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Sinatra
+# =========================================================================== #
+# require 'studium/sinatra/app.rb'
+# Studium.start_sinatra_interface
+# =========================================================================== #
+require 'studium'
+require 'studium/www/sinatra/misc.rb'
+
+begin
+  require 'cyberweb/requires/require_sinatra.rb'
+rescue LoadError; end
+
+Studium.use_www_mode_and_disable_colours
+
+module Studium
+
+class Sinatra < ::Cyberweb::Sinatra
+
+  begin
+    require 'beautiful_url'
+  rescue LoadError
+  end
+
+  require 'studium/exams/exam_question/exam_question.rb'
+
+  before {
+    content_type(:html, 'charset' => Studium.encoding?)
+  }
+
+  # ========================================================================= #
+  # === USE_THIS_UNIFORM_CSS_STYLE
+  # ========================================================================= #
+  USE_THIS_UNIFORM_CSS_STYLE = 'margin-left:3.5em; font-weight: bold;'
+
+  # ========================================================================= #
+  # === ANSWER_DIV
+  # ========================================================================= #
+  CSS_FOR_THE_WEBPAGE = '
+.answer_div
+{
+  color:            gold;
+  background-color: black;
+  padding:          0.6em;
+  border:           2px solid black;
+}
+
+a:link {
+  padding: 1px;
+  background-color: white;
+  color: black;
+  border: 1px solid black;
+  text-decoration: none;
+}
+
+a:visited {
+  padding: 1px;
+  background-color: white;
+  border: 1px solid black;
+  text-decoration: none;
+}
+
+a:hover {
+  padding: 1px;
+  color: hotpink;
+  background-color: white;
+  text-decoration: none;
+  border: 1px solid black;
+}
+
+a:active {
+  padding: 1px;
+  background-color: white;
+  border: 1px solid black;
+}
+
+.hide {
+  display: none;
+}
+
+'
+JAVASCRIPT_CODE = "
+<script>
+
+function delay_before_reveal() {
+  setTimeout(function(){
+   document.getElementById('id_footer').classList.remove('hide');
+   }, 100);
+}
+
+</script>
+
+"
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize
+    super()
+    reset
+
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    @root_string = p('You can also ask exam questions.')
+    # ======================================================================= #
+    # Create the hyperlinks-section next:
+    # ======================================================================= #
+    create_index_of_hyperlinks
+  end
+
+  # ========================================================================= #
+  # === sorted_exam_topics?
+  # ========================================================================= #
+  def sorted_exam_topics?
+    Studium.available_exam_topics?.sort
+  end
+
+  # ========================================================================= #
+  # === return_paragraph_of_hyperlinks
+  # ========================================================================= #
+  def return_paragraph_of_hyperlinks
+    p(
+      'These options are available for the Studium-sinatra '\
+      'interface: <br><br>'+
+      return_index_of_hyperlinks
+    )
+  end; alias footer return_paragraph_of_hyperlinks # === footer (footer tag)
+
+  # ========================================================================= #
+  # === return_view_string
+  # ========================================================================= #
+  def return_view_string
+    h1('Studium', css_style: 'margin-left:0.25em;')+
+    p(
+      "The <b>following entry points</b> are currently available."
+    )+
+    return_index_of_hyperlinks
+  end; alias return_root_string return_view_string # === return_root_string
+
+  # ========================================================================= #
+  # === not_found
+  # ========================================================================= #
+  not_found {
+    p('This particular <b>API</b> was not found.')+
+    p('You may try any of the following variants instead:')+
+    return_index_of_hyperlinks
+  }
+
+  # ========================================================================= #
+  # === view
+  #
+  # http://localhost:4567/view
+  # ========================================================================= #
+  get('/view') { # view tag
+    return_view_string
+  }
+
+  # ========================================================================= #
+  # === return_html_code_for_this_exam_topic
+  # ========================================================================= #
+  def return_html_code_for_this_exam_topic(this_topic)
+    css_style = '<head><style>'+CSS_FOR_THE_WEBPAGE+'</style><title>'+
+                this_topic.to_s+
+                '</title></head>'
+    result = Studium.return_question_answer_string_from_this_topic(this_topic).to_s
+    result = ::Studium.question_answer(result)
+    question = result.first
+    answer   = result.last
+    HtmlTags.html(
+      css_style+
+      HtmlTags.h2(
+        question
+      )+
+      # ===================================================================== #
+      # The <div> tag containing the answer.
+      # ===================================================================== #
+      HtmlTags.div(
+        answer,'answer_div hide', 'id_footer'
+      )+
+      JAVASCRIPT_CODE+
+      return_show_the_answer_button+
+      '<a style="border:1px solid black; margin-left:4px" href=""><b>Reload</b></a>'\
+      '<br><br>'+
+      return_link_to_the_root_entry+
+      '<br>'
+    )
+  end
+
+  # ========================================================================= #
+  # === return_show_the_answer_button
+  # ========================================================================= #
+  def return_show_the_answer_button
+    '<button style="border:1px solid black" accesskey="s" onclick="delay_before_reveal()">
+     <b>Show the answer</b></button>'
+  end
+
+  # ========================================================================= #
+  # === return_link_to_the_root_entry                              (home tag)
+  # ========================================================================= #
+  def return_link_to_the_root_entry
+    a(
+      '/',
+      content: '[HOME]',
+      css_style: 'colour: darkblue; margin-left: 2em; '\
+                 'font-weight: bold; font-size: larger'
+    )
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.start_sinatra_interface
+#
+# This method can be used to start the sinatra interface.
+# =========================================================================== #
+def self.start_sinatra_interface
+  ::Studium::Sinatra.run!
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium.start_sinatra_interface
+end # studium --sinatra

data/lib/studium/www/sinatra/curriculum_displayer/curriculum_displayer.rb

@@ -0,0 +1,162 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::CurriculumDisplayer
+#
+# This sinatra-based class is able to display
+# =========================================================================== #
+require 'html_tags'
+require 'sinatra'
+require 'studium'
+
+module Studium
+
+class CurriculumDisplayer < Sinatra::Base # === Studium::CurriculumDisplayer
+
+  require 'colours'
+  include Colours
+  include HtmlTags::BaseModule
+  require 'studium/toplevel_methods/toplevel_methods.rb'
+
+  alias e puts
+
+  # ========================================================================= #
+  # === USE_THIS_PORT
+  # ========================================================================= #
+  USE_THIS_PORT = '4575'
+
+  set :port, USE_THIS_PORT
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize
+    super()
+    reset
+    if HtmlTags::BaseModule.is_on_roebe?
+      require 'open'
+      # ===================================================================== #
+      # Tell us which port will be used:
+      # ===================================================================== #
+      target = "http://localhost:#{USE_THIS_PORT}/"
+      e sfancy(target)
+      Thread.new {
+        Open.in_browser(target) {{ delay: '1.0 seconds' }}
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === / Entry point
+  #
+  # This is the root of our web-application.
+  # ========================================================================= #
+  get('/') {
+    return_root_string
+  }
+
+  # ========================================================================= #
+  # === return_root_string
+  # ========================================================================= #
+  def return_root_string
+    '<html>'+
+    '<title>Displaying a curriculum</title>'+
+    '<body>'+
+    show_the_available_links+
+    '</body>'+
+    '</html>'
+  end
+
+  # ========================================================================= #
+  # === show_the_available_links
+  # ========================================================================= #
+  def show_the_available_links
+    available_curricula = return_available_curricula
+    p('Click on any of the following links to view the curriculum
+    that you wish to see.')+
+    available_curricula
+  end
+
+  # ========================================================================= #
+  # === /*                                        (all arguments, all params)
+  #
+  # This entry point is the main powerhorse for this class.
+  # ========================================================================= #
+  get('/*') {
+    arguments = params[:splat] # <- This is an Array.
+    joined_arguments = arguments.join
+    dataset_to_this_curriculum = Studium.return_this_curriculum_as_a_string(joined_arguments)
+    html_start+
+    dataset_to_this_curriculum+
+    br+
+    show_the_available_links+
+    html_end
+  }
+
+  # ========================================================================= #
+  # === html_start
+  # ========================================================================= #
+  def html_start
+    '<html><head></head><body>'
+  end
+
+  # ========================================================================= #
+  # === html_end
+  # ========================================================================= #
+  def html_end
+    '</body></html>'
+  end
+
+  # ========================================================================= #
+  # === return_available_curricula
+  # ========================================================================= #
+  def return_available_curricula
+    array = Studium.available_curricula?.map {|entry|
+      entry = entry.to_s
+      if entry.include? '_'
+        entry.tr!('_',' ')
+      end
+      entry[0,1] = entry[0,1].upcase
+      entry
+    }
+    string = ''.dup
+    array.each {|entry|
+      # ===================================================================== #
+      # Use the <a> tag next:
+      # ===================================================================== #
+      string << HtmlTags.a(entry, content: entry, css_style: 'padding-left:2em')+
+                HtmlTags.br+
+                "\n"
+    }
+    string
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+  end
+
+end
+
+# =========================================================================== #
+# === Studium.start_sinatra_interface
+#
+# This method can be used to start the sinatra interface.
+# =========================================================================== #
+def self.start_sinatra_interface
+  ::Studium::CurriculumDisplayer.run!
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium.start_sinatra_interface
+end

data/lib/studium/www/sinatra/misc.rb

@@ -0,0 +1,115 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'studium/sinatra/misc.rb'
+# =========================================================================== #
+module Studium
+
+begin
+  require 'cyberweb/requires/require_sinatra.rb'
+rescue LoadError; end
+
+class Sinatra < ::Cyberweb::Sinatra
+
+  require 'studium/curricula/curriculum_as_string.rb'
+  require 'studium/exams/questions_solved_from_day_to_day/questions_solved_from_day_to_day.rb'
+
+  # ========================================================================= #
+  # === /n_ects_points_passed
+  #
+  # Determine how many ECTS points were passed so far.
+  # ========================================================================= #
+  get('/n_ects_points_passed'){
+    title('n ECTS points were passed')+
+    p(
+      "<b>#{Studium.n_ects_points_were_passed?}</b>"
+    )
+  }
+
+  # ========================================================================= #
+  # === http://localhost:4567/questions_solved_from_day_to_day
+  # ========================================================================= #
+  get('/questions_solved_from_day_to_day') {|this_topic|
+    title('questions solved from day to day')+
+    Studium::Exams::QuestionsSolvedFromDayToDay.return_maximum_amount_of_questions_ever_answered.to_s
+  }
+
+  # ========================================================================= #
+  # === create_index_of_hyperlinks
+  #
+  # Create our index of hyperlinks next.
+  # ========================================================================= #
+  def create_index_of_hyperlinks
+    @index_of_hyperlinks = a(
+      '/n_ects_points_passed',
+      css_style: USE_THIS_UNIFORM_CSS_STYLE
+    )+
+    '<br>'+
+    a(
+      '/curricula',
+      css_style: USE_THIS_UNIFORM_CSS_STYLE
+    )+
+    '<br>'.dup
+    # ======================================================================= #
+    # Keep the exam-topics sorted.
+    # ======================================================================= #
+    sorted_exam_topics?.each {|this_topic|
+      @index_of_hyperlinks << a('/'+this_topic, css_style: USE_THIS_UNIFORM_CSS_STYLE)+
+      '<br>'.dup
+    }
+    @index_of_hyperlinks << a('/questions_solved_from_day_to_day', css_style: USE_THIS_UNIFORM_CSS_STYLE)
+  end
+
+  # ========================================================================= #
+  # === http://localhost:4567/amg1
+  #
+  # This will ask an exam question.
+  #
+  # http://localhost:4567/genex
+  # ========================================================================= #
+  get('/:this_exam_topic') {|this_topic|
+    this_topic = this_topic.downcase.tr(' ','_')
+    return_html_code_for_this_exam_topic(this_topic)
+  }
+
+  # ========================================================================= #
+  # === title
+  # ========================================================================= #
+  def title(i)
+    HtmlTags.title(i)
+  end
+
+  # ========================================================================= #
+  # === /curricula
+  # ========================================================================= #
+  get('/curricula'){
+    p(
+      'Click on the curriculum that ought to be displayed next.'
+    )
+  }
+
+  # ========================================================================= #
+  # === http://localhost:4567/curricula/indi2
+  #
+  # This entry point can be used to display a specific curriculum.
+  #
+  # Another example:
+  #
+  #   http://localhost:4567/curricula/indi3
+  #
+  # ========================================================================= #
+  get('/curricula/*') {
+    _ = params[:splat]
+    _ = _.first if _.is_a? Array
+    if _.end_with? '.yml'
+      _ = _.dup if _.frozen?
+      _.sub!(/\.yml$/,'')
+    end
+    # ======================================================================= #
+    # Delegate towards class Studium::Curricula::CurriculumAsString next.
+    # ======================================================================= #
+    return Studium::Curricula::CurriculumAsString.new(_).result?
+  }
+
+end; end