timequiz 0.1.4 → 0.1.6

data/lib/timequiz.rb

@@ -1,25 +1,18 @@
 #!/usr/bin/env ruby 
 #encoding: UTF-8
-
 =begin
-/******************************************************************************
- *   Copyright © 2017-2021, 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.                *
- ******************************************************************************/
+/***************************************************************************
+ *   ©2017-2024, Michael Uplawski <michael.uplawski@uplawski.eu>           *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the WTFPL 2.0 or later, see                     * 
+ *   http://www.wtfpl.net/about/                                           *
+ *                                                                         *
+ *   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.                  *
+ *                                                                         *
+ ***************************************************************************/
 =end
 
 require_relative 'argparser'
@@ -29,7 +22,7 @@ require_relative 'extstring'
 require_relative 'user_input'
 require_relative 'busy_indicator'
 require_relative 'event'
-require_relative 'logging'
+require_relative 'basic_logging'
 
 require 'date'
 
@@ -37,8 +30,7 @@ require 'date'
 # precisely in the start_game() method which has to be defined by an
 # interface-module. 
 class Timequiz
-  self::extend(Logging)
-  @@log = self::init_logger()
+  include BasicLogging
 
   # Find out, how the program has been called.
   # In juin 2017 this can be 'timequiz' or 'timequizGtk'.
@@ -60,7 +52,7 @@ class Timequiz
   when 'timequizGtk'
     # require_relative 'gtk/timequizGtk'
     # include TimequizGtk
-    @log.info('I am sorry. But there is not Gtk-interface, for the time.')
+    info('I am sorry. But there is not Gtk-interface, for the time.')
     # Text only
   when 'timequiz'
     require_relative 'console'
@@ -74,7 +66,7 @@ class Timequiz
     # 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.") 
+    error(": A user-interface \"" << called_as? << "\" has not (yet) been defined (read the code, my friend)! Aborting.") 
     exit false
   end 
 
@@ -85,14 +77,14 @@ class Timequiz
     begin
       ofl = File.open(file, 'a')
       if !File.readable?(file)
-        @log.error('The file ' << file << ' cannot be read! Aborting')
+        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.")
+        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)
+          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:")
@@ -114,25 +106,21 @@ class Timequiz
       end
     rescue IOError => ex
       ofl.close
-      @log.error('Cannot work with the given file: ' << ex.message)
+      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)
+    set_level (BasicLogging::DEBUG if options.debug)
     #    should we add only a new event to the list  
-    @log.debug('options are : ' << options.to_s)
+    debug('options are : ' << options.to_s)
     add_ok = game_ok = false
     if(options.file)
-      @log.debug('shall use non-standard events file')
+      debug('shall use non-standard events file')
       add_ok, game_ok = verify_prepare(options.file)
     else
       game_ok = require_relative 'events'
@@ -142,10 +130,10 @@ class Timequiz
         Adder::add(options)
         exit true
       elsif(options.file)
-        @log.error('cannot add events to ' << options.file)
+        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')
+        error('PSE start the program with -h or --help to see an option-overview')
         exit false
       end
     end
@@ -154,8 +142,8 @@ class Timequiz
     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!") 
+      error("Cannot play with the events in " << options.file)
+      error("PSE verify that there are at least 3 events defined!") 
       exit false
     end
   end
@@ -186,7 +174,7 @@ class Timequiz
       response_years = []
       # response.each_with_index {|r, i| response_years[r-1] = @m_events[i].year}
       response.each_with_index {|r, i| response_years[i] = @m_events[r-1].year}
-      @log.debug('response is ' << response.join(', ') << "\nresponse_years is : " << response_years.join(', ') )
+      debug('response is ' << response.join(', ') << "\nresponse_years is : " << response_years.join(', ') )
       puts 'response is ' << response.join(', ') << "\nresponse_years is : " << response_years.join(', ') 
 
       # do not change the displayed index

data/lib/user_input.rb

@@ -2,22 +2,16 @@
 
 =begin
 /***************************************************************************
- *   Copyright © 2017-2017, Michael Uplawski <michael.uplawski@uplawski.eu>*
+ *   ©2017-2024, 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.                                   *
+ *   it under the terms of the WTFPL 2.0 or later, see                     * 
+ *   http://www.wtfpl.net/about/                                           *
  *                                                                         *
  *   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.                          *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
  *                                                                         *
- *   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
 

data/lib/version.rb

@@ -1,27 +1,22 @@
-#!/usr/bin/env ruby 
 #encoding: UTF-8
 
 =begin
-/******************************************************************************
- *   Copyright © 2021-2021, 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.                *
- ******************************************************************************/
+/***************************************************************************
+ *   ©2017-2024, Michael Uplawski <michael.uplawski@uplawski.eu>           *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the WTFPL 2.0 or later, see                     * 
+ *   http://www.wtfpl.net/about/                                           *
+ *                                                                         *
+ *   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.                  *
+ *                                                                         *
+ ***************************************************************************/
 =end
 
-VERSION = '0.1.4'
-SUMMARY = 'Bugs fixed: Timeline validation corrected. Line-breaks in console-output, when more than 9 events are listed.'
-
+VERSION = '0.1.6'
+SUMMARY = 'Some new events added. Fixed a bug in the logging-configuration.'
+AUTHOR = 'Michael Uplawski'
+AUTHOR_MAIL = '<michael.uplawski@uplawski.eu>'
+YEARS = 2017 - 2024

data/timequiz.gemspec

@@ -9,11 +9,11 @@ Gem::Specification.new do |s|
   s.description = "Play a history game"
   s.authors     = ["Michael Uplawski"]
   s.email       = 'michael.uplawski@uplawski.eu'
-  s.files  	=  %w~timequiz~.collect{|f| 'bin/' << f} + %w~log.conf version.rb file_checking.rb logging.rb adder.rb argparser.rb busy_indicator.rb color_output.rb console.rb constants.rb event.rb events.rb extstring.rb user_input.rb timequiz.rb~.collect{|f| 'lib/' << f} + %w~timequiz.gemspec~.collect{|f|f} + %w~man/timequiz.6.gz html/timequiz.html pdf/timequiz.pdf rst/timequiz.rst license.txt~.collect{|f| 'doc/' << f}
+  s.files  	=  %w~timequiz~.collect{|f| 'bin/' << f} + %w~basic_logging.rb version.rb file_checking.rb adder.rb argparser.rb busy_indicator.rb color_output.rb console.rb constants.rb event.rb events.rb extstring.rb user_input.rb timequiz.rb~.collect{|f| 'lib/' << f} + %w~timequiz.gemspec~.collect{|f|f} + %w~man/timequiz.6.gz html/timequiz.html pdf/timequiz.pdf rst/timequiz.rst license.txt~.collect{|f| 'doc/' << f} + ["README.md"]
   s.homepage    = ''
   #s.requirements = ''
   #s.add_runtime_dependency ''
   s.executables = 'timequiz'
-  s.license     = 'GPL-3.0'
+  s.license     = 'Nonstandard'
   s.required_ruby_version = '>= 2.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timequiz
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Michael Uplawski
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2024-01-06 00:00:00.000000000 Z
 dependencies: []
 description: Play a history game
 email: michael.uplawski@uplawski.eu
@@ -17,6 +17,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - bin/timequiz
 - doc/html/timequiz.html
 - doc/license.txt
@@ -25,6 +26,7 @@ files:
 - doc/rst/timequiz.rst
 - lib/adder.rb
 - lib/argparser.rb
+- lib/basic_logging.rb
 - lib/busy_indicator.rb
 - lib/color_output.rb
 - lib/console.rb
@@ -33,17 +35,15 @@ files:
 - lib/events.rb
 - lib/extstring.rb
 - lib/file_checking.rb
-- lib/log.conf
-- lib/logging.rb
 - lib/timequiz.rb
 - lib/user_input.rb
 - lib/version.rb
 - timequiz.gemspec
 homepage: ''
 licenses:
-- GPL-3.0
+- Nonstandard
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -58,9 +58,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
-summary: 'Bugs fixed: Timeline validation corrected. Line-breaks in console-output,
-  when more than 9 events are listed.'
+summary: Some new events added. Fixed a bug in the logging-configuration.
 test_files: []

data/lib/log.conf

@@ -1,55 +0,0 @@
-#encoding: UTF-8 
-=begin
-/***************************************************************************
- *   ©2013 - 2021 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.             *
- ***************************************************************************/
-
-A simplified logger configuration. Set the level for each individual logger
-below. Choose a different log-device or log-file if you like. Keep the 
-formatting intact.  Do not change other sections of this file.
-=end
-
-# Do not touch from here ----->
-require 'logger'
-
-debug = Logger::DEBUG
-info = Logger::INFO
-error = Logger::ERROR
-fatal = Logger::FATAL
-warn = Logger::WARN
-unknown = Logger::UNKNOWN
-{
-# <---------------- to here !
-
-# Enter your settings here, but take into consideration that not all 
-# the named classes will really produce readable output. Well, you can 
-# always try... Either name just the log-level or make the log-level
-# precede the output-device or output-file like in the examples.
-
-# Example: naming a log-file
-#
-# :HtmlBuilder => [info, 'C:\temp\htmlbuilder.log'],
-#
-# :HtmlBuilder => [debug, '/tmp/htmlbuilder.log'],
-
-:Timequiz => [debug, '/tmp/timequiz.log'],
-:Console =>
-
-# And ignore the remainder, too.
-}
-#eof

data/lib/logging.rb

@@ -1,204 +0,0 @@
-#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