Rework code structure, improve code quality (#19)

.gitignore

@@ -1,9 +1,11 @@
 .php-cs-fixer.cache
 .phpintel
 .phpunit.result.cache
-bower_components
 build
+combustor.bak
+combustor.yml
 composer.lock
-docs
-node_modules
+tests/Fixture/Sample/controllers
+tests/Fixture/Sample/models
+tests/Fixture/Sample/views
 vendor

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to `Combustor` will be documented in this file.
 
+## [1.3.0](https://github.com/rougin/transcribe/compare/v1.2.4...v1.3.0) - Unreleased
+
+### Changed
+- Minimum version of PHP to `v5.3.0`
+- Code documentation by `php-cs-fixer`, code quality by `phpstan`
+- Workflow from `Travis CI` to `Github Actions`
+- Code coverage from `Scrutinizer CI` to `Codecov`
+
+### Removed
+- `CONTRIBUTING.md`
+
 ## [1.2.4](https://github.com/rougin/combustor/compare/v1.2.3...v1.2.4) - 2018-04-18
 
 ### Fixed

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Rougin Gutib
+Copyright (c) Rougin Gutib
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

bin/combustor

@@ -1,5 +1,22 @@
 #!/usr/bin/env php
 <?php
 
-// Load and run the Combustor application
-require 'combustor.php';
+use Rougin\Combustor\Console;
+
+// Return the root directory of the project ------------
+$vendor = (string) __DIR__ . '/../../../../';
+
+$exists = file_exists($vendor . '/vendor/autoload.php');
+
+$root = $exists ? $vendor : __DIR__ . '/../';
+// -----------------------------------------------------
+
+// Load the Composer autoloader -------
+require $root . '/vendor/autoload.php';
+// ------------------------------------
+
+$app = new Console($root);
+
+// Run the console application ---
+$app->run();
+// -------------------------------

composer.json

@@ -15,10 +15,11 @@
   ],
   "require":
   {
-    "php": ">=5.4.0",
-    "rougin/blueprint": "~0.1",
-    "rougin/describe": "~1.4",
-    "rougin/spark-plug": "~0.4"
+    "php": ">=5.3.0",
+    "rougin/blueprint": "dev-master",
+    "rougin/classidy": "dev-master",
+    "rougin/describe": "dev-master",
+    "rougin/spark-plug": "dev-master"
   },
   "require-dev":
   {
@@ -28,8 +29,7 @@
   },
   "bin":
   [
-    "bin/combustor",
-    "bin/combustor.php"
+    "bin/combustor"
   ],
   "autoload":
   {
@@ -60,7 +60,7 @@
   {
     "rougin/codeigniter": "Codeigniter 3's Composer-based package.",
     "rougin/credo": "A Doctrine ORM wrapper for Codeigniter 3.",
-    "rougin/ignite": "A Codeigniter 3 project based on Composer.",
+    "rougin/ignite": "A Composer-based Codeigniter 3 project.",
     "rougin/refinery": "\"Ready-to-eat\" migrations for Codeigniter 3.",
     "rougin/wildfire": "A Query Builder wrapper for Codeigniter 3."
   }

phpstan.neon

@@ -5,12 +5,18 @@ parameters:
     - tests
   excludePaths:
     analyse:
-      - tests/Weblog/application/views
+      - tests/Fixture/Plates
+      - tests/Fixture/Sample/controllers
+      - tests/Fixture/Sample/models
+      - tests/Fixture/Sample/views
   scanDirectories:
     - vendor/rougin/codeigniter/src
   ignoreErrors:
-    - '#^Call to an undefined method Rougin\\Wildfire\\Wildfire\:\:test\(\)\.$#'
-    - '#^Access to an undefined property CI_Controller\:\:\$db\.$#'
-    - '#^Access to an undefined property CI_Controller\:\:\$user\.$#'
+    - '#^Access to property \$database on an unknown class CI_DB\.$#'
+    - '#^Access to property \$dbdriver on an unknown class CI_DB\.$#'
+    - '#^Access to property \$dsn on an unknown class CI_DB\.$#'
+    - '#^Access to property \$hostname on an unknown class CI_DB\.$#'
+    - '#^Access to property \$password on an unknown class CI_DB\.$#'
+    - '#^Access to property \$username on an unknown class CI_DB\.$#'
     - '#^Constant APPPATH not found\.$#'
     - '#^Constant ENVIRONMENT not found\.$#'

src/Combustor.php

@@ -0,0 +1,89 @@
+<?php
+
+namespace Rougin\Combustor;
+
+use Rougin\Describe\Driver\DriverInterface;
+use Rougin\SparkPlug\Controller;
+
+/**
+ * @package Combustor
+ *
+ * @author Rougin Gutib <rougingutib@gmail.com>
+ */
+class Combustor
+{
+    /**
+     * @var \Rougin\SparkPlug\Controller|null
+     */
+    protected $app = null;
+
+    /**
+     * @var \Rougin\Describe\Driver\DriverInterface|null
+     */
+    protected $driver = null;
+
+    /**
+     * @var string
+     */
+    protected $root;
+
+    /**
+     * @param string $root
+     */
+    public function __construct($root)
+    {
+        $this->root = $root;
+    }
+
+    /**
+     * @return string
+     */
+    public function getAppPath()
+    {
+        $app = $this->root . '/application';
+
+        $root = $this->getRootPath();
+
+        return is_dir($app) ? $app : $root;
+    }
+
+    /**
+     * @return \Rougin\Describe\Driver\DriverInterface|null
+     */
+    public function getDriver()
+    {
+        return $this->driver;
+    }
+
+    /**
+     * @return string
+     */
+    public function getRootPath()
+    {
+        return $this->root;
+    }
+
+    /**
+     * @param \Rougin\SparkPlug\Controller $app
+     *
+     * @return self
+     */
+    public function setApp(Controller $app)
+    {
+        $this->app = $app;
+
+        return $this;
+    }
+
+    /**
+     * @param \Rougin\Describe\Driver\DriverInterface $driver
+     *
+     * @return self
+     */
+    public function setDriver(DriverInterface $driver)
+    {
+        $this->driver = $driver;
+
+        return $this;
+    }
+}