rtiss_libxml_to_hash 0.3.0

data/lib/rtiss_libxml_to_hash.rb

@@ -0,0 +1,156 @@
+# -*- encoding : utf-8 -*-
+
+# USAGE: Hash.from_libxml(YOUR_XML_STRING)
+require 'xml/libxml'
+# adapted from 
+# http://movesonrails.com/articles/2008/02/25/libxml-for-active-resource-2-0
+
+# This class is required to represent Nodes that contain 
+# attributes as well as other content, for example:
+# <karin zak="lebt">schon</karin>
+# We cannot non-ambigiously represent this node as a hash
+# because Hashes may contain arbitrary keys.
+# Having a separate class for representing such nodes
+# allows for easy testing for the class (which we have
+# to do anyway since hash values may be Strings, Arrays
+# or other Hashes already)
+# Update: No need for testing when using the iterable method.
+# Usage: LibXmlNode.new("karin", "zak")
+
+class LibXmlNode < Object
+  VERSION = '0.3.0'
+
+  attr_accessor :subnodes
+  attr_accessor :attributes
+  attr_accessor :text
+
+  def initialize
+    @subnodes = {}
+    @attributes = {}
+    @text = ""
+  end
+
+  def self.create(n, a, t)
+    l = LibXmlNode.new
+    l.subnodes = n
+    l.attributes = a
+    l.text = t
+    l
+  end
+
+  def add_attribute(key, value)
+    @attributes[key] = value
+  end
+    
+  def add_node(key, value)
+    if @subnodes[key] 
+      if @subnodes[key].is_a? Object::Array
+        @subnodes[key] << value
+      else
+        @subnodes[key] = [@subnodes[key], value]
+      end
+    else
+      @subnodes[key] = value
+    end
+  end
+  
+  def add_text(t)
+    @text << t
+  end
+
+  def simplify
+    if @attributes.empty?
+      if @text == ""
+        return @subnodes
+      end
+      if @subnodes == {}
+        return @text
+      end
+    end
+    return self
+  end
+ 
+  def ==(other)
+    if other.class == LibXmlNode
+      if @subnodes == other.subnodes and @attributes == other.attributes and @text == other.text
+        return true
+      end
+    end
+    false
+  end
+
+  def iterable
+    [self]
+  end
+end
+
+class Hash 
+  def iterable
+    [self]
+  end
+
+  def to_libxmlnode
+    LibXmlNode.create(self, {}, "")
+  end
+
+  class << self
+    def from_libxml!(xml, strict=true) 
+      XML.default_load_external_dtd = false
+      XML.default_pedantic_parser = strict
+      result = XML::Parser.string(xml).parse 
+      return { result.root.name.to_s => xml_node_to_hash(result.root)} 
+    end 
+
+    def from_libxml(xml, strict=true) 
+      begin
+        from_libxml!(xml, strict)
+      rescue Exception => e
+        nil
+      end
+    end 
+
+    def xml_node_to_hash(node) 
+      n = LibXmlNode.new
+      if node.element? 
+        node.attributes.each do |attribute|
+          n.add_attribute attribute.name.to_s, attribute.value
+        end
+
+        node.each_child do |child| 
+          if child.text?
+            if not child.children?
+              n.add_text child.content.to_s.strip
+            end
+          else
+            n.add_node child.name.to_s, xml_node_to_hash(child) 
+          end
+        end
+      end 
+      return n.simplify
+    end
+  end
+end
+
+class String
+  def iterable
+    [self]
+  end
+
+  def to_b
+    self.upcase == 'TRUE' or self == '1'
+  end
+
+  def to_libxmlnode
+    LibXmlNode.create({}, {}, self)
+  end
+end
+
+class Array
+  def iterable
+    self
+  end
+
+  def to_libxmlnode
+    LibXmlNode.create(self, {}, "")
+  end
+end

data/test/rtiss_libxml_to_hash_test.rb

