DarkaOnLine/L5-Swagger

View on GitHub

Showing 9 of 36 total issues

The class RoutesTest has 15 public methods. Consider refactoring RoutesTest to keep number of public methods under 10.
Open

class RoutesTest extends TestCase
{
    /** @test */
    public function userCantAccessJsonFileIfItIsNotGenerated(): void
    {
Severity: Minor
Found in tests/RoutesTest.php by phpmd

TooManyPublicMethods

Since: 0.1

A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

By default it ignores methods starting with 'get' or 'set'.

Example

Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

Method configDataProvider has 66 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public static function configDataProvider(): array
    {
        return [
            [
                [
Severity: Major
Found in tests/ConfigFactoryTest.php - About 2 hrs to fix

    Method docs has 44 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function docs(Request $request)
        {
            $fileSystem = new Filesystem();
            $documentation = $request->offsetGet('documentation');
            $config = $request->offsetGet('config');
    Severity: Minor
    Found in src/Http/Controllers/SwaggerController.php - About 1 hr to fix

      Method api has 29 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function api(Request $request)
          {
              $documentation = $request->offsetGet('documentation');
              $config = $request->offsetGet('config');
      
      
      Severity: Minor
      Found in src/Http/Controllers/SwaggerController.php - About 1 hr to fix

        Method canGenerateWithScanOptions has 28 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function canGenerateWithScanOptions(): void
            {
                $cfg = config('l5-swagger.documentations.default');
        
                $cfg['scanOptions']['exclude'] = [
        Severity: Minor
        Found in tests/GeneratorTest.php - About 1 hr to fix

          Method __construct has 6 arguments (exceeds 4 allowed). Consider refactoring.
          Open

                  array $paths,
                  array $constants,
                  bool $yamlCopyRequired,
                  SecurityDefinitions $security,
                  array $scanOptions,
          Severity: Minor
          Found in src/Generator.php - About 45 mins to fix

            Function docs has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
            Open

                public function docs(Request $request)
                {
                    $fileSystem = new Filesystem();
                    $documentation = $request->offsetGet('documentation');
                    $config = $request->offsetGet('config');
            Severity: Minor
            Found in src/Http/Controllers/SwaggerController.php - About 45 mins to fix

            Cognitive Complexity

            Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

            A method's cognitive complexity is based on a few simple rules:

            • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
            • Code is considered more complex for each "break in the linear flow of the code"
            • Code is considered more complex when "flow breaking structures are nested"

            Further reading

            Function setProcessors has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
            Open

                protected function setProcessors(OpenApiGenerator $generator): void
                {
                    $processorClasses = Arr::get($this->scanOptions, self::SCAN_OPTION_PROCESSORS, []);
                    $processors = [];
            
            
            Severity: Minor
            Found in src/Generator.php - About 35 mins to fix

            Cognitive Complexity

            Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

            A method's cognitive complexity is based on a few simple rules:

            • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
            • Code is considered more complex for each "break in the linear flow of the code"
            • Code is considered more complex when "flow breaking structures are nested"

            Further reading

            Function copyAssets has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

                protected function copyAssets(): void
                {
                    $fileSystem = new Filesystem();
                    $src = __DIR__.'/../vendor/swagger-api/swagger-ui/dist/';
                    $destination = __DIR__.'/../vendor/orchestra/testbench-core/laravel/vendor/swagger-api/swagger-ui/dist/';
            Severity: Minor
            Found in tests/TestCase.php - About 25 mins to fix

            Cognitive Complexity

            Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

            A method's cognitive complexity is based on a few simple rules:

            • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
            • Code is considered more complex for each "break in the linear flow of the code"
            • Code is considered more complex when "flow breaking structures are nested"

            Further reading

            Severity
            Category
            Status
            Source
            Language