Add CUID2 support: trait, cuid2() helper and schema macros

Author: mcandylab

.github/workflows/main.yml

@@ -2,44 +2,52 @@ name: run-tests
 
 on:
     push:
-        branches: [master]
+        branches: [main]
     pull_request:
-        branches: [master]
+        branches: [main]
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: true
 
 jobs:
     test:
-        runs-on: ${{ matrix.os }}
+        runs-on: ubuntu-latest
         strategy:
-            fail-fast: true
+            fail-fast: false
             matrix:
-                os: [ubuntu-latest, windows-latest]
-                php: [7.4, 8.0]
-                laravel: [8.*]
-                stability: [prefer-lowest, prefer-stable]
+                php: ['8.2', '8.3', '8.4', '8.5']
+                laravel: ['12.*', '13.*']
+                stability: [prefer-stable]
                 include:
-                    - laravel: 8.*
-                      testbench: ^6.6
+                    - laravel: '12.*'
+                      testbench: '10.*'
+                    - laravel: '13.*'
+                      testbench: '11.*'
+                exclude:
+                    # Laravel 13 requires PHP 8.3+
+                    - laravel: '13.*'
+                      php: '8.2'
 
-        name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
+        name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }}
 
         steps:
             - name: Checkout code
-              uses: actions/checkout@v2
+              uses: actions/checkout@v4
 
             - 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, pdo, sqlite, pdo_sqlite, bcmath, gmp
                   coverage: none
 
-            - name: Setup problem matchers
-              run: |
-                  echo "::add-matcher::${{ runner.tool_cache }}/php.json"
-                  echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
             - name: Install dependencies
               run: |
-                  composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
+                  # Don't let a security advisory on an older stable release block the CI matrix.
+                  composer config policy.advisories.block false
+                  composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --dev --no-interaction --no-update
                   composer update --${{ matrix.stability }} --prefer-dist --no-interaction
+
             - name: Execute tests
               run: vendor/bin/phpunit

.gitignore

@@ -0,0 +1,6 @@
+/vendor
+/.idea
+composer.lock
+.phpunit.result.cache
+.phpunit.cache
+build

.idea/.gitignore

@@ -1,7 +1,21 @@
 # Changelog
 
-All notable changes to `laravel-cuid2` will be documented in this file
+All notable changes to `laravel-cuid2` will be documented in this file.
 
