timequiz 0.1.3

data/lib/file_checking.rb

@@ -0,0 +1,89 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   ©2011-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
+
+=begin
+A module to facilitate frequently occuring checks on
+file-system objects. You can certainly do without this, 
+but maybe you find it useful.
+=end
+module File_Checking
+
+  @@text_messages  = {
+    :exist? => "does not exist!",
+    :exist => "does not exist!",
+    :readable? => "is not readable!",
+    :readable => "is not readable!",
+    :executable? => "is not executable!",
+    :executable => "is not executable!",
+    :writable? => "is not writable!",
+    :writable => "is not writable!",
+    :directory? => "is not a directory!",
+    :directory => "is not a directory!",
+    :file? => "is not a file!",
+    :file => "is not a file!",
+  }
+
+  # Checks if the file with the name from the first
+  # parameter has the properties, listed in the second. 
+  # The messages parameter is an array of one or several
+  # of :exist?, :readable?, :writable?, :directory?  or 
+  # their string-representations, respectively. 
+  # Returns nil in case of success, otherwise an 
+  # informative message, describing the first negative
+  # test-result.
+  def file_check(file, *messages)
+    File_Checking.file_check(file, *messages)
+  end
+
+  # Checks if the file with the name from the first
+  # parameter has the properties, listed in the second. 
+  # The messages parameter is an array of one or all
+  # of :exist?, :readable?, :writable?, :directory? or
+  # their string-representations, respectively. 
+  # Returns nil in case of success, otherwise an 
+  # informative message, describing the first negative
+  # test-result.
+  def self.file_check(file, *messages)
+    msg = nil
+    if(file && messages.respond_to?(:to_ary) && !messages.empty?)
+      messages.each do |k|
+	if(! k.to_s.end_with?('?'))	
+	  k = (k.to_s << '?').to_sym
+	end
+	@log.debug ('checking ' << k.to_s) if @log
+	if(msg == nil && File.respond_to?(k) && ! File.send(k, file.to_s))
+	  msg = "#{file} #{@@text_messages[k.to_sym]}"
+	end
+      end
+    end
+    msg
+  end
+  alias :check_file :file_check
+end
+
+=begin
+# example
+
+include File_Checking
+msg = file_check('some_file.txt', [:exist?, :readable?, 'writable'])
+puts msg if msg
+=end

data/lib/logging.rb

