Merge pull request #71 from hpi-swa-lab/bugfix/styling

JoeAtHPI · web-flow · commit d7aa6980783e · 2021-10-24T22:35:42.000+02:00
Fixes styling for empty method bodies
diff --git a/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerAddsExamplesMorphFor..st b/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerAddsExamplesMorphFor..st
@@ -0,0 +1,10 @@
+tests
+testStylerAddsExamplesMorphFor: anOriginalSourceCode
+	
+	| formattedSourceCode attributes |
+	formattedSourceCode := styler format: anOriginalSourceCode.
+	
+	attributes := formattedSourceCode attributesAt: (formattedSourceCode asString indexOf: Character startOfHeader).
+	attributes := attributes select: [:anAttribute | styler hasExamplesMorph: anAttribute].
+	self assert: 1 equals: attributes size.
+	
diff --git a/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerAddsExamplesMorphForEmptyMethodBody.st b/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerAddsExamplesMorphForEmptyMethodBody.st
@@ -0,0 +1,5 @@
+tests
+testStylerAddsExamplesMorphForEmptyMethodBody
+	
+	self testStylerAddsExamplesMorphFor: 'method' asText.
+	
diff --git a/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerAddsExamplesMorphForEmptyNewLinedMethodBody.st b/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerAddsExamplesMorphForEmptyNewLinedMethodBody.st
@@ -0,0 +1,6 @@
+tests
+testStylerAddsExamplesMorphForEmptyNewLinedMethodBody
+	
+	self testStylerAddsExamplesMorphFor: 'method
+	' asText.
+	
diff --git a/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerAddsExamplesMorphForEmptyTabbedNewLinedMethodBody.st b/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerAddsExamplesMorphForEmptyTabbedNewLinedMethodBody.st
@@ -0,0 +1,6 @@
+tests
+testStylerAddsExamplesMorphForEmptyTabbedNewLinedMethodBody
+	
+	self testStylerAddsExamplesMorphFor: 'method
+		' asText.
+	
diff --git a/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerAddsExamplesMorphForEmptyTwoNewLinedMethodBody.st b/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerAddsExamplesMorphForEmptyTwoNewLinedMethodBody.st
@@ -0,0 +1,7 @@
+tests
+testStylerAddsExamplesMorphForEmptyTwoNewLinedMethodBody
+	
+	self testStylerAddsExamplesMorphFor: 'method
+	
+	' asText.
+	
diff --git a/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerAddsExamplesMorphForSomeFilledMethodBody.st b/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerAddsExamplesMorphForSomeFilledMethodBody.st
@@ -0,0 +1,9 @@
+tests
+testStylerAddsExamplesMorphForSomeFilledMethodBody
+	
+	self testStylerAddsExamplesMorphFor: 'method
+	| a b |
+	a := 1.
+	b := 2.
+	' asText.
+	
diff --git a/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerReusesExamplesMorphWhenStyledAgain.st b/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerReusesExamplesMorphWhenStyledAgain.st
@@ -0,0 +1,16 @@
+tests
+testStylerReusesExamplesMorphWhenStyledAgain
+	
+	| formattedSourceCode oldAttributes newAttributes originalSourceCode |
+	originalSourceCode := 'method' asText.
+	
+	formattedSourceCode := styler format: originalSourceCode.
+	oldAttributes := formattedSourceCode attributesAt: (formattedSourceCode asString indexOf: Character startOfHeader).
+	oldAttributes := oldAttributes select: [:anAttribute | styler hasExamplesMorph: anAttribute].
+	
+	formattedSourceCode := styler format: formattedSourceCode.
+	newAttributes := formattedSourceCode attributesAt: (formattedSourceCode asString indexOf: Character startOfHeader).
+	newAttributes := newAttributes select: [:anAttribute | styler hasExamplesMorph: anAttribute].
+	
+	self assert: oldAttributes first identical: newAttributes first.
+	
diff --git a/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerSetsAnchorAttributeForNestedProbes.st b/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerSetsAnchorAttributeForNestedProbes.st
@@ -6,10 +6,10 @@ testStylerSetsAnchorAttributeForNestedProbes
 	"<bpProbe id: 1>""<bpProbe id: 2>"2 + 3"</bpProbe>""</bpProbe>"' asText.
 	formattedSourceCode := styler styledTextFor: originalSourceCode.
 	
