ox 2.3.0 → 2.4.0

data/lib/ox.rb

@@ -1,6 +1,7 @@
 # Copyright (c) 2011, Peter Ohler<br>
 # All rights reserved.
 
+#
 # === Description:
 # 
 # Ox handles XML documents in two ways. It is a generic XML parser and writer as

data/lib/ox/bag.rb

@@ -11,8 +11,12 @@ 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)
-    # @param [Hash] args instance variable symbols and their values
+    # - +args+ [Hash] instance variable symbols and their values
+    #
+    # *Example*
+    #
+    #  Ox::Bag.new(:@x => 42, :@y => 57)
+    #
     def initialize(args={ })
       args.each do |k,v|
         self.instance_variable_set(k, v)
@@ -20,9 +24,9 @@ module Ox
     end
 
     # 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.
+    # - +m+ [Symbol] method symbol
+    # *return* [Boolean] true for any method that matches an instance variable
+    # reader, otherwise false.
     def respond_to?(m)
       return true if super
       at_m = ('@' + m.to_s).to_sym
@@ -31,10 +35,12 @@ module Ox
 
     # Handles requests for variable values. Others cause an Exception to be
     # raised.
-    # @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.
+    # - +m+ (Symbol) 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) to method #{m}") unless args.nil? or args.empty?
       at_m = ('@' + m.to_s).to_sym
@@ -43,8 +49,8 @@ module Ox
     end
 
     # 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.
+    # - +other+ [Object] 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
@@ -61,9 +67,10 @@ 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.
-    # @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.
+    # - +classname+ (String) 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 }

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.
-    # @param value [String] value for the CDATA contents
+    # - +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.
-    # @param value [String] string value for the comment
+    # - +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.
-    # @param value [String] string value for the element
+    # - +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.
-    # @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
+    # - +prolog+ [Hash] prolog attributes
+    #   - _:version_ [String] version, typically '1.0' or '1.1'
+    #   - _:encoding_ [String] encoding for the document, currently included but ignored
+    #   - _:standalone_ [String] indicates the document is standalone
     def initialize(prolog={})
       super(nil)
       @attributes = { }

data/lib/ox/element.rb

@@ -1,3 +1,4 @@
+
 module Ox
 
   # An Element represents a element of an XML document. It has a name,
@@ -32,12 +33,11 @@ module Ox
   #   => "Makie"
   #   doc.People.Person.age
   #   => "58"
-
   class Element < Node
     include HasAttrs
     
     # Creates a new Element with the specified name.
-    # @param [String] name name of the Element
+    # - +name+ [String] name of the Element
     def initialize(name)
       super
       @attributes = {}
@@ -47,7 +47,7 @@ module Ox
     
     # Returns the Element's nodes array. These are the sub-elements of this
     # Element.
-    # @return [Array] all child Nodes.
+    # *return* [Array] all child Nodes.
     def nodes
       @nodes = [] if !instance_variable_defined?(:@nodes) or @nodes.nil?
       @nodes
@@ -55,7 +55,7 @@ module Ox
 
     # Appends a Node to the Element's nodes array. Returns the element itself
     # so multiple appends can be chained together.
-    # @param [Node] node Node to append to the nodes array
+    # - +node+ [Node] Node to append to the nodes array
     def <<(node)
       raise "argument to << must be a String or Ox::Node." unless node.is_a?(String) or node.is_a?(Node)
       @nodes = [] if !instance_variable_defined?(:@nodes) or @nodes.nil?
@@ -65,8 +65,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.
-    # @param [Object] other Object compare _self_ to.
-    # @return [Boolean] true if both Objects are equivalent, otherwise false.
+    # - +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)
@@ -85,7 +85,7 @@ module Ox
 
     # Clears any child nodes of an element and replaces those with a single Text
     # (String) node. Note the existing nodes array is modified and not replaced.
-    # @param [String] txt to become the only element of the nodes array
+    # - +txt+ [String] to become the only element of the nodes array
     def replace_text(txt)
       raise "the argument to replace_text() must be a String" unless txt.is_a?(String)
       @nodes.clear()
@@ -127,7 +127,7 @@ module Ox
     # * <code>element.locate("Family/*/@type")</code> returns the type attribute value for decendents of the Family.
     # * <code>element.locate("Family/^Comment")</code> returns any comments that are a child of Family.
     #
-    # @param [String] path path to the Nodes to locate
+    # - +path+ [String] path to the Nodes to locate
     def locate(path)
       return [self] if path.nil?
       found = []
@@ -138,9 +138,10 @@ module Ox
     
     # Handles the 'easy' API that allows navigating a simple XML by
     # referencing elements and attributes by name.
-    # @param [Symbol] id element or attribute name
-    # @return [Element|Node|String|nil] the element, attribute value, or Node identifed by the name
-    # @raise [NoMethodError] if no match is found
+    # - +id+ [Symbol] element or attribute name
+    # *return* [Element|Node|String|nil] the element, attribute value, or Node identifed by the name
+    #
+    # _raise_ [NoMethodError] if no match is found
     def method_missing(id, *args, &block)
       has_some = false
       ids = id.to_s
