inversion 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddedafd07e49192ced4ff5ad6cde6e4652665133
-  data.tar.gz: 1e3f6a0aaec50744c52103d3f4fccdbd2d6ca0f0
+  metadata.gz: 4983f0e8917f4a40d760bc7f77214c2732d04bcb
+  data.tar.gz: 5fd44317d690978ea3ebca07c9a6fcd4b3623ee5
 SHA512:
-  metadata.gz: 38b0a7a2abcffe7c3efdd9cd69d3c5e06f86fc58d26ecc4361fcea753881d392bf661bbc04d7d37d591e7cf0b970a8756892d59cad15a1f2b80a3ba73fc01474
-  data.tar.gz: 9ba61dbd363fab4f4339378f1062d7341c39ce39f2ab7609c08ee4bb2399fc34008e1750b20ea4ca0f7b8754031d475e0d201518acb7b5c0f8e1d8385196a1ec
+  metadata.gz: a6d6826555de328206231211b8d193fffe41854375c39eb25cf3dfb342d3412634c1e6de4d8dd850038246bee93e1ebc6a35cdd1f92ca18093baf87b00109ef6
+  data.tar.gz: 22eb288a86e2852b67ef94c097d9ecfc3ce26e85fb1ee58eeb964d1af481659a360856ddcc5a87a2e98f7faa1157bab1efa62b9b95a686ccb06022fcb309b408

data/History.rdoc

@@ -1,3 +1,8 @@
+== v0.15.0 [2014-11-24] Michael Granger <ged@FaerieMUD.org>
+
+Add a mechanism to allow tags to extend the template.
+
+
 == v0.14.0 [2014-11-05] Michael Granger <ged@FaerieMUD.org>
 
 - Add the fragment tag and docs

data/Rakefile

@@ -1,5 +1,6 @@
 #!/usr/bin/env rake
 
+require 'rake/clean'
 require 'rdoc/task'
 
 begin
@@ -8,6 +9,8 @@ rescue LoadError
 	abort "This Rakefile requires hoe (gem install hoe)"
 end
 
+GEMSPEC = 'inversion.gemspec'
+
 Hoe.plugin :mercurial
 Hoe.plugin :signing
 Hoe.plugin :manualgen
@@ -62,12 +65,29 @@ task :coverage do
 end
 
 
-Rake::Task[ 'docs' ].clear
-RDoc::Task.new( 'docs' ) do |rdoc|
+# Use the fivefish formatter for docs generated from development checkout
+if File.directory?( '.hg' )
+	require 'rdoc/task'
+
+	Rake::Task[ 'docs' ].clear
+	RDoc::Task.new( 'docs' ) do |rdoc|
 	rdoc.main = "README.rdoc"
 	rdoc.rdoc_files.include( "*.rdoc", "ChangeLog", "lib/**/*.rb" )
 	rdoc.generator = :fivefish
 	rdoc.rdoc_dir = 'doc'
+	end
 end
 
+task :gemspec => GEMSPEC
+file GEMSPEC => __FILE__
+task GEMSPEC do |task|
+	spec = $hoespec.spec
+	spec.files.delete( '.gemtest' )
+	spec.version = "#{spec.version}.pre#{Time.now.strftime("%Y%m%d%H%M%S")}"
+	File.open( task.name, 'w' ) do |fh|
+		fh.write( spec.to_ruby )
+	end
+end
 
+CLOBBER.include( GEMSPEC.to_s )
+task :default => :gemspec

data/Tags.rdoc

@@ -1,6 +1,6 @@
 = Built-In Tags
 
-Inversion's tags support the Pluggability[http://rubygems.org/gems/pluggability] API, allowing for the easy addition of {custom tags}[@Custom+Tags], but it comes with a number of built-in ones too.
+Inversion's tags support the Pluggability[http://rubygems.org/gems/pluggability] API, allowing for the easy addition of {custom tags}[#label-Custom+Tags], but it comes with a number of built-in ones too.
 
 
 == Tag Syntax
@@ -27,7 +27,7 @@ These tags work as you'd expect from their ruby counterparts.
 The +begin+ 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+ sections, and the
 first 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 (see options[Templates@Template+Options]).
+is handled by the configured exception behavior for the template (see Inversion::Template@Template+Options).
 
   <?begin ?><?call employees.length ?><?end?>
   
@@ -559,3 +559,26 @@ The output is escaped according to the current setting of the {:escape_format}[r
    ctime=2011-08-12 08:43:15 -0700 (1313163795)&gt;</div>
   </div>
 
+
+== Custom Tags
+
+We have a lot of documentation work to do for this still, but the basics are:
+
+* Create a file with the path <code>lib/inversion/template/«yourtagnametag».rb/code>
+
+* Name your class Inversion::Template::«yourtagname.capitalize»Tag
+
+* Subclass one of the abstract template tag types:
+
+  * If your tag body will contain code, subclass Inversion::Template::CodeTag
+
+  * Otherwise, subclass Inversion::Template::Tag
+
+* If your tag is a container, include Inversion::Template::ContainerTag
+
+* Read the documentation for the tag type you're subclassing for the methods you're
+  required to implement. 
+
+Unfortunately, the tag superclasses aren't currently documented very well, so
+the best way to accomplish what you want is to find an existing tag that does
+something similar and look at how it does it.

data/lib/inversion/template/tag.rb

@@ -66,7 +66,7 @@ class Inversion::Template::Tag < Inversion::Template::Node
 		tags = {}
 
 		Gem.find_files( TAG_PLUGIN_PATTERN ).each do |tagfile|
-			tagname = tagfile[ %r{/(\w+)tag\.rb$}, 1 ].untaint
+			tagname = tagfile[ %r{/(\w+?)_?tag\.rb$}, 1 ].untaint
 			next unless tagname
 
 			self.load( tagfile )

data/lib/inversion/template.rb

@@ -202,6 +202,56 @@ class Inversion::Template
 	end
 
 
+	### Add one or more extension +modules+ to Inversion::Template. This allows tags to decorate
+	### the template class with new functionality.
+	###
+	### Each one of the given +modules+ will be included as a mixin, and if it also
+	### contains a constant called ClassMethods and/or PrependedMethods, it will
+	### also be extended/prepended (respectively) with it.
+	###
+	### == Example
+	###
+	### Add a layout attribute to templates from a 'layout' tag:
+	###
+	###   class Inversion::Template::LayoutTag < Inversion::Tag
+	###
+	###     module TemplateExtension
+	###
+	###       def layout
+	###         return @layout || 'default.tmpl'
+	###       end
+	###
+	###       module PrependedMethods
+	###         def initialize( * )
+	###           super
+	###           @layout = nil
+	###         end
+	###     end
+	###
+	###     Inversion::Template.add_extensions( TemplateExtension )
+	###
+	###     # ... more tag stuff
+	###
+	###   end
+	###
+	def self::add_extensions( *modules )
+		self.log.info "Adding extensions to %p: %p" % [ self, modules ]
+
+		modules.each do |mod|
+			include( mod )
+			if mod.const_defined?( :ClassMethods )
+				submod = mod.const_get( :ClassMethods )
+				extend( submod )
+			end
+			if mod.const_defined?( :PrependedMethods )
+				submod = mod.const_get( :PrependedMethods )
+				prepend( submod )
+			end
+		end
+
+	end
+
+
 	### Create a new Inversion:Template with the given +source+.
 	def initialize( source, parsestate=nil, opts={} )
 		if parsestate.is_a?( Hash )

data/lib/inversion.rb

@@ -26,10 +26,10 @@ module Inversion
 	warn ">>> Inversion requires Ruby 1.9.2 or later. <<<" if RUBY_VERSION < '1.9.2'
 
 	# Library version constant
-	VERSION = '0.14.0'
+	VERSION = '0.15.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 9bb165feaf57 $
+	REVISION = %q$Revision: 7db3ff80c8e1 $
 
 
 	### Get the Inversion version.

data/spec/inversion/template_spec.rb

@@ -120,6 +120,47 @@ describe Inversion::Template do
 	end
 
 
+	it "can be extended at runtime via an extension module" do
+		extension_mod = Module.new do
+			def some_extension_stuff
+				return :extension_stuff
+			end
+		end
+
+		described_class.add_extensions( extension_mod )
+
+		expect( described_class.new('a template').some_extension_stuff ).to eq( :extension_stuff )
+	end
+
+
+	it "can be extended at runtime with class methods via a ClassMethods submodule" do
+		extension_mod = Module.new do
+			module ClassMethods
+				def some_class_extension_stuff; :class_extension_stuff; end
+			end
+		end
+
+		described_class.add_extensions( extension_mod )
+
+		expect( described_class.some_class_extension_stuff ).to eq( :class_extension_stuff )
+	end
+
+
+	it "can override methods at runtime with a PrependedMethods submodule" do
+		extension_mod = Module.new do
+			def a_method; :original_a_method; end
+
+			module PrependedMethods
+				def a_method; :extension_a_method; end
+			end
+		end
+
+		described_class.add_extensions( extension_mod )
+
+		expect( described_class.new('a template').a_method ).to eq( :extension_a_method )
+	end
+
+
 	context "loaded from a file" do
 
 		before( :each ) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inversion
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Michael Granger
@@ -31,230 +31,230 @@ cert_chain:
   c7ZKPJcWBv0sm81+FCZXNACn2f9jfF8OQinxVs0O052KbGuEQaaiGIYeuuwQE2q6
   ggcrPfcYeTwWlfZPu2LrBg==
   -----END CERTIFICATE-----
-date: 2014-11-05 00:00:00.000000000 Z
+date: 2014-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
 - !ruby/object:Gem::Dependency
   name: hoe-mercurial
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
   name: hoe-manualgen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: hoe-deveiate
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
   name: hoe-highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: hoe-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: sysexits
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rdoc-generator-fivefish
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.13'
 description: |-
@@ -277,7 +277,7 @@ extra_rdoc_files:
 - README.rdoc
 - Tags.rdoc
 files:
-- .gemtest
+- ".gemtest"
 - ChangeLog
 - Examples.rdoc
 - GettingStarted.rdoc
@@ -370,23 +370,23 @@ licenses:
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --main
+- "--main"
 - README.rdoc
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Inversion is a templating system for Ruby