Update README.md

Файл с дополнительной информацией по ходу журналирования работ

README.md

@@ -1,59 +1,32 @@
-<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
+Попытка ретроспективно описать этапы разработки проекта Magic 2.0. 
+Изначально проект реализовывался сумбурно, без структурированной фиксации каждой доработки в расчете описать всю историю перед релизом.
 
-<p align="center">
-<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>
+## Ход работ:
+Есть текущая версия Laravel со <u>всеми</u> реализованными фичами (а также с комментариями, тестовыми настройками и прочим мусором). Была развернута голая Laravel, созданы ветки и в них добавлялись скрипты из текущей версии Laravel по принципу реализованных функциональностей. Версии Laravel отличаются, поэтому некоторые конфиги из коробки могут отличаться от конфигов из текущей версии (впрочем, вроде не критично). Также я приложил excel файл (new_magic в ветку master) к репозиторию, в котором перечислил по каким веткам я разбросал файлы, а к некоторым файлам оставил комментарии
 
-## About Laravel
+Я знаю, что это не лучший способ фиксировать историчность разработки, но выбор был между отсутствием истории и такой историей. Даже если вы не будете использовать мои разработки как основу для Magic 2.0, по крайней мере пробегитесь глазами по архитектуре и почитайте комментарии. Некоторые фичи полность готовы и могут быть перенесены, другие могут сэкономить время хотя бы за счет готового описания 
 
-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:
+Не забывайте, что в Confulence тоже кое-что из реализованного уже описано
 
-- [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
-
-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.
-
-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.
-
-## Laravel Sponsors
-
-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).
+## Сборка
+Ниже опишу как бы я смотрел все эти изменения
+1. Начать с версии из ветки all_changes - там вся имеющаяся функциональность
+2. Все таблицы из db_tables экспортировать в свою локальную бд
+3. Просмотрел бы верхнеуровнево все core ветки, начиная от конфигов и core функций типа logging 
+4. На голую версия накинул бы ветку laravel_core и doubtfull
+5. Начал бы накидывать постепенно изменения из веток и смотреть как работает платформа. Я постарался в ветках хранить только ту информацию, которая нужна для работы конкреной функциональности, чтобы вы могли изолированно их посмотреть и даже запустить для тестов перед мержем с master. К сожалению у меня не было времени тестить каждую ветку отдельно
+6. В последнюю очередь накинул бы изменения из веток с реализацией страниц: magic_app_menu и taxi-app
+7. Опциально: можно начать удалять скрипты из ветки doubtfull и смотреть работает ли все как надо, чтобы облегчить платформу от ненужных скриптов

app/Enums/LogBusinessEvents.php

@@ -1,36 +0,0 @@
-<?php
-
-namespace App\Enums;
-
-/**
- * Бизнес действия, доступные для логирования через activity_log
- * @author dgavrilov
- */
-
-
-#Гаврилов
-//ПОЛУЧИТСЯ ЛИ ПЕРЕДАТЬ НА ФРОНТ ЭТОТ ENUM
-//ГАВРИЛОВ
-//ИДЕНТИЧНЫЙ СПРАВОЧНИК УКАЗАН НА СТОРОНЕ react в компоненте ENTITYHISTORY. ЕСТЬ ВОЗМОЖНОСТЬ ОБЪЕДИНИТЬ ИХ?
-enum LogBusinessEvents: string
-{
-  case Create = 'create';
-  case Edit = 'edit';
-  case Archive = 'archive';
-  case Restore = 'restore';
-  case Delete = 'delete';
-  case Cancel = 'cancel';
-
-  public function title(): string
-  {
-    return match($this)
-    {
-      self::Create => 'создание',
-      self::Edit => 'редактирование',
-      self::Archive => 'архивация',
-      self::Restore => 'восстановление',
-      self::Delete => 'удаление',
-      self::Cancel => 'отмена',
-    };
-  }
-}

app/Traits/LogsActivity_custom.php

