ported rules: invalid object initialization and non-portable messages

Johan Brichau · Johan Brichau · commit 81bec5c74bc2 · 2024-01-07T16:30:34.000+01:00
diff --git a/repository/Grease-Pharo110-Slime.package/GRInvalidObjectInitializationRule.class/README.md b/repository/Grease-Pharo110-Slime.package/GRInvalidObjectInitializationRule.class/README.md
diff --git a/repository/Grease-Pharo110-Slime.package/GRInvalidObjectInitializationRule.class/class/checksMethod.st b/repository/Grease-Pharo110-Slime.package/GRInvalidObjectInitializationRule.class/class/checksMethod.st
@@ -0,0 +1,4 @@
+testing - interest
+checksMethod
+
+	^ true
diff --git a/repository/Grease-Pharo110-Slime.package/GRInvalidObjectInitializationRule.class/instance/basicCheck..st b/repository/Grease-Pharo110-Slime.package/GRInvalidObjectInitializationRule.class/instance/basicCheck..st
@@ -0,0 +1,10 @@
+running
+basicCheck: aMethod
+
+	^ (aMethod methodClass isMeta not
+		and: [ (aMethod selector beginsWithSubCollection: #initialize)
+		and: [ aMethod selector numArgs > 0
+		and: [ aMethod methodClass ~= GRObject
+		and: [ (aMethod methodClass includesBehavior: GRObject)
+		and: [ (aMethod superMessages includes: aMethod selector) not
+		and: [ aMethod selfMessages noneSatisfy: [ :each | each beginsWithSubCollection: #initialize ] ] ] ] ] ] ])
diff --git a/repository/Grease-Pharo110-Slime.package/GRInvalidObjectInitializationRule.class/instance/group.st b/repository/Grease-Pharo110-Slime.package/GRInvalidObjectInitializationRule.class/instance/group.st
@@ -0,0 +1,4 @@
+accessing
+group
+
+	^ 'Grease Portability'
diff --git a/repository/Grease-Pharo110-Slime.package/GRInvalidObjectInitializationRule.class/instance/name.st b/repository/Grease-Pharo110-Slime.package/GRInvalidObjectInitializationRule.class/instance/name.st
@@ -0,0 +1,4 @@
+accessing
+name
+
+	^ 'Invalid object initialization'
diff --git a/repository/Grease-Pharo110-Slime.package/GRInvalidObjectInitializationRule.class/instance/rationale.st b/repository/Grease-Pharo110-Slime.package/GRInvalidObjectInitializationRule.class/instance/rationale.st
@@ -0,0 +1,4 @@
+accessing
+rationale
+
+	^ 'Initialize methods are required to call the designated initializer or its super implementation.'
diff --git a/repository/Grease-Pharo110-Slime.package/GRInvalidObjectInitializationRule.class/properties.json b/repository/Grease-Pharo110-Slime.package/GRInvalidObjectInitializationRule.class/properties.json
@@ -0,0 +1,11 @@
+{
+	"commentStamp" : "",
+	"super" : "GRReSlimeBlockLintRule",
+	"category" : "Grease-Pharo110-Slime",
+	"classinstvars" : [ ],
+	"pools" : [ ],
+	"classvars" : [ ],
+	"instvars" : [ ],
+	"name" : "GRInvalidObjectInitializationRule",
+	"type" : "normal"
+}
diff --git a/repository/Grease-Pharo110-Slime.package/GRNonPortableMessageRule.class/README.md b/repository/Grease-Pharo110-Slime.package/GRNonPortableMessageRule.class/README.md
diff --git a/repository/Grease-Pharo110-Slime.package/GRNonPortableMessageRule.class/class/checksNode.st b/repository/Grease-Pharo110-Slime.package/GRNonPortableMessageRule.class/class/checksNode.st
@@ -0,0 +1,4 @@
+testing - interest
+checksNode
+
+	^ true
diff --git a/repository/Grease-Pharo110-Slime.package/GRNonPortableMessageRule.class/instance/basicCheck..st b/repository/Grease-Pharo110-Slime.package/GRNonPortableMessageRule.class/instance/basicCheck..st
@@ -0,0 +1,4 @@
+running
+basicCheck: anEntity
+
+	^ anEntity isMessage and:[ self methodNames includes: anEntity selector ]
diff --git a/repository/Grease-Pharo110-Slime.package/GRNonPortableMessageRule.class/instance/group.st b/repository/Grease-Pharo110-Slime.package/GRNonPortableMessageRule.class/instance/group.st
@@ -0,0 +1,4 @@
+accessing
+group
+
+	^ 'Grease Portability'
diff --git a/repository/Grease-Pharo110-Slime.package/GRNonPortableMessageRule.class/instance/methodNames.st b/repository/Grease-Pharo110-Slime.package/GRNonPortableMessageRule.class/instance/methodNames.st
@@ -0,0 +1,4 @@
+private
+methodNames
+
+	^ #( anyOne withIndexCollect: )
diff --git a/repository/Grease-Pharo110-Slime.package/GRNonPortableMessageRule.class/instance/name.st b/repository/Grease-Pharo110-Slime.package/GRNonPortableMessageRule.class/instance/name.st
@@ -0,0 +1,4 @@
+accessing
+name
+
+	^ 'Uses non portable message'
diff --git a/repository/Grease-Pharo110-Slime.package/GRNonPortableMessageRule.class/instance/rationale.st b/repository/Grease-Pharo110-Slime.package/GRNonPortableMessageRule.class/instance/rationale.st
@@ -0,0 +1,4 @@
+accessing
+rationale
+
+	^ 'Some methods are not portable accross different Smalltalk dialects.'
diff --git a/repository/Grease-Pharo110-Slime.package/GRNonPortableMessageRule.class/properties.json b/repository/Grease-Pharo110-Slime.package/GRNonPortableMessageRule.class/properties.json
@@ -0,0 +1,11 @@
+{
+	"commentStamp" : "",
+	"super" : "GRReSlimeBlockLintRule",
+	"category" : "Grease-Pharo110-Slime",
+	"classinstvars" : [ ],
+	"pools" : [ ],
+	"classvars" : [ ],
+	"instvars" : [ ],
+	"name" : "GRNonPortableMessageRule",
+	"type" : "normal"
+}
diff --git a/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/assertRule.expectedMatches..st b/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/assertRule.expectedMatches..st
diff --git a/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/assertRule.expectedMatches.ignoring..st b/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/assertRule.expectedMatches.ignoring..st
diff --git a/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/assertRule.matches..st b/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/assertRule.matches..st
@@ -0,0 +1,4 @@
+running-checks
+assertRule: aRuleClass matches: expectedMatches
+
+	self assertRule: aRuleClass matches: expectedMatches ignoring: Array new
diff --git a/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/assertRule.matches.ignoring..st b/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/assertRule.matches.ignoring..st
@@ -0,0 +1,13 @@
+running-checks
+assertRule: aRuleClass matches: expectedMatches ignoring: ignoredRuleClasses
+
+	self run: aRuleClass ignoring: ignoredRuleClasses do: [ :critiques | | critiquedEntities |
+		critiquedEntities := critiques collect:[ :critique | critique sourceAnchor entity ].
+		critiquedEntities do:[ :critiquedEntity |
+			self
+				assert: (expectedMatches includes: critiquedEntity)
+				description: ('{1} should not be reported' format: { critiquedEntity printString }) ].
+		expectedMatches do: [ :expectedEntity |
+			self
+				assert: (critiquedEntities includes: expectedEntity)
+				description: ('{1} should be reported' format: { expectedEntity printString }) ] ]
diff --git a/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/rules.st b/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/rules.st
@@ -4,4 +4,5 @@ rules
 		addAll: GRReSlimeBlockLintRule allSubclasses;
 		addAll: GRReSlimeParseTreeLintRule allSubclasses;
 "		addAll: GRSlimeTransformationRule allSubclasses;"
+		add: ReMultiplePeriodsTerminatingStatementRule;
 		yourself
diff --git a/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/run.ignoring.do..st b/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/run.ignoring.do..st
@@ -1,5 +1,5 @@
 running-checks
-run: aRuleClass ignoring: aCollectionOfEntities do: aBlock
+run: aRuleClass ignoring: ignoredRuleClasses do: aBlock
 
 	| rules rule runner |
 	rules := self rules
@@ -22,7 +22,7 @@ run: aRuleClass ignoring: aCollectionOfEntities do: aBlock
 	rules do: [ :each | | result |
 		result := runner criticsOf: each. 
 		self 
-			assert: (rule = each or: [ result isEmpty "and: [ each changes isEmpty ]) or: [ aCollectionOfEntities includes: each class ]" ])
-			description: each name , ' should not report errors' ].
+			assert: (rule = each or: [ result isEmpty or: [ ignoredRuleClasses includes: each class ] ])
+			description: ('{1} should not report errors' format: { each name })  ].
 	aBlock value: (runner criticsOf: rule).
 	^ rule
diff --git a/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/testBasicNewInitializeMissing.st b/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/testBasicNewInitializeMissing.st
@@ -6,4 +6,4 @@ testBasicNewInitializeMissing
 	self compile:  'initialize' in: class.
 	self
 		assertRule: GRBasicNewInitializeMissingRule
-		expectedMatches: { class }
+		matches: { class }
diff --git a/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/testDeprecatedApiProtocol.st b/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/testDeprecatedApiProtocol.st
@@ -8,4 +8,4 @@ testDeprecatedApiProtocol
 	self compile: 'deprecated3 self greaseDeprecatedApi: ''GRSlimeMock>>#deprecated3'' details: ''Something.''' in: class.
 	self 
 		assertRule: GRDeprecatedApiProtocolRule
-		expectedMatches: { class>>#deprecated2 . class>>#deprecated3 }
+		matches: { class>>#deprecated2 . class>>#deprecated3 }
diff --git a/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/testEmptyStatements.st b/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/testEmptyStatements.st
@@ -1,13 +1,15 @@
 tests-block
 testEmptyStatements
+	"We added this test to make sure that this Pharo-supplied rule works because we previously had this one in Grease and it is important."
 	<expectedFailure>
+
 	| class |
 	class := self defineSubClassOf: #GRObject.
 	self compile: 'emptyStatement1. self and' in: class.
 	self compile: 'emptyStatement2 self and..' in: class.
 	self compile: 'emptyStatement3 self and."foo".' in: class.
 	self compile: 'emptyStatement4 self and."foo".self and' in: class.
 	self 
-		runRule: GREmptyStatementsRule
-		selectors: #(emptyStatement1 emptyStatement2 emptyStatement3 emptyStatement4)
+		assertRule: ReMultiplePeriodsTerminatingStatementRule
+		matches: { class>>#emptyStatement1 . class>>#emptyStatement2 . class>>#emptyStatement3 . class>>#emptyStatement4 }
 		ignoring: (Array with: GRUnnecessaryLastPeriodRule)
diff --git a/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/testInvalidObjectInitialization.st b/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/testInvalidObjectInitialization.st
@@ -1,9 +1,9 @@
 tests-block
 testInvalidObjectInitialization
-	<expectedFailure>
+
 	| class |
 	class := self defineSubClassOf: #GRObject.
 	self compile:  'initializeFoo: aNumber' in: class.
 	self 
-		runRule: GRInvalidObjectInitializationRule
-		selectors: #(initializeFoo:)
+		assertRule: GRInvalidObjectInitializationRule
+		matches: { class>>#initializeFoo: }
diff --git a/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/testNonPortableMessageRule.st b/repository/Grease-Tests-Pharo-Slime.package/GRReSlimeTest.class/instance/testNonPortableMessageRule.st
@@ -1,6 +1,6 @@
 tests-block
 testNonPortableMessageRule
-	<expectedFailure>
+
 	| class |
 	class := self defineSubClassOf: #GRObject.
 
@@ -11,5 +11,5 @@ testNonPortableMessageRule
 	self compile: 'valid2 ^ Array new do: [ :each | each hash ]' in: class.
 
 	self 
-		runRule: GRNonPortableMessageRule
-		selectors: #(invalid1 invalid2)
+		assertRule: GRNonPortableMessageRule
+		matches: { class>>#invalid1 . class>>#invalid2 }

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +testing - interest
 +checksMethod
++
 +	^ true