ox 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31bc59694575361e4f784ffc8eb8b37fdbb08057
-  data.tar.gz: 9332c70a159d96aa167cc738ac0a0e5bbb2ff6e9
+  metadata.gz: 1a2fc7c5c778f642b52fcf67698d66ef22980334
+  data.tar.gz: 36104a1aef0a7fdcf025ce033ebc614cde934ed7
 SHA512:
-  metadata.gz: 8ee7dccef40d6141d12b1d8eee8a5b92e5d0ad4b04a0c253086c4c333961da1894eb6a450031bf6e4476f6d62c0fb4392793786ae9fdcc2dd84db7597ac8b2bf
-  data.tar.gz: 22bed155c466594191d54ac1ed6db28d6a442c54b03836bf94378590af164fc2d2f67713d44ecd4cfedad1c2aec3bb06df5ca029eff746753b2f8715e2f6f8c9
+  metadata.gz: 4190d2fd9661a40b1fa388f3e736a114d1561d823aa4ba2f17ddea9cca8405a1f0f95fb498d2fdd053ebc1a743f076995003e8e45f7dcf85c072f23848aaa024
+  data.tar.gz: bda2a5979727f68eb5d629f7aa69dc1c0912bb232b7068005b18d27c89dcaf5f74b40fcae07ef08eebd27cd6143ad05dfa8eb4bc71c60bef583c71625ebbb772

data/README.md

@@ -34,24 +34,17 @@ A fast XML parser and Object marshaller as a Ruby gem.
 
 ## <a name="release">Release Notes</a>
 
-### Release 2.0.0
+### Release 2.0.1
 
- - The SAX parser went through a significant re-write. The options have changed. It is now 15% faster on large files and
-   much better at recovering from errors. So much so that the tolerant option was removed and is now the default and
-   only behavior. A smart option was added however. The smart option recognizes a file as an HTML file and will apply a
-   simple set of validation rules that allow the HTML to be parsed more reasonably. Errors will cause callbacks but the
-   parsing continues with the best guess as to how to recover. Rubymaniac has helped with testing and prompted the
-   rewrite to support parsing HTML pages.
+ - Added an attrs_done callback to the sax parser that will be called when all
+   attributes for an element have been read.
 
- - HTML is now supported with the SAX parser. The parser knows some tags like \<br\> or \<img\> do not have to be
-   closed. Other hints as to how to parse and when to raise errors are also included. The parser does it's best to
-   continue parsing even after errors.
+ - Fixed bug in SAX parser where raising an exception in the handler routines
+   would not cleanup. The test put together by griffinmyers was a huge help.
 
- - Added symbolize option to the sax parser. This option, if set to false will use strings instead of symbols for
-   element and attribute names.
+ - Reduced stack use in a several places to improve fiber support.
 
- - A contrib directory was added for people to submit useful bits of code that can be used with Ox. The first
-   contributor is Notezen with a nice way of building XML.
+ - Changed exception handling to assure proper cleanup with new stack minimizing.
 
 ## <a name="description">Description</a>
 
