trenni 1.7.0 → 2.0.1

data/spec/trenni/template_spec.rb

@@ -20,78 +20,104 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'trenni'
+require 'trenni/template'
+require 'trenni/parsers'
 require 'benchmark'
 
-# require 'ruby-prof'
+RSpec.describe Trenni::Template do
+	let(:template_path) {File.expand_path('corpus/large.xhtml', __dir__)}
+	let(:template) {Trenni::Template.load_file template_path}
+	let(:output) {template.to_string}
+	
+	it "should parse xhtml template and produce identical output" do
+		expect{output}.to_not raise_error
+		expect(output).to be == File.read(template_path)
+	end
+end
 
-module Trenni::TemplateSpec
-	describe Trenni::Template do
-		let(:capture_template) {Trenni::Template.load_file File.expand_path('template_spec/capture.trenni', __dir__)}
-		
-		it "should be able to capture output" do
-			expect(capture_template.to_string.strip).to be == 'TEST TEST TEST'
-		end
-		
-		let(:buffer_template) {Trenni::Template.load_file File.expand_path('template_spec/buffer.trenni', __dir__)}
-		
-		it "should be able to fetch output buffer" do
-			expect(buffer_template.to_string).to be == 'test'
-		end
-		
-		let(:nested_template) {Trenni::Template.load_file File.expand_path('template_spec/nested.trenni', __dir__)}
+RSpec.describe Trenni::Template do
+	let(:capture_template) {Trenni::Template.load_file File.expand_path('template_spec/capture.trenni', __dir__)}
+	
+	it "should be able to capture output" do
+		expect(capture_template.to_string).to be == '"TEST TEST TEST\n"'
+	end
+	
+	it "compiled template should match line numbers" do
+		code_lines = capture_template.send(:code).lines
 		
-		it "should be able to handle nested interpolations" do
-			expect(nested_template.to_string).to be == "Hello world!"
-		end
+		expect(code_lines.count).to be == 4
+		expect(code_lines[3]).to include("inspect")
+	end
+	
+	let(:buffer_template) {Trenni::Template.load_file File.expand_path('template_spec/buffer.trenni', __dir__)}
+	
+	it "should be able to fetch output buffer" do
+		expect(buffer_template.to_string).to be == 'test'
+	end
+	
+	let(:nested_template) {Trenni::Template.load_file File.expand_path('template_spec/nested.trenni', __dir__)}
+	
+	it "should be able to handle nested interpolations" do
+		expect(nested_template.to_string).to be == "Hello world!"
+	end
+	
+	let(:items) {1..4}
+	
+	it "should process list of items" do
+		buffer = Trenni::Buffer.new('<?r items.each do |item| ?>#{item}<?r end ?>')
+		template = Trenni::Template.new(buffer)
 		
-		it "should process list of items" do
-			buffer = Trenni::Buffer.new('<?r items.each do |item| ?>#{item}<?r end ?>')
-			template = Trenni::Template.new(buffer)
-			
-			items = 1..4
-			
-			expect(template.to_string(binding)).to be == "1234"
-		end
+		expect(template.to_string(self)).to be == "1234"
+	end
+	
+	it "should have correct indentation" do
+		buffer = Trenni::Buffer.new("\t<?r items.each do |item| ?>\n\t\#{item}\n\t<?r end ?>\n")
+		template = Trenni::Template.new(buffer)
 		
-		let(:large_template) {Trenni::Template.load_file File.expand_path('template_spec/large.trenni', __dir__)}
+		expect(template.to_string(self)).to be == "\t1\n\t2\n\t3\n\t4\n"
+	end
+	
+	let(:escaped_template) {Trenni::Template.load_file File.expand_path('template_spec/escaped.trenni', __dir__)}
+	
+	it "should have the same number of lines as input" do
+		expect(escaped_template.send(:code).lines.count).to be == 2
+	end
+	
+	it "should process escaped characters" do
+		expect(escaped_template.to_string).to be == 
+			"This\\nisn't one line.\n" +
+			"\\tIndentation is the best."
+	end
+end
 
