CommandFactory::createLineCreator() - Code Metrics - zwilias/beanie - Measure and Improve Code Quality continuously with Scrutinizer

CommandFactory::createLineCreator() A
last analyzed 2016-05-31 11:03 UTC

↳ Parent: CommandFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	6
ccs	4
cts	4
cp	1
rs	9.4285
cc	1
eloc	3
nc	1
nop	3
crap	1

<?php


namespace Beanie\Command;


use Beanie\Beanie;
use Beanie\Command\CommandLineCreator\CommandLineCreatorInterface;
use Beanie\Command\CommandLineCreator\GenericCommandLineCreator;
use Beanie\Command\CommandLineCreator\PutCommandLineCreator;
use Beanie\Command\CommandLineCreator\TubeNameCheckingCommandLineCreator;
use Beanie\Command\ResponseParser\GenericResponseParser;
use Beanie\Command\ResponseParser\JobResponseParser;
use Beanie\Command\ResponseParser\ResponseParserInterface;
use Beanie\Command\ResponseParser\SimpleValueResponseParser;
use Beanie\Command\ResponseParser\YAMLResponseParser;
use Beanie\Exception\DeadlineSoonException;
use Beanie\Exception\DrainingException;
use Beanie\Exception\ExpectedCRLFException;
use Beanie\Exception\InvalidArgumentException;
use Beanie\Exception\JobTooBigException;
use Beanie\Exception\NotFoundException;
use Beanie\Exception\NotIgnoredException;
use Beanie\Exception\TimedOutException;
use Beanie\Util\FactoryInterface;
use Beanie\Util\FactoryTrait;

class CommandFactory implements FactoryInterface
{
    use FactoryTrait;

    protected static $defaultCommandStructure = [
        'responseParser' => GenericResponseParser::class,
        'acceptableResponses' => [],
        'expectedErrorResponses' => [],
        'commandLineCreator' => GenericCommandLineCreator::class,
        'argumentDefaults' => []
    ];

