TwigAssetic::onRender() - Code Metrics - jasny/view - Measure and Improve Code Quality continuously with Scrutinizer

TwigAssetic::onRender() A
last analyzed 2017-06-05 19:35 UTC

↳ Parent: TwigAssetic

Complexity

Conditions	2
Paths	1

Size

Total Lines	21
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	21
ccs	13
cts	13
cp	1
rs	9.3142
c	0
b	0
f	0
cc	2
eloc	13
nc	1
nop	3
crap	2

<?php

namespace Jasny\View\Plugin;

use Jasny\ViewInterface;
use Jasny\View\Twig as TwigView;
use Jasny\View\PluginInterface;
use Assetic\AssetWriter;
use Assetic\Extension\Twig\AsseticExtension;
use Assetic\Extension\Twig\TwigFormulaLoader;
use Assetic\Extension\Twig\TwigResource;
use Assetic\Factory\AssetFactory;
use Assetic\Factory\LazyAssetManager;
use Jasny\Assetic\TwigCachingFormulaLoader;

/**
 * Assetic support for Twig
 */
class TwigAssetic implements PluginInterface
{
    /**
     * @var AssetFactory 
     */
    protected $factory;

    /**
     * @var AssetWriter
     */
    protected $writer;
    
    /**
     * Class constructor
     * 
     * @param AssetFactory $factory
     * @param AssetWriter  $writer
     */
    public function __construct(AssetFactory $factory, AssetWriter $writer)
    {
        $this->factory = $factory;
        $this->writer = $writer;
    }

    /**
     * Check that the view is a twig view
     * 
     * @param ViewInterface $view
     * @throws \InvalidArgumentException
     */
    protected function assertView(ViewInterface $view)
    {
        if (!$view instanceof TwigView) {
            throw new \InvalidArgumentException("This plugin only works with a Twig view");
        }
    }
    

    /**
     * Create an assetic extension for Twig.
     * @codeCoverageIgnore
     * 
     * @return AsseticExtension
     */
    protected function createExtension()
    {
        return new AsseticExtension($this->factory);
    }

    /**
     * Create an assetic formula loader.
     * @codeCoverageIgnore
     * 
     * @param \Twig_Environment $twig
     * @return TwigFormulaLoader
     */
    protected function createFormulaLoader($twig)
    {
        $class = class_exists('Jasny\Assetic\TwigCachingFormulaLoader')
            ? TwigCachingFormulaLoader::class
            : TwigFormulaLoader::class;
        
        return new $class($twig);
    }
    
    /**
     * Create an assetic asset manager.
     * @codeCoverageIgnore
     * 
     * @return LazyAssetManager
     */
    protected function createAssetManager()
    {
        return new LazyAssetManager($this->factory);
    }
    
    /**
     * Create an assetic twig resource.
     * @codeCoverageIgnore
     * 
     * @param \Twig_Environment $twig
     * @param string            $template
     * @return TwigResource
     */
    protected function createResource($twig, $template)
    {
        return new TwigResource($twig->getLoader(), $template);
    }
    

    /**
     * Called when the plugin is added to the view.
     * 
     * @param ViewInterface $view
     */
    public function onAdd(ViewInterface $view)
    {
        $this->assertView($view);

        $view->getTwig()->addExtension($this->createExtension());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }
    
    /**
     * Called when view renders a template.
     * 
     * @param ViewInterface $view
     * @param string        $template   Template filename
     * @param array         $context
     */
    public function onRender(ViewInterface $view, $template, array $context)
    {
        $this->assertView($view);
        
        $twig = $view->getTwig();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        
        $loader = $this->createFormulaLoader($twig);
        
        $assetManager = $this->createAssetManager($loader);

        $assetManager->setLoader('twig', $loader);   

        $tmpl = $twig->loadTemplate($template);
        
        do {
            $name = (string)$tmpl;
            $resource = $this->createResource($twig, $name);
            $assetManager->addResource($resource, 'twig');
        } while ($tmpl = $tmpl->getParent($context));
        
        $this->writer->writeManagerAssets($assetManager);
    }
}


1		<?php
2
3		namespace Jasny\View\Plugin;
4
5		use Jasny\ViewInterface;
6		use Jasny\View\Twig as TwigView;
7		use Jasny\View\PluginInterface;
8		use Assetic\AssetWriter;
9		use Assetic\Extension\Twig\AsseticExtension;
10		use Assetic\Extension\Twig\TwigFormulaLoader;
11		use Assetic\Extension\Twig\TwigResource;
12		use Assetic\Factory\AssetFactory;
13		use Assetic\Factory\LazyAssetManager;
14		use Jasny\Assetic\TwigCachingFormulaLoader;
15
16		/**
17		* Assetic support for Twig
18		*/
19		class TwigAssetic implements PluginInterface
20		{
21		/**
22		* @var AssetFactory
23		*/
24		protected $factory;
25
26		/**
27		* @var AssetWriter
28		*/
29		protected $writer;
30
31		/**
32		* Class constructor
33		*
34		* @param AssetFactory $factory
35		* @param AssetWriter $writer
36		*/
37	4	public function __construct(AssetFactory $factory, AssetWriter $writer)
38		{
39	4	$this->factory = $factory;
40	4	$this->writer = $writer;
41	4	}
42
43		/**
44		* Check that the view is a twig view
45		*
46		* @param ViewInterface $view
47		* @throws \InvalidArgumentException
48		*/
49	4	protected function assertView(ViewInterface $view)
50		{
51	4	if (!$view instanceof TwigView) {
52	2	throw new \InvalidArgumentException("This plugin only works with a Twig view");
53		}
54	2	}
55
56
57		/**
58		* Create an assetic extension for Twig.
59		* @codeCoverageIgnore
60		*
61		* @return AsseticExtension
62		*/
63		protected function createExtension()
64		{
65		return new AsseticExtension($this->factory);
66		}
67
68		/**
69		* Create an assetic formula loader.
70		* @codeCoverageIgnore
71		*
72		* @param \Twig_Environment $twig
73		* @return TwigFormulaLoader
74		*/
75		protected function createFormulaLoader($twig)
76		{
77		$class = class_exists('Jasny\Assetic\TwigCachingFormulaLoader')
78		? TwigCachingFormulaLoader::class
79		: TwigFormulaLoader::class;
80
81		return new $class($twig);
82		}
83
84		/**
85		* Create an assetic asset manager.
86		* @codeCoverageIgnore
87		*
88		* @return LazyAssetManager
89		*/
90		protected function createAssetManager()
91		{
92		return new LazyAssetManager($this->factory);
93		}
94
95		/**
96		* Create an assetic twig resource.
97		* @codeCoverageIgnore
98		*
99		* @param \Twig_Environment $twig
100		* @param string $template
101		* @return TwigResource
102		*/
103		protected function createResource($twig, $template)
104		{
105		return new TwigResource($twig->getLoader(), $template);
106		}
107
108
109		/**
110		* Called when the plugin is added to the view.
111		*
112		* @param ViewInterface $view
113		*/
114	3	public function onAdd(ViewInterface $view)
115		{
116	3	$this->assertView($view);
117
118	1	$view->getTwig()->addExtension($this->createExtension());
		0 ignored issues – show Bug introduced 2017-05-31 00:01 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Jasny\ViewInterface` as the method `getTwig()` does only exist in the following implementations of said interface: `Jasny\View\Twig`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
119	1	}
120
121		/**
122		* Called when view renders a template.
123		*
124		* @param ViewInterface $view
125		* @param string $template Template filename
126		* @param array $context
127		*/
128	1	public function onRender(ViewInterface $view, $template, array $context)
129		{
130	1	$this->assertView($view);
131
132	1	$twig = $view->getTwig();
		0 ignored issues – show Bug introduced 2017-05-30 23:48 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Jasny\ViewInterface` as the method `getTwig()` does only exist in the following implementations of said interface: `Jasny\View\Twig`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
133
134	1	$loader = $this->createFormulaLoader($twig);
135
136	1	$assetManager = $this->createAssetManager($loader);
		0 ignored issues – show Unused Code introduced 2017-06-01 23:31 UTC by Report Bug Copy Issue Report The call to `TwigAssetic::createAssetManager()` has too many arguments starting with `$loader`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
137	1	$assetManager->setLoader('twig', $loader);
138
139	1	$tmpl = $twig->loadTemplate($template);
140
141		do {
142	1	$name = (string)$tmpl;
143	1	$resource = $this->createResource($twig, $name);
144	1	$assetManager->addResource($resource, 'twig');
145	1	} while ($tmpl = $tmpl->getParent($context));
146
147	1	$this->writer->writeManagerAssets($assetManager);
148	1	}
149		}
150

jasny / view

TwigAssetic::onRender() A last analyzed 2017-06-05 19:35 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

TwigAssetic::onRender() A
last analyzed 2017-06-05 19:35 UTC