dictionaries 0.3.24

data/lib/dictionaries/sinatra/app.rb

@@ -0,0 +1,118 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Dictionaries::Sinatra
+# =========================================================================== #
+# require 'dictionaries/sinatra/app.rb'
+# =========================================================================== #
+require 'sinatra/base.rb'
+
+module Dictionaries
+
+class Sinatra < ::Sinatra::Base
+
+  require 'dictionaries/class/ask_word_from_dictionary.rb'
+  require 'dictionaries/toplevel_methods/is_on_roebe.rb'
+  require 'dictionaries/sinatra/english_to_german.rb'
+
+  include ::Colours
+  include ::Colours::E
+  begin
+    require 'html_tags'
+    include HtmlTags::BaseModule
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === USE_THIS_PORT
+  # ========================================================================= #
+  USE_THIS_PORT = '5252'
+
+  set :port, USE_THIS_PORT
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i = ARGV
+    )
+    super()
+    reset
+    consider_opening_the_page_in_the_browser(i)
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+  end
+
+  # ========================================================================= #
+  # === consider_opening_the_page_in_the_browser
+  # ========================================================================= #
+  def consider_opening_the_page_in_the_browser(
+      shall_we_open_the_page_in_the_browser = ::Dictionaries.is_on_roebe?
+    )
+    case shall_we_open_the_page_in_the_browser
+    # ======================================================================= #
+    # === :do_not_open_in_the_browser
+    # ======================================================================= #
+    when :do_not_open_in_the_browser,
+         :dont_connect,
+         :dont
+      shall_we_open_the_page_in_the_browser = false
+    end
+    if shall_we_open_the_page_in_the_browser
+      begin
+        require 'open'
+      rescue LoadError; end
+      # ===================================================================== #
+      # Tell us which port will be used:
+      # ===================================================================== #
+      target = "http://localhost:#{USE_THIS_PORT}/"
+      e sfancy(target)
+      Thread.new {
+        sleep 0.8
+        Open.in_browser(target)
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === / Entry point
+  #
+  # This is the root of our web-application.
+  # ========================================================================= #
+  get('/'){
+    html_header_default_title_and_start_of_the_body_tag+
+    p('The following translation-tables are available:')+
+    HtmlTags.a('/english_to_german', css_style: 'margin-left: 2em')+
+    br+
+    HtmlTags.a('/german_to_english', css_style: 'margin-left: 2em')+
+    br
+  }
+
+  # ========================================================================= #
+  # === not_found
+  # ========================================================================= #
+  not_found {
+    p('This particular <b>API</b> was not found.')
+  }
+
+end
+
+# =========================================================================== #
+# === Dictionaries.start_sinatra_interface
+#
+# This method can be used to start the sinatra interface.
+# =========================================================================== #
+def self.start_sinatra_interface
+  e 'Trying to start the sinatra-interface of the Dictionaries project.'
+  ::Dictionaries::Sinatra.run!
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Dictionaries.start_sinatra_interface
+end # dictionaries --sinatra

data/lib/dictionaries/sinatra/english_to_german.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# 'dictionaries/english_to_german.rb'
+# =========================================================================== #
+require 'sinatra/base.rb'
+
+module Dictionaries
+
+class Sinatra < ::Sinatra::Base
+
+  require 'dictionaries/toplevel_methods/english_to_german.rb'
+  require 'dictionaries/helper_module/helper_module.rb'
+
+  # ========================================================================= #
+  # === /english_to_german
+  #
+  # This is the root of our web-application.
+  # ========================================================================= #
+  get('/english_to_german'){
+    return_english_to_german_form
+  }
+
+  # ========================================================================= #
+  # === return_english_to_german_form
+  # ========================================================================= #
+  def return_english_to_german_form
+    route_to_this_action = '/english_to_german/'
+    html_header_default_title_and_start_of_the_body_tag+
+    h5('Input an english word to see the translation.')+
+    div(css_style: 'padding: 0.1em') {
+      p(
+        '<b>Enter the word here:</b>',
+        css_style: 'padding: 0.15em'
+      )+
+      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
+
+  # ========================================================================= #
+  # === html_header_default_title_and_start_of_the_body_tag
+  # ========================================================================= #
+  def html_header_default_title_and_start_of_the_body_tag
+    return Dictionaries::HelperModule.html_header_default_title_and_start_of_the_body_tag
+  end
+
+  # ========================================================================= #
+  # === return_search_button
+  # ========================================================================= #
+  def return_search_button
+    return Dictionaries::HelperModule.return_search_button
+  end
+
+  # ========================================================================= #
+  # === /english_to_german
+  #
+  # This is the root of our web-application.
+  # ========================================================================= #
+  get('/english_to_german/*'){
+    _ = params[:splat]
+    _ = params.fetch('user_input') if params.has_key?('user_input')
+    _ = _.join if _.is_a? Array
+    # ======================================================================= #
+    # Obtain the translated word next:
+    # ======================================================================= #
+    translated_word = Dictionaries.english_to_german(_)
+    if translated_word
+      html_header_default_title_and_start_of_the_body_tag+
+      p('The word <b>'+_.to_s+'</b> translates to: '\
+      '<b style="font-size: larger; color: darkblue">'+translated_word+'</b>')+
+      return_english_to_german_form
+    else
+      html_header_default_title_and_start_of_the_body_tag+
+      p('The key '+_.to_s+' is not registered in the Dictionaries word file.')
+    end
+  }
+
+end; end

data/lib/dictionaries/statistics/statistics.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Dictionaries::Statistics
+# =========================================================================== #
+# require 'dictionaries/statistics/statistics.rb'
+# =========================================================================== #
+module Dictionaries
+
+module Statistics # === Dictionaries::Statistics
+
+  require 'dictionaries/constants.rb'
+  require 'dictionaries/toplevel_methods/misc.rb'
+  require 'dictionaries/project/project.rb'
+
+  # ========================================================================= #
+  # === Dictionaries::Statistics.e
+  # ========================================================================= #
+  def self.e(i = '')
+    puts i
+  end
+
+  # ========================================================================= #
+  # === Dictionaries::Statistics.report
+  # ========================================================================= #
+  def self.report
+    require 'yaml'
+    begin
+      require 'colours'
+    rescue LoadError; end
+    all_files = Dir[
+      Dictionaries.project_yaml_dir?+'*'
+    ].reject {|entry| entry.include?('deutsche_fremdwörter.yml') }
+    e 'The statistics for each .yml file available in this project are'
+    e 'as follows:'
+    e
+    all_files.each {|this_file|
+      begin
+        dataset = YAML.load_file(this_file)
+        if dataset
+          e "  #{File.basename(this_file).delete_suffix('.yml').ljust(15)} "+
+            "#{::Colours.steelblue(dataset.keys.size.to_s.rjust(4))} words."
+        else
+          e 'No data is available for '+this_file+'.'
+        end
+      rescue => error
+        pp error
+      end
+    }
+    e
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Dictionaries::Statistics.report
+end # statistics.rb

data/lib/dictionaries/toplevel_methods/e.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'dictionaries/toplevel_methods/e.rb'
+# =========================================================================== #
+module Dictionaries
+
+  # ========================================================================= #
+  # === Dictionaries.e
+  # ========================================================================= #
+  def self.e(i = '')
+    puts i
+  end
+
+end

data/lib/dictionaries/toplevel_methods/english_to_german.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'dictionaries/toplevel_methods/english_to_german.rb'
+# =========================================================================== #
+require 'dictionaries/toplevel_methods/has_key.rb'  
+require 'dictionaries/toplevel_methods/misc.rb'
+
+module Dictionaries
+
+  # ========================================================================= #
+  # === Dictionaries.english_to_german
+  #
+  # This method will return nil if the key has not been found in the
+  # Dictionaries dataset.
+  # ========================================================================= #
+  def self.english_to_german(i)
+    i = i.join.strip if i.is_a? Array
+    converted_word = nil
+    if Dictionaries.has_key? i
+      converted_word = Dictionaries[i]
+    end
+    converted_word
+  end; self.instance_eval { alias translate_this_from_english_to_german english_to_german } # === Dictionaries.translate_this_from_english_to_german
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pp Dictionaries.english_to_german(ARGV)
+end

data/lib/dictionaries/toplevel_methods/has_key.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'dictionaries/toplevel_methods/has_key.rb'
+# Dictionaries.has_key?
+# =========================================================================== #
+module Dictionaries
+
+  require 'dictionaries/ask_english_word.rb'
+
+  # ========================================================================= #
+  # === Dictionaries.has_key?
+  #
+  # Query whether the main file of the Dictionaries namespace, has the
+  # given input key at hand.
+  #
+  # Returns:
+  #   true if the key is included
+  #   false otherwise
+  #
+  # Invocation examples:
+  #
+  #   Dictionaries.has_key? 'apprehensions' # => true
+  #   Dictionaries.has_key? 'apprehensio'
+  #
+  # ========================================================================= #
+  def self.has_key?(this_key)
+    Dictionaries::AskEnglishWord.dataset?.has_key?(this_key)
+  end
+
+end

data/lib/dictionaries/toplevel_methods/is_on_roebe.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'dictionaries/toplevel_methods/is_on_roebe.rb'
+# =========================================================================== #
+module Dictionaries
+
+  # ========================================================================= #
+  # === Dictionaries.is_on_roebe?
+  # ========================================================================= #
+  def self.is_on_roebe?
+    (ENV['IS_ROEBE'].to_s == '1')
+  end
+
+end

data/lib/dictionaries/toplevel_methods/main_file.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'dictionaries/toplevel_methods/main_file.rb'
+# =========================================================================== #
+module Dictionaries
+
+  # ========================================================================= #
+  # === @main_file
+  #
+  # This module-level instance variable keeps track of the main file in
+  # use.
+  # ========================================================================= #
+  @main_file = nil
+
+  # ========================================================================= #
+  # === DICTIONARIES_FILE
+  #
+  # Add support for the environment variable DICTIONARIES_FILE here.
+  # ========================================================================= #
+  if ENV['DICTIONARIES_FILE'] and
+     File.exist?(ENV['DICTIONARIES_FILE'])
+    @main_file = ENV['DICTIONARIES_FILE'].to_s
+  end
+
+  # ========================================================================= #
+  # === Dictionaries.return_name_from_compound
+  #
+  # This method will return 'italian' if the input is 'ask_italian_word'.
+  # ========================================================================= #
+  def self.return_name_from_compound(
+      i = Dictionaries.main_file?
+    )
+    i = i.to_s
+    i = File.basename(i).gsub(/.rb/, '').gsub(/.yml/, '')
+    if i.include? '_'
+      i = i.split('_')[1] # Grab the middle part here.
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === Dictionaries.set_main_file
+  #
+  # Use this method to designate the main yaml file which should contain
+  # the language-specific translations.
+  #
+  # If the input includes a '/' token and also ends with '.rb' then we
+  # assume that it may be in the form of this:
+  #
+  #   /home/x/programming/ruby/src/dictionaries/lib/dictionaries/ask_italian_word.rb
+  #
+  # So we will instead use the second part of the last part.
+  #
+  # Usage example:
+  #
+  #   Dictionaries.set_main_file(THIS_FILE)
+  #
+  # ========================================================================= #
+  def self.set_main_file(i = :default_file)
+    case i
+    when :default_file,
+         :default
+      i = FILE_ENGLISH_WORDS
+    end
+    if i.include? '/'
+      if i.end_with? '.rb' 
+        i = File.basename(i).sub(/.rb^/,'')
+        if i.include? '_'
+          i = Dictionaries.return_name_from_compound(i) # Grab the middle part here.
+          i = DICTIONARIES_DIR+i+'.yml'
+        end
+      end
+    end
+    @main_file = i
+  end
+
+  # ========================================================================= #
+  # === Dictionaries.main_file?
+  #
+  # Query method over the @main_file module-level instance variable.
+  # ========================================================================= #
+  def self.main_file?
+    @main_file
+  end; self.instance_eval { alias main_file main_file? } # === Dictionaries.main_file
+
+end

data/lib/dictionaries/toplevel_methods/misc.rb

@@ -0,0 +1,185 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'dictionaries/toplevel_methods/misc.rb'
+# =========================================================================== #
+module Dictionaries
+
+  require 'yaml'
+  require 'dictionaries/constants.rb'
+  require 'dictionaries/toplevel_methods/main_file.rb'
+  require 'dictionaries/toplevel_methods/has_key.rb'
+
+  # ========================================================================= #
+  # === Dictionaries.generate_pdf_file
+  #
+  # This method can be used to generate a .pdf file.
+  # ========================================================================= #
+  def self.generate_pdf_file(
+      use_this_font = 'Courier', # Helvetica-Bold' #  #'Times-Roman'
+      use_this_font_size = 12
+    )
+    require 'prawn'
+    ::Prawn::Fonts::AFM.hide_m17n_warning = true
+    right_arrow = ' -> '.dup.encode(
+                    'Windows-1252', invalid: :replace, undef: :replace, replace: ''
+                  )
+    dataset = YAML.load_file(Dictionaries.file_english)
+    into = File.absolute_path('english_to_german_dictionary.pdf')
+    Prawn::Document.generate(into) {
+      font use_this_font
+      font_size use_this_font_size
+      text(
+        "English to German dictionary: "\
+        "#{dataset.keys.size.to_s} translated words\n\n"
+      )
+      # ===================================================================== #
+      # Iterate over our exam dataset next.
+      # ===================================================================== #
+      dataset.each_pair {|key, value|
+        indent(8) {
+          key   = key.dup if key.frozen?
+          value = value.dup if value.frozen?
+          result = key.encode(
+              'Windows-1252', invalid: :replace, undef: :replace, replace: ''
+            )+
+            right_arrow+
+            value.encode(
+              'Windows-1252', invalid: :replace, undef: :replace, replace: ''
+            )
+          text(result, {size: 10})
+        }
+      }
+    }
+    e 'Stored into `'+into+'`.'
+  end
+
+  # ========================================================================= #
+  # === Dictionaries[]
+  #
+  # Currently this method will always reload the main file. In the future
+  # we may change this approach, but for now this has to suffice (May 2019).
+  #
+  # The method will return either the translated string - or nil. Nil
+  # indicates that the main Hash does not include that key; in other words,
+  # that the word is not registered.
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    i = i.join.strip if i.is_a? Array
+    this_file = Dictionaries.main_file?
+    if this_file.nil?
+      Dictionaries.set_main_file(:default) # Must initialize it in this case.
+      this_file = Dictionaries.main_file?
+    end
+    if this_file
+      dataset = YAML.load_file(this_file)
+      dataset[i] # Return the result here.
+    else
+      nil
+    end
+  end
+
+  # ========================================================================= #
+  # === Dictionaries.return_array_of_translated_words_from_online_leo
+  #
+  # This method can be used to query the online dictionary from leo.
+  #
+  # It will then return an Array of translations.
+  #
+  # Note that this currently only works for the translation from english 
+  # to german, not the other way around, even though that is not too 
+  # hard to implement either.
+  # ========================================================================= #
+  def self.return_array_of_translated_words_from_online_leo(this_word)
+    if this_word.is_a? Array
+      this_word = this_word.join(' ').strip
+    end
+    require 'open-uri'
+    remote_url = "https://dict.leo.org/german-english/#{this_word}"
+    remote_dataset = URI.open(remote_url).read
+    # ======================================================================= #
+    # See: https://rubular.com/r/OOXwAc6PVqjU5Q
+    # ======================================================================= #
+    use_this_regex =
+      /<words><word>([a-zA-Z\s]+)\<\/word><\/words>/
+    scanned_results = remote_dataset.scan(use_this_regex).flatten
+    # ======================================================================= #
+    # This result may look like so:
+    #   [["cat"], ["die Katze"]
+    # We have to sanitize it still.
+    # ======================================================================= #
+    scanned_results.reject! {|entry| entry.start_with?(this_word) }
+    return scanned_results # Note that the full Array is returned.
+  end
+
+  # ========================================================================= #
+  # === Dictionaries.return_unique_words_from_this_file
+  #
+  # This method will read in the words from an existing local file.
+  #
+  # Some files may be huge, though, and then this method becomes
+  # quite useless, so we really should discard a lot of data after a
+  # certain threshold, to keep memory usage low.
+  # ========================================================================= #
+  def self.return_unique_words_from_this_file(
+      this_file,
+      optional_arguments = :english,
+      remove_html_tags   = false
+    )
+    case remove_html_tags
+    # ======================================================================= #
+    # === :remove_HTML_tags
+    # ======================================================================= #
+    when :remove_HTML_tags
+      remove_html_tags = true
+    end
+    dataset = nil
+    if this_file.is_a? Array
+      this_file = this_file.join(' ').strip
+    end
+    if this_file and File.file?(this_file)
+      dataset = File.read(this_file)
+      if remove_html_tags
+        require 'cyberweb/toplevel_methods/remove_html.rb'
+        dataset = ::Cyberweb.remove_html(dataset)
+      end
+    end
+    result = [] # ← This variable will store the unique words found in the file.
+    case optional_arguments
+    # ======================================================================= #
+    # === :english
+    # ======================================================================= #
+    when :english,
+         :default
+      # ===================================================================== #
+      # Query unknown words in english. We will compare the words to the
+      # available variants.
+      # ===================================================================== #
+      result = dataset.scan(/\w+/).map {|entry| entry.downcase } # ← Obtain all words here.
+      # ===================================================================== #
+      # Next, reject those that are registered:
+      # ===================================================================== #
+      result.reject! {|this_word|
+        ::Dictionaries.has_key?(this_word)
+      }
+    end if dataset
+    return result.uniq.sort
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  #puts Dictionaries[ARGV]
+  e 'Possible words for cat:'
+  pp Dictionaries.return_array_of_translated_words_from_online_leo('cat')
+  # ========================================================================= #
+  # The next chunk of code is to test reading unique words from a given
+  # local file.
+  # ========================================================================= #
+  puts '-'*80
+  _ = Dictionaries.return_unique_words_from_this_file('/Depot/j/foobar.md')
+  pp _
+  pp _.size
+end # rb misc.rb cat

data/lib/dictionaries/toplevel_methods/module_methods.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Just bundle together some requires through this file here.
+# =========================================================================== #
+require 'dictionaries/commandline/parse_commandline.rb'
+require 'dictionaries/toplevel_methods/e.rb'
+require 'dictionaries/toplevel_methods/show_help.rb'

data/lib/dictionaries/toplevel_methods/show_help.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'dictionaries/toplevel_methods/show_help.rb'
+# =========================================================================== #
+require 'dictionaries/toplevel_methods/e.rb'
+
+module Dictionaries
+
+  # ========================================================================= #
+  # === Dictionaries.show_help
+  #
+  # To invoke this, try:
+  #
+  #   dictionaries --help
+  #
+  # ========================================================================= #
+  def self.show_help
+    help_string = <<EOF
+These options are currently available:
+
+  --n_words?                  # Show how many words are available
+  --gui                       # Start the GTK GUI; aliases exist to this, such as --gtk
+  --read=www.nytimes.com.html # Read from a specific file, to find unique words
+
+EOF
+    e help_string
+  end
+
+end