Typo + add comments for creation of a new cleaner.

jecisc · Apr 21, 2020 · f12483b · f12483b
1 parent e15dda3
commit f12483b
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 8 deletions.
diff --git a/src/Chanel-Tests/ChanelAbstractCleanerTest.class.st b/src/Chanel-Tests/ChanelAbstractCleanerTest.class.st
@@ -1,5 +1,14 @@
 "
-A ChanelAbstractCleanerTest is a test class for testing the behavior of ChanelAbstractCleaner
+A ChanelAbstractCleanerTest is a test class for testing the behavior of ChanelAbstractCleaner.
+
+List of special cases to take into account when writing a new cleaner (add tests for them):
+- Should it apply on classe side?
+- Should it apply on traits? In that case, ensure the methods are not duplicated in the user classes
+- Ensure extension methods are not moved of protocol
+- When rewriting the content of a method: ensure we do not create an infinit loop by calling self
+- If it concern only test cases, test on non test cases
+- What should happen if the method is empty?
+- Be careful of methods with pragmas which can be special cases. (for example, do not remove empty methods with a pragma)
 "
 Class {
 	#name : #ChanelAbstractCleanerTest,

diff --git a/src/Chanel-Tests/ChanelMethodsOnlyCallingSuperCleanerTest.class.st b/src/Chanel-Tests/ChanelMethodsOnlyCallingSuperCleanerTest.class.st
@@ -81,7 +81,7 @@ ChanelMethodsOnlyCallingSuperCleanerTest >> testDoesNotRemoveMethodWithPragma [
 ]
 
 { #category : #tests }
-ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveBinaryMethodOnlyCollingSuper [
+ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveBinaryMethodOnlyCallingSuper [
 	class
 		compile:
 			'= aString
@@ -93,7 +93,7 @@ ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveBinaryMethodOnlyCollingSup
 ]
 
 { #category : #tests }
-ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveKeywordMethodOnlyCollingSuper [
+ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveKeywordMethodOnlyCallingSuper [
 	class
 		compile:
 			'initialize: aString
@@ -105,7 +105,7 @@ ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveKeywordMethodOnlyCollingSu
 ]
 
 { #category : #tests }
-ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveMethodOnlyCollingSuper [
+ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveMethodOnlyCallingSuper [
 	class
 		compile:
 			'initialize
@@ -117,7 +117,7 @@ ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveMethodOnlyCollingSuper [
 ]
 
 { #category : #tests }
-ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveMethodOnlyCollingSuper2 [
+ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveMethodOnlyCallingSuper2 [
 	class
 		compile:
 			'initialize
@@ -130,7 +130,7 @@ ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveMethodOnlyCollingSuper2 [
 ]
 
 { #category : #tests }
-ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveMethodOnlyCollingSuperEvenIfThereIsAReturn [
+ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveMethodOnlyCallingSuperEvenIfThereIsAReturn [
 	class
 		compile:
 			'initialize
@@ -142,7 +142,7 @@ ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveMethodOnlyCollingSuperEven
 ]
 
 { #category : #tests }
-ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveMethodOnlyCollingSuperInTrait [
+ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveMethodOnlyCallingSuperInTrait [
 	| trait |
 	trait := self createDefaultTrait.
 
@@ -160,7 +160,7 @@ ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveMethodOnlyCollingSuperInTr
 ]
 
 { #category : #tests }
-ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveMethodOnlyCollingSuperOnClassSide [
+ChanelMethodsOnlyCallingSuperCleanerTest >> testRemoveMethodOnlyCallingSuperOnClassSide [
 	class class
 		compile:
 			'initialize