xrb 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 262e952884557bc231200ca4a520519e9372d5c0aec682bbd92685258a16d115
-  data.tar.gz: c994e66e6a2c440f0e6ff36a5d964995081e17ab4c79792564d42862c306dc98
+  metadata.gz: 7576d5a9614c5ca657109b06f71b2091717cf0919be858527dd7d2d259162327
+  data.tar.gz: 57ecf941224ddd1b6fc7da50efc01d6a1f09c8ed63fe03249b183e171c9bf25d
 SHA512:
-  metadata.gz: 006b40e77f38cf875163408b443d7f55a5a464a9658ec812071db7aa196133335281cad0ae9c80f1badbdffe77914660b59592dc0d33b99323d91bae19bad9de
-  data.tar.gz: 8b3dcfb6bee297abfbd1dacf583aed9eddfc0ec61ec99840b9096dccad01446683095394305a44b7eb63e726abc23563bd4f085f39e62afa656aedf45c186961
+  metadata.gz: c694e8def7354e1f1c74006349faa3ccf931f056bba6d89ab564cfc998b484880ef9e87f168ecb11751156d03fb5dee216402d670fb426d40151db6a9f1a884c
+  data.tar.gz: a040bd3bfa83f9e3583585e79cb801d71334c978b1222f06a7be258bf936ef14ac6bd918cd4c03828a77c4956e0c539846b829957bd27bb9e3b173777a2ffefc

data/ext/xrb/escape.c

@@ -2,18 +2,6 @@
 #include "escape.h"
 #include <assert.h>
 
