@fleetbase/fleetops-engine 0.2.6 → 0.2.8

package/.gitattributes

@@ -0,0 +1,14 @@
+/art               export-ignore
+/docs              export-ignore
+/tests             export-ignore
+/scripts           export-ignore
+/.github           export-ignore
+/.php_cs           export-ignore
+.editorconfig      export-ignore
+.gitattributes     export-ignore
+.gitignore         export-ignore
+phpstan.neon.dist  export-ignore
+phpunit.xml.dist   export-ignore
+CHANGELOG.md       export-ignore
+CONTRIBUTING.md    export-ignore
+README.md          export-ignore

package/.php-cs-fixer.php

@@ -0,0 +1,29 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__ . DIRECTORY_SEPARATOR . 'server' . DIRECTORY_SEPARATOR . 'tests')
+    ->in(__DIR__ . DIRECTORY_SEPARATOR . 'server' . DIRECTORY_SEPARATOR . 'src')
+    ->append(['.php-cs-fixer.php']);
+
+$rules = [
+    '@Symfony'               => true,
+    'phpdoc_no_empty_return' => false,
+    'array_syntax'           => ['syntax' => 'short'],
+    'yoda_style'             => false,
+    'binary_operator_spaces' => [
+        'operators' => [
+            '=>' => 'align',
+            '='  => 'align',
+        ],
+    ],
+    'concat_space'            => ['spacing' => 'one'],
+    'not_operator_with_space' => false,
+    'increment_style'         => ['style' => 'post'],
+    'indentation_type'        => true,
+    'single_quote'            => true,
+];
+
+return (new PhpCsFixer\Config())
+    ->setUsingCache(true)
+    ->setRules($rules)
+    ->setFinder($finder);

package/LICENSE.md

@@ -1,9 +1,21 @@
 The MIT License (MIT)
 
-Copyright (c) 2022
+Copyright (c) 2023 Fleetbase
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,32 +1,122 @@
-# @fleetbase/fleetops-engine
+<p align="center">
+    <img src="https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/fleetbase-logo-svg.svg" width="380" height="100" />
+</p>
+<p align="center">
+    Open-source Fleet & Transport Management Extension for Fleetbase
+</p>
 
-FleetOps extension for Fleetbase.
+---
 
+## Overview
 
-## Compatibility
+This monorepo contains both the frontend and backend components of the FleetOps extension for Fleetbase. The frontend is built using Ember.js and the backend is implemented in PHP.
 
-* Ember.js v3.24 or above
-* Ember CLI v3.24 or above
-* Node.js v14 or above
+### Requirements
 
+- PHP 7.3.0 or above
+- Ember.js v3.24 or above
+- Ember CLI v3.24 or above
+- Node.js v14 or above
 
-## Installation
+## Structure
 
 ```
-ember install @fleetbase/fleetops-engine
+├── addon
+├── app
+├── assets
+├── translations
+├── config
+├── node_modules
+├── server
+│ ├── config
+│ ├── data
+│ ├── migrations
+│ ├── resources
+│ ├── src
+│ ├── tests
+│ └── vendor
+├── tests
+├── testem.js
+├── index.js
+├── package.json
+├── phpstan.neon.dist
+├── phpunit.xml.dist
+├── pnpm-lock.yaml
+├── ember-cli-build.js
+├── composer.json
+├── CONTRIBUTING.md
+├── LICENSE.md
+├── README.md
+```
+
+## Installation
+
+### Backend
+
+Install the PHP packages using Composer:
+
+```bash
+composer require fleetbase/core-api
+composer require fleetbase/fleetops-api
 ```
+### Frontend
 
+Install the Ember.js Engine/Addon:
+
+```bash
+pnpm install @fleetbase/fleetops-engine
+```
 
 ## Usage
 
-[Longer description of how to use the addon in apps.]
+### Backend
+
+🧹 Keep a modern codebase with **PHP CS Fixer**:
+```bash
+composer lint
+```
 
+⚗️ Run static analysis using **PHPStan**:
+```bash
+composer test:types
+```
 
-## Contributing
+✅ Run unit tests using **PEST**
+```bash
+composer test:unit
+```
 
-See the [Contributing](CONTRIBUTING.md) guide for details.
+🚀 Run the entire test suite:
+```bash
+composer test
+```
 
+### Frontend
 
-## License
+🧹 Keep a modern codebase with **ESLint**:
+```bash
+pnpm lint
+```
 
