oxm 0.1.2 → 0.1.3

data/CHANGELOG.markdown

@@ -1,3 +1,6 @@
+### 0.1.3 / 2011/09/27
+* OXM can be instantiated. Warning and error messages during the last OXM#from_xml call can be accessed with OXM#warnings and OXM#errors instance methods.
+
 ### 0.1.2 / 2011/09/20
 * Bug fix: Invalid handling of empty content
 

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/oxm.rb

@@ -3,14 +3,36 @@ require 'builder'
 require 'oxm/sax_handler'
 require 'oxm/object'
 
-module OXM
+class OXM
   # @param [IO/String] xml XML data
   # @param [String] loop_element
   # @return [Array] Array of OXM::Objects
   def self.from_xml xml, loop_element, &block
-    handler = OXM::SaxHandler.new(loop_element, &block)
-    parser = Nokogiri::XML::SAX::Parser.new(handler)
-    parser.parse xml
-    handler.outputs unless block_given?
+    oxm = OXM.new xml
+    oxm.from_xml loop_element, &block
+  end
+
+  # @param [IO/String] xml XML data
+  def initialize xml
+    @xml = xml
+  end
+
+  # @param [String] loop_element
+  def from_xml loop_element, &block
+    @handler = OXM::SaxHandler.new(loop_element, &block)
+    parser = Nokogiri::XML::SAX::Parser.new(@handler)
+    parser.parse @xml
+    @handler.outputs unless block_given?
+  end
+
+  # @return [Array] Error messages during the last from_xml call
+  def errors
+    @handler ? @handler.errors : []
+  end
+
+  # @return [Array] Warning messages during the last from_xml call
+  def warnings
+    @handler ? @handler.warnings : []
   end
 end
+

data/lib/oxm/object.rb

@@ -1,4 +1,4 @@
-module OXM
+class OXM
   class Object
     attr_reader :tag
 

data/lib/oxm/sax_handler.rb

@@ -1,6 +1,8 @@
-module OXM
+class OXM
   class SaxHandler < Nokogiri::XML::SAX::Document
     attr_reader :outputs
+    attr_reader :warnings
+    attr_reader :errors
 
     def initialize loop_node, &block
       @loop_node = loop_node
@@ -8,6 +10,17 @@ module OXM
       @tags = []
       @objects = []
       @outputs = []
+
+      @warnings = []
+      @errors = []
+    end
+
+    def warning str
+      @warnings << str
+    end
+
+    def error str
+      @errors << str
     end
 
     def start_element tag, attributes

data/test/test_oxm.rb

@@ -1,8 +1,56 @@
 require 'helper'
 
 class TestOxm < Test::Unit::TestCase
+  require 'tempfile'
+  def test_errors
+    str = '
+    <?xml version="1.0"?>
+    <container attr1="1" attr2="2">
+      <item dept="A">
+        <volume unit="ml"><![CDATA[ 100 ]]></volume>
+        <volume unit="ml"><![CDATA[200]]></volume>
+      </item>
+      <item dept="B">
+        <volume unit="l">200</volume>
+        <volume unit="l">300</volume>
+      </item>
+    </container>
+    '
+
+    # Test errors (XML declaration allowed only at the start of the document)
+    oxm = OXM.new str
+    result = oxm.from_xml('container')
+    assert_equal 0, result.length
+    assert_equal 1, oxm.errors.length
+    assert_equal 0, oxm.warnings.length
+
+    # Test no-errors
+    oxm = OXM.new str.strip
+    result = oxm.from_xml('container')
+    assert_equal 1, result.length
+    assert_equal 0, oxm.errors.length
+    assert_equal 0, oxm.warnings.length
+
+    # Test empty IO
+    tf = Tempfile.new('oxm')
+    tf << str.strip
+    tf.flush
+
+    oxm = OXM.new File.open(tf.path)
+    result = oxm.from_xml('container')
+    assert_equal 1, result.length
+    assert_equal 0, oxm.errors.length
+    assert_equal 0, oxm.warnings.length
+
+    result = oxm.from_xml('container')
+    assert_equal 0, result.length
+    assert_equal 2, oxm.errors.length
+    assert_equal 0, oxm.warnings.length
+  end
+
   def test_from_xml_string
-    str = <<-EOF
+    str = '
+    <?xml version="1.0"?>
     <container attr1="1" attr2="2">
       <item dept="A">
         <volume unit="ml"><![CDATA[ 100 ]]></volume>
@@ -21,15 +69,17 @@ class TestOxm < Test::Unit::TestCase
         <volume></volume>
       </item>
     </container>
-    EOF
+    '
+
+    # STRIP
+    str = str.strip
 
-    require 'tempfile'
     tf = Tempfile.new('oxm')
     tf << str
     tf.flush
 
-    [str, File.open(tf.path)].each do |input|
-      result = OXM.from_xml(input, 'container')
+    [lambda { str }, lambda { File.open(tf.path) }].each do |input|
+      result = OXM.from_xml(input.call, 'container')
       assert       result.is_a?(Array)
       assert_equal 1, result.length
       assert_equal "", result.first.to_s
@@ -51,7 +101,7 @@ class TestOxm < Test::Unit::TestCase
       assert container.compact!.equal?(container) # Object identity
       assert container.item.is_a?(Array)
 
-      result = OXM.from_xml(str, 'container/item')
+      result = OXM.from_xml(input.call, 'container/item')
       assert_equal 4, result.length
 
       item = result.last
@@ -60,7 +110,7 @@ class TestOxm < Test::Unit::TestCase
       assert_equal '500', item.volume.to_s
       assert_equal 'L', item.volume['unit']
 
-      result = OXM.from_xml(str, 'container/item/volume')
+      result = OXM.from_xml(input.call, 'container/item/volume')
       assert_equal 8, result.length
       assert_equal %w[100 200 200 300 300 400 500] + [""], result.map(&:to_s)
       assert_equal %w[ml ml l l l ml L] + [nil], result.map { |e| e['unit'] }
@@ -99,7 +149,7 @@ class TestOxm < Test::Unit::TestCase
       assert_equal '<volume unit="L"></volume>', vol.to_xml
 
       cnt = 0
-      result = OXM.from_xml(str, 'container/item/volume') do |obj|
+      result = OXM.from_xml(input.call, 'container/item/volume') do |obj|
         assert_equal 'volume', obj.tag
         assert obj.is_a?(OXM::Object)
         cnt += 1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oxm
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-20 00:00:00.000000000Z
+date: 2011-09-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &2152490720 !ruby/object:Gem::Requirement
+  requirement: &2158741640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152490720
+  version_requirements: *2158741640
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2152489620 !ruby/object:Gem::Requirement
+  requirement: &2158740520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152489620
+  version_requirements: *2158740520
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2152488420 !ruby/object:Gem::Requirement
+  requirement: &2158738800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2152488420
+  version_requirements: *2158738800
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2152485060 !ruby/object:Gem::Requirement
+  requirement: &2158736100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2152485060
+  version_requirements: *2158736100
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2152483840 !ruby/object:Gem::Requirement
+  requirement: &2158735100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152483840
+  version_requirements: *2158735100
 description: A tiny Object-XML-Mapper using Nokogiri SAX parser
 email: junegunn.c@gmail.com
 executables: []
@@ -102,7 +102,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3232406390729243010
+      hash: -1465942368572815623
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: