com.predic8.schema.diff.AnyDiffGenerator.groovy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of soa-model-core Show documentation
There is a newer version: 2.0.1
/* Copyright 2012 predic8 GmbH, www.predic8.com
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 http://www.apache.org/licenses/LICENSE-2.0
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License. */

package com.predic8.schema.diff

import com.predic8.soamodel.*
import org.slf4j.Logger
import org.slf4j.LoggerFactory

/**
 * DiffGenerator for processing 'any' elements.
 */
class AnyDiffGenerator extends ElementDiffGenerator {
	// extends ElementDiffGenerator to inherit max/min and annotation processing
	
	public AnyDiffGenerator() {
		updateLabels()
		super.updateLabels()
	}

	// Very helpful for understanding this element and its attributes:
	// http://msdn.microsoft.com/en-us/library/ms256043.aspx

	private static final Logger log = LoggerFactory.getLogger(AnyDiffGenerator.class)

	private def labelHasChanged, labelAdded, labelAnyElement, labelRemoved, labelHasChenged, labelNamespaceChanged, labelProcessContentLess, labelProcessContentMore

	// removing an 'any' is a breaking change
	def removed = {new Difference(description:"${labelAnyElement} ${labelRemoved}.", type: 'any', breaks: ctx.exchange ? true: null, exchange: a.exchange)}

	// adding an 'any' is non-breaking
	def added = { new Difference(description:"${labelAnyElement} ${labelAdded}.", type: 'any', breaks:ctx.exchange ? false: null, exchange: b.exchange)}

	// changes may be breaking depend on their nature.  processing of attributes will determine...
	def changed = { diffs ->
		new Difference(description:"${labelAnyElement}:" , type: 'any' ,  diffs : diffs, exchange: a.exchange)
	}

	// array of processContents values in order of stringency from most leniant to most strict
	private ArrayList processContentsStrictness = ['skip', 'lax', 'strict']

	protected getTypeAndName() {
		"any"
	}

	List compareUnit(){
		log.debug("compareAny")
		def lDiffs = []
		lDiffs.addAll(generator.compareAnnotation(a.annotation, b.annotation))
		lDiffs.addAll(compareMinMaxOccurs('any'))
		lDiffs.addAll(compareNamespace())
		lDiffs.addAll(compareProcessing())

		lDiffs
	}

	List compareNamespace() {

		// ##any is the default
		String aNamespace = (a.namespace ?: '##any').trim()
		String bNamespace = (b.namespace ?: '##any').trim()

		Set aNamespaces = new HashSet(Arrays.asList(aNamespace.split("\\s+")))
		Set bNamespaces = new HashSet(Arrays.asList(bNamespace.split("\\s+")))

		// ASSUMPTIONS:
		// 1) if the new namespace is ##any, the change is safe
		// 2) if the the new namespace is ##other and the old namespace isnt ##any and
		//      doesn't contain ##targetNamespace, we're safe
		// 3) if b has a set of namespace options, they must be a superset of a's namespaces to be safe

		def isDiffBreaks = true

		if (
		bNamespace == '##any' ||  // #1
		( bNamespace == '##other' && (aNamespace == "##any" || !aNamespaces.contains("##targetNamespace")) ) || // #2
		bNamespaces.containsAll(aNamespaces)  // #3
		) {
			isDiffBreaks = false
		}

		if (!aNamespaces.equals(bNamespaces)) {
			return [
				new Difference(description:"${labelNamespaceChanged} '${bNamespace}'", type: 'any', breaks: ctx.exchange? isDiffBreaks : null, exchange: a.exchange)
			]
		}

		[]
	}

	List compareProcessing() {
		// default value for processContents is 'strict'
		def aProcessContents = a.processContents ?: 'strict'
		def bProcessContents = b.processContents ?: 'strict'

		int aStrictnessIndex = processContentsStrictness.indexOf(aProcessContents);
		int bStrictnessIndex = processContentsStrictness.indexOf(bProcessContents);

		if (aStrictnessIndex > bStrictnessIndex) return [
				new Difference(description:"${labelProcessContentLess}", type: 'any', breaks: ctx.exchange? false: null, exchange: a.exchange)
			]
		if (aStrictnessIndex < bStrictnessIndex) return [
				new Difference(description:"${labelProcessContentMore}", type: 'any', breaks: ctx.exchange? true: null, exchange: a.exchange)
			]

		[]
	}

	protected def updateLabels(){
		labelNamespaceChanged = bundle.getString("com.predic8.schema.diff.labelNamespaceChanged")
		labelAnyElement = bundle.getString("com.predic8.schema.diff.labelAnyElement")
		labelHasChanged = bundle.getString("com.predic8.schema.diff.labelHasChanged")
		labelAdded = bundle.getString("com.predic8.schema.diff.labelAdded")
		labelRemoved = bundle.getString("com.predic8.schema.diff.labelRemoved")
		labelProcessContentLess = bundle.getString("com.predic8.schema.diff.labelProcessContentLess")
		labelProcessContentMore = bundle.getString("com.predic8.schema.diff.labelProcessContentMore")
	}

}