@@ -160,9 +161,9 @@ module Ox
       raise NoMethodError.new("#{ids} not found", name)
     end
 
-    # @param [String|Symbol] id identifer of the attribute or method
-    # @param inc_all [Boolean] ignored
-    # @return true if the element has a member that matches the provided name.
+    # - +id+ [String|Symbol] identifer of the attribute or method
+    # - +ignored+ inc_all [Boolean]
+    # *return* true if the element has a member that matches the provided name.
     def respond_to?(id, inc_all=false)
       return true if super
       id_str = id.to_s
@@ -178,8 +179,8 @@ module Ox
       false
     end
 
-    # @param [Array] path array of steps in a path
-    # @param [Array] found matching nodes
+    # - +path+ [Array] array of steps in a path
+    # - +found+ [Array] matching nodes
     def alocate(path, found)
       step = path[0]
       if step.start_with?('@') # attribute

data/lib/ox/error.rb

@@ -1,6 +1,7 @@
 
 module Ox
 
+  # Base error class for Ox errors.
   class Error < StandardError
   end # Error
 
@@ -14,6 +15,7 @@ module Ox
 
   # An Exception raised if a path is not valid.
   class InvalidPath < Error
+    # Create a new instance with the +path+ specified.
     def initialize(path)
       super("#{path.join('/')} is not a valid location.")
     end

data/lib/ox/hasattrs.rb

@@ -6,25 +6,24 @@ module Ox
   #
   # To access the attributes there are several options. One is to walk the attributes. The easiest for simple regularly
   # formatted XML is to reference the attributes simply by name.
-
   module HasAttrs
     # Returns all the attributes of the Instruct as a Hash.
-    # @return [Hash] all attributes and attribute values.
+    # *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.
-    # @param [Symbol|String] attr attribute name or key to return the value for
+    # - +attr+ [Symbol|String] 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 Instruct.
-    # @param [Symbol|String] attr attribute name or key
-    # @param [Object] value value for the attribute
+    # - +attr+ [Symbol|String] attribute name or key
+    # - +value+ [Object] 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?
@@ -33,9 +32,9 @@ module Ox
     
     # Handles the 'easy' API that allows navigating a simple XML by
     # referencing attributes by name.
-    # @param [Symbol] id element or attribute name
-    # @return [String|nil] the attribute value
-    # @raise [NoMethodError] if no match is found
+    # - +id+ [Symbol] element or attribute name
+    # *return* [String|nil] the attribute value
+    # _raise_ [NoMethodError] if no match is found
     def method_missing(id, *args, &block)
       ids = id.to_s
       if instance_variable_defined?(:@attributes)

data/lib/ox/instruct.rb

@@ -5,7 +5,6 @@ module Ox
   # content. The content will be all characters with the exception of the target. If the content follows a regular
   # attribute format then the attributes will be set to the parsed values. If it does not follow the attribute formate
   # then the attributes will be empty.
-
   class Instruct < Node
     include HasAttrs
 
@@ -13,7 +12,7 @@ module Ox
     attr_accessor :content
 
     # Creates a new Instruct with the specified name.
-    # @param [String] name name of the Instruct
+    # - +name+ [String] name of the Instruct
     def initialize(name)
       super
       @attributes = nil
@@ -23,8 +22,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.
-    # @param [Object] other Object compare _self_ to.
-    # @return [Boolean] true if both Objects are equivalent, otherwise false.
+    # - +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)

data/lib/ox/node.rb

@@ -6,14 +6,14 @@ module Ox
     attr_accessor :value
     
     # Creates a new Node with the specified String value.
-    # @param [String] value string value for the Node
+    # - +value+ [String] 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.
-    # @param [Object] other Object to compare _self_ to.
+    # - +other+ [Object] Object to compare _self_ to.
     def eql?(other)
       return false if (other.nil? or self.class != other.class)
       other.value == self.value

data/lib/ox/raw.rb

@@ -5,7 +5,7 @@ module Ox
   # injected as-is.
   class Raw < Node
     # Creates a new Raw element with the specified value.
-    # @param value [String] string value for the comment
+    # - +value+ [String] string value for the comment
     def initialize(value)
       super
     end

data/lib/ox/sax.rb

@@ -1,9 +1,11 @@
+
 module Ox
   # A SAX style parse handler. The Ox::Sax handler class should be subclasses
   # and then used with the Ox.sax_parse() method. The Sax methods will then be
   # called as the file is parsed. This is best suited for very large files or
   # IO streams.<p/>
-  # @example
+  #
+  # *Example*
   # 
   #  require 'ox'
   #
@@ -45,11 +47,11 @@ module Ox
   #    def start_element(name); end
   #    def end_element(name); end
   #
-  # Initializing @line in the initializer will cause that variable to be updated
-  # before each callback with the XML line number. The same is true for the
-  # @column but it will be updated with the column in the XML file that is the
-  # start of the element or node just read. @pos if defined will hold the number
-  # of bytes from the start of the document.
+  # Initializing _line_ attribute in the initializer will cause that variable to
+  # be updated before each callback with the XML line number. The same is true
+  # for the _column_ attribute but it will be updated with the column in the XML
+  # file that is the start of the element or node just read. @pos if defined
+  # will hold the number of bytes from the start of the document.
   class Sax
     # Create a new instance of the Sax handler class.
     def initialize()

data/lib/ox/version.rb

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

data/lib/ox/xmlrpc_adapter.rb

@@ -11,12 +11,13 @@ module Ox
   #   require 'ox/xmlrpc_adapter'
   #   client = XMLRPC::Client.new2('http://some_server/rpc')
   #   client.set_parser(Ox::StreamParser.new)
-  #
   class StreamParser < XMLRPC::XMLParser::AbstractStreamParser
+    # Create a new instance.
     def initialize
       @parser_class = OxParser
     end
 
+    # The SAX wrapper.
     class OxParser < Ox::Sax
       include XMLRPC::XMLParser::StreamParserMixin
 
@@ -24,6 +25,7 @@ module Ox
       alias :end_element :endElement
       alias :start_element :startElement
 
+      # Initiates the sax parser with the provided string.
       def parse(str)
         Ox.sax_parse(self, StringIO.new(str), :symbolize => false, :convert_special => true)
       end

metadata

@@ -1,19 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: ox
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
+  prerelease: 
 platform: ruby
 authors:
 - Peter Ohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-21 00:00:00.000000000 Z
+date: 2016-04-14 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. It was designed to be an alternative to Nokogiri and other
-  Ruby\nXML parsers for generic XML parsing and as an alternative to Marshal for Object\nserialization. "
+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. It was designed to be an alternative to Nokogiri
+  and other Ruby\nXML parsers for generic XML parsing and as an alternative to Marshal
+  for Object\nserialization. "
 email: peter@ohler.com
 executables: []
 extensions:
@@ -21,81 +23,84 @@ extensions:
 extra_rdoc_files:
 - README.md
 files:
-- LICENSE
-- README.md
+- lib/ox/bag.rb
+- lib/ox/cdata.rb
+- lib/ox/comment.rb
+- lib/ox/doctype.rb
+- lib/ox/document.rb
+- lib/ox/element.rb
+- lib/ox/error.rb
+- lib/ox/hasattrs.rb
+- lib/ox/instruct.rb
+- lib/ox/node.rb
+- lib/ox/raw.rb
+- lib/ox/sax.rb
+- lib/ox/version.rb
+- lib/ox/xmlrpc_adapter.rb
+- lib/ox.rb
+- ext/ox/extconf.rb
 - ext/ox/attr.h
-- ext/ox/base64.c
 - ext/ox/base64.h
-- ext/ox/cache.c
+- ext/ox/buf.h
 - ext/ox/cache.h
-- ext/ox/cache8.c
 - ext/ox/cache8.h
-- ext/ox/cache8_test.c
-- ext/ox/cache_test.c
+- ext/ox/err.h
+- ext/ox/helper.h
+- ext/ox/ox.h
+- ext/ox/sax.h
+- ext/ox/sax_buf.h
+- ext/ox/sax_has.h
+- ext/ox/sax_hint.h
+- ext/ox/sax_stack.h
+- ext/ox/special.h
+- ext/ox/type.h
+- ext/ox/base64.c
+- ext/ox/builder.c
+- ext/ox/cache.c
+- ext/ox/cache8.c
 - ext/ox/dump.c
-- ext/ox/encode.h
 - ext/ox/err.c
-- ext/ox/err.h
-- ext/ox/extconf.rb
 - ext/ox/gen_load.c
-- ext/ox/helper.h
 - ext/ox/obj_load.c
 - ext/ox/ox.c
-- ext/ox/ox.h
 - ext/ox/parse.c
 - ext/ox/sax.c
-- ext/ox/sax.h
 - ext/ox/sax_as.c
 - ext/ox/sax_buf.c
-- ext/ox/sax_buf.h
-- ext/ox/sax_has.h
 - ext/ox/sax_hint.c
-- ext/ox/sax_hint.h
-- ext/ox/sax_stack.h
 - ext/ox/special.c
-- ext/ox/special.h
-- ext/ox/type.h
-- lib/ox.rb
-- lib/ox/bag.rb
-- lib/ox/cdata.rb
-- lib/ox/comment.rb
-- lib/ox/doctype.rb
-- lib/ox/document.rb
-- lib/ox/element.rb
-- lib/ox/error.rb
-- lib/ox/hasattrs.rb
-- lib/ox/instruct.rb
-- lib/ox/node.rb
-- lib/ox/raw.rb
-- lib/ox/sax.rb
-- lib/ox/version.rb
-- lib/ox/xmlrpc_adapter.rb
+- LICENSE
+- README.md
 homepage: http://www.ohler.com/ox
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options:
-- "--main"
+- --main
 - README.md
+- --title
+- Ox Documentation
+- --exclude
+- extconf.rb
 require_paths:
 - lib
 - ext
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: ox
-rubygems_version: 2.4.5
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: A fast XML parser and object serializer.
 test_files: []
-has_rdoc: true