Merge pull request #77 from discoverygarden/dev-IMT78

Move away from config entities
discoverygarden · Sep 10, 2021 · d19e2c7 · d19e2c7
2 parents 1221cd0 + bd4b6e1
commit d19e2c7
Show file tree

Hide file tree

Showing 10 changed files with 123 additions and 3 deletions.
diff --git a/modules/islandora_spreadsheet_ingest_example/islandora_spreadsheet_ingest_example.install b/modules/islandora_spreadsheet_ingest_example/islandora_spreadsheet_ingest_example.install
@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * @file
+ * Misc (un)installation/update hooks.
+ */
+
+/**
+ * Remove config entities.
+ */
+function islandora_spreadsheet_ingest_example_update_8100() {
+  $storage = \Drupal::service('entity_type.manager')->getStorage('isi_request');
+  $requests = $storage->loadMultiple();
+
+  $entities = [
+    'migrate_plus.migration.isi_file',
+    'migrate_plus.migration.isi_media_audio',
+    'migrate_plus.migration.isi_media_doc',
+    'migrate_plus.migration.isi_media_file',
+    'migrate_plus.migration.isi_media_image',
+    'migrate_plus.migration.isi_media_video',
+    'migrate_plus.migration.isi_node',
+  ];
+
+  $config_factory = \Drupal::configFactory();
+  foreach ($entities as $entity) {
+    $config_factory->getEditable($entity)->delete();
+  }
+
+  // XXX: Resave requests to remove the config dependency.
+  foreach ($requests as $request) {
+    $request->save();
+  }
+
+}
diff --git a/...stall/migrate_plus.migration.isi_file.yml → ...et_ingest_example/migrations/isi_file.yml b/...stall/migrate_plus.migration.isi_file.yml → ...et_ingest_example/migrations/isi_file.yml
@@ -2,9 +2,20 @@ id: isi_file
 label: Create files from rows in the csv.
 migration_group: isi
 source:
+  plugin: spreadsheet
+  source_module: migrate_spreadsheet
+  # Worksheet nonsensical but required.
+  worksheet: nada
+  track_changes: true
+  file: 'modules/contrib/islandora_spreadsheet_ingest/modules/islandora_spreadsheet_ingest_example/fixtures/migration_example.csv'
+  header_row: 1
+  keys:
+    'ID':
+      type: integer
   columns:
     - 'ID'
     - 'Digital_File'
+migration_tags: []
 process:
   _file_defined:
     - plugin: get

diff --git a/...igrate_plus.migration.isi_media_audio.yml → ...st_example/migrations/isi_media_audio.yml b/...igrate_plus.migration.isi_media_audio.yml → ...st_example/migrations/isi_media_audio.yml
@@ -2,11 +2,22 @@ id: isi_media_audio
 label: Create audio media from rows in the csv.
 migration_group: isi
 source:
+  plugin: spreadsheet
+  source_module: migrate_spreadsheet
+  # Worksheet nonsensical but required.
+  worksheet: nada
+  track_changes: true
+  file: 'modules/contrib/islandora_spreadsheet_ingest/modules/islandora_spreadsheet_ingest_example/fixtures/migration_example.csv'
+  header_row: 1
+  keys:
+    'ID':
+      type: integer
   columns:
     - 'ID'
     - 'Title'
     - 'Model'
     - 'Digital_File'
+migration_tags: []
 process:
   _file_exists:
     - plugin: get

diff --git a/.../migrate_plus.migration.isi_media_doc.yml → ...gest_example/migrations/isi_media_doc.yml b/.../migrate_plus.migration.isi_media_doc.yml → ...gest_example/migrations/isi_media_doc.yml
@@ -2,11 +2,22 @@ id: isi_media_doc
 label: Create document media from rows in the csv.
 migration_group: isi
 source:
+  plugin: spreadsheet
+  source_module: migrate_spreadsheet
+  # Worksheet nonsensical but required.
+  worksheet: nada
+  track_changes: true
+  file: 'modules/contrib/islandora_spreadsheet_ingest/modules/islandora_spreadsheet_ingest_example/fixtures/migration_example.csv'
+  header_row: 1
+  keys:
+    'ID':
+      type: integer
   columns:
     - 'ID'
     - 'Title'
     - 'Model'
     - 'Digital_File'
+migration_tags: []
 process:
   _file_exists:
     - plugin: get

diff --git a/...migrate_plus.migration.isi_media_file.yml → ...est_example/migrations/isi_media_file.yml b/...migrate_plus.migration.isi_media_file.yml → ...est_example/migrations/isi_media_file.yml
@@ -2,11 +2,22 @@ id: isi_media_file
 label: Create file media from rows in the csv.
 migration_group: isi
 source:
