When QualityAssistant Meets Pharo: Enforced Code Critiques Motivate More Valuable Rules

transcript

@yuriy_tymchuk

When QualityAssistant Meets Pharo Enforced Code Critiques Motivate

More Valuable Rules

, Mohammad Ghafari, Oscar Nierstrasz Software Composition Group @ University of Bern

The Concept

Rule Critique

produces

The Concept

Rule Critique

produces

The Concept

Rule Critique

[|]Code

produces

improves

The Concept

Rule Critique

[|]Code

produces

improves (feedback)

improves

The Concept

Rule Critique

[|]Code

produces

improves (feedback)

improves

The Concept

Rule Critique

[|]Code

produces

improves

The Concept

Rule Critique

[|]Code

produces

improves

The Existing CriticBrowser

Newly Introduced QualityAssistant

SmallLint Issues per Milestone

Pharo 3 Pharo 4 Pharo 5 Pharo 6*

Changes in Rules

Fixed Removed

Changes in Rules

Fixed Removed

(Collection>>#add:) protocol #adding

(Collection>>#add:) protocol

(ArrayedCollection>>#add:) protocol #adding

#adding

#accessing

(Collection>>#add:) protocol#'as yet unclassified'

Trivial Bug

RBModi!esCollectionRule

Horrible Bug

Removed

Probably missing ‘; yourself’

Non-blocks in special messages

References an abstract class

Removed

References an abstract classsize = 1 ifTrue: ’:’ ifFalse: ’s:’

Removed

References an abstract classString new

size = 1 ifTrue: ’:’ ifFalse: ’s:’

Removed

References an abstract classString new

size = 1 ifTrue: ’:’ ifFalse: ’s:’

Educational

assert: a = b

ifNotNilDo: ifNotNil:

Smalltalk at: Smalltalk globals at:

assert: a equals: b

assert: a = b

assert: a equals: b

Migration

assert: a = b

assert: a equals: b

Migration

Recipe: use rewrite rules

BoxedFloat64 reference to

Private Access

BoxedFloat64 reference to

Recipe: annotate/maintain a collection of system classes/methods

Private Access

b := RTMondrian new. b edges connectFrom: #superclass. b nodes: RTShape withAllSubclasses.

Invocation order

Recipe:initialize super initialize. self add: #edges requiresPreSend: #nodes:.

Invocation Order

ReAbstractRule class >> #checksPackage; >> #checksClass; >> #checksMethod; >> #checksNode

Class Structure

ReAbstractRule class >> #checksPackage; >> #checksClass; >> #checksMethod; >> #checksNode

Recipe:(aClass inheritsFrom: ReAbstractRule) and: [ selectors anySatisfy: [ :s | aClass perform: s ] ]

Class Structure

gtInspectorMethodsIn: composite <gtInspectorPresentationOrder: 20> | methods | methods := (self methods collect: #asRingDefinition) sorted: [ :x :y | x selector < y selector ] composite list title: 'Methods'; display: methods; format: #selector; tags: [ :each | {each methodClass name} ]

gtInspectorMethodsIn: composite <gtInspectorPresentationOrder: 20> composite list title: 'Methods'; display: ((self methods collect: #asRingDefinition) sorted: [ :x :y | x selector < y selector ]);

format: #selector; tags: [ :each | {each methodClass name} ]

gtInspectorMethodsIn: composite <gtInspectorPresentationOrder: 20> composite list title: 'Methods'; display: [ (self methods collect: #asRingDefinition) sorted: [ :x :y | x selector < y selector ] ]; format: #selector; tags: [ :each | {each methodClass name} ]

Added Lazy evaluation

gtInspectorMethodsIn: composite <gtInspectorPresentationOrder: 20> composite list title: 'Methods'; display: [ (self methods collect: #asRingDefinition) sorted: [ :x :y | x selector < y selector ] ]; format: #selector; tags: [ :each | {each methodClass name} ]

Added Lazy evaluation

Recipe:presentation: aPresentation isTheLeftmostRecepientIn: aStatement

^ (aStatement isMessage or: [ aStatement isCascade ]) and: [ aStatement leftmostChainReceiver = aPresentation ]

Feedback

http://renraku.inf.usi.ch/rules

Feedbackhttp://renraku.inf.usi.ch/rules

@yuriy_tymchuk

More Valuable Rules

@yuriy_tymchuk

More Valuable Rules

Important Fixes

@yuriy_tymchuk

More Valuable Rules

Important Fixes

Educational Rules Removed

@yuriy_tymchuk

More Valuable Rules

Important Fixes

Domain Rules Added

@yuriy_tymchuk

More Valuable Rules

Important Fixes

Domain Rules Added

Migration

@yuriy_tymchuk

More Valuable Rules

Important Fixes

Domain Rules Added

Migration Private access

@yuriy_tymchuk

More Valuable Rules

Important Fixes

Domain Rules Added

Migration Private access Invocation order

@yuriy_tymchuk

More Valuable Rules

Important Fixes

Domain Rules Added

Migration Private access Invocation order Class structure

@yuriy_tymchuk

More Valuable Rules

Important Fixes

Domain Rules Added

Migration Private access Invocation order Class structure Lazy evaluation