Add dir option and fix namespace for models

Load the original docblock and append the changes. This way, you can
just copy the new comments in whole (next step, replace in file..)

readme.md

@@ -1,4 +1,4 @@
-## Laravel IDE Helper & Generator
+## Laravel IDE Helper Generator
 
 ### Complete phpDocs, directly from the source
 
@@ -8,6 +8,11 @@ Add the helper file to your laravel folder (not in a public folder). The file is
 * SublimeText CodeIntel version: https://gist.github.com/barryvdh/5227814
 
 ### Automatic phpDoc generation for Laravel Facades
+#### NOTE: run before optimising. If bootstrap/compiled.php is loaded, it doesn't work.
+
+    php artisan clear-compiled
+    php artisan ide-helper:generate
+    php artisan optimize
 
 Require this package in your composer.json:
 
@@ -31,8 +36,8 @@ You can configure your composer.json to do this after each commit:
 
     "scripts":{
         "post-update-cmd":[
-            "php artisan optimize",
             "php artisan ide-helper:generate",
+            "php artisan optimize"
         ]
     },
 
@@ -52,21 +57,23 @@ The Illuminate/Support/helpers.php is already set-up, but you can add/remove you
 ### Work in progress: Model docs
 
 If you don't want to write your properties yourself, you can use the (experimental) command `ide-helper:models` to generate
-phpDocs, based on table columns, relations and getters/setters. Very alpha, so please provide feedback if you want.
-Docs are written to a phpfile in the root of the project, so you can move the docs to the real model.
+phpDocs, based on table columns, relations and getters/setters. Still in beta, so please provide feedback if you want.
+Docs are written to a phpfile (_ide_helper_models.php) in the root of the project, so you can move the docs to the real model.
 
-For now, only models in app/models are scanned. The optional argument tells what models to use.
+You can now also write the comments directly to your Model file, using the -W argument. Please make sure to backup your models, before writing the info.
+It should keep the existing comments and only append new properties/methods.
+
+For now, only models in app/models are scanned. The optional argument tells what models to use (also outside app/models).
 `php artisan ide-helper:models Post,User`
 
 Note: With namespaces, uses \\ instead of \
 `php artisan ide-helper:models API\\User`
 
 This creates a file with the phpDocs for each Model. You should check and change them to be more accurate.
-It doesn't know if datetimes are returned as string or DateTime/Carbon, but I assume they are.
 Also, all relations are Eloquent|Eloquent[] by default, you can change them to the actual Model.
 After copying the phpdocs to your model, you can clear the file, so your IDE only uses the real source.
 
 
 ### License
 
-The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
+The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)

src/Barryvdh/LaravelIdeHelper/GeneratorCommand.php

@@ -52,34 +52,37 @@ class GeneratorCommand extends Command {
      */
     public function fire()
     {
-        $filename = $this->argument('filename');
-
-        if($this->option('memory')){
-            $this->useMemoryDriver();
-        }
-
-        $this->extra = \Config::get('laravel-ide-helper::extra');
-        $this->nonstatic = \Config::get('laravel-ide-helper::nonstatic');
-        $this->onlyExtend = \Config::get('laravel-ide-helper::only_extend');
-
-        if( $this->option('helpers') || (\Config::get('laravel-ide-helper::include_helpers') && ! $this->option('nohelpers'))){
-            $this->helpers = \Config::get('laravel-ide-helper::helper_files');
+        if (file_exists($compiled = base_path().'/bootstrap/compiled.php')){
+            $this->error('Error: first delete bootstrap/compiled.php (php artisan clear-compiled)');
         }else{
-            $this->helpers = array();
-        }
-
-        $this->sublime = $this->option('sublime') || \Config::get('laravel-ide-helper::sublime');
-
-        $content = $this->generateDocs();
-
-        $written = \File::put($filename, $content);
-
-        if($written !== false){
-            $this->info("A new helper file was written to $filename");
-        }else{
-            $this->error("The helper file could not be created at $filename");
-        }
-
+            $filename = $this->argument('filename');
+    
+            if($this->option('memory')){
+                $this->useMemoryDriver();
+            }
+    
+            $this->extra = \Config::get('laravel-ide-helper::extra');
+            $this->nonstatic = \Config::get('laravel-ide-helper::nonstatic');
+            $this->onlyExtend = \Config::get('laravel-ide-helper::only_extend');
+    
+            if( $this->option('helpers') || (\Config::get('laravel-ide-helper::include_helpers') && ! $this->option('nohelpers'))){
+                $this->helpers = \Config::get('laravel-ide-helper::helper_files');
+            }else{
+                $this->helpers = array();
+            }
+    
+            $this->sublime = $this->option('sublime') || \Config::get('laravel-ide-helper::sublime');
+    
+            $content = $this->generateDocs();
+    
+            $written = \File::put($filename, $content);
+    
+            if($written !== false){
+                $this->info("A new helper file was written to $filename");
+            }else{
+                $this->error("The helper file could not be created at $filename");
+            }
+        }    
     }
 
     protected function useMemoryDriver(){

src/Barryvdh/LaravelIdeHelper/ModelsCommand.php

@@ -13,6 +13,10 @@ use Illuminate\Console\Command;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\ClassLoader\ClassMapGenerator;
+use phpDocumentor\Reflection\DocBlock;
+use phpDocumentor\Reflection\DocBlock\Context;
+use phpDocumentor\Reflection\DocBlock\Tag;
+use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
 /**
  * A command to generate autocomplete information for your IDE
  *
@@ -36,6 +40,9 @@ class ModelsCommand extends Command {
 
     protected $properties = array();
     protected $methods = array();
+    protected $write = false;
+    protected $dir;
+
 
 
     /**
@@ -46,16 +53,19 @@ class ModelsCommand extends Command {
     public function fire()
     {
         $filename = $this->option('filename');
+        $this->write = $this->option('write');
+        $this->dir = $this->option('dir');
         $model = $this->argument('model');
 
         $content = $this->generateDocs($model);
 
-        $written = \File::put($filename, $content);
-
-        if($written !== false){
-            $this->info("Model information was written to $filename");
-        }else{
-            $this->error("Failed to write model information to $filename");
+        if(!$this->write){
+            $written = \File::put($filename, $content);
+            if($written !== false){
+                $this->info("Model information was written to $filename");
+            }else{
+                $this->error("Failed to write model information to $filename");
+            }
         }
 
     }
@@ -83,6 +93,8 @@ class ModelsCommand extends Command {
     {
         return array(
             array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file', '_ide_helper_models.php'),
+            array('dir', 'D', InputOption::VALUE_OPTIONAL, 'The model dir', app_path().'/models'),
+            array('write', 'W', InputOption::VALUE_NONE, 'Write to Model file'),
         );
     }
 
@@ -129,24 +141,34 @@ class ModelsCommand extends Command {
 
 
     protected function loadModels(){
+        $dir = $this->dir;
+        if(!file_exists($dir)){
+            $dir = base_path().'/'.$dir;
+        }
         $models = array();
-        foreach(ClassMapGenerator::createMap(app_path().'/models') as $model=> $path){
+        foreach(ClassMapGenerator::createMap($dir) as $model=> $path){
             $models[] = $model;
         }
         return $models;
     }
 
+    /**
+     * Load the properties from the database table.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $model
+     */
     protected function getPropertiesFromTable($model){
         $table = $model->getTable();
         $schema = $model->getConnection()->getDoctrineSchemaManager($table);
+        $schema->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
 
         $columns = $schema->listTableColumns($table);
 
-        $properties = array();
         if($columns){
             foreach ($columns as $column) {
                 $name = $column->getName();
                 $type =  $column->getType()->getName();
+
                 switch($type){
                     case 'string':
                     case 'text':
@@ -180,6 +202,9 @@ class ModelsCommand extends Command {
         }
     }
 
+    /**
+     * @param \Illuminate\Database\Eloquent\Model $model
+     */
     protected function getPropertiesFromMethods($model){
         $methods = get_class_methods($model);
         if($methods){
@@ -242,6 +267,12 @@ class ModelsCommand extends Command {
         }
     }
 
+    /**
+     * @param string $name
+     * @param string|null $type
+     * @param bool|null $read
+     * @param bool|null $write
+     */
     protected function setProperty($name, $type = null, $read = null, $write = null){
         if(!isset($this->properties[$name])){
             $this->properties[$name] = array();
@@ -270,18 +301,38 @@ class ModelsCommand extends Command {
         }
     }
 
+    /**
+     * @param string $class
+     * @return string
+     */
     protected function createPhpDocs($class){
 
-        if(strpos($class, '\\') !== false){
-            $parts = explode('\\', $class);
-            $class = array_pop($parts);
-            $namespace = implode($parts, '\\');
-        }else{
-            $namespace = '';
+        $reflection = new \ReflectionClass($class);
+        $namespace = $reflection->getNamespaceName();
+        $classname = $reflection->getShortName();
+        $originalDoc = $reflection->getDocComment();
+        $phpdoc = new DocBlock($reflection, new Context($namespace));
+
+        if(!$phpdoc->getText()){
+            $phpdoc->setText("Generated properties for $class");
         }
-        $output = "namespace $namespace{\n";
-        $output .= "\t/**\n\t *\n\t * Generated properties for $class\n\t *\n";
+
+        $properties = array();
+        $methods = array();
+        foreach($phpdoc->getTags() as $tag){
+            $name = $tag->getName();
+            if($name == "property" || $name == "property-read" || $name == "property-write"){
+                $properties[] =$tag->getVariableName();
+            }elseif($name == "method"){
+                $methods[] = $tag->getMethodName();
+            }
+        }
+
         foreach($this->properties as $name => $property){
+            $name = "\$$name";
+            if(in_array($name, $properties)){
+                continue;
+            }
             if($property['read'] && $property['write']){
                 $attr = 'property';
             }elseif($property['write']){
@@ -289,16 +340,43 @@ class ModelsCommand extends Command {
             }else{
                 $attr = 'property-read';
             }
-            $type = $property['type'];
-            $output .= "\t * @$attr $type \$$name \n";
+            $tag = Tag::createInstance("@{$attr} {$property['type']} {$name}", $phpdoc);
+            $phpdoc->appendTag($tag);
         }
 
         foreach($this->methods as $name => $method){
-            $type = $method['type'];
-            $output .= "\t * @method $type $name() \n";
+            if(in_array($name, $methods)){
+                continue;
+            }
+            $name = "$name()";
+            $tag = Tag::createInstance("@method {$method['type']} {$name}", $phpdoc);
+            $phpdoc->appendTag($tag);
         }
 
-        $output .= "\t *\n\t */\n\tclass $class {}\n}\n\n";
+        $serializer = new DocBlockSerializer();
+        $serializer->getDocComment($phpdoc);
+        $docComment = $serializer->getDocComment($phpdoc);
+
+
+        if($this->write){
+            $filename = $reflection->getFileName();
+            $contents = \File::get($filename);
+            if($originalDoc){
+                $contents = str_replace($originalDoc, $docComment, $contents);
+            }else{
+                $needle = "class {$classname}";
+                $replace = "{$docComment}\nclass {$classname}";
+                $pos = strpos($contents,$needle);
+                if ($pos !== false) {
+                    $contents = substr_replace($contents,$replace,$pos,strlen($needle));
+                }
+            }
+            if(\File::put($filename, $contents)){
+                $this->info('Written new phpDocBlock to '.$filename);
+            }
+        }
+
+        $output = "namespace {$namespace}{\n{$docComment}\n\tclass {$classname} {}\n}\n\n";
         return $output;
     }