Merge pull request #94 from nebula-plugins/improve-provider-api-configuration-avoidance

Improve usage of Provider API

Author: rpalcolea

src/main/groovy/nebula/plugin/responsible/FacetDefinition.groovy

@@ -1,26 +1,30 @@
 package nebula.plugin.responsible
 
-import groovy.transform.Canonical
 import groovy.transform.CompileStatic
 import org.gradle.api.Named
+import org.gradle.api.model.ObjectFactory
+import org.gradle.api.provider.Property
+
+import javax.inject.Inject
 
 /**
  * Definition of a source facet, which via the NebulaFacetPlugin will create
  * a source set and runtime/compile configurations. Name is used for the source
  * directory and the prefix for configurations.
  */
-@Canonical
 @CompileStatic
 class FacetDefinition implements Named {
-    // TODO Use convention mapping to provide good defaults
-    FacetDefinition(String name) {
+    private final String name
+    final Property<String> parentSourceSet
+
+    @Inject
+    FacetDefinition(String name, ObjectFactory objects) {
         this.name = name
+        this.parentSourceSet = objects.property(String).convention('main')
     }
 
-    String name
-    String parentSourceSet
-
-    String getParentSourceSet() {
-        return parentSourceSet ?: 'main'
+    @Override
+    String getName() {
+        return name
     }
 }

src/main/groovy/nebula/plugin/responsible/NebulaFacetPlugin.groovy

@@ -14,6 +14,7 @@ import org.gradle.api.Task
 import org.gradle.api.artifacts.Configuration
 import org.gradle.api.internal.CollectionCallbackActionDecorator
 import org.gradle.api.internal.project.ProjectInternal
+import org.gradle.api.model.ObjectFactory
 import org.gradle.api.plugins.JavaBasePlugin
 import org.gradle.api.plugins.JavaPlugin
 import org.gradle.api.plugins.JavaPluginExtension
@@ -38,13 +39,14 @@ class NebulaFacetPlugin implements Plugin<Project> {
     void apply(Project project) {
         this.project = project
 
+        ObjectFactory objects = project.objects
         extension = container(FacetDefinition, new NamedDomainObjectFactory<FacetDefinition>() {
             @Override
             FacetDefinition create(String name) {
                 if (name.contains('Test')) {
-                    return new TestFacetDefinition(name)
+                    return objects.newInstance(TestFacetDefinition, name)
                 } else {
-                    return new FacetDefinition(name)
+                    return objects.newInstance(FacetDefinition, name)
                 }
             }
         })
@@ -58,7 +60,7 @@ class NebulaFacetPlugin implements Plugin<Project> {
 
 
                 SourceSetContainer sourceSets = SourceSetUtils.getSourceSets(project)
-                sourceSets.matching { SourceSet sourceSet -> sourceSet.name == facet.parentSourceSet }.all { SourceSet parentSourceSet ->
+                sourceSets.matching { SourceSet sourceSet -> sourceSet.name == facet.parentSourceSet.get() }.all { SourceSet parentSourceSet ->
 
                     // Since we're using NamedContainerProperOrder, we're configured already.
                     SourceSet sourceSet = createSourceSet(parentSourceSet, facet)
@@ -76,17 +78,17 @@ class NebulaFacetPlugin implements Plugin<Project> {
                     project.configurations.getByName(sourceSet.annotationProcessorConfigurationName).extendsFrom(annotationProcessor)
 
                     // Make sure at the classes get built as part of build
-                    project.tasks.named('build').configure(new Action<Task>() {
+                    project.tasks.named('build', new Action<Task>() {
                         @Override
                         void execute(Task buildTask) {
                             buildTask.dependsOn(sourceSet.classesTaskName)
                         }
                     })
 
                     if (facet instanceof TestFacetDefinition) {
-                        TaskProvider<Test> testTask = createTestTask(facet.testTaskName.toString(), sourceSet)
-                        if (facet.includeInCheckLifecycle) {
-                            project.tasks.named('check') configure(new Action<Task>() {
+                        TaskProvider<Test> testTask = createTestTask(facet.testTaskName.get(), sourceSet)
+                        if (facet.includeInCheckLifecycle.get()) {
+                            project.tasks.named('check', new Action<Task>() {
                                 @Override
                                 void execute(Task checkTask) {
                                     checkTask.dependsOn(testTask)
@@ -197,7 +199,7 @@ class NebulaFacetPlugin implements Plugin<Project> {
      * @return the created and configured test facet
      */
     TestFacetDefinition createTestFacet(String name, Action<? super TestFacetDefinition> configureAction) {
-        TestFacetDefinition facet = new TestFacetDefinition(name)
+        TestFacetDefinition facet = project.objects.newInstance(TestFacetDefinition, name)
         configureAction.execute(facet)
         extension.add(facet)
         return facet
@@ -210,7 +212,7 @@ class NebulaFacetPlugin implements Plugin<Project> {
      * @return the created test facet
      */
     TestFacetDefinition createTestFacet(String name) {
-        TestFacetDefinition facet = new TestFacetDefinition(name)
+        TestFacetDefinition facet = project.objects.newInstance(TestFacetDefinition, name)
         extension.add(facet)
         return facet
     }
@@ -223,7 +225,7 @@ class NebulaFacetPlugin implements Plugin<Project> {
      * @return the created and configured facet
      */
     FacetDefinition createFacet(String name, Action<? super FacetDefinition> configureAction) {
-        FacetDefinition facet = new FacetDefinition(name)
+        FacetDefinition facet = project.objects.newInstance(FacetDefinition, name)
         configureAction.execute(facet)
         extension.add(facet)
         return facet
@@ -236,7 +238,7 @@ class NebulaFacetPlugin implements Plugin<Project> {
      * @return the created facet
      */
     FacetDefinition createFacet(String name) {
-        FacetDefinition facet = new FacetDefinition(name)
+        FacetDefinition facet = project.objects.newInstance(FacetDefinition, name)
         extension.add(facet)
         return facet
     }

src/main/groovy/nebula/plugin/responsible/NebulaIntegTestPlugin.groovy

@@ -27,9 +27,9 @@ class NebulaIntegTestPlugin implements Plugin<Project> {
             facetPlugin.createTestFacet(FACET_NAME, new Action<TestFacetDefinition>() {
                 @Override
                 void execute(TestFacetDefinition facet) {
-                    facet.setTestTaskName(TASK_NAME)
-                    facet.setParentSourceSet(PARENT_SOURCE_SET)
-                    facet.setIncludeInCheckLifecycle(shouldIncludeInCheckLifecycle())
+                    facet.testTaskName.set(TASK_NAME)
+                    facet.parentSourceSet.set(PARENT_SOURCE_SET)
+                    facet.includeInCheckLifecycle.set(shouldIncludeInCheckLifecycle())
                 }
             })
         }

src/main/groovy/nebula/plugin/responsible/TestFacetDefinition.groovy

@@ -1,32 +1,32 @@
 package nebula.plugin.responsible
 
-import groovy.transform.Canonical
 import groovy.transform.CompileStatic
+import org.gradle.api.model.ObjectFactory
+import org.gradle.api.provider.Property
+
+import javax.inject.Inject
 
 /**
  * Definition of a source facet, which via the NebulaFacetPlugin will create
  * a source set and runtime/compile configurations. Name is used for the source
  * directory and the prefix for configurations.
  */
-@Canonical
 @CompileStatic
 class TestFacetDefinition extends FacetDefinition {
-
-    public TestFacetDefinition(String name) {
-        super(name)
-    }
-
     /**
      * Name of the test task that will get created
      */
-    String testTaskName
-
-    String getTestTaskName() {
-        testTaskName ?: getName()
-    }
+    final Property<String> testTaskName
 
     /**
      * Whether the task created for the test facet should be a dependency of 'check'.
      */
-    boolean includeInCheckLifecycle = true
+    final Property<Boolean> includeInCheckLifecycle
+
+    @Inject
+    TestFacetDefinition(String name, ObjectFactory objects) {
+        super(name, objects)
+        this.testTaskName = objects.property(String).convention(name)
+        this.includeInCheckLifecycle = objects.property(Boolean).convention(true)
+    }
 }