nokogiri-happymapper 0.3.6 → 0.5.1

data/lib/happymapper/item.rb

@@ -26,14 +26,25 @@ module HappyMapper
     def constant
       @constant ||= constantize(type)
     end
-        
+      
+    #
+    # @param [XMLNode] node the xml node that is being parsed
+    # @param [String] namespace the name of the namespace
+    # @param [Hash] xpath_options additional xpath options
+    #  
     def from_xml_node(node, namespace, xpath_options)
+      
+      # If the item is defined as a primitive type then cast the value to that type
+      # else if the type is XMLContent then store the xml value
+      # else the type, specified, needs to handle the parsing.
+      #
+      
       if primitive?
         find(node, namespace, xpath_options) do |n|
           if n.respond_to?(:content)
             typecast(n.content)
           else
-            typecast(n.to_s)
+            typecast(n)
           end
         end
       elsif constant == XmlContent
@@ -42,6 +53,11 @@ module HappyMapper
           n.respond_to?(:to_xml) ? n.to_xml : n.to_s
         end
       else
+        
+        # When not a primitive type or XMLContent then default to using the
+        # class method #parse of the type class. If the option 'parser' has been 
+        # defined then call that method on the type class instead of #parse
+        
         if options[:parser]
           find(node, namespace, xpath_options) do |n|
             if n.respond_to?(:content) && !options[:raw]
@@ -67,10 +83,12 @@ module HappyMapper
       xpath += './/' if options[:deep]
       xpath += "#{namespace}:" if namespace
       xpath += tag
-      # puts "xpath: #{xpath}"
+      #puts "xpath: #{xpath}"
       xpath
     end
-
+    
+    # @return [Boolean] true if the type defined for the item is defined in the
+    #     list of primite types {Types}.
     def primitive?
       Types.include?(constant)
     end
@@ -91,6 +109,17 @@ module HappyMapper
       @method_name ||= name.tr('-', '_')
     end
 
+    #
+    # When the type of the item is a primitive type, this will convert value specifed
+    # to the particular primitive type. If it fails during this process it will
+    # return the original String value.
+    # 
+    # @param [String] value the string value parsed from the XML value that will
+    #     be converted to the particular primitive type.
+    # 
+    # @return [String,Float,Time,Date,DateTime,Boolean,Integer] the converted value
+    #     to the new type.
+    #
     def typecast(value)
       return value if value.kind_of?(constant) || value.nil?
       begin        
@@ -123,6 +152,14 @@ module HappyMapper
 
     private
 
+      #
+      # Convert any String defined types into their constant version so that
+      # the method #parse or the custom defined parser method would be used.
+      # 
+      # @param [String,Constant] type is the name of the class or the constant
+      #     for the class.
+      # @return [Constant] the constant of the type
+      #
       def constantize(type)
         if type.is_a?(String)
           names = type.split('::')
@@ -152,7 +189,14 @@ module HappyMapper
         
         if element?
           if options[:single]
-            result = node.xpath(xpath(namespace), xpath_options)
+            
+            result = nil
+            
+            if options[:xpath]
+              result = node.xpath(options[:xpath], xpath_options)
+            else
+              result = node.xpath(xpath(namespace), xpath_options)
+            end
 
             if result
               value = options[:single] ? yield(result.first) : result.map {|r| yield r }
@@ -161,7 +205,10 @@ module HappyMapper
               value
             end
           else
-            results = node.xpath(xpath(namespace), xpath_options).collect do |result|
+            
+            target_path = options[:xpath] ? options[:xpath] : xpath(namespace)
+            
+            results = node.xpath(target_path, xpath_options).collect do |result|
               value = yield(result)
               handle_attributes_option(result, value, xpath_options)
               value
@@ -169,7 +216,13 @@ module HappyMapper
             results
           end
         elsif attribute?
-          yield(node[tag])
+          
+          if options[:xpath]
+            yield(node.xpath(options[:xpath],xpath_options))
+          else
+            yield(node[tag])
+          end
+          
         else # text node
           yield(node.children.detect{|c| c.text?})
         end
@@ -177,7 +230,7 @@ module HappyMapper
 
       def handle_attributes_option(result, value, xpath_options)
         if options[:attributes].is_a?(Hash)
