wunderbar 0.17.3 → 0.18.0

data/README.md

@@ -8,7 +8,7 @@ that conforms to the
 the emerging results from the [XML Error Recovery Community
 Group](http://www.w3.org/community/xml-er/wiki/Main_Page).
 
-Wunderbar is both inspired by, and builds upon Jim Weirich's 
+Wunderbar was inspired by Jim Weirich's 
 [Builder](https://github.com/jimweirich/builder#readme), and provides 
 the element id and class id syntax and based on the implementation from
 [Markaby](http://markaby.rubyforge.org/).
@@ -130,12 +130,20 @@ Capture exceptions:
 
 Class attribute shortcut (equivalent to class="front"):
 
-    div.front do
+    _div.front do
     end
 
 Id attributes shortcut (equivalent to id="search"):
 
-    div.search! do
+    _div.search! do
+    end
+
+Complete lists/rows can be defined using arrays:
+
+    _ul %w(apple orange pear)
+    _ol %w(apple orange pear)
+    _table do
+      _tr %w(apple orange pear)
     end
 
 Basic interface
@@ -208,6 +216,10 @@ Access to all of the builder _defined_ methods (typically these end in an esclam
 * `_.tag! :foo`: insert elements where the name can be dynamic
 * `_.error 'Log message'`: write a message to the server log
 
+Underscores in element and attribute names are converted to dashes.  To
+disable this behavior, express attribute names as strings and use the `_.tag!`
+method for element names.
+
 XHTML differs from HTML in the escaping of inline style and script elements.
 XHTML will also fall back to HTML output unless the user agent indicates it
 supports XHTML via the HTTP Accept header.
@@ -227,6 +239,12 @@ If one of the attributes passed on the `_html` declaration is `:_width`, an
 attempt will be made to reflow text in order to not exceed this line width.
 This won't be done if it will affect what actually is displayed.
 
+If none of the child elements for the `html` element are either `head` or
+`body`, then these tags will be created for you, and the relevant children
+will be moved to the appropriate section.  If the body contains a `h1`
+element, and the `head` doesn't contain a `title`, a title element will be
+created based on the text supplied to the first `h1` element.
+
 Methods provided to Wunderbar.json
 ---
 
@@ -406,3 +424,11 @@ The following gems, if installed, will produce cleaner and prettier output:
 
 * `nokogiri` cleans up HTML fragments inserted via `<<`
 * `escape` prettier quoting of `system` commands
+
+Related efforts:
+---
+* [Builder](https://github.com/jimweirich/builder#readme)
+* [JBuilder](https://github.com/rails/jbuilder)
+* [Markaby](http://markaby.rubyforge.org/)
+* [Nokogiri::HTML::Builder](http://nokogiri.org/Nokogiri/HTML/Builder.html)
+* [Tagz](https://github.com/ahoward/tagz)

data/lib/wunderbar/builder.rb

@@ -1,93 +1,4 @@
 module Wunderbar
-  # XmlMarkup handles indentation of elements beautifully, this class extends
-  # that support to text, data, and spacing between elements
-  class SpacedMarkup < Builder::XmlMarkup
-    def indented_text!(text)
-      indented_data!(text) {|data| text! data}
-    end
-
-    def indented_data!(data, pre=nil, post=nil, &block)
-      return if data.strip.length == 0
-
-      self << pre + target!.pop if pre
-
-      if @indent > 0
-        data = data.sub(/\n\s*\Z/, '').sub(/\A\s*\n/, '')
-
-        unindent = data.sub(/s+\Z/,'').scan(/^ *\S/).map(&:length).min || 1
-
-        before  = ::Regexp.new('^'.ljust(unindent))
-        after   =  " " * (@level * @indent)
-        data.gsub! before, after
-
-        _newline if @pending_newline and not @first_tag
-        @pending_newline = @pending_margin
-        @first_tag = @pending_margin = false
-      end
-
-      if block
-        block.call(data)
-      else
-        self << data
-      end
-
-      _newline unless data =~ /\n\Z/
-
-      self << post if post
-    end
-
-    def disable_indentation!(&block)
-      indent, level, pending_newline, pending_margin = 
-        indentation_state! [0, 0, @pending_newline, @pending_margin]
-      text! " "*indent*level
-      block.call
-    ensure
-      indentation_state! [indent, level, pending_newline, pending_margin]
-    end
-
-    def indentation_state! new_state=nil
-      result = [@indent, @level, @pending_newline, @pending_margin]
-      if new_state
-        text! "\n" if @indent == 0 and new_state.first > 0
-        @indent, @level, @pending_newline, @pending_margin = new_state
-      end
-      result
-    end
-
-    def margin!
-      _newline unless @first_tag
-      @pending_newline = false
-      @pending_margin = true
-    end
-
-    def _nested_structures(*args)
-      pending_newline = @pending_newline
-      @pending_newline = false
-      @first_tag = true
-      super
-      @first_tag = @pending_margin = false
-      @pending_newline = pending_newline
-    end
-
-    def tag!(sym, *args, &block)
-      _newline if @pending_newline
-      @pending_newline = @pending_margin
-      @first_tag = @pending_margin = false
-      # workaround for https://github.com/jimweirich/builder/commit/7c824996637d2d76455c87ad47d76ba440937e38
-      sym = "#{sym}:#{args.shift}" if args.first.kind_of?(::Symbol)
-      if not block and args.first == ''
-        attrs = {}
-        attrs.merge!(args.last) if ::Hash === args.last
-        _indent
-        _start_tag(sym, attrs)
-        _end_tag(sym)
-        _newline
-      else
-        super
-      end
-    end
-  end
-
   class BuilderBase
     def set_variables_from_params(locals={})
       @_scope.params.merge(locals).each do |key,value|
@@ -117,18 +28,19 @@ module Wunderbar
   class XmlMarkup < BuilderClass
     def initialize(args)
       @_scope = args.delete(:scope)
-      @_builder = SpacedMarkup.new(args)
+      @_indent = args.delete(:indent) or 2
       @_pdf = false
+      @doc = Node.new(nil)
+      @node = @doc
+      @indentation_enabled = true
+      @width = nil
+      @spaced = false
     end
 
-    # forward to Wunderbar, XmlMarkup, or @_scope
+    # forward to Wunderbar or @_scope
     def method_missing(method, *args, &block)
       if Wunderbar.respond_to? method
         Wunderbar.send method, *args, &block
-      elsif SpacedMarkup.public_instance_methods.include? method
-        @_builder.__send__ method, *args, &block
-      elsif SpacedMarkup.public_instance_methods.include? method.to_s
-        @_builder.__send__ method, *args, &block
       elsif @_scope and @_scope.respond_to? method
         @_scope.send method, *args, &block
       else
@@ -151,6 +63,46 @@ module Wunderbar
       super
     end
 
+    def text! text
+      @node.add_text text
+    end
+
+    def declare! *args
+      @node.children << DocTypeNode.new(*args)
+    end
+
+    def comment! text
+      @node.children << CommentNode.new(text)
+    end
+
+    def indented_text!(text)
+      return if text.strip.length == 0
+      @node.children << IndentedTextNode.new(text)
+    end
+
+    def target!
+      "#{@doc.serialize(indent: ' ' * @_indent).join("\n")}\n"
+    end
+
+    def clear!
+      @doc.children.clear
+      @node = @doc
+    end
+
+    def compact!(width, &block)
+      begin
+        @width = width
+        @indentation_enabled = false
+        block.call
+      ensure
+        @indentation_enabled = true
+      end
+    end
+
+    def spaced!
+      @spaced = true
+    end
+
     # avoid method_missing overhead for the most common case
     def tag!(sym, *args, &block)
       if sym.respond_to? :children
@@ -173,19 +125,32 @@ module Wunderbar
         end
       end
 
-      if !block and (args.empty? or args == [''])
-        CssProxy.new(@_builder, @_builder.target!, sym, args)
+      if Class === args.first and args.first < Node
+        node = args.shift.new sym, *args
       else
-        @_builder.tag! sym, *args, &block
+        node = Node.new sym, *args
+      end
+
+      unless @indentation_enabled
+        node.extend CompactNode 
+        node.width = @width
+      end
+
+      if @spaced
+        node.extend SpacedNode
+        @spaced = false
       end
-    end
 
-    def proxiable_tag!(sym, *args, &block)
+      node.text = args.first if String === args.first
+      @node.add_child node
+      @node = node
       if block
-        tag!(sym, *args, &block)
-      else
-        CssProxy.new(@_builder, @_builder.target!, sym, args)
+        block.call(self)
+        @node.children << nil if @node.children.empty?
       end
+      @node = @node.parent
+
+      node
     end
 
     def pdf=(value)
@@ -230,7 +195,7 @@ module Wunderbar
       stderr = output_class[:stderr] || '_stderr'
       hilite = output_class[:hilite] || '_stdout _hilite'
 
-      @_builder.tag! tag, echo, :class=>stdin unless opts[:echo] == false
+      tag! tag, echo, :class=>stdin unless opts[:echo] == false
 
       require 'thread'
       semaphore = Mutex.new
@@ -241,9 +206,9 @@ module Wunderbar
               out_line = pout.readline.chomp
               semaphore.synchronize do
                 if patterns.any? {|pattern| out_line =~ pattern}
-                  @_builder.tag! tag, out_line, :class=>hilite
+                  tag! tag, out_line, :class=>hilite
                 else
-                  @_builder.tag! tag, out_line, :class=>stdout
+                  tag! tag, out_line, :class=>stdout
                 end
               end
             end
@@ -253,7 +218,7 @@ module Wunderbar
             until perr.eof?
               err_line = perr.readline.chomp
               semaphore.synchronize do 
-                @_builder.tag! tag, err_line, :class=>stderr
+                tag! tag, err_line, :class=>stderr
               end
             end
           end,
@@ -272,44 +237,37 @@ module Wunderbar
       end
     end
 
-    # declaration (DOCTYPE, etc)
-    def declare(*args)
-      @_builder.declare!(*args)
-    end
-
-    # comment
-    def comment(*args)
-      @_builder.comment! *args
-    end
-
     # insert verbatim
     def <<(data)
       if not String === data or data.include? '<' or data.include? '&'
         require 'nokogiri'
         data = Nokogiri::HTML::fragment(data.to_s).to_xml
-      end
 
-      # fix CDATA in most cases (notably scripts)
-      data.gsub!(/<!\[CDATA\[(.*?)\]\]>/m) do |cdata|
-        if $1.include? '<' or $1.include? '&'
-          "//<![CDATA[\n#{$1}\n//]]>"
-        else
-          $1
+        # fix CDATA in most cases (notably scripts)
+        data.gsub!(/<!\[CDATA\[(.*?)\]\]>/m) do
+          if $1.include? '<' or $1.include? '&'
+            "//<![CDATA[\n#{$1}\n//]]>"
+          else
+            $1
+          end
         end
-      end
 
-      # fix CDATA for style elements
-      data.gsub!(/<style([^>])*>\/\/<!\[CDATA\[\n(.*?)\s+\/\/\]\]>/m) do |cdata|
-        if $2.include? '<' or $2.include? '&'
-          "<style#{$1}>/*<![CDATA[*/\n#{$2.gsub("\n\Z",'')}\n/*]]>*/"
-        else
-          $1
+        # fix CDATA for style elements
+        data.gsub!(/<style([^>])*>\/\/<!\[CDATA\[\n(.*?)\s+\/\/\]\]>/m) do
+          if $2.include? '<' or $2.include? '&'
+            "<style#{$1}>/*<![CDATA[*/\n#{$2.gsub("\n\Z",'')}\n/*]]>*/"
+          else
+            $1
+          end
         end
       end
-
-      @_builder << data
     rescue LoadError
-      @_builder << data
+    ensure
+      if String === data
+        @node.children << data
+      else
+        @node.add_child data
+      end
     end
 
     def [](*children)
@@ -331,10 +289,8 @@ module Wunderbar
           text = child.text
           if text.strip.empty?
             text! "\n" if text.count("\n")>1
-          elsif indentation_state!.first == 0
-            indented_text! text
           else
-            indented_text! text.strip
+            indented_text! text
           end
         elsif child.comment?
           comment! child.text.sub(/\A /,'').sub(/ \Z/, '')
@@ -354,7 +310,7 @@ module Wunderbar
                 if stop == 0
                   self[children.shift]
                 else
-                  disable_indentation! do
+                  compact!(nil) do
                     self[*children.shift(stop || children.length)]
                   end
                 end
@@ -362,7 +318,7 @@ module Wunderbar
             end
           else
             # disable indentation on the entire element
-            disable_indentation! do
+            compact!(nil) do
               tag!(child) {self[*child.children]}
             end
           end

data/lib/wunderbar/cgi-methods.rb

@@ -103,13 +103,8 @@ module Wunderbar
         headers['status'] =  "500 Internal Server Error"
         x.clear!
         output = x.html(*args) do
-          _head do
-            _title 'Internal Server Error'
-          end
-          _body do
-            _h1 'Internal Server Error'
-            _exception exception
-          end
+          _h1 'Internal Server Error'
+          _exception exception
         end
       end
 
@@ -192,6 +187,11 @@ module Wunderbar
             self.text(scope, *args, &block)
             return
           end
+        when Proc
+          unless xhr_json or text
+            instance_exec scope, args, block, &type
+            return
+          end
         end
       end
     end

data/lib/wunderbar/cssproxy.rb

@@ -1,27 +1,12 @@
 module Wunderbar
-  # Class "lifted" from Markaby to store element options.  Methods called
+  # Class inspired by Markaby to store element options.  Methods called
   # against the CssProxy object are added as element classes or IDs.
   #
-  # Modified to accept args for empty, non-void elements, and to capture and
-  # restore indentation state.
-  #
   # See the README for examples.
-  class CssProxy
-    def initialize(builder, stream, sym, args)
+  class CssProxy < BasicObject
+    def initialize(builder, node)
       @builder = builder
-      @indent  = builder.indentation_state!
-      @stream  = stream
-      @sym     = sym
-      @args    = args
-      @attrs   = {}
-
-      @original_stream_length = @stream.length
-
-      @builder.tag! sym, *args
-    end
-
-    def respond_to?(sym, include_private = false)
-      include_private || !private_methods.map { |m| m.to_sym }.include?(sym.to_sym) ? true : false
+      @node = node
     end
 
   private
@@ -29,44 +14,29 @@ module Wunderbar
     # Adds attributes to an element.  Bang methods set the :id attribute.
     # Other methods add to the :class attribute.
     def method_missing(id_or_class, *args, &block)
+      empty = args.empty?
+      attrs = @node.attrs
+
       if id_or_class.to_s =~ /(.*)!$/
-        @attrs[:id] = $1
+        attrs[:id] = $1
+      elsif attrs[:class]
+        attrs[:class] = "#{attrs[:class]} #{id_or_class}"
       else
-        id = id_or_class
-        @attrs[:class] = @attrs[:class] ? "#{@attrs[:class]} #{id}".strip : id
-      end
-
-      @attrs.merge! args.pop.to_hash  if args.last.respond_to? :to_hash
-      @attrs.merge! @args.pop.to_hash if @args.last.respond_to? :to_hash
-
-      # delete attrs with false/nil values; change true to attribute name
-      @attrs.delete_if {|key, value| !value}
-      @attrs.each {|key, value| @attrs[key]=key if value == true}
-
-      args.push(@attrs)
-      args = @args + args unless block or String === args.first
-
-      if @sym == :pre
-        args.first.chomp! if String === args.first and args.first.end_with? "\n"
+        attrs[:class] = id_or_class
       end
 
-      while @stream.length > @original_stream_length
-        @stream.pop
-      end
+      attrs.merge! args.pop.to_hash if args.last.respond_to? :to_hash
+      args.push(attrs)
 
-      begin
-        indent = @builder.indentation_state! @indent
+      @node.parent.children.delete(@node)
 
-        if block
-          @builder.tag! @sym, *args, &block
-        else
-          @builder.tag! @sym, *args
-        end
-      ensure
-        @builder.indentation_state! indent
+      if empty and not block
+        @builder.proxiable_tag! @node.name, *args
+      elsif SpacedNode === @node
+        @builder.__send__ "_#{@node.name}_", *args, &block
+      else
+        @builder.__send__ "_#{@node.name}", *args, &block
       end
-
-      self
     end
   end
 end

data/lib/wunderbar/environment.rb

@@ -23,7 +23,7 @@ module Wunderbar
       # contained within data provided by users of the site.
       $:.each_with_index do |path, index|
         if path.tainted?
-          $:[index] = File.expand_path(path.untaint).untaint
+          $:[index] = File.expand_path(path.dup.untaint).untaint
         end
       end
     end
@@ -37,6 +37,12 @@ module Wunderbar
       @env = env
     end
   end
+
+  @@templates = {}
+
+  def self.templates
+    @@templates
+  end
 end
 
 require 'socket'
@@ -75,6 +81,10 @@ if self.to_s == 'main'
       Wunderbar.websocket(*args, &block)
     end
 
+    def _template(name, &block)
+      Wunderbar.templates[name.to_s.gsub('_','-')] = block
+    end
+
     def env
       ENV
     end