Sprichwoerter 0.1 → 1.6

data/doc/rst/proverbs.rst

@@ -0,0 +1,117 @@
+==========
+ PROVERBS
+==========
+----------------------------------------------------------
+ Rearrange proverbs into new, mostly senseless, proverbs.
+----------------------------------------------------------
+
+*Sprichwörter* is the German name for the same program.
+
+Synopsis
+========
+
+  **proverbs**
+
+  **proverbs -[qc <COLOR>]  (--qualify --color <COLOR>)** 
+
+  **proverbs -f  (--favorites)**
+
+  **proverbs -a  (--add)**
+
+  **proverbs -h  (--help)**
+  
+  **proverbs -v  (--version)**
+
+DESCRIPTION
+============
+The program combines the beginnings and the endings of proverbs randomly picked
+from a list. The result is a phrase which is still recognizable as "kind of a
+proverb" but without claiming to convey any real message, let alone "wisdom".
+
+Yes. It is intended as a humorous waste of time. You can, for example, call
+proverbs from your *.bashrc* file.
+
+When called on the command-prompt as **proverbs** without any options, a newly
+generated proverb will be printed out on screen. 
+
+OPTIONS
+============
+
+**-a** or **--add**
+   Allows you to add a new, real proverb to the list of original proverbs. You
+   are prompted for each of the details: language (one of *en* or *de* at the
+   time of this writing), singular or plural (*s*, *p*), beginning and ending of
+   the proverb.
+
+**-f** or **--favorites**
+   Will dump the list of "qualified", random proverbs, i.e. those that had been
+   found worth saving after a previous call to proverbs.
+
+**-q** or **--qualify**
+   After a newly created proverb has been presented, you have a few seconds to
+   eventually qualify a proverb, i.e. add it to the list of favorites, by
+   pushing '+'.
+
+**-c** or **--color=COLOR**
+   Sets the color the border which sourrounds a generated proverb. Must be one
+   of red, green, yellow, purple, cyan, blue, white or black.
+
+**-h** or **--help**
+  Shows the short help-text for the program.
+
+**-v** or **--version**
+   Shows version-information
+
+ADDING PROVERBS to the default list (option -a or --add)
+------------------------------------------------------------
+At the time of this writing (october 2019), original ('real') proverbs must
+conform to the pattern
+
+"*someone or something*" | "**does or is** *something*"
+
+Just execute the program a few times on the command-line, without arguments, to
+get the idea.
+
+For the time, original proverbs are grouped with respect to their subject
+(someone or something), which is uncountable or in singular for the first group
+(like in “Fortune | favors the bold”), in plural for the second group (like
+in “All Roads | lead to Rome”).
+
+FILES
+==================
+
+The hidden directory *.proverbs* in the user's home-directory can contain three
+types of file. For the English version, these are:
+
+*liste_en.rb*
+   This file contains all the currently available, original proverbs. It exists
+   only, if you have already added new original proverbs. 
+
+*liste_en_bak.rb*
+   A backup-copy of the previous version of the list of proverbs.
+   
+*qualifile_en*
+   This file contains the list of previously qualified, randomly generated
+   proverbs, i.e. the list of *favorites*. It is created when you qualify a
+   proverb for the very first time, and dumped to screen, when you use the
+   option -f or --favorites.
+
+OTHER INFORMATION
+==================
+:Source-code: "Proverbs" had been developed in Ruby and is distributed as a
+              ruby-gem. If you installed the program from the gem-file (with
+              *gem install*), then you find all the source-files in the
+              gem-folder for your Ruby-version. Otherwise, you can also unpack
+              the gem-file (with *tar*), then uncompress the data-archive and
+              take a look at the files in the resulting, new folders *bin* and
+              *lib*.  
+:License:     "Proverbs" is released under the conditions of the
+              GNU General Public License, version 3.0.
+:Version:     1.6 of 2019/10/15
+:Author:      "Proverbs" has been programmed by Michael Uplawski
+              <michael.uplawski@uplawski.eu>. The German parlor game
+              *"Verrückte Sprichwörter"* ("Crazy Proverbs") was the principal
+              inspiration for the project.
+
+**Ω**
+

