trenni 3.8.0 → 3.13.0

data/lib/trenni/strings.rb

@@ -30,7 +30,11 @@ module Trenni
 		end
 
 		def self.to_quoted_string(string)
-			'"' + string.gsub('"', '\\"').gsub(/\r/, "\\r").gsub(/\n/, "\\n") + '"'
+			string = string.gsub('"', '\\"')
+			string.gsub!(/\r/, "\\r")
+			string.gsub!(/\n/, "\\n")
+			
+			return "\"#{string}\""
 		end
 		
 		# `value` must already be escaped.
@@ -43,11 +47,18 @@ module Trenni
 		end
 		
 		def self.to_title(string)
-			string.gsub(/(^|[ \-_])(.)/){" " + $2.upcase}.strip
+			string = string.gsub(/(^|[ \-_])(.)/){" " + $2.upcase}
+			string.strip!
+			
+			return string
 		end
-
+		
 		def self.to_snake(string)
-			string.gsub("::", "").gsub(/([A-Z]+)/){"_" + $1.downcase}.sub(/^_+/, "")
+			string = string.gsub("::", "")
+			string.gsub!(/([A-Z]+)/){"_" + $1.downcase}
+			string.sub!(/^_+/, "")
+			
+			return string
 		end
 	end
 end

data/lib/trenni/template.rb

@@ -29,36 +29,27 @@ module Trenni
 	BINDING = binding
 	
 	class Builder
-		def >> block
-			if block
-				Template.buffer(block.binding) << self
-				return nil
-			else
-				return self
-			end
-		end
-		
-		def capture(*args, &block)
-			self.append Template.capture(*args, &block)
+		def capture(*arguments, &block)
+			Template.capture(*arguments, output: self, &block)
 		end
 	end
 	
 	class Template
 		# Returns the output produced by calling the given block.
-		def self.capture(*args, &block)
+		def self.capture(*arguments, output: nil, &block)
 			scope = block.binding
-			output_buffer = scope.local_variable_get(OUT)
+			previous_output = scope.local_variable_get(OUT)
 			
-			capture_buffer = String.new.force_encoding(output_buffer.encoding)
-			scope.local_variable_set(OUT, capture_buffer)
+			output ||= previous_output.class.new(encoding: previous_output.encoding)
+			scope.local_variable_set(OUT, output)
 			
 			begin
-				block.call(*args)
+				block.call(*arguments)
 			ensure
-				scope.local_variable_set(OUT, output_buffer)
+				scope.local_variable_set(OUT, previous_output)
 			end
 			
-			return capture_buffer
+			return output
 		end
 		
 		# Returns the buffer used for capturing output.
@@ -125,7 +116,7 @@ module Trenni
 		end
 		
 		def to_proc(scope = @binding.dup)
-			@compiled_proc ||= eval("\# frozen_string_literals: true\nproc{|#{OUT}|;#{code}}", scope, @buffer.path, 0).freeze
+			@compiled_proc ||= eval("\# frozen_string_literal: true\nproc{|#{OUT}|;#{code}}", scope, @buffer.path, 0).freeze
 		end
 		
 		protected
@@ -154,9 +145,19 @@ module Trenni
 	class MarkupTemplate < Template
 		class Assembler < Template::Assembler
 			# Output a string interpolation.
-			def expression(text)
-				@code << "Trenni::Markup.append(#{OUT},(#{text}));"
+			def expression(code)
+				@code << "#{OUT}<<(#{code});"
 			end
+			
+			# Output raw text to the template.
+			def text(text)
+				text = text.gsub("'", "\\\\'")
+				@code << "#{OUT}.raw('#{text}');"
+			end
+		end
+		
+		def to_string(scope = Object.new, output = nil)
+			super.output
 		end
 		
 		protected
@@ -168,7 +169,7 @@ module Trenni
 		
 		# The output of the markup template is encoded markup (e.g. with entities, tags, etc).
 		def output_buffer
-			MarkupString.new.force_encoding(code.encoding)
+			Builder.new(encoding: code.encoding)
 		end
 	end
 end

data/lib/trenni/uri.rb

@@ -21,6 +21,7 @@
 # THE SOFTWARE.
 
 module Trenni
+	# This class is superceeded by `Trenni::Reference`.
 	class URI
 		def initialize(path, query_string, fragment, parameters)
 			@path = path

data/lib/trenni/version.rb

@@ -21,5 +21,5 @@
 # THE SOFTWARE.
 
 module Trenni
-	VERSION = "3.8.0"
+	VERSION = "3.13.0"
 end

data/parsers/trenni/query.rl

@@ -0,0 +1,23 @@
+%%{
+	machine query;
+	
+	# An application/x-www-form-urlencoded parser based on the definition by WhatWG.
+	# Based on https://url.spec.whatwg.org/#application/x-www-form-urlencoded
+	pchar = any - [&=\[\]%+];
+	echar = pchar | ('+' | '%' xdigit xdigit) >encoded;
+	
+	integer = ([0-9]+) >integer_begin %integer_end;
+	string = (echar+ - integer) >string_begin %string_end;
+	
+	value = (echar*) >value_begin %value_end;
+	
+	index = string (
+		'[' (integer | string) ']'
+	)* ('[]' %append)?;
+	
+	pair = (
+		index ('=' value)?
+	) %pair;
+	
+	main := ((pair '&')* pair)?;
+}%%

