vtd-xml

Parse large amounts of XML quickly and easily.

This library currently only works with JRuby.

Installation

Add this line to your application's Gemfile:

gem 'vtd-xml', '~> 0.0.1'

And then execute:

bundle

Or install it yourself as:

gem install vtd-xml

Usage

With the following example XML:

<?xml version="1.0" encoding="utf-8"?>
<books>
  <book title="A Tale of Two Cities" sold="200000000" firstPublished="1859">
    <author name="Charles Dickens" />
    <language>English</language>
    <publisher>Chapman &amp; Hall</publisher>
    <ratings>
      <rating userID="1">5</rating>
      <rating userID="4">2</rating>
      <rating userID="2">3</rating>
    </ratings>
  </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>
    <ratings>
      <rating userID="1">5</rating>
      <rating userID="4">4</rating>
      <rating userID="2">5</rating>
    </ratings>
  </book>
  <book title="The Little Prince" sold="140000000" firstPublished="1943">
    <author name="Antoine de Saint-Exupéry" />
    <language>French</language>
    <publisher>Gallimard</publisher>
    <ratings>
      <rating userID="4">4</rating>
      <rating userID="2">2</rating>
      <rating userID="1">3</rating>
    </ratings>
  </book>
</books>

Parsing a file

require 'vtd-xml'

# Create a parser
parser = VTD::Xml::Parser.new 'path/to.xml'

# This shortcut does the same
parser = VTD::Xml.open 'path/to.xml'

parser.find('//book/author').each do |node|
  # Iterates through each node
end

parser.find('//book/author').max_by { |node| node['sold'] }

Finding a node

node = parser.find('//book/author[1]').first

Working with attributes

# Accessing attributes
node['name']

node.fetch('missing', 'so use this default')
node.fetch('another-missing') { 'so call this block and use it' }

node.slice('title', 'missing')
# => {'title' => 'A Tale of Two Cities',  'missing' => nil}

node.attributes # => returns every attribute

Node traversal

child = node.children('language').first
child.text # => "English"

node.children('rating').map do |child|
  child.text.to_i
end
# => [5,2,3]

See the examples directory for more.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request