require 'spec_helper'

module ToXMLWithNamespaces

  #
  # Similar example as the to_xml but this time with namespacing
  #
  class Address
    include XmlMapper

    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 XmlMapper

    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 XmlMapper

    # 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
end

describe "Saving #to_xml", "with xml namespaces" do

  context "#to_xml", "with namespaces" do

    let(:subject) do
      address = ToXMLWithNamespaces::Address.new('street' => 'Mockingbird Lane',
      'location' => 'Home',
      'housenumber' => '1313',
      'postcode' => '98103',
      'city' => 'Seattle',
      'country' => ToXMLWithNamespaces::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"]

      Nokogiri::XML(address.to_xml).root
    end

    it "saves elements" do
      elements = { 'street' => 'Mockingbird Lane', 'postcode' => '98103', 'city' => 'Seattle' }

      elements.each_pair do |property,value|
        expect(subject.xpath("address:#{property}").text).to eq value
      end
    end

    it "saves attributes" do
      expect(subject.xpath('@location').text).to eq "Home-live"
    end

    context "when an element has a 'state_when_nil' parameter" do
      let(:element) { subject.xpath('address:description').first }

      it "saves an empty element" do
        expect(element.text).to eq ""
      end

      it "the empty element has the correct namespace prefix from the array of registered namespaces" do
        ns_scopes = element.namespace_scopes
        expect(ns_scopes.select { |ns| ns == element.namespace }.first.prefix).to eq "address"
      end
    end

    context "when an element has a 'on_save' parameter" do
      context "with a symbol which represents a function" do
        it "saves the element with the result of a function call and not the value of the instance variable" do
          expect(subject.xpath("address:housenumber").text).to eq "[1313]"
        end
      end

      context "with a lambda" do
        it "saves the results" do
          expect(subject.xpath('address:date_created').text).to eq "15:00:00 01/01/11"
        end
      end
    end

    context "when an attribute has a 'on_save' parameter" do
      context "with a lambda" do
        it "saves the result" do
          expect(subject.xpath('@location').text).to eq "Home-live"
        end
      end
    end

    context "when a has_many has a 'on_save' parameter" do
      context "with a lambda" do
        it "saves the result" do
          dates_updated = subject.xpath('address:dates_updated')
          expect(dates_updated.length).to eq 2
          expect(dates_updated.first.text).to eq "16:01:00 01/01/11"
          expect(dates_updated.last.text).to eq "11:30:01 01/02/11"
        end
      end
    end

    context "when an element type is a XmlMapper subclass" do
      it "saves attributes" do
        expect(subject.xpath('country:country/@countryCode').text).to eq "us"
      end

      it "saves elements" do
        expect(subject.xpath('country:country/countryName:countryName').text).to eq "USA"
      end
    end
  end

  context "with a default namespace" do
    it "writes the default namespace to xml without repeating xmlns" do
      recipe = ToXMLWithNamespaces::Recipe.new(:ingredients => ['One Cup Flour', 'Two Scoops of Lovin'])
      expect(recipe.to_xml).to match /xmlns=\"urn:eventis:prodis:onlineapi:1\.0\"/
    end
  end

  # NOTE While the original implementation of the test below is correct, the order of XML namespaces
  # in the XML generated by 'to_xml' differs under JRuby and MRI. In terms of information content,
  # the XML produced under both platforms are identical. However, the difference in namespace ordering
  # will produce different XML documents and consequently XML digests. The test below and various tests
  # in the 'libsaml' gem will compare XML documents and digests of XML documents generated by 'to_xml' which,
  # while informationally correct, have different values. Unfortunately, the cause of this behavior has
  # not been identified. In the meantime, it is important to explictly call out this behavior.

  context 'namespace supplied by element declaration trumps namespace ' \
          'specified by element class' do

    let(:expected_xml_jruby) do
      <<-XML.gsub(/^\s*\|/, '')
        |<?xml version="1.0"?>
        |<coffeemachine xmlns:beverage="http://beverages.org/Beverage/0.1" xmlns:coffee="http://coffee.org/Coffee/0.1">
        |  <beverage:beverage name="coffee"/>
        |</coffeemachine>
      XML
    end

    let(:expected_xml_mri) do
      <<-XML.gsub(/^\s*\|/, '')
        |<?xml version="1.0"?>
        |<coffeemachine xmlns:coffee="http://coffee.org/Coffee/0.1" xmlns:beverage="http://beverages.org/Beverage/0.1">
        |  <beverage:beverage name="coffee"/>
        |</coffeemachine>
      XML
    end

    class Beverage
      include XmlMapper
      namespace 'coffee'

      attribute :name, String
    end

    class CoffeeMachine
      include XmlMapper
      register_namespace 'coffee', "http://coffee.org/Coffee/0.1"
      register_namespace 'beverage', "http://beverages.org/Beverage/0.1"

      element :beverage, 'beverage', namespace: 'beverage'
    end

    it 'uses the element declaration namespace on the element' do
      machine = CoffeeMachine.new
      machine.beverage = Beverage.new.tap {|obj| obj.name = 'coffee'}
      if RUBY_ENGINE == 'jruby'
        machine.to_xml.should be == expected_xml_jruby
      else
        machine.to_xml.should be == expected_xml_mri
      end
    end
  end

end