Merge pull request #2 from mmoreram/feature/formatter-config-file

Added some support for config files

Author: mmoreram

.formatter.yml

@@ -0,0 +1,7 @@
+use-sort:
+    group:
+        - _main
+        - Mmoreram
+    group-type: each
+    sort-type: alph
+    sort-direction: asc

README.md

@@ -57,6 +57,33 @@ You can copy the `.phar` file as a global script
 $ cp php-formatter.phar /usr/local/bin/php-formatter
 ```
 
+## Config
+
+You can place a file named `.formatter.yml` in the root of your project. In
+every command execution, this will be the priority of the definitions.
+
+If an option is set in the command, this will be used. Otherwise, if is defined
+in a found config file, this will be used. Otherwise, default value will be
+used.
+
+This is the config reference
+
+``` yml
+use-sort:
+    group:
+        - _main
+        - Mmoreram
+    group-type: each
+    sort-type: alph
+    sort-direction: asc
+```
+
+you can also define where to search the `.formatter.yml` file using the
+`--config|-c` option
+
+``` bash
+$ php-formatter use:sort src/ --config="src/"
+```
 
 ## Commands
 

bin/compile

@@ -16,7 +16,7 @@
 
 require __DIR__.'/../src/bootstrap.php';
 
-use PHPFormatter\Compiler\Compiler;
+use Mmoreram\PHPFormatter\Compiler\Compiler;
 
 error_reporting(-1);
 ini_set('display_errors', 1);

bin/php-formatter

@@ -16,7 +16,7 @@
 
 require __DIR__ . '/../src/bootstrap.php';
 
-use PHPFormatter\Console\Application;
+use Mmoreram\PHPFormatter\Console\Application;
 
 error_reporting(-1);
 ini_set('display_errors', 1);

build/php-formatter.phar

@@ -32,10 +32,10 @@
         "bin-dir": "bin"
     },
     "autoload": {
-        "psr-4": {"PHPFormatter\\": "src/PHPFormatter"}
+        "psr-4": {"Mmoreram\\PHPFormatter\\": "src/PHPFormatter"}
     },
     "autoload-dev": {
-        "psr-4": {"PHPFormatter\\Tests\\": "tests/PHPFormatter"}
+        "psr-4": {"Mmoreram\\PHPFormatter\\Tests\\": "tests/PHPFormatter"}
     },
     "extra": {
         "branch-alias": {

composer.json

@@ -13,22 +13,33 @@
  * @author Marc Morera <yuhu@mmoreram.com>
  */
 
-namespace PHPFormatter\Command;
+namespace Mmoreram\PHPFormatter\Command;
 
-use PHPFormatter\Finder\FileFinder;
-use PHPFormatter\UseSorter;
-use Symfony\Component\Console\Command\Command as BaseCommand;
+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\Loader\ConfigLoader;
+use Mmoreram\PHPFormatter\Sorter\UseSorter;
+
 /**
  * Class UseSortCommand
  */
-class UseSortCommand extends BaseCommand
+class UseSortCommand extends Command
 {
+    /**
+     * @var string
+     *
+     * Command name
+     */
+    const COMMAND_NAME = 'use-sort';
+
     /**
      * configure
      */
@@ -52,22 +63,26 @@ protected function configure()
                 'sort-type',
                 null,
                 InputOption::VALUE_OPTIONAL,
-                "Sort type",
-                UseSorter::SORT_TYPE_ALPHABETIC
+                "Sort type"
             )
             ->addOption(
                 'sort-direction',
                 null,
                 InputOption::VALUE_OPTIONAL,
-                "Sort direction",
-                UseSorter::SORT_DIRECTION_ASC
+                "Sort direction"
             )
             ->addOption(
                 'group-type',
                 null,
                 InputOption::VALUE_OPTIONAL,
-                "Type of grouping",
-                UseSorter::GROUP_TYPE_EACH
+                "Type of grouping"
+            )
+            ->addOption(
+                '--config',
+                '-c',
+                InputOption::VALUE_OPTIONAL,
+                "Config file directory",
+                getcwd()
             )
             ->addOption(
                 'dry-run',
@@ -78,44 +93,123 @@ protected function configure()
     }
 
     /**
+     * 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');
-        $groups = $input->getOption('group');
-        $sortType = $input->getOption('sort-type');
-        $sortDirection = $input->getOption('sort-direction');
-        $groupType = $input->getOption('group-type');
         $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);
+
+        $options = $configLoader->loadConfigValues(
+            self::COMMAND_NAME,
+            $configFinder->findConfigFile($configPath),
+            array(
+                'group' => $input->getOption('group'),
+                'group-type' => $input->getOption('group-type'),
+                'sort-type' => $input->getOption('sort-type'),
+                'sort-direction' => $input->getOption('sort-direction')
+            ),
+            array(
+                'group' => array('_main'),
+                'group-type' => UseSorter::GROUP_TYPE_EACH,
+                'sort-type' => UseSorter::SORT_TYPE_ALPHABETIC,
+                'sort-direction' => UseSorter::SORT_DIRECTION_ASC
+            )
+        );
+
+        /**
+         * Building the real directory or file to work in
+         */
+        $filesystem = new Filesystem();
+        if (!$filesystem->isAbsolutePath($path)) {
+            $path = getcwd() . DIRECTORY_SEPARATOR . $path;
+        }
 
-        if (null !== $path) {
+        if (!is_file($path) && !is_dir($path)) {
 
-            $filesystem = new Filesystem();
-            if (!$filesystem->isAbsolutePath($path)) {
-                $path = getcwd() . DIRECTORY_SEPARATOR . $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 UseSorter file, given config values
+         */
         $useSorter = new UseSorter();
         $useSorter
-            ->setGroups($groups)
-            ->setSortType($sortType)
-            ->setSortDirection($sortDirection)
-            ->setGroupType($groupType);
+            ->setGroups($options['group'])
+            ->setGroupType($options['group-type'])
+            ->setSortType($options['sort-type'])
+            ->setSortDirection($options['sort-direction']);
+
+        $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('# Executing process with this configuration');
+            if (!empty($options['group'])) {
 
-        $finder = new FileFinder();
-        $files = $finder->findPHPFilesByPath($path);
+                foreach ($options['group'] as $group) {
 
-        if ($dryRun) {
+                    $output->writeln('#   --group="' . $group . '"');
+                }
+            }
+
+            if (!empty($options['group-type'])) {
+
+                $output->writeln('#   --group-type="' . $options['group-type'] . '"');
+            }
 
-            $output->writeln('This process is Dry-run');
-            $output->writeln('');
+            if (!empty($options['sort-type'])) {
+
+                $output->writeln('#   --sort-type="' . $options['sort-type'] . '"');
+            }
+
+            if (!empty($options['sort-direction'])) {
+
+                $output->writeln('#   --sort-direction="' . $options['sort-direction'] . '"');
+            }
         }
 
+        $output->writeln('#');
+
+        /**
+         * Each found php file is processed
+         */
         foreach ($files as $file) {
 
             $data = file_get_contents($file);
@@ -126,7 +220,10 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 continue;
             }
 
-            $output->writeln($file);
+            if ($verbose >= OutputInterface::VERBOSITY_NORMAL) {
+
+                $output->writeln('# ' . $file);
+            }
 
             if (!$dryRun) {
 

src/PHPFormatter/Command/UseSortCommand.php

@@ -1,20 +1,19 @@
 <?php
 
 /**
- * This file is part of the Elcodi package.
+ * This file is part of the php-formatter package
  *
- * Copyright (c) 2014 Elcodi.com
+ * 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 <yuhu@mmoreram.com>
- * @author Aldo Chiecchia <zimage@tiscali.it>
  */
 
-namespace PHPFormatter\Compiler;
+namespace Mmoreram\PHPFormatter\Compiler;
 
 use DateTime;
 use Phar;

src/PHPFormatter/Compiler/Compiler.php

@@ -13,11 +13,12 @@
  * @author Marc Morera <yuhu@mmoreram.com>
  */
 
-namespace PHPFormatter\Console;
+namespace Mmoreram\PHPFormatter\Console;
 
-use PHPFormatter\Command;
 use Symfony\Component\Console\Application as BaseApplication;
 
+use Mmoreram\PHPFormatter\Command;
+
 /**
  * Class Application
  */

src/PHPFormatter/Console/Application.php

@@ -0,0 +1,47 @@
+<?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 <yuhu@mmoreram.com>
+ */
+
+namespace Mmoreram\PHPFormatter\Finder;
+
+use Symfony\Component\Yaml\Parser as YamlParser;
+
+use Mmoreram\PHPFormatter\PHPFormatter;
+
+/**
+ * Class ConfigFinder
+ */
+class ConfigFinder
+{
+    /**
+     * Load, if exists, specific project configuration
+     *
+     * @param string $path Path
+     *
+     * @return array loaded config
+     */
+    public function findConfigFile($path)
+    {
+        $configFilePath = rtrim($path, '/') . '/' . PHPFormatter::CONFIG_FILE_NAME;
+        $config = array();
+        if (is_file($configFilePath)) {
+
+            $yamlParser = new YamlParser;
+            $config = $yamlParser->parse(file_get_contents($configFilePath));
+        }
+
+        return $config;
+    }
+
+}