Lechimp\Dicto\App\App

Complexity

Total Complexity

26

Size/Duplication

Total Lines	272
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	18

Test Coverage

Coverage

94.49%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	run()	0	21	2
A	configure_runtime()	0	12	2
A	load_configs()	0	14	4
A	load_schemas()	0	11	3
A	load_properties()	0	11	3
A	load_variables()	0	11	3
B	build_report_generator()	0	20	5
A	result_database_path()	0	3	1
B	create_dic()	0	106	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\App;

use Lechimp\Dicto\Analysis\CombinedReportGenerators;
use Lechimp\Dicto\Analysis\ReportGenerator;
use Lechimp\Dicto\App\RuleLoader;
use Lechimp\Dicto\Definition\RuleParser;
use Lechimp\Dicto\Rules\Ruleset;
use Lechimp\Dicto\Rules as R;
use Lechimp\Dicto\Variables as V;
use Symfony\Component\Yaml\Yaml;
use Pimple\Container;
use PhpParser\ParserFactory;

/**
 * The App to be run from a script.
 */
class App {
    public function __construct() {
        ini_set('xdebug.max_nesting_level', 200);
    }

    /**
     * Run the app.
     *
     * @param   array   $params     from commandline
     * @return  null
     */
    public function run(array $params) {
        if (count($params) < 2) {
            throw new \RuntimeException(
                "Expected path to config-file as first parameter.");
        }

        // drop program name
        array_shift($params);

        // the rest of the params are paths to configs
        list($config_file_path, $configs) = $this->load_configs($params);
        $t = explode("/", $config_file_path);
        array_pop($t);
        $config_file_path = implode("/", $t);

        $dic = $this->create_dic($config_file_path, $configs);

        $this->configure_runtime($dic["config"]);

        $dic["engine"]->run();
    }

    /**
     * Create and initialize the DI-container.
     *
     * @param   string      $config_file_path
     * @param   array       &$configs
     * @return  Container
     */
    protected function create_dic($config_file_path, array &$configs) {
        array('is_string($rule_file_path)');

        $container = new Container();

        $container["config"] = function () use ($config_file_path, &$configs) {
            return new Config($config_file_path, $configs);
        };

        $container["ruleset"] = function($c) {
            $rule_file_path = $c["config"]->project_rules();
            if (!file_exists($rule_file_path)) {
                throw new \RuntimeException("Unknown rule-file '$rule_file_path'");
            }
            $ruleset = $c["rule_loader"]->load_rules_from($rule_file_path);
            return $ruleset;
        };

        $container["rule_loader"] = function($c) {
            return new RuleLoader($c["rule_parser"]);
        };

        $container["rule_parser"] = function($c) {
            return new RuleParser
                ( $c["variables"]
                , $c["schemas"]
                , $c["properties"]
                );
        };

        $container["engine"] = function($c) {
            return new Engine
                ( $c["log"]
                , $c["config"]
                , $c["database_factory"]
                , $c["indexer_factory"]
                , $c["analyzer_factory"]
                , $c["report_generator"]
                , $c["source_status"]
                );
        };

        $container["log"] = function () {
            return new CLILogger();
        };

        $container["database_factory"] = function() {
            return new DBFactory();
        };

        $container["indexer_factory"] = function($c) {
            return new \Lechimp\Dicto\Indexer\IndexerFactory
                ( $c["log"]
                , $c["php_parser"]
                , array
                    ( new \Lechimp\Dicto\Rules\ContainText()
                    , new \Lechimp\Dicto\Rules\DependOn()
                    , new \Lechimp\Dicto\Rules\Invoke()
                    )
                );
        };

        $container["analyzer_factory"] = function($c) {
            return new \Lechimp\Dicto\Analysis\AnalyzerFactory
                ( $c["log"]
                , $c["ruleset"]
                );
        };

        $container["php_parser"] = function() {
            $lexer = new \PhpParser\Lexer\Emulative
                (["usedAttributes" => ["comments", "startLine", "endLine", "startFilePos"]]);
            return (new ParserFactory)->create(ParserFactory::PREFER_PHP7, $lexer);
        };

        $container["report_generator"] = function($c) {
            return $this->build_report_generator($c);
        };

        $container["stdout_report_generator"] = function() {
            return new CLIReportGenerator();
        };

        $container["database_report_generator"] = function($c) {
            $path = $this->result_database_path($c["config"]);
            return $c["database_factory"]->get_result_db($path);
        };

        $container["source_status"] = function($c) {
            return new SourceStatusGit($c["config"]->project_root());
        };

        $container["schemas"] = function($c) {
            return $this->load_schemas($c["config"]->rules_schemas());
        };

        $container["properties"] = function($c) {
            return $this->load_properties($c["config"]->rules_properties());
        };

        $container["variables"] = function($c) {
            return $this->load_variables($c["config"]->rules_variables());
        };

        return $container;
    }

