ox 2.4.5 → 2.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c02a5320be65c6d6ebdb2c68c1144b11ffb6550e
-  data.tar.gz: 9ed8d1775aac38b0d8e2e72ccdbcfc9d6afce7fa
+  metadata.gz: 6ce85e954842fdace95d3d258fd0ff548116b057
+  data.tar.gz: 9b2165b3c83121034f73ec319aacb5db8001d729
 SHA512:
-  metadata.gz: 9aae30b11d2a715171653477f48162a815dbf3b79a5e6d68ba85290018c296402b8d140cf5eda323c9540bbcd1c1a84e91ac0737a7a1d2a0f95dc09fe69f68af
-  data.tar.gz: 47020f8ff6795ad9ff214b85ea4668e89f45462bf6968d54ad40f418ee5bbff72a00388aa115e46ffd5e78ff99abade2dbc8ebb15035e1853dc996a5e6929744
+  metadata.gz: 5f5e42834c773acbf9e05f15b005dfcc5f1fb1e004db643b9b8519804b2861a53e104b7f1416ffdc50331d173961dd601ab35f0fb68a644ec4a301354ce3398d
+  data.tar.gz: ff413f408b7df041195b17746f72f851f7626fa157bd58bb30b113f9ddafc1a4912d80e4d889f90cd9970078c18f3f1c8103dc3789878bb4c35c1a1733ebb180

data/README.md

@@ -34,6 +34,12 @@ A fast XML parser and Object marshaller as a Ruby gem.
 
 ## Release Notes
 
+### Release 2.4.6
+
+ - Ready for Ruby 2.4 thanks to SHIBATA Hiroshi, hsbt.
+
+ - Added margin option to dump.
+
 ### Release 2.4.5
 
 - Thanks to GUI for fixing an infinite loop in Ox::Builder.

data/ext/ox/dump.c

