Lechimp\Dicto\Rules\Relation

Complexity

Total Complexity

11

Size/Duplication

Total Lines	137
Duplicated Lines	53.28 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

87%

Importance

Changes	11
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	fetch_arguments()	0	4	1
A	arguments_are_valid()	0	9	3
A	pprint()	0	3	1
B	compile()	73	81	4
A	insert_relation_into()	0	13	2

<?php
/******************************************************************************
 * An implementation of dicto (scg.unibe.ch/dicto) in and for PHP.
 *
 * Copyright (c) 2016 Richard Klees <richard.klees@rwth-aachen.de>
 *
 * This software is licensed under The MIT License. You should have received
 * a copy of the license along with the code.
 */

namespace Lechimp\Dicto\Rules;

use Lechimp\Dicto\Analysis\Query;
use Lechimp\Dicto\Definition\ArgumentParser;
use Lechimp\Dicto\Indexer\Insert;
use Lechimp\Dicto\Indexer\Location;
use Lechimp\Dicto\Variables\Variable;

/**
 * This is a rule that checks a relation between two entities
 * in the code.
 *
 * TODO: Test if relation can be used for files.
 */
abstract class Relation extends Schema {
    /**
     * @inheritdoc
     */
    public function fetch_arguments(ArgumentParser $parser) {
        $var = $parser->fetch_variable();
        return array($var);
    }

    /**
     * @inheritdoc
     */
    public function arguments_are_valid(array &$arguments) {
         if (count($arguments) != 1) {
            return false;
        }
        if (!($arguments[0] instanceof Variable)) {
            return false;
        }
        return true;
    }

    /**
     * @inheritdoc
     */
    public function pprint(Rule $rule) {
        return $this->name()." ".$rule->argument(0)->name();
    }

    /**
     * @inheritdoc
     */
    public function compile(Query $query, Rule $rule) {
        $builder = $query->builder();
        $b = $builder->expr();
        $mode = $rule->mode();
        $name_left = $rule->checked_on();
        $name_right = $rule->argument(0);
        if ($mode == Rule::MODE_CANNOT || $mode == Rule::MODE_ONLY_CAN) {

This code seems to be duplicated across your project.

            return $builder

The expression $builder->select('rel.name_left', 'rel.name_right', 'f.path as file', 'rel.line as line', 'src.source as source')->from($query->relation_table(), 'rel')->join('rel', $query->file_table(), 'f', $b->eq('rel.file', 'f.id'))->join('rel', $query->name_table(), 'nl', $b->eq('rel.name_left', 'nl.id'))->join('rel', $query->name_table(), 'nr', $b->eq('rel.name_right', 'nr.id'))->join('rel', $query->source_table(), 'src', $b->andX($b->eq('src.line', 'rel.line'), $b->eq('src.file', 'rel.file')))->where($b->eq('rel.which', $b->literal($this->name())), $name_left->compile($b, 'nl'), $name_right->compile($b, 'nr'))->execute(); of type Doctrine\DBAL\Driver\Statement|integer adds the type integer to the return on line 64 which is incompatible with the return type declared by the abstract method Lechimp\Dicto\Rules\Schema::compile of type Doctrine\DBAL\Driver\Statement.

                ->select
                    ( "rel.name_left"
                    , "rel.name_right"
                    , "f.path as file"
                    , "rel.line as line"
                    , "src.source as source"
                    )
                ->from($query->relation_table(), "rel")
                ->join
                    ( "rel", $query->file_table(), "f"
                    , $b->eq("rel.file", "f.id")
                    )
                ->join
                    ( "rel", $query->name_table(), "nl"
                    , $b->eq("rel.name_left", "nl.id")
                    )
                ->join
                    ( "rel", $query->name_table(), "nr"
                    , $b->eq("rel.name_right", "nr.id")
                    )
                ->join
                    ( "rel", $query->source_table(), "src"
                    , $b->andX
                        ( $b->eq("src.line", "rel.line")
                        , $b->eq("src.file", "rel.file")
                        )
                    )
                ->where
                    ( $b->eq("rel.which", $b->literal($this->name()))
                    , $name_left->compile($b, "nl")
                    , $name_right->compile($b, "nr")
                    )
                ->execute();
        }
        if ($mode == Rule::MODE_MUST) {

This code seems to be duplicated across your project.

            return $builder
                ->select
                    ( "d.name"
                    , "f.path as file"
                    , "d.start_line as line"
                    , "src.source as source"
                    )
                ->from($query->definition_table(), "d")
                ->join
                    ( "d", $query->file_table(), "f"
                    , $b->eq("d.file", "f.id")
                    )
                ->join
                    ( "d", $query->name_table(), "n"
                    , $b->eq("d.name", "n.id")
                    )
                ->leftJoin
                    ("d", $query->relation_table(), "rel"
                    , $b->andX
                        ( $b->eq("rel.which", $b->literal($this->name()))
                        , $b->eq("rel.name_left", "d.name")
                        )
                    )
                ->innerJoin
                    ( "d", $query->source_table(), "src"
                    , $b->andX
                        ( $b->eq("src.line", "d.start_line")
                        , $b->eq("src.file", "d.file")
                        )
                    )
                ->where
                    ( $name_left->compile($b, "n")
                    , $b->isNull("rel.name_right")
                    )
                ->execute();
        }
        throw new \LogicException("Unknown rule mode: '$mode'");
    }

    /**
     * Insert this relation somewhere, where it is recorded for all
     * entities that the current location is in.
     *
     * @param   Insert      $insert
     * @param   Location    $location
     * @param   int         $name_id
     * @return  null
     */
    protected function insert_relation_into(Insert $insert, Location $location, $name_id, $line) {
        assert('is_int($name_id)');
        assert('is_int($line)');
        foreach ($location->in_entities() as $entity) {
            $insert->relation
                ( $entity[1]
                , $name_id
                , $this->name()
                , $location->file_path()
                , $line
                );
        }
    }
}