Merge pull request #3 from OS2web/sprint-3

OS2Forms Sprint 3

Author: andriyun

.travis.yml

@@ -13,16 +13,16 @@ install:
   - nvm install node
   - nvm use node
   - npm install --global yarn
-  - cd ../ && drush dl drupal-8 --drupal-project-rename=drupal
+  - cd ../ && composer create-project drupal-composer/drupal-project:8.x-dev drupal --no-interaction
   - cd drupal
-  - DRUPAL_ROOT=$(pwd)
+  - DRUPAL_ROOT=$(pwd)/web
   - export REPOSITORIES='"repositories":\ \['
   - export REPOSITORIES_REPLACE='"repositories":\[\{"type":"path","url":"..\/os2web_datalookup","options":\{"symlink":false\}\},'
   - export REQUIRE='"require":\ {'
   - export REQUIRE_REPLACE='"require":{"os2web\/os2web_datalookup":"\*",'
   - sed -i "s/$REPOSITORIES/$REPOSITORIES_REPLACE/g" composer.json
   - sed -i "s/$REQUIRE/$REQUIRE_REPLACE/g" composer.json
-  - composer update
+  - composer update os2web/os2web_datalookup
   - PROJECT_PATH=$DRUPAL_ROOT/modules/contrib/os2web_datalookup
   - cd $DRUPAL_ROOT/core
   - yarn install

README.md

@@ -32,3 +32,21 @@ See [OS2Web code review policy](https://github.com/OS2Web/docs#code-review)
 
 ### Git name convention
 See [OS2Web git name convention](https://github.com/OS2Web/docs#git-guideline)
+
+### Using services in other modules
+
+```
+\Drupal::service('plugin.manager.os2web_datalookup')->createInstance('serviceplatformen_cvr')->getLegalUnit('[CVR number]')
+\Drupal::service('plugin.manager.os2web_datalookup')->createInstance('serviceplatformen_cpr')->cprBasicInformation('[CPR number]'))
+```
+
+## New services/features
+
+### Datafordeler integration (https://datafordeler.dk)
+
+In scope of os2forms project already implemented light integration
+with Danmarks Adresseregister (DAR) via fetching data for form elements
+autocomplete. See [os2forms_dawa submodule](https://github.com/OS2Forms/os2forms)
+
+As soon as it is clear how the integration is going to be used, then
+os2forms_dawa will be refactored to OS2Web Data lookup plugin plugin.

composer.json

@@ -5,6 +5,9 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "license": "EUPL-1.2",
+    "require": {
+        "ext-soap": "*"
+    },
     "repositories": {
         "drupal": {
             "type": "composer",

os2web_datalookup.services.yml

@@ -1,4 +1,4 @@
 services:
   plugin.manager.os2web_datalookup:
     class: Drupal\os2web_datalookup\Plugin\DataLookupManager
-    parent: default_plugin_manager
+    arguments: ['@container.namespaces', '@cache.discovery', '@module_handler', '@config.factory']

src/Controller/DatalookupController.php

@@ -52,15 +52,11 @@ public function statusList() {
 
     $rows = [];
     foreach ($this->manager->getDefinitions() as $id => $plugin_definition) {
-      /** @var \Drupal\os2web_datalookup\Plugin\os2web\DataLookup\DataLookupInterface $plugin */
       $plugin = $this->manager->createInstance($id);
       $status = $plugin->getStatus();
-      if (empty($status)) {
-        $status = $this->t('Failed');
-      }
       $rows[$id] = [
         'title' => $plugin_definition['label'],
-        'status' => $status,
+        'status' => ($plugin->isReady() ? $this->t('READY') : $this->t('ERROR')) . ': ' . $status,
         'action' => Link::createFromRoute($this->t('Settings'), "os2web_datalookup.$id"),
       ];
     }

src/Plugin/DataLookupManager.php

@@ -2,9 +2,11 @@
 
 namespace Drupal\os2web_datalookup\Plugin;
 
+use Drupal\Core\Config\ConfigFactoryInterface;
 use Drupal\Core\Plugin\DefaultPluginManager;
 use Drupal\Core\Cache\CacheBackendInterface;
 use Drupal\Core\Extension\ModuleHandlerInterface;
+use Drupal\os2web_datalookup\Form\DataLookupPluginSettingsForm;
 
 /**
  * DataLookupManager plugin manager.
@@ -15,6 +17,13 @@
  */
 class DataLookupManager extends DefaultPluginManager {
 
+  /**
+   * The config factory.
+   *
+   * @var \Drupal\Core\Config\ConfigFactoryInterface
+   */
+  protected $configFactory;
+
   /**
    * Constructs an DataLookupManager object.
    *
@@ -25,8 +34,10 @@ class DataLookupManager extends DefaultPluginManager {
    *   Cache backend instance to use.
    * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
    *   The module handler to invoke the alter hook with.
+   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
+   *   The config factory.
    */
-  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
+  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, ConfigFactoryInterface $config_factory) {
     parent::__construct(
       'Plugin/os2web/DataLookup',
       $namespaces,
@@ -36,6 +47,17 @@ public function __construct(\Traversable $namespaces, CacheBackendInterface $cac
 
     $this->alterInfo('os2web_datalookup_info');
     $this->setCacheBackend($cache_backend, 'os2web_datalookup');
+    $this->configFactory = $config_factory;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function createInstance($plugin_id, array $configuration = []) {
+    if (empty($configuration)) {
+      $configuration = $this->configFactory->get(DataLookupPluginSettingsForm::getConfigName() . '.' . $plugin_id)->get();
+    }
+    return parent::createInstance($plugin_id, $configuration);
   }
 
 }

src/Plugin/os2web/DataLookup/DataLookupBase.php

@@ -17,6 +17,13 @@
  */
 abstract class DataLookupBase extends PluginBase implements DataLookupInterface {
 
+  /**
+   * Plugin readiness flag.
+   *
+   * @var bool
+   */
+  protected $isReady = TRUE;
+
   /**
    * {@inheritdoc}
    */
@@ -68,4 +75,11 @@ public function getStatus() {
     return 'N/A';
   }
 
+  /**
+   * {@inheritdoc}
+   */
+  public function isReady() {
+    return $this->isReady;
+  }
+
 }

src/Plugin/os2web/DataLookup/DataLookupInterface.php

@@ -21,4 +21,9 @@ interface DataLookupInterface extends PluginInspectionInterface, PluginFormInter
    */
   public function getStatus();
 
+  /**
+   * Get plugin readiness.
+   */
+  public function isReady();
+
 }