-		it "should have better performance using instance" do
-			n = 1_000
-			
-			#RubyProf.start
-			
-			object_time = Benchmark.realtime{n.times{large_template.to_string(self)}}
-			binding_time = Benchmark.realtime{n.times{large_template.to_string(binding)}}
-			
-			#result = RubyProf.stop
-			
-			# Print a flat profile to text
-			#printer = RubyProf::FlatPrinter.new(result)
-			#printer.print(STDOUT)
-			
-			expect(object_time).to be < binding_time
-		end
+RSpec.shared_examples "template parser" do
+	let(:delegate) {Trenni::ParseDelegate.new}
+	
+	it "should fail to parse incomplete expression" do
+		buffer = Trenni::Buffer.new('<img src="#{poi_product.photo.thumbnail_url" />')
 		
-		let(:escaped_template) {Trenni::Template.load_file File.expand_path('template_spec/escaped.trenni', __dir__)}
-		
-		it "should have the same number of lines as input" do
-			expect(escaped_template.send(:code).lines.count).to be == 2
-		end
-		
-		it "should process escaped characters" do
-			expect(escaped_template.to_string).to be == 
-				"This\\nisn't one line.\n" +
-				"\\tIndentation is the best."
-		end
+		expect{
+			subject.parse_template(buffer, delegate)
+		}.to raise_error(Trenni::ParseError)
+	end
+	
+	it "should fail to parse incomplete instruction" do
+		buffer = Trenni::Buffer.new('<?r foo')
 		
-		it "should fail to parse" do
-			buffer = Trenni::Buffer.new('<img src="#{poi_product.photo.thumbnail_url" />')
-			broken_template = Trenni::Template.new(buffer)
-			
-			expect{broken_template.to_proc}.to raise_error(Trenni::ParseError) do |error|
-				expect(error.to_s).to include("<string>[1]: Could not find end of interpolation!")
-			end
-		end
+		expect{
+			subject.parse_template(buffer, delegate)
+		}.to raise_error(Trenni::ParseError)
 	end
 end
+
+if defined? Trenni::Fallback
+	RSpec.describe Trenni::Fallback do
+		it_behaves_like "template parser"
+	end
+end
+
+if defined? Trenni::Native
+	RSpec.describe Trenni::Native do
+		it_behaves_like "template parser"
+	end
+end

data/spec/trenni/template_spec/basic.trenni

@@ -0,0 +1 @@
+#{text}

data/spec/trenni/template_spec/capture.trenni

@@ -1,4 +1,4 @@
 <?r result = Trenni::Template.capture do ?>
-	test test test
+test test test
 <?r end ?>
-#{result.upcase}
+#{result.upcase.inspect}

data/spec/trenni/template_spec/error.trenni

@@ -0,0 +1,4 @@
+<?r
+	
+?>
+#{error_on_line_4}

data/trenni.gemspec

@@ -9,12 +9,11 @@ Gem::Specification.new do |spec|
 	spec.authors       = ["Samuel Williams"]
 	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
 	spec.description   = <<-EOF
-	Trenni is a templating system that evaluates textual strings containing Ruby
-	code. It compiles templates directly into native code which means that you
-	generally get the best possible performance.
-
+	Trenni is a templating system built on top of SGML/XML. It uses efficient
+	native parsers where possible and compiles templates into efficient Ruby.
+	
 	In addition, Trenni includes an SGML/XML builder to assist with the generation
-	of pleasantly formatted markup.
+	of pleasantly formatted markup which is compatible with the included parsers.
 	EOF
 	spec.summary       = %q{A fast native templating system that compiles directly to Ruby code.}
 	spec.homepage      = "https://github.com/ioquatix/trenni"
@@ -24,7 +23,11 @@ Gem::Specification.new do |spec|
 	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
 	spec.require_paths = ["lib"]
 	
+	spec.required_ruby_version = '~> 2.1'
+	
+	spec.extensions = %w[ext/trenni/extconf.rb]
+	
 	spec.add_development_dependency "bundler", "~> 1.3"
