Ingenerator\RunSingle\ArgumentParser

Complexity

Total Complexity

22

Size/Duplication

Total Lines	165
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	parse()	0	13	1
A	timeout()	0	8	3
A	task_name()	0	8	3
A	automatic_garbage_collect()	0	8	2
A	command()	0	9	2
A	find_sep_counter()	0	12	3
A	find_arg_parts()	0	19	4
A	key_value_strings()	0	9	2
A	escaped_command_parts()	0	9	2

<?php
/**
 * Argument parser
 *
 * @author    Matthias Gisder <matthias@ingenerator.com>
 * @copyright 2014 inGenerator Ltd
 * @licence   BSD
 */


namespace Ingenerator\RunSingle;


class ArgumentParser
{
    protected $sep_counter;

    protected $arg_defaults = array(
        'task_name'                 => '',
        'timeout'                   => '',
        'automatic_garbage_collect' => TRUE,
        'command'                   => '',
    );

    /**
     * @param array $argv
     *
     * @return array

Consider making the return type a bit more specific; maybe use array<string,integer|double|string|boolean>.

     * @throws \InvalidArgumentException
     */
    public function parse(array $argv)
    {
        $this->sep_counter   = $this->find_sep_counter($argv);
        $arg_parts           = \array_merge($this->arg_defaults, $this->find_arg_parts($argv));
        $this->command_parts = $this->escaped_command_parts($argv);

The property command_parts does not exist. Did you maybe forget to declare it?

        $args['timeout']                   = $this->timeout($arg_parts);

$args was never initialized. Although not strictly required by PHP, it is generally a good practice to add $args = array(); before regardless.

        $args['task_name']                 = $this->task_name($arg_parts);
        $args['automatic_garbage_collect'] = $this->automatic_garbage_collect($arg_parts);
        $args['command']                   = $this->command($argv);

        return ($args);
    }

    /**
     * @param array $args
     *
     * @return int

Should the return type not be integer|double|string?

     * @throws \InvalidArgumentException
     */
    protected function timeout($args)
    {
        if (! \is_numeric($args['timeout']) || $args['timeout'] <= 0) {
            throw new \InvalidArgumentException('invalid or missing timeout value (set with "--timeout=".');
        }

        return $args['timeout'];
    }

    /**
     * @param array $args
     *
     * @return string
     * @throws \InvalidArgumentException
     */
    protected function task_name($args)
    {
        if (! \is_string($args['task_name']) || $args['task_name'] == '') {
            throw new \InvalidArgumentException('invalid or missing task_name value (set with "--task_name=".');
        }

        return $args['task_name'];
    }

    /**
     * @param array $args
     *
     * @return bool
     */
    protected function automatic_garbage_collect($args)
    {
        if (isset($args['no-garbage-collect'])) {

This if statement, and the following return statement can be replaced with return !isset($args['no-garbage-collect']);.

            return FALSE;
        }

        return TRUE;
    }

    /**
     * @param $argv
     *
     * @return string
     * @throws \InvalidArgumentException
     */
    protected function command($argv)
    {
        $command = \implode(' ', $this->escaped_command_parts($argv));
        if ($command === '') {
            throw new \InvalidArgumentException('command has to be specified');
        }

        return $command;
    }

    /**
     * @param array $argv
     *
     * @return array

Should the return type not be integer?

     */
    protected function find_sep_counter($argv)
    {
        $sep_counter = 0;
        foreach ($argv as $arg) {
            if ($arg == '--') {
                break;
            }
            $sep_counter ++;
        }

        return $sep_counter;
    }

    /**
     * @param array $argv
     *
     * @return array
     */
    protected function find_arg_parts($argv)
    {
        $arg_parts         = array();
        $key_value_strings = $this->key_value_strings($argv);
        foreach ($key_value_strings as $key_value_string) {
            $new = \explode('=', $key_value_string);

            if (\preg_match('/\-\-/', $new[0])) {
                $new[0] = \str_replace('--', '', $new[0]);
                // for arguments requiring no value assignment
                if (! isset($new[1])) {
                    $new[1] = TRUE;
                }
                $arg_parts[$new[0]] = $new[1];
            }
        }

        return $arg_parts;
    }

    /**
     * @param array $argv
     *
     * @return array
     */
    protected function key_value_strings($argv)
    {
        $key_value_strings = array();
        if ($this->sep_counter > 0) {
            $key_value_strings = \array_slice($argv, 0, $this->sep_counter);
        }

        return $key_value_strings;
    }

    /**
     * @param array $argv
     *
     * @return array
     */
    protected function escaped_command_parts($argv)
    {
        $command_parts = array();
        if ($this->sep_counter > 0) {
            $command_parts = \array_slice($argv, $this->sep_counter + 1);
        }

        return \array_map('escapeshellarg', $command_parts);
    }

}