TransformerHelpers::instantiateTransformerModel() - Code Metrics - Inspection of "Add response parameter documentation" - mpociot/laravel-apidoc-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#743)

by Guy

created 2020-04-29 20:26 UTC

TransformerHelpers::instantiateTransformerModel() B

↳ Parent: TransformerHelpers

Complexity

Conditions	7
Paths	21

Size

Total Lines

Duplication

Lines	34
Ratio	100 %

Importance

Changes

Metric	Value
dl	34
loc	34
rs	8.4426
c	0
b	0
f	0
cc	7
nc	21
nop	1

<?php

namespace Mpociot\ApiDoc\Extracting;

use Exception;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Model as IlluminateModel;
use Illuminate\Support\Arr;
use Mpociot\ApiDoc\Tools\Flags;
use Mpociot\Reflection\DocBlock\Tag;
use ReflectionMethod;

trait TransformerHelpers
{
    /**
     * @param Tag $tag
     *
     * @return array
     */
    private function getStatusCodeAndTransformerClass($tag): array

    {
        $content = $tag->getContent();
        preg_match('/^(\d{3})?\s?([\s\S]*)$/', $content, $result);
        $status = $result[1] ?: 200;
        $transformerClass = $result[2];

        return [$status, $transformerClass];
    }

    /**
     * @param array $tags
     * @param ReflectionMethod $transformerMethod
     *
     * @throws Exception
     *
     * @return string
     */
    private function getClassToBeTransformed(array $tags, ReflectionMethod $transformerMethod): string
    {
        $modelTag = Arr::first(array_filter($tags, function ($tag) {
            return ($tag instanceof Tag) && strtolower($tag->getName()) == 'transformermodel';
if ($x instanceof DoesNotExist) {
    // Do something.
}
        }));

        $type = null;
        if ($modelTag) {
            $type = $modelTag->getContent();
        } else {
            $parameter = Arr::first($transformerMethod->getParameters());
            if ($parameter->hasType() && ! $parameter->getType()->isBuiltin() && class_exists($parameter->getType()->getName())) {
                // Ladies and gentlemen, we have a type!
                $type = $parameter->getType()->getName();
            }
        }

        if ($type == null) {
            throw new Exception('Failed to detect a transformer model. Please specify a model using @transformerModel.');
        }

        return $type;
    }

    /**
     * @param string $type
     *
     * @return Model|object
     */
    protected function instantiateTransformerModel(string $type)

    {
        try {
            // try Eloquent model factory

            // Factories are usually defined without the leading \ in the class name,
            // but the user might write it that way in a comment. Let's be safe.
            $type = ltrim($type, '\\');

            return factory($type)->make();
        } catch (Exception $e) {
            if (Flags::$shouldBeVerbose) {
                echo "Eloquent model factory failed to instantiate {$type}; trying to fetch from database.\n";
            }

            $instance = new $type();
            if ($instance instanceof IlluminateModel) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                try {
                    // we can't use a factory but can try to get one from the database
                    $firstInstance = $type::first();
                    if ($firstInstance) {
                        return $firstInstance;
                    }
                } catch (Exception $e) {
                    // okay, we'll stick with `new`
                    if (Flags::$shouldBeVerbose) {
                        echo "Failed to fetch first {$type} from database; using `new` to instantiate.\n";
                    }
                }
            }
        }

        return $instance;
    }

    /**
     * @param array $tags
     *
     * @return Tag|null
     */
    private function getTransformerTag(array $tags)

    {
        $transformerTags = array_values(
            array_filter($tags, function ($tag) {
                return ($tag instanceof Tag) && in_array(strtolower($tag->getName()), ['transformer', 'transformercollection']);
if ($x instanceof DoesNotExist) {
    // Do something.
}
            })
        );

        return Arr::first($transformerTags);
    }
}


1		<?php
2
3		namespace Mpociot\ApiDoc\Extracting;
4
5		use Exception;
6		use Illuminate\Database\Eloquent\Model;
7		use Illuminate\Database\Eloquent\Model as IlluminateModel;
8		use Illuminate\Support\Arr;
9		use Mpociot\ApiDoc\Tools\Flags;
10		use Mpociot\Reflection\DocBlock\Tag;
11		use ReflectionMethod;
12
13		trait TransformerHelpers
14		{
15		/**
16		* @param Tag $tag
17		*
18		* @return array
19		*/
20	View Code Duplication	private function getStatusCodeAndTransformerClass($tag): array
		0 ignored issues – show Duplication introduced 2019-10-15 21:31 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
21		{
22		$content = $tag->getContent();
23		preg_match('/^(\d{3})?\s?([\s\S]*)$/', $content, $result);
24		$status = $result[1] ?: 200;
25		$transformerClass = $result[2];
26
27		return [$status, $transformerClass];
28		}
29
30		/**
31		* @param array $tags
32		* @param ReflectionMethod $transformerMethod
33		*
34		* @throws Exception
35		*
36		* @return string
37		*/
38		private function getClassToBeTransformed(array $tags, ReflectionMethod $transformerMethod): string
39		{
40		$modelTag = Arr::first(array_filter($tags, function ($tag) {
41		return ($tag instanceof Tag) && strtolower($tag->getName()) == 'transformermodel';
		0 ignored issues – show Bug introduced 2019-11-07 20:36 UTC by Report Bug Copy Issue Report The class `Mpociot\Reflection\DocBlock\Tag` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
42		}));
43
44		$type = null;
45		if ($modelTag) {
46		$type = $modelTag->getContent();
47		} else {
48		$parameter = Arr::first($transformerMethod->getParameters());
49		if ($parameter->hasType() && ! $parameter->getType()->isBuiltin() && class_exists($parameter->getType()->getName())) {
50		// Ladies and gentlemen, we have a type!
51		$type = $parameter->getType()->getName();
52		}
53		}
54
55		if ($type == null) {
56		throw new Exception('Failed to detect a transformer model. Please specify a model using @transformerModel.');
57		}
58
59		return $type;
60		}
61
62		/**
63		* @param string $type
64		*
65		* @return Model\|object
66		*/
67	View Code Duplication	protected function instantiateTransformerModel(string $type)
		0 ignored issues – show Duplication introduced 2019-10-15 21:31 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
68		{
69		try {
70		// try Eloquent model factory
71
72		// Factories are usually defined without the leading \ in the class name,
73		// but the user might write it that way in a comment. Let's be safe.
74		$type = ltrim($type, '\\');
75
76		return factory($type)->make();
77		} catch (Exception $e) {
78		if (Flags::$shouldBeVerbose) {
79		echo "Eloquent model factory failed to instantiate {$type}; trying to fetch from database.\n";
80		}
81
82		$instance = new $type();
83		if ($instance instanceof IlluminateModel) {
		0 ignored issues – show Bug introduced 2020-01-13 09:55 UTC by Report Bug Copy Issue Report The class `Illuminate\Database\Eloquent\Model` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
84		try {
85		// we can't use a factory but can try to get one from the database
86		$firstInstance = $type::first();
87		if ($firstInstance) {
88		return $firstInstance;
89		}
90		} catch (Exception $e) {
91		// okay, we'll stick with `new`
92		if (Flags::$shouldBeVerbose) {
93		echo "Failed to fetch first {$type} from database; using `new` to instantiate.\n";
94		}
95		}
96		}
97		}
98
99		return $instance;
100		}
101
102		/**
103		* @param array $tags
104		*
105		* @return Tag\|null
106		*/
107	View Code Duplication	private function getTransformerTag(array $tags)
		0 ignored issues – show Duplication introduced 2019-10-15 21:31 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
108		{
109		$transformerTags = array_values(
110		array_filter($tags, function ($tag) {
111		return ($tag instanceof Tag) && in_array(strtolower($tag->getName()), ['transformer', 'transformercollection']);
		0 ignored issues – show Bug introduced 2019-08-25 21:49 UTC by Report Bug Copy Issue Report The class `Mpociot\Reflection\DocBlock\Tag` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
112		})
113		);
114
115		return Arr::first($transformerTags);
116		}
117		}
118

mpociot / laravel-apidoc-generator

Pull Request — master (#743)

TransformerHelpers::instantiateTransformerModel() B

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like