[JENKINS-31830] Added support for flog publisher as part of the RubyM…

…etrics Reports Plugin
jenkinsci · Dec 1, 2015 · 922a7e4 · 922a7e4
1 parent 0abcdd9
commit 922a7e4
Show file tree

Hide file tree

Showing 4 changed files with 86 additions and 0 deletions.
diff --git a/...rc/main/docs/examples/javaposse/jobdsl/dsl/helpers/publisher/PublisherContext/flog.groovy b/...rc/main/docs/examples/javaposse/jobdsl/dsl/helpers/publisher/PublisherContext/flog.groovy
@@ -0,0 +1,7 @@
+job('example') {
+    publishers {
+        flog {
+            rubyDirectories('folder')
+        }
+    }
+}
diff --git a/job-dsl-core/src/main/groovy/javaposse/jobdsl/dsl/helpers/publisher/FlogContext.groovy b/job-dsl-core/src/main/groovy/javaposse/jobdsl/dsl/helpers/publisher/FlogContext.groovy
@@ -0,0 +1,14 @@
+package javaposse.jobdsl.dsl.helpers.publisher
+
+import javaposse.jobdsl.dsl.Context
+
+class FlogContext implements Context {
+    String rubyDirectories
+
+    /**
+     * Specifies the ruby directories to monitorize with Flog, relative to the workspace.
+     */
+    void rubyDirectories(String rubyDirectories) {
+        this.rubyDirectories = rubyDirectories
+    }
+}
diff --git a/job-dsl-core/src/main/groovy/javaposse/jobdsl/dsl/helpers/publisher/PublisherContext.groovy b/job-dsl-core/src/main/groovy/javaposse/jobdsl/dsl/helpers/publisher/PublisherContext.groovy
@@ -1738,6 +1738,30 @@ class PublisherContext extends AbstractExtensibleContext {
         }
     }
 
+    /*
+     * Measures code complexity.
+     *
+     * @since 1.41
+     */
+    @RequiresPlugin(id = 'rubyMetrics', minimumVersion = '1.6.3')
+    void flog(@DslContext(FlogContext) Closure closure) {
+        FlogContext context = new FlogContext()
+        ContextHelper.executeInContext(closure, context)
+
+        publisherNodes << new NodeBuilder().'hudson.plugins.rubyMetrics.flog.FlogPublisher' {
+            rbDirectories(context.rubyDirectories ?: '')
+            splittedDirectories {
+                if (context.rubyDirectories != null) {
+                    context.rubyDirectories.split().each {
+                        delegate.string(it)
+                    }
+                } else {
+                    delegate.string(context.rubyDirectories ?: '.')
+                }
+            }
+        }
+    }
+
     @SuppressWarnings('NoDef')
     private static addStaticAnalysisContext(def nodeBuilder, StaticAnalysisContext context) {
         nodeBuilder.with {

diff --git a/...l-core/src/test/groovy/javaposse/jobdsl/dsl/helpers/publisher/PublisherContextSpec.groovy b/...l-core/src/test/groovy/javaposse/jobdsl/dsl/helpers/publisher/PublisherContextSpec.groovy
@@ -5175,4 +5175,45 @@ class PublisherContextSpec extends Specification {
         where:
         value << [true, false]
     }
+
+    def 'call flog with no options'() {
+        when:
+        context.flog {
+        }
+
+        then:
+        context.publisherNodes.size() == 1
+        with(context.publisherNodes[0]) {
+            name() == 'hudson.plugins.rubyMetrics.flog.FlogPublisher'
+            children().size() == 2
+            rbDirectories[0].value().empty
+            with(splittedDirectories[0]) {
+                children().size() == 1
+                string[0].value() == '.'
+            }
+        }
+        1 * jobManagement.requireMinimumPluginVersion('rubyMetrics', '1.6.3')
+    }
+
+    def 'call flog with all options'() {
+        when:
+        context.flog {
+            rubyDirectories('a b c')
+        }
+
+        then:
+        context.publisherNodes.size() == 1
+        with(context.publisherNodes[0]) {
+            name() == 'hudson.plugins.rubyMetrics.flog.FlogPublisher'
+            children().size() == 2
+            rbDirectories[0].value() == 'a b c'
+            with(splittedDirectories[0]) {
+                children().size() == 3
+                string[0].value() == 'a'
+                string[1].value() == 'b'
+                string[2].value() == 'c'
+            }
+        }
+        1 * jobManagement.requireMinimumPluginVersion('rubyMetrics', '1.6.3')
+    }
 }