xrb 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 474ad7c9ebec6fba7e79782a390ca3adc53846778c44114653f8dfec1d9343d6
-  data.tar.gz: 5be0e794884ef893ccdb2a5f6fc8117d797381401ff11b9d494feb9f063524f2
+  metadata.gz: ad30d066b439b8ec2f61fa0e6ce50ac25dcc95ee7f4efe266382b15b486e1cd0
+  data.tar.gz: 34d047c9ec0d9848f235e9e5becb7a9b33b25d3e5afdc6cfa097befc677f2b77
 SHA512:
-  metadata.gz: 132854e0a26f998ed20640e764dacae455f5e4f210fe69e5d2c9e9dc517a4fb4bd79a8e38997754ca475c60433bb4c0074f5215e5a36082e1eb9dd65b2823fe6
-  data.tar.gz: d8229a75ce4b215d413495f807cb27eedcc9f434bf401ae590aa37945a4e59b94d7477d0d038b5b860f20fe91fb28496ca5abb7e0577b2b6298d185c12366619
+  metadata.gz: b56901d68f70088b2fe021c772af7b62bd4a6153f35780142ca9ea1203395faa3bce87ab6d678866fbdf2c0a0201db17f01c0a556ef45c6e3a1d3c118be62838
+  data.tar.gz: efdfdaa9d81a87ee5d62e72a13169653fc13dade9ba555afbf2103c282c6f98792880599feda8de6aff0fc4cbe073ad3ceedc87bbf5cb5bbc2fb4966e7af6d0f

data/ext/extconf.rb

@@ -11,7 +11,6 @@ $CFLAGS << " -O3 -Wall -Wno-unknown-pragmas -std=c99"
 
 have_func("rb_sym2str")
 have_func("rb_str_cat_cstr")
-have_func("rb_str_reserve")
 
 $srcs = Dir.glob("xrb/*.c")
 $VPATH << "$(srcdir)/xrb"

data/ext/mkmf.log

@@ -58,59 +58,6 @@ checked program was:
 
 --------------------
 
