dictionaries 0.3.81

data/lib/dictionaries/gui/universal_widgets/dictionary/dictionary.rb

@@ -0,0 +1,516 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Dictionaries::GUI::UniversalWidgets::Dictionary
+#
+# Usage example:
+#
+#   Dictionaries::GUI::UniversalWidgets::Dictionary.new(ARGV)
+#
+# =========================================================================== #
+# require 'dictionaries/gui/universal_widgets/dictionary/dictionary.rb'
+# Dictionaries::GUI::UniversalWidgets::Dictionary.run
+# =========================================================================== #
+require 'dictionaries/base/base.rb'
+
+module Dictionaries
+
+module GUI
+
+module UniversalWidgets
+
+class Dictionary < ::Dictionaries::Base # === Dictionaries::GUI::UniversalWidgets::Dictionary
+
+  require 'universal_widgets/base_module/base_module.rb'
+  include ::UniversalWidgets::BaseModule
+
+  require 'dictionaries/toplevel_methods/e.rb'
+  require 'dictionaries/toplevel_methods/misc.rb'
+  require 'dictionaries/class/class.rb'
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Dictionary'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = '28% or minimum 280px'
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = '26% or minimum 240px'
+
+  # ========================================================================= #
+  # === USE_THIS_FONT
+  # ========================================================================= #
+  USE_THIS_FONT = :dejavu_condensed_22
+
+  # ========================================================================= #
+  # === LARGER_FONT
+  # ========================================================================= #
+  LARGER_FONT   = :hack_25
+
+  # ========================================================================= #
+  # === SMALLER_FONT
+  #
+  # This one should be relative to the font used above.
+  # ========================================================================= #
+  SMALLER_FONT = :dejavu_condensed_18
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    super(:vertical) if use_gtk3?
+    determine_the_GUI_to_be_used(commandline_arguments) # This must come first, even before reset().
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    on_delete_event_quit_the_application
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super() if respond_to?(:super)
+    reset_the_shared_module # This can come early.
+    reset_the_base_module
+    reset_the_internal_variables
+    infer_the_namespace
+    # ======================================================================= #
+    # === @configuration
+    # ======================================================================= #
+    @configuration = [true, __dir__, namespace?]
+    # ======================================================================= #
+    # === Set the title, width, height and the font in use.
+    # ======================================================================= #
+    title_width_height_font(TITLE, WIDTH, HEIGHT, USE_THIS_FONT)
+    if use_gtk3?
+      handle_CSS_rules
+    end
+    infer_the_size_automatically
+    # ======================================================================= #
+    # === @dictionaries
+    # ======================================================================= #
+    @dictionaries = Dictionaries.new(:do_not_run_yet)
+    Dictionaries.set_main_file(:default)
+    @dictionaries.load_the_english_file
+    # ======================================================================= #
+    # === @array_style_these_buttons
+    # ======================================================================= #
+    @array_style_these_buttons = []
+  end
+
+  # ========================================================================= #
+  # === smaller_font?
+  # ========================================================================= #
+  def smaller_font?
+    SMALLER_FONT
+  end
+
+  # ========================================================================= #
+  # === handle_CSS_rules                                            (CSS tag)
+  # ========================================================================= #
+  def handle_CSS_rules
+    use_gtk_paradise_project_css_file
+    append_project_css_file
+    more_CSS_then_apply_it '
+
+'
+  end
+
+  # ========================================================================= #
+  # === reset_the_shared_module
+  # ========================================================================= #
+  def reset_the_shared_module
+  end
+
+  # ========================================================================= #
+  # === e
+  # ========================================================================= #
+  def e(i = '')
+    ::Dictionaries.e(i)
+  end
+
+  # ========================================================================= #
+  # === update_the_statistics_frame                              (update tag)
+  # ========================================================================= #
+  def update_the_statistics_frame(
+      i = return_currently_selected_file
+    )
+    @label_currently_selected_file.set_text(i)
+    @label_currently_selected_file.do_markify
+  end
+
+  # ========================================================================= #
+  # === add_ask_the_question_button
+  # ========================================================================= #
+  def add_ask_the_question_button
+    button = bold_button('_Translate into german')
+    button.clear_background
+    button.bblack2
+    button.hint =
+      'Click this button in order to <b>translate the english '\
+      'word into the german equivalent word</b>.'
+    button.on_clicked {
+      button_pressed_so_try_to_convert_the_input
+    }
+    @array_style_these_buttons << button
+    hbox1 = create_hbox
+    hbox1.minimal(button, 1)
+    hbox1.halign_center
+    return hbox1
+  end
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    2
+  end
+
+  # ========================================================================= #
+  # === border_size?
+  # ========================================================================= #
+  def border_size?
+    2
+  end
+
+  # ========================================================================= #
+  # === create_the_header_bar
+  # ========================================================================= #
+  def create_the_header_bar
+    # ======================================================================= #
+    # === @header_bar
+    # ======================================================================= #
+    @header_bar = default_header_bar
+    @header_bar.title = 'Dictionary'
+  end
+
+  # ========================================================================= #
+  # === create_answer_field
+  #
+  # This method builds up the "answer-widget".
+  # ========================================================================= #
+  def create_answer_field
+    # ======================================================================= #
+    # === @answer_field
+    # ======================================================================= #
+    @answer_field = create_input_field
+    @answer_field.center
+    @answer_field.hint = 'The translated string may appear here.'
+    @answer_field.very_light_yellow_background
+  end
+
+  # ========================================================================= #
+  # === button_pressed_so_try_to_convert_the_input                (click tag)
+  #
+  # This action is called when the user clicks on the button.
+  # ========================================================================= #
+  def button_pressed_so_try_to_convert_the_input
+    user_input = @input_field.return_input
+    unless user_input.empty? # We check whether the user did input something.
+      translated_word = @dictionaries.translate(user_input)
+      e "#{::Colours.sfancy(user_input)} → "\
+        "#{::Colours.simp(translated_word)}"
+      @answer_field.set_text(translated_word)
+    end
+  end
+
+  # ========================================================================= #
+  # === add_the_widget_for_remote_query_of_the_dictionary_at_leo (bottom tag)
+  #
+  # This is the bottom widget.
+  # ========================================================================= #
+  def add_the_widget_for_remote_query_of_the_dictionary_at_leo
+    bottom_vbox = create_vbox
+    bold_label = bold_label(
+      'Query from a remote website instead (more entries available)'
+    ) 
+    bottom_vbox.minimal(bold_label, 15)
+    # This is the user-input entry at the bottom.
+    @entry_for_the_remote_query = create_entry
+    @entry_for_the_remote_query.center
+    @entry_for_the_remote_query.on_key_press_event { |widget, event|
+      case Gdk::Keyval.to_name(event.keyval) 
+      when 'Return', 'KP_Enter'
+        do_perform_a_remote_query_to_the_leo_dictionary
+      end
+    }
+    bottom_vbox.minimal(@entry_for_the_remote_query)
+    # ======================================================================= #
+    # === button_for_the_remote_query
+    # ======================================================================= #
+    button_for_the_remote_query = button(
+      '_Query from a remote dictionary'
+    )
+    button_for_the_remote_query.clear_background
+    button_for_the_remote_query.bblack2
+    button_for_the_remote_query.make_bold
+    button_for_the_remote_query.hint = 
+      'This will <b>query the remote dictionary</b> at leo instead. '\
+      'The <b>advantage</b> here is that the dataset at leo will '\
+      'contain many more entries than does the knowledgebase '\
+      'distributed with the <b>dictionaries gem</b>.'
+    button_for_the_remote_query.on_clicked {
+      do_perform_a_remote_query_to_the_leo_dictionary
+    }
+    bottom_vbox.minimal(
+      @entry_at_the_bottom_showing_the_result_from_online_leo, 2
+    )
+    @array_style_these_buttons << button_for_the_remote_query
+    small_hbox = create_hbox
+    small_hbox.minimal(button_for_the_remote_query, 1)
+    small_hbox.halign_center
+    bottom_vbox.minimal(
+      small_hbox, 2
+    )
+    return bottom_vbox
+  end
+
+  # ========================================================================= #
+  # === return_input_field_on_top
+  #
+  # This is the main widget for user input. The user types in some
+  # words, and then hits the main button on the bottom, in order
+  # to translate the (english) word to german.
+  # ========================================================================= #
+  def return_input_field_on_top
+    text_for_the_label = 'Input an english word in the field below'
+    text = label(text_for_the_label)
+    text.slateblue
+    text.set_markup(
+      '<span size="x-large" weight="bold">'+text_for_the_label+'</span>',
+      use_underline: true
+    )
+    # ======================================================================= #
+    # Add the "input field" next for the english word that is to
+    # be translated.
+    # ======================================================================= #
+    @input_field = create_input_field
+    @input_field.hint = 'Input the word that should be translated '\
+      'here. Then, press the "enter" key or the button '\
+      '"Translate into german" below.'
+    @input_field.very_light_yellow_background
+    completion = create_entry_completion
+    @input_field.completion = completion # Assign the completion.
+    completion_model = ::Gtk::ListStore.new(String)
+    @dictionaries.array.each { |word|
+      iter = completion_model.append
+      iter[0] = word
+    }
+    completion.model = completion_model
+    # ======================================================================= #
+    # Use model column 0 as the text column
+    # ======================================================================= #
+    completion.text_column = 0
+    @input_field.center
+    @input_field.on_key_press_event { |widget, event|
+      case Gdk::Keyval.to_name(event.keyval) 
+      when 'Return', 'KP_Enter'
+        button_pressed_so_try_to_convert_the_input
+      end
+    }
+    hbox_holding_label_and_input_field = create_vbox(
+      text, @input_field
+    )
+    return hbox_holding_label_and_input_field
+  end
+
+  # ========================================================================= #
+  # === connect_the_skeleton                                    (connect tag)
+  # ========================================================================= #
+  def connect_the_skeleton
+    abort_on_exception
+
+    outer_box = create_vbox
+
+    outer_box.add(add_the_header_bar)
+    outer_box.add(return_input_field_on_top)
+    outer_box.add(add_the_answer_field)
+    outer_box.add(add_ask_the_question_button)
+    outer_box.add(add_the_widget_for_remote_query_of_the_dictionary_at_leo)
+    outer_box.add(add_the_statistics_frame)
+
+    window = create_window_or_runner(nil, width?, height?, title?)
+    window << outer_box
+
+    properly_prepare_this_window(window,
+      {
+        title:       title?,
+        font:        font?,
+        width:       width?,
+        height:      height?,
+        padding:     padding?,
+        border_size: border_size?
+      }
+    )
+    window.show_all
+    window.top_left
+    do_all_startup_related_actions
+    run_main
+  end
+
+  # ========================================================================= #
+  # === do_all_startup_related_actions
+  # ========================================================================= #
+  def do_all_startup_related_actions
+    update_the_statistics_frame
+    do_style_the_important_buttons
+  end
+
+  # ========================================================================= #
+  # === do_style_the_important_buttons
+  # ========================================================================= #
+  def do_style_the_important_buttons
+    @array_style_these_buttons.each {|this_button|
+      this_button.modify_background(:normal,   :khaki)         # ← default colour
+      this_button.modify_background(:prelight, :paleturquoise) # ← mouse-on-over events
+      this_button.modify_background(:active,   :slategray)     # ← colour on mouse-press-event
+    }
+  end
+
+  # ========================================================================= #
+  # === do_perform_a_remote_query_to_the_leo_dictionary
+  # ========================================================================= #
+  def do_perform_a_remote_query_to_the_leo_dictionary(
+      i = @entry_for_the_remote_query.text.to_s
+    )
+    if i and !i.empty?
+      array = ::Dictionaries.return_array_of_translated_words_from_online_leo(i)
+      result = array.first
+      @entry_at_the_bottom_showing_the_result_from_online_leo.set_text(result)
+    end
+  end
+
+  # ========================================================================= #
+  # === return_currently_selected_file
+  # ========================================================================= #
+  def return_currently_selected_file
+    'Currently selected file: <b>'+
+    File.basename(
+      @dictionaries.currently_selected_file?.to_s
+    )+'</b>'
+  end
+
+  # ========================================================================= #
+  # === create_the_entries                           (entries tag, entry tag)
+  # ========================================================================= #
+  def create_the_entries
+    # ======================================================================= #
+    # === @entry_at_the_bottom_showing_the_result_from_online_leo
+    # ======================================================================= #
+    @entry_at_the_bottom_showing_the_result_from_online_leo = create_entry
+    @entry_at_the_bottom_showing_the_result_from_online_leo.center
+  end
+
+  # ========================================================================= #
+  # === add_the_header_bar
+  # ========================================================================= #
+  def add_the_header_bar
+    return @header_bar
+  end
+
+  # ========================================================================= #
+  # === add_the_statistics_frame
+  # ========================================================================= #
+  def add_the_statistics_frame
+    return @frame_statistics
+  end
+
+  # ========================================================================= #
+  # === add_the_answer_field
+  # ========================================================================= #
+  def add_the_answer_field
+    return @answer_field # ← Translation appears here.
+  end
+
+  # ========================================================================= #
+  # === create_the_skeleton                        (create tag, skeleton tag)
+  # ========================================================================= #
+  def create_the_skeleton
+    create_the_entries
+    create_the_header_bar
+    create_answer_field
+    create_the_statistics_frame
+  end
+
+  # ========================================================================= #
+  # === create_the_statistics_frame
+  # ========================================================================= #    
+  def create_the_statistics_frame
+    # ======================================================================= #
+    # === @frame_statistics
+    # ======================================================================= #
+    @frame_statistics = create_frame
+    @frame_statistics.set_label((' Statistics '))
+    @frame_statistics.make_bold
+    @frame_statistics.use_this_font = smaller_font?
+    vbox = create_vbox
+    @label_currently_selected_file = label(return_currently_selected_file)
+    vbox.minimal(
+      @label_currently_selected_file, 0
+    )
+    @frame_statistics.add(vbox)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    run_super
+  end
+
+  # ========================================================================= #
+  # === Dictionaries::GUI::Gtk::Dictionary.run
+  # ========================================================================= #
+  def self.run(
+      i = ARGV
+    )
+    require 'gtk_paradise/run'
+    _ = ::Dictionaries::GUI::Gtk::Dictionary.new(i)
+    r = ::Gtk.run
+    _.set_parent_widget(r) # Must come before we enable the key-combinations.
+    r << _
+    r.automatic_size_then_automatic_title
+    r.enable_quick_exit
+    r.set_background :white
+    r.border_width = 12
+    r.top_left_then_run
+  end; self.instance_eval { alias start_gui_application run } # === Dictionaries::GUI::Gtk::Dictionary.start_gui_application
+
+  # ========================================================================= #
+  # === Dictionaries::GUI::UniversalWidgets::Dictionary[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end; end
+
+# =========================================================================== #
+# === Dictionaries.gtk_widget
+#
+# This toplevel-method can be used to return the gtk-widget, which
+# can then be embedded by other ruby-gtk applications, in particular
+# admin_panel.rb of the gtk_paradise project.
+# =========================================================================== #
+def self.gtk_widget
+  Dictionaries::GUI::Gtk::Dictionary.new
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Dictionaries::GUI::UniversalWidgets::Dictionary.new(ARGV)
+end # guishell

