uva-happymapper 0.4.1

data/lib/happymapper/attribute.rb

@@ -0,0 +1,3 @@
+module HappyMapper
+  class Attribute < Item; end
+end

data/lib/happymapper/element.rb

@@ -0,0 +1,3 @@
+module HappyMapper
+  class Element < Item; end
+end

data/lib/happymapper/item.rb

@@ -0,0 +1,250 @@
+module HappyMapper
+  class Item
+    attr_accessor :name, :type, :tag, :options, :namespace
+
+    Types = [String, Float, Time, Date, DateTime, Integer, Boolean]
+
+    # options:
+    #   :deep   =>  Boolean False to only parse element's children, True to include
+    #               grandchildren and all others down the chain (// in xpath)
+    #   :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.tag = o[:tag] || name.to_s
+      self.options = { :single => true }.merge(o.merge(:name => self.name))
+
+      @xml_type = self.class.to_s.split('::').last.downcase
+    end
+
+    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)
+          end
+        end
+      elsif constant == XmlContent
+        find(node, namespace, xpath_options) do |n|
+          n = n.children if n.respond_to?(:children)
+          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]
+              value = n.content
+            else
+              value = n.to_s
+            end
+
+            begin
+              constant.send(options[:parser].to_sym, value)
+            rescue
+              nil
+            end
+          end
+        else
+          constant.parse(node, options.merge(:namespaces => xpath_options))
+        end
+      end
+    end
+
+    def xpath(namespace = self.namespace)
+      xpath  = ''
+      xpath += './/' if options[:deep]
+      xpath += "#{namespace}:" if namespace
+      xpath += tag
+      #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
+
+    def element?
+      @xml_type == 'element'
+    end
+
+    def attribute?
+      @xml_type == 'attribute'
+    end
+
+    def text_node?
+      @xml_type == 'textnode'
+    end
+
+    def method_name
+      @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        
+        if    constant == String    then value.to_s
+        elsif constant == Float     then value.to_f
+        elsif constant == Time      then Time.parse(value.to_s) rescue Time.at(value.to_i)
+        elsif constant == Date      then Date.parse(value.to_s)
+        elsif constant == DateTime  then DateTime.parse(value.to_s)
+        elsif constant == Boolean   then ['true', 't', '1'].include?(value.to_s.downcase)
+        elsif constant == Integer
+          # ganked from datamapper
+          value_to_i = value.to_i
+          if value_to_i == 0 && value != '0'
+            value_to_s = value.to_s
+            begin
+              Integer(value_to_s =~ /^(\d+)/ ? $1 : value_to_s)
+            rescue ArgumentError
+              nil
+            end
+          else
+            value_to_i
+          end
+        else
+          value
+        end
+      rescue
+        value
+      end
+    end
+
+    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('::')
+          constant = Object
+          names.each do |name|
+            constant =
+              if constant.const_defined?(name)
+                constant.const_get(name)
+              else
+                constant.const_missing(name)
+              end
+          end
+          constant
+        else
+          type
+        end
+      end
+
+
+      def find(node, namespace, xpath_options, &block)
+        if self.namespace && xpath_options["xmlns:#{self.namespace}"]
+          # from the class definition
+          namespace = self.namespace
+        elsif options[:namespace] && xpath_options["xmlns:#{options[:namespace]}"]
+          namespace = options[:namespace]
+        end
+        
+        if element?
+          if options[:single]
+            
+            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 }
+              handle_attributes_option(result, value, xpath_options)
+
+              value
+            end
+          else
+            
+            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
+            end
+            results
+          end
+        elsif attribute?
+          
+          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
+      end
+
+      def handle_attributes_option(result, value, xpath_options)
+        if options[:attributes].is_a?(Hash)
+          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]
+              attribute_value = Attribute.new(xml_attribute.name.to_sym, *attribute_options).from_xml_node(result, namespace, xpath_options)
+
+              result.instance_eval <<-EOV
+                def value.#{xml_attribute.name}
+                  #{attribute_value.inspect}
+                end
+              EOV
+            end # if attributes_options
+          end # attribute_nodes.each
+        end # if options[:attributes]
+      end # def handle...
+
+    # end private methods
+  end
+end

data/lib/happymapper/text_node.rb

@@ -0,0 +1,3 @@
+module HappyMapper
+  class TextNode < Item; end
+end

data/spec/fixtures/address.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<address>
+  <street>Milchstrasse</street>
+  <housenumber>23</housenumber>
+  <postcode>26131</postcode>
+  <city>Oldenburg</city>
+  <country code="de">Germany</country>
+</address>

data/spec/fixtures/ambigous_items.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ambigous>
+  <my-items>
+    <item>
+      <name>My first item</name>
+      <item><name>My first internal item</name></item>
+    </item>
+    <item>
+      <name>My second item</name>
+      <item><name>My second internal item</name></item>
+    </item>
+    <item>
+      <name>My third item</name>
+      <item><name>My third internal item</name></item>
+    </item>
+  </my-items>
+  <others-items>
+    <item>
+      <name>Other item</name>
+    </item>
+  <others-items>
+</ambigous>

data/spec/fixtures/analytics.xml

@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom" 
+      xmlns:openSearch="http://a9.com/-/spec/opensearchrss/1.0/" 
+      xmlns:dxp="http://schemas.google.com/analytics/2009">
+  <id>http://www.google.com/analytics/feeds/accounts/nunemaker@gmail.com</id>
+  <updated>2009-04-22T23:21:23.000-07:00</updated>
+  <title type="text">Profile list for nunemaker@gmail.com</title>
+  <link rel="self" type="application/atom+xml" 
+        href="http://www.google.com/analytics/feeds/accounts/default"/>
+  <author>
+    <name>Google Analytics</name>
+  </author>
+  <generator version="1.0">Google Analytics</generator>
+  <openSearch:totalResults>4</openSearch:totalResults>
+  <openSearch:startIndex>1</openSearch:startIndex>
+  <openSearch:itemsPerPage>4</openSearch:itemsPerPage>
+  <entry>
+    <id>http://www.google.com/analytics/feeds/accounts/ga:47912</id>
+    <updated>2008-11-24T12:11:32.000-08:00</updated>
+    <title type="text">addictedtonew.com</title>
+    <link rel="alternate" type="text/html" href="http://www.google.com/analytics"/>
+    <dxp:tableId>ga:47912</dxp:tableId>
+    <dxp:property name="ga:accountId" value="85301"/>
+    <dxp:property name="ga:accountName" value="addictedtonew.com"/>
+    <dxp:property name="ga:profileId" value="47912"/>
+    <dxp:property name="ga:webPropertyId" value="UA-85301-1"/>
+  </entry>
+  <entry>
+    <id>http://www.google.com/analytics/feeds/accounts/ga:1897579</id>
+    <updated>2008-11-24T12:11:32.000-08:00</updated>
+    <title type="text">railstips.org</title>
+    <link rel="alternate" type="text/html" href="http://www.google.com/analytics"/>
+    <dxp:tableId>ga:1897579</dxp:tableId>
+    <dxp:property name="ga:accountId" value="85301"/>
+    <dxp:property name="ga:accountName" value="addictedtonew.com"/>
+    <dxp:property name="ga:profileId" value="1897579"/>
+    <dxp:property name="ga:webPropertyId" value="UA-85301-7"/>
+  </entry>
+  <entry>
+    <id>http://www.google.com/analytics/feeds/accounts/ga:17132454</id>
+    <updated>2009-04-22T23:21:23.000-07:00</updated>
+    <title type="text">johnnunemaker.com</title>
+    <link rel="alternate" type="text/html" href="http://www.google.com/analytics"/>
+    <dxp:tableId>ga:17132454</dxp:tableId>
+    <dxp:property name="ga:accountId" value="85301"/>
+    <dxp:property name="ga:accountName" value="addictedtonew.com"/>
+    <dxp:property name="ga:profileId" value="17132454"/>
+    <dxp:property name="ga:webPropertyId" value="UA-85301-25"/>
+  </entry>
+  <entry>
+    <id>http://www.google.com/analytics/feeds/accounts/ga:17132478</id>
+    <updated>2009-04-22T23:21:23.000-07:00</updated>
+    <title type="text">harmonyapp.com</title>
+    <link rel="alternate" type="text/html" href="http://www.google.com/analytics"/>
+    <dxp:tableId>ga:17132478</dxp:tableId>
+    <dxp:property name="ga:accountId" value="85301"/>
+    <dxp:property name="ga:accountName" value="addictedtonew.com"/>
+    <dxp:property name="ga:profileId" value="17132478"/>
+    <dxp:property name="ga:webPropertyId" value="UA-85301-26"/>
+  </entry>
+</feed>

data/spec/fixtures/analytics_profile.xml

