v1 pint format and fixes

Author: asanikovich

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,81 @@
+name: Bug Report
+description: Report an Issue or Bug with the Package
+title: "[Bug]: "
+labels: [ "bug" ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        We're sorry to hear you have a problem. Can you help us solve it by providing the following details.
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: What did you expect to happen?
+      placeholder: I cannot currently do X thing because when I do, it breaks X thing.
+    validations:
+      required: true
+  - type: textarea
+    id: how-to-reproduce
+    attributes:
+      label: How to reproduce the bug
+      description: How did this occur, please add any config values used and provide a set of reliable steps if possible.
+      placeholder: When I do X I see Y.
+    validations:
+      required: true
+  - type: input
+    id: package-version
+    attributes:
+      label: Package Version
+      description: What version of our Package are you running? Please be as specific as possible
+      placeholder: 2.0.0
+    validations:
+      required: true
+  - type: input
+    id: php-version
+    attributes:
+      label: PHP Version
+      description: What version of PHP are you running? Please be as specific as possible
+      placeholder: 8.2.0
+    validations:
+      required: true
+  - type: input
+    id: laravel-version
+    attributes:
+      label: Laravel Version
+      description: What version of Laravel are you running? Please be as specific as possible
+      placeholder: 9.0.0
+    validations:
+      required: true
+  - type: dropdown
+    id: db
+    attributes:
+      label: Which database does with happen with?
+      options:
+        - MySql
+        - Mariadb
+  - type: input
+    id: db-version
+    attributes:
+      label: Database Version
+      description: What version of Database are you running? Please be as specific as possible
+      placeholder: '8.0'
+    validations:
+      required: true
+  - type: dropdown
+    id: operating-systems
+    attributes:
+      label: Which operating systems does with happen with?
+      description: You may select more than one.
+      multiple: true
+      options:
+        - macOS
+        - Windows
+        - Linux
+  - type: textarea
+    id: notes
+    attributes:
+      label: Notes
+      description: Use this field to provide any other notes that you feel might be relevant to the issue.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Ask a question
+    url: https://github.com/asanikovich/laravel-spatial/discussions/new?category=q-a
+    about: Ask the community for help
+  - name: Request a feature
+    url: https://github.com/asanikovich/laravel-spatial/discussions/new?category=ideas
+    about: Share ideas for new features
+  - name: Report a security issue
+    url: https://github.com/asanikovich/laravel-spatial/security/policy
+    about: Learn how to notify us for sensitive bugs

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "dependencies"

.github/workflows/pest-coverage.yml

@@ -12,7 +12,7 @@ jobs:
       db:
         image: mysql:8.0
         env:
-          MYSQL_ROOT_PASSWORD: root
+          MYSQL_ALLOW_EMPTY_PASSWORD: yes
           MYSQL_DATABASE: laravel
         ports:
           - 3306
@@ -34,4 +34,9 @@ jobs:
       - name: Execute tests
         env:
           DB_PORT: ${{ job.services.db.ports['3306'] }}
-        run: XDEBUG_MODE=coverage ./vendor/bin/pest --coverage --min=100
+        run: XDEBUG_MODE=coverage ./vendor/bin/pest --coverage --min=100 --coverage-clover coverage.xml
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/pest.yml

@@ -4,26 +4,28 @@ on: [ push, pull_request ]
 
 jobs:
   test:
-    name: Pest - PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }} - DB ${{ matrix.db }} ${{ matrix.dependency-version }}
+    name: Pest PHP${{ matrix.php }} Laravel ${{ matrix.laravel }} ${{ matrix.db }} ${{ matrix.dependency-version }}
 
     runs-on: ubuntu-latest
 
     strategy:
       fail-fast: false
       matrix:
         php: [ 8.2, 8.1 ]
-        laravel: [ 9.* ]
+        laravel: [ 9.*, 8.* ]
         db: [ 'mysql:8.0', 'mysql:5.7', 'mariadb:10.9' ]
-        dependency-version: [ prefer-lowest, prefer-stable ]
+        dependency-version: [ prefer-stable ]
         include:
           - laravel: 9.*
             testbench: ^7.0
