analysis.atl 54.2 KB
Newer Older
Gerson Sunyé's avatar
Gerson Sunyé committed
1
2
3
-- @nsURI smm=http://www.eclipse.org/MoDisco/SMM/1.0.Beta2/smm
-- @nsURI java=http://www.eclipse.org/MoDisco/Java/0.2.incubation/java

Gerson Sunyé's avatar
Gerson Sunyé committed
4
5

module analysis;
Gerson Sunyé's avatar
Gerson Sunyé committed
6
7
create OUT: smm from IN: java;

8
uses design;
9
uses codestyle;
Gerson Sunyé's avatar
Gerson Sunyé committed
10
uses multithreading;
11
uses performance;
12
uses bestPractices;
Roxane MARECHAL's avatar
Roxane MARECHAL committed
13
uses documentation;
14
uses errorProne;
15

16
 
Gerson Sunyé's avatar
Gerson Sunyé committed
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
rule Java2SMM {
	from
		project: java!Model
	to
		model: smm!SmmModel (
			name <- project.name,
			librairies <- lib
		),
		lib: smm!MeasureLibrary (
			name <- 'Java metrics',
			measureElements <- thisModule.allMeasures(project)
		)
}

helper def: allMeasures(project : java!Model): Set(smm!Measure) =
Raphael PAGE's avatar
Raphael PAGE committed
32

33
	Set{
34
35
36
37
38
39
		-- Example rule
		--
		thisModule.numberOfClasses(),
		
		-- Multithreading rules
		--
40
		thisModule.avoidThreadGroup(),
41
42
		thisModule.useNotifyAllInsteadOfNotify(),
		
43
44
45
		
		-- Code Style rules
		--
Louis QUESTEL's avatar
Louis QUESTEL committed
46
		thisModule.extendsObject(),
47
		thisModule.genericsNaming(),
48
		thisModule.longVariable(),
49
		thisModule.misLeadingVariableName(),
50
51
52
53
54
55
		thisModule.noPackageDeclaration(),
		thisModule.shortClassName(),
		thisModule.shortMethodName(),
		thisModule.shortVariableName(),
		thisModule.tooManyStaticImports(),
		thisModule.unnecessaryReturn(),
56

57
58
		-- Design rules
		--
59
		thisModule.ExcessiveClassLength(),
60
		thisModule.IfBraces(),
61
		thisModule.excessiveParameterList(),
62
		thisModule.finalFieldCouldBeStatic(),
63
64
65
		thisModule.longInstantiation(),
		thisModule.returnFromFinallyBlock(),
		thisModule.shortInstantiation(),
66
		thisModule.signatureDeclareThrowsException(),
67
68
		thisModule.tooManyFields(),
		thisModule.tooManyMethods(),
69
70
		thisModule.SimplifyBooleanAssertion(),
		thisModule.abstractClassWithoutAnyMethod(),
71

72
73
		-- Performance rules
		--
74
		thisModule.avoidPrintStackTrace(),
75
		thisModule.avoidRethrowingException(),
Glenn PLOUHINEC's avatar
Glenn PLOUHINEC committed
76
		thisModule.avoidUsingShortType(),
77
		thisModule.emptyStatementBlock(),
Alexis Pineau's avatar
Alexis Pineau committed
78
		thisModule.integerInstantiation(),
79
80
81
82
		thisModule.useIndexOfChar(),
		thisModule.uselessStringValueOf(),
		thisModule.tooFewBranchesForASwitchStatement(),
		
83
		
Roxane MARECHAL's avatar
Roxane MARECHAL committed
84
85
		-- Documentation rules
		--
Ronan GUEGUEN's avatar
Ronan GUEGUEN committed
86
		thisModule.commentContent(),
Roxane MARECHAL's avatar
Roxane MARECHAL committed
87

88
89
		-- Error prone rules
		--
90
		thisModule.avoidCallingFinalize(),
91
		thisModule.AvoidCatchingNPE(),
92
		thisModule.avoidCatchingThrowable(),
93
94
		thisModule.AvoidEnumAsIdentifier(),
		thisModule.CloneMethodMustBePublic(),
95
		thisModule.doNotCallGarbageCollectionExplicitly(),
96
97
98
		thisModule.doNotExtendJavaLangError(),
		thisModule.doNotExtendJavaLangThrowable(),
		thisModule.dontImportSun(),
99
		thisModule.emptyCatchBlock(),
100
101
102
103
		thisModule.EmptyInitializer(),	
		thisModule.emptySwitchStatement(),
		thisModule.emptySynchronizedBlock(),
		thisModule.emptyTryBlock(),
104
		thisModule.importFromSamePackage(),
105
106
107
108
		thisModule.missingBreakInSwitch(),
		thisModule.suspiciousEqualsMethodName(),
		thisModule.UnconditionalIfStatement(),
		thisModule.UseProperClassLoader(),
Hanane HADJI's avatar
Hanane HADJI committed
109
		
110
		-- Best practices rules
111
		thisModule.switchDensity(),
112
		thisModule.useAssertSameInsteadOfAssertTrue(),
113
		thisModule.useAssertTrueInsteadOfAssertEquals()
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
		
		-- Bugged rules:
		--
		-- thisModule.avoidThrowingNullPointerException(),
	    -- thisModule.UseArrayListInsteadOfVector(),
		-- thisModule.commentRequired(),
		-- thisModule.compareObjectsWithEquals(),
		-- thisModule.emptyWhileStmt(),
		-- thisModule.emptyFinallyBlock(),
		-- thisModule.emptyfinalizeMethod(),
		-- thisModule.doNotThrowExceptionInFinally(),
		-- thisModule.finalizeShouldBeProtected(),
		-- thisModule.avoidDollarSigns(),
		-- thisModule.returnEmptyArrayRatherThanNull(),
		-- thisModule.replaceVectorToList()
		-- thisModule.unusedPrivateMethod ()
		-- thisModule.avoidStringBufferField()
		-- thisModule.avoidThrowingNewInstanceOfSameException(),
132
133
134
		-- thisModule.stringToString(),
	    -- thisModule.dontCallThreadRun(),
		-- thisModule.methodWithSameNameAsEnclosingClass(),
Gerson Sunyé's avatar
Gerson Sunyé committed
135
136
137
		-- thisModule.dontUseFloatTypeForLoopIndices(),
		-- thisModule.methodWithSameNameAsEnclosingClass(),
		
138
		
Gerson Sunyé's avatar
Gerson Sunyé committed
139
140
};

Raphael PAGE's avatar
Raphael PAGE committed
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

-- creates a new Measure when String.valueOf is called to append its argument to a string
rule MeasureUselessStringValueOf(method : java!MethodInvocation) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'Useless string value of',
			shortDescription <- 'No need to call String.valueOf to append to a string; just use the valueOf() argument directly.'		
		),
		measurement: smm!DirectMeasurement (			
			error<- 'The class '+ method.originalCompilationUnit.name + ' violates the rule useless string value of.'
			)
	do {
		noc; 
	}
}

------------------------------------------------------------------------------------------

