jnunemaker-happymapper 0.2.0 → 0.2.1

data/History

@@ -1,3 +1,10 @@
+== 0.2.1
+* 1 minor fix, 3 major enhancements
+  * fixed warnings about using XML::Parser (mojodna)
+  * Improved namespace support, now handles multiple namespaces and allows namespaces to be set item wide or on a per element basis (mojodna)
+  * Auto detect root nodes (mojodna)
+  * Type coercion (mojodna)
+  
 == 0.2.0
 * 1 major enhancement, 2 minor ehancements
   * Automatic handling of namespaces (part by Robert Lowrey and rest by John Nunemaker)

data/Rakefile

@@ -13,7 +13,7 @@ Echoe.new(ProjectName, HappyMapper::Version) do |p|
   p.url             = "http://#{ProjectName}.rubyforge.org"
   p.author          = "John Nunemaker"
   p.email           = "nunemaker@gmail.com"
-  p.extra_deps      = [['libxml-ruby', '>= 0.9.7']]
+  p.extra_deps      = [['libxml-ruby', '= 0.9.8']]
   p.need_tar_gz     = false
   p.docs_host       = WebsitePath
 end

data/TODO

@@ -1 +0,0 @@
-* doesn't do xml namespaces really (does work with default namespace though)

data/examples/amazon.rb

@@ -3,6 +3,8 @@ require File.join(dir, 'happymapper')
 
 file_contents = File.read(dir + '/../spec/fixtures/pita.xml')
 
+# The document `pita.xml` contains both a default namespace and the 'georss'
+# namespace (for the 'point' element).
 module PITA
   class Item
     include HappyMapper
@@ -11,6 +13,9 @@ module PITA
     element :asin, String, :tag => 'ASIN'
     element :detail_page_url, String, :tag => 'DetailPageURL'
     element :manufacturer, String, :tag => 'Manufacturer', :deep => true
+    # this is the only element that exists in a different namespace, so it
+    # must be explicitly specified
+    element :point, String, :tag => 'point', :namespace => 'georss'
   end
 
   class Items

data/examples/current_weather.rb

@@ -5,7 +5,9 @@ file_contents = File.read(dir + '/../spec/fixtures/current_weather.xml')
 
 class CurrentWeather
   include HappyMapper
+  
   tag 'ob'
+  namespace 'aws'
   element :temperature, Integer, :tag => 'temp'
   element :feels_like, Integer, :tag => 'feels-like'
   element :current_condition, String, :tag => 'current-condition', :attributes => {:icon => String}

data/examples/dashed_elements.rb

@@ -7,7 +7,7 @@ module GitHub
   class Commit
     include HappyMapper
 
-    tag "commit", :root => true
+    tag "commit"
     element :url, String
     element :tree, String
     element :message, String

data/happymapper.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{happymapper}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Nunemaker"]
@@ -25,14 +25,14 @@ Gem::Specification.new do |s|
     s.specification_version = 2
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<libxml-ruby>, [">= 0.9.7"])
+      s.add_runtime_dependency(%q<libxml-ruby>, ["= 0.9.8"])
       s.add_development_dependency(%q<echoe>, [">= 0"])
     else
-      s.add_dependency(%q<libxml-ruby>, [">= 0.9.7"])
+      s.add_dependency(%q<libxml-ruby>, ["= 0.9.8"])
       s.add_dependency(%q<echoe>, [">= 0"])
     end
   else
-    s.add_dependency(%q<libxml-ruby>, [">= 0.9.7"])
+    s.add_dependency(%q<libxml-ruby>, ["= 0.9.8"])
     s.add_dependency(%q<echoe>, [">= 0"])
   end
 end

data/lib/happymapper.rb

@@ -5,7 +5,7 @@ require 'date'
 require 'time'
 require 'rubygems'
 
