vtd-xml 0.0.2-java → 0.0.3-java

data/README.md

@@ -29,16 +29,31 @@ With the following example XML:
     <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>
 ```
@@ -86,11 +101,13 @@ node.attributes # => returns every attribute
 ### Node traversal
 
 ``` ruby
-node.with_first_child('language') do |child|
-  child.text # => "English"
-end
+child = node.children('language').first
+child.text # => "English"
 
-node['title'] # => "A Tale of Two Cities"
+node.children('rating').map do |child|
+  child.text.to_i
+end
+# => [5,2,3]
 ```
 
 **See the examples directory for more.**

data/Rakefile

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

data/examples/enumerable.rb

@@ -8,7 +8,3 @@ 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/lib/vtd/xml/generator.rb

@@ -41,20 +41,35 @@ module VTD
         f.puts \
           '<?xml version="1.0" encoding="utf-8"?>',
           '<books>',
-          '  <book title="A Tale of Two Cities" sold="200000000" firstPublished="1859">',
+          '  <book title="A Tale of Two Cities" sold="200000000" firstPublished="1859" rank="1">',
           '    <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">',
+          '  <book title="The Lord of the Rings" sold="150000000" firstPublished="1954" rank="2">',
           '    <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">',
+          '  <book title="The Little Prince" sold="140000000" firstPublished="1943" rank="3">',
           '    <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>'
       end

data/lib/vtd/xml/node.rb

@@ -3,11 +3,6 @@ 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
@@ -16,7 +11,6 @@ module VTD
         @nav        = nav
         @auto_pilot = auto_pilot
         @current    = current
-        super
       end
 
       def name
@@ -27,10 +21,14 @@ 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)
+      def children(options = {})
+        Enumerator.new do |yielder|
+          @nav.push
+          next_element unless child_selected?(options)
+
+          yielder << dup while next_element
+
+          @nav.pop
         end
       end
 
@@ -40,20 +38,18 @@ module VTD
 
       private
 
-      def string_from_index(index)
-        @nav.to_normalized_string(index) if index != -1
+      def child_selected?(options)
+        name = options.fetch(:only, '*')
+        @auto_pilot.select_element(name)
+        name != '*'
       end
 
-      def move_to(type, name = nil)
-        if name
-          @nav.to_element(find_type(type), name)
-        else
-          @nav.to_element(find_type(type))
-        end
+      def next_element
+        @auto_pilot.iterate
       end
 
-      def find_type(type)
-        TYPES[type] or raise ArgumentError, "Unknown node type: #{type.inspect}"
+      def string_from_index(index)
+        @nav.to_normalized_string(index) if index != -1
       end
     end
   end

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

@@ -4,22 +4,15 @@ module VTD
       module Attributes
         AttributeMissing = Class.new(StandardError)
 
-        def initialize(*)
-          @attribute_cache = {}
-          @attributes = nil
-        end
-
         def attributes
-          return @attributes if @attributes
-
-          @attributes = {}
+          attributes = {}
 
           @auto_pilot.select_attr('*')
           while (i = @auto_pilot.iterate_attr) != -1
-            @attributes[string_from_index i] = string_from_index i + 1
+            attributes[string_from_index i] = string_from_index i + 1
           end
 
-          @attribute_cache = @attributes
+          attributes
         end
 
         def [](key)
@@ -49,7 +42,7 @@ module VTD
         private
 
         def find_attribute(key)
-          @attribute_cache[key] ||= string_from_index @nav.get_attr_val(key)
+          string_from_index @nav.get_attr_val(key)
         end
       end
     end

data/lib/vtd/xml/version.rb

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

data/{tasks → rakelib}/fixtures.rake

@@ -3,7 +3,9 @@ namespace :fixtures do
   task :generate do
     require 'vtd/xml/generator'
 
-    root = File.expand_path '../../spec/fixtures', __FILE__
+    root = File.expand_path('../../spec/fixtures', __FILE__)
+
+    puts 'Generating XML fixtures...'
     VTD::Xml::Generator.new(root).generate
   end
 end

data/spec/vtd/xml/node_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe VTD::Xml::Node do
+  let(:parser) { VTD::Xml::Parser.new 'spec/fixtures/books.xml' }
+  let(:book) { parser.find('//book[1]').first }
+
+  describe 'node attributes' do
+    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, 'rank' => '1')
+    end
+  end
+
+  describe '#children' do
+    it 'filters children by name' do
+      expect(book.children(only: 'rating').to_a.size).to eq(3)
+    end
+
+    it 'iterates through all child elements when no element name is given' do
+      expect(book.children.to_a.size).to eq(7)
+    end
+
+    it 'is enumerable' do
+      expect(book.children).to respond_to(:map)
+    end
+
+    it 'return an empty array when no matches are found' do
+      expect(book.children(only: 'soundtrack').to_a).to eq([])
+    end
+
+    it 'doesnt affect existing node traversal' do
+      ranks = parser.find('//book').map do |book|
+        book.children.to_a
+        book['rank']
+      end
+
+      expect(ranks).to eq(%w(1 2 3))
+    end
+  end
+end

data/spec/vtd/xml/parser_spec.rb

@@ -14,68 +14,4 @@ describe VTD::Xml::Parser do
       expect(node.text).to be_nil
     end
   end
-
-  describe 'node attributes' do
-    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
-
-  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

@@ -21,4 +21,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vtd-xml
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease:
 platform: java
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-02-19 00:00:00.000000000 Z
+date: 2013-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -30,6 +30,24 @@ dependencies:
     none: false
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
@@ -57,11 +75,12 @@ files:
 - lib/vtd/xml/node/attributes.rb
 - lib/vtd/xml/parser.rb
 - lib/vtd/xml/version.rb
+- rakelib/fixtures.rake
+- rakelib/rspec.rake
 - spec/spec_helper.rb
+- spec/vtd/xml/node_spec.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:
@@ -92,5 +111,6 @@ specification_version: 3
 summary: A thin wrapper around the VTD-XML Java library
 test_files:
 - spec/spec_helper.rb
+- spec/vtd/xml/node_spec.rb
 - spec/vtd/xml/parser_spec.rb
 - spec/vtd/xml_spec.rb