-This project is licensed under the [MIT License](LICENSE.md).
+✅ Run unit tests using **Ember/QUnit**
+```bash
+pnpm test
+pnpm test:ember
+pnpm test:ember-compatibility
+```
+
+🚀 Start the Ember Addon/Engine
+```bash
+pnpm start
+```
+
+🔨 Build the Ember Addon/Engine
+```bash
+pnpm build
+```
+
+## Contributing
+See the Contributing Guide for details on how to contribute to this project.
+
+## License
+This project is licensed under the MIT License.

package/composer.json

@@ -0,0 +1,85 @@
+{
+    "name": "fleetbase/fleetops-api",
+    "version": "0.2.8",
+    "description": "Fleet & Transport Management Extension for Fleetbase",
+    "keywords": [
+        "fleetbase-extension",
+        "fleetops",
+        "last-mile",
+        "tms",
+        "delivery management"
+    ],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Fleetbase Pte Ltd.",
+            "email": "hello@fleetbase.io"
+        },
+        {
+            "name": "Ronald A. Richardson",
+            "email": "ron@fleetbase.io"
+        }
+    ],
+    "require": {
+        "php": "^7.4|^8.0",
+        "fleetbase/core-api": "^1.3.1",
+        "barryvdh/laravel-dompdf": "^2.0",
+        "brick/geo": "0.7.2",
+        "cknow/laravel-money": "^7.1",
+        "geocoder-php/google-maps-places-provider": "^1.4",
+        "giggsey/libphonenumber-for-php": "^8.13",
+        "league/geotools": "^1.1.0",
+        "milon/barcode": "^9.0",
+        "php-http/guzzle7-adapter": "^1.0",
+        "psr/http-factory-implementation": "*",
+        "toin0u/geocoder-laravel": "^4.4",
+        "webit/eval-math": "^1.0"
+    },
+    "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.34.1",
+        "nunomaduro/collision": "^5.11.0|^6.4.0",
+        "pestphp/pest": "^1.22.6",
+        "phpstan/phpstan": "^1.10.38",
+        "symfony/var-dumper": "^5.4.29"
+    },
+    "autoload": {
+        "psr-4": {
+            "Fleetbase\\FleetOps\\": "server/src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Fleetbase\\Tests\\": "server/tests/"
+        }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Fleetbase\\FleetOps\\Providers\\FleetOpsServiceProvider",
+                "Fleetbase\\FleetOps\\Providers\\EventServiceProvider"
+            ]
+        }
+    },
+    "config": {
+        "vendor-dir": "./server_vendor",
+        "sort-packages": true,
+        "preferred-install": "dist",
+        "allow-plugins": {
+            "pestphp/pest-plugin": true,
+            "php-http/discovery": true
+        }
+    },
+    "scripts": {
+        "lint": "php-cs-fixer fix -v",
+        "test:lint": "php-cs-fixer fix -v --dry-run",
+        "test:types": "phpstan analyse --ansi --memory-limit=4G",
+        "test:unit": "pest --colors=always",
+        "test": [
+            "@test:lint",
+            "@test:types",
+            "@test:unit"
+        ]
+    }
+}

package/extension.json

@@ -0,0 +1,10 @@
+{
+    "name": "Fleet-Ops",
+    "version": "0.2.8",
+    "description": "Fleet & Transport Management Extension for Fleetbase",
+    "repository": "https://github.com/fleetbase/fleetops",
+    "license": "MIT",
+    "author": "Fleetbase Pte Ltd <hello@fleetbase.io>",
+    "engine": "package.json",
+    "api": "composer.json"
+}

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@fleetbase/fleetops-engine",
-    "version": "0.2.6",
-    "description": "Fleetbase Fleet-Ops extension provides a fleet management and last mile delivery operations system module.",
+    "version": "0.2.8",
+    "description": "Fleet & Transport Management Extension for Fleetbase",
     "fleetbase": {
         "route": "fleet-ops",
         "dashboard": "int/v1/fleet-ops/dashboard"
@@ -15,7 +15,7 @@
         "ember-addon",
         "ember-engine"
     ],
-    "repository": "https://github.com/fleetbase/fleetops-engine",
+    "repository": "https://github.com/fleetbase/fleetops",
     "license": "MIT",
     "author": "Fleetbase Pte Ltd <hello@fleetbase.io>",
     "directories": {

package/phpstan.neon.dist

@@ -0,0 +1,8 @@
+parameters:
+    level: max
+    paths:
+        - server/src
+
+    checkMissingIterableValueType: true
+    checkGenericClassInNonGenericObjectType: false
+    reportUnmatchedIgnoredErrors: true

package/phpunit.xml.dist

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="./server/vendor/phpunit/phpunit/phpunit.xsd"
+         colors="true"
+>
+    <testsuites>
+        <testsuite name="default">
+            <directory suffix=".php">./server/tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./server/src</directory>
+        </whitelist>
+    </filter>
+</phpunit>