flnews_post_proc 1.57 → 1.60

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b1429b1ae2eb519f5e35c6f12a6cb56705a4b24b87a33111af776f3759addd9
-  data.tar.gz: 33009debfaadea2a4e1c2868d3eac2c74ff1216601bb511fc418702a51966511
+  metadata.gz: 501b73b0978b60f22ec85311eb7b9f66df77802e963eec5ed9bf7e86066604fc
+  data.tar.gz: 985d92d55cf867f297f4ec3ceb337091495918d869b48d105b38452412835ff0
 SHA512:
-  metadata.gz: 07ae7873e4f1786ee8b12b0b3b38be2f9e3245714de8675495ba6ca0b037828dbfae9c232f72ee44ed906fa38d4e0a8edae4d5f5c39428d9237287e08be549df
-  data.tar.gz: 897130b05216307f37d67143e0875179745fbd8bed256821075b6236619e99977e7143597d308be13fdad449c550e53c1e7b59109d3d8109f120c3415da5bff2
+  metadata.gz: 2a5d65c1484b211db45f9af9b98f31eabb928cce5707fa7b661166ac02593d52bb76a00aef5e0fe36657b24c13e14faf3b3ce86192c4a8e23a96689f488ec7da
+  data.tar.gz: 33563ad93400d39082bf888618a8b43801a98b486bb678a458bb16a09797480c52f3d310d61ce4549ba7dc0c4d1b68fa7cb7921802513440a5ef494c81f94469

data/bin/flnews_post_proc

@@ -47,9 +47,16 @@ msg = PROGNAME.dup << ' ' << PROGVERSION << ' starting'
 msg = "–––––– " << msg << " ––––––"
 info msg
 # Get a configuration 
+#   this call results in the configuration file to be
+#   read and interpreted. As the log depends on the
+#   configuration, errors may render the debug-log 
+#   unavailable. See STDERR in these cases, i.e.
+#   call the program on the command-line and pipe-in
+#   a message. Is this okay?
 config = Configuration::instance
 
-# store the path to the main executable
+# Store the path to the main executable
+#   ... Forgot what this should be good for.
 # config.set(:BINDIR, File::dirname(__FILE__) )
 
 # Only if data is on STDIN
@@ -59,6 +66,8 @@ if (!STDIN.tty?)
 
    # There is content, create the post-processor.
   if !artext.strip.empty? 
+    # Be sure to know what you are doing.
+    # Ask around in case of doubt.
     mime = FileMagic.mime.buffer artext
     debug('mime is ' << mime)
     if ['news', 'rfc822'].any? {|m|  mime.start_with?('message/' << m) }
@@ -80,8 +89,9 @@ if (!STDIN.tty?)
         debug('new config: ' << config.inspect)
       end
       #<--------------
+      # Do it:
       pp = PostProcessor.new(artext)    
-      # ... and print its result.
+      # and get a result.
       article = pp.article
       if article 
         # -------------> The main objective <------

data/lib/body.rb

@@ -1,21 +1,54 @@
 #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.                  *
