trenni 1.1.0 → 1.2.0

data/lib/trenni/{scanner.rb → parser.rb}

@@ -22,58 +22,73 @@
 require 'strscan'
 
 module Trenni
-	# This scanner processes general markup into a sequence of events which are passed to a delegate.
-	class Scanner
+	# This parser processes general markup into a sequence of events which are passed to a delegate.
+	class Parser
 		OPENED_TAG = :opened
 		CLOSED_TAG = :closed
 		
-		class ScanError < StandardError
+		def self.line_at_offset(input, input_offset)
+			line_number = 1
+			line_offset = offset = 0
+
+			input.each_line do |line|
+				line_offset = offset
+				offset += line.size
+
+				if offset >= input_offset
+					return {
+						# The line that contains the input_offset:
+						:line_number => line_number,
+						# The offset to the start of that line:
+						:line_offset => line_offset,
+						# The number of characters from the start of the line to the input_offset:
+						:character_offset => input_offset - line_offset,
+						# The line of text itself:
+						:text => line.chomp
+					}
+				end
+
+				line_number += 1
+			end
+			
+			return nil
+		end
+		
+		class ParseError < StandardError
 			def initialize(message, scanner)
 				@message = message
 
-				@pos = scanner.pos
-				@offset = calculate_line_number(scanner)
+				@position = scanner.pos
+				@line = Parser.line_at_offset(scanner.string, @position)
 			end
 
 			attr :offset
 
 			def to_s
 				if @offset
-					"Scan Error: #{@message} @ [#{@offset[0]}:#{@offset[2]}]: #{@offset[4]}"
+					"Parse Error: #{@message} @ [#{@line[0]}:#{@line[2]}]: #{@line[4]}"
 				else
-					"Scan Error [#{@pos}]: #{@message}"
+					"Parse Error [#{@position}]: #{@message}"
 				end
 			end
-			
-			protected
-			
-			def calculate_line_number(scanner)
-				at = scanner.pos
-				
-				line_no = 1
-				line_offset = offset = 0
-				
-				scanner.string.lines.each do |line|
-					line_offset = offset
-					offset += line.size
-					
-					if offset >= at
-						return [line_no, line_offset, at - line_offset, offset, line]
-					end
-					
-					line_no += 1
-				end
-				
-				return nil
-			end
 		end
 		
 		def initialize(delegate)
 			@delegate = delegate
+			# The delegate must respond to:
+			# .begin_parse(scanner)
+			# .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)
+			# .comment(comment-text)
+			# .instruction(instruction-text)
 		end
 
 		def parse(string)
 			scanner = StringScanner.new(string)
+			@delegate.begin_parse(scanner)
 
 			until scanner.eos?
 				start_pos = scanner.pos
@@ -82,7 +97,7 @@ module Trenni
 				scan_tag(scanner)
 
 				if start_pos == scanner.pos
-					raise ScanError.new("Scanner didn't move", scanner)
+					raise ParseError.new("Scanner didn't move", scanner)
 				end
 			end
 		end
@@ -134,17 +149,17 @@ module Trenni
 				
 				if scanner.scan(/\/>/)
 					if begin_tag_type == CLOSED_TAG
-						raise ScanError.new("Tag cannot be closed at both ends!", scanner)
+						raise ParseError.new("Tag cannot be closed at both ends!", scanner)
 					else
 						@delegate.finish_tag(begin_tag_type, CLOSED_TAG)
 					end
 				elsif scanner.scan(/>/)
 					@delegate.finish_tag(begin_tag_type, OPENED_TAG)
 				else
-					raise ScanError.new("Invalid characters in tag!", scanner)
+					raise ParseError.new("Invalid characters in tag!", scanner)
 				end
 			else
-				raise ScanError.new("Invalid tag!", scanner)
+				raise ParseError.new("Invalid tag!", scanner)
 			end
 		end
 
@@ -152,7 +167,7 @@ module Trenni
 			if scanner.scan_until(/(.*?)\]\]>/m)
 				@delegate.cdata(scanner[1])
 			else
-				raise ScanError.new("CDATA segment is not closed!", scanner)
+				raise ParseError.new("CDATA segment is not closed!", scanner)
 			end
 		end
 		
@@ -161,13 +176,13 @@ module Trenni
 				if scanner.scan_until(/(.*?)-->/m)
 					@delegate.comment("--" + scanner[1] + "--")
 				else
