1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 

<?php
/**
 * @author stev leibelt <artodeto@bazzline.net>
 * @since 2015-10-10
 */

namespace Net\Bazzline\Component\Cli\Environment;

use Exception;
use InvalidArgumentException;
use Net\Bazzline\Component\Cli\Arguments\Arguments;
use Net\Bazzline\Component\Toolbox\Scalar\Text;

class CommandLineEnvironment
{
    /** @var Arguments */
    private $arguments;

    /** @var bool */
    private $beVerbose;

    /** @var Callable */
    private $executeExceptionHandler;

    /** @var Text */
    private $text;

    /**
     * @param array $argv
     */
    public function __construct($argv)
    {
        $this->arguments    = new Arguments($argv);
        $this->text         = new Text();
        $this->determineIfWeAreVerbose($this->arguments);
        $this->setDefaultExecuteExceptionHandler();
    }

    /**
     * @return bool
     */
    public function beVerbose()
    {
        return $this->beVerbose;
    }

    /**
     * $instruction is called with argument CommandLineEnvironment
     * \Exception thrown by $instruction are handled
     *
     * @param Callable $instruction
     * @param string $usage
     * @throws InvalidArgumentException
     */
    public function execute($instruction, $usage)
    {
        try {
            $this->throwInvalidArgumentExceptionIfNoCallableProvided($instruction);
            $instruction($this);
        } catch (Exception $exception) {
            $handler = $this->executeExceptionHandler;
            $handler($exception, $usage);
        }
    }

    /**
     * @return Arguments
     */
    public function getArguments()
    {
        return $this->arguments;
    }

    /**
     * @return Text
     */
    public function getText()
    {
        return $this->text;
    }

    /**
     * Handler is called with arguments:
     *  \Exception $exception
     *  string $usage
     *
     * @param callable $handler
     * @throws InvalidArgumentException
     */
    public function overwriteDefaultExecuteExceptionHandler($handler)
    {
        $this->throwInvalidArgumentExceptionIfNoCallableProvided($handler);
        $this->executeExceptionHandler = $handler;
    }

    /**
     * @param int|float|string|array $scalarOrArrayOfScalars
     * @throws InvalidArgumentException
     */
    public function output($scalarOrArrayOfScalars)
    {
        if (is_scalar($scalarOrArrayOfScalars)) {
            $scalarOrArrayOfScalars = [
                $scalarOrArrayOfScalars
            ];
        }

        if (!is_array($scalarOrArrayOfScalars)) {
            throw new InvalidArgumentException(
                'provided argument must be scalar or array'
            );
        }

        echo implode(PHP_EOL, $scalarOrArrayOfScalars) . PHP_EOL;
    }

    /**
     * @param int|float|string|array $scalarOrArrayOfScalars
     */
    public function outputIfVerbosityIsEnabled($scalarOrArrayOfScalars)
    {
        if ($this->beVerbose) {
            $this->output($scalarOrArrayOfScalars);
        }
    }

    /**
     * @param Arguments $arguments
     */
    private function determineIfWeAreVerbose(Arguments $arguments)
    {
        $this->beVerbose = ($arguments->hasFlag('verbose') || $arguments->hasFlag('v'));
    }

    private function setDefaultExecuteExceptionHandler()
    {
        $environment                    = $this;
        $this->executeExceptionHandler  = function (Exception $exception, $usage) use ($environment) {
            $environment->output(
                [
                    'An error occurred',
                    $exception->getMessage(),
                    '',
                    'Usage: ' . $usage
                ]
            );
            exit(1);
        };
    }

    /**
     * @param Callable $callable
     * @throws InvalidArgumentException
     */
    private function throwInvalidArgumentExceptionIfNoCallableProvided($callable)
    {
        if (!is_callable($callable)) {
            throw new InvalidArgumentException(
                'no callable provided'
            );
        }
    }
}