ox 2.11.0 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 837c0ef02149244d49ab2779216dbafc40c46cf1af3354d6ef35779929176476
-  data.tar.gz: b749a74dee9e1ff268cf69ca6dfff6edcb5681e2c4abe90a07a10442689cc484
+  metadata.gz: 5923d0aee2bea7b543f7aec674879c552846492786d05af0d7fd6447f4e60d3b
+  data.tar.gz: b0acca612b1a7624847d0c2399f18b7d122c4d9f41a77deaee23ac96c76d87c2
 SHA512:
-  metadata.gz: f18d97d2e7c3087a07983f32b4d1e061e46866e5d17734689e8af68c8c004b669c008cb7321246123b060d44099624e2c039065727886ba146a412a7f8cae166
-  data.tar.gz: 90f9b3fcc779a2ac25e7a317a3fa17f028c4f9008bb8e57c6dc26693965add3cb116f7e9b250d64038f9928d027ee178f7e633320152202f94a1d896edff6f63
+  metadata.gz: 5c9f59561ace452549c579d22f30b3c0101f0ec9e1f3bf302d711aee2844af32c5c575057fb28c60aecff009c7314d4772691c187368517939ec0ed8a48fc74d
+  data.tar.gz: 4a13ef2c59d159cb1728751c1ec7eb896df35909fb6434e65d722a8ef96e96a2a95e309852f21daf6de87c41e7ca13b13d19015f5bbaed1b0a0dcca5d14b123c

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All changes to the Ox gem are documented here. Releases follow semantic versioni
 
 ## [Unreleased]
 
+## [2.12.0] - 2019-12-18
+
+- Add `no_empty` option to not allow <xyz/> and use <xyz></xyz> instead.
+
 ## [2.11.0] - 2019-06-14
 
 ### Changed

data/README.md

@@ -22,7 +22,7 @@ A fast XML parser and Object marshaller as a Ruby gem.
 
 ## Support
 