@@ -1,148 +0,0 @@
-<?php
-
-namespace app\Traits;
-
-use PHPUnit\Event\Code\Throwable;
-use Spatie\Activitylog\LogOptions;
-use Spatie\Activitylog\Traits\LogsActivity;
-use Spatie\Activitylog\Contracts\Activity;
-use App\Enums\LogBusinessEvents; 
-
-trait LogsActivity_custom
-{
-  //"наследуем" готовый трейт из пакета логирования, чтобы расширить его
-  use LogsActivity;
-
-  /**
-   *
-   * @param string имя журнала логирования (название приложения). Нужно переопределять в модели в зависимости от используемого приложения (модуля)
-   */
-  protected $logActivity_custom__name;
-  /**
-   * @param array Массив с кастомными значениями, которые хотим логировать независимо от модели, событие в которой логируется
-   */
-  // protected $activityCustomProperties = [
-  //   'custom__user_login' => session()->get('_auth_login'),
-  // ];
-  protected $activityCustomProperties = [];
-  /**
-   * @var array массив с кастомными значениями, которые относятся к самому действию логирования, а не к изменениям в результате логируемого действия (properties). Например, название совершенного действия: архивация, отмена, восстановление и т.д.
-   */
-  protected $activityCustomDescription = [];
-  /**
-   * @var string название совершенного бизнес-действия (не события из поля event, там могут быть только eloquent события: create, udate и т.д.). По умолчанию действие - изменение.
-   * 
-   * Свойство статическое, потому что при использовании нестатического свойства, его значение после присваения "сбрасывается" до значения по умолчанию из за специфики работы с моделью. Каждое создание экземпляра модели может привести к сбросу свойства до значения по умолчанию. Если свойство статическое, его можно менять в любой момент и во всех экземплярах этой модели оно будет изменено
-   */
-  protected static $businessEvent = LogBusinessEvents::Edit;
-
-  /**
-   * Единые опции логирования любых события в моделях, где указано использование данного трейта
-   *
-   * @return LogOptions
-   */
-  public function getActivitylogOptions(): LogOptions
-  {
-    return LogOptions::defaults()
-      ->logAll()        //Логируем все поля
-      ->logOnlyDirty()  //Логируем только изменившиеся по сравнению с текущим состоянием значения
-      ->useLogName($this->logActivity_custom__name ? $this->logActivity_custom__name : 'default') //Имя журнала (имя приложения) события которого логируются
-      ->logExcept(['created_at', 'updated_at']);  //Поля, значения которых не логируются
-  }
-
-
-  /**
-   * Тут прописываем дополнительные свойства, которые будут добавляться к каждой записи логирования изменения моделей
-   *
-   * @return array
-   */
-  protected function getActivityLogDefaultProp (): array 
-  {
-    //Добавляем логин пользователя к записи с логированием события. Если изменение произошло через web роут, то берется логин из объекта ldap (свойство samaccountname), если было обращение через api ендпоинт, берется логин из таблицы users, где делается запись при аутентификации пользователя. Это связано со спецификой аутентификации при вызове web роута и api ендпоинта
-    //UPD: решил отказаться от логирования пользователя через расширение properties, но для примера пока оставил
-    //return ['custom__user_login' => auth()->user()->login ?? auth()->user()->samaccountname[0]];
-    return [];
-  }
-
-  // public function getActivitylogOptions(): LogOptions
-  // {
-  //   //CauserResolver::setCauser('dgavrilov');
-  //   return LogOptions::defaults()
-  //     ->logAll() // Перечисляем логируемые поля. В данном случае, логируем все поля
-  //     ->logExcept(['created_at', 'updated_at']) // Поля, которые не будут логироваться не при каких условиях
-  //     ->logOnlyDirty() // Логируются только поля, данные в которых были изменены
-  //     //->useLogName($this->getLogName());
-  //     ->useLogName($this->logActivity_custom__name ? $this->logActivity_custom__name : 'default'); //Имя журнала логирования. Либо переопределеяется в модели, который использует данный трейт, либо по умолчанию ставится default
-  //     // ->tapActivity(function (Activity $activity) {
-  //     //   // Указываем пользователя из сессии/кук
-  //     //   //$activity->causer_id = auth()->id(); // или явно: 1
-  //     //   $activity->causer_id = 'dgavrilov'; // или явно: 1
-  //     //   //$activity->causer_type = \App\Models\User::class;
-  //     // });
-  // }
-
-  /**
-   * Метод позволяет "вмешаться" в процесс логирования в "последний момент" перед записью в модель activity_log. В данном случае, значения в поле properties обогащаются доп значениями, которые мы описали в свойстве $this->activityCustomProperties
-   *
-   * @param Activity $activity
-   * @param string $eventName
-   * @return void
-   */
-  public function tapActivity(Activity $activity, string $eventName)
-  {
-    $this->activityCustomProperties = array_merge($this->activityCustomProperties, $this->getActivityLogDefaultProp());
-    // $this->activityCustomDescription = $this->setLogDescription();
-    $activity->properties = $activity->properties->merge(['custom_props' => $this->activityCustomProperties]); 
-    //переопределение поле  description модели activityLog
-    // $activity->description = json_encode($this->activityCustomDescription);
-    $activity->business_event = self::$businessEvent; 
-  } 
-
-  #Гаврилов
-  //ЛУЧШЕ СДЕЛАТЬ ЕДИНЫЙ МЕТОД, ПРИНИМАЮЩИЙ НАЗВАНИЕ ACTION, СРАВНИВАЯ ЕГО СО СВОЙСТВОМ ТЕКУЩЕГО КЛАССА businessAction И ВОЗВРАЩАЮЩИЙ ОШИБКУ, ЕСЛИ ТАКОГО СВОЙСТВА НЕТ 
-
-
-  
-  /**
-   * Метод инициации логирования бизнес-действия: создание, редактирование, архивация. В поле event по умолчанию логируются только Eloquent события: create, update и тд
-   *
-   * @param string $action логируемое бизнес-действие
-   * @return void
-   */
-  public function logBusinessEvent(LogBusinessEvents $event)
-  { 
-    self::$businessEvent = $event;
-  }
-
-
-  /**
-   * @return array формирование дополнительного описания с информацией для логируемого действия
-   */
-  // public function setLogDescription()
-  // {
-  //   $activityDescription = array_merge(
-  //     $this->activityCustomDescription,
-  //   );
-
-  //   return $activityDescription;
-  // }
-
-
-
-  /**
-   * Метод добавления кастомных значений для логирования
-   * 
-   * Поля, переданные в метод из модели, где подключен этот трейт
-   *
-   * @param array $properties
-   * @return void 
-   */
-  public function addCustomLogProperties(array $properties): void
-  {
-    $this->activityCustomProperties = array_merge(
-      $this->activityCustomProperties ?? [],
-      $properties
-    );
-  }
-
-}