-	spec.add_development_dependency "rspec", "~> 3.4.0"
+	spec.add_development_dependency "rspec", "~> 3.4"
 	spec.add_development_dependency "rake"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trenni
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-30 00:00:00.000000000 Z
+date: 2016-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,14 +52,15 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "\tTrenni is a templating system that evaluates textual strings containing
-  Ruby\n\tcode. It compiles templates directly into native code which means that you\n\tgenerally
-  get the best possible performance.\n\n\tIn addition, Trenni includes an SGML/XML
-  builder to assist with the generation\n\tof pleasantly formatted markup.\n"
+description: "\tTrenni is a templating system built on top of SGML/XML. It uses efficient\n\tnative
+  parsers where possible and compiles templates into efficient Ruby.\n\t\n\tIn addition,
+  Trenni includes an SGML/XML builder to assist with the generation\n\tof pleasantly
+  formatted markup which is compatible with the included parsers.\n"
 email:
 - samuel.williams@oriontransfer.co.nz
 executables: []
-extensions: []
+extensions:
+- ext/trenni/extconf.rb
 extra_rdoc_files: []
 files:
 - ".gitignore"
@@ -69,21 +70,54 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- benchmark/call_vs_yield.rb
+- benchmark/interpolation_vs_concat.rb
 - benchmark/io_vs_string.rb
+- entities.json
+- ext/trenni/extconf.rb
+- ext/trenni/markup.c
+- ext/trenni/markup.h
+- ext/trenni/markup.rl
+- ext/trenni/template.c
+- ext/trenni/template.h
+- ext/trenni/template.rl
+- ext/trenni/trenni.c
+- ext/trenni/trenni.h
 - lib/trenni.rb
 - lib/trenni/buffer.rb
 - lib/trenni/builder.rb
-- lib/trenni/parser.rb
-- lib/trenni/scanner.rb
+- lib/trenni/entities.rb
+- lib/trenni/entities.trenni
+- lib/trenni/fallback/markup.rb
+- lib/trenni/fallback/markup.rl
+- lib/trenni/fallback/template.rb
+- lib/trenni/fallback/template.rl
+- lib/trenni/markup.rb
+- lib/trenni/native.rb
+- lib/trenni/parse_delegate.rb
+- lib/trenni/parse_error.rb
+- lib/trenni/parsers.rb
 - lib/trenni/strings.rb
+- lib/trenni/substitutions.rb
 - lib/trenni/template.rb
 - lib/trenni/version.rb
+- parsers/trenni/entities.rl
+- parsers/trenni/markup.rl
+- parsers/trenni/template.rl
 - spec/trenni/builder_spec.rb
-- spec/trenni/parser_spec.rb
+- spec/trenni/corpus/large.rb
+- spec/trenni/corpus/large.xhtml
+- spec/trenni/markup_parser_spec.rb
+- spec/trenni/markup_spec.rb
+- spec/trenni/parsers_performance_spec.rb
 - spec/trenni/strings_spec.rb
+- spec/trenni/template_error_spec.rb
+- spec/trenni/template_performance_spec.rb
 - spec/trenni/template_spec.rb
+- spec/trenni/template_spec/basic.trenni
 - spec/trenni/template_spec/buffer.trenni
 - spec/trenni/template_spec/capture.trenni
+- spec/trenni/template_spec/error.trenni
 - spec/trenni/template_spec/escaped.trenni
 - spec/trenni/template_spec/large.trenni
 - spec/trenni/template_spec/nested.trenni
@@ -97,9 +131,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -113,11 +147,19 @@ specification_version: 4
 summary: A fast native templating system that compiles directly to Ruby code.
 test_files:
 - spec/trenni/builder_spec.rb
-- spec/trenni/parser_spec.rb
+- spec/trenni/corpus/large.rb
+- spec/trenni/corpus/large.xhtml
+- spec/trenni/markup_parser_spec.rb
+- spec/trenni/markup_spec.rb
+- spec/trenni/parsers_performance_spec.rb
 - spec/trenni/strings_spec.rb
+- spec/trenni/template_error_spec.rb
+- spec/trenni/template_performance_spec.rb
 - spec/trenni/template_spec.rb
+- spec/trenni/template_spec/basic.trenni
 - spec/trenni/template_spec/buffer.trenni
 - spec/trenni/template_spec/capture.trenni
