ox 2.13.4 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 455a3e6630c8cf482656e024c14c609cfcc5441d201dd6b6f7649a283309bf87
-  data.tar.gz: e6240807c3f21f2915d044b56bc05433730a39315b10a50c3698adcc5640cf1d
+  metadata.gz: '059b3f1db82648104560fe8087b57d8c7e1ee082ed953a53afcdf3f8762b0a3e'
+  data.tar.gz: 344eac455d082e55935804cc45a7f399ebce83be700c1895a4679f28cd3b635a
 SHA512:
-  metadata.gz: 3ddfd3e2a3e80338a1f5d4cf36b9b0ea28b721f24d7d6bc8c3b1a27c2c026484596274b105b4da602e4070627411297295807eebbf83cc923863d4494e0c0c32
-  data.tar.gz: af3b468beb6e48aa6046b3829ee186433be56d308dd3bb06b19068eefd4a315c004353aaa245a95fdc42d315e817d7cca4f3d309b745fb782c5e77bbd463e427
+  metadata.gz: f4a109a5e5d97594c1c266bfd071af26aedf94acaf08d11c55ea03981fef97bff44d762c3df2b6b21da8559d928e7aac1d6d3421fbe0af56fb2eec10975449a6
+  data.tar.gz: c82c7d2ca8fb54eb4f04d7da7b1b5527ef47e89905fcdd3b9ab9b5407bee6c9f3a55ea253472e212810e10cec71627a9cd84dcbb69f1c3db2bdee2e86651f6bd

data/CHANGELOG.md

@@ -4,6 +4,12 @@ All changes to the Ox gem are documented here. Releases follow semantic versioni
 
 ## [Unreleased]
 
+## [2.14.0] - 2020-12-15
+
+### Added
+
+- The `:with_cdata` option added for the hash_load() function.
+
 ## [2.13.4] - 2020-09-11
 
 ### Fixed

data/ext/ox/hash_load.c

@@ -74,9 +74,8 @@ unmark(PInfo pi, VALUE val) {
 }
 
 static void
