analysis.atl 22.7 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

Roxane MARECHAL's avatar
Roxane MARECHAL committed
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

Raphael PAGE's avatar
Raphael PAGE committed
33
	Set{	
34
35
36
37
38
39
40
		-- Example rule
		--
		thisModule.numberOfClasses(),
		
		-- Multithreading rules
		--
		thisModule.dontCallThreadRun(),
41
		thisModule.avoidThreadGroup(),
42
		thisModule.useNotifyAllInsteadOfNotify(),
43
44
45
46
47
48
49
50
51
52
53
		
		-- Code Style rules
		--
		thisModule.shortMethodName(),
		thisModule.tooManyStaticImports(),
		thisModule.AvoidDollarSigns() ,
		
		-- Design rules
		--
		thisModule.tooManyFields(),
		thisModule.tooManyMethods(),
54
		thisModule.returnFromFinallyBlock(),
55
56
		thisModule.longInstantiation(),
		thisModule.shortInstantiation(),
57
		thisModule.returnEmptyArrayRatherThanNull(),
58
		thisModule.excessiveParameterList(),
59
60
61
		
		-- Performance rules
		--
Raphael PAGE's avatar
Raphael PAGE committed
62
		thisModule.uselessStringValueOf(),
63
		thisModule.tooFewBranchesForASwitchStatement(),
Raphael PAGE's avatar
Raphael PAGE committed
64
		thisModule.useIndexOfChar(),
65
		thisModule.avoidPrintStackTrace(),
Glenn PLOUHINEC's avatar
Glenn PLOUHINEC committed
66
		thisModule.avoidUsingShortType(),
67
		thisModule.emptyStatementBlock(),
68
		
Roxane MARECHAL's avatar
Roxane MARECHAL committed
69
70
71
72
		-- Documentation rules
		--
		thisModule.commentRequired(),

73
74
		-- Error prone rules
		--
75
		thisModule.missingBreakInSwitch(),
76
77
		thisModule.doNotExtendJavaLangThrowable(),
		thisModule.doNotExtendJavaLangError(),
78
79
		
		-- Best practicices rules
80
		thisModule.avoidThrowingNewInstanceOfSameException()
Gerson Sunyé's avatar
Gerson Sunyé committed
81
82
};

Raphael PAGE's avatar
Raphael PAGE committed
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

-- 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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
-- Rule for metrics AvoidDollarSigns : return the set of class Measures that violates the rule.
helper def: AvoidDollarSigns() : Set(smm!Measure) =
	-- Browse through all variable/method/class/interface. 
	java!TypeDeclaration.allInstances()->union(java!MethodDeclaration.allInstances())->union(java!VariableDeclaration.allInstances())->iterate(i; res : Set(smm!Measure) = Set{} |
		-- Add a new measurement if the name contains a dollar.
		if i.name.indexOf('$') <> -1
		then res->union(Set{thisModule.MesureAvoidDollarSigns(i)})
		else res
		endif
	);


-- 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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155


-- 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
156

Raphael's avatar
Raphael committed
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

-- 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
172
173
174
175
176
	do {
		noc; 
	}
}

177

Gerson Sunyé's avatar
Gerson Sunyé committed
178

179
helper def: numberFieldsInClasse(s:java!ClassDeclaration) : Integer =
Astlo's avatar
Astlo committed
180
	-- Return the number of FieldDeclaration in a class.
181
	s.bodyDeclarations-> select(r | r.oclIsTypeOf(java!FieldDeclaration))->size();
182

Astlo's avatar
Astlo committed
183
-- A Measure instance if the class violates the rule 'TooManyFields'.
184
rule MesureTooManyFields(class : java!ClassDeclaration) {
Gerson Sunyé's avatar
Gerson Sunyé committed
185
186
187
188
189
190
	to
		om: smm!ObservedMeasure (
			measure <- noc,
			measurements <- measurement
		),
		noc: smm!DimensionalMeasure (
Astlo's avatar
Astlo committed
191
192
			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
193
194
		),
		measurement: smm!DirectMeasurement (
Astlo's avatar
Astlo committed
195
			error <- class.originalCompilationUnit.name + ' have too many fields'
Gerson Sunyé's avatar
Gerson Sunyé committed
196
		)
Raphael's avatar
Raphael committed
197
198
199
200
201
	do {
		noc; 
	}
}

