Sprichwoerter 0.1 → 1.6

data/lib/rearranging.rb

@@ -0,0 +1,47 @@
+#encoding: UTF-8
+
+=begin
+/***************************************************************************
+ *   ©2014-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
+
+=begin
+  Functions which rearrange an array.
+=end
+module Rearranging
+
+  public
+  # ... guess
+  def randomize
+    if( self.respond_to?(:to_ary) )
+      size = self.length
+      original_list = self.dup
+      random_list = Array.new
+      while(random_list.size < size) do
+        srand(Time::now.nsec)
+        index = rand(original_list.size)
+        item = original_list.delete_at(index) 
+        random_list << item
+      end
+      self.replace(random_list)
+    else
+      raise TypeError.new('can only randomize Array, not ' << self.class.name)
+    end
+  end
+end

data/lib/sprichw/303/266rter.rb

@@ -2,7 +2,7 @@
 #encoding: UTF-8
 =begin
 /***************************************************************************
- *   ©2016-2016 Michael Uplawski <michael.uplawski@uplawski.eu>            *
+ *   ©2016-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  *
@@ -21,39 +21,188 @@
  ***************************************************************************/
 =end
 
+require_relative 'user_input'
+require_relative 'argparser'
+require_relative 'translating'
+require_relative 'rearranging'
+require_relative 'logging'
 
-
+# Main application class.
 class SprichWoerter
-	def initialize(lang='de')
-		require_relative 'liste_' << lang
-		box = %w~┌ ┐ └ ┘ ─ │~
-		num_pvs = $proverbs.size
-		srand(Time.new.to_i)
-		first = ''
-		until !first.empty?
-			fi = rand(num_pvs)
-			second = first = $proverbs[fi][0] 
-			si = fi
-		end
-		until (si != fi && $proverbs[si][0] != first && !second.empty?)
-			si = rand(num_pvs)
-			second = $proverbs[si][1]
-		end
-=begin
-		puts ($proverbs[fi].to_s <<  " (" << fi.to_s << ")")
-		puts ($proverbs[si].to_s <<  " (" << si.to_s << ")")
-=end
-		phr = first << ' ' << second << '.'
+  include Translating
+  self.extend( Logging)
+  @@log = self.init_logger(STDOUT)
+  # An object of this class acts as a functor. Calling new() is thus the only
+  # available access to all its functionality.
+  #def initialize(lang='de', action = :create)
+
+  def initialize(lang='de', args)
+    @lang = lang
+    @log = @@log
+    @options = ArgParser.parse(ARGV)
+    @log.debug("options are: " << @options.inspect)
+    listfile = 'liste' << '_' << @lang 
+    # ------------- language is set --------------
+    @confdir = ENV['HOME'].dup << File::Separator << ".proverbs" 
+
+    if(@options.list)
+      show_favorites
+      exit 0
+    end
+    user_list = @confdir.dup << File::Separator << listfile
+    # cosmetics
+    listrb = user_list << '.rb'
+
+    if File::exist?(listrb) && File.readable?(listrb)
+      require user_list
+    else        
+      require_relative listfile
+    end
+    # ------------- proverbs are identified ---------
+    if @options.add
+      Adder.new(@lang, @options.add, *ARGV)
+      exit true
+    end
+
+    # borders 
+    up_left = '┌' 
+    up_right = '┐'
+    bottom_left =  '└'
+    bottom_right =  '┘'
+    hor =  '─'
+    vert =  '│'
+    srand(Time.now.nsec)
+    # group 0 or group 1 ?
+    sfx = [0, 1][rand(2)]
+    proverbs = eval("$proverbs" + sfx.to_s)
+    # This appears to improve the randomness :
+    # allow for the list of proverbs to be 'rearranged' ...
+    proverbs.extend(Rearranging)
+    # ... and do it, each time.
+    # This seeds the pseudo-random generator anew
+    proverbs.randomize
+    num_pvs = proverbs.size
+    first = ''
+    # Find 1 original proverb in the group.
+    until !first.empty?
+      # determine the index of an original proverb.
+      fi = rand(num_pvs)
+      # read the beginning of the proverb
+      second = first = proverbs[fi][0] 
+      si = fi
+    end
+    srand(Time.now.nsec)
+    # Find a second proverb, different from the first.
+    until (si != fi && proverbs[si][0] != first && !second.empty?)
+      si = rand(num_pvs)
+      # read the end of the proverb
+      second = proverbs[si][1]
+    end
+    # Construct the new proverb.
+    phr = first << ' ' << second << '.'
+
+    #draw
+    len = phr.size
+    # TODO: Wrap text if needed, determine number of line-breaks, then draw 1
+    # border around all lines of text.
+    col = @options.color
+    puts "" << maybe_in_color(up_left << hor * len << up_right, col)
+    puts "" << maybe_in_color(vert, col) << phr << maybe_in_color(vert, col)
+    puts "" << maybe_in_color(bottom_left << hor * len << bottom_right, col)
+    # Allow the new proverb to be rated
+    qualify( phr) if @options.qualify
+  end
+
+  # This function wraps a call to eval(). It also verifies that a color is
+  # set, although a default should apply, if not.
+  def maybe_in_color(txt, color)
+    if @options.color
+      cmd = @options.color + ' "' << txt << '"'
+      eval (cmd) 
+    else
+      txt
+    end
+  end
+
+  def show_favorites
+    puts read_qualifile[0].join("\n") 
+  end
 