-## 1.0.0 - 201X-XX-XX
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-- initial release
+## 1.0.0 - 2026-07-12
+
+### Added
+
+- `HasCuid2` trait that auto-populates a model's primary key with a CUID2 on create,
+  sets `keyType` to `string` and disables auto-incrementing, and supports additional
+  columns via `uniqueIds()`.
+- Global `cuid2()` helper for generating identifiers, with a configurable length.
+- `cuid2()` and `foreignCuid2()` schema blueprint macros for migrations.
+- `LaravelCuid2` facade with `generate()` and `isValid()` methods.
+- Publishable configuration file with a `length` option (default `24`).
+- Support for PHP 8.2+ and Laravel 12 and 13 (Laravel 13 requires PHP 8.3+).
+
+Generation is powered by the [`visus/cuid2`](https://github.com/visus-io/php-cuid2) library.

.idea/laravel-cuid2.iml

@@ -1,52 +1,129 @@
-# Very short description of the package
+# Laravel CUID2
+
+[🇬🇧 **English**](README.md) | [🇷🇺 Русский](README.ru.md)
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/mcandylab/laravel-cuid2.svg?style=flat-square)](https://packagist.org/packages/mcandylab/laravel-cuid2)
 [![Total Downloads](https://img.shields.io/packagist/dt/mcandylab/laravel-cuid2.svg?style=flat-square)](https://packagist.org/packages/mcandylab/laravel-cuid2)
-![GitHub Actions](https://github.com/mcandylab/laravel-cuid2/actions/workflows/main.yml/badge.svg)
+[![run-tests](https://github.com/mcandylab/laravel-cuid2/actions/workflows/main.yml/badge.svg)](https://github.com/mcandylab/laravel-cuid2/actions/workflows/main.yml)
 
-This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.
+Use [CUID2](https://github.com/paralleldrive/cuid2) as primary keys for your Eloquent
+models in Laravel. The package provides a model trait, a global `cuid2()` helper and
+schema macros for migrations. Generation is delegated to the
+[`visus/cuid2`](https://github.com/visus-io/php-cuid2) library.
 
-## Installation
+## Requirements
 
-You can install the package via composer:
+- PHP >= 8.2
+- Laravel 12 or 13 (Laravel 13 requires PHP 8.3+)
+
+## Installation
 
 ```bash
 composer require mcandylab/laravel-cuid2
 ```
 
+The package uses auto-discovery. Publish the config if needed:
+
+```bash
+php artisan vendor:publish --provider="Mcandylab\LaravelCuid2\LaravelCuid2ServiceProvider" --tag="config"
+```
+
 ## Usage
 
+### Model trait
+
+Add the `HasCuid2` trait — the primary key will be automatically populated with a
+valid CUID2 when a record is created:
+
+```php
+use Illuminate\Database\Eloquent\Model;
+use Mcandylab\LaravelCuid2\Concerns\HasCuid2;
+
+class Post extends Model
+{
+    use HasCuid2;
+}
+```
+
+The trait sets `keyType = 'string'` and `incrementing = false` for you.
+To generate a cuid2 for more than just the primary key, override `uniqueIds()`:
+
+```php
+public function uniqueIds(): array
+{
+    return [$this->getKeyName(), 'public_id'];
+}
+```
+
+### Migrations
+
+The `cuid2()` and `foreignCuid2()` macros declare `char` columns of the configured length:
+
+```php
+Schema::create('posts', function (Blueprint $table) {
+    $table->cuid2()->primary();      // id column
+    $table->string('title');
+    $table->timestamps();
+});
+
+Schema::create('comments', function (Blueprint $table) {
+    $table->cuid2()->primary();
+    $table->foreignCuid2('post_id')->constrained();
+    $table->text('body');
+});
+```
+
+### Helper
+
+```php
+$id = cuid2();      // 24 characters (or config('laravel-cuid2.length'))
+$short = cuid2(10); // arbitrary length 4..32
+```
+
+### Facade
+
 ```php
-// Usage description here
+use Mcandylab\LaravelCuid2\LaravelCuid2Facade as Cuid2;
+
+Cuid2::generate();          // generate an id
+Cuid2::isValid($someId);    // validate a string
 ```
 
-### Testing
+## Configuration
+
+`config/laravel-cuid2.php`:
+
+```php
+return [
+    // Identifier length (4..32). The cuid2 standard is 24.
+    'length' => (int) env('CUID2_LENGTH', 24),
+];
+```
+
+## Testing
 
 ```bash
 composer test
 ```
 
-### Changelog
+## Changelog
 
-Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+See [CHANGELOG](CHANGELOG.md).
 
 ## Contributing
 
-Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+See [CONTRIBUTING](CONTRIBUTING.md).
 
-### Security
+## Security
 
-If you discover any security related issues, please email an.abramov@internet.ru instead of using the issue tracker.
+If you discover any security related issues, please [open an issue](https://github.com/mcandylab/laravel-cuid2/issues).
 
 ## Credits
 
--   [Andrey Abramov](https://github.com/mcandylab)
--   [All Contributors](../../contributors)
+- [Andrey Abramov](https://github.com/mcandylab)
+- [All Contributors](../../contributors)
+- [visus-io/php-cuid2](https://github.com/visus-io/php-cuid2)
 
 ## License
 
-The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
-
-## Laravel Package Boilerplate
-
-This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).
+The MIT License (MIT). See [License File](LICENSE.md).