init

Author: butschster

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.yml]
+indent_size = 2

.gitattributes

@@ -0,0 +1 @@
+* text=auto

.gitignore

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

README.md

@@ -0,0 +1,201 @@
+# Cycle ORM integration for the Laravel Framework
+
+**!!! Important note!!!**
+At this moment this package work only with postgres database driver.
+
+### Requirements
+- Laravel 7.x
+- PHP 7.4 and above
+
+## Installation and Configuration
+
+From the command line run
+```shell script
+composer require butschster/cycle-orm
+```
+
+### Env variables
+
+```
+DB_CONNECTION=postgres
+DB_HOST=127.0.0.1
+DB_PORT= # Default port 5432
+DB_DATABASE=homestead
+DB_USERNAME=root
+DB_PASSWORD=
+
+DB_MIGRATIONS_TABLE=migrations # Migrations table name
+
+DB_SCHEMA_SYNC=false # Sync DB schema without migrations
+DB_SCHEMA_CACHE=true # Cache DB schema
+DB_SCHEMA_CACHE_DRIVER=file # DB schema cache driver
+```
+
+### Configuration
+
+Publish the config file.
+```shell script
+php artisan vendor:publish --provider="Butschster\Cycle\Providers\LaravelServiceProvider" --tag=config
+```
+
+**That's it!**
+
+### Console commands
+
+#### php artisan cycle:migrate
+Run cycle orm migrations from directory.
+
+#### php artisan cycle:refresh
+Refresh database schema.
+
+## Usage
+By default, class locator looks for entities in app folder. You can specify locations in `config/cycle.php` config file.
+
+```php
+...
+'directories' => [
+    app_path(),
+],
+...
+```
+
+### Example
+
+#### User
+```php
+<?php
+namespace App;
+
+use Illuminate\Contracts\Auth\Authenticatable;
+
+/**
+ * @ORM\Entity(
+ *     table="users",
+ *     repository="App\UserRepository",
+ * )
+ */
+class User implements Authenticatable
+{
+    /** @ORM\Column(type="uuid", primary=true) */
+    protected string $id;
+
+    /** @ORM\Column(type="string") */
+    protected string $password;
+
+    /** @ORM\Column(type="string") */
+    protected string $rememberToken = '';
+
+    public function getId(): string
+    {
+        return $this->id;
+    }
+
+    /**
+     * @return string
+     */
+    public function getAuthIdentifierName(): string
+    {
+        return 'id';
+    }
+
+    /**
+     * @return string
+     */
+    public function getAuthIdentifier(): string
+    {
+        return $this->getId();
+    }
+
+    /**
+     * @return string
+     */
+    public function getAuthPassword(): string
+    {
+        return $this->password;
+    }
+
+    /**
+     * @param string $password
+     */
+    public function setAuthPassword(string $password): void
+    {
+        $this->password = $password;
+    }
+
+    /**
+     * @return string
+     */
+    public function getRememberToken(): string
+    {
+        return $this->rememberToken;
+    }
+
+    /**
+     * @param string $value
+     */
+    public function setRememberToken($value): void
+    {
+        $this->rememberToken = $value;
+    }
+
+    /**
+     * @return string
+     */
+    public function getRememberTokenName(): string
+    {
+        return 'rememberToken';
+    }
+}
+```
+
+#### Repository
+```php
+namespace App;
+
+use Butschster\Cycle\Repository;
+
+class UserRepository extends Repository
+{
+    /** @inheritDoc */
+    public function findByUsername(string $username): ?User
+    {
+        return $this->findOne(['username' => $username]);
+    }
+}
+```
+
+#### Create user
+```php
+use Cycle\ORM\ORMInterface;
+use Butschster\Cycle\Facades\ORM;
+
+$user = new User();
+$repository = app(ORMInterface::class)->getRepository($user);
+// or
+$repository = ORM::getRepository($user);
+// or
+$repository = ORM::getRepository(User::class);
+
+$repository->persist($user);
+```
+
+#### Update user
+```php
+use Butschster\Cycle\Facades\ORM;
+
+$repository = ORM::getRepository(User::class);
+$user = $repository->findByPK('5c9e177b0a975a6eeccf5960');
+$user->setAuthPassword('secret');
+
+$repository->persist($user);
+```
+
+#### Delete user
+```php
+use Butschster\Cycle\Facades\ORM;
+
+$repository = ORM::getRepository(User::class);
+$user = $repository->findByPK('5c9e177b0a975a6eeccf5960');
+
+$repository->delete($user);
+```