-have_func: checking for rb_str_reserve()... -------------------- no
-
-DYLD_LIBRARY_PATH=.:/Users/samuel/.rubies/ruby-3.3.0/lib "clang -o conftest -I/Users/samuel/.rubies/ruby-3.3.0/include/ruby-3.3.0/arm64-darwin23 -I/Users/samuel/.rubies/ruby-3.3.0/include/ruby-3.3.0/ruby/backward -I/Users/samuel/.rubies/ruby-3.3.0/include/ruby-3.3.0 -I. -I/opt/local/include -D_XOPEN_SOURCE -D_DARWIN_C_SOURCE -D_DARWIN_UNLIMITED_SELECT -D_REENTRANT   -fdeclspec -O3 -fno-fast-math -ggdb3 -Wall -Wextra -Wextra-tokens -Wdeprecated-declarations -Wdivision-by-zero -Wdiv-by-zero -Wimplicit-function-declaration -Wimplicit-int -Wpointer-arith -Wshorten-64-to-32 -Wwrite-strings -Wold-style-definition -Wmissing-noreturn -Wno-cast-function-type -Wno-constant-logical-operand -Wno-long-long -Wno-missing-field-initializers -Wno-overlength-strings -Wno-parentheses-equality -Wno-self-assign -Wno-tautological-compare -Wno-unused-parameter -Wno-unused-value -Wunused-variable -Wmisleading-indentation -Wundef -pipe -O3 -Wall -Wno-unknown-pragmas -std=c99 conftest.c  -L. -L/Users/samuel/.rubies/ruby-3.3.0/lib -L/opt/local/lib -L. -fstack-protector-strong -L/opt/local/lib  -arch arm64   -lruby.3.3-static -framework CoreFoundation -ldl -lobjc -lpthread   -lpthread  "
-conftest.c:14:57: error: use of undeclared identifier 'rb_str_reserve'
-int t(void) { void ((*volatile p)()); p = (void ((*)()))rb_str_reserve; return !p; }
-                                                        ^
-1 error generated.
-checked program was:
-/* begin */
- 1: #include "ruby.h"
- 2: 
- 3: /*top*/
- 4: extern int t(void);
- 5: int main(int argc, char **argv)
- 6: {
- 7:   if (argc > 1000000) {
- 8:     int (* volatile tp)(void)=(int (*)(void))&t;
- 9:     printf("%d", (*tp)());
-10:   }
-11: 
-12:   return !!argv[argc];
-13: }
-14: int t(void) { void ((*volatile p)()); p = (void ((*)()))rb_str_reserve; return !p; }
-/* end */
-
-DYLD_LIBRARY_PATH=.:/Users/samuel/.rubies/ruby-3.3.0/lib "clang -o conftest -I/Users/samuel/.rubies/ruby-3.3.0/include/ruby-3.3.0/arm64-darwin23 -I/Users/samuel/.rubies/ruby-3.3.0/include/ruby-3.3.0/ruby/backward -I/Users/samuel/.rubies/ruby-3.3.0/include/ruby-3.3.0 -I. -I/opt/local/include -D_XOPEN_SOURCE -D_DARWIN_C_SOURCE -D_DARWIN_UNLIMITED_SELECT -D_REENTRANT   -fdeclspec -O3 -fno-fast-math -ggdb3 -Wall -Wextra -Wextra-tokens -Wdeprecated-declarations -Wdivision-by-zero -Wdiv-by-zero -Wimplicit-function-declaration -Wimplicit-int -Wpointer-arith -Wshorten-64-to-32 -Wwrite-strings -Wold-style-definition -Wmissing-noreturn -Wno-cast-function-type -Wno-constant-logical-operand -Wno-long-long -Wno-missing-field-initializers -Wno-overlength-strings -Wno-parentheses-equality -Wno-self-assign -Wno-tautological-compare -Wno-unused-parameter -Wno-unused-value -Wunused-variable -Wmisleading-indentation -Wundef -pipe -O3 -Wall -Wno-unknown-pragmas -std=c99 conftest.c  -L. -L/Users/samuel/.rubies/ruby-3.3.0/lib -L/opt/local/lib -L. -fstack-protector-strong -L/opt/local/lib  -arch arm64   -lruby.3.3-static -framework CoreFoundation -ldl -lobjc -lpthread   -lpthread  "
-ld: warning: ignoring duplicate libraries: '-lpthread'
-Undefined symbols for architecture arm64:
-  "_rb_str_reserve", referenced from:
-      _t in conftest-abc093.o
-ld: symbol(s) not found for architecture arm64
-clang: error: linker command failed with exit code 1 (use -v to see invocation)
-checked program was:
-/* begin */
- 1: #include "ruby.h"
- 2: 
- 3: /*top*/
- 4: extern int t(void);
- 5: int main(int argc, char **argv)
- 6: {
- 7:   if (argc > 1000000) {
- 8:     int (* volatile tp)(void)=(int (*)(void))&t;
- 9:     printf("%d", (*tp)());
-10:   }
-11: 
-12:   return !!argv[argc];
-13: }
-14: extern void rb_str_reserve();
-15: int t(void) { rb_str_reserve(); return 0; }
-/* end */
-
---------------------
-
 extconf.h is:
 /* begin */
 1: #ifndef EXTCONF_H

data/ext/xrb/escape.c

