wunderbar 0.8.6 → 0.8.7

data/Manifest

@@ -1,6 +1,8 @@
 COPYING
-README
+README.md
 Rakefile
+demo/envdump.rb
+demo/helloworld.rb
 demo/wiki.html
 demo/wiki.rb
 lib/wunderbar.rb
@@ -16,4 +18,5 @@ test/test_builder.rb
 test/test_html_markup.rb
 test/test_logger.rb
 tools/web2script.rb
+wunderbar.gemspec
 Manifest

data/README.md

@@ -0,0 +1,212 @@
+Wunderbar: Easy HTML5 applications
+===
+
+Wunderbar makes it easy to produce valid HTML5, wellformed XHTML, Unicode
+(utf-8), consistently indented, readable applications.  This includes output
+that conforms to the
+[Polyglot](http://dev.w3.org/html5/html-xhtml-author-guide/) specification and
+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 
+[Builder](https://github.com/jimweirich/builder#readme).
+
+Quick Start
+---
+
+Simple element:
+
+        _br
+
+Nested elements:
+
+        _div do
+          _hr
+        end
+
+Element with text:
+
+        _h1 "My weblog"
+
+Element with attributes:
+
+        _img src: '/img/logo.jpg', alt: 'site logo'
+
+Element with both text and attributes:
+
+        _a 'search', href: 'http://google.com'
+
+Text:
+
+        _ "hello"
+
+Mixed content (autospaced):
+
+        _p do
+          _ 'It is a'
+          _em 'very'
+          _ 'nice day.'
+        end
+
+Mixed content (space controlled):
+
+        _p! do
+          _ 'Source is on '
+          _a 'github', href: 'https://github.com/'
+          _ '.'
+        end
+
+Insert blank lines between rows in the HTML produced:
+
+        _tbody do
+          _tr_ do
+            _td 1
+          end
+          _tr_ do
+            _td 2
+          end
+          _tr_ do
+            _td 3
+          end
+        end
+
+Capture exceptions:
+
+    _body? do
+      raise NotImplementedError.new('page')
+    end
+
+
+Basic interface
+---
+
+A typical main program produces one or more of HTML, JSON, or plain text
+output.  This is accomplished by providing one or more of the following:
+
+        Wunderbar.html do
+         code
+        end
+  
+        Wunderbar.json do
+          expression
+        end
+
+        Wunderbar.text do
+          code
+        end
+ 
+Arbitrary Ruby code can be placed in each.  For html, use the `_` methods described here.  For json, the results (typically a hash or array) are converted to JSON.  For text, use `puts` and `print` statements to produce the desired results.
+
+Methods provided to Wunderbar.html
+---
+
+Invoking methods that start with a Unicode "low line" character ("_") will
+generate a HTML tag.  As with builder on which this library is based, these
+tags can have text content and attributes.  Tags can also be nested.  Logic
+can be freely intermixed.
+
+Wunderbar knows which HTML tags need to be explicitly closed with separate end
+tags (example: textarea), and which should never be closed with separate end
+tags (example: br).  It also takes care of HTML quoting and escaping of
+arguments and text.
+
+Suffixes after the tag name will modify the processing.
+
+* `!`: turns off all special processing, including indenting
+* `?`: adds code to rescue exceptions and produce tracebacks 
+* `_`: adds extra blank lines between this tag and siblings
+
+The "`_`" method serves a number of purposes.  Calling it with a single argument
+produces text nodes.  Inserting markup verbatim is done by "`_ << text`".  A
+number of other convenience methods are defined:
+
+* _.`post?`  -- was this invoked via HTTP POST?
+* _.`system` -- invokes a shell command, captures stdin, stdout, and stderr
+* _.`submit`: runs command (or block) as a deamon process
+
+Access to all of the builder _defined_ methods (typically these end in an esclamation mark) and all of the Wunderbar module methods can be accessed in this way.  Examples:
+
+* `_.tag! :foo`
+* `_.error 'Log message'`
+
+Globals provided
+---
+* `$cgi`   - Common Gateway Interface
+* `$param` - Access to parameters (read-only OpenStruct like interface)
+* `$env`  - Access to environment variables (read-only OpenStruct like interface)
+* `$USER`  - Host user id
+* `$HOME`  - Home directory
+* `$SERVER`- Server name
+* `SELF`   - Request URI
+* `SELF?`  - Request URI with '?' appended (avoids spoiling the cache)
+* `$HOME`   - user's home directory
+* `$HOST`   - server host
+* `$HTTP_GET`   - request is an HTTP GET
+* `$HTTP_POST`  - request is an HTTP POST
+* `$XHR_JSON`   - request is XmlHttpRequest for JSON
+* `$XHTML`      - user agent accepts XHTML responses
+* `$TEXT`       - user agent accepts plain text responses
+
+Also, the following environment variables are set if they aren't already:
+
+* `HOME`
+* `HTTP_HOST`
+* `LANG`
+* `REMOTE_USER`
+
+Finally, the (Ruby 1.9.x) default external and internal encodings are set to
+UTF-8.  For Ruby 1.8, `$KCODE` is set to `U`
+
+HTML methods
+---
+* `_head`: insert meta charset utf-8
+* `_svg`: insert svg namespace
+* `_math`: insert math namespace
+* `_coffeescript`: convert [coffeescript](http://coffeescript.org/) to JS and insert script tag
+
+Note that adding an exclamation mark to the end of the tag name disables this
+behavior.
+
+CGI methods (deprecated?)
+---
+* `json`    - produce JSON output using the block specified
+* `json!`   - produce JSON output using the block specified and exit
+* `html`    - produce HTML output using the block specified
+* `html!`   - produce HTML output using the block specified and exit
+* `post`    - execute block only if method is POST
+* `post!`   - if POST, produce HTML output using the block specified and exit
+
+OpenStruct methods (for $params and $env)
+---
+* `untaint_if_match`: untaints value if it matches a regular expression
+
+Builder extensions
+---
+* `indented_text!`: matches text indentation to markup
+* `indented_data!`: useful for script and styles in HTML syntax
+* `disable_indendation!`: temporarily disable insertion of whitespace
+* `margin!`: insert blank lines between tags
+
+Logging:
+---
+* _.`debug`: debug messages
+* _.`info`: informational messages
+* _.`warn`: warning messages
+* _.`error`: error messages
+* _.`fatal`: fatal error messages
+* _.`log_level`=: set logging level (default: `:warn`)
+* _.`logger`: return [Logger](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html) instance
+
+Command line options
+---
+When run from the command line, CGI name=value pairs can be specified.
+Additionally, the following options are supported:
+
+* --`html`: HTML (HTTP GET) output is expected
+* --`post`: HTML (HTTP POST) output is expected
+* --`json`: JSON (XML HTTP Request) output is expected
+* --`xhtml`: XHTML output is expected
+* --`prompt` or --`offline`: prompt for key/value pairs using stdin
+* --`debug`, --`info`,--`warn`, --`error`, --`fatal`: set log level
+* --`install`=path: produce an suexec-callable wrapper script
+* --`rescue` or --`backtrace` cause wrapper script to capture errors

data/demo/envdump.rb

@@ -0,0 +1,20 @@
+require 'wunderbar'
+
+Wunderbar.html do
+  _head_ do
+    _title 'CGI Environment'
+  end
+  _body? do
+    _h1 'Environment Variables'
+    _table do
+      _tbody do
+        ENV.sort.each do |name, value|
+          _tr_ do
+            _td name
+            _td value
+          end
+        end
+      end
+    end
+  end
+end

data/demo/helloworld.rb

@@ -0,0 +1,22 @@
+require 'wunderbar'
+
+Wunderbar.html do
+  _head_ do
+    _title 'Greeter'
+    _style %{
+      input {display: block; margin: 2em}
+    }
+  end
+
+  _body? do
+    if @name
+      _p "Hello #{@name}!"
+    else
+      _form method: 'post' do
+        _p 'Please enter your name:'
+        _input name: 'name'
+        _input type: 'submit'
+      end
+    end
+  end
+end

data/lib/wunderbar/builder.rb

@@ -43,7 +43,7 @@ module Wunderbar
       @indent, @level = indent, level
     end
 
-    def _margin
+    def margin!
       _newline unless @first_tag
       @pending_newline = false
       @pending_margin = true

data/lib/wunderbar/cgi-methods.rb

@@ -85,7 +85,7 @@ end
 # produce html/xhtml
 def $cgi.html(*args, &block)
   return if $XHR_JSON or $TEXT
-  args.push {} if args.empty?
+  args << {} if args.empty?
   args.first[:xmlns] ||= 'http://www.w3.org/1999/xhtml' if Hash === args.first
   mimetype = ($XHTML ? 'application/xhtml+xml' : 'text/html')
   x = HtmlMarkup.new

data/lib/wunderbar/html-methods.rb

@@ -28,7 +28,7 @@ class HtmlMarkup
     end
 
     if name.sub!(/_$/,'')
-      @x._margin
+      @x.margin!
     end
 
     if flag != '!'

data/lib/wunderbar/job-control.rb

@@ -1,30 +1,32 @@
 # run command/block as a background daemon
-def submit(cmd=nil)
-  fork do
-    # detach from tty
-    Process.setsid
-    fork and exit
+module Wunderbar
+  def submit(cmd=nil)
+    fork do
+      # detach from tty
+      Process.setsid
+      fork and exit
 
-    # clear working directory and mask
-    Dir.chdir '/'
-    File.umask 0000
+      # clear working directory and mask
+      Dir.chdir '/'
+      File.umask 0000
 
-    # close open files
-    STDIN.reopen '/dev/null'
-    STDOUT.reopen '/dev/null', 'a'
-    STDERR.reopen STDOUT
+      # close open files
+      STDIN.reopen '/dev/null'
+      STDOUT.reopen '/dev/null', 'a'
+      STDERR.reopen STDOUT
 
-    # clear environment of cgi cruft
-    ENV.keys.to_a.each do |key|
-      ENV.delete(key) if key =~ /HTTP/ or $cgi.respond_to? key.downcase
-    end
+      # clear environment of cgi cruft
+      ENV.keys.to_a.each do |key|
+        ENV.delete(key) if key =~ /HTTP/ or $cgi.respond_to? key.downcase
+      end
 
-    # setup environment
-    ENV['USER'] ||= $USER
-    ENV['HOME'] ||= $HOME
+      # setup environment
+      ENV['USER'] ||= $USER
+      ENV['HOME'] ||= $HOME
 
-    # run cmd and/or block
-    system cmd if cmd
-    yield if block_given?
+      # run cmd and/or block
+      system cmd if cmd
+      yield if block_given?
+    end
   end
 end

data/lib/wunderbar/version.rb

@@ -2,7 +2,7 @@ module Wunderbar
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 8
-    TINY  = 6
+    TINY  = 7
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/wunderbar.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = "wunderbar"
-  s.version = "0.8.6"
+  s.version = "0.8.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sam Ruby"]
   s.date = "2012-03-17"
   s.description = "    Provides a number of globals, helper methods, and monkey patches which\n    simplify the generation of HTML and the development of CGI scripts.\n"
   s.email = "rubys@intertwingly.net"
-  s.extra_rdoc_files = ["COPYING", "README", "lib/wunderbar.rb", "lib/wunderbar/builder.rb", "lib/wunderbar/cgi-methods.rb", "lib/wunderbar/environment.rb", "lib/wunderbar/html-methods.rb", "lib/wunderbar/installation.rb", "lib/wunderbar/job-control.rb", "lib/wunderbar/logger.rb", "lib/wunderbar/version.rb"]
-  s.files = ["COPYING", "README", "Rakefile", "demo/wiki.html", "demo/wiki.rb", "lib/wunderbar.rb", "lib/wunderbar/builder.rb", "lib/wunderbar/cgi-methods.rb", "lib/wunderbar/environment.rb", "lib/wunderbar/html-methods.rb", "lib/wunderbar/installation.rb", "lib/wunderbar/job-control.rb", "lib/wunderbar/logger.rb", "lib/wunderbar/version.rb", "test/test_builder.rb", "test/test_html_markup.rb", "test/test_logger.rb", "tools/web2script.rb", "Manifest", "wunderbar.gemspec"]
+  s.extra_rdoc_files = ["COPYING", "README.md", "lib/wunderbar.rb", "lib/wunderbar/builder.rb", "lib/wunderbar/cgi-methods.rb", "lib/wunderbar/environment.rb", "lib/wunderbar/html-methods.rb", "lib/wunderbar/installation.rb", "lib/wunderbar/job-control.rb", "lib/wunderbar/logger.rb", "lib/wunderbar/version.rb"]
+  s.files = ["COPYING", "README.md", "Rakefile", "demo/envdump.rb", "demo/helloworld.rb", "demo/wiki.html", "demo/wiki.rb", "lib/wunderbar.rb", "lib/wunderbar/builder.rb", "lib/wunderbar/cgi-methods.rb", "lib/wunderbar/environment.rb", "lib/wunderbar/html-methods.rb", "lib/wunderbar/installation.rb", "lib/wunderbar/job-control.rb", "lib/wunderbar/logger.rb", "lib/wunderbar/version.rb", "test/test_builder.rb", "test/test_html_markup.rb", "test/test_logger.rb", "tools/web2script.rb", "wunderbar.gemspec", "Manifest"]
   s.homepage = "http://github.com/rubys/wunderbar"
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Wunderbar", "--main", "README"]
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Wunderbar", "--main", "README.md"]
   s.require_paths = ["lib"]
   s.rubyforge_project = "wunderbar"
   s.rubygems_version = "1.8.15"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wunderbar
 version: !ruby/object:Gem::Version 
-  hash: 51
+  hash: 49
   prerelease: 
   segments: 
   - 0
   - 8
-  - 6
-  version: 0.8.6
+  - 7
+  version: 0.8.7
 platform: ruby
 authors: 
 - Sam Ruby
@@ -53,7 +53,7 @@ extensions: []
 
 extra_rdoc_files: 
 - COPYING
-- README
+- README.md
 - lib/wunderbar.rb
 - lib/wunderbar/builder.rb
 - lib/wunderbar/cgi-methods.rb
@@ -65,8 +65,10 @@ extra_rdoc_files:
 - lib/wunderbar/version.rb
 files: 
 - COPYING
-- README
+- README.md
 - Rakefile
+- demo/envdump.rb
+- demo/helloworld.rb
 - demo/wiki.html
 - demo/wiki.rb
 - lib/wunderbar.rb
@@ -82,8 +84,8 @@ files:
 - test/test_html_markup.rb
 - test/test_logger.rb
 - tools/web2script.rb
-- Manifest
 - wunderbar.gemspec
+- Manifest
 homepage: http://github.com/rubys/wunderbar
 licenses: []
 
@@ -94,7 +96,7 @@ rdoc_options:
 - --title
 - Wunderbar
 - --main
-- README
+- README.md
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/README

@@ -1,99 +0,0 @@
-= Wunderbar: Common Gateway Interface for Single Page Applications
-
-Wunder provides a number of globals, helper methods, and monkey patches which
-simplify the development of single page applications in the form of CGI
-scripts.
-
-Basic interface
-===============
-
-A typical main program produces one or more of HTML, JSON, or plain text
-output.  This is accomplished by providing one or more of the following:
-
-  Wunderbar.html do
-    code
-  end
-  
-  Wunderbar.json do
-    expression
-  end
-
-  Wunderbar.text do
-    code
-  end
- 
-Arbitrary Ruby code can be placed in each.  
-
-== Methods provided to Wunderbar.html
-
-Invoking methods that start with a Unicode "low line" character ("_") will
-generate a HTML tag.  As with builder on which this library is based, these
-tags can have text content and attributes.  Tags can also be nested.  Logic
-can be freely intermixed.
-
-Wunderbar knows which HTML tags need to be explicitly closed with separate end
-tags (example: textarea), and which should never be closed with separate end
-tags (example: br).  It also takes care of HTML quoting and escaping of
-arguments and text.
-
-The "_" method serves a number of purposes.  Calling it with a single argument
-produces text nodes.  Inserting markup verbatim is done by "_ << text".  A
-number of other convenience methods are defined:
-
-  _.post?  -- was this invoked via HTTP POST?
-  _.system -- invokes a shell command, captures stdin, stdout, and stderr
-
-== Globals provided
-* $cgi   - Common Gateway Interface
-* $param - Access to parameters (read-only OpenStruct like interface)
-* $env   - Access to environment variables (read-only OpenStruct like interface)
-* $USER  - Host user id
-* $HOME  - Home directory
-* $SERVER- Server name
-* SELF   - Request URI
-* SELF?  - Request URI with '?' appended (avoids spoiling the cache)
-
-* $USER   - user
-* $HOME   - user's home directory
-* $HOST   - server host
-
-* $HTTP_GET   - request is an HTTP GET
-* $HTTP_POST  - request is an HTTP POST
-* $XHR_JSON   - request is XmlHttpRequest for JSON
-* $XHTML      - user agent accepts XHTML responses
-
-== HTML methods
-* style!  - argument is indented text/data
-* system! - run command and capture output
-* script! - argument is indented text/data
-* body?   - capture exceptions, and produce a stack traceback
-
-== CGI methods
-* json    - produce JSON output using the block specified
-* json!   - produce JSON output using the block specified and exit
-* html    - produce HTML output using the block specified
-* html!   - produce HTML output using the block specified and exit
-* post    - execute block only if method is POST
-* post!   - if POST, produce HTML output using the block specified and exit
-
-== Helper methods
-* submit: runs command (or block) as a deamon process
-
-== OpenStruct methods (for $params and $env)
-* untaint_if_match: untaints value if it matches a regular expression
-
-== Builder extensions
-* indented_text: matches text indentation to markup
-* indented_data: useful for script and styles in HTML syntax
-* traceback!: formats an exception traceback
-* method_missing: patched to ensure open tags are closed
-
-== Command line options
-When run from the command line, CGI name=value pairs can be specified.
-Additionally, the following options are supported:
-* --html: HTML (HTTP GET) output is expected
-* --post: HTML (HTTP POST) output is expected
-* --json: JSON (XML HTTP Request) output is expected
-* --xhtml: XHTML output is expected
-* --prompt: prompt for key/value pairs using stdin
-* --install=path: produce an suexec-callable wrapper script