Merge pull request #17 from RobQuistNL/cat-12

Upgrade a test project, and implement local directory repositories

Author: RobQuistNL

.travis.yml

@@ -17,4 +17,4 @@ after_success:
 
 cache:
   directories:
-    - $HOME/.composer/cache/files
+    - $HOME/.composer/cache/files

README.md

@@ -81,6 +81,38 @@ The windows installer adds `catalyst` to the path by default. You can run `catal
 
 If you haven't got catalyst in your path (linux or OSX), you can execute the `index.php` file manually. 
 
+### Install requirements
+First initialize your project with Catalyst by writing a `catalyst.json` file, or using `catalyst init`.
+
+Write requirements into the file, or use `catalyst require <pacakgename>`.
+
+Run `catalyst install` to install all dependencies.
+
+### Local directories as packages
+If you don't want to share packages, you can add a directory repository in your `catalyst.json` file. 
+Make sure that the project folders inside of the given folder contain a `catalyst.json` file!
+Since there is no version information available through this setup, the system assumes "1.0.0". So if you want to 
+require the package `../private-projects/My Tools/My Tools.yyp` you'll have create a `catalyst.json` with 
+`"name": "private/my-tools"` and then run `catalyst require private/my-tools` in your main project, using a constraint that 
+satisfies `1.0.0`; for example `*` or `>=1.0`. You can mix multiple repositories.
+
+```json
+{
+    "name": "dukesoft/other-project",
+    "description": "Other project",
+    "license": "MIT",
+    "homepage": "https://github.com/robquistnl/other",
+    "yyp": "OtherProject.yyp",
+    "repositories": {
+      "../private-projects": "directory"
+    },
+    "require": {
+        "private/my-tools": "*",
+        "dukesoft/dscpu-mercy": ">=1.2"
+    }
+}
+``` 
+
 `catalyst help` will display all commands and information
 
 ### Arguments

src/Command/RequireCommand.php

@@ -3,6 +3,7 @@
 namespace Catalyst\Command;
 
 use Catalyst\Entity\CatalystEntity;
+use Catalyst\Exception\PackageNotFoundException;
 use Catalyst\Service\CatalystService;
 use Catalyst\Service\PackageService;
 use Catalyst\Service\StorageService;
@@ -70,7 +71,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             return 1;
         }
 
-        $this->packageService->packageExists($package, $version);
+        if (!$this->packageService->packageExists($package, $version)) {
+            throw new PackageNotFoundException($package, $version);
+        }
 
         $catalyst->addRequire($package, $version);
 

src/Model/Repository.php

@@ -1,10 +1,13 @@
 <?php
 namespace Catalyst\Model;
 
+use Assert\Assert;
+use Assert\Assertion;
 use Catalyst\Entity\CatalystEntity;
 use Catalyst\Exception\PackageNotFoundException;
 use Catalyst\Exception\PackageNotSatisfiableException;
 use Catalyst\Service\GithubService;
+use Catalyst\Service\StorageService;
 use Composer\Semver\Semver;
 
 class Repository implements \JsonSerializable {
@@ -27,6 +30,7 @@ class Repository implements \JsonSerializable {
 
     public function __construct(string $type, string $uri)
     {
+        Assertion::inArray($type, $this->getRepositoryTypes());
         $this->type = $type;
         $this->uri = $uri;
     }
@@ -63,7 +67,7 @@ public function packageExists(string $packageName, string $version): bool
             return true;
         }
 
-        throw new PackageNotSatisfiableException($packageName, $version);
+        return false;
     }
 
     public function findPackage(string $packageName, string $version): CatalystEntity
@@ -72,7 +76,7 @@ public function findPackage(string $packageName, string $version): CatalystEntit
         if (count($satisfieableVersions)) {
             switch ($this->type) {
                 case self::REPO_DIRECTORY:
-                    return CatalystEntity::createFromPath($this->availablePackages[$packageName][$satisfieableVersions[0]]);
+                    return CatalystEntity::createFromPath($this->availablePackages[$packageName]['source'], true);
                     break;
                 case self::REPO_VCS: //@todo replace zipball downloading with git clone
                     //@see https://github.com/GameMakerHub/Catalyst/issues/11
@@ -97,15 +101,12 @@ public function findPackageDependencies(string $packageName, string $version): a
         $satisfieableVersions = $this->getSatisfiableVersions($packageName, $version);
         if (count($satisfieableVersions)) {
             switch ($this->type) {
-                case self::REPO_DIRECTORY:
-                    $catalystFile = CatalystEntity::createFromPath($this->availablePackages[$packageName][$satisfieableVersions[0]]);
-                    return $catalystFile->require();
-                    break;
                 case self::REPO_VCS:
                     $githubService = new GithubService();
                     return $githubService->getDependenciesFor($packageName, $satisfieableVersions[0]);
                     break;
                 case self::REPO_CATALYST:
+                case self::REPO_DIRECTORY:
                     return $this->availablePackages[$packageName]['versions'][$version];
                     break;
             }
@@ -135,9 +136,10 @@ private function scanPackagesIfNotScanned():void
 
     private function scanPackagesForDirectory():void
     {
-        throw new \Exception('Directory repositories are not yet supported.');
         $packagePaths = [];
-        foreach (glob($this->uri . '/*/*', GLOB_ONLYDIR) as $projectPath) {
+
+        $realLocation = StorageService::pathToAbsolute($this->uri);
+        foreach (glob($realLocation . '/*', GLOB_ONLYDIR) as $projectPath) {
             if (file_exists($projectPath . '/catalyst.json')) {
                 $packagePaths[] = $projectPath;
             }
@@ -146,12 +148,18 @@ private function scanPackagesForDirectory():void
         foreach ($packagePaths as $packagePath) {
             try {
                 $jsonData = json_decode(file_get_contents($packagePath . '/catalyst.json'));
-                if ($jsonData->name && $jsonData->version) {
+                if ($jsonData->name) {
                     if (!array_key_exists($jsonData->name, $this->availablePackages)) {
                         $this->availablePackages[$jsonData->name] = [];
                     }
-
-                    $this->availablePackages[$jsonData->name][$jsonData->version] = $packagePath;
+                    $this->availablePackages[$jsonData->name]['source'] = $packagePath;
+                    $versions = [];
+                    if (isset($jsonData->require)) {
+                        $versions = (array) $jsonData->require;
+                    }
+                    $this->availablePackages[$jsonData->name]['versions'] = [
+                        '1.0.0' => $versions //Default version, 1.0.0 ?
+                    ];
                 }
             } catch (\Exception $e) {
                 // ignore
@@ -197,4 +205,13 @@ private function scanCatalystForPackages(): void
             ];
         }
     }
+
+    private function getRepositoryTypes(): array
+    {
+        return [
+            self::REPO_CATALYST,
+            self::REPO_DIRECTORY,
+            self::REPO_VCS,
+        ];
+    }
 }

src/Service/InstallService.php

@@ -30,7 +30,7 @@ public function setOutput(OutputInterface $output)
     public function install(CatalystEntity &$project)
     {
         $this->project = $project;
-        $this->writeLine('Resolving dependencies and building installation list...');
+        $this->write('Resolving dependencies and building installation list...');
         $packagesToInstall = $this->packageService->solveDependencies($project);
         $this->writeLine('Done!');
 
@@ -144,4 +144,11 @@ private function writeLine($string)
             $this->output->writeln($string);
         }
     }
+
+    private function write($string)
+    {
+        if (null !== $this->output) {
+            $this->output->write($string);
+        }
+    }
 }

src/Service/PackageService.php

@@ -4,9 +4,9 @@
 
 use Catalyst\Entity\CatalystEntity;
 use Catalyst\Exception\PackageNotFoundException;
+use Catalyst\Exception\UnresolveableDependenciesException;
 use Catalyst\Model\Repository;
 use Composer\Semver\Semver;
-use Ramsey\Uuid\Exception\UnsatisfiedDependencyException;
 
 class PackageService
 {
@@ -16,9 +16,6 @@ class PackageService
     public function __construct()
     {
         // Add default repositories
-        //new Repository(Repository::REPO_DIRECTORY, 'C:\Users\PC\Documents\GameMakerStudio2\Catalyst\tests')
-        //new Repository(Repository::REPO_catalyst, 'https://raw.githubusercontent.com/GameMakerHub/packages/master/packages.json')
-        //new Repository(Repository::REPO_VCS, 'git@github.com:DukeSoft/extended-functions.git')
         $this->addRepository(new Repository(Repository::REPO_CATALYST, 'http://repo.gamemakerhub.net'));
     }
 
@@ -53,7 +50,7 @@ public function packageExists(string $package, string $version): bool
             }
         }
 
-        throw new PackageNotFoundException($package, $version);
+        return false;
     }
 
     public function getPackageDependencies(string $package, string $version): array
@@ -73,24 +70,33 @@ public function getSatisfiableVersions(string $package, string $version): array
         $versions = [];
 
         foreach ($this->repositories as $repository) {
-            $versions += $repository->getSatisfiableVersions($package, $version);
+            try {
+                $versions += $repository->getSatisfiableVersions($package, $version);
+            } catch (PackageNotFoundException $e) {
+                // Ignore
+            }
         }
 
         return $versions;
     }
 
+    private function addRepositoriesFromCatalyst(CatalystEntity $project)
+    {
+        foreach ($project->repositories() as $location => $type) {
+            $this->addRepository(new Repository($type, $location));
+        }
+    }
+
     public function solveDependencies(CatalystEntity $project, $finalPackages = [])
     {
         $requirements = $project->require();
-        foreach ($project->repositories() as $repository) {
-            $this->addRepository($repository);
-        }
+        $this->addRepositoriesFromCatalyst($project);
 
         // First find all available versions of all required packages
         foreach ($requirements as $package => $version) {
             $finalPackages[$package] = $this->getSatisfiableVersions($package, $version);
             if (count($finalPackages[$package]) == 0) {
-                throw new UnsatisfiedDependencyException(
+                throw new UnresolveableDependenciesException(
                     sprintf('No version for constraint "%s" for package "%s" can be found', $version, $package)
                 );
             }
@@ -102,7 +108,7 @@ public function solveDependencies(CatalystEntity $project, $finalPackages = [])
             $addedNewPackage = false;
             foreach ($finalPackages as $package => $versions) {
                 if (count($versions) == 0) {
-                    throw new UnsatisfiedDependencyException(
+                    throw new UnresolveableDependenciesException(
                         $package . ' cant be satisfied, due to a dependency constraint'
                     );
                 }
@@ -113,7 +119,7 @@ public function solveDependencies(CatalystEntity $project, $finalPackages = [])
                         //Apply constraint on current list
                         $finalPackages[$depPackage] = Semver::satisfiedBy($finalPackages[$depPackage], $depVersionConstraint);
                     } else {
-                        //Add new pacakge to list
+                        //Add new package to list
                         $finalPackages[$depPackage] = $this->getSatisfiableVersions($depPackage, $depVersionConstraint);
                         $addedNewPackage = true;
                     }
@@ -125,7 +131,7 @@ public function solveDependencies(CatalystEntity $project, $finalPackages = [])
         $result = [];
         foreach ($finalPackages as $package => $versions) {
             if (count($versions) == 0) {
-                throw new UnsatisfiedDependencyException(
+                throw new UnresolveableDependenciesException(
                     $package . ' cant be satisfied, due to a dependency constraint'
                 );
             }

src/Service/StorageService.php

@@ -161,6 +161,12 @@ public function getFromWriteStorage($filename)
         throw new \Exception('File not written in storage: ' . $filename);
     }
 
+    public static function pathToAbsolute($pathOrFile)
+    {
+        $inst = self::getInstance();
+        return $inst->getAbsoluteFilename($inst->makeRealFilename($pathOrFile));
+    }
+
     private function makeRealFilename($filename)
     {
         if (!$this->pathIsAbsolute($filename)) {
@@ -263,6 +269,11 @@ public function getAbsoluteFilename($filename) {
             }
         }
 
-        return join('/', $path);
+        if (strcasecmp(substr(PHP_OS, 0, 3), 'WIN') === 0) {
+            // Make windows style directories if we're on windows
+            return join('/', $path);
+        }
+
+        return '/' . join('/', $path);
     }
 }

tests/projects/GMLProject/catalyst.json

@@ -7,5 +7,8 @@
     "require": {
         "gamemakerhub/extended-functions": "*",
         "dukesoft/dscpu-mercy": ">=1.2"
+    },
+    "repositories": {
+        "../projects": "directory"
     }
 }

tests/projects/OtherProject/OtherProject.yyp

@@ -4,5 +4,7 @@
     "license": "MIT",
     "homepage": "https://github.com/robquistnl/other",
     "yyp": "OtherProject.yyp",
-    "version": "1.2.1"
+    "require": {
+        "dukesoft/dscpu-mercy": ">=1.2"
+    }
 }