unhappymapper 0.4.0

data/spec/happymapper_text_node_spec.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe HappyMapper::Attribute do
+  describe "initialization" do
+    before do
+      @attr = HappyMapper::TextNode.new(:foo, String)
+    end
+    
+    it 'should know that it is a text node' do
+      @attr.text_node?.should be_true
+    end
+    
+    it 'should know that it is NOT an element' do
+      @attr.element?.should be_false
+    end
+
+    it 'should know that it is NOT an attribute' do
+      @attr.attribute?.should be_false
+    end
+  end
+end

data/spec/happymapper_to_xml_namespaces_spec.rb

@@ -0,0 +1,196 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+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, :on_save => :when_saving_location
+
+    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
+
+    def when_saving_location(loc)
+      loc + '-live'
+    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
+
+
+  #
+  # This class is an example of a class that has a default namespace
+  #xmlns="urn:eventis:prodis:onlineapi:1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
+  # 
+  class Recipe
+    include HappyMapper
+    
+    # this is the default namespace of the document
+    register_namespace 'xmlns', 'urn:eventis:prodis:onlineapi:1.0'
+    register_namespace 'xsi', "http://www.w3.org/2001/XMLSchema-instance"
+    register_namespace 'xsd', "http://www.w3.org/2001/XMLSchema"
+    
+    has_many :ingredients, String
+    
+    def initialize(parameters)
+      parameters.each_pair {|property,value| send("#{property}=",value) if respond_to?("#{property}=") }
+    end
+  end
+  
+  describe HappyMapper do
+
+    context "#to_xml", "with namespaces" 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 = Nokogiri::XML(address.to_xml).root
+      end
+
+      it "should save elements" do
+        
+        { 'street' => 'Mockingbird Lane',
+          'postcode' => '98103',
+          'city' => 'Seattle' }.each_pair do |property,value|
+          
+          @address_xml.xpath("address:#{property}").text.should == value
+          
+        end
+        
+      end
+
+      it "should save the element with the result of a function call and not the value of the instance variable" do
+        @address_xml.xpath("address:housenumber").text.should == "[1313]"
+      end
+
+      it "should save attributes" do
+        @address_xml.xpath('@location').text.should == "Home-live"
+      end
+      
+      context "state_when_nil options" do
+      
+        it "should save an empty element" do
+          @address_xml.xpath('address:description').text.should == ""
+        end
+        
+      end
+
+      context "on_save option" do
+      
+        it "should save the result of the lambda" do
+          @address_xml.xpath('address:date_created').text.should == "15:00:00 01/01/11"
+        end
+        
+        it "should save the result of a method" do
+          @address_xml.xpath('@location').text.should == "Home-live"
+        end
+        
+      end
+
+      it "should save elements defined with the 'has_many' relationship" do
+        dates_updated = @address_xml.xpath('address:dates_updated')
+        dates_updated.length.should == 2
+        dates_updated.first.text.should == "16:01:00 01/01/11"
+        dates_updated.last.text.should == "11:30:01 01/02/11"
+      end
+
+      context "class types that also include HappyMapper mappings" do
+
+        it "should save attributes" do
+          @address_xml.xpath('country:country/@country:countryCode').text.should == "us"
+        end
+
+        it "should save elements" do
+          @address_xml.xpath('country:country/countryName:countryName').text.should == "USA"
+        end
+        
+      end
+
+    end
+
+    context "#to_xml", "with a default namespace" do
+      it "should write the default namespace to xml without repeating xmlns" do
+        recipe = Recipe.new(:ingredients => ['One Cup Flour', 'Two Scoops of Lovin'])
+        recipe.to_xml.should =~ /xmlns=\"urn:eventis:prodis:onlineapi:1\.0\"/
+      end
+    end
+  end
+
+end

data/spec/happymapper_to_xml_spec.rb

