hermeneutics 1.10 → 1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 721abdbe281ba643a27fefdcb8016c0f1a0202ed65e6c9741b5a90c3320c121e
-  data.tar.gz: c78e80af37ced64e8ab89d19b729da96f3b6d0e888f0bf0c5de96274bbdf30c3
+  metadata.gz: f95dbd49c6d0f467ff381f459e23b2ede01e74a36cbffc71d7840efb1fd6e6c3
+  data.tar.gz: cafb0d288c12b99cfac80512d0da471124be8f8fb76f23f5f1c0b0ccaae602e1
 SHA512:
-  metadata.gz: 30f6297db18bab61106428eee10338bfe4907dae30fa12bfbff8dc3e94a931b349befc4f5fa65bd21c9b053d9c9e8904d8c7d9920fc2f63f51d393167dc13a0b
-  data.tar.gz: 9f96a1b60536b83254252029fa36fa3e7ed739f270799bd8ccd155e068407a4b31de0073bb7049c5306b7096f5c9b54dca7ba53f8564966f7e82e6830cc644f4
+  metadata.gz: 18e1e83b59d712df7c0d30adeb6d1c9d6cb80ed2d9ee5ebd3a6a458f1405a764c16ad85871bafaaac07752f4703f33853834df1e5257fe0bf569a8ad0c16fc5e
+  data.tar.gz: 5cf7d8ee879802e39c0483c871cab99609fb5b338f7598e9c4cf26762bc500dfceda23e68ba67848e47eecfb140b9a1d8fb3ffd3d1533d11747edfa72413f81a

data/bin/hermesmail

@@ -164,10 +164,10 @@ module Hermeneutics
     LICENSE   = Hermeneutics::LICENSE
     AUTHORS   = Hermeneutics::AUTHORS
 
-    DESCRIPTION = <<-EOT
-This mail delivery agent (MDA) reads a configuration file
-that is plain Ruby code. See the examples section for how
-to write one.
+    DESCRIPTION = <<~EOT
+      This mail delivery agent (MDA) reads a configuration file
+      that is plain Ruby code. See the examples section for how
+      to write one.
     EOT
 
     attr_accessor :rulesfile, :mbox, :fetchfile

data/lib/hermeneutics/cgi.rb

@@ -2,6 +2,7 @@
 #  hermeneutics/cgi.rb  -- CGI responses
 #
 
+require "supplement"
 require "hermeneutics/escape"
 require "hermeneutics/message"
 require "hermeneutics/html"
@@ -13,29 +14,54 @@ module Hermeneutics
 
     CONTENT_TYPE = "text/html"
 
-    attr_reader :cgi
-
-    def initialize cgi
-      @cgi = cgi
-    end
+    attr_accessor :cgi
 
     def form! **attrs, &block
-      attrs[ :action] = @cgi.fullpath attrs[ :action]
+      attrs[ :action] = @cgi.fullname attrs[ :action]
       form **attrs, &block
     end
 
     def href dest, params = nil, anchor = nil
       @utx ||= URLText.new
-      dest = @cgi.fullpath dest
+      dest = @cgi.fullname dest
       @utx.mkurl dest, params, anchor
     end
 
-    def href! params = nil, anchor = nil
-      href nil, params, anchor
+    def href! dest, params = nil, anchor = nil
+      dest = @cgi.fullpath dest
+      href dest, params, anchor
     end
 
   end
 
+  class Text
+    CONTENT_TYPE = "text/plain"
+    attr_accessor :cgi
+    def generate out = nil
+      @out = out||$stdout
+      yield
+    ensure
+      @out = nil
+    end
+    def document *args, **kwargs, &block
+      build *args, **kwargs, &block
+    end
+    def build *args, **kwargs, &block
+    end
+    private
+    def p *args
+      args.each { |a| @out << a.to_s }
+    end
+    def l arg
+      arg = arg.to_s
+      @out << arg
+      arg.ends_with? $/ or @out << $/
+    end
+    def nl
+      @out << $/
+    end
+  end
+
 
   # Example:
   #
@@ -65,104 +91,167 @@ module Hermeneutics
       end
     end
 
