studium 0.16.9

data/lib/studium/gui/jruby/exam_question_widget/exam_question_widget.rb

@@ -0,0 +1,317 @@
+#!/usr/bin/jruby
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The code in this file will try to make a jruby swing application run on
+# windows, as-is.
+# =========================================================================== #
+include Java
+
+java_import java.lang.System
+java_import java.awt.Color;
+java_import java.awt.Font;
+java_import java.awt.Insets;
+java_import java.awt.Dimension;
+java_import java.awt.FlowLayout;
+java_import java.awt.GradientPaint;
+java_import java.awt.Graphics;
+java_import java.awt.Graphics2D;
+java_import java.awt.Point;
+
+java_import Java.javax.swing.JButton
+java_import Java.javax.swing.JComboBox
+java_import Java.javax.swing.JFrame
+java_import Java.javax.swing.JLabel
+java_import Java.javax.swing.JPanel
+java_import Java.javax.swing.JTextArea
+java_import Java.javax.swing.JTextField
+java_import Java.javax.swing.JScrollPane
+java_import Java.javax.swing.UIManager
+java_import Java.javax.swing.border.EmptyBorder
+java_import Java.javax.swing.BorderFactory 
+
+module Studium
+
+class ExamQuestionWidget < JFrame # === Studium::ExamQuestionWidget
+
+  require 'studium'
+  require 'swing_paradise/autoinclude.rb'
+
+  alias e puts
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = 1400
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = 800
+
+  # ========================================================================= #
+  # === PANEL_TOOLTIP_TEXT
+  # ========================================================================= #
+  PANEL_TOOLTIP_TEXT = 'Exam Question Widget'
+
+  # ========================================================================= #
+  # === USE_THIS_AS_THE_TOOLTIP_TEXT_FOR_THE_ASK_EXAM_QUESTION_BUTTON
+  # ========================================================================= #
+  USE_THIS_AS_THE_TOOLTIP_TEXT_FOR_THE_ASK_EXAM_QUESTION_BUTTON =
+    'Click this button to ask a new exam question.'
+
+  # ========================================================================= #
+  # === USE_THIS_FONT
+  # ========================================================================= #
+  USE_THIS_FONT = Font.new("Serif", Font::PLAIN, 25)
+
+  # ========================================================================= #
+  # === SMALLER_FONT
+  # ========================================================================= #
+  SMALLER_FONT = Font.new("Serif", Font::PLAIN, 21)
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      run_already = true
+    )
+    super(PANEL_TOOLTIP_TEXT)
+    reset
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    setSize(WIDTH, HEIGHT)
+  end
+
+  # ========================================================================= #
+  # === connect_skeleton
+  # ========================================================================= #
+  def connect_skeleton
+    # ======================================================================= #
+    # Create the main panel next:
+    # ======================================================================= #
+    panel = jpanel
+    panel.setBorder(EmptyBorder.new(3, 3, 3, 3))
+    getContentPane.add(panel)
+    panel.setLayout(nil)
+    panel.hint = PANEL_TOOLTIP_TEXT
+
+    # ======================================================================= #
+    # Add the combo box next:
+    # ======================================================================= #
+    @combo_box.dimensions(
+      x_axis:   2,
+      y_axis:   2,
+      width:  450,
+      height:  48
+    )
+    panel << @combo_box
+
+    # ======================================================================= #
+    # Create the button next - it will be an instance of
+    # Java::JavaxSwing::JButton
+    # ======================================================================= #
+    button = jbutton(
+      'Ask an exam question'
+    )
+    button.use_this_font = USE_THIS_FONT
+    button.dimensions(
+      x_axis:  475,
+      y_axis:    2,
+      width:   300,
+      height:   48
+    )
+    # ======================================================================= #
+    # Set a tool tip next:
+    # ======================================================================= #
+    button.hint = USE_THIS_AS_THE_TOOLTIP_TEXT_FOR_THE_ASK_EXAM_QUESTION_BUTTON
+    button.on_event {|event|
+      do_ask_a_new_exam_question
+    }
+    panel << button
+
+    # ======================================================================= #
+    # === The solved-button
+    # ======================================================================= #
+    button_solved = jbutton(
+      'Solved'
+    )
+    button_solved.setFont(USE_THIS_FONT)
+    button_solved.dimensions(
+      x_axis:  778,
+      y_axis:    2,
+      width:   150,
+      height:   48
+    )
+    button_solved.hint = 'Click this button to solve the exam topic at hand.'
+    button_solved.setFont(USE_THIS_FONT)
+    button_solved.on_event {|event|
+      the_solve_button_was_clicked
+    }
+    panel << button_solved
+    
+    # ======================================================================= #
+    # === @entry_delay
+    # ======================================================================= #
+    @entry_delay = JTextField.new(5)
+    @entry_delay.setText('3') # Default delay.
+    @entry_delay.setBounds(928, 2, 100, 48) # x, y, width, height
+    @entry_delay.setFont(USE_THIS_FONT)
+    @entry_delay.center
+    @entry_delay.setMargin(Insets.new(10, 10, 10, 10))
+    panel << @entry_delay
+
+    # ======================================================================= #
+    # === Exam question label
+    # ======================================================================= #
+    _ = text('Exam question:')
+    _.use_this_font = SMALLER_FONT
+    _.dimensions(
+      x_axis:  2,
+      y_axis:  64,
+      width:   220,
+      height:  25
+    )
+    panel << _
+    # ======================================================================= #
+    # === @question_buffer
+    # ======================================================================= #
+    @question_buffer = jtextarea
+    @question_buffer.use_this_font = SMALLER_FONT
+    @question_buffer.dimensions(
+      x_axis:  2,
+      y_axis:  100,
+      width:   880,
+      height:  180
+    )
+    scroll = JScrollPane.new(@question_buffer,
+      Java::JavaxSwing::ScrollPaneConstants::VERTICAL_SCROLLBAR_ALWAYS,
+      Java::JavaxSwing::ScrollPaneConstants::HORIZONTAL_SCROLLBAR_NEVER
+    )
+    scroll.dimensions(
+      x_axis:  2,
+      y_axis:  100,
+      width:   880,
+      height:  180
+    )
+    panel << scroll
+    # ======================================================================= #
+    # === @answer_buffer
+    # ======================================================================= #
+    @answer_buffer = jtextarea
+    @answer_buffer.use_this_font = SMALLER_FONT
+    @answer_buffer.dimensions(
+      x_axis:  2,
+      y_axis:  300,
+      width:   880,
+      height:  180
+    )
+    scroll = JScrollPane.new(@answer_buffer,
+      Java::JavaxSwing::ScrollPaneConstants::VERTICAL_SCROLLBAR_ALWAYS,
+      Java::JavaxSwing::ScrollPaneConstants::HORIZONTAL_SCROLLBAR_NEVER
+    )
+    scroll.dimensions(
+      x_axis:  2,
+      y_axis:  300,
+      width:   880,
+      height:  180
+    )
+    panel << scroll
+
+    panel << return_the_main_quit_button
+  end
+
+  # ========================================================================= #
+  # === the_solve_button_was_clicked
+  # ========================================================================= #
+  def the_solve_button_was_clicked
+    _ = Studium::Exams::Solved.new(ARGV, :dont_run_yet)
+    _.set_commandline
+    _.run
+  end
+
+  # ========================================================================= #
+  # === do_ask_a_new_exam_question
+  # ========================================================================= #
+  def do_ask_a_new_exam_question(
+      from_this_topic = @combo_box.text?
+    )
+    @answer_buffer.setText('') # Empty it just in case.
+    array = Studium.return_question_answer_as_array(from_this_topic)
+    first = array.first
+    last  = array.last
+    first = Studium.remove_html(first)
+    last  = Studium.remove_html(last)
+    if first.size > 80
+      first = Studium.word_wrap(first, 80)
+    end
+    if last.size > 80
+      last = Studium.word_wrap(last, 80)
+    end
+    @question_buffer.setText(first)
+    Thread.new {
+      sleep(@entry_delay.text?.to_i)
+      @answer_buffer.setText(last)
+    }
+  end
+
+  # ========================================================================= #
+  # === create_skeleton                                        (skeleton tag)
+  # ========================================================================= #
+  def create_skeleton
+    # ======================================================================= #
+    # === @combo_box
+    # ======================================================================= #
+    @combo_box = jcombobox(Studium.array_exam_topics?.sort)
+    @combo_box.setFont(USE_THIS_FONT)
+  end
+
+  # ========================================================================= #
+  # === return_the_main_quit_button                                (quit tag)
+  # ========================================================================= #
+  def return_the_main_quit_button
+    a_quit_button = quit_button
+    a_quit_button.setFont(USE_THIS_FONT)
+    a_quit_button.dimensions(
+      x_axis:  900,
+      y_axis:  435,
+      width:   100,
+      height:   48
+    )
+    a_quit_button.setBorderPainted(true)
+    a_quit_button.setBorder(BorderFactory.createLineBorder(Color::BLUE, 3))
+    a_quit_button.hint = 'Use this button to quit the application.'
+    return a_quit_button
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    create_skeleton
+    connect_skeleton
+    default_close
+    setLocationRelativeTo(nil)
+    set_visible(true)
+    UIManager.get_installed_look_and_feels.each { |info|
+      info_name = info.name
+      case info_name
+      when 'Nimbus'
+        UIManager.set_look_and_feel(info.class_name)
+        # UIManager.set_look_and_feel(UIManager.getSystemLookAndFeelClassName)
+      #when 'GTK+'
+      #  UIManager.set_look_and_feel(info.class_name)
+      end
+    }
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::ExamQuestionWidget.new  
+end

