Feature/initial implementation

.gitignore

@@ -5,6 +5,7 @@
 !var/cache/.gitkeep
 /var/log/*
 !var/log/.gitkeep
+/var/test/*
 /tools
 .phpactor.json
 composer.lock

README.md

@@ -1,5 +1,11 @@
-[![codecov](https://codecov.io/gh/sitepark/atoolo-resource/graph/badge.svg?token=QwvDRxKEa2)](https://codecov.io/gh/sitepark/atoolo-resource)
+[![codecov](https://codecov.io/gh/sitepark/atoolo-search/graph/badge.svg?token=xBMwUzm34b)](https://codecov.io/gh/sitepark/atoolo-search)
+![phpstan](https://img.shields.io/badge/PHPStan-level%209-brightgreen)
+![php](https://img.shields.io/badge/PHP-8.1-blue)
+![php](https://img.shields.io/badge/PHP-8.2-blue)
+![php](https://img.shields.io/badge/PHP-8.3-blue)
 
 # Atoolo search
 
-Provides services with which a Solr index can be filled and searched for [resources](https://github.com/sitepark/atoolo-resource) via this index.
+Provides services with which a Solr index can be filled and searched for [resources](https://github.com/sitepark/atoolo-resource) via a index.
+
+[Documentation](https://sitepark.github.io/atoolo-docs/develop/components/search/)

bin/console

@@ -0,0 +1,20 @@
+#!/usr/bin/env php
+<?php
+// application.php
+
+require __DIR__.'/../vendor/autoload.php';
+
+use Atoolo\Search\Console\Application;
+use Symfony\Component\Config\FileLocator;
+
+$container = new Symfony\Component\DependencyInjection\ContainerBuilder();
+$loader    = new Symfony\Component\DependencyInjection\Loader\YamlFileLoader(
+    $container,
+    new FileLocator(__DIR__ . '/../config'));
+
+$loader->load('commands.yml');
+$container->compile();
+
+$application = $container->get(Application::class);
+
+$application->run();

composer.json

@@ -21,22 +21,26 @@
     "prefer-stable": true,
     "require": {
         "php": ">=8.1 <8.4.0",
-        "atoolo/resource": "dev-feature/hierarchy-loader",
+        "atoolo/resource": "dev-main",
         "solarium/solarium": "^6.3",
-        "symfony/config": "^6.3",
-        "symfony/console": "^6.3",
-        "symfony/dependency-injection": "^6.3",
-        "symfony/event-dispatcher": "^6.3",
-        "symfony/finder": "^6.3",
-        "symfony/yaml": "^6.3"
+        "symfony/config": "^6.3 | ^7.0",
+        "symfony/console": "^6.3 | ^7.0",
+        "symfony/dependency-injection": "^6.3 | ^7.0",
+        "symfony/event-dispatcher": "^6.3 | ^7.0",
+        "symfony/finder": "^6.3 | ^7.0",
+        "symfony/lock": "^6.3 | ^7.0",
+        "symfony/property-access": "^6.3 | ^7.0",
+        "symfony/serializer": "^6.3 | ^7.0",
+        "symfony/yaml": "^6.3 | ^7.0"
     },
     "require-dev": {
         "dealerdirect/phpcodesniffer-composer-installer": "^1.0",
         "infection/infection": "^0.27.6",
         "phpcompatibility/php-compatibility": "^9.3",
         "phpunit/phpunit": "^10.4",
         "roave/security-advisories": "dev-latest",
-        "squizlabs/php_codesniffer": "^3.7"
+        "squizlabs/php_codesniffer": "^3.7",
+        "symfony/filesystem": "^6.3 | ^7.0"
     },
     "scripts": {
 
@@ -77,5 +81,7 @@
             "*": "dist"
         },
         "sort-packages": true
+    },
+    "repositories": {
     }
 }

config/commands.yml

@@ -0,0 +1,23 @@
+services:
+    _defaults:
+        autowire: true
+        autoconfigure: true
+    _instanceof:
+        Symfony\Component\Console\Command\Command:
+            tags: ['command']
+
+    Atoolo\Search\Console\:
+        resource: '../src/Console'
+
+    Atoolo\Search\Console\Command\Indexer:
+      arguments:
+        - !tagged_iterator { tag: 'atoolo.search.indexer.documentEnricher.schema2x' }
+
+    Atoolo\Search\Console\Command\DumpIndexDocument:
+      arguments:
+        - !tagged_iterator { tag: 'atoolo.search.indexer.documentEnricher.schema2x' }
+
+    Atoolo\Search\Console\Application:
+        public: true
+        arguments:
+            - !tagged command

phpunit.xml

@@ -5,9 +5,14 @@
 		bootstrap="vendor/autoload.php"
 		executionOrder="random"
 		cacheResultFile="var/cache/.phpunit.result.cache"
-		cacheDirectory="var/cache/.phpunit.cache">
+		cacheDirectory="var/cache/.phpunit.cache"
+		displayDetailsOnTestsThatTriggerDeprecations="true"
+		displayDetailsOnTestsThatTriggerErrors="true"
+		displayDetailsOnTestsThatTriggerNotices="true"
+		displayDetailsOnTestsThatTriggerWarnings="true">
 
-	<coverage>
+	<coverage
+			disableCodeCoverageIgnore="false">
 		<report>
 			<clover outputFile="var/log/clover/clover.xml"/>
 			<html outputDirectory="var/log/clover"/>

src/Console/Application.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atoolo\Search\Console;
+
+use Symfony\Component\Console\Application as BaseApplication;
+use Symfony\Component\Console\Command\Command;
+
+class Application extends BaseApplication
+{
+    /**
+     * @param iterable<Command> $commands
+     */
+    public function __construct(iterable $commands = [])
+    {
+        parent::__construct();
+        foreach ($commands as $command) {
+            $this->add($command);
+        }
+    }
+}

