11291593011

Committed 11 Oct 2024 11:33AM UTC coverage: 98.185% (-1.8%) from 100.0%

Build # 11291593011

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #58 from saifulferoz/feature/attribute-support

feat: replace doctrine annotation to php attribute

Run Details

7 of 7 new or added lines in 2 files covered. (100.0%)

9 existing lines in 1 file now uncovered.

487 of 496 relevant lines covered (98.19%)

23.43 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

80.0

/Subscriber/DoctrineSubscriber.php

<?php

/*
 * This file is part of the XiideaEasyAuditBundle package.
 *
 * (c) Xiidea <http://www.xiidea.net>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Xiidea\EasyAuditBundle\Subscriber;

use Doctrine\Common\Util\ClassUtils;
use Doctrine\Persistence\Event\LifecycleEventArgs;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Xiidea\EasyAuditBundle\Attribute\SubscribeDoctrineEvents;
use Xiidea\EasyAuditBundle\Events\DoctrineEvents;
use Xiidea\EasyAuditBundle\Events\DoctrineObjectEvent;

class DoctrineSubscriber
{
    private array $toBeDeleted = [];
    private  $dispatcher = null;

    public function __construct(private array $entities = [])
    {
    }

    public function postPersist(LifecycleEventArgs $args)
    {
        $this->handleEvent(DoctrineEvents::ENTITY_CREATED, $args);
    }

    public function postUpdate(LifecycleEventArgs $args)
    {
        $this->handleEvent(DoctrineEvents::ENTITY_UPDATED, $args);
    }

    public function preRemove(LifecycleEventArgs $args)
    {
        if (false === $this->isConfiguredToTrack($args->getObject(), DoctrineEvents::ENTITY_DELETED)) {
            return;
        }

        $className = ClassUtils::getClass($args->getObject());

        if (!isset($this->toBeDeleted[$className])) {
            $this->toBeDeleted[$className] = [];
        }

        $this->toBeDeleted[$className][spl_object_hash($args->getObject())] = $this->getIdentity($args, $className);
    }

    public function postRemove(LifecycleEventArgs $args)
    {
        $identity = $this->getToBeDeletedId($args->getObject());

        if (null !== $identity) {
            $this->dispatcher->dispatch(new DoctrineObjectEvent($args, $identity), DoctrineEvents::ENTITY_DELETED);
        }
    }

    private function getToBeDeletedId($entity)
    {
        if ($this->isScheduledForDelete($entity)) {
            return $this->toBeDeleted[ClassUtils::getClass($entity)][spl_object_hash($entity)];
        }

        return null;
    }

    /**
     * @param  string  $eventName
     * @param  LifecycleEventArgs  $args
     */
    private function handleEvent($eventName, LifecycleEventArgs $args)
    {
        if (true === $this->isConfiguredToTrack($args->getObject(), $eventName)) {
            $this->dispatcher->dispatch(
                new DoctrineObjectEvent($args, $this->getIdentity($args, ClassUtils::getClass($args->getObject()))),
                $eventName
            );
        }
    }

    /**
     * @param $entity
     * @param  string  $eventName
     *
     * @return bool
     */
    private function isConfiguredToTrack($entity, $eventName = '')
    {
        $class = ClassUtils::getClass($entity);
        $eventType = DoctrineEvents::getShortEventType($eventName);

        if (null !== $track = $this->isAttributedEvent($entity, $eventType)) {
            return $track;
        }

        if (!isset($this->entities[$class])) {
            return false;
        }

        if ($this->shouldTrackAllEventType($class)) {
            return true;
        }

        return $this->shouldTrackEventType($eventType, $class);
    }

    /**
     * @param $entity
     * @param string $eventType
     * @return bool|null
     * @throws \ReflectionException
     */
    protected function isAttributedEvent($entity, $eventType)
    {
        $reflection = new \ReflectionClass($entity);
        $attribute = $reflection->getAttributes(SubscribeDoctrineEvents::class);
        if (empty($attribute)) {
            return null;
        }

        $instance = $attribute[0]->newInstance();

        return empty($instance->events) || in_array($eventType, $instance->events);
    }


    /**
     * @param  string  $eventType
     * @param  string  $class
     *
     * @return bool
     */
    private function shouldTrackEventType($eventType, $class)
    {
        return is_array($this->entities[$class]) && in_array($eventType, $this->entities[$class]);
    }

    /**
     * @param  string  $class
     *
     * @return bool
     */
    private function shouldTrackAllEventType($class)
    {
        return empty($this->entities[$class]);
    }

    /**
     * @param  LifecycleEventArgs  $args
     * @param $className
     *
     * @return array
     */
    protected function getIdentity(LifecycleEventArgs $args, $className)
    {
        return $args->getObjectManager()->getClassMetadata($className)->getIdentifierValues($args->getObject());
    }

    /**
     * @param $entity
     *
     * @return bool
     */
    private function isScheduledForDelete($entity)
    {
        $originalClassName = ClassUtils::getClass($entity);

        return isset($this->toBeDeleted[$originalClassName]) && isset(
                $this->toBeDeleted[$originalClassName][spl_object_hash(
                    $entity
                )]
            );
    }

    /**
     * @param  EventDispatcherInterface  $dispatcher
     */
    public function setDispatcher($dispatcher)
    {
        $this->dispatcher = $dispatcher;
    }
}

1	<?php
2
3	/*
4	* This file is part of the XiideaEasyAuditBundle package.
5	*
6	* (c) Xiidea <http://www.xiidea.net>
7	*
8	* This source file is subject to the MIT license that is bundled
9	* with this source code in the file LICENSE.
10	*/
11
12	namespace Xiidea\EasyAuditBundle\Subscriber;
13
14	use Doctrine\Common\Util\ClassUtils;
15	use Doctrine\Persistence\Event\LifecycleEventArgs;
16	use Symfony\Component\EventDispatcher\EventDispatcherInterface;
17	use Xiidea\EasyAuditBundle\Attribute\SubscribeDoctrineEvents;
18	use Xiidea\EasyAuditBundle\Events\DoctrineEvents;
19	use Xiidea\EasyAuditBundle\Events\DoctrineObjectEvent;
20
21	class DoctrineSubscriber
22	{
23	private array $toBeDeleted = [];
24	private $dispatcher = null;
25
26	public function __construct(private array $entities = [])
27	{
28	}	21✔
29
30	public function postPersist(LifecycleEventArgs $args)
31	{
32	$this->handleEvent(DoctrineEvents::ENTITY_CREATED, $args);	12✔
33	}
34
35	public function postUpdate(LifecycleEventArgs $args)
36	{
37	$this->handleEvent(DoctrineEvents::ENTITY_UPDATED, $args);	3✔
38	}
39
40	public function preRemove(LifecycleEventArgs $args)
41	{
42	if (false === $this->isConfiguredToTrack($args->getObject(), DoctrineEvents::ENTITY_DELETED)) {	6✔
UNCOV 43	return;	×
44	}
45
46	$className = ClassUtils::getClass($args->getObject());	6✔
47
48	if (!isset($this->toBeDeleted[$className])) {	6✔
49	$this->toBeDeleted[$className] = [];	6✔
50	}
51
52	$this->toBeDeleted[$className][spl_object_hash($args->getObject())] = $this->getIdentity($args, $className);	6✔
53	}
54
55	public function postRemove(LifecycleEventArgs $args)
56	{
57	$identity = $this->getToBeDeletedId($args->getObject());	6✔
58
59	if (null !== $identity) {	6✔
60	$this->dispatcher->dispatch(new DoctrineObjectEvent($args, $identity), DoctrineEvents::ENTITY_DELETED);	3✔
61	}
62	}
63
64	private function getToBeDeletedId($entity)
65	{
66	if ($this->isScheduledForDelete($entity)) {	6✔
67	return $this->toBeDeleted[ClassUtils::getClass($entity)][spl_object_hash($entity)];	3✔
68	}
69
70	return null;	3✔
71	}
72
73	/**
74	* @param string $eventName
75	* @param LifecycleEventArgs $args
76	*/
77	private function handleEvent($eventName, LifecycleEventArgs $args)
78	{
79	if (true === $this->isConfiguredToTrack($args->getObject(), $eventName)) {	15✔
80	$this->dispatcher->dispatch(	15✔
81	new DoctrineObjectEvent($args, $this->getIdentity($args, ClassUtils::getClass($args->getObject()))),	15✔
82	$eventName	15✔
83	);	15✔
84	}
85	}
86
87	/**
88	* @param $entity
89	* @param string $eventName
90	*
91	* @return bool
92	*/
93	private function isConfiguredToTrack($entity, $eventName = '')
94	{
95	$class = ClassUtils::getClass($entity);	21✔
96	$eventType = DoctrineEvents::getShortEventType($eventName);	21✔
97
98	if (null !== $track = $this->isAttributedEvent($entity, $eventType)) {	21✔
99	return $track;	21✔
100	}
101
UNCOV 102	if (!isset($this->entities[$class])) {	×
UNCOV 103	return false;	×
104	}
105
UNCOV 106	if ($this->shouldTrackAllEventType($class)) {	×
UNCOV 107	return true;	×
108	}
109
UNCOV 110	return $this->shouldTrackEventType($eventType, $class);	×
111	}
112
113	/**
114	* @param $entity
115	* @param string $eventType
116	* @return bool\|null
117	* @throws \ReflectionException
118	*/
119	protected function isAttributedEvent($entity, $eventType)
120	{
121	$reflection = new \ReflectionClass($entity);	21✔
122	$attribute = $reflection->getAttributes(SubscribeDoctrineEvents::class);	21✔
123	if (empty($attribute)) {	21✔
UNCOV 124	return null;	×
125	}
126
127	$instance = $attribute[0]->newInstance();	21✔
128
129	return empty($instance->events) \|\| in_array($eventType, $instance->events);	21✔
130	}
131
132
133	/**
134	* @param string $eventType
135	* @param string $class
136	*
137	* @return bool
138	*/
139	private function shouldTrackEventType($eventType, $class)
140	{
UNCOV 141	return is_array($this->entities[$class]) && in_array($eventType, $this->entities[$class]);	×
142	}
143
144	/**
145	* @param string $class
146	*
147	* @return bool
148	*/
149	private function shouldTrackAllEventType($class)
150	{
UNCOV 151	return empty($this->entities[$class]);	×
152	}
153
154	/**
155	* @param LifecycleEventArgs $args
156	* @param $className
157	*
158	* @return array
159	*/
160	protected function getIdentity(LifecycleEventArgs $args, $className)
161	{
162	return $args->getObjectManager()->getClassMetadata($className)->getIdentifierValues($args->getObject());	21✔
163	}
164
165	/**
166	* @param $entity
167	*
168	* @return bool
169	*/
170	private function isScheduledForDelete($entity)
171	{
172	$originalClassName = ClassUtils::getClass($entity);	6✔
173
174	return isset($this->toBeDeleted[$originalClassName]) && isset(	6✔
175	$this->toBeDeleted[$originalClassName][spl_object_hash(	6✔
176	$entity	6✔
177	)]	6✔
178	);	6✔
179	}
180
181	/**
182	* @param EventDispatcherInterface $dispatcher
183	*/
184	public function setDispatcher($dispatcher)
185	{
186	$this->dispatcher = $dispatcher;	21✔
187	}
188	}

xiidea / EasyAuditBundle / 11291593011

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous