Merge pull request #3 from mmoreram/feature/php-header-command

New feature: PHP Header fixer

Author: mmoreram

.formatter.yml

@@ -4,4 +4,18 @@ use-sort:
         - Mmoreram
     group-type: each
     sort-type: alph
-    sort-direction: asc
+    sort-direction: asc
+
+header: |
+    /**
+     * This file is part of the php-formatter package
+     *
+     * Copyright (c) 2014 Marc Morera
+     *
+     * For the full copyright and license information, please view the LICENSE
+     * file that was distributed with this source code.
+     *
+     * Feel free to edit as you please, and have fun.
+     *
+     * @author Marc Morera <[email protected]>
+     */

README.md

@@ -5,6 +5,17 @@ PHP Formatter
 [![Latest Stable Version](https://poser.pugx.org/mmoreram/php-formatter/v/stable.png)](https://packagist.org/packages/mmoreram/php-formatter)
 [![Latest Unstable Version](https://poser.pugx.org/mmoreram/php-formatter/v/unstable.png)](https://packagist.org/packages/mmoreram/php-formatter)
 
+This PHP formatter aims to provide you some bulk actions for you PHP projects to
+ensure their consistency. Any of them fixes PSR rules. If you want to fix PSR
+rules, please check [fabpot/php-cs-fixer](https://github.com/fabpot/PHP-CS-Fixer).
+
+## Tags
+
+* Use last unstable version ( alias of `dev-master` ) to stay in last commit
+* Use last stable version tag to stay in a stable release.
+* [![Latest Unstable Version](https://poser.pugx.org/mmoreram/php-formatter/v/unstable.png)](https://packagist.org/packages/mmoreram/php-formatter)
+[![Latest Stable Version](https://poser.pugx.org/mmoreram/php-formatter/v/stable.png)](https://packagist.org/packages/mmoreram/php-formatter)
+
 ## Install
 
 Install PHP Formatter in this way:
@@ -76,13 +87,27 @@ use-sort:
     group-type: each
     sort-type: alph
     sort-direction: asc
+
+header: |
+    /**
+     * This file is part of the php-formatter package
+     *
+     * Copyright (c) 2014 Marc Morera
+     *
+     * For the full copyright and license information, please view the LICENSE
+     * file that was distributed with this source code.
+     *
+     * Feel free to edit as you please, and have fun.
+     *
+     * @author Marc Morera <[email protected]>
+     */
 ```
 
 you can also define where to search the `.formatter.yml` file using the
 `--config|-c` option
 
 ``` bash
-$ php-formatter use:sort src/ --config="src/"
+$ php-formatter formatter:use:sort src/ --config="src/"
 ```
 
 ## Commands
@@ -107,10 +132,11 @@ Options:
   --no-interaction -n Do not ask any interactive question.
 
 Available commands:
-  help       Displays help for a command
-  list       Lists commands
-use
-  use:sort   Sort Use statements
+  help                   Displays help for a command
+  list                   Lists commands
+formatter
+  formatter:header:fix   Ensures that all PHP files has header defined in config file
+  formatter:use:sort     Sort Use statements
 ```
 
 ### Sort all Use Statements
@@ -119,7 +145,7 @@ You can sort your Use Statements in a very different ways. For this command you
 must provide as an argument the path where to look for the PHP files you want to
 process.
 
-* command: `php-formatter use:sort`
+* command: `php-formatter formatter:use:sort`
 * argument: path
 * option: --group [***multiple***]
 * option: --group-type=***one***|***each***
@@ -133,7 +159,7 @@ You can use this tool just to test the files will be modified, using option
 --dry-run
 
 ``` bash
-$ php-formatter use:sort src/ --dry-run
+$ php-formatter formatter:use:sort src/ --dry-run
 ```
 
 #### Group
@@ -146,7 +172,7 @@ Common group is named `_main` and if is not specified, is placed in the
 begining. You can define where to place this group with `--group` option
 
 ``` bash
-$ php-formatter use:sort src/ --group="Mmoreram" --group="_main" --group="Symfony"
+$ php-formatter formatter:use:sort src/ --group="Mmoreram" --group="_main" --group="Symfony"
 ```
 
 This command will sort the code like this
@@ -169,7 +195,7 @@ Finally, the `--group-type` defines if you want one `use` literal in every
 namespace line
 
 ``` bash
-$ php-formatter use:sort src/ --group="Mmoreram" --group-type="each"
+$ php-formatter formatter:use:sort src/ --group="Mmoreram" --group-type="each"
 ```
 
 This command will sort the code like this
@@ -187,7 +213,7 @@ use Mmoreram\MySecondClass;
 or if you want only one use for all group.
 
 ``` bash
-$ php-formatter use:sort src/ --group="Mmoreram" --group-type="one"
+$ php-formatter formatter:use:sort src/ --group="Mmoreram" --group-type="one"
 ```
 
 This command will sort the code like this
@@ -208,7 +234,7 @@ There are two options of sorting. You can sort your namespaces alphabetically
 ***(default value)***
 
 ``` bash
-$ php-formatter use:sort src/ --sort-type="alph"
+$ php-formatter formatter:use:sort src/ --sort-type="alph"
 ```
 
 This command will sort the code like this
@@ -225,7 +251,7 @@ use Symfony\OneClass;
 or by length (two namespaces with same length will be sorted alphabetically)
 
 ``` bash
-$ php-formatter use:sort src/ --sort-type="length"
+$ php-formatter formatter:use:sort src/ --sort-type="length"
 ```
 
 This command will sort the code like this
@@ -243,7 +269,7 @@ You can also define the direction of the sorting. This can be ascending
 ***(default value)***
 
 ``` bash
-$ php-formatter use:sort src/ --sort-direction="asc"
+$ php-formatter formatter:use:sort src/ --sort-direction="asc"
 ```
 
 This command will sort the code like this
@@ -260,7 +286,7 @@ use Symfony\OneClass;
 or descending
 
 ``` bash
-$ php-formatter use:sort src/ --sort-direction="desc"
+$ php-formatter formatter:use:sort src/ --sort-direction="desc"
 ```
 
 This command will sort the code like this
@@ -273,3 +299,39 @@ use Mmoreram\MySecondClass;
 use Mmoreram\MyClass;
 use AnotherBundle\AnotherClass;
 ```
+
+### Fix all PHP headers
+
+You can define your PHP header in your `.formatter.yml` file an this command
+will check and fix that all PHP files have it properly.
+
+* command: `php-formatter formatter:header:fix`
+* argument: path
+* option: --dry-run [***no value***]
+
+#### Dry run
+
+You can use this tool just to test the files will be modified, using option
+--dry-run
+
+``` bash
+$ php-formatter formatter:header:fix src/ --dry-run
+```
+
+Your PHP Header definition must have this format.
+
+``` yml
+header: |
+    /**
+     * This file is part of the php-formatter package
+     *
+     * Copyright (c) 2014 Marc Morera
+     *
+     * For the full copyright and license information, please view the LICENSE
+     * file that was distributed with this source code.
+     *
+     * Feel free to edit as you please, and have fun.
+     *
+     * @author Marc Morera <[email protected]>
+     */
+```

bin/compile

@@ -0,0 +1,171 @@
+<?php
+
+/**
+ * This file is part of the php-formatter package
+ *
+ * Copyright (c) 2014 Marc Morera
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * Feel free to edit as you please, and have fun.
+ *
+ * @author Marc Morera <[email protected]>
+ */
+
+namespace Mmoreram\PHPFormatter\Command;
+
+use Exception;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Filesystem\Filesystem;
+
+use Mmoreram\PHPFormatter\Finder\ConfigFinder;
+use Mmoreram\PHPFormatter\Finder\FileFinder;
+use Mmoreram\PHPFormatter\Fixer\HeaderFixer;
+use Mmoreram\PHPFormatter\Loader\ConfigLoader;
+
+/**
+ * Class HeaderCommand
+ */
+class HeaderCommand extends Command
+{
+    /**
+     * @var string
+     *
+     * Command name
+     */
+    const COMMAND_NAME = 'header';
+
+    /**
+     * configure
+     */
+    protected function configure()
+    {
+        $this
+            ->setName('formatter:header:fix')
+            ->setDescription('Ensures that all PHP files has header defined in config file')
+            ->addArgument(
+                'path',
+                InputArgument::REQUIRED,
+                'Path'
+            )
+            ->addOption(
+                '--config',
+                '-c',
+                InputOption::VALUE_OPTIONAL,
+                "Config file directory",
+                getcwd()
+            )
+            ->addOption(
+                'dry-run',
+                null,
+                InputOption::VALUE_NONE,
+                "Just print the result, nothing is overwritten"
+            );
+    }
+
+    /**
+     * Execute command
+     *
+     * @param InputInterface  $input  Input
+     * @param OutputInterface $output Output
+     *
+     * @return int|null|void
+     *
+     * @throws Exception
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $verbose = $output->getVerbosity();
+        $path = $input->getArgument('path');
+        $dryRun = $input->getOption('dry-run');
+        $fileFinder = new FileFinder;
+        $configLoader = new ConfigLoader;
+        $configFinder = new ConfigFinder;
+
+        /**
+         * This section is just for finding the right values to work with in
+         * this execution.
+         *
+         * $options array will have, after this block, all these values
+         */
+        $configPath = rtrim($input->getOption('config'), DIRECTORY_SEPARATOR);
+
+        $header = $configLoader->loadConfigValue(
+            self::COMMAND_NAME,
+            $configFinder->findConfigFile($configPath)
+        );
+
+        /**
+         * Building the real directory or file to work in
+         */
+        $filesystem = new Filesystem();
+        if (!$filesystem->isAbsolutePath($path)) {
+            $path = getcwd() . DIRECTORY_SEPARATOR . $path;
+        }
+
+        if (!is_file($path) && !is_dir($path)) {
+
+            throw new Exception('Directory or file "' . $path . '" does not exist');
+        }
+
+        /**
+         * Dry-run message
+         */
+        if ($dryRun && $verbose >= OutputInterface::VERBOSITY_VERBOSE) {
+
+            $output->writeln('# This process has been executed in mode dry-run');
+        }
+
+        if ($verbose >= OutputInterface::VERBOSITY_VERBOSE) {
+
+            $output->writeln('# Executing process in ' . $path);
+        }
+
+        /**
+         * Creates the new HeaderFixer
+         */
+        $headerFixer = new HeaderFixer($header);
+
+        $files = $fileFinder->findPHPFilesByPath($path);
+
+        /**
+         * If verbose level is higher or equal than -vv, we print the config
+         * file data, if is not empty.
+         */
+        if ($verbose >= OutputInterface::VERBOSITY_VERBOSE) {
+
+            $output->writeln("# Header used:\n\n" . $header);
+        }
+
+        $output->writeln('#');
+
+        /**
+         * Each found php file is processed
+         */
+        foreach ($files as $file) {
+
+            $data = file_get_contents($file);
+            $result = $headerFixer->fix($data);
+
+            if ($result === false || $data === $result) {
+
+                continue;
+            }
+
+            if ($verbose >= OutputInterface::VERBOSITY_NORMAL) {
+
+                $output->writeln('# ' . $file);
+            }
+
+            if (!$dryRun) {
+
+                file_put_contents($file, $result);
+            }
+        }
+    }
+}

build/php-formatter.phar

@@ -47,7 +47,7 @@ class UseSortCommand extends Command
     protected function configure()
     {
         $this
-            ->setName('use:sort')
+            ->setName('formatter:use:sort')
             ->setDescription('Sort Use statements')
             ->addArgument(
                 'path',

src/PHPFormatter/Command/HeaderCommand.php

@@ -48,6 +48,7 @@ protected function getDefaultCommands()
     {
         $commands = parent::getDefaultCommands();
         $commands[] = new Command\UseSortCommand();
+        $commands[] = new Command\HeaderCommand();
 
         return $commands;
     }