hermeneutics 1.10 → 1.13

data/lib/hermeneutics/css.rb

@@ -26,7 +26,7 @@ module Hermeneutics
   #       a ":visited", ATTR_COL2, ATTR_DECON
   #       a ":active", ATTR_COL1, ATTR_DECON
   #       a ":focus",  ATTR_COL1, ATTR_DECOU
-  #       space
+  #       skip
   #
   #       body "#dummy" do
   #         properties background_color: "f7f7f7".to_rgb
@@ -145,22 +145,22 @@ module Hermeneutics
     def comment str
       @out << "/*"
       str = mask_comment str
-      ml = str =~ %r(#$/)
+      ml = str =~ %r(\n)
       if ml then
-        @out << $/
+        @out << "\n"
         str.each_line { |l|
           l.chomp!
-          @out << " * " << l << $/
+          @out << " * " << l << "\n"
         }
       else
         @out << " " << str
       end
       @out << " */"
-      ml and @out << $/
+      ml and @out << "\n"
     end
 
-    def space
-      @out << $/
+    def skip
+      @out << "\n"
     end
 
     def tag *args
@@ -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
@@ -228,15 +232,15 @@ module Hermeneutics
       args.each { |a| p.update a }
       @out << sel << " {"
       nl, ind = if p.size > 1 then
-        @out << $/
-        [ $/, INDENT]
+        @out << "\n"
+        [ "\n", INDENT]
       else
         [ " ", " "]
       end
       single p do |s|
         @out << ind << s << nl
       end
-      @out << "}" << $/
+      @out << "}" << "\n"
     end
 
     def single hash

data/lib/hermeneutics/escape.rb

@@ -12,25 +12,25 @@ require "supplement"
 :section: Classes definied here
 
 Hermeneutics::Entities encodes to and decodes from HTML-Entities
-(<code>&amp;</code> etc.)
+(+&amp;+ etc.)
 
 Hermeneutics::URLText encodes to and decodes from URLs
-(<code>%2d</code> etc.)
+(+%2d+ etc.)
 
 Hermeneutics::HeaderExt encodes to and decodes from E-Mail Header fields
-(<code>=?UTF-8?Q?=C3=B6?=</code> etc.).
+(+=?UTF-8?Q?=C3=B6?=+ etc.).
 
 =end
 
 module Hermeneutics
 
-  # Translate HTML and XML character entities: <code>"&"</code> to
-  # <code>"&amp;"</code> and vice versa.
+  # Translate HTML and XML character entities: +"&"+ to
+  # +"&amp;"+ and vice versa.
   #
   # == What actually happens
   #
-  # HTML pages usually come in with characters encoded <code>&lt;</code>
-  # for <code><</code> and <code>&euro;</code> for <code>€</code>.
+  # HTML pages usually come in with characters encoded +&lt;+ for +<+ and
+  # +&euro;+ for +€+.
   #
   # Further, they may contain a meta tag in the header like this:
   #
@@ -41,27 +41,25 @@ module Hermeneutics
   #
   #   <?xml version="1.0" encoding="UTF-8" ?>         (XHTML)
   #
-  # When +charset+ is <code>utf-8</code> and the file contains the byte
-  # sequence <code>"\303\244"</code>/<code>"\xc3\xa4"</code> then there will
-  # be displayed a character <code>"ä"</code>.
+  # When +charset+ is +utf-8+ and the file contains the byte sequence
+  # +"\303\244"+/+"\xc3\xa4"+ then there will be displayed a character +"ä"+.
   #
-  # When +charset+ is <code>iso8859-15</code> and the file contains the byte
-  # sequence <code>"\344"</code>/<code>"\xe4"</code> then there will be
-  # displayed a character <code>"ä"</code>, too.
+  # When +charset+ is +iso8859-15+ and the file contains the byte sequence
+  # +"\344"+/+"\xe4"+ then there will be displayed a character +"ä"+, too.
   #
-  # The sequence <code>"&auml;"</code> will produce an <code>"ä"</code> in any
+  # The sequence +"&auml;"+ will produce an +"ä"+ in any
   # case.
   #
   # == What you should do
   #
   # Generating your own HTML pages you will always be safe when you only
-  # produce entity tags as <code>&auml;</code> and <code>&euro;</code> or
-  # <code>&#x00e4;</code> and <code>&#x20ac;</code> respectively.
+  # produce entity tags as +&auml;+ and +&euro;+ or +&#x00e4;+ and +&#x20ac;+
+  # respectively.
   #
   # == What this module does
   #
-  # This module translates strings to a HTML-masked version.  The encoding will
-  # not be changed and you may demand to keep 8-bit-characters.
+  # This module translates strings to a HTML-masked version.  The encoding
+  # will not be changed and you may demand to keep 8-bit-characters.
   #
   # == Examples
   #
@@ -118,7 +116,7 @@ module Hermeneutics
     # :call-seq:
     #   new( keep_8bit: bool)     -> ent
     #
-    # Creates an <code>Entities</code> converter.
+    # Creates an +Entities+ converter.
     #
     #   ent = Entities.new keep_8bit: true
     #
@@ -184,9 +182,8 @@ module Hermeneutics
       #   Entities.decode "&lt;"                       #=> "<"
       #   Entities.decode "&auml;&ouml;&uuml;"         #=> "äöü"
       #
-      # Unmasked 8-bit-characters (<code>"ä"</code> instead of
-      # <code>"&auml;"</code>) will be kept but translated to
-      # a unique encoding.
+      # Unmasked 8-bit-characters (+"ä"+ instead of +"&auml;"+) will be kept
+      # but translated to a unique encoding.
       #
       #   s = "ä &ouml; ü"
       #   s.encode! "utf-8"
@@ -259,7 +256,7 @@ module Hermeneutics
     # :call-seq:
     #   new( hash)  -> urltext
     #
-    # Creates a <code>URLText</code> converter.
+    # Creates a +URLText+ converter.
     #
     # The parameters may be given as values or as a hash.
     #
@@ -276,7 +273,7 @@ module Hermeneutics
     # :call-seq:
     #   encode( str)     -> str
     #
-    # Create a string that contains <code>%XX</code>-encoded bytes.
+    # Create a string that contains +%XX+-encoded bytes.
     #
     #   utx = URLText.new
     #   utx.encode "'Stop!' said Fred."       #=> "%27Stop%21%27+said+Fred."
@@ -292,15 +289,14 @@ module Hermeneutics
     #   s = "< ä >".encode "ISO-8859-1"
     #   utx.encode s                    #=> "%3C+\xe4+%3E"      in ISO-8859-1
     #
-    # A space <code>" "</code> will not be replaced by a plus <code>"+"</code>
-    # if +keep_space+ is set.
+    # A space +" "+ will not be replaced by a plus +"\+"+ if +keep_space+ is
+    # set.
     #
     #   utx = URLText.new keep_space: true
     #   s = "< x >"
     #   utx.encode s                    #=> "%3C x %3E"
     #
-    # When +mask_space+ is set, then a space will be represented as
-    # <code>"%20"</code>,
+    # When +mask_space+ is set, then a space will be represented as +"%20"+,
     #
     def encode str
       r = str.new_string
@@ -347,6 +343,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]
@@ -369,7 +366,7 @@ module Hermeneutics
     # :call-seq:
     #   encode_hash( hash)     -> str
     #
