Add compound (hierarchical) metadata foundation

.koppie/config/metadata_profiles/m3_profile.yaml

@@ -927,4 +927,192 @@ properties:
       display: true
       primary: false
     range: http://www.w3.org/2001/XMLSchema#string
-    property_uri: http://vocabulary.samvera.org/ns#transcriptIds
+    property_uri: http://vocabulary.samvera.org/ns#transcriptIds
+  # Sample compound (hierarchical) metadata, demonstrating the Hyrax compound
+  # foundation in flexible mode. A compound is a `type: hash, multiple: true`
+  # parent; its members are declared as separate properties naming it via
+  # `available_on: { properties: [<parent>] }`, each carrying its own indexing
+  # and form placement. A member may name more than one parent, and `name:` sets
+  # its key inside the compound. Such members are not standalone resource
+  # attributes. See documentation/compound_fields.md.
+  participants:
+    available_on:
+      class:
+        - GenericWork
+        - CollectionResource
+    data_type: array
+    type: hash
+    range: http://www.w3.org/2001/XMLSchema#string
+    display_label:
+      default: Participants
+    form:
+      primary: true
+    property_uri: http://id.loc.gov/vocabulary/relators/asn
+    # Group metadata (label) for subproperties declaring `group: <key>`.
+    groups:
+      identity:
+        label: Identity
+    view:
+      render_as: compound
+      html_dl: true
+  # Subproperties declare `available_on: { properties: [<parent>] }` (no
+  # `class:`/`range`/`display_label`): they inherit their parent compound's class
+  # scope and are folded into it by the schema loader. Solr fields are derived
+  # per sub-property (`<parent>_<name>_<suffix>`) unless an explicit `indexing:`
+  # overrides or `indexing: false` opts out. (`participants` gets its `title`
+  # from the reused `shared_title` below.)
+  participant_name:
+    type: string
+    name: name
+    available_on:
+      properties:
+        - participants
+    group: identity
+    required: true
+    form:
+      cols: 4
+  participant_role:
+    type: controlled
+    name: role
+    available_on:
+      properties:
+        - participants
+    group: identity
+    required: true
+    values: [Author, Editor, Contributor, Creator, Data Collector, Funder, Publisher, Other]
+    form:
+      cols: 4
+  identifiers:
+    available_on:
+      class:
+        - GenericWork
+        - CollectionResource
+    data_type: array
+    type: hash
+    range: http://www.w3.org/2001/XMLSchema#string
+    display_label:
+      default: Identifiers
+    form:
+      primary: false
+    property_uri: http://purl.org/dc/terms/identifier
+    view:
+      render_as: compound
+      html_dl: true
+  identifier_value:
+    type: string
+    name: value
+    available_on:
+      properties:
+        - identifiers
+    required: true
+    form:
+      cols: 6
+  identifier_type:
+    type: controlled
+    name: type
+    available_on:
+      properties:
+        - identifiers
+    required: true
+    values: [DOI, Handle, ISBN, ISSN, URL, URN, ARK, Other]
+    form:
+      cols: 6
+  compound_rights:
+    available_on:
+      class:
+        - GenericWork
+        - CollectionResource
+    data_type: array
+    type: hash
+    range: http://www.w3.org/2001/XMLSchema#string
+    display_label:
+      default: Rights
+    form:
+      primary: false
+    property_uri: http://purl.org/dc/terms/rights
+    view:
+      render_as: compound
+      html_dl: true
+  compound_rights_statement:
+    type: controlled
+    name: statement
+    available_on:
+      properties:
+        - compound_rights
+    authority: rights_statements
+    form:
+      cols: 6
+  compound_rights_license:
+    type: controlled
+    name: license
+    available_on:
+      properties:
+        - compound_rights
+    authority: licenses
+    form:
+      cols: 6
+  # Overriding the derived index keys: a `string` would derive both
+  # `compound_rights_notes_sim` (facet) and `_tesim` (full-text). A free-text
+  # notes field is worth searching but not faceting, so an explicit `indexing:`
+  # narrows it to `_tesim` only. An explicit list replaces the derived set.
+  compound_rights_notes:
+    type: string
+    name: notes
+    available_on:
+      properties:
+        - compound_rights
+    indexing: [compound_rights_notes_tesim]
+    form:
+      cols: 12
+  relationships:
+    available_on:
+      class:
+        - GenericWork
+        - CollectionResource
+    data_type: array
+    type: hash
+    range: http://www.w3.org/2001/XMLSchema#string
+    display_label:
+      default: Relationships
+    form:
+      primary: true
+    property_uri: http://purl.org/dc/terms/relation
+    view:
+      render_as: compound
+      html_dl: true
+      display: card
+  relationship_item:
+    type: work_or_url
+    name: item
+    available_on:
+      properties:
+        - relationships
+    required: true
+    form:
+      cols: 6
+  relationship_type:
+    type: controlled
+    name: type
+    available_on:
+      properties:
+        - relationships
+    required: true
+    values: [References, Is Referenced By, Is Part Of, Has Part, Is Version Of, Replaces, Requires, Other]
+    form:
+      cols: 6
+  # A single subproperty definition reused by two compounds. The top-level key
+  # (`shared_title`) is globally unique, while `name: title` sets the cleaner key
+  # inside each compound row (so both `participants` and `relationships` rows
+  # carry a `title`), and `available_on.properties` lists both parents. Its Solr
+  # fields are derived per parent (`participants_title_sim`/`_tesim` and
+  # `relationships_title_sim`/`_tesim`), so the reused field is searchable in
+  # each compound with no collision and no hand-written `indexing:`.
+  shared_title:
+    type: string
+    name: title
+    available_on:
+      properties:
+        - participants
+        - relationships
+    form:
+      cols: 12

