EscolaLMS/Images

View on GitHub

Showing 13 of 13 total issues

Similar blocks of code found in 2 locations. Consider refactoring.
Open

    public function test_allowed_width(): void
    {
        $allowed_width = 300;
        Config::set('images.public.allowed_widths', [$allowed_width]);

Severity: Major
Found in tests/Api/ImagesTest.php and 1 other location - About 1 day to fix
tests/Api/ImagesTest.php on lines 447..481

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 264.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

    public function test_allowed_height(): void
    {
        $allowed_height = 200;
        Config::set('images.public.allowed_heights', [$allowed_height]);

Severity: Major
Found in tests/Api/ImagesTest.php and 1 other location - About 1 day to fix
tests/Api/ImagesTest.php on lines 411..445

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 264.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

    private function determineWidth(InterventionImage $img, $width): ?int
    {
        if (is_null($width)) {
            return null;
        }
Severity: Major
Found in src/Services/ImagesService.php and 1 other location - About 5 hrs to fix
src/Services/ImagesService.php on lines 154..174

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 191.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

    private function determineHeight(InterventionImage $img, $height): ?int
    {
        if (is_null($height)) {
            return null;
        }
Severity: Major
Found in src/Services/ImagesService.php and 1 other location - About 5 hrs to fix
src/Services/ImagesService.php on lines 132..152

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 191.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

File ImagesTest.php has 342 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace Api;

use EscolaLms\Images\Events\FileStored;
Severity: Minor
Found in tests/Api/ImagesTest.php - About 4 hrs to fix

    Method testAdministrableConfigApi has 75 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function testAdministrableConfigApi(): void
        {
            $configKey = SettingsServiceProvider::CONFIG_KEY;
            $user = $this->makeAdmin();
    
    
    Severity: Major
    Found in tests/Api/SettingsTest.php - About 3 hrs to fix

      Similar blocks of code found in 2 locations. Consider refactoring.
      Open

          public function testPut(): void
          {
              Storage::fake();
              Event::fake([FileStored::class]);
              $file = UploadedFile::fake()->image('test.png');
      Severity: Major
      Found in tests/Feature/CustomFilesystemManagerTest.php and 1 other location - About 2 hrs to fix
      tests/Feature/CustomFilesystemManagerTest.php on lines 43..55

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 123.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Similar blocks of code found in 2 locations. Consider refactoring.
      Open

          public function testPutFile(): void
          {
              Storage::fake();
              Event::fake([FileStored::class]);
              $file = UploadedFile::fake()->image('test.png');
      Severity: Major
      Found in tests/Feature/CustomFilesystemManagerTest.php and 1 other location - About 2 hrs to fix
      tests/Feature/CustomFilesystemManagerTest.php on lines 29..41

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 123.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Method test_image_post_results has 45 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function test_image_post_results(): void
          {
              $filename = 'test.jpg';
              $filepath = realpath(__DIR__ . '/' . $filename);
      
      
      Severity: Minor
      Found in tests/Api/ImagesTest.php - About 1 hr to fix

        Method test_invalid_image_post_results has 42 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function test_invalid_image_post_results(): void
            {
                Event::fake([FileStored::class]);
                $disk = Storage::disk('local');
        
        
        Severity: Minor
        Found in tests/Api/ImagesTest.php - About 1 hr to fix

          Method render has 39 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public function render($path, $params): array
              {
                  $hash = sha1($path . json_encode($params));
                  $ext = pathinfo($path)['extension'] ?? null;
          
          
          Severity: Minor
          Found in src/Services/ImagesService.php - About 1 hr to fix

            Function render has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
            Open

                public function render($path, $params): array
                {
                    $hash = sha1($path . json_encode($params));
                    $ext = pathinfo($path)['extension'] ?? null;
            
            
            Severity: Minor
            Found in src/Services/ImagesService.php - About 1 hr 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 determineWidthAndHeight has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

                private function determineWidthAndHeight(InterventionImage $img, array $params): array
                {
                    if (isset($params['size'])) {
                        $size_definitions = config('images.public.size_definitions');
                        if (is_array($size_definitions) && array_key_exists($params['size'], $size_definitions)) {
            Severity: Minor
            Found in src/Services/ImagesService.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