inversion 0.0.4 → 0.1.0

data/ChangeLog

@@ -1,8 +1,169 @@
+2011-09-23  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/inversion.rb:
+	Bump minor version for new release.
+	[dbc96c7b052a] [tip]
+
+	* lib/inversion/template.rb, lib/inversion/template/tag.rb,
+	lib/inversion/template/timedeltatag.rb,
+	spec/inversion/template_spec.rb:
+	Added template reloading via Inversion::Template#changed? and
+	#reload.
+	[2abf3629e1dc]
+
+	* lib/inversion/exceptions.rb:
+	Added Inversion::Error and made all exception classes inherit from
+	it.
+	[9827d30cceeb]
+
+2011-09-21  Michael Granger  <ged@FaerieMUD.org>
+
+	* manual/resources/css/manual.css, manual/resources/css/reset.css:
+	Fixing CSS font-face declarations; adding missing reset.css
+	[45f04400b244]
+
+	* .hgtags:
+	Added tag v0.0.4 for changeset 7a412b7ed72b
+	[46bf35f77d74]
+
+	* .hgsigs:
+	Added signature for changeset 3e614ef5c021
+	[7a412b7ed72b] [v0.0.4]
+
+	* .hgtags:
+	Removed tag v0.0.4
+	[3e614ef5c021]
+
+	* Manifest.txt:
+	More manifest updates
+	[906f9d232d80]
+
+	* Manifest.txt:
+	Fixed History path in the Manifest
+	[6d9d4fb86261]
+
+	* .hgtags:
+	Added tag v0.0.4 for changeset 59d9ec43bfda
+	[fd4d1ea02cbc]
+
+	* .hgsigs:
+	Added signature for changeset 27f893edf42a
+	[59d9ec43bfda]
+
+	* History.md, History.rdoc, Rakefile, lib/inversion.rb:
+	Updated History; fixed History name in the Rakefile; Bumped patch
+	version for release.
+	[27f893edf42a]
+
+	* Merged with 1d255d7d60a5
+	[4597a6f63059]
+
+	* lib/inversion/template.rb:
+	Avoid Pathname#expand_path in Inversion::Template.load [profiled]
+	[91cbb0c90b85]
+
+	* Rakefile:
+	Disable the .gemtest task that hoe defines without asking
+	[cf76def7d9cf]
+
+2011-09-16  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/inversion/template/elsiftag.rb:
+	Fix circular require in inversion/template/elsiftag.rb.
+	[1d255d7d60a5]
+
+	* lib/inversion/template/begintag.rb:
+	Fix shadowed variable in BeginTag#handle_exception.
+	[8424ac44da4a]
+
+2011-08-17  Michael Granger  <ged@FaerieMUD.org>
+
+	* manual/resources/css/manual.css:
+	Fixed font path
+	[986a5c14ec18]
+
+	* manual/resources/css/manual.css,
+	manual/resources/fonts/GraublauWeb.otf,
+	manual/resources/fonts/GraublauWebBold.otf, manual/resources/fonts
+	/Muli-Light.ttf, manual/resources/fonts/Muli-Regular.ttf:
+	Manual CSS tweaks
+	[cae91ab725fa]
+
+2011-08-15  Michael Granger  <ged@FaerieMUD.org>
+
+	* manual/lib/api-filter.rb, manual/src/examples.page,
+	manual/src/gettingstarted.page, manual/src/index.page,
+	manual/src/tags.page, manual/src/templates.page:
+	Merged with e0193bdb57db
+	[2e8da6e2f400]
+
+2011-07-30  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgignore, Manual Diagrams.graffle, README.rdoc,
+	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:
+	Adding a manual
+	[e0193bdb57db] [github/master]
+
 2011-08-15  Michael Granger  <ged@FaerieMUD.org>
 
