Sign upLogin

lter/deims

View on GitHub
Star
modules/custom/pasta/lib/PastaApi.php

Summary

Maintainability
C
1 day
Test Coverage

Function fetchDOI has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
Open

  public function fetchDOI() {
    list($scope, $identifier, $revision) = $this->dataSet->getPackageIDParts();

    $url = static::getApiUrl("package/doi/eml/{$scope}/{$identifier}/{$revision}");
    $request = drupal_http_request($url, array('timeout' => 10));
Severity: Minor
Found in modules/custom/pasta/lib/PastaApi.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 fetchEmlReport has 26 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  public function fetchEmlReport() {

    list($scope, $identifier, $revision) = $this->dataSet->getPackageIDParts();

    // Fetch the EML report from the API.
Severity: Minor
Found in modules/custom/pasta/lib/PastaApi.php - About 1 hr to fix

    Method fetchDOI has 26 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      public function fetchDOI() {
    list($scope, $identifier, $revision) = $this->dataSet->getPackageIDParts();

    $url = static::getApiUrl("package/doi/eml/{$scope}/{$identifier}/{$revision}");
    $request = drupal_http_request($url, array('timeout' => 10));
    Severity: Minor
    Found in modules/custom/pasta/lib/PastaApi.php - About 1 hr to fix

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

        public function fetchEmlReport() {

    list($scope, $identifier, $revision) = $this->dataSet->getPackageIDParts();

    // Fetch the EML report from the API.
      Severity: Minor
      Found in modules/custom/pasta/lib/PastaApi.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

      Avoid too many return statements within this method.
      Open

            return array();
      Severity: Major
      Found in modules/custom/pasta/lib/PastaApi.php - About 30 mins to fix

        Avoid too many return statements within this method.
        Open

              return array();
        Severity: Major
        Found in modules/custom/pasta/lib/PastaApi.php - About 30 mins to fix

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

            public function deleteEml() {
    list($scope, $identifier) = $this->dataSet->getPackageIDParts();
    $url = static::getApiUrl("package/eml/$scope/$identifier");
    $options = array(
      'method' => 'DELETE',
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.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

          Avoid unused local variables such as '$revision'.
          Open

              list($scope, $identifier, $revision) = $this->dataSet->getPackageIDParts();
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpmd

          UnusedLocalVariable

          Since: 0.2

          Detects when a local variable is declared and/or assigned, but not used.

          Example

          class Foo {
    public function doSomething()
    {
        $i = 5; // Unused
    }
}

          Source https://phpmd.org/rules/unusedcode.html#unusedlocalvariable

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

            public function fetchEMLID() {
    list($scope, $identifier, $revision) = $this->dataSet->getPackageIDParts();

    $url = static::getApiUrl("package/eml/{$scope}/{$identifier}?filter=newest");
    $request = drupal_http_request($url, array('timeout' => 10));
          Severity: Major
          Found in modules/custom/pasta/lib/PastaApi.php and 1 other location - About 4 hrs to fix
          modules/custom/pasta/sync_eml_id/lib/PastaEmlIdApi.php on lines 28..43

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

          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

          Closing brace indented incorrectly; expected 2 spaces, found 0
          Open

          }
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Separate the @throws and @ingroup sections by a blank line.
          Open

             * @ingroup eml_data_manager_api
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Line indented incorrectly; expected 8 spaces, found 7
          Open

                 else {
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Expected 1 space after ELSE keyword; 0 found
          Open

                }else{
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Line indented incorrectly; expected 8 spaces, found 7
          Open

                 }
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Line indented incorrectly; expected 2 spaces, found 1
          Open

           /**
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Missing function doc comment
          Open

            public function __construct(EmlDataSet $dataSet) {
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Line indented incorrectly; expected 6 spaces, found 4
          Open

              //  dataset nuked
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Line indented incorrectly; expected 8 spaces, found 7
          Open

                 if (preg_match('/doi:([\d.]+\/FK2\/[a-z0-9]+)/', $request->data, $matches)) {
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Expected 2 space(s) before asterisk; 3 found
          Open

             */
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Separate the @throws and @see sections by a blank line.
          Open

             * @see PastaApi::fetchEmlReport()
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          2 spaces found before inline comment; expected "// dataset nuked" but found "// dataset nuked"
          Open

              //  dataset nuked
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Line indented incorrectly; expected 8 spaces, found 7
          Open

                 }
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Line indented incorrectly; expected 10 spaces, found 8
          Open

                  return $matches[1];
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Line indented incorrectly; expected 10 spaces, found 8
          Open

                  throw new Exception(t('DOI request to @url returned expected result %doi.', array('@url' => $url, '%doi' => $request->data)));
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Expected newline after closing brace
          Open

                }else{
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Line indented incorrectly; expected 10 spaces, found 8
          Open

                  throw new Exception(t('DOI request to @url returned expected result %doi.', array('@url' => $url, '%doi' => $request->data)));
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Separate the @throws and @ingroup sections by a blank line.
          Open

             * @ingroup eml_data_manager_api
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Public method name "PastaApi::fetchDOI" is not in lowerCamel format
          Open

            public function fetchDOI() {
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Line indented incorrectly; expected 8 spaces, found 7
          Open

                 if (preg_match('/doi:([\d.]+\/pasta\/[a-z0-9]+)/', $request->data, $matches)) {
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Line indented incorrectly; expected 8 spaces, found 7
          Open

                 }
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          The first index in a multi-value array must be on a new line
          Open

                throw new Exception(t('Unable to fetch EML ID from @url: @error.', array('@url' => $url, '@er
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Separate the @throws and @see sections by a blank line.
          Open

             * @see PastaApi::fetchValidationReportTransaction()
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Missing class doc comment
          Open

          class PastaApi {
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Missing function doc comment
          Open

            public function getDataSet() {
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Missing function doc comment
          Open

            public function deleteEml() {
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Inline comments must start with a capital letter
          Open

              //  dataset nuked
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Expected 2 space(s) before asterisk; 3 found
          Open

             *
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          The first index in a multi-value array must be on a new line
          Open

                throw new Exception(t('Unable to fetch EML ID from @url: @error.', array('@url' => $url, '@er
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Expected 1 blank line after function; 0 found
          Open

            }
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Expected 2 space(s) before asterisk; 3 found
          Open

             *
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Expected 2 space(s) before asterisk; 3 found
          Open

             * @throws Exception
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Expected 2 space(s) before asterisk; 3 found
          Open

             * @ingroup eml_data_manager_api
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Line indented incorrectly; expected 8 spaces, found 7
          Open

                 }
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Line indented incorrectly; expected 8 spaces, found 7
          Open

                 else {
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Expected 2 space(s) before asterisk; 3 found
          Open

             * @return int
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Expected 2 space(s) before asterisk; 3 found
          Open

             *   An integer from the PASTA API.
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Closing parenthesis of array declaration must be on a new line
          Open

          ror' => $request->error)));
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Expected 1 blank line after function; 2 found
          Open

            }
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Parameter $xml is not described in comment
          Open

            /**
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Missing function doc comment
          Open

            public function submitEml() {
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Expected 1 blank line after function; 2 found
          Open

            }
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Line indented incorrectly; expected 2 spaces, found 0
          Open

          }
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Expected 1 blank line after function; 0 found
          Open

            }
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Public method name "PastaApi::fetchEMLID" is not in lowerCamel format
          Open

            public function fetchEMLID() {
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Separate the @throws and @see sections by a blank line.
          Open

             * @see PastaApi::fetchValidationReport()
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          There must be exactly one blank line before the tags in a doc comment
          Open

             * @throws Exception
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Missing function doc comment
          Open

            public static function getApiUrl($path, array $options = array()) {
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Inline comments must end in full-stops, exclamation marks, colons, question marks, or closing parentheses
          Open

              //  dataset nuked
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Expected 2 space(s) before asterisk; 3 found
          Open

             * Fetch a data set's Eml revision ID (data object version) from the LTER PASTA Data Manager API.
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Doc comment for parameter $report_xml does not match actual variable name $xml
          Open

             * @param string $report_xml
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          The closing brace for the class must have an empty line before it
          Open

          }
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Missing function doc comment
          Open

            public static function addApiAuthentication(array &$options) {
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Line indented incorrectly; expected 10 spaces, found 8
          Open

                  return $matches[1];
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          Line indented incorrectly; expected 6 spaces, found 8
          Open

                  return $request->data;
          Severity: Minor
          Found in modules/custom/pasta/lib/PastaApi.php by phpcodesniffer

          There are no issues that match your filters.

          Category
          Status