jan@66: "{ Package: 'stx:goodies/builder/reports' }"
jan@66: 
jan@66: "{ NameSpace: Builder }"
jan@66: 
jan@66: ReportFormat subclass:#LintReportFormat
jan@66: 	instanceVariableNames:''
jan@66: 	classVariableNames:''
jan@66: 	poolDictionaries:''
jan@66: 	category:'Builder-Reports-Formats'
jan@66: !
jan@66: 
jan@66: LintReportFormat subclass:#CheckStyle
jan@66: 	instanceVariableNames:''
jan@66: 	classVariableNames:''
jan@66: 	poolDictionaries:''
jan@66: 	privateIn:LintReportFormat
jan@66: !
jan@66: 
jan@66: LintReportFormat subclass:#PMD
jan@66: 	instanceVariableNames:''
jan@66: 	classVariableNames:''
jan@66: 	poolDictionaries:''
jan@66: 	privateIn:LintReportFormat
jan@66: !
jan@66: 
jan@66: 
jan@66: !LintReportFormat class methodsFor:'testing'!
jan@66: 
jan@66: isAbstract
jan@66: 
jan@66:     ^self == LintReportFormat
jan@66: 
jan@66:     "Created: / 04-08-2011 / 11:44:25 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@66: ! !
jan@66: 
jan@253: !LintReportFormat methodsFor:'writing'!
jan@253: 
jan@266: writeFile: filename with: block
jan@266: 
jan@266:     "Writes a section for given file"
jan@253: 
jan@266:     stream tab; nextPutAll:'<file name="'; nextPutAll:filename; nextPutAll: '">'; cr.
jan@266:     block valueWithOptionalArgument: self.
jan@266:     stream tab; nextPutAll:'</file>'; cr.
jan@266: 
jan@266:     "Created: / 07-10-2011 / 10:40:25 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@253: ! !
jan@253: 
jan@66: !LintReportFormat::CheckStyle class methodsFor:'accessing'!
jan@66: 
jan@66: symbolicNames
jan@66:     "Returns a collection of symbolic names for this format"
jan@66: 
jan@66:     ^#(checkstyle)
jan@66: 
jan@66:     "Modified: / 04-08-2011 / 14:23:52 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@66: ! !
jan@66: 
jan@66: !LintReportFormat::CheckStyle methodsFor:'accessing - defaults'!
jan@66: 
jan@66: defaultFileSuffix
jan@66: 
jan@66:     ^ 'xml'
jan@66: 
jan@66:     "Modified: / 08-10-2011 / 10:47:53 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@66: ! !
jan@66: 
jan@66: !LintReportFormat::CheckStyle methodsFor:'writing'!
jan@66: 
jan@66: writeFile: filename with: block
jan@66: 
jan@66:     "Writes a section for given file"
jan@66: 
jan@66:     stream tab; nextPutAll:'<file name="'; nextPutAll:filename; nextPutAll: '">'; cr.
jan@66:     block valueWithOptionalArgument: self.
jan@66:     stream tab; nextPutAll:'</file>'; cr.
jan@66: 
jan@66:     "Created: / 07-10-2011 / 10:40:25 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@66: !
jan@66: 
jan@66: writeFooter
jan@66: 
jan@66:     stream nextPutAll: '</checkstyle>'
jan@66: 
jan@66:     "Modified: / 04-08-2011 / 14:42:28 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@66: !
jan@66: 
jan@66: writeHeader
jan@66: 
jan@66:     stream nextPutAll: '<?xml version="1.0" encoding="UTF-8"?>'; nextPut: Character lf.
jan@66:     stream nextPutAll: '<checkstyle version="5.4">'; nextPut: Character lf.
jan@66: 
jan@66:     "Modified: / 06-10-2011 / 23:50:56 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@66: !
jan@66: 
jan@66: writeViolation:rule class: aClass selector: aSelector startLine:line column:column stopLine:lineStop column:columnStop
jan@66: 
jan@66:     | severity |
jan@66: 
jan@66:     rule severity = #information ifTrue:[
jan@66:         severity := 'info'
jan@66:     ] ifFalse:[
jan@66:         rule severity = #warning ifTrue:[
jan@66:             severity := 'warning'
jan@66:         ] ifFalse:[
jan@66:             severity := 'error'
jan@66:         ]
jan@66:     ].
jan@66: 
jan@66:     stream tab; tab; nextPutAll:'<error'.
jan@66:     stream nextPutAll:' source="'; nextPutAll:(self encode:rule class name); nextPut:$".
jan@66:     stream nextPutAll:' message="'; nextPutAll:(self encode:rule name ); nextPut:$".
jan@66: 
jan@66:     stream nextPutAll:' severity="'; nextPutAll: severity; nextPut:$".
jan@66:     stream nextPutAll:' line="'; nextPutAll:line printString; nextPut:$".
jan@66:     column <= 1 ifFalse:[
jan@66:         stream nextPutAll:' column="'; nextPutAll:column printString; nextPut:$"
jan@66:     ].
jan@66:     stream nextPutAll:'/>'; cr.
jan@66: 
jan@66:     "Created: / 25-11-2011 / 22:23:44 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@66: ! !
jan@66: 
jan@66: !LintReportFormat::PMD methodsFor:'accessing - defaults'!
jan@66: 
jan@66: defaultFileSuffix
jan@66: 
jan@66:     ^ 'xml'
jan@66: 
jan@66:     "Modified: / 08-10-2011 / 10:47:53 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@66: ! !
jan@66: 
jan@66: !LintReportFormat::PMD methodsFor:'writing'!
jan@66: 
jan@66: writeFooter
jan@66: 
jan@66:     stream nextPutAll: '</pmd>'
jan@66: 
jan@66:     "Modified: / 25-11-2011 / 19:38:07 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@66: !
jan@66: 
jan@66: writeHeader
jan@66: 
jan@66:     stream nextPutAll: '<?xml version="1.0" encoding="UTF-8"?>'; nextPut: Character lf.
jan@66:     stream 
jan@66:         nextPutAll: '<pmd version="4.3" timestamp="'; 
jan@66:         nextPutAll: Timestamp now printString;
jan@66:         nextPutAll:'">';
jan@66:         nextPut: Character lf.
jan@66: 
jan@66:     "Modified: / 25-11-2011 / 19:39:09 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@66: !
jan@66: 
jan@66: writeViolation:rule class: aClass selector: aSelector startLine:beginLine column:beginColumn stopLine:endLine column:endColumn
jan@66: 
jan@66:     | priority |
jan@66: 
jan@66:     rule severity = #information ifTrue:[
jan@66:         priority := '1'
jan@66:     ] ifFalse:[
jan@66:         rule severity = #warning ifTrue:[
jan@66:             priority := '2'
jan@66:         ] ifFalse:[
jan@66:             priority := '3'
jan@66:         ]
jan@66:     ].
jan@66: 
jan@66:     stream nextPutAll:'<violation '.
jan@66: 
jan@66:     stream nextPutAll:'beginline="';nextPutAll: beginLine printString; nextPut:$"; cr.
jan@66:     stream nextPutAll:'begincolumn="';nextPutAll: beginColumn printString; nextPut:$"; cr.
jan@66:     stream nextPutAll:'endline="';nextPutAll: endLine printString; nextPut:$"; cr.
jan@66:     stream nextPutAll:'endcolumn="';nextPutAll: endColumn printString; nextPut:$"; cr.
jan@66: 
jan@66:     stream nextPutAll:'rule="';nextPutAll: (self encode:rule class name); nextPut:$"; cr.
jan@66:     stream nextPutAll:'ruleset="';nextPutAll: (self encode:rule group); nextPut:$"; cr.
jan@66: 
jan@66:     stream nextPutAll:'package="';nextPutAll: aClass package; nextPut:$"; cr.
jan@66:     stream nextPutAll:'class="';nextPutAll: aClass name; nextPut:$"; cr.
jan@66: 
jan@66:     aSelector notNil ifTrue:[
jan@66:         stream nextPutAll:'method="';nextPutAll: aSelector; nextPut:$"; cr.
jan@66:     ].
jan@66: 
jan@66:     stream nextPutAll:'><!![CDATA['; cr.
jan@66:     stream nextPutAll: (self encode: rule rationale); cr.
jan@66:     stream nextPutAll:']]></violation>'; cr; cr.
jan@66:     stream flush.
jan@66: 
jan@66:     "Created: / 25-11-2011 / 22:28:34 / Jan Vrany <jan.vrany@fit.cvut.cz>"
jan@66: ! !
jan@66: 
jan@66: !LintReportFormat class methodsFor:'documentation'!
jan@66: 
jan@66: version
jan@66:     ^ '$Header$'
jan@66: !
jan@66: 
jan@66: version_CVS
jan@66:     ^ '$Header$'
jan@66: !
jan@66: 
jan@66: version_SVN
jan@253:     ^ '$Id$'
jan@66: ! !
jan@253: