org.disl.util.doc.DocGenerator.groovy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of disl Show documentation
disl = data integration specific language. Goal of this project is to implement groovy based domain specific language supporting modelling of data integration projects. Disl will support data modeling and data mapping including support for MDA transformations and unit testing.
There is a newer version: 1.1.2
Show newest version
/*
 * Copyright 2015 - 2016 Karel H?bl .
 *
 * This file is part of disl.
 *
 * Disl is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Disl is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Disl.  If not, see .
 */
package org.disl.util.doc

import groovy.util.logging.Slf4j

import org.disl.meta.Base
import org.disl.meta.Lookup
import org.disl.meta.Mapping
import org.disl.meta.Table
import org.disl.util.doc.IDocumentationStep.IJobDocumentationStep
import org.disl.util.doc.IDocumentationStep.ILineageStep
import org.disl.util.doc.IDocumentationStep.ILookupDocumentationStep
import org.disl.util.doc.IDocumentationStep.IMappingDocumentationStep
import org.disl.util.doc.IDocumentationStep.IPackageDocumentationStep
import org.disl.util.doc.IDocumentationStep.ITableDocumentationStep
import org.disl.util.doc.step.DefaultAllElementsFrame
import org.disl.util.doc.step.DefaultCssStep
import org.disl.util.doc.step.DefaultIndexStep
import org.disl.util.doc.step.DefaultJobDocumentationStep
import org.disl.util.doc.step.DefaultLineageStep
import org.disl.util.doc.step.DefaultLookupDocumentationStep
import org.disl.util.doc.step.DefaultMappingDocumentationStep
import org.disl.util.doc.step.DefaultOverviewFrameStep
import org.disl.util.doc.step.DefaultOverviewSummaryStep
import org.disl.util.doc.step.DefaultPackageFrameStep
import org.disl.util.doc.step.DefaultPackageSummaryStep
import org.disl.util.doc.step.DefaultTableDocumentationStep
import org.disl.workflow.Job

@Slf4j
class DocGenerator {
	String outputFolder='build/docs/disldoc'
	MetaManager metaManager=new MetaManager()

	IDocumentationStep indexStep=new DefaultIndexStep(docGenerator:this)
	IDocumentationStep cssStep=new DefaultCssStep(docGenerator:this)
	IDocumentationStep allElementsStep=new DefaultAllElementsFrame(docGenerator:this)
	IDocumentationStep overviewFrameStep=new DefaultOverviewFrameStep(docGenerator:this)
	IDocumentationStep overviewSummaryStep=new DefaultOverviewSummaryStep(docGenerator:this)
	ITableDocumentationStep tableDocumentationStep=new DefaultTableDocumentationStep(docGenerator:this)
	IMappingDocumentationStep mappingDocumentationStep=new DefaultMappingDocumentationStep(docGenerator:this)
	ILookupDocumentationStep lookupDocumentationStep=new DefaultLookupDocumentationStep(docGenerator:this)
	IPackageDocumentationStep packageFrameStep=new DefaultPackageFrameStep(docGenerator:this)
	IPackageDocumentationStep packageSummaryStep=new DefaultPackageSummaryStep(docGenerator:this)
	IJobDocumentationStep jobDocumentationStep=new DefaultJobDocumentationStep(docGenerator:this)
	ILineageStep lineageStep=new DefaultLineageStep(docGenerator:this)


	static String link(Base base,String urlPrefix='') {
		link(base.class.name,urlPrefix)
	}

	static String link(String baseClassName,String urlPrefix='') {
		"${MetaManager.getElementName(baseClassName)}"
	}

	void addRootPackage(String rootPackage) {
		metaManager.addRootPackage(rootPackage)
	}

	public void generate() {
		clean()
		org.codehaus.groovy.runtime.NullObject.metaClass.toString = {return ''}
		metaManager.process({generate(it)})
		generatePackages()
		generateLineage()
		indexStep.execute()
		cssStep.execute()
		allElementsStep.execute()
		overviewFrameStep.execute()
		overviewSummaryStep.execute()
	}

	void clean() {
		new File(getOutputFolder()).deleteDir()
	}

	protected void generate(Table table) {
		tableDocumentationStep.setTable(table)
		tableDocumentationStep.execute()
		generateEmptyLineage(table)
	}

	protected void generate(Mapping mapping) {
		mappingDocumentationStep.setMapping(mapping)
		mappingDocumentationStep.execute()
		generateEmptyLineage(mapping)
	}

	protected void generate(Lookup lookup) {
		lookupDocumentationStep.setLookup(lookup)
		lookupDocumentationStep.execute()
		generateEmptyLineage(lookup)
	}

	protected void generate(Job job) {
		jobDocumentationStep.setJob(job)
		jobDocumentationStep.execute()
		generateEmptyLineage(job)
	}
	
	protected void generateEmptyLineage(Base base) {
		new File(outputFolder,"model/${base.class.name}-lineage.html").createNewFile()
	}
	
	protected void generate(Base source) {
		log.warn("No documentation generated for ${source.class.name}.")
	}

	protected void generatePackages() {
		metaManager.packageContent.keySet().each {
			packageFrameStep.setPackageName(it)
			packageFrameStep.execute()
			packageSummaryStep.setPackageName(it)
			packageSummaryStep.execute()
		}
	}
	
	/**
	 * Generate lineage. Overwrite default empty lineage.
	 * */
	protected void generateLineage() {
		Set lineageElements=new HashSet()
		lineageElements.addAll(metaManager.sourceUsage.keySet())
		lineageElements.addAll(metaManager.targetUsage.keySet())
		lineageElements.each {
			lineageStep.setElementClassName(it)
			lineageStep.execute()
		}
		
	}
}