html2index 1.31 → 1.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac3500ba93b1ad1108106100ff3ba3f283365fc1d0e9450166e3665094a1399e
-  data.tar.gz: 353507e7937e2d346a0c6a84090565137e0b7efd5719f6c86c3de3baa4743811
+  metadata.gz: 1456e2bc8e3d35b08d58d69cc1261fceb4ec2fc0e1ee3201f2b953c386978349
+  data.tar.gz: 98fd67920f0d97a8ec7398217e9a0e5bc6e36de38607248d69884348d3a706d6
 SHA512:
-  metadata.gz: b96ea9f2c1af992b11258d41be02d2440227a7e409f71e2e88ce315bac65c05be300dd8731dc8dd6a6f352ccb2bacd4856a3579d0ec414cdc5e1b9057d765dd4
-  data.tar.gz: 040a38e2d826e985a74cf294eabc0ff7f3dca73eb08f03135841ddb1965915dfcd264aaac38339702ef176e01eda0567e54077fbc934c6058bcf8debb8b067c2
+  metadata.gz: 0d41f7adc915c991c9cd76bbc0fcb5b710e42fb1d1c293d3709e8438c7498638dea55f43ef41c955117da6af6a2ca0ea785ecd741a295066def23988ced49b96
+  data.tar.gz: d5ae2d2fa8bc32e8bbd3a61efd4acba0c50132a87b5124e1e29eaed3ea945aa6d8ebdb107d540b516c0d80c49d05a1cf2a3bbc9ce355ef7194e469c04059fbe7

data/doc/rst/html2index.rst

@@ -267,3 +267,15 @@ accessible. You can also decompress the gem-file to take a look at the code.
 
 :AUTHOR: Michael Uplawski <michael[dot]uplawski[at]uplawski[dot]eu>
 
+This document
+=============
+.. _CC By-ND 4.0: https://creativecommons.org/licenses/by-nd/4.0/
+.. |date| date::
+
+©Michael Uplawski <michael.uplawski@uplawski.eu>
+
+License: `CC BY-ND 4.0`_
+
+Date: |date|
+
+**Ω**

data/html2index.gemspec

@@ -10,10 +10,10 @@ Gem::Specification.new do |s|
   s.description = "creates a glossary from HTML"
   s.authors     = ["Michael Uplawski"]
   s.email       = 'michael.uplawski@uplawski.eu'
-  s.files  	=  %w~html2index~.collect{|f| 'bin/' << f} + %w~version.rb argparser.rb configuration.rb constants.rb dictionary.rb html2index.rb basic_logging.rb translating.rb user_input.rb definition.rb file_checking.rb log.conf template.rb translations~.collect{|f| 'lib/' << f} + %w~html2index.gemspec~.collect{|f|f} + %w~html/html2index.html man/html2index.1.gz pdf/html2index.pdf rst/html2index.rst~.collect{|f| 'doc/' << f}
+  s.files  	=  %w~html2index~.collect{|f| 'bin/' << f} + %w~version.rb argparser.rb config configuration.rb constants.rb dictionary.rb html2index.rb basic_logging.rb translating.rb user_input.rb definition.rb template.rb translations~.collect{|f| 'lib/' << f} + %w~html2index.gemspec~.collect{|f|f} + %w~html/html2index.html man/html2index.1.gz pdf/html2index.pdf rst/html2index.rst~.collect{|f| 'doc/' << f}
   s.requirements = 'nokogiri, ruby-filemagic'
   s.add_runtime_dependency 'nokogiri', '~> 1.18', '>= 1.18.10'