@@ -0,0 +1,204 @@
+#encoding: UTF-8 
+=begin
+/***************************************************************************
+ *   ©2011-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 'logger'
+require_relative 'file_checking'
+
+=begin Creates a member @log and precede its output with the name of the class
+of the object. 
+Example for a class-level logger:
+# --------------------
+class TClass
+	self.extend(Logging)
+	@@log = init_logger(STDOUT)
+	def test_log
+		@@log.info('class-level logger called from instance: ' << @@log.to_s)
+		@log = @@log
+		@log.info('AGAIN: class-level logger called from instance: ' << @log.to_s)
+	end
+	def self::test_log
+		@log.info('class-level logger called from class: ' << @log.to_s)
+		@@log.info('AGAIN: class-level logger called from class: ' << @@log.to_s)
+	end
+end
+#---------------------
+Example for a object-level logger:
+ATTN! This means 1 logger per object.
+# --------------------
+class TClass
+	include Logging
+	def initialize
+		init_logger(STDOUT, Logger::DEBUG)
+	end
+	def test_log
+		@log.debug('called test_log() ')
+	end
+end
+=end
+module Logging
+	include File_Checking
+
+	@@have_log = false
+	@@LOG_CONF = File.dirname(File.absolute_path(__FILE__)) << File::Separator << 'log.conf'
+
+	# Call this method in an instance-method (e.g. initialize() ) to define the
+	# object-level logger; i.e. an object-specific member @log.
+	# Call this method within the class-definition for a class-level logger; i.e.
+	# a member @log for class-level acces.
+	# The method returns the logger, so you can actually do what you want with it.
+	def init_logger(target = STDOUT, level = Logger::INFO)
+		# Prepare for a class-level logger. This is actually quite cool.
+		
+		# ---> Ingeniuous code starts here
+		cn = (self.class == Class ? name : self.class.name)
+		# <--- Ingeniuous code ends here
+		
+		# allow to override the set log-levels with an
+		# external configuration (log.conf).
+		log_conf(cn)
+		# Or use the defaults as set here or elsewhere...
+
+		@level ||= level 
+		@target ||= target
+
+		@log = Logger.new(@target)
+		@log.level = @level
+
+		@log.formatter = proc do |severity, datetime, progname, msg|
+			t = Time.now
+			"#{cn}: #{severity} #{t.hour}-#{t.min}-#{t.sec}: #{msg}\n"
+		end
+		if ! @@have_log
+			@log.debug cn.dup << ' reading logging-configuration from ' << @@LOG_CONF	
+			@@have_log = true
+			@log.debug('level is ' << level.to_s)
+		end
+		return @log
+	end
+
+        def log_label=(label)
+          @log.formatter = proc do |severity, datetime, progname, msg|
+            t = Time.now
+            if(label && !label.empty?)
+              "#{label}: #{severity} #{t.hour}-#{t.min}-#{t.sec}: #{msg}\n"
+            else
+              "#{$0}: #{severity} #{t.hour}-#{t.min}-#{t.sec}: #{msg}\n"
+            end
+          end
+        end
+
+        # Set the log-target to an IO object.
+        def log_target=(target)
+          @target = target
+          @log = Logger.new(@@target)
+          @log.level = @level
+        end
+
+        # set the log-level
+        def log_level=(level)
+          @level = level
+          @log.level = @level
+        end
+
+        private
+
+        # Override or set the log-level and target-device, as set in a file 'log.conf'.
+        # I do not like the look of this, but it works just the way I want it to.
+        # "HEAVANS! Isn't there a standard way to do this in Ruby, for Christ's sake?", you say.
+        # Heck, I don't care. <= Read that again, I say.
+        def log_conf(cn = nil)
+          config = level = target = nil
+          # puts 'log-config is in ' << @@LOG_CONF
+          if(File::exist?(@@LOG_CONF) )
+            begin
+              conf = File.read(@@LOG_CONF)
+              config = instance_eval(conf)
+            rescue Exception => ex
+              STDERR.puts "WARNING! Cannot evaluate the logger-configuration!" << ' ' << ex.message
+              STDERR.puts "Default log-levels apply."
+            end
+          # else
+            # puts "Default log-levels apply."
+          end
+
+          if(config && config.respond_to?(:to_hash) )
+            config.default = nil
+            if cn
+              config = config[cn.to_sym]
+            else
+              config = config[self.class.name.to_sym]
+            end
+
+            if(config )
+              if(config.respond_to?(:to_ary) && config.size == 2)
+                @level, @target = config
+                @target.downcase!
+                logdir = File.dirname(@target)
+                msg = file_check(logdir, :exist?, :directory?, :writable?)
+                if(msg) 
+                  STDERR.puts "WARNING! A logfile for '%s' cannot be written to %s (%s)!" %[self.class.name, logdir, msg] 
+                  @target = nil
+                end
+              else
+                @level = config
+              end	
+            end
+          end
+        end
+end
+
+######### test
+if __FILE__ == $0
+  class TClass
+    # class level ---->
+    self.extend(Logging)
+    @@log = init_logger(STDOUT, Logger::INFO)
+    # <------
+    # object-level ---->
+    include Logging
+    # <---------
+
+    def test_log
+      @@log.info('class-level logger called from instance: ' << @@log.to_s)
+      #@log = @@log # works too
+      @log = TClass.class_eval{@log}
+      @log.info('AGAIN: class-level logger called from instance: ' << @log.to_s)
+      @log.debug("you won't see this on log-level INFO")
+
+      # object-level ---->
+      init_logger
+      # <-----------
+      @log.info("That's a different thing: " << @log.to_s << " - object-level logger!")
+
+    end
+    def self::test_log
+      @log.info('class-level logger called from class: ' << @log.to_s)
+      @@log.info('AGAIN: class-level logger called from class: ' << @log.to_s)
+    end
+  end
+
+  TClass.new.test_log # class-logger + 1st object-logger
+  TClass.new.test_log # same class-logger + 2nd object-logger
+
+  TClass::test_log # same class-logger
+  puts 'And just say it once clearly: THIS IS COOOL!!'
+end
+#EOF

data/lib/timequiz.rb

@@ -0,0 +1,216 @@
+#!/usr/bin/env ruby 
+#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 'argparser'
+require_relative 'adder'
+require_relative 'color_output'
+require_relative 'extstring'
+require_relative 'user_input'
+require_relative 'busy_indicator'
+require_relative 'event'
+require_relative 'logging'
+
+require 'date'
+
+# Main program class. All action is within the initialize() method, or, more
+# precisely in the start_game() method which has to be defined by an
+# interface-module. 
+class Timequiz
+  self::extend(Logging)
+  @@log = self::init_logger
+
+  # Find out, how the program has been called.
+  # In juin 2017 this can be 'timequiz' or 'timequizGtk'.
+  # Write a Qt-interface, create a symbolic link 'timequizQt' in
+  # ../../bin and add a when-clause to the case-when structure, right below the
+  # method (in class-scope).
+  # Returns true if the given executable file is named the same as the one 
+  # called, false if they are not the same.
+  # Returns the name of the called executable, if no argument is given.
+  def self.called_as?(executable = nil)
+    return File::basename($0) == executable.strip if executable
+    return File::basename($0) 
+  end
+
+  # This adds all the functionality of the named interface module to the
+  # current class.
+  case called_as?
+    # GTK-Interface
+  when 'timequizGtk'
+    # require_relative 'gtk/timequizGtk'
+    # include TimequizGtk
+    @log.info('I am sorry. But there is not Gtk-interface, for the time.')
+    # Text only
+  when 'timequiz'
+    require_relative 'console'
+    include Console 
+    # EXAMPLE
+    # when 'timequizSWT'
+    #   require_relative 'swt'
+    #   include SWT
+  else
+    # beats me
+    # puts "How did you do that?"
+    # ... HEY! I guess: You created a link to the executable but forgot
+    # something else. Read the comment to the 'called_as?' method, above.
+    @log.error(": A user-interface \"" << called_as? << "\" has not (yet) been defined (read the code, my friend)! Aborting.") 
+    exit false
+  end 
+
+  def verify_prepare(file)
+    if(file && !file.empty? && !file.end_with?('.rb'))
+       file << ".rb"
+    end
+    begin
+      ofl = File.open(file, 'a')
+      if !File.readable?(file)
+        @log.error('The file ' << file << ' cannot be read! Aborting')
+        exit false
+      end
+      if(File.empty?(file)  )
+        @log.info("The file " << file << " is empty. You must add some events to it.")
+        if(File.writable?(file) )
+          orig_file = File.dirname(__FILE__) << File::Separator << 'events.rb'
+          @log.debug('orig_file is ' << orig_file)
+          File.open(orig_file, 'r') do |ifl|
+            ofl.puts("# Events defined for the Timequiz game")
+            ofl.puts("# Lines starting with '#' are comments.\n\n# EXAMPLES:")
+            3.times do 
+              line = ""
+              line = ifl.readline.strip until line.start_with?('$')
+              ofl.puts('#' << line)
+            end
+            ofl.puts("\n# Add your own events below this line\n#" << '_' * 60)
+          end
+          ofl.close
+        end
+        add_ok = require file 
+      else
+        add_ok = require file 
+        if(add_ok)
+          return add_ok, $events.length >= 3
+        end
+      end
+    rescue IOError => ex
+      ofl.close
+      @log.error('Cannot work with the given file: ' << ex.message)
+      exit false
+    end
+  end
+
+  def initialize(*args)
+    @log = @@log
+    # adjust log-level, if given.
+    # Else use what you know.
+    options = ArgParser.parse(*args)
+    $LOG_LEVEL = Logger::DEBUG if options.debug
+    @log.level = $LOG_LEVEL if $LOG_LEVEL 
+    @log.debug('log_level is ' << $LOG_LEVEL.to_s)
+    @log.debug('options are ' << options.to_s)
+    #    should we add only a new event to the list  
+    @log.debug('options are : ' << options.to_s)
+    add_ok = game_ok = false
+    if(options.file)
+      @log.debug('shall use non-standard events file')
+      add_ok, game_ok = verify_prepare(options.file)
+    else
+      game_ok = require_relative 'events'
+    end
+    if(options.add)
+      if(add_ok)
+        Adder::add(options)
+        exit true
+      elsif(options.file)
+        @log.error('cannot add events to ' << options.file)
+        exit false
+      else
+        @log.error('PSE start the program with -h or --help to see an option-overview')
+        exit false
+      end
+    end
+
+    # start the chosen interface
+    if(game_ok)
+      start_game 
+    else
+      @log.error("Cannot play with the events in " << options.file)
+      @log.error("PSE verify that there are at least 3 events defined!") 
+      exit false
+    end
+  end
+
+  private
+
+  # A dangerous method. Not only because the use of the argument is somewhat
+  # esotheric...  This sorts the events in the *correct* order of their years.
+  # Any later comparison with user-provided values is based on the *correct*
+  # order, not the one currently at display! Although this is of interest only
+  # after the very first round, it caused me some headache, once the
+  # user-interfaces had been separated... Mind this when creating a new UI.
+  # The argument 'index' controlls if the displayed index should be changed to
+  # mirror the *correct* order of events, meaning the index from the Array + 1
+  # (i.e. [1,2,3...]). I forgot, how this is useful (see in 'good_order',
+  # below).
+  def sort_years(index = false)
+    @m_events.sort! {|f, s| f.year <=> s.year } 
+    @m_events.each_with_index {|ev, i| ev.disp_index = i+1} if index
+  end
+
+  # Verifies and reports if the user-provided order is correct in the way that
+  # it creates a consistent timeline. The argument 'response' may be either an
+  # Array of Integers or just one Integer. In the latter case, an Event should
+  # be given, too.
+  def good_order(response, event = nil)
+    if(response.respond_to?(:to_ary) )
+      response_years = []
+      response.each_with_index {|r, i| response_years[r-1] = @m_events[i].year}
+      @log.debug('response is ' << response.join(', ') << "\nresponse_years is : " << response_years.join(', ') )
+
+      # do not change the displayed index
+      sort_years(false)
+      event_years = @m_events.collect{|ev| ev.year }
+
+      # Compare the order of years, not the order of events!
+      # There may be two or more events in the same year.
+      response_years == event_years
+    elsif(response.respond_to?(:to_int) )
+      # set/change the displayed index 
+      sort_years(true)
+      # Compare the order of years, not the order of events!
+      # There may be two or more events in the same year.
+      @m_events[response + 1].year == event.year
+    end
+  end
+
+
+end
+
+
+## ---TEST
+if __FILE__ == $0
+  qu = Timequiz.new
+end
+
+## ---END TEST
+# EOF, too.