-          result = result.first if result.respond_to?(:first)
+          result = result.first unless result.respond_to?(:attribute_nodes)
 
           result.attribute_nodes.each do |xml_attribute|
             if attribute_options = options[:attributes][xml_attribute.name.to_sym]

data/spec/fixtures/ambigous_items.xml

@@ -18,5 +18,5 @@
     <item>
       <name>Other item</name>
     </item>
-  <others-items>
+  </others-items>
 </ambigous>

data/spec/fixtures/atom.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<feed xml:lang="en-US" xmlns="http://www.w3.org/2005/Atom">
+  <id>tag:www.example.com,2005:/tv_shows</id>
+  <link rel="alternate" type="text/html" href="http://www.example.com"/>
+  <link rel="self" type="application/atom+xml" href="http://www.example.com/tv_shows.atom"/>
+  <title>TV Shows</title>
+  <updated>2011-07-08T13:47:01Z</updated>
+  <entry>
+    <id>tag:www.example.com,2005:TvShow/17</id>
+    <published>2011-07-08T13:47:01Z</published>
+    <updated>2011-07-08T13:47:01Z</updated>
+    <link rel="alternate" type="text/html" href="http://www.example.com/sources/channel-twenty-seven/tv_shows/name-goes-here.atom"/>
+    <title>Name goes here</title>
+    <content type="html">Name goes here (0 episodes)</content>
+    <author>
+      <name>Source URL goes here</name>
+    </author>
+  </entry>
+</feed>

data/spec/fixtures/inagy.xml

@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<CatalogTree code="NLD" xmlns="urn:eventis:prodis:onlineapi:1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+    <Node vodBackOfficeId="69fcb5eb-1020-4053-8fce-6bce030cac5b">
+        <Name>Parent 1</Name>
+        <Description>
+            111#111#120#NPO-BrowseMode.jpg#NPO-ExtendedMode.jpg
+        </Description>
+        <Translations>
+            <Translation Language="en-GB">
+                <Name>Parent 1 en</Name>
+            </Translation>
+            <Translation Language="de-DE">
+                <Name>Parent 1 de</Name>
+            </Translation>
+        </Translations>
+        <Rating>0</Rating>
+        <Adult>false</Adult>
+        <CatalogCode>NLD</CatalogCode>
+        <Position>1</Position>
+        <SubNodes>
+            <Node vodBackOfficeId="27feedad-dead-4721-ba61-c3f9f17d0956">
+                <Name>First</Name>
+                <Translations>
+                    <Translation Language="en-GB">
+                        <Name>First en</Name>
+                    </Translation>
+                </Translations>
+                <Rating>0</Rating>
+                <Adult>false</Adult>
+                <CatalogCode>NLD</CatalogCode>
+                <ParentId>69fcb5eb-1020-4053-8fce-6bce030cac5b</ParentId>
+                <Position>0</Position>
+                <SubNodes>
+                    <Node vodBackOfficeId="7edbcc13-2d03-4254-aaf6-307ba553d4fd">
+                        <Name>Second</Name>
+                        <Translations>
+                            <Translation Language="en-GB">
+                                <Name>Second en</Name>
+                            </Translation>
+                        </Translations>
+                        <Rating>0</Rating>
+                        <Adult>false</Adult>
+                        <CatalogCode>NLD</CatalogCode>
+                        <ParentId>b17dd22b-c028-44ad-8e75-e676e2619ceb</ParentId>
+                        <Position>0</Position>
+                        <SubNodes>
+                            <Node vodBackOfficeId="27feedad-dead-4721-ba61-c3f9f17d1111">
+                                <Name>Third</Name>
+                                <Translations>
+                                    <Translation Language="en-GB">
+                                        <Name>Third en</Name>
+                                    </Translation>
+                                </Translations>
+                                <Rating>0</Rating>
+                                <Adult>false</Adult>
+                                <CatalogCode>NLD</CatalogCode>
+                                <ParentId>69fcb5eb-1020-4053-8fce-6bce030cac5b</ParentId>
+                                <Position>0</Position>
+                            </Node>
+                        </SubNodes>
+                    </Node>
+                </SubNodes>
+            </Node>
+        </SubNodes>
+    </Node>
+    <Node vodBackOfficeId="69fcb5eb-1020-4053-8fce-12312312312">
+        <Name>Parent 2</Name>
+        <Description>
+            111#111#120#NPO-BrowseMode.jpg#NPO-ExtendedMode.jpg
+        </Description>
+        <Translations>
+            <Translation Language="en-GB">
+                <Name>Parent 2 en</Name>
+            </Translation>
+            <Translation Language="de-DE">
+                <Name>Parent 2 de</Name>
+            </Translation>
+        </Translations>
+        <Rating>0</Rating>
+        <Adult>false</Adult>
+        <CatalogCode>NLD</CatalogCode>
+        <Position>1</Position>
+        <SubNodes/>
+    </Node>
+</CatalogTree>

data/spec/fixtures/optional_attributes.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<addresses>
+  <address street=""/>
+  <address street="Milchstrasse"/>
+  <address />
+</addresses>

data/spec/fixtures/subclass_namespace.xml

@@ -0,0 +1,50 @@
+<article:Article xmlns:article="http://www.wetpaint.com/alfresco/article"
+  xmlns:photo="http://www.wetpaint.com/alfresco/photo"
+  xmlns:gallery="http://www.wetpaint.com/alfresco/gallery"
+  xmlns:alf="http://www.alfresco.org" 
+  alf:name="title">
+  <article:title>article title</article:title>
+  <article:text>article text</article:text>
+  <article:publishOptions>
+    <article:author>Nathan</article:author>
+    <article:draft>false</article:draft>
+    <article:scheduledDay>2011-01-14</article:scheduledDay>
+    <article:scheduledTime>11:31:45.0</article:scheduledTime>
+    <article:publishDisplayDay>2011-01-14</article:publishDisplayDay>
+    <article:publishDisplayTime>11:31:45.0</article:publishDisplayTime>
+    <article:createdDay>2011-01-14</article:createdDay>
+    <article:createdTime>11:52:24.0</article:createdTime>
+  </article:publishOptions>
+  
+  <photo:Photo>
+    <photo:title>photo title</photo:title>
+    <photo:publishOptions>
+      <photo:author>Stephanie</photo:author>
+      <photo:draft>false</photo:draft>
+      <photo:scheduledDay>2011-01-13</photo:scheduledDay>
+      <photo:scheduledTime>15:47:30.0</photo:scheduledTime>
+      <photo:publishDisplayDay>2011-01-13</photo:publishDisplayDay>
+      <photo:publishDisplayTime>15:47:30.0</photo:publishDisplayTime>
+      <photo:createdDay>2011-01-13</photo:createdDay>
+      <photo:createdTime>15:51:47.0</photo:createdTime>
+    </photo:publishOptions>
+  </photo:Photo>
+  
+  <gallery:Gallery>
+    <gallery:title>gallery title</gallery:title>
+    <photo:Photo>
+      <photo:title>photo title</photo:title>
+      <photo:publishOptions>
+        <photo:author>Stephanie</photo:author>
+        <photo:draft>false</photo:draft>
+        <photo:scheduledDay>2011-01-13</photo:scheduledDay>
+        <photo:scheduledTime>15:47:30.0</photo:scheduledTime>
+        <photo:publishDisplayDay>2011-01-13</photo:publishDisplayDay>
+        <photo:publishDisplayTime>15:47:30.0</photo:publishDisplayTime>
+        <photo:createdDay>2011-01-13</photo:createdDay>
+        <photo:createdTime>15:51:47.0</photo:createdTime>
+      </photo:publishOptions>
+    </photo:Photo>
+  </gallery:Gallery>
+  
+</article:Article>

data/spec/happymapper_spec.rb

@@ -69,6 +69,24 @@ module Analytics
   end
 end
 
+module Atom
+  class Feed
+    include HappyMapper
+    tag 'feed'
+
+    attribute :xmlns, String, :single => true
+    element :id, String, :single => true
+    element :title, String, :single => true
+    element :updated, DateTime, :single => true
+    element :link, String, :single => false, :attributes => {
+        :rel => String,
+        :type => String,
+        :href => String
+      }
+    # has_many :entries, Entry # nothing interesting in the entries
+  end
+end
+
 class Address
   include HappyMapper
 
