trenni 1.0.1 → 1.0.2

data/lib/trenni/builder.rb

@@ -18,6 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'trenni/strings'
+
 module Trenni
 	
 	INSTRUCT_ATTRIBUTES = [
@@ -26,22 +28,41 @@ module Trenni
 	].freeze
 	
 	class Builder
+		INDENT = "\t"
+		
+		# A helper to generate fragments of markup.
+		def self.fragment(builder = nil, &block)
+			if builder
+				yield builder
+				
+				return nil
+			else
+				builder = Builder.new
+				
+				yield builder
+				
+				return builder.output.string
+			end
+		end
+		
 		def initialize(options = {})
+			@strict = options[:strict]
+			
 			@output = options[:output] || StringIO.new
+			@indentation = options[:indentation] || INDENT
+			@indent = options.fetch(:indent, true)
 			
-			@options = options
+			@escape = options[:escape]
 			
 			@level = [0]
 			@children = [0]
 		end
 		
-		def indent?
-			@options[:indent] != nil
-		end
+		attr :output
 		
-		def indent
-			if indent?
-				@options[:indent] * (@level.size - 1)
+		def indentation
+			if @indent
+				@indentation * (@level.size - 1)
 			else
 				''
 			end
@@ -70,58 +91,52 @@ module Trenni
 			@output.puts "<!DOCTYPE#{text}>"
 		end
 		
+		# Begin a block tag.
 		def tag(name, attributes = {}, &block)
-			if block_given?
-				@output.puts if indent? and @level.last > 0
-				@output.write indent + "<#{name}#{tag_attributes(attributes)}>"
-				@output.puts if indent?
-				
-				@level[@level.size-1] += 1
-				
-				@level << 0
-				yield self
-				@level.pop
-				
-				@output.puts if indent?
-				@output.write indent + "</#{name}>"
-			else
-				@output.write indent + "<#{name}#{tag_attributes(attributes)}/>"
+			full_tag(name, attributes, @indent, @indent, &block)
+		end
+		
+		# Begin an inline tag.
+		def inline(name, attributes = {}, &block)
+			indent = @indent
+			
+			full_tag(name, attributes, @indent, false) do
+				@indent = false
+				yield
+				@indent = indent
 			end
 		end
 		
 		def text(data)
-			if indent?
-				data.split(/\n/).each_with_index do |line, i|
+			append to_html(data)
+		end
+		
+		# Append pre-existing markup:
+		def append(data)
+			# The parent has one more child:
+			@level[-1] += 1
+			
+			if @indent
+				lines = data.strip.split(/\n/)
+				
+				lines.each_with_index do |line, i|
 					@output.puts if i > 0
-					@output.write indent + line
+					@output.write indentation + line
 				end
 			else
 				@output.write data
 			end
 		end
 		
-		def options(options)
-			saved_options = @options
-			@options = options
-			
-			yield
-			
-			@options = saved_options
-		end
-		
-		def tag_attributes(attributes)
-			self.class.tag_attributes(attributes, @options[:strict])
-		end
-		
 		# Convert a set of attributes into a string suitable for use within a <tag>.
-		def self.tag_attributes(attributes, strict = false)
+		def tag_attributes(attributes)
 			buffer = []
 			
 			attributes.each do |key, value|
 				if value == true
-					buffer << (strict ? "#{key}=\"#{key}\"" : key)
+					buffer << Strings::to_simple_attribute(key, @strict)
 				elsif value
-					buffer << "#{key}=\"#{value.to_s.gsub('"', '&quot;')}\""
+					buffer << Strings::to_attribute(key, to_html(value))
 				end
 			end
 			
@@ -131,6 +146,43 @@ module Trenni
 				return ''
 			end
 		end
+		
+		protected
+		
+		def to_html(data)
+			@escape ? Strings::to_html(data) : data
+		end
+		
+		# A normal block level/container tag.
+		def full_tag(name, attributes, indent_outer, indent_inner, &block)
+			if block_given?
+				if indent_outer
+					@output.puts if @level.last > 0
+					@output.write indentation
+				end
+				
+				@output.write "<#{name}#{tag_attributes(attributes)}>"
+				@output.puts if indent_inner
+				
+				# The parent has one more child:
+				@level[-1] += 1
+				
+				@level << 0
+				
+				yield
+				
+				children = @level.pop
+				
+				if indent_inner
+					@output.puts if children > 0
+					@output.write indentation
+				end
+				
+				@output.write "</#{name}>"
+			else
+				@output.write indentation + "<#{name}#{tag_attributes(attributes)}/>"
+			end
+		end
 	end
 	
 end

