axml 0.0.3 → 0.0.4

data/spec/axml/autoload_spec.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+require 'axml/autoload'
+
+class AXMLAutoload < MiniTest::Spec
+
+  it 'gives install instructions' do
+    yoshi = 'yoshidam'
+    rf = 'rubyforge.org'
+    {:xmlparser => [yoshi], :libxml => [rf], :all => [rf, yoshi] }.each do |key,val|
+      val.each do |st|
+        AXML::Autoload.install_instructions(key).include?(st).must_equal true
+      end
+      
+    end
+  end
+
+end

data/spec/axml/libxml_spec.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../axml_spec'
+
+class LibXMLBased < MiniTest::Spec
+  include GenericAXMLBehaviorSpec
+  include ValuesAtBehaviorSpec
+
+  before do
+    super
+    @parser = :libxml
+  end
+end
+
+

data/spec/axml/xmlparser_spec.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/../axml_spec'
+
+
+class XMLParserBased < MiniTest::Spec
+  include GenericAXMLBehaviorSpec
+  include IndexBehaviorSpec
+  include ValuesAtBehaviorSpec
+
+  before do
+    super
+    @parser = :xmlparser
+  end
+ 
+end
+
+

data/spec/axml_spec.rb

@@ -0,0 +1,299 @@
+require File.dirname(__FILE__) + "/spec_helper.rb"
+
+require 'minitest/spec'
+require 'axml'
+
+module GenericAXMLBehaviorSpec
+  extend Shareable
+
+  before do
+
+    @class = nil  # <- specify your class!
+
+    @xml_string = <<END
+<xml>
+  <doc1>
+    <dog name="spot" height="23" weight="13">
+      <flea name="ouchy" height="20" weight="10"/>
+      <flea name="crawly" height="22" weight="9"/>
+    </dog>
+  </doc1>
+  <doc2>
+    <dog name="billy" height="5" weight="3">
+    </dog>
+  </doc2>
+</xml>
+END
+    @small_xml_string = <<END
+<first>
+  <inner1 name="hello">
+  </inner1>
+  <inner2>
+  </inner2>
+</first>
+END
+    @xml_large_string = <<END
+<n1>
+    <n2 id='1'>
+      <n3 id='1'> </n3>
+      <n3 id='2'> </n3>
+      <n3b id='5'></n3b>
+      <n3b id='6'></n3b>
+    </n2>
+    <n2 id='2'>
+      <n3 id='3'> </n3>
+      <n3 id='4'> </n3>
+    </n2>
+</n1>
+END
+    @xml_with_text = <<END
+<n1>
+  <n2>doc1_text</n2>
+  <n3>doc2_text<n4>doc3_text</n4></n3>
+  <n5>Bill&apos;y&apos; &quot;Wrangler&quot; Jones</n5>
+  <n6 class="8 &lt; and 6 &gt;" id="27&amp;22"/>
+  <n7>love &amp; roses</n7>
+</n1>
+END
+  end
+
+  it 'can return a parser' do  # <- very rough spec 
+    AXML::Autoload.parser('crazy').must_be_nil
+    AXML::Autoload.parser(@parser).wont_be_nil
+  end
+
+  it 'reads xml strings' do
+    node = AXML.parse(@small_xml_string, :parser => @parser)
+
+    #node.class.must_equal AXML::El
+    node.name.must_equal 'first'
+
+    node.children.first.name.must_equal 'inner1'
+  end
+
+  it 'reads IO objects' do
+    file = File.dirname(__FILE__) + '/axml.tmp'
+    File.open(file, 'w') {|io| io.puts @xml_string}
+    root = File.open(file) do |io|
+      AXML.parse(io, :parser => @parser)
+    end
+    root.name.must_equal 'xml'
+    root.kids[0].kids.first.attrs["name"].must_equal 'spot'
+    File.unlink(file) if File.exist? file
+  end
+
+  it 'reads files' do
+    file = File.dirname(__FILE__) + '/axml.tmp'
+    File.open(file, 'w') {|fh| fh.puts @xml_string}
+    root = AXML.parse(file, :parser => @parser)
+    root.name.must_equal 'xml'
+    root.kids[0].kids.first.attrs["name"].must_equal 'spot'
+    File.unlink(file) if File.exist? file
+  end
+
+  it 'can access subnodes with "children" or "kids"' do
+    node = AXML.parse(@small_xml_string, :parser => @parser) 
+    node.name.must_equal 'first'
+    node.kids.zip(%w(inner1 inner2)) do |kd,nm|
+      kd.name.must_equal nm
+    end
+  end
+
+  it 'accesses attributes with "[]"' do
+    root = AXML.parse(@xml_string, :parser => @parser)
+    dog_node = root.kids[0].kids[0]
+    dog_node.name.must_equal 'dog'
+    dog_node['name'].must_equal 'spot'
+    dog_node['height'].must_equal '23'
+  end
+
+  it 'can "find_first_descendant"' do
+    root = AXML.parse(@xml_string, :parser => @parser)
+    doc1_node = root.find_first_descendant('doc1')
+    doc1_node.name.must_equal 'doc1'
+    doc1_node.children.size.must_equal 1
+    doc1_node.find_first_descendant('xml').must_equal nil
+    doc1_node.find_first_descendant('doc1').must_equal nil
+    child_node = root.find_first_descendant('flea')
+    child_node.name.must_equal 'flea'
+    child_node['name'].must_equal 'ouchy'
+    child_node.find_first_descendant('flea').must_equal nil
+  end
+
+  it 'can "find_first_child"' do
+    root = AXML.parse(@xml_string, :parser => @parser)
+    doc1_node = root.find_first_child('doc1')
+    doc1_node.name.must_equal 'doc1'
+    doc1_node.children.size.must_equal 1
+    doc1_node.find_first_child('xml').must_equal nil
+    doc1_node.find_first_child('doc1').must_equal nil
+    dog_node = doc1_node.find_first_child('dog')
+    dog_node.name.must_equal 'dog'
+    dog_node['name'].must_equal 'spot'
+    doc2_node = root.find_first_child('doc2')
+    doc2_node.name.must_equal 'doc2'
+    doc2_node.children.size.must_equal 1
+  end
+
+  it 'can do some find_first xpath' do
+    root = AXML.parse(@xml_string, :parser => @parser)
+    flea_node = root.find_first('descendant::flea')
+    flea_node.name.must_equal 'flea'
+    flea_node['name'].must_equal 'ouchy'
+    root.find_first('child::flea').must_be_nil
+    #root.find_first('child::doc2').name.must_equal 'doc2'
+    root.find_first('child::doc2').name.must_equal 'doc2'
+  end
+
+  it 'can drop nodes with "drop"' do
+    root = AXML.parse(@xml_string, :parser => @parser)
+    root.find_first_descendant("dog").wont_be_nil
+    root.child.name.must_equal "doc1"
+    doc2 = root.child.next
+    doc2.name.must_equal "doc2"
+    doc2.child.name.must_equal "dog"
+    doc2.child['height'].must_equal "5"
+  end
+
+  it 'can return "child" node' do
+    root = AXML.parse(@xml_string, :parser => @parser)
+    doc1 = root.child
+    doc1.name.must_equal 'doc1'
+    dog = doc1.child
+    dog.name.must_equal 'dog'
+    dog['name'].must_equal 'spot'
+    flea = dog.child
+    flea.name.must_equal 'flea'
+    flea['name'].must_equal 'ouchy'
+    flea.child.must_equal nil
+  end
+
+  it 'can return "next" node' do
+    root = AXML.parse(@xml_string, :parser => @parser)
+    root.next.must_equal nil
+    doc1 = root.child
+    doc2 = doc1.next
+    doc2.name.must_equal 'doc2'
+    doc2.next.must_equal nil
+    dog = doc1.child
+    dog.name.must_equal 'dog'
+    dog.next.must_equal nil
+    flea2 = dog.child.next
+    flea2.name.must_equal 'flea'
+    flea2['name'].must_equal 'crawly'
+    flea2.next.must_equal nil
+  end
+
+  it 'can find "following-sibling"' do
+    n1 = AXML.parse(@xml_large_string, :parser => @parser)
+    n3 = n1.child.child
+    n3.name.must_equal 'n3'
+    n3id2 = n3.find_first("following-sibling::n3")
+    n3id2['id'].must_equal '2'
+    n3b = n3.find_first("following-sibling::n3b")
+    n3b['id'].must_equal '5'
+    n3b.find_first("following-sibling::n3").must_equal nil
+  end
+
+  it 'knows if it has text' do
+    n1 = AXML.parse(@xml_with_text, :parser => @parser)
+    n5 = n1.find_first_child("n5")
+    n5.text?.must_equal true
+    n1.text?.must_equal false
+  end
+
+
+  it 'gets text from nodes' do
+    xml = '<n1><n2>this is the text</n2></n1>'
+    root = AXML.parse(xml, :parser => @parser)
+    root.child.text.must_equal 'this is the text'
+    root.child.content.must_equal 'this is the text'
+  end
+
+  it 'does full node traversal' do
+    root = AXML.parse(@xml_string, :parser => @parser)
+    names = []
+    root.traverse do |node|
+      names << node.name
+    end
+    names.must_equal ["xml", "doc1", "dog", "flea", "flea", "doc2", "dog"]
+  end
+
+  it 'can "find" with a little xpath' do
+    root = AXML.parse(@xml_large_string, :parser => @parser)
+    nodes = root.find('child::n2')
+    nodes.size.must_equal 2
+    nodes.each {|v| v.name.must_equal 'n2' }
+    nodes.each_with_index {|v,i| v['id'].must_equal( (i+1).to_s ) } 
+
+    nodes = root.find('descendant::n3')
+    nodes.size.must_equal 4
+    nodes.each {|v| v.name.must_equal 'n3' }
+    nodes.each_with_index {|v,i| v['id'].must_equal( (i+1).to_s )} 
+  end
+
+
+end
+
+module IndexBehaviorSpec
+  extend Shareable
+
+  it 'can retrieve text indices for a select node' do
+    root = AXML.parse(@xml_with_text, :text_indices => 'n2', :parser => @parser)
+    root.child.text.must_equal [11,9] # only the specified node affected
+    root.find_first_child("n7").text.must_equal "love & roses"
+  end
+end
+
+module OutputBehaviorSpec
+  extend Shareable
+
+    it '"to_s" gives xml' do
+    root = AXML.parse(@xml_string, :parser => @parser)
+    to_string = <<END
+<xml>
+  <doc1>
+    <dog name="spot" weight="13" height="23">
+      <flea name="ouchy" weight="10" height="20"/>
+      <flea name="crawly" weight="9" height="22"/>
+    </dog>
+  </doc1>
+  <doc2>
+    <dog name="billy" weight="3" height="5"/>
+  </doc2>
+</xml>
+END
+    root.to_s.must_equal to_string
+  end
+
+  it 'escapes element text in to_s output' do
+    n1 = AXML.parse(@xml_with_text, :parser => @parser)
+    n5 = n1.find_first_child("n5")
+    xml = <<END
+<n1>
+  <n2>doc1_text</n2>
+  <n3>doc2_text
+    <n4>doc3_text</n4>
+  </n3>
+  <n5>Bill&apos;y&apos; &quot;Wrangler&quot; Jones</n5>
+  <n6 class="8 &lt; and 6 &gt;" id="27&amp;22"/>
+  <n7>love &amp; roses</n7>
+</n1>
+END
+    n1.to_s.must_equal xml
+  end
+
+end
+
+module ValuesAtBehaviorSpec
+  extend Shareable
+
+   it 'can get many attributes at once with values_at (not supported by libxml)' do
+    root = AXML.parse(@xml_string, :parser => @parser)
+    dog = root.child.child.child
+    exp = %w(ouchy 20 10)
+    reply = dog.attrs.values_at('name', 'height', 'weight')
+    reply.must_equal exp
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: axml
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - John Prince
@@ -9,12 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-07 00:00:00 -07:00
+date: 2009-02-23 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
 description: 
-email: jprince@icmb.utexas.edu
+email: jtprince@gmail.com
 executables: []
 
 extensions: []
@@ -23,12 +23,18 @@ extra_rdoc_files:
 - README
 - LICENSE
 files: 
+- lib/axml
+- lib/axml/el.rb
+- lib/axml/autoload.rb
+- lib/axml/libxml.rb
+- lib/axml/xmlparser.rb
+- lib/axml/traverse.rb
 - lib/axml.rb
 - README
 - LICENSE
 - Rakefile
 has_rdoc: true
-homepage: 
+homepage: http://axml.rubyforge.org/
 post_install_message: 
 rdoc_options: 
 - --main
@@ -50,11 +56,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
   version: 
 requirements: 
-- xmlparser is needed right now
-rubyforge_project: 
+- xmlparser or libxml
+rubyforge_project: axml
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: AXML - Provides a simple DOM for working with XML (using XMLParser under the hood) that can serve as a drop in replacement for a subset of basic libxml functionality (e.g., each, children, child, find_first, find, next).
-test_files: []
-
+summary: "AXML - Provides a simple, minimalistic DOM for working with data stored in an XML document.  The API is very similar to LibXML, differing slightly in the handling of text nodes.  It is designed with very large documents in mind: nodes are represented in memory efficient Struct objects and it works with either XMLParser or LibXML!"
+test_files: 
+- spec/axml/xmlparser_spec.rb
+- spec/axml/autoload_spec.rb
+- spec/axml/libxml_spec.rb
+- spec/axml_spec.rb