+    CGIENV = %w(content document gateway http query
+                          remote request script server unique)
+
+    private
+
+    def method_missing sym, *args
+      if args.empty? and CGIENV.include? sym[ /\A(\w+?)_\w+\z/, 1] then
+        ENV[ sym.to_s.upcase]
+      else
+        super
+      end
+    end
+
+    public
+
+    def https?
+      ENV[ "HTTPS"].notempty?
+    end
+
     # Overwrite this.
+    #
+    # If you're reacting to POST uploads, please consider limiting
+    # the upload size.
+    #   Apache:   LimitRequestBody
+    #   Nginx:    client_max_body_size
+    #   Lighttpd: server.max-request-size
+    #
     def run
       document Html
     end
 
-    def parameters &block
+    def parameters! nl: false, sym: false, strip: false
+      @parameters ||= parameters nl: nl, sym: sym, strip: strip
+      nil
+    end
+
+    def parameters nl: false, sym: false, strip: false
       if block_given? then
-        case request_method
-          when "GET", "HEAD" then parse_query query_string, &block
-          when "POST"        then parse_posted &block
-          else                    parse_input &block
+        data.parse do |k,v,**kw|
+          k = k.to_sym if sym
+          if v then
+            v.strip! if strip
+            v.gsub! "\r\n", "\n" if nl
+          end
+          yield k, v.notempty?, **kw
         end
       else
         p = {}
-        parameters do |k,v|
+        parameters nl: nl, sym: sym, strip: strip do |k,v|
           p[ k] = v
         end
         p
       end
     end
 
-    CGIENV = %w(content document gateway http query
-                          remote request script server unique)
-
-    def method_missing sym, *args
-      if args.empty? and CGIENV.include? sym[ /\A(\w+?)_\w+\z/, 1] then
-        ENV[ sym.to_s.upcase]
-      else
-        super
+    def data
+      case request_method
+        when "GET", "HEAD" then
+          Data::UrlEnc.new query_string
+        when "POST"        then
+          data = $stdin.read
+          data.bytesize == content_length.to_i or
+            warn "Content length #{content_length} is wrong (#{data.bytesize})."
+          ct = ContentType.parse content_type
+          data.force_encoding ct[ :charset]||Encoding::ASCII_8BIT
+          case ct.fulltype
+            when "application/x-www-form-urlencoded" then
+              Data::UrlEnc.new data
+            when "multipart/form-data" then
+              Data::Multiparted.new data, ct.hash
+            when "text/plain" then
+              Data::Plain.new data
+            when "application/json" then
+              Data::Json.new data
+            when "application/x-yaml", "application/yaml" then
+              Data::Yaml.new data
+            else
+              Data::UrlEnc.new data
+          end
+        else
+          Data::Lines.new read_interactive
       end
     end
 
-    def https?
-      ENV[ "HTTPS"].notempty?
-    end
 
     private
 
-    def parse_query data, &block
-      URLText.decode_hash data, &block
-    end
-
-    def parse_posted &block
-      data = $stdin.read.force_encoding Encoding::ASCII_8BIT
-      data.bytesize == content_length.to_i or
-        @warn = "Content length #{content_length} is wrong (#{data.bytesize})."
-      ct = ContentType.parse content_type
-      case ct.fulltype
-        when "application/x-www-form-urlencoded" then
-          parse_query data, &block
-        when "multipart/form-data" then
-          mp = Multipart.parse data, **ct.hash
-          parse_multipart mp, &block
-        when "text/plain" then
-          # Suppose this is for testing purposes only.
-          mk_params data.lines, &block
-        else
-          parse_query data, &block
+    module Data
+      class Plain
+        attr_reader :data
+        def initialize data
+          @data = data
+        end
       end