+  plugin: spreadsheet
+  source_module: migrate_spreadsheet
+  # Worksheet nonsensical but required.
+  worksheet: nada
+  track_changes: true
+  file: 'modules/contrib/islandora_spreadsheet_ingest/modules/islandora_spreadsheet_ingest_example/fixtures/migration_example.csv'
+  header_row: 1
+  keys:
+    'ID':
+      type: integer
   columns:
     - 'ID'
     - 'Title'
     - 'Model'
     - 'Digital_File'
+migration_tags: []
 process:
   _file_exists:
     - plugin: get

diff --git a/...igrate_plus.migration.isi_media_image.yml → ...st_example/migrations/isi_media_image.yml b/...igrate_plus.migration.isi_media_image.yml → ...st_example/migrations/isi_media_image.yml
@@ -2,11 +2,22 @@ id: isi_media_image
 label: Create image media from rows in the csv.
 migration_group: isi
 source:
+  plugin: spreadsheet
+  source_module: migrate_spreadsheet
+  # Worksheet nonsensical but required.
+  worksheet: nada
+  track_changes: true
+  file: 'modules/contrib/islandora_spreadsheet_ingest/modules/islandora_spreadsheet_ingest_example/fixtures/migration_example.csv'
+  header_row: 1
+  keys:
+    'ID':
+      type: integer
   columns:
     - 'ID'
     - 'Title'
     - 'Model'
     - 'Digital_File'
+migration_tags: []
 process:
   _file_exists:
     - plugin: get

diff --git a/...igrate_plus.migration.isi_media_video.yml → ...st_example/migrations/isi_media_video.yml b/...igrate_plus.migration.isi_media_video.yml → ...st_example/migrations/isi_media_video.yml
@@ -2,11 +2,22 @@ id: isi_media_video
 label: Create video media from rows in the csv.
 migration_group: isi
 source:
+  plugin: spreadsheet
+  source_module: migrate_spreadsheet
+  # Worksheet nonsensical but required.
+  worksheet: nada
+  track_changes: true
+  file: 'modules/contrib/islandora_spreadsheet_ingest/modules/islandora_spreadsheet_ingest_example/fixtures/migration_example.csv'
+  header_row: 1
+  keys:
+    'ID':
+      type: integer
   columns:
     - 'ID'
     - 'Title'
     - 'Model'
     - 'Digital_File'
+migration_tags: []
 process:
   _file_exists:
     - plugin: get

diff --git a/...stall/migrate_plus.migration.isi_node.yml → ...et_ingest_example/migrations/isi_node.yml b/...stall/migrate_plus.migration.isi_node.yml → ...et_ingest_example/migrations/isi_node.yml
@@ -2,13 +2,24 @@ id: isi_node
 label: Create nodes from rows in the csv.
 migration_group: isi
 source:
+  plugin: spreadsheet
+  source_module: migrate_spreadsheet
+  # Worksheet nonsensical but required.
+  worksheet: nada
+  track_changes: true
+  file: 'modules/contrib/islandora_spreadsheet_ingest/modules/islandora_spreadsheet_ingest_example/fixtures/migration_example.csv'
+  header_row: 1
+  keys:
+    'ID':
+      type: integer
   columns:
     - 'ID'
     - 'Title'
     - 'Model'
     - 'Member_of'
     - 'Member_of_existing_entity'
     - 'Description'
+migration_tags: []
 process:
   field_model:
     - plugin: get

diff --git a/src/Entity/Request.php b/src/Entity/Request.php
@@ -158,8 +158,15 @@ public function getOwner() {
   public function calculateDependencies() {
     parent::calculateDependencies();
 
+    $storage = $this->entityTypeManager()->getStorage('migration');
+
+    // XXX: We expect the module to be accounted for in the "migration_group"
+    // config entity, an so need need deal with it specifically for the
+    // migration plugin.
     foreach (array_column($this->getMappings(), 'original_migration_id') as $original_migration_id) {
-      $this->addDependency('config', "migrate_plus.migration.{$original_migration_id}");
+      if ($storage->load($original_migration_id)) {
+        $this->addDependency('config', "migrate_plus.migration.{$original_migration_id}");
+      }
     }
     list($type, $id) = explode(':', $this->getOriginalMapping());
     switch ($type) {

diff --git a/src/Form/Ingest/FileUpload.php b/src/Form/Ingest/FileUpload.php
@@ -300,8 +300,9 @@ protected function mapMappings($mapping) {
    */
   protected function mapMappingFromMigrationGroup($id) {
     $map_migrations = function ($etm, $mpm) use ($id) {
-      $storage = $etm->getStorage('migration');
-      $names = $storage->getQuery()->condition('migration_group', $id)->execute();
+      $names = array_keys(array_filter($mpm->getDefinitions(), function (array $def) use ($id) {
+        return ($def['migration_group'] ?? '') === $id;
+      }));
 
       $migrations = $mpm->createInstances($names);