inversion 0.0.1 → 0.0.2

data/Manifest.txt

@@ -12,12 +12,14 @@ lib/inversion/renderstate.rb
 lib/inversion/sinatra.rb
 lib/inversion/template.rb
 lib/inversion/template/attrtag.rb
+lib/inversion/template/begintag.rb
 lib/inversion/template/calltag.rb
 lib/inversion/template/codetag.rb
 lib/inversion/template/commenttag.rb
 lib/inversion/template/conditionaltag.rb
 lib/inversion/template/configtag.rb
 lib/inversion/template/containertag.rb
+lib/inversion/template/defaulttag.rb
 lib/inversion/template/elsetag.rb
 lib/inversion/template/elsiftag.rb
 lib/inversion/template/endtag.rb
@@ -30,25 +32,66 @@ lib/inversion/template/node.rb
 lib/inversion/template/parser.rb
 lib/inversion/template/pptag.rb
 lib/inversion/template/publishtag.rb
+lib/inversion/template/rescuetag.rb
 lib/inversion/template/subscribetag.rb
 lib/inversion/template/tag.rb
 lib/inversion/template/textnode.rb
+lib/inversion/template/timedeltatag.rb
 lib/inversion/template/unlesstag.rb
 lib/inversion/template/uriencodetag.rb
 lib/inversion/template/yieldtag.rb
 lib/inversion/tilt.rb
 lib/inversion/utils.rb
+manual/layouts/default.erb
+manual/lib/api-filter.rb
+manual/lib/editorial-filter.rb
+manual/lib/examples-filter.rb
+manual/lib/links-filter.rb
+manual/resources/css/manual.css
+manual/resources/fonts/GraublauWeb.otf
+manual/resources/fonts/GraublauWebBold.otf
+manual/resources/fonts/Inconsolata.otf
+manual/resources/images/arrow_225_small.png
+manual/resources/images/arrow_315_small.png
+manual/resources/images/arrow_skip.png
+manual/resources/images/cc-by.png
+manual/resources/images/dialog-error.png
+manual/resources/images/dialog-information.png
+manual/resources/images/dialog-warning.png
+manual/resources/images/emblem-important.png
+manual/resources/images/help.png
+manual/resources/images/information.png
+manual/resources/images/magnifier.png
+manual/resources/images/magnifier_left.png
+manual/resources/images/page_white_code.png
+manual/resources/images/page_white_copy.png
+manual/resources/images/printer.png
+manual/resources/images/question.png
+manual/resources/images/scripts_code.png
+manual/resources/images/wrap.png
+manual/resources/images/wrapping.png
+manual/resources/js/jquery-1.4.4.min.js
+manual/resources/js/manual.js
+manual/resources/js/sh.js
+manual/resources/swf/clipboard.swf
+manual/src/examples.page
+manual/src/gettingstarted.page
+manual/src/index.page
+manual/src/tags.page
+manual/src/templates.page
 spec/data/sinatra/hello.inversion
 spec/inversion/mixins_spec.rb
 spec/inversion/monkeypatches_spec.rb
 spec/inversion/renderstate_spec.rb
 spec/inversion/sinatra_spec.rb
 spec/inversion/template/attrtag_spec.rb
+spec/inversion/template/begintag_spec.rb
 spec/inversion/template/calltag_spec.rb
 spec/inversion/template/codetag_spec.rb
 spec/inversion/template/commenttag_spec.rb
 spec/inversion/template/configtag_spec.rb
 spec/inversion/template/containertag_spec.rb
+spec/inversion/template/defaulttag_spec.rb
 spec/inversion/template/elsetag_spec.rb
 spec/inversion/template/elsiftag_spec.rb
 spec/inversion/template/endtag_spec.rb
@@ -61,9 +104,11 @@ spec/inversion/template/node_spec.rb
 spec/inversion/template/parser_spec.rb
 spec/inversion/template/pptag_spec.rb
 spec/inversion/template/publishtag_spec.rb
+spec/inversion/template/rescuetag_spec.rb
 spec/inversion/template/subscribetag_spec.rb
 spec/inversion/template/tag_spec.rb
 spec/inversion/template/textnode_spec.rb
+spec/inversion/template/timedeltatag_spec.rb
 spec/inversion/template/unlesstag_spec.rb
 spec/inversion/template/uriencodetag_spec.rb
 spec/inversion/template/yieldtag_spec.rb

data/lib/inversion.rb

@@ -26,10 +26,10 @@ module Inversion
 	require 'inversion/monkeypatches'
 
 	# Library version constant
-	VERSION = '0.0.1'
+	VERSION = '0.0.2'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 73c3d8215868 $
+	REVISION = %q$Revision: 08e77b056c67 $
 
 	#
 	# Logging

data/lib/inversion/template/begintag.rb

@@ -0,0 +1,122 @@
+#!/usr/bin/env ruby
+# vim: set noet nosta sw=4 ts=4 :
+
+require 'inversion/mixins'
+require 'inversion/template/attrtag'
+require 'inversion/template/containertag'
+require 'inversion/template/conditionaltag'
+require 'inversion/template/rescuetag'
+
+
+# Inversion 'begin' tag.
+#
+# This tag causes a section of the template to be rendered only if no exceptions are raised
+# while it's being rendered. If an exception is raised, it is checked against any 'rescue'
+# blocks, and the first one with a matching exception is rendered instead. If no 'rescue' block
+# is found, the exception is handled by the configured exception behavior for the template,
+# and the resulting replaces the block.
+#
+# == Syntax
+#
+#   <?begin ?><?call employees.length ?><?end?>
+#
+#   <?begin ?>
+#		<?for employee in employees.all ?>
+#			<?attr employee.name ?> --> <?attr employee.title ?>
+#		<?end for?>
+#   <?rescue DatabaseError => err ?>
+#		Oh no!! I can't talk to the database for some reason.  The
+#		error was as follows:
+#		<pre>
+#			<?attr err.message ?>
+#		</pre>
+#   <?end?>
+#
+class Inversion::Template::BeginTag < Inversion::Template::Tag
+	include Inversion::Loggable,
+	        Inversion::Template::ContainerTag
+
+
+	### Initialize a new BeginTag.
+	def initialize( body='', linenum=nil, colnum=nil ) # :notnew:
+		super
+		@rescue_clauses = [] # [ [RuntimeError, ArgumentError], [subnodes] ]
+	end
+
+
+	######
+	public
+	######
+
+	# The tuples of rescue clauses handled by the begin
+	attr_reader :rescue_clauses
+
+
+	### Override the append operator to separate out RescueTags and the nodes that follow
+	### them.
+	def <<( subnode )
+		case
+
+		# If this node is a <?rescue?>, add a container for the subnodes that belong to it
+		# and the list of exception types that it rescues
+		when subnode.is_a?( Inversion::Template::RescueTag )
+			@rescue_clauses << [ subnode.exception_types, [] ]
+
+		# If there's already at least one rescue clause in effect, add any subnodes to
+		# the last one
+		when !@rescue_clauses.empty?
+			@rescue_clauses.last[1] << subnode
+
+		# Append nodes in the begin, but before any rescue to the begin tag
+		else
+			super
+		end
+
+		return self
+	end
+
+
+	### Render the tag's contents if the condition is true, or any else or elsif sections
+	### if the condition isn't true.
+	def render( state )
+		output = []
+
+		errhandler = self.method( :handle_exception )
+		state.with_destination( output ) do
+			state.with_error_handler( errhandler ) do
+				catch( :stop_rendering ) do
+					self.render_subnodes( state )
+				end
+				self.log.debug "  leaving the error-handler block"
+			end
+			self.log.debug "  leaving the overridden output block"
+		end
+
+		self.log.debug "Rendered begin section as: %p" % [ output ]
+		return output
+	end
+
+
+	### The replacement exception-handler provided to RenderState.
+	def handle_exception( state, node, exception )
+		self.log.debug "Handling %p raised by %p: %s" % [ exception.class, node, exception.message ]
+		state.destination.clear
+
+		self.rescue_clauses.each do |errclasses, nodes|
+			self.log.debug "  considering rescue clause: %p -> %p" % [ errclasses, nodes ]
+			if errclasses.any? {|eclass| eclass === exception }
+				self.log.debug "  rescued by a clause for %p" % [ errclasses ]
+				nodes.each {|node| state << node }
+				throw :stop_rendering
+			end
+		end
+
+		# Use the default error handler
+		self.log.debug "  no rescue clause for a %p: falling back to the default error handler" %
+			[ exception.class ]
+		state.destination << state.default_error_handler( state, node, exception )
+		throw :stop_rendering
+	end
+
+end # class Inversion::Template::BeginTag
+

