cgi-spa 0.2.1 → 0.3.0

data/COPYING

@@ -0,0 +1,18 @@
+Copyright (c) 2009 Sam Ruby <rubys@intertwingly.net>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -1,23 +1,55 @@
-Provides the following globals:
-  $cgi    - Common Gateway Interface
-  $params - Access to parameters
-  $x      - XmlBuilder instance
+= cgi-spa: Common Gateway Interface for Single Page Applications
 
-  $USER   - user
-  $HOME   - user's home directory
-  $HOST   - server host
+CGI-SPA provides a number of globals, helper methods, and monkey patches which
+simplify the development of single page applications in the form of CGI
+scripts.
 
-  $HTTP_GET   - request is an HTTP GET
-  $HTTP_POST  - request is an HTTP POST
-  $XHR_JSON   - request is XmlHttpRequest for JSON
+== Globals provided
+* $cgi   - Common Gateway Interface
+* $param - Access to parameters (read-only OpenStruct like interface)
+* $x     - XmlBuilder instance
+* $USER  - Host user id
+* $HOME  - Home directory
+* $SERVER- Server name
+* SELF   - Request URI
+* SELF?  - Request URI with '?' appended (avoids spoiling the cache)
 
-Helper methods:
-  submit: runs command (or block) as a deamon process
+* $USER   - user
+* $HOME   - user's home directory
+* $HOST   - server host
 
-MonkeyPatches to Builder:
-  indented_text: matches text indentation to markup
-  indented_data: useful for script and styles in HTML syntax
-  traceback!   : formats an exception traceback
+* $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
 
-  method_missing: patched to ensure open tags are closed
+== HTML methods
+* style!  - argument is indented text/data
+* script! - argument is indented text/data
 
+== 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
+
+== 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

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-require File.expand_path(File.dirname(__FILE__) + "/lib/version")
+require File.expand_path(File.dirname(__FILE__) + "/lib/cgi-spa/version")
 
 Echoe.new('cgi-spa', CgiSpa::VERSION::STRING) do |p|
   p.summary    = "CGI Single Page Applications"

data/cgi-spa.gemspec

@@ -2,18 +2,18 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cgi-spa}
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sam Ruby"]
-  s.date = %q{2009-12-18}
+  s.date = %q{2009-12-19}
   s.description = %q{    Provides a number of globals, helper methods, and monkey patches which
     simplify the development of single page applications in the form of
     CGI scripts.
 }
   s.email = %q{rubys@intertwingly.net}
