Completed
Pull Request — master (#32)
by Bernhard
05:42
created

JsonFileStoreGenerator   A

Complexity

Total Complexity 7

Size/Duplication

Total Lines 50
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 5

Test Coverage

Coverage 100%

Importance

Changes 2
Bugs 2 Features 0
Metric Value
wmc 7
c 2
b 2
f 0
lcom 1
cbo 5
dl 0
loc 50
ccs 26
cts 26
cp 1
rs 10

1 Method

Rating   Name   Duplication   Size   Complexity  
C generateNewInstance() 0 36 7
1
<?php
2
3
/*
4
 * This file is part of the puli/manager package.
5
 *
6
 * (c) Bernhard Schussek <[email protected]>
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace Puli\Manager\Factory\Generator\KeyValueStore;
13
14
use Puli\Manager\Api\Factory\Generator\GeneratorRegistry;
15
use Puli\Manager\Api\Factory\Generator\ServiceGenerator;
16
use Puli\Manager\Api\Php\Import;
17
use Puli\Manager\Api\Php\Method;
18
use Puli\Manager\Assert\Assert;
19
use Webmozart\PathUtil\Path;
20
21
/**
22
 * Generates the setup code for a {@link JsonFileStore}.
23
 *
24
 * @since  1.0
25
 *
26
 * @author Bernhard Schussek <[email protected]>
27
 */
28
class JsonFileStoreGenerator implements ServiceGenerator
29
{
30
    private static $defaultOptions = array(
31
        'path' => 'data.json',
32
        'serializeStrings' => true,
33
        'serializeArrays' => true,
34
        'escapeSlash' => true,
35
        'prettyPrint' => false,
36
    );
37
38
    /**
39
     * {@inheritdoc}
40
     */
41 32
    public function generateNewInstance($varName, Method $targetMethod, GeneratorRegistry $generatorRegistry, array $options = array())
42
    {
43 32
        Assert::keyExists($options, 'rootDir', 'The "rootDir" option is missing.');
44
45 31
        $options = array_replace(self::$defaultOptions, $options);
46
47 31
        $path = Path::makeAbsolute($options['path'], $options['rootDir']);
48 31
        $relPath = Path::makeRelative($path, $targetMethod->getClass()->getDirectory());
49
50 31
        $flags = array();
51
52 31
        if (!$options['serializeStrings']) {
53 27
            $flags[] = 'JsonFileStore::NO_SERIALIZE_STRINGS';
54 27
        }
55
56 31
        if (!$options['serializeArrays']) {
57 27
            $flags[] = 'JsonFileStore::NO_SERIALIZE_ARRAYS';
58 27
        }
59
60 31
        if (!$options['serializeArrays']) {
61 27
            $flags[] = 'JsonFileStore::NO_ESCAPE_SLASH';
62 27
        }
63
64 31
        if ($options['prettyPrint']) {
65 27
            $flags[] = 'JsonFileStore::PRETTY_PRINT';
66 27
        }
67
68 31
        $targetMethod->getClass()->addImport(new Import('Webmozart\KeyValueStore\JsonFileStore'));
69
70 31
        $targetMethod->addBody(sprintf("$%s = new JsonFileStore(%s%s%s);",
0 ignored issues
show
Coding Style Comprehensibility introduced by
The string literal $%s = new JsonFileStore(%s%s%s); does not require double quotes, as per coding-style, please use single quotes.

PHP provides two ways to mark string literals. Either with single quotes 'literal' or with double quotes "literal". The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences.

String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (\') and the backslash (\\). Every other character is displayed as is.

Double quoted string literals may contain other variables or more complex escape sequences.

<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

will print an indented: Single is Value

If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear.

For more information on PHP string literals and available escape sequences see the PHP core documentation.

Loading history...
71 31
            $varName,
72 31
            $flags ? "\n    " : '',
73 31
            '__DIR__.'.var_export('/'.$relPath, true),
74 31
            $flags ? ",\n    ".implode("\n        | ", $flags)."\n" : ''
75 31
        ));
76 31
    }
77
}
78