ox 1.2.5 → 1.2.6

data/ext/ox/dump.c

@@ -539,8 +539,7 @@ dump_obj(ID aid, VALUE obj, unsigned int depth, Out out) {
             dump_value(out, b64, size);
             e.indent = -1;
             out->w_end(out, &e);
-            // TBD pass in flag to free if failure
-            if (sizeof(buf64) <= size) {
+            if (buf64 != b64) {
                 free(b64);
             }
         }
@@ -677,7 +676,7 @@ dump_obj(ID aid, VALUE obj, unsigned int depth, Out out) {
             }
             to_base64((u_char*)s, cnt, b64);
             dump_value(out, b64, size);
-            if (sizeof(buf64) <= size) {
+            if (buf64 != b64) {
                 free(b64);
             }
         }

data/ext/ox/obj_load.c

@@ -100,15 +100,16 @@ resolve_classname(VALUE mod, const char *class_name, Effort effort) {
 
     switch (effort) {
     case TolerantEffort:
-        if (rb_const_defined(mod, ci)) {
-            clas = rb_const_get(mod, ci);
+        if (rb_const_defined_at(mod, ci)) {
+            clas = rb_const_get_at(mod, ci);
         } else {
             clas = Qundef;
         }
         break;
     case AutoEffort:
-        if (rb_const_defined(mod, ci)) {
-            clas = rb_const_get(mod, ci);
+        //printf("*** auto %s\n", class_name);
+        if (rb_const_defined_at(mod, ci)) {
+            clas = rb_const_get_at(mod, ci);
         } else {
             clas = rb_define_class_under(mod, class_name, ox_bag_clas);
         }
@@ -116,7 +117,7 @@ resolve_classname(VALUE mod, const char *class_name, Effort effort) {
     case StrictEffort:
     default:
         // raise an error if name is not defined
-        clas = rb_const_get(mod, ci);
+        clas = rb_const_get_at(mod, ci);
         break;
     }
     return clas;

data/ext/ox/ox.c

@@ -134,6 +134,7 @@ static void     parse_dump_options(VALUE ropts, Options copts);
  * - xsd_date: [true|false|nil] use XSD date format instead of decimal format
  * - mode: [:object|:generic|:limited|nil] load method to use for XML
  * - effort: [:strict|:tolerant|:auto_define] set the tolerance level for loading
+ * @return [Hash] all current option settings.
  */
 static VALUE
 get_def_opts(VALUE self) {
@@ -165,19 +166,21 @@ get_def_opts(VALUE self) {
     return opts;
 }
 
-/* call-seq: default_options=(Hash)
+/* call-seq: default_options=(opts)
  *
- * Sets the default options for load and dump. Options are:
- * - 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
- * - with_dtd: [true|false|nil] include DTD in the dump
- * - with_instruct: [true|false|nil] include instructions in the dump
- * - with_xml: [true|false|nil] include XML prolog in the dump
- * - circular: [true|false|nil] support circular references while dumping
- * - xsd_date: [true|false|nil] use XSD date format instead of decimal format
- * - mode: [:object|:generic|:limited|nil] load method to use for XML
- * - effort: [:strict|:tolerant|:auto_define] set the tolerance level for loading
+ * Sets the default options for load and dump.
+ * @param [Hash] opts options to change
+ * @param [Fixnum] :indent number of spaces to indent each element in an XML document
+ * @param [Fixnum] :trace trace level where 0 is silent
+ * @param [String] :encoding character encoding for the XML file
+ * @param [true|false|nil] :with_dtd include DTD in the dump
+ * @param [true|false|nil] :with_instruct include instructions in the dump
+ * @param [true|false|nil] :with_xml include XML prolog in the dump
+ * @param [true|false|nil] :circular support circular references while dumping
+ * @param [true|false|nil] :xsd_date use XSD date format instead of decimal format
+ * @param [:object|:generic|:limited|nil] :mode load method to use for XML
+ * @param [:strict|:tolerant|:auto_define] :effort set the tolerance level for loading
+ * @return [nil]
  */
 static VALUE
 set_def_opts(VALUE self, VALUE opts) {
@@ -261,7 +264,8 @@ set_def_opts(VALUE self, VALUE opts) {
  * optimized XML formated String. For other formats use the more generic
  * Ox.load() method.  Raises an exception if the XML is malformed or the
  * classes specified in the file are not valid.
- * [xml] XML String in optimized Object format.
+ * @param [String] xml XML String in optimized Object format.
+ * @return [Object] deserialized Object.
  */
 static VALUE
 to_obj(VALUE self, VALUE ruby_xml) {
@@ -279,8 +283,9 @@ to_obj(VALUE self, VALUE ruby_xml) {
 /* call-seq: parse(xml) => Ox::Document or Ox::Element
  *
  * Parses and XML document String into an Ox::Document or Ox::Element.
- * Raises an exception if the XML is malformed.
- * [xml] XML String
+ * @param [String] xml XML String
+ * @return [Ox::Document or Ox::Element] parsed XML document.
+ * @raise [Exception] if the XML is malformed.
  */
 static VALUE
 to_gen(VALUE self, VALUE ruby_xml) {
@@ -360,17 +365,17 @@ load(char *xml, int argc, VALUE *argv, VALUE self) {
  * Parses and XML document String into an Ox::Document, or Ox::Element, or
  * Object depending on the options.  Raises an exception if the XML is
  * malformed or the classes specified are not valid.
- * [xml]     XML String
- * [options] load options
- *           [:mode]   format expected
- *                     [:object]  object format
- *                     [:generic] read as a generic XML file
- *                     [:limited] read as a generic XML file but with callbacks on text and elements events only
- *           [:effort] effort to use when an undefined class is encountered, default: :strict
- *                     [:strict]      raise an NameError for missing classes and modules
- *                     [:tolerant]    return nil for missing classes and modules
- *                     [:auto_define] auto define missing classes and modules
- *           [:trace]  trace level as a Fixnum, default: 0 (silent)
+ * @param [String] xml XML String
+ * @param [Hash] options load options
+ * @param [:object|:generic|:limited] :mode format expected
+ *  - *:object* - object format
+ *  - *:generic* - read as a generic XML file
+ *  - *:limited* - read as a generic XML file but with callbacks on text and elements events only
+ * @param [:strict|:tolerant|:auto_define] :effort effort to use when an undefined class is encountered, default: :strict
+ *  - *:strict* - raise an NameError for missing classes and modules
+ *  - *:tolerant* - return nil for missing classes and modules
+ *  - *:auto_define* - auto define missing classes and modules
+ * @param [Fixnum] :trace trace level as a Fixnum, default: 0 (silent)
  */
 static VALUE
 load_str(int argc, VALUE *argv, VALUE self) {
@@ -388,17 +393,17 @@ load_str(int argc, VALUE *argv, VALUE self) {
  * Parses and XML document from a file into an Ox::Document, or Ox::Element,
  * or Object depending on the options.  Raises an exception if the XML is
  * malformed or the classes specified are not valid.
- * [file_path] file path to read the XML document from
- * [options] load options
- *           [:mode]   format expected
- *                     [:object]  object format
- *                     [:generic] read as a generic XML file
- *                     [:limited] read as a generic XML file but with callbacks on text and elements events only
- *           [:effort] effort to use when an undefined class is encountered, default: :strict
- *                     [:strict]      raise an NameError for missing classes and modules
- *                     [:tolerant]    return nil for missing classes and modules
- *                     [:auto_define] auto define missing classes and modules
- *           [:trace]  trace level as a Fixnum, default: 0 (silent)
+ * @param [String] file_path file path to read the XML document from
+ * @param [Hash] options load options
+ * @param [:object|:generic|:limited] :mode format expected
+ *  - *:object* - object format
+ *  - *:generic* - read as a generic XML file
+ *  - *:limited* - read as a generic XML file but with callbacks on text and elements events only
+ * @param [:strict|:tolerant|:auto_define] :effort effort to use when an undefined class is encountered, default: :strict
+ *  - *:strict* - raise an NameError for missing classes and modules
+ *  - *:tolerant* - return nil for missing classes and modules
+ *  - *:auto_define* - auto define missing classes and modules
+ * @param [Fixnum] :trace trace level as a Fixnum, default: 0 (silent)
  */
 static VALUE
 load_file(int argc, VALUE *argv, VALUE self) {
@@ -492,14 +497,14 @@ parse_dump_options(VALUE ropts, Options copts) {
 /* call-seq: dump(obj, options) => xml-string
  *
  * Dumps an Object (obj) to a string.
- * [obj]     Object to serialize as an XML document String
- * [options] formating options
- *           [:indent]   number of spaces to use as the standard indention, default: 2
- *           [:xsd_date] use XSD date format if true, default: false
- *           [:circular] allow circular references, default: false
- *           [:effort] effort to use when an undumpable object (e.g., IO) is encountered, default: :strict
- *                     [:strict]   raise an NotImplementedError if an undumpable object is encountered
- *                     [:tolerant] replaces undumplable objects with nil
+ * @param [Object] obj Object to serialize as an XML document String
+ * @param [Hash] options formating options
+ * @param [Fixnum] :indent format expected
+ * @param [true|false] :xsd_date use XSD date format if true, default: false
+ * @param [true|false] :circular allow circular references, default: false
+ * @param [:strict|:tolerant] :effort effort to use when an undumpable object (e.g., IO) is encountered, default: :strict
+ *  - *:strict* - raise an NotImplementedError if an undumpable object is encountered
+ *  - *:tolerant* - replaces undumplable objects with nil
  */
 static VALUE
 dump(int argc, VALUE *argv, VALUE self) {
@@ -525,19 +530,19 @@ dump(int argc, VALUE *argv, VALUE self) {
 /* call-seq: to_file(file_path, obj, options)
  *
  * Dumps an Object to the specified file.
- * [file_path] file path to write the XML document to
- * [obj]       Object to serialize as an XML document String
- * [options]   formating options
- *             [:indent]   number of spaces to use as the standard indention, default: 2
- *             [:xsd_date] use XSD date format if true, default: false
- *             [:circular] allow circular references, default: false
- *             [:effort]   effort to use when an undumpable object (e.g., IO) is encountered, default: :strict
- *                       [:strict]   raise an NotImplementedError if an undumpable object is encountered
- *                       [:tolerant] replaces undumplable objects with nil
+ * @param [String] file_path file path to write the XML document to
+ * @param [Object] obj Object to serialize as an XML document String
+ * @param [Hash] options formating options
+ * @param [Fixnum] :indent format expected
+ * @param [true|false] :xsd_date use XSD date format if true, default: false
+ * @param [true|false] :circular allow circular references, default: false
+ * @param [:strict|:tolerant] :effort effort to use when an undumpable object (e.g., IO) is encountered, default: :strict
+ *  - *:strict* - raise an NotImplementedError if an undumpable object is encountered
+ *  - *:tolerant* - replaces undumplable objects with nil
  */
 static VALUE
 to_file(int argc, VALUE *argv, VALUE self) {
-    struct _Options     copts;
+    struct _Options     copts = default_options;
     
     if (3 == argc) {
         parse_dump_options(argv[2], &copts);
@@ -632,12 +637,12 @@ void Init_ox() {
 
     
     //rb_require("node"); // generic xml node classes
-    ox_document_clas = rb_const_get(Ox, rb_intern("Document"));
-    ox_element_clas = rb_const_get(Ox, rb_intern("Element"));
-    ox_comment_clas = rb_const_get(Ox, rb_intern("Comment"));
-    ox_doctype_clas = rb_const_get(Ox, rb_intern("DocType"));
-    ox_cdata_clas = rb_const_get(Ox, rb_intern("CData"));
-    ox_bag_clas = rb_const_get(Ox, rb_intern("Bag"));
+    ox_document_clas = rb_const_get_at(Ox, rb_intern("Document"));
+    ox_element_clas = rb_const_get_at(Ox, rb_intern("Element"));
+    ox_comment_clas = rb_const_get_at(Ox, rb_intern("Comment"));
+    ox_doctype_clas = rb_const_get_at(Ox, rb_intern("DocType"));
+    ox_cdata_clas = rb_const_get_at(Ox, rb_intern("CData"));
+    ox_bag_clas = rb_const_get_at(Ox, rb_intern("Bag"));
 
     ox_cache_new(&symbol_cache);
     ox_cache_new(&class_cache);

data/lib/ox/bag.rb

@@ -11,7 +11,8 @@ module Ox
     # The initializer can take multiple arguments in the form of key values
     # where the key is the variable name and the value is the variable
     # value. This is intended for testing purposes only.
-    # Example: Ox::Bag.new(:@x => 42, :@y => 57)
+    # @example Ox::Bag.new(:@x => 42, :@y => 57)
+    # @param [Hash] args instance variable symbols and their values
     def initialize(args={ })
       args.each do |k,v|
         self.instance_variable_set(k, v)
@@ -22,9 +23,10 @@ module Ox
       end
     end
 
-    # Replaces the Object.respond_to?() method to return true for any method
-    # than matches instance variables.
-    # [m] method symbol
+    # Replaces the Object.respond_to?() method.
+    # @param [Symbol] m method symbol
+    # @return [Boolean] true for any method that matches an instance
+    #                   variable reader, otherwise false.
     def respond_to?(m)
       at_m = ('@' + m.to_s).to_sym
       instance_variables.include?(at_m)
@@ -32,16 +34,20 @@ module Ox
 
     # Handles requests for variable values. Others cause an Exception to be
     # raised.
-    # [m] method symbol
+    # @param [Symbol] m method symbol
+    # @return [Boolean] the value of the specified instance variable.
+    # @raise [ArgumentError] if an argument is given. Zero arguments expected.
+    # @raise [NoMethodError] if the instance variable is not defined.
     def method_missing(m, *args, &block)
-      raise ArgumentError.new("wrong number of arguments(#{args.size} for 0)") unless args.nil? or args.empty?
+      raise ArgumentError.new("wrong number of arguments (#{args.size} for 0) to method #{m}") unless args.nil? or args.empty?
       at_m = ('@' + m.to_s).to_sym
-      raise NoMethodError("undefined method", m) unless instance_variable_defined?(at_m)
+      raise NoMethodError.new("undefined method #{m}", m) unless instance_variable_defined?(at_m)
       instance_variable_get(at_m)
     end
 
-    # Replace eql?() with something more reasonable for this Class.
-    # [other] Object to compare this one to
+    # Replaces eql?() with something more reasonable for this Class.
+    # @param [Object] other Object to compare self to
+    # @return [Boolean] true if each variable and value are the same, otherwise false.
     def eql?(other)
       return false if (other.nil? or self.class != other.class)
       ova = other.instance_variables
@@ -58,11 +64,13 @@ module Ox
     # the Ox module and is available to service wrappers that receive XML
     # requests that include Objects of Classes not defined in the storage
     # process.
-    # [classname] Class name or symbol that includes Module names
+    # @param [String] classname Class name or symbol that includes Module names.
+    # @return [Object] an instance of the specified Class.
+    # @raise [NameError] if the classname is invalid.
     def self.define_class(classname)
       classname = classname.to_s unless classname.is_a?(String)
       tokens = classname.split('::').map { |n| n.to_sym }
-      raise "Invalid classname '#{classname}" if tokens.empty?
+      raise NameError.new("Invalid classname '#{classname}") if tokens.empty?
       m = Object
       tokens[0..-2].each do |sym|
         if m.const_defined?(sym)
@@ -84,5 +92,4 @@ module Ox
     end
 
   end # Bag
-
 end # Ox

data/lib/ox/cdata.rb

@@ -3,7 +3,7 @@ module Ox
   # CData represents a CDATA element in an XML document.
   class CData < Node
     # Creates a CDATA element.
-    # [value] value for the CDATA contents
+    # @param value [String] value for the CDATA contents
     def initialize(value)
       super
     end

data/lib/ox/comment.rb

@@ -4,7 +4,7 @@ module Ox
   # attribute only.
   class Comment < Node
     # Creates a new Comment with the specified value.
-    # [value] string value for the comment
+    # @param value [String] string value for the comment
     def initialize(value)
       super
     end

data/lib/ox/doctype.rb

@@ -4,7 +4,7 @@ module Ox
   class DocType < Node
     # Creates a DOCTYPE elements with the content as a string specified in the
     # value parameter.
-    # [value] contents of the element
+    # @param value [String] string value for the element
     def initialize(value)
       super
     end

data/lib/ox/document.rb

@@ -4,10 +4,10 @@ module Ox
   # the XML prolog. A Document includes Elements.
   class Document < Element
     # Create a new Document.
-    # [prolog] prolog attributes
-    #          [:version]    version, typically '1.0' or '1.1'
-    #          [:encoding]   encoding for the document, currently included but ignored
-    #          [:standalone] indicates the document is standalone
+    # @param [Hash] prolog prolog attributes
+    # @option prolog [String] :version version, typically '1.0' or '1.1'
+    # @option prolog [String] :encoding encoding for the document, currently included but ignored
+    # @option prolog [String] :standalone indicates the document is standalone
     def initialize(prolog={})
       super(nil)
       @attributes = { }

data/lib/ox/element.rb

@@ -5,24 +5,24 @@ module Ox
   class Element < Node
     
     # Creates a new Element with the specified name.
-    # [name] name of the Element
+    # @param [String] name name of the Element
     def initialize(name)
       super
       @attributes = nil
       @nodes = nil
     end
-    
     alias name value
     
     # Returns the Element's nodes array. These are the sub-elements of this
     # Element.
+    # @return [Array] all child Nodes.
     def nodes
       @nodes = [] if !instance_variable_defined?(:@nodes) or @nodes.nil?
       @nodes
     end
 
     # Appends a Node to the Element's nodes array.
-    # [node] Node to append to the nodes array
+    # @param [Node] node Node to append to the nodes array
     def <<(node)
       @nodes = [] if !instance_variable_defined?(:@nodes) or @nodes.nil?
       raise "argument to << must be a String or Ox::Node." unless node.is_a?(String) or node.is_a?(Node)
@@ -30,21 +30,22 @@ module Ox
     end
 
     # Returns all the attributes of the Element as a Hash.
+    # @return [Hash] all attributes and attribute values.
     def attributes
       @attributes = { } if !instance_variable_defined?(:@attributes) or @attributes.nil?
       @attributes
     end
     
     # Returns the value of an attribute.
-    # [attr]  attribute name or key to return the value for
+    # @param [Symbol|String] attr attribute name or key to return the value for
     def [](attr)
       return nil unless instance_variable_defined?(:@attributes) and @attributes.is_a?(Hash)
       @attributes[attr] or (attr.is_a?(String) ? @attributes[attr.to_sym] : @attributes[attr.to_s])
     end
 
     # Adds or set an attribute of the Element.
-    # [attr]  attribute name or key
-    # [value] value for the attribute
+    # @param [Symbol|String] attr attribute name or key
+    # @param [Object] value value for the attribute
     def []=(attr, value)
       raise "argument to [] must be a Symbol or a String." unless attr.is_a?(Symbol) or attr.is_a?(String)
       @attributes = { } if !instance_variable_defined?(:@attributes) or @attributes.nil?
@@ -53,7 +54,8 @@ module Ox
 
     # Returns true if this Object and other are of the same type and have the
     # equivalent value and the equivalent elements otherwise false is returned.
-    # [other] Object compare _self_ to.
+    # @param [Object] other 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)

data/lib/ox/node.rb

@@ -6,14 +6,14 @@ module Ox
     attr_accessor :value
     
     # Creates a new Node with the specified String value.
-    # [value] value for the Node
+    # @param [String] value string value for the Node
     def initialize(value)
       @value = value.to_s
     end
 
     # Returns true if this Object and other are of the same type and have the
     # equivalent value otherwise false is returned.
-    # [other] Object compare _self_ to.
+    # @param [Object] other Object to compare _self_ to.
     def eql?(other)
       return false if (other.nil? or self.class != other.class)
       other.value == @value

data/lib/ox/version.rb

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

metadata

@@ -2,7 +2,7 @@
 name: ox
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.2.5
+  version: 1.2.6
 platform: ruby
 authors: 
 - Peter Ohler
@@ -10,7 +10,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-29 00:00:00 Z
+date: 2011-08-18 00:00:00 +09:00
+default_executable: 
 dependencies: []
 
 description: A fast XML parser and object serializer that uses only standard C lib.
@@ -48,7 +49,6 @@ files:
 - ext/ox/parse.c
 - test/bug1.rb
 - test/bug2.rb
-- test/bug3.rb
 - test/cache16_test.rb
 - test/cache8_test.rb
 - test/cache_test.rb
@@ -78,6 +78,7 @@ files:
 - test/Sample.graffle
 - LICENSE
 - README.rdoc
+has_rdoc: true
 homepage: https://github.com/ohler55/ox
 licenses: []
 
@@ -103,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ox
-rubygems_version: 1.8.5
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A fast XML parser and object serializer.

data/test/bug3.rb

@@ -1,23 +0,0 @@
-#!/usr/bin/env ruby -wW1
-
-$: << '../lib'
-$: << '../ext'
-
-if __FILE__ == $0
-  if (i = ARGV.index('-I'))
-    x,path = ARGV.slice!(i, 2)
-    $: << path
-  end
-end
-
-require 'ox'
-
-def dump(cnt = 100000)
-  cnt.times do |i|
-    xml = Ox.dump([:inc, 1])
-    #puts xml
-    
-  end
-end
-
-dump()