Composer integration, PSR coding standards

.gitignore

@@ -0,0 +1 @@
+.idea

README.md

@@ -5,11 +5,14 @@ Command-line script to convert PHP's `array()` syntax to PHP 5.4's short array s
 
 By relying on the PHP tokenizer, nothing but the array syntax itself will be altered. The script was successfully tested against code bases with more than 5.000 PHP files.
 
+Installation via Composer
+===========
+Just add `"thomasbachem/php-short-array-syntax-converter": "dev-master"` to your require(-dev) section and run update command on Composer.
 
 Usage
 ================================
 
-    Usage: php convert.php [-w] <file>
+    Usage: php array-converter.php [-w] <file>
 
 Run the script with the path of the PHP file you wish to convert as argument. This will print the converted source code to STDOUT. 
 
@@ -19,7 +22,7 @@ In case of any error, an error message is written to STDERR and the script exits
 
 Use `find` to convert a whole directory recursively:
 
-    find <directory> -name "*.php" -exec php "convert.php" -w "{}" \;
+    find <directory> -name "*.php" -exec php "array-converter.php" -w "{}" \;
 
 In case you don't trust the script yet, you can even perform a syntax check after conversion:
 

array-converter.php

@@ -0,0 +1,147 @@
+<?php
+
+/**
+ * PHP 5.4 Short Array Syntax Converter
+ *
+ * Command-line script to convert PHP's "array()" syntax to PHP 5.4's
+ * short array syntax "[]" using PHP's built-in tokenizer.
+ *
+ * This script is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License (LGPL) as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This script is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+ *
+ * @link      https://github.com/thomasbachem/php-short-array-syntax-converter
+ *
+ * @link      http://php.net/manual/en/language.types.array.php
+ *
+ * @license   http://www.gnu.org/licenses/lgpl.html
+ * @author    Thomas Bachem <[email protected]>
+ */
+
+
+// - - - - - HANDLE COMMAND LINE ARGUMENTS - - - - -
+
+$filePath = null;
+$saveFile = false;
+
+if ($argc > 3) {
+    file_put_contents('php://stderr', 'Usage: php convert.php [-w] <file>' . "\n");
+    exit(1);
+}
+for ($i = 1; $i < $argc; ++$i) {
+    if ($argv[$i] && $argv[$i][0] == '-') {
+        $saveFile = ($argv[$i] == '-w');
+    } else {
+        $filePath = $argv[$i];
+    }
+}
+
+if (!$filePath) {
+    file_put_contents('php://stderr', 'Usage: php array-converter.php [-w] <file>' . "\n");
+    exit(1);
+} elseif (!file_exists($filePath)) {
+    file_put_contents('php://stderr', 'File "' . $filePath . '" not found.' . "\n");
+    exit(1);
+}
+
+
+// - - - - - READ ORIGINAL CODE - - - - -
+
+$code   = file_get_contents($filePath);
+$tokens = token_get_all($code);
+
+
+// - - - - - PARSE CODE - - - - -
+
+$replacements = array();
+$offset       = 0;
+for ($i = 0; $i < count($tokens); ++$i) {
+    // Keep track of the current byte offset in the source code
+    $offset += strlen(is_array($tokens[$i]) ? $tokens[$i][1] : $tokens[$i]);
+
+    // T_ARRAY could either mean the "array(...)" syntax we're looking for
+    // or a type hinting statement ("function(array $foo) { ... }")
+    if (is_array($tokens[$i]) && $tokens[$i][0] === T_ARRAY) {
+        // Look for a subsequent opening bracket ("(") to be sure we're actually
+        // looking at an "array(...)" statement
+        $isArraySyntax = false;
+        $subOffset     = $offset;
+        for ($j = $i + 1; $j < count($tokens); ++$j) {
+            $subOffset += strlen(is_array($tokens[$j]) ? $tokens[$j][1] : $tokens[$j]);
+
+            if (is_string($tokens[$j]) && $tokens[$j] == '(') {
+                $isArraySyntax = true;
+                break;
+            } elseif (!is_array($tokens[$j]) || $tokens[$j][0] !== T_WHITESPACE) {
+                $isArraySyntax = false;
+                break;
+            }
+        }
+
+        if ($isArraySyntax) {
+            // Replace "array" and the opening bracket (including preceeding whitespace) with "["
+            $replacements[] = array(
+                'start' => $offset - strlen($tokens[$i][1]),
+                'end' => $subOffset,
+                'string' => '[',
+            );
+
+            // Look for matching closing bracket (")")
+            $subOffset         = $offset;
+            $openBracketsCount = 0;
+            for ($j = $i + 1; $j < count($tokens); ++$j) {
+                $subOffset += strlen(is_array($tokens[$j]) ? $tokens[$j][1] : $tokens[$j]);
+
+                if (is_string($tokens[$j]) && $tokens[$j] == '(') {
+                    ++$openBracketsCount;
+                } elseif (is_string($tokens[$j]) && $tokens[$j] == ')') {
+                    --$openBracketsCount;
+
+                    if ($openBracketsCount == 0) {
+                        // Replace ")" with "]"
+                        $replacements[] = array(
+                            'start' => $subOffset - 1,
+                            'end' => $subOffset,
+                            'string' => ']',
+                        );
+                        break;
+                    }
+                }
+            }
+        }
+    }
+}
+
+
+// - - - - - UPDATE CODE - - - - -
+
+// Apply the replacements to the source code
+$offsetChange = 0;
+foreach ($replacements as $replacement) {
+    $code = substr_replace(
+        $code,
+        $replacement['string'],
+        $replacement['start'] + $offsetChange,
+        $replacement['end'] - $replacement['start']
+    );
+    $offsetChange += strlen($replacement['string']) - ($replacement['end'] - $replacement['start']);
+}
+
+
+// - - - - - OUTPUT/WRITE NEW CODE - - - - -
+
+if ($saveFile) {
+    file_put_contents($filePath, $code);
+} else {
+    print $code;
+}

bin/array-converter

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

composer.json

@@ -0,0 +1,31 @@
+{
+    "name": "thomasbachem/php-short-array-syntax-converter",
+    "description": "Command-line script to convert PHP's array() syntax to PHP 5.4's short array syntax [] using PHP's built-in tokenizer.",
+    "type": "library",
+    "homepage": "https://github.com/a-vasyliev/php-short-array-syntax-converter",
+    "keywords": [
+        "short",
+        "array",
+        "converter",
+        "php"
+    ],
+    "authors": [
+        {
+            "name": "Thomas Bachem",
+            "email": "[email protected]",
+            "homepage": "http://thomasbachem.com"
+        },
+        {
+            "name": "Andrii Vasyliev",
+            "email": "[email protected]",
+            "homepage": "http://andrey-vasiliev.com"
+        }
+    ],
+    "minimum-stability": "dev",
+    "require": {
+        "php": ">=5.4"
+    },
+    "bin": [
+        "bin/array-converter"
+    ]
+}