data/spec/trenni/builder_spec.rb

@@ -21,22 +21,34 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'trenni'
+require 'trenni/builder'
 
-module Trenni::BuilderSpec
-	describe 'Trenni::Builder#tag' do
-		subject {Trenni::Builder.new}
-		
-		it "should format nested attributes" do
-			subject.tag('div', data: {id: 10})
-			
-			expect(subject.output).to be == '<div data-id="10"/>'
+RSpec.describe Trenni::Builder do
+	it "should produce valid html" do
+		subject.doctype
+		subject.tag('html') do
+			subject.tag('head') do
+				subject.inline('title') do
+					subject.text('Hello World')
+				end
+			end
+			subject.tag('body') do
+			end
 		end
+		
+		expect(subject.output).to be == <<~HTML.chomp
+		<!DOCTYPE html>
+		<html>
+			<head>
+				<title>Hello World</title>
+			</head>
+			<body>
+			</body>
+		</html>
+		HTML
 	end
 	
-	describe 'Trenni::Builder#fragment' do
-		let(:builder) {Trenni::Builder.new}
-		
+	describe '.fragment' do
 		it "should use an existing builder" do
 			result = Trenni::Builder.fragment do |builder|
 			end
@@ -47,49 +59,59 @@ module Trenni::BuilderSpec
 		it "should use an existing builder" do
 			expect(Trenni::Builder).to receive(:new).and_call_original
 			
-			result = Trenni::Builder.fragment(builder) do |builder|
+			result = Trenni::Builder.fragment(subject) do |builder|
 			end
 			
-			expect(result).to_not be_nil
+			expect(result).to be_nil
 		end
 	end
 	
-	describe Trenni::Builder do
-		it 'should be able to append nil' do
-			expect{subject.append(nil)}.to_not raise_error
-		end
-		
-		it 'should append existing markup' do
-			subject.tag("outer") do
-				subject.append("<inner>\n\t<nested/>\n</inner>")
-			end
-			
-			expect(subject.output).to be == "<outer>\n\t<inner>\n\t\t<nested/>\n\t</inner>\n</outer>"
-		end
-		
-		it "should produce valid html" do
-			subject.doctype
-			subject.tag('html') do
-				subject.tag('head') do
-					subject.inline('title') do
-						subject.text('Hello World')
-					end
-				end
-				subject.tag('body') do
-				end
-			end
+	describe '#tag' do
+		it "should format nested attributes" do
+			subject.tag('div', data: {id: 10})
 			
-			expect(subject.output).to be == "<!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>"
+			expect(subject.output).to be == '<div data-id="10"/>'
 		end
 		
 		it "should indent self-closing tag correctly" do
 			builder = Trenni::Builder.new
 			
-			builder.tag('foo') { builder.tag('bar') }
+			builder.tag('foo') {builder.tag('bar')}
 			
-			expect(builder.output).to be == "<foo>\n\t<bar/>\n</foo>"
+			expect(builder.output).to be == <<~HTML.chomp
+			<foo>
+				<bar/>
+			</foo>
+			HTML
+		end
+		
+		it "should support compact attributes" do
+			subject.tag :option, :required => true
+			expect(subject.output).to be == %Q{<option required/>}
 		end
 		
+		it "should output without changing escaped characters" do
+			subject.tag "section", :'data-text' => 'foo\nbar'
+			expect(subject.output).to be == '<section data-text="foo\nbar"/>'
+		end
+		
+		it "should order array attributes as specified" do
+			subject.tag :t, [[:a, 10], [:b, 20]]
+			expect(subject.output).to be == %Q{<t a="10" b="20"/>}
+		end
+		
+		it "should order hash attributes as specified" do
+			subject.tag :t, :b => 20, :a => 10
+			expect(subject.output).to be == %Q{<t b="20" a="10"/>}
+		end
+		
+		it "shouldn't output attributes with nil value" do
+			subject.tag :t, [[:a, 10], [:b, nil]]
+			expect(subject.output).to be == %Q{<t a="10"/>}
+		end
+	end
+	
+	describe '#inline' do
 		it "should produce inline html" do
 			subject.inline("div") do
 				subject.tag("strong") do
@@ -102,6 +124,20 @@ module Trenni::BuilderSpec
 			expect(subject.output).to be == "<div><strong>Hello</strong>World!</div>"
 		end
 		
+		it "can inline fragments" do
+			subject.inline! do
+				subject.inline('a') do
+					subject << "Hello"
+				end
+				
+				subject.inline('a') do
+					subject << "World"
+				end
+			end
+			
+			expect(subject.output).to be == "<a>Hello</a><a>World</a>"
+		end
+		
 		it "escapes attributes and text correctly" do
 			subject.inline :foo, :bar => %Q{"Hello World"} do
 				subject.text %Q{if x < 10}