-gem 'libxml-ruby', '>= 0.9.7'
+gem 'libxml-ruby', '= 0.9.8'
 require 'xml'
 require 'libxml_ext/libxml_helper'
 
@@ -13,7 +13,9 @@ require 'libxml_ext/libxml_helper'
 class Boolean; end
 
 module HappyMapper
-  
+
+  DEFAULT_NS = "happymapper"
+
   def self.included(base)
     base.instance_variable_set("@attributes", {})
     base.instance_variable_set("@elements", {})
@@ -50,12 +52,16 @@ module HappyMapper
     def has_many(name, type, options={})
       element name, type, {:single => false}.merge(options)
     end
-    
-    # Options:
-    #   :root => Boolean, true means this is xml root
-    def tag(new_tag_name, o={})
-      options = {:root => false}.merge(o)
-      @root = options.delete(:root)
+
+    # Specify a namespace if a node and all its children are all namespaced
+    # elements. This is simpler than passing the :namespace option to each
+    # defined element.
+    def namespace(namespace = nil)
+      @namespace = namespace if namespace
+      @namespace
+    end
+
+    def tag(new_tag_name)
       @tag_name = new_tag_name.to_s
     end
     
@@ -65,55 +71,61 @@ module HappyMapper
       end
     end
         
-    def is_root?
-      @root
-    end
-    
-    def parse(xml, o={})      
-      xpath, collection, options = '', [], {:single => false}.merge(o)
-      doc   = xml.is_a?(LibXML::XML::Node) ? xml : xml.to_libxml_doc
-      node  = doc.respond_to?(:root) ? doc.root : doc
-      
-      # puts doc.inspect, doc.respond_to?(:root) ? doc.root.inspect : ''
-      
-      unless node.namespaces.default.nil?
-        namespace = "default_ns:" 
-        node.namespaces.default_prefix = namespace.chop
-        # warn "Default XML namespace present -- results are unpredictable" 
+    def parse(xml, options = {})
+      # locally scoped copy of namespace for this parse run
+      namespace = @namespace
+
+      if xml.is_a?(XML::Node)
+        node = xml
+      else
+        if xml.is_a?(XML::Document)
+          node = xml.root
+        else
+          node = xml.to_libxml_doc.root
+        end
+
+        root = node.name == get_tag_name
       end
-      
-      if node.namespaces.to_a.size > 0 && namespace.nil? && !node.namespaces.namespace.nil?
-        namespace = node.namespaces.namespace.prefix + ":" 
+
+      # This is the entry point into the parsing pipeline, so the default
+      # namespace prefix registered here will propagate down
+      namespaces = node.namespaces
+      if namespaces && namespaces.default
+        namespaces.default_prefix = DEFAULT_NS
+        namespace ||= DEFAULT_NS
       end
-      
-      # xpath += doc.respond_to?(:root) ? '' : '.'
-      xpath += is_root? ? '/' : './/'
-      xpath += namespace  if namespace
+
+      xpath = root ? '/' : './/'
+      xpath += "#{namespace}:" if namespace
       xpath += get_tag_name
       # puts "parse: #{xpath}"
       
       nodes = node.find(xpath)
-      nodes.each do |n|
+      collection = nodes.collect do |n|
         obj = new
         
         attributes.each do |attr| 
           obj.send("#{attr.method_name}=", 
-                    attr.from_xml_node(n))
+                    attr.from_xml_node(n, namespace))
         end
         
         elements.each do |elem|
-          elem.namespace = namespace
           obj.send("#{elem.method_name}=", 
-                    elem.from_xml_node(n))
+                    elem.from_xml_node(n, namespace))
         end
-        collection << obj
+
+        obj
       end
 
       # per http://libxml.rubyforge.org/rdoc/classes/LibXML/XML/Document.html#M000354
       nodes = nil
       GC.start
 
-      options[:single] || is_root? ? collection.first : collection
+      if options[:single] || root
+        collection.first
+      else
+        collection
+      end
     end
   end
 end

