DelegatingStaxMateSerializerTest.java

/**
 * Copyright (C) cedarsoft GmbH.
 *
 * Licensed under the GNU General Public License version 3 (the "License")
 * with Classpath Exception; you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *         http://www.cedarsoft.org/gpl3ce
 *         (GPL 3 with Classpath Exception)
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 3 only, as
 * published by the Free Software Foundation. cedarsoft GmbH designates this
 * particular file as subject to the "Classpath" exception as provided
 * by cedarsoft GmbH in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 3 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 3 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact cedarsoft GmbH, 72810 Gomaringen, Germany,
 * or visit www.cedarsoft.com if you need additional information or
 * have any questions.
 */

package com.cedarsoft.serialization.stax.mate;

import com.cedarsoft.test.utils.AssertUtils;
import com.cedarsoft.version.Version;
import com.cedarsoft.version.VersionRange;
import com.cedarsoft.serialization.test.utils.AbstractXmlSerializerTest;
import com.cedarsoft.serialization.SerializingStrategy;
import com.cedarsoft.serialization.ToString;
import com.cedarsoft.serialization.VersionMappings;
import com.cedarsoft.serialization.ui.VersionMappingsVisualizer;
import org.apache.commons.io.Charsets;
import org.codehaus.staxmate.out.SMOutputElement;
import org.junit.*;
import org.xml.sax.SAXException;

import javax.annotation.Nonnull;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.StringWriter;
import java.util.Comparator;

import static org.junit.Assert.*;

/**
 *
 */
public class DelegatingStaxMateSerializerTest extends AbstractXmlSerializerTest<Number> {
  private MySerializer serializer;

  @Before
  public void setUp() throws Exception {
    AbstractStaxMateSerializingStrategy<Integer> intSerializer = new AbstractStaxMateSerializingStrategy<Integer>( "int", "asdf", Integer.class, new VersionRange( new Version( 1, 0, 0 ), new Version( 1, 0, 0 ) ) ) {
      @Override
      public void serialize( @Nonnull SMOutputElement serializeTo, @Nonnull Integer object, @Nonnull Version formatVersion ) throws IOException, XMLStreamException {
        serializeTo.addCharacters( object.toString() );

      }

      @Override
      @Nonnull
      public Integer deserialize( @Nonnull XMLStreamReader deserializeFrom, @Nonnull Version formatVersion ) throws IOException, XMLStreamException {
        assert isVersionReadable( formatVersion );
        getText( deserializeFrom );
        return 1;
      }
    };

    AbstractStaxMateSerializingStrategy<Double> doubleSerializer = new AbstractStaxMateSerializingStrategy<Double>( "double", "asdf", Double.class, new VersionRange( new Version( 1, 0, 0 ), new Version( 1, 0, 0 ) ) ) {
      @Override
      public void serialize( @Nonnull SMOutputElement serializeTo, @Nonnull Double object, @Nonnull Version formatVersion ) throws IOException, XMLStreamException {
        assert isVersionWritable( formatVersion );
        serializeTo.addCharacters( object.toString() );

      }

      @Override
      @Nonnull
      public Double deserialize( @Nonnull XMLStreamReader deserializeFrom, @Nonnull Version formatVersion ) throws IOException, XMLStreamException {
        assert isVersionReadable( formatVersion );
        getText( deserializeFrom );
        return 2.0;
      }
    };
    serializer = new MySerializer( intSerializer, doubleSerializer );
  }

  @Nonnull
  @Override
  protected AbstractStaxMateSerializer<Number> getSerializer() {
    return serializer;
  }

  @Nonnull
  @Override
  protected Number createObjectToSerialize() {
    return 1;
  }

  @Nonnull
  @Override
  protected String getExpectedSerialized() {
    return "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
      "<number xmlns=\"http://number/1.0.0\" type=\"int\">1</number>";
  }

  @Override
  protected void verifyDeserialized( @Nonnull Number deserialized ) {
    assertEquals( 1, deserialized );
  }

  @Test
  public void testIt() throws IOException, SAXException {
    assertEquals( 2, serializer.getStrategies().size() );

    AssertUtils.assertXMLEquals( new String( serializer.serializeToByteArray( 1 ), Charsets.UTF_8 ).trim(), "<number xmlns=\"http://number/1.0.0\" type=\"int\">1</number>" );
    AssertUtils.assertXMLEquals( new String( serializer.serializeToByteArray( 2.0 ), Charsets.UTF_8 ).trim(), "<number xmlns=\"http://number/1.0.0\" type=\"double\">2.0</number>" );
  }

  @Test
  public void testVis() throws IOException {
    VersionMappings<SerializingStrategy<? extends Number, SMOutputElement, XMLStreamReader, XMLStreamException, OutputStream, InputStream>> versionMappings = serializer.getSerializingStrategySupport().getVersionMappings();

    assertTrue( versionMappings.verify() );
    assertEquals( 2, versionMappings.getMappings().size() );

    VersionMappingsVisualizer<SerializingStrategy<? extends Number, SMOutputElement, XMLStreamReader, XMLStreamException, OutputStream, InputStream>> visualizer = VersionMappingsVisualizer.create( versionMappings, new Comparator<SerializingStrategy<? extends Number, SMOutputElement, XMLStreamReader, XMLStreamException, OutputStream, InputStream>>() {
                                                                                                                                                                            @Override
                                                                                                                                                                            public int compare( SerializingStrategy<? extends Number, SMOutputElement, XMLStreamReader, XMLStreamException, OutputStream, InputStream> o1, SerializingStrategy<? extends Number, SMOutputElement, XMLStreamReader, XMLStreamException, OutputStream, InputStream> o2 ) {
                                                                                                                                                                              return o1.getId().compareTo( o2.getId() );
                                                                                                                                                                            }
                                                                                                                                                                          }, new ToString<SerializingStrategy<? extends Number, SMOutputElement, XMLStreamReader, XMLStreamException, OutputStream, InputStream>>() {
      @Nonnull
      @Override
      public String convert( @Nonnull SerializingStrategy<? extends Number, SMOutputElement, XMLStreamReader, XMLStreamException, OutputStream, InputStream> object ) {
        return object.getId();
      }
    }
    );
    StringWriter writer = new StringWriter();
    visualizer.visualize( writer );

    assertEquals(
      "         -->    double       int\n" +
        "--------------------------------\n" +
        "   1.0.0 -->     1.0.0     1.0.0\n" +
        "--------------------------------\n", writer.toString() );
  }

  public static class MySerializer extends AbstractDelegatingStaxMateSerializer<Number> {
    public MySerializer( SerializingStrategy intSerializer, SerializingStrategy doubleSerializer ) {
      super( "number", "http://number", VersionRange.from( 1, 0, 0 ).to( 1, 0, 0 ) );

      addStrategy( intSerializer )
        .map( VersionRange.from( 1, 0, 0 ).to( 1, 0, 0 ) ).toDelegateVersion( 1, 0, 0 )
      ;

      addStrategy( doubleSerializer )
        .map( VersionRange.from( 1, 0, 0 ).to( 1, 0, 0 ) ).toDelegateVersion( 1, 0, 0 )
      ;

      //Verify the delegate mappings
      getSerializingStrategySupport().verify();
    }
  }
}