ox 2.14.14 → 2.14.15

data/ext/ox/special.h

@@ -8,7 +8,7 @@
 
 #include <stdint.h>
 
-extern char*	ox_ucs_to_utf8_chars(char *text, uint64_t u);
-extern char*	ox_entity_lookup(char *text, const char *key);
+extern char *ox_ucs_to_utf8_chars(char *text, uint64_t u);
+extern char *ox_entity_lookup(char *text, const char *key);
 
 #endif /* OX_SPECIAL_H */

data/ext/ox/type.h

@@ -7,31 +7,31 @@
 #define OX_TYPE_H
 
 typedef enum {
-    NoCode	   = 0,
-    ArrayCode	   = 'a',
+    NoCode         = 0,
+    ArrayCode      = 'a',
     String64Code   = 'b', /* base64 encoded String */
-    ClassCode	   = 'c',
+    ClassCode      = 'c',
     Symbol64Code   = 'd', /* base64 encoded Symbol */
-    DateCode	   = 'D',
+    DateCode       = 'D',
     BigDecimalCode = 'B',
     ExceptionCode  = 'e',
-    FloatCode	   = 'f',
-    RegexpCode	   = 'g',
-    HashCode	   = 'h',
-    FixnumCode	   = 'i',
-    BignumCode	   = 'j',
-    KeyCode	   = 'k', /* indicates the value is a hash key, kind of a hack */
+    FloatCode      = 'f',
+    RegexpCode     = 'g',
+    HashCode       = 'h',
+    FixnumCode     = 'i',
+    BignumCode     = 'j',
+    KeyCode        = 'k', /* indicates the value is a hash key, kind of a hack */
     RationalCode   = 'l',
-    SymbolCode	   = 'm',
+    SymbolCode     = 'm',
     FalseClassCode = 'n',
-    ObjectCode	   = 'o',
-    RefCode	   = 'p',
-    RangeCode	   = 'r',
-    StringCode	   = 's',
-    TimeCode	   = 't',
-    StructCode	   = 'u',
-    ComplexCode	   = 'v',
-    RawCode	   = 'x',
+    ObjectCode     = 'o',
+    RefCode        = 'p',
+    RangeCode      = 'r',
+    StringCode     = 's',
+    TimeCode       = 't',
+    StructCode     = 'u',
+    ComplexCode    = 'v',
+    RawCode        = 'x',
     TrueClassCode  = 'y',
     NilClassCode   = 'z',
 } Type;

data/lib/ox/bag.rb

@@ -1,13 +1,10 @@
-
 module Ox
-
   # A generic class that is used only for storing attributes. It is the base
   # Class for auto-generated classes in the storage system. Instance variables
   # are added using the instance_variable_set() method. All instance variables
   # can be accessed using the variable name (without the @ prefix). No setters
   # are provided as the Class is intended for reading only.
   class Bag
-
     # 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.
@@ -17,9 +14,9 @@ module Ox
     #
     #  Ox::Bag.new(:@x => 42, :@y => 57)
     #
-    def initialize(args={ })
-      args.each do |k,v|
-        self.instance_variable_set(k, v)
+    def initialize(args={})
+      args.each do |k, v|
+        instance_variable_set(k, v)
       end
     end
 
@@ -29,6 +26,7 @@ module Ox
     # reader, otherwise false.
     def respond_to?(m)
       return true if super
+
       at_m = ('@' + m.to_s).to_sym
       instance_variables.include?(at_m)
     end
@@ -42,9 +40,13 @@ module Ox
     #
     # _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?
+      unless args.nil? or args.empty?
+        raise ArgumentError.new("wrong number of arguments (#{args.size} for 0) to method #{m}")
+      end
+
       at_m = ('@' + m.to_s).to_sym
       raise NoMethodError.new("undefined method #{m}", m) unless instance_variable_defined?(at_m)
+
       instance_variable_get(at_m)
     end
 
@@ -53,16 +55,18 @@ module Ox
     # *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
       iv = instance_variables
       return false if ova.size != iv.size
+
       iv.each do |vid|
         return false if instance_variable_get(vid) != other.instance_variable_get(vid)
       end
       true
     end
     alias == eql?
-    
+
     # Define a new class based on the Ox::Bag class. This is used internally in
     # the Ox module and is available to service wrappers that receive XML
     # requests that include Objects of Classes not defined in the storage
@@ -75,6 +79,7 @@ module Ox
       classname = classname.to_s unless classname.is_a?(String)
       tokens = classname.split('::').map { |n| n.to_sym }
       raise NameError.new("Invalid classname '#{classname}") if tokens.empty?
+
       m = Object
       tokens[0..-2].each do |sym|
         if m.const_defined?(sym)
@@ -94,6 +99,5 @@ module Ox
       end
       c
     end
-
   end # Bag
 end # Ox

data/lib/ox/cdata.rb

@@ -1,4 +1,3 @@
-
 module Ox
   # CData represents a CDATA element in an XML document.
   class CData < Node
@@ -7,6 +6,5 @@ module Ox
     def initialize(value)
       super
     end
-
   end # CData
 end # Ox

data/lib/ox/comment.rb

@@ -1,4 +1,3 @@
-
 module Ox
   # Comments represent XML comments in an XML document. A comment has a value
   # attribute only.
@@ -8,6 +7,5 @@ module Ox
     def initialize(value)
       super
     end
-
   end # Comment
 end # Ox

data/lib/ox/doctype.rb

@@ -1,4 +1,3 @@
-
 module Ox
   # Represents a DOCTYPE in an XML document.
   class DocType < Node
@@ -8,6 +7,5 @@ module Ox
     def initialize(value)
       super
     end
-
   end # DocType
 end # Ox

data/lib/ox/document.rb

@@ -1,4 +1,3 @@
-
 module Ox
   # Represents an XML document. It has a fixed set of attributes which form
   # the XML prolog. A Document includes Elements.
@@ -10,14 +9,14 @@ module Ox
     #   - _:standalone_ [String] indicates the document is standalone
     def initialize(prolog={})
       super(nil)
-      @attributes = { }
+      @attributes = {}
       @attributes[:version] = prolog[:version] unless prolog[:version].nil?
       @attributes[:encoding] = prolog[:encoding] unless prolog[:encoding].nil?
       @attributes[:standalone] = prolog[:standalone] unless prolog[:standalone].nil?
     end
-    
+
     # Returns the first Element in the document.
-    def root()
+    def root
       unless !instance_variable_defined?(:@nodes) || @nodes.nil?
         @nodes.each do |n|
           return n if n.is_a?(::Ox::Element)
@@ -25,6 +24,5 @@ module Ox
       end
       nil
     end
-
   end # Document
 end # Ox

data/lib/ox/element.rb

@@ -1,6 +1,4 @@
-
 module Ox
-
   # An Element represents a element of an XML document. It has a name,
   # attributes, and sub-nodes.
   #
@@ -58,7 +56,8 @@ module Ox
     # so multiple appends can be chained together.
     # - +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)
+      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?
       @nodes << node
       self
@@ -68,7 +67,8 @@ module Ox
     # so multiple appends can be chained together.
     # - +node+ [Node] Node to prepend to the nodes array
     def prepend_child(node)