Yannis LE BARS's avatar
Yannis LE BARS committed
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
-- A Measure instance if the class violates the rule 'AvoidDollarSigns'.
rule MesureAvoidDollarSigns(node : java!ASTNode) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'AvoidDollarSigns',
			shortDescription <- 'Avoid using dollar signs in variable/method/class/interface names.'
		),
		measurement: smm!DirectMeasurement (
			error <- node.name + ' has dollar in ' + node.originalCompilationUnit.name
		)
	do {
		noc; 
	}
}

Yannis LE BARS's avatar
Yannis LE BARS committed
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201


-- A Measure instance if the class violates the rule 'ShortMethodName'.
rule MesureShortMethodName(method : java!MethodDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'ShortMethodName',
			shortDescription <- 'Method names names that are very short are not helpful to the reader.'
		),
		measurement: smm!DirectMeasurement (
			error <- method.name + ' is too short in ' + method.originalCompilationUnit.name
		)
	do {
		noc; 
	}
}
Raphael PAGE's avatar
Raphael PAGE committed
202

Raphael's avatar
Raphael committed
203

Marion HUNAULT's avatar
Marion HUNAULT committed
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
-- A Measure instance if the class violates the rule 'ShortClassName'.
rule MesureShortClassName(class : java!ClassDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'ShortClassName',
			shortDescription <- 'Short Classnames with fewer than e.g. five characters are not recommended.'
		),
		measurement: smm!DirectMeasurement (
			error <- 'The Class ' + class.name + ' is too short.'
		)
	do {
		noc; 
	}
}

223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
-- A Measure instance if the variable violates the rule 'ShortVariableName'.
rule MesureShortVariableName(variable : java!VariableDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'ShortVariableName',
			shortDescription <- 'Short Variable names with fewer than e.g. three characters are not recommended.'
		),
		measurement: smm!DirectMeasurement (
			error <- 'The Variable ' + variable.name + ' is too short.'
		)
	do {
		noc; 
	}
}

Marion HUNAULT's avatar
Marion HUNAULT committed
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
-- A Measure instance if the method violates the rule 'StringToString'.
rule MeasureStringToString(method : java!MethodInvocation) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'StringToString',
			shortDescription <- 'Avoid calling toString() on objects already known to be string instances; this is unnecessary.'
		),
		measurement: smm!DirectMeasurement (
			error <- 'The Object ' + method.expression.variable.name + ' is already a String in ' + method.originalCompilationUnit.name
		)
	do {
		noc; 
	}
}
Marion HUNAULT's avatar
Marion HUNAULT committed
260

Raphael's avatar
Raphael committed
261
262
263
264
265
266
267
268
269
270
271
272
273
274
-- creates a new Measure when Thread.run() is used instead of Thread.start()
rule MeasureDontCallThreadRun(method : java!MethodInvocation) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'Don t call Thread.run()',
			shortDescription <- 'Explicitly calling Thread.run() method will execute in the caller s thread of control. Instead, call Thread.start() for the intended behavior.'		
		),
		measurement: smm!DirectMeasurement (			
			error<-'The class '+ method.originalCompilationUnit.name + ' violates the rule don t call Thread.run().'
		)
Raphael's avatar
Raphael committed
275
276
277
278
279
	do {
		noc; 
	}
}

280

Astlo's avatar
Astlo committed
281
-- A Measure instance if the class violates the rule 'TooManyFields'.
282
rule MesureTooManyFields(class : java!ClassDeclaration) {
Gerson Sunyé's avatar
Gerson Sunyé committed
283
284
285
286
287
288
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
Astlo's avatar
Astlo committed
289
290
			name <- 'TooManyFields',
			shortDescription <- 'Classes that have too many fields can become unwieldy and could be redesigned to have fewer field.'
Gerson Sunyé's avatar
Gerson Sunyé committed
291
292
		),
		measurement: smm!DirectMeasurement (
Astlo's avatar
Astlo committed
293
			error <- class.originalCompilationUnit.name + ' have too many fields'
Gerson Sunyé's avatar
Gerson Sunyé committed
294
		)
Raphael's avatar
Raphael committed
295
296
297
298
299
	do {
		noc; 
	}
}

Raphael's avatar
Raphael committed
300

Raphael's avatar
Raphael committed
301
-- creates a new Measure when the parameter of String.indexOf(char) is not of type char when checking for the index of a single character
Raphael's avatar
Raphael committed
302
303
304
305
306
307
308
309
310
311
312
rule MeasureUseIndexOfChar(method : java!MethodInvocation) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'Use index of char',
			shortDescription <- 'Use String.indexOf(char) when checking for the index of a single character; it executes faster.'		
		),
		measurement: smm!DirectMeasurement (			
Raphael's avatar
Raphael committed
313
			error<- 'The class '+ method.originalCompilationUnit.name + ' violates the rule index of char.'
Raphael's avatar
Raphael committed
314
315
316
317
318
		)
	do {
		noc; 
	}
}
Gerson Sunyé's avatar
Gerson Sunyé committed
319

Raphael PAGE's avatar
Raphael PAGE committed
320
321
------------------------------------------------------------------------------------------

Gerson Sunyé's avatar
Gerson Sunyé committed
322
323
324
325
326
327
328
329
330
331
332
333
rule numberOfClasses() {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'Number of Classes'
		),
		measurement: smm!DirectMeasurement (
			value <- java!ClassDeclaration.allInstances() -> reject(each | each.isProxy()) -> size()
		)
Gerson Sunyé's avatar
Gerson Sunyé committed
334

Gerson Sunyé's avatar
Gerson Sunyé committed
335
336
337
338
	do {
		noc; 
	}
}
339

Glenn PLOUHINEC's avatar
Glenn PLOUHINEC committed
340

341
-- Rule that creates an instance of Measure for the switch statement with too few branches passed in parameter  
342
rule MeasureTooFewBranchesForASwitchStatement(switchStatement: java!SwitchStatement) {
343
344
345
346
347
348
	to
		om: smm!ObservedMeasure (
			measure <- tooFewBranchesForASwitchStatement,
			measurements <- measurement
		),
		tooFewBranchesForASwitchStatement: smm!DimensionalMeasure (
349
350
			name <- 'TooFewBranchesForASwitchStatement',
			shortDescription <- 'Switch statements are intended to be used to support complex branching behaviour. Using a switch for only a few cases is ill-advised, since switches are not as easy to understand as if-then statements. In these cases use the if-then statement to increase code readability.'
351
352
		),
		measurement: smm!DirectMeasurement (
353
			error <- 'Too few branches for SwitchStatement in Class : ' + switchStatement.originalCompilationUnit.name,
354
355
356
357
358
359
			value <- thisModule.nbBranchesOfASwitchStatement(switchStatement)
		)
	do {
		tooFewBranchesForASwitchStatement; 
	}
}
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424

--------------------------------------------- ShortInstantiation ---------------------------------------------
-- A Measure instance if the class violates the rule 'ShortInstantiation'.
rule MeasureShortInstantiation(variable : java!CompilationUnit) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'ShortInstantiation',
			shortDescription <- 'Calling new Short() causes memory allocation that can be avoided by the static Short.valueOf(). It makes use of an internal cache that recycles earlier instances making it more memory efficient. Note that new Short() is deprecated since JDK 9 for that reason.'		
		),
		measurement: smm!DirectMeasurement (			
			error<-'In the Class '+ variable.name + ' an instantiation of Short must be Short.ValueOf().'
		)
		
	do {
		noc; 
	}
}


