This repository has been archived by the owner on Sep 20, 2022. It is now read-only.
Add support for parameter names #136
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,8 +33,9 @@ final class FunctionDeclarationVisitorSpec: QuickSpec { | |
| expect(self.sut.functionDeclarations.first?.name) == "greet" | ||
| } | ||
| it("finds the function parameter") { | ||
| expect(self.sut.functionDeclarations.first?.parameters?.first?.argumentLabelName) == "person" | ||
| expect(self.sut.functionDeclarations.first?.parameters?.first?.parameterName) == "person" | ||
| expect(self.sut.functionDeclarations.first?.parameters?.first?.type) == .simple(name: "String") | ||
| } | ||
| it("finds the return type") { | ||
| expect(self.sut.functionDeclarations.first?.returnType) == TypeDescription.simple(name: "String") | ||
|
|
@@ -59,8 +60,9 @@ final class FunctionDeclarationVisitorSpec: QuickSpec { | |
| expect(self.sut.functionDeclarations.first?.name) == "printWithoutCounting" | ||
| } | ||
| it("finds the function parameter") { | ||
| expect(self.sut.functionDeclarations.first?.parameters?.first?.argumentLabelName) == "string" | ||
| expect(self.sut.functionDeclarations.first?.parameters?.first?.parameterName) == "string" | ||
| expect(self.sut.functionDeclarations.first?.parameters?.first?.type) == .simple(name: "String") | ||
| } | ||
| it("sets the return type as nil") { | ||
| expect(self.sut.functionDeclarations.first?.returnType).to(beNil()) | ||
|
|
@@ -94,8 +96,9 @@ final class FunctionDeclarationVisitorSpec: QuickSpec { | |
| expect(self.sut.functionDeclarations.first?.name) == "minMax" | ||
| } | ||
| it("finds the function parameter") { | ||
| expect(self.sut.functionDeclarations.first?.parameters?.first?.argumentLabelName) == "array" | ||
| expect(self.sut.functionDeclarations.first?.parameters?.first?.parameterName) == "array" | ||
| expect(self.sut.functionDeclarations.first?.parameters?.first?.type) == .array(element: .simple(name: "Int")) | ||
| } | ||
| it("finds the tuple return value") { | ||
| expect(self.sut.functionDeclarations.first?.returnType) == .tuple([.simple(name: "Int"), .simple(name: "Int")]) | ||
|
|
@@ -134,16 +137,16 @@ final class FunctionDeclarationVisitorSpec: QuickSpec { | |
| let firstFunction = self.sut.functionDeclarations.first | ||
| expect(firstFunction?.modifiers) == Modifiers.public | ||
| expect(firstFunction?.name) == "minMax" | ||
| expect(firstFunction?.parameters?.first?.argumentLabelName) == "array" | ||
| expect(firstFunction?.parameters?.first?.type) == .array(element: .simple(name: "Int")) | ||
| expect(firstFunction?.returnType) == .tuple([.simple(name: "Int"), .simple(name: "Int")]) | ||
| } | ||
| it("finds the last function") { | ||
| let lastFunction = self.sut.functionDeclarations.last | ||
| expect(lastFunction?.modifiers) == [.private, .static] | ||
| expect(lastFunction?.name) == "printWithoutCounting" | ||
| expect(lastFunction?.parameters?.first?.argumentLabelName) == "string" | ||
| expect(lastFunction?.parameters?.first?.type) == .simple(name: "String") | ||
| expect(lastFunction?.returnType).to(beNil()) | ||
| } | ||
| } | ||
|
|
@@ -159,12 +162,12 @@ final class FunctionDeclarationVisitorSpec: QuickSpec { | |
| try? self.sut.walkContent(content) | ||
| } | ||
|
|
||
| it("finds no parameters") { | ||
| expect(self.sut.functionDeclarations.first?.parameters).to(beNil()) | ||
| } | ||
| } | ||
|
|
||
| context("function with empty argument label") { | ||
| beforeEach { | ||
| let content = """ | ||
| func print(_ string: String) { | ||
|
|
@@ -175,8 +178,11 @@ final class FunctionDeclarationVisitorSpec: QuickSpec { | |
| try? self.sut.walkContent(content) | ||
| } | ||
|
|
||
| it("finds the argument label") { | ||
| expect(self.sut.functionDeclarations.first?.parameters?.first?.argumentLabelName) == "_" | ||
| } | ||
| it("finds the parameter name") { | ||
| expect(self.sut.functionDeclarations.first?.parameters?.first?.parameterName) == "string" | ||
| } | ||
| it("calculates the selectorName") { | ||
| expect(self.sut.functionDeclarations.first?.selectorName) == "print(_:)" | ||
|
|
@@ -194,18 +200,21 @@ final class FunctionDeclarationVisitorSpec: QuickSpec { | |
| try? self.sut.walkContent(content) | ||
| } | ||
|
|
||
| it("finds the argument label") { | ||
| expect(self.sut.functionDeclarations.first?.parameters?.first?.argumentLabelName) == "argumentLabelName" | ||
| } | ||
| it("calculates the selectorName") { | ||
| expect(self.sut.functionDeclarations.first?.selectorName) == "append(argumentLabelName:)" | ||
| } | ||
| it("finds the parameter name") { | ||
| expect(self.sut.functionDeclarations.first?.parameters?.first?.parameterName) == "parameterName" | ||
| } | ||
| } | ||
|
|
||
| context("function with multiple parameters") { | ||
| beforeEach { | ||
| let content = """ | ||
| func append(argumentLabelName parameterName: String, type secondParameterName: TypeDescription) { | ||
| // ... | ||
| } | ||
| """ | ||
|
|
@@ -214,11 +223,15 @@ final class FunctionDeclarationVisitorSpec: QuickSpec { | |
| } | ||
|
|
||
| it("finds the correct number of parameters") { | ||
| expect(self.sut.functionDeclarations.first?.parameters?.count) == 2 | ||
| } | ||
| it("finds the argument labels") { | ||
|
There was a problem hiding this comment. Can we add a test somewhere for a case where there is no argument label and only a parameter name? There was a problem hiding this comment. I don't think that's possible, the argument label is always present IIUC?
I think you're referring to having the argument label be the same as the parameter name, which I think we already have tests for? There was a problem hiding this comment. I just pushed a new commit that hopefully will help clarify a bit f4c285d |
||
| expect(self.sut.functionDeclarations.first?.parameters?.first?.argumentLabelName) == "argumentLabelName" | ||
| expect(self.sut.functionDeclarations.first?.parameters?.last?.argumentLabelName) == "type" | ||
| } | ||
| it("finds the parameter names") { | ||
| expect(self.sut.functionDeclarations.first?.parameters?.first?.parameterName) == "parameterName" | ||
| expect(self.sut.functionDeclarations.first?.parameters?.last?.parameterName) == "secondParameterName" | ||
| } | ||
| it("calculates the selectorName") { | ||
| expect(self.sut.functionDeclarations.first?.selectorName) == "append(argumentLabelName:type:)" | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was going to say that we should make the argument label optional but since Swift stresses both exist I think this is fine.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Per my realization at the end of #136 (comment) I think making the
parameterNameoptional would be helpful.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just pushed a new commit that hopefully will help clarify a bit f4c285d