eu.solven.cleanthat.spotless.language.JsonFormatterStepFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spotless Show documentation
There is a newer version: 2.22
/*
 * Copyright 2023 Benoit Lacelle - SOLVEN
 *
 * 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 eu.solven.cleanthat.spotless.language;

import java.util.Map;

import com.diffplug.spotless.FormatterStep;
import com.diffplug.spotless.Provisioner;
import com.diffplug.spotless.json.JacksonJsonConfig;
import com.diffplug.spotless.json.JacksonJsonStep;
import com.diffplug.spotless.json.JsonSimpleStep;
import com.diffplug.spotless.json.gson.GsonConfig;
import com.diffplug.spotless.json.gson.GsonStep;

import eu.solven.cleanthat.codeprovider.ICodeProvider;
import eu.solven.cleanthat.spotless.AFormatterStepFactory;
import eu.solven.cleanthat.spotless.pojo.SpotlessFormatterProperties;
import eu.solven.cleanthat.spotless.pojo.SpotlessStepParametersProperties;
import eu.solven.cleanthat.spotless.pojo.SpotlessStepProperties;

/**
 * Configure Spotless engine for JSON files
 * 
 * @author Benoit Lacelle
 *
 */
public class JsonFormatterStepFactory extends AFormatterStepFactory {
	private static final int DEFAULT_INDENTATION = 4;
	private static final String DEFAULT_GSON_VERSION = "2.10.1";

	public JsonFormatterStepFactory(JsonFormatterFactory jsonFactory,
			ICodeProvider codeProvider,
			SpotlessFormatterProperties spotlessProperties) {
		super(jsonFactory, codeProvider, spotlessProperties);
	}

	@Override
	public String licenseHeaderDelimiter() {
		return null;
	}

	@SuppressWarnings("PMD.TooFewBranchesForASwitchStatement")
	@Override
	public FormatterStep makeSpecializedStep(SpotlessStepProperties s, Provisioner provisioner) {
		String stepId = s.getId();
		SpotlessStepParametersProperties parameters = s.getParameters();

		switch (stepId) {
		case "simple": {
			return makeSimple(parameters, provisioner);
		}
		case "gson": {
			return makeGson(parameters, provisioner);
		}
		case "jackson": {
			return makeJackson(parameters, provisioner);
		}
		default: {
			throw new IllegalArgumentException("Unknown step: " + stepId);
		}
		}
	}

	private FormatterStep makeSimple(SpotlessStepParametersProperties parameters, Provisioner provisioner) {
		Integer indentSpaces = parameters.getCustomProperty("indent_spaces", Integer.class);
		if (indentSpaces == null) {
			indentSpaces = DEFAULT_INDENTATION;
		}

		return JsonSimpleStep.create(indentSpaces, provisioner);
	}

	private FormatterStep makeGson(SpotlessStepParametersProperties parameters, Provisioner provisioner) {
		Integer indentSpaces = parameters.getCustomProperty("indent_spaces", Integer.class);
		if (indentSpaces == null) {
			indentSpaces = DEFAULT_INDENTATION;
		}

		Boolean sortByKeys = parameters.getCustomProperty("sort_by_keys", Boolean.class);
		if (sortByKeys == null) {
			sortByKeys = false;
		}

		Boolean escapeHtml = parameters.getCustomProperty("escape_html", Boolean.class);
		if (escapeHtml == null) {
			escapeHtml = false;
		}

		String version = parameters.getCustomProperty("version", String.class);
		if (version == null) {
			version = DEFAULT_GSON_VERSION;
		}

		return GsonStep.create(new GsonConfig(sortByKeys, escapeHtml, indentSpaces, version), provisioner);
	}

	private FormatterStep makeJackson(SpotlessStepParametersProperties parameters, Provisioner provisioner) {
		var jacksonConfig = new JacksonJsonConfig();

		Boolean spaceBeforeSeparator = parameters.getCustomProperty("space_before_separator", Boolean.class);
		if (spaceBeforeSeparator != null) {
			jacksonConfig.setSpaceBeforeSeparator(spaceBeforeSeparator);
		}

		@SuppressWarnings("unchecked")
		Map features = parameters.getCustomProperty("features", Map.class);
		if (features != null) {
			jacksonConfig.appendFeatureToToggle(features);
		}

		@SuppressWarnings("unchecked")
		Map jsonFeatures = parameters.getCustomProperty("json_features", Map.class);
		if (jsonFeatures != null) {
			jacksonConfig.appendJsonFeatureToToggle(jsonFeatures);
		}

		String version = parameters.getCustomProperty("version", String.class);
		if (version == null) {
			version = JacksonJsonStep.defaultVersion();
		}

		return JacksonJsonStep.create(jacksonConfig, version, provisioner);
	}

}