Sign upLogin

skqr/raml

View on GitHub
Star

Showing 125 of 125 total issues

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

    private function copy(array $source, array $values)
    {
        foreach ($source as $key => &$value) {
            $params = $this->parseParams($key);
Severity: Major
Found in Root/ResourceType.php and 1 other location - About 4 hrs to fix
Root/RamlTrait.php on lines 83..107

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

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

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

    private function copy(array $source, array $values)
    {
        foreach ($source as $key => &$value) {
            $params = $this->parseParams($key);
Severity: Major
Found in Root/RamlTrait.php and 1 other location - About 4 hrs to fix
Root/ResourceType.php on lines 78..102

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

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

Function dig has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
Open

    private static function dig($raml, $key = NULL)
    {
        $args = array_slice(func_get_args(), 2);

        if (!empty($key)) {
Severity: Minor
Found in DocNavigator.php - About 3 hrs 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 applyAllToTree has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
Open

    private static function applyAllToTree(
        RamlDoc $ramlDoc, array $item, $itemKey = NULL
    )
    {
        if (
Severity: Minor
Found in DocExpander.php - About 2 hrs 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 apply has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
Open

    public function apply($type, array $node)
    {
        $copy = NULL;

        if (empty($node['is'])) {
Severity: Minor
Found in Root/RamlTrait.php - About 2 hrs 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 parse has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
Open

    public function parse($raw, RamlDoc $ramlDoc)
    {
        $collection = new Root\MapCollection;

        if (is_string($raw)) {
Severity: Minor
Found in MapCollectionParser.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

Avoid excessively long variable names like $rootLevelDeclarations. Keep variable name length under 20.
Open

    public static $rootLevelDeclarations = [
        self::PROPERTY_DECLARE_RESOURCE_TYPES,
        self::PROPERTY_DECLARE_TRAITS,
        self::PROPERTY_DECLARE_SCHEMAS
    ];
Severity: Minor
Found in RamlSpec.php by phpmd

LongVariable

Since: 0.2

Detects when a field, formal or local variable is declared with a long name.

Example

class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

Source https://phpmd.org/rules/naming.html#longvariable

Avoid excessively long variable names like $resourceTypeParameters. Keep variable name length under 20.
Open

    public static $resourceTypeParameters = [
        self::PARAMETER_RESOURCE_PATH,
        self::PARAMETER_RESOURCE_PATH_NAME
    ];
Severity: Minor
Found in RamlSpec.php by phpmd

LongVariable

Since: 0.2

Detects when a field, formal or local variable is declared with a long name.

Example

class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

Source https://phpmd.org/rules/naming.html#longvariable

Function getPathDefinition has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

    public function getPathDefinition($path)
    {
        $raml = $this->rawRaml;

        foreach (explode('/', substr($path, 1)) as $part) {
Severity: Minor
Found in RamlDoc.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 dig has 35 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private static function dig($raml, $key = NULL)
    {
        $args = array_slice(func_get_args(), 2);

        if (!empty($key)) {
Severity: Minor
Found in DocNavigator.php - About 1 hr to fix

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

        public function findRequestSchema(
        $method, $resourceUri, $mediaType = RamlSpec::MEDIA_TYPE_JSON
    )
    {
        if (!RamlDoc::isValidMethod($method)) {
    Severity: Minor
    Found in DocNavigator.php - About 1 hr to fix

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

          private static function applyAllToTree(
        RamlDoc $ramlDoc, array $item, $itemKey = NULL
    )
    {
        if (
      Severity: Minor
      Found in DocExpander.php - About 1 hr to fix

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

            public function apply($type, array $node)
    {
        $copy = NULL;

        if (empty($node['is'])) {
        Severity: Minor
        Found in Root/RamlTrait.php - About 1 hr to fix

          Function copy has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
          Open

              private function copy(array $source, array $values)
    {
        foreach ($source as $key => &$value) {
            $params = $this->parseParams($key);
          Severity: Minor
          Found in Root/ResourceType.php - About 55 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 copy has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
          Open

              private function copy(array $source, array $values)
    {
        foreach ($source as $key => &$value) {
            $params = $this->parseParams($key);
          Severity: Minor
          Found in Root/RamlTrait.php - About 55 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 findRequestSchema has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
          Open

              public function findRequestSchema(
        $method, $resourceUri, $mediaType = RamlSpec::MEDIA_TYPE_JSON
    )
    {
        if (!RamlDoc::isValidMethod($method)) {
          Severity: Minor
          Found in DocNavigator.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

          TRUE, FALSE and NULL must be lowercase; expected "null" but found "NULL"
          Open

                  return NULL;
          Severity: Minor
          Found in Root/MapCollection.php by phpcodesniffer

          TRUE, FALSE and NULL must be lowercase; expected "null" but found "NULL"
          Open

                  $this->usage = !empty($source['usage']) ? $source['usage'] : NULL;
          Severity: Minor
          Found in Root/ResourceType.php by phpcodesniffer

          Multi-line function declarations must define one parameter per line
          Open

                  RamlDoc $ramlDoc, array $item, $itemKey = NULL
          Severity: Minor
          Found in DocExpander.php by phpcodesniffer

          Each PHP statement must be on a line by itself
          Open

                              $callback = function($part) { return '/' . $part; };
          Severity: Minor
          Found in DocNavigator.php by phpcodesniffer
          Severity
          Category
          Status
          Source
          Language