-  s.add_runtime_dependency 'ruby-filemagic', '~> 0.7', '>= 0.7.3'
+  s.add_runtime_dependency 'marcel', '~> 1.2', '>= 1.2.1'
   s.executables = 'html2index'
   s.metadata = {
     "homepage_uri" => 'https://www.uplawski.eu/software/',

data/lib/argparser.rb

@@ -23,7 +23,7 @@ require_relative 'version'
 require_relative 'constants'
 
 class ArgParser 
-  include BasicLogging
+  extend BasicLogging
   # self.extend(Translating)
 
   # Returns a structure describing the options.
@@ -45,8 +45,8 @@ class ArgParser
       opts.banner = usage
 
       opts.on("-d", "--debug", 'Be verbose') do  
-        $log_level = Logger::DEBUG
-        set_level $log_level
+        $log_level = BasicLogging::DEBUG
+        set_level BasicLogging::DEBUG
       end
 
       opts.on("-sOURCE", "--source=SOURCE", 'Source document (html)') do |so|
@@ -83,7 +83,6 @@ class ArgParser
       puts "Start this program with parameter -h or --help to see the usage-message."
       exit false
     end
-    debug('options are ' << options.to_s)
 
     options
   end  # parse()

data/lib/basic_logging.rb

@@ -21,15 +21,15 @@
 # Execute this file to see the output.
 module BasicLogging
 
-  DEBUG = 0
-  INFO =  1
-  WARN =  2
-  ERROR = 3
-  FATAL = 4
-  UNKNOWN = nil
+  DEBUG ||= 0 
+  INFO ||=  1
+  WARN ||=  2
+  ERROR ||= 3
+  FATAL ||= 4
+  UNKNOWN ||= nil
   
   # this is mainly for the translation of method calls into log levels
-  Levels = {:debug => DEBUG, :info => INFO, :warn => WARN, :error => ERROR,
+  Levels ||= {:debug => DEBUG, :info => INFO, :warn => WARN, :error => ERROR,
             :fatal => FATAL, :unknown => UNKNOWN}
 
   @@log_level = UNKNOWN

data/lib/config

@@ -0,0 +1,27 @@
+---
+
+template: "~/template.html "
+
+placeholders:
+ dict_list : "index"
+ glossary  : "glossary"
+
+fdelim: '%='
+
+html_tag: 'span'
+html_attribute: 'class'
+attr_value: 'glossar'
+
+dictionaries:
+    - dict1:
+       name: Merriam-Webster
+       url: https://www.merriam-webster.com/thesaurus/
+       xpath: ".//span[@class='dt ']"
+       color: #a0a000
+
+#    - dict2
+#        name:
+#        url:
+#        xpath:
+#        color: 
+

data/lib/configuration.rb

@@ -17,12 +17,11 @@ require 'yaml'
 require 'singleton'
 require 'ostruct'
 require_relative 'constants'
-require_relative 'file_checking'
 require_relative 'basic_logging'
 require_relative 'translating'
 
+# TODO: write default configuration to file !
 class Configuration
-  include File_Checking
   include Translating
   include BasicLogging
 
@@ -44,8 +43,17 @@ class Configuration
     config = confdir << File::Separator << 'config'
     if(!File.exist?(config ) )
       begin
-        File.open(config, 'w') {|co| co.write(File.read(@@config_file))}
-        info("Created user-version of the configuration-file in\n\t" << config)
+        debug 'user cofiguration shall be ' << config
+        debug 'reading defaults from ' << @@config_file
+        if(File.exist?(@@config_file) )
+          File.open(config, 'w+') {|co| co.write(File.read(@@config_file))}
+          info("Created user-version of the configuration-file in\n\t" << config)
+        else
+          warn(@@config_file.dup << ' does not exist!')
+          #----------- write default configuration to file --------
+          
+          give_up
+        end
       rescue Exception => ex
         error('Cannot create the configuration: ' << ex.message)
         give_up
@@ -77,14 +85,16 @@ class Configuration
     if(options['config'])
       cf = options['config'] 
       debug('config should be ' << cf.to_s)
-      msg = file_check(cf, :file, :readable)
-      if(!msg) 
-        @@config_file = cf
-      else
-        msg = ("The file %s " << msg.split[1,100].join(' ')) %msg.split[0]
-        error(("ERROR! Unsuitable file") << ' ' << msg)
-        give_up
+      [:file?, :readable?].each do |cond|
+        if ! File.send(cond, cf)
+          msg = cf.dup.to_s << ": Not " << cond.to_s.split('?')[0] << '!'
+          error(("ERROR! Unsuitable file") << ' ' << msg)
+          # exit
+          give_up
+        end
       end
+
+      @@config_file = cf
     else
       @@config_file = user_conf
     end
@@ -158,7 +168,7 @@ Defaults are: %s~ %[URL_DICT1.dup << ', ' << URL_DICT2.dup])
       @dicts << Dictionary.new(NAME_DICT2, URL_DICT2, XPATH_DICT2, DICT_COLORS[1])
       debug('dicts are from constants' << @dicts.to_s)
     end
-    warn "HINT: Adapt #{@@config_file} to avoid warnings in the future." if warn
+    warn "HINT: Adapt #{@@config_file} to avoid warnings in the future." 
   end
 
   # exit on error

data/lib/constants.rb

@@ -17,7 +17,7 @@ require_relative 'dictionary'
 require_relative 'basic_logging'
 require 'date'
 
-APPNAME = 'HTML2Index'
+APPNAME ||= 'HTML2Index'
 
 # URL and xpath for the definitions.
 #
@@ -43,7 +43,7 @@ DICT_COLORS ||= ['a000a0', '00a000']
 
 # definitions which cause problems are logged.
 PROBLEM_LOG ||= 'html2index_problems.txt'
-$log_level = BasicLogging::INFO
+$log_level ||= BasicLogging::INFO
 
 # meta-tag for the html-output
-GeneratorMeta = "<meta name=\"generator\" content=\"HTML2Index ©2015-#{Date.today.strftime('%Y')} michael.uplawski@uplawski.eu\" />"
+GeneratorMeta ||= "<meta name=\"generator\" content=\"HTML2Index ©2015-#{Date.today.strftime('%Y')} michael.uplawski@uplawski.eu\" />"

data/lib/dictionary.rb

@@ -27,6 +27,13 @@ class Dictionary
 		@xpath = xpath
 		@color = color
 	end
+
+    def valid?
+      return (@name && ! @name.empty?
+              && @url && ! @url.empty?
+              && @xpath && ! @xpath.empty?
+              && @color && ! @color.empty?)
+    end
 end
 
 ##### TEST

data/lib/html2index.rb

@@ -24,14 +24,15 @@ require_relative 'dictionary'
 require_relative 'template'
 require 'open-uri'
 require 'nokogiri'
-require 'filemagic'
-require_relative 'file_checking'
+require 'marcel'
 require_relative 'configuration'
 
 class HTML2Index
   include BasicLogging
   include Nokogiri
 
+
+  @@log_level = :debug
 =begin
         initialize the HTML2Index-object
 =end
@@ -45,15 +46,18 @@ class HTML2Index
     @file = $configuration.source
 
     debug("read #{@file}, write #{$configuration.target}")
-    msg = File_Checking::file_check(@file, :exist?, :readable?, :file?)
-    if(msg) 
-      error("Error: unsuitable file " <<@file << ": " << msg)
-      exit false
+    msg = ''
+    [:exist?, :readable?, :file?].each do |cond|
+      if !File.send(cond, @file)
+        error("Error: unsuitable file " <<@file << ": NOT " << cond.to_s.split('?')[0] << '!')
+        exit false
+      end
     end
 
-    ftype = File_Checking::file_type(@file)
+    ftype = Marcel::Magic.by_path(@file).subtype
+
     debug('ftype for ' << @file << ' is ' << ftype.to_s)
-    if(ftype && !ftype.empty? && !ftype[0].downcase.match("(html|xml) .*document") )
+    if(ftype && !ftype.empty? && !ftype.downcase.match(/(html|xml)/) )
       error(@file.dup << ' does not look like a valid file to scan: ' << ftype)
       exit false
     end
@@ -101,41 +105,62 @@ class HTML2Index
 =end
   def dict_definition(expression)
     definitions = Array.new
-    $configuration.dicts.each do |d|
-      text_array = Array.new
-      page = nil
-      begin
-        url = d.url.dup << URI.encode_www_form_component(expression.gsub(/\s/,'_').gsub("'", ''))
-        page = Nokogiri::HTML(URI.open(url))
-      rescue Exception => ex
-        url_b = d.url.dup << URI.encode_www_form_component(expression.gsub(/\s/,'_'))
-        warn('WARNING, accessing ' << url << ': ' << ex.message)
-        if(url_b != url)
-          warn("\twill try " << url_b)
+    if $configuration.dicts && ! $configuration.dicts.empty?  
+      $configuration.dicts.each do |d|
+        if d && d.valid?
+          debug 'dict: ' << (d ? d.inspect : ' N I L ')
+          text_array = Array.new
+          page = nil
           begin
-            page = Nokogiri::HTML(URI.open(url_b, "User-Agent"=>"#{APPNAME} #{VERSION}", "From"=>"Function Test <bat.guano@don.blech.e4ward.com>"))
+            url = d.url.dup << URI.encode_www_form_component(expression.gsub(/\s/,'_').gsub("'", ''))
+            page = Nokogiri::HTML(URI.open(url))
           rescue Exception => ex
-            warn("\tWARNING, accessing " << url_b << ': ' << ex.message)
+            url_b = d.url.dup << URI.encode_www_form_component(expression.gsub(/\s/,'_'))
+            warn('WARNING, accessing ' << url << ': ' << ex.message)
+            if(url_b != url)
+              warn("\twill try " << url_b)
+              begin
+                page = Nokogiri::HTML(URI.open(url_b, "User-Agent"=>"#{APPNAME} #{VERSION}", "From"=>"Function Test <bat.guano@don.blech.e4ward.com>"))
+              rescue Exception => ex
+                warn("\tWARNING, accessing " << url_b << ': ' << ex.message)
+              end
+            end
+          else
+            warn  'invalid dictionary definition'
+
           end
         end
-      end
-      if(page)
-        nodes = page.xpath(d.xpath)
-        if(nodes)
-          text_array = nodes.collect {|n| n.inner_text.to_s.strip}
-          if(!text_array.empty?)
-            definition = Definition.new(d.name, expression.gsub('_', ' '), text_array)
-            definition.color = d.color
-            definitions.push(definition)
+        if(page)
+          nodes = page.xpath(d.xpath)
+          if(nodes)
+            text_array = nodes.collect {|n| n.inner_text.to_s.strip}
+            if(!text_array.empty?)
+              definition = Definition.new(d.name, expression.gsub('_', ' '), text_array)
+              definition.color = d.color
+              definitions.push(definition)
+            end
           end
+        else
+          File.open(@problem_log, 'a'){|f| f.write(expression + "\n") }
         end
-      else
-        File.open(@problem_log, 'a'){|f| f.write(expression + "\n") }
       end
+    else
+      error 'no dictionaries defined!'
+      exit false
     end
     return definitions
   end
 
+  def verify_strings(strs)
+    debug 'strings to verify: ' << strs.to_s
+    if strs.respond_to?(:to_ary) 
+      strs.each {|s| return false if(!s || s.strip.empty?) }
+    else
+      return strs && !(strs.strip).empy?()
+    end
+    return true
+  end
+
 =begin
 Creates and returns an Array of Definitions.
 =end
@@ -144,43 +169,57 @@ Creates and returns an Array of Definitions.
       #TODO: Hash
       list = Array.new
       def_list = Array.new
+
       tag = $configuration.html_tag
       attr = $configuration.html_attribute
       value = $configuration.attr_value
-      xpath = ".//#{tag}[contains(@#{attr}, '#{value}')]"
-      # xpath = './/' << value << '[@' << attr << '="' << value << '"]'
-      debug('xpath is ' << xpath)
-      tags = @doc.xpath(xpath)
-      tags.each do |t|
-        expression = t.attribute('title').to_s
-        unless (expression && !expression.strip.empty? )
-          expression = t.text.to_s
-        end
-        if(expression)
-          expression.gsub!(/\s+/, " ")
-          expression.strip!	
-          if(!expression.empty? && !def_list.include?(expression) )
-            if(!list.include?expression.downcase) 
-              list.push expression.downcase
-              definition = dict_definition(expression)
-              if(definition && !definition.empty?)
-                # debug('definition is ' << definition.to_s)
-                def_list.push(format_index(definition) )
-                def_list.sort!
+
+      if verify_strings([tag,attr,value]) 
+        xpath = ".//#{tag}[contains(@#{attr}, '#{value}')]"
+        # xpath = './/' << value << '[@' << attr << '="' << value << '"]'
+        debug('xpath is ' << xpath)
+        tags = @doc.xpath(xpath)
+        if(tags && !tags.empty?)
+          tags.each do |t|
+            expression = t.attribute('title').to_s
+            unless (expression && !expression.strip.empty? )
+              expression = t.text.to_s
+            end
+            if(expression)
+              expression.gsub!(/\s+/, " ")
+              expression.strip!	
+              if(!expression.empty? && !def_list.include?(expression) )
+                if(!list.include?expression.downcase) 
+                  list.push expression.downcase
+                  definition = dict_definition(expression)
+                  if(definition && !definition.empty?)
+                    # debug('definition is ' << definition.to_s)
+                    def_list.push(format_index(definition) )
+                    def_list.sort!
+                  end
+                end
               end
             end
           end
+        else
+          error 'Cannot find any marked tags in the source-file. Aborting!'
+          raise SystemExit
+          #exit false
         end
+      else
+        error 'Configuration incomplete. Verify tag, attribute and attribute value! Aborting!'
+        raise SystemExit
+        #exit false
       end
-=begin
-      if(level == Logger::DEBUG)
-        debug('def_list is ') 
-        def_list.each_with_index{|t, i| debug( "%i %s"%[i, t]) }
-      end
-=end
     rescue Interrupt => ex
       warn "--------------\n\tIndex generation interrupted by user\n---------------"
+    rescue SystemExit => sx
+      raise sx
+    rescue Exception => ex 
+      error( "line #{__LINE__} " << ex.message << ' (' << ex.class.name << ')')
+      exit false
     end
+
     return def_list
   end
 
@@ -219,10 +258,12 @@ Formats the definition text.
     tempfile = nil
     out = nil
     out_file = $configuration.target
+    debug 'out_file is ' << out_file
     template = Template.new
+    debug 'template is ' << template.to_s
     if out_file
-      if(File.exist?(out_file))
-        if(File.writable?(out_file))
+      if(out_file != '<STDOUT>' && File.exist?(out_file) )
+        if( File.writable?(out_file) )
           puts "\nWARNING! File " << out_file << " exists!"
           print "Do you want to overwrite it? (Y/n) "
           res = wait_for_user
@@ -237,9 +278,10 @@ Formats the definition text.
         end
       end
     else
-      debug('out_file is STDOUT')
+      info('Writing to ' << out_file)
     end
     begin
+      debug 'begin'
       html = template.to_s
 
       # create the definitions in index()

data/lib/template.rb

@@ -19,7 +19,6 @@ require 'date'
 require_relative 'basic_logging'
 require_relative 'dictionary'
 require_relative 'constants'
-require_relative 'file_checking'
 
 class Template
   include BasicLogging
@@ -29,18 +28,17 @@ class Template
     template_file = $configuration.template
     @template = nil
     if template_file
-      msg = File_Checking::file_check(template_file, :file, :readable )
-      if !msg
-        ftype = File_Checking::file_type(template_file)
-        if ftype && !ftype.empty? && !ftype[0].downcase.match("(html|xml) .*document")
-          msg = template_file.dup << ' does not look like a valid template file for (x)html: ' << ftype.join('; ') 
+      error = nil 
+      [:file?, :readable?].each do |cond|
+        if(!File.send(cond, template_file) )
+           error = true
+           warn('Cannot use template ' << template_file << ': NOT ' << cond.to_s.split('?')[0] << ',' << "\n\tusing default template")
         end
       end
-      if(!msg)
+
+      if(!error)
         @template = File.read(template_file)
         debug('using template ' << template_file)
-      else
-        warn('Cannot use template ' << template_file << ': ' << msg << "\n\tusing default template")
       end
     end
   end

data/lib/translating.rb

@@ -18,7 +18,6 @@
 RD = File.expand_path(File.dirname(__FILE__) ) +  File::SEPARATOR if !defined?(RD)
 
 require 'yaml'
-require_relative 'file_checking'
 
 
 # A way to produce translated text in a ruby-program.
@@ -31,21 +30,32 @@ module Translating
 
 	@@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_Checking::file_check(@@lang_file, [:exist?, :readable?]) && 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
+    @@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]
+        else
+          error = nil 
+          [:exist?, :readable?].each do |cond|
+            if(! File.send(cond, @@lang_File))
+              error = cond.to_s.split('?')[0]
+            end
+          end
+          if(!error && File::size(@@lang_file) >= 2)
+            File::open(@@lang_file, 'r') {|f| @@lang = f.readline}
+            @@lang.chomp!.downcase! if @@lang
+          else
+            warn 'Cannot use ' << @@lang_file << '; file unuseable'
+            info 'Language will be English'
+          end
+        end
+      end
+      @@lang = 'en' if !@@lang
+    end
 
 	# Translate a string to the currently set langage. 
 	# The args parameter may contain replacement-text which 