--------------------------------------------- LongInstantiation ---------------------------------------------
-- A Measure instance if the class violates the rule 'LongInstantiation'.
rule MeasureLongInstantiation(variable : java!CompilationUnit) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'LongInstantiation',
			shortDescription <- 'Calling new Long() causes memory allocation that can be avoided by the static Long.valueOf(). It makes use of an internal cache that recycles earlier instances making it more memory efficient. Note that new Long() is deprecated since JDK 9 for that reason.'		
		),
		measurement: smm!DirectMeasurement (			
			error<-'In the Class '+ variable.name + ' an instantiation of Long must be Long.ValueOf().'
		)
		
	do {
		noc; 
	}
}

--------------------------------------------- DoNotExtendJavaLangThrowable  ---------------------------------------------
-- A Measure instance if the class violates the rule DoNotExtendJavaLangThrowable.
rule MeasureDoNotExtendJavaLangThrowable(variable : java!ClassDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'DoNotExtendJavaLangThrowable ',
			shortDescription <- 'Extend Exception or RuntimeException instead of Throwable.'
		
		),
		measurement: smm!DirectMeasurement (			
			error<-'In the Class '+ variable.name + ' should not extend Throwable but RuntimeException or Exception .'
		)
		
	do {
		noc; 
	}
}
425
426
427
	
-- Returns the number of branches in the switch statement passed in parameter
helper def: nbBranchesOfASwitchStatement(switchStatement:java!SwitchStatement) : Integer =
428
429
430
	switchStatement.statements->select(each | each.oclIsTypeOf(java!SwitchCase)).size()
;

431
432
433
434
-- Returns the number of Fields in Class
helper def: numberFieldsInClasse(s:java!ClassDeclaration) : Integer =
	-- Return the number of FieldDeclaration in a class.
	s.bodyDeclarations-> select(r | r.oclIsTypeOf(java!FieldDeclaration))->size();
Martin's avatar
Martin committed
435

436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
-- Returns the number of breaks of the switch statement passed in parameter
helper def: nbBreakStatementOfASwitchStatement(ss:java!SwitchStatement) : Integer =
    ss.statements->select(each | each.oclIsTypeOf(java!BreakStatement)).size()
;

-- Returns the number of expressions of the switch statement passed in parameter
helper def: nbExpressionsStatementOfASwitchStatement(ss:java!SwitchStatement) : Integer =
    ss.statements->select(each | each.oclIsTypeOf(java!ExpressionStatement)).size()
;

-- Returns the number of intentional fall-through (empty switch cases) of a switchStatement
helper def: nbIntentionalFallThroughOfASwitchStatement(ss:java!SwitchStatement) : Integer =
    thisModule.nbBranchesOfASwitchStatement(ss) - thisModule.nbExpressionsStatementOfASwitchStatement(ss)
;

-- Creates an instance of Measure for the switch statement missing one or more break statements
-- To test, use input model : missing-break-in-switch.xmi
rule createMeasureForMissingBreakInSwitch(ss: java!SwitchStatement) {
	to
		om: smm!ObservedMeasure (
			measure <- missingBreakInSwitch,
			measurements <- measurement
		),
		missingBreakInSwitch: smm!DimensionalMeasure (
			name <- 'Missing break in Switch',
			shortDescription <- 'Switch statements without break or return statements for each case option may indicate problematic behaviour. Empty cases are ignored as these indicate an intentional fall-through.'
		),
		measurement: smm!DirectMeasurement (
			error <- 'Missing breaks in Switch in Class : ' + ss.originalCompilationUnit.name + '',
			-- Indicates the number of breaks missing in the switch statement
			value <- (thisModule.nbBranchesOfASwitchStatement(ss) - thisModule.nbIntentionalFallThroughOfASwitchStatement(ss)) - thisModule.nbBreakStatementOfASwitchStatement(ss)
		)
	do {
		missingBreakInSwitch; 
	}
}

Martin's avatar
Martin committed
473
474
475
476
477
478
479
480
481
482
483
484
-- A Measure instance if the class violates the rule 'TooManyMethods'.
rule MesureTooManyMethods(class : java!ClassDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'TooManyMethods',
			shortDescription <- 'A class with too many methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.'
		),
		measurement: smm!DirectMeasurement (
Martin ARS's avatar
Martin ARS committed
485
			error <- class.originalCompilationUnit.name + ' has too many methods'
Martin's avatar
Martin committed
486
487
488
489
490
491
		)

	do {
		noc; 
	}
}
Martin ARS's avatar
Martin ARS committed
492

493
-- A Measure instance if the class violates the rule ReturnFromFinallyBlock.
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
rule MesureReturnFromFinallyBlock(method : java!MethodDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'returnFromFinallyBlock',
			shortDescription <- 'Avoid returning from a finally block, this can discard exceptions.'
		),
		measurement: smm!DirectMeasurement (
			error <- 'The method ' + method.name + ' in the class ' + method.originalCompilationUnit.name + ' has a return statement in a finally block.'
		)
	do {
		noc; 
	}
}
Martin ARS's avatar
Martin ARS committed
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528

-- A Measure instance if the class violates the rule 'TooManyStaticImports'.
rule MesureTooManyStaticImports(class : java!CompilationUnit) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'TooManyStaticImports',
			shortDescription <- 'If you overuse the static import feature, it can make your program unreadable and unmaintainable, polluting its namespace with all the static members you import. Readers of your code (including you, a few months after you wrote it) will not know which class a static member comes from (Sun 1.5 Language Guide).'
		),
		measurement: smm!DirectMeasurement (
			error <- class.name + ' has too many static imports'
		)
	do {
		noc; 
	}
Raphael's avatar
Raphael committed
529
530
}

Raphael PAGE's avatar
Raphael PAGE committed
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
-- creates a new Measure when the method printStackTrace is used
rule MeasureAvoidPrintStackTrace(method : java!MethodInvocation) {
		to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'Avoid print stack trace',
			shortDescription <- 'Avoid printStackTrace(); use a logger call instead.'		
		),
		measurement: smm!DirectMeasurement (			
			error<- 'The class '+ method.originalCompilationUnit.name + ' violates the rule avoid print stack trace.'
		)
	do {
		noc; 
	}
}
Raphael's avatar
Raphael committed
549
550
551
552
553
554
555
556

-- creates a new Measure when Thread.run() is used instead of Thread.start()
rule measureAvoidThreadGroup(variable : java!VariableDeclarationFragment) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
557
		noc: smm!DimensionalMeasure (
Raphael's avatar
Raphael committed
558
559
560
561
562
563
564
			name <- 'Avoid Thread Group',
			shortDescription <- 'Avoid using java.lang.ThreadGroup; although it is intended to be used in a threaded environment it contains methods that are not thread-safe.'		
		),
		measurement: smm!DirectMeasurement (			
			error<-'The class '+ variable.originalCompilationUnit.name + ' violates the rule avoid thread group.'
		)
		
