Doctrine

Timestamp:

02/23/08 21:43:57 (17 months ago)

Author:

jwage

Message:

fixes #627 #791 This also fixes an issue where the class tables do not extend the correct class when dealing with inheritance. Also new tests to cover this functionality.

Location:

branches/0.10

Files:

• lib/Doctrine/Import/Builder.php (modified) (26 diffs)
• models/ModelLoadingTest/Aggressive (deleted)
• models/ModelLoadingTest/Conservative (deleted)
• tests/BaseTestCase.php (modified) (2 diffs)
• tests/Import/BuilderTestCase.php (modified) (2 diffs)
• tests/ModelLoadingTest (moved) (moved from branches/0.10/models/ModelLoadingTest)
• tests/ModelLoadingTest/ModelLoadingTest (copied) (copied from branches/0.10/models/ModelLoadingTest)
• tests/run.php (modified) (4 diffs)

branches/0.10/lib/Doctrine/Import/Builder.php

@@ -40 +40 @@
 {
     /**
-     * Path
+     * _path
      * 
      * the path where imported files are being generated
@@ -49 +49 @@
     
     /**
-     * packagesPrefix
+     * _packagesPrefix
      *
      * @var string
@@ -56 +56 @@
 
     /**
-     * packagesPath
+     * _packagesPath
      *
      * @var string
@@ -63 +63 @@
     
     /**
-     * suffix
+     * _suffix
      * 
      * File suffix to use when writing class definitions
@@ -72 +72 @@
 
     /**
-     * generateBaseClasses
+     * _generateBaseClasses
      * 
      * Bool true/false for whether or not to generate base classes
@@ -81 +81 @@
 
     /**
-     * baseClassesDirectory
+     * _base
+     *
+     * Prefix to use for generated base classes
+     *
+     * @var string
+     */
+    protected $_baseClassPrefix = 'Base';
+
+    /**
+     * _baseClassesDirectory
      * 
      * Directory to put the generate base classes in
@@ -90 +99 @@
     
     /**
-     * baseClassName
+     * _baseClassName
      *
      * @var string
@@ -97 +106 @@
     
     /**
-     * tpl
+     * _tpl
      *
      * Class template used for writing classes
@@ -123 +132 @@
     public function setTargetPath($path)
     {
-        if ( ! $this->_packagesPath) {
-            $this->setPackagesPath($path . DIRECTORY_SEPARATOR . 'packages');
-        }
-
-        $this->_path = $path;
+        if ($path) {
+            if ( ! $this->_packagesPath) {
+                $this->setPackagesPath($path . DIRECTORY_SEPARATOR . 'packages');
+            }
+
+            $this->_path = $path;
+        }
     }
     
@@ -149 +160 @@
     public function setPackagesPath($packagesPath)
     {
-        $this->_packagesPath = $packagesPath;
+        if ($packagesPath) {
+            $this->_packagesPath = $packagesPath;
+        }
     }
     
@@ -168 +181 @@
         return $this->_generateBaseClasses;
     }
-
+    
+    /**
+     * setBaseClassPrefix
+     *
+     * @param string $prefix 
+     * @return void
+     */
+    public function setBaseClassPrefix($prefix)
+    {
+        $this->_baseClassPrefix = $prefix;
+    }
+    
+    /**
+     * getBaseClassPrefix
+     *
+     * @return void
+     */
+    public function getBaseClassPrefix()
+    {
+        return $this->_baseClassPrefix;
+    }
+    
     /**
      * setBaseClassesDirectory
@@ -358 +392 @@
 
                 if (isset($relation['refClass'])) {
-                    $a[] = '\'refClass\' => ' . var_export($relation['refClass'], true);
+                    $a[] = '\'refClass\' => ' . $this->varExport($relation['refClass']);
                 }
             
                 if (isset($relation['deferred']) && $relation['deferred']) {
-                    $a[] = '\'default\' => ' . var_export($relation['deferred'], true);
+                    $a[] = '\'default\' => ' . $this->varExport($relation['deferred']);
                 }
             
                 if (isset($relation['local']) && $relation['local']) {
-                    $a[] = '\'local\' => ' . var_export($relation['local'], true);
+                    $a[] = '\'local\' => ' . $this->varExport($relation['local']);
                 }
             
                 if (isset($relation['foreign']) && $relation['foreign']) {
-                    $a[] = '\'foreign\' => ' . var_export($relation['foreign'], true);
+                    $a[] = '\'foreign\' => ' . $this->varExport($relation['foreign']);
                 }
             
                 if (isset($relation['onDelete']) && $relation['onDelete']) {
-                    $a[] = '\'onDelete\' => ' . var_export($relation['onDelete'], true);
+                    $a[] = '\'onDelete\' => ' . $this->varExport($relation['onDelete']);
                 }
             
                 if (isset($relation['onUpdate']) && $relation['onUpdate']) {
-                    $a[] = '\'onUpdate\' => ' . var_export($relation['onUpdate'], true);
+                    $a[] = '\'onUpdate\' => ' . $this->varExport($relation['onUpdate']);
                 }
             
                 if (isset($relation['equal']) && $relation['equal']) { 
-                    $a[] = '\'equal\' => ' . var_export($relation['equal'], true); 
+                    $a[] = '\'equal\' => ' . $this->varExport($relation['equal']); 
                 }
             
@@ -446 +480 @@
             
             if (is_array($options) && !empty($options)) {
-                $build .= ', ' . var_export($options, true);
+                $build .= ', ' . $this->varExport($options);
             }
     
@@ -453 +487 @@
         
         return $build;
+    }
+
+    /**
+     * varExport
+     *
+     * Special function for var_export()
+     * The normal code which is returned is malformed and does not follow Doctrine standards
+     * So we do some string replacing to clean it up
+     *
+     * @param string $var 
+     * @return void
+     */
+    public function varExport($var)
+    {
+        $export = var_export($var, true);
+        $export = str_replace("\n ", '', $export);
+        $export = str_replace('array ( ', 'array(', $export);
+        $export = str_replace(",\n", "", $export);
+        
+        return $export;
     }
 
@@ -502 +556 @@
             
             if (is_array($options) && !empty($options)) {
-                $optionsPhp = var_export($options, true);
+                $optionsPhp = $this->varExport($options);
             
                 $build .= "    \$this->loadTemplate('" . $name . "', " . $optionsPhp . ");\n";
@@ -528 +582 @@
         foreach ($actAs as $name => $options) {
             if (is_array($options) && !empty($options)) {
-                $optionsPhp = var_export($options, true);
+                $optionsPhp = $this->varExport($options);
                 
                 $build .= "    \$this->actAs('" . $name . "', " . $optionsPhp . ");\n";
@@ -587 +641 @@
         $build = '';
         foreach ($options as $name => $value) {
-            $build .= "    \$this->option('$name', " . var_export($value, true) . ");\n";
+            $build .= "    \$this->option('$name', " . $this->varExport($value) . ");\n";
         }
         
@@ -605 +659 @@
       foreach ($indexes as $indexName => $definitions) {
           $build .= "\n    \$this->index('" . $indexName . "'";
-          $build .= ', ' . var_export($definitions, true);
+          $build .= ', ' . $this->varExport($definitions);
           $build .= ');';
       }
@@ -665 +719 @@
             throw new Doctrine_Import_Builder_Exception('Missing class name.');
         }
-
+        
+        $definition['topLevelClassName'] = $definition['className'];
+        
         if ($this->generateBaseClasses()) {
             $definition['is_package'] = (isset($definition['package']) && $definition['package']) ? true:false;
@@ -674 +730 @@
                 unset($e[0]);
                 
-                $definition['package_path'] = implode(DIRECTORY_SEPARATOR, $e);
+                $definition['package_path'] = ! empty($e) ? implode(DIRECTORY_SEPARATOR, $e):$definition['package_name'];
             }
             
@@ -701 +757 @@
                 $packageLevel['is_package_class'] = true;
                 unset($packageLevel['connection']);
+                
+                $packageLevel['tableClassName'] = $packageLevel['className'] . 'Table';
+                $packageLevel['inheritance']['tableExtends'] = isset($definition['inheritance']['extends']) ? $definition['inheritance']['extends'] . 'Table':'Doctrine_Table';
+                
+                $topLevel['tableClassName'] = $topLevel['topLevelClassName'] . 'Table';
+                $topLevel['inheritance']['tableExtends'] = $packageLevel['className'] . 'Table';
+            } else {
+                $topLevel['tableClassName'] = $topLevel['className'] . 'Table';
+                $topLevel['inheritance']['tableExtends'] = isset($definition['inheritance']['extends']) ? $definition['inheritance']['extends'] . 'Table':'Doctrine_Table';
             }
 
@@ -711 +776 @@
             $this->writeDefinition($baseClass);
             
-            if (!empty($packageLevel)) {
+            if ( ! empty($packageLevel)) {
                 $this->writeDefinition($packageLevel);
             }
@@ -718 +783 @@
         } else {
             $this->writeDefinition($definition);
+        }
+    }
+
+    /**
+     * writeTableDefinition
+     *
+     * @return void
+     */
+    public function writeTableDefinition($className, $path, $options = array())
+    {
+        $content  = '<?php' . PHP_EOL;
+        $content .= sprintf(self::$_tpl, false,
+                                       $className,
+                                       isset($options['extends']) ? $options['extends']:'Doctrine_Table',
+                                       null,
+                                       null,
+                                       null
+                                       );
+
+        Doctrine_Lib::makeDirectories($path);
+
+        $writePath = $path . DIRECTORY_SEPARATOR . $className . $this->_suffix;
+
+        if ( ! file_exists($writePath)) {
+            file_put_contents($writePath, $content);
         }
     }
@@ -750 +840 @@
                 $writePath = $this->_path;
             }
