Start writing unit tests #17
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| import 'package:checks/checks.dart'; | ||
| import 'package:zulip/model/content.dart'; | ||
|
|
||
| extension ContentNodeChecks on Subject<ContentNode> { | ||
| void equalsNode(ContentNode expected) { | ||
| if (expected is ZulipContent) { | ||
| isA<ZulipContent>() | ||
| .nodes.deepEquals(expected.nodes.map( | ||
| (e) => it()..isA<BlockContentNode>().equalsNode(e))); | ||
| // A shame we need the dynamic `isA` there. This | ||
| // version hits a runtime type error: | ||
| // .nodes.deepEquals(expected.nodes.map( | ||
| // (e) => it<BlockContentNode>()..equalsNode(e))); | ||
| // and with `it()` with no type argument, it doesn't type-check. | ||
| // TODO: report that as API feedback on deepEquals | ||
| } else if (expected is ParagraphNode) { | ||
| isA<ParagraphNode>() | ||
| ..wasImplicit.equals(expected.wasImplicit) | ||
| ..nodes.deepEquals(expected.nodes.map( | ||
| (e) => it()..isA<InlineContentNode>().equalsNode(e))); | ||
| } else { | ||
| // TODO handle remaining ContentNode subclasses that lack structural == | ||
| equals(expected); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| extension ZulipContentChecks on Subject<ZulipContent> { | ||
| Subject<List<BlockContentNode>> get nodes => has((n) => n.nodes, 'nodes'); | ||
| } | ||
|
|
||
| extension ParagraphNodeChecks on Subject<ParagraphNode> { | ||
| Subject<bool> get wasImplicit => has((n) => n.wasImplicit, 'wasImplicit'); | ||
| Subject<List<InlineContentNode>> get nodes => has((n) => n.nodes, 'nodes'); | ||
| } | ||
|
|
||
| extension TextNodeChecks on Subject<TextNode> { | ||
| Subject<String> get text => has((n) => n.text, 'text'); | ||
| } | ||
|
|
||
| // TODO write similar extensions for the rest of the content node classes |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| import 'package:checks/checks.dart'; | ||
| import 'package:test/scaffolding.dart'; | ||
| import 'package:zulip/model/content.dart'; | ||
|
|
||
| import 'content_checks.dart'; | ||
|
|
||
| void main() { | ||
| test('parse a plain-text paragraph', () { | ||
| check(parseContent('<p>hello world</p>')) | ||
| .equalsNode(const ZulipContent(nodes: [ | ||
| ParagraphNode(nodes: [TextNode('hello world')]), | ||
| ])); | ||
| }); | ||
|
|
||
| test('parse two plain-text paragraphs', () { | ||
| check(parseContent('<p>hello</p><p>world</p>')) | ||
| .equalsNode(const ZulipContent(nodes: [ | ||
| ParagraphNode(nodes: [TextNode('hello')]), | ||
| ParagraphNode(nodes: [TextNode('world')]), | ||
| ])); | ||
| }); | ||
|
|
||
| // TODO write more tests for this code | ||
| } |
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.
LineBreakNodeis unlikely to be subclassed, I think, but isn't that a factor in choosing this implementation withisover one that equality-checks theruntimeTypes? Theoperator ==example in the Flutter project's style guide comparesruntimeTypes:If we have a class
Animalthat overrides==, and its subclassesDogandCatthat don't, thensomeDog == someCatwill giveAnimal's==override isother is AnimalAnimal's==override isother.runtimeType == runtimeType(False is probably the right answer.)
(code that you can paste into dartpad.dev)
Uh oh!
There was an error while loading. Please reload this page.
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'm wondering if it's worth changing the implementation or commenting about the expectation that it won't be subclassed. Am I being too paranoid? 😅
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.
Oh, and:
Is this right? If so, can I make the same judgment of the other non-
abstractFooNodeclasses in the file (so e.g.LineBreakInlineNodebut notEmojiNode)?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.
Yeah, none of these classes should ever have subclasses beyond the ones defined in this file. (So in Dart 3, we'll declare them as
sealed: https://github.com/dart-lang/language/blob/a374667bcc4095edd22e2e6d454cbe9d9f9d85fa/accepted/future-releases/sealed-types/feature-specification.md .) For most of them, includingLineBreakNode, that means they'll have no subclasses at all.