Martin ARS's avatar
Martin ARS committed
565
566
567
	do {
		noc; 
	}
Raphael PAGE's avatar
Raphael PAGE committed
568
}
569

570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
--------------------------------------------- AvoidThrowingNewInstanceOfSameException ---------------------------------------------
-- A Measure instance if the class violates the rule 'AvoidThrowingNewInstanceOfSameException'.
rule MeasureAvoidThrowingNewInstanceOfSameException(catch : java!CatchClause) {
    to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'AvoidThrowingNewInstanceOfSameException',
			shortDescription <- 'Catch blocks that merely rethrow a caught exception wrapped inside a new instance of the same type only add to code size and runtime complexity.'		
		),
		measurement: smm!DirectMeasurement (			
			error <-'The class '+ catch.originalCompilationUnit.name + ' has a method that rethrows a caught exception wrapped inside a new instance of the same type.'
		)
	do {
		noc; 
	}
}

590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
--------------------------------------------- ReturnEmptyArrayRatherThanNull ---------------------------------------------	
-- creates a new Measure when a method returns an empty method rather than null
rule MesureReturnEmptyArrayRatherThanNull(method : java!ReturnStatement) {
    to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'ReturnEmptyArrayRatherThanNull',
			shortDescription <- 'For any method that returns an array, it is a better to return an empty array rather than a null reference.'
		),
		measurement: smm!DirectMeasurement (
			error <- 'A method in the class ' + method.originalCompilationUnit.name + ' returns null instead of an empty array.'
		)
	do {
		noc; 
	}
}
609

610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
--------------------------------------------- ExcessiveParameterList ---------------------------------------------
-- creates a new Measure when a method has more than 10 parameters
rule MesureExcessiveParameterList(method : java!MethodDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'ExcessiveParameterList',
			shortDescription <- 'Methods with numerous parameters are a challenge to maintain, especially if most of them share the same datatype.'		
		),
		measurement: smm!DirectMeasurement (			
			error<-'The method '+ method.name + ' in the class ' + method.originalCompilationUnit.name + ' has an excessive parameter list.'
		)
	do {
		noc; 
	}
}

630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
-- A Measure instance if the class violates the rule 'AvoidFieldNameMatchingMethodName'.
rule MesureAvoidFieldNameMatchingMethodName(class : java!ClassDeclaration, method : java!MethodDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'AvoidFieldNameMatchingMethodName',
			shortDescription <- 'It can be confusing to have a field name with the same name as a method. While this is permitted, having information (field) and actions (method) is not clear naming. Developers versed in Smalltalk often prefer this approach as the methods denote accessor methods.'
		),
		measurement: smm!DirectMeasurement (
			error <- 'In the ' + class.name + ' class you have an field and an method with the same name : '+ method.name
		)
	do {
		noc; 
	}
}
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666

-- Creates a measure instance when rule 'UseNotifyAllInsteadOfNotify' is violated
rule MeasureUseNotifyAllInsteadOfNotify(method: java!MethodInvocation) {
	to
		om: smm!ObservedMeasure (
			measure <- useNotifyAllInsteadOfNotify,
			measurements <- measurement
		),
		useNotifyAllInsteadOfNotify: smm!DimensionalMeasure (
			name <- 'UseNotifyAllInsteadOfNotify',
			shortDescription <- 'Thread.notify() awakens a thread monitoring the object. If more than one thread is monitoring, then only one is chosen. The thread chosen is arbitrary; thus its usually safer to call notifyAll() instead.'
		),
		measurement: smm!DirectMeasurement (
			error <- 'Used notify() instead of notifyAll() in Class : ' + method.originalCompilationUnit.name
		)
	do {
		useNotifyAllInsteadOfNotify; 
	}
}
Roxane MARECHAL's avatar
Roxane MARECHAL committed
667

668
--- Creates a measure instance for each element that violates the rule : CommentRequired
Roxane MARECHAL's avatar
Roxane MARECHAL committed
669
670
671
672
673
674
675
676
677
678
679
rule MeasureCommentRequired(element: java!BodyDeclaration, violatedProperties: Set(String)) {
	to
		om: smm!ObservedMeasure (
			measure <- commentRequired,
			measurements <- measurement
		),
		commentRequired: smm!DimensionalMeasure (
			name <- 'CommentRequired',
			shortDescription <- 'Denotes whether comments are required (or unwanted) for specific language elements.'
		),
		measurement: smm!DirectMeasurement (
680
			error <- 'Violated the properties  ' + violatedProperties + ' in Class: ' + element.originalCompilationUnit.name + ' -> ' + element.oclType().name + ': ' + element.modifier.visibility + ' ' + element.getBodyDeclarationName()
Roxane MARECHAL's avatar
Roxane MARECHAL committed
681
682
683
684
685
		)
		do {
		commentRequired; 
		}
}
Ronan GUEGUEN's avatar
Ronan GUEGUEN committed
686
-- Creates a measure instance when a bad word is found in a comment
Ronan GUEGUEN's avatar
Ronan GUEGUEN committed
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
rule MeasureCommentContent(element: Sequence(String)){
	to
		om: smm!ObservedMeasure (
			measure <- commentContent,
			measurements <- measurement
		),
		commentContent: smm!DimensionalMeasure (
			name <- 'CommentContent',
			shortDescription <- 'A rule for the politically correct… we don’t want to offend anyone.'
		),
		measurement: smm!DirectMeasurement (
			error <- 'The words ' + element +' were found in a comment '	
		)
		do {
			commentContent;
		}
	
}

Ronan GUEGUEN's avatar
Ronan GUEGUEN committed
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
-- Creates a measure instance when a for loop uses a float as loop indice 
rule MeasureDontUseFloatTypeForLoopIndices(){
	to
		om: smm!ObservedMeasure (
			measure <- dontUseFloatTypeForLoopIndices,
			measurements <- measurement
		),
		dontUseFloatTypeForLoopIndices: smm!DimensionalMeasure (
			name <- 'DontUseFloatTypeForLoopIndices()',
			shortDescription <- 'Don’t use floating point for loop indices.'
		),
		measurement: smm!DirectMeasurement (
			error <- 'Use integer instead of floats as loop indice'	
		)
		do {
			dontUseFloatTypeForLoopIndices;
		}
	
}

726
727
728
729
730
731
732
--- Returns the name of a BodyDeclaration
helper context java!BodyDeclaration def: getBodyDeclarationName() : String =
    self.name;

--- In FielDeclaration, the attribute 'name' is NULL, this information is contained in "fragments" instead
helper context java!FieldDeclaration def: getBodyDeclarationName() : String =
    self.fragments.first().name;
Roxane MARECHAL's avatar
Roxane MARECHAL committed
733

