javabean_xml 0.1.0

data/lib/javabean_xml.rb

@@ -0,0 +1,129 @@
+require "nokogiri"
+require "builder"
+
+# TODO : document
+
+class JavabeanXml
+
+  def self.default_transformations
+    Hash.new { |hash, key|
+      lambda { |value, properties|
+        {
+          :class => key,
+          :value => value,
+          :properties => properties
+        }.delete_if { |k,v| v.nil? || v.respond_to?(:empty?) && v.empty? }
+      }
+    }
+  end
+
+  def self.from_xml xml, type_transformations = {}
+    nodes = Nokogiri::XML(xml).xpath("/java/object")
+    # clean out all empty text-nodes to simplify parsing
+    nodes.xpath("//text()").each do |text_node|
+      if text_node.content.strip.empty?
+        text_node.remove
+      end
+    end
+    JavabeanXml.new(default_transformations.merge(type_transformations)).parse(nodes)
+  end
+
+  def self.to_xml object, type_transformations = {}
+    xml = Builder::XmlMarkup.new #:indent => 2
+    xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+    xml.java :version => "1.6.0_26", :class => "java.beans.XMLDecoder" do
+      JavabeanXml.new(type_transformations).to_xml(object, xml)
+    end
+  end
+
+  def initialize type_transformations
+    @type_transformations = type_transformations
+  end
+
+  def parse node
+    if node.is_a? Nokogiri::XML::NodeSet
+      raise "structure error" if node.length != 1
+      node = node.first
+    end
+    case node.name
+    when "object"
+      parse_object node
+    else
+      parse_value node
+    end
+  end
+
+  def to_xml object, xml
+    if object.is_a? Hash
+      case object[:class]
+      when Symbol
+        to_value_xml object, xml
+      else
+        to_object_xml object, xml
+      end
+    else
+      # puts "#{object.inspect} (#{object.class})"
+      # puts " -- #{@type_transformations.keys.inspect}"
+      transformation = @type_transformations[object.class]
+      raise "No transformation registered for #{object.class}" unless transformation
+      to_xml transformation[object], xml
+    end
+  end
+
+  private
+  def parse_object obj_node
+    klass = obj_node["class"]
+    value = []
+    properties = {}
+    obj_node.children.each do |prop|
+      case prop.name
+      when "void"
+        properties[prop[:property].to_sym] = parse(prop.children)
+      when "string", "int", "boolean", "long"
+        value << parse_value(prop)
+      else
+        raise "Unsupported method: #{prop.inspect}"
+      end
+    end
+    value = value.first if value.length == 1
+    @type_transformations[klass][value, properties]
+  end
+
+  def parse_value val_node
+    case val_node.name
+    when "int", "long"
+      value = val_node.text.to_i
+    when "boolean"
+      value = val_node.text.strip == "true"
+    else
+      value = val_node.text
+    end
+    klass = val_node.name.to_sym
+    @type_transformations[klass][value, nil]
+  end
+
+  def to_value_xml object, xml
+    xml.tag! object[:class] do
+      xml.text! object[:value].to_s
+    end
+  end
+
+  def to_object_xml object, xml
+    xml.object :class => object[:class] do
+      if value = object[:value]
+        value = [value] unless value.is_a? Array
+        value.each do |v|
+          to_xml v, xml
+        end
+      end
+      if object[:properties]
+        object[:properties].each_pair do |p, val|
+          xml.void :property => p do
+            to_xml val, xml
+          end
+        end
+      end
+    end
+  end
+
+end

data/test/test_javabean_xml.rb

@@ -0,0 +1,294 @@
+require "rubygems"
+require "test/unit"
+require "equivalent-xml"
+require "javabean_xml.rb"
+class JavabeanXmlTest < Test::Unit::TestCase
+  @@test_xml_1 = <<-XML_END.split(/\n/).map{|l|l.gsub(/^(  ){3}/, "")}.join("\n")
+      <?xml version="1.0" encoding="UTF-8"?>
+      <java version="1.6.0_26" class="java.beans.XMLDecoder">
+        <object class="java.SomeClass">
+          <void property="myString">
+            <string>string1</string>
+          </void>
+          <void property="myObject">
+            <object class="java.NestedObject">
+              <string>Initialization string</string>
+            </object>
+          </void>
+          <void property="myDate">
+            <object class="java.util.Date">
+              <long>1314102227000</long>
+            </object>
+          </void>
+        </object>
+      </java>
+    XML_END
+  @@test_object_1_a = {
+    :class => "java.SomeClass",
+    :properties => {
+      :myString => {
+        :class => :string,
+        :value => "string1"
+      },
+      :myObject => {
+        :class => "java.NestedObject",
+        :value => {
+          :class => :string,
+          :value => "Initialization string"
+        }
+      },
+      :myDate => {
+        :class => "java.util.Date",
+        :value => {
+          :class => :long,
+          :value => 1314102227000
+        }
+      }
+    }
+  }
+  @@test_object_1_b = {
+    :class => "java.SomeClass",
+    :properties => {
+      :myString => {
+        :class => :string,
+        :value => "string1"
+      },
+      :myObject => {
+        :class => "java.NestedObject",
+        :value => {
+          :class => :string,
+          :value => "Initialization string"
+        }
+      },
+      :myDate => Time.at(1314102227)
+    }
+  }
+
+  @@test_xml_2 = <<-XML_END.split(/\n/).map{|l|l.gsub(/^(  ){3}/, "")}.join("\n")
+      <?xml version="1.0" encoding="UTF-8"?>
+      <java version="1.6.0_26" class="java.beans.XMLDecoder">
+        <object class="java.SomeClass">
+          <void property="myString">
+            <string>string1</string>
+          </void>
+          <void property="myRectangle">
+            <object class="java.awt.Rectangle">
+              <int>0</int>
+              <int>2</int>
+              <int>200</int>
+              <int>300</int>
+            </object>
+          </void>
+          <void property="myDate">
+            <object class="java.util.Date">
+              <long>1314102227000</long>
+            </object>
+          </void>
+        </object>
+      </java>
+    XML_END
+
+  @@test_object_2_a = {
+    :class => "java.SomeClass",
+    :properties => {
+      :myString => {
+        :class => :string,
+        :value => "string1"
+      },
+      :myRectangle => {
+        :class => "java.awt.Rectangle",
+        :value => [
+          {
+            :class => :int,
+            :value => 0
+          },
+          {
+            :class => :int,
+            :value => 2
+          },
+          {
+            :class => :int,
+            :value => 200
+          },
+          {
+            :class => :int,
+            :value => 300
+          },
+        ]
+      },
+      :myDate => {
+        :class => "java.util.Date",
+        :value => {
+          :class => :long,
+          :value => 1314102227000
+        }
+      }
+    }
+  }
+
+  Rect = Struct.new :values
+  MyClass = Struct.new :myString, :myRectangle, :myDate
+
+  @@test_object_2_b = \
+        MyClass.new(
+          "string1",
+          Rect.new([0,2,200,300]),
+          Time.at(1314102227)
+        )
+
+  def test_deserialization_simple
+    assert_equal(
+      @@test_object_1_a,
+      JavabeanXml.from_xml(@@test_xml_1),
+      "Should parse simple object"
+    )
+  end
+
+
+  def test_deserialization_multiple_initialization_values
+    assert_equal(
+      @@test_object_2_a,
+      JavabeanXml.from_xml(@@test_xml_2),
+      "Should handle several initialization parameters"
+    )
+  end
+
+  def test_deserialization_custom_object_types_simple
+    assert_equal(
+      @@test_object_1_b,
+      JavabeanXml.from_xml(
+        @@test_xml_1,
+        :long => lambda { |value, properties|
+          value.to_i
+        },
+        "java.util.Date" => lambda { |value, properties|
+          Time.at(value/1000)
+        }
+      ),
+      "Should parse object and transform them"
+    )
+  end
+
+  def test_deserialization_custom_object_types_complex
+    assert_equal(
+      @@test_object_2_b,
+      JavabeanXml.from_xml(
+        @@test_xml_2,
+        :long => lambda { |value, properties|
+          value.to_i
+        },
+        "java.util.Date" => lambda { |value, properties|
+          Time.at(value/1000)
+        },
+        :int => lambda { |value, properties|
+          value.to_i
+        },
+        :string => lambda { |value, properties|
+          value
+        },
+        "java.awt.Rectangle" => lambda { |value, properties|
+          Rect.new value
+        },
+        "java.SomeClass" => lambda { |value, properties|
+          c = MyClass.new
+          properties.each_pair do |k, v|
+            c.send :"#{k}=", v
+          end
+          c
+        }
+      ),
+      "Should parse object and transform them"
+    )
+  end
+
+  def test_serialization_simple
+    assert(
+      EquivalentXml.equivalent?(
+        @@test_xml_1,
+        JavabeanXml.to_xml(@@test_object_1_a),
+        :element_order => (RUBY_VERSION =~ /^1.9/),
+        :normalize_whitespace => true
+      ),
+      "Should serialize simple object"
+    )
+  end
+
+  def test_serialization_simple_with_transformation
+    result = JavabeanXml.to_xml(
+          @@test_object_1_b,
+          Time => lambda { |value|
+            {
+              :class => "java.util.Date",
+              :value => {
+                :class => :long,
+                :value => value.to_i * 1000
+              }
+            }
+          }
+        )
+    unless EquivalentXml.equivalent?(
+          @@test_xml_1,
+          result,
+          :element_order => (RUBY_VERSION =~ /^1.9/),
+          :normalize_whitespace => true
+        )
+    then
+      puts "Expected:"
+      puts @@test_xml_2
+      puts
+      puts "Was:"
+      puts result
+      fail "Should serialize object and transform types"
+    end
+  end
+
+  def test_serialization_complex_with_transformation
+    result = JavabeanXml.to_xml(
+          @@test_object_2_b,
+          Rect => lambda { |value|
+            {
+              :class => "java.awt.Rectangle",
+              :value => value.values.map {|v|
+                {
+                  :class => :int,
+                  :value => v
+                }
+              }
+            }
+          },
+          String => lambda { |value|
+            { :class => :string, :value => value }
+          },
+          Time => lambda { |value|
+            {
+              :class => "java.util.Date",
+              :value => {
+                :class => :long,
+                :value => value.to_i * 1000
+              }
+            }
+          },
+          MyClass => lambda { |value|
+            {
+              :class => "java.SomeClass",
+              :properties => value.each_pair.inject({}){|h, (k, v)| h[k] = v; h}
+            }
+          }
+        )
+    unless EquivalentXml.equivalent?(
+                                @@test_xml_2,
+                                result,
+                                :element_order => (RUBY_VERSION =~ /^1.9/),
+                                :normalize_whitespace => true
+                             )
+    then
+      puts "Expected:"
+      puts @@test_xml_2
+      puts
+      puts "Was:"
+      puts result
+      fail "Should serialize object and transform types"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: javabean_xml
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Einar Magn\xC3\xBAs Boson"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-22 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: equivalent-xml
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 2
+        version: "0.2"
+  type: :development
+  version_requirements: *id003
+description: Small library for encoding and decoding xml the way java.beans.{Encoder,Decoder} does it
+email: einar.boson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/javabean_xml.rb
+- test/test_javabean_xml.rb
+has_rdoc: true
+homepage: http://github.com/einarmagnus/javabean_xml
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Small library for interacting with java.beans.{Encoder,Decoder}
+test_files: 
+- test/test_javabean_xml.rb