Merge branch 'release/0.6.0'

Author: Gianluca Arbezzano

.gitignore

@@ -1,5 +1,3 @@
-tests/*.expect
-tests/*.result
+.test_fs
 build/
 vendor/
-phpctags

.travis.yml

@@ -0,0 +1,22 @@
+language: php
+
+php:
+    - 5.3
+    - 5.4
+    - 5.5
+    - 5.6
+    - 7
+    - hhvm
+
+before_script:
+    - composer self-update
+    - composer install
+    - if [ "$TRAVIS_PHP_VERSION" = 'hhvm' ]; then export COMPOSER_PROCESS_TIMEOUT=900; fi
+
+script:
+    - vendor/bin/phpunit
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - php: 7

ChangeLog.md

@@ -1,3 +1,12 @@
+Version 0.6.0
+* Exclude phpctags when re-building phar
+* Fix typo in README.md
+* Fixed PHPUnit.xml.dist
+* Refactoring codebase
+* Refactroing testsuite
+* Now composer support an entry point to install in globally
+* Define new build flow
+
 Version 0.5.1
 -------------
 

Makefile

@@ -6,12 +6,11 @@ source := README.md \
           PHPCtags.class.php
 
 .PHONY: all
-all: phpctags
+all: build/phpctags.phar
 
 .PHONY: clean
 clean:
 	@echo "Cleaning executables ..."
-	@rm -f ./phpctags
 	@rm -f ./build/phpctags.phar
 	@echo "Done!"
 
@@ -20,7 +19,6 @@ dist-clean:
 	@echo "Cleaning old build files and vendor libraries ..."
 	@rm -rf ./build
 	@rm -rf ./vendor
-	@rm -f  ./phpctags
 	@echo "Done!"
 
 .PHONY: install
@@ -45,8 +43,3 @@ vendor: composer.lock build/composer.phar
 build/phpctags.phar: vendor $(source) | build
 	@php -dphar.readonly=0 buildPHAR.php
 	@chmod +x build/phpctags.phar
-
-phpctags: build/phpctags.phar
-	@echo "Building phpctags ..."
-	@cp build/phpctags.phar phpctags
-	@echo "Done!"

PHPCtags.class.php

@@ -20,16 +20,18 @@ class PHPCtags
     );
 
     private $mParser;
-
-    private $mStructs;
-
+    private $mLines;
     private $mOptions;
+    private $tagdata;
+    private $cachefile;
+    private $filecount;
 
     public function __construct($options)
     {
         $this->mParser = new PHPParser_Parser(new PHPParser_Lexer);
-        $this->mStructs = array();
+        $this->mLines = array();
         $this->mOptions = $options;
+        $this->filecount = 0;
     }
 
     public function setMFile($file)
@@ -59,6 +61,10 @@ public function addFile($file)
         $this->mFiles[realpath($file)] = 1;
     }
 
+    public function setCacheFile($file) {
+        $this->cachefile = $file;
+    }
+
     public function addFiles($files)
     {
         foreach ($files as $file) {
@@ -250,12 +256,16 @@ private function struct($node, $reset=FALSE, $parent=array())
         return $structs;
     }
 
-    private function render()
+    private function render($structure)
     {
         $str = '';
-        foreach ($this->mStructs as $struct) {
+        foreach ($structure as $struct) {
             $file = $struct['file'];
 
+            if (!in_array($struct['kind'], $this->mOptions['kinds'])) {
+                continue;
+            }
+
             if (!isset($files[$file]))
                 $files[$file] = file($file);
 
@@ -357,19 +367,42 @@ private function render()
             $str .= "\n";
         }
 
-        // remove the last line ending
-        $str = trim($str);
+        // remove the last line ending and carriage return
+        $str = trim(str_replace("\x0D", "", $str));
+
+        return $str;
+    }
+
+    private function full_render() {
+        // Files will have been rendered already, just join and export.
+
+        $str = '';
+        foreach($this->mLines as $file => $data) {
+          $str .= $data.PHP_EOL;
+        }
 
         // sort the result as instructed
         if (isset($this->mOptions['sort']) && ($this->mOptions['sort'] == 'yes' || $this->mOptions['sort'] == 'foldcase')) {
             $str = self::stringSortByLine($str, $this->mOptions['sort'] == 'foldcase');
         }
 
+        // Save all tag information to a file for faster updates if a cache file was specified.
+        if (isset($this->cachefile)) {
+            file_put_contents($this->cachefile, serialize($this->tagdata));
+            if ($this->mOptions['v']) {
+                echo "Saved cache file.".PHP_EOL;
+            }
+        }
+
+        $str = trim($str);
+
         return $str;
     }
 
     public function export()
     {
+        $start = microtime(true);
+
         if (empty($this->mFiles)) {
             throw new PHPCtagsException('No File specified.');
         }
@@ -378,14 +411,30 @@ public function export()
             $this->process($file);
         }
 
-        return $this->render();
+        $content = $this->full_render();
+
+        $end = microtime(true);
+
+        if ($this->mOptions['V']) {
+            echo "It tooks ".($end-$start)." seconds.".PHP_EOL;
+        }
+
+        return $content;
     }
 
     private function process($file)
     {
+        // Load the tag md5 data to skip unchanged files.
+        if (!isset($this->tagdata) && isset($this->cachefile) && file_exists(realpath($this->cachefile))) {
+            if ($this->mOptions['v']) {
+                echo "Loaded cache file.".PHP_EOL;
+            }
+            $this->tagdata = unserialize(file_get_contents(realpath($this->cachefile)));
+        }
+
         if (is_dir($file) && isset($this->mOptions['R'])) {
             $iterator = new RecursiveIteratorIterator(
-                new RecursiveDirectoryIterator(
+                new ReadableRecursiveDirectoryIterator(
                     $file,
                     FilesystemIterator::SKIP_DOTS |
                     FilesystemIterator::FOLLOW_SYMLINKS
@@ -404,31 +453,64 @@ private function process($file)
                 }
 
                 try {
-                    $this->setMFile((string) $filename);
-                    $this->mStructs = array_merge(
-                        $this->mStructs,
-                        $this->struct($this->mParser->parse(file_get_contents($this->mFile)), TRUE)
-                    );
+                    $this->process_single_file($filename);
                 } catch(Exception $e) {
                     echo "PHPParser: {$e->getMessage()} - {$filename}".PHP_EOL;
                 }
             }
         } else {
             try {
-                $this->setMFile($file);
-                $this->mStructs = array_merge(
-                    $this->mStructs,
-                    $this->struct($this->mParser->parse(file_get_contents($this->mFile)), TRUE)
-                );
+                $this->process_single_file($file);
             } catch(Exception $e) {
-                echo "PHPParser: {$e->getMessage()} - {$filename}".PHP_EOL;
+                echo "PHPParser: {$e->getMessage()} - {$file}".PHP_EOL;
+            }
+        }
+    }
+
+    private function process_single_file($filename)
+    {
+        if ($this->mOptions['v'] && $this->filecount > 1 && $this->filecount % 64 == 0) {
+            echo " ".$this->filecount." files".PHP_EOL;
+        }
+        $this->filecount++;
+
+        $this->setMFile((string) $filename);
+        $file = file_get_contents($this->mFile);
+        $md5 = md5($file);
+        if (isset($this->tagdata[$this->mFile][$md5])) {
+            // The file is the same as the previous time we analyzed and saved.
+            $this->mLines[$this->mFile] = $this->tagdata[$this->mFile][$md5];
+            if ($this->mOptions['V']) {
+                echo ".";
             }
+            return;
+        }
+
+        $struct = $this->struct($this->mParser->parse($file), TRUE);
+        $this->mLines[$this->mFile] = $this->render($struct);
+        $this->tagdata[$this->mFile][$md5] = $this->mLines[$this->mFile];
+        if ($this->mOptions['debug']) {
+            echo "Parse: ".($finishfile - $startfile).", Merge: ".($finishmerge-$finishfile)."; (".$this->filecount.")".$this->mFile.PHP_EOL;
+        } else if ($this->mOptions['v']) {
+            echo "U";
         }
     }
+
 }
 
 class PHPCtagsException extends Exception {
     public function __toString() {
-        return "PHPCtags: {$this->message}\n";
+        return "\nPHPCtags: {$this->message}\n";
+    }
+}
+
+class ReadableRecursiveDirectoryIterator extends RecursiveDirectoryIterator {
+    function getChildren() {
+        try {
+            return new ReadableRecursiveDirectoryIterator($this->getPathname());
+        } catch(UnexpectedValueException $e) {
+            file_put_contents('php://stderr', "\nPHPPCtags: {$e->getMessage()} - {$this->getPathname()}\n");
+            return new RecursiveArrayIterator(array());
+        }
     }
 }

README.md

@@ -1,5 +1,7 @@
 phpctags
 ========
+Master  [![Build Status](https://travis-ci.org/vim-php/phpctags.svg)](https://travis-ci.org/vim-php/phpctags?branch=master)  
+Develop [![Build Status](https://travis-ci.org/vim-php/phpctags.svg)](https://travis-ci.org/vim-php/phpctags?branch=develop)  
 
 An enhanced php [ctags](http://ctags.sourceforge.net/) index file generator
 compatible with http://ctags.sourceforge.net/FORMAT.
@@ -18,6 +20,14 @@ Enjoy!
 Installation
 ------------
 
+## Download
+
+```
+curl -Ss http://vim-php.com/phpctags/install/phpctags.phar > phpctags
+php ./phpctags
+```
+
+## Build
 > We currently only support building PHAR executable for \*nix like platform
 which provides `make` utility. If you are interested in building an executable
 for other platform, especially for Windows, please help yourself out. It
@@ -27,7 +37,7 @@ provide a patch for this.
 
 Installation is simple, make sure you have PHP's PHAR extension enabled, then
 just run `make` in the root directory of the source, you will get a `phpctags`
-PHAR executable, add it to your `$PATH`, then you can invoke `phpcatgs`
+PHAR executable, add it to your `$PATH`, then you can invoke `phpctags`
 directly from anywhere.
 
 See [phpctags on packagist](http://packagist.org/packages/techlivezheng/phpctags)

bin/phpctags

@@ -0,0 +1,4 @@
+#!/usr/bin/env php
+
+<?php
+include(__DIR__."/../bootstrap.php");