packbackbooks/lti-1-3-php-library

View on GitHub

Showing 10 of 14 total issues

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

    public function __construct(?array $grade = null)
    {
        $this->score_given = $grade['scoreGiven'] ?? null;
        $this->score_maximum = $grade['scoreMaximum'] ?? null;
        $this->comment = $grade['comment'] ?? null;
Severity: Major
Found in src/LtiGrade.php and 1 other location - About 5 hrs to fix
src/LtiLineitem.php on lines 20..31

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 195.

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 LtiMessageLaunch.php has 389 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace Packback\Lti1p3;

use Exception;
Severity: Minor
Found in src/LtiMessageLaunch.php - About 5 hrs to fix

    LtiMessageLaunch has 39 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class LtiMessageLaunch
    {
        public const TYPE_DEEPLINK = 'LtiDeepLinkingRequest';
        public const TYPE_SUBMISSIONREVIEW = 'LtiSubmissionReviewRequest';
        public const TYPE_RESOURCELINK = 'LtiResourceLinkRequest';
    Severity: Minor
    Found in src/LtiMessageLaunch.php - About 5 hrs to fix

      LtiLineitem has 21 functions (exceeds 20 allowed). Consider refactoring.
      Open

      class LtiLineitem
      {
          use JsonStringable;
          private $id;
          private $score_maximum;
      Severity: Minor
      Found in src/LtiLineitem.php - About 2 hrs to fix

        LtiGrade has 21 functions (exceeds 20 allowed). Consider refactoring.
        Open

        class LtiGrade
        {
            use JsonStringable;
            private $score_given;
            private $score_maximum;
        Severity: Minor
        Found in src/LtiGrade.php - About 2 hrs to fix

          Method getAccessToken has 32 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public function getAccessToken(ILtiRegistration $registration, array $scopes): string
              {
                  // Get a unique cache key for the access token
                  $accessTokenKey = $this->getAccessTokenCacheKey($registration, $scopes);
                  // Get access token from cache if it exists
          Severity: Minor
          Found in src/LtiServiceConnector.php - About 1 hr to fix

            Function getPublicKey has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
            Open

                private function getPublicKey(): Key
                {
                    $request = new ServiceRequest(
                        ServiceRequest::METHOD_GET,
                        $this->registration->getKeySetUrl(),
            Severity: Minor
            Found in src/LtiMessageLaunch.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

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

                private function getPublicKey(): Key
                {
                    $request = new ServiceRequest(
                        ServiceRequest::METHOD_GET,
                        $this->registration->getKeySetUrl(),
            Severity: Minor
            Found in src/LtiMessageLaunch.php - About 1 hr to fix

              Method sign has 5 arguments (exceeds 4 allowed). Consider refactoring.
              Open

                  public function sign(string $deploymentId, string $iss, string $clientId, string $exp, string $nonce): string
              Severity: Minor
              Found in src/Lti1p1Key.php - About 35 mins to fix

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

                    public function getGroupsBySet(): array
                    {
                        $groups = $this->getGroups();
                        $sets = $this->getSets();
                
                
                Severity: Minor
                Found in src/LtiCourseGroupsService.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

                Severity
                Category
                Status
                Source
                Language