    /**
     * Configure php runtime.
     *
     * @param   Config  $config
     * @return  null
     */
    protected function configure_runtime(Config $config) {
        if ($config->runtime_check_assertions()) {
            assert_options(ASSERT_ACTIVE, true);
            assert_options(ASSERT_WARNING, true);
            assert_options(ASSERT_BAIL, false);
        }
        else {
            assert_options(ASSERT_ACTIVE, false);
            assert_options(ASSERT_WARNING, false);
            assert_options(ASSERT_BAIL, false);
        }
    }

    /**
     * Load extra configs from yaml files.
     *
     * @param   array   $config_file_paths
     * @return  array
     */
    protected function load_configs(array $config_file_paths) {
        $configs_array = array();
        $config_file_path = null;
        foreach ($config_file_paths as $config_file) {
            if (!file_exists($config_file)) {
                throw new \RuntimeException("Unknown config-file '$config_file'");
            }
            if ($config_file_path === null) {
                $config_file_path = $config_file;
            }
            $configs_array[] = Yaml::parse(file_get_contents($config_file));
        }
        return array($config_file_path, $configs_array);
    }

    /**
     * Loads the schemas defined in the config.
     *
     * @param   array   $schema_classes
     * @return  R\Schema[]
     */
    protected function load_schemas(array $schema_classes) {
        $schemas = array();
        foreach ($schema_classes as $schema_class) {
            $schema = new $schema_class;
            if (!($schema instanceof R\Schema)) {
                throw new \RuntimeException("'$schema_class' is not a Schema-class.");
            }
            $schemas[] = $schema;
        }
        return $schemas;
    }

    /**
     * Loads the properties defined in the config.
     *
     * @param   array   $property_classes
     * @return  R\Schema[]
     */
    protected function load_properties(array $property_classes) {
        $properties = array();
        foreach ($property_classes as $property_class) {
            $property = new $property_class;
            if (!($property instanceof V\Property)) {
                throw new \RuntimeException("'$property_class' is not a Schema-class.");
            }
            $properties[] = $property;
        }
        return $properties;
    }

    /**
     * Loads the variables defined in the config.
     *
     * @param   array   $variable_classes
     * @return  R\Schema[]
     */
    protected function load_variables(array $variable_classes) {
        $variables = array();
        foreach ($variable_classes as $variable_class) {
            $variable = new $variable_class;
            if (!($variable instanceof V\Variable)) {
                throw new \RuntimeException("'$variable_class' is not a Schema-class.");
            }
            $variables[] = $variable;
        }
        return $variables;
    }

    /**
     * Build the report generators.
     *
     * @param   Container       $c
     * @return  ReportGenerator
     */
    public function build_report_generator(Container $c) {
        $config = $c["config"];
        $stdout = $config->analysis_report_stdout();
        $db = $config->analysis_report_database();
        if ($stdout && $db) {
            return new CombinedReportGenerators
                ([$c["stdout_report_generator"]
                , $c["database_report_generator"]
                ]);
        }
        elseif($stdout) {
            return $c["stdout_report_generator"];
        }
        elseif($db) {
            return $c["database_report_generator"];
        }

        throw new \RuntimeException
            ("No need to run analysis if no report generator is defined.");
    }

    protected function result_database_path(Config $c) {
        return $c->project_storage()."/results.sqlite";
    }
}