    protected static $commandStructureMap = [
        CommandInterface::COMMAND_BURY => [
            'acceptableResponses' => [Response::RESPONSE_BURIED],
            'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
            'argumentDefaults' => [
                'jobId' => null,
                'priority' => Beanie::DEFAULT_PRIORITY
            ]
        ],
        CommandInterface::COMMAND_DELETE => [
            'acceptableResponses' => [Response::RESPONSE_DELETED],
            'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
            'argumentDefaults' => [
                'jobId' => null
            ]
        ],
        CommandInterface::COMMAND_IGNORE => [
            'responseParser' => SimpleValueResponseParser::class,
            'acceptableResponses' => [Response::RESPONSE_WATCHING],
            'expectedErrorResponses' => [Response::FAILURE_NOT_IGNORED],
            'commandLineCreator' => TubeNameCheckingCommandLineCreator::class,
            'argumentDefaults' => [
                'tubeName' => null
            ]
        ],
        CommandInterface::COMMAND_KICK => [
            'responseParser' => SimpleValueResponseParser::class,
            'acceptableResponses' => [Response::RESPONSE_KICKED],
            'argumentDefaults' => [
                'howMany' => Beanie::DEFAULT_MAX_TO_KICK
            ]
        ],
        CommandInterface::COMMAND_KICK_JOB => [
            'acceptableResponses' => [Response::RESPONSE_KICKED],
            'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
            'argumentDefaults' => [
                'jobId' => null
            ]
        ],
        CommandInterface::COMMAND_LIST_TUBES => [
            'responseParser' => YAMLResponseParser::class,
            'acceptableResponses' => [Response::RESPONSE_OK]
        ],
        CommandInterface::COMMAND_LIST_TUBES_WATCHED => [
            'responseParser' => YAMLResponseParser::class,
            'acceptableResponses' => [Response::RESPONSE_OK]
        ],
        CommandInterface::COMMAND_LIST_TUBE_USED => [
            'responseParser' => SimpleValueResponseParser::class,
            'acceptableResponses' => [Response::RESPONSE_USING]
        ],
        CommandInterface::COMMAND_PAUSE_TUBE => [
            'acceptableResponses' => [Response::RESPONSE_PAUSED],
            'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
            'commandLineCreator' => TubeNameCheckingCommandLineCreator::class,
            'argumentDefaults' => [
                'tubeName' => null,
                'howLong' => Beanie::DEFAULT_DELAY
            ]
        ],
        CommandInterface::COMMAND_PEEK => [
            'responseParser' => JobResponseParser::class,
            'acceptableResponses' => [Response::RESPONSE_FOUND],
            'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
            'argumentDefaults' => [
                'jobId' => null
            ]
        ],
        CommandInterface::COMMAND_PEEK_BURIED => [
            'responseParser' => JobResponseParser::class,
            'acceptableResponses' => [Response::RESPONSE_FOUND],
            'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND]
        ],
        CommandInterface::COMMAND_PEEK_DELAYED => [
            'responseParser' => JobResponseParser::class,
            'acceptableResponses' => [Response::RESPONSE_FOUND],
            'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND]
        ],
        CommandInterface::COMMAND_PEEK_READY => [
            'responseParser' => JobResponseParser::class,
            'acceptableResponses' => [Response::RESPONSE_FOUND],
            'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND]
        ],
        CommandInterface::COMMAND_PUT => [
            'responseParser' => SimpleValueResponseParser::class,
            'acceptableResponses' =>  [Response::RESPONSE_INSERTED, Response::RESPONSE_BURIED],
            'expectedErrorResponses' => [
                Response::FAILURE_DRAINING,
                Response::FAILURE_EXPECTED_CRLF,
                Response::FAILURE_JOB_TOO_BIG
            ],
            'commandLineCreator' => PutCommandLineCreator::class,
            'argumentDefaults' => [
                'priority' => Beanie::DEFAULT_PRIORITY,
                'delay' => Beanie::DEFAULT_DELAY,
                'timeToRun' => Beanie::DEFAULT_TIME_TO_RUN
            ]
        ],
        CommandInterface::COMMAND_QUIT => [],
        CommandInterface::COMMAND_RELEASE => [
            'acceptableResponses' => [Response::RESPONSE_BURIED, Response::RESPONSE_RELEASED],
            'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
            'argumentDefaults' => [
                'jobId' => null,
                'priority' => Beanie::DEFAULT_PRIORITY,
                'delay' => Beanie::DEFAULT_DELAY
            ]
        ],
        CommandInterface::COMMAND_RESERVE => [
            'responseParser' => JobResponseParser::class,
            'acceptableResponses' => [Response::RESPONSE_RESERVED],
            'expectedErrorResponses' => [Response::FAILURE_DEADLINE_SOON]
        ],
        CommandInterface::COMMAND_RESERVE_WITH_TIMEOUT => [
            'responseParser' => JobResponseParser::class,
            'acceptableResponses' => [Response::RESPONSE_RESERVED],
            'expectedErrorResponses' => [Response::FAILURE_DEADLINE_SOON, Response::FAILURE_TIMED_OUT],
            'argumentDefaults' => [
                'timeout' => null
            ]
        ],
        CommandInterface::COMMAND_STATS => [
            'responseParser' => YAMLResponseParser::class,
            'acceptableResponses' => [Response::RESPONSE_OK]
        ],
        CommandInterface::COMMAND_STATS_JOB => [
            'responseParser' => YAMLResponseParser::class,
            'acceptableResponses' => [Response::RESPONSE_OK],
            'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
            'argumentDefaults' => [
                'jobId' => null
            ]
        ],
        CommandInterface::COMMAND_STATS_TUBE => [
            'responseParser' => YAMLResponseParser::class,
            'acceptableResponses' => [Response::RESPONSE_OK],
            'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
            'commandLineCreator' => TubeNameCheckingCommandLineCreator::class,
            'argumentDefaults' => [
                'tubeName' => null
            ]
        ],
        CommandInterface::COMMAND_TOUCH => [
            'acceptableResponses' => [Response::RESPONSE_TOUCHED],
            'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
            'argumentDefaults' => [
                'jobId' => null
            ]
        ],
        CommandInterface::COMMAND_USE => [
            'responseParser' => SimpleValueResponseParser::class,
            'acceptableResponses' => [Response::RESPONSE_USING],
            'commandLineCreator' => TubeNameCheckingCommandLineCreator::class,
            'argumentDefaults' => [
                'tubeName' => null
            ]
        ],
        CommandInterface::COMMAND_WATCH => [
            'responseParser' => SimpleValueResponseParser::class,
            'acceptableResponses' => [Response::RESPONSE_WATCHING],
            'expectedErrorResponses' => [],
            'commandLineCreator' => TubeNameCheckingCommandLineCreator::class,
            'argumentDefaults' => [
                'tubeName' => null
            ]
        ]
    ];

    protected static $errorResponseExceptionMap = [
        Response::FAILURE_NOT_FOUND => NotFoundException::class,
        Response::FAILURE_NOT_IGNORED => NotIgnoredException::class,
        Response::FAILURE_DRAINING => DrainingException::class,
        Response::FAILURE_EXPECTED_CRLF => ExpectedCRLFException::class,
        Response::FAILURE_JOB_TOO_BIG => JobTooBigException::class,
        Response::FAILURE_DEADLINE_SOON => DeadlineSoonException::class,
        Response::FAILURE_TIMED_OUT => TimedOutException::class
    ];

    /**
     * @param string $commandName
     * @param array $arguments
     * @return GenericCommand
     * @throws InvalidArgumentException
     */
    public function create($commandName, array $arguments = [])
    {
        if (!isset(self::$commandStructureMap[$commandName])) {
            throw new InvalidArgumentException('Could not create Command for \'' . $commandName . '\'');
        }

        $commandStructure = array_merge(self::$defaultCommandStructure, self::$commandStructureMap[$commandName]);

        return new GenericCommand(
            $this->createLineCreator($commandStructure, $commandName, $arguments),
            $this->createResponseParser($commandStructure)
        );
    }

    /**
     * @param array $commandStructure
     * @return ResponseParserInterface
     */
    private function createResponseParser($commandStructure)
    {
        return new $commandStructure['responseParser'](
            $commandStructure['acceptableResponses'],
            array_intersect_key(
                self::$errorResponseExceptionMap,
                array_flip($commandStructure['expectedErrorResponses'])
            )
        );
    }

    /**
     * @param array $commandStructure
     * @param string $commandName
     * @param array $arguments
     * @return CommandLineCreatorInterface
     */
    private function createLineCreator($commandStructure, $commandName, $arguments)
    {
        return new $commandStructure['commandLineCreator'](
            $commandName, $arguments, $commandStructure['argumentDefaults']
        );
    }
}


1		<?php
2
3
4		namespace Beanie\Command;
5
6
7		use Beanie\Beanie;
8		use Beanie\Command\CommandLineCreator\CommandLineCreatorInterface;
9		use Beanie\Command\CommandLineCreator\GenericCommandLineCreator;
10		use Beanie\Command\CommandLineCreator\PutCommandLineCreator;
11		use Beanie\Command\CommandLineCreator\TubeNameCheckingCommandLineCreator;
12		use Beanie\Command\ResponseParser\GenericResponseParser;
13		use Beanie\Command\ResponseParser\JobResponseParser;
14		use Beanie\Command\ResponseParser\ResponseParserInterface;
15		use Beanie\Command\ResponseParser\SimpleValueResponseParser;
16		use Beanie\Command\ResponseParser\YAMLResponseParser;
17		use Beanie\Exception\DeadlineSoonException;
18		use Beanie\Exception\DrainingException;
19		use Beanie\Exception\ExpectedCRLFException;
20		use Beanie\Exception\InvalidArgumentException;
21		use Beanie\Exception\JobTooBigException;
22		use Beanie\Exception\NotFoundException;
23		use Beanie\Exception\NotIgnoredException;
24		use Beanie\Exception\TimedOutException;
25		use Beanie\Util\FactoryInterface;
26		use Beanie\Util\FactoryTrait;
27
28		class CommandFactory implements FactoryInterface
29		{
30		use FactoryTrait;
31
32		protected static $defaultCommandStructure = [
33		'responseParser' => GenericResponseParser::class,
34		'acceptableResponses' => [],
35		'expectedErrorResponses' => [],
36		'commandLineCreator' => GenericCommandLineCreator::class,
37		'argumentDefaults' => []
38		];
39
40		protected static $commandStructureMap = [
41		CommandInterface::COMMAND_BURY => [
42		'acceptableResponses' => [Response::RESPONSE_BURIED],
43		'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
44		'argumentDefaults' => [
45		'jobId' => null,
46		'priority' => Beanie::DEFAULT_PRIORITY
47		]
48		],
49		CommandInterface::COMMAND_DELETE => [
50		'acceptableResponses' => [Response::RESPONSE_DELETED],
51		'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
52		'argumentDefaults' => [
53		'jobId' => null
54		]
55		],
56		CommandInterface::COMMAND_IGNORE => [
57		'responseParser' => SimpleValueResponseParser::class,
58		'acceptableResponses' => [Response::RESPONSE_WATCHING],
59		'expectedErrorResponses' => [Response::FAILURE_NOT_IGNORED],
60		'commandLineCreator' => TubeNameCheckingCommandLineCreator::class,
61		'argumentDefaults' => [
62		'tubeName' => null
63		]
64		],
65		CommandInterface::COMMAND_KICK => [
66		'responseParser' => SimpleValueResponseParser::class,
67		'acceptableResponses' => [Response::RESPONSE_KICKED],
68		'argumentDefaults' => [
69		'howMany' => Beanie::DEFAULT_MAX_TO_KICK
70		]
71		],
72		CommandInterface::COMMAND_KICK_JOB => [
73		'acceptableResponses' => [Response::RESPONSE_KICKED],
74		'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
75		'argumentDefaults' => [
76		'jobId' => null
77		]
78		],
79		CommandInterface::COMMAND_LIST_TUBES => [
80		'responseParser' => YAMLResponseParser::class,
81		'acceptableResponses' => [Response::RESPONSE_OK]
82		],
83		CommandInterface::COMMAND_LIST_TUBES_WATCHED => [
84		'responseParser' => YAMLResponseParser::class,
85		'acceptableResponses' => [Response::RESPONSE_OK]
86		],
87		CommandInterface::COMMAND_LIST_TUBE_USED => [
88		'responseParser' => SimpleValueResponseParser::class,
89		'acceptableResponses' => [Response::RESPONSE_USING]
90		],
91		CommandInterface::COMMAND_PAUSE_TUBE => [
92		'acceptableResponses' => [Response::RESPONSE_PAUSED],
93		'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
94		'commandLineCreator' => TubeNameCheckingCommandLineCreator::class,
95		'argumentDefaults' => [
96		'tubeName' => null,
97		'howLong' => Beanie::DEFAULT_DELAY
98		]
99		],
100		CommandInterface::COMMAND_PEEK => [
101		'responseParser' => JobResponseParser::class,
102		'acceptableResponses' => [Response::RESPONSE_FOUND],
103		'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
104		'argumentDefaults' => [
105		'jobId' => null
106		]
107		],
108		CommandInterface::COMMAND_PEEK_BURIED => [
109		'responseParser' => JobResponseParser::class,
110		'acceptableResponses' => [Response::RESPONSE_FOUND],
111		'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND]
112		],
113		CommandInterface::COMMAND_PEEK_DELAYED => [
114		'responseParser' => JobResponseParser::class,
115		'acceptableResponses' => [Response::RESPONSE_FOUND],
116		'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND]
117		],
118		CommandInterface::COMMAND_PEEK_READY => [
119		'responseParser' => JobResponseParser::class,
120		'acceptableResponses' => [Response::RESPONSE_FOUND],
121		'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND]
122		],
123		CommandInterface::COMMAND_PUT => [
124		'responseParser' => SimpleValueResponseParser::class,
125		'acceptableResponses' => [Response::RESPONSE_INSERTED, Response::RESPONSE_BURIED],
126		'expectedErrorResponses' => [
127		Response::FAILURE_DRAINING,
128		Response::FAILURE_EXPECTED_CRLF,
129		Response::FAILURE_JOB_TOO_BIG
130		],
131		'commandLineCreator' => PutCommandLineCreator::class,
132		'argumentDefaults' => [
133		'priority' => Beanie::DEFAULT_PRIORITY,
134		'delay' => Beanie::DEFAULT_DELAY,
135		'timeToRun' => Beanie::DEFAULT_TIME_TO_RUN
136		]
137		],
138		CommandInterface::COMMAND_QUIT => [],
139		CommandInterface::COMMAND_RELEASE => [
140		'acceptableResponses' => [Response::RESPONSE_BURIED, Response::RESPONSE_RELEASED],
141		'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
142		'argumentDefaults' => [
143		'jobId' => null,
144		'priority' => Beanie::DEFAULT_PRIORITY,
145		'delay' => Beanie::DEFAULT_DELAY
146		]
147		],
148		CommandInterface::COMMAND_RESERVE => [
149		'responseParser' => JobResponseParser::class,
150		'acceptableResponses' => [Response::RESPONSE_RESERVED],
151		'expectedErrorResponses' => [Response::FAILURE_DEADLINE_SOON]
152		],
153		CommandInterface::COMMAND_RESERVE_WITH_TIMEOUT => [
154		'responseParser' => JobResponseParser::class,
155		'acceptableResponses' => [Response::RESPONSE_RESERVED],
156		'expectedErrorResponses' => [Response::FAILURE_DEADLINE_SOON, Response::FAILURE_TIMED_OUT],
157		'argumentDefaults' => [
158		'timeout' => null
159		]
160		],
161		CommandInterface::COMMAND_STATS => [
162		'responseParser' => YAMLResponseParser::class,
163		'acceptableResponses' => [Response::RESPONSE_OK]
164		],
165		CommandInterface::COMMAND_STATS_JOB => [
166		'responseParser' => YAMLResponseParser::class,
167		'acceptableResponses' => [Response::RESPONSE_OK],
168		'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
169		'argumentDefaults' => [
170		'jobId' => null
171		]
172		],
173		CommandInterface::COMMAND_STATS_TUBE => [
174		'responseParser' => YAMLResponseParser::class,
175		'acceptableResponses' => [Response::RESPONSE_OK],
176		'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
177		'commandLineCreator' => TubeNameCheckingCommandLineCreator::class,
178		'argumentDefaults' => [
179		'tubeName' => null
180		]
181		],
182		CommandInterface::COMMAND_TOUCH => [
183		'acceptableResponses' => [Response::RESPONSE_TOUCHED],
184		'expectedErrorResponses' => [Response::FAILURE_NOT_FOUND],
185		'argumentDefaults' => [
186		'jobId' => null
187		]
188		],
189		CommandInterface::COMMAND_USE => [
190		'responseParser' => SimpleValueResponseParser::class,
191		'acceptableResponses' => [Response::RESPONSE_USING],
192		'commandLineCreator' => TubeNameCheckingCommandLineCreator::class,
193		'argumentDefaults' => [
194		'tubeName' => null
195		]
196		],
197		CommandInterface::COMMAND_WATCH => [
198		'responseParser' => SimpleValueResponseParser::class,
199		'acceptableResponses' => [Response::RESPONSE_WATCHING],
200		'expectedErrorResponses' => [],
201		'commandLineCreator' => TubeNameCheckingCommandLineCreator::class,
202		'argumentDefaults' => [
203		'tubeName' => null
204		]
205		]
206		];
207
208		protected static $errorResponseExceptionMap = [
209		Response::FAILURE_NOT_FOUND => NotFoundException::class,
210		Response::FAILURE_NOT_IGNORED => NotIgnoredException::class,
211		Response::FAILURE_DRAINING => DrainingException::class,
212		Response::FAILURE_EXPECTED_CRLF => ExpectedCRLFException::class,
213		Response::FAILURE_JOB_TOO_BIG => JobTooBigException::class,
214		Response::FAILURE_DEADLINE_SOON => DeadlineSoonException::class,
215		Response::FAILURE_TIMED_OUT => TimedOutException::class
216		];
217
218		/**
219		* @param string $commandName
220		* @param array $arguments
221		* @return GenericCommand
222		* @throws InvalidArgumentException
223		*/
224	50	public function create($commandName, array $arguments = [])
225		{
226	50	if (!isset(self::$commandStructureMap[$commandName])) {
227	1	throw new InvalidArgumentException('Could not create Command for \'' . $commandName . '\'');
228		}
229
230	49	$commandStructure = array_merge(self::$defaultCommandStructure, self::$commandStructureMap[$commandName]);
231
232	49	return new GenericCommand(
233	49	$this->createLineCreator($commandStructure, $commandName, $arguments),
234	49	$this->createResponseParser($commandStructure)
235	49	);
236		}
237
238		/**
239		* @param array $commandStructure
240		* @return ResponseParserInterface
241		*/
242	49	private function createResponseParser($commandStructure)
243		{
244	49	return new $commandStructure['responseParser'](
245	49	$commandStructure['acceptableResponses'],
246	49	array_intersect_key(
247	49	self::$errorResponseExceptionMap,
248	49	array_flip($commandStructure['expectedErrorResponses'])
249	49	)
250	49	);
251		}
252
253		/**
254		* @param array $commandStructure
255		* @param string $commandName
256		* @param array $arguments
257		* @return CommandLineCreatorInterface
258		*/
259	49	private function createLineCreator($commandStructure, $commandName, $arguments)
260		{
261	49	return new $commandStructure['commandLineCreator'](
262	49	$commandName, $arguments, $commandStructure['argumentDefaults']
263	49	);
264		}
265		}
266

zwilias / beanie

CommandFactory::createLineCreator() A last analyzed 2016-05-31 11:03 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

CommandFactory::createLineCreator() A
last analyzed 2016-05-31 11:03 UTC