@@ -0,0 +1,86 @@
+# -*- encoding : utf-8 -*-
+require "test/unit"
+require "./lib/rtiss_libxml_to_hash.rb"
+
+class LibXmlToHashTest < Test::Unit::TestCase
+  def test_tiss_xml_node_class
+    assert_equal "karin", LibXmlNode.create("karin", "zak", "lebt").subnodes
+    assert_equal "zak", LibXmlNode.create("karin", "zak", "lebt").attributes
+    assert_equal "lebt", LibXmlNode.create("karin", "zak", "lebt").text
+  end
+
+  def test_from_libxml
+    assert_equal({"karin" => {}}, Hash.from_libxml("<karin/>"))
+    assert_equal({"karin" => {}}, Hash.from_libxml("<karin></karin>"))
+    assert_equal({"karin" => "zak"}, Hash.from_libxml("<karin>zak</karin>"))
+    assert_equal({"karin" => LibXmlNode.create({}, {"zak" => "lebt"}, "")}, Hash.from_libxml("<karin zak=\"lebt\"></karin>"))
+    assert_equal({"karin" => {"zak" => "lebt"}}, Hash.from_libxml("<karin><zak>lebt</zak></karin>"))
+    assert_equal({"karin" => LibXmlNode.create({"zak" => "nicht"}, {"zak" => "lebt"}, "")}, Hash.from_libxml("<karin zak=\"lebt\"><zak>nicht</zak></karin>"))
+    assert_equal({"karin" => {"zak" => ["nicht", "schon"] }}, Hash.from_libxml("<karin><zak>nicht</zak><zak>schon</zak></karin>"))
+    assert_equal({"karin" => {"zak" => ["nicht", "schon", "oder"] }}, Hash.from_libxml("<karin><zak>nicht</zak><zak>schon</zak><zak>oder</zak></karin>"))
+    assert_equal({"karin" => {"zak" => "nicht", "lebt" => "schon"}}, Hash.from_libxml("<karin><zak>nicht</zak><lebt>schon</lebt></karin>"))
+    assert_equal({"karin" => {"zak" => "nicht", "lebt" => "schon", "oder" => {"was" => "nicht" }}}, Hash.from_libxml("<karin><zak>nicht</zak><lebt>schon</lebt><oder><was>nicht</was></oder></karin>"))
+    assert_equal({"karin" => LibXmlNode.create({}, {"zak" => "lebt"}, "schon")}, Hash.from_libxml("<karin zak=\"lebt\">schon</karin>"))
+    assert_equal({"karin" => LibXmlNode.create({"zak"=>{}}, {}, "textmoretext")}, Hash.from_libxml("<karin>text<zak/>moretext</karin>"))
+  end
+
+  def test_exceptions
+    assert_nothing_raised { Hash.from_libxml("<karin") }
+    assert_nil Hash.from_libxml("<karin")
+    assert_raise LibXML::XML::Error do Hash.from_libxml!("<karin") end
+  end
+
+  def test_iterable
+    for s in "karin".iterable do
+      assert_equal "karin", s
+    end
+    for h in {"karin" => "zak"}.iterable do
+      assert_equal({"karin" => "zak"}, h)
+    end
+    for n in LibXmlNode.create({}, {"zak" => "lebt"}, "").iterable do
+      assert_equal LibXmlNode.create({}, {"zak" => "lebt"}, ""), n
+    end
+    for a in ["karin"].iterable do
+      assert_equal "karin", a
+    end
+  end
+
+  def test_to_b
+    assert not("false".to_b)
+    assert not("0".to_b)
+    assert "true".to_b
+    assert "1".to_b
+    assert not("karin".to_b)
+  end
+
+  def test_alex_xml
+    assert_equal(
+{"tuvienna"=>
+  {"response"=>
+    [LibXmlNode.create({"confirmed"=>"false", "error"=>"invalid_persnr"}, {"employeeId"=>"1293191270"}, ""),
+     LibXmlNode.create({"confirmed"=>"true"}, {"employeeId"=>"VADE111111"}, ""),
+     LibXmlNode.create({"confirmed"=>"false",
+        "error"=>["invalid_hours", "unknown_person", "deleted"]}, {"employeeId"=>"SKYW111111"}, "")]}},
+     Hash.from_libxml('<?xml version="1.0" encoding="UTF-8"?>
+<tuvienna xmlns="https://tiss.tuwien.ac.at/api/schemas/lecturerResponse/v10" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <response employeeId="1293191270">
+    <confirmed>false</confirmed>
+    <error>invalid_persnr</error>
+  </response>
+  <response employeeId="VADE111111">
+    <confirmed>true</confirmed>
+  </response>
+  <response employeeId="SKYW111111">
+    <confirmed>false</confirmed>
+    <error>invalid_hours</error>
+    <error>unknown_person</error>
+    <error>deleted</error>
+  </response>
+</tuvienna>'))
+  end
+
+  def test_to_libxmlnode
+    assert_equal "text".to_libxmlnode, LibXmlNode.create({}, {}, "text")
+    assert_equal({"karin" => "zak"}.to_libxmlnode, LibXmlNode.create({"karin" => "zak"}, {}, ""))
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: rtiss_libxml_to_hash
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- Johannes Thoma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'A simple library to convert XML strings to hashes using libxml
+
+
+  This adds to from_lib_xml method to the Hash class which uses libxml (which
+
+  is much faster than ReXML) to convert a XML string into a Hash'
+email: johannes.thoma@gmx.at
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rtiss_libxml_to_hash.rb
+- test/rtiss_libxml_to_hash_test.rb
+homepage: https://github.com/rtiss/libxml-to-hash
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: rtiss_libxml_to_hash
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A simple library to convert XML strings to hashes using libxml
+test_files: []