data/lib/inversion/template/defaulttag.rb

@@ -0,0 +1,135 @@
+#!/usr/bin/env ruby
+# vim: set noet nosta sw=4 ts=4 :
+
+require 'inversion/template/codetag'
+
+# Inversion 'default' tag.
+#
+# The default tag sets the default value of an attribute to a constant, the value of
+# another attribute, or the results of evaluating a methodchain on an attribute.
+#
+# == Syntax
+#   <!-- Set a default width that can be overridden by the controller -->
+#   <?default width to 120 ?>
+#   <?default employees to [] ?>
+#
+#   <!-- Default an attribute to the value of a second attribute -->
+#   <?default content to body ?>
+#
+#   <!-- Set the title to the employee's name if it hasn't been set explicitly -->
+#   <?default title to "%s, %s" % [ employee.lastname, employee.firstname ] ?>
+#
+class Inversion::Template::DefaultTag < Inversion::Template::CodeTag
+
+	# <?default «identifier» to "%s" % foo ?>
+	tag_pattern '$(ident) sp $(ident) sp tstring_beg $(tstring_content) tstring_end sp* $(op) sp* $( .* )' do |tag, match|
+		op = match.string( 4 )
+		raise Inversion::ParseError, "expected '%%', got %p instead" % [ op ] unless op == '%'
+		raise Inversion::ParseError, "invalid operator: expected 'to', got %p for %p" %
+			[ match.string(2), tag.body ] unless match.string(2) == 'to'
+
+		tag.name    = match.string( 1 )
+		tag.format  = match.string( 3 )
+		tag.literal = match.string( 5 )
+	end
+
+	# <?default «identifer» to «identifier».«methodchain» ?>
+	tag_pattern "$(ident) sp $(ident) sp $(ident) $( .* )" do |tag, match|
+		raise Inversion::ParseError, "invalid operator: expected 'to', got %p for %p" %
+			[ match.string(2), tag.body ] unless match.string(2) == 'to'
+
+		tag.name        = match.string( 1 )
+		tag.identifiers << match.string( 3 )
+		tag.methodchain = match.string( 4 )
+	end
+
+	# <?default «identifer» to «literal» ?>
+	tag_pattern "$(ident) sp $(ident) sp $( .* )" do |tag, match|
+		raise Inversion::ParseError, "invalid operator: expected 'to', got %p for %p" %
+			[ match.string(2), tag.body ] unless match.string(2) == 'to'
+
+		tag.name    = match.string( 1 )
+		tag.literal = match.string( 3 )
+	end
+
+
+	### Create a new DefaultTag with the given +name+, which should be a valid
+	### Ruby identifier.
+	def initialize( body, linenum=nil, colnum=nil )
+		@name        = nil
+		@methodchain = nil
+		@literal     = nil
+		@format      = nil
+
+		super
+
+		# Add an identifier for the tag name
+		self.identifiers << self.name.untaint.to_sym
+	end
+
+
+	######
+	public
+	######
+
+	# the name of the attribute
+	attr_accessor :name
+
+	# the format string used to format the attribute in the template (if
+	# one was declared)
+	attr_accessor :format
+
+	# The literal, if the tag had one (as opposed to an attribute or methodchain)
+	attr_accessor :literal
+
+	# the chain of methods that should be called (if any).
+	attr_accessor :methodchain
+
+
+	### Render the tag as the body of a comment, suitable for template debugging.
+	def as_comment_body
+		comment = "%s '%s': { " % [ self.tagname, self.name ]
+		if self.methodchain
+			comment << "template.%s%s" % [ self.identifiers.first, self.methodchain ]
+		else
+			comment << self.literal
+		end
+		comment << " }"
+		comment << " with format: %p" % [ self.format ] if self.format
+
+		return comment
+	end
+
+
+	### Set the specified value (if it's nil) before rendering.
+	def before_rendering( renderstate )
+		if val = renderstate.attributes[ self.name.to_sym ]
+			self.log.info "Not defaulting %s: already set to %p" %
+				[ self.name, val ]
+			return nil
+		end
+
+		default = nil
+		if chain = self.methodchain
+			self.log.debug "Using methodchain %p to set default for %p" %
+				[ chain, self.name ]
+			default = renderstate.eval( 'self' + '.' + self.identifiers.first + chain )
+		else
+			self.log.debug "Using literal %p to set default for %p" %
+				[ self.literal, self.name ]
+			default = renderstate.eval( self.literal )
+			default = self.format % default if self.format
+		end
+
+		self.log.debug "  default value: %p" % [ default ]
+		renderstate.attributes[ self.name.to_sym ] = default
+	end
+
+
+	### Render as the empty string.
+	def render( renderstate )
+		return ''
+	end
+
+end # class Inversion::Template::DefaultTag
+

