happymapper-swanandp 0.4.0

data/spec/happymapper_to_xml_namespaces_spec.rb

@@ -0,0 +1,149 @@
+require 'spec_helper'
+
+module ToXMLWithNamespaces
+
+  #
+  # Similar example as the to_xml but this time with namespacing
+  #
+  class Address
+    include HappyMapper
+
+    register_namespace 'address', 'http://www.company.com/address'
+    register_namespace 'country', 'http://www.company.com/country'
+
+    tag 'Address'
+    namespace 'address'
+
+    element :country, 'Country', :tag => 'country', :namespace => 'country'
+
+
+    attribute :location, String
+
+    element :street, String
+    element :postcode, String
+    element :city, String
+
+    element :housenumber, String
+
+    #
+    # to_xml will default to the attr_accessor method and not the attribute,
+    # allowing for that to be overwritten
+    #
+    def housenumber
+      "[#{@housenumber}]"
+    end
+
+    #
+    # Write a empty element even if this is not specified
+    #
+    element :description, String, :state_when_nil => true
+
+    #
+    # Perform the on_save operation when saving
+    #
+    has_one :date_created, Time, :on_save => lambda {|time| DateTime.parse(time).strftime("%T %D") if time }
+
+    #
+    # Write multiple elements and call on_save when saving
+    #
+    has_many :dates_updated, Time, :on_save => lambda {|times|
+      times.compact.map {|time| DateTime.parse(time).strftime("%T %D") } if times }
+
+    #
+    # Class composition
+    #
+
+    def initialize(parameters)
+      parameters.each_pair do |property,value|
+        send("#{property}=",value) if respond_to?("#{property}=")
+      end
+    end
+
+  end
+
+  #
+  # Country is composed above the in Address class. Here is a demonstration
+  # of how to_xml will handle class composition as well as utilizing the tag
+  # value.
+  #
+  class Country
+    include HappyMapper
+
+    register_namespace 'countryName', 'http://www.company.com/countryName'
+
+    attribute :code, String, :tag => 'countryCode'
+    has_one :name, String, :tag => 'countryName', :namespace => 'countryName'
+
+    def initialize(parameters)
+      parameters.each_pair do |property,value|
+        send("#{property}=",value) if respond_to?("#{property}=")
+      end
+    end
+
+  end
+
+  describe "#to_xml" do
+
+    context "Address" do
+
+      before(:all) do
+        address = Address.new('street' => 'Mockingbird Lane',
+        'location' => 'Home',
+        'housenumber' => '1313',
+        'postcode' => '98103',
+        'city' => 'Seattle',
+        'country' => Country.new(:name => 'USA', :code => 'us'),
+        'date_created' => '2011-01-01 15:00:00')
+
+        address.dates_updated = ["2011-01-01 16:01:00","2011-01-02 11:30:01"]
+
+        @address_xml = XML::Parser.string(address.to_xml).parse.root
+      end
+
+      { 'street' => 'Mockingbird Lane',
+        'postcode' => '98103',
+        'city' => 'Seattle' }.each_pair do |property,value|
+
+        it "should have the element '#{property}' with the value '#{value}'" do
+          @address_xml.find("address:#{property}").first.child.to_s.should == value
+        end
+
+      end
+
+      it "should use the result of #housenumber method (not the @housenumber)" do
+        @address_xml.find("address:housenumber").first.child.to_s.should == "[1313]"
+      end
+
+      it "should have the attribute 'location' with the value 'Home'" do
+        @address_xml.find('@location').first.child.to_s.should == "Home"
+      end
+
+      it "should add an empty description element" do
+        @address_xml.find('address:description').first.child.to_s.should == ""
+      end
+
+      it "should call #on_save when saving the time to convert the time" do
+        @address_xml.find('address:date_created').first.child.to_s.should == "15:00:00 01/01/11"
+      end
+
+      it "should handle multiple elements for 'has_many'" do
+        dates_updated = @address_xml.find('address:dates_updated')
+        dates_updated.length.should == 2
+        dates_updated.first.child.to_s.should == "16:01:00 01/01/11"
+        dates_updated.last.child.to_s.should == "11:30:01 01/02/11"
+      end
+
+      it "should write the country code" do
+        @address_xml.find('country:country/@country:countryCode').first.child.to_s.should == "us"
+      end
+
+      it "should write the country name" do
+        @address_xml.find('country:country/countryName:countryName').first.child.to_s.should == "USA"
+      end
+
+    end
+
+
+  end
+
+end