config/activitylog.php

@@ -1,53 +0,0 @@
-<?php
-
-return [
-
-    /*
-     * If set to false, no activities will be saved to the database.
-     */
-    'enabled' => env('ACTIVITY_LOGGER_ENABLED', true),
-
-    /*
-     * When the clean-command is executed, all recording activities older than
-     * the number of days specified here will be deleted.
-     */
-    //'delete_records_older_than_days' => 365,
-
-    /*
-     * If no log name is passed to the activity() helper
-     * we use this default log name.
-     */
-    'default_log_name' => 'default',
-
-    /*
-     * You can specify an auth driver here that gets user models.
-     * If this is null we'll use the current Laravel auth driver.
-     */
-    'default_auth_driver' => null,
-
-    /*
-     * If set to true, the subject returns soft deleted models.
-     */
-    'subject_returns_soft_deleted_models' => false,
-
-    /*
-     * This model will be used to log activity.
-     * It should implement the Spatie\Activitylog\Contracts\Activity interface
-     * and extend Illuminate\Database\Eloquent\Model.
-     */
-    'activity_model' => \Spatie\Activitylog\Models\Activity::class,
-
-    /*
-     * This is the name of the table that will be created by the migration and
-     * used by the Activity model shipped with this package.
-     */
-    'table_name' => env('ACTIVITY_LOGGER_TABLE_NAME', 'activity_log'),
-
-    /*
-     * This is the database connection that will be used by the migration and
-     * the Activity model shipped with this package. In case it's not set
-     * Laravel's database.default will be used instead.
-     */
-    'database_connection' => env('ACTIVITY_LOGGER_DB_CONNECTION'),
-
-];