allow edition of the lockfile path in configuration

Author: Kharhamel

src/Commands/AlteredConfiguration.php

@@ -138,4 +138,9 @@ public function getAnnotationParser(): AnnotationParser
     {
         return $this->configuration->getAnnotationParser();
     }
+
+    public function getLockFilePath(): string
+    {
+        return $this->configuration->getLockFilePath();
+    }
 }

src/Commands/GenerateCommand.php

@@ -32,8 +32,12 @@ protected function configure()
             ->setDescription('Generates DAOs and beans.')
             ->setHelp('Use this command to generate or regenerate the DAOs and beans for your project.')
             ->addOption(
-                'from-lock',null,InputOption::VALUE_OPTIONAL, 'Load the schema from the lock file instead of database',false
-            );
+                'from-lock',
+                null,
+                InputOption::VALUE_OPTIONAL,
+                'Load the schema from the lock file instead of database',
+                false
+            )
         ;
     }
 

src/Configuration.php

@@ -21,6 +21,7 @@
 use TheCodingMachine\TDBM\Utils\PathFinder\PathFinderInterface;
 use Psr\Log\LoggerInterface;
 use TheCodingMachine\TDBM\Utils\PathFinder\PathFinder;
+use TheCodingMachine\TDBM\Utils\RootProjectLocator;
 
 class Configuration implements ConfigurationInterface
 {
@@ -69,6 +70,7 @@ class Configuration implements ConfigurationInterface
      * @var AnnotationParser
      */
     private $annotationParser;
+    private $lockFilePath;
 
     /**
      * @param string $beanNamespace The namespace hosting the beans
@@ -81,9 +83,10 @@ class Configuration implements ConfigurationInterface
      * @param GeneratorListenerInterface[] $generatorListeners A list of listeners that will be triggered when beans/daos are generated
      * @param AnnotationParser|null $annotationParser
      * @param CodeGeneratorListenerInterface[] $codeGeneratorListeners A list of listeners that can alter code generation of each bean/dao
+     * @param string|null $lockFilePath
      * @throws \Mouf\Database\SchemaAnalyzer\SchemaAnalyzerException
      */
-    public function __construct(string $beanNamespace, string $daoNamespace, Connection $connection, NamingStrategyInterface $namingStrategy = null, Cache $cache = null, SchemaAnalyzer $schemaAnalyzer = null, LoggerInterface $logger = null, array $generatorListeners = [], AnnotationParser $annotationParser = null, array $codeGeneratorListeners = [])
+    public function __construct(string $beanNamespace, string $daoNamespace, Connection $connection, NamingStrategyInterface $namingStrategy = null, Cache $cache = null, SchemaAnalyzer $schemaAnalyzer = null, LoggerInterface $logger = null, array $generatorListeners = [], AnnotationParser $annotationParser = null, array $codeGeneratorListeners = [], string $lockFilePath = null)
     {
         $this->beanNamespace = rtrim($beanNamespace, '\\');
         $this->daoNamespace = rtrim($daoNamespace, '\\');
@@ -104,6 +107,7 @@ public function __construct(string $beanNamespace, string $daoNamespace, Connect
         $this->annotationParser = $annotationParser ?: AnnotationParser::buildWithDefaultAnnotations([]);
         $this->codeGeneratorListener = new CodeGeneratorEventDispatcher($codeGeneratorListeners);
         $this->namingStrategy = $namingStrategy ?: new DefaultNamingStrategy($this->annotationParser, $this->connection->getSchemaManager());
+        $this->lockFilePath = $lockFilePath;
     }
 
     /**
@@ -214,4 +218,14 @@ public function getAnnotationParser(): AnnotationParser
     {
         return $this->annotationParser;
     }
+
+    public static function getDefaultLockFilePath(): string
+    {
+        return RootProjectLocator::getRootLocationPath().'tdbm.lock.yml';
+    }
+
+    public function getLockFilePath(): string
+    {
+        return $this->lockFilePath ?: self::getDefaultLockFilePath();
+    }
 }

src/ConfigurationInterface.php

@@ -73,4 +73,6 @@ public function getPathFinder(): PathFinderInterface;
      * @return AnnotationParser
      */
     public function getAnnotationParser(): AnnotationParser;
+
+    public function getLockFilePath(): string;
 }

src/TDBMSchemaAnalyzer.php

@@ -14,15 +14,13 @@
 use Doctrine\DBAL\Types\Type;
 use Mouf\Database\SchemaAnalyzer\SchemaAnalyzer;
 use TheCodingMachine\TDBM\Utils\ImmutableCaster;
-use TheCodingMachine\TDBM\Utils\RootProjectLocator;
 
 /**
  * This class is used to analyze the schema and return valuable information / hints.
  */
 class TDBMSchemaAnalyzer
 {
-    const schemaFileName =  'tdbm.lock.yml';
-
+    private $lockFilePath;
     private $connection;
 
     /**
@@ -51,17 +49,19 @@ class TDBMSchemaAnalyzer
     private $schemaVersionControlService;
 
     /**
-     * @param Connection     $connection     The DBAL DB connection to use
-     * @param Cache          $cache          A cache service to be used
+     * @param Connection $connection The DBAL DB connection to use
+     * @param Cache $cache A cache service to be used
      * @param SchemaAnalyzer $schemaAnalyzer The schema analyzer that will be used to find shortest paths...
      *                                       Will be automatically created if not passed
+     * @param string $lockFilePath The path for the lock file which will store the database schema
      */
-    public function __construct(Connection $connection, Cache $cache, SchemaAnalyzer $schemaAnalyzer)
+    public function __construct(Connection $connection, Cache $cache, SchemaAnalyzer $schemaAnalyzer, string $lockFilePath)
     {
         $this->connection = $connection;
         $this->cache = $cache;
         $this->schemaAnalyzer = $schemaAnalyzer;
-        $this->schemaVersionControlService = new SchemaVersionControlService($this->connection, self::getLockFilePath());
+        $this->lockFilePath = $lockFilePath;
+        $this->schemaVersionControlService = new SchemaVersionControlService($this->connection, $this->lockFilePath);
     }
 
     /**
@@ -78,10 +78,9 @@ public function getCachePrefix(): string
         return $this->cachePrefix;
     }
 
-    //todo: in config
-    public static function getLockFilePath(): string
+    public function getLockFilePath(): string
     {
-        return RootProjectLocator::getRootLocationPath().self::schemaFileName;
+        return $this->lockFilePath;
     }
 
     /**
@@ -93,7 +92,7 @@ public function getSchema(bool $ignoreCache = false): Schema
             $cacheKey = $this->getCachePrefix().'_immutable_schema';
             if (!$ignoreCache && $this->cache->contains($cacheKey)) {
                 $this->schema = $this->cache->fetch($cacheKey);
-            } elseif (!file_exists(self::getLockFilePath())) {
+            } elseif (!file_exists($this->getLockFilePath())) {
                 throw new TDBMException('No tdbm lock file found. Please regenerate DAOs and Beans.');
             } else {
                 $this->schema = $this->schemaVersionControlService->loadSchemaFile();
@@ -108,6 +107,7 @@ public function getSchema(bool $ignoreCache = false): Schema
     public function generateLockFile(): void
     {
         $this->schemaVersionControlService->dumpSchema();
+        \chmod($this->getLockFilePath(), 0664);
     }
 
     /**

src/TDBMService.php

@@ -187,10 +187,11 @@ public function __construct(ConfigurationInterface $configuration)
         $this->connection = $configuration->getConnection();
         $this->cache = $configuration->getCache();
         $this->schemaAnalyzer = $configuration->getSchemaAnalyzer();
+        $lockFilePath = $configuration->getLockFilePath();
 
         $this->magicQuery = new MagicQuery($this->connection, $this->cache, $this->schemaAnalyzer);
 
-        $this->tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer($this->connection, $this->cache, $this->schemaAnalyzer);
+        $this->tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer($this->connection, $this->cache, $this->schemaAnalyzer, $lockFilePath);
         $this->cachePrefix = $this->tdbmSchemaAnalyzer->getCachePrefix();
 
         $this->toSaveObjects = new \SplObjectStorage();

tests/Commands/GenerateCommandTest.php

@@ -3,56 +3,33 @@
 
 namespace TheCodingMachine\TDBM\Commands;
 
+use TheCodingMachine\TDBM\Configuration;
 use TheCodingMachine\TDBM\TDBMAbstractServiceTest;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Input\InputDefinition;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\BufferedOutput;
 use Symfony\Component\Console\Output\OutputInterface;
-use TheCodingMachine\TDBM\TDBMSchemaAnalyzer;
 
 class GenerateCommandTest extends TDBMAbstractServiceTest
 {
-    public static function getInputDefinition()
-    {
-        return new InputDefinition([
-        ]);
-    }
-
     public function testCall(): void
     {
-        $input = new ArrayInput([
-        ], self::getInputDefinition());
+        $input = new ArrayInput([], new InputDefinition([]));
+        $output = new BufferedOutput();
+        $output->setVerbosity(OutputInterface::VERBOSITY_DEBUG);
 
         //let's delete the lock file
-        $schemaFilePath = TDBMSchemaAnalyzer::getLockFilePath();
+        $schemaFilePath = Configuration::getDefaultLockFilePath();
         if (file_exists($schemaFilePath)) {
             unlink($schemaFilePath);
         }
-        $result = $this->callCommand(new GenerateCommand($this->getConfiguration()), $input);
+        (new GenerateCommand($this->getConfiguration()))->run($input, $output);
+        $result = $output->fetch();
 
         $this->assertContains('Finished regenerating DAOs and beans', $result);
         //Check that the lock file was generated
         $this->assertFileExists($schemaFilePath);
     }
-
-    /**
-     * Calls the command passed in parameter. Returns the output.
-     *
-     * @param Command $command
-     * @param InputInterface $input
-     * @return string
-     */
-    protected function callCommand(Command $command, InputInterface $input) : string
-    {
-        $output = new BufferedOutput();
-        $output->setVerbosity(OutputInterface::VERBOSITY_DEBUG);
-
-        $r = new \ReflectionMethod($command, 'execute');
-        $r->setAccessible(true);
-        $r->invoke($command, $input, $output);
-
-        return $output->fetch();
-    }
 }

tests/Performance/ManyToOneBench.php

@@ -91,7 +91,7 @@ private static function generateDaosAndBeans(Connection $connection): void
     {
         $schemaManager = $connection->getSchemaManager();
         $schemaAnalyzer = new SchemaAnalyzer($schemaManager);
-        $tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer($connection, new ArrayCache(), $schemaAnalyzer);
+        $tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer($connection, new ArrayCache(), $schemaAnalyzer, Configuration::getDefaultLockFilePath());
         $tdbmDaoGenerator = new TDBMDaoGenerator(self::createConfiguration(), $tdbmSchemaAnalyzer);
         $rootPath = __DIR__ . '/../';
         self::recursiveDelete(__DIR__. '/../../src/Test/Dao/');

tests/TDBMDaoGeneratorTest.php

@@ -98,7 +98,7 @@ protected function setUp(): void
         parent::setUp();
         $schemaManager = $this->tdbmService->getConnection()->getSchemaManager();
         $schemaAnalyzer = new SchemaAnalyzer($schemaManager);
-        $tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer($this->tdbmService->getConnection(), new ArrayCache(), $schemaAnalyzer);
+        $tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer($this->tdbmService->getConnection(), new ArrayCache(), $schemaAnalyzer, Configuration::getDefaultLockFilePath());
         $this->tdbmDaoGenerator = new TDBMDaoGenerator($this->getConfiguration(), $tdbmSchemaAnalyzer);
         $this->rootPath = __DIR__ . '/../';
         //$this->tdbmDaoGenerator->setComposerFile($this->rootPath.'composer.json');
@@ -107,13 +107,13 @@ protected function setUp(): void
     public function testGetSchemaCrashWithoutLock()
     {
         //let's delete the lock file
-        $schemaFilePath = TDBMSchemaAnalyzer::getLockFilePath();
+        $schemaFilePath = Configuration::getDefaultLockFilePath();
         if (file_exists($schemaFilePath)) {
             unlink($schemaFilePath);
         }
         //let's check we cannot call get schema without a lock file
         $schemaAnalyzer = new SchemaAnalyzer(self::getConnection()->getSchemaManager(), new ArrayCache(), 'prefix_');
-        $tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer(self::getConnection(), new ArrayCache(), $schemaAnalyzer);
+        $tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer(self::getConnection(), new ArrayCache(), $schemaAnalyzer, Configuration::getDefaultLockFilePath());
         $this->expectException('TheCodingMachine\TDBM\TDBMException');
         $schema1 = $tdbmSchemaAnalyzer->getSchema(true);
     }
@@ -129,7 +129,7 @@ public function testDaoGeneration(): void
         $this->assertFileExists($dummyFile);
 
         //let's delete the lock file
-        $schemaFilePath = TDBMSchemaAnalyzer::getLockFilePath();
+        $schemaFilePath = Configuration::getDefaultLockFilePath();
         if (file_exists($schemaFilePath)) {
             unlink($schemaFilePath);
         }
@@ -169,7 +169,7 @@ public function testGenerationException(): void
 
         $schemaManager = $this->tdbmService->getConnection()->getSchemaManager();
         $schemaAnalyzer = new SchemaAnalyzer($schemaManager);
-        $tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer($this->tdbmService->getConnection(), new ArrayCache(), $schemaAnalyzer);
+        $tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer($this->tdbmService->getConnection(), new ArrayCache(), $schemaAnalyzer, Configuration::getDefaultLockFilePath());
         $tdbmDaoGenerator = new TDBMDaoGenerator($configuration, $tdbmSchemaAnalyzer);
         $this->rootPath = __DIR__ . '/../../../../';
         //$tdbmDaoGenerator->setComposerFile($this->rootPath.'composer.json');

tests/TDBMSchemaAnalyzerTest.php

@@ -36,7 +36,7 @@ protected function setUp(): void
     {
         parent::setUp();
         $schemaAnalyzer = new SchemaAnalyzer(self::getConnection()->getSchemaManager(), new ArrayCache(), 'prefix_');
-        $this->tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer(self::getConnection(), new ArrayCache(), $schemaAnalyzer);
+        $this->tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer(self::getConnection(), new ArrayCache(), $schemaAnalyzer, Configuration::getDefaultLockFilePath());
     }
 
     public function testSchemaLock(): void
@@ -51,7 +51,7 @@ public function testSchemaLock(): void
 
         $schemaAnalyzer = new SchemaAnalyzer(self::getConnection()->getSchemaManager(), new ArrayCache(), 'prefix_');
         $cache = new ArrayCache();
-        $tdbmSchemaAnalyzer1 = new TDBMSchemaAnalyzer(self::getConnection(), $cache, $schemaAnalyzer);
+        $tdbmSchemaAnalyzer1 = new TDBMSchemaAnalyzer(self::getConnection(), $cache, $schemaAnalyzer, Configuration::getDefaultLockFilePath());
 
         $schemaFromAnalyser = $tdbmSchemaAnalyzer1->getSchema(true);
         $schemaFromAnalyserCached = $tdbmSchemaAnalyzer1->getSchema();
@@ -63,8 +63,8 @@ public function testGetSchema(): void
     {
         $schemaAnalyzer = new SchemaAnalyzer(self::getConnection()->getSchemaManager(), new ArrayCache(), 'prefix_');
         $cache = new ArrayCache();
-        $tdbmSchemaAnalyzer1 = new TDBMSchemaAnalyzer(self::getConnection(), $cache, $schemaAnalyzer);
-        $tdbmSchemaAnalyzer2 = new TDBMSchemaAnalyzer(self::getConnection(), $cache, $schemaAnalyzer);
+        $tdbmSchemaAnalyzer1 = new TDBMSchemaAnalyzer(self::getConnection(), $cache, $schemaAnalyzer, Configuration::getDefaultLockFilePath());
+        $tdbmSchemaAnalyzer2 = new TDBMSchemaAnalyzer(self::getConnection(), $cache, $schemaAnalyzer, Configuration::getDefaultLockFilePath());
 
         // Why don't we go in all lines of code????
         $schema1 = $tdbmSchemaAnalyzer1->getSchema();
@@ -77,7 +77,7 @@ public function testGetIncomingForeignKeys(): void
     {
         $schemaAnalyzer = new SchemaAnalyzer(self::getConnection()->getSchemaManager(), new ArrayCache(), 'prefix_');
         $cache = new ArrayCache();
-        $tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer(self::getConnection(), $cache, $schemaAnalyzer);
+        $tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer(self::getConnection(), $cache, $schemaAnalyzer, Configuration::getDefaultLockFilePath());
 
         $fks = $tdbmSchemaAnalyzer->getIncomingForeignKeys('users');
         $this->assertCount(1, $fks);
@@ -87,7 +87,7 @@ public function testGetIncomingForeignKeys2(): void
     {
         $schemaAnalyzer = new SchemaAnalyzer(self::getConnection()->getSchemaManager(), new ArrayCache(), 'prefix_');
         $cache = new ArrayCache();
-        $tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer(self::getConnection(), $cache, $schemaAnalyzer);
+        $tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer(self::getConnection(), $cache, $schemaAnalyzer, Configuration::getDefaultLockFilePath());
 
         $fks = $tdbmSchemaAnalyzer->getIncomingForeignKeys('contact');
         $this->assertCount(1, $fks);
@@ -97,7 +97,7 @@ public function testGetIncomingForeignKeys3(): void
     {
         $schemaAnalyzer = new SchemaAnalyzer(self::getConnection()->getSchemaManager(), new ArrayCache(), 'prefix_');
         $cache = new ArrayCache();
-        $tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer(self::getConnection(), $cache, $schemaAnalyzer);
+        $tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer(self::getConnection(), $cache, $schemaAnalyzer, Configuration::getDefaultLockFilePath());
 
         $fks = $tdbmSchemaAnalyzer->getIncomingForeignKeys('country');
         $this->assertCount(5, $fks);
@@ -112,7 +112,7 @@ public function testGetPivotTableLinkedToTable(): void
     {
         $schemaAnalyzer = new SchemaAnalyzer(self::getConnection()->getSchemaManager(), new ArrayCache(), 'prefix_');
         $cache = new ArrayCache();
-        $tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer(self::getConnection(), $cache, $schemaAnalyzer);
+        $tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer(self::getConnection(), $cache, $schemaAnalyzer, Configuration::getDefaultLockFilePath());
 
         $pivotTables = $tdbmSchemaAnalyzer->getPivotTableLinkedToTable('rights');
         $this->assertCount(1, $pivotTables);