data/lib/inversion/template/rescuetag.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+# vim: set noet nosta sw=4 ts=4 :
+
+require 'inversion/template/tag'
+
+
+# Inversion 'rescue' tag.
+#
+# This tag adds a logical switch to a BeginTag. If rendering any of the BeginTag's nodes raises
+# an exception of the type specified by the RescueTag, the nodes following the RescueTag are
+# rendered instead.
+# 
+# == Syntax
+#
+#   <?begin ?>
+#       <?for employee in employees.all ?>
+#           <?attr employee.name ?> --> <?attr employee.title ?>
+#       <?end for?>
+#   <?rescue DatabaseError => err ?>
+#       Oh no!! I can't talk to the database for some reason.  The
+#       error was as follows:
+#       
+#           <?attr err.message ?>
+#       
+#   <?end?>
+#
+class Inversion::Template::RescueTag < Inversion::Template::Tag
+	include Inversion::Loggable
+
+
+	### Overridden to default body to nothing, and raise an error if it has one.
+	def initialize( body='', linenum=nil, colnum=nil ) # :notnew:
+		super
+		@exception_types = parse_exception_types( self.body )
+	end
+
+
+	######
+	public
+	######
+
+	# The exception classes the rescue will handle (an Array of Class objects)
+	attr_reader :exception_types
+
+
+	### Parsing callback -- check to be sure the node tree can have the
+	### 'else' tag appended to it.
+	def before_appending( parsestate )
+		condtag = parsestate.node_stack.reverse.find do |node|
+			case node
+
+			# If there was a previous 'begin', the 'rescue' belongs to it. Also
+			# allow it to be appended to a 'comment' section so you can comment out a
+			# rescue clause without commenting out the begin
+			when Inversion::Template::BeginTag,
+			     Inversion::Template::CommentTag
+				break node
+
+			# If it's some other kind of container, it's an error
+			when Inversion::Template::ContainerTag
+				raise Inversion::ParseError, "'%s' tags can't have '%s' clauses" %
+					[ node.tagname.downcase, self.tagname.downcase ]
+			end
+		end
+
+		# If there wasn't a valid container, it's an error too
+		raise Inversion::ParseError, "orphaned '%s' tag" % [ self.tagname.downcase ] unless condtag
+	end
+
+
+	#######
+	private
+	#######
+
+	### Parse one or more exception classes from the given +rescuespec+ and return them.
+	def parse_exception_types( rescuespec )
+		return [ ::RuntimeError ] if rescuespec.nil? || rescuespec == ''
+
+		# Turn a comma-delimited list of exception names into the corresponding classes
+		return rescuespec.split( /\s*,\s*/ ).collect do |classname|
+			classname.split( '::' ).
+				reject( &:empty? ).
+				inject( Object ) do |klass, name|
+					klass = klass.const_get( name ) or
+						raise "No such exception class %s" % [ classname ]
+						klass
+				end
+		end
+	end
+
+end # class Inversion::Template::RescueTag
+