-					raise ScanError.new("Comment is not closed!", scanner)
+					raise ParseError.new("Comment is not closed!", scanner)
 				end
 			else
 				if scanner.scan_until(/(.*?)>/)
 					@delegate.comment(scanner[1])
 				else
-					raise ScanError.new("Comment is not closed!", scanner)
+					raise ParseError.new("Comment is not closed!", scanner)
 				end
 			end
 		end

data/lib/trenni/version.rb

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

data/test/{test_scanner.rb → test_parser.rb}

@@ -25,10 +25,10 @@ require 'test/unit'
 require 'stringio'
 require 'digest/md5'
 
-require 'trenni/scanner'
+require 'trenni/parser'
 
-class TestScanner < Test::Unit::TestCase
-	class ScannerDelegate
+class TestParser < Test::Unit::TestCase
+	class ParserDelegate
 		def initialize
 			@events = []
 		end
@@ -38,11 +38,15 @@ class TestScanner < Test::Unit::TestCase
 		def method_missing(*args)
 			@events << args
 		end
+		
+		def begin_parse(scanner)
+			# ignore this event
+		end
 	end
 	
 	def test_markup
-		delegate = ScannerDelegate.new
-		scanner = Trenni::Scanner.new(delegate)
+		delegate = ParserDelegate.new
+		scanner = Trenni::Parser.new(delegate)
 
 		scanner.parse(%Q{<foo bar="20" baz>Hello World</foo>})
 
@@ -60,8 +64,8 @@ class TestScanner < Test::Unit::TestCase
 	end
 	
 	def test_cdata
-		delegate = ScannerDelegate.new
-		scanner = Trenni::Scanner.new(delegate)
+		delegate = ParserDelegate.new
+		scanner = Trenni::Parser.new(delegate)
 
 		scanner.parse(%Q{<test><![CDATA[Hello World]]></test>})
 
@@ -77,19 +81,30 @@ class TestScanner < Test::Unit::TestCase
 	end
 	
 	def test_errors
-		delegate = ScannerDelegate.new
-		scanner = Trenni::Scanner.new(delegate)
+		delegate = ParserDelegate.new
+		scanner = Trenni::Parser.new(delegate)
 
-		assert_raise Trenni::Scanner::ScanError do
+		assert_raise Trenni::Parser::ParseError do
 			scanner.parse(%Q{<foo})
 		end
 		
-		assert_raise Trenni::Scanner::ScanError do
+		assert_raise Trenni::Parser::ParseError do
 			scanner.parse(%Q{<foo bar=>})
 		end
 		
-		assert_nothing_raised Trenni::Scanner::ScanError do
+		assert_nothing_raised Trenni::Parser::ParseError do
 			scanner.parse(%Q{<foo bar="" baz>})
 		end
 	end
+	
+	def test_line_at_offset
+		data = %Q{Hello\nWorld\nFoo\nBar!}
+		
+		line = Trenni::Parser.line_at_offset(data, 7)
+		
+		assert_equal "World", line[:text]
+		assert_equal 2, line[:line_number]
+		assert_equal 6, line[:line_offset]
+		assert_equal 1, line[:character_offset]
+	end
 end

metadata

@@ -1,37 +1,26 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: trenni
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 1.2.0
   prerelease: 
-  segments: 
-  - 1
-  - 1
-  - 0
-  version: 1.1.0
 platform: ruby
-authors: 
+authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-10-26 00:00:00 Z
+date: 2012-10-26 00:00:00.000000000 Z
 dependencies: []
-
-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"
-email: 
+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"
+email:
 - samuel.williams@oriontransfer.co.nz
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -40,50 +29,47 @@ files:
 - lib/trenni.rb
 - lib/trenni/builder.rb
 - lib/trenni/extensions/symbol-1.8.7.rb
-- lib/trenni/scanner.rb
+- lib/trenni/parser.rb
 - lib/trenni/strings.rb
 - lib/trenni/template.rb
 - lib/trenni/version.rb
 - test/test_builder.rb
-- test/test_scanner.rb
+- test/test_parser.rb
 - test/test_strings.rb
 - test/test_template.rb
 - trenni.gemspec
 homepage: https://github.com/ioquatix/trenni
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -514891289960522672
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -514891289960522672
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A fast native templating system that compiles directly to Ruby code.
-test_files: 
+test_files:
 - test/test_builder.rb
-- test/test_scanner.rb
+- test/test_parser.rb
 - test/test_strings.rb
 - test/test_template.rb