+	* .hgtags:
+	Added tag v0.0.3 for changeset 30fbb9cccd00
+	[e8da683c90ba]
+
+	* .hgsigs:
+	Added signature for changeset f70888949c8c
+	[30fbb9cccd00] [v0.0.3]
+
+	* Rakefile, lib/inversion.rb:
+	Fixed dependency version requirement; bumped patch version.
+	[f70888949c8c]
+
+	* .hgtags:
+	Added tag v0.0.2 for changeset 5477976fd550
+	[1a5c6f90bfaa]
+
+	* .hgsigs:
+	Added signature for changeset 08e77b056c67
+	[5477976fd550] [v0.0.2]
+
+	* lib/inversion.rb:
+	Bump patch version for package-fix release.
+	[08e77b056c67]
+
+	* Manifest.txt:
+	Updated manifest to include all released files.
+	[d62150159d96]
+
 	* .hgtags:
 	Added tag v0.0.1 for changeset 42184d34d45d
-	[e9e43e8d1060] [tip]
+	[e9e43e8d1060]
 
 	* .hgsigs:
 	Added signature for changeset 0bca14d50d50
@@ -292,7 +453,7 @@
 
 	* spec/lib/helpers.rb:
 	Add SimpleCov to the Rakefile.
-	[9d871bbfa95d] [github/master]
+	[9d871bbfa95d]
 
 2011-07-07  Michael Granger  <ged@FaerieMUD.org>
 
@@ -311,6 +472,16 @@
 	* Merged with b822cc9b6ff2
 	[f46b1ff133cd]
 
+2011-07-05  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* lib/inversion/template/pptag.rb, spec/inversion/mixins_spec.rb,
+	spec/inversion/template/pptag_spec.rb:
+	Heh, added the pp tag and mixin spec files back from changeset
+	5d244064e631. Whoops.
+	[b822cc9b6ff2]
+
+2011-07-06  Michael Granger  <ged@FaerieMUD.org>
+
 	* .hgignore, README.md, Rakefile, lib/inversion.rb,
 	lib/inversion/monkeypatches.rb, lib/inversion/renderstate.rb,
 	lib/inversion/template.rb, lib/inversion/template/attrtag.rb,
@@ -367,14 +538,6 @@
 	- Add SimpleCov coverage ()
 	[4d7a94c4cf02]
 
-2011-07-05  Mahlon E. Smith  <mahlon@martini.nu>
-
-	* lib/inversion/template/pptag.rb, spec/inversion/mixins_spec.rb,
-	spec/inversion/template/pptag_spec.rb:
-	Heh, added the pp tag and mixin spec files back from changeset
-	5d244064e631. Whoops.
-	[b822cc9b6ff2]
-
 2011-07-05  Michael Granger  <ged@FaerieMUD.org>
 
 	* Rakefile, lib/inversion/sinatra.rb, lib/inversion/tilt.rb,
@@ -762,6 +925,14 @@
 	Merged with dc16cc877dfc, updated README
 	[0fdf3122bf7c]
 
+	* README.md, experiments/erb_scope_bleed.rb:
+	Fleshing out the README, adding scope-bleedover example
+	[f44b597af8bd]
+
+	* lib/inversion.rb:
+	Removing checked-in revision value
+	[773feca505b8]
+
 2011-04-06  Michael Granger  <ged@FaerieMUD.org>
 
 	* .irbrc, Rakefile, experiments/ripper_spike.rb, lib/inversion.rb,
@@ -790,10 +961,6 @@
 	* Merging with b50fef00621b
 	[861b21a30656]
 
-	* lib/inversion.rb:
-	Clearing Revision tag
-	[cdacb5f98f93]
-
 2011-02-07  Mahlon E. Smith  <mahlon@martini.nu>
 
 	* lib/inversion/template.rb, lib/inversion/template/attr_tag.rb,
@@ -804,15 +971,11 @@
 	Checkpoint, fleshing out Tags.
 	[4a4fc3f1dc14]
 
-2011-04-12  Michael Granger  <ged@FaerieMUD.org>
-
-	* README.md, experiments/erb_scope_bleed.rb:
-	Fleshing out the README, adding scope-bleedover example
-	[f44b597af8bd]
+2011-03-18  Michael Granger  <ged@FaerieMUD.org>
 
 	* lib/inversion.rb:
-	Removing checked-in revision value
-	[773feca505b8]
+	Clearing Revision tag
+	[cdacb5f98f93]
 
 2011-02-07  Mahlon E. Smith  <mahlon@martini.nu>
 

data/History.rdoc

@@ -1,3 +1,9 @@
+== v0.1.0 [2011-09-23] Michael Granger <ged@FaerieMUD.org>
+
+- Added template reloading via Inversion::Template#changed?
+  and #reload.
+
+
 == v0.0.4 [2011-09-21] Michael Granger <ged@FaerieMUD.org>
 
 - Avoid Pathname#expand_path in Inversion::Template.load

data/lib/inversion.rb

@@ -26,10 +26,10 @@ module Inversion
 	require 'inversion/monkeypatches'
 
 	# Library version constant
-	VERSION = '0.0.4'
+	VERSION = '0.1.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 27f893edf42a $
+	REVISION = %q$Revision: dbc96c7b052a $
 
 	#
 	# Logging

data/lib/inversion/exceptions.rb

@@ -4,17 +4,20 @@
 #--
 module Inversion
 
+	# A generic Inversion exception class
+	class Error < ::RuntimeError; end
+
 	# An exception class raised from the Inversion::Template::Parser when
 	# a problem is encountered while parsing a template.
-	class ParseError < ::RuntimeError; end
+	class ParseError < Inversion::Error; end
 
 	# An exception class raised when a problem is detected in a template
 	# configuration option.
-	class OptionsError < ::RuntimeError; end
+	class OptionsError < Inversion::Error; end
 
 	# An exception class raised when a template includes itself, either
 	# directly or indirectly.
-	class StackError < ::RuntimeError; end
+	class StackError < Inversion::Error; end
 
 end # module Inversion
 

data/lib/inversion/template.rb

@@ -76,7 +76,7 @@ class Inversion::Template
 
 		tmpl = nil
 		path = Pathname( path )
-		template_paths = self.config[:template_paths] + [ Dir.pwd ]
+		template_paths = Array( self.config[:template_paths] ) + [ Dir.pwd ]
 
 		# Unrestricted template location.
 		if path.absolute?
@@ -117,35 +117,56 @@ class Inversion::Template
 
 		@source       = source
 		@parser       = Inversion::Template::Parser.new( self, opts )
-		@node_tree    = []
-		@options      = self.class.config.merge( opts )
-
+		@node_tree    = [] # Parser expects this to always be an Array
+		@init_options = opts
+		@options      = nil
 		@attributes   = {}
 		@source_file  = nil
+		@created_at   = Time.now
 
-		# Now parse the template source into a tree of nodes and pre-generate accessors
-		# for any attributes defined by them
-		@node_tree = @parser.parse( source, parsestate )
-		self.define_attribute_accessors
+		self.parse( source, parsestate )
 	end
 
 
-
 	######
 	public
 	######
 
+	# The raw template source from which the object was parsed.
 	attr_reader :source
 
+	# The Pathname of the file the source was read from
 	attr_accessor :source_file
 
+	# The Hash of template attributes
 	attr_reader :attributes
 
+	# The Template's configuration options hash
 	attr_reader :options
 
+	# The node tree parsed from the template source
 	attr_reader :node_tree
 
 
+	### If the template was loaded from a file, reload and reparse it from the same file.
+	def reload
+		file = self.source_file or
+			raise Inversion::Error, "template was not loaded from a file" 
+
+		self.log.debug "Reloading from %s" % [ file ]
+		source = file.read
+		self.parse( source )
+	end
+
+
+	### Returns +true+ if the template was loaded from a file and the file's mtime
+	### is after the time the template was created.
+	def changed?
+		return false unless file = self.source_file
+		return ( file.mtime > @created_at )
+	end
+
+
 	### Render the template, optionally passing a render state (if, for example, the
 	### template is being rendered inside another template).
 	def render( parentstate=nil, &block )