data/lib/dictionaries/helper_module/helper_module.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'dictionaries/helper_module/helper_module.rb'
+# include Dictionaries::HelperModule
+# =========================================================================== #
+module Dictionaries
+
+module HelperModule
+
+  require 'html_tags'
+  include HtmlTags
+
+  # ========================================================================= #
+  # === Dictionaries::HelperModule.return_search_button
+  # ========================================================================= #
+  def self.return_search_button
+    '<input type="submit" name="user_input_submit" value="Search" '\
+    'style="font-weight: bold; font-size: larger; '\
+    'border: 2px dotted slateblue; margin: 4px; margin-left: 2em">'
+  end
+
+  # ========================================================================= #
+  # === Dictionaries::HelperModule.html_header_default_title_and_start_of_the_body_tag
+  # ========================================================================= #
+  def self.html_header_default_title_and_start_of_the_body_tag
+    "<html>\n"\
+    "<title>Dictionaries</title>\n"\
+    "<body>\n"
+  end
+
+  # ========================================================================= #
+  # === Dictionaries::HelperModule.return_english_to_german_form
+  # ========================================================================= #
+  def self.return_english_to_german_form
+    route_to_this_action = '/english_to_german/'
+    html_header_default_title_and_start_of_the_body_tag+
+    HtmlTags.h5('Input an english word to see the translation.')+
+    HtmlTags.div(css_style: 'padding: 0.1em') {
+      HtmlTags.p(
+        '<b>Enter the word here:</b>',
+        css_style: 'padding: 0.15em'
+      )+
+      HtmlTags.form(action: route_to_this_action,
+               id: 'english_to_german',
+        css_style: 'margin-left:1em; margin-top:2px') {
+        '<input type="text" name="user_input" style="border:3px solid slateblue; padding: 4px"><br>'+
+        return_search_button
+      }
+    }
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  include Dictionaries::HelperModule
+  e Dictionaries::HelperModule.return_english_to_german_form  
+end

