trenni 3.0.4 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 678975501ff1d7219ad2c2fae3f3fab031d05544
-  data.tar.gz: 2142c44dbdda88baed7670cfe398673f0b3181b4
+  metadata.gz: 1ca1689a6184db9df2773f6d3b4b6211ed558f1a
+  data.tar.gz: 97d4dc5f0e2fa4f7f165519bc8f3c86c8e36c822
 SHA512:
-  metadata.gz: 4c3eb22887267903a78c77bb436dbe04869b6967bc241c91c2e8d3f55d4b9efac3cabf6ed1323c775e83f2a4227890464c92e7ed9534aeb278d9e10b8b5eedf8
-  data.tar.gz: 0bfcfcae5eada6e53c0e3f9ac2272fef413f5f703a33cd5bcfe7dac71354972f94a06a9ded4e68669655cfb28c04c1eb2b2750ed0a5c5ce55ffe5a60160cef03
+  metadata.gz: c57c4f0c3463d35c0d73142be0451ea2243901fc67801d36f9dded3acc1118a85104be7138da3a442028e267333099772d2f867e6517ab0c6abb47acf731dc2a
+  data.tar.gz: 1b84a6d7d545ac7fc8de48c203f8d8cd1ab8652ce422f6c8da1e754d2d67023db807e96d2c236926ad34d88b4cf1f938c5a60ca498daf3a3f1c27b305f7d6ccc

data/README.md

@@ -172,6 +172,111 @@ To test the native C parsers:
 
 	rake generate_native_parsers && rake compile && rspec
 
+### Benchmarks
+
+Trenni has a pure Ruby implemenation, with performance critical operations implemented natively. All critical code paths have benchmark specs.
+
+#### Parser Performance
+
+You can evaluate and compare template performance with ERB:
+
+```
+rspec spec/trenni/parsers_performance_spec.rb
+
+Trenni::Native
+  #parse_markup
+Warming up --------------------------------------
+      Large (Trenni)    64.000  i/100ms
+    Large (Nokogiri)    30.000  i/100ms
+Calculating -------------------------------------
+      Large (Trenni)    637.720  (± 6.4%) i/s -      3.200k in   5.038187s
+    Large (Nokogiri)    294.762  (± 5.8%) i/s -      1.470k in   5.004284s
+
+Comparison:
+      Large (Trenni):      637.7 i/s
+    Large (Nokogiri):      294.8 i/s - 2.16x  slower
+
+    should be fast to parse large documents
+  #parse_template
+Warming up --------------------------------------
+      Large (Trenni)     7.791k i/100ms
+         Large (ERB)   488.000  i/100ms
+Calculating -------------------------------------
+      Large (Trenni)     87.889k (± 9.5%) i/s -    436.296k in   5.024283s
+         Large (ERB)      4.844k (± 5.6%) i/s -     24.400k in   5.053247s
+
+Comparison:
+      Large (Trenni):    87889.4 i/s
+         Large (ERB):     4844.5 i/s - 18.14x  slower
+
+    should have better performance using instance
+
+Finished in 28.2 seconds (files took 0.14204 seconds to load)
+2 examples, 0 failures
+```
+
+To run this with the pure ruby implementation, use `TRENNI_PREFER_FALLBACK=y rspec spec/trenni/parsers_performance_spec.rb`.
+
+#### Markup String Performance
+
+Markup safe strings require escaping characters. Doing this natively makes sense, and in MRI, `CGI.escape_html` is implemented in C. Strings that include characters that need to be escaped are a bit slower because a new string must be allocated and modified. So, we test these two cases.
+
+```
+rspec spec/trenni/markup_performance_spec.rb 
+
+Trenni::Markup
+Warming up --------------------------------------
+      General String   179.396k i/100ms
+         Code String    85.050k i/100ms
+Calculating -------------------------------------
+      General String      4.773M (±10.0%) i/s -     23.680M in   5.027576s
+         Code String      1.469M (± 5.7%) i/s -      7.399M in   5.052467s
+
+Comparison:
+      General String:  4773201.3 i/s
+         Code String:  1469345.5 i/s - 3.25x  slower
+
+  should be fast to parse large documents
+
+Finished in 14.11 seconds (files took 0.09696 seconds to load)
+1 example, 0 failures
+```
+
+#### Template Evaluation Performance
+
+Evaluating templates and generating output is critical to performance. You can compare Trenni with ERB. The primary factor affecting performance, is the number of interpolations, because each interpolation requires evaluation and concatenation.
+
+```
+rspec spec/trenni/template_performance_spec.rb 
+
+Trenni::Template
+Warming up --------------------------------------
+              Trenni    79.000  i/100ms
+Calculating -------------------------------------
+              Trenni    817.703  (± 7.7%) i/s -      4.108k in   5.071586s
+  should be fast for lots of interpolations
+Warming up --------------------------------------
+     Trenni (object)    79.149k i/100ms
+       ERB (binding)     5.416k i/100ms
+Calculating -------------------------------------
+     Trenni (object)      1.081M (± 3.7%) i/s -      5.461M in   5.059151s
+       ERB (binding)     59.016k (± 4.7%) i/s -    297.880k in   5.058614s
+
+Comparison:
+     Trenni (object):  1080909.2 i/s
+       ERB (binding):    59016.3 i/s - 18.32x  slower
+
+  should be fast for basic templates
+Warming up --------------------------------------
+              Trenni    34.204k i/100ms
+Calculating -------------------------------------
+              Trenni    407.905k (± 9.0%) i/s -      2.018M in   5.001248s
+  should be fast with capture
+
+Finished in 28.25 seconds (files took 0.09765 seconds to load)
+3 examples, 0 failures
+```
+
 ## Contributing
 
 1. Fork it