734
--- Returns the AnnotationTypeDeclaration corresponding to the given BodyDeclaration
Roxane MARECHAL's avatar
Roxane MARECHAL committed
735
736
737
738
739
740
741
742
743
744
-- This is necessary because BodyDeclaration.annotations returns Sequence(!IN<unamed>)
helper def: getAnnotationTypeDeclarationsFromBodyDeclaration(elem: java!BodyDeclaration): Set(java!AnnotationTypeDeclaration) =
	java!AnnotationTypeDeclaration.allInstances()
	->select(annotTypeDec | 
		annotTypeDec.usagesInTypeAccess->exists(usage | 
			(usage.eContainer().eContainer().name = elem.name)
			.and(usage.eContainer().eContainer().modifier.visibility = elem.modifier.visibility)
			.and(usage.eContainer().eContainer().originalCompilationUnit.name = elem.originalCompilationUnit.name))
	)
;
Glenn PLOUHINEC's avatar
Glenn PLOUHINEC committed
745

746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
-- A Measure instance if the class violates the rule 'SuspiciousEqualsMethodName'
rule MeasureSuspiciousEqualsMethodName(method : java!MethodDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'Suspicious Equals Method Name',
			shortDescription <- 'The method name and parameter number are suspiciously close to equals(Object), which can denote an intention to override the equals(Object) method.'
		),
		measurement: smm!DirectMeasurement (
				error <- 'The class ' + method.originalCompilationUnit.name + ' has a suspicious \'equals\' method name : ' + method.toString()
		)
	do {
		noc;
	}
}

Glenn PLOUHINEC's avatar
Glenn PLOUHINEC committed
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
-- A Measure instance if the class violates the rule 'AvoidUsingShortType'
rule MeasureAvoidUsingShortType(typeShort : java!VariableDeclarationStatement) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'Avoid using short type',
			shortDescription <- 'Java uses the \'short\' type to reduce memory usage, not to optimize calculation.' 
								+ ' In fact, the JVM does not have any arithmetic capabilities for the short type:' 
								+ ' the JVM must convert the short into an int, do the proper calculation and convert' 
								+ ' the int back to a short. Thus any storage gains found through use of the \'short\' type' 
								+ ' may be offset by adverse impacts on performance.'
		),
		measurement: smm!DirectMeasurement (
				error <- 'The class ' + typeShort.originalCompilationUnit.name + ' has \'short\' type variable.'
		)
	do {
		noc;
	}
}
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805

-- A Measure instance if the class violates the rule 'EmptyStatementBlock'
rule MeasureEmptyStatementBlock(block : java!Block) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'Empty Statement Block',
			shortDescription <- 'Empty block statements serve no purpose and should be removed.'
		),
		measurement: smm!DirectMeasurement (
				error <- 'The class ' + block.originalCompilationUnit.name + ' has an empty statement block.'
		)
	do {
		noc;
	}
}
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827

--------------------------------------------- DoNotExtendJavaLangError  ---------------------------------------------
-- A Measure instance if the class violates the rule DoNotExtendJavaLangError.
rule MeasureDoNotExtendJavaLangError(variable : java!ClassDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'DoNotExtendJavaLangError ',
			shortDescription <- 'Errors are system exceptions. Do not extend them.'
		
		),
		measurement: smm!DirectMeasurement (			
			error<-'In the Class '+ variable.name + ' Do not extend Error, Errors are system exceptions.'
		)
		
	do {
		noc; 
	}
}
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849

--------------------------------------------- MeasureFinalFieldCouldBeStatic  ---------------------------------------------
-- A Measure instance if the class violates the rule MeasureFinalFieldCouldBeStatic.
rule MeasureFinalFieldCouldBeStatic(field : java!FieldDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'FinalFieldCouldBeStatic',
			shortDescription <- 'If a final field is assigned to a compile-time constant, it could be made static, thus saving overhead in each object at runtime.'
		
		),
		measurement: smm!DirectMeasurement (			
			error<-'The field '+ field.fragments->collect(i | i.name)->first() + ' could be static in the class '  + field.originalCompilationUnit.name +'.'
		)
		
	do {
		noc; 
	}
}
Louis QUESTEL's avatar
Louis QUESTEL committed
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872


--------------------------------------------- MeasureExtendsObject  ---------------------------------------------
-- A Measure instance if the class violates the rule ExtendsObject.
rule MeasureExtendsObject(variable : java!ClassDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'ExtendsObject',
			shortDescription <- 'No need to explicitly extend Object.'
		
		),
		measurement: smm!DirectMeasurement (			
			error<-'In the Class '+ variable.name + ' No need to explicitly extend Object.'
		)
		
	do {
		noc; 
	}
}
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939

--------------------------------------------- SwitchDensity  ---------------------------------------------
-- A Measure instance if the class violates the rule SwitchDensity.
rule MeasureSwitchDensity(switch : java!SwitchStatement) {
	
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			
			name <- 'SwitchDensity ',
			shortDescription <- 'Statement to label ratio is too high (> 10)'
		
		),
		measurement: smm!DirectMeasurement (			
			error<-'In the Class '+ switch.originalCompilationUnit.name + ' a switch case contains too many statements.'
		)
	do {
		noc; 
	}
}	 
--------------------------------------------- SignatureDeclareThrowsException  ---------------------------------------------
-- A Measure instance if the class violates the rule SignatureDeclareThrowsException.
rule MeasureSignatureDeclareThrowsException(class : java!ClassDeclaration) {
	
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			
			name <- 'SignatureDeclareThrowsException ',
			shortDescription <- 'A method/constructor should not explicitly throw the generic java.lang.Exception'
		
		),
		measurement: smm!DirectMeasurement (			
			error<-'In the Class '+ class.name + ' a method/constructor explicitly throws the generic java.lang.Exception.'
		)
	do {
		noc; 
	}
}	 

--------------------------------------------- UnnecessaryReturn  ---------------------------------------------
-- A Measure instance if the class violates the rule UnnecessaryReturn.
rule MeasureUnnecessaryReturn(state : java!ReturnStatement) {
	
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			
			name <- 'UnnecessaryReturn ',
			shortDescription <- 'Avoid the use of unnecessary return statements.'
		
		),
		measurement: smm!DirectMeasurement (			
			error<-'In the Class '+ state.originalCompilationUnit.name + ' an unnecessary return was used.'
		)
	do {
		noc; 
	}
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
}


--------------------------------------------- MeasureCompareObjectsWithEquals  ---------------------------------------------
--A measure instance if the class violates the rule MeasureCompareObjectsWithEquals.
rule MeasureCompareObjectsWithEquals(expression : java!InfixExpression) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'CompareObjectsWithEquals',
			shortDescription <- 'Use equals() to compare object references; avoid comparing them with ==.'
		
		),
		measurement: smm!DirectMeasurement (			
			error<-'The Class '+ expression.originalCompilationUnit.name + ' is using == instead of equals() to compare objects.'
		)
		
	do {
		noc; 
	}
963
}	 
Alexis Pineau's avatar
Alexis Pineau committed
964

965

