Merge pull request #638 from Flynsarmy/fileHelperTest

Add some FilesHelper tests

composer.json

@@ -31,7 +31,8 @@
         "wp-coding-standards/wpcs": "*",
         "phpcompatibility/php-compatibility": "*",
         "php-parallel-lint/php-parallel-lint": "*",
-        "10up/wp_mock": "^0.4.2"
+        "10up/wp_mock": "^0.4.2",
+        "mikey179/vfsstream": "^1.6"
     },
     "autoload": {
         "psr-4": {

src/FilesHelper.php

@@ -36,9 +36,9 @@ public static function delete_dir_with_files( string $dir ) : void {
     }
 
     /**
-     * Get public URLs for all files in a local directory
+     * Get public URLs for all files in a local directory.
      *
-     * @return string[] list of URLs
+     * @return string[] list of relative, urlencoded URLs
      */
     public static function getListOfLocalFilesByDir( string $dir ) : array {
         $files = [];
@@ -71,6 +71,12 @@ public static function getListOfLocalFilesByDir( string $dir ) : array {
         return $files;
     }
 
+    /**
+     * Ensure a given filepath has an allowed filename and extension.
+     *
+     * @return bool  True if the given file does not have a disallowed filename
+     *               or extension.
+     */
     public static function filePathLooksCrawlable( string $file_name ) : bool {
         $filenames_to_ignore = [
             '__MACOSX',
@@ -176,10 +182,11 @@ function( $file_extension ) {
     }
 
     /**
-     * Clean all detected URLs before use
+     * Clean all detected URLs before use. Accepts relative and absolute URLs
+     * both with and without starting or trailing slashes.
      *
-     * @param string[] $urls list of URLs
-     * @return string[] list of URLs
+     * @param string[] $urls list of absolute or relative URLs
+     * @return string[] list of relative URLs
      * @throws WP2StaticException
      */
     public static function cleanDetectedURLs( array $urls ) : array {
@@ -232,4 +239,3 @@ function ( $url ) use ( $home_url ) {
         return $cleaned_urls;
     }
 }
-