kind_dom 0.9.6 → 0.9.7

data/README

@@ -1,4 +1,4 @@
-KindDom provides graceful access to the the DOM of an XML document, while preserving the original libxml behavior of the parsed document.
+KindDom: gracefully use XML content with node-type neutrality, content closure & default values.
 
 See the source code comments, rdoc or ri for usage details; the tests also demonstrate use cases.
 

data/lib/kind_dom/base.rb

@@ -1,15 +1,14 @@
-require 'kind_dom/object_proxy'
 require 'xml/libxml'
 
 module KindDom
 
   # KindDom provides graceful access to the the DOM of an XML document using
-  # three methods of Kindness: 
+  # three methods of kindness: 
   # - <tt>#collection_of</tt> to select a collection of nodes
   # - <tt>#first_of</tt> to select one node
   # - <tt>#content_for</tt> to get node content.
   #
-  # The original libxml behavior of the parsed document is preserved.
+  # The original libxml behavior of the XML document is preserved through the #dom accessor.
   #
   # As a contrived example, in the controller:
   #    @results = KindDom::Base.new(xml_data)
@@ -31,105 +30,102 @@ module KindDom
   #      <% end -%>
   #    <% end -%>
   #
-  class Base < ObjectProxy
+  class Base
   
-    attr_accessor :dom
+    attr_reader :dom
   
     # A new KindDom object may be created from raw XML [string] data, or 
-    # an already instantiated XML::Node or XML::Document.
+    # an already instantiated KindDom::Base, XML::Node or XML::Document.
     #
     def initialize(xml_in=nil)
-      unless xml_in.blank?
+      unless xml_in.nil?
         case 
+        when xml_in.kind_of?(KindDom::Base)
+          @dom = xml_in.dom
+        when xml_in.kind_of?(XML::Document), xml_in.kind_of?(XML::Node)
+          @dom = xml_in
         when xml_in.kind_of?(String)
           parser = XML::Parser.new
           parser.string = xml_in
           @dom = parser.parse
-        when xml_in.kind_of?(XML::Document), xml_in.kind_of?(XML::Node)
-          @dom = xml_in
         end
       end
     rescue XML::Parser::ParseError
+    end
+  
+    # Retrieve the contents of the first node or attribute selected by the XPath; 
+    # defaults to the current node, "."
+    #
+    # Optional second argument is the default value to return if the DOM find fails.
+    #
+    # When a block is provided, it will be called with the found content 
+    # (or default) before returning.
+    #
+    def content_for(xpath='.', default=nil)       # :yields: found_content
+      node = case @dom.class.to_s
+      when 'XML::Document' then
+        @dom.root.find_first(xpath)
+      else # 'XML::Node'
+        @dom.find_first(xpath)
+      end
+      content = case node.class.to_s
+      when 'XML::Attr' then
+        node.value
+      else
+        node.content
+      end
+    rescue NoMethodError
     ensure
-      @dom.extend Kindness
-      super(@dom) # Proxy all method calls to @dom. 
+      content = content.blank? ? default : content
+      if block_given? and !content.blank?
+        return yield(content)
+      else
+        return content
+      end
     end
   
-    module Kindness
-      # Retrieve the contents of the first node or attribute selected by the XPath.
-      #
-      # Optional second argument is the default value to return if the DOM find fails.
-      #
-      # When a block is provided, it will be called with the found content 
-      # (or default) before returning.
-      #
-      def content_for(xpath, default=nil)       # :yields: found_content
-        node = case self.class.to_s
-        when 'XML::Document' then
-          root.find_first(xpath)
-        else # 'XML::Node'
-          find_first(xpath)
-        end
-        content = case node.class.to_s
-        when 'XML::Attr' then
-          node.value
-        else
-          node.content
-        end
-      rescue NoMethodError
-      ensure
-        content = content.blank? ? default : content
-        if block_given? and !content.blank?
-          return yield(content)
-        else
-          return content
-        end
+    # Retrieve a collection (Array) of DOM nodes selected by the XPath.
+    #
+    # Each node is returned as KindDom to support #content_for, #collection_of & #first_of.
+    #
+    # When a block is provided, it will be called with the found collection 
+    # (or default) before returning.
+    #
+    def collection_of(xpath, default=nil)      # :yields: found_collection
+      c = @dom.find(xpath).collect {|n| self.class.new(n) }
+    rescue NoMethodError
+    ensure
+      c = c.blank?||c.size<1 ? default : c
+      if block_given? and !c.nil?
+        return yield(c)
+      else
+        return c
       end
