RubyGems - inversion - Versions diffs - 0.0.1 - Mend

inversion 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (78) hide show

data.tar.gz.sig +2 -0
data/.gemtest +0 -0
data/ChangeLog +836 -0
data/History.md +4 -0
data/Manifest.txt +74 -0
data/README.rdoc +171 -0
data/Rakefile +55 -0
data/bin/inversion +276 -0
data/lib/inversion.rb +98 -0
data/lib/inversion/exceptions.rb +21 -0
data/lib/inversion/mixins.rb +236 -0
data/lib/inversion/monkeypatches.rb +20 -0
data/lib/inversion/renderstate.rb +337 -0
data/lib/inversion/sinatra.rb +35 -0
data/lib/inversion/template.rb +250 -0
data/lib/inversion/template/attrtag.rb +120 -0
data/lib/inversion/template/calltag.rb +16 -0
data/lib/inversion/template/codetag.rb +164 -0
data/lib/inversion/template/commenttag.rb +54 -0
data/lib/inversion/template/conditionaltag.rb +49 -0
data/lib/inversion/template/configtag.rb +60 -0
data/lib/inversion/template/containertag.rb +45 -0
data/lib/inversion/template/elsetag.rb +62 -0
data/lib/inversion/template/elsiftag.rb +49 -0
data/lib/inversion/template/endtag.rb +55 -0
data/lib/inversion/template/escapetag.rb +26 -0
data/lib/inversion/template/fortag.rb +120 -0
data/lib/inversion/template/iftag.rb +69 -0
data/lib/inversion/template/importtag.rb +70 -0
data/lib/inversion/template/includetag.rb +51 -0
data/lib/inversion/template/node.rb +102 -0
data/lib/inversion/template/parser.rb +297 -0
data/lib/inversion/template/pptag.rb +28 -0
data/lib/inversion/template/publishtag.rb +72 -0
data/lib/inversion/template/subscribetag.rb +88 -0
data/lib/inversion/template/tag.rb +150 -0
data/lib/inversion/template/textnode.rb +43 -0
data/lib/inversion/template/unlesstag.rb +60 -0
data/lib/inversion/template/uriencodetag.rb +30 -0
data/lib/inversion/template/yieldtag.rb +51 -0
data/lib/inversion/tilt.rb +82 -0
data/lib/inversion/utils.rb +235 -0
data/spec/data/sinatra/hello.inversion +1 -0
data/spec/inversion/mixins_spec.rb +177 -0
data/spec/inversion/monkeypatches_spec.rb +35 -0
data/spec/inversion/renderstate_spec.rb +291 -0
data/spec/inversion/sinatra_spec.rb +59 -0
data/spec/inversion/template/attrtag_spec.rb +216 -0
data/spec/inversion/template/calltag_spec.rb +30 -0
data/spec/inversion/template/codetag_spec.rb +51 -0
data/spec/inversion/template/commenttag_spec.rb +84 -0
data/spec/inversion/template/configtag_spec.rb +105 -0
data/spec/inversion/template/containertag_spec.rb +54 -0
data/spec/inversion/template/elsetag_spec.rb +105 -0
data/spec/inversion/template/elsiftag_spec.rb +87 -0
data/spec/inversion/template/endtag_spec.rb +78 -0
data/spec/inversion/template/escapetag_spec.rb +59 -0
data/spec/inversion/template/fortag_spec.rb +98 -0
data/spec/inversion/template/iftag_spec.rb +241 -0
data/spec/inversion/template/importtag_spec.rb +106 -0
data/spec/inversion/template/includetag_spec.rb +108 -0
data/spec/inversion/template/node_spec.rb +81 -0
data/spec/inversion/template/parser_spec.rb +170 -0
data/spec/inversion/template/pptag_spec.rb +51 -0
data/spec/inversion/template/publishtag_spec.rb +69 -0
data/spec/inversion/template/subscribetag_spec.rb +60 -0
data/spec/inversion/template/tag_spec.rb +97 -0
data/spec/inversion/template/textnode_spec.rb +86 -0
data/spec/inversion/template/unlesstag_spec.rb +84 -0
data/spec/inversion/template/uriencodetag_spec.rb +49 -0
data/spec/inversion/template/yieldtag_spec.rb +54 -0
data/spec/inversion/template_spec.rb +269 -0
data/spec/inversion/tilt_spec.rb +47 -0
data/spec/inversion_spec.rb +95 -0
data/spec/lib/constants.rb +9 -0
data/spec/lib/helpers.rb +160 -0
metadata +316 -0
metadata.gz.sig +0 -0

data/lib/inversion/template/pptag.rb ADDED

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# vim: set noet nosta sw=4 ts=4 :
+require 'pp'
+require 'inversion/template/calltag'
+# Inversion object inspection tag.
+#
+# This tag dumps the result of the attribute or method chain.
+#
+# == Syntax
+#
+#   <?pp foo.bar ?>
+#
+class Inversion::Template::PpTag < Inversion::Template::CallTag
+	include Inversion::Escaping
+	### Render the method chains against the attributes of the specified +render_state+
+	### and return them.
+	def render( render_state )
+		raw = super
+		buf = ''
+		PP.pp( raw, buf )
+		return self.escape( buf.chomp, render_state )
+	end
+end # class Inversion::Template::PpTag

data/lib/inversion/template/publishtag.rb ADDED

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+# vim: set noet nosta sw=4 ts=4 :
+require 'inversion/template/tag'
+require 'inversion/template/containertag'
+# Inversion publish tag.
+#
+# The publish tag exports one or more subnodes to enclosing templates.
+#
+# == Syntax
+#
+#   <!-- Outer template -->
+#   <html>
+#     <head>
+#       <?subscribe headers ?>
+#     </head>
+#     <body><?attr body ?></body>
+#   </html>
+#
+#   <!-- In the body template, add a stylesheet link to the outer
+#        template's <head> -->
+#   <?publish headers ?>
+#      <link rel="stylesheet" ... />
+#   <?end ?>
+#   <div>(page content)</div>
+#
+class Inversion::Template::PublishTag < Inversion::Template::Tag
+	include Inversion::Template::ContainerTag
+	### Create a new PublishTag with the given +body+.
+	def initialize( body, line=nil, column=nil )
+		super
+		key = self.body[ /^([a-z]\w+)$/ ] or
+			raise Inversion::ParseError,
+				"malformed key: expected simple identifier, got %p" % [ self.body ]
+		@key = key.to_sym
+	end
+	######
+	public
+	######
+	# The name of the key the nodes will be published under
+	attr_reader :key
+	### Render the published subnodes in the context of the given +renderstate+, but
+	### save them for publication after the render is done.
+	def render( renderstate )
+		self.log.debug "Publishing %d nodes as %s" % [ self.subnodes.length, self.key ]
+		rendered_nodes = []
+		renderstate.with_destination( rendered_nodes ) do
+			self.render_subnodes( renderstate )
+		end
+		renderstate.publish( self.key, *rendered_nodes ) unless rendered_nodes.empty?
+		return nil
+	end
+	### Render the tag as the body of a comment, suitable for template debugging.
+	def as_comment_body
+		return "Published %d nodes as %s" % [ self.subnodes.length, self.key ]
+	end
+end # class Inversion::Template::PublishTag

data/lib/inversion/template/subscribetag.rb ADDED

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+# vim: set noet nosta sw=4 ts=4 :
+require 'inversion/template/tag'
+# Inversion subscription tag.
+#
+# The subscribe tag places one or more published nodes from subtemplates.
+#
+# == Syntax
+#
+#   <!-- Outer template -->
+#   <html>
+#     <head>
+#       <title><?subscribe title || Untitled ?></title>
+#       <?subscribe headers ?>
+#     </head>
+#     <body><?attr body ?></body>
+#   </html>
+#
+#   <!-- In the body template, add a stylesheet link to the outer
+#        template's <head> -->
+#   <?publish headers ?>
+#      <link rel="stylesheet" ... />
+#   <?end ?>
+#   <div>(page content)</div>
+#
+class Inversion::Template::SubscribeTag < Inversion::Template::Tag
+	### Create a new SubscribeTag with the given +body+.
+	def initialize( body, line=nil, column=nil )
+		super
+		unless self.body =~ /^([a-z]\w+)(?:\s*\|\|\s*(.+))?$/
+			raise Inversion::ParseError,
+				"malformed subscribe: %p" % [ self.body ]
+		end
+		key, default = $1, $2
+		@key = key.to_sym
+		@content = []
+		@default = default
+	end
+	######
+	public
+	######
+	# The name of the key the nodes will be published under
+	attr_reader :key
+	### Tell the +renderstate+ that this tag is interested in nodes that are published with
+	### its key.
+	def before_rendering( renderstate )
+		renderstate.subscribe( self.key, self )
+	end
+	### Return the subscribe node itself to act as a placeholder for subscribed nodes.
+	def render( renderstate )
+		return self
+	end
+	### Pub/sub callback. Called from the RenderState when a PublishTag publishes +nodes+
+	### with the same key as the current tag.
+	def publish( *nodes )
+		@content.push( *nodes )
+	end
+	### Stringify and join all of the published nodes for this subscription and return them
+	### as a String.
+	def to_s
+		if @content.empty?
+			self.log.debug "Nothing published with the %p key, defaulting to %p" %
+				[ self.key, @default ]
+			return @default.to_s
+		else
+			return @content.map( &:to_s ).join( '' )
+		end
+	end
+end # class Inversion::Template::SubscribeTag