src/Console/Command/DumpIndexDocument.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atoolo\Search\Console\Command;
+
+use Atoolo\Search\Console\Command\Io\TypifiedInput;
+use Atoolo\Search\Service\Indexer\DocumentEnricher;
+use Atoolo\Search\Service\Indexer\IndexDocument;
+use JsonException;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+#[AsCommand(
+    name: 'atoolo:dump-index-document',
+    description: 'Dump a index document'
+)]
+class DumpIndexDocument extends Command
+{
+    /**
+     * phpcs:ignore
+     * @param iterable<DocumentEnricher<IndexDocument>> $documentEnricherList
+     */
+    public function __construct(
+        private readonly iterable $documentEnricherList,
+        private readonly IndexDocumentDumperBuilder $indexDocumentDumperBuilder
+    ) {
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setHelp('Command to dump a index-document')
+            ->addArgument(
+                'resource-dir',
+                InputArgument::REQUIRED,
+                'Resource directory whose data is to be indexed.'
+            )
+            ->addArgument(
+                'paths',
+                InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
+                'Resources paths or directories of resources to be indexed.'
+            )
+        ;
+    }
+
+    /**
+     * @throws JsonException
+     */
+    protected function execute(
+        InputInterface $input,
+        OutputInterface $output
+    ): int {
+
+        $typedInput = new TypifiedInput($input);
+
+        $resourceDir = $typedInput->getStringArgument('resource-dir');
+
+        $dumper = $this->indexDocumentDumperBuilder
+            ->resourceDir($resourceDir)
+            ->documentEnricherList($this->documentEnricherList)
+            ->build();
+
+        $paths = $typedInput->getArrayArgument('paths');
+        $dump = $dumper->dump($paths);
+
+        foreach ($dump as $fields) {
+            $output->writeln(json_encode(
+                $fields,
+                JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT
+            ));
+        }
+
+        return Command::SUCCESS;
+    }
+}

src/Console/Command/IndexDocumentDumperBuilder.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atoolo\Search\Console\Command;
+
+use Atoolo\Resource\Loader\SiteKitLoader;
+use Atoolo\Search\Service\Indexer\DocumentEnricher;
+use Atoolo\Search\Service\Indexer\IndexDocument;
+use Atoolo\Search\Service\Indexer\IndexDocumentDumper;
+
+class IndexDocumentDumperBuilder
+{
+    private string $resourceDir;
+    /**
+     * phpcs:ignore
+     * @var iterable<DocumentEnricher<IndexDocument>>
+     */
+    private iterable $documentEnricherList;
+
+    public function __construct(
+        private readonly ResourceBaseLocatorBuilder $resourceBaseLocatorBuilder
+    ) {
+    }
+
+    public function resourceDir(string $resourceDir): IndexDocumentDumperBuilder
+    {
+        $this->resourceDir = $resourceDir;
+        return $this;
+    }
+
+    /**
+     * phpcs:ignore
+     * @param iterable<DocumentEnricher<IndexDocument>> $documentEnricherList
+     */
+    public function documentEnricherList(
+        iterable $documentEnricherList
+    ): IndexDocumentDumperBuilder {
+        $this->documentEnricherList = $documentEnricherList;
+        return $this;
+    }
+
+    public function build(): IndexDocumentDumper
+    {
+        $resourceBaseLocator = $this->resourceBaseLocatorBuilder->build(
+            $this->resourceDir
+        );
+
+        $resourceLoader = new SiteKitLoader($resourceBaseLocator);
+
+        return new IndexDocumentDumper(
+            $resourceLoader,
+            $this->documentEnricherList
+        );
+    }
+}