Merge branch 'release/1.0.0' into main

Author: lindyhopchris

.github/workflows/tests.yml

@@ -0,0 +1,43 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    
+    strategy:
+      fail-fast: true
+      matrix:
+        php: ['7.4', '8.0']
+        laravel: ['^8.0']
+
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v2
+
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ matrix.php }}
+        extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, gd
+        tools: composer:v2
+        coverage: none
+
+    - name: Set Laravel Version
+      run: composer require "laravel/framework:${{ matrix.laravel }}" --no-update -n
+
+    - name: Install dependencies
+      uses: nick-invision/retry@v1
+      with:
+        timeout_minutes: 5
+        max_attempts: 5
+        command: composer install --no-suggest --prefer-dist -n -o
+        
+    - name: Execute tests
+      run: vendor/bin/phpunit

CHANGELOG.md

@@ -3,4 +3,7 @@
 All notable changes to this project will be documented in this file. This project adheres to
 [Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
 
-## Unreleased
+## [1.0.0] - 2021-07-21
+
+Initial release. This brought in the code from `laravel-json-api/eloquent:1.0.0-beta.6`, with the only changes being new
+namespaces.

composer.json

@@ -26,8 +26,9 @@
         "php": "^7.4|^8.0",
         "ext-json": "*",
         "illuminate/database": "^8.0",
+        "illuminate/pagination": "^8.0",
         "illuminate/support": "^8.0",
-        "laravel-json-api/eloquent": "^1.0.0-stable"
+        "laravel-json-api/eloquent": "^1.0.0"
     },
     "require-dev": {
         "orchestra/testbench": "^6.9",
@@ -50,7 +51,7 @@
             "dev-develop": "1.x-dev"
         }
     },
-    "minimum-stability": "dev",
+    "minimum-stability": "stable",
     "prefer-stable": true,
     "config": {
         "sort-packages": true

src/.gitkeep

@@ -0,0 +1,117 @@
+<?php
+/*
+ * Copyright 2021 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace LaravelJsonApi\CursorPagination\Cursor;
+
+use InvalidArgumentException;
+
+class Cursor
+{
+
+    /**
+     * @var string|null
+     */
+    private ?string $before;
+
+    /**
+     * @var string|null
+     */
+    private ?string $after;
+
+    /**
+     * @var int|null
+     */
+    private ?int $limit;
+
+    /**
+     * Cursor constructor.
+     *
+     * @param string|null $before
+     * @param string|null $after
+     * @param int|null $limit
+     */
+    public function __construct(string $before = null, string $after = null, int $limit = null)
+    {
+        if (is_int($limit) && 1 > $limit) {
+            throw new InvalidArgumentException('Expecting a limit that is 1 or greater.');
+        }
+
+        $this->before = $before ?: null;
+        $this->after = $after ?: null;
+        $this->limit = $limit;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isBefore(): bool
+    {
+        return !is_null($this->before);
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getBefore(): ?string
+    {
+        return $this->before;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isAfter(): bool
+    {
+        return !is_null($this->after) && !$this->isBefore();
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getAfter(): ?string
+    {
+        return $this->after;
+    }
+
+    /**
+     * Set a limit, if no limit is set on the cursor.
+     *
+     * @param int $limit
+     * @return Cursor
+     */
+    public function withDefaultLimit(int $limit): self
+    {
+        if (is_null($this->limit)) {
+            $copy = clone $this;
+            $copy->limit = $limit;
+            return $copy;
+        }
+
+        return $this;
+    }
+
+    /**
+     * @return int|null
+     */
+    public function getLimit(): ?int
+    {
+        return $this->limit;
+    }
+
+}