implab/gradle-common Commit - r56:c41a563716ec

variants: refine public API boundary

cin -

r56:c41a563716ec default

parent child

Context file:

r56:c41a563716ec

Collapse all files

variants/src/main/java/org/implab/gradle/variants/internal/IdentityContainerFactory.java created 644 +14 0

@@ -0,0 +1,14
	1	package org.implab.gradle.variants.internal;
	2
	3	import org.gradle.api.Named;
	4	import org.gradle.api.NamedDomainObjectContainer;
	5	import org.gradle.api.model.ObjectFactory;
	6
	7	public final class IdentityContainerFactory {
	8	private IdentityContainerFactory() {
	9	}
	10
	11	public static <T extends Named> NamedDomainObjectContainer<T> create(ObjectFactory objectFactory, Class<T> type) {
	12	return objectFactory.domainObjectContainer(type, name -> objectFactory.named(type, name));
	13	}
	14	}

variants/src/main/java/org/implab/gradle/variants/internal/package-info.java created 644 +7 0

@@ -0,0 +1,7
	1	/**
	2	* Internal implementation utilities of the variants module.
	3	*
	4	* <p>Types in this package are not part of the public API. They may change,
	5	* move, or be removed without compatibility guarantees.
	6	*/
	7	package org.implab.gradle.variants.internal;

variants/src/main/java/org/implab/gradle/variants/sources/internal/package-info.java created 644 +9 0

@@ -0,0 +1,9
	1	/**
	2	* Internal implementation of the variant sources plugin.
	3	*
	4	* <p>Types in this package are not part of the public API. They may change,
	5	* move, or be removed without compatibility guarantees. Build logic should use
	6	* the public contracts from {@link org.implab.gradle.variants.sources}
	7	* instead.
	8	*/
	9	package org.implab.gradle.variants.sources.internal;

variants/build.gradle +4 0

                 useJUnitPlatform()
             }