-    
-      # Retrieve a collection (Array) of DOM nodes selected by the XPath.
-      #
-      # Each node is extended with Kindness to support #content_for, #collection_of & #first_of.
-      #
-      # When a block is provided, it will be called with the found collection 
-      # (or default) before returning.
-      #
-      def collection_of(xpath, default=nil)      # :yields: found_collection
-        c = find(xpath).collect {|n| n.extend Kindness }
-      rescue NoMethodError
-      ensure
-        c = c.blank?||c.size<1 ? default : c
-        if block_given? and !c.nil?
-          return yield(c)
-        else
-          return c
-        end
+    end
+  
+    # Retrieve the first DOM node selected by the XPath.
+    #
+    # The node is returned as KindDom to support #content_for, #collection_of & #first_of.
+    #
+    # When a block is provided, it will be called with the found node 
+    # (or default) before returning.
+    #
+    def first_of(xpath, default=nil)      # :yields: found_node
+      n = case @dom.class.to_s
+      when 'XML::Document' then
+        @dom.root.find_first(xpath)
+      else # 'XML::Node'
+        @dom.find_first(xpath)
       end
-    
-      # Retrieve the first DOM node selected by the XPath.
-      #
-      # The node is extended with Kindness to support #content_for, #collection_of & #first_of.
-      #
-      # When a block is provided, it will be called with the found node 
-      # (or default) before returning.
-      #
-      def first_of(xpath, default=nil)      # :yields: found_node
-        n = case self.class.to_s
-        when 'XML::Document' then
-          root.find_first(xpath)
-        else # 'XML::Node'
-          find_first(xpath)
-        end
-        n.extend Kindness
-      rescue NoMethodError
-      ensure
-        n = n.blank? ? default : n
-        if block_given? and !n.blank?
-          return yield(n)
-        else
-          return n
-        end
+    rescue NoMethodError
+    ensure
+      n = n.blank? ? default : self.class.new(n)
+      if block_given? and !n.blank?
+        return yield(n)
+      else
+        return n
       end
     end
   
   end
-end
+end

data/test/kind_dom_test.rb

@@ -3,102 +3,105 @@ require File.dirname(__FILE__) + '/../lib/kind_dom'
 
 class KindDomTest < Test::Unit::TestCase
   
-  @@test_dom = KindDom::Base.new(File.read(File.dirname(__FILE__) + '/flickr_rss.xml'))
+  @@test_doc = KindDom::Base.new(File.read(File.dirname(__FILE__) + '/flickr_rss.xml'))
   
   def test_initialization_from_raw_xml
-    assert_kind_of XML::Document, @@test_dom
-    assert @@test_dom.respond_to?(:content_for)
+    assert_kind_of KindDom::Base, @@test_doc
+    assert_kind_of XML::Document, @@test_doc.dom
+    assert @@test_doc.respond_to?(:content_for)
   end
   
   def test_initialization_from_xml_document
     parsed = parse_xml File.read(File.dirname(__FILE__) + '/flickr_rss.xml')
     k = KindDom::Base.new(parsed)
-    assert_kind_of XML::Document, k
+    assert_kind_of KindDom::Base, k
+    assert_kind_of XML::Document, k.dom
     assert k.respond_to?(:content_for)
   end
   
   def test_initialization_from_xml_node
     parsed = parse_xml File.read(File.dirname(__FILE__) + '/flickr_rss.xml')
     k = KindDom::Base.new(parsed.root.find_first('channel/item'))
-    assert_kind_of XML::Node, k
+    assert_kind_of KindDom::Base, k
+    assert_kind_of XML::Node, k.dom
     assert k.respond_to?(:content_for)
   end
   
   
   def test_content_for__success
-    assert_equal 'Photos from marsi', @@test_dom.content_for('channel/title')
+    assert_equal 'Photos from marsi', @@test_doc.content_for('channel/title')
   end
   
   def test_content_for__success_with_closure
-    assert_equal 'PHOTOS FROM MARSI', @@test_dom.content_for('channel/title') {|content| content.upcase}
+    assert_equal 'PHOTOS FROM MARSI', @@test_doc.content_for('channel/title') {|content| content.upcase}
   end
   
   def test_content_for__default
-    assert_equal 'a flickr stream', @@test_dom.content_for('//blank_or_non_existent', 'a flickr stream')
+    assert_equal 'a flickr stream', @@test_doc.content_for('//blank_or_non_existent', 'a flickr stream')
   end
   
   def test_content_for__default_with_closure
-    assert_equal 'A FLICKR STREAM', @@test_dom.content_for('//blank_or_non_existent', 'a flickr stream') {|content| content.upcase}
+    assert_equal 'A FLICKR STREAM', @@test_doc.content_for('//blank_or_non_existent', 'a flickr stream') {|content| content.upcase}
   end
   
   def test_content_for__failure
-    assert_nil @@test_dom.content_for('//blank_or_non_existent')
+    assert_nil @@test_doc.content_for('//blank_or_non_existent')
   end
   
   def test_content_for__failure_with_closure