data/spec/happymapper_to_xml_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+module ToXML
+
+  class Address
+    include HappyMapper
+
+    tag 'address'
+
+    attribute :location, String
+
+    element :street, String
+    element :postcode, String
+    element :city, String
+
+    element :housenumber, String
+
+    #
+    # to_xml will default to the attr_accessor method and not the attribute,
+    # allowing for that to be overwritten
+    #
+    def housenumber
+      "[#{@housenumber}]"
+    end
+
+    #
+    # Write a empty element even if this is not specified
+    #
+    element :description, String, :state_when_nil => true
+
+    #
+    # Perform the on_save operation when saving
+    #
+    has_one :date_created, Time, :on_save => lambda {|time| DateTime.parse(time).strftime("%T %D") if time }
+
+    #
+    # Write multiple elements and call on_save when saving
+    #
+    has_many :dates_updated, Time, :on_save => lambda {|times|
+      times.compact.map {|time| DateTime.parse(time).strftime("%T %D") } if times }
+
+    #
+    # Class composition
+    #
+    element :country, 'Country', :tag => 'country'
+
+    def initialize(parameters)
+      parameters.each_pair do |property,value|
+        send("#{property}=",value) if respond_to?("#{property}=")
+      end
+    end
+
+  end
+
+  #
+  # Country is composed above the in Address class. Here is a demonstration
+  # of how to_xml will handle class composition as well as utilizing the tag
+  # value.
+  #
+  class Country
+    include HappyMapper
+
+    attribute :code, String, :tag => 'countryCode'
+    has_one :name, String, :tag => 'countryName'
+
+    def initialize(parameters)
+      parameters.each_pair do |property,value|
+        send("#{property}=",value) if respond_to?("#{property}=")
+      end
+    end
+
+  end
+
+  describe "#to_xml" do
+
+    context "Address" do
+
+      before(:all) do
+        address = Address.new('street' => 'Mockingbird Lane',
+        'location' => 'Home',
+        'housenumber' => '1313',
+        'postcode' => '98103',
+        'city' => 'Seattle',
+        'country' => Country.new(:name => 'USA', :code => 'us'),
+        'date_created' => '2011-01-01 15:00:00')
+
+        address.dates_updated = ["2011-01-01 16:01:00","2011-01-02 11:30:01"]
+
+        @address_xml = XML::Parser.string(address.to_xml).parse.root
+      end
+
+      { 'street' => 'Mockingbird Lane',
+        'postcode' => '98103',
+        'city' => 'Seattle' }.each_pair do |property,value|
+
+        it "should have the element '#{property}' with the value '#{value}'" do
+          @address_xml.find("#{property}").first.child.to_s.should == value
+        end
+
+      end
+
+      it "should use the result of #housenumber method (not the @housenumber)" do
+        @address_xml.find("housenumber").first.child.to_s.should == "[1313]"
+      end
+
+      it "should have the attribute 'location' with the value 'Home'" do
+        @address_xml.find('@location').first.child.to_s.should == "Home"
+      end
+
+      it "should add an empty description element" do
+        @address_xml.find('description').first.child.to_s.should == ""
+      end
+
+      it "should call #on_save when saving the time to convert the time" do
+        @address_xml.find('date_created').first.child.to_s.should == "15:00:00 01/01/11"
+      end
+
+      it "should handle multiple elements for 'has_many'" do
+        dates_updated = @address_xml.find('dates_updated')
+        dates_updated.length.should == 2
+        dates_updated.first.child.to_s.should == "16:01:00 01/01/11"
+        dates_updated.last.child.to_s.should == "11:30:01 01/02/11"
+      end
+
+      it "should write the country code" do
+        @address_xml.find('country/@countryCode').first.child.to_s.should == "us"
+      end
+
+      it "should write the country name" do
+        @address_xml.find('country/countryName').first.child.to_s.should == "USA"
+      end
+
+    end
+
+
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'spec'
+require File.expand_path('../../lib/happymapper', __FILE__)
+
+def fixture_file(filename)
+  File.read(File.dirname(__FILE__) + "/fixtures/#{filename}")
+end

data/spec/support/models.rb

@@ -0,0 +1,323 @@
+module Analytics
+  class Property
+    include HappyMapper
+
+    tag 'property'
+    namespace 'http://schemas.google.com/analytics/2009'
+    attribute :name, String
+    attribute :value, String
+  end
+
+  class Entry
+    include HappyMapper
+
+    tag 'entry'
+    element :id, String
+    element :updated, DateTime
+    element :title, String
+    element :table_id, String, :namespace => 'http://schemas.google.com/analytics/2009', :tag => 'tableId'
+    has_many :properties, Property
+  end
+
+  class Feed
+    include HappyMapper
+
+    tag 'feed'
+    element :id, String
+    element :updated, DateTime
+    element :title, String
+    has_many :entries, Entry
+  end
+end
+
+class Feature
+  include HappyMapper
+  element :name, String, :tag => '.|.//text()'
+end
+
+class FeatureBullet
+  include HappyMapper
+
+  tag 'features_bullets'
+  has_many :features, Feature
+  element :bug, String
+end
+
+class Product
+  include HappyMapper
+
+  element :title, String
+  has_one :feature_bullets, FeatureBullet
+end
+
+module FamilySearch
+  class Person
+    include HappyMapper
+
+    attribute :version, String
+    attribute :modified, Time
+    attribute :id, String
+  end
+
+  class Persons
+    include HappyMapper
+    has_many :person, Person
+  end
+
+  class FamilyTree
+    include HappyMapper
+
+    tag 'familytree'
+    attribute :version, String
+    attribute :status_message, String, :tag => 'statusMessage'
+    attribute :status_code, String, :tag => 'statusCode'
+    has_one :persons, Persons
+  end
+end
+
+module FedEx
+  class Address
+    include HappyMapper
+
+    tag 'Address'
+    namespace 'http://fedex.com/ws/track/v2'
+    element :city, String, :tag => 'City'
+    element :state, String, :tag => 'StateOrProvinceCode'
+    element :zip, String, :tag => 'PostalCode'
+    element :countrycode, String, :tag => 'CountryCode'
+    element :residential, Boolean, :tag => 'Residential'
+  end
+
+  class Event
+    include HappyMapper
+
+    tag 'Events'
+    namespace 'http://fedex.com/ws/track/v2'
+    element :timestamp, String, :tag => 'Timestamp'
+    element :eventtype, String, :tag => 'EventType'
+    element :eventdescription, String, :tag => 'EventDescription'
+    has_one :address, Address
+  end
+
+  class PackageWeight
+    include HappyMapper
+
+    tag 'PackageWeight'
+    namespace 'http://fedex.com/ws/track/v2'
+    element :units, String, :tag => 'Units'
+    element :value, Integer, :tag => 'Value'
+  end
+
+  class TrackDetails
+    include HappyMapper
+
+    tag 'TrackDetails'
+    namespace 'http://fedex.com/ws/track/v2'
+    element   :tracking_number, String, :tag => 'TrackingNumber'
+    element   :status_code, String, :tag => 'StatusCode'
+    element   :status_desc, String, :tag => 'StatusDescription'
+    element   :carrier_code, String, :tag => 'CarrierCode'
+    element   :service_info, String, :tag => 'ServiceInfo'
+    has_one   :weight, PackageWeight, :tag => 'PackageWeight'
+    element   :est_delivery,  String, :tag => 'EstimatedDeliveryTimestamp'
+    has_many  :events, Event
+  end
+
+  class Notification
+    include HappyMapper
+
+    tag 'Notifications'
+    namespace 'http://fedex.com/ws/track/v2'
+    element :severity, String, :tag => 'Severity'
+    element :source, String, :tag => 'Source'
+    element :code, Integer, :tag => 'Code'
+    element :message, String, :tag => 'Message'
+    element :localized_message, String, :tag => 'LocalizedMessage'
+  end
+
+  class TransactionDetail
+    include HappyMapper
+
+    tag 'TransactionDetail'
+    namespace 'http://fedex.com/ws/track/v2'
+    element :cust_tran_id, String, :tag => 'CustomerTransactionId'
+  end
+
+  class TrackReply
+    include HappyMapper
+
+    tag 'TrackReply'
+    namespace 'http://fedex.com/ws/track/v2'
+    element   :highest_severity, String, :tag => 'HighestSeverity'
+    element   :more_data, Boolean, :tag => 'MoreData'
+    has_many  :notifications, Notification, :tag => 'Notifications'
+    has_many  :trackdetails, TrackDetails, :tag => 'TrackDetails'
+    has_one   :tran_detail, TransactionDetail, :tab => 'TransactionDetail'
+  end
+end
+
+class Place
+  include HappyMapper
+  element :name, String
+end
+
+class Radar
+  include HappyMapper
+  has_many :places, Place
+end
+
+class Post
+  include HappyMapper
+
+  attribute :href, String
+  attribute :hash, String
+  attribute :description, String
+  attribute :tag, String
+  attribute :time, Time
+  attribute :others, Integer
+  attribute :extended, String
+end
+
+class User
+  include HappyMapper
+
+  element :id, Integer
+  element :name, String
+  element :screen_name, String
+  element :location, String
+  element :description, String
+  element :profile_image_url, String
+  element :url, String
+  element :protected, Boolean
+  element :followers_count, Integer
+
+  attr_accessor :after_parse_called
+  attr_accessor :after_parse2_called
+
+  after_parse do |doc|
+    doc.after_parse_called = true
+  end
+
+  after_parse do |doc|
+    doc.after_parse2_called = true
+  end
+end
+
+class Status
+  include HappyMapper
+
+  element :id, Integer
+  element :text, String
+  element :created_at, Time
+  element :source, String
+  element :truncated, Boolean
+  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
+
+class CurrentWeather
+  include HappyMapper
+
+  tag 'ob'
+  namespace 'http://www.aws.com/aws'
+  element :temperature, Integer, :tag => 'temp'
+  element :feels_like, Integer, :tag => 'feels-like'
+  element :current_condition, String, :tag => 'current-condition', :attributes => {:icon => String}
+end
+
+class Address
+  include HappyMapper
+
+  tag 'address'
+  element :street, String
+  element :postcode, String
+  element :housenumber, String
+  element :city, String
+  element :country, String
+end
+
+class MultiStreetAddress
+  include HappyMapper
+  
+  tag 'address'
+  # allow primitive type to be collection
+  has_many :street_address, String, :tag => "streetaddress"
+  element :city, String
+  element :state_or_providence, String, :tag => "stateOfProvidence"
+  element :zip, String
+  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, URI, :tag => 'DetailPageURL', :parser => :parse
+    element :manufacturer, String, :tag => 'Manufacturer', :deep => true
+    element :point, String, :tag => 'point', :namespace => 'http://www.georss.org/georss'
+    element :product_group, ProductGroup, :tag => 'ProductGroup', :deep => true, :parser => :new, :raw => true
+  end
+
+  class Items
+    include HappyMapper
+
+    tag 'Items' # if you put class in module you need tag
+    element :total_results, Integer, :tag => 'TotalResults'
+    element :total_pages, Integer, :tag => 'TotalPages'
+    has_many :items, Item
+  end
+end
+
+module GitHub
+  class Commit
+    include HappyMapper
+
+    tag "commit"
+    element :url, String
+    element :tree, String
+    element :message, String
+    element :id, String
+    element :'committed-date', Date
+  end
+end
+
+module Backpack
+  class Note
+    include HappyMapper
+
+    attribute :id, Integer
+    attribute :title, String
+    attribute :created_at, Date
+
+    content :body
+  end
+end
+
+module RawXml
+  class CustomStuff
+    include HappyMapper
+    raw_content :body
+    tag :custom
+  end
+
+  class Address
+    include HappyMapper
+
+    tag 'address'
+    element :street, String
+    element :postcode, String
+    element :housenumber, String
+    element :city, String
+    element :country, String
+    has_one :custom_stuff, RawXml::CustomStuff
+  end
+  
+end