xmlhash 1.2.4 → 1.3.0

data/History.txt

@@ -1,3 +1,8 @@
+=== 1.3.0 / 2012-10-01
+
+* parse will no longer return a plain ruby Hash, but a XMLHash,
+  which is a subclass with some convenience functions added to it
+
 === 1.2.4 / 2012-09-27
 
 * set the encoding of the result to the encoding of the input

data/ext/xmlhash/xmlhash.c

@@ -1,4 +1,9 @@
 #include <assert.h>
+
+/* libxml headers first - see https://github.com/coolo/xmlhash/issues/1 */
+#include <libxml/parser.h>
+#include <libxml/xmlreader.h>
+
 #include <ruby.h>
 #ifdef HAVE_RUBY_ST_H
 # include <ruby/st.h>
@@ -11,13 +16,11 @@
 # include <ruby/encoding.h>
 #endif
 
-#include <libxml/parser.h>
-#include <libxml/xmlreader.h>
-
 static VALUE m_current = Qnil;
 static VALUE m_stack = Qnil;
 static VALUE m_cstring = Qnil;
 static VALUE m_result = Qnil;
+static VALUE m_xmlClass = Qnil;
 #ifdef HAVE_RUBY_ENCODING_H
 static rb_encoding *m_current_encoding = NULL;
 #endif
@@ -33,7 +36,7 @@ void xml_hash_start_element(const xmlChar *name)
 {
   VALUE pair;
   /* needed for further attributes */
-  m_current = rb_hash_new();
+  m_current = rb_class_new_instance(0, 0, m_xmlClass);
   pair = rb_ary_new();
   rb_ary_push(pair, rb_str_new2((const char*)name));
   rb_ary_push(pair, m_current);
@@ -223,6 +226,7 @@ void Init_xmlhash()
 
   LIBXML_TEST_VERSION
   mXmlhash = rb_define_module("Xmlhash");
+  m_xmlClass = rb_define_class_under(mXmlhash, "XMLHash", rb_cHash);
   rb_define_singleton_method(mXmlhash, "parse", &parse_xml_hash, 1);
   m_stack = rb_ary_new();
   rb_global_variable(&m_stack);

data/lib/xmlhash.rb

@@ -1,5 +1,60 @@
 require 'xmlhash/xmlhash'
 
 module Xmlhash
-  VERSION = '1.2.4'
+  VERSION = '1.3.0'
+
+  class XMLHash < Hash
+    
+    # Return an array of elements or []. It requires a plain string as argument
+    # 
+    # This makes it easy to write code that assumes an array. 
+    # If there is just a single child in the XML, it will be wrapped
+    # in a single-elemnt array and if there are no children, an empty
+    # array is returned.
+    # 
+    # You can also pass a block to iterate over all childrens.
+    def elements(name)
+      unless name.kind_of? String
+        raise ArgumentError, "expected string"
+      end
+      sub = self[name]
+      return [] unless sub
+      unless sub.kind_of? Array
+        if block_given?
+          yield sub
+          return
+        else
+          return [sub]
+        end
+      end
+      return sub unless block_given?
+      sub.each do |n|
+        yield n
+      end
+    end
+
+    # Return the element by the given name or an empty hash
+    # 
+    # This makes it easy to write code that assumes a child to be present.
+    # obj["a"]["b"] will give you a "[] not defined for nil".
+    # obj.get("a")["b"] will give you nil
+    def get(name)
+      sub = self[name]
+      return sub if sub
+      return XMLHash.new
+    end
+      
+    # Return the value of the name or nil if nothing is there
+    # 
+    def value(name)
+      sub = self[name.to_s]
+      return nil unless sub
+      return '' if sub.empty? # avoid {}
+      return sub
+    end
+    
+    def inspect
+      "X(#{super})"
+    end
+  end
 end 

data/test/test_xmlhash.rb

@@ -72,7 +72,7 @@ eos
   def test_entry
       xml = <<eos
 <?xml version='1.0' encoding='UTF-8'?>
-<directory>
+<directory count="4">
    <entry name="Apache"/>
    <entry name="Apache:APR_Pool_Debug"/>
    <entry name="Apache:MirrorBrain"/>
@@ -80,15 +80,18 @@ eos
 </directory>
 eos
 
-      rubyoutput = {"entry"=>
-	             [{"name"=>"Apache"},
-		      {"name"=>"Apache:APR_Pool_Debug"},
-		      {"name"=>"Apache:MirrorBrain"},
-		      {"name"=>"Apache:Modules"}]}
+    rubyoutput = {"count" => "4",
+      "entry"=>
+      [{"name"=>"Apache"},
+       {"name"=>"Apache:APR_Pool_Debug"},
+       {"name"=>"Apache:MirrorBrain"},
+       {"name"=>"Apache:Modules"}]}
+    
+    ret = Xmlhash.parse(xml)
+    assert_equal ret, rubyoutput
+
+    assert_equal ret.elements("entry").first.value("name"), "Apache"
 
-      ret = Xmlhash.parse(xml)
-     
-      assert_equal ret, rubyoutput
   end
 
   def test_encoding
@@ -100,6 +103,8 @@ eos
      xml = "<?xml version='1.0' encoding='UTF-8'?><name value='Adrian Schröter'/>"
      ret = Xmlhash.parse(xml)
      assert_equal ret, {"value"=>"Adrian Schröter"}
+
+     assert_equal ret.get("value"), "Adrian Schröter"
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xmlhash
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-27 00:00:00.000000000 Z
+date: 2012-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pkg-config