-		#draw
-		len = phr.size
+  # Find the file with the list of rated, generated proverbs. Returns
+  # an Array of those proverbs and the path to the file itself.
+  def read_qualifile
+    qualifile = @confdir.dup << File::Separator << 'qualifile_' << @lang
+    lines = Array.new
+    if(File.exist?(qualifile) )
+      msg = nil
+      if(!File.readable?(qualifile) )
+        msg = trl("ERROR") << '!' << trl("The file %s cannot be opened for reading!") %qualifile
+      elsif (!File.writable?(qualifile) )
+        msg = trl("ERROR") << '!' << trl("The file %s cannot be opened for writing!") %qualifile
+      end
+      if msg
+        puts msg
+        exit false
+      else
+        qf = File.open(qualifile, 'a+')
+        lines = qf.readlines(chomp:true)
+      end
+    else
+      if !File.exist?(@confdir)
+        Dir.mkdir(@confdir)
+      end
+      qf = File.new(qualifile, 'w') 
+    end
+    qf.close
+    return lines, qualifile
+  end
 
-		puts "" << box[0] << box[4] * len << box[1]
-		puts "" << box[5] << phr << box[5]
-		puts "" << box[2] << box[4] * len << box[3]
-	end
+  # Rate a proverb. For the time, only a simple, positive rating is possible.
+  def qualify(phr)
+    # Create a cheap busy-indicator; Asynchronously count down from 5 to 1.
+    thr = Thread.new do
+      5.downto(1) do |n|
+        print n 
+        sleep 1
+        print "\b"
+        if(n == 1)
+          print("\n")
+          exit true
+        end
+      end
+    end
+    msg = trl("Push '+' for a positive rating") << ".\n"
+    puts msg
+    # Wait for user-input while the count-down is running.
+    # The loop serves to re 
+    while thr.alive? do
+      user_input = wait_for_user
+      if ('+' == user_input.chr.downcase )
+        # Terminate the count-down, if the user pushed '+'
+        thr.terminate
+        qf = nil
+        lines, qf = read_qualifile
+        if (qf && !lines.include?(phr))
+          # add the latest generated proverb
+          File.write(qf, phr + "\n", :mode=>'a+')
+          puts "\b" << trl('Done')
+          exit true
+        end
+        # Handle Ctrl+c, Ctrl+d and Esc in the same way.
+      elsif [3,4,27].include? user_input 
+        thr.terminate
+        puts "\n"
+        exit true
+      end
+    end
+  end
 end
 
 if __FILE__ == $0
-	sp = SprichWoerter.new(ARGV[0])
+  if !ARGV.empty?
+    SprichWoerter.new(ARGV[0])
+  else
+    SprichWoerter.new('de')
+  end
 end
+# EOF

data/lib/translating.rb

@@ -0,0 +1,101 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   ©2011-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
+
+
+RD = File.expand_path(File.dirname(__FILE__) ) +  File::SEPARATOR if !defined?(RD)
+
+require 'yaml'
+
+# A way to produce translated text in a ruby-program.
+# Translations are read from a file "translations" in the program folder.
+module Translating
+  # There are better ways to extend a translated 
+  # string, but I keep the 'wild-card' for 
+  # historical reasons.
+
+  @@lang = nil 
+  @@lang_file = format("%s%s", RD, 'LANG')  
+  @@tr = YAML::load_file("#{RD}translations")
+
+  # find the current language-setting and return it.
+  def self.language()
+    if @@lang == nil
+      r = ENV['LANG']
+      if(r)
+        @@lang = r[0, 2]
+      elsif( File.exist?(@@lang_file) && File.readable?(@@lang_file) && File::size(@@lang_file) >= 2)
+        File::open(@@lang_file, 'r') {|f| @@lang = f.readline}
+        @@lang.chomp!.downcase! if @@lang
+      end
+    end
+    @@lang = 'en' if !@@lang
+  end
+
+  # Translate a string to the currently set langage.
+  # Note that the argument may contain a format-string
+  # in sprintf-syntax.
+  def self.trl(t)
+    Translating::language()
+    lt = @@tr[t]
+    if(lt)
+      lt = lt[@@lang]
+    else
+      # File.open('/tmp/mtf', 'a+') {|f| f << t << "\n"}
+      puts "\nTRANSLATION MISSING: \"" << t << "\""
+    end
+    lt ||= t
+    return lt
+  end
+
+  # Translate a string to the currently set langage. 
+  # Note that the argument may contain a format-string
+  # in sprintf-syntax.
+  def trl(t )
+    Translating::trl(t)
+  end
+
+  # Translate in the given string only those words for which a translation
+  # is found.
+  # This is useful for mixed content like dates: "Friday, 8. July 2011".
+  # As the order changes with the locale, alphabetic content is matched and the
+  # remainder discarded.
+  def self::trl_words(str)
+    n_str = str.clone
+    loop do 
+      m = str.match(/[[:alpha:]]+/)
+      break if !m
+      str.gsub!(m.to_s, '')
+      n_str.gsub!(m.to_s, trl(m.to_s))
+    end
+    return n_str
+  end
+  # Translate in the given string only those words for which a translation
+  # exists.
+  # This is useful for mixed content like dates: "Friday, 8. July 2011".
+  # As the order changes with the locale, alphabetic content is matched and the
+  # remainder discarded.
+  def trl_words(str)
+    Translating::trl_words(str)
+  end
+
+end
+

data/lib/translations

@@ -0,0 +1,164 @@
+list:
+  de: liste
+
+Execute with option -h to see an option summary:
+  de: Starten Sie das Program mit -h um die Erklärung der Kommandozeilenargumente zu sehen.
+
+invalid option:
+  de: Ungültiges Argument
+
+missing argument:
+  de: Fehlender Wert 
+
+for option:
+  de: für Option
+
+Error!:
+  de: Fehler!
+
+Invalid color value:
+  de: Ungültiger Farbname
+
+Singular or plural (s, p):
+  de: Singular oder Plural (s, p)
+
+s:
+  de: s
+
+p: 
+  de: p
+
+singular:
+  de: singular
+
+plural:
+  de: plural
+
+Cannot add the proverb, invalid argument:
+  de: Kann das Sprichwort nicht hinzufügen, ungültiges Argument
+
+List %s has been updated:
+  de: Liste %s wurde aktualisiert
+
+Push '+' for a positive rating:
+  de: Drücken Sie ‚+’, um das Sprichwort positiv zu bewerten
+
+Done:
+  de: Fertig
+a:
+  de: n
+
+add:
+  de: neu
+
+GROUP:
+  de: GRUPPE
+
+LANG:
+  de: SPRACHE
+
+f:
+  de: l
+
+l:
+  de: s
+
+Language:
+  de: Sprache
+
+lang:
+  de: sprache
+
+favorites: 
+  de: liste
+
+q:
+  de: w
+
+qualify:
+  de: werten
+
+c:
+  de: f
+
+-c:
+  de: -f
+
+color:
+  de: farbe
+
+h:
+  de: h
+
+help:
+  de: hilfe
+
+Usage:
+  de: Syntax
+
+Specific options:
+  de: Spezielle Optionen
+
+Add real proverb to the base:
+  de: Neues Sprichwort in Stammdaten aufnehmen
+
+Beginning of the proverb:
+  de: Anfang des Sprichworts
+
+Ending of the proverb:
+  de: Ende des Sprichworts
+
+Set language:
+  de: Sprache festlegen
+
+Show favorites:
+  de: Best Bewertete auflisten
+
+Qualify proverbs:
+  de: Sprichwörter bewerten
+
+Use color in program-output (one of red, green, yellow, purple, cyan, blue, white, black):
+  de: Farbige Programmausgabe (eine von rot, grün, gelb, lila, cyan, blau, weiß, schwarz)
+
+Common options:
+  de: Allgemeine Optionen
+
+Show this message:
+  de: Diese Meldung anzeigen
+
+v:
+  de: v
+
+version:
+  de: version
+
+Show version and program information:
+  de: Versionsinformationen anzeigen
+
+COLOR: 
+  de: FARBE
+
+red:
+  de: rot
+
+green:
+  de: grün
+
+purple:
+  de: lila
+
+yellow:
+  de: gelb
+
+cyan:
+  de: cyan
+
+blue:
+  de: blau
+
+white:
+  de: weiß
+
+black:
+  de: schwarz
+