implement basic index (without search) (#3)

Author: wachterjohannes

.gitignore

@@ -0,0 +1 @@
+.docker/data

PuceneAdapter.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of Pucene.
+ *
+ * (c) asapo.at
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Pucene\SealAdapter;
+
+use Pucene\Index\Driver\DriverFactoryInterface;
+use Pucene\Index\PuceneIndexFactory;
+use Schranz\Search\SEAL\Adapter\AdapterInterface;
+use Schranz\Search\SEAL\Adapter\ConnectionInterface;
+use Schranz\Search\SEAL\Adapter\SchemaManagerInterface;
+
+class PuceneAdapter implements AdapterInterface
+{
+    public static function createFromFactories(
+        PuceneIndexFactory $indexFactory,
+        DriverFactoryInterface $driverFactory,
+    ): self {
+        return new self(
+            new PuceneConnection($indexFactory),
+            new PuceneSchemaManager($driverFactory),
+        );
+    }
+
+    private readonly ConnectionInterface $connection;
+
+    private readonly SchemaManagerInterface $schemaManager;
+
+    public function __construct(
+        ConnectionInterface $connection,
+        SchemaManagerInterface $schemaManager,
+    ) {
+        $this->connection = $connection;
+        $this->schemaManager = $schemaManager;
+    }
+
+    public function getSchemaManager(): SchemaManagerInterface
+    {
+        return $this->schemaManager;
+    }
+
+    public function getConnection(): ConnectionInterface
+    {
+        return $this->connection;
+    }
+}

PuceneConnection.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of Pucene.
+ *
+ * (c) asapo.at
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Pucene\SealAdapter;
+
+use Pucene\Index\PuceneIndexFactory;
+use Schranz\Search\SEAL\Adapter\ConnectionInterface;
+use Schranz\Search\SEAL\Schema\Index;
+use Schranz\Search\SEAL\Search\Result;
+use Schranz\Search\SEAL\Search\Search;
+
+class PuceneConnection implements ConnectionInterface
+{
+    public function __construct(
+        private PuceneIndexFactory $indexFactory,
+    ) {
+    }
+
+    /**
+     * @param mixed[] $document
+     *
+     * @return mixed[]
+     */
+    public function save(Index $index, array $document): array
+    {
+        return $this->indexFactory->create($index)->save($document);
+    }
+
+    public function delete(Index $index, string $identifier): void
+    {
+        $this->indexFactory->create($index)->delete($identifier);
+    }
+
+    public function search(Search $search): Result
+    {
+        // TODO: Implement search() method.
+
+        return new Result($this->mockGenerator(), 1);
+    }
+
+    private function mockGenerator(): \Generator
+    {
+        yield ['id' => 1];
+    }
+}

PuceneSchemaManager.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of Pucene.
+ *
+ * (c) asapo.at
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Pucene\SealAdapter;
+
+use Pucene\Index\Driver\DriverFactoryInterface;
+use Schranz\Search\SEAL\Adapter\SchemaManagerInterface;
+use Schranz\Search\SEAL\Schema\Index;
+
+class PuceneSchemaManager implements SchemaManagerInterface
+{
+    public function __construct(
+        private DriverFactoryInterface $driverFactory,
+    ) {
+    }
+
+    public function existIndex(Index $index): bool
+    {
+        return $this->driverFactory->create($index)->isInitialized();
+    }
+
+    public function dropIndex(Index $index): void
+    {
+        $this->driverFactory->create($index)->drop();
+    }
+
+    public function createIndex(Index $index): void
+    {
+        $this->driverFactory->create($index)->initialize();
+    }
+}

README.md

@@ -1 +1,43 @@
 # Pucene: Seal Adapter
+
+Adapter package that glues pucene into SEAL universe.
+
+> This is a subtree split of the `pucene/pucene` project create issues in the [main repository](https://github.com/pucene/pucene).
+
+## Usage
+
+```php
+<?php
+
+use Doctrine\DBAL\DriverManager;
+use Pucene\Analysis\StandardAnalyzer;
+use Pucene\DbalDriver\DbalDriverFactory;
+use Pucene\Index\PuceneIndexFactory;
+use Pucene\SealAdapter\PuceneAdapter;
+use Schranz\Search\SEAL\Schema\Index;
+use Schranz\Search\SEAL\Schema\Schema;
+use Schranz\Search\SEAL\Schema\Field;
+
+$dbalConnection = DriverManager::getConnection([
+    'url' => 'mysql://[email protected]:3306/pucene?serverVersion=8.0',
+]);
+$driverFactory = new DbalDriverFactory($dbalConnection);
+
+$adapter = PuceneAdapter::createFromFactories(
+    new PuceneIndexFactory(
+        $driverFactory,
+        new StandardAnalyzer(),
+    ),
+    $driverFactory,
+);
+
+$engine = new Engine(
+    $adapter,
+    new Schema([
+        'blog' => new Index('blog', [
+            'id' => new Field\IdentifierField('id'),
+            'title' => new Field\TextField('title'),
+        ]),
+    ]),
+);
+```

Tests/.gitkeep

@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of Pucene.
+ *
+ * (c) asapo.at
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Tests;
+
+use Doctrine\DBAL\DriverManager;
+use Pucene\Analysis\StandardAnalyzer;
+use Pucene\DbalDriver\DbalDriverFactory;
+use Pucene\Index\PuceneIndexFactory;
+use Pucene\SealAdapter\PuceneAdapter;
+use Schranz\Search\SEAL\Testing\AbstractAdapterTestCase;
+
+class PuceneAdapterTest extends AbstractAdapterTestCase
+{
+    public static function setUpBeforeClass(): void
+    {
+        $dbalConnection = DriverManager::getConnection([
+            'url' => 'mysql://[email protected]:3306/pucene?serverVersion=8.0',
+        ]);
+        $driverFactory = new DbalDriverFactory($dbalConnection);
+
+        self::$adapter = PuceneAdapter::createFromFactories(
+            new PuceneIndexFactory(
+                $driverFactory,
+                new StandardAnalyzer(),
+            ),
+            $driverFactory,
+        );
+    }
+
+    public function testDocument(): void
+    {
+        $this->markTestSkipped();
+    }
+}

Tests/PuceneAdapterTest.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of Pucene.
+ *
+ * (c) asapo.at
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Tests;
+
+use Doctrine\DBAL\DriverManager;
+use Pucene\DbalDriver\DbalDriverFactory;
+use Pucene\SealAdapter\PuceneSchemaManager;
+use Schranz\Search\SEAL\Testing\AbstractSchemaManagerTestCase;
+
+class PuceneSchemaManagerTest extends AbstractSchemaManagerTestCase
+{
+    public static function setUpBeforeClass(): void
+    {
+        $dbalConnection = DriverManager::getConnection([
+            'url' => 'mysql://[email protected]:3306/pucene?serverVersion=8.0',
+        ]);
+        $driverFactory = new DbalDriverFactory($dbalConnection);
+
+        self::$schemaManager = new PuceneSchemaManager($driverFactory);
+    }
+}

Tests/PuceneSchemaManagerTest.php

@@ -24,6 +24,8 @@
     ],
     "require": {
         "php": "^8.1",
+        "pucene/index": "^0.1@dev",
+        "pucene/dbal-driver": "^0.1@dev",
         "schranz-search/seal": "^0.1@dev"
     },
     "require-dev": {
@@ -34,5 +36,28 @@
         "test": "@phpunit Tests",
         "phpunit": "vendor/bin/phpunit --bootstrap vendor/autoload.php"
     },
-    "minimum-stability": "dev"
+    "minimum-stability": "dev",
+    "repositories": [
+        {
+            "type": "path",
+            "url": "../analysis",
+            "options": {
+                "symlink": true
+            }
+        },
+        {
+            "type": "path",
+            "url": "../dbal-driver",
+            "options": {
+                "symlink": true
+            }
+        },
+        {
+            "type": "path",
+            "url": "../index",
+            "options": {
+                "symlink": true
+            }
+        }
+    ]
 }

composer.json

@@ -0,0 +1,13 @@
+version: '3'
+
+services:
+    database:
+        image: mysql/mysql-server:8.0
+        environment:
+            MYSQL_DATABASE: pucene
+            MYSQL_ALLOW_EMPTY_PASSWORD: 1
+            MYSQL_ROOT_HOST: '%'
+        ports:
+            - 3306:3306
+        volumes:
+            - ./.docker/data/mysql:/var/lib/mysql