966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
--------------------------------------------- UseAssertTrueInsteadOfAssertEquals  ---------------------------------------------
-- A Measure instance if the class violates the rule UseAssertTrueInsteadOfAssertEquals.
rule MesureUseAssertTrueInsteadOfAssertEquals(class : java!MethodInvocation) {
	
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'UseAssertTrueInsteadOfAssertEquals',
			shortDescription <- 'Use AssertTrue instead of AssertEquals' 
		),
		measurement: smm!DirectMeasurement (
			error <- class.originalCompilationUnit.name + ' Use AssertTrue instead of AssertEquals ' 
		)

	do {
		noc; 
	}
}
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
--------------------------------------------- AvoidRethrowingException  ---------------------------------------------
 --A Measure instance if the class violates the rule AvoidRethrowingException.
rule MeasureAvoidRethrowingException(statement : java!TryStatement) {
 		to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			
			name <- 'AvoidRethrowingException ',
			shortDescription <- 'Avoid merely rethrowing an exception.'
		
		),
		measurement: smm!DirectMeasurement (			
			error<-'In the Class '+ statement.originalCompilationUnit.name + ' an exception was caught and merely rethrown.'
		)
	do {
		noc; 
	}
}	 
	
Alexis Pineau's avatar
Alexis Pineau committed
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
--------------------------------------------- IntegerInstantiation ---------------------------------------------
-- A Measure instance if the class violates the rule 'IntegerInstantiation'.
rule MeasureIntegerInstantiation(variable : java!CompilationUnit) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'IntegerInstantiation',
			shortDescription <- 'Calling new Integer() causes memory allocation that can be avoided by the static Integer.valueOf(). It makes use of an internal cache that recycles earlier instances making it more memory efficient. Note that new Integer() is deprecated since JDK 9 for that reason.'		
		),
		measurement: smm!DirectMeasurement (			
			error<-'In the Class '+ variable.name + ' an instantiation of Integer must be Integer.ValueOf().'
		)
		
	do {
		noc; 
	}
}

1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
--------------------------------------------- LongVariable  ---------------------------------------------
-- A Measure instance if the variable violates the rule LongVariable.
rule MeasureLongVariable(variable : java!VariableDeclarationFragment) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'LongVariable',
			shortDescription <- ': Fields, formal arguments, or local variable names that are too long can make the code difficult '
		),
		measurement: smm!DirectMeasurement (
			error <- variable.name + ' is too Long ' 
		)
	do {
		noc; 
	}
}

--------------------------------------------- AvoidCallingFinalize  ---------------------------------------------
-- A Measure instance if the class violates the rule LongVariable.
rule MeasureAvoidCallingFinalize(methode : java!MethodInvocation) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'AvoidCallingFinalize',
			shortDescription <- ': The method Object.finalize() is called by the garbage collector on an object when garbage collect... '
		),
		measurement: smm!DirectMeasurement (
			error <- 'finalize() is called in class' + methode.originalCompilationUnit.name 
		)
	do {
		noc; 
	}
}

--------------------------------------------- AvoidStringBufferField  ---------------------------------------------
-- A Measure instance if the class violates AvoidStringBufferField .
rule MeasureAvoidStringBufferField(declaration : java!VariableDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'AvoidStringBufferField',
			shortDescription <- ': StringBuffers/StringBuilders can grow considerably, and so may become a source of memory leaksif ...'
		),
		measurement: smm!DirectMeasurement (
			error <- 'AvoidStringBufferField is detected in ' + declaration.originalCompilationUnit.name 
		)
	do {
		noc; 
	}
}

--------------------- AvoidThrowingNullPointerException----------------------------------
-- A Measure instance if the class violates AvoidThrowingNullPointerException .
rule MeasureAvoidThrowingNullPointerException(c : java!ClassInstanceCreation) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'AvoidThrowingNullPointerException',
			shortDescription <- 'Avoid throwing NullPointerExceptions manually. These are confusing because most people will assume that the virtual machine threw it'
		),
		measurement: smm!DirectMeasurement (
			error <- 'AvoidThrowingNullPointerException is detected in ' + c.originalCompilationUnit.name
		)
	do {
		noc; 
	}
}


--------------------- EmptyTryBlock----------------------------------
--A measure instance if the class violates the rule EmptyTryBlock.
rule MeasureEmptyTryBlock(t : java!TryStatement) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'EmptyTryBlock',
			shortDescription <- ': Avoid empty try blocks - what s the point?'
		),
		measurement: smm!DirectMeasurement (
			error <- 'EmptyTryBlock is detected in ' + t.originalCompilationUnit.name
		)
	do {
		noc; 
	}
}

---------------------EmptyWhileStmt----------------------------------
--A measure instance if the class violates the rule EmptyWhileStmt.
rule MeasureEmptyWhileStmt(w : java!TryStatement) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'EmptyWhileStmt',
			shortDescription <- ': Empty While Statement finds all instances where a while statement does nothing.'
		),
		measurement: smm!DirectMeasurement (
			error <- 'EmptyWhileStmt is detected in  ' + w.originalCompilationUnit.name
		)
	do {
		noc; 
	}
}

------------------------------------------- MeasureDontImportSun----------------------------------------------
-- A Measure instance if the class violate the rule DontImportSun
rule MeasureDontImportSun(p : java!CompilationUnit) {
	to
		om: smm!ObservedMeasure (
				measure <- noc,
				measurements <- measurement
			),
			noc: smm!DimensionalMeasure (
				name <- 'DontImportSun',
				shortDescription <- ' : Avoid importing anything from the sun. packages.'
			),
			measurement: smm!DirectMeasurement (
				error <- ' Import Sun. , is detected in '+ p -> collect(i | i.name)
			)
	do {
		noc; 
	}
}

------------------------------------------- FinalizeShouldBeProtected----------------------------------------------
-- A Measure instance if the class violate the rule FinalizeShouldBeProtected
rule MesureFinalizeShouldBeProtected(m : java!MethodDeclaration) {
	to
		om: smm!ObservedMeasure (
				measure <- noc,
				measurements <- measurement
			),
			noc: smm!DimensionalMeasure (
				name <- 'FinalizeShouldBeProtected',
				shortDescription <- ' : When overriding the finalize(), the new method should be set as protected.  '
			),
			measurement: smm!DirectMeasurement (
				error <- 'Finalize is not protected in class : ' + m.originalCompilationUnit.name
			)
	do {
		noc; 
	}
}
Hanane HADJI's avatar
Hanane HADJI committed
1190
-----------------------EmptySwitchStatement---------------------------------------------
1191

Hanane HADJI's avatar
Hanane HADJI committed
1192
1193
-- A Measure instance if the class violates the rule 'EmptySwitchStatement'
rule MeasureEmptySwitchStatement(switchStatement: java!SwitchStatement) {
1194
1195
1196
1197
1198
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
Hanane HADJI's avatar
Hanane HADJI committed
1199
1200
1201
		noc: smm!DimensionalMeasure (
			name <- 'Empty Switch Statement ',
			shortDescription <- 'Empty Switch statements serve no purpose and should be removed.'
1202
1203
		),
		measurement: smm!DirectMeasurement (
Hanane HADJI's avatar
Hanane HADJI committed
1204
				error <- 'EmptyswitchStatement is detected in ' + switchStatement.originalCompilationUnit.name
1205
1206
1207
1208
1209
		)
	do {
		noc;
	}
}
Hanane HADJI's avatar
Hanane HADJI committed
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
--------------------------------EmptySynchronizedBlock---------------------------------------------

