EscolaLMS/model-fields

View on GitHub
src/Traits/ModelFields.php

Summary

Maintainability
A
1 hr
Test Coverage
A
100%

Avoid using static access to class '\Illuminate\Support\Facades\Cache' in method 'clearModelFieldsValuesCache'.
Open

            Cache::flush();
Severity: Minor
Found in src/Traits/ModelFields.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Avoid assigning values to variables in if clauses and the like (line '125', column '13').
Open

    public static function firstOrCreate(array $attributes = [], array $values = [])
    {
        $modelFieldKeys = ModelFieldsFacade::getFieldsMetadata(static::class)->pluck('name')->toArray();
        $baseAttributes = array_diff_key($attributes, array_flip($modelFieldKeys));
        $additionalAttributes = array_diff_key($attributes, $baseAttributes);
Severity: Minor
Found in src/Traits/ModelFields.php by phpmd

IfStatementAssignment

Since: 2.7.0

Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

Example

class Foo
{
    public function bar($flag)
    {
        if ($foo = 'bar') { // possible typo
            // ...
        }
        if ($baz = 0) { // always false
            // ...
        }
    }
}

Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

Avoid using static access to class '\EscolaLms\ModelFields\Facades\ModelFields' in method 'getExtraAttributesValues'.
Open

        return ModelFieldsFacade::getExtraAttributesValues($this);
Severity: Minor
Found in src/Traits/ModelFields.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

syntax error, unexpected 'Collection' (T_STRING), expecting function (T_FUNCTION) or const (T_CONST)
Open

    private Collection $extraFields;
Severity: Critical
Found in src/Traits/ModelFields.php by phan

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

        if ($instance = $query->first()) {
            foreach ($additionalAttributes as $key => $value) {
                $query = $query->whereHas('fields', function ($query) use ($key, $value){
                    return $query->where([
                        ['name', '=', $key],
Severity: Minor
Found in src/Traits/ModelFields.php and 1 other location - About 50 mins to fix
src/Models/Model.php on lines 145..158

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

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

        $this->extraFields = collect($attributes)
            ->filter(fn ($item, $key) => in_array($key, array_keys($fields)))
            ->map(fn ($item, $key) => ['name' => $key, 'value' =>  self::convertValueForFill($item, $fields[$key])]);
Severity: Minor
Found in src/Traits/ModelFields.php and 1 other location - About 40 mins to fix
src/Models/Model.php on lines 69..71

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

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

Expected 1 space before opening brace; found 0
Open

                $query = $query->whereHas('fields', function ($query) use ($key, $value){
Severity: Minor
Found in src/Traits/ModelFields.php by phpcodesniffer

Line exceeds 120 characters; contains 137 characters
Open

            $this->extraFields = isset($this->extraFields) ? $this->extraFields->prepend(['name' => $key, 'value' => $value]) : collect([
Severity: Minor
Found in src/Traits/ModelFields.php by phpcodesniffer

Space before opening parenthesis of function call prohibited
Open

            ->mapWithKeys(fn ($item) =>  [$item['name'] => $item])
Severity: Minor
Found in src/Traits/ModelFields.php by phpcodesniffer

Space before opening parenthesis of function call prohibited
Open

            ->map(fn ($item, $key) => ['name' => $key, 'value' =>  self::convertValueForFill($item, $fields[$key])]);
Severity: Minor
Found in src/Traits/ModelFields.php by phpcodesniffer

Space before opening parenthesis of function call prohibited
Open

        $names = $extraFields->map(fn ($item) => $item['name'])->toArray();
Severity: Minor
Found in src/Traits/ModelFields.php by phpcodesniffer

Space before opening parenthesis of function call prohibited
Open

            ->mapWithKeys(fn ($item, $key) =>  [$item['name'] => $item])
Severity: Minor
Found in src/Traits/ModelFields.php by phpcodesniffer

Space before opening parenthesis of function call prohibited
Open

            ->filter(fn ($item, $key) => in_array($key, array_keys($fields)))
Severity: Minor
Found in src/Traits/ModelFields.php by phpcodesniffer

There are no issues that match your filters.

Category
Status