data/doc/rst/sprichwoerter.rst

@@ -0,0 +1,123 @@
+===============
+ Sprichwoerter
+===============
+------------------------------------------------------------------------------------------
+ Kombiniert Anfänge und Enden von Sprichwörtern zu neuen, meist sinnlosen, Sprichwörtern.
+------------------------------------------------------------------------------------------
+*Proverbs*     - Der englische Name für das gleiche Programm.
+
+Programmaufruf 
+====================
+
+  **sprichwoerter**
+
+  **sprichwoerter -[wf <FARBE>]  (--werten --farbe=<FARBE>)** 
+
+  **sprichwoerter -l  (--liste)**
+
+  **sprichwoerter -n  (--neu)**
+
+  **sprichwoerter -h  (--help)**
+
+  **sprichwoerter -v  (--version)**
+
+
+Beschreibung
+===================
+Das Programm kombiniert die Anfänge und Enden von zufällig aus einer Liste
+ausgewählten Sprichwörtern. Das Ergebnis ist ein Satz, der immer noch als eine
+Art „Sprichwort“ erkennbar ist, allerdings ohne den Anspruch, eine wirkliche
+Information zu vermitteln, geschweige denn „Weisheit“.
+
+Ja. Eine lustige Zeitverschwendung. Sie können das Programm „Sprichwörter“ zum
+Beispiel aus Ihrer *.bashrc* Datei aufrufen.
+
+Wenn **Sprichwörter** ohne Argumente von der Kommandozeile gestartet wird,
+erzeugt es ein neues Sprichwort und zeigt es an.
+
+OPTIONEN
+===================
+
+**-n** oder **--neu**
+   Erlaubt es, neue aber echte Sprichwörter zur Liste der originalen
+   Sprichwörter hinzuzufügen. Sie werden zur Eingabe jedes notwendigen Details
+   einzeln aufgefordert: Sprache (zur Zeit eines von *en* oder *de*), Singular
+   oder Plural (*s*, *p*), Beginn und Ende des Sprichworts.
+
+**-l** oder **--liste**
+   Gibt die Liste der bereits bewerteten, zufälligen Sprichwörter auf dem
+   Bildschirm aus.
+
+**-w** oder **--werten**
+   Wenn ein neu erzeugtes Sprichwort angezeigt wird, bleiben Ihnen einige
+   Sekunden, um es eventuell zu bewerten (durch drücken von '*+*') und damit in
+   die Liste der bewerteten Sprichwörter aufzunehmen. 
+
+**-f** oder **--farbe=FARBE**
+   Bestimmt die Farbe des Rahmens, der ein neu generiertes Sprichwort umgibt.
+   Der Farbname muss einer der folgenden sein: rot, grün, gelb, lila, cyan,
+   blau, weiß, schwarz.
+
+**-h** oder **--hilfe**
+   Zeigt die Kurzhilfe zum Program.
+
+**-v** or **--version**
+   Gibt Versions-Informationen aus.
+
+SPRICHWÖRTER ZUR LISTE HINZUFÜGEN
+--------------------------------------------
+Zur Zeit der Redaktion dieses Dokuments (Oktober 2019) müssen Sprichwörter 
+dem im Folgenden beschriebenen Muster folgen:
+
+"*Jemand oder etwas*" | "**tut oder ist** *etwas*"
+
+Führen Sie das Programm einfach ein paar Mal auf der Kommandozeile aus, um
+diese Einschränkung zu verstehen.
+
+Bis auf weiteres werden originale Sprichwörter in zwei Gruppen eingeteilt:
+diejenigen, deren Subjekt unzählbar ist oder im Singular steht (zum Beispiel
+„Der Zweck | heiligt die Mittel“, „Hochmut | kommt vor dem Fall“) und die
+zweite Gruppe von Sprichwörtern mit einem Subjekt im Plural (zum Beispiel
+„Große Ereignisse | werfen ihre Schatten voraus“)
+
+DATEIEN
+==================
+
+Im versteckten Verzeichnis *.proverbs*, im Benutzerverzeichnis, können drei
+Arten von Datei abgelegt sein. Für die deutsche Version sind das:
+
+*liste_de.rb*
+   Diese Datei enthält alle augenblicklich verfügbaren originalen Sprichwörter.
+   Sie existiert nur, wenn Sie bereits ein solches Sprichwort zur Liste
+   hinzugefügt haben (mit Option *-n* oder *--neu*).
+
+*liste_de_bak.rb*
+   Eine Sicherheitskopie der vorigen Version der Liste originaler Sprichwörter.
+   
+*qualifile_de*
+   Diese Datei enthält die Liste der bereits bewerteten, zufällig generierten
+   Sprichwörter. Sie wird erzeugt, wenn Sie zum ersten Mal eine Wertung
+   vornehmen. Später wird diese Liste angezeigt, wenn Sie das Programmargument
+   -l oder --liste verwenden. 
+
+ANDERE INFORMATIONEN
+====================
+Das Gesellschaftsspiel "*Verrückte Sprichwörter*" diente als Inspiration für
+die Entwicklung des Programms. 
+
+:Quellcode: "Sprichwörter" ist in Ruby programmiert und wird als Ruby-Gem
+            veröffentlicht. Wenn Sie das Programm aus der Gem-Datei installiert
+            haben, befinden sich alle Quellcode-Dateien im Gem-Ordner für Ihre
+            Ruby-Version. Anderenfalls können sie auch die Gem-Datei entpacken
+            (mit *tar*) und dann das data-Archiv dekomprimieren. Der Quellcode
+            befindet sich danach in den Verzeichnissen **bin** und **lib**.  
+
+:Version: 1.6 vom 15. Oktober 2019
+
+:Lizenz: "Sprichwörter" ist freie Software gemäß den Bestimmungen der GNU GPL,
+         Version 3.0
+
+:Autor: "Sprichwörter" wurde von Michael Uplawski
+        <michael.uplawski@uplawski.eu> programmiert.
+
+**Ω**