data/lib/studium/gui/libui/ask_exam_question/ask_exam_question.rb

@@ -0,0 +1,349 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::GUI::Libui::AskExamQuestion
+# =========================================================================== #
+# require 'studium/gui/libui/ask_exam_question/ask_exam_question.rb'
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+module Studium
+
+module GUI
+
+module Libui
+
+class AskExamQuestion # === Studium::GUI::Libui::AskExamQuestion
+
+  require 'studium/constants/constants.rb'
+  require 'studium/toplevel_methods/filter_away_invalid_questions.rb'
+  require 'studium/toplevel_methods/misc.rb'
+  require 'studium/exams/solved/solved.rb'
+  require 'studium/exams/exam_question/exam_question.rb'
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Ask Exam Questions'
+
+  # ========================================================================= #
+  # === SLEEP_FOR_N_SECONDS
+  # ========================================================================= #
+  SLEEP_FOR_N_SECONDS = 3
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      run_already = true
+    )
+    reset
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @array_available_exam_topics
+    # ======================================================================= #
+    @array_available_exam_topics =
+      ::Studium.available_exam_topics_in_short_form?.map(&:downcase).sort
+    set_title_width_height(TITLE, '70%', '50%')
+    e 'Starting with width of '+width?.to_s+
+      ' px and a height of '+height?.to_s+' px.'    
+  end
+
+  # ========================================================================= #
+  # === n_seconds?
+  # ========================================================================= #
+  def n_seconds?
+    @entry_sleep_for_n_seconds.text?.to_f
+  end; alias sleep_for_n_seconds? n_seconds? # === sleep_for_n_seconds?
+
+  # ========================================================================= #
+  # === reveal_the_answer
+  # ========================================================================= #
+  def reveal_the_answer(
+      i = Studium.remove_html(@answer.to_s)
+    )
+    @answer_buffer.set_text(i)
+  end
+
+  # ========================================================================= #
+  # === reveal_this_answer_after_a_specified_delay
+  # ========================================================================= #
+  def reveal_this_answer_after_a_specified_delay(i = Studium.remove_html(@answer.to_s))
+    if @checkbox_automatically_reveal_the_answer_after_a_delay.is_active?
+      Thread.new {
+        sleep sleep_for_n_seconds?
+        reveal_the_answer(i)
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === current_exam_topic?
+  # ========================================================================= #
+  def current_exam_topic?
+    @entry_for_the_exam_topic.text?.to_s
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    create_skeleton
+    main_window = padded_window(
+      @title,
+      @width.to_i,
+      @height.to_i,
+      0
+    )
+    outer_vbox = padded_vbox
+    
+    hbox = padded_hbox
+    hbox.add(
+      text('Exam topic: ')
+    )
+    hbox.add(@entry_for_the_exam_topic)
+    hbox.minimal(@combo_box_containing_all_exam_topics)
+    hbox.add(return_box_with_checkboxes)
+    outer_vbox.add(hbox)
+    outer_vbox.add(@question_buffer, 1)
+    outer_vbox.add(@answer_buffer,   1)
+    outer_vbox.add(text_view,   1) # This is the "guess answer" view.
+    outer_vbox.minimal(hsep)
+    # ======================================================================= #
+    # === Button reveal the answer
+    # ======================================================================= #
+    button_reveal_the_answer = button('Reveal the answer')
+    button_reveal_the_answer.on_clicked {
+      reveal_the_answer
+    }
+    # ======================================================================= #
+    # === Button solved
+    # ======================================================================= #
+    button_solved = button('Solved')
+    button_solved.on_clicked {
+      the_current_exam_question_is_now_solved
+    }
+    hbox1 = hbox(@button_ask_an_exam_question_from_the_currently_selected_exam_topic, @button_ask_a_random_exam_question)
+    hbox2 = hbox(button_reveal_the_answer, button_solved) # Or padded hbox.
+
+    outer_vbox.minimal(hbox1, 0)
+    outer_vbox.minimal(libui_hsep)
+    outer_vbox.minimal(hbox2, 1)
+
+    main_window.child = outer_vbox
+    main_window.intelligent_exit
+  end
+
+  # ========================================================================= #
+  # === cpruby
+  # ========================================================================= #
+  def cpruby
+    base_dir = ENV['USERS']
+    base_dir = '/home' if base_dir.nil?
+    path_to_setup_rb_file =
+      "#{RUBY_SRC_DIR}roebe/lib/roebe/setup/setup.rb"
+    copy(path_to_setup_rb_file, '.')
+  end
+
+  # ========================================================================= #
+  # === rinstall2
+  # ========================================================================= #
+  def rinstall2
+    cpruby
+    system 'ruby setup.rb --quiet config'
+    system 'ruby setup.rb --quiet setup'
+    system 'ruby setup.rb --quiet install'
+    delete_file 'setup.rb'
+    delete_file 'InstalledFiles' if File.exist?('InstalledFiles')
+    delete_file '.config'
+  end
+
+  # ========================================================================= #
+  # === create_the_combo_box
+  # ========================================================================= #
+  def create_the_combo_box
+    # ======================================================================= #
+    # === @combo_box_containing_all_exam_topics
+    # ======================================================================= #
+    @combo_box_containing_all_exam_topics = libui_combo_box(
+      @array_available_exam_topics
+    )
+  end
+
+  # ========================================================================= #
+  # === create_skeleton                            (create tag, skeleton tag)
+  # ========================================================================= #
+  def create_skeleton
+    # ======================================================================= #
+    # === @question_buffer
+    # ======================================================================= #
+    @question_buffer = text_view
+    # ======================================================================= #
+    # === @answer_buffer
+    # ======================================================================= #
+    @answer_buffer   = text_view
+    create_the_buttons
+    create_the_entries
+    create_the_combo_box
+    # ======================================================================= #
+    # widget1, then widget2
+    # ======================================================================= #
+    ui_sync_connect(
+      @combo_box_containing_all_exam_topics,
+      @entry_for_the_exam_topic,
+      @array_available_exam_topics
+    )
+  end
+
+  # ========================================================================= #
+  # === create_the_entries
+  # ========================================================================= #
+  def create_the_entries
+    # ======================================================================= #
+    # === @entry_for_the_exam_topic
+    # ======================================================================= #
+    @entry_for_the_exam_topic = ui_search_entry # ui_entry
+    # ======================================================================= #
+    # === @entry_sleep_for_n_seconds
+    #
+    # This entry allows the user to specify the number of seconds
+    # to sleep.
+    # ======================================================================= #
+    @entry_sleep_for_n_seconds = ui_entry(SLEEP_FOR_N_SECONDS.to_s)
+  end
+
+  # ========================================================================= #
+  # === return_box_with_checkboxes
+  # ========================================================================= #
+  def return_box_with_checkboxes
+    outer_vbox = padded_vbox
+    vbox = padded_vbox
+    vbox.add(
+      text(
+        'There are a total of '+Studium.n_exam_questions?.to_s+
+        ' exam questions available.'
+      )
+    )
+    # ======================================================================= #
+    # === @checkbox_automatically_reveal_the_answer_after_a_delay
+    # ======================================================================= #
+    @checkbox_automatically_reveal_the_answer_after_a_delay = checkbox(
+      "Automatically reveal the answer after a delay "\
+      "of #{n_seconds?} seconds."
+    )
+    @checkbox_automatically_reveal_the_answer_after_a_delay.set_active
+    vbox.add(@checkbox_automatically_reveal_the_answer_after_a_delay)
+    outer_vbox.add(vbox)
+
+    text_specify_the_delay = text('Specify the delay in n seconds:')
+    lower_box = hbox
+    lower_box.add(text_specify_the_delay)
+    lower_box.maximal(@entry_sleep_for_n_seconds, 1)
+    outer_vbox.add(lower_box)
+    return outer_vbox
+  end
+
+  # ========================================================================= #
+  # === the_current_exam_question_is_now_solved                  (solved tag)
+  #
+  # This method will be run when the user clicks on the "solved" button.
+  # ========================================================================= #
+  def the_current_exam_question_is_now_solved
+    _ = Studium::Exams::Solved.new { :do_not_run_yet }
+    _.set_commandline
+    _.run
+    if is_on_roebe? and Object.const_defined?(:Roebe)
+      rinstall2
+    end
+  end
+
+  # ========================================================================= #
+  # === create_the_buttons                                      (buttons tag)
+  # ========================================================================= #
+  def create_the_buttons
+    # ======================================================================= #
+    # === Button ask a random exam question
+    # ======================================================================= #
+    @button_ask_a_random_exam_question = button('Ask a random exam question')
+    @button_ask_a_random_exam_question.on_clicked {
+      # ===================================================================== #
+      # First obtain a random exam topic:
+      # ===================================================================== #
+      use_this_exam_topic = Studium.random_exam_topic? # => "Theoretische Informatik"
+      use_this_exam_topic = Studium.find_corresponding_exam_topic(use_this_exam_topic)
+      the_ask_exam_question_button_was_pressed(use_this_exam_topic)
+    }
+    # ======================================================================= #
+    # === @button_ask_an_exam_question_from_the_currently_selected_exam_topic
+    # ======================================================================= #
+    @button_ask_an_exam_question_from_the_currently_selected_exam_topic = button(
+      'Ask an exam question from the currently selected exam topic.'
+    )
+    @button_ask_an_exam_question_from_the_currently_selected_exam_topic.on_clicked {
+      if current_exam_topic?.empty?
+        # Add a safeguard here.
+        @entry_for_the_exam_topic.set_text(Studium.random_exam_topic?.to_s)
+      end
+      the_ask_exam_question_button_was_pressed
+    }
+  end
+
+  # ========================================================================= #
+  # === the_ask_exam_question_button_was_pressed
+  #
+  # This is the method that is called when the main ask-question button
+  # has been pressed.
+  # ========================================================================= #
+  def the_ask_exam_question_button_was_pressed(
+      use_this_exam_topic = current_exam_topic?
+    )
+    use_this_exam_topic = ::Studium.find_corresponding_exam_topic(use_this_exam_topic)
+    # ======================================================================= #
+    # Next, identify the file that we will use here:
+    # ======================================================================= #
+    path_to_the_exam_topics = Studium.exam_topics_directory?
+    full_path = path_to_the_exam_topics+
+                use_this_exam_topic
+    @entry_for_the_exam_topic.set_text(use_this_exam_topic.to_s)
+    if File.exist? full_path
+      dataset = File.read(full_path)
+      sanitized_dataset = Studium.filter_away_invalid_questions(dataset.split("\n"))
+      available_questions = sanitized_dataset.reject {|line| line.include? ' []' }
+      line = available_questions.sample
+      @dataset = Studium::Exams::ExamQuestion.new(ARGV, :do_not_run_yet)
+      @dataset.set_this_line(line)
+      @dataset.parse_the_random_line_from_the_obtained_dataset
+
+      @question = @dataset.question?.to_s.dup
+      @answer   = @dataset.answer?.to_s.dup
+      # ===================================================================== #
+      # Note that @question_buffer is a Fiddle::Pointer that was set via
+      # ui_text_view().
+      # ===================================================================== #
+      @question_buffer.set_text(
+        Studium.remove_html(@question.to_s)
+      )
+      # ===================================================================== #
+      # Clear the old buffer content on the answer-buffer, so that old
+      # answers are not retained.
+      # ===================================================================== #
+      @answer_buffer.set_text('')
+      @dataset.store_last_topic_into_file
+      reveal_this_answer_after_a_specified_delay(Studium.remove_html(@answer.to_s))
+    else
+      e "No file exists at #{full_path}."
+    end
+  end
+
+end; end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::GUI::Libui::AskExamQuestion.new  
+end