Adding file matchers #73

vasekbrychta · 2021-08-23T21:02:11Z

I'm sending first draft of IsExistingDirectory and IsExistingFile matchers. Please review the code and let me know if this structure is ok for you. I'll then create the rest of file matchers in a similar fashion and I'll update this pull request.

Merge IsExistingDirectoryPathTest to IsExistingDirectoryTest

Merge IsExistingFilePathTest to IsExistingFileTest

vasekbrychta · 2021-08-31T23:38:46Z

What do you think @aik099?

hamcrest/Hamcrest.php

aik099 · 2021-09-04T17:09:22Z

hamcrest/Hamcrest/File/FileMatcher.php

@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);


Please remove this and don't use non-PHP 5.3+ (from composer.json) incompatible code.

I haven't seen this in any of the other files.

Ok, I saw that the tests are running for PHP 7.0 and above, so I assumed that the first supported version is PHP 7.0. Will change the code to be compatible with PHP 5.3 (btw PHP 5.3 reached end of life on 14 Aug 2014)

aik099 · 2021-09-04T17:11:49Z

hamcrest/Hamcrest/File/FileMatcher.php

+	/** @var string */
+	private $ownDescription;
+	/** @var string */
+	private $failureDescription;


Please follow the code format (also in comments) of the main codebase.

P.S.
The same applies to other places of the code.

DocBlock style doesn't match the rest of the matchers. They either don't have DocBlocks or format them in a multi-line way.

I'm sorry, I was too focused on the functionality itself that I forgot to maintain the style. Is there any cookbook/style definition or should I just try to find a similar case in the codebase?

I have no idea. The https://github.com/hamcrest/hamcrest-php/blob/master/CONTRIBUTING.md file mentions coding standard but doesn't tell what it is. I'm assuming it's PSR-2.

Anyway, it's usually best to copy/paste new files from parts of the existing file to ensure that the code style is the same.

aik099 · 2021-09-04T17:13:49Z

hamcrest/Hamcrest/File/FileMatcher.php

+		if ($this->isSafeType($item))
+		{
+			$this->describeFileMismatch($this->createSplFileInfoObjectFromPath($item), $mismatchDescription);
+		}
+		else
+		{
+			parent::describeMismatch($item, $mismatchDescription);
+		}


Code formatting. Generally, it's the best idea to configure IDE as per the coding standards of the project and mass-reformat any new code.

Where can I get the coding standards for this project?

I have no idea. The https://github.com/hamcrest/hamcrest-php/blob/master/CONTRIBUTING.md file mentions coding standard but doesn't tell what it is. I'm assuming it's PSR-2.

Anyway, it's usually best to copy/paste new files from parts of the existing file to ensure that the code style is the same.

aik099 · 2021-09-04T17:18:42Z

hamcrest/Hamcrest/File/IsExistingDirectory.php

+		parent::__construct('an existing directory', 'is not a directory');
+	}
+
+	protected function matchesFile(\SplFileInfo $file): bool


Non a PHP 5.3+ compatible code. Likely you have more places, like this.

P.S.
I wonder any none of the builds have failed. Ha-ha, they don't include PHP 5.x in even though it's supported according to composer.json.

I guess that issue needs to be fixed in a separate PR if you're up for it.

aik099 · 2021-09-04T17:21:47Z

hamcrest/Hamcrest/File/IsExistingFile.php

+	 * Accepts only <code>\SplFileInfo</code> objects or <code>string</code> paths.
+	 *
+	 * @return \Hamcrest\File\IsExistingFile
+	 * @factory


This is likely to fail when used by a generator mentioned above.

Why do you think it might fail? I used the generator and it worked correctly.