-    # Encode a <code>Hash</code> to a URL-style string.
+    # Encode a +Hash+ to a URL-style string.
     #
     #   utx = URLText.new
     #
@@ -469,8 +466,8 @@ module Hermeneutics
       #   decode_hash( str)                      -> hash
       #   decode_hash( str) { |key,val| ... }    -> nil or int
       #
-      # Decode a URL-style encoded string to a <code>Hash</code>.
-      # In case a block is given, the number of key-value pairs is returned.
+      # Decode a URL-style encoded string to a +Hash+. In case a block is
+      # given, the number of key-value pairs is returned.
       #
       #   str = "a=%3B%3B%3B&x=%26auml%3B%26ouml%3B%26uuml%3B"
       #   URLText.decode_hash str do |k,v|
@@ -527,7 +524,7 @@ module Hermeneutics
     # :call-seq:
     #   new( [ parameters] )    -> con
     #
-    # Creates a <code>HeaderExt</code> converter.
+    # Creates a +HeaderExt+ converter.
     #
     # See the +encode+ method for an explanation of the parameters.
     #
@@ -571,8 +568,8 @@ module Hermeneutics
     # The result will not contain any 8-bit characters. The encoding will
     # be kept although it won't have a meaning.
     #
-    # The parameter <code>:mask</code> will have no influence on the masking
-    # itself but will guarantee characters to be masked.
+    # The parameter +:mask+ will have no influence on the masking itself but
+    # will guarantee characters to be masked.
     #
     # == Examples
     #

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)
@@ -147,7 +151,7 @@ module Hermeneutics
               @out << tag
               mkattrs attrs
             end
-            if nls >3 then
+            if nls>3 then
               verbose_block yield
             else
               indent_if nls>2 do
@@ -209,9 +213,9 @@ module Hermeneutics
           @out << "/* "
           brace false do
             @out << "![CDATA["
-            @out << " */" << $/
+            @out << " */\n"
             @out << str
-            @out << $/ << "/* "
+            @out << "\n/* "
             @out << "]]"
           end
           @out << " */"
@@ -223,7 +227,7 @@ module Hermeneutics
       def brk
         unless @nl then
           @nl = true
-          @out << $/
+          @out << "\n"
         end
       end
       def out_brk 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