Pals Knapsack: Contribute Back to Hyku

.github/workflows/build-test-lint.yaml

@@ -17,7 +17,7 @@ on:
 
 jobs:
   build:
-    uses: scientist-softserv/actions/.github/workflows/[email protected].15
+    uses: scientist-softserv/actions/.github/workflows/[email protected].21
     secrets: inherit
     with:
       platforms: "linux/amd64" # "linux/amd64,linux/arm64"

Gemfile.lock

@@ -481,7 +481,7 @@ GEM
       railties (>= 4.1.0)
       responders
       warden (~> 1.2.3)
-    devise-guests (0.8.1)
+    devise-guests (0.8.2)
       devise
     devise-i18n (1.12.0)
       devise (>= 4.9.0)

app/assets/javascripts/admin_font_select.js

@@ -0,0 +1,6 @@
+Blacklight.onLoad(function() {
+  if($("#admin_appearance_body_font").length > 0){
+    $("#admin_appearance_body_font").fontselect({lookahead: 20});
+    $("#admin_appearance_headline_font").fontselect({lookahead: 20});
+  }
+});

app/assets/javascripts/application.js

@@ -19,6 +19,7 @@
 //= require jquery.dataTables
 //= require dataTables.bootstrap4
 //= require cropper.min
+
 //= require stat_slider
 //= require turbolinks
 //= require cocoon
@@ -64,5 +65,4 @@
 //= require blacklight_range_limit/range_limit_slider
 //= require bootstrap-slider
 //= require jquery.flot.js
-
 //= require tinymce

app/assets/javascripts/hyrax/editor.es6

@@ -0,0 +1,156 @@
+// Override from Hyrax 5.0.1 - Add previous version dropdown
+import RelationshipsControl from 'hyrax/relationships/control'
+import SaveWorkControl from 'hyrax/save_work/save_work_control'
+import AdminSetWidget from 'hyrax/editor/admin_set_widget'
+import ControlledVocabulary from 'hyrax/editor/controlled_vocabulary'
+import Autocomplete from 'hyrax/autocomplete'
+import AuthoritySelect from 'hyrax/authority_select'
+
+export default class {
+  /**
+   * initialize the editor behaviors
+   * @param {jQuery} element - The form that has a data-param-key attribute
+   */
+  constructor(element) {
+    this.element = element
+    this.paramKey = element.data('paramKey') // The work type
+    this.adminSetWidget = new AdminSetWidget(element.find('select[id$="_admin_set_id"]'))
+    this.sharingTabElement = $('#tab-share')
+  }
+
+  init() {
+    this.autocomplete()
+    this.controlledVocabularies()
+    this.sharingTab()
+    this.relationshipsControl()
+    this.saveWorkControl()
+    this.saveWorkFixed()
+    this.authoritySelect()
+    this.formInProgress()
+  }
+
+  // Immediate feedback after work creation, editing.
+  formInProgress() {
+    $('[data-behavior~=work-form]').on('submit', function(event){
+      $('.card-footer.save-progress').removeAttr("hidden");
+    });
+  }
+
+  // Used when you have a linked data field that can have terms from multiple
+  // authorities.
+  authoritySelect() {
+      $("[data-authority-select]").each(function() {
+          let authoritySelect = $(this).data().authoritySelect
+          let options =  {selectBox: 'select.' + authoritySelect,
+                          inputField: 'input.' + authoritySelect}
+          new AuthoritySelect(options);
+      })
+  }
+
+  // Autocomplete fields for the work edit form (based_near, subject, language, child works)
+  autocomplete() {
+      var autocomplete = new Autocomplete()
+
+      $('[data-autocomplete]').each((function() {
+        var elem = $(this)
+        autocomplete.setup(elem, elem.data('autocomplete'), elem.data('autocompleteUrl'))
+        elem.parents('.multi_value.form-group').manage_fields({
+          add: function(e, element) {
+            var elem = $(element)
+            // Don't mark an added element as readonly even if previous element was
+            // Enable before initializing, as otherwise LinkedData fields remain disabled
+            elem.attr('readonly', false)
+            autocomplete.setup(elem, elem.data('autocomplete'), elem.data('autocompleteUrl'))
+          }
+        })
+      }))
+  }
+
+  // initialize any controlled vocabulary widgets
+  controlledVocabularies() {
+    this.element.find('.controlled_vocabulary.form-group').each((_idx, controlled_field) =>
+      new ControlledVocabulary(controlled_field, this.paramKey)
+    )
+  }
+
+  // Display the sharing tab if they select an admin set that permits sharing
+  sharingTab() {
+    if(this.adminSetWidget && !this.adminSetWidget.isEmpty()) {
+      this.adminSetWidget.on('change', () => this.sharingTabVisiblity(this.adminSetWidget.isSharing()))
+      this.sharingTabVisiblity(this.adminSetWidget.isSharing())
+    }
+  }
+
+  sharingTabVisiblity(visible) {
+      if (visible)
+         this.sharingTabElement.removeAttr("hidden")
+      else
+         this.sharingTabElement.attr("hidden","")
+  }
+
+  relationshipsControl() {
+      let collections = this.element.find('[data-behavior="collection-relationships"]')
+      collections.each((_idx, element) =>
+          new RelationshipsControl(element,
+                                   collections.data('members'),
+                                   collections.data('paramKey'),
+                                   'member_of_collections_attributes',
+                                   'tmpl-collection').init())
+
+      let works = this.element.find('[data-behavior="child-relationships"]')
+      works.each((_idx, element) =>
+          new RelationshipsControl(element,
+                                   works.data('members'),
+                                   works.data('paramKey'),
+                                   'work_members_attributes',
+                                   'tmpl-child-work').init())
+
+      let previous_versions = this.element.find('[data-behavior="previous-version-relationship"]')
+      previous_versions.each((_idx, element) =>
+          new RelationshipsControl(element,
+                                  previous_versions.data('members'), 
+                                  previous_versions.data('paramKey'),
+                                  'related_members_attributes',
+                                  'tmpl-previous-version',
+                                  previous_versions.data('relationship')).init())
+
+      // added newer_versions relationship
+      let newer_versions = this.element.find('[data-behavior="newer-version-relationship"]')
+      newer_versions.each((_idx, element) =>
+          new RelationshipsControl(element,
+                                  newer_versions.data('members'),
+                                  newer_versions.data('paramKey'),
+                                  'related_members_attributes',
+                                  'tmpl-newer-version',
+                                  newer_versions.data('relationship')).init())
+
+      // added alternate_versions relationship
+      let alternate_versions = this.element.find('[data-behavior="alternate-version-relationship"]')
+      alternate_versions.each((_idx, element) =>
+          new RelationshipsControl(element,
+                                  alternate_versions.data('members'),
+                                  alternate_versions.data('paramKey'),
+                                  'related_members_attributes',
+                                  'tmpl-alternate-version',
+                                  alternate_versions.data('relationship')).init())
+
+      // added alternate_versions relationship
+      let related_items = this.element.find('[data-behavior="related-item-relationship"]')
+      related_items.each((_idx, element) =>
+          new RelationshipsControl(element,
+                                  related_items.data('members'),
+                                  related_items.data('paramKey'),
+                                  'related_members_attributes',
+                                  'tmpl-related-item',
+                                  related_items.data('relationship')).init())
+  }
+
+  saveWorkControl() {
+      new SaveWorkControl(this.element.find("#form-progress"), this.adminSetWidget)
+  }
+
+  saveWorkFixed() {
+      // Fixedsticky will polyfill position:sticky
+      this.element.find('#savewidget').fixedsticky()
+  }
+}

app/assets/javascripts/hyrax/relationships/control.es6

