Merge branch 'release/0.4'

Author: weynhamz

.gitignore

@@ -1,5 +1,5 @@
-vendor
-composer.lock
-composer.phar
 tests/*.expect
 tests/*.result
+build/
+vendor/
+phpctags

ChangeLog.md

@@ -1,3 +1,12 @@
+Version 0.4
+-----------
+
+* add tagline support
+  thanks to Mark Wu
+* add a Makefile to build stand-alone PHAR executable
+  thanks to Mark Wu
+* update PHPParser dependency to version 0.9.3
+
 Version 0.3
 -----------
 

Makefile

@@ -0,0 +1,52 @@
+source := README.md \
+          ChangeLog.md \
+          composer.json \
+          composer.lock \
+          bootstrap.php \
+          PHPCtags.class.php
+
+.PHONY: all
+all: phpctags
+
+.PHONY: clean
+clean:
+	@echo "Cleaning executables ..."
+	@rm -f ./phpctags
+	@rm -f ./build/phpctags.phar
+	@echo "Done!"
+
+.PHONY: dist-clean
+dist-clean:
+	@echo "Cleaning old build files and vendor libraries ..."
+	@rm -rf ./build
+	@rm -rf ./vendor
+	@rm -f  ./phpctags
+	@echo "Done!"
+
+.PHONY: install
+install: phpctags
+	@echo "Sorry, you need to move phpctags to /usr/bin/phpctags or /usr/local/bin/phpctags or any place you want manually."
+
+build:
+	@if [ ! -x build ]; \
+	then \
+		mkdir build; \
+	fi
+
+build/composer.phar: | build
+	@echo "Installing composer ..."
+	@curl -s http://getcomposer.org/installer | php -- --install-dir=build
+
+vendor: composer.lock build/composer.phar
+	@echo "Installing vendor libraries ..."
+	@php build/composer.phar install
+	@touch vendor/
+
+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

@@ -1,6 +1,8 @@
 <?php
 class PHPCtags
 {
+    const VERSION = 0.4;
+
     private $mFile;
 
     private $mFiles;
@@ -343,18 +345,26 @@ private function process($file)
                     continue;
                 }
 
-                $this->setMFile((string) $filename);
+                try {
+                    $this->setMFile((string) $filename);
+                    $this->mStructs = array_merge(
+                        $this->mStructs,
+                        $this->struct($this->mParser->parse(file_get_contents($this->mFile)), TRUE)
+                    );
+                } 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)
                 );
+            } catch(Exception $e) {
+                echo "PHPParser: {$e->getMessage()} - {$filename}".PHP_EOL;
             }
-        } else {
-            $this->setMFile($file);
-            $this->mStructs = array_merge(
-                $this->mStructs,
-                $this->struct($this->mParser->parse(file_get_contents($this->mFile)), TRUE)
-            );
         }
     }
 }

README.md

@@ -18,12 +18,9 @@ Enjoy!
 Installation
 ------------
 
-We use [composer](http://getcomposer.org/) for dependency management, run the
-following commands under the project directory to get composer and install the
-dependency.
-
-    curl -s http://getcomposer.org/installer | php
-    php composer.phar install
+Installation is simple, 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` directly from anywhere.
 
 See [phpctags on packagist](http://packagist.org/packages/techlivezheng/phpctags)
 for more details.
@@ -40,3 +37,4 @@ Acknowledgements
 * [Snapi](https://github.com/sanpii) for composer support.
 * [DeMarko](https://github.com/DeMarko) for memory limit support.
 * [Sander Marechal](https://github.com/sandermarechal) for improve console support
+* [Mark Wu](https://github.com/markwu) for building a stand-alone PHAR executable

phpctags renamed to bootstrap.php

@@ -1,4 +1,3 @@
-#!/usr/bin/env php
 <?php
 if (file_exists($autoload = __DIR__ . '/vendor/autoload.php')) {
     require($autoload);
@@ -12,9 +11,9 @@
     );
 }
 
-$version = <<<'EOF'
-Version: 0.3
+$version = PHPCtags::VERSION;
 
+$copyright = <<<'EOF'
 Exuberant Ctags compatiable PHP enhancement, Copyright (C) 2012 Techlive Zheng
 Addresses: <techlivezheng@gmail.com>, https://github.com/techlivezheng/phpctags
 EOF;
@@ -96,15 +95,17 @@
 }
 
 if (isset($options['help'])) {
-    echo $version;
+    echo "Version: ".$version."\n\n".$copyright;
     echo PHP_EOL;
     echo PHP_EOL;
     echo $options_info;
+    echo PHP_EOL;
     exit;
 }
 
 if (isset($options['version'])) {
-    echo $version;
+    echo "Version: ".$version."\n\n".$copyright;
+    echo PHP_EOL;
     exit;
 }
 
@@ -158,7 +159,7 @@
     } else if ($options['sort'] == 'foldcase') {
         $options['sort'] = 'foldcase';
     } else {
-        die('phpctags: Invalid value for "sort" option');
+        die('phpctags: Invalid value for "sort" option'.PHP_EOL);
     }
 // option -n is equivalent to --sort=no
 } else if (isset($options['u'])) {
@@ -180,15 +181,15 @@
     if ($options['append'] === FALSE || yes_or_no($options['append']) == 'yes') {
         $options['a'] = FALSE;
     } else if (yes_or_no($options['append']) != 'no') {
-        die('phpctags: Invalid value for "append" option');
+        die('phpctags: Invalid value for "append" option'.PHP_EOL);
     }
 }
 
 if (isset($options['recurse'])) {
     if ($options['recurse'] === FALSE || yes_or_no($options['recurse']) == 'yes') {
         $options['R'] = FALSE;
     } else if (yes_or_no($options['recurse']) != 'no') {
-        die('phpctags: Invalid value for "recurse" option');
+        die('phpctags: Invalid value for "recurse" option'.PHP_EOL);
     }
 }
 
@@ -202,7 +203,7 @@
     $ctags->addFiles($argv);
     $result = $ctags->export();
 } catch (Exception $e) {
-    die("phpctags: {$e->getMessage()}");
+    die("phpctags: {$e->getMessage()}".PHP_EOL);
 }
 
 // write to a specified file
@@ -215,7 +216,18 @@
 } else {
     $tagfile = fopen('tags', isset($options['a']) ? 'a' : 'w');
 }
-fwrite($tagfile, $result);
+
+$mode = ($options['sort'] == 'yes' ? 1 : ($options['sort'] == 'foldcase' ? 2 : 0));
+$tagline = <<<EOF
+!_TAG_FILE_FORMAT\t2\t/extended format; --format=1 will not append ;" to lines/
+!_TAG_FILE_SORTED\t{$mode}\t/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_PROGRAM_AUTHOR\ttechlivezheng\t/techlivezheng@gmail.com/
+!_TAG_PROGRAM_NAME\tphpctags\t//
+!_TAG_PROGRAM_URL\thttps://github.com/techlivezheng/phpctags\t/official site/
+!_TAG_PROGRAM_VERSION\t${version}\t//\n
+EOF;
+
+fwrite($tagfile, $tagline.$result);
 fclose($tagfile);
 
 function yes_or_no($arg) {

buildPHAR.php

@@ -0,0 +1,38 @@
+<?php
+
+$phar = new Phar('build/phpctags.phar', 0, 'phpctags.phar');
+
+$phar->buildFromIterator(
+    new RecursiveIteratorIterator(
+        new RecursiveCallbackFilterIterator(
+            new RecursiveDirectoryIterator(
+                getcwd(),
+                FilesystemIterator::SKIP_DOTS
+            ),
+            function ($current) {
+                $excludes = array(
+                    '.*',
+                    'tags',
+                    'build/*',
+                    'tests/*',
+                    'Makefile',
+                    'phpctags.sh',
+                    'buildPHAR.php',
+                );
+
+                foreach($excludes as $exclude) {
+                    if (fnmatch(getcwd().'/'.$exclude, $current->getPathName())) {
+                            return false;
+                    }
+                }
+
+                return true;
+            }
+        )
+    ),
+    getcwd()
+);
+
+$phar->setStub(
+    "#!/usr/bin/env php\n".$phar->createDefaultStub('bootstrap.php')
+);