Alpha release

Author: peterfox

.github/workflows/php-cs-fixer.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Run PHP CS Fixer
         uses: docker://oskarstark/php-cs-fixer-ga
         with:
-          args: --config=.php_cs.dist.php --allow-risky=yes
+          args: --config=.php-cs-fixer.dist.php --allow-risky=yes
 
       - name: Commit changes
         uses: stefanzweifel/git-auto-commit-action@v4

.github/workflows/run-tests.yml

@@ -9,13 +9,13 @@ on:
 jobs:
   test:
     runs-on: ${{ matrix.os }}
+
     strategy:
-      fail-fast: true
       matrix:
-        os: [ubuntu-latest, windows-latest]
-        php: [8.0]
+        os: [ubuntu-latest]
+        php: [8.0, 8.1]
         laravel: [8.*]
-        stability: [prefer-lowest, prefer-stable]
+        stability: [prefer-stable, prefer-lowest]
         include:
           - laravel: 8.*
             testbench: ^6.23
@@ -26,11 +26,15 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v2
 
+      - name: Run CockroachDB Service
+        run: docker-compose up -d
+
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_pgsql
+          tools: composer:v2
           coverage: none
 
       - name: Setup problem matchers
@@ -43,5 +47,9 @@ jobs:
           composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
           composer update --${{ matrix.stability }} --prefer-dist --no-interaction
 
+      - name: Configure Database
+        run: |
+          php ./database.php
+
       - name: Execute tests
         run: vendor/bin/pest

.php_cs.dist.php renamed to .php-cs-fixer.dist.php

@@ -2,6 +2,6 @@
 
 All notable changes to `cockroachdb-laravel` will be documented in this file.
 
-## 1.0.0 - 202X-XX-XX
+## 0.1.0 - 2021-12-14
 
-- initial release
+- initial alpha release

CHANGELOG.md

@@ -1,31 +1,12 @@
 # CockroachDB Driver for Laravel
 
-A driver/grammer for Laravel that works with CockroachDB.
-
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/ylsideas/cockroachdb-laravel.svg?style=flat-square)](https://packagist.org/packages/ylsideas/cockroachdb-laravel)
 [![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/ylsideas/cockroachdb-laravel/run-tests?label=tests)](https://github.com/ylsideas/cockroachdb-laravel/actions?query=workflow%3Arun-tests+branch%3Amain)
 [![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/ylsideas/cockroachdb-laravel/Check%20&%20fix%20styling?label=code%20style)](https://github.com/ylsideas/cockroachdb-laravel/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/ylsideas/cockroachdb-laravel.svg?style=flat-square)](https://packagist.org/packages/ylsideas/cockroachdb-laravel)
 
----
-This repo can be used to scaffold a Laravel package. Follow these steps to get started:
-
-1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this cockroachdb-laravel
-2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files
-3. Remove this block of text.
-4. Have fun creating your package.
-5. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
----
-
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
-
-## Support us
-
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/cockroachdb-laravel.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/cockroachdb-laravel)
-
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
+A driver/grammar for Laravel that works with CockroachDB. This is currently an alpha.
+All tests pass, but you may run into bugs potentially going forward.
 
 ## Installation
 
@@ -35,40 +16,41 @@ You can install the package via composer:
 composer require ylsideas/cockroachdb-laravel
 ```
 
-You can publish and run the migrations with:
-
-```bash
-php artisan vendor:publish --tag="cockroachdb-laravel_without_prefix-migrations"
-php artisan migrate
-```
-
-You can publish the config file with:
-```bash
-php artisan vendor:publish --tag="cockroachdb-laravel_without_prefix-config"
-```
-
-Optionally, you can publish the views using
-
-```bash
-php artisan vendor:publish --tag="example-views"
-```
-
-This is the contents of the published config file:
-
+You need to add the connection type to the database config:
 ```php
-return [
-];
+'crdb' => [
+    'driver' => 'crdb',
+    'url' => env('DATABASE_URL'),
+    'host' => env('DB_HOST', '127.0.0.1'),
+    'port' => env('DB_PORT', '26257'),
+    'database' => env('DB_DATABASE', 'forge'),
+    'username' => env('DB_USERNAME', 'forge'),
+    'password' => env('DB_PASSWORD', ''),
+    'charset' => 'utf8',
+    'prefix' => '',
+    'prefix_indexes' => true,
+    'schema' => 'public',
+    'sslmode' => 'prefer',
+]
 ```
 
 ## Usage
 
-```php
-$cockroachdb-laravel = new YlsIdeas\CockroachDb();
-echo $cockroachdb-laravel->echoPhrase('Hello, YlsIdeas!');
-```
+To enable set `DB_CONNECTION=crdb` in your .env.
+
+## Notes
+
+CockroachDB does not support performing deletes using joins. If you wish to
+do something like this you will need to use a sub-query instead.
 
 ## Testing
 
+The tests try to closely follow the same functionality of the grammar provided by Laravel
+by lifting the tests straight from laravel/framework. This does provide some complications.
+Namely, cockroachdb is designed to be distributed so primary keys do not occur in sequence.
+Also deletes with joins do not work compared to other Laravel supported databases so the 
+delete with limit test uses a sub query instead.
+
 ```bash
 composer test
 ```

README.md

@@ -18,9 +18,10 @@
     "require": {
         "php": "^8.0",
         "spatie/laravel-package-tools": "^1.9.2",
-        "illuminate/contracts": "^8.73"
+        "illuminate/contracts": "8.*"
     },
     "require-dev": {
+        "doctrine/dbal": "^3.2",
         "nunomaduro/collision": "^5.10",
         "nunomaduro/larastan": "^1.0",
         "orchestra/testbench": "^6.22",
@@ -55,10 +56,7 @@
         "laravel": {
             "providers": [
                 "YlsIdeas\\CockroachDb\\CockroachDbServiceProvider"
-            ],
-            "aliases": {
-                "CockroachDb": "YlsIdeas\\CockroachDb\\Facades\\CockroachDb"
-            }
+            ]
         }
     },
     "minimum-stability": "dev",