YumlClient::generateGraph() - Code Metrics - Inspection of "Integration of metadataGrapher new features" - Nono1971/doctrine-yuml-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0165b3...f3e283 )

by Bruno

created 2017-04-09 09:30 UTC

YumlClient::generateGraph() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

namespace Onurb\Bundle\YumlBundle\Yuml;

use Doctrine\Common\Persistence\Mapping\ClassMetadata;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Mapping\ClassMetadataFactory;
use Doctrine\Common\Persistence\Mapping\ClassMetadataFactory as ClassMetadataFactoryInterface;
use Onurb\Bundle\YumlBundle\Curl\Curl;
use Onurb\Bundle\YumlBundle\Curl\CurlInterface;
use Onurb\Doctrine\ORMMetadataGrapher\YUMLMetadataGrapher as MetadataGrapher;
use Onurb\Doctrine\ORMMetadataGrapher\YUMLMetadataGrapherInterface as MetadataGrapherInterface;

/**
 * Utility to generate Yuml compatible strings from metadata graphs
 * Adaptation of DoctrineORMModule\Yuml\YumlController for ZendFramework-Zend-Developer-Tools
 *
 * @license MIT
 * @link    http://www.doctrine-project.org/
 * @author  Marco Pivetta <[email protected]>
 * @author  Bruno Heron <[email protected]>
 **/
class YumlClient implements YumlClientInterface
{
    const YUML_POST_URL = 'https://yuml.me/diagram/plain/class';
    const YUML_REDIRECT_URL = 'https://yuml.me/';

    protected $entityManager;

    protected $metadataFactory;

    protected $metadataGrapher;

    /**
     * @param EntityManagerInterface $entityManager
     * @param ClassMetadataFactoryInterface|null $classMetadataFactory
     * @param MetadataGrapherInterface|null $metadataGrapher
     */
    public function __construct(
        EntityManagerInterface          $entityManager,
        ClassMetadataFactoryInterface   $classMetadataFactory = null,
        MetadataGrapherInterface        $metadataGrapher = null
    ) {
        $this->entityManager = $entityManager;
        $this->metadataFactory = $classMetadataFactory ? $classMetadataFactory : new ClassMetadataFactory();
        $this->metadataFactory->setEntityManager($this->entityManager);
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.
    }
}
        $this->metadataGrapher = $metadataGrapher ? $metadataGrapher : new MetadataGrapher();
    }


    /**
     * Get doctrine metadata as yuml.
     *
     * @param bool $showDetail
     * @param array $colors
     * @param array $notes
     * @return string
     */
    public function makeDslText($showDetail = false, $colors = array(), $notes = array())
    {
        return $this->metadataGrapher->generateFromMetadata(
            $this->getClasses(),
            $showDetail,
            $colors,
            $notes
        );
    }

    /**
     * Use yuml.me to generate an image from yuml.
     *
     * @param string $dsl_text
     *
     * @return string The url of the generated image.
     */
    public function getGraphUrl($dsl_text)
    {
        $curl = new Curl(self::YUML_POST_URL);
        $curl->setPosts(array('dsl_text' => $dsl_text));
        $return = $curl->getResponse();

        return self::YUML_REDIRECT_URL . $return;
    }

    /**
     * @param string $graphUrl
     * @param string $filename
     * @return mixed
     */
    public function downloadImage($graphUrl, $filename, CurlInterface $curl = null)
    {
        $curl = $curl ? $curl : new Curl($graphUrl);
        $curl->setOutput($filename);

        return $curl->getResponse();
    }

    /**
     * @return array
     */
    private function getMetadata()
    {
        return $this->metadataFactory->getAllMetadata();
    }

    /**
     * @return array
     */
    private function getClasses()
    {
        $classes = array();
        /** @var ClassMetadata $class */
        foreach ($this->getMetadata() as $class) {
            $classes[$class->getName()] = $class;
        }
        ksort($classes);

        return $classes;
    }
}


