Compare commits

..

4 Commits

6 changed files with 337 additions and 28 deletions
+53 -26
View File
@@ -1,32 +1,59 @@
# Magic 2.0 <p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
Попытка ретроспективно описать этапы разработки проекта Magic 2.0.
Изначально проект реализовывался сумбурно, без структурированной фиксации каждой доработки в расчете описать всю историю перед релизом.
## Ход работ: <p align="center">
Есть текущая версия Laravel со <u>всеми</u> реализованными фичами (а также с комментариями, тестовыми настройками и прочим мусором). Была развернута голая Laravel, созданы ветки и в них добавлялись скрипты из текущей версии Laravel по принципу реализованных функциональностей. Версии Laravel отличаются, поэтому некоторые конфиги из коробки могут отличаться от конфигов из текущей версии (впрочем, вроде не критично). Также я приложил excel файл (new_magic в ветку master) к репозиторию, в котором перечислил по каким веткам я разбросал файлы, а к некоторым файлам оставил комментарии <a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
</p>
Я знаю, что это не лучший способ фиксировать историчность разработки, но выбор был между отсутствием истории и такой историей. Даже если вы не будете использовать мои разработки как основу для Magic 2.0, по крайней мере пробегитесь глазами по архитектуре и почитайте комментарии. Некоторые фичи полность готовы и могут быть перенесены, другие могут сэкономить время хотя бы за счет готового описания ## About Laravel
Не забывайте, что в Confulence тоже кое-что из реализованного уже описано Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
_Заранее извиняюсь за сумбурность и неработоспособность чего-то - можете лишить меня годовой премии_ - [Simple, fast routing engine](https://laravel.com/docs/routing).
- [Powerful dependency injection container](https://laravel.com/docs/container).
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
- [Robust background job processing](https://laravel.com/docs/queues).
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
## Ветки Laravel is accessible, powerful, and provides tools required for large, robust applications.
Ниже описание некоторых веток. В основном, они называются очевидным образом, но некоторые требуют пояснения
+ all_changes - по сути это текущая версия Magic 2.0 со всеми изменениям
+ master - голая версия Laravel, от которой наследовались все фичевые ветки
+ doubtfull - сомнительная ветка. Не уверен, что скрипты из нее нужны для запуска проекта. Возможно, конфиги, которые в новой версии Laravel не требуются для запуска
+ trash - мусорная ветка. Скрипты отсюда почти наверняка не нужны для работы проекта. Например, тестовые скрипты или пустые скрипты архитектурных сущностей, которыми мы не пользовались (вроде сидеры к ним относятся). В новых версиях ларавель они создаются не из коробки, а при вызове команды на создание сущностей
+ db_tables - набор конфигов sql таблиц и дампов с имеющимися на текущий момент записями
+ ветки, начинающиеся на **front_** или **react_** - предполагаю, что их должен проанализировать фронтендер
+ laravel_core - основные конфиги для запуска проекта
## Сборка ## Learning Laravel
Ниже опишу как бы я смотрел все эти изменения
1. Начать с версии из ветки all_changes - там вся имеющаяся функциональность Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework. You can also check out [Laravel Learn](https://laravel.com/learn), where you will be guided through building a modern Laravel application.
2. Все таблицы из db_tables экспортировать в свою локальную бд
3. Просмотрел бы верхнеуровнево все core ветки, начиная от конфигов и core функций типа logging If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
4. На голую версия накинул бы ветку laravel_core и doubtfull
5. Начал бы накидывать постепенно изменения из веток и смотреть как работает платформа. Я постарался в ветках хранить только ту информацию, которая нужна для работы конкреной функциональности, чтобы вы могли изолированно их посмотреть и даже запустить для тестов перед мержем с master. К сожалению у меня не было времени тестить каждую ветку отдельно ## Laravel Sponsors
6. В последнюю очередь накинул бы изменения из веток с реализацией страниц: magic_app_menu и taxi-app
7. Опциально: можно начать удалять скрипты из ветки doubtfull и смотреть работает ли все как надо, чтобы облегчить платформу от ненужных скриптов We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).
### Premium Partners
- **[Vehikl](https://vehikl.com)**
- **[Tighten Co.](https://tighten.co)**
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
- **[64 Robots](https://64robots.com)**
- **[Curotec](https://www.curotec.com/services/technologies/laravel)**
- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
- **[Redberry](https://redberry.international/laravel-development)**
- **[Active Logic](https://activelogic.com)**
## Contributing
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
## Code of Conduct
In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
## Security Vulnerabilities
If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
## License
The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
+8 -2
View File
@@ -3,6 +3,9 @@
namespace App\Providers; namespace App\Providers;
use Illuminate\Support\ServiceProvider; use Illuminate\Support\ServiceProvider;
use Spatie\Activitylog\Facades\CauserResolver;
use Illuminate\Support\Facades\View;
use App\Services\ModuleService;
class AppServiceProvider extends ServiceProvider class AppServiceProvider extends ServiceProvider
{ {
@@ -11,7 +14,8 @@ class AppServiceProvider extends ServiceProvider
*/ */
public function register(): void public function register(): void
{ {
// //Регистрируем передачу во все blade шаблоны функционал сервиса по определению имени модуля из текущего роута
View::share('moduleName', app(ModuleService::class));
} }
/** /**
@@ -19,6 +23,8 @@ class AppServiceProvider extends ServiceProvider
*/ */
public function boot(): void public function boot(): void
{ {
// // Глобально отключаем определение causer для корректной работы пакета activity_log. По умолчанию пакет ожидает получить экземпляр модели Models\User для прописывания в таблицу activity_log значения causer_type и causer_id. Эти значения нельзя руками прописать при логировании. Никакие танцы с бубнами не помогали кроме строки ниже. Данные по инициатору изменения решил записывать в поле properties
//UPD: Решил отказаться, так как все равно для корректной работы аутентификации пришел к фиксации записи в модели users, для отображения истории бизнес-сущностей удобнее будет получать пользователя, совершившего действие, из отдельного поля в модели, а не парсить json из поля properties
// CauserResolver::resolveUsing(fn () => null);
} }
} }
+40
View File
@@ -0,0 +1,40 @@
<?php
/**Сервис для определения модуля
@author dgavrilov
*/
namespace App\Services;
class ModuleService{
/**
* Получаем имя модуля из роута (так как в нем обязательно указывается префикс)
*
* @return string | null
*/
public function getModuleName(): string | null
{
$route = request()->route();
$routePrefix = null;
if ($route && $route->getPrefix()) {
$routePrefix = explode('/', $route->getPrefix())[1];
}
return $routePrefix;
}
/**
* Основываясь на имени модуля из роута получаем имя роута на русском (свойство name_ru), которое обязательное прописывается в конфиге модуля
*
* @return string | null
*/
public function getRuModuleName(): string | null
{
if ($module = $this->getModuleName()) {
return config("$module.name_ru", null);
} else {
return null;
}
}
}
+232
View File
@@ -0,0 +1,232 @@
<?php
use Nwidart\Modules\Activators\FileActivator;
use Nwidart\Modules\Providers\ConsoleServiceProvider;
return [
/*
|--------------------------------------------------------------------------
| Module Namespace
|--------------------------------------------------------------------------
|
| Default module namespace.
|
*/
'namespace' => 'Modules',
/*
|--------------------------------------------------------------------------
| Module Stubs
|--------------------------------------------------------------------------
|
| Default module stubs.
|
*/
'stubs' => [
'enabled' => false,
'path' => base_path('vendor/nwidart/laravel-modules/src/Commands/stubs'),
'files' => [
'routes/web' => 'routes/web.php',
'routes/api' => 'routes/api.php',
'views/index' => 'resources/views/index.blade.php',
'views/master' => 'resources/views/layouts/master.blade.php',
'scaffold/config' => 'config/config.php',
'composer' => 'composer.json',
'assets/js/app' => 'resources/assets/js/app.js',
'assets/sass/app' => 'resources/assets/sass/app.scss',
'vite' => 'vite.config.js',
'package' => 'package.json',
],
'replacements' => [
'routes/web' => ['LOWER_NAME', 'STUDLY_NAME', 'MODULE_NAMESPACE', 'CONTROLLER_NAMESPACE'],
'routes/api' => ['LOWER_NAME', 'STUDLY_NAME'],
'vite' => ['LOWER_NAME'],
'json' => ['LOWER_NAME', 'STUDLY_NAME', 'MODULE_NAMESPACE', 'PROVIDER_NAMESPACE'],
'views/index' => ['LOWER_NAME'],
'views/master' => ['LOWER_NAME', 'STUDLY_NAME'],
'scaffold/config' => ['STUDLY_NAME'],
'composer' => [
'LOWER_NAME',
'STUDLY_NAME',
'VENDOR',
'AUTHOR_NAME',
'AUTHOR_EMAIL',
'MODULE_NAMESPACE',
'PROVIDER_NAMESPACE',
],
],
'gitkeep' => true,
],
'paths' => [
/*
|--------------------------------------------------------------------------
| Modules path
|--------------------------------------------------------------------------
|
| This path is used to save the generated module.
| This path will also be added automatically to the list of scanned folders.
|
*/
'modules' => base_path('Modules'),
/*
|--------------------------------------------------------------------------
| Modules assets path
|--------------------------------------------------------------------------
|
| Here you may update the modules' assets path.
|
*/
'assets' => public_path('modules'),
/*
|--------------------------------------------------------------------------
| The migrations' path
|--------------------------------------------------------------------------
|
| Where you run the 'module:publish-migration' command, where do you publish the
| the migration files?
|
*/
'migration' => base_path('database/migrations'),
/*
|--------------------------------------------------------------------------
| Generator path
|--------------------------------------------------------------------------
| Customise the paths where the folders will be generated.
| Setting the generate key to false will not generate that folder
*/
'generator' => [
'config' => ['path' => 'config', 'generate' => true],
'command' => ['path' => 'App/Console', 'generate' => false],
'channels' => ['path' => 'App/Broadcasting', 'generate' => false],
'migration' => ['path' => 'Database/migrations', 'generate' => false],
'seeder' => ['path' => 'Database/Seeders', 'generate' => true],
'factory' => ['path' => 'Database/Factories', 'generate' => false],
'model' => ['path' => 'App/Models', 'generate' => false],
'observer' => ['path' => 'App/Observers', 'generate' => false],
'routes' => ['path' => 'routes', 'generate' => true],
'controller' => ['path' => 'App/Http/Controllers', 'generate' => true],
'filter' => ['path' => 'App/Http/Middleware', 'generate' => false],
'request' => ['path' => 'App/Http/Requests', 'generate' => false],
'provider' => ['path' => 'App/Providers', 'generate' => true],
'assets' => ['path' => 'resources/assets', 'generate' => false],
'lang' => ['path' => 'lang', 'generate' => false],
'views' => ['path' => 'resources/views', 'generate' => true],
'test' => ['path' => 'tests/Unit', 'generate' => false],
'test-feature' => ['path' => 'tests/Feature', 'generate' => false],
'repository' => ['path' => 'App/Repositories', 'generate' => false],
'event' => ['path' => 'App/Events', 'generate' => false],
'listener' => ['path' => 'App/Listeners', 'generate' => false],
'policies' => ['path' => 'App/Policies', 'generate' => false],
'rules' => ['path' => 'App/Rules', 'generate' => false],
'jobs' => ['path' => 'App/Jobs', 'generate' => false],
'emails' => ['path' => 'App/Emails', 'generate' => false],
'notifications' => ['path' => 'App/Notifications', 'generate' => false],
'resource' => ['path' => 'App/resources', 'generate' => false],
'component-view' => ['path' => 'resources/views/components', 'generate' => false],
'component-class' => ['path' => 'App/View/Components', 'generate' => false],
],
],
/*
|--------------------------------------------------------------------------
| Package commands
|--------------------------------------------------------------------------
|
| Here you can define which commands will be visible and used in your
| application. You can add your own commands to merge section.
|
*/
'commands' => ConsoleServiceProvider::defaultCommands()
->merge([
// New commands go here
])->toArray(),
/*
|--------------------------------------------------------------------------
| Scan Path
|--------------------------------------------------------------------------
|
| Here you define which folder will be scanned. By default will scan vendor
| directory. This is useful if you host the package in packagist website.
|
*/
'scan' => [
'enabled' => false,
'paths' => [
base_path('vendor/*/*'),
],
],
/*
|--------------------------------------------------------------------------
| Composer File Template
|--------------------------------------------------------------------------
|
| Here is the config for the composer.json file, generated by this package
|
*/
'composer' => [
'vendor' => 'nwidart',
'author' => [
'name' => 'Nicolas Widart',
'email' => 'n.widart@gmail.com',
],
'composer-output' => false,
],
/*
|--------------------------------------------------------------------------
| Caching
|--------------------------------------------------------------------------
|
| Here is the config for setting up the caching feature.
|
*/
'cache' => [
'enabled' => false,
'driver' => 'file',
'key' => 'laravel-modules',
'lifetime' => 60,
],
/*
|--------------------------------------------------------------------------
| Choose what laravel-modules will register as custom namespaces.
| Setting one to false will require you to register that part
| in your own Service Provider class.
|--------------------------------------------------------------------------
*/
'register' => [
'translations' => true,
/**
* load files on boot or register method
*/
'files' => 'register',
],
/*
|--------------------------------------------------------------------------
| Activators
|--------------------------------------------------------------------------
|
| You can define new types of activators here, file, database, etc. The only
| required parameter is 'class'.
| The file activator will store the activation status in storage/installed_modules
*/
'activators' => [
'file' => [
'class' => FileActivator::class,
'statuses-file' => base_path('modules_statuses.json'),
'cache-key' => 'activator.installed',
'cache-lifetime' => 604800,
],
],
'activator' => 'file',
];
+4
View File
@@ -0,0 +1,4 @@
{
"Taxi": true,
"Test": true
}
BIN
View File
Binary file not shown.