reports/stx_goodies_builder_reports.st
author Claus Gittinger <cg@exept.de>
Thu, 28 Mar 2019 13:54:38 +0100
changeset 542 aa25a71be62a
parent 289 258f98c24a4e
child 295 4dd4d4b67e42
permissions -rw-r--r--
#DOCUMENTATION by cg
class: stx_goodies_builder_quickSelfTest
class definition

class: stx_goodies_builder_quickSelfTest class
added:18 methods
     1 "{ Package: 'stx:goodies/builder/reports' }"
     2 
     3 "{ NameSpace: Smalltalk }"
     4 
     5 LibraryDefinition subclass:#stx_goodies_builder_reports
     6 	instanceVariableNames:''
     7 	classVariableNames:''
     8 	poolDictionaries:''
     9 	category:'* Projects & Packages *'
    10 !
    11 
    12 
    13 !stx_goodies_builder_reports class methodsFor:'description'!
    14 
    15 excludedFromPreRequisites
    16     "list all packages which should be ignored in the automatic
    17      preRequisites scan. See #preRequisites for more."
    18 
    19     ^ #(
    20         #'stx:goodies/monticello'    "MCPatch - referenced by HDChangeReport>>changesFor: "
    21     )
    22 
    23     "Modified: / 08-03-2011 / 22:08:29 / Jan Vrany <jan.vrany@fit.cvut.cz>"
    24 !
    25 
    26 mandatoryPreRequisites
    27     "list all required mandatory packages.
    28      Packages are mandatory, if they contain superclasses of the package's classes
    29      or classes which are extended by this package.
    30      This list can be maintained manually or (better) generated and
    31      updated by scanning the superclass hierarchies
    32      (the browser has a menu function for that)"
    33 
    34     ^ #(
    35         #'stx:goodies/sunit'    "TestAsserter - extended "
    36         #'stx:libbasic'    "LibraryDefinition - superclass of stx_goodies_builder_reports "
    37     )
    38 !
    39 
    40 referencedPreRequisites
    41     "list all packages containing classes referenced by the packages's members.
    42      This list can be maintained manually or (better) generated and
    43      updated by looking for global variable accesses
    44      (the browser has a menu function for that)
    45      However, often too much is found, and you may want to explicitely
    46      exclude individual packages in the #excludedFromPreRequisites method."
    47 
    48     ^ #(
    49         #'stx:goodies/refactoryBrowser/browser'    "PackageEnvironment - referenced by Builder::LintReport>>setupForPackages: "
    50         #'stx:goodies/refactoryBrowser/helpers'    "BrowserEnvironment - referenced by Builder::LintReport>>setupForClasses: "
    51         #'stx:goodies/refactoryBrowser/lint'    "RBBasicLintRule - referenced by Builder::LintReport>>setUp "
    52         #'stx:libcomp'    "InstrumentationContext - referenced by Builder::TestReport>>runReport "
    53     )
    54 !
    55 
    56 subProjects
    57     "list packages which are known as subprojects.
    58      The generated makefile will enter those and make there as well.
    59      However: they are not forced to be loaded when a package is loaded;
    60      for those, redefine requiredPrerequisites"
    61 
    62     ^ #(
    63     )
    64 ! !
    65 
    66 !stx_goodies_builder_reports class methodsFor:'description - contents'!
    67 
    68 classNamesAndAttributes
    69     "lists the classes which are to be included in the project.
    70      Each entry in the list may be: a single class-name (symbol),
    71      or an array-literal consisting of class name and attributes.
    72      Attributes are: #autoload or #<os> where os is one of win32, unix,..."
    73 
    74     ^ #(
    75         "<className> or (<className> attributes...) in load order"
    76         (#'Builder::JUnitReportReader' autoload)
    77         #'Builder::Report'
    78         #'Builder::ReportFormat'
    79         #'Builder::ReportRunner'
    80         #'Builder::ReportSourceInfo'
    81         #'stx_goodies_builder_reports'
    82         #'Builder::ChangeReport'
    83         #'Builder::CoverageReport'
    84         #'Builder::CoverageReportFormat'
    85         #'Builder::LintReport'
    86         #'Builder::LintReportFormat'
    87         #'Builder::ReportClassSourceInfo'
    88         #'Builder::ReportExtensionsSourceInfo'
    89         #'Builder::TestReport'
    90         #'Builder::TestReportFormat'
    91     )
    92 !
    93 
    94 extensionMethodNames
    95     "lists the extension methods which are to be included in the project.
    96      Entries are 2-element array literals, consisting of class-name and selector."
    97 
    98     ^ #(
    99         TestCase nameForHDTestReport
   100         TestCase selectorForHDTestReport
   101         'TestCase class' isJUnitTestCaseProxy
   102         'TestCase class' isTestletTestCaseProxy
   103         TestCase timeout
   104     )
   105 ! !
   106 
   107 !stx_goodies_builder_reports class methodsFor:'description - project information'!
   108 
   109 applicationIconFileName
   110     "Return the name (without suffix) of an icon-file (the app's icon); will be included in the rc-resource file"
   111 
   112     ^ nil
   113     "/ ^ self applicationName
   114 !
   115 
   116 companyName
   117     "Return a companyname which will appear in <lib>.rc"
   118 
   119     ^ 'SWING Research Group & eXept Software AG'
   120 
   121     "Modified: / 21-07-2011 / 10:05:05 / Jan Vrany <jan.vrany@fit.cvut.cz>"
   122 !
   123 
   124 description
   125     "Return a description string which will appear in vc.def / bc.def"
   126 
   127     ^ 'Report Runner for Jenkins CI Server'
   128 
   129     "Modified: / 21-07-2011 / 10:06:33 / Jan Vrany <jan.vrany@fit.cvut.cz>"
   130 !
   131 
   132 legalCopyright
   133     "Return a copyright string which will appear in <lib>.rc"
   134 
   135     ^ 'Copyright Jan Vrany 2011\nCopyright eXept Software AG 2011'
   136 
   137     "Modified: / 21-07-2011 / 10:05:37 / Jan Vrany <jan.vrany@fit.cvut.cz>"
   138 !
   139 
   140 productInstallDirBaseName
   141     "Returns a default installDir which will appear in <app>.nsi.
   142      This is usually not the one you want to keep"
   143 
   144     ^ (self package asCollectionOfSubstringsSeparatedByAny:':/') last
   145 !
   146 
   147 productName
   148     "Return a product name which will appear in <lib>.rc"
   149 
   150     ^ 'ReportRunner'
   151 
   152     "Modified: / 21-07-2011 / 10:06:24 / Jan Vrany <jan.vrany@fit.cvut.cz>"
   153 ! !
   154 
   155 !stx_goodies_builder_reports class methodsFor:'description - startup'!
   156 
   157 startupClassName
   158     "the name of the class which starts the show in its <startupSelector> method.
   159      Usually, the name of a subclass of StandAloneStartup."
   160 
   161 
   162     ^ 'HDReportRunner'
   163 
   164     "Modified: / 21-07-2011 / 10:06:51 / Jan Vrany <jan.vrany@fit.cvut.cz>"
   165 !
   166 
   167 startupSelector
   168     "the message that is sent to the startupClass to start the show"
   169 
   170     ^ #'start'        
   171 ! !
   172 
   173 !stx_goodies_builder_reports class methodsFor:'description - svn'!
   174 
   175 svnRepositoryUrlString
   176     "Return a SVN repository URL of myself.
   177      (Generated since 2011-04-08)
   178     "        
   179 
   180     ^ '$URL$'
   181 !
   182 
   183 svnRevisionNr
   184     "Return a SVN revision number of myself.
   185      This number is updated after a commit"
   186 
   187     ^ "$SVN-Revision:"'exported'"$"
   188 ! !
   189 
   190 !stx_goodies_builder_reports class methodsFor:'documentation'!
   191 
   192 version
   193     ^ '$Header$'
   194 !
   195 
   196 version_CVS
   197     ^ '$Header$'
   198 !
   199 
   200 version_SVN
   201     ^ '$Id$'
   202 ! !
   203