@@ -82,7 +100,7 @@ end
 
 class Feature
   include HappyMapper
-  element :name, String, :tag => '.|.//text()'
+  element :name, String, :xpath => './/text()'
 end
 
 class FeatureBullet
@@ -286,7 +304,7 @@ class Country
   include HappyMapper
 
   attribute :code, String
-  text_node :name, String
+  content :name, String
 end
 
 class Address
@@ -423,6 +441,103 @@ module AmbigousItems
   end
 end
 
+class PublishOptions
+  include HappyMapper
+  
+  tag 'publishOptions'
+  
+  element :author, String, :tag => 'author'
+
+  element :draft, Boolean, :tag => 'draft'
+  element :scheduled_day, String, :tag => 'scheduledDay'
+  element :scheduled_time, String, :tag => 'scheduledTime'
+  element :published_day, String, :tag => 'publishDisplayDay'
+  element :published_time, String, :tag => 'publishDisplayTime'
+  element :created_day, String, :tag => 'publishDisplayDay'
+  element :created_time, String, :tag => 'publishDisplayTime'
+  
+end
+
+class Article
+  include HappyMapper
+  
+  tag 'Article'
+  namespace 'article'
+  
+  attr_writer :xml_value
+  
+  element :title, String
+  element :text, String
+  has_many :photos, 'Photo', :tag => 'Photo', :namespace => 'photo', :xpath => '/article:Article'
+  has_many :galleries, 'Gallery', :tag => 'Gallery', :namespace => 'gallery'
+  
+  element :publish_options, PublishOptions, :tag => 'publishOptions', :namespace => 'article'
+  
+end
+
+class PartiallyBadArticle
+  include HappyMapper
+  
+  attr_writer :xml_value
+  
+  tag 'Article'
+  namespace 'article'
+  
+  element :title, String
+  element :text, String
+  has_many :photos, 'Photo', :tag => 'Photo', :namespace => 'photo', :xpath => '/article:Article'
+  has_many :videos, 'Video', :tag => 'Video', :namespace => 'video'
+    
+  element :publish_options, PublishOptions, :tag => 'publishOptions', :namespace => 'article'
+  
+end
+
+class Photo
+  include HappyMapper
+
+  tag 'Photo'
+  namespace 'photo'
+  
+  attr_writer :xml_value
+  
+  element :title, String
+  element :publish_options, PublishOptions, :tag => 'publishOptions', :namespace => 'photo'
+  
+end
+
+class Gallery
+  include HappyMapper
+  
+  tag 'Gallery'
+  namespace 'gallery'
+
+  attr_writer :xml_value
+
+  element :title, String
+  
+end
+
+class Video
+  include HappyMapper
+  
+  tag 'Video'
+  namespace 'video'
+
+  attr_writer :xml_value
+  
+  element :title, String
+  element :publish_options, PublishOptions, :tag => 'publishOptions', :namespace => 'video'
+  
+end
+
+class OptionalAttribute
+  include HappyMapper
+  tag 'address'
+  
+  attribute :street, String
+end
+
+
 describe HappyMapper do
 
   describe "being included into another class" do
@@ -486,7 +601,7 @@ describe HappyMapper do
       element = @klass.elements.first
       element.name.should == 'user'
       element.type.should == User
-      element.options[:single] = true
+      element.options[:single].should == true
     end
 
     it "should allow has many association" do
@@ -494,7 +609,7 @@ describe HappyMapper do
       element = @klass.elements.first
       element.name.should == 'users'
       element.type.should == User
-      element.options[:single] = false
+      element.options[:single].should == false
     end
 
     it "should default tag name to lowercase class" do
@@ -585,6 +700,12 @@ describe HappyMapper do
     address.country.code.should == 'de'
   end
 
+  it "should treat Nokogiri::XML::Document as root" do
+    doc = Nokogiri::XML(fixture_file('address.xml'))
+    address = Address.parse(doc)
+    address.class.should == Address
+  end
+
   it "should parse xml with default namespace (amazon)" do
     file_contents = fixture_file('pita.xml')
     items = PITA::Items.parse(file_contents, :single => true)
