Lechimp\Dicto\App\Engine

Complexity

Total Complexity

10

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	11

Test Coverage

Coverage

90.2%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	16	1
A	run()	0	19	3
A	index_database_path()	0	4	1
A	run_indexing()	0	8	1
A	run_analysis()	0	8	1
A	build_index()	0	3	1
A	write_index_to()	0	3	1
A	read_index_from()	0	3	1

<?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\App;

use Lechimp\Dicto\Indexer\IndexerFactory;
use Lechimp\Dicto\Analysis\ReportGenerator;
use Lechimp\Dicto\Analysis\AnalyzerFactory;
use Lechimp\Dicto\Analysis\Index;
use Lechimp\Dicto\Indexer\Insert;
use Lechimp\Dicto\Graph;
use Psr\Log\LoggerInterface as Log;

/**
 * The Engine of the App drives the analysis process.
 */
class Engine {
    /**
     * @var Log
     */
    protected $log;

    /**
     * @var Config
     */
    protected $config;

    /**
     * @var DBFactory
     */
    protected $db_factory;

    /**
     * @var IndexerFactory
     */
    protected $indexer_factory;

    /**
     * @var AnalyzerFactory
     */
    protected $analyzer_factory;

    /**
     * @var ReportGenerator
     */
    protected $report_generator;

    /**
     * @var SourceStatus
     */
    protected $source_status;

    public function __construct( Log $log
                               , Config $config
                               , DBFactory $db_factory
                               , IndexerFactory $indexer_factory
                               , AnalyzerFactory $analyzer_factory
                               , ReportGenerator $report_generator
                               , SourceStatus $source_status
                               ) {
        $this->log = $log;
        $this->config = $config;
        $this->db_factory = $db_factory;
        $this->indexer_factory = $indexer_factory;
        $this->analyzer_factory = $analyzer_factory;
        $this->report_generator = $report_generator;
        $this->source_status = $source_status;
    }

    /**
     * Run the analysis.
     * 
     * @return null
     */
    public function run() {
        $index_db_path = $this->index_database_path();
        if (!$this->db_factory->index_db_exists($index_db_path)) {
            $index = $this->build_index();
            $this->run_indexing($index);

            if ($this->config->analysis_store_index()) {
                $index_db = $this->db_factory->build_index_db($index_db_path);
                $this->log->notice("Writing index to database '$index_db_path'...");
                $this->write_index_to($index, $index_db);
            }
        }
        else {
            $index_db = $this->db_factory->load_index_db($index_db_path);
            $this->log->notice("Reading index from database '$index_db_path'...");
            $index = $this->read_index_from($index_db);
        }
        $this->run_analysis($index);
    }

    protected function index_database_path() {
        $commit_hash = $this->source_status->commit_hash();
        return $this->config->project_storage()."/$commit_hash.sqlite";
    }

    protected function run_indexing(Insert $index) {
        $this->log->notice("Starting to build index...");
        $indexer = $this->indexer_factory->build($index);
        $indexer->index_directory
            ( $this->config->project_root()
            , $this->config->analysis_ignore()
            );
    }

    protected function run_analysis(Index $index) {
        $this->log->notice("Running analysis...");
        $commit_hash = $this->source_status->commit_hash();
        $this->report_generator->begin_run($commit_hash);
        $analyzer = $this->analyzer_factory->build($index, $this->report_generator);
        $analyzer->run();
        $this->report_generator->end_run();
    }

    protected function build_index() {
        return new Graph\IndexDB;
    }

    protected function write_index_to(Graph\IndexDB $index, IndexDB $db) {
        $db->write_index($index);
    }

    protected function read_index_from(IndexDB $db) {
        return $db->read_index();
    }
}