sufia 7.3.0.rc3 → 7.3.0

data/app/assets/javascripts/sufia/autocomplete/language.es6

@@ -1,4 +1,4 @@
-export class Language {
+export default class Language {
   constructor(element, url) {
     this.url = url
     element.autocomplete(this.options());
@@ -22,4 +22,3 @@ export class Language {
     };
   }
 }
-

data/app/assets/javascripts/sufia/autocomplete/location.es6

@@ -1,4 +1,4 @@
-export class Location {
+export default class Location {
   constructor(element, url) {
     this.url = url
     element.autocomplete(this.options());

data/app/assets/javascripts/sufia/autocomplete/subject.es6

@@ -1,4 +1,4 @@
-export class Subject {
+export default class Subject {
   constructor(element, url) {
     this.url = url
     element.autocomplete(this.options());
@@ -22,5 +22,3 @@ export class Subject {
     };
   }
 }
-
-

data/app/assets/javascripts/sufia/autocomplete/work.es6

@@ -1,29 +1,38 @@
-export class Work {
-  // Autocomplete for finding possible related works (child and parent).
-  constructor(element, url, user, id) {
+export default class Work {
+  // Autocomplete for finding possible related works.
+  constructor(element, url, excludeWorkId) {
     this.url = url;
-    this.user = user;
-    this.work_id = id;
-    element.autocomplete(this.options());
+    this.excludeWorkId = excludeWorkId;
+    this.initUI(element)
   }
 
-  options() {
-    return {
-      minLength: 2,
-      source: ( request, response ) => {
-        $.getJSON(this.url, {
-          q: request.term,
-          id: this.work_id,
-          user: this.user
-        }, response );
+  initUI(element) {
+    element.select2( {
+      minimumInputLength: 2,
+      initSelection : (row, callback) => {
+        var data = {id: row.val(), text: row.val()};
+        callback(data);
       },
-      focus: function() {
-        // prevent value inserted on focus
-        return false;
-      },
-      complete: function(event) {
-        $('.ui-autocomplete-loading').removeClass("ui-autocomplete-loading");
+      ajax: { // instead of writing the function to execute the request we use Select2's convenient helper
+        url: this.url,
+        dataType: 'json',
+        data: (term, page) => {
+          return {
+            q: term, // search term
+            id: this.excludeWorkId // Exclude this work
+          };
+        },
+        results: this.processResults
       }
-    };
+    }).select2('data', null);
+  }
+
+  // parse the results into the format expected by Select2.
+  // since we are using custom formatting functions we do not need to alter remote JSON data
+  processResults(data, page) {
+    let results = data.map((obj) => {
+                             return { id: obj.id, text: obj.label[0] };
+                          })
+    return { results: results };
   }
 }

data/app/assets/javascripts/sufia/editor.es6

@@ -0,0 +1,47 @@
+import RelationshipsControl from 'sufia/relationships/control'
+import SaveWorkControl from 'sufia/save_work/save_work_control'
+import AdminSetWidget from 'sufia/editor/admin_set_widget'
+
+export default class {
+  constructor(element) {
+    this.element = element
+    this.adminSetWidget = new AdminSetWidget(element.find('select[id$="_admin_set_id"]'))
+    this.sharingTabElement = $('#tab-share')
+
+    this.sharingTab()
+    this.relationshipsControl()
+    this.saveWorkControl()
+    this.saveWorkFixed()
+  }
+
+  // Display the sharing tab if they select an admin set that permits sharing
+  sharingTab() {
+    if(this.adminSetWidget && !this.adminSetWidget.isEmpty()) {
+      this.adminSetWidget.on('change', (data) => this.sharingTabVisiblity(data))
+      this.sharingTabVisiblity(this.adminSetWidget.isSharing())
+    }
+  }
+
+  sharingTabVisiblity(visible) {
+      if (visible)
+         this.sharingTabElement.removeClass('hidden')
+      else
+         this.sharingTabElement.addClass('hidden')
+  }
+
+  relationshipsControl() {
+      new RelationshipsControl(this.element.find('[data-behavior="child-relationships"]'),
+                               'work_members_attributes',
+                               'tmpl-child-work')
+  }
+
+  saveWorkControl() {
+      new SaveWorkControl(this.element.find("#form-progress"), this.adminSetWidget)
+  }
+
+  saveWorkFixed() {
+      // Setting test to false to skip native and go right to polyfill
+      FixedSticky.tests.sticky = false
+      this.element.find('#savewidget').fixedsticky()
+  }
+}

data/app/assets/javascripts/sufia/editor/admin_set_widget.es6

@@ -0,0 +1,39 @@
+export default class {
+    // takes a jquery selector for a select field
+    // create a custom change event with the data when it changes
+    constructor(element) {
+        this.changeHandlers = []
+        this.element = element
+        element.on('change', (e) => {
+            this.change(this.data())
+        })
+    }
+
+    data() {
+        return this.element.find(":selected").data()
+    }
+
+    isEmpty() {
+        return this.element.children().length === 0
+    }
+
+    /**
+     * returns undefined or true
+     */
+    isSharing() {
+        return this.data()["sharing"]
+    }
+
+    on(eventName, handler) {
+        switch (eventName) {
+            case "change":
+                return this.changeHandlers.push(handler)
+        }
+    }
+
+    change(data) {
+        for (let fn of this.changeHandlers) {
+          setTimeout(function() { fn(data) }, 0)
+        }
+    }
+}

data/app/assets/javascripts/sufia/notifications.es6

@@ -13,28 +13,28 @@ export class Notifications {
   }
 
   poller(interval, url) {
-    setInterval(() => { this.fetchUpdates(url) }, interval);
+      setInterval(() => { this.fetchUpdates(url) }, interval);
   }
 
   fetchUpdates(url) {
-    $.getJSON( url, (data) => this.updatePage(data))
+      $.getJSON( url, (data) => this.updatePage(data))
   }
 
   updatePage(data) {
-    let notification = $('.notify_number')
-    notification.find('.count').html(data.notify_number)
-    if (data.notify_number == 0) {
-      notification.addClass('label-default')
-      notification.removeClass('label-danger')
-    } else {
-      notification.addClass('label-danger')
-      notification.removeClass('label-default')
-    }
+      let notification = $('.notify_number')
+      notification.find('.count').html(data.notify_number)
+      if (data.notify_number === 0) {
+          notification.addClass('label-default')
+          notification.removeClass('label-danger')
+      } else {
+          notification.addClass('label-danger')
+          notification.removeClass('label-default')
+      }
   }
 
   getIntervalSeconds(default_interval) {
-    var seconds = parseInt(this.queryStringParam("notification_seconds"));
-    return seconds || default_interval;
+      var seconds = parseInt(this.queryStringParam("notification_seconds"), 10);
+      return seconds || default_interval;
   }
 
   // During development allow the frequency of the notifications check to

data/app/assets/javascripts/sufia/permissions/control.es6

@@ -6,10 +6,10 @@ export class PermissionsControl {
   /**
    * Initialize the save controls
    * @param {jQuery} element the jquery selector for the permissions container
-   * @param {String} template_id the identifier of the template for the added elements 
+   * @param {String} template_id the identifier of the template for the added elements
    */
   constructor(element, template_id) {
-    if (element.size() == 0) {
+    if (element.size() === 0) {
       return
     }
     this.element = element
@@ -19,7 +19,7 @@ export class PermissionsControl {
     this.group_controls = new GroupControls(this.element, this.registry)
   }
 
-  // retrieve object_name the name of the object to create 
+  // retrieve object_name the name of the object to create
   object_name() {
     return this.element.data('param-key')
   }

data/app/assets/javascripts/sufia/permissions/group_controls.es6

@@ -56,7 +56,7 @@ export class GroupControls {
   }
 
   selectedGroupValid() {
-    return this.selectedGroup().index() != 0
+    return this.selectedGroup().index() !== 0
   }
 
   selectedGroup() {
@@ -64,7 +64,7 @@ export class GroupControls {
   }
 
   permissionValid() {
-    return this.selectedPermission().index() != 0
+    return this.selectedPermission().index() !== 0
   }
 
   selectedPermission() {

data/app/assets/javascripts/sufia/permissions/user_controls.es6

@@ -60,7 +60,7 @@ export class UserControls {
   }
 
   selectedUserIsDepositor() {
-    return this.userName() == this.depositor
+    return this.userName() === this.depositor
   }
 
   userValid() {
@@ -68,11 +68,11 @@ export class UserControls {
   }
 
   userNameValid() {
-    return this.userName() != ""
+    return this.userName() !== ""
   }
 
   permissionValid() {
-    return this.selectedPermission().index() != 0
+    return this.selectedPermission().index() !== 0
   }
 
   selectedPermission() {

data/app/assets/javascripts/sufia/relationships.js

@@ -1,2 +1,4 @@
-//= require sufia/relationships/table
-//= require sufia/relationships/table_row
+//= require sufia/relationships/control
+//= require sufia/relationships/registry
+//= require sufia/relationships/registry_entry
+//= require sufia/relationships/work

data/app/assets/javascripts/sufia/relationships/control.es6

@@ -0,0 +1,83 @@
+import Registry from './registry'
+import Work from './work'
+
+export default class RelationshipsControl {
+
+  /**
+   * Initializes the class in the context of an individual table element
+   * @param {jQuery} element the table element that this class represents
+   * @param {String} property the property to submit
+   * @param {String} templateId the template identifier for new rows
+   */
+  constructor(element, property, templateId) {
+    this.element = element
+    this.registry = new Registry(this.element, this.element.data('paramKey'), property, templateId)
+
+    this.input = this.element.find("[data-autocomplete='work']")
+    this.warning = this.element.find(".message.has-warning")
+    this.addButton = this.element.find("[data-behavior='add-relationship']")
+    this.errors = null
+    this.bindAddButton();
+  }
+
+  validate() {
+    if (this.input.val() === "") {
+      this.errors = ['ID cannot be empty.']
+    }
+  }
+
+  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 work 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.addWork(new Work(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");
+  }
+}

data/app/assets/javascripts/sufia/relationships/registry.es6

@@ -0,0 +1,60 @@
+import RegistryEntry from './registry_entry'
+export default class Registry {
+  /**
+   * Initialize the registry
+   * @param {jQuery} element the jquery selector for the permissions container
+   * @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
+   */
+  constructor(element, objectName, propertyName, templateId) {
+    this.objectName = objectName
+    this.propertyName = propertyName
+
+    this.templateId = templateId
+    this.items = []
+    this.element = element
+
+    // the remove button is only on preexisting grants
+    element.find('[data-behavior="remove-relationship"]').on('click', (evt) => this.removeWork(evt))
+  }
+
+  // Return an index for the hidden field when adding a new row.
+  // This makes the assumption that all the tr elements represent a work except
+  // for the final one, which is the "add another" form
+  nextIndex() {
+      return this.element.find('tbody').children('tr').length - 1;
+  }
+
+  addWork(work) {
+    work.index = this.nextIndex()
+    this.items.push(new RegistryEntry(work, this, this.element.find('tr:last'), this.templateId))
+    this.showSaveNote();
+  }
+
+  // removes a row that has been persisted
+  removeWork(evt) {
+     evt.preventDefault();
+     let button = $(evt.target);
+     let container = button.closest('tr');
+     container.addClass('hidden'); // do not show the block
+     this.addDestroyField(container, button.attr('data-index'));
+     this.showSaveNote();
+  }
+
+  addDestroyField(element, index) {
+      $('<input>').attr({
+          type: 'hidden',
+          name: `${this.fieldPrefix(index)}[_destroy]`,
+          value: 'true'
+      }).appendTo(element);
+  }
+
+  fieldPrefix(counter) {
+    return `${this.objectName}[${this.propertyName}][${counter}]`
+  }
+
+  showSaveNote() {
+    // TODO: we may want to reveal a note that changes aren't active until the work is saved
+  }
+
+}

data/app/assets/javascripts/sufia/relationships/registry_entry.es6

@@ -0,0 +1,38 @@
+export default class RegistryEntry {
+  /**
+   * Initialize the registry entry
+   * @param {Work} work the work to display on the form
+   * @param {Registry} registry the registry that holds this registry entry.
+   * @param {jQuery} element a place to insert the new row
+   * @param {String} template identifer of the new row template.
+   */
+  constructor(work, registry, element, template) {
+    this.work = work
+    this.registry = registry
+    this.element = element
+
+    let row = this.createRow(work, template);
+    this.addHiddenField(row, work);
+    row.effect("highlight", {}, 3000);
+  }
+
+  // Remove a row that has not been persisted
+  createRow(work, templateId) {
+    let row = $(tmpl(templateId, work));
+    this.element.before(row);
+    row.find('[data-behavior="remove-relationship"]').click(function () {
+      row.remove();
+    });
+
+    return row;
+  }
+
+  addHiddenField(element, work) {
+      var prefix = this.registry.fieldPrefix(work.index);
+      $('<input>').attr({
+          type: 'hidden',
+          name: prefix + '[id]',
+          value: work.id
+      }).appendTo(element);
+  }
+}