-- A Measure instance if the class violates the rule 'EmptySynchronizedBlock'
rule MeasureEmptySynchronizedBlock(synchronizedBlock: java!SynchronizedStatement) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'Empty Synchronized Block ',
			shortDescription <- 'Empty Synchronized Block serve no purpose and should be removed.'
		),
		measurement: smm!DirectMeasurement (
				error <- 'EmptySynchronizedBlock is detected in ' + synchronizedBlock.originalCompilationUnit.name
		)
	do {
		noc;
	}
}
--------------------- EmptyFinallyBlock----------------------------------
--A measure instance if the class violates the rule EmptyFinallyBlock.
rule MeasureEmptyFinallyBlock(finallyBlock : java!TryStatement) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'EmptyFinallyBlock',
			shortDescription <- ': Avoid empty Finally blocks - what s the point?'
		),
		measurement: smm!DirectMeasurement (
			error <- 'EmptyFinallyBlock is detected in ' + finallyBlock.originalCompilationUnit.name
		)
	do {
		noc; 
	}
}
1249

Hanane HADJI's avatar
Hanane HADJI committed
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
--------------------- EmptyFinalizer----------------------------------
--A measure instance if the class violates the rule EmptyFinalizer.
rule MeasureEmptyFinalizer(finalizeMethod : java!MethodDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'EmptyFinalizer',
			shortDescription <- ': Avoid empty Finalizer  - what s the point?'
		),
		measurement: smm!DirectMeasurement (
			error <- 'EmptyFinalizer is detected in ' + finalizeMethod.originalCompilationUnit.name
		)
	do {
		noc; 
	}
}
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
-------------------------------------------UseAssertSameInsteadOfAssertTrue----------------------------------------------
-- A Measure instance if the class violate the rule AssertSameInsteadOfAssertTrue
rule MesureUseAssertSameInsteadOfAssertTrue(tab :java!Package) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
	noc: smm!DimensionalMeasure (
			name <- 'Use AssertSame Instead Of AssertTrue',
			shortDescription <- 'Use AssertSame Instead Of AssertTrue'
		),
		measurement: smm!DirectMeasurement (
			error<- 'Use AssertSame Instead Of AssertTrue.'
		)
	do {
		noc;
	}
}
1288

E19C506H's avatar
E19C506H committed
1289
-- A Measure instance if the class violates the rule AvoidNoPackageDeclaration.
E19C506H's avatar
E19C506H committed
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
rule MesureAvoidNoPackageDeclaration(class : java!CompilationUnit) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'AvoidNoPackageDeclaration',
			shortDescription <- 'you need to declare some package.'
		),
		measurement: smm!DirectMeasurement (
1301
			error <- class.name + ' class have no package declaration'
E19C506H's avatar
E19C506H committed
1302
1303
1304
1305
1306
		)
	do {
		noc; 
	}
}
E19C506H's avatar
E19C506H committed
1307

E19C506H's avatar
E19C506H committed
1308
-- A Measure instance if the class violates the rule UnconditionalIfStatement.
E19C506H's avatar
E19C506H committed
1309
1310
1311
1312
1313
1314
1315
1316
rule MeasureUnconditionalIfStatement(w: java!IfStatement) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'UnconditionalIfStatement',
1317
			shortDescription <- ': UnconditionalIfStatement'
E19C506H's avatar
E19C506H committed
1318
1319
1320
1321
1322
1323
1324
		),
		measurement: smm!DirectMeasurement (
			error <- 'UnconditionalIfStatement is detected in  ' + w.originalCompilationUnit.name
		)
	do {
		noc; 
	}
E19C506H's avatar
E19C506H committed
1325
1326
}

E19C506H's avatar
E19C506H committed
1327
-- A Measure instance if the class violates the rule EmptyInitializer.
E19C506H's avatar
E19C506H committed
1328
1329
1330
1331
1332
1333
1334
1335
rule MeasureEmptyInitializer(w: java!Initializer) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'EmptyInitializer',
1336
			shortDescription <- ': EmptyInitializer'
E19C506H's avatar
E19C506H committed
1337
1338
		),
		measurement: smm!DirectMeasurement (
1339
			error <- ' class '+w.originalCompilationUnit.name +' hase an empty Initializer! do not declare an EmptyInitializer, EmptyInitializer! this block need to be deleted'
E19C506H's avatar
E19C506H committed
1340
1341
1342
1343
		)
	do {
		noc; 
	}
E19C506H's avatar
E19C506H committed
1344
1345
}

E19C506H's avatar
E19C506H committed
1346
1347
-- A Measure instance if the class violates the rule ExcessiveClassLength.
rule MeasureExcessiveClassLength(w: java!MethodDeclaration) {
E19C506H's avatar
E19C506H committed
1348
1349
1350
1351
1352
1353
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
E19C506H's avatar
E19C506H committed
1354
1355
			name <- 'ExcessiveClassLength',
			shortDescription <- ': class file lengths are usually indications that the class may be burdened with excessive responsibilities that could be provided by external classes or functions'
E19C506H's avatar
E19C506H committed
1356
1357
		),
		measurement: smm!DirectMeasurement (
1358
			error <- ' class '+w.originalCompilationUnit.name+ ' has a block with more than 1000 line of code per a method it may need a separation in the code'
E19C506H's avatar
E19C506H committed
1359
1360
1361
1362
		)
	do {
		noc; 
	}
E19C506H's avatar
E19C506H committed
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
}

-- A Measure instance if the class violates the rule CloneMethodMustBePublic.
rule MeasureCloneMethodMustBePublic(w: java!MethodDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'CloneMethodMustBePublic',
1374
			shortDescription <- ': Clone Method Must Be Public'
E19C506H's avatar
E19C506H committed
1375
1376
		),
		measurement: smm!DirectMeasurement (
1377
			error <- ' class '+w.originalCompilationUnit.name+ ' has a clone methode witch need to be public '
E19C506H's avatar
E19C506H committed
1378
1379
1380
1381
		)
	do {
		noc; 
	}
E19C506H's avatar
E19C506H committed
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
}

-- A Measure instance if the class violates the rule AvoidEnumAsIdentifier.
rule MeasureAvoidEnumAsIdentifier(w: java!VariableDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'AvoidEnumAsIdentifier',
1393
			shortDescription <- ': Avoid Enum As Identifier'
E19C506H's avatar
E19C506H committed
1394
1395
		),
		measurement: smm!DirectMeasurement (
1396
			error <- ' class '+w.originalCompilationUnit.name+ ' has a variable named to enum witch is a reserved name'
E19C506H's avatar
E19C506H committed
1397
1398
1399
1400
		)
	do {
		noc; 
	}
E19C506H's avatar
E19C506H committed
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
}

-- A Measure instance if the class violates the rule AvoidCatchingNPE.
rule MeasureAvoidCatchingNPE(w: java!CatchClause) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'AvoidCatchingNPE',
1412
			shortDescription <- ': Avoid Catching NullPointerExceptions'