data/lib/version.rb

@@ -12,5 +12,5 @@
  *                                                                         *
  ***************************************************************************/
 =end
-VERSION ='1.31'
-SUMMARY = "New logging module, new license, homepage and documentation"
+VERSION ='1.32'
+SUMMARY = "Generate a Glossary from a html-page"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: html2index
 version: !ruby/object:Gem::Version
-  version: '1.31'
+  version: '1.32'
 platform: ruby
 authors:
 - Michael Uplawski
 bindir: bin
 cert_chain: []
-date: 2026-01-16 00:00:00.000000000 Z
+date: 2026-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -30,25 +30,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.18.10
 - !ruby/object:Gem::Dependency
-  name: ruby-filemagic
+  name: marcel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 1.2.1
 description: creates a glossary from HTML
 email: michael.uplawski@uplawski.eu
 executables:
@@ -64,13 +64,12 @@ files:
 - html2index.gemspec
 - lib/argparser.rb
 - lib/basic_logging.rb
+- lib/config
 - lib/configuration.rb
 - lib/constants.rb
 - lib/definition.rb
 - lib/dictionary.rb
-- lib/file_checking.rb
 - lib/html2index.rb
-- lib/log.conf
 - lib/template.rb
 - lib/translating.rb
 - lib/translations
@@ -97,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - nokogiri, ruby-filemagic
-rubygems_version: 3.6.7
+rubygems_version: 4.0.18
 specification_version: 4