-        }
-
+
+            $this->writeTableDefinition($definition['tableClassName'], $writePath, array('extends' => $definition['inheritance']['tableExtends']));
+        }
         // If is the package class then we need to make the path to the complete package
-        if (isset($definition['is_package_class']) && $definition['is_package_class']) {
-            $path = str_replace('.', DIRECTORY_SEPARATOR, trim($definition['package']));
-            
-            $writePath = $packagesPath . DIRECTORY_SEPARATOR . $path;
-        }
-        
+        else if (isset($definition['is_package_class']) && $definition['is_package_class']) {
+            $writePath = $packagesPath . DIRECTORY_SEPARATOR . $definition['package_path'];
+
+            $this->writeTableDefinition($definition['tableClassName'], $writePath, array('extends' => $definition['inheritance']['tableExtends']));
+        }
         // If it is the base class of the doctrine record definition
-        if (isset($definition['is_base_class']) && $definition['is_base_class']) {
+        else if (isset($definition['is_base_class']) && $definition['is_base_class']) {
             // If it is a part of a package then we need to put it in a package subfolder
             if (isset($definition['is_package']) && $definition['is_package']) {
-                $writePath  = $this->_path . DIRECTORY_SEPARATOR . $definition['package_name'] . DIRECTORY_SEPARATOR . $this->_baseClassesDirectory;
+                $basePath = $this->_path . DIRECTORY_SEPARATOR . $definition['package_name'];
+                $writePath = $basePath . DIRECTORY_SEPARATOR . $this->_baseClassesDirectory;
             // Otherwise lets just put it in the root generated folder
             } else {
@@ -770 +861 @@
         }
 
+        // If we have a writePath from the if else conditionals above then use it
         if (isset($writePath)) {
             Doctrine_Lib::makeDirectories($writePath);
-            
+
             $writePath .= DIRECTORY_SEPARATOR . $fileName;
+        // Otherwise none of the conditions were met and we aren't generating base classes
         } else {
             Doctrine_Lib::makeDirectories($this->_path);
-            
+
             $writePath = $this->_path . DIRECTORY_SEPARATOR . $fileName;
         }
@@ -789 +882 @@
         $code .= PHP_EOL . $definitionCode;
 
+        $bytes = file_put_contents($writePath, $code);
+        return;
+        
         if (isset($definition['generate_once']) && $definition['generate_once'] === true) {
             if ( ! file_exists($writePath)) {

branches/0.10/tests/BaseTestCase.php

@@ -35 +35 @@
     public function testAggressiveModelLoading()
     {
-        $path = realpath('../models/ModelLoadingTest/Aggressive');
+        $path = realpath('ModelLoadingTest/Aggressive');
         
         $models = Doctrine::loadModels($path, Doctrine::MODEL_LOADING_AGGRESSIVE);
@@ -55 +55 @@
     public function testConservativeModelLoading()
     {
-        $path = realpath('../models/ModelLoadingTest/Conservative');
+        $path = realpath('ModelLoadingTest/Conservative');
 
         $models = Doctrine::loadModels($path, Doctrine::MODEL_LOADING_CONSERVATIVE);

branches/0.10/tests/Import/BuilderTestCase.php

@@ -46 +46 @@
         $schemaTestInheritanceChild2 = new ReflectionClass('SchemaTestInheritanceChild2');
 
-        /*
         $schemaTestInheritanceParentTable = new ReflectionClass('SchemaTestInheritanceParentTable');
         $schemaTestInheritanceChild1Table = new ReflectionClass('SchemaTestInheritanceChild1Table');
         $schemaTestInheritanceChild2Table = new ReflectionClass('SchemaTestInheritanceChild2Table');
-        */
 
+        $this->assertTrue($schemaTestInheritanceParent->isSubClassOf('Doctrine_Record'));
         $this->assertTrue($schemaTestInheritanceParent->isSubClassOf('BaseSchemaTestInheritanceParent'));
+        $this->assertTrue($schemaTestInheritanceParent->isSubClassOf('PackageSchemaTestInheritanceParent'));
         $this->assertTrue($schemaTestInheritanceChild1->isSubClassOf('BaseSchemaTestInheritanceChild1'));
         $this->assertTrue($schemaTestInheritanceChild2->isSubClassOf('BaseSchemaTestInheritanceChild2'));
@@ -63 +63 @@
         $this->assertTrue($schemaTestInheritanceChild2->isSubClassOf('SchemaTestInheritanceChild1'));
         $this->assertTrue($schemaTestInheritanceChild2->isSubClassOf('BaseSchemaTestInheritanceChild1'));
+        $this->assertTrue($schemaTestInheritanceChild2->isSubClassOf('PackageSchemaTestInheritanceParent'));
 
-        /*
         $this->assertTrue($schemaTestInheritanceParentTable->isSubClassOf('Doctrine_Table'));
         $this->assertTrue($schemaTestInheritanceChild1Table->isSubClassOf('SchemaTestInheritanceParentTable'));
         $this->assertTrue($schemaTestInheritanceChild1Table->isSubClassOf('PackageSchemaTestInheritanceParentTable'));
-        */
-        
+
+        $this->assertTrue($schemaTestInheritanceChild2Table->isSubClassOf('SchemaTestInheritanceParentTable'));
+        $this->assertTrue($schemaTestInheritanceChild2Table->isSubClassOf('PackageSchemaTestInheritanceParentTable'));
+        $this->assertTrue($schemaTestInheritanceChild2Table->isSubClassOf('SchemaTestInheritanceChild1Table'));
+        $this->assertTrue($schemaTestInheritanceChild2Table->isSubClassOf('PackageSchemaTestInheritanceChild1Table'));
+
         Doctrine_Lib::removeDirectories($path);
     }

branches/0.10/tests/run.php

@@ -90 +90 @@
 $export->addTestCase(new Doctrine_Export_Mysql_TestCase());
 $export->addTestCase(new Doctrine_Export_Sqlite_TestCase());
+$export->addTestCase(new Doctrine_Export_Schema_TestCase());
 $test->addTestCase($export);
 
@@ -104 +105 @@
 $import->addTestCase(new Doctrine_Import_Oracle_TestCase());
 $import->addTestCase(new Doctrine_Import_Sqlite_TestCase());
+$import->addTestCase(new Doctrine_Import_Builder_TestCase());
+$import->addTestCase(new Doctrine_Import_Schema_TestCase());
 $test->addTestCase($import);
 
@@ -228 +231 @@
 $record->addTestCase(new Doctrine_Record_Inheritance_TestCase());
 $record->addTestCase(new Doctrine_Record_Synchronize_TestCase());
-$record->addTestCase(new Doctrine_Import_Builder_TestCase());
 $test->addTestCase($record);
 
@@ -279 +281 @@
 $test->addTestCase($parser);
 
-$schemaFiles = new GroupTest('Schema files', 'schema_files');
-$schemaFiles->addTestCase(new Doctrine_Import_Schema_TestCase());
-$schemaFiles->addTestCase(new Doctrine_Export_Schema_TestCase());
-$test->addTestCase($schemaFiles);
-
 $data = new GroupTest('Data exporting/importing fixtures', 'data_fixtures');
 $data->addTestCase(new Doctrine_Data_Import_TestCase());