-inline static int XRB_Markup_is_markup(VALUE value) {
-	if (RB_IMMEDIATE_P(value))
-		return 0;
-	
-	// This is a short-cut:
-	if (rb_class_of(value) == rb_XRB_MarkupString) {
-		return 1;
-	}
-	
-	return rb_funcall(value, id_is_a, 1, rb_XRB_Markup) == Qtrue;
-}
-
 VALUE XRB_MarkupString_raw(VALUE self, VALUE string) {
 	string = rb_str_dup(string);
 	
@@ -91,7 +79,7 @@ static inline VALUE XRB_Markup_append_buffer(VALUE buffer, const char * s, const
 }
 
 // Escape and append a string to the output buffer.
-VALUE XRB_Markup_append_string(VALUE buffer, VALUE string) {
+static VALUE XRB_Markup_append_string(VALUE buffer, VALUE string) {
 	const char * begin = RSTRING_PTR(string);
 	const char * end = begin + RSTRING_LEN(string);
 	
@@ -103,37 +91,26 @@ VALUE XRB_Markup_append_string(VALUE buffer, VALUE string) {
 	return XRB_Markup_append_buffer(buffer, s, p, end);
 }
 
-VALUE XRB_Markup_append_slow(VALUE self, VALUE output, VALUE value) {
-	// if (value == Qnil) return Qnil;
+// Append self to the output buffer efficiently, escaping special characters.
+VALUE XRB_Markup_append_markup(VALUE self, VALUE output) {
+	if (self == Qnil) return output;
+	
+	VALUE value = self;
 	
-	if (!XRB_Markup_is_markup(value)) {
+	// Ensure value is a string:
+	if (rb_type(value) != T_STRING) {
 		value = rb_funcall(value, id_to_s, 0);
-		value = XRB_Markup_escape_string(Qnil, value);
+		rb_string_value(&value);
 	}
 	
-	rb_funcall(output, id_concat, 1, value);
-	
-	return output;
-}
-
-VALUE XRB_Markup_append(VALUE self, VALUE output, VALUE value) {
-	if (value == Qnil) return Qnil;
-	
 	if (RB_TYPE_P(output, T_STRING)) {
-		rb_str_modify(output);
-	} else {
-		return XRB_Markup_append_slow(self, output, value);
-	}
-	
-	// The output buffer is a string, so we can append directly:
-	if (XRB_Markup_is_markup(value)) {
-		rb_str_append(output, value);
-	} else {
-		if (rb_type(value) != T_STRING) {
-			value = rb_funcall(value, id_to_s, 0);
-		}
-		
+		// Fast path:
+		rb_str_modify_expand(output, RSTRING_LEN(value));
 		XRB_Markup_append_string(output, value);
+	} else {
+		// Slow path (generates temporary strings):
+		value = XRB_Markup_escape_string(Qnil, value);
+		rb_funcall(output, id_concat, 1, value);
 	}
 	
 	return output;
@@ -160,14 +137,8 @@ VALUE XRB_Markup_escape_string(VALUE self, VALUE string) {
 }
 
 void Init_XRB_escape(void) {
-	rb_XRB_MarkupString = rb_define_class_under(rb_XRB, "MarkupString", rb_cString);
-	rb_include_module(rb_XRB_MarkupString, rb_XRB_Markup);
-	
-	rb_undef_method(rb_class_of(rb_XRB_Markup), "escape_string");
-	rb_define_singleton_method(rb_XRB_Markup, "escape_string", XRB_Markup_escape_string, 1);
-	
-	rb_undef_method(rb_class_of(rb_XRB_Markup), "append");
-	rb_define_singleton_method(rb_XRB_Markup, "append", XRB_Markup_append, 2);
+	rb_undef_method(rb_XRB_Markup, "append_markup");
+	rb_define_method(rb_XRB_Markup, "append_markup", XRB_Markup_append_markup, 1);
 	
 	rb_undef_method(rb_class_of(rb_XRB_Markup), "raw");
 	rb_define_singleton_method(rb_XRB_Markup, "raw", XRB_MarkupString_raw, 1);

data/ext/xrb/escape.h

@@ -9,7 +9,7 @@ void Init_XRB_escape(void);
 VALUE XRB_MarkupString_raw(VALUE self, VALUE string);
 
 // Append any value to the output buffer efficiently, escaping entities as needed.
-VALUE XRB_Markup_append(VALUE self, VALUE buffer, VALUE value);
+VALUE XRB_Markup_append_markup(VALUE self, VALUE buffer);
 
 // Escape any entities in the given string. If no entities were found, might return the original string.
 VALUE XRB_Markup_escape_string(VALUE self, VALUE string);

data/ext/xrb/tag.c

@@ -67,7 +67,7 @@ static void XRB_Tag_append_tag_attribute(VALUE buffer, VALUE key, VALUE value, V
 		
 		if (value != Qtrue) {
 			rb_str_cat_cstr(buffer, "=\"");
-			XRB_Markup_append(Qnil, buffer, value);
+			XRB_Markup_append_markup(value, buffer);
 			rb_str_cat_cstr(buffer, "\"");
 		}
 	}
@@ -160,7 +160,7 @@ VALUE XRB_Tag_append_tag_string(VALUE self, VALUE buffer, VALUE name, VALUE attr
 		rb_str_cat_cstr(buffer, ">");
 		
 		if (content != Qtrue) {
-			XRB_Markup_append(self, buffer, content);
+			XRB_Markup_append_markup(content, buffer);
 		}
 		
 		rb_str_cat_cstr(buffer, "</");

data/ext/xrb/xrb.c

@@ -51,6 +51,7 @@ void Init_XRB_Extension(void) {
 	
 	rb_XRB = rb_define_module("XRB");
 	rb_XRB_Markup = rb_define_module_under(rb_XRB, "Markup");
+	rb_XRB_MarkupString = rb_define_class_under(rb_XRB, "MarkupString", rb_cString);
 	rb_XRB_Native = rb_define_module_under(rb_XRB, "Native");
 	
 	Init_XRB_escape();

data/lib/xrb/builder.rb

@@ -9,8 +9,6 @@ require_relative 'tag'
 module XRB
 	# Build markup quickly and efficiently.
 	class Builder
-		include Markup
-		
 		INDENT = "\t"
 		
 		class Fragment
@@ -19,18 +17,20 @@ module XRB
 				@builder = nil
 			end
 			
-			def call(builder)
+			def append_markup(output)
+				builder = Builder.new(output)
+				
+				self.build_markup(builder)
+				
+				return builder.output
+			end
+			
+			def build_markup(builder)
 				@block.call(builder)
 			end
 			
 			def to_s
-				unless @builder
-					@builder = Builder.new
-					
-					self.call(@builder)
-				end
-				
-				return @builder.to_s
+				self.append_markup(nil)
 			end
 			
 			def == other
@@ -84,6 +84,10 @@ module XRB
 			@children = [0]
 		end
 		
+		def build_markup(builder)
+			builder.append(@output)
+		end
+		
 		attr :output
 		
 		def encoding
@@ -149,7 +153,7 @@ module XRB
 				@output << indentation
 			end
 			
-			Markup.append(@output, content)
+			content.build_markup(self)
 			
 			if @indent
 				@output << "\n"
@@ -161,15 +165,7 @@ module XRB
 		end
 		
 		def <<(content)
-			return unless content
-			
-			if content.is_a?(Fragment)
-				inline! do
-					content.call(self)
-				end
-			else
-				Markup.append(@output, content)
-			end
+			content&.build_markup(self)
 		end
 		
 		# Append pre-existing markup:

data/lib/xrb/markup.rb

@@ -8,32 +8,33 @@ require 'cgi'
 module XRB
 	# A wrapper which indicates that `value` can be appended to the output buffer without any changes.
 	module Markup
-		# Converts special characters `<`, `>`, `&`, and `"` into their equivalent entities.
-		# @return [String] May return the original string if no changes were made.
-		def self.escape_string(string)
-			CGI.escape_html(string)
+		def self.raw(string)
+			MarkupString.raw(string)
 		end
 		
-		# Appends a string to the output buffer, escaping if if necessary.
-		def self.append(buffer, value)
-			if value.is_a? Markup
-				buffer << value
-			elsif value
-				buffer << self.escape_string(value.to_s)
-			end
+		def self.append(output, value)
+			value.append_markup(output)
+		end
+		
+		def append_markup(output)
+			output << ::CGI.escape_html(self.to_s)
+		end
+		
+		def build_markup(builder)
+			append_markup(builder.output)
 		end
 	end
 	
+	::Object.prepend(Markup)
+	
 	# Initialized from text which is escaped to use HTML entities.
 	class MarkupString < String
-		include Markup
-		
 		# @param string [String] the string value itself.
 		# @param escape [Boolean] whether or not to escape the string.
 		def initialize(string = nil, escape = true)
 			if string
 				if escape
-					string = Markup.escape_string(string)
+					string = ::CGI.escape_html(string)
 				end
 				
 				super(string)
@@ -52,6 +53,10 @@ module XRB
 		def html_safe?
 			true
 		end
+		
+		def append_markup(output)
+			output << self
+		end
 	end
 	
 	module Script

data/lib/xrb/tag.rb

@@ -8,8 +8,6 @@ require_relative 'markup'
 module XRB
 	# This represents an individual SGML tag, e.g. <a>, </a> or <a />, with attributes. Attribute values must be escaped.
 	Tag = Struct.new(:name, :closed, :attributes) do
-		include XRB::Markup
-		
 		def self.split(qualified_name)
 			if i = qualified_name.index(':')
 				return qualified_name.slice(0...i), qualified_name.slice(i+1..-1)
@@ -80,7 +78,7 @@ module XRB
 			else
 				buffer << '>'
 				unless content == true
-					Markup.append(buffer, content)
+					content.append_markup(buffer)
 				end
 				buffer << '</' << name.to_s << '>'
 			end
@@ -108,7 +106,7 @@ module XRB
 					buffer << ' ' << attribute_key.to_s
 				else
 					buffer << ' ' << attribute_key.to_s << '="'
-					Markup.append(buffer, value)
+					value.append_markup(buffer)
 					buffer << '"'
 				end
 			end

data/lib/xrb/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xrb
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -40,7 +40,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-10-26 00:00:00.000000000 Z
+date: 2024-10-27 00:00:00.000000000 Z
 dependencies: []
 description:
 email: