traverse 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in traversable.gemspec
+gemspec

data/README.md

@@ -0,0 +1,3 @@
+# Traverse
+
+Traverse is a simple tool that makes it easy to traverse XML.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+desc 'run the spec'
+task "spec" do
+  load './spec/spec.rb'
+end

data/lib/traverse/version.rb

@@ -0,0 +1,3 @@
+module Traverse
+  VERSION = "0.0.1"
+end

data/lib/traverse.rb

@@ -0,0 +1,69 @@
+require "traverse/version"
+require 'nokogiri'
+require 'open-uri'
+
+module Traverse
+  class Document
+    def initialize document
+      if document.is_a? String
+        begin
+          @document = Nokogiri::XML(document)
+        rescue
+          return nil
+        end
+      else
+        @document = document
+      end
+
+      if text_node?
+        define_singleton_method "text" do
+          @document.children.first.content
+        end
+      else
+        @document.children.reject do |child|
+          child.is_a? Nokogiri::XML::Text
+        end.group_by(&:name).each do |name, children|
+          if children.count == 1
+            define_singleton_method "#{name}" do 
+              Document.new children.first
+            end
+          else
+            define_singleton_method "#{name}s" do
+              children.map { |child| Document.new child }
+            end
+          end
+        end
+      end
+    end
+
+    def [] attr
+      @document.get_attribute attr
+    end
+
+    private
+      def method_missing m, *args, &block
+        self[m] or super
+      end
+
+      def text_node?
+        num_children = @document.children.count
+        return false unless num_children == 1
+
+        @document.children.first.is_a? Nokogiri::XML::Text
+      end
+  end
+
+  module Proxy
+    private
+      def proxy *args
+        if args.empty?
+          @proxy
+        else
+          @proxy = args.first
+          def method_missing m
+            @proxy.send m
+          end
+        end
+      end
+  end
+end

data/spec/spec.rb

@@ -0,0 +1,91 @@
+$:.push '../'
+require 'traverse'
+
+gem 'minitest'
+require 'minitest/autorun'
+require 'minitest/pride'
+
+xml = %{
+  <book title="Vineland" author="Thomas Pynchon">
+    <author name="Thomas Pynchon">
+      <book title="V" />
+      <book title="The Crying of Lot 49" />
+      <book title="Gravity's Rainbow" />
+      <book title="Slow Learner" />
+      <book title="Vineland" />
+      <book title="Mason &amp; Dixon" />
+      <book title="Against the Day" />
+      <book title="Inherent Vice" />
+    </author>
+    <epigraph author="Johnny Copeland">
+      Every dog has his day,
+      and a good dog
+        just might have two days.
+    </epigraph>
+    <quotations>
+      <quotation>
+        Up and down that street, she remembered, television screens had
+        flickered silent blue in the darkness. Strange loud birds, not of the
+        neighborhood, were attracted, some content to perch in the palm
+        trees, keeping silence and an eye out for the rats who lived in the
+        fronds, others flying by close to windows, seeking an angle to sit
+        and view the picture from. When the commercials came on, the birds,
+        with voices otherworldly pure, would sing back at them, sometimes
+        even when none were on.
+      </quotation>
+      <quotation>
+        Takeshi recognized his acquaintance Minoru, a government bomb-squad
+        expert. Not a genius, exactly, more like an idiot savant with X-ray
+        vision.
+      </quotation>
+    </quotes>
+    <review reviewer="Salman Rushdie">
+      What is interesting is to have before us, at the end of the Greed
+      Decade, that rarest of birds: a major political novel about what
+      America has been doing to itself, to its children, all these many
+      years.
+    </review>
+    <text text="seriously, who writes XML like this">
+      I mean, rilly.
+    </text>
+  </book>
+}
+
+describe Traverse::Document do
+  before do
+    @doc = Traverse::Document.new xml
+  end
+
+  it "helps you access attributes" do
+    @doc.book.title.must_equal "Vineland"
+  end
+
+  it "also helps you access attributes shadowed by children" do
+    @doc.book.author.wont_equal "Thomas Pynchon"
+    @doc.book['author'].must_equal "Thomas Pynchon"
+    @doc.book.author.name.must_equal "Thomas Pynchon"
+  end
+
+  it "helps you get at child nodes" do
+    @doc.book.review.reviewer.must_equal "Salman Rushdie"
+    @doc.book.epigraph.author.must_equal "Johnny Copeland"
+  end
+
+  it "knows when a node contains only text" do
+    assert @doc.book.epigraph.send(:text_node?)
+  end
+
+  it "handles annoying text nodes transparently" do
+    @doc.book.epigraph.text.must_match(/Every dog has his day/)
+    @doc.book.review.text.must_match(/that rarest of birds/)
+  end
+
+  it "nevertheless handles attributes named 'text'" do
+    @doc.book.text['text'].must_match(/seriously/)
+    @doc.book.text.text.must_match(/rilly/)
+  end
+
+  it "knows to collect children with the same name" do
+    @doc.book.author.books.count.must_equal 8
+  end
+end

data/traverse.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "traverse/version"
+
+Gem::Specification.new do |s|
+  s.name        = "traverse"
+  s.version     = Traverse::VERSION
+  s.authors     = ["happy4crazy"]
+  s.email       = ["alan.m.odonnell@gmail.com"]
+  s.homepage    = "https://github.com/happy4crazy/traverse"
+  s.summary     = %q{Easily traverse an XML document.}
+  s.description = %q{Easily traverse an XML document.}
+
+  s.rubyforge_project = "traverse"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'nokogiri', '~> 1.5'
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: traverse
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- happy4crazy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-02 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2164471840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164471840
+description: Easily traverse an XML document.
+email:
+- alan.m.odonnell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/traverse.rb
+- lib/traverse/version.rb
+- spec/spec.rb
+- traverse.gemspec
+has_rdoc: true
+homepage: https://github.com/happy4crazy/traverse
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: traverse
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Easily traverse an XML document.
+test_files:
+- spec/spec.rb