docs: add configuration metadata reference

.gitignore

@@ -14,4 +14,5 @@ out
 atlassian-ide-plugin.xml
 plugin-ui/plugin/src/main/templates/views/*
 !etc/bin
-etc/bin/results
+etc/bin/results
+plugin-core/docs/src/docs/configurationProperties.adoc

docs/build.gradle

@@ -128,6 +128,7 @@ ext {
 }
 
 tasks.named('asciidoctor', AsciidoctorTask) {
+    dependsOn(':core-docs:generateConfigurationProperties')
     sourceDir(layout.projectDirectory.file('src/docs'))
     sources { include('index.adoc') }
     outputDir = layout.buildDirectory.file('docs')

docs/src/docs/index.adoc

@@ -89,6 +89,8 @@ include::{core-docs-dir}/voters.adoc[leveloffset=+1]
 
 include::{core-docs-dir}/miscProperties.adoc[leveloffset=+1]
 
+include::{core-docs-dir}/configurationProperties.adoc[leveloffset=+1]
+
 include::{core-docs-dir}/tutorials.adoc[leveloffset=+1]
 
 include::{core-docs-dir}/examples.adoc[leveloffset=+1]

gradle/rat-root-config.gradle

@@ -52,6 +52,7 @@ tasks.named('rat') {
             'plugin-ui/plugin/grails-app/assets/stylesheets/jquery.jdMenu.css', // See license file, MIT licensed
             'plugin-ui/plugin/grails-app/assets/stylesheets/jquery.jdMenu.slate.css', // See license file, MIT licensed
             'plugin-ui/plugin/src/main/templates/**', // template files that people are expected to use in the end application
+            '**/spring-configuration-metadata.json', // JSON files cannot contain license headers
     ]
     // never cache license audits
     outputs.upToDateWhen { false }

plugin-core/docs/build.gradle

@@ -17,6 +17,8 @@
  *  under the License.
  */
 
+import groovy.json.JsonSlurper
+
 plugins {
     id 'groovy' // For groovydoc task
 }
@@ -37,3 +39,101 @@ tasks.withType(Groovydoc).configureEach {
     it.destinationDir = rootProject.layout.buildDirectory.dir('docs/core-plugin/groovydoc').get().asFile
 }
 
+def configurationMetadataFile = rootProject.layout.projectDirectory.file(
+        'plugin-core/plugin/src/main/resources/META-INF/spring-configuration-metadata.json'
+)
+def configurationPropertiesFile = layout.projectDirectory.file('src/docs/configurationProperties.adoc')
+
+tasks.register('generateConfigurationProperties') {
+    inputs.file(configurationMetadataFile)
+    outputs.file(configurationPropertiesFile)
+    doLast {
+        def metadata = new JsonSlurper().parse(configurationMetadataFile.asFile)
+        def groupsByName = (metadata.groups ?: []).collectEntries { group ->
+            [(group.name): group]
+        }
+        def propertiesByGroup = (metadata.properties ?: []).groupBy { property ->
+            property.group ?: 'grails.plugin.springsecurity.miscellaneous'
+        }
+        def orderedGroupNames = [
+                'grails.plugin.springsecurity.general',
+                'grails.plugin.springsecurity.domain-classes',
+                'grails.plugin.springsecurity.authentication',
+                'grails.plugin.springsecurity.login-logout',
+                'grails.plugin.springsecurity.password-encoding',
+                'grails.plugin.springsecurity.remember-me',
+                'grails.plugin.springsecurity.session',
+                'grails.plugin.springsecurity.url-mapping',
+                'grails.plugin.springsecurity.basic-digest-auth',
+                'grails.plugin.springsecurity.switch-user',
+                'grails.plugin.springsecurity.port-channel',
+                'grails.plugin.springsecurity.x509',
+                'grails.plugin.springsecurity.miscellaneous'
+        ]
+
+        configurationPropertiesFile.asFile.text = ''
+        configurationPropertiesFile.asFile << '''////
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+////
+
+[[configuration-properties]]
+== Configuration Properties
+
+This page is generated from `spring-configuration-metadata.json`. For IDE auto-completion of these properties, ensure the plugin JAR is on your classpath.
+'''
+
+        orderedGroupNames.each { groupName ->
+            def group = groupsByName[groupName]
+            def properties = propertiesByGroup[groupName] ?: []
+            if (!properties) {
+                return
+            }
+
+            def heading = group?.description ?: groupName
+            configurationPropertiesFile.asFile << """
+
+=== ${heading}
+
+[cols=\"3,5,2\", options=\"header\"]
+|===
+|Property |Description |Default
+"""
+
+            properties.sort { it.name }.each { property ->
+                def defaultValue = property.containsKey('defaultValue') ? property.defaultValue : ''
+                def defaultText
+                if (defaultValue == null) {
+                    defaultText = '-'
+                } else if (defaultValue instanceof CharSequence && defaultValue.toString().isEmpty()) {
+                    defaultText = '`""`'
+                } else if (defaultValue instanceof List && ((List) defaultValue).isEmpty()) {
+                    defaultText = '`[]`'
+                } else {
+                    defaultText = "`${defaultValue}`"
+                }
+                configurationPropertiesFile.asFile << """
+|`${property.name}`
+|${property.description}
+|${defaultText}
+"""
+            }
+
+            configurationPropertiesFile.asFile << """
+|===
+"""
+        }
+    }
+}

plugin-core/docs/src/docs/index.adoc

@@ -67,6 +67,8 @@ include::voters.adoc[]
 
 include::miscProperties.adoc[]
 
+include::configurationProperties.adoc[]
+
 include::tutorials.adoc[]
 
 include::examples.adoc[]