@@ -0,0 +1,196 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+module ToXML
+
+  class Address
+    include HappyMapper
+
+    tag 'address'
+    
+    attribute :location, String, :on_save => :when_saving_location
+    
+    element :street, String
+    element :postcode, String
+    element :city, String
+
+    element :housenumber, String
+
+    attribute :modified, Boolean, :read_only => true
+    element :temporary, Boolean, :read_only => true
+    #
+    # to_xml will default to the attr_accessor method and not the attribute,
+    # allowing for that to be overwritten
+    #    
+    def housenumber
+      "[#{@housenumber}]" 
+    end
+    
+    def when_saving_location(loc)
+      loc + "-live"
+    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 }
+    
+    
+    #
+    # Execute the method with the same name 
+    
+    #
+    # 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
+      @modified = @temporary = true
+    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'
+    has_one :description, 'Description', :tag => 'description'
+    
+    #
+    # This inner-class here is to demonstrate saving a text node
+    # and optional attributes
+    #
+    class Description
+      include HappyMapper
+      text_node :description, String
+      attribute :category, String, :tag => 'category'
+      attribute :rating, String, :tag => 'rating', :state_when_nil => true
+      
+      def initialize(desc)
+        @description = desc
+      end
+    end
+    
+    def initialize(parameters)
+      parameters.each_pair do |property,value|
+        send("#{property}=",value) if respond_to?("#{property}=")
+      end
+    end
+    
+  end
+
+  describe HappyMapper do
+
+    context "#to_xml" 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', :empty_code => nil, 
+          :description => Country::Description.new("A lovely country") ),
+        '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 = Nokogiri::XML(address.to_xml).root
+      end
+      
+      it "should save elements" do
+        { 'street' => 'Mockingbird Lane',
+          'postcode' => '98103',
+          'city' => 'Seattle' }.each_pair do |property,value|
+        
+          @address_xml.xpath("#{property}").text.should == value
+          
+        end
+      end
+      
+      it "should save the element with the result of a function call and not the value of the instance variable" do
+        @address_xml.xpath("housenumber").text.should == "[1313]"
+      end
+      
+      it "should not save elements marked as read_only" do
+        @address_xml.xpath('temporary').should be_empty
+      end
+      
+      it "should save attribues" do
+        @address_xml.xpath('@location').text.should == "Home-live"
+      end
+      
+      it "should not save attributes marked as read_only" do
+        @address_xml.xpath("@modified").should be_empty
+      end
+      
+      context "state_when_nil option" do
+      
+        it "should save an empty element" do
+          @address_xml.xpath('description').text.should == ""
+        end
+        
+      end
+
+      context "on_save option" do
+        
+        it "should save the result of the lambda" do
+          @address_xml.xpath('date_created').text.should == "15:00:00 01/01/11"
+        end
+        
+        it "should save the result of a method" do
+          @address_xml.xpath('@location').text.should == "Home-live"
+        end
+        
+      end
+
+      
+      it "should save elements defined with the 'has_many' relationship" do
+        dates_updated = @address_xml.xpath('dates_updated')
+        dates_updated.length.should == 2
+        dates_updated.first.text.should == "16:01:00 01/01/11"
+        dates_updated.last.text.should == "11:30:01 01/02/11"
+      end
+
+      context "class types that also contain HappyMapper mappings" do
+
+        it "should save attributes" do
+          @address_xml.xpath('country/@countryCode').text.should == "us"
+        end
+
+        it "should save elements" do
+          @address_xml.xpath('country/countryName').text.should == "USA"
+        end
+
+        it "should save elements" do
+          @address_xml.xpath('country/description').text.should == "A lovely country"
+        end
+        
+      end
+
+    end
+
+
+  end
+
+end

data/spec/ignay_spec.rb