E19C506H's avatar
E19C506H committed
1413
1414
		),
		measurement: smm!DirectMeasurement (
1415
			error <- ' class '+w.originalCompilationUnit.name+ ' has a Code that should never
E19C506H's avatar
E19C506H committed
1416
1417
1418
1419
1420
1421
			throw NullPointerExceptions under normal circumstances. A catch block may hide the
			original error, causing other, more subtle problems later on.'
		)
	do {
		noc; 
	}
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
}

-- A Measure instance if the class violates the rule UseProperClassLoader.
rule MeasureUseProperClassLoader(w: java!MethodInvocation) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'UseProperClassLoader',
			shortDescription <- ': Use ProperClassLoader'
		),
		measurement: smm!DirectMeasurement (
			error <- ' class'+ w.originalCompilationUnit.name+ ' Use a statement with getClassLoader(),
			use Thread.currentThread().getContextClassLoader() instead '
		)
	do {
		noc; 
	}
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
}
-------------------------------------------GenericsNaming----------------------------------------------
-- A Measure instance if the class violate the rule GenericsNaming
rule MeasureGenericsNaming(type :java!TypeParameter) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'GenericsNaming',
			shortDescription <- 'Names for references to generic values should be limited to a single uppercase letter.'
		),
		measurement: smm!DirectMeasurement (
			error<- 'The generic type ' + type.name + ' should be limited to a single uppercase letter.'
		)
	do {
		noc;
	}
}
-------------------------------------------MisLeadingVariableName----------------------------------------------
-- A Measure instance if the class violate the rule MisLeadingVariableName
rule MeasureMisLeadingVariableName(variable :java!VariableDeclarationFragment) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'MisLeadingVariableName',
1472
			shortDescription <- 'Detects when a non-field has a name starting with �m_�. This usually denotes a field and could be confusing.'
1473
1474
		),
		measurement: smm!DirectMeasurement (
1475
			error<- 'Variable ' + variable.name + ' should not start with �m_� as it is not a field.'
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
		)
	do {
		noc;
	}
}
-------------------------------------------AvoidCatchingThrowable----------------------------------------------
-- A Measure instance if the class violate the rule MisLeadingVariableName
rule MeasureAvoidCatchingThrowable(catch :java!CatchClause) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'AvoidCatchingThrowable',
			shortDescription <- 'Catching Throwable errors is not recommended since its scope is very broad. It includes runtime issues such as OutOfMemoryError that should be exposed and managed separately.'
		),
		measurement: smm!DirectMeasurement (
			error<- 'Throwable ' + catch.exception.name + ' should not be catched.'
		)
	do {
		noc;
	}
}
-------------------------------------------DoNotCallGarbageCollectionExplicitly----------------------------------------------
-- A Measure instance if the class violate the rule DoNotCallGarbageCollectionExplicitly
rule MeasureDoNotCallGarbageCollectionExplicitly(method : java!MethodInvocation) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'DoNotCallGarbageCollectionExplicitly',
			shortDescription <- 'Calls to System.gc(), Runtime.getRuntime().gc(), and System.runFinalization() are not advised.'
		),
		measurement: smm!DirectMeasurement (
			error<- 'Garbage collector is called explicitly in ' + method.originalCompilationUnit.name
		)
	do {
		noc;
	}
}
-------------------------------------------EmptyCatchBlock----------------------------------------------
-- A Measure instance if the class violate the rule EmptyCatchBlock
rule MeasureEmptyCatchBlock(catch : java!CatchClause) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'EmptyCatchBlock',
			shortDescription <- 'Empty Catch Block finds instances where an exception is caught, but nothing is done. In most circumstances, this swallows an exception which should either be acted on or reported.'
		),
		measurement: smm!DirectMeasurement (
			error<- 'Empty catch block in ' + catch.originalCompilationUnit.name
		)
	do {
		noc;
	}
}
-------------------------------------------ImportFromSamePackage----------------------------------------------
-- A Measure instance if the class violate the rule ImportFromSamePackage
rule MeasureImportFromSamePackage(import : java!ImportDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'ImportFromSamePackage',
			shortDescription <- 'There is no need to import a type that lives in the same package.'
		),
		measurement: smm!DirectMeasurement (
			error<- 'No need to import ' + import.importedElement.name + ' in ' + import.originalCompilationUnit.name
		)
	do {
		noc;
	}
}
-------------------------------------------MethodWithSameNameAsEnclosingClass----------------------------------------------
-- A Measure instance if the class violate the rule MethodWithSameNameAsEnclosingClass
rule MeasureMethodWithSameNameAsEnclosingClass(method : java!MethodDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'MethodWithSameNameAsEnclosingClass',
			shortDescription <- 'Non-constructor methods should not have the same name as the enclosing class.'
		),
		measurement: smm!DirectMeasurement (
			error<- 'Method ' + method.name + ' has the same name as ' + method.originalCompilationUnit.name + ' and is not a contructor.'
		)
	do {
		noc;
	}
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
}

--------------------------------------------- ExcessiveImports ---------------------------------------------
-- creates a new Measure when a class has more than 4 imports
rule MeasureExcessiveImports(i : java!CompilationUnit) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'ExcessiveImports',
			shortDescription <- 'A high number of imports can indicate a high degree of coupling within an object. This rule counts the number of unique imports and reports a violation if the count is above the user-specified threshold.'		
		),
		measurement: smm!DirectMeasurement (			
			error<-'The class '+ i.name + ' has an excessive imports.',
			value<- i.imports.size()
		)
	do {
		noc; 
	}
}

--------------------------------------------- IfStmtsMustUseBraces ---------------------------------------------
-- creates a new Measure when a class that contains an if statement without braces.
rule MeasureIfStmtsMustUseBraces(i : java!IfStatement) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'If then Statement must use braces',
			shortDescription <- 'Deprecated Avoid using if statements without using braces to surround the code block. If the code formatting...'		
		),
		measurement: smm!DirectMeasurement (			
			error <- 'The class ' + condition.originalCompilationUnit.name +  ' has an if statement without braces. '
		)
	do {
		noc; 
	}
}

--------------------------------------------- SimplifyBooleanAssertion ---------------------------------------------
-- creates a new Measure when a class contains a negation in an assertTrue or assertFalse.
rule MeasureSimplifyBooleanAssertion(i : java!PrefixExpression) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'SimplifyBooleanAssertion',
			shortDescription <- 'Avoid negation in an assertTrue or assertFalse test.'		
		),
		measurement: smm!DirectMeasurement (			
			error<-'The method test ' + i.eContainer().eContainer().eContainer().eContainer().name + ' contains a negation in an assertTrue or assertFalse.'
		)
	do {
		noc; 
	}
}

--------------------------------------------- AbstractClassWithoutAnyMethod ---------------------------------------------
-- creates a new Measure when an abstract class does not provides any methods.

rule MeasureAbstractClassWithoutAnyMethod(i : java!ClassDeclaration) {
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
			name <- 'AbstractClassWithoutAnyMethod',
			shortDescription <- 'If an abstract class does not provides any methods, it may be acting as a simple data containerth...'		
		),
		measurement: smm!DirectMeasurement (			
			error<-'The class anstract' + i.name + ' has not method.'
		)
	do {
		noc; 
	}
}