data/lib/inversion/template/tag.rb ADDED

@@ -0,0 +1,150 @@
+#!/usr/bin/env ruby
+# vim: set noet nosta sw=4 ts=4 :
+require 'inversion' unless defined?( Inversion )
+require 'inversion/template' unless defined?( Inversion::Template )
+require 'inversion/template/node'
+require 'inversion/mixins'
+# Inversion template tag node base class. Represents a directive in a template
+# that defines behavior and/or state.
+#
+# This class supports the RubyGems plugin API: to provide one or more Inversion tags
+# in a gem of your own, put them into a directory named 'inversion/template' and
+# name the files <tt><tagname>tag.rb</tt> and the classes <tagname.capitalize>Tag.
+class Inversion::Template::Tag < Inversion::Template::Node
+	include Inversion::Loggable,
+	        Inversion::AbstractClass
+	# The glob pattern for matching template tag plugins
+	TAG_PLUGIN_PATTERN = 'inversion/template/*tag.rb'
+	########################################################################
+	### C L A S S   M E T H O D S
+	########################################################################
+	# The hash of loaded tag types
+	@types = nil
+	# Derivatives of this class
+	@derivatives = []
+	class << self
+		attr_reader :types, :derivatives
+	end
+	### Inheritance hook -- keep track of loaded derivatives.
+	def self::inherited( subclass )
+		# Inversion.log.debug "%p inherited from %p" % [ subclass, self ]
+		Inversion::Template::Tag.derivatives << subclass
+		super
+	end
+	### Return a Hash of all loaded tag types, loading them if they haven't been loaded already.
+	def self::types
+        self.load_all unless @types
+        return @types
+	end
+	### Load all available template tags and return them as a Hash keyed by their name.
+	def self::load_all
+		tags = {}
+		Gem.find_files( TAG_PLUGIN_PATTERN ).each do |tagfile|
+			tagname = tagfile[ %r{/(\w+)tag\.rb$}, 1 ].untaint
+			Inversion.log.debug "Loading tag type %p from %p" % [ tagname, tagfile ]
+			self.load( tagfile )
+			# Inversion.log.debug "Looking for class for %p tag" % [ tagname ]
+			tagclass = self.derivatives.find do |derivclass|
+				if derivclass.name.nil? || derivclass.name.empty?
+					# Inversion.log.debug "  skipping anonymous class %p" % [ derivclass ]
+					nil
+				elsif !derivclass.respond_to?( :new )
+					# Inversion.log.debug "  skipping abstract class %p" % [ derivclass ]
+					nil
+				else
+					derivclass.name.downcase =~ /\b#{tagname}tag$/
+				end
+			end
+			unless tagclass
+				Inversion.log.debug "  no class found for %p tag" % [ tagname ]
+				next
+			end
+			Inversion.log.debug "  found: %p" % [ tagclass ]
+			tags[ tagname.to_sym ] = tagclass
+		end
+		@types ||= {}
+		@types.merge!( tags )
+		return @types
+	end
+	### Safely load the specified +tagfile+.
+	def self::load( tagfile )
+		require( tagfile )
+	rescue => err
+		Inversion.log.error "%s while loading tag plugin %p: %s" %
+			[ err.class.name, tagfile, err.message ]
+		Inversion.log.debug "  " + err.backtrace.join( "\n  " )
+		return false
+	end
+	### Create a new Inversion::Template::Tag from the specified +tagname+ and +body+.
+	def self::create( tagname, body, linenum=nil, colnum=nil )
+		tagname =~ /^(\w+)$/i or raise ArgumentError, "invalid tag name %p" % [ tagname ]
+		tagtype = $1.downcase.untaint
+		unless tagclass = self.types[ tagtype.to_sym ]
+			Inversion.log.warn "Unknown tag type %p; registered: %p" %
+				[ tagtype, self.types.keys ]
+			return nil
+		end
+		return tagclass.new( body, linenum, colnum )
+	end
+	########################################################################
+	### I N S T A N C E   M E T H O D S
+	########################################################################
+	### Create a new Inversion::Template::Tag with the specified +body+.
+	def initialize( body, linenum=nil, colnum=nil )
+		super
+		@body = body.to_s.strip
+	end
+	######
+	public
+	######
+	# the body of the tag
+	attr_reader :body
+	### Render the tag as the body of a comment, suitable for template debugging.
+	def as_comment_body
+		return "%s %s at %s" % [ self.tagname, self.body.to_s.dump, self.location ]
+	end
+	### Return the human-readable name of the tag class
+	def tagname
+		return self.class.name.sub(/Tag$/, '').sub( /^.*::/, '' )
+	end
+end # class Inversion::Template::Tag

