Skip to content

[TASK] Add more tests for OutputFormat #893

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 10, 2025
Merged

[TASK] Add more tests for OutputFormat #893

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c74bdd0
[TASK] Add more tests for `OutputFormat`
oliverklee Feb 9, 2025
00defce
Update tests/Unit/OutputFormatTest.php
oliverklee Feb 10, 2025
ede4dd7
Changes suggested in code review
oliverklee Feb 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 141 additions & 2 deletions tests/Unit/OutputFormatTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -891,7 +891,7 @@ public function getFormatterCalledTwoTimesReturnsSameInstance(): void
/**
* @test
*/
public function createReturnsNewOutputFormatInstance(): void
public function createReturnsOutputFormatInstance(): void
{
self::assertInstanceOf(OutputFormat::class, OutputFormat::create());
}
Expand All @@ -910,7 +910,7 @@ public function createCalledTwoTimesReturnsDifferentInstances(): void
/**
* @test
*/
public function createCompactReturnsNewOutputFormatInstance(): void
public function createCompactReturnsOutputFormatInstance(): void
{
self::assertInstanceOf(OutputFormat::class, OutputFormat::createCompact());
}
Expand Down Expand Up @@ -1016,6 +1016,16 @@ public function createCompactReturnsInstanceWithSpaceAfterSelectorSeparatorSetTo
self::assertSame('', $newInstance->getSpaceAfterSelectorSeparator());
}

/**
* @test
*/
public function createCompactReturnsInstanceWithSpaceAfterListArgumentSeparatorsSetToEmptyArray(): void
{
$newInstance = OutputFormat::createCompact();

self::assertSame([], $newInstance->getSpaceAfterListArgumentSeparators());
}

/**
* @test
*/
Expand All @@ -1025,4 +1035,133 @@ public function createCompactReturnsInstanceWithRenderCommentsDisabled(): void

self::assertFalse($newInstance->getRenderComments());
}

/**
* @test
*/
public function createPrettyReturnsOutputFormatInstance(): void
{
self::assertInstanceOf(OutputFormat::class, OutputFormat::createPretty());
}

/**
* @test
*/
public function createPrettyCalledTwoTimesReturnsDifferentInstances(): void
Copy link
Collaborator

@JakeQZ JakeQZ Feb 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm thinking (and agreeing) "TwoTimes" is better than "Twice" for non-native-English speaking coders.

{
$firstCallResult = OutputFormat::createPretty();
$secondCallResult = OutputFormat::createPretty();

self::assertNotSame($firstCallResult, $secondCallResult);
}

/**
* @test
*/
public function createPrettyReturnsInstanceWithSpaceBeforeRulesSetToNewline(): void
{
$newInstance = OutputFormat::createPretty();

self::assertSame("\n", $newInstance->getSpaceBeforeRules());
}

/**
* @test
*/
public function createPrettyReturnsInstanceWithSpaceBetweenRulesSetToNewline(): void
{
$newInstance = OutputFormat::createPretty();

self::assertSame("\n", $newInstance->getSpaceBetweenRules());
}

/**
* @test
*/
public function createPrettyReturnsInstanceWithSpaceAfterRulesSetToNewline(): void
{
$newInstance = OutputFormat::createPretty();

self::assertSame("\n", $newInstance->getSpaceAfterRules());
}

/**
* @test
*/
public function createPrettyReturnsInstanceWithSpaceBeforeBlocksSetToNewline(): void
{
$newInstance = OutputFormat::createPretty();

self::assertSame("\n", $newInstance->getSpaceBeforeBlocks());
}

/**
* @test
*/
public function createPrettyReturnsInstanceWithSpaceBetweenBlocksSetToTwoNewlines(): void
{
$newInstance = OutputFormat::createPretty();

self::assertSame("\n\n", $newInstance->getSpaceBetweenBlocks());
}

/**
* @test
*/
public function createPrettyReturnsInstanceWithSpaceAfterBlocksSetToNewline(): void
{
$newInstance = OutputFormat::createPretty();

self::assertSame("\n", $newInstance->getSpaceAfterBlocks());
}

/**
* @test
*/
public function createPrettyReturnsInstanceWithSpaceAfterRuleNameSetToSpace(): void
{
$newInstance = OutputFormat::createPretty();

self::assertSame(' ', $newInstance->getSpaceAfterRuleName());
}

/**
* @test
*/
public function createPrettyReturnsInstanceWithSpaceBeforeOpeningBraceSetToSpace(): void
{
$newInstance = OutputFormat::createPretty();

self::assertSame(' ', $newInstance->getSpaceBeforeOpeningBrace());
}

/**
* @test
*/
public function createPrettyReturnsInstanceWithSpaceAfterSelectorSeparatorSetToSpace(): void
{
$newInstance = OutputFormat::createPretty();

self::assertSame(' ', $newInstance->getSpaceAfterSelectorSeparator());
}

/**
* @test
*/
public function createPrettyReturnsInstanceWithSpaceAfterListArgumentSeparatorsSetToSpaceForCommaOnly(): void
{
$newInstance = OutputFormat::createPretty();

self::assertSame([',' => ' '], $newInstance->getSpaceAfterListArgumentSeparators());
Copy link
Collaborator

@JakeQZ JakeQZ Feb 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this just test that the key , has the value {space} - instead of the whole array?

Copy link
Collaborator

@JakeQZ JakeQZ Feb 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or maybe the test method should be renamed to indicate it's checking the whole array by adding On;y at the end of its name.

}

/**
* @test
*/
public function createPrettyReturnsInstanceWithRenderCommentsEnabled(): void
{
$newInstance = OutputFormat::createPretty();

self::assertTrue($newInstance->getRenderComments());
}
}