@@ -103,9 +103,27 @@ 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 buffer, VALUE value) {
+	if (value == Qnil) return Qnil;
+	
+	if (!XRB_Markup_is_markup(value)) {
+		value = XRB_Markup_escape_string(Qnil, value);
+	}
+	 
+	rb_funcall(buffer, id_concat, 1, value);
+	
+	return buffer;
+}
+
 VALUE XRB_Markup_append(VALUE self, VALUE buffer, VALUE value) {
 	if (value == Qnil) return Qnil;
 	
+	if (RB_TYPE_P(buffer, T_STRING)) {
+		rb_str_modify(buffer);
+	} else {
+		return XRB_Markup_append_slow(self, buffer, value);
+	}
+	
 	if (XRB_Markup_is_markup(value)) {
 		rb_str_append(buffer, value);
 	} else {
@@ -121,6 +139,10 @@ VALUE XRB_Markup_append(VALUE self, VALUE buffer, VALUE value) {
 
 // Convert markup special characters to entities. May return the original string if no changes were made.
 VALUE XRB_Markup_escape_string(VALUE self, VALUE string) {
+	if (rb_type(string) != T_STRING) {
+		rb_raise(rb_eTypeError, "expected a string");
+	}
+	
 	const char * begin = RSTRING_PTR(string);
 	const char * end = begin + RSTRING_LEN(string);
 	
@@ -135,7 +157,7 @@ VALUE XRB_Markup_escape_string(VALUE self, VALUE string) {
 	return XRB_Markup_append_buffer(XRB_buffer_for(string), s, p, end);
 }
 
-void Init_xrb_escape() {
+void Init_XRB_escape(void) {
 	rb_XRB_MarkupString = rb_define_class_under(rb_XRB, "MarkupString", rb_cString);
 	rb_gc_register_mark_object(rb_XRB_MarkupString);
 	

data/ext/xrb/escape.h

@@ -3,7 +3,7 @@
 
 #include "xrb.h"
 
-void Init_xrb_escape();
+void Init_XRB_escape(void);
 
 // Given a string, replace it's class with XRB::MarkupString so that it would be output as is.
 VALUE XRB_MarkupString_raw(VALUE self, VALUE string);

data/ext/xrb/tag.c

@@ -138,7 +138,7 @@ VALUE XRB_Tag_format_tag(VALUE self, VALUE name, VALUE attributes, VALUE content
 	rb_encoding *encoding = rb_enc_get(name);
 	
 	VALUE buffer = rb_enc_str_new(0, 0, encoding);
-	rb_str_reserve(buffer, 256);
+	rb_str_modify_expand(buffer, 256);
 	
 	XRB_Tag_append_tag(self, buffer, name, attributes, content);
 	
@@ -152,7 +152,7 @@ VALUE XRB_Tag_write_opening_tag(VALUE self, VALUE buffer) {
 
 	StringValue(name);
 	
-	rb_str_reserve(buffer, RSTRING_LEN(name) + 256);
+	rb_str_modify_expand(buffer, RSTRING_LEN(name) + 256);
 	
 	rb_str_cat_cstr(buffer, "<");
 	rb_str_buf_append(buffer, name);
@@ -173,7 +173,7 @@ VALUE XRB_Tag_write_closing_tag(VALUE self, VALUE buffer) {
 	
 	StringValue(name);
 	
-	rb_str_reserve(buffer, RSTRING_LEN(name) + 3);
+	rb_str_modify_expand(buffer, RSTRING_LEN(name) + 3);
 	
 	rb_str_cat_cstr(buffer, "</");
 	rb_str_buf_append(buffer, name);
@@ -182,7 +182,7 @@ VALUE XRB_Tag_write_closing_tag(VALUE self, VALUE buffer) {
 	return Qnil;
 }
 
-void Init_xrb_tag() {
+void Init_XRB_Tag(void) {
 	rb_undef_method(rb_class_of(rb_XRB_Tag), "append_attributes");
 	rb_define_singleton_method(rb_XRB_Tag, "append_attributes", XRB_Tag_append_attributes, 3);
 	

data/ext/xrb/tag.h

@@ -3,7 +3,7 @@
 
 #include "xrb.h"
 
-void Init_xrb_tag();
+void Init_XRB_Tag(void);
 
 // Split a qualified name `namespace:name` into it's components. Return `[nil, name]` if no namespace is present.
 // Usage: namespace, name = XRB::Tag.split(qualified_name)

data/ext/xrb/xrb.c

@@ -8,7 +8,7 @@
 #include "escape.h"
 
 VALUE rb_XRB = Qnil, rb_XRB_Native = Qnil, rb_XRB_Tag = Qnil, rb_XRB_Markup = Qnil, rb_XRB_MarkupString = Qnil, rb_XRB_ParseError = Qnil;
-ID id_cdata, id_open_tag_begin, id_open_tag_end, id_attribute, id_close_tag, id_text, id_doctype, id_comment, id_instruction, id_read, id_expression, id_key_get, id_string, id_integer, id_append, id_assign, id_pair, id_new, id_name, id_attributes, id_closed, id_to_s, id_is_a;
+ID id_cdata, id_open_tag_begin, id_open_tag_end, id_attribute, id_close_tag, id_text, id_doctype, id_comment, id_instruction, id_read, id_expression, id_key_get, id_string, id_integer, id_append, id_assign, id_pair, id_new, id_name, id_attributes, id_closed, id_to_s, id_is_a, id_concat;
 
 void XRB_raise_error(const char * message, VALUE buffer, size_t offset) {
 	VALUE exception = rb_funcall(rb_XRB_ParseError, id_new, 3, rb_str_new_cstr(message), buffer, ULONG2NUM(offset));
@@ -16,7 +16,7 @@ void XRB_raise_error(const char * message, VALUE buffer, size_t offset) {
 	rb_exc_raise(exception);
 }
 
-void Init_XRB_Extension() {
+void Init_XRB_Extension(void) {
 	id_open_tag_begin = rb_intern("open_tag_begin");
 	id_open_tag_end = rb_intern("open_tag_end");
 	id_close_tag = rb_intern("close_tag");
@@ -47,6 +47,8 @@ void Init_XRB_Extension() {
 	id_to_s = rb_intern("to_s");
 	id_is_a = rb_intern("is_a?");
 	
+	id_concat = rb_intern("<<");
+	
 	rb_XRB = rb_define_module("XRB");
 	rb_gc_register_mark_object(rb_XRB);
 	
@@ -56,7 +58,7 @@ void Init_XRB_Extension() {
 	rb_XRB_Native = rb_define_module_under(rb_XRB, "Native");
 	rb_gc_register_mark_object(rb_XRB_Native);
 	
-	Init_xrb_escape();
+	Init_XRB_escape();
 	
 	rb_XRB_ParseError = rb_const_get_at(rb_XRB, rb_intern("ParseError"));
 	rb_gc_register_mark_object(rb_XRB_ParseError);
@@ -68,5 +70,5 @@ void Init_XRB_Extension() {
 	rb_XRB_Tag = rb_const_get_at(rb_XRB, rb_intern("Tag"));
 	rb_gc_register_mark_object(rb_XRB_Tag);
 	
-	Init_xrb_tag();
+	Init_XRB_Tag();
 }

data/ext/xrb/xrb.h

@@ -19,16 +19,6 @@
 #define RB_IMMEDIATE_P IMMEDIATE_P
 #endif
 
-// A helper to reserve a specific capacity of data for a buffer.
-#ifndef HAVE_RB_STR_RESERVE
-inline VALUE rb_str_reserve(VALUE string, long extra) {
-	long actual = RSTRING_LEN(string);
-	rb_str_resize(string, actual + extra);
-	rb_str_set_len(string, actual);
-	return string;
-}
-#endif
-
 // Modules and classes exposed by XRB.
 extern VALUE
 	rb_XRB,
@@ -62,7 +52,8 @@ extern ID
 	id_attributes,
 	id_closed,
 	id_to_s,
-	id_is_a;
+	id_is_a,
+	id_concat;
 
 // A convenient C string token class.
 typedef struct {
@@ -84,7 +75,7 @@ static inline VALUE XRB_string(const char * begin, const char * end, rb_encoding
 static inline VALUE XRB_buffer_for(VALUE string) {
 	VALUE buffer = rb_enc_str_new(0, 0, rb_enc_get(string));
 	
-	rb_str_reserve(buffer, RSTRING_LEN(string) + 128);
+	rb_str_modify_expand(buffer, RSTRING_LEN(string) + 128);
 	
 	return buffer;
 }

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.

data/lib/xrb/version.rb

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

data/readme.md

@@ -4,14 +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 the following output using `XRB::Template.load_file(path).to_string`:
+
+``` 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.
 
-  - [Usage](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.
+  - [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-rails](https://github.com/socketry/xrb-rails) - A Rails ActionView integration for rendering XRB templates.
+  - [xrb-sanitize](https://github.com/socketry/xrb-sanitize) - A stream-based HTML sanitizer for XRB, based on the XRB Markup parser.
   - [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.
 

metadata

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