TwigFakerExtension::createNewFakeData() - Code Metrics - Inspection of "Refactored and added tests" - alanablett/twig-faker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b9874a...3faeb6 )

by Alan

created 2016-05-18 13:43 UTC

TwigFakerExtension::createNewFakeData() A

↳ Parent: TwigFakerExtension

Complexity

Conditions	3
Paths	3

Size

Total Lines	17
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	1	Features	2

Metric	Value
c	3
b	1
f	2
dl	0
loc	17
rs	9.4285
cc	3
eloc	8
nc	3
nop	2

<?php

namespace Ablett\TwigFaker;

use Faker\Factory;

class TwigFakerExtension extends \Twig_Extension {

    public static $factoriesPath = 'factories/';
    private $cache;
    private $fake_data;

    /**
     * Returns the name of the extension.
     *
     * @return string The extension name
     */
    public function getName()
    {
        return 'faker';
    }

    /**
     * Callback for twig.
     *
     * @return array
     */
    public function getFunctions()
    {
        return [
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            'fake' => new \Twig_Function_Method($this, 'fakerData')

        ];
    }

    /**
     * Generate fake data.
     *
     * @param $type
     * @param int $count
     * @return array
     */
    public function fakerData($type, $count = 1, $cache_key = null)
    {
        if (isset($cache_key)) $cache_key = "{$type}-$cache_key";

        if (isset($this->cache[$cache_key]))
        {
            return $this->cache[$cache_key];
        }

        $this->createNewFakeData($type, $count);
        $this->cacheNewFakeData($cache_key);

        return $this->fake_data;
    }

    /**
     * Create the fake data.
     *
     * @param $type
     * @param integer $count
     * @throws InvalidFactoryException
     */
    private function createNewFakeData($type, $count)
    {
        $faker = Factory::create();
        $this->fake_data = [];

        for ($i = 0; $i < $count; $i++)
        {
            if ( ! file_exists($this->fullFactoryPath($type)))
            {
                throw new InvalidFactoryException('does not exist');
            }

            $fake_item = include $this->fullFactoryPath($type);

            array_push($this->fake_data, $fake_item);
        }
    }

    /**
     * Cache the new fake data if a key was sent.
     *
     * @param $cache_key
     */
    private function cacheNewFakeData($cache_key)
    {
        if ($cache_key)
        {
            $this->cache[$cache_key] = $this->fake_data;
        }
    }

    /**
     * Get the full factory path.
     *
     * @param $type
     * @return string
     */
    private function fullFactoryPath($type)
    {
        return static::$factoriesPath . $type . '.php';
    }
}

class InvalidFactoryException extends \Exception {}


1			<?php
2
3			namespace Ablett\TwigFaker;
4
5			use Faker\Factory;
6
7			class TwigFakerExtension extends \Twig_Extension {
8
9			public static $factoriesPath = 'factories/';
10			private $cache;
11			private $fake_data;
12
13			/**
14			* Returns the name of the extension.
15			*
16			* @return string The extension name
17			*/
18			public function getName()
19			{
20			return 'faker';
21			}
22
23			/**
24			* Callback for twig.
25			*
26			* @return array
27			*/
28			public function getFunctions()
29			{
30			return [
			0 ignored issues – show Bug Best Practice introduced 2016-05-18 13:35 UTC by Report Bug Copy Issue Report The return type of `return array('fake' => n...d($this, 'fakerData'));` (`array<string,Twig_Function_Method>`) is incompatible with the return type declared by the interface `Twig_ExtensionInterface::getFunctions` of type `Twig_SimpleFunction[]`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
31			'fake' => new \Twig_Function_Method($this, 'fakerData')
			0 ignored issues – show Deprecated Code introduced 2016-05-18 13:35 UTC by Report Bug Copy Issue Report The class `Twig_Function_Method` has been deprecated with message: since 1.12 (to be removed in 2.0) This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
32			];
33			}
34
35			/**
36			* Generate fake data.
37			*
38			* @param $type
39			* @param int $count
40			* @return array
41			*/
42			public function fakerData($type, $count = 1, $cache_key = null)
43			{
44			if (isset($cache_key)) $cache_key = "{$type}-$cache_key";
45
46			if (isset($this->cache[$cache_key]))
47			{
48			return $this->cache[$cache_key];
49			}
50
51			$this->createNewFakeData($type, $count);
52			$this->cacheNewFakeData($cache_key);
53
54			return $this->fake_data;
55			}
56
57			/**
58			* Create the fake data.
59			*
60			* @param $type
61			* @param integer $count
62			* @throws InvalidFactoryException
63			*/
64			private function createNewFakeData($type, $count)
65			{
66			$faker = Factory::create();
67			$this->fake_data = [];
68
69			for ($i = 0; $i < $count; $i++)
70			{
71			if ( ! file_exists($this->fullFactoryPath($type)))
72			{
73			throw new InvalidFactoryException('does not exist');
74			}
75
76			$fake_item = include $this->fullFactoryPath($type);
77
78			array_push($this->fake_data, $fake_item);
79			}
80			}
81
82			/**
83			* Cache the new fake data if a key was sent.
84			*
85			* @param $cache_key
86			*/
87			private function cacheNewFakeData($cache_key)
88			{
89			if ($cache_key)
90			{
91			$this->cache[$cache_key] = $this->fake_data;
92			}
93			}
94
95			/**
96			* Get the full factory path.
97			*
98			* @param $type
99			* @return string
100			*/
101			private function fullFactoryPath($type)
102			{
103			return static::$factoriesPath . $type . '.php';
104			}
105			}
106
107			class InvalidFactoryException extends \Exception {}
			0 ignored issues – show Coding Style Compatibility introduced 2016-05-18 13:47 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...

alanablett / twig-faker

Push — master ( b9874a...3faeb6 )

TwigFakerExtension::createNewFakeData() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like