com.dslplatform.compiler.client.parameters.Settings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dsl-clc Show documentation
Command line client for interaction with DSL Platform compiler (https://dsl-platform.com)
The newest version!
package com.dslplatform.compiler.client.parameters;

import com.dslplatform.compiler.client.*;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

public enum Settings implements CompileParameter, ParameterParser {
	INSTANCE;

	@Override
	public String getAlias() { return "settings"; }
	@Override
	public String getUsage() { return "options"; }

	public enum Option {
		ACTIVE_RECORD("active-record", "Active record pattern in client libraries"),
		UTC("utc", "Timestamp should use UTC by default"),
		JACKSON("jackson", "Add Jackson annotations"),
		JAVA_BEANS("java-beans", "Add Java Beans support"),
		MANUAL_JSON("manual-json", "Add optimized serialization/deserialization methods"),
		NO_HELPERS("no-helpers", "Don't use helper methods"),
		MULTI_TENANCY("multi-tenancy", "Support Multi-tenancy on server"),
		LEGACY("legacy", "Legacy methods"),
		SOURCE_ONLY("source-only", "Only provide source code, don't run post-step (compilation)"),
		JODA_TIME("joda-time", "Use Joda Time library (instead of Java time API)"),
		NO_PREPARE_EXECUTE("no-prepare-execute", "Don't use PREPARE/EXECUTE statements in Postgres"),
		MINIMAL_SERIALIZATION("minimal-serialization", "Minimize serialization output (omit default values)"),
		LAZY_LOAD_WARNING("lazy-load-warning", "Inject warning when accessing lazy load property"),
		URI_REFERENCE("uri-reference", "Helper method for setting reference through URI value"),
		JAXB("jaxb", "Add annotations and converters for Java Architecture for XML Binding (JAXB)"),
		PERMISSION_ACCESS("permission-access", "Generate only code accessible through permissions"),
		DISABLE_COMPANION("disable-companion", "Don't use companion object for scala classes"),
		BUILDER("builder", "Create builder object when appropriate"),
		DOCUMENTATION_METADATA("docs-metadata", "Create documentation metadata");

		private final String value;
		private final String description;

		Option(final String value, final String description) {
			this.value = value;
			this.description = description;
		}

		private static Option from(final String value) {
			for (final Option o : Option.values()) {
				if (o.value.equalsIgnoreCase(value)) {
					return o;
				}
			}
			return null;
		}

		@Override
		public String toString() {
			return value;
		}
	}

	private static final String CACHE_NAME = "settings_option_cache";

	public static List get(final Context context) {
		return context.load(CACHE_NAME);
	}

	public static boolean hasSourceOnly(final Context context) {
		final List options = get(context);
		return options != null && options.contains(Option.SOURCE_ONLY.value);
	}

	private static void listOptions(final Context context) {
		for (final Option o : Option.values()) {
			context.show(o.value + " - " + o.description);
		}
		context.show("Example usages:");
		context.show("\tsettings=active-record,joda-time,jackson");
		context.show("\tactive-record manual-json");
	}

	@Override
	public Either tryParse(final String name, final String value, final Context context) {
		if (Option.from(name) != null) {
			if (value != null && value.length() > 0) {
				return Either.fail("Settings parameter detected, but settings don't support arguments. Parameter: " + name);
			}
			context.put(name, null);
			return Either.success(true);
		}
		return Either.success(false);
	}

	@Override
	public boolean check(final Context context) {
		final List settings = new ArrayList();
		if (context.contains(INSTANCE)) {
			final String value = context.get(INSTANCE);
			if (value == null || value.length() == 0) {
				context.error("Settings not provided. Available settings: ");
				listOptions(context);
				return false;
			}
			Collections.addAll(settings, value.split(","));
		}
		for(final Option o : Option.values()) {
			if (context.contains(o.value) && !settings.contains(o.value)) {
				settings.add(o.value);
			}
		}
		if(settings.size() == 0) {
			if (context.contains(INSTANCE)) {
				context.error("Settings not provided. Available settings: ");
				listOptions(context);
				return false;
			}
			return true;
		}
		final List options = new ArrayList(settings.size());
		for(final String name : settings) {
			final Option o = Option.from(name);
			if (o == null) {
				if (!context.contains(Force.INSTANCE)) {
					context.error("Unknown setting: " + name + ". If you wish to use this setting, enable force option.");
					listOptions(context);
					return false;
				}
				context.warning("Unknown setting: " + name + ". Adding it due to force option.");
				options.add(name);
			} else options.add(o.value);
		}
		context.cache(CACHE_NAME, options);
		return true;
	}

	@Override
	public void run(final Context context) {
	}

	@Override
	public String getShortDescription() {
		return "Custom compile settings for DSL -> target conversion (Active record, Jackson, etc...)";
	}

	@Override
	public String getDetailedDescription() {
		final StringBuilder sb = new StringBuilder();
		sb.append("DSL Platform compiler supports various compilation options for tweaking target library.\n");
		sb.append("Some options are only available in some languages.\n");
		sb.append("'Unsupported' settings can be passed using force option.\n");
		sb.append("--------------------------------------------------\n");
		for (final Option o : Option.values()) {
			sb.append(o.value).append(" - ").append(o.description).append("\n");
		}
		return sb.toString();
	}
}