data/lib/adder.rb

@@ -0,0 +1,91 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   ©2016-2016 Michael Uplawski <michael.uplawski@uplawski.eu>            *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+
+require_relative 'color_output'
+require_relative 'translating'
+require_relative 'logging'
+require 'readline'
+
+class Adder
+  self.extend(Logging)
+  @@log = self.init_logger(STDOUT)
+  include Translating
+
+  # Initialize with a language code and specify singular or plural.
+  # Devide the proverb into "beginning" and "ending", mind the quotes!
+  def initialize(lang = 'de', sipl = 'singular', beginning, ending)
+    @log = @@log
+
+    details = ask_details
+    @log.debug('lang ' << @language)
+    @log.debug('sipl ' << @sipl)
+    @log.debug('beginning ' << @beginning)
+    @log.debug('ending ' << @ending)
+    listfile = trl('list') << '_' << @language 
+    @log.debug('listfile is ' << listfile) 
+    confdir = ENV['HOME'].dup << File::Separator << ".proverbs" 
+    user_list = confdir.dup << File::Separator << listfile
+    listrb = user_list.dup << '.rb'
+    if File::exist?(listrb) && File.readable?(listrb)
+      require user_list
+    else
+      require_relative listfile
+    end
+    new_proverb = [@beginning, @ending]
+
+    case @sipl.downcase
+    when trl('s')
+      $proverbs1.push new_proverb
+
+    when trl('p')
+      $proverbs0.push new_proverb
+    else
+      puts red(trl("Cannot add the proverb, invalid argument") << ' ' << bold("#{sipl}") )
+      exit false
+    end
+
+    if !File.exist?(confdir)
+      Dir.mkdir(confdir)
+    end
+    File.rename(listrb, user_list.dup << '_bak.rb') if(File.exist?(listrb) )
+    File.open( listrb,'w') do |lfile|
+      lfile.puts "$proverbs0=" << $proverbs0.uniq.to_s
+      lfile.puts
+      lfile.puts "$proverbs1=" << $proverbs1.uniq.to_s
+    end
+    puts green(trl("List %s has been updated") %listrb )
+  end
+
+  private
+
+  def ask_details
+    @language = Readline.readline( trl("Language") << " (de, en): ")
+    @sipl = Readline.readline("\n" << trl("Singular or plural (s, p)") << (": ") )
+    @beginning = Readline.readline( "\n" << trl("Beginning of the proverb") << ": " )
+    @ending = Readline.readline( "\n" << trl("Ending of the proverb") << ": " )
+  end
+end
+
+# -- test
+if __FILE__ == $0
+  Adder.new('en', 'singular', "no man", "is an island")
+end