Because I saw @factory annotation elsewhere with a parameter (e.g. @factory la-la) and assumed (haven't checked with generator code), that generator might fail.

tests/Hamcrest/File/IsExistingFileTest.php

vasekbrychta · 2022-06-06T14:10:59Z

Took me a bit longer, but it should be finally done.

I haven't included a matcher for absolute path because there's no easy way to get the absolute path that wouldn't be canonical in php.

aik099 · 2022-07-09T17:24:05Z

README.md

+* `anEmptyFile` - evaluates to true if the file is empty
+```php
+$file = new \SplFileInfo('/var/log/php-fpm.log');
+assertThat($file, anEmptyFile());
+
+assertThat('/var/log/php-fpm.log', anEmptyFile());
+```
+
+* `aNonEmptyFile` - evaluates to true if the file is not empty
+```php
+$file = new \SplFileInfo('/var/log/php-fpm.log');
+assertThat($file, aNonEmptyFile());
+
+assertThat('/var/log/php-fpm.log', aNonEmptyFile());
+```
+


Are you sure, that such matches exist in the Java version of the library?

aik099 · 2022-07-09T17:29:27Z

README.md

+* `aFileNamed` - evaluates to true if the file name is equal to given value or the provided matcher matches the file name
+```php
+$file = new \SplFileInfo('/var/log/php-fpm.log');
+assertThat($file, aFileNamed('php-fpm.log'));
+assertThat($file, aFileNamed(startsWith('php')));
+
+assertThat('/var/log/php-fpm.log', aFileNamed('php-fpm.log'));
+assertThat('/var/log/php-fpm.log', aFileNamed(startsWith('php')));
+```
+
+* `aFileWithCanonicalPath` - evaluates to true if the file canonical path is equal to given value or the provided matcher matches the canonical path of the file
+```php
+$file = new \SplFileInfo('/var/log/./php-fpm.log');
+assertThat($file, aFileWithCanonicalPath('/var/log/php-fpm.log'));
+assertThat($file, aFileWithCanonicalPath(endsWith('log/php-fpm.log')));
+
+assertThat('/var/log/./php-fpm.log', aFileWithCanonicalPath('/var/log/php-fpm.log'));
+assertThat('/var/log/./php-fpm.log', aFileWithCanonicalPath(endsWith('log/php-fpm.log')));
+```
+


In the Java version of the library, these matchers only accept another matcher as an argument but don't accept file reference (string or SPL).

aik099 · 2022-07-09T17:30:12Z

README.md

+assertThat('/var/log/./php-fpm.log', aFileWithCanonicalPath('/var/log/php-fpm.log'));
+assertThat('/var/log/./php-fpm.log', aFileWithCanonicalPath(endsWith('log/php-fpm.log')));
+```
+
 ### Object


The aFileWithAbsolutePath matcher wasn't implemented.

aik099 · 2022-07-09T17:39:28Z

hamcrest/Hamcrest/Core/DescribedAs.php

+	public function describeMismatch($item, Description $description)
+	{
+		$this->_matcher->describeMismatch($item, $description);
+	}
+


Why this is needed? All existing matches seem to work without this.

aik099 · 2022-07-09T17:43:28Z

hamcrest/Hamcrest/File/IsFileNamed.php

+
+    /**
+     * Does file name satisfy a given matcher?
+	 * Accepts only <code>\SplFileInfo</code> objects or <code>string</code> paths.


Wrong indentation.

aik099 · 2022-07-09T18:04:28Z

tests/Hamcrest/File/IsFileWithSizeTest.php

+	public function testMatchesAFileWithEqualSize()
+	{
+		$this->assertMatches(
+			aFileWithSize(self::$ACTUAL_SIZE),


Not sure, that it's a good idea to use matcher functions from a global namespace vs namespaced methods.

Please see how it's implemented in other matchers.

aik099 · 2022-07-09T18:04:36Z

tests/Hamcrest/File/IsFileWithSizeTest.php

+
+	protected function createMatcher()
+	{
+		return IsFileWithSize::aFileWithSize(not(anything()));


Something isn't right here. Should the createMatcher method have an argument given to the matcher and then all tests in this class create matcher via the createMatcher method?

Please see how it's implemented in other matcher tests, that have arguments.

aik099 · 2022-07-09T18:06:30Z

tests/Hamcrest/File/IsFileWithSizeTest.php

+		self::$EMPTY_FILE = new class('/tmp/empty') extends \SplFileInfo {
+			public function getSize()
+			{
+				return 0;
+			}
+		};


Why not create an empty file in the temp folder in the setUp method and then delete it in the tearDown method?

This way you can actually use that file name in tests instead of only using the SplFileInfo object.

aik099 · 2022-07-09T18:09:32Z

tests/Hamcrest/File/IsReadableFileTest.php

+
+		self::$READABLE_FILE = new \SplFileInfo(self::$READABLE_FILE_PATH);
+
+		self::$NON_READABLE_FILE = new class('/tmp/non-readable') extends \SplFileInfo {


What kind of class instantiation syntax is this?

Does it create an anonymous class instance?

Will this code work in all supported by this library PHP versions?

aik099 · 2022-07-09T18:10:16Z

tests/Hamcrest/File/IsWritableFileTest.php

+
+		self::$WRITABLE_FILE = new \SplFileInfo(self::$WRITABLE_FILE_PATH);
+
+		self::$NON_WRITABLE_FILE = new class('/tmp/non-writable') extends \SplFileInfo {


What kind of class instantiation syntax is this?

Does it create an anonymous class instance?

Will this code work in all supported by this library PHP versions?

vasekbrychta added 3 commits August 23, 2021 22:47

Adding IsExistingDirectory matcher

23a1edc

Merge IsExistingDirectoryPathTest to IsExistingDirectoryTest

Adding IsExistingFile matcher

de2beb5

Merge IsExistingFilePathTest to IsExistingFileTest

Extracting common file matchers behavior to FileMatcher class

0576f73

aik099 requested changes Sep 4, 2021

View reviewed changes

vasekbrychta added 8 commits September 6, 2021 21:57

Making the code PHP 5.3 compatible

7d90e18

Reformatting to maintain project code style

c992e71

Adding IsExistingFileOrDirectory matcher

900240f

Adding IsReadableFile matcher

f857e2e

Adding IsWritableFile matcher

38958e9

Adding IsFileWithSize matcher

4234a1e

Adding IsFileNamed matcher

8cb405b

Adding IsFileWithCanonicalPath matcher

5b57f05

vasekbrychta marked this pull request as ready for review June 6, 2022 13:56

aik099 requested changes Jul 9, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding file matchers #73

Adding file matchers #73

vasekbrychta commented Aug 23, 2021

vasekbrychta commented Aug 31, 2021

aik099 Sep 4, 2021

vasekbrychta Sep 6, 2021 •

edited

aik099 Sep 4, 2021

vasekbrychta Sep 6, 2021

aik099 Sep 10, 2021 •

edited

aik099 Sep 4, 2021

vasekbrychta Sep 6, 2021

aik099 Sep 10, 2021

aik099 Sep 4, 2021

aik099 Sep 4, 2021

vasekbrychta Sep 6, 2021

aik099 Sep 10, 2021

vasekbrychta commented Jun 6, 2022

aik099 Jul 9, 2022

aik099 Jul 9, 2022

aik099 Jul 9, 2022

aik099 Jul 9, 2022

aik099 Jul 9, 2022

aik099 Jul 9, 2022

aik099 Jul 9, 2022

aik099 Jul 9, 2022

aik099 Jul 9, 2022

aik099 Jul 9, 2022


		self::$READABLE_FILE = new \SplFileInfo(self::$READABLE_FILE_PATH);

		self::$NON_READABLE_FILE = new class('/tmp/non-readable') extends \SplFileInfo {


		self::$WRITABLE_FILE = new \SplFileInfo(self::$WRITABLE_FILE_PATH);

		self::$NON_WRITABLE_FILE = new class('/tmp/non-writable') extends \SplFileInfo {

		@@ -0,0 +1,76 @@
		<?php

		declare(strict_types=1);

Adding file matchers #73

Are you sure you want to change the base?

Adding file matchers #73

Conversation

vasekbrychta commented Aug 23, 2021

vasekbrychta commented Aug 31, 2021

Choose a reason for hiding this comment

vasekbrychta Sep 6, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aik099 Sep 10, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vasekbrychta commented Jun 6, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vasekbrychta Sep 6, 2021 •

edited

aik099 Sep 10, 2021 •

edited