vtd-xml 0.0.1-java

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/fixtures
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--order random
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vtd-xml.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 James Conroy-Finn
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# 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
+<?xml version="1.0" encoding="utf-8"?>
+<books>
+  <book title="A Tale of Two Cities" sold="200000000" firstPublished="1859">
+    <author name="Charles Dickens" />
+  </book>
+  <book title="The Lord of the Rings" sold="150000000" firstPublished="1954">
+    <author name="J. R. R. Tolkien" />
+  </book>
+  <book title="The Little Prince" sold="140000000" firstPublished="1943">
+    <author name="Antoine de Saint-Exupéry" />
+  </book>
+</books>
+```
+
+### Parsing a file
+
+``` ruby
+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
+
+``` ruby
+node = parser.find('//book/author[1]').first
+```
+
+### Working with attributes
+
+``` ruby
+
+# 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
+```
+
+**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

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+$: << 'lib'
+
+Rake.add_rakelib 'tasks'
+
+desc 'Run RSpec code examples'
+task :default => :spec

data/benchmarks/jruby_vtd.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby --profile.flat
+require 'java'
+
+$: << 'lib'
+require 'vtd-xml-java.jar'
+
+vg = com.ximpleware.VTDGen.new
+vg.parse_file('spec/fixtures/books.xml', false)
+
+nav = vg.get_nav
+auto_pilot = com.ximpleware.AutoPilot.new(nav)
+auto_pilot.selectXPath('//book/author')
+
+while auto_pilot.eval_xpath != -1
+  name = nav.get_attr_val('name')
+  if name != -1
+    puts nav.to_normalized_string(name)
+  end
+end

data/benchmarks/nokogiri.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby --profile.flat
+require 'nokogiri'
+
+doc = Nokogiri::XML(File.open('spec/fixtures/products.xml'))
+
+count = odds = 0
+
+doc.xpath('//outer/inner').each do |node|
+  count += 1
+  odds  += 1 if node['id'].to_i.odd?
+end
+
+puts "That's #{odds} odd IDs in #{count} nodes!"

data/examples/enumerable.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby --profile.flat
+
+$: << 'lib'
+require 'vtd/xml'
+
+xml = VTD::Xml.open('spec/fixtures/books.xml')
+
+# Make use of the entire attribute list
+node = xml.find('//book').max_by { |node| node.attributes['sold'].to_i }
+puts "Max sold was #{node.attributes['sold'].inspect}"
+
+# Make use of the attribute cache
+node = xml.find('//book').max_by { |node| node['sold'].to_i }
+puts "Max sold was #{node['sold'].inspect}"

data/examples/simple.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby --profile.flat
+
+$: << 'lib'
+require 'vtd/xml'
+
+xml = VTD::Xml.open('spec/fixtures/products.xml')
+
+count = odds = 0
+
+xml.find('//outer/inner').each do |node|
+  count += 1
+  odds  += 1 if node['id'].to_i.odd?
+end
+
+puts "That's #{odds} odd IDs in #{count} nodes!"

data/lib/vtd-xml.rb

@@ -0,0 +1 @@
+require 'vtd/xml'

data/lib/vtd/xml.rb

@@ -0,0 +1,15 @@
+require 'java'
+require 'vtd-xml-java.jar'
+
+require 'vtd/xml/version'
+require 'vtd/xml/finder'
+require 'vtd/xml/parser'
+require 'vtd/xml/node'
+
+module VTD
+  module Xml
+    def self.open(path)
+      Parser.new(path)
+    end
+  end
+end

data/lib/vtd/xml/finder.rb

@@ -0,0 +1,21 @@
+module VTD
+  module Xml
+    class Finder
+      include Enumerable
+
+      def initialize(nav, xpath)
+        @nav = nav
+        @xpath = xpath
+
+        @auto_pilot = com.ximpleware.AutoPilot.new(@nav)
+        @auto_pilot.select_xpath(@xpath)
+      end
+
+      def each
+        while (current = @auto_pilot.eval_xpath) != -1
+          yield Node.new(@nav, @auto_pilot, current)
+        end
+      end
+    end
+  end
+end

