timequiz 0.1.3

data/lib/console.rb

@@ -0,0 +1,219 @@
+#encoding: UTF-8
+
+=begin
+/***************************************************************************
+ *   Copyright © 2017-2017, 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 'extstring'
+require_relative 'user_input'
+require_relative 'constants'
+
+# Functions which create a user-interface in the terminal 
+module Console
+  # Some definitions which may change one day, become configurable one day,
+  # need to be accessed (one day) from somewhere else or not.
+  @@win_sequence = %w"won.. won.. Won.. WOn.. wON.. wON!. woN!! won!! won.!  won.. _on.. __n.. ___.. ___.. w__.. wo_.. " 
+  @@wait_sequence = %w"U\  V\  Y\  T\  |\  ¦\  :\  .\  _\  .\  o\  O\ "
+  @@fail_sequence = %w":-|\  :-|\  :-[\  :-[\  :-(\  :-(\  8-(\  8-(\  8-(\  8-(\  8-(\  8-(\  8-(\  8-(\  .... |... lo.. Los. LOso LOSe LOSE lOSE loSE lose"
+  @@points = 0
+  # start with some arbitrary events
+  def start_game
+    available = $events
+    clear
+    puts "Put the following events into the right chronological order (e.g.: 2 3 1)."
+    @m_events = Array.new
+    out = ''
+    $num_events.times do |i|
+      srand(Time.new.usec)
+      index = rand(available.length)
+      ev = Event.new(available.delete_at(index))
+      ev.disp_index = (i + 1)
+      @m_events << ev
+      out << (i + 1).to_s << ') ' << ev.title << "\n"
+    end
+    puts out.box(:left => 2)
+    response = nil
+
+    response = int_array_input($num_events, (1..$num_events) ) 
+    if response == :quit_game
+      score @@points
+      exit true
+    end
+
+    compare_order(response)
+    # good order of the response-array
+    if good_order(response)
+      @@points += $num_events 
+      win
+      score(@@points)
+    else
+      lose
+      score(@@points)
+    end
+
+    # Start the loop. Add events as requested.
+    until @m_events.length == $MAX_NUM_EVENTS do
+      ui = ask_new_event
+      if ui == :quit_game
+        score @@points
+        exit true
+      end
+      if('a' == ui)
+        ev = new_event
+        if ev == :all_events_done
+          score(@@points)
+          exit true
+        end
+
+        # ------> unresolved trouble with 0-based array.indices. <----------
+        # 1) exclude new event from the choices (hence -1), allow 0 as 'earlier than any'.
+        r = int_input(0..(@m_events.length - 1) )
+        if r == :quit_game
+          score @@points
+          exit true
+        end
+        # User-input can be 0, which complicates the comparison with the
+        # 0-based event-array.  
+
+        # 2) in the range of known events, if not 0 (hence 0 is allowed).
+        position_by_user(r)
+
+        # 4) 'order' must fit in between the indices of the event-array (0-based, hence -1. Again.)
+        ok = good_order(r - 1, ev)
+
+        sort_years(true)
+        # 5) show the resulting order as starting from 1, not 0.
+        show_correct_order
+        # <---------- This should be it. ------------>
+
+        if ok
+          @@points += 1
+          win
+          score(@@points)
+        else
+          lose
+          score(@@points)
+        end
+      else
+        detail( a2i(ui) )
+      end
+    end
+
+  end
+
+  def clear
+    system 'clear'
+  end
+
+
+  # add a new event to the game
+  def new_event
+    known_events = @m_events.collect {|ev| ev.title}
+    available = $events.collect {|ev| ev unless known_events.include?(ev[0]) }.compact
+    if !available || available.empty?
+      puts "\n\tNo more events available. Aborting. Bye"
+      puts
+      return :all_events_done
+    end
+    clear
+    out = ''
+    @m_events.each_with_index {|ev, i| out << (i + 1).to_s << ') ' << ev.title << "\n"}
+    puts out.box(:left => 2)
+
+    puts "Indicate the event from the previous list, which precedes the following, or '0' (zero) to put it in front:"
+    srand(Time.new.usec)
+    index = rand(available.length)
+    ev = Event.new(available[index]) 
+    @m_events << ev
+    puts ev.title.box(:color => :yellow)
+    return ev
+  end
+
+  def a2i(array)
+    UserInput::a2i(array)
+  end
+
+  def int_input(range = nil)
+    UserInput::int_input(range)
+  end
+  def int_array_input(len, range)
+    UserInput::int_array_input(len, range ) 
+  end
+
+  def ask_new_event
+    puts "\nEnter number for more information about an event, 'a' to play with one new, random event, 'q' to quit." 
+    UserInput::input()
+  end
+
+  def score(pts)
+    puts ' (Current score: %i %s)' %[pts, (pts == 1 ? 'point' : 'points')]
+  end
+
+  def lose
+    cmt = 'You ' << red('lose.') 
+    wait @@fail_sequence, 1, cmt 
+  end
+
+  def win
+    cmt = 'You ' << cyan(' W O N !!') 
+    wait(@@win_sequence, 1, cmt)
+  end
+
+  def show_correct_order
+    cmt = "\tThe right order is:\n" << @m_events.collect {|ev| (@m_events.index(ev) + 1).to_s << ') ' << ev.title << ' (' << ev.year.to_s << ')'}.join("\n").box()
+    wait(@@wait_sequence, 1, cmt) 
+  end
+
+  # show information on an event
+  def detail(num)
+    if(0 != num && num <= @m_events.length)
+      det = @m_events.detect{|ev| ev.disp_index == num}.detail
+      if(det && !det.empty?)
+        puts ("\n" << num.to_s << ') ' << det).box(:color => :green)
+      else
+        puts " - No details known -"
+      end
+    end
+  end
+
+  def position_by_user(p)
+    if(p > 0)
+      puts "\n... You say: " << bold("after \"" << @m_events[p-1].title << "\"")
+    else
+      puts "\n... You say: " << bold("Earlier than any of the listed events")
+    end
+  end
+
+  def compare_order(response)
+    puts "\n... You say: " << bold(response.join(', '))
+    devents = @m_events.dup.sort {|f, s| f.year <=> s.year } 
+    cmt = "\tThe right order is:\n" << devents.collect {|ev| ev.disp_index.to_s << ') ' << ev.year.to_s }.join("\n").box()
+    wait(@@wait_sequence, 1, cmt)
+  end
+
+  def wait(seq, sec, cmt)
+    bi = BusyIndicator.new(false)
+    bi.sequence = seq
+    bi.run
+    sleep sec
+    bi.stop(cmt)
+  end
+
+end

data/lib/constants.rb

@@ -0,0 +1,41 @@
+#encoding: UTF-8
+
+=begin
+/***************************************************************************
+ *   Copyright © 2017-2017, 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 'logging'
+
+$APPNAME='Timequiz'
+$VERSION = '0.1.3'
+
+# number of initial events
+$num_events = 3
+# maximal, final number of events per game
+$MAX_NUM_EVENTS = 15
+$LOG_LEVEL=Logger::INFO
+$events = Array.new
+# Constants for the Gtk-Interface
+# EVENTS
+CLICKED = 'clicked'
+ACTIVATE = 'activate'
+ENTER = 'enter-notify-event'
+LEAVE = 'leave'
+TOGGLED = 'toggled'
+

data/lib/event.rb

@@ -0,0 +1,41 @@
+#encoding: UTF-8
+
+=begin
+/******************************************************************************
+ *   Copyright © 2017-2017, 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
+
+# An object of this class is representing a historical event.
+class Event
+
+  def initialize(ev)
+    @title = ev[0] 
+    @year = ev[1]
+    @detail = ev[2]
+    @disp_index = 0
+  end
+
+  def to_s
+    str = '' << self.class.name << '{ title=' << @title << ', year=' << @year.to_s << ', detail=' << @detail << ', disp_index=' << @disp_index.to_s << '}'
+  end
+  attr_reader :title, :year, :detail
+  attr_accessor :disp_index
+end
+#EOF
+

data/lib/events.rb

@@ -0,0 +1,45 @@
+#encoding: UTF-8
+
+=begin
+/******************************************************************************
+ *   Copyright © 2017-2017, 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
+
+# All events known.
+$events << ['Foundation of the UNESCO', 1946, '(4/11/1946) The United Nations Educational, Scientific and Cultural Organization wants to intensify the cooperation between peoples by developing education, science and culture']
+$events << ['Invention of soap', -1500, '']
+$events << ['First honeybees', -100000000, '']
+$events << ['Artisanal production of glass', -2500, '']
+$events << ['Invention of the door key', -2000, '']
+$events << ['Invention of the solar clock', -1500, '']
+$events << ['The Roman emperor Diocletian devides the empire in two', 185 , 'Caius Aurelius Valerianus Diocletianus also devides the power as he lets Maximian rule the western part of the Roman Empire and eight years later associates with each of the two "Augustus" one lesser colegue and designated successor of the title "Cæsar".']
+$events << ['The American Saxophonist William John Coltrane is born', 1926, 'Coltrane played with Miles Davis and Thelonious Monk, then founded his own quartet. Major recordings: "My Favourite Things" (1960) and "A Love Supreme" (1964)']
+$events << ['The French architect Jacques Lemercier becomes the principal architect of Louis XIII', 1618, 'Lemercier is considered one of the initiators of the French Classicism']
+$events << ['The treaty of Greenville (USA/Ohio)', 1795, 'The British company of Ohio has ended the French occupation of the territory in 1763. Already under US administration since 1783, with the end of the Indian wars (Greenville, 1795), Ohio could become the 17th US-state in 1803.']
+$events << ['"Each acceptor of electrons is an acid and each emitter a base" (Gilbert Newton LEWIS).', 1938, 'Lewis worked after 1913 on the chemical liaisons between non-metalic atoms. Since 1923 he elaborates a theory on acids and bases.']
+$events << ['Destruction of Nimrod and Ninive by the Medians and Neo-Babylonians', -612, 'The medians were nomads and had become a thread to the Assyrian empire when their tribes united under king Phraorte. The Assyrians fought several preventive wars but in the end lost their empire to the victorious Medians.']
+$events << ['French writer François Rabelais dies', 1553, 'Rabelais work show the humanists\' enthusiasm for philosophy, moral and knowledge of antiquity, the wisdom of which he admired. His freedom of expression, wealth of vocabulary and imagination still appear unequalled.']
+$events << ['The anarchist Léon Czolgoscz assassinates the US-president William McKinley', 1901, 'President since 1896, McKinley advocates a strict economic protectionism. The victory in the Spanish-American war of 1898 assures his easy re-election in 1900. After the murder, McKinley is replaced by his vice-president Theodor Rosevelt']
+$events << ['The German army under General Alexander von Kluck reaches the River Marne for the first time', 1914, '(05/09/1914) The first battle of the Marne took place in 1914, when a weakened German 1st army under General von Kluck was attacked and finally beaten by the 6th French army under Maunoury with decisive assistance by the British corps under John French.']
+$events << ['The Italian painter Lorenzo Lotto dies', 1556, 'Unable to stand his ground against contemporaries like Raphael (in Rome) and Titian (in Venise), Lotto retreats to Bergamo, where he paints his big religious compositions between 1518 and 1528.']
+$events << ['End of the "War of the mercenaries"', -238, 'Out of work after the first punic war and discriminated, the mercenaries of Carthago unite in -240 with other dissatisfied people under the Libyan Matho, besiege the city of Utica, but get finally massacred by an army under Hamilcar Barca and Hannon the Great.']
+$events << ['Independence of the Republic of Nicaragua', 1821, 'Discovered by Christopher Columbus in 1502, the country was conquered by Gonzales d\'Avila who bate the Indian chief Nicarao. Since 1560, Nicaragua was part of the territory of Guatemala.']
+$events << ['First siege of Vienna (Austria) by Süleyman the Magnificent', 1529, 'Under sultan Süleyman, the Ottoman empire won much territory and prospered in all respects. In October 1529, the Turkish army of 120000 men could though not break the resistance of the citizens of Vienna and finally had to retreat.']
+$events << ['The Roman empress Galla Placidia dies', 450, 'Born around the year 390 as the daughter of Theodosius I, she was first married to Alaric\'s brother in law, Athaulf, king of the Visigoths, then to the future Constantius III, a general of her brother Honorius who inherited from her the title of "Augustus". After Honorius\' death and at the decision of Theodosius II, grandson of Theodosius I and emperor of the orient, Galla Placida governed the western empire for her six year old son Valentinian (the future Valentinian III).']
+$events << ['Birth of Kathleen Mansfield', 1888, '(1888 Wellington, New-Zealand). Of vivid sensibility, Katherine Mansfield is the most representative novelist and poet of the era after World War I. Her novels had the biggest success in France. She died in 1923 on tuberculosis.']

data/lib/extstring.rb

@@ -0,0 +1,161 @@
+#encoding: UTF-8
+
+=begin
+/******************************************************************************
+ *   Copyright © 2017-2017, 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'
+
+# Functions which extend the String-class. Simply require this file to add
+# capabilities to each String-object in your code. 
+
+# For historical reasons. Probably obsolete
+if(! String.method_defined?(:end_with?))
+  class String
+    def end_with?(str)
+      isso = false;
+      if(str.respond_to?(:to_str) && self.include?(str))
+        isso = (slice(rindex(str), (size()-1)) == str)
+      end
+      return isso
+    end
+  end
+end
+
+# Not obsolete
+
+class String
+
+  # Draws a box around the content.
+  # TODO: the :padding option is currently disabled as it confuses me.
+  def box(opt = {})
+    # ---------------
+    # Welcome to hell
+    # ---------------
+
+    color = opt[:color]
+
+    upleft = color ? colorize("\u250F", color) : "\u250F"
+    upright = color ? colorize("\u2513", color) : "\u2513"
+    downleft = color ? colorize("\u2517", color) : "\u2517"
+    downright = color ? colorize("\u251B", color) : "\u251B"
+
+    vert = color ? colorize("\u2503", color) : "\u2503"
+    hor = color ? colorize("\u2501", color) : "\u2501"
+
+    left = opt[:left]
+    top = opt[:top]
+    # padding = opt[:padding]
+
+    min_width = opt[:min_width]
+
+    size = `stty size`.split.map { |x| x.to_i }.reverse
+    left ||= 0
+    top ||= 0
+    # padding ||= 0
+    
+    min_width ||= 15
+    
+    # max_width is the width of the screen - left margin - 2x border
+    max_width = size[0] - left - 2
+
+    gsub!("\t", '    ')
+    width = max_width
+    # wrap lines, maybe
+    wrap(width , /^\d\)/)
+    # determine the width of the box 
+    width = self.split("\n").max {|l1, l2| l1.chomp.length <=> l2.chomp.length}.length  
+    width = [width, min_width].max
+
+    box = ''
+    # top margin
+    box << "\n" * top
+    # top border, left margin
+    box << ' ' * left << upleft.dup << hor.dup * width   << upright.dup << "\n"
+    # top padding, left margin and so on ...
+    box << ' ' * left << vert.dup << ' ' * width << vert.dup << "\n"
+    # lines
+    self.split("\n").each do |line|
+      if(line && !line.empty?)
+        nl = ' ' * left << vert.dup << "%-#{width}s" %line
+        while(nl.length < width )
+          nl << ' '
+        end
+        nl << vert.dup << "\n"
+      else
+        nl = ' ' * left << vert.dup << ' ' * width  << vert.dup << "\n"
+      end
+      box << nl
+    end
+    # bottom padding
+    box << ' ' * left << vert.dup << ' ' * width << vert.dup << "\n"
+    # bottom border
+    box << ' ' * left << downleft.dup << hor.dup * width << downright.dup
+    return box
+  end
+
+  def box!(opt = {})
+    self.replace(String.new(box(opt)))
+  end
+
+  # A wrap-function which works here, but may fail everywhere else.
+  def wrap(width, delimiter = "\n")
+    # YEAH. Ruby is crap because its regular expressions do not work as they
+    # should with special characters. And your coffee mug has a speech
+    # impediment. Face it! 
+    words = self.scan(/\p{P}*[\wöÖüÜäÄßéèàôûùîçÇœæŒÆ]+\p{P}*/)
+   
+    lines = []
+    lines << ''
+    li = 0
+    words.each do |w|
+      w.strip!
+      if( w.length + lines[li].length + 1 > width || w != words.first && w.match(delimiter) )
+        lines[li].squeeze!(' ')
+        lines << ''
+        li += 1
+      else
+      end
+      lines[li] << w 
+      lines[li] << ' ' if w != words.last
+    end
+    self.replace(lines.join("\n"))
+  end
+
+end
+
+#--------------- TEST ---------------
+if __FILE__ == $0
+  s = "Ein König mit Krone ist besser als ohne,\n\n(du Nase)!!".wrap(12)
+  puts s
+
+  s = "1) Ein Koenig mit Krone ist besser als ohne,\n\n(du Nase)!!\n2) We are not in Kansas anymore.\n3) Toto? Ich glaub, der Köter hieß Toto... ".wrap(12, /^\d/)
+  puts s
+  
+
+  # puts "Ein Koenig mit Krone ist besser als ohne,\n\ndu Nase!!".box(:padding=>2)
+
+  s = "1) Didudel Doedel didödeledel dödeldödel dödeldödel du dödel. DOEDEL !\n"
+  s << "2) Man gab uns mancherlei auf Erden.\nZum Denken gab man uns die Stirn."
+  s << "2a) Man gab uns Herz- und Leibbeschwerden.\nDoch auch den Himmel und den Zwirn."
+  s << "3) Himmel, Ding und Zwirn."
+  s.wrap(12, /\d\)/)
+  puts s.box(:min_width=>20, :left => 20)
+end