trenni 3.7.1 → 3.12.0

data/lib/trenni/strings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -28,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.
@@ -41,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/tag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/trenni/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -27,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.
@@ -123,7 +116,7 @@ module Trenni
 		end
 		
 		def to_proc(scope = @binding.dup)
-			@compiled_proc ||= eval("proc{|#{OUT}|;#{code}}", scope, @buffer.path).freeze
+			@compiled_proc ||= eval("\# frozen_string_literal: true\nproc{|#{OUT}|;#{code}}", scope, @buffer.path, 0).freeze
 		end
 		
 		protected
@@ -152,11 +145,21 @@ 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
 		
 		# We need an assembler which builds specific `Markup.append` sequences.
@@ -166,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -19,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -19,5 +21,5 @@
 # THE SOFTWARE.
 
 module Trenni
-	VERSION = "3.7.1"
+	VERSION = "3.12.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/spec_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'covered/rspec'
 require 'trenni'

data/spec/trenni/builder_spec.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
 
 # Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
@@ -49,11 +50,23 @@ module Trenni::BuilderSpec
 			result = Trenni::Builder.fragment(builder) do |builder|
 			end
 			
-			expect(result).to_not be_nil
+			expect(result).to be_nil
 		end
 	end
 	
 	describe Trenni::Builder do
+		describe '#<<' do
+			it 'can append text' do
+				subject << 'text'
+				expect(subject.output).to be == "text"
+			end
+			
+			it "doesn't append nil" do
+				subject << nil
+				expect(subject.output).to be == ""
+			end
+		end
+		
 		it 'should be able to append nil' do
 			expect{subject.append(nil)}.to_not raise_error
 		end

data/spec/trenni/corpus/large.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 [
 	[:instruction, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"],
 	[:text, "\n"],

data/spec/trenni/markup_parser_spec.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 

data/spec/trenni/markup_performance_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'benchmark/ips'
 require 'trenni/markup'
@@ -8,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/markup_spec.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
 
 # Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 

data/spec/trenni/parsers_performance_spec.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
 
 require 'benchmark/ips'
 require 'trenni/parsers'
 require 'trenni/entities'
 
+require 'trenni/query'
+require 'rack/utils'
+
 require 'nokogiri'
 
 RSpec.describe Trenni::Parsers do
@@ -70,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

data/spec/trenni/reference_spec.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright, 2012, 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/reference'
+
+RSpec.describe Trenni::Reference do
+	describe Trenni::Reference('path with spaces/image.jpg') do
+		it "encodes whitespace" do
+			expect(subject.to_s).to be == "path%20with%20spaces/image.jpg"
+		end
+	end
+	
+	describe Trenni::Reference('path', array: [1, 2, 3]) do
+		it "encodes array" do
+			expect(subject.to_s).to be == "path?array[]=1&array[]=2&array[]=3"
+		end
+	end
+	
+	describe Trenni::Reference('path_with_underscores/image.jpg') do
+		it "doesn't touch underscores" do
+			expect(subject.to_s).to be == "path_with_underscores/image.jpg"
+		end
+	end
+	
+	describe Trenni::Reference('index', :'my name' => 'Bob Dole') do
+		it "encodes query" do
+			expect(subject.to_s).to be == "index?my%20name=Bob%20Dole"
+		end
+	end
+	
+	describe Trenni::Reference('index#All Your Base') do
+		it "encodes fragment" do
+			expect(subject.to_s).to be == "index\#All%20Your%20Base"
+		end
+	end
+	
+	describe Trenni::Reference('I/❤️/UNICODE', face: '😀') do
+		it "encodes unicode" do
+			expect(subject.to_s).to be == "I/%E2%9D%A4%EF%B8%8F/UNICODE?face=%F0%9F%98%80"
+		end
+	end
+	
+	it "can be an attribute" do
+		tag = Trenni::Tag.closed('img', src: Trenni::Reference('image.jpg', x: 10))
+		
+		expect(tag.to_s).to be == '<img src="image.jpg?x=10"/>'
+	end
+	
+	describe Trenni::Reference("foo?bar=10&baz=20", yes: 'no') do
+		it "can use existing query parameters" do
+			expect(subject.to_s).to be == "foo?bar=10&baz=20&yes=no"
+		end
+	end
+	
+	describe Trenni::Reference("foo?yes=yes", yes: 'no') do
+		it "overrides existing parameters" do
+			expect(subject.to_s).to be == "foo?yes=no"
+		end
+	end
+	
+	describe Trenni::Reference('foo#frag') do
+		it "can use existing fragment" do
+			expect(subject.fragment).to be == "frag"
+			expect(subject.to_s).to be == 'foo#frag'
+		end
+	end
+end