@@ -197,6 +218,17 @@ class Inversion::Template
 	end
 
 
+	### Parse the given +source+ into the template node tree.
+	def parse( source, parsestate=nil )
+		@options = self.class.config.merge( @init_options )
+		@attributes.clear
+		@node_tree = @parser.parse( source, parsestate )
+		@source = source
+
+		self.define_attribute_accessors
+	end
+
+
 	### Walk the template's node tree, yielding each node in turn to the given block.
 	def walk_tree( nodes=@node_tree, &block )
 		nodes.each do |node|

data/lib/inversion/template/tag.rb

@@ -17,6 +17,7 @@ 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'
 

data/lib/inversion/template/timedeltatag.rb

@@ -19,12 +19,14 @@ require 'inversion/template/attrtag'
 class Inversion::Template::TimeDeltaTag < Inversion::Template::AttrTag
 
 	# Approximate Time Constants (in seconds)
-	MINUTES = 60
-	HOURS   = 60  * MINUTES
-	DAYS    = 24  * HOURS
-	WEEKS   = 7   * DAYS
-	MONTHS  = 30  * DAYS
-	YEARS   = 365.25 * DAYS
+	unless defined?( MINUTES )
+		MINUTES = 60
+		HOURS   = 60  * MINUTES
+		DAYS    = 24  * HOURS
+		WEEKS   = 7   * DAYS
+		MONTHS  = 30  * DAYS
+		YEARS   = 365.25 * DAYS
+	end
 
 
 	######

data/spec/inversion/template_spec.rb

@@ -34,13 +34,6 @@ describe Inversion::Template do
 		Inversion::Template.new( "a template" ).to_s.should == 'a template'
 	end
 
-	it "untaints template content loaded from a file" do
-		content = 'file contents'.taint
-		IO.should_receive( :read ).with( '/tmp/hooowat' ).and_return( content )
-
-		Inversion::Template.load( '/tmp/hooowat' ).source.should_not be_tainted()
-	end
-
 	it "calls before and after rendering hooks on all of its nodes when rendered" do
 		node = double( "fake node" )
 		parentstate = Inversion::RenderState.new( :foo => 'the merged stuff' )
@@ -84,6 +77,73 @@ describe Inversion::Template do
 	end
 
 
+	context "loaded from a file" do
+
+		before( :each ) do
+			@timestamp = Time.now
+			content = 'file contents'.taint
+			IO.should_receive( :read ).with( '/tmp/hooowat' ).and_return( content )
+			@template = Inversion::Template.load( '/tmp/hooowat' )
+		end
+
+
+		it "untaints template content loaded from a file" do
+			@template.source.should_not be_tainted()
+		end
+
+		it "can be reloaded" do
+			newcontent = 'changed file contents'.taint
+			IO.should_receive( :read ).with( '/tmp/hooowat' ).and_return( newcontent )
+			@template.reload
+			@template.source.should == newcontent
+		end
+
+		context "that hasn't changed since it was loaded" do
+
+			before( :each ) do
+				@template.source_file.stub!( :mtime ).and_return( @timestamp )
+			end
+
+			it "knows that it hasn't changed" do
+				@template.should_not be_changed()
+			end
+		end
+
+		context "that has changed since it was loaded" do
+
+			before( :each ) do
+				@template.source_file.stub!( :mtime ).and_return( @timestamp + 1 )
+			end
+
+			it "knows that is has changed" do
+				@template.should be_changed()
+			end
+
+		end
+
+	end
+
+
+	context "loaded from a String" do
+
+		before( :each ) do
+			@template = Inversion::Template.new( 'some stuff' )
+		end
+
+		it "never says it has changed" do
+			@template.should_not be_changed()
+		end
+
+		it "raises an exception if reloaded" do
+			expect {
+				@template.reload
+			}.to raise_error( Inversion::Error, /not loaded from a file/i )
+		end
+
+	end
+
+
+
 	context "without template paths set" do
 
 		before( :each ) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inversion
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -49,11 +49,11 @@ cert_chain:
   -----END CERTIFICATE-----
 
 '
