flnews_post_proc 1.45 → 1.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c48262d6fc3031346ffa1e2b528e11a696cef83b6d7c64fa98cdef444cf60247
-  data.tar.gz: 12e53f1d88d613d14671ed06f03c0e65ca5f438088c85a66c22d3e37beec9b61
+  metadata.gz: a8f98e3bc6d688a4ee18fd913ee8f04fcc63115dfe50f2ae52f1d7814b5ffb58
+  data.tar.gz: 2193f2432974be939df1ae1d151a5aaa6c37808c76144ad779ccc1371ab0b379
 SHA512:
-  metadata.gz: f1845950986bcb9919a4ad353c4913a9fca9427f2387bb8a4cbe7b1968eaf26f35d837f331dd9d3f9a1ab5c49b8e9a49d7868f89902c7b9f427d2592e73dc607
-  data.tar.gz: f87ff6d5bd9462ebf3988b23482b64d6bb3d7ced99fbeecb06cc6c271392b65b7d8a510cd69e7e83c6792775ffbceb6e6dc1a6313b0bb2abd335752f508655ba
+  metadata.gz: d2f018b1861d3255fcf76a673c4f3b3af6ad7e77d05d245bdf2395bba6d45a1be582c6937c7d12ca766dfc7911c3c0b9a03ebce8e3bd0ada528808d1810c93e7
+  data.tar.gz: d8341b0b9d639d1fdfde99dadda0f786825f5e34c0c39264c691875bc6632435a5e2116a9dc76edcb5e8992718427790de6c0d5a8d07bdcb724caffa2eac9351

data/README.md

@@ -93,14 +93,14 @@ some users may not always agree with the result and for arbitrary reasons:
   Custom headers may be defined in the configuration file for the program  
   and will then be added to each outgoing post.
 
-* The Archive- and X-No-Archive headers are sometimes set to avoid that an
-  article be saved and stays available to search-engines (Google, notably).
-  Test-  postings, for example, do probably not justify at all that they would
-  be  referenced in search results. The post-processor program can impose the
-  Archive- and X-No-Archive header for all posts to certain newsgroups.
-
-  **ATTN** As of 2024, the X-No-Archive has lost most of its utility and it 
-  is the decision of server operators to honor it or not.
+* The Archive- and X-No-Archive headers are sometimes set to avoid that an 
+  article be saved and stays available to search-engines (Google, notably). 
+  Test-  postings, for example, do probably not justify at all that they would 
+  be  referenced in search results. The post-processor program can impose the 
+  Archive- and X-No-Archive header for all posts to certain newsgroups. 
+
+  **ATTN** As of 2024, the header “X-No-Archive“ has lost most of its utility 
+  and it is the decision of server operators to honor it or not.  
 
 * If a news post contains many references to either other posts or Web  
   pages, the text can be cluttered with URLs.  

data/bin/flnews_post_proc

@@ -1,5 +1,6 @@
 #!/bin/env ruby
 #encoding: UTF-8
+
 =begin
 /***************************************************************************
  *   ©2023-2024, Michael Uplawski <michael.uplawski@uplawski.eu>           *
@@ -32,7 +33,7 @@ self.extend(BasicLogging)
 
 msg = PROGNAME.dup << ' ' << PROGVERSION << ' starting' 
 msg = "–––––– " << msg << " ––––––"
-
+clear_log
 info msg
 # Get a configuration 
 config = Configuration::instance

data/lib/basic_logging.rb

@@ -48,15 +48,19 @@ module BasicLogging
 
   # set the log level 
   def set_level(lv)
-    if lv.respond_to?(:to_str)
+    if lv.respond_to?(:to_str) && Levels.keys.include?(lv.strip.to_sym)
       lv = Levels[lv.to_sym]
+    elsif lv.respond_to?(:to_sym) && Levels.keys.include?(lv)
+      lv = Levels[lv]
     end
 
     if(!lv || (lv.respond_to?(:to_int) && lv >= DEBUG && lv <= FATAL) )
       @@log_level = lv
     else
-      STDERR.puts __FILE__.dup << ": ERROR : invalid log level \"" << lv.to_s << "\""
-      STDERR.puts "Keepinng old log level " << Levels.keys.detect {| k| Levels[k] == @@log_level}.to_s
+      msg = __FILE__.dup << ": ERROR : invalid log level \"" << lv.to_s << "\""
+      msg << "\n" << "Keepinng old log level " << Levels.keys.detect {| k| Levels[k] == @@log_level}.to_s
+      STDERR.puts msg
+      puts msg
     end
   end
 
@@ -91,13 +95,27 @@ module BasicLogging
     end
   end
 
+  def target
+    @@target.path if @@target
+  end
+
+  def level
+    @@level.to_s if @@level
+  end
+
+  # Clear the log (-file)
+  def clear_log
+    if @@target && @@target.respond_to?(:truncate)
+      @@target.truncate(0) 
+    end
+  end
+
   alias :debug :log
   alias :info :log
   alias :warn :log
   alias :error :log
   alias :fatal :log
 
-  attr_reader :target, :log_level
 
   private 
 

data/lib/body.rb

@@ -87,7 +87,7 @@ class Body
             i = i.next
             line = @lines[i]
           end
-          # check if there is a citation, at all
+          # check if there is a quote, at all
           if(line.start_with?('>'))
             debug("\tfound intro " << ointro)
             # variables are part of the $intro.
@@ -121,7 +121,11 @@ class Body
   def join 
     return @lines.join("\r\n")
   end
- 
+  # ------->
+  # TODO : Concentrate all URL/URI munging functionality in 1 or 2 helper
+  # classes, e.g. Body::News and Body::Http
+  # <------ 
+  
   # Verify and possibly correct links in the post.
   # Simple.
   def handle_urls() 

data/lib/configuration.rb

@@ -25,7 +25,6 @@ class Configuration
   include Singleton
   include BasicLogging
 
-  self.extend(BasicLogging)
 
   def initialize() 
     debug 'Configuration::initialize()'
@@ -114,7 +113,10 @@ class Configuration
   def read_config
     if File::exist?(@config_file) && File::readable?(@config_file)
       begin
+puts "config_file is " << @config_file
         @conf = YAML::load_file(@config_file)
+puts 'load_file'
+
         @conf.transform_keys!{|k| k.to_sym}
         @keys = @conf.keys
         clevel = @conf[:LOG_LEVEL]

data/lib/flnews_post_proc.rb

@@ -29,11 +29,10 @@ $LN = "\r\n"
 # The main application class.
 #  Does it.
 class PostProcessor
-  # class-level configuration object
-  @@config = Configuration.instance
   include BasicLogging  
 
   def initialize(article_text)
+    @config = Configuration.instance
     # for simplicity.
     # separate the headers and the body.
     debug ' initializing headers'

data/lib/headers.rb

@@ -20,13 +20,12 @@ require_relative 'newsgroups'
 # an object of this class represents the headers of a news-article
 
 class Headers
-  # class-level configuration object
-  @@config = Configuration.instance
   include BasicLogging
 
   # read the headers from the article
   def initialize(article_text)
     
+    @config = Configuration.instance
     line = nil
     # transform the article to an array.
     debug('before split, article_text is : ' << article_text)
@@ -105,10 +104,10 @@ class Headers
       @headers["X-No-Archive".to_sym] = no_archive
       @headers["Archive".to_sym] = 'no'
     end
-    if @@config.CUSTOM_HEADERS    
-      ch = @@config.CUSTOM_HEADERS
+    if @config.CUSTOM_HEADERS    
+      ch = @config.CUSTOM_HEADERS
       debug('setting custom headers : ' << ch.inspect)
-      @@config.CUSTOM_HEADERS.each do |pair| 
+      @config.CUSTOM_HEADERS.each do |pair| 
         ch = pair.split(':')
         hn = ch[0].strip
         hv = ch[1].strip

data/lib/new_basic_logging.rb

@@ -0,0 +1,221 @@
+#!/bin/env ruby
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   2023-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 'io/wait'
+#
+# Simplified logging. 
+# See example code at the bottom of this file.
+# Execute this file to see the output.
+module BasicLogging
+
+  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,
+            :fatal => FATAL, :unknown => UNKNOWN}
+
+  @@log_level = UNKNOWN
+  @@log_target = STDOUT
+  @@muted = []
+
+  # do not log, if caller is obj (class or instance)
+  def self.mute(obj)
+    name = obj.class == Class ? obj.name.dup : obj.class.name
+    @@muted << name
+  end
+
+  # Log, if caller is obj (class or instance)
+  def self.unmute(obj)
+    name = obj.class == Class ? obj.name.dup : obj.class.name
+    if @@muted.include?(name)
+      @@muted.delete(name)
+    end
+  end
+
+  def self.is_muted?(obj)
+    name = obj.class == Class ? obj.name.dup : obj.class.name
+    @@muted.include?(name)  
+  end
+
+  # set the log level 
+  def set_level(lv)
+    # String – like 'debug' – or symbol – like :debug?
+    if lv 
+      if lv.respond_to?(:to_str) 
+        lv = lv.downcase.to_sym 
+        # integer or nil
+        lv = Levels[lv] 
+      elsif lv.respond_to?(:to_sym) && Levels.keys.include?(lv)
+        # integer or nil
+        lv = Levels[lv]
+      else 
+        lv = nil
+      end
+    end
+    # set level to Integer or nil 
+    if(!lv || (lv.respond_to?(:to_int) && lv >= DEBUG && lv <= FATAL) )
+      @@log_level = lv
+    else
+      STDERR.puts __FILE__.dup << ": ERROR : invalid log level \"" << lv.to_s << "\""
+      STDERR.puts "Keepinng old log level " << Levels.keys.detect {| k| Levels[k] == @@log_level}.to_s
+    end
+  end
+
+  # set the log target 
+  def set_target(tg)
+    if !tg || tg.respond_to?(:to_str) && tg.strip.empty?
+      @@log_target = nil
+    elsif tg.respond_to?(:to_io) && tg.wait_writable
+      @@log_target = tg
+    elsif(!File::exist?(tg) || ( File.file?(tg) && File.writable?(tg) ) )
+      @@log_target = File.open(tg, 'w+')  
+    else
+      STDERR.puts __FILE__.dup << ': ERROR : target ' << tg << ' cannot be set'
+      STDERR.puts "Keeping old target " << @@log_target.inspect
+      return
+    end
+  end
+
+  # Output of log messages, depending on the log level set for the calling class
+  # and the name of the alias method which is actually called.
+  def log(message)
+    if !BasicLogging.is_muted?(self)
+      # how has this method been called?
+      mlevel = __callee__
+      if Levels.has_key?(mlevel) && Levels[mlevel] <=  FATAL
+        # output only for levels equal or above the value that corresponds to
+        # the calling alias.
+        if @@log_level && Levels[mlevel] >= @@log_level 
+          format_log( message, mlevel)      
+        end
+      else
+        STDERR.puts __FILE__.dup << ": ERROR : invalid log level \"" << mlevel.to_s << "\""
+      end
+    end
+  end
+
+  def target
+    @@log_target.path if @@log_target
+  end
+
+  def level
+    @@log_level.to_s if @@log_level
+  end
+
+  # Clear the log (-file)
+  def clear_log
+    if @@log_target && @@log_target.respond_to?(:truncate)
+      File::truncate(@@log_target, 0)
+    end
+  end
+
+  alias :debug :log
+  alias :info :log
+  alias :warn :log
+  alias :error :log
+  alias :fatal :log
+
+
+  private 
+
+  # 1 format_log for all loggers.
+  def format_log(message, mlevel)
+    if @@log_target
+      # indicate if a registered class or the registered object of a class is calling.
+      name = self.class == Class ? self.name.dup << ' [class]' : self.class.name
+      str = '' << name << ' ' << mlevel.to_s << ' ' << Time.now.strftime("%H:%M:%S:%6N")  << ': ' << message.gsub("\n", "\n |")
+      @@log_target.puts str
+    end
+  end
+end
+#---------test: execute file----------
+if $0 == __FILE__
+  Array.extend(BasicLogging)
+  Array.set_level("info")
+  Array.info('TEST')
+  ar = Array.new
+  ar.extend(BasicLogging)
+  # --- no output : 
+  l = __LINE__
+  ar.debug(l.next.to_s << ': debug-test 0')
+  # output
+  ar.set_level(:debug)
+  l = __LINE__
+  ar.debug(l.next.to_s << ': debug-test 1')
+
+  obj = Object.new
+  obj.extend(BasicLogging)
+  obj.set_level(BasicLogging::DEBUG)
+  puts "--------debug-----------"
+  obj.debug('debug')
+  obj.info('info')
+  obj.warn('warn')
+  obj.error('error')
+  obj.fatal('fatal')
+  puts "--------info-----------"
+  obj.set_level("info")
+  obj.debug('debug')
+  obj.info('info')
+  obj.warn('warn')
+  obj.error('error')
+  obj.fatal('fatal')
+  puts "--------fatal-----------"
+  obj.set_level("fatal")
+  obj.debug('debug')
+  obj.info('info')
+  obj.warn('warn')
+  obj.error('error')
+  obj.fatal('fatal')
+  puts "--------UNKNOWN-----------"
+  obj.set_level(nil)
+  obj.debug('debug')
+  obj.info('info')
+  obj.warn('warn')
+  obj.error('error')
+  obj.fatal('fatal')
+  puts " ------ Output into file ----"
+  obj.set_target "/tmp/test_log.log"
+  puts " ------ INFO -----------"
+  obj.set_level BasicLogging::INFO
+  obj.info('info output')
+
+  obj.info('info output 2') 
+  puts "---------- invalid -------"
+  obj.set_target(STDOUT)
+  obj.set_level "power"
+  begin
+    File.open("/tmp/invalid_log", 'r') do |f|
+      obj.set_target f
+    end
+  rescue Exception => er
+    obj.error "ERROR! " << er.message
+  end
+  puts "------------ muted -------"
+  BasicLogging::mute obj
+  puts "is muted? " << BasicLogging.is_muted?(obj).to_s
+  obj.info "test"
+  puts "--------- unmute ----"
+  BasicLogging::unmute obj
+  puts "is muted? " << BasicLogging.is_muted?(obj).to_s
+  obj.info "back again"
+end
+
+# EOF 

data/lib/newsgroups.rb

@@ -20,11 +20,10 @@ require_relative 'configuration'
 require_relative 'basic_logging'
 
 class Newsgroups
-  # class-level configuration object
-  @@config = Configuration.instance
-  include BasicLogging  
 
+  include BasicLogging  
   def initialize(groups)
+    @config = Configuration.instance
     @groups = groups.split(',')
     debug('set signature, intro, no_archive')
     # set details for this post
@@ -50,7 +49,7 @@ class Newsgroups
     # only one group.
     group = @groups[0]
     # all configured intro-lines.
-    gintros = @@config.GROUP_INTROS
+    gintros = @config.GROUP_INTROS
 
     if gintros && gintros.respond_to?(:to_hash)
       # find the intro for the group.
@@ -93,7 +92,7 @@ class Newsgroups
     @signature = nil
     # 1 group
     group = @groups[0]
-    gsigs = @@config.GROUP_SIGS
+    gsigs = @config.GROUP_SIGS
 
     if gsigs && gsigs.respond_to?(:to_hash)
       # find the signature for the group
@@ -124,7 +123,7 @@ class Newsgroups
   # define the no_archive header.
   def set_no_archive
     @no_archive = nil
-    xgs = @@config.NO_ARCHIVE_GROUPS
+    xgs = @config.NO_ARCHIVE_GROUPS
     if xgs && !xgs.empty? && xgs.detect {|g| @groups[0].match(g) }
       debug("setting no_archive")
       @no_archive = 'yes' 

data/lib/version.rb

@@ -14,8 +14,8 @@
 =end
 
 PROGNAME = 'flnews_post_proc'
-PROGVERSION = "1.45"
+PROGVERSION = "1.46"
 AUTHORS = "Michael Uplawski"
 EMAIL = "michael.uplawski@uplawski.eu"
 YEARS = "2023 - 2024"
-SUMMARY = "Bugfix: URLs exclude punctuation and others at the end."
+SUMMARY = "Logging modul: unused functionality corrected."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flnews_post_proc
 version: !ruby/object:Gem::Version
-  version: '1.45'
+  version: '1.46'
 platform: ruby
 authors:
 - Michael Uplawski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-11 00:00:00.000000000 Z
+date: 2024-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -56,6 +56,7 @@ files:
 - lib/flnews_post_proc.conf
 - lib/flnews_post_proc.rb
 - lib/headers.rb
+- lib/new_basic_logging.rb
 - lib/newsgroups.rb
 - lib/override.rb
 - lib/ruby_dlg
@@ -82,8 +83,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
-summary: 'Bugfix: URLs exclude punctuation and others at the end.'
+summary: 'Logging modul: unused functionality corrected.'
 test_files: []