-    assert_nil @@test_dom.content_for('//blank_or_non_existent') {|content| 'this closure is not called'}
+    assert_nil @@test_doc.content_for('//blank_or_non_existent') {|content| 'this closure is not called'}
   end
   
   
   def test_collection_of__success
-    items = @@test_dom.collection_of('channel/item')
+    items = @@test_doc.collection_of('channel/item')
     assert_kind_of Enumerable, items
     assert 20 == items.size
   end
   
   def test_collection_of__success_with_closure
-    items = @@test_dom.collection_of('channel/item') {|collection| collection[0..-2]}
+    items = @@test_doc.collection_of('channel/item') {|collection| collection[0..-2]}
     assert_kind_of Enumerable, items
     assert 19 == items.size
   end
   
   def test_collection_of__default
-    items = @@test_dom.collection_of('//blank_or_non_existent', ['A lonely default item'])
+    items = @@test_doc.collection_of('//blank_or_non_existent', ['A lonely default item'])
     assert_kind_of Enumerable, items
     assert 1 == items.size
   end
   
   def test_collection_of__default_with_closure
-    items = @@test_dom.collection_of('//blank_or_non_existent', Array.new) {|collection| collection << 'I was empty' }
+    items = @@test_doc.collection_of('//blank_or_non_existent', Array.new) {|collection| collection << 'I was empty' }
     assert_kind_of Enumerable, items
     assert 1 == items.size
   end
   
   def test_collection_of__failure
-    assert_nil @@test_dom.collection_of('//blank_or_non_existent')
+    assert_nil @@test_doc.collection_of('//blank_or_non_existent')
   end
   
   def test_collection_of__failure_with_closure
-    assert_nil @@test_dom.collection_of('//blank_or_non_existent') {|collection| 'this closure is not called'}
+    assert_nil @@test_doc.collection_of('//blank_or_non_existent') {|collection| 'this closure is not called'}
   end
   
   
   def test_first_of__success
-    assert_kind_of XML::Node, @@test_dom.first_of('channel/item')
+    assert_kind_of KindDom::Base, @@test_doc.first_of('channel/item')
   end
   
   def test_first_of__success_with_closure
-    n = @@test_dom.first_of('channel/item') {|node| node.parent}
-    assert_kind_of XML::Node, n
-    assert_equal 'channel', n.name
+    n = @@test_doc.first_of('channel/item') {|node| node.first_of('title') }
+    assert_kind_of KindDom::Base, n
+    assert_equal 'Alaya Cove', n.content_for
   end
   
   def test_first_of__failure
-    assert_nil @@test_dom.first_of('//blank_or_non_existent')
+    assert_nil @@test_doc.first_of('//blank_or_non_existent')
   end
   
   def test_first_of__failure_with_closure
-    assert_nil @@test_dom.first_of('//blank_or_non_existent') {|node| 'this closure is not called'}
+    assert_nil @@test_doc.first_of('//blank_or_non_existent') {|node| 'this closure is not called'}
   end
   
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kind_dom
 version: !ruby/object:Gem::Version 
-  version: 0.9.6
+  version: 0.9.7
 platform: ruby
 authors: 
 - Mars Hall
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-02 00:00:00 -07:00
+date: 2008-07-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,7 +41,6 @@ extra_rdoc_files:
 files: 
 - lib/kind_dom
 - lib/kind_dom/base.rb
-- lib/kind_dom/object_proxy.rb
 - lib/kind_dom.rb
 - test/flickr_rss.xml
 - test/kind_dom_test.rb

data/lib/kind_dom/object_proxy.rb

@@ -1,31 +0,0 @@
-module KindDom
-
-  # The foundation of an object proxy is the BlankSlate.
-  #
-  # BlankSlate is included with Rails ActiveSupport
-  # as active_support/vendor/builder-2.1.2/blankslate.rb
-  #
-  # From the Rails rdoc: "BlankSlate provides an abstract base class with 
-  # no predefined methods (except for __send__ and __id__). BlankSlate is useful
-  # as a base class when writing classes that depend upon method_missing 
-  # (e.g. dynamic proxies)."
-  #
-  # ObjectProxy is a bare-bones proxy. Override #method_missing in your subclass
-  # to handle method calls in the proxy.
-  #
-  class ObjectProxy < BlankSlate
-  
-    # Create a proxy to the provided object.
-    def initialize(target)
-      @target = target
-    end
-  
-    # Override #method_missing in your subclass
-    # to handle method calls in the proxy; call `super(sym, *args, &block)`
-    # therein to get a response from the proxied object.
-    def method_missing(sym, *args, &block)
-      @target.__send__(sym, *args, &block)
-    end
-  end
-  
-end