Merge pull request #425 from CoreMedia/JENKINS-27368

[JENKINS-27368] made closure parameter optional for factory methods

Author: daspilker

docs/Job-DSL-Commands.md

@@ -7,8 +7,7 @@ methods imply the creation of a Jenkins item and the closure to the method can b
 The only mandatory option is the item's name.
 
 ```groovy
-job('my-job') {
-}
+job('my-job')
 ```
 
 When defining jobs, views or folders the name is treated as absolute to the Jenkins root by default, but the seed job
@@ -38,26 +37,25 @@ need.)
 The DSL exposes several methods to create jobs of different types.
 
 ```groovy
-job(String name, Closure closure)          // since 1.30, an alias for freeStyleJob
+job(String name, Closure closure = null)          // since 1.30, an alias for freeStyleJob
 
-freeStyleJob(String name, Closure closure) // since 1.30
+freeStyleJob(String name, Closure closure = null) // since 1.30
 
-buildFlowJob(String name, Closure closure) // since 1.30
+buildFlowJob(String name, Closure closure = null) // since 1.30
 
-matrixJob(String name, Closure closure)    // since 1.30
+matrixJob(String name, Closure closure = null)    // since 1.30
 
-mavenJob(String name, Closure closure)     // since 1.30
+mavenJob(String name, Closure closure = null)     // since 1.30
 
-multiJob(String name, Closure closure)     // since 1.30
+multiJob(String name, Closure closure = null)     // since 1.30
 
-workflowJob(String name, Closure closure)  // since 1.30
+workflowJob(String name, Closure closure = null)  // since 1.30
 ```
 
 These methods will return a job object that can be re-used and passed around. E.g.
 
 ```groovy
-def myJob = freeStyleJob('SimpleJob') {
-}
+def myJob = freeStyleJob('SimpleJob')
 myJob.with {
     description 'A Simple Job'
 }
@@ -78,17 +76,17 @@ job(Map<String, ?> arguments = [:], Closure closure) // deprecated since 1.30
 To create views, the DSL provides the following methods.
 
 ```groovy
-listView(String name, Closure closure)             // since 1.30
+listView(String name, Closure closure = null)             // since 1.30
 
-sectionedView(String name, Closure closure)        // since 1.30
+sectionedView(String name, Closure closure = null)        // since 1.30
 
-nestedView(String name, Closure closure)           // since 1.30
+nestedView(String name, Closure closure = null)           // since 1.30
 
-deliveryPipelineView(String name, Closure closure) // since 1.30
+deliveryPipelineView(String name, Closure closure = null) // since 1.30
 
-buildPipelineView(String name, Closure closure)    // since 1.30
+buildPipelineView(String name, Closure closure = null)    // since 1.30
 
-buildMonitorView(String name, Closure closure)     // since 1.30
+buildMonitorView(String name, Closure closure = null)     // since 1.30
 ```
 
 The view methods behaves like the [job](#job) methods and will return a view object.
@@ -129,24 +127,20 @@ Folders will be created before jobs and views to ensure that a folder exists bef
 
 ```groovy
 folder('project-a') {
-  displayName 'Project A'
+  displayName('Project A')
 }
 ```
 
 Items can be created within folders by using the full path as job name.
 
 ```groovy
-folder('project-a') {
-}
+folder('project-a')
 
-freeStyleJob('project-a/compile') {
-}
+freeStyleJob('project-a/compile')
 
-listView('project-a/pipeline') {
-}
+listView('project-a/pipeline')
 
-folder('project-a/testing') {
-}
+folder('project-a/testing')
 ```
 
 # Config File
@@ -155,9 +149,9 @@ When the [Config File Provider Plugin](https://wiki.jenkins-ci.org/display/JENKI
 installed, the DSL can be used to create configuration files.
 
 ```groovy
-customConfigFile(String name, Closure configFileClosure)        // since 1.30
+customConfigFile(String name, Closure configFileClosure = null)        // since 1.30
 
