html2index 1.2.1 → 1.31

data/lib/file_checking.rb

@@ -1,24 +1,19 @@
 #encoding: UTF-8
 =begin
 /***************************************************************************
- *   ©2011-2017 Michael Uplawski <michael.uplawski@uplawski.eu>            *
+ *   ©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 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, 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.  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
+
 require 'filemagic'
 
 =begin

data/lib/html2index.rb

@@ -1,27 +1,20 @@
 #encoding: UTF-8 
 =begin
 /***************************************************************************
- *   ©2015-201/ Michael Uplawski <michael.uplawski@uplawski.eu>            *
+ *   ©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 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, 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.  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
-
 require_relative 'argparser'
-require_relative 'logging'
+require_relative 'basic_logging'
 require_relative 'translating'
 require_relative 'user_input'
 require_relative 'constants'
@@ -36,7 +29,7 @@ require_relative 'file_checking'
 require_relative 'configuration'
 
 class HTML2Index
-  include Logging
+  include BasicLogging
   include Nokogiri
 
 =begin
@@ -44,30 +37,29 @@ class HTML2Index
 =end
 
   def initialize(*argv)
-    init_logger()
     # ensure the configuration-file exist.
     options = ArgParser.parse(argv)
     $configuration = Configuration.new(options)
     $configuration.user_conf
-    @log.level = $log_level
+    set_level $log_level
     @file = $configuration.source
 
-    @log.debug("read #{@file}, write #{$configuration.target}")
+    debug("read #{@file}, write #{$configuration.target}")
     msg = File_Checking::file_check(@file, :exist?, :readable?, :file?)
     if(msg) 
-      @log.error("Error: unsuitable file " <<@file << ": " << msg)
+      error("Error: unsuitable file " <<@file << ": " << msg)
       exit false
     end
 
     ftype = File_Checking::file_type(@file)
-    @log.debug('ftype for ' << @file << ' is ' << ftype.to_s)
+    debug('ftype for ' << @file << ' is ' << ftype.to_s)
     if(ftype && !ftype.empty? && !ftype[0].downcase.match("(html|xml) .*document") )
-      @log.error(@file.dup << ' does not look like a valid file to scan: ' << ftype)
+      error(@file.dup << ' does not look like a valid file to scan: ' << ftype)
       exit false
     end
 
     @problem_log = File.join(temp_dir, PROBLEM_LOG)
-    @log.debug('calling generate() ') 
+    debug('calling generate() ') 
     generate()
   end
 
@@ -77,7 +69,7 @@ class HTML2Index
     $configuration.dicts.each do |d|
       list << '<li>' << d.name << ' : ' << '<a href="' << d.url << '">' << d.url << '</a></li>' << "\n"
     end
-    @log.debug('list is ' << list.to_s)
+    debug('list is ' << list.to_s)
     list << "</ul>\n"
   end
 
@@ -85,19 +77,19 @@ class HTML2Index
         Parses the html-file and generates the glossary.
 =end
   def generate()
-    @log.info('Generating... PSE wait')
+    info('Generating... PSE wait')
     begin
       @doc = HTML::Document.parse(File.open(@file ) )
       write_html()
     rescue SystemExit => ir
-      @log.info "Bye"
+      info "Bye"
       exit true
     rescue Exception => ex
-      @log.error "line #{__LINE__}: " << ex.message
+      error "line #{__LINE__}: " << ex.message
       exit false
     end
     if(File.exist?(@problem_log ))
-      @log.info "Some expressions caused problems and are listed in " << @problem_log
+      info "Some expressions caused problems and are listed in " << @problem_log
     end
   end
   private
@@ -117,13 +109,13 @@ class HTML2Index
         page = Nokogiri::HTML(URI.open(url))
       rescue Exception => ex
         url_b = d.url.dup << URI.encode_www_form_component(expression.gsub(/\s/,'_'))
-        @log.warn('WARNING, accessing ' << url << ': ' << ex.message)
+        warn('WARNING, accessing ' << url << ': ' << ex.message)
         if(url_b != url)
-          @log.warn("\twill try " << url_b)
+          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
-            @log.warn("\tWARNING, accessing " << url_b << ': ' << ex.message)
+            warn("\tWARNING, accessing " << url_b << ': ' << ex.message)
           end
         end
       end
@@ -157,7 +149,7 @@ Creates and returns an Array of Definitions.
       value = $configuration.attr_value
       xpath = ".//#{tag}[contains(@#{attr}, '#{value}')]"
       # xpath = './/' << value << '[@' << attr << '="' << value << '"]'
-      @log.debug('xpath is ' << xpath)
+      debug('xpath is ' << xpath)
       tags = @doc.xpath(xpath)
       tags.each do |t|
         expression = t.attribute('title').to_s
@@ -172,7 +164,7 @@ Creates and returns an Array of Definitions.
               list.push expression.downcase
               definition = dict_definition(expression)
               if(definition && !definition.empty?)
-                # @log.debug('definition is ' << definition.to_s)
+                # debug('definition is ' << definition.to_s)
                 def_list.push(format_index(definition) )
                 def_list.sort!
               end
@@ -181,13 +173,13 @@ Creates and returns an Array of Definitions.
         end
       end
 =begin
-      if(@log.level == Logger::DEBUG)
-        @log.debug('def_list is ') 
-        def_list.each_with_index{|t, i| @log.debug( "%i %s"%[i, t]) }
+      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
-      @log.warn "--------------\n\tIndex generation interrupted by user\n---------------"
+      warn "--------------\n\tIndex generation interrupted by user\n---------------"
     end
     return def_list
   end
@@ -212,11 +204,11 @@ Formats the definition text.
   # def temp_dir options = {:remove => true}
   def temp_dir
     @temp_dir ||= begin
-                    @log.debug('creating temp_dir')
+                    debug('creating temp_dir')
                     require 'tmpdir'
                     require 'fileutils'
                     path = File.join(Dir::tmpdir, "HTML2Index_#{Time.now.to_i}_#{rand(1000)}")
-                    @log.debug('temp-dir path is ' << path)
+                    debug('temp-dir path is ' << path)
                     Dir.mkdir(path)
                     # at_exit {FileUtils.rm_rf(path) if File.exists?(path)} if options[:remove]
                     File.new path
@@ -245,7 +237,7 @@ Formats the definition text.
         end
       end
     else
-      @log.debug('out_file is STDOUT')
+      debug('out_file is STDOUT')
     end
     begin
       html = template.to_s
@@ -258,15 +250,15 @@ Formats the definition text.
       fdelim = $configuration.fdelim
       placeholders.each_pair do |k, v|
         repl = fdelim.dup << v << fdelim.reverse
-        @log.debug('try to replace ' << repl)
+        debug('try to replace ' << repl)
         html.gsub!(repl, data[k])
       end
-      @log.debug('html is now ' << html)
+      debug('html is now ' << html)
       html.gsub!(/\<head\>/, "<head>\n\t#{GeneratorMeta}")
       File.write(out_file, html) if out_file
       puts html if !out_file
     rescue Exception => ex
-      @log.error( "line #{__LINE__} " << ex.message << ' (' << ex.class.name << ')')
+      error( "line #{__LINE__} " << ex.message << ' (' << ex.class.name << ')')
     ensure
       out.close if out && !out.closed?
       File.unlink(out) if out

data/lib/template.rb

@@ -1,38 +1,31 @@
 #encoding: UTF-8 
+
 =begin
 /***************************************************************************
- *   ©2017-2017 Michael Uplawski <michael.uplawski@uplawski.eu>            *
+ *   ©2017-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 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, 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.  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
-require 'logger'
+
 require 'date'
-require_relative 'logging'
+require_relative 'basic_logging'
 require_relative 'dictionary'
 require_relative 'constants'
 require_relative 'file_checking'
 
 class Template
-  self.extend(Logging)
-  @@log = init_logger
+  include BasicLogging
 
   def initialize()
-    @log = @@log
-    @log.level = $log_level
+    set_level = $log_level
     template_file = $configuration.template
     @template = nil
     if template_file
@@ -45,9 +38,9 @@ class Template
       end
       if(!msg)
         @template = File.read(template_file)
-        @log.debug('using template ' << template_file)
+        debug('using template ' << template_file)
       else
-        @log.warn('Cannot use template ' << template_file << ': ' << msg << "\n\tusing default template")
+        warn('Cannot use template ' << template_file << ': ' << msg << "\n\tusing default template")
       end
     end
   end
@@ -57,7 +50,7 @@ class Template
     if @template && @template.respond_to?(:to_str)
       str = @template
     else
-      @log.warn('Empty template, using default!')
+      warn('Empty template, using default!')
       str = @@def_template
     end
     str
@@ -74,8 +67,8 @@ class Template
     when :def_template
       @@def_template
     else
-      @log.error('Do not know ' << name.to_s)
-      @log.error('Aborting. Bye!')
+      error('Do not know ' << name.to_s)
+      error('Aborting. Bye!')
     end
   end
 

data/lib/translating.rb

@@ -1,23 +1,16 @@
 #encoding: UTF-8
 =begin
 /***************************************************************************
- *   ©2011-2017, Michael Uplawski				           * 
- *   <michael.uplawski@uplawski.eu>  					   *
+ *   ©2011-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 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, 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.  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/user_input.rb

@@ -1,26 +1,18 @@
 #encoding: UTF-8
-
 =begin
 /***************************************************************************
- *   Copyright © 2014, Michael Uplawski <michael.uplawski@uplawski.eu>     *
+ *   ©2011-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 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, 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.  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
-
 require 'io/wait'
 require 'io/console'
 

data/lib/version.rb

@@ -1,12 +1,16 @@
-# 
-# DON'T FORGET SCHWEINE-MET ON THE FENSTERBRETT !!
-# =================================================
-# - Change gemspec !!
-# - Change version in the doc/rst folder !!
-# - INSTALL AND TEST THAT GEM !!
-# - gem push
-#
-# - blame yourself.
-#
-VERSION='1.2.1'
-
+=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
+VERSION ='1.31'
+SUMMARY = "New logging module, new license, homepage and documentation"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: html2index
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: '1.31'
 platform: ruby
 authors:
 - Michael Uplawski
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-05 00:00:00.000000000 Z
+date: 2026-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,20 +15,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.18'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.9
+        version: 1.18.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.18'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.9
+        version: 1.18.10
 - !ruby/object:Gem::Dependency
   name: ruby-filemagic
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +38,7 @@ dependencies:
         version: '0.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.7.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +48,7 @@ dependencies:
         version: '0.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.7.3
 description: creates a glossary from HTML
 email: michael.uplawski@uplawski.eu
 executables:
@@ -64,6 +63,7 @@ files:
 - doc/rst/html2index.rst
 - html2index.gemspec
 - lib/argparser.rb
+- lib/basic_logging.rb
 - lib/configuration.rb
 - lib/constants.rb
 - lib/definition.rb
@@ -71,17 +71,17 @@ files:
 - lib/file_checking.rb
 - lib/html2index.rb
 - lib/log.conf
-- lib/logging.rb
 - lib/template.rb
 - lib/translating.rb
 - lib/translations
 - lib/user_input.rb
 - lib/version.rb
-homepage: http://www.souris-libre.fr
 licenses:
-- GPL-3.0
-metadata: {}
-post_install_message: 
+- Nonstandard
+metadata:
+  homepage_uri: https://www.uplawski.eu/software/
+  documentation_uri: https://www.uplawski.eu/software/html2index/html2index.html
+  license_uri: https://www.wtfpl.net/about/
 rdoc_options: []
 require_paths:
 - lib
@@ -89,7 +89,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.1
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -97,8 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - nokogiri, ruby-filemagic
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
-summary: updated dependencies, updated use of the URI module.
+summary: New logging module, new license, homepage and documentation
 test_files: []