-[Get supported Ox with a Tidelift Subscription.](https://tidelift.com/subscription/pkg/rubygems-ox?utm_source=rubygems-ox&utm_medium=referral&utm_campaign=readme)
+[Get supported Ox with a Tidelift Subscription.](https://tidelift.com/subscription/pkg/rubygems-ox?utm_source=rubygems-ox&utm_medium=referral&utm_campaign=readme) Security updates are [supported](https://tidelift.com/security).
 
 ## Links of Interest
 
@@ -108,7 +108,13 @@ obj2 = Ox.parse_obj(xml)
 ```ruby
 require 'ox'
 
-doc = Ox::Document.new(:version => '1.0')
+doc = Ox::Document.new
+
+instruct = Ox::Instruct.new(:xml)
+instruct[:version] = '1.0'
+instruct[:encoding] = 'UTF-8'
+instruct[:standalone] = 'yes'
+doc << instruct
 
 top = Ox::Element.new('top')
 top[:name] = 'sample'
@@ -120,20 +126,31 @@ top << mid
 
 bot = Ox::Element.new('bottom')
 bot[:name] = 'third'
+bot << 'text at bottom'
 mid << bot
 
+other_elements = Ox::Element.new('otherElements')
+other_elements << Ox::CData.new('<sender>John Smith</sender>')
+other_elements << Ox::Comment.new('Director\'s commentary')
+# other_elements << Ox::DocType.new('content')
+other_elements << Ox::Raw.new('<warning>Be carefull with this! Direct inject into XML!</warning>')
+top << other_elements
+
+
 xml = Ox.dump(doc)
 
 # xml =
+# <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 # <top name="sample">
 #   <middle name="second">
-#     <bottom name="third"/>
+#     <bottom name="third">text at bottom</bottom>
 #   </middle>
+#   <otherElements>
+#     <![CDATA[<sender>John Smith</sender>]]>
+#     <!-- Director's commentary -->
+#     <warning>Be carefull with this! Direct inject into XML!</warning>
+#   </otherElements>
 # </top>
-
-doc2 = Ox.parse(xml)
-puts "Same? #{doc == doc2}"
-# true
 ```
 
 ### HTML Parsing:

data/ext/ox/dump.c

@@ -301,7 +301,14 @@ dump_start(Out out, Element e) {
 	fill_attr(out, 'i', s, end - s);
     }
     if (e->closed) {
-	*out->cur++ = '/';
+	if (out->opts->no_empty) {
+	    *out->cur++ = '>';
+	    *out->cur++ = '<';
+	    *out->cur++ = '/';
+	    *out->cur++ = e->type;
+	} else {
+	    *out->cur++ = '/';
+	}
     }
     *out->cur++ = '>';
     *out->cur = '\0';
@@ -1105,6 +1112,11 @@ dump_gen_element(VALUE obj, int depth, Out out) {
 	*out->cur++ = '<';
 	*out->cur++ = '/';
 	fill_value(out, name, nlen);
+    } else if (out->opts->no_empty) {
+	*out->cur++ = '>';
+	*out->cur++ = '<';
+	*out->cur++ = '/';
+	fill_value(out, name, nlen);
     } else {
 	*out->cur++ = '/';
     }

data/ext/ox/ox.c

@@ -127,6 +127,7 @@ static VALUE	limited_sym;
 static VALUE	margin_sym;
 static VALUE	mode_sym;
 static VALUE	nest_ok_sym;
+static VALUE	no_empty_sym;
 static VALUE	object_sym;
 static VALUE	off_sym;
 static VALUE	opt_format_sym;
@@ -177,8 +178,9 @@ struct _options	 ox_default_options = {
     Yes,		// sym_keys
     SpcSkip,		// skip
     No,			// smart
-    1,			// convert_special
+    true,		// convert_special
     No,			// allow_invalid
+    false,		// no_empty
     { '\0' },		// inv_repl
     { '\0' },		// strip_ns
     NULL,		// html_hints
@@ -293,6 +295,7 @@ hints_to_overlay(Hints hints) {
  * - _:smart_ [true|false|nil] flag indicating the SAX parser uses hints if available (use with html)
  * - _: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
  * - _: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
@@ -326,6 +329,7 @@ get_def_opts(VALUE self) {
     rb_hash_aset(opts, element_key_mod_sym, ox_default_options.element_key_mod);
     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);
     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;
@@ -542,6 +546,17 @@ set_def_opts(VALUE self, VALUE opts) {
 	rb_raise(ox_parse_error_class, ":convert_special must be true or false.\n");
     }
 
+    v = rb_hash_lookup(opts, no_empty_sym);
+    if (Qnil == v) {
+	// no change
+    } else if (Qtrue == v) {
+	ox_default_options.no_empty = 1;
+    } else if (Qfalse == v) {
+	ox_default_options.no_empty = 0;
+    } else {
+	rb_raise(ox_parse_error_class, ":no_empty must be true or false.\n");
+    }
+
     v = rb_hash_aref(opts, invalid_replace_sym);
     if (Qnil == v) {
 	ox_default_options.allow_invalid = Yes;
@@ -777,6 +792,9 @@ load(char *xml, size_t len, int argc, VALUE *argv, VALUE self, VALUE encoding, E
 	if (Qnil != (v = rb_hash_lookup(h, convert_special_sym))) {
 	    options.convert_special = (Qfalse != v);
 	}
+	if (Qnil != (v = rb_hash_lookup(h, no_empty_sym))) {
+	    options.no_empty = (Qfalse != v);
+	}
 
 	v = rb_hash_lookup(h, invalid_replace_sym);
 	if (Qnil == v) {
@@ -996,7 +1014,7 @@ load_file(int argc, VALUE *argv, VALUE self) {
 	xml = ALLOCA_N(char, len + 1);
     }
     fseek(f, 0, SEEK_SET);
-    if (len != fread(xml, 1, len, f)) {
+    if ((size_t)len != fread(xml, 1, len, f)) {
 	ox_err_set(&err, rb_eLoadError, "Failed to read %ld bytes from %s.\n", (long)len, path);
 	obj = Qnil;
     } else {
@@ -1208,6 +1226,9 @@ parse_dump_options(VALUE ropts, Options copts) {
 	    }
 	    strncpy(copts->encoding, StringValuePtr(v), sizeof(copts->encoding) - 1);
 	}
+	if (Qnil != (v = rb_hash_lookup(ropts, no_empty_sym))) {
+	    copts->no_empty = (v == Qtrue);
+	}
 	if (Qnil != (v = rb_hash_lookup(ropts, effort_sym))) {
 	    if (auto_define_sym == v) {
 		copts->effort = AutoEffort;
@@ -1275,6 +1296,7 @@ parse_dump_options(VALUE ropts, Options copts) {
  * - +obj+ [Object] Object to serialize as an XML document String
  * - +options+ [Hash] formating options
  *   - *:indent* [Fixnum] format expected
+ *   - *:no_empty* [true|false] if true don't output empty elements
  *   - *:xsd_date* [true|false] use XSD date format if true, default: false
  *   - *:circular* [true|false] allow circular references, default: false
  *   - *:strict|:tolerant]* [ :effort effort to use when an undumpable object (e.g., IO) is encountered, default: :strict
@@ -1480,6 +1502,7 @@ void Init_ox() {
     margin_sym = ID2SYM(rb_intern("margin"));			rb_gc_register_address(&margin_sym);
     mode_sym = ID2SYM(rb_intern("mode"));			rb_gc_register_address(&mode_sym);
     nest_ok_sym = ID2SYM(rb_intern("nest_ok"));			rb_gc_register_address(&nest_ok_sym);
+    no_empty_sym = ID2SYM(rb_intern("no_empty")); 		rb_gc_register_address(&no_empty_sym);
     object_sym = ID2SYM(rb_intern("object"));			rb_gc_register_address(&object_sym);
     off_sym = ID2SYM(rb_intern("off"));				rb_gc_register_address(&off_sym);
     opt_format_sym = ID2SYM(rb_intern("opt_format"));		rb_gc_register_address(&opt_format_sym);

data/ext/ox/ox.h

@@ -123,26 +123,27 @@ typedef struct _circArray {
 } *CircArray;
 
 typedef struct _options {
-    char		encoding[64];	/* encoding, stored in the option to avoid GC invalidation in default values */
-    char		margin[128];	/* left margin for dumping */
-    int			indent;		/* indention for dump, default 2 */
-    int			trace;		/* trace level */
-    char		margin_len;	/* margin length */
-    char		with_dtd;	/* YesNo */
-    char		with_xml;	/* YesNo */
-    char		with_instruct;	/* YesNo */
-    char		circular;	/* YesNo */
-    char		xsd_date;	/* YesNo */
-    char		mode;		/* LoadMode */
-    char		effort;		/* Effort */
-    char		sym_keys;	/* symbolize keys */
-    char		skip;		/* skip mode */
-    char		smart;		/* YesNo sax smart mode */
-    char		convert_special;/* boolean true or false */
-    char		allow_invalid;	/* YesNo */
-    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 */
+    char		encoding[64];	// encoding, stored in the option to avoid GC invalidation in default values
+    char		margin[128];	// left margin for dumping
+    int			indent;		// indention for dump, default 2
+    int			trace;		// trace level
+    char		margin_len;	// margin length
+    char		with_dtd;	// YesNo
+    char		with_xml;	// YesNo
+    char		with_instruct;	// YesNo
+    char		circular;	// YesNo
+    char		xsd_date;	// YesNo
+    char		mode;		// LoadMode
+    char		effort;		// Effort
+    char		sym_keys;	// symbolize keys
+    char		skip;		// skip mode
+    char		smart;		// YesNo sax smart mode
+    char		convert_special;// boolean true or false
+    char		allow_invalid;	// YesNo
+    char		no_empty;	// boolean - no empty elements when dumping
+    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
     VALUE		attr_key_mod;
     VALUE		element_key_mod;
 #if HAS_ENCODING_SUPPORT
@@ -158,13 +159,13 @@ typedef struct _options {
 struct _pInfo {
     struct _helperStack	helpers;
     struct _err		err;
-    char		*str;		//buffer being read from
+    char		*str;		// buffer being read from
     char		*end;		// end of original string
     char		*s;		// current position in buffer
     VALUE		obj;
     ParseCallbacks	pcb;
     CircArray		circ_array;
-    unsigned long	id;		//set for text types when cirs_array is set
+    unsigned long	id;		// set for text types when cirs_array is set
     Options		options;
     char		last;		// last character read, rarely set
 };

data/lib/ox/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ox
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.12.0
 platform: ruby
 authors:
 - Peter Ohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-14 00:00:00.000000000 Z
+date: 2019-12-18 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
@@ -35,7 +35,6 @@ files:
 - ext/ox/cache8.c
 - ext/ox/cache8.h
 - ext/ox/dump.c
-- ext/ox/encode.h
 - ext/ox/err.c
 - ext/ox/err.h
 - ext/ox/extconf.rb
@@ -99,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A fast XML parser and object serializer.

data/ext/ox/encode.h

@@ -1,26 +0,0 @@
-/* encode.h
- * Copyright (c) 2011, Peter Ohler
- * All rights reserved.
- */
-
-#ifndef __OX_ENCODE_H__
-#define __OX_ENCODE_H__
-
-#include "ruby.h"
-#if HAS_ENCODING_SUPPORT
-#include "ruby/encoding.h"
-#endif
-
-static inline VALUE
-ox_encode(VALUE rstr) {
-#if HAS_ENCODING_SUPPORT
-    rb_enc_associate(rstr, ox_utf8_encoding);
-#else
-    if (Qnil != ox_utf8_encoding) {
-	rstr = rb_funcall(ox_utf8_encoding, ox_iconv_id, 1, rstr);
-    }
-#endif
-    return rstr;
-}
-
-#endif /* __OX_ENCODE_H__ */