xrb 0.2.0 → 0.4.0

data/lib/xrb/parsers.rb

@@ -4,7 +4,6 @@
 # Copyright, 2012-2024, by Samuel Williams.
 
 require_relative 'native'
-require_relative 'parse_delegate'
 
 if defined? XRB::Native
 	XRB::Parsers = XRB::Native

data/lib/xrb/template.rb

@@ -20,7 +20,7 @@ module XRB
 	end
 	
 	class Template
-		# Returns the output produced by calling the given block.
+		# @returns [String] the output produced by calling the given block.
 		def self.capture(*arguments, output: nil, &block)
 			scope = block.binding
 			previous_output = scope.local_variable_get(OUT)
@@ -34,7 +34,7 @@ module XRB
 				scope.local_variable_set(OUT, previous_output)
 			end
 			
-			return output
+			return output.to_str
 		end
 		
 		# Returns the buffer used for capturing output.
@@ -46,13 +46,13 @@ module XRB
 			def initialize(encoding: Encoding::UTF_8)
 				@code = String.new.force_encoding(encoding)
 			end
-
+			
 			attr :code
-
+			
 			# Output raw text to the template.
 			def text(text)
 				text = text.gsub("'", "\\\\'")
-				@code << "#{OUT}<<'#{text}';"
+				@code << "#{OUT}.raw('#{text}');"
 				
 				# This is an interesting approach, but it doens't preserve newlines or tabs as raw characters, so template line numbers don't match up.
 				# @parts << "#{OUT}<<#{text.dump};"
@@ -64,9 +64,8 @@ module XRB
 			end
 			
 			# Output a string interpolation.
-			def expression(text)
-				# Double brackets are required here to handle expressions like #{foo rescue "bar"}.
-				@code << "#{OUT}<<String(#{text});"
+			def expression(code)
+				@code << "#{OUT}<<(#{code});"
 			end
 		end
 		
@@ -93,11 +92,11 @@ module XRB
 		end
 		
 		def to_string(scope = Object.new, output = nil)
-			output ||= output_buffer
+			builder = Builder.new(output, encoding: code.encoding)
 			
-			scope.instance_exec(output, &to_proc)
+			scope.instance_exec(builder, &to_proc)
 			
-			return output
+			return builder.output
 		end
 		
 		def to_buffer(scope)
@@ -110,10 +109,6 @@ module XRB
 		
 		protected
 		
-		def output_buffer
-			String.new.force_encoding(code.encoding)
-		end
-		
 		def code
 			@code ||= compile!
 		end
@@ -130,35 +125,4 @@ module XRB
 			assembler.code
 		end
 	end
-	
-	class MarkupTemplate < Template
-		class Assembler < Template::Assembler
-			# Output a string interpolation.
-			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.
-		def make_assembler
-			Assembler.new
-		end
-		
-		# The output of the markup template is encoded markup (e.g. with entities, tags, etc).
-		def output_buffer
-			Builder.new(encoding: code.encoding)
-		end
-	end
 end

data/lib/xrb/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2012-2024, by Samuel Williams.
 
 module XRB
-	VERSION = "0.2.0"
+	VERSION = "0.4.0"
 end

data/readme.md

@@ -4,11 +4,52 @@ XRB is a templating system built loosely on top of XHTML markup. It uses efficie
 
 [![Development Status](https://github.com/socketry/xrb/workflows/Test/badge.svg)](https://github.com/socketry/xrb/actions?workflow=Test)
 
+``` xrb
+<h1>XRB Examples</h1>
+
+<ul>
+	<li>XRB uses normal string interpolation syntax: #{"Hello World"}</li>
+
+	<?r if true ?>
+	<li>XRB also adopts standard #{"<?r ... ?>"} script tags</li>
+	<?r end ?>
+	
+	<!-- That's all of the syntax! -->
+<ul>
+```
+
+Generates:
+
+``` xml
+<h1>XRB Examples</h1>
+
+<ul>
+	<li>XRB uses normal string interpolation syntax: Hello World</li>
+
+	<li>XRB also adopts standard &lt;?r ... ?&gt; script tags</li>
+	
+	<!-- That's all of the syntax! -->
+<ul>
+```
+
+## Is it fast?
+
+Yes. XRB is designed to be fast. It uses a combination of efficient native parsers and Ruby code generation to ensure that templates are compiled into efficient Ruby code. This means that XRB is suitable for use in high performance applications. In comparison to `ERB`, it is generally about 10x faster.
+
 ## Usage
 
+Please see the [project documentation](https://socketry.github.io/xrb/) for more details.
+
+  - [Getting Started](https://socketry.github.io/xrb/guides/getting-started/index) - This guide gives a brief overview of the XRB templating system and how to use it.
+
+  - [Capturing Output](https://socketry.github.io/xrb/guides/capturing-output/index) - This guide explains how to capture intermediate output during template rendering.
+
+  - [Markup Parser](https://socketry.github.io/xrb/guides/markup-parser/index) - This guide explains how to parse and manipulate Markup using the XRB templating system.
+
 ## See Also
 
-  - [xrb-vscode](https://github.com/socketry/xrb-vscode) package for Visual Studio Code.
+  - [xrb-vscode](https://github.com/socketry/xrb-vscode) - A syntax highlighting package for Visual Studio Code.
+  - [trenni](https://github.com/ioquatix/trenni) - The original templating system which XRB is based on.
 
 ## Contributing
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xrb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -39,7 +39,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-04-25 00:00:00.000000000 Z
+date: 2024-04-28 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -80,7 +80,6 @@ files:
 - lib/xrb/fallback/template.rl
 - lib/xrb/markup.rb
 - lib/xrb/native.rb
-- lib/xrb/parse_delegate.rb
 - lib/xrb/parsers.rb
 - lib/xrb/query.rb
 - lib/xrb/reference.rb

data/lib/xrb/parse_delegate.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2016-2024, by Samuel Williams.
-
-module XRB
-	# This is a sample delegate for capturing all events. It's only use is for testing.
-	class ParseDelegate
-		def initialize
-			@events = []
-		end
-		
-		attr :events
-		
-		def method_missing(*args)
-			@events << args
-		end
-	end
-end