@@ -98,92 +91,92 @@ Ox is compatible with Ruby 1.8.7, 1.9.2, JRuby, and RBX.
 ### Object Dump Sample:
 
 ```ruby
-    require 'ox'
-  
-    class Sample
-      attr_accessor :a, :b, :c
-  
-      def initialize(a, b, c)
-        @a = a
-        @b = b
-        @c = c
-      end
-    end
-  
-    # Create Object
-    obj = Sample.new(1, "bee", ['x', :y, 7.0])
-    # Now dump the Object to an XML String.
-    xml = Ox.dump(obj)
-    # Convert the object back into a Sample Object.
-    obj2 = Ox.parse_obj(xml)
+require 'ox'
+
+class Sample
+  attr_accessor :a, :b, :c
+
+  def initialize(a, b, c)
+    @a = a
+    @b = b
+    @c = c
+  end
+end
+
+# Create Object
+obj = Sample.new(1, "bee", ['x', :y, 7.0])
+# Now dump the Object to an XML String.
+xml = Ox.dump(obj)
+# Convert the object back into a Sample Object.
+obj2 = Ox.parse_obj(xml)
 ```
 
 ### Generic XML Writing and Parsing:
 
 ```ruby
-    require 'ox'
-
-    doc = Ox::Document.new(:version => '1.0')
-    
-    top = Ox::Element.new('top')
-    top[:name] = 'sample'
-    doc << top
-    
-    mid = Ox::Element.new('middle')
-    mid[:name] = 'second'
-    top << mid
-    
-    bot = Ox::Element.new('bottom')
-    bot[:name] = 'third'
-    mid << bot
-    
-    xml = Ox.dump(doc)
-    
-    # xml =
-    # <top name="sample">
-    #   <middle name="second">
-    #     <bottom name="third"/>
-    #   </middle>
-    # </top>
-    
-    doc2 = Ox.parse(xml)
-    puts "Same? #{doc == doc2}"
-    # true
+require 'ox'
+
+doc = Ox::Document.new(:version => '1.0')
+
+top = Ox::Element.new('top')
+top[:name] = 'sample'
+doc << top
+
+mid = Ox::Element.new('middle')
+mid[:name] = 'second'
+top << mid
+
+bot = Ox::Element.new('bottom')
+bot[:name] = 'third'
+mid << bot
+
+xml = Ox.dump(doc)
+
+# xml =
+# <top name="sample">
+#   <middle name="second">
+#     <bottom name="third"/>
+#   </middle>
+# </top>
+
+doc2 = Ox.parse(xml)
+puts "Same? #{doc == doc2}"
+# true
 ```
 
 ### SAX XML Parsing:
 
 ```ruby
-    require 'stringio'
-    require 'ox'
-    
-    class Sample < ::Ox::Sax
-      def start_element(name); puts "start: #{name}";        end
-      def end_element(name);   puts "end: #{name}";          end
-      def attr(name, value);   puts "  #{name} => #{value}"; end
-      def text(value);         puts "text #{value}";         end
-    end
-    
-    io = StringIO.new(%{
-    <top name="sample">
-      <middle name="second">
-        <bottom name="third"/>
-      </middle>
-    </top>
-    })
-    
-    handler = Sample.new()
-    Ox.sax_parse(handler, io)
-    # outputs
-    # start: top
-    #   name => sample
-    # start: middle
-    #   name => second
-    # start: bottom
-    #   name => third
-    # end: bottom
-    # end: middle
-    # end: top
+require 'stringio'
+require 'ox'
+
+class Sample < ::Ox::Sax
+  def start_element(name); puts "start: #{name}";        end
+  def end_element(name);   puts "end: #{name}";          end
+  def attr(name, value);   puts "  #{name} => #{value}"; end
+  def text(value);         puts "text #{value}";         end
+end
+
+io = StringIO.new(%{
+<top name="sample">
+  <middle name="second">
+    <bottom name="third"/>
+  </middle>
+</top>
+})
+
+handler = Sample.new()
+Ox.sax_parse(handler, io)
+# outputs
+# start: top
+#   name => sample
+# start: middle
+#   name => second
+# start: bottom
+#   name => third
+# end: bottom
+# end: middle
+# end: top
 ```
 
 ### Object XML format
@@ -196,27 +189,27 @@ necessary.
 
 The type indicator map is:
 
-- **a** => Array
-- **b** => Base64
-- **c** => Class
-- **f** => Float
-- **g** => Regexp
-- **h** => Hash
-- **i** => Fixnum
-- **j** => Bignum
-- **l** => Rational
-- **m** => Symbol
-- **n** => FalseClass
-- **o** => Object
-- **p** => Ref
-- **r** => Range
-- **s** => String
-- **t** => Time
-- **u** => Struct
-- **v** => Complex
-- **x** => Raw
-- **y** => TrueClass
-- **z** => NilClass
+- **a** => `Array`
+- **b** => `Base64`
+- **c** => `Class`
+- **f** => `Float`
+- **g** => `Regexp`
+- **h** => `Hash`
+- **i** => `Fixnum`
+- **j** => `Bignum`
+- **l** => `Rational`
+- **m** => `Symbol`
+- **n** => `FalseClass`
+- **o** => `Object`
+- **p** => `Ref`
+- **r** => `Range`
+- **s** => `String`
+- **t** => `Time`
+- **u** => `Struct`
+- **v** => `Complex`
+- **x** => `Raw`
+- **y** => `TrueClass`
+- **z** => `NilClass`
 
 If the type is an Object, type 'o' then an attribute named 'c' should be set
 with the full Class name including the Module names. If the XML element
@@ -230,27 +223,27 @@ interpreter.)
 
 Values are encoded as the text portion of an element or in the sub-elements
 of the principle. For example, a Fixnum is encoded as:
-
-    <i>123</i>
-
+```xml
+<i>123</i>
+```
 An Array has sub-elements and is encoded similar to this example.
-
-    <a>
-      <i>1</i>
-      <s>abc</s>
-    </a>
-
+```xml
+<a>
+  <i>1</i>
+  <s>abc</s>
+</a>
+```
 A Hash is encoded with an even number of elements where the first element is
 the key and the second is the value. This is repeated for each entry in the
 Hash. An example is of { 1 => 'one', 2 => 'two' } encoding is:
-
-    <h>
-      <i>1</i>
-      <s>one</s>
-      <i>2</i>
-      <s>two</s>
-    </h>
-
+```xml
+<h>
+  <i>1</i>
+  <s>one</s>
+  <i>2</i>
+  <s>two</s>
+</h>
+```
 Strings with characters not allowed in XML are base64 encoded amd will be
 converted back into a String when loaded.
 

data/ext/ox/attr.h

@@ -0,0 +1,109 @@
+/* attr.h
+ * Copyright (c) 2011, Peter Ohler
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ *  - Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ * 
+ *  - Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 
+ *  - Neither the name of Peter Ohler nor the names of its contributors may be
+ *    used to endorse or promote products derived from this software without
+ *    specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef __OX_ATTR_H__
+#define __OX_ATTR_H__
+
+#include "ox.h"
+
+#define ATTR_STACK_INC	8
+
+typedef struct _Attr {
+    const char	*name;
+    const char	*value;
+} *Attr;
+
+typedef struct _AttrStack {
+    struct _Attr	base[ATTR_STACK_INC];
+    Attr		head;	/* current stack */
+    Attr		end;	/* stack end */
+    Attr		tail;	/* pointer to one past last element name on stack */
+} *AttrStack;
+
+inline static void
+attr_stack_init(AttrStack stack) {
+    stack->head = stack->base;
+    stack->end = stack->base + sizeof(stack->base) / sizeof(struct _Attr);
+    stack->tail = stack->head;
+    stack->head->name = 0;
+}
+
+inline static int
+attr_stack_empty(AttrStack stack) {
+    return (stack->head == stack->tail);
+}
+
+inline static void
+attr_stack_cleanup(AttrStack stack) {
+    if (stack->base != stack->head) {
+        xfree(stack->head);
+	stack->head = stack->base;
+    }
+}
+
+inline static void
+attr_stack_push(AttrStack stack, const char *name, const char *value) {
+    if (stack->end <= stack->tail + 1) {
+	size_t	len = stack->end - stack->head;
+	size_t	toff = stack->tail - stack->head;
+
+	if (stack->base == stack->head) {
+	    stack->head = ALLOC_N(struct _Attr, len + ATTR_STACK_INC);
+	    memcpy(stack->head, stack->base, sizeof(struct _Attr) * len);
+	} else {
+	    REALLOC_N(stack->head, struct _Attr, len + ATTR_STACK_INC);
+	}
+	stack->tail = stack->head + toff;
+	stack->end = stack->head + len + ATTR_STACK_INC;
+    }
+    stack->tail->name = name;
+    stack->tail->value = value;
+    stack->tail++;
+    stack->tail->name = 0; // terminate
+}
+
+inline static Attr
+attr_stack_peek(AttrStack stack) {
+    if (stack->head < stack->tail) {
+	return stack->tail - 1;
+    }
+    return 0;
+}
+
+inline static Attr
+attr_stack_pop(AttrStack stack) {
+    if (stack->head < stack->tail) {
+	stack->tail--;
+	return stack->tail;
+    }
+    return 0;
+}
+
+#endif /* __OX_ATTR_H__ */

data/ext/ox/err.c

@@ -0,0 +1,64 @@
+/* err.c
+ * Copyright (c) 2011, Peter Ohler
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ *  - Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ * 
+ *  - Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 
+ *  - Neither the name of Peter Ohler nor the names of its contributors may be
+ *    used to endorse or promote products derived from this software without
+ *    specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <stdarg.h>
+
+#include "err.h"
+
+void
+ox_err_set(Err e, VALUE clas, const char *format, ...) {
+    va_list	ap;
+
+    va_start(ap, format);
+    e->clas = clas;
+    vsnprintf(e->msg, sizeof(e->msg) - 1, format, ap);
+    va_end(ap);
+}
+
+void
+ox_err_raise(Err e) {
+    rb_raise(e->clas, "%s", e->msg);
+}
+
+void
+_ox_err_set_with_location(Err err, const char *msg, const char *xml, const char *current, const char* file, int line) {
+    int	xline = 1;
+    int	col = 1;
+
+    for (; xml < current && '\n' != *current; current--) {
+	col++;
+    }
+    for (; xml < current; current--) {
+	if ('\n' == *current) {
+	    xline++;
+	}
+    }
+    ox_err_set(err, ox_parse_error_class, "%s at line %d, column %d [%s:%d]\n", msg, xline, col, file, line);
+}