@@ -109,30 +145,37 @@ module Trenni::BuilderSpec
 			
 			expect(subject.output).to be == %Q{<foo bar="&quot;Hello World&quot;">if x &lt; 10</foo>}
 		end
-		
-		it "should support compact attributes" do
-			subject.tag :option, :required => true
-			expect(subject.output).to be == %Q{<option required/>}
-		end
-		
-		it "should output without changing escaped characters" do
-			subject.tag "section", :'data-text' => 'foo\nbar'
-			expect(subject.output).to be == '<section data-text="foo\nbar"/>'
+	end
+	
+	describe '#<<' do
+		it 'can append text' do
+			subject << 'text'
+			expect(subject.output).to be == "text"
 		end
 		
-		it "should order array attributes as specified" do
-			subject.tag :t, [[:a, 10], [:b, 20]]
-			expect(subject.output).to be == %Q{<t a="10" b="20"/>}
+		it "doesn't append nil" do
+			subject << nil
+			expect(subject.output).to be == ""
 		end
-		
-		it "should order hash attributes as specified" do
-			subject.tag :t, :b => 20, :a => 10
-			expect(subject.output).to be == %Q{<t b="20" a="10"/>}
+	end
+	
+	describe '#append' do
+		it 'should be able to append nil' do
+			expect{subject.append(nil)}.to_not raise_error
 		end
 		
-		it "shouldn't output attributes with nil value" do
-			subject.tag :t, [[:a, 10], [:b, nil]]
-			expect(subject.output).to be == %Q{<t a="10"/>}
+		it 'should append existing markup' do
+			subject.tag("outer") do
+				subject.append("<inner>\n\t<nested/>\n</inner>")
+			end
+			
+			expect(subject.output).to be == <<~HTML.chomp
+			<outer>
+				<inner>
+					<nested/>
+				</inner>
+			</outer>
+			HTML
 		end
 	end
 end

data/spec/trenni/markup_performance_spec.rb

@@ -9,13 +9,25 @@ RSpec.describe Trenni::Markup do
 	
 	it "should be fast to parse large documents" do
 		Benchmark.ips do |x|
-			x.report("General String") do |times|
+			x.report("CGI.escapeHTML(general_string)") do |times|
+				while (times -= 1) >= 0
+					CGI.escapeHTML(general_string)
+				end
+			end
+			
+			x.report("CGI.escapeHTML(code_string)") do |times|
+				while (times -= 1) >= 0
+					CGI.escapeHTML(code_string)
+				end
+			end
+			
+			x.report("Trenni::Markup.escape_string(general_string)") do |times|
 				while (times -= 1) >= 0
 					Trenni::Markup.escape_string(general_string)
 				end
 			end
 			
-			x.report("Code String") do |times|
+			x.report("Trenni::Markup.escape_string(code_string)") do |times|
 				while (times -= 1) >= 0
 					Trenni::Markup.escape_string(code_string)
 				end

data/spec/trenni/parsers_performance_spec.rb

@@ -4,6 +4,9 @@ require 'benchmark/ips'
 require 'trenni/parsers'
 require 'trenni/entities'
 
+require 'trenni/query'
+require 'rack/utils'
+
 require 'nokogiri'
 
 RSpec.describe Trenni::Parsers do
@@ -71,4 +74,32 @@ RSpec.describe Trenni::Parsers do
 			end
 		end
 	end
+	
+	describe '#parse_query' do
+		let(:string) {"foo=hi%20there&bar[blah]=123&bar[quux][0]=1&bar[quux][1]=2&bar[quux][2]=3"}
+		
+		it "should be fast to parse large query strings" do
+			# query = Trenni::Query.new
+			# query.parse(Trenni::Buffer.new string)
+			# pp query
+			# 
+			# pp Rack::Utils.parse_nested_query(string)
+			
+			Benchmark.ips do |x|
+				x.report("Large (Trenni)") do |times|
+					while (times -= 1) >= 0
+						Trenni::Query.new.parse(Trenni::Buffer.new string)
+					end
+				end
+				
+				x.report("Large (Rack)") do |times|
+					while (times -= 1) >= 0
+						Rack::Utils.parse_nested_query(string)
+					end
+				end
+				
+				x.compare!
+			end
+		end
+	end
 end

data/spec/trenni/query_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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 'trenni/query'
+
+RSpec.describe Trenni::Query do
+	def parse(string)
+		subject.parse(Trenni::Buffer.new(string))
+		
+		return subject
+	end
+	
+	it "can parse query string with integer key" do
+		expect(parse "q[0]=0").to be == {q: {0 => "0"}}
+	end
+	
+	it "can parse query string with mixed integer/string key" do
+		expect(parse "q[2d]=3d").to be == {q: {:'2d' => "3d"}}
+	end
+	
+	it "can parse query string appending items to array" do
+		expect(parse "q[]=a&q[]=b").to be == {q: ["a", "b"]}
+	end
+	
+	it "can decode encoded keys" do
+		expect(parse "hello+world=true").to be == {:"hello world" => "true"}
+	end
+	
+	it "can decode encoded values" do
+		expect(parse "message=hello+world").to be == {message: "hello world"}
+	end
+end