Merge pull request #1244 from emptyhand/feature-ordered-seeds

Add ordered seeds feature

.travis.yml

@@ -33,7 +33,7 @@ before_script:
 script:
     - if [[ $DEFAULT = 1 ]]; then vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover; fi
     - if [[ $PHPSTAN = 1 ]]; then composer require --dev phpstan/phpstan:^0.8 && vendor/bin/phpstan analyse -c phpstan.neon -l 4 src; fi
-    - if [[ $PHPCS = 1 ]]; then composer require --dev squizlabs/php_codesniffer:^3.0 && vendor/bin/phpcs -p -s src; fi
+    - if [[ $PHPCS = 1 ]]; then composer require --dev squizlabs/php_codesniffer:~3.1.1 && vendor/bin/phpcs -p -s src; fi
 
 after_success:
   - if [[ $DEFAULT = 1 ]]; then bash <(curl -s https://codecov.io/bash); fi

src/Phinx/Migration/Manager.php

@@ -768,6 +768,54 @@ public function setSeeds(array $seeds)
         return $this;
     }
 
+    /**
+     * Get seed dependencies instances from seed dependency array
+     *
+     * @param AbstractSeed $seed Seed
+     *
+     * @return AbstractSeed[]
+     */
+    private function getSeedDependenciesInstances(AbstractSeed $seed)
+    {
+        $dependenciesInstances = [];
+        $dependencies = $seed->getDependencies();
+        if (!empty($dependencies)) {
+            foreach ($dependencies as $dependency) {
+                foreach ($this->seeds as $seed) {
+                    if (get_class($seed) === $dependency) {
+                        $dependenciesInstances[get_class($seed)] = $seed;
+                    }
+                }
+            }
+        }
+
+        return $dependenciesInstances;
+    }
+
+    /**
+     * Order seeds by dependencies
+     *
+     * @param AbstractSeed[] $seeds Seeds
+     *
+     * @return AbstractSeed[]
+     */
+    private function orderSeedsByDependencies(array $seeds)
+    {
+        $orderedSeeds = [];
+        foreach ($seeds as $seed) {
+            $key = get_class($seed);
+            $dependencies = $this->getSeedDependenciesInstances($seed);
+            if (!empty($dependencies)) {
+                $orderedSeeds[$key] = $seed;
+                $orderedSeeds = array_merge($this->orderSeedsByDependencies($dependencies), $orderedSeeds);
+            } else {
+                $orderedSeeds[$key] = $seed;
+            }
+        }
+
+        return $orderedSeeds;
+    }
+
     /**
      * Gets an array of database seeders.
      *
@@ -823,6 +871,7 @@ public function getSeeds()
             $this->setSeeds($seeds);
         }
 
+        $this->seeds = $this->orderSeedsByDependencies($this->seeds);
         return $this->seeds;
     }
 

src/Phinx/Seed/AbstractSeed.php

@@ -94,6 +94,16 @@ public function run()
     {
     }
 
+    /**
+     * Return seeds dependencies.
+     *
+     * @return array
+     */
+    public function getDependencies()
+    {
+        return [];
+    }
+
     /**
      * {@inheritdoc}
      */

tests/Phinx/Migration/ManagerTest.php

@@ -5413,6 +5413,14 @@ public function testExecuteANonExistentSeedWorksAsExpectedWithMixedNamespace()
         $this->assertContains('Foo\Bar\UserSeeder', $output);
     }
 
+    public function testOrderSeeds()
+    {
+        $seeds = array_values($this->manager->getSeeds());
+        $this->assertInstanceOf('UserSeeder', $seeds[0]);
+        $this->assertInstanceOf('GSeeder', $seeds[1]);
+        $this->assertInstanceOf('PostSeeder', $seeds[2]);
+    }
+
     public function testGettingInputObject()
     {
         $migrations = $this->manager->getMigrations();

tests/Phinx/Migration/_files/seeds/PostSeeder.php

@@ -21,4 +21,12 @@ public function run()
         $posts->insert($data)
               ->save();
     }
+
+    public function getDependencies()
+    {
+        return [
+            'UserSeeder',
+            'GSeeder',
+        ];
+    }
 }