-      raise "argument to << must be a String or Ox::Node." unless node.is_a?(String) or node.is_a?(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?
       @nodes.unshift(node)
       self
@@ -80,15 +80,16 @@ module Ox
     # *return* [Boolean] true if both Objects are equivalent, otherwise false.
     def eql?(other)
       return false unless super(other)
-      return false unless self.attributes == other.attributes
-      return false unless self.nodes == other.nodes
+      return false unless attributes == other.attributes
+      return false unless nodes == other.nodes
+
       true
     end
     alias == eql?
 
     # Returns the first String in the elements nodes array or nil if there is
     # no String node.
-    def text()
+    def text
       nodes.each { |n| return n if n.is_a?(String) }
       nil
     end
@@ -97,15 +98,16 @@ module Ox
     # (String) node. Note the existing nodes array is modified and not replaced.
     # - +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()
+      raise 'the argument to replace_text() must be a String' unless txt.is_a?(String)
+
+      @nodes.clear
       @nodes << txt
     end
 
     # Return true if all the key-value pairs in the cond Hash match the
     # @attributes key-values.
     def attr_match(cond)
-      cond.each_pair { |k,v| return false unless v == @attributes[k.to_sym] || v == @attributes[k.to_s] }
+      cond.each_pair { |k, v| return false unless v == @attributes[k.to_sym] || v == @attributes[k.to_s] }
       true
     end
 
@@ -161,6 +163,7 @@ module Ox
     # - +path+ [String] path to the Nodes to locate
     def locate(path)
       return [self] if path.nil?
+
       found = []
       pa = path.split('/')
       if '*' == path[0]
@@ -183,6 +186,7 @@ module Ox
     # - +children+ [Array] array of OX
     def remove_children(*children)
       return self if children.compact.empty?
+
       recursive_children_removal(children.compact.map { |c| c.object_id })
       self
     end
@@ -198,6 +202,7 @@ module Ox
       del_locate(path.split('/')) unless path.nil?
       self
     end
+
     # Handles the 'easy' API that allows navigating a simple XML by
     # referencing elements and attributes by name.
     # - +id+ [Symbol] element or attribute name
@@ -209,17 +214,20 @@ module Ox
       ids = id.to_s
       i = args[0].to_i # will be 0 if no arg or parsing fails
       nodes.each do |n|
-        if (n.is_a?(Element) || n.is_a?(Instruct)) && (n.value == id || n.value == ids || name_matchs?(n.value, ids))
-          return n if 0 == i
-          has_some = true
-          i -= 1
+        unless (n.is_a?(Element) || n.is_a?(Instruct)) && (n.value == id || n.value == ids || name_matchs?(n.value, ids))
+          next
         end
+        return n if 0 == i
+
+        has_some = true
+        i -= 1
       end
       if instance_variable_defined?(:@attributes)
         return @attributes[id] if @attributes.has_key?(id)
         return @attributes[ids] if @attributes.has_key?(ids)
       end
       return nil if has_some
+
       raise NoMethodError.new("#{ids} not found", name)
     end
 
@@ -228,6 +236,7 @@ module Ox
     # *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
       id_sym = id.to_sym
       nodes.each do |n|
@@ -247,10 +256,11 @@ module Ox
       step = path[0]
       if step.start_with?('@') # attribute
         raise InvalidPath.new(path) unless 1 == path.size
+
         if instance_variable_defined?(:@attributes)
           step = step[1..-1]
           sym_step = step.to_sym
-          @attributes.each do |k,v|
+          @attributes.each do |k, v|
             found << v if ('?' == step or k == step or k == sym_step)
           end
         end
@@ -261,6 +271,7 @@ module Ox
         else
           name = step[0..i-1]
           raise InvalidPath.new(path) unless step.end_with?(']')
+
           i += 1
           qual = step[i..i] # step[i] would be better but some rubies (jruby, ree, rbx) take that as a Fixnum.
           if '0' <= qual and qual <= '9'
@@ -270,13 +281,13 @@ module Ox
           end
           index = step[i..-2].to_i
         end
-        if '?' == name or '*' == name
+        if ['?', '*'].include?(name)
           match = nodes
         elsif '^' == name[0..0] # 1.8.7 thinks name[0] is a fixnum
           case name[1..-1]
-           when 'Element'
+          when 'Element'
             match = nodes.select { |e| e.is_a?(Element) }
-           when 'String', 'Text'
+          when 'String', 'Text'
             match = nodes.select { |e| e.is_a?(String) }
           when 'Comment'
             match = nodes.select { |e| e.is_a?(Comment) }
@@ -285,7 +296,7 @@ module Ox
           when 'DocType'
             match = nodes.select { |e| e.is_a?(DocType) }
           else
-            #puts "*** no match on #{name}"
+            # puts "*** no match on #{name}"
             match = []
           end
         else
@@ -302,7 +313,7 @@ module Ox
           when '>'
             match = index <= match.size ? match[index + 1..-1] : []
           when '@'
-            k,v = step[i..-2].split('=')
+            k, v = step[i..-2].split('=')
             if v
               match = match.select { |n| n.is_a?(Element) && (v == n.attributes[k.to_sym] || v == n.attributes[k]) }
             else
@@ -328,10 +339,11 @@ module Ox
       step = path[0]
       if step.start_with?('@') # attribute
         raise InvalidPath.new(path) unless 1 == path.size
+
         if instance_variable_defined?(:@attributes)
           step = step[1..-1]
           sym_step = step.to_sym
-          @attributes.delete_if { |k,v| '?' == step || k.to_sym == sym_step }
+          @attributes.delete_if { |k, v| '?' == step || k.to_sym == sym_step }
         end
       else # element name
         if (i = step.index('[')).nil? # just name
@@ -340,6 +352,7 @@ module Ox
         else
           name = step[0..i-1]
           raise InvalidPath.new(path) unless step.end_with?(']')
+
           i += 1
           qual = step[i..i] # step[i] would be better but some rubies (jruby, ree, rbx) take that as a Fixnum.
           if '0' <= qual and qual <= '9'
@@ -349,13 +362,13 @@ module Ox
           end
           index = step[i..-2].to_i
         end
-        if '?' == name or '*' == name
+        if ['?', '*'].include?(name)
           match = nodes
         elsif '^' == name[0..0] # 1.8.7 thinks name[0] is a fixnum
           case name[1..-1]
-           when 'Element'
+          when 'Element'
             match = nodes.select { |e| e.is_a?(Element) }
-           when 'String', 'Text'
+          when 'String', 'Text'
             match = nodes.select { |e| e.is_a?(String) }
           when 'Comment'
             match = nodes.select { |e| e.is_a?(Comment) }
@@ -364,7 +377,7 @@ module Ox
           when 'DocType'
             match = nodes.select { |e| e.is_a?(DocType) }
           else
-            #puts "*** no match on #{name}"
+            # puts "*** no match on #{name}"
             match = []
           end
         else
@@ -381,7 +394,7 @@ module Ox
           when '>'
             match = index <= match.size ? match[index + 1..-1] : []
           when '@'
-            k,v = step[i..-2].split('=')
+            k, v = step[i..-2].split('=')
             if v
               match = match.select { |n| n.is_a?(Element) && (v == n.attributes[k.to_sym] || v == n.attributes[k]) }
             else
@@ -427,6 +440,7 @@ module Ox
     # - +found+ [Array] An array of Ox::Element
     def recursive_children_removal(found)
       return if found.empty?
+
       nodes.tap do |ns|
         # found.delete(n.object_id) stops looking for an already found object_id
         ns.delete_if { |n| found.include?(n.object_id) ? found.delete(n.object_id) : false }
@@ -438,6 +452,7 @@ module Ox
 
     def name_matchs?(pat, id)
       return false unless pat.length == id.length
+
       pat.length.times { |i| return false unless '_' == id[i] || pat[i] == id[i] }
       true
     end

data/lib/ox/error.rb

@@ -1,6 +1,4 @@
-
 module Ox
-
   # Base error class for Ox errors.
   class Error < StandardError
   end # Error
@@ -24,5 +22,4 @@ module Ox
       super("#{path.join('/')} is not a valid location.")
     end
   end # InvalidPath
-
 end # Ox

data/lib/ox/hasattrs.rb

@@ -1,6 +1,4 @@
-
 module Ox
-
   # An Object that includes the HasAttrs module can have attributes which are a Hash of String values and either String
   # or Symbol keys.
   #
@@ -10,7 +8,7 @@ module Ox
     # Returns all the attributes of the Instruct as a Hash.
     # *return* [Hash] all attributes and attribute values.
     def attributes
-      @attributes = { } if !instance_variable_defined?(:@attributes) or @attributes.nil?
+      @attributes = {} if !instance_variable_defined?(:@attributes) or @attributes.nil?
       @attributes
     end
 
@@ -18,6 +16,7 @@ module Ox
     # - +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
 
@@ -25,14 +24,15 @@ module Ox
     # - +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?
+      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?
       a_str = attr.to_s
       a_sym = attr.to_sym
       if @attributes.has_key?(a_str)
-	attr = a_str
+        attr = a_str
       elsif @attributes.has_key?(a_sym)
-	attr = a_sym
+        attr = a_sym
       end
       @attributes[attr] = value.to_s
     end
@@ -50,6 +50,5 @@ module Ox
       end
       raise NoMethodError.new("#{ids} not found", name)
     end
-
   end # HasAttrs
 end # Ox

data/lib/ox/instruct.rb

@@ -1,6 +1,4 @@
-
 module Ox
-
   # An Instruct represents a processing instruction of an XML document. It has a target, attributes, and a value or
   # 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
@@ -19,18 +17,18 @@ module Ox
       @content = nil
     end
     alias target value
-    
+
     # 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] Object compare _self_ to.
     # *return* [Boolean] true if both Objects are equivalent, otherwise false.
     def eql?(other)
       return false unless super(other)
-      return false unless self.attributes == other.attributes
-      return false unless self.content == other.content
+      return false unless attributes == other.attributes
+      return false unless content == other.content
+
       true
     end
     alias == eql?
-    
   end # Instruct
 end # Ox

data/lib/ox/node.rb

@@ -1,10 +1,9 @@
-
 module Ox
   # The Node is the base class for all other in the Ox module.
   class Node
     # String value associated with the Node.
     attr_accessor :value
-    
+
     # Creates a new Node with the specified String value.
     # - +value+ [String] string value for the Node
     def initialize(value)
@@ -16,9 +15,9 @@ module Ox
     # - +other+ [Object] Object to compare _self_ to.
     def eql?(other)
       return false if (other.nil? or self.class != other.class)
-      other.value == self.value
+
+      other.value == value
     end
     alias == eql?
-
   end # Node
 end # Ox

data/lib/ox/raw.rb

@@ -1,4 +1,3 @@
-
 module Ox
   # Raw elements are used to inject existing XML strings into a document
   # WARNING: Use of this feature can result in invalid XML, since `value` is
@@ -9,6 +8,5 @@ module Ox
     def initialize(value)
       super
     end
-
   end # Raw
 end # Ox

data/lib/ox/sax.rb

@@ -1,4 +1,3 @@
-
 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
@@ -6,7 +5,7 @@ module Ox
   # IO streams.<p/>
   #
   # *Example*
-  # 
+  #
   #  require 'ox'
   #
   #  class MySax < ::Ox::Sax
@@ -56,10 +55,10 @@ module Ox
   # 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()
-      #@pos = nil
-      #@line = nil
-      #@column = nil
+    def initialize
+      # @pos = nil
+      # @line = nil
+      # @column = nil
     end
 
     # To make the desired methods active while parsing the desired method
@@ -67,47 +66,32 @@ module Ox
     # they will not be called during parsing.
     private
 
-    def instruct(target)
-    end
+    def instruct(target); end
 
-    def end_instruct(target)
-    end
+    def end_instruct(target); end
 
-    def attr(name, str)
-    end
+    def attr(name, str); end
 
-    def attr_value(name, value)
-    end
+    def attr_value(name, value); end
 
-    def attrs_done()
-    end
+    def attrs_done; end
 
-    def doctype(str)
-    end
+    def doctype(str); end
 
-    def comment(str)
-    end
+    def comment(str); end
 
-    def cdata(str)
-    end
+    def cdata(str); end
 
-    def text(str)
-    end
+    def text(str); end
 
-    def value(value)
-    end
+    def value(value); end
 
-    def start_element(name)
-    end
+    def start_element(name); end
 
-    def end_element(name)
-    end
-    
-    def error(message, line, column)
-    end
+    def end_element(name); end
 
-    def abort(name)
-    end
-    
+    def error(message, line, column); end
+
+    def abort(name); end
   end # Sax
 end # Ox

data/lib/ox/version.rb

@@ -1,5 +1,4 @@
-
 module Ox
   # Current version of the module.
-  VERSION = '2.14.14'
+  VERSION = '2.14.15'
 end