Sign upLogin

swaggest/php-code-builder

View on GitHub
Star

Showing 65 of 65 total issues

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

        if (!$this->skipProperties
            //&& $this->schema->type === Type::OBJECT
            && !$this->phpBuilder->minimizeRefs
            && $this->schema->getFromRefs()
        ) {
Severity: Major
Found in src/JsonSchema/SchemaBuilder.php and 1 other location - About 2 hrs to fix
src/JsonSchema/SchemaBuilder.php on lines 133..150

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

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

        foreach ($type as $i => $t) {
            switch ($t) {
                case Schema::NULL:
                    $isOptional = true;
                    break;
Severity: Major
Found in src/JSDoc/TypeBuilder.php and 1 other location - About 2 hrs to fix
src/Markdown/TypeBuilder.php on lines 166..194

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

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

        foreach ($type as $i => $t) {
            switch ($t) {
                case Schema::NULL:
                    $isOptional = true;
                    break;
Severity: Major
Found in src/Markdown/TypeBuilder.php and 1 other location - About 2 hrs to fix
src/JSDoc/TypeBuilder.php on lines 105..133

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

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 processType has 57 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private function processType()
    {
        if ($this->schema->type !== null) {
            switch ($this->schema->type) {
                case Type::INTEGER:
Severity: Major
Found in src/JsonSchema/SchemaBuilder.php - About 2 hrs to fix

    Method process has 57 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function process(PhpClass $class, $path, $schema)
    {
        $schemaProperties = Schema::properties();

        $propertiesFound = array();
    Severity: Major
    Found in src/JsonSchema/SchemaExporterInterface.php - About 2 hrs to fix

      Function processEnum has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
      Open

          private function processEnum()
    {
        if (!empty($this->schema->enum)) {
            $this->result->addSnippet(
                "{$this->varName}->enum = array(\n"
      Severity: Minor
      Found in src/JsonSchema/SchemaBuilder.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

      Method processLogic has 53 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function processLogic()
    {
        $names = Schema::names();
        /** @var string $keyword */
        foreach (array($names->not, $names->if, $names->then, $names->else) as $keyword) {
      Severity: Major
      Found in src/JsonSchema/SchemaBuilder.php - About 2 hrs to fix

        Function processType has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
        Open

            private function processType()
    {
        if ($this->schema->type !== null) {
            switch ($this->schema->type) {
                case Type::INTEGER:
        Severity: Minor
        Found in src/JsonSchema/SchemaBuilder.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

        Method schemaIsNullable has 51 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            private function schemaIsNullable($property)
    {
        if (!empty($property->enum) && !in_array(null, $property->enum)) {
            return false;
        }
        Severity: Major
        Found in src/JsonSchema/PhpBuilder.php - About 2 hrs to fix

          Method processObject has 47 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              private function processObject()
    {
        if ($this->schema->type === Type::OBJECT) {
            if (!$this->skipProperties) {
                $this->result->addSnippet(
          Severity: Minor
          Found in src/JsonSchema/SchemaBuilder.php - About 1 hr to fix

            Function processObject has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
            Open

                private function processObject()
    {
        if ($this->schema->type === Type::OBJECT) {
            if (!$this->skipProperties) {
                $this->result->addSnippet(
            Severity: Minor
            Found in src/JsonSchema/SchemaBuilder.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 processAdditionalPatternProperties has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
            Open

                private function processAdditionalPatternProperties()
    {
        $schema = $this->schema;

        if ($schema->additionalProperties instanceof Schema) {
            Severity: Minor
            Found in src/JsonSchema/TypeBuilder.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 processEnum has 37 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                private function processEnum()
    {
        if (!empty($this->schema->enum)) {
            $this->result->addSnippet(
                "{$this->varName}->enum = array(\n"
            Severity: Minor
            Found in src/JsonSchema/SchemaBuilder.php - About 1 hr to fix

              Method varExport has 37 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  public static function varExport($value)
    {
        /** @var string $result */
        $result = '';
              Severity: Minor
              Found in src/PhpCode.php - About 1 hr to fix

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

                    public function addClass(PhpClassTraitInterface $class)
    {
        //$this->classes[] = $class;

        if (!$class->getName()) {
                Severity: Minor
                Found in src/App/PhpApp.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 renderPhpDocType has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
                Open

                    public function renderPhpDocType()
    {
        $index = array();
        foreach ($this->types as $type) {
            $phpDocType = $type->renderPhpDocType();
                Severity: Minor
                Found in src/Types/OrType.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 renderPhpDoc has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
                Open

                    private function renderPhpDoc()
    {
        $result = new PhpDoc();
        if ($this->description) {
            $result->add(null, $this->description);
                Severity: Minor
                Found in src/PhpFunction.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 addClass has 29 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                    public function addClass(PhpClassTraitInterface $class)
    {
        //$this->classes[] = $class;

        if (!$class->getName()) {
                Severity: Minor
                Found in src/App/PhpApp.php - About 1 hr to fix

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

                      protected function toString()
    {
        $result = '';
        ksort($this->namespaces);
        foreach ($this->namespaces as $namespace => $as) {
                  Severity: Minor
                  Found in src/PhpNamespaces.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 renderArrayPhpDocType has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
                  Open

                      public function renderArrayPhpDocType()
    {
        $index = array();
        foreach ($this->types as $type) {
            if ($type instanceof OrType) {
                  Severity: Minor
                  Found in src/Types/OrType.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

                  Severity
                  Category
                  Status
                  Source
                  Language