Merge pull request #27 from leafsphp/feat/schema-module

Feat/schema module

Author: mychidarko

README.md

@@ -11,32 +11,21 @@
 [![Total Downloads](https://poser.pugx.org/leafs/mvc-core/downloads)](https://packagist.org/packages/leafs/mvc-core)
 [![License](https://poser.pugx.org/leafs/mvc-core/license)](https://packagist.org/packages/leafs/mvc-core)
 
-Leaf MVC Core is the heart of Leaf MVC and serves as bridge between Leaf, modules and the MVC file structure. It provides a ton of extra functionality like extra globals, classes and methods that help with separation of concerns and building a full-blown MVC application with Leaf.
+Leaf MVC Core is the heart of Leaf MVC and serves as bridge between Leaf, modules and the MVC file structure. It provides a ton of extra functionality like extra globals, classes, console commands and methods that help with separation of concerns and building a full-blown MVC application with Leaf.
 
-## 📦 Installation
+It ships with all Leaf MVC applications and is not meant to be used on its own.
 
-You can quickly get leaf mvc core up and running with the leaf cli
-
-```sh
-leaf install mvc-core
-```
-
-or with composer
-
-```bash
-composer require leafs/mvc-core
-```
-
-## 🧩 Components
+## 🧩 Features
 
 MVC Core comes with:
 
-- Controllers
-- Database & Model functionalities
-- Tons of MVC and module globals
+- Base Controllers
+- Shortcuts for views and layouts
+- Console commands for generating files/layouts/modules
+- Automatic module loading
+- Config loading for MVC apps
 - Autoloading directory files
-
-Since you don't use this package on its own, the documentation is covered in the [Leaf MVC documentation](https://leafphp.dev/docs/mvc/).
+- Basically everything that gives Leaf it's MVC superpowers
 
 ## 💬 Stay In Touch
 

composer.json

@@ -35,11 +35,13 @@
     "prefer-stable": true,
     "require": {
         "leafs/leaf": "*",
-        "vlucas/phpdotenv": "^5.4",
-        "illuminate/database": "^8.75|^10.0|^12.0",
-        "illuminate/events": "^8.75|^10.0|^12.0",
-        "symfony/yaml": "^5.4|^6.4",
-        "leafs/db": "*"
+        "vlucas/phpdotenv": "*",
+        "illuminate/support": "*",
+        "illuminate/database": "*",
+        "illuminate/events": "*",
+        "symfony/yaml": "*",
+        "leafs/db": "*",
+        "leafs/sprout": "^0.7.0"
     },
     "require-dev": {
         "fakerphp/faker": "^1.24"

src/Commands/AppDownCommand.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Leaf\Commands;
+
+use Leaf\Sprout\Command;
+
+class AppDownCommand extends Command
+{
+    protected $signature = 'app:down';
+    protected $description = 'Place app in maintenance mode';
+    protected $help = 'Set app in maintenance mode';
+
+    protected function handle()
+    {
+        $file = getcwd() . DIRECTORY_SEPARATOR . '.env';
+
+        $fileContent = file_get_contents($file);
+        $fileContent = str_replace(
+            ['APP_DOWN=false', 'APP_DOWN = false'],
+            'APP_DOWN=true',
+            $fileContent
+        );
+
+        file_put_contents($file, $fileContent);
+
+        $this->comment('App now running in down mode...');
+        $this->info('You might need to restart your server to see changes');
+
+        return 0;
+    }
+}

src/Commands/AppUpCommand.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Leaf\Commands;
+
+use Leaf\Sprout\Command;
+
+class AppUpCommand extends Command
+{
+    protected $signature = 'app:up';
+    protected $description = 'Remove app from maintenance mode';
+    protected $help = 'Set app in normal mode';
+
+    protected function handle()
+    {
+        $env = getcwd() . DIRECTORY_SEPARATOR . '.env';
+
+        $envContent = file_get_contents($env);
+        $envContent = str_replace(
+            ['APP_DOWN=true', 'APP_DOWN = true'],
+            'APP_DOWN=false',
+            $envContent
+        );
+
+        file_put_contents($env, $envContent);
+
+        $this->comment('App is now out of down mode...');
+        $this->info('You might need to restart your server to see changes');
+
+        return 0;
+    }
+}

src/Commands/ConfigLibCommand.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Leaf\Commands;
+
+use Leaf\Sprout\Command;
+
+class ConfigLibCommand extends Command
+{
+    protected $signature = 'config:lib';
+    protected $description = 'Setup Leaf MVC to use external libraries';
+    protected $help = 'Setup Leaf MVC to use external libraries';
+
+    protected function handle()
+    {
+        $directory = getcwd() . DIRECTORY_SEPARATOR . LibPath();
+
+        if (!\Leaf\FS\Directory::exists($directory)) {
+            \Leaf\FS\Directory::create($directory);
+        }
+
+        $this->comment('lib folder setup successfully!');
+
+        return 0;
+    }
+}

src/Commands/ConfigPublishCommand.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Leaf\Commands;
+
+use Leaf\Sprout\Command;
+
+class ConfigPublishCommand extends Command
+{
+    protected $signature = 'config:publish {config? : Config file to publish}';
+    protected $description = 'Publish config files to your project';
+    protected $help = 'Publish config files to your project';
+
+    protected function handle()
+    {
+        $configDir = getcwd() . DIRECTORY_SEPARATOR . ConfigPath();
+
+        if (!\Leaf\FS\Directory::exists($configDir)) {
+            \Leaf\FS\Directory::create($configDir);
+        }
+
+        $config = $this->argument('config');
+        $configFiles = \Leaf\FS\Directory::files(__DIR__ . '/stubs/config');
+
+        foreach ($configFiles as $file) {
+            if ($config && $file !== "$config.php") {
+                continue;
+            }
+
+            \Leaf\FS\File::copy(
+                __DIR__ . "/stubs/config/$file",
+                getcwd() . DIRECTORY_SEPARATOR . ConfigPath($file),
+                ['recursive' => true, 'overwrite' => true]
+            );
+        }
+
+        $this->comment('Config published successfully!');
+
+        return 0;
+    }
+}

src/Commands/DeleteControllerCommand.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Leaf\Commands;
+
+use Leaf\Sprout\Command;
+use Illuminate\Support\Str;
+
+class DeleteControllerCommand extends Command
+{
+    protected $signature = 'd:controller {controller : The name of the controller}';
+    protected $description = 'Delete a controller';
+    protected $help = 'Delete a controller';
+
+    protected function handle()
+    {
+        $controller = Str::studly($this->argument('controller'));
+
+        if (!strpos($controller, 'Controller')) {
+            $controller = str::plural($controller);
+            $controller .= 'Controller';
+        }
+
+        $controllerFile = getcwd() . DIRECTORY_SEPARATOR . ControllersPath("$controller.php");
+
+        if (!\Leaf\FS\File::exists($controllerFile)) {
+            $this->error("$controller doesn't exist!");
+            return 1;
+        }
+
+        if (!\Leaf\FS\File::delete($controllerFile)) {
+            $this->error("Couldn't delete $controllerFile, you might need to remove it manually.");
+            return 1;
+        }
+
+        $this->comment("$controller deleted successfully");
+
+        return 0;
+    }
+}

src/Commands/DevToolsCommand.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace Leaf\Commands;
+
+use Leaf\Sprout\Command;
+
+class DevToolsCommand extends Command
+{
+    protected $signature = 'devtools:install';
+    protected $description = 'Install the Leaf PHP devtools';
+    protected $help = 'Install the leaf PHP Dev tools';
+
+    protected function handle()
+    {
+        $this->comment('Installing leaf devtools...');
+
+        if (sprout()->composer()->install('leafs/devtools')->getExitCode() !== 0) {
+            $this->error('Failed to install leaf devtools via composer. Please run "composer require leafs/devtools" manually.');
+            return 1;
+        }
+
+        $this->comment('Installing leaf devtools routes...');
+
+        $rootFilePath = getcwd() . DIRECTORY_SEPARATOR . PublicPath('index.php');
+        $rootFile = str_replace(
+            "/*
+|--------------------------------------------------------------------------
+| Install the devtools
+|--------------------------------------------------------------------------
+|
+| Add Leaf devtools routes and config
+|
+*/
+\Leaf\DevTools::install();",
+            '',
+            \Leaf\FS\File::read($rootFilePath)
+        );
+
+        $rootFile = str_replace(
+            ["require dirname(__DIR__) . '/vendor/autoload.php';", 'require "$appPath/vendor/autoload.php"'],
+            "require dirname(__DIR__) . '/vendor/autoload.php';
+
+/*
+|--------------------------------------------------------------------------
+| Install the devtools
+|--------------------------------------------------------------------------
+|
+| Add Leaf devtools routes and config
+|
+*/
+\Leaf\DevTools::install();",
+            $rootFile
+        );
+
+        $rootFile = str_replace("\n\n\n", "\n", $rootFile);
+
+        \Leaf\FS\File::write($rootFilePath, $rootFile);
+
+        $this->info('Leaf devtools installed successfully!');
+
+        return 0;
+    }
+}

src/Commands/EnvGenerateCommand.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Leaf\Commands;
+
+use Leaf\Sprout\Command;
+
+class EnvGenerateCommand extends Command
+{
+    protected $signature = 'env:generate';
+    protected $description = 'Generate .env file';
+    protected $help = 'Generate .env file';
+
+    protected function handle()
+    {
+        $envFile = getcwd() . DIRECTORY_SEPARATOR . '.env';
+        $envExampleFile = getcwd() . DIRECTORY_SEPARATOR . '.env.example';
+
+        if (file_exists($envFile)) {
+            $this->error('.env already exists');
+            return 1;
+        }
+
+        if (file_exists($envExampleFile)) {
+            if (\Leaf\FS\File::copy($envExampleFile, $envFile) || \Leaf\FS\File::copy(__DIR__ . '/stubs/.env.stub', $envFile)) {
+                $this->comment('.env generated successfully!');
+                return 0;
+            }
+        }
+
+        $this->error('Couldn\'t generate env file');
+
+        return 1;
+    }
+}

src/Commands/EnvSetCommand.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Leaf\Commands;
+
+use Leaf\Sprout\Command;
+
+class EnvSetCommand extends Command
+{
+    protected $signature = 'env:set
+        {key : The environment variable key}
+        {value : The environment variable value}';
+    protected $description = 'Set a new environment variable for your app';
+    protected $help = 'Set a new environment variable in the .env file and update .env.example if it exists.';
+
+    protected function handle()
+    {
+        $envFile = getcwd() . DIRECTORY_SEPARATOR . '.env';
+
+        if (!file_exists($envFile)) {
+            $this->comment('No .env file found. Generating one...');
+
+            if (sprout()->process('php leaf env:generate')->run() !== 0) {
+                $this->error('Couldn\'t generate .env file. Please run `php leaf env:generate` first.');
+                return 1;
+            }
+        }
+
+        \Leaf\FS\File::write($envFile, function ($env) {
+            $key = $this->argument('key');
+            $value = $this->argument('value');
+
+            if (strpos($env, $key) !== false) {
+                $this->info("$key already exists, updating value...");
+                $env = preg_replace("/^$key=(.*)/m", "$key=$value", $env);
+            } else {
+                $this->info("Setting new environment variable: $key");
+                $env .= "\n$key=$value\n";
+            }
+
+            return $env;
+        });
+
+        if (file_exists($envExampleFile = getcwd() . DIRECTORY_SEPARATOR . '.env.example')) {
+            \Leaf\FS\File::write($envExampleFile, function ($envExample) {
+                $key = $this->argument('key');
+
+                if (strpos($envExample, $key) === false) {
+                    $envExample .= "\n$key=\n";
+                }
+
+                return $envExample;
+            });
+        }
+
+        $this->info("Environment updated successfully.");
+
+        return 0;
+    }
+}