@@ -0,0 +1,107 @@
+/**
+ * Copied from hyrax 2.5 to add relationship
+ **/
+
+
+import Registry from './registry'
+import Resource from './resource'
+/**
+ * This depends on the passed in element containing `data-autocomplete="work'"`
+ * that is also a select2 element.
+*/
+export default class RelationshipsControl {
+
+  /**
+   * COPIED FROM HYRAX TO ADD RELATIONSHIP FOR RELATED ITEMS
+   * Initializes the class in the context of an individual table element
+   * @param {HTMLElement} element the table element that this class represents.
+   * @param {Array} members the members to display in the table
+   * @param {String} paramKey the key for the type of object we're submitting (e.g. 'generic_work')
+   * @param {String} property the property to submit
+   * @param {String} templateId the template identifier for new rows
+   * @param {String} relationship the type of relationship for oer items
+   */
+  constructor(element, members, paramKey, property, templateId, relationship) {
+    this.element = $(element)
+    this.members = this.element.data('members')
+    this.relationship = relationship
+    this.registry = new Registry(this.element.find('tbody'), paramKey, property, templateId, relationship)
+    this.input = this.element.find(`[data-autocomplete]`)
+    this.warning = this.element.find(".message.has-warning")
+    this.addButton = this.element.find("[data-behavior='add-relationship']")
+    this.errors = null
+  }
+
+  init() {
+    this.bindAddButton();
+    this.displayMembers();
+  }
+
+  validate() {
+    if (this.input.val() === "") {
+      this.errors = ['ID cannot be empty.']
+    }
+  }
+
+  // added relationship
+  displayMembers() {
+    this.members.forEach((elem) =>
+      this.registry.addResource(new Resource(elem.id, elem.label, elem.relationship))
+    )
+  }
+
+  isValid() {
+    this.validate()
+    return this.errors === null
+  }
+
+  /**
+   * Handle click events by the "Add" button in the table, setting a warning
+   * message if the input is empty or calling the server to handle the request
+   */
+  bindAddButton() {
+    this.addButton.on("click", () => this.attemptToAddRow())
+  }
+
+  attemptToAddRow() {
+      // Display an error when the input field is empty, or if the resource ID is already related,
+      // otherwise clone the row and set appropriate styles
+      if (this.isValid()) {
+        this.addRow()
+      } else {
+        this.setWarningMessage(this.errors.join(', '))
+      }
+  }
+
+  addRow() {
+    this.hideWarningMessage()
+    let data = this.searchData()
+    this.registry.addResource(new Resource(data.id, data.text))
+
+    // finally, empty the "add" row input value
+    this.clearSearch();
+  }
+
+  searchData() {
+    return this.input.select2('data')
+  }
+
+  clearSearch() {
+    this.input.select2("val", '');
+  }
+
+  /**
+   * Set the warning message related to the appropriate row in the table
+   * @param {String} message the warning message text to set
+   */
+  setWarningMessage(message) {
+    this.warning.text(message).removeClass("hidden");
+  }
+
+  /**
+   * Hide the warning message on the appropriate row
+   */
+  hideWarningMessage(){
+    this.warning.addClass("hidden");
+  }
+}

app/assets/javascripts/hyrax/relationships/registry.es6

@@ -0,0 +1,73 @@
+/**
+ * Copied from hyrax 2.5 to add relationship
+ **/
+
+ import RegistryEntry from './registry_entry'
+export default class Registry {
+  /**
+   * COPIED FROM HYRAX TO ADD RELATIONSHIP FOR RELATED ITEMS
+   * Initialize the registry
+   * @param {jQuery} element the jquery selector for the permissions container.
+   *                         must be a table with a tbody element.
+   * @param {String} object_name the name of the object, for constructing form fields (e.g. 'generic_work')
+   * @param {String} templateId the the identifier of the template for the added elements
+   * @param {String} relationship the indentifier of which relationship being added
+   */
+  constructor(element, objectName, propertyName, templateId, relationship) {
+    this.objectName = objectName
+    this.propertyName = propertyName
+    this.relationship = relationship
+    this.templateId = templateId
+    this.items = []
+    this.element = element
+    element.closest('form').on('submit', (evt) => {
+        this.serializeToForm()
+    });
+  }
+
+  // Return an index for the hidden field when adding a new row.
+  // A large random will probably avoid collisions.
+  nextIndex() {
+      return Math.floor(Math.random() * 1000000000000000)
+  }
+
+  export() {
+      return this.items.map(item => item.export())
+  }
+
+  // ADDED RELATIONSHIP
+  serializeToForm() {
+      this.export().forEach((item, index) => {
+          let nextIndex = this.nextIndex()
+          this.addHiddenField(nextIndex, 'id', item.id)
+          this.addHiddenField(nextIndex, '_destroy', item['_destroy'])
+          this.addHiddenField(nextIndex, 'relationship', item.relationship)
+      })
+  }
+
+  addHiddenField(index, key, value) {
+      $('<input>').attr({
+          type: 'hidden',
+          name: `${this.fieldPrefix(index)}[${key}]`,
+          value: value
+      }).appendTo(this.element);
+  }
+
+  // ADDED RELATIONSHIP
+  // Adds the resource to the first row of the tbody
+  addResource(resource) {
+    resource.index = this.nextIndex()
+    let entry = new RegistryEntry(resource, this, this.templateId, this.relationship)
+    this.items.push(entry)
+    this.element.prepend(entry.view)
+    this.showSaveNote()
+  }
+
+  fieldPrefix(counter) {
+    return `${this.objectName}[${this.propertyName}][${counter}]`
+  }
+
+  showSaveNote() {
+    // TODO: we may want to reveal a note that changes aren't active until the resource is saved
+  }
+}