+          - laravel: 8.*
+            testbench: ^6.23
 
     services:
       db:
         image: ${{ matrix.db }}
         env:
-          MYSQL_ROOT_PASSWORD: root
+          MYSQL_ALLOW_EMPTY_PASSWORD: yes
           MYSQL_DATABASE: laravel
         ports:
           - 3306

.github/workflows/phpstan.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: [ 8.2, 8.1, 8.0 ]
+        php: [ 8.2, 8.1 ]
 
     steps:
       - name: Checkout code

.github/workflows/pint.yml

@@ -0,0 +1,26 @@
+name: Fix PHP code style issues
+
+on:
+  push:
+    paths:
+      - "**.php"
+  pull_request:
+    branches: [master]
+
+jobs:
+  php-code-styling:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Fix PHP code style issues
+        uses: aglipanci/laravel-pint-action@2.1.0
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Fix styling

README.md

@@ -1,15 +1,18 @@
-# Laravel Eloquent Spatial
+# Laravel Spatial
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/asanikovich/laravel-spatial.svg?style=flat-square)](https://packagist.org/packages/asanikovich/laravel-spatial)
-[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/asanikovich/laravel-spatial/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/asanikovich/laravel-spatial/actions?query=workflow%3Arun-tests+branch%3Amain)
-[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/asanikovich/laravel-spatial/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/asanikovich/laravel-spatial/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
+[![GitHub Tests Status](https://img.shields.io/github/actions/workflow/status/asanikovich/laravel-spatial/pest.yml?branch=master&label=tests&style=flat-square)](https://github.com/asanikovich/laravel-spatial/actions/workflows/pest.yml?query=branch%3Amaster)
+[![GitHub Tests Coverage Status](https://img.shields.io/codecov/c/github/asanikovich/laravel-spatial?token=E0703O0PPT&style=flat-square)](https://github.com/asanikovich/laravel-spatial/actions/workflows/pest-coverage.yml?query=branch%3Amaster)
+[![GitHub Code Style Status](https://img.shields.io/github/actions/workflow/status/asanikovich/laravel-spatial/phpstan.yml?branch=master&label=code%20style&style=flat-square)](https://github.com/asanikovich/laravel-spatial/actions/workflows/phpstan.yml?query=branch%3Amaster)
+[![GitHub Lint Status](https://img.shields.io/github/actions/workflow/status/asanikovich/laravel-spatial/pint.yml?branch=master&label=lint&style=flat-square)](https://github.com/asanikovich/laravel-spatial/actions/workflows/pint.yml?query=branch%3Amaster)
 [![Total Downloads](https://img.shields.io/packagist/dt/asanikovich/laravel-spatial.svg?style=flat-square)](https://packagist.org/packages/asanikovich/laravel-spatial)
+[![Licence](https://img.shields.io/packagist/l/asanikovich/laravel-spatial.svg?style=flat-square)](https://packagist.org/packages/asanikovich/laravel-spatial)
 
 **This Laravel package allows you to easily work with spatial data types and functions.**
 
-The latest version, v3, supports Laravel 10 and PHP 8.1+. For Laravel 8 or 9, and PHP 8.0, use v2.
+v1 supports Laravel 8,9 and PHP 8.1+.
 
-This package supports MySQL v8, MySQL v5.7, and MariaDB v10.
+This package supports MySQL v8 or v5.7, and MariaDB v10.
 
 ## Getting Started
 
@@ -21,12 +24,32 @@ You can install the package via composer:
 composer require asanikovich/laravel-spatial
 ```
 
+### Configuration
+
+Default Configuration file includes geometry types mapping:
+```php
+<?php
+
+use ASanikovich\LaravelSpatial\Enums\GeometryType;
+use ASanikovich\LaravelSpatial\Geometry;
+
+return [
+    GeometryType::POINT->value => Geometry\Point::class,
+    GeometryType::POLYGON->value => Geometry\Polygon::class,
+    /// ...
+];
+```
+
 You can publish the config file with:
 
 ```bash
 php artisan vendor:publish --tag="laravel-spatial-config"
 ```
 
+If you want you can override custom geometry types mapping:
+* globally by config file
+* by custom `$casts` in your model (top priority)
+
 ### Setting Up Your First Model
 
 1. First, generate a new model along with a migration file by running:
@@ -67,21 +90,19 @@ php artisan vendor:publish --tag="laravel-spatial-config"
     php artisan migrate
     ```
 
-4. In your new model, fill the `$fillable` and `$casts` arrays and use the `HasSpatial` trait:
+4. In your new model, fill `$casts` arrays and use the `HasSpatial` trait (fill the `$fillable` - optional):
 
     ```php
     namespace App\Models;
 
     use Illuminate\Database\Eloquent\Model;
     use ASanikovich\LaravelSpatial\Eloquent\HasSpatial;
-    use ASanikovich\LaravelSpatial\Eloquent\SpatialBuilder;
     use ASanikovich\LaravelSpatial\Geometry\Point;
     use ASanikovich\LaravelSpatial\Geometry\Polygon;
 
     /**
      * @property Point $location
      * @property Polygon $area
-     * @method static SpatialBuilder<Place> query()
      */
     class Place extends Model
     {
@@ -155,25 +176,9 @@ echo $vacationCity->area->toJson(); // {"type":"Polygon","coordinates":[[[41.907
 
 For more comprehensive documentation on the API, please refer to the [API](API.md) page.
 
-## Tips for Improving IDE Support
-
-In order to get better IDE support, you can add a `query` method phpDoc annotation to your model:
-
-```php
-/**
- * @method static SpatialBuilder query()
- */
-class Place extends Model
-{
-    // ...
-}
-```
-
-Create queries only with the `query()` static method:
-
+Create queries only with scopes methods:
 ```php
-Place::query()->whereDistance(...); // This is IDE-friendly
-Place::whereDistance(...); // This is not
+Place::whereDistance(...); // This is IDE-friendly
 ```
 
 ## Extension
@@ -204,18 +209,37 @@ echo $londonEyePoint->getName(); // Point
 ```
 
 ## Development
+Here are some useful commands for development
 
-Here are some useful commands for development:
-
-* Run tests: `composer pest`
-* Run tests with coverage: `composer pest-coverage`
-* Perform type checking: `composer phpstan`
-* Format your code: `composer format`
+Before running tests run db by docker-compose:
+```bash
+docker-compose up -d
+```
+Run tests:
+```bash
+composer run test
+```
+Run tests with coverage:
+```bash
+composer run test-coverage
+```
+Perform type checking:
+```bash
+composer run phpstan
+```
+Format your code:
+```bash
+composer run format
+```
 
 ## Updates and Changes
 
 For details on updates and changes, please refer to our [CHANGELOG](CHANGELOG.md).
 
 ## License
 
-Laravel Eloquent Spatial is released under The MIT License (MIT). For more information, please see our [License File](LICENSE.md).
+Laravel Spatial is released under The MIT License (MIT). For more information, please see our [License File](LICENSE.md).
+
+## Credits
+
+Originally inspired from [MatanYadaev's laravel-eloquent-spatial package](https://github.com/MatanYadaev/laravel-eloquent-spatial).

composer.json

@@ -10,17 +10,17 @@
         }
     ],
     "require": {
-        "php": "^8.0",
+        "php": "^8.1",
         "ext-json": "*",
         "ext-pdo": "*",
-        "laravel/framework": "^9.0",
+        "laravel/framework": "^8.0",
         "phayes/geophp": "^1.2"
     },
     "require-dev": {
-        "doctrine/dbal": "^2.0|^3.0",
-        "laravel/pint": "^1.10",
+        "doctrine/dbal": "^3.0",
+        "laravel/pint": "^1.5",
         "nunomaduro/larastan": "^1.0|^2.4",
-        "orchestra/testbench": "^7.0",
+        "orchestra/testbench": "^6.23|^7.0",
         "pestphp/pest": "^1.0",
         "pestphp/pest-plugin-laravel": "^1.4.0"
     },

docker-compose.yml

@@ -6,4 +6,4 @@ services:
       - "3306:3306"
     environment:
       MYSQL_DATABASE: 'laravel'
-      MYSQL_ROOT_PASSWORD: 'root'
+      MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'