-    end
-
-    def parse_multipart mp
-      mp.each { |part|
-        cd = part.headers.content_disposition
-        if cd.caption == "form-data" then
-          yield cd.name, part.body_decoded, **cd.hash
+      class UrlEnc < Plain
+        def parse &block
+          URLText.decode_hash @data, &block
         end
-      }
+      end
+      class Multiparted < Plain
+        def initialize data, params
+          super data
+          @params = params
+        end
+        def parse
+          mp = Multipart.parse @data, **@params
+          mp.each { |part|
+            cd = part.headers.content_disposition
+            if cd.caption == "form-data" then
+              yield cd.name, part.body_decoded, **cd.hash
+            end
+          }
+        end
+      end
+      class Lines < Plain
+        def initialize lines
+          @lines = lines
+        end
+        def data ; @lines.join $/ ; end
+        def parse
+          @lines.each { |s|
+            k, v = s.split %r/=/
+            v ||= k
+            [k, v].each { |x| x.strip! }
+            yield k, v
+          }
+        end
+      end
+      class Json < Plain
+        def parse &block
+          require "json"
+          (JSON.load @data).each_pair &block
+        end
+      end
+      class Yaml < Plain
+        def parse &block
+          require "yaml"
+          (YAML.load @data).each_pair &block
+        end
+      end
     end
 
-    def mk_params l
-      l.each { |s|
-        k, v = s.split %r/=/
-        v ||= k
-        [k, v].each { |x| x.strip! }
-        yield k, v
-      }
-    end
 
-    def parse_input &block
+    def read_interactive
+      ENV[ "SCRIPT_NAME"] ||= $0
       if $*.any? then
-        l = $*
+        $*
       else
         if $stdin.tty? then
-          $stderr.puts <<~EOT
-            Offline mode: Enter name=value pairs on standard input.
-          EOT
-        end
-        l = []
-        while (a = $stdin.gets) and a !~ /^$/ do
-          l.push a
+          $stderr.puts "Offline mode: Enter name=value pairs on standard input."
+          l = []
+          while (a = $stdin.gets) and a !~ /^$/ do
+            l.push a
+          end
+          l
+        else
+          $stdin.read.split $/
         end
       end
-      ENV[ "SCRIPT_NAME"] = $0
-      mk_params l, &block
     end
 
-
     class Done < Exception
       attr_reader :result
       def initialize result
@@ -186,10 +275,14 @@ module Hermeneutics
         run
       rescue
         done { |res|
-          res.body = "#$! (#{$!.class})#$/"
-          $@.each { |a| res.body << "\t" << a << $/ }
-          res.headers.add :content_type,
-                            "text/plain", charset: res.body.encoding
+          res.body = if $!.class.const_defined? :HTTP_STATUS then
+            res.headers.add :status, "%03d" % $!.class::HTTP_STATUS
+            $!.message + $/
+          else
+            # Why doesn't Ruby provide the encoding of #message?
+            ($!.full_message highlight: false, order: :top).force_encoding $!.message.encoding
+          end
+          res.headers.add :content_type, "text/plain", charset: res.body.encoding
         }
       end
     rescue Done
