vtd-xml 0.0.1-java → 0.0.2-java

data/README.md

@@ -27,12 +27,18 @@ With the following example XML:
 <books>
   <book title="A Tale of Two Cities" sold="200000000" firstPublished="1859">
     <author name="Charles Dickens" />
+    <language>English</language>
+    <publisher>Chapman &amp; Hall</publisher>
   </book>
   <book title="The Lord of the Rings" sold="150000000" firstPublished="1954">
     <author name="J. R. R. Tolkien" />
+    <language>English</language>
+    <publisher>George Allen &amp; Unwin</publisher>
   </book>
   <book title="The Little Prince" sold="140000000" firstPublished="1943">
     <author name="Antoine de Saint-Exupéry" />
+    <language>French</language>
+    <publisher>Gallimard</publisher>
   </book>
 </books>
 ```
@@ -77,6 +83,16 @@ node.slice('title', 'missing')
 node.attributes # => returns every attribute
 ```
 
+### Node traversal
+
+``` ruby
+node.with_first_child('language') do |child|
+  child.text # => "English"
+end
+
+node['title'] # => "A Tale of Two Cities"
+```
+
 **See the examples directory for more.**
 
 ## Contributing

data/lib/vtd/xml/generator.rb

@@ -43,12 +43,18 @@ module VTD
           '<books>',
           '  <book title="A Tale of Two Cities" sold="200000000" firstPublished="1859">',
           '    <author name="Charles Dickens" />',
+          '    <language>English</language>',
+          '    <publisher>Chapman &amp; Hall</publisher>',
           '  </book>',
           '  <book title="The Lord of the Rings" sold="150000000" firstPublished="1954">',
           '    <author name="J. R. R. Tolkien" />',
+          '    <language>English</language>',
+          '    <publisher>George Allen &amp; Unwin</publisher>',
           '  </book>',
           '  <book title="The Little Prince" sold="140000000" firstPublished="1943">',
           '    <author name="Antoine de Saint-Exupéry" />',
+          '    <language>French</language>',
+          '    <publisher>Gallimard</publisher>',
           '  </book>',
           '</books>'
       end

data/lib/vtd/xml/node.rb

@@ -3,6 +3,11 @@ require 'vtd/xml/node/attributes'
 module VTD
   module Xml
     class Node
+      TYPES = {
+        first_child: com.ximpleware.VTDNav::FIRST_CHILD,
+        parent: com.ximpleware.VTDNav::PARENT
+      }
+
       include Attributes
 
       attr_reader :name, :text
@@ -22,11 +27,34 @@ module VTD
         @text ||= string_from_index @nav.get_text
       end
 
+      def with_first_child(name = nil)
+        if move_to(:first_child, name)
+          yield dup
+          move_to(:parent)
+        end
+      end
+
+      def inspect
+        %(#<#{self.class}:#{self.object_id} @current=#{@current} @nav=#{@nav}>)
+      end
+
       private
 
       def string_from_index(index)
         @nav.to_normalized_string(index) if index != -1
       end
+
+      def move_to(type, name = nil)
+        if name
+          @nav.to_element(find_type(type), name)
+        else
+          @nav.to_element(find_type(type))
+        end
+      end
+
+      def find_type(type)
+        TYPES[type] or raise ArgumentError, "Unknown node type: #{type.inspect}"
+      end
     end
   end
 end

data/lib/vtd/xml/version.rb

@@ -1,5 +1,5 @@
 module VTD
   module Xml
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

data/spec/vtd/xml/parser_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 
 describe VTD::Xml::Parser do
   let(:parser) { VTD::Xml::Parser.new 'spec/fixtures/books.xml' }
+  let(:book) { parser.find('//book[1]').first }
 
   it 'will pull everything that matches your XPath' do
     expect(parser.find('//book/author').to_a.length).to eq(3)
@@ -15,7 +16,6 @@ describe VTD::Xml::Parser do
   end
 
   describe 'node attributes' do
-    let(:book)       { parser.find('//book[1]').first }
     let(:title)      { 'A Tale of Two Cities' }
     let(:sold)       { '200000000' }
     let(:published)  { '1859' }
@@ -46,4 +46,36 @@ describe VTD::Xml::Parser do
         'title' => title, 'sold' => sold, 'firstPublished' => published)
     end
   end
+
+  describe 'node elements' do
+    it 'can access node child element' do
+      book.with_first_child do |child|
+        expect(child['name']).to eq('Charles Dickens')
+      end
+    end
+
+    it 'can access node child elements' do
+      book.with_first_child('publisher') do |child|
+        expect(child.text).to eq('Chapman & Hall')
+      end
+    end
+
+    it 'returns nil when no element is found' do
+      expect { |b|
+        book.with_first_child('soundtrack', &b)
+      }.to_not yield_control
+    end
+
+    it 'returns the cursor back to the initial position' do
+      book.with_first_child('publisher') {}
+
+      expect { |b|
+        book.with_first_child(&b)
+      }.to yield_with_args
+
+      book.with_first_child do |child|
+        expect(child['name']).to eq('Charles Dickens')
+      end
+    end
+  end
 end

data/vtd-xml.gemspec

@@ -5,10 +5,10 @@ require 'vtd/xml/version'
 Gem::Specification.new do |gem|
   gem.name          = 'vtd-xml'
   gem.version       = VTD::Xml::VERSION
-  gem.platform =    'java'
+  gem.platform      = 'java'
 
-  gem.authors       = ['James Conroy-Finn']
-  gem.email         = ['james@logi.cl']
+  gem.authors       = ['James Conroy-Finn', 'Jesper Kjeldgaard']
+  gem.email         = ['james@logi.cl', 'thejspr@gmail.com']
 
   gem.description   = %q{VTD-XML for JRuby}
   gem.summary       = %q{A thin wrapper around the VTD-XML Java library}

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: vtd-xml
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease:
 platform: java
 authors:
 - James Conroy-Finn
+- Jesper Kjeldgaard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-02-18 00:00:00.000000000 Z
+date: 2013-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -32,6 +33,7 @@ dependencies:
 description: VTD-XML for JRuby
 email:
 - james@logi.cl
+- thejspr@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []