demolisher 0.3.2 → 0.3.3

data/README.rdoc

@@ -1,4 +1,4 @@
-= demolisher
+= Demolisher
 
 Works in a similar fashion to Builder but is instead used for extracting information from XML files rather than building them.
 
@@ -6,7 +6,7 @@ Works in a similar fashion to Builder but is instead used for extracting informa
 
 Given the simple XML example file below
 
-  <addressbook>
+  <addressbook version="1.0">
     <person>
       <firstname>Enoch</firstname>
       <lastname>Root</lastname>
@@ -31,6 +31,7 @@ we can parse it with
 
   xml = Demolisher.demolish('addressbook.xml')
   xml.addressbook do
+    puts "Version #{xml['version']}"
     xml.person do
       puts "#{xml.firstname} #{xml.lastname}: #{xml.contact.email}"
       puts "this person is active" if xml.active?

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.3.3

data/demolisher.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{demolisher}
-  s.version = "0.3.2"
+  s.version = "0.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Geoff Garside"]

data/lib/demolisher.rb

@@ -9,30 +9,47 @@ module Demolisher
     yield node if block_given?
     node
   end
+
+  # Handles all the complexity of accessing the XML contents
   class Node
-    # Creates a new Node object. If the node is not the root node then
-    # the second argument needs to be false.
+    # Creates a new Node object.
+    #
+    # If the node is not the root node then the secondargument needs to be false.
     def initialize(xml, is_root = true)
       @nodes = [xml]
       @nodes.unshift(nil) unless is_root
     end
-    # Access an attribute of the current node
-    # Example:
+
+    # Access an attribute of the current node.
+    #
+    # XML file:
     #   <addressbook>
     #     <person rel="friend">
     #       <firstname>Steve</firstname>
     #     </person>
     #   </addressbook>
-    # 
+    #
+    # Example:
     #   xml.addressbook do
     #     xml.person do
     #       puts "#{xml.firstname} is a #{xml['rel']}"  #=> "Steve is a friend"
     #     end
     #   end
-    # 
+    #
     def [](attr_name)
       @nodes.last.attributes[attr_name]
     end
+
+    # The workhorse, finds the node matching meth.
+    #
+    # Rough flow guide:
+    #   If a block is given then yield to it each for each instance
+    #     of the element found in the current node.
+    #   If no block given then get the first element found
+    #     If the node has only one text element check if the
+    #       method called has a ? suffix then return true if node content
+    #       looks like a boolean. Otherwise return text content
+    #     Otherwise return a new Node instance
     def method_missing(meth, *args, &block) # :nodoc:
       xpath = @nodes.last.find(element_from_symbol(meth))
       return nil if xpath.empty?
@@ -41,10 +58,10 @@ module Demolisher
         xpath.each_with_index do |node, idx|
           @nodes.push(node)
           case block.arity
-          when 0
-            yield
           when 1
             yield idx
+          else
+            yield
           end
           @nodes.pop
         end
@@ -64,13 +81,18 @@ module Demolisher
         end
       end
     end
+
+    # Returns the current nodes contents.
     def to_s # :nodoc:
       @nodes.last.content.strip
     end
+
+    # Transforms a symbol into a XML element path.
     def element_from_symbol(sym) # :nodoc:
       "#{is_root_node? ? '/' : nil}#{sym.to_s.gsub(/[^a-z0-9_]/i, '')}"
     end
-    # Indicates if the current node is the root of the XML document
+
+    # Indicates if the current node is the root of the XML document.
     def is_root_node?
       @nodes.size == 1
     end

data/test/test.xml

@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
 <addressbook>
   <person>
     <firstname>Enoch</firstname>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: demolisher
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors: 
 - Geoff Garside
@@ -43,10 +43,8 @@ files:
 - test/demolisher_test.rb
 - test/test.xml
 - test/test_helper.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/geoffgarside/demolisher
-licenses: []
-
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -67,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: demolisher
-rubygems_version: 1.3.4
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 3
 summary: Gem for extracting information from XML files, think Builder but backwards