fixed readme and renamed vimdoc file

Author: mkusher

README.md

@@ -1,102 +1,88 @@
-phpcomplete-composer(WIP)
+Padawan.vim for php
 ====================
 
-This plugin is a fork of [phpcomplete-extended by M2mdas](https://github.com/m2mdas/phpcomplete-extended) with completely rebuilt index generation part. New index generator based on [nikic/PHP-Parser](https://github.com/nikic/PHP-Parser).
+Smart php intelligent code completion plugin. It tries to be 
+a [Jedi](https://github.com/davidhalter/jedi-vim), but currently 
+it's only a padawan.
+
+This plugin is a fork of 
+[phpcomplete-extended by M2mdas](https://github.com/m2mdas/phpcomplete-extended) 
+with completely rewritten index generation part. 
+New index generator based on [nikic/PHP-Parser](https://github.com/nikic/PHP-Parser).
+
+Currently it's under development and does not support some of the original 
+plugin features.
 
 Plugin
 ======
 
-phpcomplete-extended is a fast, extensible, context aware autocomplete plugin
-for PHP composer projects. Initially it reads autoload classmap of a composer
-project, parses doc-comments of each class and creates index from them. After
-that it auto updates index as you type thanks to
+Padawan.vim  reads autoload classmap of a composer
+project, parses doc-comments and functions declarations of each class and creates index 
+from them. After that it auto updates index as you type thanks to
 [vimproc.vim](https://github.com/Shougo/vimproc.vim) plugin. Besides
-autocomplete this plugin have several code inspection features,
+autocomplete this plugin have several code inspection features:
 
-* Includes full core PHP documentation
 * See documentation of current word, be it class name, method or property. It is
   context aware.
 * Go to definition of a symbol. Also context aware.
 * Automatically add use statement of current completed word. Also added plugin
   command of this action.
-* If [unite.vim](https://github.com/Shougo/unite.vim/) plugin installed following sources are available,
-    * `phpcomplete/files`           : Lists PHP files of the project.
-    * `phpcomplete/vendors`         : Lists vendor directories
-    * `phpcomplete/extends`         : Lists classes that extends the class guessed from
-      the current cursor word.
-    * `phpcomplete/implements`      : Lists classes that implements the class guessed
-      from the current cursor word.
-
-Demo videos (click on the image to goto youtube)
------------------------------------------------
+
+Demo videos (click on the image to goto youtube) by M2mdas
+----------------------------------------------------------
 ## Autocomplete demo video:
 
 [![ScreenShot](http://img.youtube.com/vi/yZYFKslqkC8/maxresdefault.jpg)](http://www.youtube.com/watch?v=yZYFKslqkC8)
 
-## Unite sources demo video:
-
-[![ScreenShot](http://i1.ytimg.com/vi/Wd5G7QA3OFw/maxresdefault.jpg)](http://www.youtube.com/watch?v=Wd5G7QA3OFw)
 
 Installation
 -------------
 
-The plugin depends on following plugins,
+The plugin depends on following plugins:
 
+*  php 5.4+
 *  [vimproc.vim](https://github.com/Shougo/vimproc.vim) : Asynchronous library for vim. Required for auto-update index. C
   compiler is needed to build the plugiin. For windows install cygwin or
   msys to get the compiler.
-*  [unite.vim](https://github.com/Shougo/unite.vim/): Optional, but enables some good features.
 
 Plugin managers are recommended for installing these plugins. Installation instructions for
 various plugin managers are given bellow.
 
 ## Pathogen
-
+ 
+You should manually install vimproc.vim!
 Issue following commands.
 
 ```sh
-git clone https://github.com/Shougo/vimproc.vim.git ~/.vim/bundle/vimproc.vim
-cd ~/.vim/bundle/vimproc.vim
-make
-cd ..
-git clone https://github.com/Shougo/unite.vim.git ~/.vim/bundle/unit.vim
-git clone https://github.com/m2mdas/phpcomplete-extended.git ~/.vim/bundle/phpcomplete-extended
+git clone https://github.com/mkusher/padawan.vim ~/.vim/bundle/padawan.vim
 ```
 
 ## NeoBundle (preferred)
+
+You should manually install vimproc.vim!
 Put these lines in `.vimrc` and issue `source %` command
 
 ```vim
-NeoBundle 'Shougo/vimproc', {
-      \ 'build' : {
-      \     'windows' : 'make -f make_mingw32.mak',
-      \     'cygwin' : 'make -f make_cygwin.mak',
-      \     'mac' : 'make -f make_mac.mak',
-      \     'unix' : 'make -f make_unix.mak',
-      \    },
-     \ }
-NeoBundle 'Shougo/unite.vim'
-NeoBundle 'm2mdas/phpcomplete-extended'
+NeoBundle 'mkusher/padawan.vim', { 'build': {'unix': 'php /path/to/composer.phar install'} }
 "your other plugins
 NeoBundleCheck
 ```
 
-If C compiler found for respective environment, `neobundle` will automatically
-compile the library.
+You should have composer.phar installed.
 
 ## Vundle
 
+You should manually install vimproc.vim!
 Put following lines in `.vimrc` and issue `:BundleInstall` command.
 ```vim
-Bundle 'Shougo/vimproc'
-Bundle 'Shougo/unite.vim'
-Bundle 'm2mdas/phpcomplete-extended'
+Bundle 'mkusher/padawan.vim'
 "your other plugins
 "....
 ```
 
-After installation goto `vimproc` folder and issue `make` command from command
-line. C compiler must be installed.
+After installation goto `padawan.vim` folder and run 
+`php /path/to/composer.phar install` command from command
+line. You should have composer installed.
 
 Walk through of the plugin
 -------------------------
@@ -115,7 +101,8 @@ composer.phar dumpautoload --optimize` command. By default composer command is
 set to `php composer.phar`. The command can be changed by setting
 `g:phpcomplete_index_composer_command` global variable.
 
-The plugin is dependent on `@var`, `@param`, `@return` doc-comments to give proper context aware
+The plugin is dependent on `@var`, `@param`, `@return` doc-comments and class 
+declarations to give proper context aware
 autocomplete. So documenting your class will help tremendously. It does not
 analyse full class. Just parses the variable declaration to get the relevant
 tokens. Does not provide autocomplete suggestion if there is error in code.
@@ -147,20 +134,31 @@ Minimal configuration for supertab support,
 ## [YouCompleteMe](https://github.com/Valloric/YouCompleteMe)
 
 If `omnifunc` set the omni completer of `YouCompleteMe` should get the completion
-candidates. I haven't tested it though.
+candidates. You should check semantic trigers for php.
+
+Why not original plugin
+-----------------------
 
-Extensions
----------
+The M2mdas's plugin is pretty good, but have some core bugs due to
+self-written parser:
 
-Phpcomplete Extended pluign exposes api hooks so that it can be possible to
-provide framework specific autocomplete suggestion. For example facades in
-laravel, DIC services in Symfony2 etc. The plugin api divided in two part, `PHP`
-and `vim`. PHP part is responsible for creating index related to the framework,
-and vim part is responsible for providing autocomplete menu entries based on the
-index. For reference see
-[phpcomplete-extended-symfony](https://github.com/m2mdas/phpcomplete-extended-symfony)
-and
-[phpcomplete-extended-laravlel](https://github.com/m2mdas/phpcomplete-extended-laravel) plugins.
+* It does not support files with 2 or more classes in it
+* It fails on parsing RabbitMQ classes
+
+So, I decided to rewrite index generation part.
+
+Roadmap
+-------
+
+As of now this plugin sucks, but I'm working hard on it and these features are
+now in progress:
+
+* Fix bugs with symbol type detection
+* Fix plugin user interface
+* Add doc-comment parsing
+* Add class inheritance indexing
+* Add plugins support
+* Add symfony2 plugin
 
 License
 -------
@@ -175,4 +173,3 @@ This plugin would not be possible without the works of
 [shawncplus](https://github.com/shawncplus/),
 [tpope](https://github.com/tpope/), [vim-jp](https://github.com/vim-jp),
 [thinca](https://github.com/thinca) and many others.
-

autoload/phpcomplete_extended.vim

@@ -334,7 +334,7 @@ function! s:getFQCNFromTokens(parsedTokens, currentFQCN, isThis) "{{{
 
     let isPrevTokenArray = 0
 
-    if currentFQCN =~  '\[\]$' && len(parsedTokens)
+    if currentFQCN =~  '\[\]$' && len(parsedTokens) 
                 \ && has_key(parsedTokens[0], 'isArrayElement')
         let currentFQCN = matchstr(currentFQCN, '\zs.*\ze\[\]$')
         let isPrevTokenArray = 1
@@ -345,16 +345,16 @@ function! s:getFQCNFromTokens(parsedTokens, currentFQCN, isThis) "{{{
         let insideBraceText = token['insideBraceText']
         let isArrayElement = has_key(token, 'isArrayElement')? 1 :0
         let currentClassData = phpcomplete_extended#getClassData(currentFQCN)
-
+        
         let  pluginFQCN = s:get_plugin_fqcn(currentFQCN,token)
 
         if insideBraceText[0] == "("
             let currentFQCN = ""
         elseif pluginFQCN != ""
             let currentFQCN = pluginFQCN
-        elseif isArrayElement
+        elseif isArrayElement 
             let isPrevTokenArray = 0
-            if phpcomplete_extended#isClassOfType(currentFQCN, 'ArrayAccess')
+            if phpcomplete_extended#isClassOfType(currentFQCN, 'ArrayAccess') 
                     \ && has_key(currentClassData['methods']['all'], 'offsetGet')
                 let offsetType = currentClassData['methods']['all']['offsetGet']['return']
                 if empty(offsetType)
@@ -854,7 +854,7 @@ function! phpcomplete_extended#parsereverse(cursorLine, cursorLineNumber) "{{{
     let parsedTokens = phpcomplete_extended#parser#reverseParse(cursorLine, [])
 
 
-    if empty(parsedTokens)
+    if empty(parsedTokens) 
             \ || (len(parsedTokens) && has_key(parsedTokens[0], 'start') && parsedTokens[0].start == 0)
         let linesTillFunc = s:getLinesTilFunc(a:cursorLineNumber)
         let joinedLines = join(reverse(linesTillFunc),"")
@@ -1199,7 +1199,7 @@ function! s:setClassData(fqcn, file,  classData) "{{{
 endfunction "}}}
 
 function! s:makeCacheDir() "{{{
-    let cache_dir = phpcomplete_extended#util#substitute_path_separator(fnamemodify(getcwd(), ':p:h').'/.phpcomplete_extended')
+    let cache_dir = phpcomplete_extended#util#substitute_path_separator(fnamemodify(getcwd(), ':p:h').'/.padawan.vim')
     if !isdirectory(cache_dir)
         call mkdir(cache_dir)
     endif
@@ -1210,7 +1210,7 @@ function! phpcomplete_extended#saveIndexCache() " {{{
         return
     endif
 
-    let cache_dir = phpcomplete_extended#util#substitute_path_separator(fnamemodify(getcwd(), ':p:h').'/.phpcomplete_extended')
+    let cache_dir = phpcomplete_extended#util#substitute_path_separator(fnamemodify(getcwd(), ':p:h').'/.padawan.vim')
     let index_cache_file = phpcomplete_extended#util#substitute_path_separator(fnamemodify(cache_dir, ':p:h')."/index_cache")
     let content = []
     if exists('g:phpcomplete_index_cache')
@@ -1224,7 +1224,7 @@ function! s:getCacheFile() " {{{
     if !phpcomplete_extended#is_phpcomplete_extended_project()
         return
     endif
-    let index_cache_file = phpcomplete_extended#util#substitute_path_separator(fnamemodify(getcwd(), ':p:h')."/.phpcomplete_extended/index_cache")
+    let index_cache_file = phpcomplete_extended#util#substitute_path_separator(fnamemodify(getcwd(), ':p:h')."/.padawan.vim/index_cache")
     return index_cache_file
 endfunction
 " }}}
@@ -1277,20 +1277,9 @@ function! s:loadIndex() " {{{
         return
     endif
 
-    let index_file = phpcomplete_extended#util#substitute_path_separator(getcwd().'/.phpcomplete_extended/phpcomplete_index')
+    let index_file = phpcomplete_extended#util#substitute_path_separator(getcwd().'/.padawan.vim/phpcomplete_index')
     let plugin_index_file = s:getPluginIndexFileName()
 
-    if !filereadable(index_file)
-        let initial_message = "Composer project detected, Do you want to create index?"
-        let ret = phpcomplete_extended#util#input_yesno(initial_message)
-        if !ret
-            call add(s:disabled_projects, getcwd())
-            return
-        endif
-        echo "\n\n"
-        call phpcomplete_extended#generateIndex()
-    endif
-
     if !g:phpcomplete_index_loaded
         call phpcomplete_extended#util#print_message("Loading Index")
         if filereadable(plugin_index_file)
@@ -1393,7 +1382,7 @@ endfunction
 
 function! s:copyCoreIndex() "{{{
     let src  = phpcomplete_extended#util#substitute_path_separator(g:phpcomplete_extended_root_dir . "/bin/core_index")
-    let cache_dir = phpcomplete_extended#util#substitute_path_separator(fnamemodify(getcwd(), ':p:h').'/.phpcomplete_extended')
+    let cache_dir = phpcomplete_extended#util#substitute_path_separator(fnamemodify(getcwd(), ':p:h').'/.padawan.vim')
     let dest = phpcomplete_extended#util#substitute_path_separator(cache_dir. "/core_index")
     if empty(findfile(dest, cache_dir))
         call phpcomplete_extended#util#copy(src, dest)
@@ -1404,7 +1393,7 @@ function! phpcomplete_extended#loadCoreIndex() "{{{
     if exists('g:core_index_loaded') && g:core_index_loaded
         return
     endif
-    let cache_dir = phpcomplete_extended#util#substitute_path_separator(fnamemodify(getcwd(), ':p:h').'/.phpcomplete_extended')
+    let cache_dir = phpcomplete_extended#util#substitute_path_separator(fnamemodify(getcwd(), ':p:h').'/.padawan.vim')
     let location = phpcomplete_extended#util#substitute_path_separator(cache_dir. "/core_index")
 
     if !filereadable(location)
@@ -1502,12 +1491,12 @@ function! phpcomplete_extended#checkUpdates() "{{{
             let s:update_info = {}
             return
         endif
-        let update_file = phpcomplete_extended#util#substitute_path_separator(fnamemodify(getcwd(), ':p:h').'/.phpcomplete_extended/'.s:update_info['update_file_name'])
+        let update_file = phpcomplete_extended#util#substitute_path_separator(fnamemodify(getcwd(), ':p:h').'/.padawan.vim/'.s:update_info['update_file_name'])
 
         if filereadable(update_file)
             try
                 let updateData = s:readIndex(update_file)
-            catch
+            catch 
                 echoerr "Error occured while reading update index"
                 return
             endtry
@@ -1533,7 +1522,7 @@ function! phpcomplete_extended#checkUpdates() "{{{
 endfunction "}}}
 
 function! s:getPluginIndexFileName() "{{{
-    return phpcomplete_extended#util#substitute_path_separator(fnamemodify(getcwd(), ':p:h').'/.phpcomplete_extended/plugin_index')
+    return phpcomplete_extended#util#substitute_path_separator(fnamemodify(getcwd(), ':p:h').'/.padawan.vim/plugin_index')
 endfunction "}}}
 
 function! s:readIndex(filename) "{{{
@@ -1664,7 +1653,7 @@ endfunction
 "}}}
 
 function! s:register_plugins() "{{{
-    let list = split(globpath(&runtimepath, 'autoload/phpcomplete_extended/*.vim'), "\n")
+    let list = split(globpath(&runtimepath, 'autoload/padawan/*.vim'), "\n")
     let s:plugins = {}
     let s:plugin_php_files = []
     for script_file in list

bin/src/Command/AbstractCommand.php

@@ -2,10 +2,13 @@
 
 namespace Command;
 
+use DI\Container;
+
 abstract class AbstractCommand implements CommandInterface{
     protected $container;
     public function __construct(){
-        $this->container = new \DI\Container();
+        $this->container = new Container();
+        $a = new Container;
     }
     public function get($serviceName){
         return $this->container->get($serviceName);

bin/src/Command/GenerateCommand.php

@@ -10,21 +10,11 @@ public function run(array $arguments = []){
         $generator = $this->get("IndexGenerator");
 
         $index = $generator->generateIndex($this->get("Index"));
-        $index = $this->prepareIndex($index);
         $indexWriter = $this->get('IndexWriter');
 
         $indexWriter->writeIndex($index);
         //$indexWriter->writeReport($generator->getInvalidClasses());
     }
-    protected function prepareIndex($index){
-        $jsonIndex = json_encode($index->toArray());
-        $lastJsonError = json_last_error();
-        if($lastJsonError != JSON_ERROR_NONE) {
-            $this->printJsonError($lastJsonError);
-            exit;
-        }
-        return $jsonIndex;
-    }
     protected function printJsonError($errorCode)
     {
         switch (json_last_error()) {

bin/src/Entity/Index.php

@@ -22,8 +22,7 @@ public function setNamespaces(array $namespaces){
         $this->namespaces = $namespaces;
     }
     public function addNamespace($namespace){
-        if(!in_array($namespace, $this->namespaces))
-            $this->namespaces[] = $namespace;
+        $this->namespaces[$namespace] = $namespace;
     }
 
     public function getInterfaces(){