1		<?php
2
3		namespace Onurb\Bundle\YumlBundle\Yuml;
4
5		use Doctrine\Common\Persistence\Mapping\ClassMetadata;
6		use Doctrine\ORM\EntityManagerInterface;
7		use Doctrine\ORM\Mapping\ClassMetadataFactory;
8		use Doctrine\Common\Persistence\Mapping\ClassMetadataFactory as ClassMetadataFactoryInterface;
9		use Onurb\Bundle\YumlBundle\Curl\Curl;
10		use Onurb\Bundle\YumlBundle\Curl\CurlInterface;
11		use Onurb\Doctrine\ORMMetadataGrapher\YUMLMetadataGrapher as MetadataGrapher;
12		use Onurb\Doctrine\ORMMetadataGrapher\YUMLMetadataGrapherInterface as MetadataGrapherInterface;
13
14		/**
15		* Utility to generate Yuml compatible strings from metadata graphs
16		* Adaptation of DoctrineORMModule\Yuml\YumlController for ZendFramework-Zend-Developer-Tools
17		*
18		* @license MIT
19		* @link http://www.doctrine-project.org/
20		* @author Marco Pivetta <[email protected]>
21		* @author Bruno Heron <[email protected]>
22		**/
23		class YumlClient implements YumlClientInterface
24		{
25		const YUML_POST_URL = 'https://yuml.me/diagram/plain/class';
26		const YUML_REDIRECT_URL = 'https://yuml.me/';
27
28		protected $entityManager;
29
30		protected $metadataFactory;
31
32		protected $metadataGrapher;
33
34		/**
35		* @param EntityManagerInterface $entityManager
36		* @param ClassMetadataFactoryInterface\|null $classMetadataFactory
37		* @param MetadataGrapherInterface\|null $metadataGrapher
38		*/
39	4	public function __construct(
40		EntityManagerInterface $entityManager,
41		ClassMetadataFactoryInterface $classMetadataFactory = null,
42		MetadataGrapherInterface $metadataGrapher = null
43		) {
44	4	$this->entityManager = $entityManager;
45	4	$this->metadataFactory = $classMetadataFactory ? $classMetadataFactory : new ClassMetadataFactory();
46	4	$this->metadataFactory->setEntityManager($this->entityManager);
		0 ignored issues – show Bug introduced 2016-07-17 19:45 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Doctrine\Common\Persiste...ng\ClassMetadataFactory` as the method `setEntityManager()` does only exist in the following implementations of said interface: `Doctrine\ORM\Mapping\ClassMetadataFactory`, `Doctrine\ORM\Tools\Disco...tedClassMetadataFactory`. 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...
47	4	$this->metadataGrapher = $metadataGrapher ? $metadataGrapher : new MetadataGrapher();
48	4	}
49
50
51		/**
52		* Get doctrine metadata as yuml.
53		*
54		* @param bool $showDetail
55		* @param array $colors
56		* @param array $notes
57		* @return string
58		*/
59	1	public function makeDslText($showDetail = false, $colors = array(), $notes = array())
60		{
61	1	return $this->metadataGrapher->generateFromMetadata(
62	1	$this->getClasses(),
63		$showDetail,
64		$colors,
65		$notes
66		);
67		}
68
69		/**
70		* Use yuml.me to generate an image from yuml.
71		*
72		* @param string $dsl_text
73		*
74		* @return string The url of the generated image.
75		*/
76	1	public function getGraphUrl($dsl_text)
77		{
78	1	$curl = new Curl(self::YUML_POST_URL);
79	1	$curl->setPosts(array('dsl_text' => $dsl_text));
80	1	$return = $curl->getResponse();
81
82	1	return self::YUML_REDIRECT_URL . $return;
83		}
84
85		/**
86		* @param string $graphUrl
87		* @param string $filename
88		* @return mixed
89		*/
90	1	public function downloadImage($graphUrl, $filename, CurlInterface $curl = null)
91		{
92	1	$curl = $curl ? $curl : new Curl($graphUrl);
93	1	$curl->setOutput($filename);
94
95	1	return $curl->getResponse();
96		}
97
98		/**
99		* @return array
100		*/
101	1	private function getMetadata()
102		{
103	1	return $this->metadataFactory->getAllMetadata();
104		}
105
106		/**
107		* @return array
108		*/
109	1	private function getClasses()
110		{
111	1	$classes = array();
112		/** @var ClassMetadata $class */
113	1	foreach ($this->getMetadata() as $class) {
114	1	$classes[$class->getName()] = $class;
115		}
116	1	ksort($classes);
117
118	1	return $classes;
119		}
120		}
121

Nono1971 / doctrine-yuml-bundle

GitHub Access Token became invalid

Push — master ( 0165b3...f3e283 )

YumlClient::generateGraph() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like