Add Laravel v10 support (#77)

* Add Laravel 10 support

* Replace $dates with $casts usage

* Remove orchestra/database dev dependency

* Add docker compose for dev

Author: antonkomarev

.docker/nginx/app.laravel-eloquent-flag.80.conf

@@ -0,0 +1,40 @@
+server {
+    listen 80;
+    listen [::]:80;
+    server_name app.laravel-eloquent-flag.localhost;
+
+    root /app/public;
+    index index.php index.html;
+    access_log /dev/stdout;
+    error_log /dev/stderr info;
+
+    charset utf-8;
+
+    proxy_set_header Host $host;
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-Forwarded-Host $server_name;
+
+    add_header Strict-Transport-Security "max-age=31536000" always;
+    add_header X-Frame-Options "SAMEORIGIN" always;
+    add_header X-Content-Type-Options "nosniff" always;
+    add_header Referrer-Policy "strict-origin-when-cross-origin" always;
+
+    server_tokens off;
+    client_max_body_size 100M;
+
+    location ~ \.php$ {
+        try_files $uri =404;
+        fastcgi_split_path_info ^(.+\.php)(/.+)$;
+        fastcgi_pass app:9000;
+        fastcgi_index index.php;
+        include fastcgi_params;
+        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
+        fastcgi_param PATH_INFO $fastcgi_path_info;
+    }
+
+    location / {
+        try_files $uri $uri/ /index.php?$query_string;
+        gzip_static on;
+    }
+}

.docker/php/Dockerfile

@@ -0,0 +1,19 @@
+# ----------------------
+# The FPM base container
+# ----------------------
+FROM php:8.1-fpm-alpine AS dev
+
+# Cleanup apk cache and temp files
+RUN rm -rf /var/cache/apk/* /tmp/*
+
+# ----------------------
+# Composer install step
+# ----------------------
+
+# Get latest Composer
+COPY --from=composer:latest /usr/bin/composer /usr/bin/composer
+
+# ----------------------
+# The FPM production container
+# ----------------------
+FROM dev

.docker/php/www.conf

@@ -0,0 +1,85 @@
+; Start a new pool named 'www'.
+; the variable $pool can be used in any directive and will be replaced by the
+; pool name ('www' here)
+[www]
+
+; Unix user/group of processes
+; Note: The user is mandatory. If the group is not set, the default user's group
+;       will be used.
+user = www-data
+group = www-data
+
+; The address on which to accept FastCGI requests.
+; Valid syntaxes are:
+;   'ip.add.re.ss:port'    - to listen on a TCP socket to a specific IPv4 address on
+;                            a specific port;
+;   '[ip:6:addr:ess]:port' - to listen on a TCP socket to a specific IPv6 address on
+;                            a specific port;
+;   'port'                 - to listen on a TCP socket to all addresses
+;                            (IPv6 and IPv4-mapped) on a specific port;
+;   '/path/to/unix/socket' - to listen on a unix socket.
+; Note: This value is mandatory.
+listen = 9000
+
+; Choose how the process manager will control the number of child processes.
+; Possible Values:
+;   static  - a fixed number (pm.max_children) of child processes;
+;   dynamic - the number of child processes are set dynamically based on the
+;             following directives. With this process management, there will be
+;             always at least 1 children.
+;             pm.max_children      - the maximum number of children that can
+;                                    be alive at the same time.
+;             pm.start_servers     - the number of children created on startup.
+;             pm.min_spare_servers - the minimum number of children in 'idle'
+;                                    state (waiting to process). If the number
+;                                    of 'idle' processes is less than this
+;                                    number then some children will be created.
+;             pm.max_spare_servers - the maximum number of children in 'idle'
+;                                    state (waiting to process). If the number
+;                                    of 'idle' processes is greater than this
+;                                    number then some children will be killed.
+;  ondemand - no children are created at startup. Children will be forked when
+;             new requests will connect. The following parameter are used:
+;             pm.max_children           - the maximum number of children that
+;                                         can be alive at the same time.
+;             pm.process_idle_timeout   - The number of seconds after which
+;                                         an idle process will be killed.
+; Note: This value is mandatory.
+pm = dynamic
+
+; The number of child processes to be created when pm is set to 'static' and the
+; maximum number of child processes when pm is set to 'dynamic' or 'ondemand'.
+; This value sets the limit on the number of simultaneous requests that will be
+; served. Equivalent to the ApacheMaxClients directive with mpm_prefork.
+; Equivalent to the PHP_FCGI_CHILDREN environment variable in the original PHP
+; CGI. The below defaults are based on a server without much resources. Don't
+; forget to tweak pm.* to fit your needs.
+; Note: Used when pm is set to 'static', 'dynamic' or 'ondemand'
+; Note: This value is mandatory.
+pm.max_children = 5
+
+; The number of child processes created on startup.
+; Note: Used only when pm is set to 'dynamic'
+; Default Value: min_spare_servers + (max_spare_servers - min_spare_servers) / 2
+pm.start_servers = 2
+
+; The desired minimum number of idle server processes.
+; Note: Used only when pm is set to 'dynamic'
+; Note: Mandatory when pm is set to 'dynamic'
+pm.min_spare_servers = 1
+
+; The desired maximum number of idle server processes.
+; Note: Used only when pm is set to 'dynamic'
+; Note: Mandatory when pm is set to 'dynamic'
+pm.max_spare_servers = 3
+
+; The number of seconds after which an idle process will be killed.
+; Note: Used only when pm is set to 'ondemand'
+; Default Value: 10s
+;pm.process_idle_timeout = 10s;
+
+; The number of requests each child process should execute before respawning.
+; This can be useful to work around memory leaks in 3rd party libraries. For
+; endless request processing specify '0'. Equivalent to PHP_FCGI_MAX_REQUESTS.
+; Default Value: 0
+;pm.max_requests = 500

.gitattributes

@@ -1,5 +1,6 @@
 * text=auto
 
+/.docker export-ignore
 /.github export-ignore
 /tests export-ignore
 /.gitattributes export-ignore
@@ -8,4 +9,5 @@
 /.travis.yml export-ignore
 /CODE_OF_CONDUCT.md export-ignore
 /CONTRIBUTING.md export-ignore
+/docker-compose.yaml export-ignore
 /phpunit.xml.dist export-ignore

.github/workflows/tests.yaml

@@ -9,41 +9,19 @@ jobs:
       fail-fast: true
       matrix:
         os: [ ubuntu-latest ]
-        php: [ 7.2, 7.3, 7.4, 8.0, 8.1 ]
-        laravel: [ 6.*, 7.*, 8.*, 9.* ]
+        php: [ 8.0, 8.1, 8.2 ]
+        laravel: [ 9.*, 10.* ]
         dependency-version: [ prefer-lowest, prefer-stable ]
         exclude:
-          - laravel: 6.*
-            dependency-version: prefer-lowest
-          - laravel: 7.*
-            dependency-version: prefer-lowest
-          - laravel: 8.*
-            dependency-version: prefer-lowest
           - laravel: 9.*
-            dependency-version: prefer-lowest
-          - laravel: 6.*
-            php: 8.1
-          - laravel: 7.*
-            php: 8.1
-          - laravel: 8.*
-            php: 7.2
-          - laravel: 9.*
-            php: 7.2
-          - laravel: 9.*
-            php: 7.3
-          - laravel: 9.*
-            php: 7.4
+            php: 8.2
+          - laravel: 10.*
+            php: 8.0
         include:
-          - laravel: 6.*
-            testbench: 4.*
-          - laravel: 7.*
-            testbench: 5.*
-          - laravel: 8.*
-            testbench: 6.*
-            legacy-factories: 1.*
           - laravel: 9.*
             testbench: 7.*
-            legacy-factories: 1.*
+          - laravel: 10.*
+            testbench: 8.*
 
     name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.dependency-version }}
 
@@ -70,10 +48,5 @@ jobs:
           composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
           composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction
 
-      - name: Install legacy factories dependency
-        run: |
-          composer require "laravel/legacy-factories:${{ matrix.legacy-factories }}" --no-interaction
-        if: matrix.legacy-factories
-
       - name: Execute tests
-        run: vendor/bin/phpunit --verbose
+        run: vendor/bin/phpunit --testdox

CHANGELOG.md

@@ -4,6 +4,21 @@ All notable changes to `cybercog/laravel-eloquent-flag` will be documented in th
 
 ## [Unreleased]
 
+### Added
+
+- ([#77]) Added Laravel 10 support
+
+### Changed
+
+- ([#77]) Timestamp flagged attributes using Eloquent Model `$casts` property
+
+### Removed
+
+- ([#77]) Dropped Laravel 5.8 support
+- ([#77]) Dropped Laravel 6 support
+- ([#77]) Dropped Laravel 7 support
+- ([#77]) Dropped Laravel 8 support
+
 ## [5.4.0] - 2022-04-13
 
 ### Added
@@ -333,6 +348,7 @@ All notable changes to `cybercog/laravel-eloquent-flag` will be documented in th
 [1.2.0]: https://github.com/cybercog/laravel-eloquent-flag/compare/1.1.0...1.2.0
 [1.1.0]: https://github.com/cybercog/laravel-eloquent-flag/compare/1.0.0...1.1.0
 
+[#77]: https://github.com/cybercog/laravel-eloquent-flag/pull/77
 [#74]: https://github.com/cybercog/laravel-eloquent-flag/pull/71
 [#71]: https://github.com/cybercog/laravel-eloquent-flag/pull/71
 [#69]: https://github.com/cybercog/laravel-eloquent-flag/pull/69

CONTRIBUTING.md

@@ -25,8 +25,8 @@ This project follows [PSR-12 coding style guide](https://www.php-fig.org/psr/psr
 
 The phpunit script can be used to invoke the PHPUnit test runner:
 
-```shell script
-$ vendor/bin/phpunit
+```shell
+vendor/bin/phpunit
 ```
 
 ## Reporting issues

README.md

@@ -99,8 +99,8 @@ Helper traits will automatically cast flag attributes to a `DateTime` / `Carbon`
 
 Pull in the package through Composer.
 
-```shell script
-$ composer require cybercog/laravel-eloquent-flag
+```shell
+composer require cybercog/laravel-eloquent-flag
 ```
 
 ## Usage
@@ -123,8 +123,8 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 Run the tests with:
 
-```shell script
-$ vendor/bin/phpunit
+```shell
+vendor/bin/phpunit
 ```
 
 ## Security

composer.json

@@ -53,14 +53,14 @@
         "docs": "https://github.com/cybercog/laravel-eloquent-flag/wiki"
     },
     "require": {
-        "php": "^7.1.3|^8.0",
-        "illuminate/database": "^5.8|^6.0|^7.0|^8.0|^9.0"
+        "php": "^8.0",
+        "illuminate/database": "^9.0|^10.0",
+        "laravel/legacy-factories": "^1.3"
     },
     "require-dev": {
         "mockery/mockery": "^1.0",
-        "orchestra/database": "~3.8.0|^4.0|^5.0|^6.0|^7.0",
-        "orchestra/testbench": "~3.8.0|^4.0|^5.0|^6.0|^7.0",
-        "phpunit/phpunit": "^7.0|^8.0|^9.0"
+        "orchestra/testbench": "^7.0|^8.0",
+        "phpunit/phpunit": "^9.6"
     },
     "autoload": {
         "psr-4": {

docker-compose.yaml

@@ -0,0 +1,35 @@
+version: "3.9"
+services:
+  app:
+    container_name: laravel-eloquent-flag-app
+    image: laravel-eloquent-flag-app
+    build:
+      context: ./
+      dockerfile: ./.docker/php/Dockerfile
+    restart: unless-stopped
+    working_dir: /app
+    volumes:
+      - ./:/app
+      - ./.docker/php/www.conf:/usr/local/etc/php-fpm.d/www.conf:ro
+    networks:
+      - laravel-eloquent-flag
+
+  nginx:
+    container_name: laravel-eloquent-flag-nginx
+    image: nginx:1.21-alpine
+    restart: unless-stopped
+    depends_on:
+      - app
+    ports:
+      - "80:80"
+    environment:
+      VIRTUAL_HOST: app.laravel-eloquent-flag.localhost
+    volumes:
+      - ./.docker/nginx/app.laravel-eloquent-flag.80.conf:/etc/nginx/conf.d/app.laravel-eloquent-flag.80.conf:ro
+      - ./public:/app/public:ro
+    networks:
+      - laravel-eloquent-flag
+
+networks:
+  laravel-eloquent-flag:
+    driver: bridge

src/Traits/Classic/HasAcceptedAtHelpers.php

@@ -19,7 +19,7 @@ trait HasAcceptedAtHelpers
 {
     public function initializeHasAcceptedAtHelpers(): void
     {
-        $this->dates[] = 'accepted_at';
+        $this->casts['accepted_at'] = 'datetime';
     }
 
     public function isAccepted(): bool

src/Traits/Classic/HasApprovedAtHelpers.php

@@ -19,7 +19,7 @@ trait HasApprovedAtHelpers
 {
     public function initializeHasApprovedAtHelpers(): void
     {
-        $this->dates[] = 'approved_at';
+        $this->casts['approved_at'] = 'datetime';
     }
 
     public function isApproved(): bool

src/Traits/Classic/HasInvitedAtHelpers.php

@@ -19,7 +19,7 @@ trait HasInvitedAtHelpers
 {
     public function initializeHasInvitedAtHelpers(): void
     {
-        $this->dates[] = 'invited_at';
+        $this->casts['invited_at'] = 'datetime';
     }
 
     public function isInvited(): bool

src/Traits/Classic/HasPublishedAtHelpers.php

@@ -19,7 +19,7 @@ trait HasPublishedAtHelpers
 {
     public function initializeHasPublishedAtHelpers(): void
     {
-        $this->dates[] = 'published_at';
+        $this->casts['published_at'] = 'datetime';
     }
 
     public function isPublished(): bool

src/Traits/Classic/HasVerifiedAtHelpers.php

@@ -19,7 +19,7 @@ trait HasVerifiedAtHelpers
 {
     public function initializeHasVerifiedAtHelpers(): void
     {
-        $this->dates[] = 'verified_at';
+        $this->casts['verified_at'] = 'datetime';
     }
 
     public function isVerified(): bool

src/Traits/Inverse/HasArchivedAtHelpers.php

@@ -19,7 +19,7 @@ trait HasArchivedAtHelpers
 {
     public function initializeHasArchivedAtHelpers(): void
     {
-        $this->dates[] = 'archived_at';
+        $this->casts['archived_at'] = 'datetime';
     }
 
     public function isArchived(): bool