grails-scaffold-core

Plugin makes possible to scaffold everything.

Core functionality for scaffolding tempates in /src/groovy/scaffold/ or templates provided by plugin. e.g. grails-scaffold-angular

Usage

grails create-demo

Generates everything in src/templates/scaffold directory.

Architecture

Plugins templates are should be in directory src\templates\scaffold\

Then comes "package" name. With that you can configure generated content location.

Template folder: src\templates\scaffold\backendSrc\

Scaffolding is generated in src folder with config: folders = ['backendSrc':'src/']

In every "package" folders there should be static and dynamic folder

static - Static files that are not treated as templates (images, js plugins, css). Static files are generated only once if ignoreStatic = true is set

dynamic - Every file in there is treated as template file.

Full path examples

src\templates\scaffold\backend\static\grails-app\config\SomeOtherConfig.groovy 

src\templates\scaffold\backend\dynamic\src\groovy\__packageName__\__shortName__Controller.groovy

src\templates\scaffold\backend\dynamic\grails-app\controllers\__packageName__\__shortName__Controller.groovy 

src\templates\scaffold\backend\dynamic\grails-app\conf\__Bootstrap.groovy

Generated for every domain class

In every "dynamic" folder there can be folders: e.g: foo.bar.someDomainObject

__propertyName__ - someDomainObject/
__shortName__ - SomeDomainObject/
__packageName__ - foo/bar/ In every "dynamic" folder there can be files:
__propertyName__Service.groovy - someDomainObjectService.groovy
__shortName__Service.groovy - SomeDomainObjectService.groovy
__packageName__ - don't use in filenames

Other examples:

src\templates\scaffold\\dynamic\controllers\__packageName__\__shortName__Controller.groovy
src\templates\scaffold\dynamic\conf\__Bootstrap.groovy
src\templates\scaffold\dynamic\conf\CustomMarshallerRegistrar.groovy

Generated only once

SomeFile.someextentsion - every file is generated with original name and extension
__Bootstrap.groovy - Partial file that adds content to existing file. File content is Map[ regex: closure ] . regex - place where content is added.

Properties in templates

pluginManager - GrailsPluginManager
comparator - DomainClassPropertyComparator.class
config - grailsApplication.config
domainClasses- excludedDomainClasses
allDomainClasses- grailsApplication.domainClasses
scaffoldingHelper - look ScaffoldingHelper.groovy
appName - grailsApplication.metadata['app.name'].capitalize().replace(" ", "")
appUrl - serverURL | 'localhost:8080/'+metadata['app.name']

+Templates that are generated for every domain class

domainClass - GrailsDomainClass
packageName - domainClass.packageName
className - domainClass.shortName
propertyName - domainClass.propertyName

For partials there are CoreTemplateGenerator properties

ignoreFileNames - grails.plugin.scaffold.core.ignoreFileNames
ignoreDomainNames - grails.plugin.scaffold.core.ignoreFileNames
ignoreStatic - grails.plugin.scaffold.core.ignoreStatic
grailsApplication - grailsApplication
pluginManager - GrailsPluginManager
excludedDomainClasses - domainClasses - ignoreDomainNames
scaffoldingHelper - ScaffoldingHelper.groovy

Config

grails{
    plugin{
        scaffold{
            core{
                overwrite = true // false = Ask before replacing file
                // Map of domain class names. contains list of maps
                displayNames = ['Division':['name':null], 'User':['group':['name']]]
                folders = ['backendSrc':'src/', 'backendTests':'test/', 'backendGrailsApp':'grails-app/', 'frontend':'angular/']
                // don't generate files or menu for domains
                ignoreDomainNames = []
                ignoreFileNames = ['TestDataGeneratorService.groovy', 'TestDataConfig.groovy']
                ignoreStatic = true
            }
        }
    }
}

Developing new plugin

Lines to be added to Scaffold*GrailsPlugin

def dependsOn = [scaffoldCore: "0.1"]

def doWithSpring = {
    templatesLocator(grails.plugin.scaffold.core.DefaultTemplatesLocator, "%%pluginName%%")
}

And add templates to /src/templates/scaffold

Misc problems

Reloading does not work when plugin is included like:

grails.plugin.location.'scaffold-angular' = "../grails-scaffold-angular"

Better use folder syncer (e.g DirSync Pro). Plugin development dir:

grails-scaffold-angular\src\templates\ => app_dir/target\plugins\scaffold-angular-0.3\src\templates\

burtbeckwith / grails-scaffold-core Goto Github PK