@@ -611,6 +732,23 @@ describe HappyMapper do
     first.current_condition.icon.should == 'http://deskwx.weatherbug.com/images/Forecast/icons/cond007.gif'
   end
 
+  it "parses xml with attributes of elements that aren't :single => true" do
+    feed = Atom::Feed.parse(fixture_file('atom.xml'))
+    feed.link.first.href.should == 'http://www.example.com'
+    feed.link.last.href.should == 'http://www.example.com/tv_shows.atom'
+  end
+
+  it "returns nil rather than empty array for absent values when :single => true" do
+    address = Address.parse('<?xml version="1.0" encoding="UTF-8"?><foo/>', :single => true)
+    address.should be_nil
+  end
+
+  it "should return same result for absent values when :single => true, regardless of :in_groups_of" do
+    addr1 = Address.parse('<?xml version="1.0" encoding="UTF-8"?><foo/>', :single => true)
+    addr2 = Address.parse('<?xml version="1.0" encoding="UTF-8"?><foo/>', :single => true, :in_groups_of => 10)
+    addr1.should == addr2
+  end
+
   it "should parse xml with nested elements" do
     radars = Radar.parse(fixture_file('radar.xml'))
     first = radars[0]
@@ -768,6 +906,25 @@ describe HappyMapper do
     l = Location.parse(fixture_file('lastfm.xml'))
     l.first.latitude.should == "51.53469"
   end
+  
+  describe "Parse optional attributes" do
+    
+    it "should parse an empty String as empty" do
+      a = OptionalAttribute.parse(fixture_file('optional_attributes.xml'))
+      a[0].street.should == ""
+    end
+    
+    it "should parse a String with value" do
+      a = OptionalAttribute.parse(fixture_file('optional_attributes.xml'))
+      a[1].street.should == "Milchstrasse"
+    end
+    
+    it "should parse a String with value" do
+      a = OptionalAttribute.parse(fixture_file('optional_attributes.xml'))
+      a[2].street.should be_nil
+    end
+    
+  end
 
   describe 'Xml Content' do
     before(:each) do
@@ -789,8 +946,65 @@ describe HappyMapper do
   end
 
   it "should parse ambigous items" do
-    items = AmbigousItems::Item.parse(fixture_file('ambigous_items.xml'),
-                                       :xpath => '/ambigous/my-items')
+    items = AmbigousItems::Item.parse(fixture_file('ambigous_items.xml'), :xpath => '/ambigous/my-items')
     items.map(&:name).should == %w(first second third).map{|s| "My #{s} item" }
   end
+  
+    
+  context Article do
+    it "should parse the publish options for Article and Photo" do
+      @article.title.should_not be_nil
+      @article.text.should_not be_nil
+      @article.photos.should_not be_nil
+      @article.photos.first.title.should_not be_nil
+    end
+    
+    it "should parse the publish options for Article" do
+      @article.publish_options.should_not be_nil
+    end
+
+    it "should parse the publish options for Photo" do
+      @article.photos.first.publish_options.should_not be_nil
+    end
+
+    it "should only find only items at the parent level" do
+      @article.photos.length.should == 1
+    end
+    
+    before(:all) do
+      @article = Article.parse(fixture_file('subclass_namespace.xml'))
+    end
+  
+  end
+  
+  context "Namespace is missing because an optional element that uses it is not present" do
+     it "should parse successfully" do
+       @article = PartiallyBadArticle.parse(fixture_file('subclass_namespace.xml'))
+       @article.should_not be_nil
+       @article.title.should_not be_nil
+       @article.text.should_not be_nil
+       @article.photos.should_not be_nil
+       @article.photos.first.title.should_not be_nil
+     end
+   end
+   
+   
+   describe "with limit option" do
+     it "should return results with limited size: 6" do
+       sizes = []
+       posts = Post.parse(fixture_file('posts.xml'), :in_groups_of => 6) do |a|
+         sizes << a.size
+       end
+       sizes.should == [6, 6, 6, 2]
+     end
+
+     it "should return results with limited size: 10" do
+       sizes = []
+       posts = Post.parse(fixture_file('posts.xml'), :in_groups_of => 10) do |a|
+         sizes << a.size
+       end
+       sizes.should == [10, 10]
+     end
+   end
+  
 end