-date: 2011-09-22 00:00:00.000000000Z
+date: 2011-09-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hoe-mercurial
-  requirement: &70167586903860 !ruby/object:Gem::Requirement
+  requirement: &2153364080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -61,21 +61,21 @@ dependencies:
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *70167586903860
+  version_requirements: *2153364080
 - !ruby/object:Gem::Dependency
   name: hoe-manualgen
-  requirement: &70167587027660 !ruby/object:Gem::Requirement
+  requirement: &2153363380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.1.1
   type: :development
   prerelease: false
-  version_requirements: *70167587027660
+  version_requirements: *2153363380
 - !ruby/object:Gem::Dependency
   name: hoe-highline
-  requirement: &70167587148600 !ruby/object:Gem::Requirement
+  requirement: &2153362780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -83,10 +83,10 @@ dependencies:
         version: 0.0.1
   type: :development
   prerelease: false
-  version_requirements: *70167587148600
+  version_requirements: *2153362780
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70167587148140 !ruby/object:Gem::Requirement
+  requirement: &2153362080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -94,10 +94,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70167587148140
+  version_requirements: *2153362080
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70167587147720 !ruby/object:Gem::Requirement
+  requirement: &2153350520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -105,10 +105,10 @@ dependencies:
         version: 1.3.2
   type: :development
   prerelease: false
-  version_requirements: *70167587147720
+  version_requirements: *2153350520
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70167587147300 !ruby/object:Gem::Requirement
+  requirement: &2153349840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -116,10 +116,10 @@ dependencies:
         version: 1.2.6
   type: :development
   prerelease: false
-  version_requirements: *70167587147300
+  version_requirements: *2153349840
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70167587146880 !ruby/object:Gem::Requirement
+  requirement: &2153349080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -127,10 +127,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *70167587146880
+  version_requirements: *2153349080
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70167587146460 !ruby/object:Gem::Requirement
+  requirement: &2153348500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -138,10 +138,10 @@ dependencies:
         version: 0.4.2
   type: :development
   prerelease: false
-  version_requirements: *70167587146460
+  version_requirements: *2153348500
 - !ruby/object:Gem::Dependency
   name: hoe-manualgen
-  requirement: &70167587146040 !ruby/object:Gem::Requirement
+  requirement: &2153347960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -149,10 +149,10 @@ dependencies:
         version: 0.2.0
   type: :development
   prerelease: false
-  version_requirements: *70167587146040
+  version_requirements: *2153347960
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &70167587145620 !ruby/object:Gem::Requirement
+  requirement: &2153347420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -160,10 +160,10 @@ dependencies:
         version: 1.16.2
   type: :development
   prerelease: false
-  version_requirements: *70167587145620
+  version_requirements: *2153347420
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &70167587145200 !ruby/object:Gem::Requirement
+  requirement: &2153346780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -171,10 +171,10 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *70167587145200
+  version_requirements: *2153346780
 - !ruby/object:Gem::Dependency
   name: sysexits
-  requirement: &70167587144780 !ruby/object:Gem::Requirement
+  requirement: &2153346060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -182,10 +182,10 @@ dependencies:
         version: 1.0.2
   type: :development
   prerelease: false
-  version_requirements: *70167587144780
+  version_requirements: *2153346060
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &70167587144360 !ruby/object:Gem::Requirement
+  requirement: &2153345500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -193,7 +193,7 @@ dependencies:
         version: '2.12'
   type: :development
   prerelease: false
-  version_requirements: *70167587144360
+  version_requirements: *2153345500
 description: ! 'Inversion is a templating system for Ruby. It uses the "Inversion
   of Control" principle to decouple