-	theTextAttributes := (formattedSourceCode attributesAt: 12) select: [:attribute | 
+	theTextAttributes := (formattedSourceCode attributesAt: 11) select: [:attribute | 
 			attribute isKindOf: TextAnchor].
 	self assert: 2 equals: theTextAttributes size.
-	12 to: 16 do: [:offset | 
+	11 to: 15 do: [:offset | 
 		anchorTextAttributes := (formattedSourceCode attributesAt: offset) select: [:attribute | 
 			attribute isKindOf: TextAnchor].
 	
diff --git a/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerSetsAnchorAttributeForProbe.st b/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerSetsAnchorAttributeForProbe.st
@@ -6,9 +6,9 @@ testStylerSetsAnchorAttributeForProbe
 	"<bpProbe id: 31412>"2 + 3"</bpProbe>"' asText.
 	formattedSourceCode := styler styledTextFor: originalSourceCode.
 	
-	theTextAttribute := ((formattedSourceCode attributesAt: 12) select: [:attribute | 
+	theTextAttribute := ((formattedSourceCode attributesAt: 11) select: [:attribute | 
 			attribute isKindOf: TextAnchor]) first.
-	12 to: 16 do: [:offset | 
+	11 to: 15 do: [:offset | 
 		anchorTextAttributes := (formattedSourceCode attributesAt: offset) select: [:attribute | 
 			attribute isKindOf: TextAnchor].
 	
diff --git a/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerSetsAnchorAttributeForProbeOnOperand.st b/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerSetsAnchorAttributeForProbeOnOperand.st
@@ -6,9 +6,9 @@ testStylerSetsAnchorAttributeForProbeOnOperand
 	"<bpProbe id: 31412>"2"</bpProbe>" + 3' asText.
 	formattedSourceCode := styler styledTextFor: originalSourceCode.
 	
-	theTextAttribute := ((formattedSourceCode attributesAt: 12) select: [:attribute | 
+	theTextAttribute := ((formattedSourceCode attributesAt: 11) select: [:attribute | 
 			attribute isKindOf: TextAnchor]) first.
-	12 to: 13 do: [:offset | 
+	11 to: 12 do: [:offset | 
 		anchorTextAttributes := (formattedSourceCode attributesAt: offset) select: [:attribute | 
 			attribute isKindOf: TextAnchor].
 	
diff --git a/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerSetsAnchorAttributeForProbeOnUnaryMessageChain.st b/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerSetsAnchorAttributeForProbeOnUnaryMessageChain.st
@@ -6,9 +6,9 @@ testStylerSetsAnchorAttributeForProbeOnUnaryMessageChain
 	"<bpProbe id: 31412>"2 negated"</bpProbe>" + 3' asText.
 	formattedSourceCode := styler styledTextFor: originalSourceCode.
 	
-	theTextAttribute := ((formattedSourceCode attributesAt: 12) select: [:attribute | 
+	theTextAttribute := ((formattedSourceCode attributesAt: 11) select: [:attribute | 
 			attribute isKindOf: TextAnchor]) first.
-	12 to: 20 do: [:offset | 
+	11 to: 19 do: [:offset | 
 		anchorTextAttributes := (formattedSourceCode attributesAt: offset) select: [:attribute | 
 			attribute isKindOf: TextAnchor].
 	
diff --git a/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerSetsAnchorForAssignmentProbe.st b/packages/Babylonian-Tests.package/BPStylerTest.class/instance/testStylerSetsAnchorForAssignmentProbe.st
@@ -8,9 +8,9 @@ testStylerSetsAnchorForAssignmentProbe
 	"<bpProbe id: 31412>"variable := 2 + 3"</bpProbe>"' asText.
 	formattedSourceCode := styler styledTextFor: originalSourceCode.
 	
-	theTextAttribute := ((formattedSourceCode attributesAt: 26) select: [:attribute | 
+	theTextAttribute := ((formattedSourceCode attributesAt: 25) select: [:attribute | 
 			attribute isKindOf: TextAnchor]) first.
-	26 to: 42 do: [:offset | 
+	25 to: 41 do: [:offset | 
 		anchorTextAttributes := (formattedSourceCode attributesAt: offset) select: [:attribute | 
 			attribute isKindOf: TextAnchor].
 	
diff --git a/packages/Babylonian-Tests.package/BPStylerTest.class/methodProperties.json b/packages/Babylonian-Tests.package/BPStylerTest.class/methodProperties.json
@@ -5,14 +5,21 @@
 		"method" : "pre 7/23/2019 12:04",
 		"runCase" : "pre 12/16/2020 19:16",
 		"setUp" : "jb 12/7/2020 19:10",
+		"testStylerAddsExamplesMorphFor:" : "jb 8/29/2021 20:39",
+		"testStylerAddsExamplesMorphForEmptyMethodBody" : "jb 8/29/2021 20:32",
+		"testStylerAddsExamplesMorphForEmptyNewLinedMethodBody" : "jb 8/29/2021 20:32",
+		"testStylerAddsExamplesMorphForEmptyTabbedNewLinedMethodBody" : "jb 8/29/2021 20:32",
+		"testStylerAddsExamplesMorphForEmptyTwoNewLinedMethodBody" : "jb 8/29/2021 20:32",
+		"testStylerAddsExamplesMorphForSomeFilledMethodBody" : "jb 8/29/2021 20:44",
 		"testStylerCanCopeWithProbeWithinSliderRange" : "jb 12/7/2020 19:10",
-		"testStylerSetsAnchorAttributeForNestedProbes" : "jb 12/7/2020 19:10",
-		"testStylerSetsAnchorAttributeForProbe" : "jb 12/7/2020 19:10",
-		"testStylerSetsAnchorAttributeForProbeOnOperand" : "jb 12/7/2020 19:10",
-		"testStylerSetsAnchorAttributeForProbeOnUnaryMessageChain" : "jb 12/7/2020 19:10",
+		"testStylerReusesExamplesMorphWhenStyledAgain" : "jb 8/29/2021 20:43",
+		"testStylerSetsAnchorAttributeForNestedProbes" : "jb 10/24/2021 22:16",
+		"testStylerSetsAnchorAttributeForProbe" : "jb 10/24/2021 22:16",
+		"testStylerSetsAnchorAttributeForProbeOnOperand" : "jb 10/24/2021 22:17",
+		"testStylerSetsAnchorAttributeForProbeOnUnaryMessageChain" : "jb 10/24/2021 22:17",
 		"testStylerSetsAnchorCharacterForProbe" : "jb 12/7/2020 19:10",
 		"testStylerSetsAnchorForAssertion" : "jb 12/7/2020 19:10",
-		"testStylerSetsAnchorForAssignmentProbe" : "jb 12/7/2020 19:10",
+		"testStylerSetsAnchorForAssignmentProbe" : "jb 10/24/2021 22:17",
 		"testStylerSetsAnchorForExample" : "jb 12/7/2020 19:10",
 		"testStylerSetsAnchorForReplacement" : "jb 12/7/2020 19:10",
 		"testStylerSetsAnchorForScriptExample" : "jb 12/7/2020 19:10",
diff --git a/packages/Babylonian-UI.package/BPStyler.class/instance/extractExistingExamplesMorphFrom.headerEndingAt.ifFound.ifNone..st b/packages/Babylonian-UI.package/BPStyler.class/instance/extractExistingExamplesMorphFrom.headerEndingAt.ifFound.ifNone..st
@@ -0,0 +1,8 @@
+private
+extractExistingExamplesMorphFrom: aText headerEndingAt: anIndex ifFound: aFoundBlock ifNone: anExceptionBlock
+
+	^ (aText attributesAt: anIndex + 2) 
+		detect: [:anAttribute | self hasExamplesMorph: anAttribute]
+		ifFound: aFoundBlock
+		ifNone: anExceptionBlock
+					
diff --git a/packages/Babylonian-UI.package/BPStyler.class/instance/hasExamplesMorph..st b/packages/Babylonian-UI.package/BPStyler.class/instance/hasExamplesMorph..st
@@ -0,0 +1,4 @@
+private
+hasExamplesMorph: aTextAttribute
+	
+	^ (aTextAttribute isKindOf: BPTextAnchor) and: [aTextAttribute anchoredMorph isExamples]
diff --git a/packages/Babylonian-UI.package/BPStyler.class/instance/insertExamplesMorph.into.withNewLineStartingFrom.to..st b/packages/Babylonian-UI.package/BPStyler.class/instance/insertExamplesMorph.into.withNewLineStartingFrom.to..st
@@ -0,0 +1,10 @@
+private
+insertExamplesMorph: aBPExamplesMorph into: aText withNewLineStartingFrom: aStartIndex to: anEndIndex
+	
+	^ (aText size < anEndIndex)
+		ifTrue: [ aText append: (self newLineWithAttributesOf: aBPExamplesMorph)]
+		ifFalse: [ aText 
+					copyReplaceFrom: aStartIndex
+					to: anEndIndex
+					with: (self newLineWithAttributesOf: aBPExamplesMorph)]
+		
diff --git a/packages/Babylonian-UI.package/BPStyler.class/instance/insertExamplesMorphFrom.into.basedOn..st b/packages/Babylonian-UI.package/BPStyler.class/instance/insertExamplesMorphFrom.into.basedOn..st
@@ -7,33 +7,22 @@ insertExamplesMorphFrom: parseResult into: text basedOn: annotations
 		yourself. 
 	endOfHeaderIndex := self extractEndOfMethodHeader value: parseResult.
 	bpExamplesMorph := bpExamples asMorph.
-	
-	self flag: #todo. "tidy this up... --pre"
 	lineAfterHeader := text asString lineCorrespondingToIndex: endOfHeaderIndex + 2.
+	
 	newText := lineAfterHeader withBlanksTrimmed 
-		ifEmpty: ["If there already is an empty line, there might already be an examples
-			morph, if not we can use it"
-			((lineAfterHeader at: 2 ifAbsent: [nil]) = Character startOfHeader and: [
-				(text attributesAt: endOfHeaderIndex + 3) anySatisfy: [:a | 
-					(a isKindOf: BPTextAnchor) and: [a anchoredMorph isExamples]]]) 
-				ifTrue: [
-					(text attributesAt: endOfHeaderIndex + 3) 
-						detect: [:a | (a isKindOf: BPTextAnchor) and: [a anchoredMorph isExamples]]
-						ifFound: [:oldExamplesAnchor | bpExamplesMorph := oldExamplesAnchor anchoredMorph].
-					text]
-				ifFalse: [
-					text 
-						copyReplaceFrom: endOfHeaderIndex + 1
-						to: endOfHeaderIndex + 1 + lineAfterHeader size + 1
-						with: ((Text newFrom: (String cr , String tab , Character startOfHeader , String cr)) 
-								addAllAttributes: {BPTextAnchor new anchoredMorph: bpExamplesMorph; yourself} from: 3 to: 3;
-								yourself)]]
+		ifEmpty: [
+			self extractExistingExamplesMorphFrom: text
+				headerEndingAt: endOfHeaderIndex
+				ifFound: [:oldExamplesAnchor | bpExamplesMorph := oldExamplesAnchor anchoredMorph. text]
+				ifNone: [self insertExamplesMorph: bpExamplesMorph 
+							into: text 
+							withNewLineStartingFrom: endOfHeaderIndex + 1 
+							to: endOfHeaderIndex + 1 + lineAfterHeader size + 1]]
 		ifNotEmpty: [
-			text 
-				copyReplaceFrom: endOfHeaderIndex + 1
-				to: endOfHeaderIndex + 1
-				with: ((Text newFrom: (String cr , String tab , Character startOfHeader , String cr)) 
-						addAllAttributes: {BPTextAnchor new anchoredMorph: bpExamplesMorph; yourself} from: 3 to: 3;
-						yourself)].
-		bpExamplesMorph methodReference: selectedMethod.
-		^ newText
+			self insertExamplesMorph: bpExamplesMorph 
+				into: text 
+				withNewLineStartingFrom: endOfHeaderIndex + 1 
+				to: endOfHeaderIndex + 1].
+			
+	bpExamplesMorph methodReference: selectedMethod.
+	^ newText
diff --git a/packages/Babylonian-UI.package/BPStyler.class/instance/newLineWithAttributesOf..st b/packages/Babylonian-UI.package/BPStyler.class/instance/newLineWithAttributesOf..st
@@ -0,0 +1,7 @@
+private
+newLineWithAttributesOf: aBPExamplesMorph
+
+	^ (Text newFrom: (String cr, Character startOfHeader , String cr)) 
+			addAllAttributes: {BPTextAnchor new anchoredMorph: aBPExamplesMorph; yourself.
+							    TextIndent tabs: 1} from: 2 to: 2;
+			yourself
diff --git a/packages/Babylonian-UI.package/BPStyler.class/methodProperties.json b/packages/Babylonian-UI.package/BPStyler.class/methodProperties.json
@@ -10,10 +10,14 @@
 		"annotationMorphFor:" : "pre 1/6/2021 17:40",
 		"applyAnnotationsFrom:to:" : "pre 1/6/2021 17:49",
 		"extractEndOfMethodHeader" : "pre 8/24/2020 17:04",
+		"extractExistingExamplesMorphFrom:headerEndingAt:ifFound:ifNone:" : "jb 10/24/2021 22:30",
 		"extractIntervals" : "jb 12/3/2020 22:57",
+		"hasExamplesMorph:" : "jb 8/21/2021 15:38",
 		"ifNoSelectedMethod:" : "pre 3/19/2020 11:07",
-		"insertExamplesMorphFrom:into:basedOn:" : "pre 5/6/2021 16:51",
+		"insertExamplesMorph:into:withNewLineStartingFrom:to:" : "jb 8/21/2021 16:29",
+		"insertExamplesMorphFrom:into:basedOn:" : "jb 8/21/2021 16:31",
 		"isAlreadyAnnotatedExpressionAt:in:" : "pre 5/29/2019 22:40",
+		"newLineWithAttributesOf:" : "jb 10/24/2021 21:56",
 		"privateFormat:" : "jb 12/3/2020 23:35",
 		"reformat:basedOn:" : "jb 12/3/2020 22:58",
 		"removePotentialEmptyLinesInText:around:" : "pre 8/25/2020 09:47",
diff --git a/packages/Babylonian-UI.package/BPTextAnchor.class/instance/isOblivious.st b/packages/Babylonian-UI.package/BPTextAnchor.class/instance/isOblivious.st
@@ -1,4 +1,4 @@
-as yet unclassified
+testing
 isOblivious
 
 	^ true

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +tests
 +testStylerAddsExamplesMorphForEmptyMethodBody
++
 +	self testStylerAddsExamplesMorphFor: 'method' asText.
++