-mavenSettingsConfigFile(String name, Closure configFileClosure) // since 1.30
+mavenSettingsConfigFile(String name, Closure configFileClosure = null) // since 1.30
 ```
 
 These methods behaves like the [job](#job) methods and will return a config file object.
@@ -166,8 +160,8 @@ Config files will be created before jobs to ensure that the file exists before i
 
 ```groovy
 customConfigFile('my-config') {
-  comment 'My important configuration'
-  content '<some-xml/>'
+  comment('My important configuration')
+  content('<some-xml/>')
 }
 
 mavenSettingsConfigFile('central-mirror') {

job-dsl-core/src/main/groovy/javaposse/jobdsl/dsl/DslFactory.groovy

@@ -21,18 +21,32 @@ interface DslFactory {
     @Deprecated
     Job job(Map<String, Object> arguments, @DslContext(Job) Closure closure)
 
+    FreeStyleJob job(String name)
+
     FreeStyleJob job(String name, @DslContext(FreeStyleJob) Closure closure)
 
+    FreeStyleJob freeStyleJob(String name)
+
     FreeStyleJob freeStyleJob(String name, @DslContext(FreeStyleJob) Closure closure)
 
+    BuildFlowJob buildFlowJob(String name)
+
     BuildFlowJob buildFlowJob(String name, @DslContext(BuildFlowJob) Closure closure)
 
+    MatrixJob matrixJob(String name)
+
     MatrixJob matrixJob(String name, @DslContext(MatrixJob) Closure closure)
 
+    MavenJob mavenJob(String name)
+
     MavenJob mavenJob(String name, @DslContext(MavenJob) Closure closure)
 
+    MultiJob multiJob(String name)
+
     MultiJob multiJob(String name, @DslContext(MultiJob) Closure closure)
 
+    WorkflowJob workflowJob(String name)
+
     WorkflowJob workflowJob(String name, @DslContext(WorkflowJob) Closure closure)
 
     @Deprecated
@@ -41,21 +55,35 @@ interface DslFactory {
     @Deprecated
     View view(Map<String, Object> arguments, @DslContext(View) Closure closure)
 
+    ListView listView(String name)
+
     ListView listView(String name, @DslContext(ListView) Closure closure)
 
+    SectionedView sectionedView(String name)
+
     SectionedView sectionedView(String name, @DslContext(SectionedView) Closure closure)
 
+    NestedView nestedView(String name)
+
     NestedView nestedView(String name, @DslContext(NestedView) Closure closure)
 
+    DeliveryPipelineView deliveryPipelineView(String name)
+
     DeliveryPipelineView deliveryPipelineView(String name, @DslContext(DeliveryPipelineView) Closure closure)
 
+    BuildPipelineView buildPipelineView(String name)
+
     BuildPipelineView buildPipelineView(String name, @DslContext(BuildPipelineView) Closure closure)
 
+    BuildMonitorView buildMonitorView(String name)
+
     BuildMonitorView buildMonitorView(String name, @DslContext(BuildMonitorView) Closure closure)
 
     @Deprecated
     Folder folder(@DslContext(Folder) Closure closure)
 
+    Folder folder(String name)
+
     Folder folder(String name, @DslContext(Folder) Closure closure)
 
     @Deprecated
@@ -64,8 +92,12 @@ interface DslFactory {
     @Deprecated
     ConfigFile configFile(Map<String, Object> arguments, @DslContext(ConfigFile) Closure closure)
 
+    ConfigFile customConfigFile(String name)
+
     ConfigFile customConfigFile(String name, @DslContext(ConfigFile) Closure closure)
 
+    ConfigFile mavenSettingsConfigFile(String name)
+
     ConfigFile mavenSettingsConfigFile(String name, @DslContext(ConfigFile) Closure closure)
 
     /**

job-dsl-core/src/main/groovy/javaposse/jobdsl/dsl/JobParent.groovy

@@ -24,45 +24,47 @@ abstract class JobParent extends Script implements DslFactory {
     List<String> queueToBuild = []
 
     @Override
-    FreeStyleJob job(String name, @DslContext(FreeStyleJob) Closure closure) {
+    FreeStyleJob job(String name, @DslContext(FreeStyleJob) Closure closure = null) {
         freeStyleJob(name, closure)
     }
 
     @Override
-    FreeStyleJob freeStyleJob(String name, @DslContext(FreeStyleJob) Closure closure) {
+    FreeStyleJob freeStyleJob(String name, @DslContext(FreeStyleJob) Closure closure = null) {
         processJob(name, FreeStyleJob, closure)
     }
 
     @Override
-    BuildFlowJob buildFlowJob(String name, @DslContext(BuildFlowJob) Closure closure) {
+    BuildFlowJob buildFlowJob(String name, @DslContext(BuildFlowJob) Closure closure = null) {
         processJob(name, BuildFlowJob, closure)
     }
 
     @Override
-    MatrixJob matrixJob(String name, @DslContext(MatrixJob) Closure closure) {
+    MatrixJob matrixJob(String name, @DslContext(MatrixJob) Closure closure = null) {
         processJob(name, MatrixJob, closure)
     }
 
     @Override
-    MavenJob mavenJob(String name, @DslContext(MavenJob) Closure closure) {
+    MavenJob mavenJob(String name, @DslContext(MavenJob) Closure closure = null) {
         processJob(name, MavenJob, closure)
     }
 
     @Override
-    MultiJob multiJob(String name, @DslContext(MultiJob) Closure closure) {
+    MultiJob multiJob(String name, @DslContext(MultiJob) Closure closure = null) {
         processJob(name, MultiJob, closure)
     }
 
     @Override
-    WorkflowJob workflowJob(String name, @DslContext(WorkflowJob) Closure closure) {
+    WorkflowJob workflowJob(String name, @DslContext(WorkflowJob) Closure closure = null) {
         processJob(name, WorkflowJob, closure)
     }
 
     // this method cannot be private due to http://jira.codehaus.org/browse/GROOVY-6263
     protected <T extends Job> T processJob(String name, Class<T> jobClass, Closure closure) {
         T job = jobClass.newInstance(jm)
         job.name = name
-        job.with(closure)
+        if (closure) {
+            job.with(closure)
+        }
         referencedJobs << job
         job
     }
@@ -82,40 +84,42 @@ abstract class JobParent extends Script implements DslFactory {
     }
 
     @Override
-    ListView listView(String name, @DslContext(ListView) Closure closure) {
+    ListView listView(String name, @DslContext(ListView) Closure closure = null) {
         processView(name, ListView, closure)
     }
 
     @Override
-    SectionedView sectionedView(String name, @DslContext(SectionedView) Closure closure) {
+    SectionedView sectionedView(String name, @DslContext(SectionedView) Closure closure = null) {
         processView(name, SectionedView, closure)
     }
 
     @Override
-    NestedView nestedView(String name, @DslContext(NestedView) Closure closure) {
+    NestedView nestedView(String name, @DslContext(NestedView) Closure closure = null) {
         processView(name, NestedView, closure)
     }
 
     @Override
-    DeliveryPipelineView deliveryPipelineView(String name, @DslContext(DeliveryPipelineView) Closure closure) {
+    DeliveryPipelineView deliveryPipelineView(String name, @DslContext(DeliveryPipelineView) Closure closure = null) {
         processView(name, DeliveryPipelineView, closure)
     }
 
     @Override
-    BuildPipelineView buildPipelineView(String name, @DslContext(BuildPipelineView) Closure closure) {
+    BuildPipelineView buildPipelineView(String name, @DslContext(BuildPipelineView) Closure closure = null) {
         processView(name, BuildPipelineView, closure)
     }
 
     @Override
-    BuildMonitorView buildMonitorView(String name, @DslContext(BuildMonitorView) Closure closure) {
+    BuildMonitorView buildMonitorView(String name, @DslContext(BuildMonitorView) Closure closure = null) {
         processView(name, BuildMonitorView, closure)
     }
 
     // this method cannot be private due to http://jira.codehaus.org/browse/GROOVY-6263
     protected <T extends View> T processView(String name, Class<T> viewClass, Closure closure) {
         T view = viewClass.newInstance(jm)
         view.name = name
-        view.with(closure)
+        if (closure) {
+            view.with(closure)
+        }
         referencedViews << view
         view
     }
@@ -145,21 +149,23 @@ abstract class JobParent extends Script implements DslFactory {
     }
 
     @Override
-    Folder folder(String name, @DslContext(Folder) Closure closure) {
+    Folder folder(String name, @DslContext(Folder) Closure closure = null) {
         Preconditions.checkArgument(!Strings.isNullOrEmpty(name), 'name must be specified')
 
         Folder folder = new Folder(jm)
         folder.name = name
-        folder.with(closure)
+        if (closure) {
+            folder.with(closure)
+        }
         referencedJobs << folder
         folder
     }
 
-    ConfigFile customConfigFile(String name, @DslContext(ConfigFile) Closure closure) {
+    ConfigFile customConfigFile(String name, @DslContext(ConfigFile) Closure closure = null) {
         processConfigFile(name, ConfigFileType.Custom, closure)
     }
 
-    ConfigFile mavenSettingsConfigFile(String name, @DslContext(ConfigFile) Closure closure) {
+    ConfigFile mavenSettingsConfigFile(String name, @DslContext(ConfigFile) Closure closure = null) {
         processConfigFile(name, ConfigFileType.MavenSettings, closure)
     }
 
@@ -180,7 +186,9 @@ abstract class JobParent extends Script implements DslFactory {
     protected ConfigFile processConfigFile(String name, ConfigFileType configFileType, Closure closure) {
         ConfigFile configFile = new ConfigFile(configFileType, jm)
         configFile.name = name
-        configFile.with(closure)
+        if (closure) {
+            configFile.with(closure)
+        }
         referencedConfigFiles << configFile
         configFile
     }