.rubocop.yml

@@ -95,6 +95,7 @@ Rails/OutputSafety:
     - 'app/presenters/hyrax/fixity_status_presenter.rb'
     - 'app/presenters/hyrax/presents_attributes.rb'
     - 'app/renderers/hyrax/renderers/attribute_renderer.rb'
+    - 'app/renderers/hyrax/renderers/compound_attribute_renderer.rb'
     - 'spec/views/hyrax/my/works/_list_works.html.erb_spec.rb'
 
 RSpec/DescribeClass:

app/assets/javascripts/hyrax.js

@@ -46,6 +46,7 @@
 //= require hyrax/single_use_links_manager
 //= require hyrax/copy_permalink_button
 //= require hyrax/redirects
+//= require hyrax/compound_metadata
 //= require hyrax/dashboard_actions
 //= require hyrax/batch
 //= require hyrax/flot_stats

app/assets/javascripts/hyrax/compound_metadata.js

@@ -0,0 +1,98 @@
+// Behavior for compound metadata fields on resource edit forms (add/remove row,
+// work_or_url select2). Event-delegated so dynamically-added rows need no
+// rebinding. The sentinel guards against the IIFE running twice (Turbolinks
+// re-evaluates module scripts on some navigation paths), which would stack
+// duplicate listeners. Mirrors hyrax/redirects.js.
+(function() {
+    if (document.hyraxCompoundsBound) return;
+    document.hyraxCompoundsBound = true;
+
+    // Bind select2 to a `work_or_url` sub-property. The v3 API (Hyrax bundles
+    // select2-rails 3.x) binds to a hidden input; createSearchChoice lets a
+    // typed external URL be selected as-is.
+    function bindWorkOrUrlInputs(root) {
+        if (typeof jQuery === 'undefined' || !jQuery.fn.select2) return;
+        jQuery(root).find('[data-hyrax-compound-work-input]').each(function() {
+            var $el = jQuery(this);
+            if ($el.hasClass('select2-offscreen') || $el.data('select2')) return; // already bound
+            $el.select2({
+                width: '100%',
+                allowClear: true,
+                placeholder: 'Search for a work or enter a URL',
+                minimumInputLength: 2,
+                // Let a typed value (e.g. an external URL) be selected as-is.
+                createSearchChoice: function(term) {
+                    return { id: term, text: term };
+                },
+                // Render the current value's label (work title or the URL) on load.
+                initSelection: function(element, callback) {
+                    var val = element.val();
+                    if (!val) return;
+                    callback({ id: val, text: element.data('label') || val });
+                },
+                ajax: {
+                    url: $el.data('autocomplete-url'),
+                    dataType: 'json',
+                    quietMillis: 250,
+                    data: function(term, page) { return { q: term }; },
+                    results: function(data, page) {
+                        return {
+                            results: data.map(function(obj) {
+                                return { id: obj.id, text: [].concat(obj.label)[0] };
+                            })
+                        };
+                    }
+                }
+            });
+        });
+    }
+
+    // Bind saved rows once the DOM is ready (at script-eval time the form
+    // inputs don't exist yet, so the select2 would never attach). Covers both a
+    // fresh load and Turbolinks navigation.
+    function bindAll() { bindWorkOrUrlInputs(document); }
+    if (document.readyState === 'loading') {
+        document.addEventListener('DOMContentLoaded', bindAll);
+    } else {
+        bindAll();
+    }
+    document.addEventListener('turbolinks:load', bindAll);
+
+    document.addEventListener('click', function(event) {
+        var removeButton = event.target.closest('[data-hyrax-compound-remove-row]');
+        if (removeButton) {
+            var row = removeButton.closest('[data-hyrax-compound-row]');
+            if (!row) return;
+            var destroyFlag = row.querySelector('[data-hyrax-compound-destroy-flag]');
+            if (destroyFlag && destroyFlag.value !== undefined) {
+                // Persisted rows: flip the _destroy flag and hide so the
+                // populator drops the row server-side.
+                destroyFlag.value = '1';
+                row.style.display = 'none';
+            } else {
+                row.parentNode.removeChild(row);
+            }
+            return;
+        }
+
+        var addButton = event.target.closest('[data-hyrax-compound-add-row]');
+        if (!addButton) return;
+        var section = addButton.closest('[data-hyrax-compound]');
+        if (!section) return;
+        var template = section.querySelector('[data-hyrax-compound-row-template]');
+        var rowsHost = section.querySelector('[data-hyrax-compound-rows]');
+        if (!template || !rowsHost) return;
+
+        // Monotonic counter on the section; never recycle an index after a
+        // row is removed. Fallback to row count when the attribute is missing.
+        var nextIndex = parseInt(section.dataset.nextIndex, 10);
+        if (isNaN(nextIndex)) {
+            nextIndex = rowsHost.querySelectorAll('[data-hyrax-compound-row]').length;
+        }
+        var html = template.innerHTML.replace(/__INDEX__/g, nextIndex);
+        rowsHost.insertAdjacentHTML('beforeend', html);
+        // Bind select2 on any work_or_url inputs in the row just added.
+        bindWorkOrUrlInputs(rowsHost.lastElementChild || rowsHost);
+        section.dataset.nextIndex = String(nextIndex + 1);
+    });
+})();

