dictionaries 0.3.70

data/lib/dictionaries/commandline/parse_commandline.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'dictionaries/commandline/parse_commandline.rb'
+# =========================================================================== #
+module Dictionaries
+
+  require 'dictionaries/toplevel_methods/show_help.rb'
+  require 'dictionaries/class/class.rb'
+  require 'dictionaries/statistics/statistics.rb'
+
+  # ========================================================================= #
+  # === Dictionaries.start_gtk_component
+  #
+  # This module-method will start the GTK component.
+  # ========================================================================= #
+  def self.start_gtk_component
+    require 'dictionaries/gui/gtk3/dictionary/dictionary.rb'
+    Dictionaries::GUI::Gtk::Dictionary.run
+  end
+
+  # ========================================================================= #
+  # === Dictionaries.parse_commandline
+  # ========================================================================= #
+  def self.parse_commandline(
+      i = ARGV
+    )
+    if i.is_a? Array
+      i.each {|entry| parse_commandline(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === dictionaries --stats
+      #
+      # This entry point allows the user to show some statistics about
+      # this project.
+      # ===================================================================== #
+      when /^-?-?stats\??$/i,
+           /^-?-?statistics\??$/i
+        Dictionaries::Statistics.report
+      # ===================================================================== #
+      # === dictionaries --read=www.nytimes.com.html
+      # ===================================================================== #
+      when /^-?-?read=(.+)$/i
+        _ = $1.to_s.dup
+        require 'dictionaries/toplevel_methods/misc.rb'
+        if File.exist? _
+          e 'Finding unique words ... this may take a while. Please be'
+          e 'patient.'
+          unique_words = ::Dictionaries.return_unique_words_from_this_file(_, :default, :remove_HTML_tags).sort
+          pp unique_words
+          e 'n entries: '+unique_words.size.to_s
+        else
+          e 'No file exists at '+sfile(_)+'.'
+        end
+      # ===================================================================== #
+      # === dictionaries --gui
+      # ===================================================================== #
+      when /^-?-?gui$/i,
+           /^-?-?gtk$/i,
+           /^-?-?start(-|_)?gtk$/i
+        start_gtk_component
+      # ===================================================================== #
+      # === dictionaries --sinatra
+      # ===================================================================== #
+      when /^-?-?sinatra$/i
+        require 'dictionaries/sinatra/app.rb'
+        Dictionaries.start_sinatra_interface
+      # ===================================================================== #
+      # === dictionaries --n-words?
+      # ===================================================================== #
+      when /^-?-?n(_|-)?words\??$/i
+        e "#{Colours.sfancy(Dictionaries.n_entries?)} english-to-german "\
+          "translations are presently registered in this project."
+      # ===================================================================== #
+      # === dictionaries --help
+      # ===================================================================== #
+      when /help/
+        show_help
+      end
+    end
+  end
+
+end

data/lib/dictionaries/constants/constants.rb

@@ -0,0 +1,134 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'dictionaries/constants/constants.rb'
+# =========================================================================== #
+
+module Dictionaries
+
+  require 'dictionaries/project/project.rb'
+  require 'dictionaries/version/version.rb'
+
+  # ========================================================================= #
+  # === Dictionaries::N
+  # ========================================================================= #
+  N = "\n"
+
+  # ========================================================================= #
+  # === Dictionaries::URL_FOR_DICT_LEO
+  # ========================================================================= #
+  URL_FOR_DICT_LEO = 'http://dict.leo.org/'
+
+  # ========================================================================= #
+  # === URL_FOR_ITALIAN_DICTIONARY
+  # ========================================================================= #
+  URL_FOR_ITALIAN_DICTIONARY = 'http://www.wordreference.com/iten/'
+
+  # ========================================================================= #
+  # === LPAD
+  # ========================================================================= #
+  LPAD = '  '
+
+  # ========================================================================= #
+  # === RUBY_SRC
+  # ========================================================================= #
+  if ENV['RUBY_SRC']
+    RUBY_SRC = ENV['RUBY_SRC'].to_s.dup+'/'
+  else # else we just hardcode it anyway.
+    RUBY_SRC = '/home/x/programming/ruby/src/'
+  end
+
+  # ========================================================================= #
+  # === MY_DICTIONARIES
+  #
+  # This constant is only valid for my own system.
+  # ========================================================================= #
+  MY_DICTIONARIES = "#{RUBY_SRC}dictionaries/lib/dictionaries/yaml/"
+
+  # ========================================================================= #
+  # === SCIENCE_DIR
+  # ========================================================================= #
+  SCIENCE_DIR = ENV['SCIENCE'].to_s+'/'
+
+  # ========================================================================= #
+  # === DEPOT_INFORMATION_DIR
+  # ========================================================================= #
+  DEPOT_INFORMATION_DIR = '/Depot/Information/'
+
+  # ========================================================================= #
+  # === DICTIONARIES_DIR
+  #
+  # This constant will point at a path such as this one here:
+  #
+  #   /Programs/Ruby/2.6.3/lib/ruby/site_ruby/2.6.0/dictionaries/yaml/
+  #
+  # ========================================================================= #
+  DICTIONARIES_DIR = Dictionaries.dictionary_directory?
+
+  # ========================================================================= #
+  # === ENGLISH_WORDS
+  #
+  # This constant is no longer that important because we can now
+  # automatically infer the name of the .yml file.
+  # ========================================================================= #
+  ENGLISH_WORDS = DICTIONARIES_DIR+'english.yml'
+  ENGLISH_YAML_FILE = ENGLISH_WORDS  # === ENGLISH_YAML_FILE
+  FILE_ENGLISH_WORDS = ENGLISH_WORDS # === FILE_ENGLISH_WORDS
+  FILE_ENGLISH_DICTIONARY = ENGLISH_YAML_FILE
+
+  # ========================================================================= #
+  # === Dictionaries.file_english
+  # ========================================================================= #
+  def self.file_english
+    FILE_ENGLISH_DICTIONARY
+  end; self.instance_eval { alias file_english? file_english } # === Dictionaries.file_english?
+
+  # ========================================================================= #
+  # === ITALIAN_WORDS
+  #
+  # This constant is no longer that important because we can now
+  # automatically infer the name of the .yml file.
+  # ========================================================================= #
+  ITALIAN_WORDS = DICTIONARIES_DIR+'italian.yml'
+  ITALIAN_YAML_FILE = ITALIAN_WORDS
+  FILE_ITALIAN_DICTIONARY = ITALIAN_YAML_FILE
+
+  # ========================================================================= #
+  # === STORE_LINE_NUMBER_HERE
+  # ========================================================================= #
+  STORE_LINE_NUMBER_HERE = DEPOT_INFORMATION_DIR+'line_number_of_the_last_word'
+
+  # ========================================================================= #
+  # === STORE_LAST_ENGLISH_QUESTION_ASKED_HERE
+  # ========================================================================= #
+  STORE_LAST_ENGLISH_QUESTION_ASKED_HERE =
+    DEPOT_INFORMATION_DIR+'last_english_question_asked' # cat $MY_TEMP/last_english_question_asked
+
+  # ========================================================================= #
+  # === STORE_LAST_ITALIAN_QUESTION_ASKED_HERE
+  # ========================================================================= #
+  STORE_LAST_ITALIAN_QUESTION_ASKED_HERE =
+    DEPOT_INFORMATION_DIR+'last_italian_question_asked' # cat $MY_TEMP/last_italian_question_asked
+
+  # ========================================================================= #
+  # === SHALL_WE_DOWNCASE
+  # ========================================================================= #
+  SHALL_WE_DOWNCASE = true
+
+  # ========================================================================= #
+  # === USE_THIS_ENCODING
+  #
+  # This is the main encoding to use.
+  # ========================================================================= #
+  USE_THIS_ENCODING = 'ISO-8859-1'
+    MAIN_ENCODING = USE_THIS_ENCODING
+
+  # ========================================================================= #
+  # === DEFAULT_DELAY
+  #
+  # Specify how long to wait before revealing the translated word.
+  # ========================================================================= #
+  DEFAULT_DELAY = 1.6
+
+end

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/class.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/run'
+    _ = ::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.