data/lib/argparser.rb

@@ -0,0 +1,128 @@
+#encoding: UTF-8 
+=begin
+/***************************************************************************
+ *   ©2019-2019 Michael Uplawski <michael.uplawski@uplawski.eu>            *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+
+
+require 'optparse'
+require 'optparse/time'
+require 'ostruct'
+require 'date'
+require_relative 'translating'
+require_relative 'version'
+
+class ArgParser 
+  extend Translating
+
+
+  def self.trl_color(localized_color)
+    color = %w~
+          red
+          green
+          purple
+          yellow
+          cyan
+          blue
+          white
+          black
+    ~.detect {|col| trl(col) == localized_color }
+    return color
+  end
+
+
+  # Returns a structure describing the options.
+  #
+  def self.parse(args)
+    # The options specified on the command line will be collected in <b>options</b>.
+    # We set default values here.
+    options = OpenStruct.new
+    options.qualify = false
+    options.color = 'white'
+    options.list = false
+    options.add = nil
+
+    op = OptionParser.new do |opts|
+      opts.banner = trl("Usage") << ":\t" << "%s <options>" %($0) <<"\n"
+
+      opts.separator ""
+      opts.separator trl("Specific options") << ":"
+
+      opts.on('-' << trl('a'), '--' << trl('add') , trl('Add real proverb to the base') ) do |g|
+        options.add = g
+      end
+
+      opts.on('-' << trl('f'), '--' << trl('favorites'), trl('Show favorites')) do
+        options.list = true
+      end
+
+      opts.on('-' << trl('q'), '--' << trl("qualify"), trl("Qualify proverbs")) do 
+        options.qualify = true
+      end
+
+      opts.on('-' << trl('c'), '--' << trl('color') << '=' << trl('COLOR'), trl('Use color in program-output (one of red, green, yellow, purple, cyan, blue, white, black)')) do |col|
+        color = trl_color(col.strip) 
+        if(color && [:red, :green, :yellow, :purple, :cyan, :blue, :white, :black].include?(color.strip.to_sym))
+          options.color = color
+        else
+          puts (trl("Error!") << ' ' << trl('Invalid color value') << ' "' << col << '"!')
+          usage()
+          exit false
+        end
+      end
+
+      opts.separator ""
+      opts.separator (trl("Common options")) << ':'
+
+      # No argument, shows at tail.  This will print an options summary.
+      opts.on_tail('-' << trl('h'), '--' << trl('help'), (trl('Show this message') ) ) do
+        usage(opts)
+      end
+
+      opts.on_tail('-' << trl('v'), '--' << trl('version'), (trl('Show version and program information') )) do
+        puts "\t#{$0} #{VERSION}"
+        puts "\t© 2016-2019 Michael Uplawski <michael.uplawski at uplawski.eu>"
+        exit true
+      end
+    end
+    begin
+      op.parse!(args)
+    rescue OptionParser::MissingArgument => ex
+      puts trl(ex.reason) + " " << trl("for option") << " " << ex.args[0] 
+      usage()
+      exit
+    rescue OptionParser::InvalidOption => ex
+      puts trl(ex.reason) + " " << ex.args[0] 
+      usage()
+      exit
+    end
+    options
+  end  # parse()
+
+  def self::usage(opts = nil)
+    if(opts)
+      puts opts
+    else
+      puts trl("Execute with option -h to see an option summary")
+    end
+    exit true
+
+  end
+end  
+