-add_text(PInfo pi, char *text, int closed) {
+add_str(PInfo pi, VALUE s) {
     Helper		parent = helper_stack_peek(&pi->helpers);
-    volatile VALUE	s = rb_str_new2(text);
     volatile VALUE	a;
 
 #if HAVE_RB_ENC_ASSOCIATE
@@ -102,6 +101,16 @@ add_text(PInfo pi, char *text, int closed) {
     }
 }
 
+static void
+add_text(PInfo pi, char *text, int closed) {
+    add_str(pi, rb_str_new2(text));
+}
+
+static void
+add_cdata(PInfo pi, const char *text, size_t len) {
+    add_str(pi, rb_str_new(text, len));
+}
+
 static void
 add_element(PInfo pi, const char *ename, Attr attrs, int hasChildren) {
     if (helper_stack_empty(&pi->helpers)) {
@@ -250,6 +259,19 @@ struct _parseCallbacks   _ox_hash_callbacks = {
 
 ParseCallbacks   ox_hash_callbacks = &_ox_hash_callbacks;
 
+struct _parseCallbacks   _ox_hash_cdata_callbacks = {
+    NULL,
+    NULL,
+    NULL,
+    add_cdata,
+    add_text,
+    add_element,
+    end_element,
+    finish,
+};
+
+ParseCallbacks   ox_hash_cdata_callbacks = &_ox_hash_cdata_callbacks;
+
 struct _parseCallbacks   _ox_hash_no_attrs_callbacks = {
     NULL,
     NULL,
@@ -262,3 +284,16 @@ struct _parseCallbacks   _ox_hash_no_attrs_callbacks = {
 };
 
 ParseCallbacks   ox_hash_no_attrs_callbacks = &_ox_hash_no_attrs_callbacks;
+
+struct _parseCallbacks   _ox_hash_no_attrs_cdata_callbacks = {
+    NULL,
+    NULL,
+    NULL,
+    add_cdata,
+    add_text,
+    add_element_no_attrs,
+    end_element_no_attrs,
+    NULL,
+};
+
+ParseCallbacks   ox_hash_no_attrs_cdata_callbacks = &_ox_hash_no_attrs_cdata_callbacks;

data/ext/ox/ox.c

@@ -145,6 +145,7 @@ static VALUE	symbolize_keys_sym;
 static VALUE	symbolize_sym;
 static VALUE	tolerant_sym;
 static VALUE	trace_sym;
+static VALUE	with_cdata_sym;
 static VALUE	with_dtd_sym;
 static VALUE	with_instruct_sym;
 static VALUE	with_xml_sym;
@@ -179,6 +180,7 @@ struct _options	 ox_default_options = {
     true,		// convert_special
     No,			// allow_invalid
     false,		// no_empty
+    false,		// with_cdata
     { '\0' },		// inv_repl
     { '\0' },		// strip_ns
     NULL,		// html_hints
@@ -192,7 +194,9 @@ extern ParseCallbacks	ox_gen_callbacks;
 extern ParseCallbacks	ox_limited_callbacks;
 extern ParseCallbacks	ox_nomode_callbacks;
 extern ParseCallbacks	ox_hash_callbacks;
+extern ParseCallbacks	ox_hash_cdata_callbacks;
 extern ParseCallbacks	ox_hash_no_attrs_callbacks;
+extern ParseCallbacks	ox_hash_no_attrs_cdata_callbacks;
 
 static void	parse_dump_options(VALUE ropts, Options copts);
 
@@ -290,6 +294,7 @@ hints_to_overlay(Hints hints) {
  * - _:convert_special_ [true|false|nil] flag indicating special characters like < are converted with the SAX parser
  * - _:invalid_replace_ [nil|String] replacement string for invalid XML characters on dump. nil indicates include anyway as hex. A string, limited to 10 characters will replace the invalid character with the replace.
  * - _:no_empty_ [true|false|nil] flag indicating there should be no empty elements in a dump
+ * - _:with_cdata_ [true|false] includes cdata in hash_load results
  * - _:strip_namespace_ [String|true|false] false or "" results in no namespace stripping. A string of "*" or true will strip all namespaces. Any other non-empty string indicates that matching namespaces will be stripped.
  * - _:overlay_ [Hash] a Hash of keys that match html element names and values that are one of
  *   - _:active_ - make the normal callback for the element
@@ -324,6 +329,7 @@ get_def_opts(VALUE self) {
     rb_hash_aset(opts, smart_sym, (Yes == ox_default_options.smart) ? Qtrue : ((No == ox_default_options.smart) ? Qfalse : Qnil));
     rb_hash_aset(opts, convert_special_sym, (ox_default_options.convert_special) ? Qtrue : Qfalse);
     rb_hash_aset(opts, no_empty_sym, (ox_default_options.no_empty) ? Qtrue : Qfalse);
+    rb_hash_aset(opts, with_cdata_sym, (ox_default_options.with_cdata) ? Qtrue : Qfalse);
     switch (ox_default_options.mode) {
     case ObjMode:		rb_hash_aset(opts, mode_sym, object_sym);		break;
     case GenMode:		rb_hash_aset(opts, mode_sym, generic_sym);		break;
@@ -431,6 +437,7 @@ sax_html_overlay(VALUE self) {
  *   - _:smart_ [true|false|nil] flag indicating the SAX parser uses hints if available (use with html)
  *   - _:invalid_replace_ [nil|String] replacement string for invalid XML characters on dump. nil indicates include anyway as hex. A string, limited to 10 characters will replace the invalid character with the replace.
  *   - _:strip_namespace_ [nil|String|true|false] "" or false result in no namespace stripping. A string of "*" or true will strip all namespaces. Any other non-empty string indicates that matching namespaces will be stripped.
+ * - _:with_cdata_ [true|false] includes cdata in hash_load results
  * - _:overlay_ [Hash] a Hash of keys that match html element names and values that are one of
  *   - _:active_ - make the normal callback for the element
  *   - _:nest_ok_ - active but ignore nest check
@@ -630,6 +637,10 @@ set_def_opts(VALUE self, VALUE opts) {
 	    rb_hash_foreach(v, set_overlay, (VALUE)ox_default_options.html_hints);
 	}
     }
+    if (Qnil != (v = rb_hash_lookup(opts, with_cdata_sym))) {
+	ox_default_options.with_cdata = (Qtrue == v);
+    }
+
     ox_default_options.element_key_mod = rb_hash_lookup2(opts, element_key_mod_sym, ox_default_options.element_key_mod);
     ox_default_options.attr_key_mod = rb_hash_lookup2(opts, attr_key_mod_sym, ox_default_options.attr_key_mod);
 
@@ -838,6 +849,9 @@ load(char *xml, size_t len, int argc, VALUE *argv, VALUE self, VALUE encoding, E
 	    options.margin[sizeof(options.margin) - 1] = '\0';
 	    options.margin_len = strlen(options.margin);
 	}
+	if (Qnil != (v = rb_hash_lookup(h, with_cdata_sym))) {
+	    options.with_cdata = (Qtrue == v);
+	}
     }
 #if HAVE_RB_ENC_FIND
     if ('\0' == *options.encoding) {
@@ -869,10 +883,18 @@ load(char *xml, size_t len, int argc, VALUE *argv, VALUE self, VALUE encoding, E
 	obj = ox_parse(xml, len, ox_limited_callbacks, 0, &options, err);
 	break;
     case HashMode:
-	obj = ox_parse(xml, len, ox_hash_callbacks, 0, &options, err);
+	if (options.with_cdata) {
+	    obj = ox_parse(xml, len, ox_hash_cdata_callbacks, 0, &options, err);
+	} else {
+	    obj = ox_parse(xml, len, ox_hash_callbacks, 0, &options, err);
+	}
 	break;
     case HashNoAttrMode:
-	obj = ox_parse(xml, len, ox_hash_no_attrs_callbacks, 0, &options, err);
+	if (options.with_cdata) {
+	    obj = ox_parse(xml, len, ox_hash_no_attrs_cdata_callbacks, 0, &options, err);
+	} else {
+	    obj = ox_parse(xml, len, ox_hash_no_attrs_callbacks, 0, &options, err);
+	}
 	break;
     case NoMode:
 	obj = ox_parse(xml, len, ox_nomode_callbacks, 0, &options, err);
@@ -908,6 +930,7 @@ load(char *xml, size_t len, int argc, VALUE *argv, VALUE self, VALUE encoding, E
  *   - *:symbolize_keys* [true|false|nil] symbolize element attribute keys or leave as Strings
  *   - *:invalid_replace* [nil|String] replacement string for invalid XML characters on dump. nil indicates include anyway as hex. A string, limited to 10 characters will replace the invalid character with the replace.
  *   - *:strip_namespace* [String|true|false] "" or false result in no namespace stripping. A string of "*" or true will strip all namespaces. Any other non-empty string indicates that matching namespaces will be stripped.
+ *   - *:with_cdata* [true|false] if true cdata is included in hash_load output otherwise it is not.
  */
 static VALUE
 load_str(int argc, VALUE *argv, VALUE self) {
@@ -1516,6 +1539,7 @@ void Init_ox() {
     symbolize_sym = ID2SYM(rb_intern("symbolize"));		rb_gc_register_address(&symbolize_sym);
     tolerant_sym = ID2SYM(rb_intern("tolerant"));		rb_gc_register_address(&tolerant_sym);
     trace_sym = ID2SYM(rb_intern("trace"));			rb_gc_register_address(&trace_sym);
+    with_cdata_sym = ID2SYM(rb_intern("with_cdata"));		rb_gc_register_address(&with_cdata_sym);
     with_dtd_sym = ID2SYM(rb_intern("with_dtd"));		rb_gc_register_address(&with_dtd_sym);
     with_instruct_sym = ID2SYM(rb_intern("with_instructions")); rb_gc_register_address(&with_instruct_sym);
     with_xml_sym = ID2SYM(rb_intern("with_xml"));		rb_gc_register_address(&with_xml_sym);

data/ext/ox/ox.h

@@ -136,6 +136,7 @@ typedef struct _options {
     char		convert_special;// boolean true or false
     char		allow_invalid;	// YesNo
     char		no_empty;	// boolean - no empty elements when dumping
+    char		with_cdata;	// boolean - hash_load should include cdata
     char		inv_repl[12];	// max 10 valid characters, first character is the length
     char		strip_ns[64];	// namespace to strip, \0 is no-strip, \* is all, else only matches
     struct _hints	*html_hints;	// html hints

data/lib/ox/element.rb

@@ -115,17 +115,8 @@ module Ox
     # matching name will be yielded to. If the cond is a Hash then the
     # keys-value pairs in the cond must match the child attribute values with
     # the same keys. Any other cond type will yield to nothing.
-    def each(cond=nil)
-      if cond.nil?
-        nodes.each { |n| yield(n) }
-      else
-        cond = cond.to_s if cond.is_a?(Symbol)
-        if cond.is_a?(String)
-          nodes.each { |n| yield(n) if n.is_a?(Element) && cond == n.name }
-        elsif cond.is_a?(Hash)
-          nodes.each { |n| yield(n) if n.is_a?(Element) && n.attr_match(cond) }
-        end
-      end
+    def each(cond=nil, &block)
+      build_enumerator(cond).each(&block)
     end
 
     # Returns an array of Nodes or Strings that correspond to the locations
@@ -413,6 +404,24 @@ module Ox
 
     private
 
+    # Builds an enumerator for use in `#each` call
+    #
+    # - +cond+ [Hash, String, nil] an element filter
+    def build_enumerator(cond)
+      if cond.nil?
+        nodes.each
+      else
+        cond = cond.to_s if cond.is_a?(Symbol)
+        Enumerator.new do |yielder|
+          if cond.is_a?(String)
+            nodes.each { |n| yielder.yield(n) if n.is_a?(Element) && cond == n.name }
+          elsif cond.is_a?(Hash)
+            nodes.each { |n| yielder.yield(n) if n.is_a?(Element) && n.attr_match(cond) }
+          end
+        end
+      end
+    end
+
     # Removes recursively children for nodes and sub_nodes
     #
     # - +found+ [Array] An array of Ox::Element

data/lib/ox/version.rb

@@ -1,5 +1,5 @@
 
 module Ox
   # Current version of the module.
-  VERSION = '2.13.4'
+  VERSION = '2.14.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ox
 version: !ruby/object:Gem::Version
-  version: 2.13.4
+  version: 2.14.0
 platform: ruby
 authors:
 - Peter Ohler
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-12-15 00:00:00.000000000 Z
 dependencies: []
 description: "A fast XML parser and object serializer that uses only standard C lib.\n\nOptimized
   XML (Ox), as the name implies was written to provide speed optimized\nXML handling.
@@ -76,7 +76,7 @@ homepage: http://www.ohler.com/ox
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -99,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A fast XML parser and object serializer.
 test_files: []