- *                                                                         *
- ***************************************************************************/
+  /***************************************************************************
+   *   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_relative 'basic_logging'
-require_relative 'configuration'
+  require_relative 'configuration'
+
+WRAP_LENGTH = 65
+# Endow the String class with a wrap function.
+# This is not yet applicable to the message body, itself.
+class String
+  include BasicLogging
+  public
+  # wraps at length, returns the result
+  def wrap! (length = WRAP_LENGTH, indent = 0)
+    max = length
+
+    line = 0
+    out = [""]
+
+    self.gsub!("\r\n", " ")
+    self.gsub!("  ", " ")
+
+    words = self.split(" ")
+
+    while !words.empty?
+      word = words.shift.strip
+      break if not word
+      if out[line].length + word.length > max
+        out[line].squeeze!(" ")
+        line += 1
+        out[line] = (line > 0 ? " " * indent : "")
+      end
+      out[line] << word + " "
+    end
+    self.replace( out.join("\r\n"))
+  end
+
+end
 
 # An object of this class represents the body of a news-article.
 # It processes the original text and changes some details:
@@ -104,7 +137,7 @@ class Body
             # exchange original intro-line against the new one
             @lines[@lines.index(ointro)] = intro.strip 
             # looked complicated because it is.
-            
+
             # keep this line for reference.
             @intro = intro
           else
@@ -141,7 +174,7 @@ class Body
   # 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_uris() 
@@ -149,11 +182,11 @@ class Body
     # Default is no. nil or '' do qualify as default.
     debug 'verify URLs ? ' << @@config.VFY_URLS.to_s
     if @@config.VFY_URLS
-    debug 'verifying URLs'
+      debug 'verifying URLs'
       @lines.each_with_index do | l, i | 
         # leave cited lines as they are.
         if !l.start_with?( '>') 
-=begin
+=begin Currently Unused
           # IMPORTANT --------------------------------->
           # IT IS HENCEFORTH PROHIBITED TO WRITE AN EMAIL-ADDRESS
           # IN THE BODY OF A NEWS-POST AND TO NOT PREPEND IT WITH
@@ -205,6 +238,9 @@ class Body
           end
         end until ref == nil
         debug("all references found:\n" << references.join('\n')) if !references.empty?
+        # re-wrap body
+        # ATTN! Does not work!
+        # body.wrap!
       else
         msg = 'The References Delimiter is the same in its reversed form.'
         msg << "#{$LN}Cannot handle references or footnotes!"
@@ -216,7 +252,10 @@ class Body
         body << $LN << @@config.REFERENCES_SEPARATOR << $LN
         references.each_with_index do |r, i| 
           r = r.gsub(ref_delim, '').gsub(ref_delim.reverse,'')
-          body << (i + 1 ).to_s << ") " << r.strip <<  $LN
+          num = (i + 1).to_s << ") "
+          r.strip!
+          r.wrap!(WRAP_LENGTH, num.length)
+          body << num << r <<  $LN
         end
       else
         debug('no refences found')

data/lib/configuration.rb

@@ -98,8 +98,8 @@ class Configuration
         File::write(bak_conf, File.read(@config_file))
         File::write(@config_file, @conf.to_yaml)
       rescue Exception => ex
-        msg = ex.message
-        error "Cannot write altered configuration to " << @config_file << "!"
+        msg = "Cannot write altered configuration to " << @config_file << "!\n\t" << ex.message
+        STDERR.puts(msg << "\nAborting, bye\n")
         error msg
         exit false
       end
@@ -126,14 +126,15 @@ class Configuration
         clear_log
         debug('log target and -level set: ' << @@log_level.to_s << ', ' << target_string)
       rescue Exception => ex
-        msg = ex.message
-        error msg
-        STDERR.puts("Configuration: cannot use the configuration-file (" << @config_file << ")") 
-        STDERR.puts("Exception: " << msg)
+        msg = "Cannot use the configuration-file (" << @config_file << ")"
+        msg << "\n\t" << ex.message
+        # No log.
+        # error msg
+        STDERR.puts(msg << "\nAborting, bye\n") 
         exit false
       end
     else
-      STDERR.puts("cannot read the configuration-file (" << @config_file << ")") 
+      STDERR.puts("Cannot read the configuration-file (" << @config_file << ")") 
       exit false
     end
   end

data/lib/version.rb

@@ -14,10 +14,9 @@
 =end
 
 PROGNAME = 'flnews_post_proc'
-PROGVERSION = "1.57"
+PROGVERSION = "1.60"
 AUTHORS = "Michael Uplawski"
 EMAIL = "michael.uplawski@uplawski.eu"
 YEARS = "2023 - 2024"
-SUMMARY = "Better error-handling when interpreting the configuration."
-SUMMARY << " README updated"
+SUMMARY = "Word wrapping with indenting for reference-lists"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flnews_post_proc
 version: !ruby/object:Gem::Version
-  version: '1.57'
+  version: '1.60'
 platform: ruby
 authors:
 - Michael Uplawski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-22 00:00:00.000000000 Z
+date: 2024-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -105,5 +105,5 @@ requirements: []
 rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
-summary: Better error-handling when interpreting the configuration. README updated
+summary: Word wrapping with indenting for reference-lists
 test_files: []