data/lib/inversion/template/textnode.rb ADDED

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+# vim: set noet nosta sw=4 ts=4 :
+require 'inversion/template/node'
+# Inversion text node class -- static content in templates between tags are contained
+# in a text node.
+class Inversion::Template::TextNode < Inversion::Template::Node
+	include Inversion::Loggable
+	### Create a new TextNode with the specified +source+.
+	def initialize( body, linenum=nil, colnum=nil )
+		@body = body
+		super
+	end
+	######
+	public
+	######
+	# The node body
+	attr_reader :body
+	### Render the node.
+	def render( renderstate )
+		body = self.body.dup
+		body.sub!( /\A\r?\n/, '' ) if renderstate && renderstate.options[:strip_tag_lines]
+		return body
+	end
+	### Render the text node as the body of a comment.
+	def as_comment_body
+		comment_body = self.body[0,40].dump
+		comment_body[-1,0] = '...' unless comment_body == self.body.dump
+		return "Text (%d bytes): %s" % [ self.body.length, comment_body ]
+	end
+end # class Inversion::Template::TextNode

data/lib/inversion/template/unlesstag.rb ADDED

@@ -0,0 +1,60 @@
+#!/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/elsetag'
+# Inversion 'unless' tag.
+#
+# This tag causes a section of the template to be rendered only if its methodchain or attribute
+# is a *false* value.
+#
+# == Syntax
+#
+#   <?unless attr ?>...<?end?>
+#   <?unless obj.method ?>...<?end?>
+#
+class Inversion::Template::UnlessTag < Inversion::Template::AttrTag
+	include Inversion::Loggable,
+	        Inversion::Template::ContainerTag,
+	        Inversion::Template::ConditionalTag
+	# Inherits AttrTag's tag patterns
+	### 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 )
+		self.enable_rendering unless super
+		self.render_subnodes( state )
+		return state
+	end
+	### Render the tag's subnodes according to the tag's logical state.
+	def render_subnodes( renderstate )
+		self.log.debug "Rendering subnodes. Rendering initially %s" %
+			[ self.rendering_enabled? ? "enabled" : "disabled" ]
+		# walk the subtree, modifying the logic flags for else and elsif tags,
+		# and rendering nodes if rendering is enabled
+		self.subnodes.each do |node|
+			if node.is_a?( Inversion::Template::ElseTag )
+				self.log.debug "  logic switch: %p..." % [ node ]
+				if !self.rendering_was_enabled?
+					self.enable_rendering
+				else
+					self.disable_rendering
+				end
+			else
+				renderstate << node if self.rendering_enabled?
+			end
+		end
+	end
+end # class Inversion::Template::UnlessTag

data/lib/inversion/template/uriencodetag.rb ADDED

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# vim: set noet nosta sw=4 ts=4 :
+require 'uri'
+require 'inversion/template/attrtag'
+# Inversion URL encoding tag.
+#
+# This tag is a derivative of the 'attr' tag that encodes the results of its method call
+# according to RFC 3986.
+#
+# == Syntax
+#
+#   <?uriencode foo.bar ?>
+#
+class Inversion::Template::UriencodeTag < Inversion::Template::AttrTag
+	# Unreserved characters from section 2.3 of RFC 3986
+ 	# ALPHA / DIGIT / "-" / "." / "_" / "~"
+	DEFAULT_ENCODED_CHARACTERS = /[^\w\-\.~]/
+	### Render the method chains against the attributes of the specified +render_state+
+	### and return them.
+	def render( render_state )
+		raw = super
+		return URI.encode( raw.to_s, DEFAULT_ENCODED_CHARACTERS )
+	end
+end # class Inversion::Template::UriencodeTag