Begin management of the return statement (tests fail locally but I think my image is busted :( )

Author: jecisc

src/FAST-Python-Model-Generator/FASTPythonMetamodelGenerator.class.st

@@ -139,7 +139,10 @@ Class {
 		'import',
 		'importedEntity',
 		'fromModule',
-		'tInvocation'
+		'tInvocation',
+		'tStatementBlock',
+		'tReturnStatement',
+		'tStatement'
 	],
 	#category : 'FAST-Python-Model-Generator',
 	#package : 'FAST-Python-Model-Generator'
@@ -177,7 +180,7 @@ FASTPythonMetamodelGenerator >> defineClasses [
 	augmentedAssignment := builder ensureClassNamed: #AugmentedAssignment."Todo"
 	await := builder ensureClassNamed: #Await."Todo"
 	binaryOperator := builder ensureClassNamed: #BinaryOperator.
-	block := builder ensureClassNamed: #Block."Todo"
+	block := builder ensureClassNamed: #Block."To review"
 	boolean := builder ensureClassNamed: #Boolean.
 	booleanOperator := builder ensureClassNamed: #BooleanOperator.
 	breakStatement := builder ensureClassNamed: #BreakStatement."Todo"
@@ -301,18 +304,21 @@ FASTPythonMetamodelGenerator >> defineHierarchy [
 	super defineHierarchy.
 
 	entity --|> tEntity.
-	self flag: #todo. "The next line is WRONG and NEEDS to be reviewed but we currently need it because else everything will break until the MM is in a better state."
+	self flag: #todo. "The next two line are WRONG and NEEDS to be reviewed but we currently need it because else everything will break until the MM is in a better state."
 	entity --|> tExpression.
+	entity --|> tStatement.
 
 	assignment --|> tAssignment.
 
 	attribute --|> structuralEntity.
 
-	booleanOperator --|> operator.
-	booleanOperator --|> tBinaryExpression. "I am not 100% sure this is the best trait to use but it seems to work well for now"
-	
 	binaryOperator --|> operator.
 	binaryOperator --|> tBinaryExpression.
+
+	block --|> tStatementBlock.
+	
+	booleanOperator --|> operator.
+	booleanOperator --|> tBinaryExpression. "I am not 100% sure this is the best trait to use but it seems to work well for now"
 
 	boolean --|> literal.
 	boolean --|> tBooleanLiteral.
@@ -355,6 +361,8 @@ FASTPythonMetamodelGenerator >> defineHierarchy [
 
 	operator --|> expression.
 
+	returnStatement --|> tReturnStatement.
+	
 	string --|> literal.
 	string --|> tStringLiteral.
 
@@ -428,6 +436,9 @@ FASTPythonMetamodelGenerator >> defineTraits [
 	tComment := self remoteTrait: #TComment withPrefix: #FAST.
 	tExpression := self remoteTrait: #TExpression withPrefix: #FAST.
 	tInvocation := self remoteTrait: #TInvocation withPrefix: #FAST. 
+	tReturnStatement := self remoteTrait: #TReturnStatement withPrefix: #FAST.
+	tStatement := self remoteTrait: #TStatement withPrefix: #FAST.
+	tStatementBlock := self remoteTrait: #TStatementBlock withPrefix: #FAST.
 	tLiteral := self remoteTrait: #TLiteral withPrefix: #FAST.
 	tNamedBehaviouralEntity := self remoteTrait: #TNamedBehaviouralEntity withPrefix: #FAST.
 	tNamedEntity := self remoteTrait: #TNamedEntity withPrefix: #FAST.

src/FAST-Python-Model/FASTPyBlock.class.st

@@ -1,6 +1,34 @@
+"
+## Relations
+======================
+
+### Parents
+| Relation | Origin | Opposite | Type | Comment |
+|---|
+| `fastBehaviouralParent` | `FASTTStatementBlock` | `statementBlock` | `FASTTBehaviouralEntity` | Behavioural entity containing the statement block.|
+| `parentLoopStatement` | `FASTTStatement` | `body` | `FASTTLoopStatement` | Optional loop of which this statement is the body|
+| `statementContainer` | `FASTTStatement` | `statements` | `FASTTStatementBlock` | Block containing this statement.|
+
+### Children
+| Relation | Origin | Opposite | Type | Comment |
+|---|
+| `statements` | `FASTTStatementBlock` | `statementContainer` | `FASTTStatement` | Statements enclosed in this block|
+
+
+## Properties
+======================
+
+| Name | Type | Default value | Comment |
+|---|
+| `endPos` | `Number` | nil | |
+| `startPos` | `Number` | nil | |
+
+"
 Class {
 	#name : 'FASTPyBlock',
 	#superclass : 'FASTPyEntity',
+	#traits : 'FASTTStatementBlock',
+	#classTraits : 'FASTTStatementBlock classTrait',
 	#category : 'FAST-Python-Model-Entities',
 	#package : 'FAST-Python-Model',
 	#tag : 'Entities'

src/FAST-Python-Model/FASTPyEntity.class.st

@@ -14,8 +14,10 @@
 | `parentExpression` | `FASTTExpression` | `expression` | `FASTTUnaryExpression` | Parent (unary) expression|
 | `parentExpressionLeft` | `FASTTExpression` | `leftOperand` | `FASTTBinaryExpression` | Parent (binary) expression of which I am left side|
 | `parentExpressionRight` | `FASTTExpression` | `rightOperand` | `FASTTBinaryExpression` | Parent (binary) expression of which I am right side|
+| `parentLoopStatement` | `FASTTStatement` | `body` | `FASTTLoopStatement` | Optional loop of which this statement is the body|
 | `parentUnaryOperator` | `FASTTExpression` | `argument` | `FASTPyTUnaryOperator` | Parent unary operator in which I am.|
 | `returnOwner` | `FASTTExpression` | `expression` | `FASTTReturnStatement` | The return statement that own the expression (if it's the case)|
+| `statementContainer` | `FASTTStatement` | `statements` | `FASTTStatementBlock` | Block containing this statement.|
 
 ### Children
 | Relation | Origin | Opposite | Type | Comment |
@@ -35,8 +37,8 @@
 Class {
 	#name : 'FASTPyEntity',
 	#superclass : 'MooseEntity',
-	#traits : 'FASTTEntity + FASTTExpression',
-	#classTraits : 'FASTTEntity classTrait + FASTTExpression classTrait',
+	#traits : 'FASTTEntity + FASTTExpression + FASTTStatement',
+	#classTraits : 'FASTTEntity classTrait + FASTTExpression classTrait + FASTTStatement classTrait',
 	#instVars : [
 		'#genericChildren => FMMany type: #FASTPyEntity opposite: #genericParent',
 		'#genericParent => FMOne type: #FASTPyEntity opposite: #genericChildren'
@@ -122,6 +124,13 @@ FASTPyEntity >> genericParentGroup [
 	^ MooseSpecializedGroup with: self genericParent
 ]
 
+{ #category : 'testing' }
+FASTPyEntity >> hasImmediateSource [
+
+	<generated>
+	^ false
+]
+
 { #category : 'testing' }
 FASTPyEntity >> isAssignment [
 
@@ -171,13 +180,27 @@ FASTPyEntity >> isLiteral [
 	^ false
 ]
 
+{ #category : 'testing' }
+FASTPyEntity >> isReturnStatement [
+
+	<generated>
+	^ false
+]
+
 { #category : 'testing' }
 FASTPyEntity >> isScopableEntity [
 
 	<generated>
 	^ false
 ]
 
+{ #category : 'testing' }
+FASTPyEntity >> isStatementBlock [
+
+	<generated>
+	^ false
+]
+
 { #category : 'testing' }
 FASTPyEntity >> isStringLiteral [
 

src/FAST-Python-Model/FASTPyReturnStatement.class.st

@@ -1,6 +1,33 @@
+"
+## Relations
+======================
+
+### Parents
+| Relation | Origin | Opposite | Type | Comment |
+|---|
+| `parentLoopStatement` | `FASTTStatement` | `body` | `FASTTLoopStatement` | Optional loop of which this statement is the body|
+| `statementContainer` | `FASTTStatement` | `statements` | `FASTTStatementBlock` | Block containing this statement.|
+
+### Children
+| Relation | Origin | Opposite | Type | Comment |
+|---|
+| `expression` | `FASTTReturnStatement` | `returnOwner` | `FASTTExpression` | The expression returned|
+
+
+## Properties
+======================
+
+| Name | Type | Default value | Comment |
+|---|
+| `endPos` | `Number` | nil | |
+| `startPos` | `Number` | nil | |
+
+"
 Class {
 	#name : 'FASTPyReturnStatement',
 	#superclass : 'FASTPyEntity',
+	#traits : 'FASTTReturnStatement',
+	#classTraits : 'FASTTReturnStatement classTrait',
 	#category : 'FAST-Python-Model-Entities',
 	#package : 'FAST-Python-Model',
 	#tag : 'Entities'

src/FAST-Python-Tools-Tests/FASTPythonImporterTest.class.st

@@ -14,8 +14,9 @@ Class {
 }
 
 { #category : 'test generation' }
-FASTPythonImporterTest class >> generateAssertionsFor: entity pushing: pushString on: aStream identation: aNumber [
-
+FASTPythonImporterTest class >> generateAssertionsFor: entity pushing: pushString on: aStream identation: aNumber popAtTheEnd: shouldPop [
+	
+	| propertiesToAssert |
 	aStream
 		cr;
 		tab: aNumber;
@@ -27,9 +28,9 @@ FASTPythonImporterTest class >> generateAssertionsFor: entity pushing: pushStrin
 
 	aStream
 		nextPutAll: 'self assert: self topEntity sourceCode equals: ';
-		print: entity sourceCode;
+		print: entity sourceCode withInternalLineEndings;
 		nextPutAll: (entity sourceCode lines size > 1
-				 ifTrue: [ ' withPlateformLineEnding.' ]
+				 ifTrue: [ ' withPlatformLineEndings.' ]
 				 ifFalse: [ '.' ]);
 		cr;
 		tab: aNumber;
@@ -39,10 +40,12 @@ FASTPythonImporterTest class >> generateAssertionsFor: entity pushing: pushStrin
 		cr;
 		tab: aNumber.
 
-	(entity mooseDescription allProperties select: [ :property | self shouldSelectProperty: property of: entity ]) do: [ :property |
-			| result selector |
+	propertiesToAssert := (entity mooseDescription allProperties select: [ :property | self shouldSelectProperty: property of: entity ]).
+	propertiesToAssert do: [ :property |
+			| result selector skipPop |
 			result := property getRawFrom: entity.
 			selector := property implementingSelector.
+			skipPop := shouldPop and: [ property = propertiesToAssert last ].
 			(property isMultivalued and: [ property type isPrimitive not ])  "When we have a relation to a collection of entities we do recursively do the testing." 
 				ifTrue: [
 						result ifNotEmpty: [
@@ -66,7 +69,8 @@ FASTPythonImporterTest class >> generateAssertionsFor: entity pushing: pushStrin
 											generateAssertionsFor: child
 											pushing: '(stack top ' , selector , ' at: ' , index asString , ')'
 											on: aStream
-											identation: aNumber + 1 ] ] ]
+											identation: aNumber + 1
+											popAtTheEnd: (skipPop not or: [ result size = index ]) ] ] ]
 				ifFalse: [
 						(result isMooseObject and: [ result isMooseEntity ])
 							ifTrue: [
@@ -86,7 +90,8 @@ FASTPythonImporterTest class >> generateAssertionsFor: entity pushing: pushStrin
 										generateAssertionsFor: result
 										pushing: 'self topEntity ' , selector
 										on: aStream
-										identation: aNumber + 1 ]
+										identation: aNumber + 1
+										popAtTheEnd: skipPop ]
 							ifFalse: [
 									aStream
 										nextPutAll: 'self assert: self topEntity ';
@@ -97,10 +102,11 @@ FASTPythonImporterTest class >> generateAssertionsFor: entity pushing: pushStrin
 										cr;
 										tab: aNumber ] ] ].
 
-	aStream
-		nextPutAll: 'stack pop.';
-		cr;
-		tab: aNumber
+	shouldPop ifTrue: [
+		aStream
+			nextPutAll: 'stack pop.';
+			cr;
+			tab: aNumber]
 ]
 
 { #category : 'test generation' }
@@ -145,7 +151,7 @@ FASTPythonImporterTest class >> generateTestNamed: aString fromCode: code protoc
 
 			          model rootEntities size = 1 ifFalse: [ self error: 'FAST generator was thought with only 1 top entity?' ].
 
-			          self generateAssertionsFor: model rootEntities anyOne genericChildren first pushing: 'fast rootEntities anyOne genericChildren first' on: aStream identation: 1 ].
+			          self generateAssertionsFor: model rootEntities anyOne genericChildren first pushing: 'fast rootEntities anyOne genericChildren first' on: aStream identation: 1popAtTheEnd: false ].
 
 
 
@@ -1192,6 +1198,40 @@ FASTPythonImporterTest >> testRawString [
 	self assertEmpty: string allContainedEntities
 ]
 
+{ #category : 'tests' }
+FASTPythonImporterTest >> testReturnEmpty [
+	"Generated as regression test by FASTPythonImporterTest class>>#generateTestNamed:fromCode:protocol: "
+
+	self parse: 'def aFunction():
+	return'.
+
+	self assert: (fast allWithType: FASTPyFunctionDefinition) size equals: 1.
+	self assert: (fast allWithType: FASTPyBlock) size equals: 1.
+	self assert: (fast allWithType: FASTPyModule) size equals: 1.
+	self assert: (fast allWithType: FASTPyReturnStatement) size equals: 1.
+
+	stack push: fast rootEntities anyOne genericChildren first.
+	self assert: self topEntity sourceCode equals: 'def aFunction():
+	return' withPlatformLineEndings.
+	self assert: (self topEntity isOfType: FASTPyFunctionDefinition).
+	self assert: self topEntity name equals: 'aFunction'.
+	
+	"Testing value of monovalue relation statementBlock"
+	self assert: self topEntity statementBlock isNotNil.
+
+		stack push: self topEntity statementBlock.
+		self assert: self topEntity sourceCode equals: 'return'.
+		self assert: (self topEntity isOfType: FASTPyBlock).
+		
+		"Testing value of multivalued relation statements"
+		self assert: self topEntity statements size equals: 1.
+		
+			stack push: (stack top statements at: 1).
+			self assert: self topEntity sourceCode equals: 'return'.
+			self assert: (self topEntity isOfType: FASTPyReturnStatement).
+			
+]
+
 { #category : 'tests - literals' }
 FASTPythonImporterTest >> testSingleQuotedString [
 

src/FAST-Python-Tools/TSFASTPythonImporter.class.st

@@ -62,6 +62,14 @@ TSFASTPythonImporter >> visitBinaryOperator: aTSNode [
 	^ self manageBinaryOperator: aTSNode ofKind: FASTPyBinaryOperator
 ]
 
+{ #category : 'visiting' }
+TSFASTPythonImporter >> visitBlock: aTSNode [
+
+	self onNextContextDo: [ :contextEntry | contextEntry add: 'statements' asAliasOfField: '<unnamedChild>' ].
+
+	^ self createEntityForNode: aTSNode kind: FASTPyBlock
+]
+
 { #category : 'visiting' }
 TSFASTPythonImporter >> visitBooleanOperator: aTSNode [
 
@@ -128,9 +136,11 @@ TSFASTPythonImporter >> visitFunctionDefinition: aNode [
 	"TreeSitter has the same nodes for method and function definitions but in FAST we want to disambiguate."
 
 	| definition |
+	self onNextContextDo: [ :contextEntry | contextEntry add: 'statementBlock' asAliasOfField: 'body' ].
+
 	definition := (context anySatisfy: [ :entry | entry fastEntity isClassDefinition ])
-		  ifTrue: [ self createEntityForNode: aNode kind: FASTPyMethodDefinition ]
-		  ifFalse: [ self createEntityForNode: aNode kind: FASTPyFunctionDefinition ]
+		              ifTrue: [ self createEntityForNode: aNode kind: FASTPyMethodDefinition ]
+		              ifFalse: [ self createEntityForNode: aNode kind: FASTPyFunctionDefinition ]
 ]
 
 { #category : 'visiting' }