data/lib/trenni/uri.rb

@@ -0,0 +1,85 @@
+# Copyright, 2017, 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.
+
+module Trenni
+	class URI
+		def initialize(base, fragment, query)
+			@base = base
+			@fragment = fragment
+			@query = query
+		end
+		
+		attr :base
+		attr :fragment
+		attr :query
+		
+		def append(buffer)
+			buffer << escape_path(@base)
+			
+			if @query&.any?
+				buffer << query_separator << query_part
+			end
+			
+			if @fragment
+				buffer << '#' << escape(@fragment)
+			end
+			
+			return buffer
+		end
+		
+		def to_str
+			append(String.new)
+		end
+		
+		alias to_s to_str
+		
+		private
+		
+		# Escapes a path string, using percent encoding, but additionally ignoring "/" and substituting spaces with "+".
+		def escape_path(path)
+			encoding = path.encoding
+			path.b.gsub(/([^ a-zA-Z0-9_.\-\/:]+)/) do |m|
+				'%' + m.unpack('H2' * m.bytesize).join('%').upcase
+			end.tr(' ', '+').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_part
+			@query.map{|k,v| "#{escape(k.to_s)}=#{escape(v.to_s)}"}.join('&')
+		end
+		
+		def query_separator
+			@base.include?('?') ? '&' : '?'
+		end
+	end
+	
+	def self.URI(path = '', query = nil)
+		base, fragment = path.split('#', 2)
+		
+		URI.new(base, fragment, query)
+	end
+end

data/lib/trenni/version.rb

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

data/spec/trenni/parsers_performance_spec.rb

@@ -8,34 +8,66 @@ require 'nokogiri'
 RSpec.describe Trenni::Parsers do
 	# include_context "profile"
 	
-	let(:xhtml_path) {File.expand_path('corpus/large.xhtml', __dir__)}
-	let(:xhtml_buffer) {Trenni::FileBuffer.new(xhtml_path)}
-	let(:entities) {Trenni::Entities::HTML5}
-	
-	it "should be fast to parse large documents" do
-		Benchmark.ips do |x|
-			x.report("Large (Trenni)") do |times|
-				delegate = Trenni::ParseDelegate.new
+	describe '#parse_markup' do
+		let(:xhtml_path) {File.expand_path('corpus/large.xhtml', __dir__)}
+		let(:xhtml_buffer) {Trenni::FileBuffer.new(xhtml_path)}
+		let(:entities) {Trenni::Entities::HTML5}
+		
+		it "should be fast to parse large documents" do
+			Benchmark.ips do |x|
+				x.report("Large (Trenni)") do |times|
+					delegate = Trenni::ParseDelegate.new
+					
+					while (times -= 1) >= 0
+						Trenni::Parsers.parse_markup(xhtml_buffer, delegate, entities)
+						
+						delegate.events.clear
+					end
+				end
 				
-				while (times -= 1) >= 0
-					Trenni::Parsers.parse_markup(xhtml_buffer, delegate, entities)
+				x.report("Large (Nokogiri)") do |times|
+					delegate = Trenni::ParseDelegate.new
+					parser = Nokogiri::HTML::SAX::Parser.new(delegate)
 					
-					delegate.events.clear
+					while (times -= 1) >= 0
+						parser.parse(xhtml_buffer.read)
+						
+						delegate.events.clear
+					end
 				end
-			end
-			
-			x.report("Large (Nokogiri)") do |times|
-				delegate = Trenni::ParseDelegate.new
-				parser = Nokogiri::HTML::SAX::Parser.new(delegate)
 				
-				while (times -= 1) >= 0
-					parser.parse(xhtml_buffer.read)
+				x.compare!
+			end
+		end
+	end
+	
+	describe '#parse_template' do
+		let(:large_trenni_path) {File.expand_path('template_spec/large.trenni', __dir__)}
+		let(:trenni_buffer) {Trenni::FileBuffer.new(large_trenni_path)}
+		
+		let(:large_erb_path) {File.expand_path('template_spec/large.erb', __dir__)}
+		let(:erb_buffer) {Trenni::FileBuffer.new(large_erb_path)}
+		
+		it "should be fast to parse large templates" do
+			Benchmark.ips do |x|
+				x.report("Large (Trenni)") do |times|
+					delegate = Trenni::ParseDelegate.new
 					
-					delegate.events.clear
+					while (times -= 1) >= 0
+						Trenni::Parsers.parse_template(trenni_buffer, delegate)
+						
+						delegate.events.clear
+					end
 				end
+				
+				x.report("Large (ERB)") do |times|
+					while (times -= 1) >= 0
+						ERB.new(erb_buffer.read)
+					end
+				end
+				
+				x.compare!
 			end
-			
-			x.compare!
 		end
 	end
-end
+end

data/spec/trenni/template_spec/large.erb

@@ -0,0 +1,16 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent gravida, turpis id bibendum bibendum, ipsum diam vestibulum arcu, sit amet tempor ipsum lorem non urna. Suspendisse nec nisl a risus laoreet lacinia ac sit amet neque. Mauris vel turpis semper massa bibendum viverra. Curabitur vel felis est. Donec sed faucibus augue, ac molestie purus. Nulla a lectus dui. Quisque id scelerisque urna. Aenean in vehicula nibh, in aliquam turpis. <%='Suspendisse'%> iaculis suscipit lectus in efficitur. Nulla facilisi. Fusce facilisis, justo ac eleifend convallis, ligula est bibendum risus, a consequat metus sapien eget mauris. Sed quis mollis tellus, sed tempor lacus. Proin et efficitur metus. Vestibulum blandit tellus sed turpis tincidunt, in aliquet augue bibendum. Suspendisse venenatis faucibus lectus sed convallis.
+
+<%='Curabitur'%> aliquet ligula et volutpat efficitur. Duis sed tortor elit. Quisque justo eros, maximus quis elit sed, accumsan faucibus lectus. Nulla blandit quam urna, ac bibendum turpis semper quis. Proin a ligula eu eros semper condimentum. Ut pellentesque, justo sed malesuada condimentum, est massa tempor turpis, id facilisis neque odio eu neque. Morbi convallis laoreet tortor, ut dapibus mi accumsan a. Proin convallis neque sed leo blandit lacinia. Phasellus porta odio nunc, quis placerat sem facilisis quis. Quisque et <%='ornare'%> elit. Duis efficitur cursus lectus vitae placerat. In lacinia eros nec feugiat finibus.
+
+Morbi orci magna, tempor at convallis sed, porta elementum nulla. Aliquam sit amet fringilla felis, eget volutpat lorem. Pellentesque laoreet, elit quis fringilla ultricies, leo nisl semper mauris, ac feugiat libero tortor id urna. Praesent ligula augue, mollis nec justo vitae, faucibus posuere risus. Praesent blandit molestie ex eu fringilla. Ut non vehicula mauris. Aliquam gravida rutrum laoreet. Pellentesque facilisis mi ipsum, ac dapibus mi iaculis nec.
+
+Vestibulum sit amet nibh velit. Sed rhoncus odio ut nisi blandit vestibulum. Aliquam erat volutpat. Suspendisse sed posuere ligula. Proin ex ex, pharetra vel dui vulputate, pellentesque ullamcorper metus. Cras imperdiet dictum lorem. Nullam eleifend nunc eu metus ullamcorper dignissim. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean sit amet sem sed enim rutrum volutpat a non libero.
+
+<% 10.downto(1) do |i| -%>
+	<%=i%> bottle<%=i == 1 ? '' : 's'%> of beer on the wall,
+	<%=i%> bottle<%=i == 1 ? '' : 's'%> of beer,
+	Take one down and pass it around,
+	<%=i-1%> bottle<%=i == 1 ? '' : 's'%> of beer on the wall.
+<% end -%>
+
+Integer in ligula at ex gravida pellentesque in et felis. Nulla dolor sapien, pretium a odio a, consectetur ultrices justo. Suspendisse libero quam, pulvinar eu est non, fermentum volutpat nisl. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Cras at dapibus lorem, nec imperdiet quam. Proin ut tellus sagittis, sollicitudin elit ac, porttitor diam. Quisque at hendrerit lacus, sit amet mollis lacus.

data/spec/trenni/uri_spec.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+# 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/uri'
+
+RSpec.describe Trenni::URI do
+	describe Trenni::URI('path with spaces/image.jpg') do
+		it "encodes whitespace" do
+			expect(subject.to_s).to be == "path+with+spaces/image.jpg"
+		end
+	end
+	
+	describe Trenni::URI('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::URI('index#All Your Base') do
+		it "encodes fragment" do
+			expect(subject.to_s).to be == "index\#All%20Your%20Base"
+		end
+	end
+	
+	describe Trenni::URI('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::URI('image.jpg', x: 10))
+		
+		expect(tag.to_s).to be == '<img src="image.jpg?x=10"/>'
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trenni
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.1.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2017-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -119,6 +119,7 @@ files:
 - lib/trenni/strings.rb
 - lib/trenni/tag.rb
 - lib/trenni/template.rb
+- lib/trenni/uri.rb
 - lib/trenni/version.rb
 - parsers/trenni/entities.rl
 - parsers/trenni/markup.rl
@@ -142,9 +143,11 @@ files:
 - spec/trenni/template_spec/error.trenni
 - spec/trenni/template_spec/escaped.trenni
 - spec/trenni/template_spec/interpolations.trenni
+- spec/trenni/template_spec/large.erb
 - spec/trenni/template_spec/large.trenni
 - spec/trenni/template_spec/lines.trenni
 - spec/trenni/template_spec/nested.trenni
+- spec/trenni/uri_spec.rb
 - tasks/entities.rake
 - tasks/parsers.rake
 - trenni.gemspec
@@ -191,6 +194,8 @@ test_files:
 - spec/trenni/template_spec/error.trenni
 - spec/trenni/template_spec/escaped.trenni
 - spec/trenni/template_spec/interpolations.trenni
+- spec/trenni/template_spec/large.erb
 - spec/trenni/template_spec/large.trenni
 - spec/trenni/template_spec/lines.trenni
 - spec/trenni/template_spec/nested.trenni
+- spec/trenni/uri_spec.rb