-  s.extra_rdoc_files = ["README", "lib/cgi-spa.rb", "lib/version.rb"]
-  s.files = ["Manifest", "README", "Rakefile", "cgi-spa.gemspec", "lib/cgi-spa.rb", "lib/version.rb"]
+  s.extra_rdoc_files = ["COPYING", "README", "lib/cgi-spa.rb", "lib/cgi-spa/builder.rb", "lib/cgi-spa/cgi-methods.rb", "lib/cgi-spa/environment.rb", "lib/cgi-spa/html-methods.rb", "lib/cgi-spa/installation.rb", "lib/cgi-spa/job-control.rb", "lib/cgi-spa/version.rb"]
+  s.files = ["COPYING", "Manifest", "README", "Rakefile", "cgi-spa.gemspec", "lib/cgi-spa.rb", "lib/cgi-spa/builder.rb", "lib/cgi-spa/cgi-methods.rb", "lib/cgi-spa/environment.rb", "lib/cgi-spa/html-methods.rb", "lib/cgi-spa/installation.rb", "lib/cgi-spa/job-control.rb", "lib/cgi-spa/version.rb"]
   s.homepage = %q{http://github.com/rubys/cgi-spa}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Cgi-spa", "--main", "README"]
   s.require_paths = ["lib"]

data/lib/cgi-spa/builder.rb

@@ -0,0 +1,102 @@
+# add indented_text!, indented_data! and traceback! methods to builder
+module Builder
+  class XmlMarkup
+    unless method_defined? :indented_text!
+      def indented_text!(text)
+        indented_data!(text) {|data| text! data}
+      end
+    end
+
+    unless method_defined? :indented_data!
+      def indented_data!(data)
+        return if data.strip.length == 0
+        lines = data.gsub(/\n\s*\n/,"\n")
+        unindent = lines.scan(/^ */).map {|str| str.length}.min
+
+        before  = Regexp.new('^'.ljust(unindent+1))
+        after   =  " " * (@level * @indent)
+        data = data.gsub(before, after)
+
+        if block_given?
+          yield data 
+        else
+          self << data
+        end
+
+        _newline unless data =~ /\s$/
+      end
+    end
+
+    unless method_defined? :traceback!
+      def traceback!(exception=$!, klass='traceback')
+        pre :class=>klass do
+          text! exception.inspect
+          _newline
+          exception.backtrace.each {|frame| text!((' '*@indent)+frame + "\n")}
+        end
+      end
+    end
+  end
+end
+
+# monkey patch to ensure that tags are closed
+test = 
+  Builder::XmlMarkup.new.html do |x|
+    x.body do
+     begin
+       x.p do
+         raise Exception.new('boom')
+       end
+     rescue Exception => e
+       x.pre e
+     end
+    end
+  end
+
+if test.index('<p>') and !test.index('</p>')
+  module Builder
+    class XmlMarkup
+      def method_missing(sym, *args, &block)
+          text = nil
+        attrs = nil
+        sym = "#{sym}:#{args.shift}" if args.first.kind_of?(Symbol)
+        args.each do |arg|
+          case arg
+          when Hash
+            attrs ||= {}
+            attrs.merge!(arg)
+          else
+            text ||= ''
+            text << arg.to_s
+          end
+        end
+        if block
+          unless text.nil?
+            raise ArgumentError, "XmlMarkup cannot mix a text argument with a block"
+          end
+          _indent
+          _start_tag(sym, attrs)
+          _newline
+          begin ### Added
+            _nested_structures(block)
+          ensure ### Added
+            _indent
+            _end_tag(sym)
+            _newline
+          end ### Added
+        elsif text.nil?
+          _indent
+          _start_tag(sym, attrs, true)
+          _newline
+        else
+          _indent
+          _start_tag(sym, attrs)
+          text! text
+          _end_tag(sym)
+          _newline
+        end
+        @target
+      end
+    end
+  end
+end

data/lib/cgi-spa/cgi-methods.rb

@@ -0,0 +1,51 @@
+# produce json
+def $cgi.json
+  return unless $XHR_JSON
+  $cgi.out 'type' => 'application/json', 'Cache-Control' => 'no-cache' do
+    JSON.pretty_generate(yield)+ "\n"
+  end
+end
+
+# produce json and quit
+def $cgi.json! &block
+  return unless $XHR_JSON
+  json(&block)
+  Process.exit
+end
+
+# produce html/xhtml
+def $cgi.html
+  return if $XHR_JSON
+  if $XHTML
+    $cgi.out 'type' => 'application/xhtml+xml', 'charset' => 'UTF-8' do
+      $x.declare! :DOCTYPE, :html
+      $x.html :xmlns => 'http://www.w3.org/1999/xhtml' do
+        yield $x
+      end
+    end
+  else
+    $cgi.out 'type' => 'text/html', 'charset' => 'UTF-8' do
+      $x.declare! :DOCTYPE, :html
+      $x.html do
+        yield $x
+      end
+    end
+  end
+end
+
+# produce html and quit
+def $cgi.html! &block
+  return if $XHR_JSON
+  html(&block)
+  Process.exit
+end
+
+# post specific logic (doesn't produce output)
+def $cgi.post
+  yield unless $HTML_POST
+end
+
+# post specific content (produces output)
+def $cgi.post! &block
+  html!(&block) unless $HTML_POST
+end

data/lib/cgi-spa/environment.rb

@@ -0,0 +1,45 @@
+# explicit request types
+$HTTP_GET  = ARGV.delete('--html')
+$HTTP_POST = ARGV.delete('--post')
+$XHR_JSON  = ARGV.delete('--json')
+$XHTML     = ARGV.delete('--xhtml')
+
+# Only prompt if explicitly asked for
+ARGV.push '' if ARGV.empty?
+ARGV.delete('--prompt') or ARGV.delete('--offline')
+
+# standard objects
+$cgi = CGI.new
+$param = $cgi.params
+$x = Builder::XmlMarkup.new :indent => 2
+
+# implied request types
+$HTTP_GET  ||= ($cgi.request_method == 'GET')
+$HTTP_POST ||= ($cgi.request_method == 'POST')
+$XHR_JSON  ||= ($cgi.accept.to_s =~ /json/)
+$XHTML     ||= ($cgi.accept.to_s =~ /xhtml/)
+
+# get arguments if CGI couldn't find any... 
+$param.merge!(CGI.parse(ARGV.join('&'))) if $param.empty?
+
+# fast path for accessing CGI parameters
+def $param.method_missing(name)
+  self[name.to_s].join if has_key? name.to_s
+end
+
+# quick access to request_uri
+SELF = ENV['REQUEST_URI'].to_s
+def SELF?
+  SELF + "?" # avoids spoiling the cache
+end
+
+# environment objects
+$USER = ENV['USER'] ||
+  if RUBY_PLATFORM =~ /darwin/
+    `dscl . -search /Users UniqueID #{Process.uid}`.split.first
+  else
+    `getent passwd #{Process.uid}`.split(':').first
+  end
+
+$HOME   = ENV['HOME'] || File.expand_path('~' + $USER)
+$SERVER = ENV['HTTP_HOST'] || `hostname`.chomp

data/lib/cgi-spa/html-methods.rb

@@ -0,0 +1,25 @@
+# smart style, knows that the content is indented text/data
+def $x.style!(text)
+  text.slice! /^\n/
+  text.slice! /[ ]+\z/
+  $x.style :type => "text/css" do
+    if $XHTML
+      indented_text! text
+    else
+      indented_data! text
+    end
+  end
+end
+
+# smart script, knows that the content is indented text/data
+def $x.script!(text)
+  text.slice! /^\n/
+  text.slice! /[ ]+\z/
+  $x.script :lang => "text/javascript" do
+    if $XHTML
+      indented_text! text
+    else
+      indented_data! text
+    end
+  end
+end

data/lib/cgi-spa/installation.rb

@@ -0,0 +1,54 @@
+# option to create an suexec callable wrapper
+install = ARGV.find {|arg| arg =~ /--install=(.*)/}
+if install and ARGV.delete(install)
+
+  # scope out the situation
+  dest = File.expand_path($1)
+  main = File.expand_path(caller.last[/^(.*):\d+(:|$)/,1])
+
+  # if destination is a directory, determine an appropriate file name
+  if File.directory?(dest)
+    if dest =~ /\/cgi-bin\/?$/
+      dest = File.join(dest, File.basename(main))
+    else
+      dest = File.join(dest, File.basename(main).sub(/\.rb$/,'.cgi'))
+    end
+  end
+
+  # prevent accidental overwrite
+  if File.exist?(dest) and not ARGV.delete('-f')
+    STDERR.puts "File #{dest} already exists.  (Specify -f to overwrite)"
+    Process.exit
+  end
+
+  # ensure destination directory exists
+  destdir = File.dirname(dest)
+  if not File.exist?(destdir) or not File.directory?(destdir)
+    STDERR.puts "Directory #{destdir} does not exist."
+    Process.exit
+  end
+
+  # output wrapper
+  open(dest,'w') do |file|
+    # she-bang
+    file.puts "#!" + File.join(
+      RbConfig::CONFIG["bindir"],
+      RbConfig::CONFIG["ruby_install_name"] + RbConfig::CONFIG["EXEEXT"]
+    )
+
+    # Change directory
+    file.puts "Dir.chdir #{File.dirname(main).inspect}"
+
+    # Optional data from the script (after __END__)
+    file.puts DATA.read if Object.const_defined? :DATA
+
+    # Load script
+    file.puts "require #{File.basename(main).sub(/\.rb$/,'').inspect}"
+  end
+
+  # Mark wrapper as executable
+  File.chmod(0755, dest)
+
+  # Don't execute the script itself at this time
+  Process.exit
+end

data/lib/cgi-spa/job-control.rb

@@ -0,0 +1,25 @@
+# run command/block as a background daemon
+def submit(cmd=nil)
+  fork do
+    # detach from tty
+    Process.setsid
+    fork and exit
+
+    # 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
+
+    # setup environment
+    ENV['USER'] ||= $USER
+    ENV['HOME'] ||= $HOME
+
+    # run cmd and/or block
+    system cmd if cmd
+    yield if block_given?
+  end
+end

data/lib/{version.rb → cgi-spa/version.rb}

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

data/lib/cgi-spa.rb

@@ -1,169 +1,11 @@
-#!/usr/bin/ruby
 require 'cgi'
-require 'rubygems'
 require 'builder'
 require 'json'
 
-# standard objects
-$cgi = CGI.new
-$param = $cgi.params
-$x = Builder::XmlMarkup.new :indent => 2
+require 'cgi-spa/environment'
+require 'cgi-spa/cgi-methods'
+require 'cgi-spa/html-methods'
+require 'cgi-spa/job-control'
+require 'cgi-spa/installation'
+require 'cgi-spa/builder'
 
-# get arguments if CGI couldn't find any... 
-$param.merge!(CGI.parse(ARGV.join('&'))) if $param.empty?
-
-# fast path for accessing CGI parameters
-def $param.method_missing(name)
-  self[name.to_s].join if has_key? name.to_s
-end
-
-# quick access to request_uri
-SELF = ENV['REQUEST_URI'].to_s
-def SELF?
-  SELF + "?" # avoids spoiling the cache
-end
-
-# environment objects
-$USER = ENV['USER'] ||
-  if RUBY_PLATFORM =~ /darwin/
-    `dscl . -search /Users UniqueID #{Process.uid}`.split.first
-  else
-    `getent passwd #{Process.uid}`.split(':').first
-  end
-
-$HOME   = ENV['HOME'] || File.expand_path('~' + $USER)
-$SERVER = ENV['HTTP_HOST'] || `hostname`.chomp
-
-# request types
-$HTTP_GET  = ($cgi.request_method == 'GET')
-$HTTP_POST = ($cgi.request_method == 'POST')
-$XHR_JSON  = (ENV['HTTP_ACCEPT'] =~ /json/)
-
-# run command/block as a background daemon
-def submit(cmd=nil)
-  fork do
-    # detach from tty
-    Process.setsid
-    fork and exit
-
-    # 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
-
-    # setup environment
-    ENV['USER'] ||= $USER
-    ENV['HOME'] ||= $HOME
-
-    # run cmd and/or block
-    system cmd if cmd
-    yield if block_given?
-  end
-end
-
-# add indented_text!, indented_data! and traceback! methods to builder
-module Builder
-  class XmlMarkup
-    unless method_defined? :indented_text!
-      def indented_text!(text)
-        indented_data!(text) {|data| text! data}
-      end
-    end
-
-    unless method_defined? :indented_data!
-      def indented_data!(data)
-        return if data.strip.length == 0
-        lines = data.gsub(/\n\s*\n/,"\n")
-        unindent = lines.scan(/^ */).map {|str| str.length}.min
-
-        before  = Regexp.new('^'.ljust(unindent+1))
-        after   =  " " * (@level * @indent)
-        data = data.gsub(before, after)
-
-        if block_given?
-          yield data 
-        else
-          self << data
-        end
-
-        _newline unless data =~ /\s$/
-      end
-    end
-
-    unless method_defined? :traceback!
-      def traceback!(exception=$!, klass='traceback')
-        pre :class=>klass do
-          text! exception.inspect
-          _newline
-          exception.backtrace.each {|frame| text!((' '*@indent)+frame + "\n")}
-        end
-      end
-    end
-  end
-end
-
-# monkey patch to ensure that tags are closed
-test = 
-  Builder::XmlMarkup.new.html do |x|
-    x.body do
-     begin
-       x.p do
-         raise Exception.new('boom')
-       end
-     rescue Exception => e
-       x.pre e
-     end
-    end
-  end
-
-if test.index('<p>') and !test.index('</p>')
-  module Builder
-    class XmlMarkup
-      def method_missing(sym, *args, &block)
-          text = nil
-        attrs = nil
-        sym = "#{sym}:#{args.shift}" if args.first.kind_of?(Symbol)
-        args.each do |arg|
-          case arg
-          when Hash
-            attrs ||= {}
-            attrs.merge!(arg)
-          else
-            text ||= ''
-            text << arg.to_s
-          end
-        end
-        if block
-          unless text.nil?
-            raise ArgumentError, "XmlMarkup cannot mix a text argument with a block"
-          end
-          _indent
-          _start_tag(sym, attrs)
-          _newline
-          begin ### Added
-            _nested_structures(block)
-          ensure ### Added
-            _indent
-            _end_tag(sym)
-            _newline
-          end ### Added
-        elsif text.nil?
-          _indent
-          _start_tag(sym, attrs, true)
-          _newline
-        else
-          _indent
-          _start_tag(sym, attrs)
-          text! text
-          _end_tag(sym)
-          _newline
-        end
-        @target
-      end
-    end
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cgi-spa
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Sam Ruby
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-18 00:00:00 -05:00
+date: 2009-12-19 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,16 +39,30 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- COPYING
 - README
 - lib/cgi-spa.rb
-- lib/version.rb
+- lib/cgi-spa/builder.rb
+- lib/cgi-spa/cgi-methods.rb
+- lib/cgi-spa/environment.rb
+- lib/cgi-spa/html-methods.rb
+- lib/cgi-spa/installation.rb
+- lib/cgi-spa/job-control.rb
+- lib/cgi-spa/version.rb
 files: 
+- COPYING
 - Manifest
 - README
 - Rakefile
 - cgi-spa.gemspec
 - lib/cgi-spa.rb
-- lib/version.rb
+- lib/cgi-spa/builder.rb
+- lib/cgi-spa/cgi-methods.rb
+- lib/cgi-spa/environment.rb
+- lib/cgi-spa/html-methods.rb
+- lib/cgi-spa/installation.rb
+- lib/cgi-spa/job-control.rb
+- lib/cgi-spa/version.rb
 has_rdoc: true
 homepage: http://github.com/rubys/cgi-spa
 licenses: []