data/lib/happymapper/item.rb

@@ -7,33 +7,55 @@ module HappyMapper
     # options:
     #   :deep   =>  Boolean False to only parse element's children, True to include
     #               grandchildren and all others down the chain (// in expath)
+    #   :namespace => String Element's namespace if it's not the global or inherited
+    #                  default
+    #   :parser =>  Symbol Class method to use for type coercion.
+    #   :raw    =>  Boolean Use raw node value (inc. tags) when parsing.
     #   :single =>  Boolean False if object should be collection, True for single object
+    #   :tag    =>  String Element name if it doesn't match the specified name.
     def initialize(name, type, o={})
       self.name = name.to_s
       self.type = type
       self.tag = o.delete(:tag) || name.to_s
-      self.options = {
-        :single => false, 
-        :deep   => false,
-      }.merge(o)
+      self.options = o
       
       @xml_type = self.class.to_s.split('::').last.downcase
     end
         
-    def from_xml_node(node)
+    def from_xml_node(node, namespace)
       if primitive?
-        value_from_xml_node(node) do |value_before_type_cast|
-          typecast(value_before_type_cast)
+        find(node, namespace) do |n|
+          if n.respond_to?(:content)
+            typecast(n.content)
+          else
+            typecast(n.to_s)
+          end
         end
       else
-        type.parse(node, options)
+        if options[:parser]
+          find(node, namespace) do |n|
+            if n.respond_to?(:content) && !options[:raw]
+              value = n.content
+            else
+              value = n.to_s
+            end
+
+            begin
+              type.send(options[:parser].to_sym, value)
+            rescue
+              nil
+            end
+          end
+        else
+          type.parse(node, options)
+        end
       end
     end
     
-    def xpath
+    def xpath(namespace = self.namespace)
       xpath  = ''
       xpath += './/' if options[:deep]
-      xpath += namespace if namespace
+      xpath += "#{namespace}:" if namespace
       xpath += tag
       # puts "xpath: #{xpath}"
       xpath
@@ -86,16 +108,25 @@ module HappyMapper
     end
     
     private
-      def value_from_xml_node(node)
+      def find(node, namespace, &block)
+        # this node has a custom namespace (that is present in the doc)
+        if self.namespace && node.namespaces.find_by_prefix(self.namespace)
+          # from the class definition
+          namespace = self.namespace
+        elsif options[:namespace] && node.namespaces.find_by_prefix(options[:namespace])
+          # from an element definition
+          namespace = options[:namespace]
+        end
+
         if element?
-          result = node.find_first(xpath)
+          result = node.find_first(xpath(namespace))
           # puts "vfxn: #{xpath} #{result.inspect}"
           if result
-            value = yield(result.content)
+            value = yield(result)
             if options[:attributes].is_a?(Hash)
               result.attributes.each do |xml_attribute|
                 if attribute_options = options[:attributes][xml_attribute.name.to_sym]
-                  attribute_value = Attribute.new(xml_attribute.name.to_sym, *attribute_options).from_xml_node(result)
+                  attribute_value = Attribute.new(xml_attribute.name.to_sym, *attribute_options).from_xml_node(result, namespace)
                   result.instance_eval <<-EOV
                     def value.#{xml_attribute.name}
                       #{attribute_value.inspect}

data/lib/happymapper/version.rb

@@ -1,3 +1,3 @@
 module HappyMapper
-  Version = '0.2.0'
+  Version = '0.2.1'
 end

data/lib/libxml_ext/libxml_helper.rb

@@ -50,8 +50,6 @@ end
  
 class String
   def to_libxml_doc
-    xp = XML::Parser.new
-    xp.string = self
-    return xp.parse
+    XML::Parser.string(self).parse
   end
 end

data/spec/fixtures/pita.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<ItemSearchResponse xmlns="http://webservices.amazon.com/AWSECommerceService/2005-10-05">
+<ItemSearchResponse xmlns="http://webservices.amazon.com/AWSECommerceService/2005-10-05" xmlns:georss="http://www.georss.org/georss">
 	<OperationRequest>
 		<HTTPHeaders>
 			<Header Name="UserAgent">
@@ -27,6 +27,7 @@
 		<TotalPages>3</TotalPages>
 		<Item>
 			<ASIN>0321480791</ASIN>
+			<georss:point>38.5351715088 -121.7948684692</georss:point>
 		<DetailPageURL>http://www.amazon.com/gp/redirect.html%3FASIN=0321480791%26tag=ws%26lcode=xm2%26cID=2025%26ccmID=165953%26location=/o/ASIN/0321480791%253FSubscriptionId=dontbeaswoosh</DetailPageURL>
 			<ItemAttributes>
 				<Author>Michael Hartl</Author>

data/spec/happymapper_item_spec.rb

@@ -44,7 +44,7 @@ describe HappyMapper::Item do
     
     it "should prepend namespace if namespace exists" do
       item = HappyMapper::Item.new(:foo, String, :tag => 'foobar')
-      item.namespace = 'v2:'
+      item.namespace = 'v2'
       item.xpath.should == 'v2:foobar'
     end
   end

data/spec/happymapper_spec.rb

@@ -1,5 +1,6 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 require 'pp'
+require 'uri'
 
 class Feature
   include HappyMapper
@@ -38,7 +39,7 @@ module FamilySearch
   class FamilyTree
     include HappyMapper
     
-    tag 'familytree', :root => true
+    tag 'familytree'
     attribute :version, String
     attribute :status_message, String, :tag => 'statusMessage'
     attribute :status_code, String, :tag => 'statusCode'
@@ -51,6 +52,7 @@ module FedEx
     include HappyMapper
     
     tag 'Address'
+    namespace 'v2'
     element :city, String, :tag => 'City'
     element :state, String, :tag => 'StateOrProvinceCode'
     element :zip, String, :tag => 'PostalCode'
@@ -62,6 +64,7 @@ module FedEx
     include HappyMapper
     
     tag 'Events'
+    namespace 'v2'
     element :timestamp, String, :tag => 'Timestamp'
     element :eventtype, String, :tag => 'EventType'
     element :eventdescription, String, :tag => 'EventDescription'
@@ -72,6 +75,7 @@ module FedEx
     include HappyMapper
     
     tag 'PackageWeight'
+    namespace 'v2'
     element :units, String, :tag => 'Units'
     element :value, Integer, :tag => 'Value'
   end
@@ -80,6 +84,7 @@ module FedEx
     include HappyMapper
     
     tag 'TrackDetails'
+    namespace 'v2'
     element   :tracking_number, String, :tag => 'TrackingNumber'
     element   :status_code, String, :tag => 'StatusCode'
     element   :status_desc, String, :tag => 'StatusDescription'
@@ -94,6 +99,7 @@ module FedEx
     include HappyMapper
     
     tag 'Notifications'
+    namespace 'v2'
     element :severity, String, :tag => 'Severity'
     element :source, String, :tag => 'Source'
     element :code, Integer, :tag => 'Code'
@@ -105,13 +111,15 @@ module FedEx
     include HappyMapper
     
     tag 'TransactionDetail'
+    namespace 'v2'
     element :cust_tran_id, String, :tag => 'CustomerTransactionId'
   end
   
   class TrackReply
     include HappyMapper
     
-    tag 'TrackReply', :root => true
+    tag 'TrackReply'
+    namespace 'v2'
     element   :highest_severity, String, :tag => 'HighestSeverity'
     element   :more_data, Boolean, :tag => 'MoreData'
     has_many  :notifications, Notification, :tag => 'Notifications'
