dictionaries 0.2.184

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 543e04679b80ce72082208e97783a6df1cacd35371410a86a1394d2a66614efe
+  data.tar.gz: 96d6192afb769000399a4f3425b2417421acc231b9480a90602ec9eaa5e0ec2b
+SHA512:
+  metadata.gz: 7013aadc2d6a56e90e94f58b1606cc8842790d9da60df19b6a54a407a46d24736a6c943bc6ef57d3ec4c07475e3d59fa5b26e8ffc6d77425ba37f245f555f315
+  data.tar.gz: bcdef37d043a0a63883745682850e4f8bebeb95fa1442b8b1ee36af3d487e191c0456e57a3645ad2e22629c55fa4d63f413142ffd20af46f51d5ca372babba4a

data/README.md

@@ -0,0 +1,136 @@
+[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](https://www.gobolinux.org/)
+[![forthebadge](http://forthebadge.com/images/badges/made-with-ruby.svg)](https://www.ruby-lang.org/en/)
+[![Gem Version](https://badge.fury.io/rb/dictionaries.svg)](https://badge.fury.io/rb/dictionaries)
+
+## GUI component
+
+The **GUI component** of the dictionaries gem currently
+defaults to **GTK2**.
+
+It is in a very early, incomplete beta stage.
+
+First, install the gtk2 gem:
+
+    gem install gtk2
+
+Then install the gtk_module:
+
+    gem install gtk_module
+
+Now you can start the GUI component:
+
+    dictionaries --gui
+
+See also the help options.
+
+    dictionaries --help
+
+## Environment variable to use a specific yaml file
+
+You can use an <b>environment variable</b> to denote the default
+yaml file in use. This allows you to use your own yaml file
+format, rather than the yaml files that are distributed with
+this gem.
+
+The name of that environment variable must be <b>DICTIONARIES_FILE</b>.
+It shall point to your yaml file that holds the key-value pairs.
+
+For example, if your file is at /opt/czech.yml, then
+DICTIONARIES_FILE should point at that location.
+
+In bash, this may be equivalent to:
+
+    export DICTIONARIES_FILE=/opt/czech.yml
+
+Note that in the long run, the dictionaries gem could be extended
+with these yaml files - or allow means to download these files
+over the www. But before we can do so, let's aim for at the least
+100 words in such a file before we would consider distributing
+it or offering means to distribute said file.
+
+## sinatra
+
+To start the sinatra interface, do:
+
+    dictionaries --sinatra
+
+## Difficult english sentences
+
+English is not the most difficult language in the world, but when it
+comes to proper pronounciation of words, english can be surprisingly
+difficult.
+
+This subsection may keep a listing of sentences that, for one reason
+or the other, can be somewhat difficult to **read out aloud** without
+mistake, on a first try. It is just a fun-subsection, not meant to be
+taken too seriously; and it is quite subjective.
+
+Without any further ado, here comes a listing of sentences that may
+be difficult to pronounce properly so:
+
+    I would like to distribute something.
+
+## Obtaining all translations into german for a given english word
+
+Since as of November 2020 the following API exists:
+
+    Dictionaries.return_array_of_translated_words_from_online_leo('cat')
+    Dictionaries.return_array_of_translated_words_from_online_leo('dog')
+    Dictionaries.return_array_of_translated_words_from_online_leo('human')
+
+This will return an Array of german names. It does not work 100% perfectly
+as it is based on a regex; and using a regex to parse HTML is never a
+trivial way. But if you just want to get the first entry, just call
+.first on it, and in most cases this is the best, most likely
+translation available.
+
+The regex has to find matches to entries such as the following one:
+
+    </repr><words><word>der Jazzfan</word></words>
+
+Anyone to come up with a more accurate regex is welcome to share it. :)
+
+This functionality was specifically necessary because I needed to
+use this in the ruby-gtk bindings for this project.
+
+## Dictionaries.return_unique_words_from_this_file
+
+This method will return all words that are presently not registered
+in the english dictionary.
+
+The idea here is for me to slowly add more english words into the
+yaml file. I won't add every english word that exists, but I will
+try to aim for a seizable number in the long run, such as 
+5000 english words - already halfway there. \o/
+ 
+## Licence
+
+Until the 17th of October 2019, this project was using the GPLv2
+licence (no later clause).
+
+However had, I believe that the GPLv2 licence is not great for
+a project that focuses on existing words in real languages, aka
+dictionaries. Thus, I have decided to change the licence into
+the MIT licence on that day (17.11.2019, in dd.mm.yyyy notation).
+
+So the gem is now MIT licenced. \o/
+
+For a description of that licence, see
+https://opensource.org/licenses/MIT.
+
+
+## Contact information
+
+If your creative mind has ideas and specific suggestions to make this
+gem more useful in general, feel free to drop me an email at any
+time, via:
+
+    shevegen@gmail.com
+
+(Do keep in mind that responding to emails may take some time, depending
+on the amount of work I may have at that moment, due to reallife. I will,
+however had, read feedback. Patches and code changes are welcome too
+of course, as long as they are in the spirit of the project at
+hand, e. g. fitting to the general theme.)
+
+Thank you.

data/bin/dictionaries

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'dictionaries'
+
+Dictionaries.parse_commandline(ARGV)

data/bin/unique_words_in_this_file

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'dictionaries'
+
+pp Dictionaries.return_unique_words_from_this_file(ARGV)

data/dictionaries.gemspec

@@ -0,0 +1,85 @@
+# =========================================================================== #
+# Gemspec for Project Dictionaries.
+# =========================================================================== #
+require 'dictionaries/ask_english_word.rb'
+require 'dictionaries/version/version.rb'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'dictionaries'
+  s.version = Dictionaries::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+
+  DESCRIPTION = <<-EOF
+
+This project is called dictionaries.
+
+It used to be called ask_english_words but the name was changed towards
+"dictionaries", when the focus became on dictionaries in general rather
+than merely translations from and to the english language.
+
+There are a total of #{Dictionaries.n_entries?} english words
+registered, with the associated german translation. (It is
+german primarily because that is my native language, but in
+principle this project could be extended to include other
+languages as well. You only need to add a yaml file containing
+the key-value pairs.)
+
+If you need a more comprehensive dictionary, I can recommend
+the file de-en.txt that is part of the tu-chemnitz 
+distribution ( https://www-user.tu-chemnitz.de/~fri/ding/ ). That
+file is really huge - about 20 MB.
+
+In principle, the dictionaries project could be extended to 
+make use of that massive file instead. I will be thinking
+about this for the time being (starting at July 2018).
+
+  EOF
+
+  s.summary     = DESCRIPTION
+  s.description = DESCRIPTION
+
+  # ========================================================================= #
+  # Show this message when a user installs this project.
+  # ========================================================================= #
+  s.post_install_message = <<-EOF
+
+  This project can ask or translate english or italian words (or words
+  from any other language, as long as a .yml file is supplied that
+  contains these key-value pair entries).
+
+  This project is probably not very useful for other people, but it helps
+  me to improve my knowledge about the english or italian language or
+  any other language.
+
+  For more information, have a look at the main README.md file, which
+  can also be found on the hompage of this gem at rubygems.org, on
+  the bottom right side (see https://www.rubydoc.info/gems/dictionaries/ ).
+
+  EOF
+  
+  s.extra_rdoc_files = %w()
+
+  s.authors  = ['Robert A. Heiler']
+  s.email    = 'shevegen@gmail.com'
+  s.files    = Dir['**/*']
+  # s.files   << 'README.md'
+  # s.files   << 'USAGE.md'
+  s.license  = 'MIT'
+  s.homepage = 'https://www.rubydoc.info/gems/dictionaries/'
+
+  s.required_ruby_version     = '>= '+RUBY_VERSION
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  # ========================================================================= #
+  # External dependencies for the project:
+  # ========================================================================= #
+  s.add_dependency 'colours'
+  s.add_dependency 'generate_shell_completion'
+  s.add_dependency 'opn'
+  s.add_dependency 'open_in_browser'
+  s.add_dependency 'save_file'
+  s.add_dependency 'xorg_buffer'
+
+}

data/doc/README.gen

@@ -0,0 +1,119 @@
+ADD_RUBY_BADGE
+
+## GUI component
+
+The **GUI component** of the dictionaries gem currently
+defaults to **GTK2**.
+
+It is in a very early, incomplete beta stage.
+
+First, install the gtk2 gem:
+
+    gem install gtk2
+
+Then install the gtk_module:
+
+    gem install gtk_module
+
+Now you can start the GUI component:
+
+    dictionaries --gui
+
+See also the help options.
+
+    dictionaries --help
+
+## Environment variable to use a specific yaml file
+
+You can use an <b>environment variable</b> to denote the default
+yaml file in use. This allows you to use your own yaml file
+format, rather than the yaml files that are distributed with
+this gem.
+
+The name of that environment variable must be <b>DICTIONARIES_FILE</b>.
+It shall point to your yaml file that holds the key-value pairs.
+
+For example, if your file is at /opt/czech.yml, then
+DICTIONARIES_FILE should point at that location.
+
+In bash, this may be equivalent to:
+
+    export DICTIONARIES_FILE=/opt/czech.yml
+
+Note that in the long run, the dictionaries gem could be extended
+with these yaml files - or allow means to download these files
+over the www. But before we can do so, let's aim for at the least
+100 words in such a file before we would consider distributing
+it or offering means to distribute said file.
+
+## sinatra
+
+To start the sinatra interface, do:
+
+    dictionaries --sinatra
+
+## Difficult english sentences
+
+English is not the most difficult language in the world, but when it
+comes to proper pronounciation of words, english can be surprisingly
+difficult.
+
+This subsection may keep a listing of sentences that, for one reason
+or the other, can be somewhat difficult to **read out aloud** without
+mistake, on a first try. It is just a fun-subsection, not meant to be
+taken too seriously; and it is quite subjective.
+
+Without any further ado, here comes a listing of sentences that may
+be difficult to pronounce properly so:
+
+    I would like to distribute something.
+
+## Obtaining all translations into german for a given english word
+
+Since as of November 2020 the following API exists:
+
+    Dictionaries.return_array_of_translated_words_from_online_leo('cat')
+    Dictionaries.return_array_of_translated_words_from_online_leo('dog')
+    Dictionaries.return_array_of_translated_words_from_online_leo('human')
+
+This will return an Array of german names. It does not work 100% perfectly
+as it is based on a regex; and using a regex to parse HTML is never a
+trivial way. But if you just want to get the first entry, just call
+.first on it, and in most cases this is the best, most likely
+translation available.
+
+The regex has to find matches to entries such as the following one:
+
+    </repr><words><word>der Jazzfan</word></words>
+
+Anyone to come up with a more accurate regex is welcome to share it. :)
+
+This functionality was specifically necessary because I needed to
+use this in the ruby-gtk bindings for this project.
+
+## Dictionaries.return_unique_words_from_this_file
+
+This method will return all words that are presently not registered
+in the english dictionary.
+
+The idea here is for me to slowly add more english words into the
+yaml file. I won't add every english word that exists, but I will
+try to aim for a seizable number in the long run, such as 
+5000 english words - already halfway there. \o/
+ 
+## Licence
+
+Until the 17th of October 2019, this project was using the GPLv2
+licence (no later clause).
+
+However had, I believe that the GPLv2 licence is not great for
+a project that focuses on existing words in real languages, aka
+dictionaries. Thus, I have decided to change the licence into
+the MIT licence on that day (17.11.2019, in dd.mm.yyyy notation).
+
+So the gem is now MIT licenced. \o/
+
+For a description of that licence, see
+https://opensource.org/licenses/MIT.
+
+ADD_CONTACT_INFORMATION

data/lib/dictionaries.rb

@@ -0,0 +1 @@
+require 'dictionaries/require_project/require_project.rb'

data/lib/dictionaries/ask_english_word.rb

@@ -0,0 +1,141 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Dictionaries::AskEnglishWord
+#
+# Use this class to ask a random english word.
+#
+# There are two ways to use this class:
+#
+# - Pass in an optional argument to it, which we will use to query this
+#   word from the database.
+#
+# - Pass nothing to it, in which case we load a random entry.
+#
+# Specific usage examples:
+#
+#   require 'dictionaries'
+#   Dictionaries::AskEnglishWord.new
+#   Dictionaries.ask_english_word
+#
+# =========================================================================== #
+# require 'dictionaries/ask_english_word.rb'
+# Dictionaries.path_to_the_english_file?
+# =========================================================================== #
+require 'dictionaries/class/ask_word_from_dictionary.rb'
+
+module Dictionaries
+
+class AskEnglishWord < AskWordFromDictionary
+
+  # ========================================================================= #
+  # === DATA
+  # ========================================================================= #
+  if defined?(DATA) == 'constant'
+    if DATA.respond_to? :read
+      _ = DATA.read
+    else
+      e 'DATA does not respond to :read'
+    end
+  else
+    _ = ''
+  end
+
+  # ========================================================================= #
+  # === DEFAULT_DELAY
+  # ========================================================================= #
+  if _.to_s.empty? # Next, define the default delay.
+    DEFAULT_DELAY = 2.2 # How long to wait before asking a question.
+  else
+    _ = _.first if _.is_a? Array
+    DEFAULT_DELAY = _.strip.to_f
+  end
+
+  # ========================================================================= #
+  # === AskEnglishWord::THIS_FILE
+  # ========================================================================= #
+  THIS_FILE = THIS_FILE_HERE = __FILE__.to_s
+
+  unless ENV['DICTIONARIES_FILE'] and File.exist?(ENV['DICTIONARIES_FILE'])
+    Dictionaries.set_main_file(THIS_FILE) # Assign it at once.
+  end
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV
+    )
+    super(commandline_arguments, self.class.main_file?)
+  end
+
+  # ========================================================================= #
+  # === Dictionaries::AskEnglishWord.main_file?
+  # ========================================================================= #
+  def self.main_file?
+    Dictionaries.main_file?
+  end
+
+  # ========================================================================= #
+  # === Dictionaries::AskEnglishWord.dataset?
+  #
+  # Note that this method will load the dataset from the main file anew
+  # whenever you invoke it.
+  # ========================================================================= #
+  def self.dataset?
+    YAML.load_file(self.main_file?)
+  end
+
+  # ========================================================================= #
+  # === Dictionaries::AskEnglishWord.n_entries?
+  #
+  # Feedback how many entries are registered.
+  # ========================================================================= #
+  def self.n_entries?
+    _ = dataset?
+    n_entries = _.size
+    return n_entries
+  end; self.instance_eval { alias n_questions? n_entries? } # === AskEnglishWord.n_questions?
+
+  # ========================================================================= #
+  # === Dictionaries::AskEnglishWord[]
+  # ========================================================================= #
+  def self.[](i)
+    self.new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Dictionaries.ask_english_word
+# =========================================================================== #
+def self.ask_english_word
+  AskEnglishWord.new
+end
+
+# =========================================================================== #
+# === Dictionaries.path_to_the_english_file?
+#
+# This method may return a String, as a file path, such as
+# "/home/Programs/Ruby/2.7.2/lib/ruby/site_ruby/2.7.0/dictionaries/yaml/english.yml".
+# =========================================================================== #
+def self.path_to_the_english_file?
+  Dictionaries.main_file?
+end
+
+# =========================================================================== #
+# === Dictionaries.n_entries?
+# =========================================================================== #
+def self.n_entries?
+  ::Dictionaries::AskEnglishWord.n_entries?
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Dictionaries::AskEnglishWord.new(ARGV)
+end # askeng
+# This is the delay to use for this class.
+__END__
+1.8