@@ -0,0 +1,95 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+class CatalogTree
+  include HappyMapper
+  
+  tag 'CatalogTree'
+  register_namespace 'xmlns', 'urn:eventis:prodis:onlineapi:1.0'
+  register_namespace 'xsi', 'http://www.w3.org/2001/XMLSchema-instance'
+  register_namespace 'xsd', 'http://www.w3.org/2001/XMLSchema'
+
+  attribute :code, String
+  
+  has_many :nodes, 'CatalogNode', :tag => 'Node', :xpath => '.'
+  
+end
+
+
+class CatalogNode
+  include HappyMapper
+  
+  tag 'Node'
+  
+  attribute :back_office_id, String, :tag => 'vodBackOfficeId'
+  
+  has_one :name, String, :tag => 'Name'
+  # other important fields
+  
+  has_many :translations, 'CatalogNode::Translations', :tag => 'Translation', :xpath => 'child::*'
+  
+  class Translations
+    include HappyMapper
+    tag 'Translation'
+    
+    attribute :language, String, :tag => 'Language'
+    has_one :name, String, :tag => 'Name'
+    
+  end
+  
+  has_many :nodes, CatalogNode, :tag => 'Node', :xpath => 'child::*'
+  
+end
+
+describe HappyMapper do
+
+  it "should not be nil" do
+    catalog_tree.should_not be_nil
+  end
+  
+  it "should have the attribute code" do
+    catalog_tree.code.should == "NLD"
+  end
+  
+  it "should have many nodes" do
+    catalog_tree.nodes.should_not be_empty
+    catalog_tree.nodes.length.should == 2
+  end
+  
+  context "first node" do
+    
+    it "should have a name" do
+      first_node.name.should == "Parent 1"
+    end
+    
+    it "should have translations" do
+      first_node.translations.length.should == 2
+      
+      first_node.translations.first.language.should == "en-GB"
+      
+      first_node.translations.last.name.should == "Parent 1 de"
+    end
+    
+    it "should have subnodes" do
+      first_node.nodes.should be_kind_of(Enumerable)
+      first_node.nodes.should_not be_empty
+      first_node.nodes.length.should == 1
+    end
+
+    it "first node - first node name" do
+      first_node.nodes.first.name.should == "First"
+    end
+
+    def first_node
+      @first_node = catalog_tree.nodes.first
+    end
+    
+  end
+
+
+  def catalog_tree ; @catalog_tree ; end
+
+  before(:all) do
+    xml_reference = "#{File.dirname(__FILE__)}/fixtures/inagy.xml"
+    @catalog_tree = CatalogTree.parse(File.read(xml_reference), :single => true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'happymapper')
+
+def fixture_file(filename)
+  File.read(File.dirname(__FILE__) + "/fixtures/#{filename}")
+end

data/spec/xpath_spec.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+test_xml = %{
+  <rss>
+    <amazing:item xmlns:amazing="http://www.amazing.com/amazing" xmlns:different="http://www.different.com/different">
+      <amazing:title>Test XML</amazing:/title>
+      <different:link href="different_link" />
+      <amazing:link href="link_to_resources" />
+      <amazing:subitem>
+        <amazing:detail>I want to parse this</amazing:detail>
+        <amazing:more first="this one">more 1</amazing:more>
+        <amazing:more alternative="another one">more 2</amazing:more>
+      </amazing:subitem>
+      <amazing:baby>
+        <amazing:name>Jumbo</amazing:name>
+      </amazing:baby>
+    </amazing:item>
+  </rss>
+}
+
+class Item
+  include HappyMapper
+
+  tag 'item'
+  namespace 'amazing'
+
+  element :title, String
+  attribute :link, String, :xpath => 'amazing:link/@href'
+  has_one :different_link, String, :xpath => 'different:link/@href'
+  element :detail, String, :xpath => 'amazing:subitem/amazing:detail'
+  has_many :more_details_text, String, :xpath => 'amazing:subitem/amazing:more'
+  has_many :more_details, String, :xpath => 'amazing:subitem/amazing:more/@first|amazing:subitem/amazing:more/@alternative'
+  has_many :more_details_alternative, String, :xpath => 'amazing:subitem/amazing:more/@*'
+
+  has_one :baby, 'Baby', :name => 'baby', :namespace => 'amazing'
+
+end
+
+class Baby
+  include HappyMapper
+
+  has_one :name, String
+end
+
+describe HappyMapper do
+
+  it "should have a title" do
+    @item.title.should == "Test XML"
+  end
+
+  it "should find the link href value" do
+    @item.link.should == 'link_to_resources'
+  end
+
+  it "should find the link href value" do
+    @item.different_link.should == 'different_link'
+  end
+
+  it "should find this subitem based on the xpath" do
+    @item.detail.should == 'I want to parse this'
+  end
+
+  it "should find the subitems based on the xpath" do
+    @item.more_details_text.length.should == 2
+    @item.more_details_text.first.should == "more 1"
+    @item.more_details_text.last.should == "more 2"
+  end
+
+  it "should find the subitems based on the xpath" do
+    @item.more_details.length.should == 2
+    @item.more_details.first.should == "this one"
+    @item.more_details.last.should == "another one"
+  end
+
+  it "should find the subitems based on the xpath" do
+    @item.more_details.length.should == 2
+    @item.more_details_alternative.first.should == "this one"
+    @item.more_details_alternative.last.should == "another one"
+  end
+  it "should have a baby name" do
+    @item.baby.name.should == "Jumbo"
+  end
+
+  before(:all) do
+    @item = Item.parse(test_xml,:single => true)
+  end
+
+end