@@ -0,0 +1,127 @@
+<feed xmlns='http://www.w3.org/2005/Atom' xmlns:dxp='http://schemas.google.com/analytics/2009' xmlns:openSearch='http://a9.com/-/spec/opensearch/1.1/' xmlns:gd='http://schemas.google.com/g/2005' gd:etag='W/&quot;CU4CSXo_cCp7I2A9Wx9RGU0.&quot;' gd:kind='analytics#accounts'>
+       <id>http://www.google.com/analytics/feeds/accounts/someuser@gmail.com</id>
+       <updated>2010-12-20T19:59:28.448-08:00</updated>
+       <title>Profile list for someuser@gmail.com</title>
+       <link rel='self' type='application/atom+xml' href='https://www.google.com/analytics/feeds/accounts/default'/>
+       <author>
+               <name>Google Analytics</name>
+       </author>
+       <generator version='1.0'>Google Analytics</generator>
+       <openSearch:totalResults>9</openSearch:totalResults>
+       <openSearch:startIndex>1</openSearch:startIndex>
+       <openSearch:itemsPerPage>9</openSearch:itemsPerPage>
+       <dxp:segment id='gaid::-1' name='All Visits'>
+               <dxp:definition> </dxp:definition>
+       </dxp:segment>
+       <dxp:segment id='gaid::-2' name='New Visitors'>
+               <dxp:definition>ga:visitorType==New Visitor</dxp:definition>
+       </dxp:segment>
+       <dxp:segment id='gaid::-3' name='Returning Visitors'>
+               <dxp:definition>ga:visitorType==Returning Visitor</dxp:definition>
+       </dxp:segment>
+       <dxp:segment id='gaid::-4' name='Paid Search Traffic'>
+               <dxp:definition>ga:medium==cpa,ga:medium==cpc,ga:medium==cpm,ga:medium==cpp,ga:medium==cpv,ga:medium==ppc</dxp:definition>
+       </dxp:segment>
+       <dxp:segment id='gaid::-5' name='Non-paid Search Traffic'>
+               <dxp:definition>ga:medium==organic</dxp:definition>
+       </dxp:segment>
+       <dxp:segment id='gaid::-6' name='Search Traffic'>
+               <dxp:definition>ga:medium==cpa,ga:medium==cpc,ga:medium==cpm,ga:medium==cpp,ga:medium==cpv,ga:medium==organic,ga:medium==ppc</dxp:definition>
+       </dxp:segment>
+       <dxp:segment id='gaid::-7' name='Direct Traffic'>
+               <dxp:definition>ga:medium==(none)</dxp:definition>
+       </dxp:segment>
+       <dxp:segment id='gaid::-8' name='Referral Traffic'>
+               <dxp:definition>ga:medium==referral</dxp:definition>
+       </dxp:segment>
+       <dxp:segment id='gaid::-9' name='Visits with Conversions'>
+               <dxp:definition>ga:goalCompletionsAll&gt;0</dxp:definition>
+       </dxp:segment>
+       <dxp:segment id='gaid::-10' name='Visits with Transactions'>
+               <dxp:definition>ga:transactions&gt;0</dxp:definition>
+       </dxp:segment>
+       <dxp:segment id='gaid::-11' name='Mobile Traffic'>
+               <dxp:definition>ga:isMobile==Yes</dxp:definition>
+       </dxp:segment>
+       <dxp:segment id='gaid::-12' name='Non-bounce Visits'>
+               <dxp:definition>ga:bounces==0</dxp:definition>
+       </dxp:segment>
+       <entry gd:etag='W/&quot;CkENQXs9fip7I2A9Wx5SE0w.&quot;' gd:kind='analytics#account'>
+               <id>http://www.google.com/analytics/feeds/accounts/ga:123456</id>
+               <updated>2010-08-08T16:38:10.566-07:00</updated>
+               <title>www.homedepot.com</title>
+               <link rel='alternate' type='text/html' href='http://www.google.com/analytics'/>
+               <dxp:property name='ga:accountId' value='254087'/>
+               <dxp:property name='ga:accountName' value='www.homechefdepot.com'/>
+               <dxp:property name='ga:profileId' value='123456'/>
+               <dxp:property name='ga:webPropertyId' value='UA-254087-1'/>
+               <dxp:property name='ga:currency' value='USD'/>
+               <dxp:property name='ga:timezone' value='America/Los_Angeles'/>
+               <dxp:tableId>ga:123456</dxp:tableId>
+       </entry>
+       <entry gd:etag='W/&quot;C0YESXcyfyp7I2A9Wx9SFkU.&quot;' gd:kind='analytics#account'>
+               <id>http://www.google.com/analytics/feeds/accounts/ga:8575980</id>
+               <updated>2010-12-06T16:18:28.997-08:00</updated>
+               <title>www.pda.org</title>
+               <link rel='alternate' type='text/html' href='http://www.google.com/analytics'/>
+               <dxp:property name='ga:accountId' value='4277553'/>
+               <dxp:property name='ga:accountName' value='www.pdma.org'/>
+               <dxp:property name='ga:profileId' value='8575980'/>
+               <dxp:property name='ga:webPropertyId' value='UA-4277553-1'/>
+               <dxp:property name='ga:currency' value='USD'/>
+               <dxp:property name='ga:timezone' value='America/Los_Angeles'/>
+               <dxp:tableId>ga:8575980</dxp:tableId>
+       </entry>
+       <entry gd:etag='W/&quot;CU4CSXo_cCp7I2A9Wx9RGU0.&quot;' gd:kind='analytics#account'>
+               <id>http://www.google.com/analytics/feeds/accounts/ga:25620226</id>
+               <updated>2010-12-20T19:59:28.448-08:00</updated>
+               <title>business.com</title>
+               <link rel='alternate' type='text/html' href='http://www.google.com/analytics'/>
+               <dxp:property name='ga:accountId' value='12312214'/>
+               <dxp:property name='ga:accountName' value='business.com'/>
+               <dxp:property name='ga:profileId' value='25620226'/>
+               <dxp:property name='ga:webPropertyId' value='UA-12312214-1'/>
+               <dxp:property name='ga:currency' value='USD'/>
+               <dxp:property name='ga:timezone' value='America/Los_Angeles'/>
+               <dxp:tableId>ga:25620226</dxp:tableId>
+       </entry>
+       <entry gd:etag='W/&quot;CU4CSX0yfCp7I2A9Wx9RGU0.&quot;' gd:kind='analytics#account'>
+               <id>http://www.google.com/analytics/feeds/accounts/ga:12123131</id>
+               <updated>2010-12-20T19:59:28.394-08:00</updated>
+               <title>blog.com</title>
+               <link rel='alternate' type='text/html' href='http://www.google.com/analytics'/>
+               <dxp:property name='ga:accountId' value='12312214'/>
+               <dxp:property name='ga:accountName' value='business.com'/>
+               <dxp:property name='ga:profileId' value='12123131'/>
+               <dxp:property name='ga:webPropertyId' value='UA-12345678-1'/>
+               <dxp:property name='ga:currency' value='USD'/>
+               <dxp:property name='ga:timezone' value='America/Los_Angeles'/>
+               <dxp:tableId>ga:12123131</dxp:tableId>
+       </entry>
+       <entry gd:etag='W/&quot;DUMNQHk_fSp7I2A9Wx5bEE4.&quot;' gd:kind='analytics#account'>
+               <id>http://www.google.com/analytics/feeds/accounts/ga:37685582</id>
+               <updated>2010-10-25T13:11:31.745-07:00</updated>
+               <title>The Social</title>
+               <link rel='alternate' type='text/html' href='http://www.google.com/analytics'/>
+               <dxp:property name='ga:accountId' value='12312214'/>
+               <dxp:property name='ga:accountName' value='business.com'/>
+               <dxp:property name='ga:profileId' value='37685582'/>
+               <dxp:property name='ga:webPropertyId' value='UA-12312214-1'/>
+               <dxp:property name='ga:currency' value='USD'/>
+               <dxp:property name='ga:timezone' value='America/Los_Angeles'/>
+               <dxp:tableId>ga:37685582</dxp:tableId>
+       </entry>
+       <entry gd:etag='W/&quot;DE8HR3o4eCp7I2A9Wx5UF0w.&quot;' gd:kind='analytics#account'>
+               <id>http://www.google.com/analytics/feeds/accounts/ga:38132423</id>
+               <updated>2010-10-21T20:07:16.430-07:00</updated>
+               <title>Skyline</title>
+               <link rel='alternate' type='text/html' href='http://www.google.com/analytics'/>
+               <dxp:property name='ga:accountId' value='12312214'/>
+               <dxp:property name='ga:accountName' value='business.com'/>
+               <dxp:property name='ga:profileId' value='38132423'/>
+               <dxp:property name='ga:webPropertyId' value='UA-12312214-1'/>
+               <dxp:property name='ga:currency' value='USD'/>
+               <dxp:property name='ga:timezone' value='America/Los_Angeles'/>
+               <dxp:tableId>ga:38132423</dxp:tableId>
+       </entry>
+</feed>