+            javadoc {
+                exclude "**/internal/**"
+            }
             publishing {
                 repositories {
                     ivy {

variants/src/main/java/org/implab/gradle/variants/VariantArtifactsPlugin.java +1 -1

                         // apply materialization policy hooks to outgoing variants
                         outgoing.configureEach(materializationHandler::execute);
-                        sourcesExtension.whenFinalized(sources -> {
+                        sourcesExtension.whenAvailable(sources -> {
                             var assemblyHandler = new ArtifactAssemblyHandler(
                                     objects,
                                     tasks,

variants/src/main/java/org/implab/gradle/variants/VariantSourcesPlugin.java +4 -4

                     var variantSourcesExtension = new VariantSourcesExtension() {
                         @Override
-                        public void whenFinalized(Action<? super VariantSourcesContext> action) {
+                        public void whenAvailable(Action<? super VariantSourcesContext> action) {
                             deferred.whenResolved(action::execute);
                         }
                             lateConfigurationPolicy.finalizePolicy();
-                            whenFinalized(ctx -> ctx.configureVariant(resolveVariant(ctx.getVariants(), variantName), action));
+                            whenAvailable(ctx -> ctx.configureVariant(resolveVariant(ctx.getVariants(), variantName), action));
                         }
                         @Override
                             lateConfigurationPolicy.finalizePolicy();
-                            whenFinalized(ctx -> ctx.configureLayer(resolveLayer(ctx.getVariants(), layerName), action));
+                            whenAvailable(ctx -> ctx.configureLayer(resolveLayer(ctx.getVariants(), layerName), action));
                         }
                         @Override
                             lateConfigurationPolicy.finalizePolicy();
-                            whenFinalized(ctx -> ctx.configureUnit(resolveCompileUnit(ctx, variantName, layerName), action));
+                            whenAvailable(ctx -> ctx.configureUnit(resolveCompileUnit(ctx, variantName, layerName), action));
                         }
                     };

variants/src/main/java/org/implab/gradle/variants/VariantsPlugin.java +1 -1

             import org.gradle.api.Project;
             import org.gradle.api.model.ObjectFactory;
             import org.implab.gradle.common.core.lang.Deferred;
-            import org.implab.gradle.internal.IdentityContainerFactory;
             import org.implab.gradle.variants.core.Layer;
             import org.implab.gradle.variants.core.Role;
             import org.implab.gradle.variants.core.Variant;
             import org.implab.gradle.variants.core.VariantDefinition;
             import org.implab.gradle.variants.core.VariantsExtension;
             import org.implab.gradle.variants.core.VariantsView;
+            import org.implab.gradle.variants.internal.IdentityContainerFactory;
             /**
              * <ul>

variants/src/main/java/org/implab/gradle/variants/artifacts/internal/OutgoingRegistry.java +1 -1

             import org.gradle.api.artifacts.ConfigurationContainer;
             import org.gradle.api.model.ObjectFactory;
             import org.gradle.api.provider.Property;
-            import org.implab.gradle.internal.IdentityContainerFactory;
             import org.implab.gradle.common.core.lang.ReplayableQueue;
             import org.implab.gradle.variants.artifacts.OutgoingVariant;
             import org.implab.gradle.variants.artifacts.Slot;
             import org.implab.gradle.variants.core.Variant;
+            import org.implab.gradle.variants.internal.IdentityContainerFactory;
             /**
              * Registry of variant-level outgoing models.

variants/src/main/java/org/implab/gradle/variants/sources/VariantSourcesExtension.java +10 -10

                  * <li>it must be selected before the first selector rule is registered via
                  * {@link #variant(String, Action)}, {@link #layer(String, Action)} or
                  * {@link #unit(String, String, Action)};</li>
-                 * <li>it must be selected before the finalized context becomes observable via
+                 * <li>it must be selected before the source context becomes observable via
-                 * {@link #whenFinalized(Action)};</li>
+                 * {@link #whenAvailable(Action)};</li>
-                 * <li>once selected or once the finalized context is being created, it cannot
+                 * <li>once selected or once source context creation begins, it cannot
                  * be changed later;</li>
                  * <li>the policy controls both diagnostics and late-application semantics.</li>
                  * </ul>
                 }
                 /**
-                 * Selects how compile-unit name collisions are handled when the finalized
+                 * Selects how compile-unit name collisions are handled when the source
-                 * source context is created.
+                 * context is created from the finalized variant model.
                  *
                  * <p>This policy is single-valued:
                  * <ul>
                  * <li>it must be selected before the finalized
                  * {@link VariantSourcesContext} becomes observable through
-                 * {@link #whenFinalized(Action)};</li>
+                 * {@link #whenAvailable(Action)};</li>
                  * <li>once the context is being created, the policy is fixed and cannot be
                  * changed later;</li>
                  * <li>the policy governs validation of compile-unit names produced by the
                 }
                 /**
-                 * Invoked when finalized variants-derived source context becomes available.
+                 * Invoked when the variants-derived source context becomes available.
                  *
                  * Replayable:
                  * <ul>
                  * policy has already been fixed and symbolic source-set names for finalized
                  * compile units are determined.
                  */
-                void whenFinalized(Action<? super VariantSourcesContext> action);
+                void whenAvailable(Action<? super VariantSourcesContext> action);
-                default void whenFinalized(Closure<?> closure) {
+                default void whenAvailable(Closure<?> closure) {
-                    whenFinalized(Closures.action(closure));
+                    whenAvailable(Closures.action(closure));
                 }

variants/src/test/java/org/implab/gradle/variants/VariantSourcesPluginFunctionalTest.java +9 -9

                             def lines = []
-                            variantSources.whenFinalized { ctx ->
+                            variantSources.whenAvailable { ctx ->
                                 lines << "units=" + ctx.compileUnits.units
                                     .collect { "${it.variant().name}:${it.layer().name}" }
                                     .sort()
                             }
                             afterEvaluate {
-                                variantSources.whenFinalized { ctx ->
+                                variantSources.whenAvailable { ctx ->
                                     lines << "late:variants=" + ctx.variants.variants.collect { it.name }.sort().join(',')
                                 }
                             }
                             }
                             afterEvaluate {
-                                variantSources.whenFinalized { ctx ->
+                                variantSources.whenAvailable { ctx ->
                                     def browser = ctx.variants.variants.find { it.name == 'browser' }
                                     def node = ctx.variants.variants.find { it.name == 'node' }
                                     def mainLayer = ctx.variants.layers.find { it.name == 'main' }
                             }
                             afterEvaluate {
-                                variantSources.whenFinalized { ctx ->
+                                variantSources.whenAvailable { ctx ->
                                     def browser = ctx.variants.variants.find { it.name == 'browser' }
                                     def mainLayer = ctx.variants.layers.find { it.name == 'main' }
                                     def unit = ctx.compileUnits.requireUnit(browser, mainLayer)
                             }
                             afterEvaluate {
-                                variantSources.whenFinalized { ctx ->
+                                variantSources.whenAvailable { ctx ->
                                     def browser = ctx.variants.variants.find { it.name == 'browser' }
                                     def mainLayer = ctx.variants.layers.find { it.name == 'main' }
                                     def unit = ctx.compileUnits.requireUnit(browser, mainLayer)
                             }
                             afterEvaluate {
-                                variantSources.whenFinalized { ctx ->
+                                variantSources.whenAvailable { ctx ->
                                     def browser = ctx.variants.variants.find { it.name == 'browser' }
                                     def mainLayer = ctx.variants.layers.find { it.name == 'main' }
                                     def unit = ctx.compileUnits.requireUnit(browser, mainLayer)
                             }
                             afterEvaluate {
-                                variantSources.whenFinalized { ctx ->
+                                variantSources.whenAvailable { ctx ->
                                     def foo = ctx.variants.variants.find { it.name == 'foo' }
                                     def fooVariant = ctx.variants.variants.find { it.name == 'fooVariant' }
                                     def variantBar = ctx.variants.layers.find { it.name == 'variantBar' }
                                 role('production') { layers('main') }
                             }
-                            variantSources.whenFinalized {
+                            variantSources.whenAvailable {
                                 variantSources.namingPolicy {
                                     resolveNameCollision()
                                 }
                                 role('production') { layers('main') }
                             }
-                            variantSources.whenFinalized {
+                            variantSources.whenAvailable {
                                 variantSources.lateConfigurationPolicy {
                                     allowLateConfiguration()
                                 }

variants/src/main/java/org/implab/gradle/internal/IdentityContainerFactory.java removed 0 -14

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages