Fix path issue on Windows

Author: lcharette

CHANGELOG.md

@@ -33,9 +33,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
     - Added specific tests for sprinkleManager with 100% test coverage
 - Ignore existing `package-lock.json` which caused incorrect dependencies to be installed when upgrading from older versions of UserFrosting.
 - Vendor assets not found in production mode
-
-### Deprecated
-- `UserFrosting\APP_DIR_NAME` : Use `UserFrosting\APP_DIR` instead.
+- Fix path issue on Windows
 
 ## 4.2.0-beta.1
 

app/defines.php

@@ -28,14 +28,14 @@
 define('UserFrosting\ROOT_DIR', realpath(__DIR__ . '/..'));
 
 // Names of app directories
-define('UserFrosting\APP_DIR_NAME', basename(__DIR__)); //@deprecated; Use `UserFrosting\APP_DIR` instead
+define('UserFrosting\APP_DIR_NAME', basename(__DIR__));
 define('UserFrosting\SPRINKLES_DIR_NAME', 'sprinkles');
 
 // Names of src directories within Sprinkles
 define('UserFrosting\SRC_DIR_NAME', 'src');
 
 // Full path to Sprinkles directory
-define('UserFrosting\SPRINKLES_DIR', APP_DIR . DS . SPRINKLES_DIR_NAME);
+define('UserFrosting\SPRINKLES_DIR', APP_DIR_NAME . DS . SPRINKLES_DIR_NAME);
 
 // Full path to sprinkles schema file
 define('UserFrosting\SPRINKLES_SCHEMA_FILE', APP_DIR . DS . 'sprinkles.json');

app/sprinkles/core/src/ServicesProvider/ServicesProvider.php

@@ -698,8 +698,9 @@ public function register(ContainerInterface $container)
             $sprinkles = $c->sprinkleManager->getSprinkleNames();
 
             // Add Sprinkles' templates namespaces
+            // TODO : Use locator
             foreach ($sprinkles as $sprinkle) {
-                $path = \UserFrosting\SPRINKLES_DIR . \UserFrosting\DS .
+                $path = \UserFrosting\APP_DIR . \UserFrosting\DS . \UserFrosting\SPRINKLES_DIR_NAME . \UserFrosting\DS .
                     $sprinkle . \UserFrosting\DS .
                     \UserFrosting\TEMPLATE_DIR_NAME . \UserFrosting\DS;
 

app/system/Sprinkle/SprinkleManager.php

@@ -34,7 +34,7 @@ class SprinkleManager
     protected $sprinkles = [];
 
     /**
-     * @var string The full absolute base path to the sprinkles directory.
+     * @var string Relaive path to the sprinkles directory. Will be used to register the location with the ResourceLocator
      */
     protected $sprinklesPath = \UserFrosting\SPRINKLES_DIR . \UserFrosting\DS;
 
@@ -60,7 +60,7 @@ public function addResources()
     }
 
     /**
-     * Register a sprinkle as a locator location
+     * Register a sprinkle as a locator location, using relative path to the sprinkle
      * @param string $sprinkleName
      */
     public function addSprinkleResources($sprinkleName)
@@ -85,12 +85,13 @@ public function getSprinklePath($sprinkleName)
         }
 
         // Get path and make sure it exist
-        $path = $this->getSprinklesPath() . $sprinkle;
-        if (!file_exists($path)) {
-            throw new FileNotFoundException("Sprinkle `$sprinkleName` should be found at `$path`, but that directory doesn't exist.");
+        $relPath = $this->getSprinklesPath() . $sprinkle;
+        $fullpath = \UserFrosting\ROOT_DIR . \UserFrosting\DS . $relPath;
+        if (!file_exists($fullpath)) {
+            throw new FileNotFoundException("Sprinkle `$sprinkleName` should be found at `$fullpath`, but that directory doesn't exist.");
         }
 
-        return $path;
+        return $relPath;
     }
 
     /**

app/tests/Unit/SprinkleManagerTest.php

@@ -134,16 +134,16 @@ public function testIsAvailable($sprinkleName, $isAvailable, SprinkleManager $sp
     /**
      * @depends testInitFromSchema
      * @param string          $sprinkleName
-     * @param bool            $path
      * @param SprinkleManager $sprinkleManager
-     * @testWith        ["foo", "/data/foo"]
-     *                  ["bar", "/data/bar"]
-     *                  ["test", "/data/test"]
+     * @testWith        ["foo"]
+     *                  ["bar"]
+     *                  ["test"]
      */
-    public function testGetSprinklePath($sprinkleName, $path, SprinkleManager $sprinkleManager)
+    public function testGetSprinklePath($sprinkleName, SprinkleManager $sprinkleManager)
     {
-        $sprinkleManager->setSprinklesPath(__DIR__ . '/data/');
-        $this->assertSame(__DIR__ . $path, $sprinkleManager->getSprinklePath($sprinkleName));
+        $basePath = 'app/tests/Unit/data/';
+        $sprinkleManager->setSprinklesPath($basePath);
+        $this->assertSame($basePath . $sprinkleName, $sprinkleManager->getSprinklePath($sprinkleName));
     }
 
     /**
@@ -154,7 +154,8 @@ public function testGetSprinklePath($sprinkleName, $path, SprinkleManager $sprin
      */
     public function testGetSprinklePathWherePathDoesntExist(SprinkleManager $sprinkleManager)
     {
-        $sprinkleManager->setSprinklesPath(__DIR__ . '/foo/');
+        $basePath = 'app/tests/Unit/foo/';
+        $sprinkleManager->setSprinklesPath($basePath);
         $sprinkleManager->getSprinklePath('foo');
     }
 
@@ -193,7 +194,8 @@ class_alias('foo', 'UserFrosting\Sprinkle\Test\ServicesProvider\ServicesProvider
      */
     public function testAddResources(SprinkleManager $sprinkleManager)
     {
-        $sprinkleManager->setSprinklesPath(__DIR__ . '/data/');
+        $basePath = 'app/tests/Unit/data/';
+        $sprinkleManager->setSprinklesPath($basePath);
         $sprinkleManager->addResources();
     }