app/assets/stylesheets/hyrax/_collections.scss

@@ -610,11 +610,18 @@ button.branding-banner-remove:hover {
 
     dt {
       flex-basis: 115px;
+      // Hold the label column fixed so every value column (dd) starts at the
+      // same x; otherwise a long unbreakable value (e.g. a URL link) shrinks
+      // this column and shifts the value left.
+      flex-shrink: 0;
       font-weight: bold;
     }
 
     dd {
       flex-basis: auto;
+      // Let the value column shrink to its flex space so long URLs wrap within
+      // it rather than forcing the row wider.
+      min-width: 0;
     }
 
   }

app/assets/stylesheets/hyrax/_compound_metadata.scss

@@ -0,0 +1,50 @@
+// Compound metadata display on work and collection show pages.
+// See documentation/compound_fields.md.
+//
+// `!important` throughout: the collection metadata area styles nested divs with
+// a descendant selector (`.hyc-metadata div { display: flex; border-bottom }`
+// in _collections.scss) that would otherwise turn each entry into a bordered
+// flex row. These rules override it regardless of source order.
+.hyrax-compound-values {
+  display: block !important;
+  flex-direction: column;
+  border: 0 !important;
+  padding: 0 !important;
+  max-width: 100%;
+
+  // Force block flow on the entries/sub-properties; the label/value spans stay
+  // inline so each sub-property reads as "Label: value" on one wrapping line.
+  .hyrax-compound-entry,
+  .hyrax-compound-subproperty {
+    display: block !important;
+  }
+
+  .hyrax-compound-entry,
+  .hyrax-compound-subproperty,
+  .hyrax-compound-subproperty-label,
+  .hyrax-compound-subproperty-value {
+    border: 0 !important;
+    padding: 0 !important;
+    margin: 0;
+    background: none;
+  }
+
+  // A light divider between entries.
+  .hyrax-compound-entry + .hyrax-compound-entry {
+    margin-top: 0.5rem;
+    padding-top: 0.5rem !important;
+    border-top: 1px solid $gray-200 !important;
+  }
+
+  .hyrax-compound-subproperty {
+    display: block;
+    line-height: 1.4;
+    overflow-wrap: break-word;
+    word-break: break-word;
+  }
+
+  .hyrax-compound-subproperty-label {
+    font-weight: 600;
+    margin-right: 0.25rem;
+  }
+}

app/assets/stylesheets/hyrax/_hyrax.scss

@@ -10,7 +10,7 @@
   "hyrax/select_work_type", "hyrax/users", "hyrax/dashboard", "hyrax/sidebar",
   "hyrax/controlled_vocabulary", "hyrax/accessibility", "hyrax/recent",
   "hyrax/viewer", "hyrax/breadcrumbs", "hyrax/facets", "hyrax/card",
-  "hyrax/badge";
+  "hyrax/badge", "hyrax/compound_metadata";
 @import "hydra-editor/multi_value_fields";
 @import "typeahead";
 @import "sharing_buttons";