kind_dom 0.9.3 → 0.9.4

data/lib/kind_dom/base.rb

@@ -0,0 +1,126 @@
+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: 
+  # - <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.
+  #
+  # As a contrived example, in the controller:
+  #    @results = KindDom.new(xml_data)
+  # 
+  # In the view:
+  #    
+  #    <% @results.first_of('//item') do |item| -%>
+  #      <p>(This block is only executed if `item` is found.)</p>
+  #    
+  #      <% item.content_for('title') do |title| -%>
+  #        <h2><%=h title %></h2>
+  #        <p>(This block is only executed if `title` has content.)</p>
+  #      <% end -%>
+  #     
+  #      <% item.content_for('description') do |description| -%>
+  #        <p><%=h description %></p>
+  #        <p>(This block is only executed if `description` has content.)</p>
+  #      <% end -%>
+  #    <% end -%>
+  #
+  class Base < ObjectProxy
+  
+    attr_accessor :dom
+  
+    def initialize(raw_xml=nil)
+      unless raw_xml.blank?
+        parser = XML::Parser.new
+        parser.string = raw_xml
+        @dom = parser.parse
+      end
+    rescue XML::Parser::ParseError
+    ensure
+      @dom.extend Kindness
+      super(@dom) # Proxy all method calls to @dom. 
+    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
+      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 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
+      end
+    end
+  
+  end
+end

data/lib/kind_dom/object_proxy.rb

@@ -0,0 +1,31 @@
+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

data/lib/kind_dom.rb

@@ -1,125 +1,9 @@
-require 'object_proxy'
-require 'active_support'
-require 'xml/libxml'
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-
-# KindDom provides graceful access to the the DOM of an XML document using
-# 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.
-#
-# As a contrived example, in the controller:
-#    @results = KindDom.new(xml_data)
-# 
-# In the view:
-#    
-#    <% @results.first_of('//item') do |item| -%>
-#      <p>(This block is only executed if `item` is found.)</p>
-#    
-#      <% item.content_for('title') do |title| -%>
-#        <h2><%=h title %></h2>
-#        <p>(This block is only executed if `title` has content.)</p>
-#      <% end -%>
-#     
-#      <% item.content_for('description') do |description| -%>
-#        <p><%=h description %></p>
-#        <p>(This block is only executed if `description` has content.)</p>
-#      <% end -%>
-#    <% end -%>
-#
-class KindDom < ObjectProxy
-  
-  attr_accessor :dom
-  
-  def initialize(raw_xml=nil)
-    unless raw_xml.nil?
-      parser = XML::Parser.new
-      parser.string = raw_xml
-      @dom = parser.parse
-    end
-  rescue XML::Parser::ParseError
-  ensure
-    @dom.extend Kindness
-    super(@dom) # Proxy all method calls to @dom. 
-  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
-    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 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
-    end
-  end
-  
+unless defined? ActiveSupport
+  require 'rubygems'
+  require 'active_support'
 end
+
+require 'kind_dom/base'

data/test/kind_dom_test.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/../lib/kind_dom'
 
 class KindDomTest < Test::Unit::TestCase
   
-  @@test_dom = KindDom.new(File.read(File.dirname(__FILE__) + '/flickr_rss.xml'))
+  @@test_dom = KindDom::Base.new(File.read(File.dirname(__FILE__) + '/flickr_rss.xml'))
   
   def test_dom_initialization
     assert_kind_of XML::Document, @@test_dom

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kind_dom
 version: !ruby/object:Gem::Version 
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors: 
 - Mars Hall
@@ -12,15 +12,6 @@ cert_chain: []
 date: 2008-04-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: object_proxy
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.0.2
-    version: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
   version_requirement: 
@@ -48,6 +39,9 @@ extensions: []
 extra_rdoc_files: 
 - README
 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