studioespresso/craft-seo-fields

View on GitHub
src/migrations/m191114_201532_addRedirectsTable.php

Summary

Maintainability
B
4 hrs
Test Coverage

Method safeUp has 40 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function safeUp()
    {
        $tablesCreated = false;
        $tableSchema = Craft::$app->db->schema->getTableSchema(RedirectRecord::tableName());
        if ($tableSchema === null) {
Severity: Minor
Found in src/migrations/m191114_201532_addRedirectsTable.php - About 1 hr to fix

    Avoid using static access to class '\studioespresso\seofields\records\RedirectRecord' in method 'safeUp'.
    Open

                    RedirectRecord::tableName(),

    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 using static access to class '\studioespresso\seofields\records\RedirectRecord' in method 'safeUp'.
    Open

                    RedirectRecord::tableName(),

    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 using static access to class '\studioespresso\seofields\records\RedirectRecord' in method 'safeUp'.
    Open

            $tableSchema = Craft::$app->db->schema->getTableSchema(RedirectRecord::tableName());

    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 using static access to class '\studioespresso\seofields\records\RedirectRecord' in method 'safeUp'.
    Open

                    $this->db->getForeignKeyName(RedirectRecord::tableName(), 'siteId'),

    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 using static access to class '\studioespresso\seofields\records\NotFoundRecord' in method 'safeUp'.
    Open

                    $this->db->getForeignKeyName(NotFoundRecord::tableName(), 'redirect'),

    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 using static access to class '\studioespresso\seofields\records\NotFoundRecord' in method 'safeUp'.
    Open

                    NotFoundRecord::tableName(),

    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

    Define a constant instead of duplicating this literal "redirect" 3 times.
    Open

                        'redirect' => $this->string(255)->notNull(),

    Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

    On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

    Noncompliant Code Example

    With the default threshold of 3:

    function run() {
      prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
      execute('action1');
      release('action1');
    }
    

    Compliant Solution

    ACTION_1 = 'action1';
    
    function run() {
      prepare(ACTION_1);
      execute(ACTION_1);
      release(ACTION_1);
    }
    

    Exceptions

    To prevent generating some false-positives, literals having less than 5 characters are excluded.

    Define a constant instead of duplicating this literal "siteId" 3 times.
    Open

                        'siteId' => $this->integer(11)->defaultValue(null),

    Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

    On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

    Noncompliant Code Example

    With the default threshold of 3:

    function run() {
      prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
      execute('action1');
      release('action1');
    }
    

    Compliant Solution

    ACTION_1 = 'action1';
    
    function run() {
      prepare(ACTION_1);
      execute(ACTION_1);
      release(ACTION_1);
    }
    

    Exceptions

    To prevent generating some false-positives, literals having less than 5 characters are excluded.

    Reference to static property app from undeclared class \Craft
    Open

            $tableSchema = Craft::$app->db->schema->getTableSchema(RedirectRecord::tableName());

    Call to undeclared method \studioespresso\seofields\migrations\m191114_201532_addRedirectsTable::uid
    Open

                        'uid' => $this->uid(),

    Call to undeclared method \studioespresso\seofields\migrations\m191114_201532_addRedirectsTable::integer
    Open

                        'siteId' => $this->integer(11)->defaultValue(null),

    Call to undeclared method \studioespresso\seofields\migrations\m191114_201532_addRedirectsTable::addForeignKey
    Open

                $this->addForeignKey(

    Call to undeclared method \studioespresso\seofields\migrations\m191114_201532_addRedirectsTable::addForeignKey
    Open

                $this->addForeignKey(

    Call to undeclared method \studioespresso\seofields\migrations\m191114_201532_addRedirectsTable::string
    Open

                        'pattern' => $this->string(255)->notNull(),

    Call to undeclared method \studioespresso\seofields\migrations\m191114_201532_addRedirectsTable::string
    Open

                        'matchType' => $this->string(),

    Call to undeclared method \studioespresso\seofields\migrations\m191114_201532_addRedirectsTable::primaryKey
    Open

                        'id' => $this->primaryKey(),

    Call to undeclared method \studioespresso\seofields\migrations\m191114_201532_addRedirectsTable::string
    Open

                        'redirect' => $this->string(255)->notNull(),

    Call to undeclared method \studioespresso\seofields\migrations\m191114_201532_addRedirectsTable::bigInteger
    Open

                        'counter' => $this->bigInteger(),

    Call to undeclared method \studioespresso\seofields\migrations\m191114_201532_addRedirectsTable::integer
    Open

                        'method' => $this->integer(3)->notNull(),

    Call to undeclared method \studioespresso\seofields\migrations\m191114_201532_addRedirectsTable::dateTime
    Open

                        'dateUpdated' => $this->dateTime()->notNull(),

    Reference to undeclared property \studioespresso\seofields\migrations\m191114_201532_addRedirectsTable->db
    Open

                    $this->db->getForeignKeyName(NotFoundRecord::tableName(), 'redirect'),

    Call to undeclared method \studioespresso\seofields\migrations\m191114_201532_addRedirectsTable::string
    Open

                        'sourceMatch' => $this->string(),

    Class extends undeclared class \craft\db\Migration
    Open

    class m191114_201532_addRedirectsTable extends Migration

    Call to undeclared method \studioespresso\seofields\migrations\m191114_201532_addRedirectsTable::createTable
    Open

                $this->createTable(

    Reference to undeclared property \studioespresso\seofields\migrations\m191114_201532_addRedirectsTable->db
    Open

                    $this->db->getForeignKeyName(RedirectRecord::tableName(), 'siteId'),

    Call to undeclared method \studioespresso\seofields\migrations\m191114_201532_addRedirectsTable::dateTime
    Open

                        'dateLastHit' => $this->dateTime(),

    Call to undeclared method \studioespresso\seofields\migrations\m191114_201532_addRedirectsTable::dateTime
    Open

                        'dateCreated' => $this->dateTime()->notNull(),

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

                $this->createTable(
                    RedirectRecord::tableName(),
                    [
                        'id' => $this->primaryKey(),
                        'siteId' => $this->integer(11)->defaultValue(null),
    Severity: Major
    Found in src/migrations/m191114_201532_addRedirectsTable.php and 1 other location - About 3 hrs to fix
    src/migrations/Install.php on lines 82..98

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

    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

    The class m191114_201532_addRedirectsTable is not named in CamelCase.
    Open

    class m191114_201532_addRedirectsTable extends Migration
    {
        /**
         * @inheritdoc
         */

    CamelCaseClassName

    Since: 0.2

    It is considered best practice to use the CamelCase notation to name classes.

    Example

    class class_name {
    }

    Source

    Class name "m191114_201532_addRedirectsTable" is not in camel caps format
    Open

    class m191114_201532_addRedirectsTable extends Migration

    There are no issues that match your filters.

    Category
    Status