Merge pull request #45 from bryceray1121/master

Removing \r from generator in order to prevent ^M from being inserted in...

composer.json

@@ -14,8 +14,9 @@
         "illuminate/support": "4.x",
         "illuminate/console": "4.x",
         "illuminate/filesystem": "4.x",
-        "barryvdh/reflection-docblock": ">=2.0.1",
-        "symfony/class-loader": "~2.3"
+        "phpdocumentor/reflection-docblock": "2.0.0",
+        "symfony/class-loader": "~2.3",
+        "doctrine/dbal": "~2.3"
     },
     "autoload": {
         "psr-0": {

readme.md

@@ -52,9 +52,9 @@ The Illuminate/Support/helpers.php is already set-up, but you can add/remove you
 
 If you don't want to write your properties yourself, you can use the command `ide-helper:models` to generate
 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.
-
-You can now also write the comments directly to your Model file, using the `--write (-W)` option. Please make sure to backup your models, before writing the info.
+You can now also write the comments directly to your Model file, using the `--write (-W)` option. By default, you are asked to overwrite or
+write to a seperate file (_ide_helper_models.php) (You can force No with `--nowrite (-N)`).
+Please make sure to backup your models, before writing the info.
 It should keep the existing comments and only append new properties/methods. The existing phpdoc is replaced, or added if not found.
 With the `--reset (-R)` option, the existing phpdocs are ignored, only the newly found columns/relations are saved as phpdocs.
 
@@ -73,11 +73,19 @@ With the `--reset (-R)` option, the existing phpdocs are ignored, only the newly
      * @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
      */
 
-For now, only models in app/models are scanned. The optional argument tells what models to use (also outside app/models).
+By default, 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`
+You can also scan a different directory, using the --dir option (relative from the base path):
+
+    php artisan ide-helper:models --dir="app/workbench/name/package/models"
+
+Models can be ignored using the --ignore (-I) option
+
+    php artisan ide-helper:models --ignore="Post,User"
+
+Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`)
 
 ### License
 

src/Barryvdh/LaravelIdeHelper/GeneratorCommand.php

@@ -13,10 +13,10 @@ use Illuminate\Console\Command;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputArgument;
 use Illuminate\Foundation\AliasLoader;
-use Barryvdh\Reflection\DocBlock;
-use Barryvdh\Reflection\DocBlock\Context;
-use Barryvdh\Reflection\DocBlock\Tag;
-use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
+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
  *
@@ -41,6 +41,7 @@ class GeneratorCommand extends Command {
     protected $extra;
     protected $onlyExtend;
     protected $helpers;
+    protected $magic;
 
 
     /**
@@ -60,6 +61,7 @@ class GeneratorCommand extends Command {
             }
     
             $this->extra = \Config::get('laravel-ide-helper::extra');
+            $this->magic = \Config::get('laravel-ide-helper::magic');
 
             if( $this->option('helpers') || (\Config::get('laravel-ide-helper::include_helpers') )){
                 $this->helpers = \Config::get('laravel-ide-helper::helper_files');
@@ -145,7 +147,9 @@ exit('Only to be used as an helper for your IDE');\n\n";
             try{
 
                 //Some classes extend the facade
-                if(class_exists($facade)){
+                if(interface_exists($facade)){
+                    $output .= "interface $alias extends $facade{\n";
+                }elseif(class_exists($facade)){
                     $output .= "class $alias extends $facade{\n";
                 }else{
                     $output .= "class $alias{\n";
@@ -168,6 +172,11 @@ exit('Only to be used as an helper for your IDE');\n\n";
                     $output .= $this->getMethods($this->extra[$alias], $alias, $usedMethods);
                 }
 
+                //Add extra methods, from other classes (magic static calls)
+                if(array_key_exists($alias, $this->magic)){
+                    $output .= $this->addMagicMethods($this->magic[$alias], $alias, $usedMethods);
+                }
+
 
                 $output .= "}\n\n";
 
@@ -178,8 +187,8 @@ exit('Only to be used as an helper for your IDE');\n\n";
         }
 
         //Include the helper file, if requested
-        if(!empty($helpers)){
-            foreach($helpers as $helper){
+        if(!empty($this->helpers)){
+            foreach($this->helpers as $helper){
                 if (file_exists($helper)){
                     $output .= str_replace(array('<?php', '?>'), '', \File::get($helper));
                 }
@@ -282,17 +291,53 @@ exit('Only to be used as an helper for your IDE');\n\n";
     }
 
     /**
-     * @param \ReflectionMethod $method
-     * @param string $alias
+     * Get the methods for one or multiple magic methods.
+     *
+     * @param $methods
+     * @param $alias
+     * @param $usedMethods
+     * @param bool $addOutput
      * @return string
      */
-    protected function parseMethod($method, $alias, $class){
+    protected function addMagicMethods($methods, $alias, &$usedMethods, $addOutput = true){
+        $output = '';
+        foreach($methods as $magic => $real){
+            list($className, $name) = explode('::', $real);
+            if(!class_exists($className) && !interface_exists($className)){
+                continue;
+            }
+            $method = new \ReflectionMethod($className, $name);
+            $class = new \ReflectionClass($className);
+
+            if(!in_array($method->name, $usedMethods)){
+                if( $addOutput){
+                    $output .= $this->parseMethod($method, $alias, $class, $magic);
+                }
+                $usedMethods[] = $method->name;
+            }
+
+
+            $usedMethods[] = $magic;
+
+        }
+        return $output;
+    }
+
+    /**
+     * @param \ReflectionMethod $method
+     * @param string $alias
+     * @param $class
+     * @param null $methodName
+     * @return string
+     */
+    protected function parseMethod($method, $alias, $class, $methodName = null){
         $output = '';
 
         // Don't add the __clone() functions
         if($method->name === '__clone'){
             return $output;
         }
+        $methodName = $methodName ?: $method->name;
 
         $namespace = $method->getDeclaringClass()->getNamespaceName();
 
@@ -304,7 +349,7 @@ exit('Only to be used as an helper for your IDE');\n\n";
         $this->normalizeDescription($phpdoc, $method);
 
         //Correct the return values
-        $returnValue = $this->normalizeReturn($phpdoc, $method, $alias);
+        $returnValue = $this->getReturn($phpdoc);
 
         //Get the parameters, including formatted default values
         list($params, $paramsWithDefault) = $this->getParameters($method);
@@ -313,10 +358,10 @@ exit('Only to be used as an helper for your IDE');\n\n";
         $phpdoc->appendTag(Tag::createInstance('@static', $phpdoc));
 
         //Write the output, using the DocBlock serializer
-        $output .= $serializer->getDocComment($phpdoc) ."\n\t public static function ".$method->name."(";
+        $output .= $serializer->getDocComment($phpdoc) ."\n\t public static function ".$methodName."(";
 
         $output .= implode($paramsWithDefault, ", ");
-        $output .= "){\r\n";
+        $output .= "){\n";
 
         //Only return when not a constructor and not void.
         $return = ($returnValue && $returnValue !== "void" && $method->name !== "__construct") ? 'return' : '';
@@ -326,13 +371,13 @@ exit('Only to be used as an helper for your IDE');\n\n";
         $root = $class->getName();
 
         if($declaringClass->name != $root){
-            $output .= "\t\t//Method inherited from $declaringClass->name\r\n";
+            $output .= "\t\t//Method inherited from $declaringClass->name\n";
         }
 
         $output .=  "\t\t$return $root::";
 
         //Write the default parameters in the function call
-        $output .=  $method->name."(".implode($params, ", ").");\r\n";
+        $output .=  $method->name."(".implode($params, ", ").");\n";
         $output .= "\t }\n\n";
 
         return $output;
@@ -371,23 +416,15 @@ exit('Only to be used as an helper for your IDE');\n\n";
      * Make some changes to the return types, if needed.
      *
      * @param $phpdoc
-     * @param $method
-     * @param $alias
-     * @return null
+     * @return string|null
      */
-    protected function normalizeReturn(&$phpdoc, $method, $alias){
+    protected function getReturn($phpdoc){
         //Get the return type and adjust them for beter autocomplete
         $returnTags = $phpdoc->getTagsByName('return');
         if($returnTags){
             /** @var  $tag */
             $tag = reset($returnTags);
             $returnValue = $tag->getType();
-
-            if($method->name == "__construct"){
-                $tag->setType('self');
-            }elseif($alias == 'Eloquent' and in_array($method->name, array('hasOne', 'hasMany', 'belongsTo', 'belongsToMany', 'morphOne', 'morphTo', 'morphMany'))){
-                $tag->addType('\Eloquent');
-            }
         }else{
             $returnValue = null;
         }

src/Barryvdh/LaravelIdeHelper/IdeHelperServiceProvider.php

@@ -19,7 +19,7 @@ class IdeHelperServiceProvider extends ServiceProvider {
 	 *
 	 * @var bool
 	 */
-	protected $defer = false;
+	protected $defer = true;
 
 	/**
 	 * Bootstrap the application events.

src/Barryvdh/LaravelIdeHelper/ModelsCommand.php

@@ -13,10 +13,10 @@ use Illuminate\Console\Command;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\ClassLoader\ClassMapGenerator;
-use Barryvdh\Reflection\DocBlock;
-use Barryvdh\Reflection\DocBlock\Context;
-use Barryvdh\Reflection\DocBlock\Tag;
-use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
+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
  *
@@ -30,6 +30,7 @@ class ModelsCommand extends Command {
      * @var string
      */
     protected $name = 'ide-helper:models';
+    protected $filename = '_ide_helper_models.php';
 
     /**
      * The console command description.
@@ -57,9 +58,17 @@ class ModelsCommand extends Command {
         $this->write = $this->option('write');
         $this->dir = $this->option('dir');
         $model = $this->argument('model');
+        $ignore = $this->option('ignore');
         $this->reset = $this->option('reset');
 
-        $content = $this->generateDocs($model);
+        //If filename is default and Write is not specified, ask what to do
+        if(!$this->write && $filename === $this->filename && !$this->option('nowrite')){
+            if($this->confirm("Do you want to overwrite the existing model files for '$model'? Choose no to write to $filename instead? (Yes/No): ")){
+                $this->write = true;
+            }
+        }
+
+        $content = $this->generateDocs($model, $ignore);
 
         if(!$this->write){
             $written = \File::put($filename, $content);
@@ -69,7 +78,6 @@ class ModelsCommand extends Command {
                 $this->error("Failed to write model information to $filename");
             }
         }
-
     }
 
 
@@ -82,7 +90,6 @@ class ModelsCommand extends Command {
     {
         return array(
             array('model', InputArgument::OPTIONAL, 'Which models to include', '*'),
-
         );
     }
 
@@ -94,14 +101,16 @@ class ModelsCommand extends Command {
     protected function getOptions()
     {
         return array(
-            array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file', '_ide_helper_models.php'),
+            array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file', $this->filename),
             array('dir', 'D', InputOption::VALUE_OPTIONAL, 'The model dir','app/models'),
             array('write', 'W', InputOption::VALUE_NONE, 'Write to Model file'),
+            array('nowrite', 'N', InputOption::VALUE_NONE, 'Don\'t write to Model file'),
             array('reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'),
+            array('ignore', 'I', InputOption::VALUE_OPTIONAL, 'Which models to ignore', ''),
         );
     }
 
-    protected function generateDocs($model){
+    protected function generateDocs($model, $ignore = ''){
 
 
         $output = "<?php
@@ -120,7 +129,15 @@ class ModelsCommand extends Command {
             $models = explode(',', $model);
         }
 
+        $ignore = explode(',', $ignore);
+
         foreach($models as $name){
+            if(in_array($name, $ignore)){
+                $this->comment("Ignoring model '$name'");
+                continue;
+            }else{
+                $this->comment("Loading model '$name'");
+            }
             $this->properties = array();
             $this->methods = array();
             if(class_exists($name)){
@@ -225,9 +242,13 @@ class ModelsCommand extends Command {
                    }
                }elseif(\Str::startsWith($method, 'scope') && $method !== 'scopeQuery'){
                    //Magic set<name>Attribute
-                   $name =  \Str::snake(substr($method, 5));
+                   $name =  \Str::camel(substr($method, 5));
                    if(!empty($name)){
-                       $this->setMethod($name, 'static');
+                       $reflection = new \ReflectionMethod($model, $method);
+                       $args = $this->getParameters($reflection);
+                       //Remove the first ($query) argument
+                       array_shift($args);
+                       $this->setMethod($name, $reflection->class, $args);
                    }
                }elseif(!method_exists('Eloquent', $method) && !\Str::startsWith($method, 'get')){
 
@@ -293,13 +314,11 @@ class ModelsCommand extends Command {
         }
     }
 
-    protected function setMethod($name, $type = null){
+    protected function setMethod($name, $type = '', $arguments=array()){
         if(!isset($this->methods[$name])){
             $this->methods[$name] = array();
-            $this->methods[$name]['type'] = 'static';
-        }
-        if($type !== null){
             $this->methods[$name]['type'] = $type;
+            $this->methods[$name]['arguments'] = $arguments;
         }
     }
 
@@ -355,8 +374,8 @@ class ModelsCommand extends Command {
             if(in_array($name, $methods)){
                 continue;
             }
-            $name = "$name()";
-            $tag = Tag::createInstance("@method {$method['type']} {$name}", $phpdoc);
+            $arguments = implode(', ',$method['arguments']);
+            $tag = Tag::createInstance("@method static {$method['type']} {$name}({$arguments}) ", $phpdoc);
             $phpdoc->appendTag($tag);
         }
 
@@ -387,4 +406,37 @@ class ModelsCommand extends Command {
         return $output;
     }
 
+    /**
+     * Get the parameters and format them correctly
+     *
+     * @param $method
+     * @return array
+     */
+    public function getParameters($method){
+        //Loop through the default values for paremeters, and make the correct output string
+        $params = array();
+        $paramsWithDefault = array();
+        foreach ($method->getParameters() as $param) {
+            $paramStr = '$'.$param->getName();
+            $params[] = $paramStr;
+            if ($param->isOptional()) {
+                $default = $param->getDefaultValue();
+                if(is_bool($default)){
+                    $default = $default? 'true':'false';
+                }elseif(is_array($default)){
+                    $default = 'array()';
+                }elseif(is_null($default)){
+                    $default = 'null';
+                }elseif(is_int($default)){
+                    //$default = $default;
+                }else{
+                    $default = "'".trim($default)."'";
+                }
+                $paramStr .= " = $default";
+            }
+            $paramsWithDefault[] = $paramStr;
+        }
+        return $paramsWithDefault;
+    }
+
 }

src/config/config.php

@@ -40,7 +40,22 @@ return array(
     */
 
     'extra' => array(
-        'Eloquent'  => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
+        'Artisan' => array('Illuminate\Foundation\Artisan'),
+        'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
+        'Session' => array('Illuminate\Session\Store'),
     ),
 
+    'magic' => array(
+        'Log' => array(
+            'debug'     => 'Monolog\Logger::addDebug',
+            'info'      => 'Monolog\Logger::addInfo',
+            'notice'    => 'Monolog\Logger::addNotice',
+            'warning'   => 'Monolog\Logger::addWarning',
+            'error'     => 'Monolog\Logger::addError',
+            'critical'  => 'Monolog\Logger::addCritical',
+            'alert'     => 'Monolog\Logger::addAlert',
+            'emergency' => 'Monolog\Logger::addEmergency',
+        )
+    )
+
 );