-summary: New logging module, new license, homepage and documentation
+summary: Generate a Glossary from a html-page
 test_files: []

data/lib/file_checking.rb

@@ -1,98 +0,0 @@
-#encoding: UTF-8
-=begin
-/***************************************************************************
- *   ©2015-2026, 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, version 2 or later, as published on  *
- *   https://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 'filemagic'
-
-=begin
-A module to facilitate frequently occuring checks on
-file-system objects
-=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!",
-    :type => "is not of the right file-type!",
-    :mime => "does not have the right mime-type!",
-  }
-
-  # find the file-type for a given file name
-  def self::file_type(file, mime = false)
-    fm = FileMagic.fm
-    file_magic = fm.file(file)
-    file_mime = nil
-    if mime
-    fm.flags = [:mime_type] 
-    file_mime = fm.file(file)	
-    end
-    return file_magic, file_mime
-  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 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
-end
-
-=begin
-# example
-
-include File_Checking
-msg = file_check('some_file.txt', [:exist?, :readable?, 'writable'])
-puts msg if msg
-=end

data/lib/log.conf

@@ -1,56 +0,0 @@
-#encoding: UTF-8 
-=begin
-/***************************************************************************
- *   ©2013-2015 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'],
-
-:HTML2Index => debug,
-:Template => info,
-:Configuration => info,
-:ArgParser => info,
-
-# And ignore the remainder, too.
-}
-
-#eof