TestSemanticOneSpaceFormatter.java

/**
 * Copyright (c) 2012 Cloudsmith Inc. and other contributors, as listed below.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *   Cloudsmith
 * 
 */
package org.cloudsmith.geppetto.pp.dsl.tests;

import static com.google.inject.util.Modules.override;
import static org.cloudsmith.geppetto.injectable.CommonModuleProvider.getCommonModule;

import org.cloudsmith.geppetto.pp.AssignmentExpression;
import org.cloudsmith.geppetto.pp.LiteralList;
import org.cloudsmith.geppetto.pp.PPFactory;
import org.cloudsmith.geppetto.pp.PuppetManifest;
import org.cloudsmith.geppetto.pp.dsl.PPRuntimeModule;
import org.cloudsmith.xtext.dommodel.DomModelUtils;
import org.cloudsmith.xtext.dommodel.IDomNode;
import org.cloudsmith.xtext.dommodel.formatter.IDomModelFormatter;
import org.cloudsmith.xtext.dommodel.formatter.OneWhitespaceDomFormatter;
import org.cloudsmith.xtext.dommodel.formatter.context.IFormattingContext;
import org.cloudsmith.xtext.serializer.DomBasedSerializer;
import org.eclipse.xtext.formatting.IIndentationInformation;
import org.eclipse.xtext.resource.XtextResource;
import org.eclipse.xtext.serializer.ISerializer;
import org.eclipse.xtext.serializer.diagnostic.ISerializationDiagnostic.Acceptor;
import org.eclipse.xtext.util.ITextRegion;
import org.eclipse.xtext.util.ReplaceRegion;
import org.junit.Before;
import org.junit.Test;

import com.google.inject.Binder;
import com.google.inject.Guice;
import com.google.inject.Injector;

/**
 * Tests the OneSpace Semantic Formatter.
 * (This is not the most important formatter, and there are only a few smoke tests).
 * 
 */
public class TestSemanticOneSpaceFormatter extends AbstractPuppetTests {
	public static class DebugFormatter extends OneWhitespaceDomFormatter {

		/*
		 * (non-Javadoc)
		 * 
		 * @see org.cloudsmith.geppetto.pp.dsl.xt.dommodel.formatter.IDomModelFormatter#format(org.cloudsmith.geppetto.pp.dsl.xt.dommodel.IDomNode,
		 * org.eclipse.xtext.util.ITextRegion, org.cloudsmith.geppetto.pp.dsl.xt.dommodel.formatter.IFormattingContext,
		 * org.eclipse.xtext.serializer.diagnostic.ISerializationDiagnostic.Acceptor)
		 */
		@Override
		public ReplaceRegion format(IDomNode dom, ITextRegion regionToFormat, IFormattingContext formattingContext,
				Acceptor errors) {
			System.err.println(DomModelUtils.compactDump(dom, true));
			return super.format(dom, regionToFormat, formattingContext, errors);
		}

	}

	public static class TestSetup extends PPTestSetup {
		public static class TestModule extends PPTestModule {
			/*
			 * (non-Javadoc)
			 * 
			 * @see org.eclipse.xtext.service.AbstractGenericModule#configure(com.google.inject.Binder)
			 */
			@Override
			public void configure(Binder binder) {
				super.configure(binder);
				binder.bind(ISerializer.class).to(DomBasedSerializer.class);
				binder.bind(IIndentationInformation.class).to(IIndentationInformation.Default.class);
				binder.bind(IDomModelFormatter.class).to(DebugFormatter.class);
			}
		}

		@Override
		public Injector createInjector() {
			return Guice.createInjector(override(getCommonModule(), new PPRuntimeModule()).with(new TestModule()));
		}
	}

	@Override
	@Before
	public void setUp() throws Exception {
		super.setUp();
		// with(PPStandaloneSetup.class);
		with(TestSetup.class);
	}

	@Override
	protected boolean shouldTestSerializer(XtextResource resource) {
		return false;
	}

	@Test
	public void test_Serialize_arrayNoSpaces() throws Exception {
		String code = "$a=['10','20']";
		String fmt = "$a = [ '10' , '20' ]";
		XtextResource r = getResourceFromString(code);
		String s = serializeFormatted(r.getContents().get(0));
		assertEquals("serialization should produce expected one-spaced result", fmt, s);
	}

	@Test
	public void test_Serialize_arrayWithComments() throws Exception {
		String code = "/*1*/$a/*2*/=/*3*/[/*4*/'10'/*5*/,/*6*/'20'/*7*/]/*8*/";
		String fmt = "/*1*/ $a /*2*/ = /*3*/ [ /*4*/ '10' /*5*/ , /*6*/ '20' /*7*/ ] /*8*/";
		XtextResource r = getResourceFromString(code);
		String s = serializeFormatted(r.getContents().get(0));
		assertEquals("serialization should produce expected on-spaced result", fmt, s);
	}

	@Test
	public void test_Serialize_assignArray() throws Exception {
		PuppetManifest pp = pf.createPuppetManifest();
		AssignmentExpression assignment = PPFactory.eINSTANCE.createAssignmentExpression();
		assignment.setLeftExpr(createVariable("a"));
		LiteralList pplist = PPFactory.eINSTANCE.createLiteralList();
		assignment.setRightExpr(pplist);
		pplist.getElements().add(createSqString("10"));
		pplist.getElements().add(createSqString("20"));
		pp.getStatements().add(assignment);
		String fmt = "$a = [ '10' , '20' , ]";
		String s = serialize(pp);
		assertEquals("serialization should produce single spaced result", fmt, s);

	}

	@Test
	public void test_Serialize_shortArrayWithComments() throws Exception {
		String code = "[a /*1*/]/*2*/";
		String fmt = "[ a /*1*/ ] /*2*/";
		XtextResource r = getResourceFromString(code);
		String s = serializeFormatted(r.getContents().get(0));
		assertEquals("serialization should produce expected one-spaced result", fmt, s);
	}
}