data/lib/dictionaries/project/project.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file will point to the yaml directory of the Dictionaries project.
+# =========================================================================== #
+# require 'dictionaries/project/project.rb'
+# =========================================================================== #
+module Dictionaries
+
+  # ========================================================================= #
+  # === Dictionaries::PROJECT_BASE_DIRECTORY
+  # ========================================================================= #
+  PROJECT_BASE_DIRECTORY =
+    File.absolute_path("#{__dir__}/..")+'/'
+
+  # ========================================================================= #
+  # === Dictionaries.project_base_dir?
+  # ========================================================================= #
+  def self.project_base_dir?
+    PROJECT_BASE_DIRECTORY
+  end
+
+  # ========================================================================= #
+  # === PROJECT_YAML_DIRECTORY
+  # ========================================================================= #
+  PROJECT_YAML_DIRECTORY = "#{PROJECT_BASE_DIRECTORY}yaml/"
+
+  # ========================================================================= #
+  # === Dictionaries.project_yaml_dir?
+  # ========================================================================= #
+  def self.project_yaml_dir?
+    PROJECT_YAML_DIRECTORY
+  end; self.instance_eval { alias dictionary_directory? project_yaml_dir? } # === Dictionaries.dictionary_directory?
+
+end

data/lib/dictionaries/require_project/require_project.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'dictionaries/require_project/require_project.rb'
+# =========================================================================== #
+require 'dictionaries/project/project.rb'
+require 'dictionaries/ask_italian_word.rb'
+require 'dictionaries/toplevel_methods/has_key.rb' # This file requires the files above.
+require 'dictionaries/toplevel_methods/module_methods.rb'
+require 'dictionaries/toplevel_methods/english_to_german.rb'
+require 'dictionaries/toplevel_methods/is_on_roebe.rb'
+require 'dictionaries/sinatra/app.rb'
+require 'dictionaries/statistics/statistics.rb'