@@ -200,7 +293,8 @@ module Hermeneutics
 
     def document cls = Html, *args, &block
       done { |res|
-        doc = cls.new self
+        doc = cls.new
+        doc.cgi = self
         res.body = ""
         doc.generate res.body do
           doc.document *args, &block
@@ -209,8 +303,14 @@ module Hermeneutics
         ct = if doc.respond_to?    :content_type then doc.content_type
         elsif   cls.const_defined? :CONTENT_TYPE then doc.class::CONTENT_TYPE
         end
-        ct and res.headers.add :content_type, ct,
-                    charset: res.body.encoding||Encoding.default_external
+        if ct then
+          cs = if doc.respond_to?    :charset then doc.charset
+          elsif   cls.const_defined? :CHARSET then doc.class::CHARSET
+          else
+            res.body.encoding||Encoding.default_external
+          end
+          res.headers.add :content_type, ct, charset: cs
+        end
         if doc.respond_to? :cookies then
           doc.cookies do |c|
             res.headers.add :set_cookie, c
@@ -225,20 +325,35 @@ module Hermeneutics
       end
       utx = URLText.new mask_space: true
       unless dest =~ %r{\A\w+://} then
-        dest = %Q'#{https? ? "https" : "http"}://#{http_host}#{fullpath dest}'
+        dest = %Q'#{https? ? "https" : "http"}://#{http_host||"localhost"}#{fullpath dest}'
       end
       url = utx.mkurl dest, params, anchor
       done { |res| res.headers.add "Location", url }
     end
 
-    def fullpath dest
+    def fullname dest
       if dest then
-        dest =~ %r{\A/} || dest =~ /\.\w+\z/ ? dest : dest + ".rb"
+        if dest =~ /\.\w+\z/ then
+          dest
+        else
+          "#{dest}.rb"
+        end
       else
-        File.basename script_name
+        script_name
+      end
+    end
+
+    def fullpath dest
+      dest = fullname dest
+      unless File.absolute_path? dest then
+        dir = File.dirname script_name rescue ""
+        dest = File.join dir, dest
       end
     end
 
+    def warn msg
+    end
+
 
     if defined? MOD_RUBY then
       # This has not been tested.

data/lib/hermeneutics/color.rb

@@ -247,13 +247,20 @@ module Hermeneutics
 end
 
 
-class Float
+class Integer
   def to_gray
     Hermeneutics::Color.gray self
   end
   alias to_grey to_gray
 end
 
+class Float
+  def to_gray
+    (0xff * self).to_i.to_gray
+  end
+  alias to_grey to_gray
+end
+
 class String
   def to_gray
     (Integer self).to_gray

data/lib/hermeneutics/contents.rb

@@ -123,6 +123,8 @@ module Hermeneutics
     def [] key ; @hash[ key.to_sym] ; end
     alias field []
 
+    private
+
     def method_missing sym, *args
       if sym =~ /[^a-z_]/ or args.any? then
         super
@@ -131,6 +133,8 @@ module Hermeneutics
       end
     end
 
+    public
+
     # :call-seq:
     #   keys()       -> ary
     #

data/lib/hermeneutics/css.rb

@@ -182,6 +182,8 @@ module Hermeneutics
                               protected_instance_methods + instance_methods)
     undef_method *m
 
+    private
+
     def method_missing sym, *args, &block
       if Html::TAGS[ sym] then
         if args.any? and not Hash === args.first then
@@ -198,6 +200,8 @@ module Hermeneutics
       end
     end
 
+    public
+
     def properties *args
       write @selector.to_s, *args
     end

data/lib/hermeneutics/escape.rb

@@ -347,6 +347,7 @@ module Hermeneutics
           else                                      val.to_s.notempty?
         end
       end
+      private
       def method_missing sym, *args
         if args.empty? and not sym =~ /[!?=]\z/ then
           self[ sym]

data/lib/hermeneutics/html.rb

@@ -121,6 +121,10 @@ module Hermeneutics
         @out.path
       rescue NoMethodError
       end
+      def merge str
+        do_ind
+        @out << str
+      end
       def plain str
         do_ind
         @out << (@ent.encode str)
@@ -319,6 +323,8 @@ module Hermeneutics
       TAGS[ name]
     end
 
+    private
+
     def method_missing name, *args, &block
       t = tag? name
       t or super
@@ -330,10 +336,16 @@ module Hermeneutics
       end
     end
 
+    public
+
+    def merge str
+      @generator.merge str
+      nil
+    end
+
     def pcdata *strs
       strs.each { |s|
-        s or next
-        @generator.plain s
+        @generator.plain s if s.notempty?
       }
       nil
     end
@@ -343,9 +355,13 @@ module Hermeneutics
       self
     end
 
-    def _ str = nil
-      @generator.plain str||yield
-      nil
+    def _ *strs
+      if strs.notempty? then
+        pcdata *strs
+      else
+        @generator.plain yield
+        nil
+      end
     end
 
     def comment str
@@ -362,64 +378,26 @@ module Hermeneutics
       method_missing :html, **attrs do yield end
     end
 
-    def head attrs = nil
-      method_missing :head, attrs do
+    def head **attrs
+      method_missing :head, **attrs do
         meta charset: @generator.encoding
         yield
       end
     end
 
-    def form attrs, &block
-      attrs[ :method] ||= if attrs[ :enctype] == "multipart/form-data" then
-        "post"
-      else
-        "get"
-      end
-      @tabindex = 0
-      method_missing :form, attrs, &block
-    ensure
-      @tabindex = nil
+    def h i, **attrs, &block
+      method_missing :"h#{i.to_i}", **attrs, &block
     end
 
-    Field = Struct[ :type, :attrs]
-
-    def field type, attrs
-      attrs[ :id] ||= attrs[ :name]
-      @tabindex += 1
-      attrs[ :tabindex] ||= @tabindex
-      Field[ type, attrs]
+    def form **attrs, &block
+      attrs[ :method] ||=
+              attrs[ :enctype] == "multipart/form-data" ? "post" : "get"
+      method_missing :form, **attrs, &block
     end
 
-    def label field = nil, attrs = nil, &block
-      if String === attrs then
-        label field do attrs end
-      else
-        if Field === field or attrs then
-          attrs = attrs.merge for: field.attrs[ :id]
-        else
-          attrs = field
-        end
-        method_missing :label, attrs, &block
-      end
-    end
-
-    def input arg, &block
-      if Field === arg then
-        case arg.type
-          when /select/i   then
-            method_missing :select, arg.attrs, &block
-          when /textarea/i then
-            block and
-              raise ArgumentError, "Field textarea: use the value attribute."
-            v = arg.attrs.delete :value
-            method_missing :textarea, arg.attrs do v end
-          else
-            arg.attrs[ :type] ||= arg.type
-            method_missing :input, arg.attrs, &block
-        end
-      else
-        method_missing :input, arg, &block
-      end
+    def input **attrs, &block
+      attrs[ :id] ||= attrs[ :name]
+      method_missing :input, **attrs, &block
     end
 
   end
@@ -433,8 +411,8 @@ module Hermeneutics
       super
     end
 
-    def a attrs = nil
-      attrs[ :name] ||= attrs[ :id] if attrs
+    def a **attrs
+      attrs[ :name] ||= attrs[ :id]
       super
     end
 

data/lib/hermeneutics/message.rb

@@ -413,6 +413,8 @@ module Hermeneutics
         end
       end
 
+      private
+
       def method_missing sym, *args
         if args.empty? and not sym =~ /[!?=]\z/ then
           field sym, *args
@@ -421,6 +423,8 @@ module Hermeneutics
         end
       end
 
+      public
+
       def add name, *contents
         e = build_entry name, *contents
         add_entry e
@@ -544,6 +548,8 @@ module Hermeneutics
       @headers ||= Headers.create
     end
 
+    private
+
     def method_missing sym, *args, &block
       case sym
         when /h_(.*)/, /header_(.*)/ then
@@ -553,6 +559,8 @@ module Hermeneutics
       end
     end
 
+    public
+
     def [] name, type = nil
       @headers[ name, type]
     end

data/lib/hermeneutics/tags.rb

@@ -288,12 +288,16 @@ module Hermeneutics
       nil
     end
 
+    private
+
     def method_missing sym, *args
       (tag sym, *args) or super
     rescue
       super
     end
 
+    public
+
     def data
       d = ""
       gather_data self, d

data/lib/hermeneutics/version.rb

@@ -14,7 +14,7 @@
 module Hermeneutics
 
   NAME        = "hermeneutics"
-  VERSION     = "1.10".freeze
+  VERSION     = "1.11".freeze
   SUMMARY     = "CGI and mail handling"
 
   DESCRIPTION = <<~EOT
@@ -22,7 +22,7 @@ module Hermeneutics
     and CSS. Further, it is a CGI library.
   EOT
 
-  COPYRIGHT   = "(C) 2013-2020 Bertram Scharpf"
+  COPYRIGHT   = "(C) 2013-2021 Bertram Scharpf"
   LICENSE     = "BSD-2-Clause"
   AUTHORS     = [ "Bertram Scharpf"]
   MAIL        = "<software@bertram-scharpf.de>"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hermeneutics
 version: !ruby/object:Gem::Version
-  version: '1.10'
+  version: '1.11'
 platform: ruby
 authors:
 - Bertram Scharpf
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-25 00:00:00.000000000 Z
+date: 2021-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: supplement
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Just Ruby
-rubygems_version: 3.0.6
+rubygems_version: 3.0.8
 signing_key:
 specification_version: 4
 summary: CGI and mail handling