+- spec/trenni/template_spec/error.trenni
 - spec/trenni/template_spec/escaped.trenni
 - spec/trenni/template_spec/large.trenni
 - spec/trenni/template_spec/nested.trenni

data/lib/trenni/parser.rb

@@ -1,153 +0,0 @@
-# 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_relative 'scanner'
-
-module Trenni
-	# This parser processes general markup into a sequence of events which are passed to a delegate.
-	class Parser < StringScanner
-		OPENED_TAG = :opened
-		CLOSED_TAG = :closed
-		
-		def initialize(buffer, delegate)
-			super(buffer)
-			
-			@delegate = delegate
-			
-			# The delegate must respond to:
-			# .begin_parse(self)
-			# .text(escaped_data)
-			# .cdata(unescaped_data)
-			# .attribute(name, value_or_true)
-			# .begin_tag(name, :opened or :closed)
-			# .end_tag(begin_tag_type, :opened or :closed)
-			# .doctype(doctype_attributes)
-			# .comment(comment_text)
-			# .instruction(instruction_text)
-		end
-
-		def parse!
-			@delegate.begin_parse(self)
-
-			until eos?
-				start_pos = self.pos
-
-				scan_text
-				scan_tag
-
-				raise_if_stuck(start_pos)
-			end
-		end
-
-		protected
-
-		def scan_text
-			# Match any character data except the open tag character.
-			if self.scan(/[^<]+/m)
-				@delegate.text(self.matched)
-			end
-		end
-		
-		def scan_tag
-			if self.scan(/</)
-				if self.scan(/\//)
-					scan_tag_normal(CLOSED_TAG)
-				elsif self.scan(/!\[CDATA\[/)
-					scan_tag_cdata
-				elsif self.scan(/!--/)
-					scan_tag_comment
-				elsif self.scan(/!DOCTYPE/)
-					scan_doctype
-				elsif self.scan(/\?/)
-					scan_tag_instruction
-				else
-					scan_tag_normal
-				end
-			end
-		end
-
-		def scan_attributes
-			# Parse an attribute in the form of key="value" or key.
-			while self.scan(/\s*([^\s=\/>]+)/um)
-				name = self[1].freeze
-				if self.scan(/=((['"])(.*?)\2)/um)
-					value = self[3].freeze
-					@delegate.attribute(name, value)
-				else
-					@delegate.attribute(name, true)
-				end
-			end
-		end
-		
-		def scan_tag_normal(begin_tag_type = OPENED_TAG)
-			if self.scan(/[^\s\/>]+/)
-				@delegate.begin_tag(self.matched.freeze, begin_tag_type)
-				
-				self.scan(/\s*/)
-				self.scan_attributes
-				self.scan(/\s*/)
-				
-				if self.scan(/\/>/)
-					if begin_tag_type == CLOSED_TAG
-						parse_error!("Tag cannot be closed at both ends!")
-					else
-						@delegate.finish_tag(begin_tag_type, CLOSED_TAG)
-					end
-				elsif self.scan(/>/)
-					@delegate.finish_tag(begin_tag_type, OPENED_TAG)
-				else
-					parse_error!("Invalid characters in tag!")
-				end
-			else
-				parse_error!("Invalid tag!")
-			end
-		end
-		
-		def scan_doctype
-			if self.scan_until(/(.*?)>/)
-				@delegate.doctype(self[1].strip.freeze)
-			else
-				parse_error!("DOCTYPE is not closed!")
-			end
-		end
-		
-		def scan_tag_cdata
-			if self.scan_until(/(.*?)\]\]>/m)
-				@delegate.cdata(self[1].freeze)
-			else
-				parse_error!("CDATA segment is not closed!")
-			end
-		end
-		
-		def scan_tag_comment
-			if self.scan_until(/(.*?)-->/m)
-				@delegate.comment(self[1].freeze)
-			else
-				parse_error!("Comment is not closed!")
-			end
-		end
-		
-		def scan_tag_instruction
-			if self.scan_until(/(.*)\?>/)
-				@delegate.instruction(self[1].freeze)
-			end
-		end
-	end
-end