Raphael's avatar
Raphael committed
202

Raphael's avatar
Raphael committed
203
-- 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
204
205
206
207
208
209
210
211
212
213
214
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
215
			error<- 'The class '+ method.originalCompilationUnit.name + ' violates the rule index of char.'
Raphael's avatar
Raphael committed
216
217
218
219
220
		)
	do {
		noc; 
	}
}
Gerson Sunyé's avatar
Gerson Sunyé committed
221

Raphael PAGE's avatar
Raphael PAGE committed
222
223
------------------------------------------------------------------------------------------

Gerson Sunyé's avatar
Gerson Sunyé committed
224
225
226
227
228
229
230
231
232
233
234
235
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
236

Gerson Sunyé's avatar
Gerson Sunyé committed
237
238
239
240
	do {
		noc; 
	}
}
241

Glenn PLOUHINEC's avatar
Glenn PLOUHINEC committed
242

243
-- Rule that creates an instance of Measure for the switch statement with too few branches passed in parameter  
244
rule MeasureTooFewBranchesForASwitchStatement(switchStatement: java!SwitchStatement) {
245
246
247
248
249
250
	to
		om: smm!ObservedMeasure (
			measure <- tooFewBranchesForASwitchStatement,
			measurements <- measurement
		),
		tooFewBranchesForASwitchStatement: smm!DimensionalMeasure (
251
252
			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.'
253
254
		),
		measurement: smm!DirectMeasurement (
255
			error <- 'Too few branches for SwitchStatement in Class : ' + switchStatement.originalCompilationUnit.name,
256
257
258
259
260
261
			value <- thisModule.nbBranchesOfASwitchStatement(switchStatement)
		)
	do {
		tooFewBranchesForASwitchStatement; 
	}
}
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326

--------------------------------------------- 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; 
	}
}
327
328
329
	
-- Returns the number of branches in the switch statement passed in parameter
helper def: nbBranchesOfASwitchStatement(switchStatement:java!SwitchStatement) : Integer =
330
331
332
	switchStatement.statements->select(each | each.oclIsTypeOf(java!SwitchCase)).size()
;

Martin's avatar
Martin committed
333

334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
-- 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
371
372
373
374
375
376
377
378
379
380
381
382
-- 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
383
			error <- class.originalCompilationUnit.name + ' has too many methods'
Martin's avatar
Martin committed
384
385
386
387
388
389
		)

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

391
-- A Measure instance if the class violates the rule ReturnFromFinallyBlock.
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426

-- 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
427
428
}

Raphael PAGE's avatar
Raphael PAGE committed
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
-- 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
447
448
449
450
451
452
453
454

-- 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
		),
455
		noc: smm!DimnsionalMeasure (
Raphael's avatar
Raphael committed
456
457
458
459
460
461
462
			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
463
464
465
	do {
		noc; 
	}
Raphael PAGE's avatar
Raphael PAGE committed
466
}
467

468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
--------------------------------------------- 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; 
	}
}

488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
--------------------------------------------- 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; 
	}
}
507

508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
--------------------------------------------- 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; 
	}
}

528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
-- 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; 
	}
}
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564

-- 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
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604

-- Creates a measure instance for each element that violates the rule : CommentRequired
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 (
			error <- 'Violated the properties  {' + violatedProperties + '} in Class: ' + element.originalCompilationUnit.name + ' -> ' + element.oclType().name + ': ' + element.modifier.visibility + ' ' + thisModule.getBodyDeclarationName(element)
		)
		do {
		commentRequired; 
		}
}

-- Returns the declaration name of a BodyDeclaration
-- In FielDeclaration, the attribute 'name' is NULL, this information is contained in "fragments" instead
helper def: getBodyDeclarationName(elem: java!BodyDeclaration): String = 
	if (elem.oclIsTypeOf(java!FieldDeclaration)) 
		then elem.fragments.first().name
		else elem.name
	endif
;

-- Returns the AnnotationTypeDeclaration corresponding to the given BodyDeclaration
-- 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
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627

-- 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;
	}
}
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646

-- 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;
	}
}
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668

--------------------------------------------- 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; 
	}
}