data/lib/vtd/xml/generator.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+module VTD
+  module Xml
+    class Generator
+      GENERATORS = [:products, :books]
+
+      def initialize(root)
+        @root = root
+      end
+
+      def generate
+        GENERATORS.each do |generator_name|
+          open(generator_name, &method(generator_name))
+        end
+      end
+
+      private
+
+      def open(generator_name, &writer)
+        File.open(fixture_path(generator_name), 'w', &writer)
+      end
+
+      def fixture_path(generator_name)
+        File.join(@root, "#{generator_name}.xml")
+      end
+
+      def products(f)
+        f.puts '<?xml version="1.0" encoding="utf-8"?>'
+        f.puts '<container>'
+
+        1_000_000.times do |i|
+          f.puts %(  <outer id="#{i + 10}">)
+          f.puts %(    <inner id="#{i}" name="Could be random #{i}" />)
+          f.puts %(  </outer>)
+        end
+
+        f.puts '</container>'
+      end
+
+      def books(f)
+        f.puts \
+          '<?xml version="1.0" encoding="utf-8"?>',
+          '<books>',
+          '  <book title="A Tale of Two Cities" sold="200000000" firstPublished="1859">',
+          '    <author name="Charles Dickens" />',
+          '  </book>',
+          '  <book title="The Lord of the Rings" sold="150000000" firstPublished="1954">',
+          '    <author name="J. R. R. Tolkien" />',
+          '  </book>',
+          '  <book title="The Little Prince" sold="140000000" firstPublished="1943">',
+          '    <author name="Antoine de Saint-Exupéry" />',
+          '  </book>',
+          '</books>'
+      end
+    end
+  end
+end

data/lib/vtd/xml/node.rb

@@ -0,0 +1,32 @@
+require 'vtd/xml/node/attributes'
+
+module VTD
+  module Xml
+    class Node
+      include Attributes
+
+      attr_reader :name, :text
+
+      def initialize(nav, auto_pilot, current)
+        @nav        = nav
+        @auto_pilot = auto_pilot
+        @current    = current
+        super
+      end
+
+      def name
+        @name ||= @nav.to_string(@current)
+      end
+
+      def text
+        @text ||= string_from_index @nav.get_text
+      end
+
+      private
+
+      def string_from_index(index)
+        @nav.to_normalized_string(index) if index != -1
+      end
+    end
+  end
+end

data/lib/vtd/xml/node/attributes.rb

@@ -0,0 +1,57 @@
+module VTD
+  module Xml
+    class Node
+      module Attributes
+        AttributeMissing = Class.new(StandardError)
+
+        def initialize(*)
+          @attribute_cache = {}
+          @attributes = nil
+        end
+
+        def attributes
+          return @attributes if @attributes
+
+          @attributes = {}
+
+          @auto_pilot.select_attr('*')
+          while (i = @auto_pilot.iterate_attr) != -1
+            @attributes[string_from_index i] = string_from_index i + 1
+          end
+
+          @attribute_cache = @attributes
+        end
+
+        def [](key)
+          find_attribute(key)
+        end
+
+        def slice(*keys)
+          Hash[*keys.flat_map { |key| [key, find_attribute(key)] }]
+        end
+
+        def fetch(*args)
+          if args.length == 2
+            key, default = *args
+          else
+            key = args.first
+          end
+
+          if item = find_attribute(key)
+            return item
+          end
+
+          return yield(key) if block_given?
+          return default if defined? default
+          raise AttributeMissing, 'attribute not found'
+        end
+
+        private
+
+        def find_attribute(key)
+          @attribute_cache[key] ||= string_from_index @nav.get_attr_val(key)
+        end
+      end
+    end
+  end
+end

data/lib/vtd/xml/parser.rb

@@ -0,0 +1,16 @@
+module VTD
+  module Xml
+    class Parser
+      def initialize(path)
+        @path = path
+
+        @gen = com.ximpleware.VTDGen.new
+        @gen.parse_file(@path, false)
+      end
+
+      def find(xpath)
+        VTD::Xml::Finder.new(@gen.get_nav, xpath).enum_for(:each)
+      end
+    end
+  end
+end

data/lib/vtd/xml/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$: << 'lib'
+require 'vtd/xml'

data/spec/vtd/xml/parser_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe VTD::Xml::Parser do
+  let(:parser) { VTD::Xml::Parser.new 'spec/fixtures/books.xml' }
+
+  it 'will pull everything that matches your XPath' do
+    expect(parser.find('//book/author').to_a.length).to eq(3)
+  end
+
+  it 'yields a node for each match' do
+    parser.find('//book/author').with_index do |node, index|
+      expect(node.name).to eq('author')
+      expect(node.text).to be_nil
+    end
+  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' }
+
+    it 'can be accessed with []' do
+      expect(book['title']).to eq(title)
+    end
+
+    it 'can be accessed with fetch' do
+      expect(book.fetch('title')).to eq(title)
+    end
+
+    it 'uses the second argument when fetch fails' do
+      expect(book.fetch('not-present', 'Arg')).to eq('Arg')
+    end
+
+    it 'uses a block when fetch fails' do
+      expect(book.fetch('not-present') { 'Block' }).to eq('Block')
+    end
+
+    it 'can slice attributes' do
+      expect(book.slice('title', 'sold')).to eq(
+        'title' => title, 'sold' => sold)
+    end
+
+    it 'can return all attributes' do
+      expect(book.attributes).to eq(
+        'title' => title, 'sold' => sold, 'firstPublished' => published)
+    end
+  end
+end

data/spec/vtd/xml_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe VTD::Xml do
+  it 'has a version number' do
+    VTD::Xml::VERSION.should_not be_nil
+  end
+
+  describe '.open' do
+    it 'creates a new parser' do
+      VTD::Xml::Parser.should_receive(:new).with('path.xml')
+      VTD::Xml.open 'path.xml'
+    end
+  end
+end

data/tasks/fixtures.rake

@@ -0,0 +1,9 @@
+namespace :fixtures do
+  desc 'Generate XML fixtures for tests'
+  task :generate do
+    require 'vtd/xml/generator'
+
+    root = File.expand_path '../../spec/fixtures', __FILE__
+    VTD::Xml::Generator.new(root).generate
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = '--format progress --color --order random'
+end

data/vtd-xml.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+$: << 'lib'
+require 'vtd/xml/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'vtd-xml'
+  gem.version       = VTD::Xml::VERSION
+  gem.platform =    'java'
+
+  gem.authors       = ['James Conroy-Finn']
+  gem.email         = ['james@logi.cl']
+
+  gem.description   = %q{VTD-XML for JRuby}
+  gem.summary       = %q{A thin wrapper around the VTD-XML Java library}
+  gem.homepage      = 'https://github.com/jcf/vtd-xml'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: vtd-xml
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease:
+platform: java
+authors:
+- James Conroy-Finn
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
+description: VTD-XML for JRuby
+email:
+- james@logi.cl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmarks/jruby_vtd.rb
+- benchmarks/nokogiri.rb
+- examples/enumerable.rb
+- examples/simple.rb
+- lib/vtd-xml-java.jar
+- lib/vtd-xml.rb
+- lib/vtd/xml.rb
+- lib/vtd/xml/finder.rb
+- lib/vtd/xml/generator.rb
+- lib/vtd/xml/node.rb
+- lib/vtd/xml/node/attributes.rb
+- lib/vtd/xml/parser.rb
+- lib/vtd/xml/version.rb
+- spec/spec_helper.rb
+- spec/vtd/xml/parser_spec.rb
+- spec/vtd/xml_spec.rb
+- tasks/fixtures.rake
+- tasks/rspec.rake
+- vtd-xml.gemspec
+homepage: https://github.com/jcf/vtd-xml
+licenses:
+- MIT
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: !binary |-
+        MA==
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: !binary |-
+        MA==
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: A thin wrapper around the VTD-XML Java library
+test_files:
+- spec/spec_helper.rb
+- spec/vtd/xml/parser_spec.rb
+- spec/vtd/xml_spec.rb