studium 0.18.7

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

@@ -0,0 +1,637 @@
+#!/usr/bin/jruby
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::GUI::Jruby::ExamTrainer
+#
+# The code in this file will try to make a jruby swing application run on
+# windows, as-is.
+# =========================================================================== #
+# require 'studium/gui/jruby/exam_trainer/exam_trainer.rb'
+# Studium::GUI::Jruby::ExamTrainer.new(ARGV)
+# =========================================================================== #
+java_import javax.swing.JFrame
+
+module Studium
+
+module GUI
+
+module Jruby
+
+class ExamTrainer < JFrame # === Studium::GUI::Jruby::ExamTrainer
+
+  require 'swing_paradise/base_module/base_module.rb'
+  include SwingParadise::BaseModule
+
+  # ========================================================================= #
+  # === USE_THIS_FONT
+  # ========================================================================= #
+  USE_THIS_FONT = Font.new('Serif', Font::PLAIN, 25)
+
+  # ========================================================================= #
+  # === medium_font?
+  # ========================================================================= #
+  def medium_font?
+    Font.new('Serif', Font::PLAIN, 25)
+  end
+
+  # ========================================================================= #
+  # === SMALLER_FONT
+  # ========================================================================= #
+  SMALLER_FONT = Font.new('Serif', Font::PLAIN, 21)
+
+  # ========================================================================= #
+  # === LARGE_FONT_SIZE
+  # ========================================================================= #
+  LARGE_FONT_SIZE = 32
+
+  # ========================================================================= #
+  # === Y_AXIS_FOR_THE_BOTTOM_BUTTONS
+  # ========================================================================= #
+  Y_AXIS_FOR_THE_BOTTOM_BUTTONS = 700
+
+  # ========================================================================= #
+  # === WIDTH_OF_THE_TEXTVIEWS
+  # ========================================================================= #
+  WIDTH_OF_THE_TEXTVIEWS = 1680
+
+  # ========================================================================= #
+  # === 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.'
+
+  # ========================================================================= #
+  # === HEIGHT_FOR_THE_BUTTONS_ON_THE_BOTTOM
+  # ========================================================================= #
+  HEIGHT_FOR_THE_BUTTONS_ON_THE_BOTTOM = 100
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    super(TITLE)
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super() if respond_to?(:super)
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    @internal_hash = {} # Must come before reset_the_shared_variables.
+    reset_the_shared_variables
+  end
+
+  # ========================================================================= #
+  # === create_skeleton                            (create tag, skeleton tag)
+  # ========================================================================= #
+  def create_skeleton
+    # ======================================================================= #
+    # === @panel
+    #
+    # This should come first in this method.
+    # ======================================================================= #
+    @panel = jpanel # This is an instance of Java::JavaxSwing::JPanel.
+    @panel.set_font(Font.new('Calibri', Font::PLAIN, 30))
+    @panel.set_border(EmptyBorder.new(3, 3, 3, 3))
+    @panel.setLayout(nil)
+    @panel.hint = 'The main panel.'
+    create_the_combo_box
+    create_the_solved_button
+    create_the_ask_an_exam_button
+    create_the_entries
+    create_the_reveal_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
+
+  # ========================================================================= #
+  # === connect_skeleton
+  # ========================================================================= #
+  def connect_skeleton
+  end
+
+  # ========================================================================= #
+  # === large_font?
+  # ========================================================================= #
+  def large_font?
+    LARGE_FONT_SIZE
+  end
+
+  # ========================================================================= #
+  # === determine_the_look_and_feel
+  # ========================================================================= #
+  def determine_the_look_and_feel
+    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
+
+  # ========================================================================= #
+  # === return_the_main_quit_button                                (quit tag)
+  # ========================================================================= #
+  def return_the_main_quit_button
+    _ = quit_button
+    _.set_font(Font.new('Calibri', Font::PLAIN, 30))
+    _.dimensions(
+      x_axis:  1200, # x-position
+      y_axis:   Y_AXIS_FOR_THE_BOTTOM_BUTTONS, # y-position
+      width:    190,
+      height:   HEIGHT_FOR_THE_BUTTONS_ON_THE_BOTTOM
+    )
+    _.setBorderPainted(true)
+    _.setBorder(BorderFactory.createLineBorder(Color::BLUE, 2))
+    _.hint = 'Use this button to quit the application.'
+    return _
+  end
+
+  # ========================================================================= #
+  # === create_the_combo_box                                   (combobox tag)
+  # ========================================================================= #
+  def create_the_combo_box
+    # ======================================================================= #
+    # Create the primary combo-box next:
+    # ======================================================================= #
+    _ = combo_box(exam_topics_short_form?)
+    _.set_font(Font.new 'Sans serif', Font::PLAIN, LARGE_FONT_SIZE)
+    _.dimensions(
+      x_axis: 800, # x-position
+      y_axis:   2, # y-position, aka top-towards-bottom.
+      width:  500, # width
+      height:  48  # height
+    )
+    _.add_action_listener { |event|
+      case event.get_action_command
+      when /comboBoxChanged/
+        clear_question_buffer
+        clear_answer_buffer
+        current_selection = _.text?
+        entry_current_exam_topic?.set_text(current_selection)
+      end
+    }
+    @internal_hash[:combobox_available_exam_topics] = _
+  end
+
+  # ========================================================================= #
+  # === create_the_solved_button
+  # ========================================================================= #
+  def create_the_solved_button
+    # ======================================================================= #
+    # === The solved-button will be created next
+    # ======================================================================= #
+    @button_solved = button(
+      'Solved'
+    )
+    @button_solved.set_font(USE_THIS_FONT)
+    @button_solved.dimensions(
+      x_axis:  935,
+      y_axis:  Y_AXIS_FOR_THE_BOTTOM_BUTTONS, # up-to-bottom.
+      width:   260,
+      height:  HEIGHT_FOR_THE_BUTTONS_ON_THE_BOTTOM
+    )
+    @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
+    }
+    @button_solved.blue_border(2)
+    @panel << @button_solved
+  end
+
+  # ========================================================================= #
+  # === bottom_line_in_pixel_size?
+  # ========================================================================= #
+  def bottom_line_in_pixel_size?
+    Y_AXIS_FOR_THE_BOTTOM_BUTTONS
+  end
+
+  # ========================================================================= #
+  # === Studium::GUI::Jruby::ExamTrainer[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+  # ========================================================================= #
+  # === enhance_entry_n_answered_exam_questions
+  # ========================================================================= #
+  def enhance_entry_n_answered_exam_questions(
+      use_this_font = nil
+    )
+    if use_this_font
+      @entry_n_answered_exam_questions.set_font(use_this_font)
+    end
+    @entry_n_answered_exam_questions.center
+  end
+
+  # ========================================================================= #
+  # === create_the_entries
+  # ========================================================================= #
+  def create_the_entries
+    create_the_entry_for_sleeping_n_seconds
+    # ======================================================================= #
+    # === :entry_current_exam_topic
+    # ======================================================================= #
+    _ = JTextField.new(5)
+    _.setBounds(
+      200, # x
+        5, # y
+      400, # width
+       48  # height
+    )
+    _.setFont(USE_THIS_FONT)
+    _.center
+    _.setMargin(Insets.new(10, 10, 10, 10))
+    @internal_hash[:entry_for_the_current_exam_topic] = _
+    @panel << _ # Add the entry current exam topic here.
+  end
+
+  # ========================================================================= #
+  # === do_ask_a_new_exam_question                                  (ask tag)
+  # ========================================================================= #
+  def do_ask_a_new_exam_question(
+      current_exam_topic = combo_box?.text?.to_s
+    )
+    answer_buffer?.setText('') # Empty it just in case.
+    update_hash_dataset_of_all_lectures
+    current_exam_topic = entry_for_the_current_exam_topic?.text?.to_s
+
+    if current_exam_topic.empty?
+      set_current_exam_topic(combo_box?.text?.to_s)
+      current_exam_topic = entry_for_the_current_exam_topic?.text?.to_s
+    end
+
+    current_exam_topic = Studium.expand_this_exam_topic(current_exam_topic) { :be_quiet }
+
+    if ::Studium.is_this_exam_topic_available?(current_exam_topic)
+      clear_the_answer_buffer
+      # =================================================================== #
+      # (1) Pass the current exam topic into a method that will return
+      #     an Array.
+      # =================================================================== #
+      array = Studium.return_an_array_for_this_exam_topic(current_exam_topic)
+      # =================================================================== #
+      # (2) Keep track of the Array next:
+      # =================================================================== #
+      @internal_hash[:array_all_exam_questions] = array
+      @question, @answer = array
+      first = Studium.remove_html(@question)
+      last  = Studium.remove_html(@answer)
+      first = word_wrap(first, 80) if first.size > 80
+      last = word_wrap(last, 80) if last.size > 80
+      question_buffer?.set_text(first)
+
+      hash = hash_dataset_of_all_lectures?
+
+      if current_exam_topic # Protect against nil-values here.
+        _ = hash[current_exam_topic.tr(' ','_').to_sym]
+        if _ # Protect against nil values here as well.
+          set_n_exam_questions_exist_in_total(
+            _[:n_total_questions]
+          )
+          set_n_exam_questions_were_already_answered(
+            _[:n_questions_answered]
+          )
+          set_n_percentage_of_questions_answered( # Update the n percentage value answered.
+            _[:percentage_of_questions_answered]
+          )
+          set_n_exam_questions_are_unanswered(
+            _[:n_total_questions] -
+            _[:n_questions_answered]
+          )
+        end
+      end
+
+      Thread.new {
+        current_delay = entry_delay?.text?.to_f # Obtain the current delay from the entry.
+        sleep(current_delay)
+        answer_buffer?.setText(last)
+      }
+
+    else
+      e 'Not a registered exam-topic: '+current_exam_topic.to_s
+    end
+  end
+
+  # ========================================================================= #
+  # === create_the_ask_an_exam_button
+  # ========================================================================= #
+  def create_the_ask_an_exam_button
+    # ======================================================================= #
+    # Create the button next - it will be an instance of
+    # Java::JavaxSwing::JButton
+    # ======================================================================= #
+    @button_ask_an_exam_question = button(
+      'Ask an exam question'
+    )
+    @button_ask_an_exam_question.use_this_font = USE_THIS_FONT
+    @button_ask_an_exam_question.dimensions(
+      x_axis:  185,
+      y_axis:  bottom_line_in_pixel_size?,
+      width:   290,
+      height:  HEIGHT_FOR_THE_BUTTONS_ON_THE_BOTTOM
+    )
+    # ======================================================================= #
+    # Set a tool tip next:
+    # ======================================================================= #
+    @button_ask_an_exam_question.hint = USE_THIS_AS_THE_TOOLTIP_TEXT_FOR_THE_ASK_EXAM_QUESTION_BUTTON
+    @button_ask_an_exam_question.on_event {|event|
+      do_ask_a_new_exam_question
+    }
+    @panel << @button_ask_an_exam_question
+  end
+
+  # ========================================================================= #
+  # === create_the_reveal_button                                 (reveal tag)
+  #
+  # This is the "Reveal the Answer" button.
+  # ========================================================================= #
+  def create_the_reveal_button
+    _ = button('Reveal the Answer') {{ font: USE_THIS_FONT }}
+    _.on_clicked {
+      text_view_for_the_answer?.set_text(
+        sanitize_this_answer(
+          answer_is?,
+          :filter_away_tags
+        )
+      )
+    }
+    _.dimensions(
+      x_axis:  490,
+      y_axis:  bottom_line_in_pixel_size?,
+      width:   300,
+      height:  HEIGHT_FOR_THE_BUTTONS_ON_THE_BOTTOM
+    )
+    @panel << _
+    @button_reveal_the_answer = _
+  end
+
+  # ========================================================================= #
+  # === use_jruby?
+  # ========================================================================= #
+  def use_jruby?
+    true
+  end
+
+  # ========================================================================= #
+  # === enhance_the_entry_containing_n_questions
+  # ========================================================================= #
+  def enhance_the_entry_containing_n_questions
+    @entry_containing_n_questions.center
+  end
+
+  # ========================================================================= #
+  # === enhance_the_the_entry_percentage
+  # ========================================================================= #
+  def enhance_the_the_entry_percentage(optional_use_this_font = nil)
+  end
+
+  # ========================================================================= #
+  # === enhance_the_entry_percentage
+  # ========================================================================= #
+  def enhance_the_entry_percentage(
+      optional_argument = nil
+    )
+    _ = entry_percentage?
+    _.center
+    use_this_colour = java_colour(:bisque)
+    _.setBackground(use_this_colour)
+  end
+
+  # ========================================================================= #
+  # === enhance_the_entry_for_sleeping_n_seconds
+  # ========================================================================= #
+  def enhance_the_entry_for_sleeping_n_seconds
+    _ = @internal_hash[:entry_for_sleeping_n_seconds]
+    _.center
+    _.setMargin(Insets.new(10, 10, 10, 10))
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    default_close
+    setLocationRelativeTo(nil)
+    set_visible(true)
+    create_skeleton
+    connect_skeleton
+    frame = frame('Exam Trainer')
+    frame.getContentPane.add(@panel) # Add the panel.
+
+    # ======================================================================= #
+    # === The question buffer
+    # ======================================================================= #
+    _ = text_view
+    _.set_font(Font.new 'Sans serif', Font::PLAIN, LARGE_FONT_SIZE)
+    _.set_bounds(10, 20+48, WIDTH_OF_THE_TEXTVIEWS, 150) # Last two are width and height.
+    @widget_for_the_questions = _ # For the questions.
+    scroll = scroll_pane(
+      question_buffer?,
+      :vertical_always,
+      :horizontal_never
+    )
+    scroll.set_bounds(
+      10,
+      20+48,
+      WIDTH_OF_THE_TEXTVIEWS,
+      150
+    ) # Last two are width and height.
+    @panel << scroll
+
+    # ======================================================================= #
+    # === The answer buffer
+    # ======================================================================= #
+    _ = text_view
+    _.set_font(Font.new 'Sans serif', Font::PLAIN, LARGE_FONT_SIZE)
+    _.set_bounds(10, 180+48, WIDTH_OF_THE_TEXTVIEWS, 150) # Last two are width and height.
+    @text_view_for_the_answer = _ # For the questions.
+    scroll = scroll_pane(
+      @text_view_for_the_answer,
+      :vertical_always,
+      :horizontal_never
+    )
+    scroll.set_bounds(10, 180+48, WIDTH_OF_THE_TEXTVIEWS, 180)
+    @panel << scroll
+
+    _ = text_view
+    _.set_font(Font.new 'Sans serif', Font::PLAIN, LARGE_FONT_SIZE)
+    # _.set_bounds(10, 420, WIDTH_OF_THE_TEXTVIEWS, 150) # Last two are width and height.
+    @textarea3 = _ # For the questions.
+    scroll = scroll_pane(
+      @textarea3,
+      :vertical_always,
+      :horizontal_never
+    )
+    scroll.set_bounds(10, 420, WIDTH_OF_THE_TEXTVIEWS, 150) # Last two are width and height.
+    @panel << scroll
+
+    # ======================================================================= #
+    # Add the combo box next:
+    # ======================================================================= #
+    @panel << @internal_hash[:combobox_available_exam_topics]
+    @panel << return_the_main_quit_button
+
+    # ======================================================================= #
+    # === Exam question label
+    # ======================================================================= #
+    _ = text('Exam topic: ')
+    _.use_this_font = medium_font?
+    _.dimensions(
+      x_axis:    4,
+      y_axis:   24,
+      width:   220,
+      height:   25
+    )
+    @panel << _
+
+    # ======================================================================= #
+    # Add the "n exam questions in total":
+    # ======================================================================= #
+    _ = text(
+      N_ANSWERED_EXAM_QUESTIONS
+    )
+    _.use_this_font = medium_font?
+    @panel << _
+
+    # ======================================================================= #
+    # Next add the panel containing most of the entries in the middle:
+    # ======================================================================= #
+		@panel.add(return_the_panel_containing_most_of_the_entries_in_the_middle, BorderLayout::NORTH)
+
+    frame.exit_on_close
+    frame.set_size(1640, 920)
+    frame.setLocationRelativeTo(nil)
+    frame.show_all
+    frame.setExtendedState(JFrame::MAXIMIZED_BOTH)
+    determine_the_look_and_feel
+  end
+
+  # ========================================================================= #
+  # === return_the_panel_containing_most_of_the_entries_in_the_middle
+  # ========================================================================= #
+  def return_the_panel_containing_most_of_the_entries_in_the_middle
+		panel = create_panel { :left }
+    panel.set_font(Font.new('Calibri', Font::PLAIN, 42))
+    panel.hint = 'New panel'
+
+    # ======================================================================= #
+    # Add the "n exam questions in total":
+    # ======================================================================= #
+    _ = text(
+      N_EXAM_QUESTIONS_IN_TOTAL
+    )
+    _.use_this_font = medium_font?
+    _.setAlignmentX(Component::CENTER_ALIGNMENT)
+    box = new_boxlayout(:new_panel)
+    box.setBorder(BorderFactory.create_uniform_empty_border(6))
+    box << _
+    box << create_the_entry_containing_n_questions
+    panel << box
+
+    # ======================================================================= #
+    # Add the "n unanswered exam questions" next:
+    # ======================================================================= #
+    _ = text(
+      N_UNANSWERED_EXAM_QUESTIONS
+    )
+    _.use_this_font = medium_font?
+    
+    # ======================================================================= #
+    # === n unanswered exam questions:
+    # ======================================================================= #
+    _.setAlignmentX(Component::CENTER_ALIGNMENT)
+    box = new_boxlayout(:new_panel)
+    box.setBorder(BorderFactory.create_uniform_empty_border(6))
+    box << _
+    box << create_the_entry_containing_n_unanswered_exam_questions
+    panel << box
+
+    # ======================================================================= #
+    # === n answered exam questions:
+    # ======================================================================= #
+    _ = text(
+      N_ANSWERED_EXAM_QUESTIONS
+    )
+    _.use_this_font = medium_font?
+    _.setAlignmentX(Component::CENTER_ALIGNMENT)
+    box = new_boxlayout(:new_panel)
+    box.setBorder(BorderFactory.create_uniform_empty_border(6))
+    box << _
+    box << create_the_entry_containing_n_answered_exam_questions
+    panel << box
+
+    # ======================================================================= #
+    # Add the label "n % solved" as well as the associated entry:
+    # ======================================================================= #
+    _ = text(
+      N_PERCENT_SOLVED
+    )
+    _.use_this_font = medium_font?
+    _.setAlignmentX(Component::CENTER_ALIGNMENT)
+    box = new_boxlayout(:new_panel)
+    box.setBorder(BorderFactory.create_uniform_empty_border(6))
+    box << _
+    box << create_the_entry_percentage # And the entry here.
+    panel << box
+
+    # ======================================================================= #
+    # Add the label "sleep n seconds" and then the appropriate entry
+    # ======================================================================= #
+    _ = text(SLEEP_N_SECONDS)
+    _.use_this_font = medium_font?
+    _.setAlignmentX(Component::CENTER_ALIGNMENT)
+    box = new_boxlayout(:new_panel)
+    box.setBorder(BorderFactory.create_uniform_empty_border(6))
+    box << _
+    box << return_the_entry_sleep_n_seconds # And the entry here.
+    panel << box
+
+    # ======================================================================= #
+    # And, finally, position the panel properly:
+    # ======================================================================= #
+		panel.dimensions(
+      x_axis:    15,
+      y_axis:   575,
+      width:   1400,
+      height:  HEIGHT_FOR_THE_BUTTONS_ON_THE_BOTTOM
+    )
+    return panel
+  end
+
+end; end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::GUI::Jruby::ExamTrainer.new(ARGV)
+end # exam_trainer