dictionaries 0.3.7

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

@@ -0,0 +1,457 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Dictionaries::GUI::Gtk::Dictionary
+# =========================================================================== #
+# require 'dictionaries/gui/gtk3/dictionaries/dictionaries.rb'
+# Dictionaries::GUI::Gtk::Dictionary.run
+# =========================================================================== #
+require 'gtk_paradise/require_gtk3'
+
+module Dictionaries
+
+module GUI
+
+module Gtk
+
+class Dictionary < ::Gtk::Box # === Dictionaries::GUI::Gtk::Dictionary 
+
+  require 'dictionaries/toplevel_methods/e.rb'
+  require 'dictionaries/toplevel_methods/misc.rb'
+  require 'dictionaries/class/ask_word_from_dictionary.rb'
+
+  require 'gtk_paradise/requires/require_the_base_module.rb'
+  include ::Gtk::BaseModule
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Dictionary'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = '25% or minimum 200px'
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = '25% or minimum 200px'
+
+  # ========================================================================= #
+  # === USE_THIS_FONT
+  # ========================================================================= #
+  USE_THIS_FONT = :dejavu_condensed_22
+
+  # ========================================================================= #
+  # === SMALLER_FONT
+  #
+  # This one should be relative to the font used above.
+  # ========================================================================= #
+  SMALLER_FONT = :dejavu_condensed_18
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already           = true
+    )
+    super(:vertical)
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    reset_the_internal_variables
+    # ======================================================================= #
+    # === @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)
+    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 = []
+    handle_CSS
+  end
+
+  # ========================================================================= #
+  # === handle_CSS
+  # ========================================================================= #
+  def handle_CSS
+    use_gtk_paradise_project_css_file
+  end
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    2
+  end
+
+  # ========================================================================= #
+  # === border_size?
+  # ========================================================================= #
+  def border_size?
+    2
+  end
+
+  # ========================================================================= #
+  # === e
+  # ========================================================================= #
+  def e(i = '')
+    ::Dictionaries.e(i)
+  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 = gtk_hbox
+    hbox1.minimal(button, 1)
+    hbox1.halign_center
+    minimal(hbox1, 5)
+  end
+
+  # ========================================================================= #
+  # === create_answer_field
+  #
+  # This method builds up the "answer-widget".
+  # ========================================================================= #
+  def create_answer_field
+    # ======================================================================= #
+    # === @answer_field
+    # ======================================================================= #
+    @answer_field = gtk_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 = gtk_vbox
+    bold_label = gtk_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 = gtk_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 = gtk_hbox
+    small_hbox.minimal(button_for_the_remote_query, 1)
+    small_hbox.halign_center
+    bottom_vbox.minimal(
+      small_hbox, 2
+    )
+    maximal(bottom_vbox, 2)
+  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
+
+  # ========================================================================= #
+  # === 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
+
+  # ========================================================================= #
+  # === create_the_statistics_frame
+  # ========================================================================= #    
+  def create_the_statistics_frame
+    # ======================================================================= #
+    # === @frame_statistics
+    # ======================================================================= #
+    @frame_statistics = gtk_frame(' Statistics ')
+    @frame_statistics.make_bold
+    @frame_statistics.use_this_font = smaller_font?
+    vbox = gtk_vbox
+    @label_currently_selected_file = gtk_label(return_currently_selected_file)
+    vbox.minimal(
+      @label_currently_selected_file, 0
+    )
+    @frame_statistics.add(vbox)
+  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_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 create_input_field_on_top
+    text_for_the_label = 'Input an english word in the field below'
+    text = gtk_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 = gtk_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 = gtk_entry_completion
+    @input_field.completion = completion # Assign the completion.
+    completion_model = gtk_list_store(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 = gtk_vbox(
+      text, @input_field
+    )
+    minimal(hbox_holding_label_and_input_field, 2)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    super()
+    update_the_statistics_frame
+    do_style_the_important_buttons
+    show_all
+  end
+
+  # ========================================================================= #
+  # === smaller_font?
+  # ========================================================================= #
+  def smaller_font?
+    SMALLER_FONT
+  end
+
+  # ========================================================================= #
+  # === create_the_header_bar
+  # ========================================================================= #
+  def create_the_header_bar
+    # ======================================================================= #
+    # === @header_bar
+    # ======================================================================= #
+    @header_bar = default_header_bar
+    @header_bar.title = 'Dictionary'
+  end
+
+  # ========================================================================= #
+  # === create_skeleton                            (create tag, skeleton tag)
+  # ========================================================================= #
+  def create_skeleton
+    create_the_entries
+    create_the_header_bar
+    add_the_header_bar
+    create_input_field_on_top
+    create_answer_field
+    create_the_statistics_frame
+  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 = gtk_entry
+    @entry_at_the_bottom_showing_the_result_from_online_leo.center
+  end
+
+  # ========================================================================= #
+  # === add_the_header_bar
+  # ========================================================================= #
+  def add_the_header_bar
+    minimal(@header_bar, 1)
+  end
+
+  # ========================================================================= #
+  # === add_the_statistics_frame
+  # ========================================================================= #
+  def add_the_statistics_frame
+    maximal(@frame_statistics, 2)
+  end
+
+  # ========================================================================= #
+  # === add_the_answer_field
+  # ========================================================================= #
+  def add_the_answer_field
+    minimal(@answer_field) # ← Translation appears here.
+  end
+
+  # ========================================================================= #
+  # === connect_skeleton                                        (connect tag)
+  # ========================================================================= #
+  def connect_skeleton
+    abort_on_exception
+    add_the_answer_field
+    add_ask_the_question_button
+    add_the_widget_for_remote_query_of_the_dictionary_at_leo
+    add_the_statistics_frame
+  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
+
+  # ========================================================================= #
+  # === Dictionaries::GUI::Gtk::Dictionary.run
+  #
+  # Use this method if you wish to start a new gtk-application window.
+  # ========================================================================= #
+  def self.run(
+      i = ARGV
+    )
+    require 'gtk_paradise/app/app.rb'
+    _ = ::Dictionaries::GUI::Gtk::Dictionary.new(i)
+    r = ::Gtk.run
+    r << _
+    r.automatic_size_then_automatic_title
+    r.enable_quick_exit
+    r.border_width = 12
+    r.top_left_then_run
+  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::Gtk::Dictionary.run
+end

data/lib/dictionaries/gui/tk/README.md

@@ -0,0 +1,2 @@
+This directory includes experimental tk code. The main GUI is
+ruby-gtk, so this is just a fallback.

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

@@ -0,0 +1,85 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Dictionaries::GUI::Tk::Dictionary
+#
+# This is a small TK-wrapper.
+# =========================================================================== #
+# require 'dictionaries/gui/tk/dictionary.rb'
+# =========================================================================== #
+begin
+  require 'tk'
+rescue LoadError; end
+require 'dictionaries/class/ask_word_from_dictionary.rb'
+require 'dictionaries/toplevel_methods/e.rb'
+
+module Dictionaries
+
+module GUI
+
+module Tk
+
+class Dictionary < ::TkFrame # < Base === Dictionaries::GUI::Tk::Dictionary.new
+
+  include Colours::E
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    super()
+    reset
+    set_input(i)
+    title "TK wrapper for the Dictionaries project"
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    TkLabel.new(root) do
+     text 'Hello, World!'
+     pack { padx 15 ; pady 15; side 'left' }
+    end
+  end
+ 
+  # ========================================================================= #
+  # === Dictionaries::GUI:Tk::Dictionary[]
+  # ========================================================================= #
+  def self.[](i = '')
+    self.new(i)
+  end
+
+end; end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Dictionaries::GUI:Tk::Dictionary.new(ARGV)
+  ::Tk.mainloop
+end # dictionary.rb

data/lib/dictionaries/project/project_base_directory.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'dictionaries/project/project_base_directory.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
+
+end

data/lib/dictionaries/project/project_yaml_directory.rb

@@ -0,0 +1,25 @@
+#!/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_yaml_directory.rb'
+# =========================================================================== #
+require 'dictionaries/project/project_base_directory.rb'
+
+module Dictionaries
+
+  # ========================================================================= #
+  # === 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,11 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'dictionaries/require_project/require_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'