trenni 3.8.0 → 3.9.0

data/lib/trenni/fallback/template.rl

@@ -67,7 +67,7 @@
 	include template "trenni/template.rl";
 }%%
 
-require_relative '../parse_error'
+require_relative '../error'
 
 module Trenni
 	module Fallback

data/lib/trenni/native.rb

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative 'parse_error'
+require_relative 'error'
 
 # Methods on the following classes may be replaced by native implementations:
 require_relative 'tag'

data/lib/trenni/parsers.rb

@@ -8,6 +8,7 @@ if defined? Trenni::Native
 else
 	require_relative 'fallback/markup'
 	require_relative 'fallback/template'
+	require_relative 'fallback/query'
 	
 	Trenni::Parsers = Trenni::Fallback
 end

data/lib/trenni/query.rb

@@ -0,0 +1,94 @@
+# 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_relative 'buffer'
+
+require 'uri'
+
+module Trenni
+	class Query < Hash
+		def parse(buffer)
+			Parsers.parse_query(buffer, Delegate.new(self))
+		end
+		
+		class Delegate
+			def initialize(top = {})
+				@top = top
+				
+				@current = @top
+				@index = nil
+			end
+			
+			def string(key, encoded)
+				if encoded
+					key = ::URI.decode_www_form_component(key)
+				end
+				
+				index(key.to_sym)
+			end
+			
+			def integer(key)
+				index(key.to_i)
+			end
+			
+			def index(key)
+				if @index
+					@current = @current.fetch(@index) do
+						@current[@index] = {}
+					end
+				end
+				
+				@index = key
+			end
+			
+			def append
+				if @index
+					@current = @current.fetch(@index) do
+						@current[@index] = []
+					end
+				end
+				
+				@index = @current.size
+			end
+			
+			def assign(value, encoded)
+				if encoded
+					value = ::URI.decode_www_form_component(value)
+				end
+				
+				@current[@index] = value
+				
+				@current = @top
+				@index = nil
+			end
+			
+			def pair
+				if @index
+					@current[@index] = true
+				end
+				
+				@current = @top
+				@index = nil
+			end
+		end
+	end
+end

data/lib/trenni/reference.rb

@@ -0,0 +1,125 @@
+# 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_relative 'query'
+
+module Trenni
+	class Reference
+		def initialize(path, query = {}, fragment: nil)
+			@path = path.to_s
+			@query = query
+			@fragment = fragment
+		end
+		
+		# The path component of the URI, e.g. /foo/bar/index.html
+		attr :path
+		
+		# The query parameters.
+		attr :query
+		
+		# A fragment identifier, the part after the '#'
+		attr :fragment
+		
+		def append(buffer)
+			buffer << escape_path(@path)
+			
+			unless @query.empty?
+				buffer << '?' << query_string
+			end
+			
+			if @fragment
+				buffer << '#' << escape(@fragment)
+			end
+			
+			return buffer
+		end
+		
+		def to_str
+			append(String.new)
+		end
+		
+		alias to_s to_str
+		
+		private
+		
+		# According to https://tools.ietf.org/html/rfc3986#section-3.3, we escape non-pchar.
+		NON_PCHAR = /([^
+			a-zA-Z0-9
+			\-\._~
+			!\$&'\(\)\*\+,;=
+			:@\/
+		]+)/x.freeze
+		
+		def escape_path(path)
+			encoding = path.encoding
+			path.b.gsub(NON_PCHAR) do |m|
+				'%' + m.unpack('H2' * m.bytesize).join('%').upcase
+			end.force_encoding(encoding)
+		end
+		
+		# Escapes a generic string, using percent encoding.
+		def escape(string)
+			encoding = string.encoding
+			string.b.gsub(/([^a-zA-Z0-9_.\-]+)/) do |m|
+				'%' + m.unpack('H2' * m.bytesize).join('%').upcase
+			end.force_encoding(encoding)
+		end
+		
+		def query_string
+			build_nested_query(@query)
+		end
+		
+		def build_nested_query(value, prefix = nil)
+			case value
+			when Array
+				value.map { |v|
+					build_nested_query(v, "#{prefix}[]")
+				}.join("&")
+			when Hash
+				value.map { |k, v|
+					build_nested_query(v, prefix ? "#{prefix}[#{escape(k.to_s)}]" : escape(k.to_s))
+				}.reject(&:empty?).join('&')
+			when nil
+				prefix
+			else
+				raise ArgumentError, "value must be a Hash" if prefix.nil?
+				"#{prefix}=#{escape(value.to_s)}"
+			end
+		end
+	end
+	
+	# Generate a URI from a path and user parameters. The path may contain a `#fragment` or `?query=parameters`.
+	def self.Reference(path = '', **parameters)
+		base, fragment = path.split('#', 2)
+		path, query_string = base.split('?', 2)
+		
+		query = Query.new
+		
+		if query_string
+			query.parse(Buffer.new(query_string))
+		end
+		
+		query.update(parameters)
+		
+		Reference.new(path, query, fragment: fragment)
+	end
+end

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/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.9.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/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