composer.json

@@ -0,0 +1,56 @@
+{
+    "name": "butschster/cycle-orm",
+    "description": "Cycle ORM integration for the Laravel Framework",
+    "keywords": [
+        "laravel",
+        "lumen",
+        "orm",
+        "database",
+        "cycle"
+    ],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Pavel Buchnev",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": "^7.4",
+        "illuminate/config": "^7.0",
+        "illuminate/database": "^7.0",
+        "illuminate/support": "^7.0",
+        "illuminate/contracts": "^7.0",
+        "illuminate/console": "^7.0",
+        "illuminate/pagination": "^7.0",
+        "cycle/annotated": "^2.0",
+        "cycle/migrations": "^1.0",
+        "cycle/orm": "^1.2",
+        "cycle/proxy-factory": "^1.2.1",
+        "cycle/schema-builder": "^1.1"
+    },
+    "require-dev": {
+        "fzaninotto/faker": "^1.9.1",
+        "mockery/mockery": "^1.0",
+        "phpunit/phpunit": "^7.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Butschster\\Cycle\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Butschster\\Tests\\": "tests/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Butschster\\Cycle\\Providers\\LaravelServiceProvider"
+            ]
+        }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
+}

config/cycle.php

@@ -0,0 +1,70 @@
+<?php
+
+use Cycle\ORM\Schema;
+
+return [
+    'directories' => [
+        app_path(),
+    ],
+
+    'database' => [
+        'default' => 'default',
+
+        'databases' => [
+            'default' => [
+                'connection' => env('DB_CONNECTION', 'postgres'),
+            ],
+        ],
+
+        'connections' => [
+            'postgres' => [
+                'driver' => Spiral\Database\Driver\Postgres\PostgresDriver::class,
+                'options' => [
+                    'connection' => sprintf(
+                        'pgsql:host=%s;port=%d;dbname=%s;',
+                        env('DB_HOST', '127.0.0.1'),
+                        env('DB_PORT', '5432'),
+                        env('DB_DATABASE', 'homestead')
+                    ),
+                    'username' => env('DB_USERNAME', 'root'),
+                    'password' => env('DB_PASSWORD'),
+                ],
+            ],
+        ],
+    ],
+
+    'schema' => [
+        // Sync db schema with database without migrations
+        'sync' => env('DB_SCHEMA_SYNC', false),
+
+        // Cache schema
+        // Кеширование схемы. После изменение сущности необходимо будет сбрасывать схему
+        'cache' => [
+            'storage' => env('DB_SCHEMA_CACHE_DRIVER', 'file'),
+            'enabled' => (bool)env('DB_SCHEMA_CACHE', true),
+        ],
+
+        'defaults' => [
+            Schema::MAPPER => Butschster\Cycle\Mapper::class,
+            Schema::REPOSITORY => Butschster\Cycle\Repository::class,
+            Schema::SOURCE => Cycle\ORM\Select\Source::class,
+        ],
+    ],
+
+    'migrations' => [
+        'directory' => database_path('migrations/cycle/'),
+        'table' => env('DB_MIGRATIONS_TABLE', 'migrations'),
+    ],
+
+    // https://cycle-orm.dev/docs/advanced-promise#proxies-and-promises
+    'relations' => [
+        'materializer' => [
+            'driver' => env('DB_MATERIALIZER_DRIVER', 'eval'),
+            'drivers' => [
+                'file' => [
+                    'path' => storage_path('framework/cache/entities'),
+                ]
+            ]
+        ],
+    ],
+];

phpunit.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>