data/lib/trenni/strings.rb

@@ -0,0 +1,32 @@
+
+module Trenni
+	module Strings
+		HTML_ESCAPE = {"&" => "&amp;", "<" => "&lt;", ">" => "&gt;", "\"" => "&quot;"}
+		HTML_ESCAPE_PATTERN = Regexp.new("[" + Regexp.quote(HTML_ESCAPE.keys.join) + "]")
+
+		def self.to_html(string)
+			string.gsub(HTML_ESCAPE_PATTERN){|c| HTML_ESCAPE[c]}
+		end
+
+		def self.to_quoted_string(string)
+			'"' + string.gsub('"', '\\"').gsub(/\r/, "\\r").gsub(/\n/, "\\n") + '"'
+		end
+		
+		# `value` must already be escaped.
+		def self.to_attribute(key, value)
+			%Q{#{key}="#{value}"}
+		end
+		
+		def self.to_simple_attribute(key, strict)
+			strict ? %Q{#{key}="#{key}"} : key.to_s
+		end
+		
+		def self.to_title(string)
+			string.gsub(/(^|[ \-_])(.)/){" " + $2.upcase}.strip
+		end
+
+		def self.to_snake(string)
+			string.gsub("::", "").gsub(/([A-Z]+)/){"_" + $1.downcase}.sub(/^_+/, "")
+		end
+	end
+end

data/lib/trenni/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Trenni
-	VERSION = "1.0.1"
+	VERSION = "1.0.2"
 end

data/test/test_builder.rb

@@ -27,54 +27,79 @@ require 'digest/md5'
 
 require 'trenni'
 
-class BuilderTest < Test::Unit::TestCase
+class TestBuilder < Test::Unit::TestCase
 	def test_tags
-		output = StringIO.new
-		
-		builder = Trenni::Builder.new(:output => output)
+		builder = Trenni::Builder.new(:indent => false)
 
 		builder.instruct
 		builder.tag('foo', 'bar' => 'baz') do
 			builder.text("apples and oranges")
 		end
 		
-		assert_equal "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<foo bar=\"baz\">apples and oranges</foo>", output.string
+		assert_equal "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<foo bar=\"baz\">apples and oranges</foo>", builder.output.string
 	end
 	
-	def test_html
-		output = StringIO.new
+	def test_full_html
+		builder = Trenni::Builder.new(:indent => true)
 		
-		builder = Trenni::Builder.new(:output => output, :indent => "\t")
-		builder.options(:indent => "\t") do
-			builder.doctype
-			builder.tag('html') do
-				builder.tag('head') do
-					builder.tag('title') do
-						builder.text('Hello World')
-					end
-				end
-				builder.tag('body') do
+		builder.doctype
+		builder.tag('html') do
+			builder.tag('head') do
+				builder.inline('title') do
+					builder.text('Hello World')
 				end
 			end
+			builder.tag('body') do
+			end
 		end
 		
-		assert_equal "<!DOCTYPE html>\n<html>\n\t<head>\n\t\t<title>\n\t\t\tHello World\n\t\t</title>\n\t</head>\n\t<body>\n\n\t</body>\n</html>", output.string
+		assert_equal "<!DOCTYPE html>\n<html>\n\t<head>\n\t\t<title>Hello World</title>\n\t</head>\n\t<body>\n\t</body>\n</html>", builder.output.string
 	end
 	
-	def test_attributes
-		# Non-strict output (e.g. HTML)
-		text = Trenni::Builder.tag_attributes({:required => true})
-		assert_equal " required", text
+	def test_inline_html
+		builder = Trenni::Builder.new(:indent => true)
 		
-		# Strict output (e.g. XML)
-		text = Trenni::Builder.tag_attributes({:required => true}, true)
-		assert_equal " required=\"required\"", text
+		builder.inline("div") do
+			builder.tag("strong") do
+				builder.text("Hello")
+			end
+			
+			builder.text "World!"
+		end
 		
-		text = Trenni::Builder.tag_attributes({:required => false})
-		assert_equal "", text
+		assert_equal "<div><strong>Hello</strong>World!</div>", builder.output.string
+	end
+	
+	def test_indentation
+		builder = Trenni::Builder.new(:indent => "\t")
 		
-		# Check the order is correct
-		text = Trenni::Builder.tag_attributes([[:a, 10], [:b, 20]])
-		assert_equal " a=\"10\" b=\"20\"", text
+		puts builder.output.string
+	end
+	
+	def test_escaping
+		builder = Trenni::Builder.new(:escape => true)
+		builder.inline :foo, :bar => %Q{"Hello World"} do
+			builder.text %Q{if x < 10}
+		end
+		
+		assert_equal %Q{<foo bar="&quot;Hello World&quot;">if x &lt; 10</foo>}, builder.output.string
+	end
+	
+	def test_attributes_strict
+		builder = Trenni::Builder.new(:strict => true)
+		builder.tag :option, :required => true
+		assert_equal %Q{<option required="required"/>}, builder.output.string
+	end
+	
+	def test_attributes_compact
+		builder = Trenni::Builder.new(:strict => false)
+		builder.tag :option, :required => true
+		assert_equal %Q{<option required/>}, builder.output.string
+	end
+	
+	def test_attributes_order
+		builder = Trenni::Builder.new(:strict => true)
+		builder.tag :t, [[:a, 10], [:b, 20]]
+		assert_equal %Q{<t a="10" b="20"/>}, builder.output.string
 	end
 end

data/test/test_strings.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2007, 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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 OR COPYRIGHT HOLDERS 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.
+
+require 'pathname'
+require 'test/unit'
+require 'stringio'
+
+require 'trenni/strings'
+
+class TestStrings < Test::Unit::TestCase
+	def test_to_html
+		text = Trenni::Strings.to_html("<foobar>")
+		assert_equal "&lt;foobar&gt;", text
+		
+		text = Trenni::Strings.to_html(%q{"I'd like to do this & that :p", she said.})
+		assert_equal %q{&quot;I'd like to do this &amp; that :p&quot;, she said.}, text
+	end
+
+	def test_to_quoted_string
+		text = Trenni::Strings.to_quoted_string(%Q{"Hello World"})
+		assert_equal %q{"\"Hello World\""}, text
+		
+		text = Trenni::Strings.to_quoted_string(%Q{"Hello\r\nWorld"})
+		assert_equal %q{"\"Hello\r\nWorld\""}, text
+	end
+		
+	def test_to_attribute
+		text = Trenni::Strings.to_attribute(:foo, 'bar')
+		assert_equal %Q{foo="bar"}, text
+		
+		text = Trenni::Strings.to_simple_attribute(:foo, false)
+		assert_equal %Q{foo}, text
+		
+		text = Trenni::Strings.to_simple_attribute(:foo, true)
+		assert_equal %Q{foo="foo"}, text
+	end
+		
+	def self.to_simple_attribute
+		strict ? %Q{#{key}="#{key}"} : key.to_s
+	end
+		
+	def test_to_title
+		text = Trenni::Strings.to_title("foo bar")
+		assert_equal "Foo Bar", text
+	end
+
+	def test_to_snake
+		text = Trenni::Strings.to_snake("Happy::Go::Lucky")
+		assert_equal "happy_go_lucky", text
+	end
+end

data/test/test_template.rb

@@ -26,7 +26,7 @@ require 'stringio'
 
 require 'trenni'
 
-class TemplateTest < Test::Unit::TestCase
+class TestTemplate < Test::Unit::TestCase
 	def test_template_each
 		template = Trenni::Template.new('<?r items.each do |item| ?>#{item}<?r end ?>')
 		

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trenni
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -28,9 +28,11 @@ files:
 - Rakefile
 - lib/trenni.rb
 - lib/trenni/builder.rb
+- lib/trenni/strings.rb
 - lib/trenni/template.rb
 - lib/trenni/version.rb
 - test/test_builder.rb
+- test/test_strings.rb
 - test/test_template.rb
 - trenni.gemspec
 homepage: https://github.com/ioquatix/trenni
@@ -47,7 +49,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1799901624385534337
+      hash: -2578082460541813883
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -56,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1799901624385534337
+      hash: -2578082460541813883
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -65,4 +67,5 @@ specification_version: 3
 summary: A fast native templating system that compiles directly to Ruby code.
 test_files:
 - test/test_builder.rb
+- test/test_strings.rb
 - test/test_template.rb