@@ -158,6 +158,10 @@ inline static void
 fill_indent(Out out, int cnt) {
     if (0 <= cnt) {
 	*out->cur++ = '\n';
+	if (0 < out->opts->margin_len) {
+	    memcpy(out->cur, out->opts->margin, out->opts->margin_len);
+	    out->cur += out->opts->margin_len;
+	}
 	for (; 0 < cnt; cnt--) {
 	    *out->cur++ = ' ';
 	}
@@ -244,7 +248,7 @@ grow(Out out, size_t len) {
 
 static void
 dump_start(Out out, Element e) {
-    size_t	size = e->indent + 4;
+    size_t	size = e->indent + 4 + out->opts->margin_len;
 
     if (0 < e->attr.len) { /* a="attr" */
 	size += e->attr.len + 5;
@@ -258,7 +262,7 @@ dump_start(Out out, Element e) {
     if (out->end - out->cur <= (long)size) {
 	grow(out, size);
     }
-    if (out->buf < out->cur) {
+    if (out->buf + out->opts->margin_len < out->cur) {
 	fill_indent(out, e->indent);
     }
     *out->cur++ = '<';
@@ -285,7 +289,7 @@ dump_start(Out out, Element e) {
 
 static void
 dump_end(Out out, Element e) {
-    size_t	size = e->indent + 5;
+    size_t	size = e->indent + 5 + out->opts->margin_len;
 
     if (out->end - out->cur <= (long)size) {
 	grow(out, size);
@@ -530,6 +534,9 @@ dump_first_obj(VALUE obj, Out out) {
     int		cnt;
 
     if (Yes == copts->with_xml) {
+	if (0 < copts->margin_len) {
+	    dump_value(out, copts->margin, copts->margin_len);
+	}
 	if ('\0' == *copts->encoding) {
 	    dump_value(out, "<?xml version=\"1.0\"?>", 21);
 	} else {
@@ -538,16 +545,27 @@ dump_first_obj(VALUE obj, Out out) {
 	}
     }
     if (Yes == copts->with_instruct) {
-	cnt = snprintf(buf, sizeof(buf), "%s<?ox version=\"1.0\" mode=\"object\"%s%s?>",
-		      (out->buf < out->cur) ? "\n" : "",
+	if (out->buf < out->cur) {
+	    dump_value(out, "\n", 1);
+	}
+	if (0 < copts->margin_len) {
+	    dump_value(out, copts->margin, copts->margin_len);
+	}
+	cnt = snprintf(buf, sizeof(buf), "<?ox version=\"1.0\" mode=\"object\"%s%s?>",
 		      (Yes == copts->circular) ? " circular=\"yes\"" : ((No == copts->circular) ? " circular=\"no\"" : ""),
 		      (Yes == copts->xsd_date) ? " xsd_date=\"yes\"" : ((No == copts->xsd_date) ? " xsd_date=\"no\"" : ""));
 	dump_value(out, buf, cnt);
     }
     if (Yes == copts->with_dtd) {
+	if (0 < copts->margin_len) {
+	    dump_value(out, copts->margin, copts->margin_len);
+	}
 	cnt = snprintf(buf, sizeof(buf), "%s<!DOCTYPE %c SYSTEM \"ox.dtd\">", (out->buf < out->cur) ? "\n" : "", obj_class_code(obj));
 	dump_value(out, buf, cnt);
     }
+    if (0 < copts->margin_len) {
+	dump_value(out, copts->margin, copts->margin_len);
+    }
     dump_obj(0, obj, 0, out);
 }
 
@@ -568,7 +586,7 @@ dump_obj(ID aid, VALUE obj, int depth, Out out) {
     } else {
 	e.attr.str = rb_id2name(aid);
 	// Ruby 2.3 started to return NULL for some IDs so check for
-	// NULL. Ignore is NULL aid.
+	// NULL. Ignore if NULL aid.
 	if (NULL == e.attr.str) {
 	    return;
 	}
@@ -772,9 +790,9 @@ dump_obj(ID aid, VALUE obj, int depth, Out out) {
 	}
 	clas = rb_obj_class(obj);
 	if (rb_cRange == clas) {
-	    VALUE	beg = RSTRUCT_PTR(obj)[0];
-	    VALUE	end = RSTRUCT_PTR(obj)[1];
-	    VALUE	excl = RSTRUCT_PTR(obj)[2];
+	    VALUE	beg  = RSTRUCT_GET(obj, 0);
+	    VALUE	end  = RSTRUCT_GET(obj, 1);
+	    VALUE	excl = RSTRUCT_GET(obj, 2);
 	    int		d2 = depth + 1;
 
 	    e.type = RangeCode;	 e.clas.len = 5;  e.clas.str = "Range";
@@ -785,17 +803,23 @@ dump_obj(ID aid, VALUE obj, int depth, Out out) {
 	    out->w_end(out, &e);
 	} else {
 	    char	num_buf[16];
-	    VALUE	*vp;
-	    int		i;
 	    int		d2 = depth + 1;
+#if UNIFY_FIXNUM_AND_BIGNUM
+		long i;
+		long cnt = NUM2LONG(RSTRUCT_LEN(obj));
+#else // UNIFY_FIXNUM_AND_INTEGER
+		int   i;
+		int   cnt = (int)RSTRUCT_LEN(obj);
+#endif // UNIFY_FIXNUM_AND_INTEGER
 	    
 	    e.type = StructCode;
 	    e.clas.str = rb_class2name(clas);
 	    e.clas.len = strlen(e.clas.str);
 	    out->w_start(out, &e);
-	    cnt = (int)RSTRUCT_LEN(obj);
-	    for (i = 0, vp = RSTRUCT_PTR(obj); i < cnt; i++, vp++) {
-		dump_obj(rb_intern(ulong2str(i, num_buf + sizeof(num_buf) - 1)), *vp, d2, out);
+
+	    for (i = 0; i < cnt; i++) {
+	        VALUE v = RSTRUCT_GET(obj, i);
+	        dump_obj(rb_intern(ulong2str(i, num_buf + sizeof(num_buf) - 1)), v, d2, out);
 	    }
 	    out->w_end(out, &e);
 	}
@@ -994,6 +1018,9 @@ dump_gen_doc(VALUE obj, int depth, Out out) {
 	}
     }
     if (Yes == out->opts->with_xml) {
+	if (0 < out->opts->margin_len) {
+	    dump_value(out, out->opts->margin, out->opts->margin_len);
+	}
 	dump_value(out, "<?xml", 5);
 	if (Qnil != attrs) {
 	    rb_hash_foreach(attrs, dump_gen_attr, (VALUE)out);
@@ -1002,10 +1029,12 @@ dump_gen_doc(VALUE obj, int depth, Out out) {
     }
     if (Yes == out->opts->with_instruct) {
 	if (out->buf < out->cur) {
-	    dump_value(out, "\n<?ox version=\"1.0\" mode=\"generic\"?>", 36);
-	} else {
-	    dump_value(out, "<?ox version=\"1.0\" mode=\"generic\"?>", 35);
+	    dump_value(out, "\n", 1);
+	}
+	if (0 < out->opts->margin_len) {
+	    dump_value(out, out->opts->margin, out->opts->margin_len);
 	}
+	dump_value(out, "<?ox version=\"1.0\" mode=\"generic\"?>", 35);
     }
     if (Qnil != nodes) {
 	dump_gen_nodes(nodes, depth, out);
@@ -1029,10 +1058,14 @@ dump_gen_element(VALUE obj, int depth, Out out) {
     } else {
 	indent = depth * out->indent;
     }
-    size = indent + 4 + nlen;
+    size = indent + 4 + nlen + out->opts->margin_len;
     if (out->end - out->cur <= (long)size) {
 	grow(out, size);
     }
+    if (0 == depth && 0 < out->opts->margin_len && 0 < out->indent) {
+	memcpy(out->cur, out->opts->margin, out->opts->margin_len);
+	out->cur += out->opts->margin_len;
+    }
     fill_indent(out, indent);
     *out->cur++ = '<';
     fill_value(out, name, nlen);
@@ -1195,7 +1228,7 @@ dump_gen_val_node(VALUE obj, int depth,
     } else {
 	indent = depth * out->indent;
     }
-    size = indent + plen + slen + vlen;
+    size = indent + plen + slen + vlen + out->opts->margin_len;
     if (out->end - out->cur <= (long)size) {
 	grow(out, size);
     }

data/ext/ox/extconf.rb

@@ -36,6 +36,7 @@ dflags = {
   'HAS_TOP_LEVEL_ST_H' => ('ree' == type || ('ruby' == type &&  '1' == version[0] && '8' == version[1])) ? 1 : 0,
   'NEEDS_UIO' => (RUBY_PLATFORM =~ /(win|w)32$/) ? 0 : 1,
   'HAS_DATA_OBJECT_WRAP' => ('ruby' == type && '2' == version[0] && '3' <= version[1]) ? 1 : 0,
+  'UNIFY_FIXNUM_AND_BIGNUM' => ('ruby' == type && '2' == version[0] && '4' <= version[1]) ? 1 : 0,
 }
 
 if RUBY_PLATFORM =~ /(win|w)32$/ || RUBY_PLATFORM =~ /solaris2\.10/

data/ext/ox/obj_load.c

@@ -756,11 +756,11 @@ end_element(PInfo pi, const char *ename) {
 	    case RangeCode:
 #if HAS_RSTRUCT
 		if (ox_beg_id == h->var) {
-		    RSTRUCT_PTR(ph->obj)[0] = h->obj;
+		    RSTRUCT_SET(ph->obj, 0, h->obj);
 		} else if (ox_end_id == h->var) {
-		    RSTRUCT_PTR(ph->obj)[1] = h->obj;
+		    RSTRUCT_SET(ph->obj, 1, h->obj);
 		} else if (ox_excl_id == h->var) {
-		    RSTRUCT_PTR(ph->obj)[2] = h->obj;
+		    RSTRUCT_SET(ph->obj, 2, h->obj);
 		} else {
 		    set_error(&pi->err, "Invalid range attribute", pi->str, pi->s);
 		    return;

data/ext/ox/ox.c

@@ -118,6 +118,7 @@ static VALUE	generic_sym;
 static VALUE	inactive_sym;
 static VALUE	invalid_replace_sym;
 static VALUE	limited_sym;
+static VALUE	margin_sym;
 static VALUE	mode_sym;
 static VALUE	object_sym;
 static VALUE	off_sym;
@@ -153,8 +154,10 @@ void		*ox_utf8_encoding = 0;
 
 struct _Options	 ox_default_options = {
     { '\0' },		/* encoding */
+    { '\0' },		/* margin */
     2,			/* indent */
     0,			/* trace */
+    0,			/* margin_len */
     No,			/* with_dtd */
     No,			/* with_xml */
     No,			/* with_instruct */
@@ -257,6 +260,7 @@ hints_to_overlay(Hints hints) {
 /* call-seq: default_options() => Hash
  *
  * Returns the default load and dump options as a Hash. The options are
+ * - _:margin_ [String] left margin to inset when dumping
  * - _:indent_ [Fixnum] number of spaces to indent each element in an XML document
  * - _:trace_ [Fixnum] trace level where 0 is silent
  * - _:encoding_ [String] character encoding for the XML file
@@ -291,6 +295,7 @@ get_def_opts(VALUE self) {
     int		elen = (int)strlen(ox_default_options.encoding);
 
     rb_hash_aset(opts, ox_encoding_sym, (0 == elen) ? Qnil : rb_str_new(ox_default_options.encoding, elen));
+    rb_hash_aset(opts, margin_sym, rb_str_new(ox_default_options.margin, ox_default_options.margin_len));
     rb_hash_aset(opts, ox_indent_sym, INT2FIX(ox_default_options.indent));
     rb_hash_aset(opts, trace_sym, INT2FIX(ox_default_options.trace));
     rb_hash_aset(opts, with_dtd_sym, (Yes == ox_default_options.with_dtd) ? Qtrue : ((No == ox_default_options.with_dtd) ? Qfalse : Qnil));
@@ -384,6 +389,7 @@ sax_html_overlay(VALUE self) {
  *
  * Sets the default options for load and dump.
  * - +opts+ [Hash] opts options to change
+ *   - _:margin_ [String] left margin to inset when dumping
  *   - _:indent_ [Fixnum] number of spaces to indent each element in an XML document
  *   - _:trace_ [Fixnum] trace level where 0 is silent
  *   - _:encoding_ [String] character encoding for the XML file
@@ -509,7 +515,7 @@ set_def_opts(VALUE self, VALUE opts) {
 
 	Check_Type(v, T_STRING);
 	slen = RSTRING_LEN(v);
-	if (sizeof(ox_default_options.inv_repl) - 2 <  (size_t)slen) {
+	if (sizeof(ox_default_options.inv_repl) - 2 < (size_t)slen) {
 	    rb_raise(ox_parse_error_class, ":invalid_replace can be no longer than %ld characters.",
 		     sizeof(ox_default_options.inv_repl) - 2);
 	}
@@ -530,7 +536,7 @@ set_def_opts(VALUE self, VALUE opts) {
 
 	Check_Type(v, T_STRING);
 	slen = RSTRING_LEN(v);
-	if (sizeof(ox_default_options.strip_ns) - 1 <  (size_t)slen) {
+	if (sizeof(ox_default_options.strip_ns) - 1 < (size_t)slen) {
 	    rb_raise(ox_parse_error_class, ":strip_namespace can be no longer than %ld characters.",
 		     sizeof(ox_default_options.strip_ns) - 1);
 	}
@@ -538,6 +544,21 @@ set_def_opts(VALUE self, VALUE opts) {
 	ox_default_options.strip_ns[sizeof(ox_default_options.strip_ns) - 1] = '\0';
     }
 
+    v = rb_hash_aref(opts, margin_sym);
+    if (Qnil != v) {
+	long	slen;
+
+	Check_Type(v, T_STRING);
+	slen = RSTRING_LEN(v);
+	if (sizeof(ox_default_options.margin) - 1 < (size_t)slen) {
+	    rb_raise(ox_parse_error_class, ":margin can be no longer than %ld characters.",
+		     sizeof(ox_default_options.margin) - 1);
+	}
+	strncpy(ox_default_options.margin, StringValuePtr(v), sizeof(ox_default_options.margin) - 1);
+	ox_default_options.margin[sizeof(ox_default_options.margin) - 1] = '\0';
+	ox_default_options.margin_len = strlen(ox_default_options.margin);
+    }
+
     for (o = ynos; 0 != o->attr; o++) {
 	v = rb_hash_lookup(opts, o->sym);
 	if (Qnil == v) {
@@ -720,7 +741,7 @@ load(char *xml, int argc, VALUE *argv, VALUE self, VALUE encoding, Err err) {
 
 	    Check_Type(v, T_STRING);
 	    slen = RSTRING_LEN(v);
-	    if (sizeof(options.inv_repl) - 2 <  (size_t)slen) {
+	    if (sizeof(options.inv_repl) - 2 < (size_t)slen) {
 		rb_raise(ox_parse_error_class, ":invalid_replace can be no longer than %ld characters.",
 			 sizeof(options.inv_repl) - 2);
 	    }
@@ -740,13 +761,27 @@ load(char *xml, int argc, VALUE *argv, VALUE self, VALUE encoding, Err err) {
 
 	    Check_Type(v, T_STRING);
 	    slen = RSTRING_LEN(v);
-	    if (sizeof(options.strip_ns) - 1 <  (size_t)slen) {
+	    if (sizeof(options.strip_ns) - 1 < (size_t)slen) {
 		rb_raise(ox_parse_error_class, ":strip_namespace can be no longer than %ld characters.",
 			 sizeof(options.strip_ns) - 1);
 	    }
 	    strncpy(options.strip_ns, StringValuePtr(v), sizeof(options.strip_ns) - 1);
 	    options.strip_ns[sizeof(options.strip_ns) - 1] = '\0';
 	}
+	v = rb_hash_lookup(h, margin_sym);
+	if (Qnil != v) {
+	    long	slen;
+
+	    Check_Type(v, T_STRING);
+	    slen = RSTRING_LEN(v);
+	    if (sizeof(options.margin) - 1 < (size_t)slen) {
+		rb_raise(ox_parse_error_class, ":margin can be no longer than %ld characters.",
+			 sizeof(options.margin) - 1);
+	    }
+	    strncpy(options.margin, StringValuePtr(v), sizeof(options.margin) - 1);
+	    options.margin[sizeof(options.margin) - 1] = '\0';
+	    options.margin_len = strlen(options.margin);
+	}
     }
 #if HAS_ENCODING_SUPPORT
     if ('\0' == *options.encoding) {
@@ -1140,6 +1175,20 @@ parse_dump_options(VALUE ropts, Options copts) {
 	    *copts->inv_repl = (char)slen;
 	    copts->allow_invalid = No;
 	}
+	v = rb_hash_lookup(ropts, margin_sym);
+	if (Qnil != v) {
+	    long	slen;
+
+	    Check_Type(v, T_STRING);
+	    slen = RSTRING_LEN(v);
+	    if (sizeof(copts->margin) - 2 <  (size_t)slen) {
+		rb_raise(ox_parse_error_class, ":margin can be no longer than %ld characters.",
+			 sizeof(copts->margin) - 2);
+	    }
+	    strncpy(copts->margin, StringValuePtr(v), sizeof(copts->margin) - 1);
+	    copts->margin[sizeof(copts->margin) - 1] = '\0';
+	    copts->margin_len = (char)slen;
+	}
 	
 	for (o = ynos; 0 != o->attr; o++) {
 	    if (Qnil != (v = rb_hash_lookup(ropts, o->sym))) {
@@ -1376,6 +1425,7 @@ void Init_ox() {
     smart_sym = ID2SYM(rb_intern("smart"));			rb_gc_register_address(&smart_sym);
     strict_sym = ID2SYM(rb_intern("strict"));			rb_gc_register_address(&strict_sym);
     strip_namespace_sym = ID2SYM(rb_intern("strip_namespace"));	rb_gc_register_address(&strip_namespace_sym);
+    margin_sym = ID2SYM(rb_intern("margin"));			rb_gc_register_address(&margin_sym);
     symbolize_keys_sym = ID2SYM(rb_intern("symbolize_keys"));	rb_gc_register_address(&symbolize_keys_sym);
     symbolize_sym = ID2SYM(rb_intern("symbolize"));		rb_gc_register_address(&symbolize_sym);
     tolerant_sym = ID2SYM(rb_intern("tolerant"));		rb_gc_register_address(&tolerant_sym);

data/ext/ox/ox.h

@@ -120,8 +120,10 @@ typedef struct _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 */

data/lib/ox/element.rb

@@ -68,7 +68,6 @@ module Ox
     # - +other+ [Object] Object compare _self_ to.
     # *return* [Boolean] true if both Objects are equivalent, otherwise false.
     def eql?(other)
-      return false if (other.nil? or self.class != other.class)
       return false unless super(other)
       return false unless self.attributes == other.attributes
       return false unless self.nodes == other.nodes

data/lib/ox/instruct.rb

@@ -25,7 +25,6 @@ module Ox
     # - +other+ [Object] Object compare _self_ to.
     # *return* [Boolean] true if both Objects are equivalent, otherwise false.
     def eql?(other)
-      return false if (other.nil? or self.class != other.class)
       return false unless super(other)
       return false unless self.attributes == other.attributes
       return false unless self.content == other.content

data/lib/ox/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ox
 version: !ruby/object:Gem::Version
-  version: 2.4.5
+  version: 2.4.6
 platform: ruby
 authors:
 - Peter Ohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-11 00:00:00.000000000 Z
+date: 2016-11-28 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
@@ -97,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ox
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A fast XML parser and object serializer.