@@ -167,6 +175,7 @@ class Status
 	element :in_reply_to_status_id, Integer
 	element :in_reply_to_user_id, Integer
 	element :favorited, Boolean
+	element :non_existent, String, :tag => 'dummy', :namespace => 'fake'
 	has_one :user, User
 end
 
@@ -174,6 +183,7 @@ class CurrentWeather
   include HappyMapper
   
   tag 'ob'
+  namespace 'aws'
   element :temperature, Integer, :tag => 'temp'
   element :feels_like, Integer, :tag => 'feels-like'
   element :current_condition, String, :tag => 'current-condition', :attributes => {:icon => String}
@@ -182,7 +192,7 @@ end
 class Address
   include HappyMapper
   
-  tag 'address', :root => true
+  tag 'address'
   element :street, String
   element :postcode, String
   element :housenumber, String
@@ -190,14 +200,19 @@ class Address
   element :country, String
 end
 
+# for type coercion
+class ProductGroup < String; end
+
 module PITA
   class Item
     include HappyMapper
     
     tag 'Item' # if you put class in module you need tag
     element :asin, String, :tag => 'ASIN'
-    element :detail_page_url, String, :tag => 'DetailPageURL'
+    element :detail_page_url, URI, :tag => 'DetailPageURL', :parser => :parse
     element :manufacturer, String, :tag => 'Manufacturer', :deep => true
+    element :point, String, :tag => 'point', :namespace => 'georss'
+    element :product_group, ProductGroup, :tag => 'ProductGroup', :deep => true, :parser => :new, :raw => true
   end
 
   class Items
@@ -214,7 +229,7 @@ module GitHub
   class Commit
     include HappyMapper
 
-    tag "commit", :root => true
+    tag "commit"
     element :url, String
     element :tree, String
     element :message, String
@@ -290,7 +305,7 @@ describe HappyMapper do
       element.type.should == User
       element.options[:single] = false
     end
-    
+
     it "should default tag name to lowercase class" do
       Foo.get_tag_name.should == 'foo'
     end
@@ -305,6 +320,11 @@ describe HappyMapper do
       Foo.get_tag_name.should == 'FooBar'
     end
     
+    it "should allow setting a namespace" do
+      Foo.namespace(namespace = "foo")
+      Foo.namespace.should == namespace
+    end
+
     it "should provide #parse" do
       Foo.should respond_to(:parse)
     end
@@ -320,7 +340,7 @@ describe HappyMapper do
   describe "#elements" do
     it "should only return elements for the current class" do
       Post.elements.size.should == 0
-      Status.elements.size.should == 9
+      Status.elements.size.should == 10
     end
   end
   
@@ -376,8 +396,11 @@ describe HappyMapper do
     first  = items.items[0]
     second = items.items[1]
     first.asin.should == '0321480791'
-    first.detail_page_url.should == 'http://www.amazon.com/gp/redirect.html%3FASIN=0321480791%26tag=ws%26lcode=xm2%26cID=2025%26ccmID=165953%26location=/o/ASIN/0321480791%253FSubscriptionId=dontbeaswoosh'
+    first.point.should == '38.5351715088 -121.7948684692'
+    first.detail_page_url.should be_a_kind_of(URI)
+    first.detail_page_url.to_s.should == 'http://www.amazon.com/gp/redirect.html%3FASIN=0321480791%26tag=ws%26lcode=xm2%26cID=2025%26ccmID=165953%26location=/o/ASIN/0321480791%253FSubscriptionId=dontbeaswoosh'
     first.manufacturer.should == 'Addison-Wesley Professional'
+    first.product_group.should == '<ProductGroup>Book</ProductGroup>'
     second.asin.should == '047022388X'
     second.manufacturer.should == 'Wrox'
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jnunemaker-happymapper
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - John Nunemaker
@@ -17,9 +17,9 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: 0.9.7
+        version: 0.9.8
     version: 
 - !ruby/object:Gem::Dependency 
   name: echoe