sufia 7.0.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acfeaab8524307303e47d77881ceb17215fb9207
-  data.tar.gz: 2b2e2f5c6f8812d4f63d5e240cdbb9f62f9f49ad
+  metadata.gz: 4959186bc36418c96f0c6118865f46ed422b86d5
+  data.tar.gz: ee6e03dd75c97f0d9fe345bb969f7a6940b6e643
 SHA512:
-  metadata.gz: 1df4473fc8e9a9673fd1e82c6239427770420a69bc4d73f000c969220f13c96c81d9ad4d478086a99f973e981ba0000ca634ddcc0f26245e4f1d9905181cc3a8
-  data.tar.gz: 547d3fed24466909efb179dfd8d54b790b6105cb48c192fdd1500b586e8f5e1e920dc5054c6d2c9b6ee17731508bd50ae352921f0982e931d9aa1fed156baebd
+  metadata.gz: 8bb24da31692f203e40a97a20572b258564c033635c08279fef9ad993f1101c43feef8f71652de061ce05ba0f4c862e6675a5e42b9bb426cd6e7cf660a1a1126
+  data.tar.gz: 7485282e6e6ec891998a94bd978843eafbb4023fee59d780a0382ffb1b666a89fd39cbf7dde9ab8994949f16fbdc23f1d4930fbe0039dc2e954123d3ff8cbe56

data/README.md

@@ -11,7 +11,7 @@ Docs: [![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.sv
 [![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./.github/CONTRIBUTING.md)
 [![API Docs](http://img.shields.io/badge/API-docs-blue.svg)](http://rubydoc.info/gems/sufia)
 
-Jump in: [![Slack Status](http://slack.projecthydra.org/badge.svg)](http://slack.projecthydra.org/) [![Ready Tickets](https://badge.waffle.io/projecthydra/sufia.png?label=ready&milestone=7.0.0&title=Ready)](https://waffle.io/projecthydra/sufia?milestone=7.0.0)
+Jump in: [![Slack Status](http://slack.projecthydra.org/badge.svg)](http://slack.projecthydra.org/) [![Ready Tickets](https://badge.waffle.io/projecthydra/sufia.png?label=ready&milestone=7.2.0&title=Ready)](https://waffle.io/projecthydra/sufia?milestone=7.2.0)
 
 # Table of Contents
 
@@ -49,7 +49,7 @@ Sufia uses the full power of [Hydra](http://projecthydra.org/) and extends it to
 
 Sufia has the following features:
 
-* Multiple file, or folder, upload
+* Multiple file upload, and folder uploads (for Chrome browser only)
 * Flexible user- and group-based access controls
 * Transcoding of audio and video files
 * Generation and validation of identifiers
@@ -79,6 +79,7 @@ Sufia has the following features:
 * Proxy deposit and transfers of ownership
 * Integration with Zotero for automatic population of user content
 * Suggested values from controlled vocabularies provided by [Questioning Authority](https://github.com/projecthydra-labs/questioning_authority)
+* [ResourceSync](http://www.openarchives.org/rs/1.0/resourcesync) capability lists and resource lists
 
 See [Sufia's documentation site](http://sufia.io/) for more non-technical documentation.
 
@@ -89,7 +90,7 @@ If you have questions or need help, please email [the Hydra community tech list]
 # Getting started
 
 This document contains instructions specific to setting up an app with __Sufia
-v7.0.0.beta1__. If you are looking for instructions on installing a different
+v7.1.0__. If you are looking for instructions on installing a different
 version, be sure to select the appropriate branch or tag from the drop-down
 menu above.
 
@@ -143,10 +144,10 @@ We recommend either Ruby 2.3 or the latest 2.2 version.
 
 ## Rails
 
-Generate a new Rails application. We recommend the latest Rails 4.2 release (4.2.6 when last updated).
+Generate a new Rails application. We recommend the latest Rails 4.2 release.
 
 ```
-gem install rails -v 4.2.6
+gem install rails -v 4.2.7.1
 rails new my_app
 ```
 
@@ -155,7 +156,7 @@ rails new my_app
 Add the following lines to your application's Gemfile.
 
 ```
-gem 'sufia', '7.0.0'
+gem 'sufia', '7.1.0'
 ```
 
 Then install Sufia as a dependency of your app via `bundle install`
@@ -170,7 +171,7 @@ rails generate sufia:install -f
 
 ## Generate a primary work type
 
-While earlier versions of Sufia came with a pre-defined object model, Sufia 7.0 and greater allow you to specify your primary work type by using tooling provided by the CurationConcerns gem. Work on the 7.x series will include adding support for users to generate an arbitrary number of work types, not **just** a primary work type. At this time we do *not* recommend generating multiple work types.
+While earlier versions of Sufia came with a pre-defined object model, Sufia 7.x and greater allow you to specify your primary work type by using tooling provided by the CurationConcerns gem. Work on the 7.x series will include adding support for users to generate an arbitrary number of work types, not **just** a primary work type. At this time we do *not* recommend generating multiple work types.
 
 Pass a (CamelCased) model name to Sufia's work generator to get started, e.g.:
 

data/app/assets/javascripts/sufia.js

@@ -17,13 +17,13 @@
 //= require bootstrap/tab
 
 //= require jquery.validate
-//= require zeroclipboard
 //= require select2
 //= require fixedsticky
 
 //= require jquery.flot
 //= require jquery.flot.time
 //= require jquery.flot.selection
+//= require clipboard
 
 //= require batch_edit
 //
@@ -35,7 +35,6 @@
 //= require sufia/featured_researcher
 //= require sufia/batch_select_all
 //= require sufia/browse_everything
-//= require sufia/single_use_link
 //= require sufia/search
 //= require sufia/editor
 //= require sufia/ga_events
@@ -45,6 +44,7 @@
 //= require sufia/proxy_rights
 //= require sufia/sorting
 //= require curation_concerns/batch_select
+//= require curation_concerns/single_use_links_manager
 //= require sufia/dashboard_actions
 //= require sufia/batch
 //= require sufia/flot_stats
@@ -57,11 +57,10 @@
 //= require sufia/autocomplete/location
 //= require sufia/autocomplete/subject
 //= require sufia/autocomplete/language
-
+//= require sufia/relationships
 //= require curation_concerns/collections
 //= require hydra-editor/hydra-editor
 //= require nestable
 
 // this needs to be after batch_select so that the form ids get setup correctly
 //= require sufia/batch_edit
-

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

@@ -9,6 +9,7 @@ Sufia = {
         this.permissions();
         this.notifications();
         this.transfers();
+        this.relationships_table();
     },
 
     autocomplete: function () {
@@ -58,6 +59,13 @@ Sufia = {
 
     transfers: function () {
         $("#proxy_deposit_request_transfer_to").userSearch();
+    },
+
+    relationships_table: function () {
+        var rel = require('sufia/relationships/table');
+        $('table.relationships-ajax-enabled').each(function () {
+            new rel.RelationshipsTable($(this));
+        });
     }
 };
 

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

@@ -0,0 +1,2 @@
+//= require sufia/relationships/table
+//= require sufia/relationships/table_row

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

@@ -0,0 +1,206 @@
+import { RelationshipsTableRow } from './table_row'
+
+export class RelationshipsTable {
+
+  /**
+   * Initializes the class in the context of an individual table element
+   * @param {jQuery} element the table element that this class represents
+   */
+  constructor(element) {
+    this.$element = element;
+    this.form_action = this.$element.parents("form").attr("action");
+    this.query_url = this.$element.data('query-url');
+    this.existing_related_works_values = this.$element.find("input.related_works_ids:not(.new-form-control)").map(function(i, e){ return e.value; });
+
+    // TODO: Fall back to just cloning rows and removing rows for form posting
+    if (!this.query_url)
+      return;
+
+    this.bindAddButton();
+    this.bindRemoveButton();
+    this.bindKeyEvents();
+  }
+
+  /**
+   * 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() {
+    let $this = this;
+
+    $this.$element.on("click", ".btn-add-row", function(event) {
+      let $row = $(this).parents("tr:first");
+      let $input = $row.find("input.new-form-control");
+
+      // 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 ($input.val() == "") {
+        $this.setWarningMessage($row, "ID cannot be empty.");
+      } else if ($.inArray($input.val(), $this.existing_related_works_values) > -1) {
+        $this.setWarningMessage($row, "Work is already related.");
+      } else {
+
+        let query_url = $this.query_url.replace('$id', $input.val());
+        $this.hideWarningMessage($row);
+        $this.callAjax({
+          row: $row,
+          table: $this.$element,
+          input: $input,
+          url: $this.form_action,
+          query_url: query_url,
+          on_error: $this.handleError,
+          on_success: $this.handleAddRowSuccess
+        });
+      }
+    });
+  }
+
+  /**
+   * Find and fire off the click event for the "Add" button
+   * @param {jQuery} $row the row containing the add button to click
+   */
+  clickAddbutton($row) {
+    $row.find(".btn-add-row").click();
+  }
+
+  /**
+   * Handle click events by the "Remove" buttons in the table, and calling the
+   * server to handle the request
+   */
+  bindRemoveButton() {
+    let $this = this;
+
+    $this.$element.on("click", ".btn-remove-row", function(event) {
+      let $row = $(this).parents("tr:first");
+      let $input = $row.find("input.related_works_ids:first");
+
+      // Track which input is attemping to be removed, to provide an easy way
+      // for the ajax call to exclude it when making the call to the server
+      $input.addClass("removing");
+      $this.callAjax({
+        row: $row,
+        table: $this.$element,
+        input: $input,
+        url: $this.form_action,
+        on_error: $this.handleError,
+        on_success: $this.handleRemoveRowSuccess
+      });
+    });
+  }
+
+  /**
+   * Handle keyup and keypress events at the form level to prevent the ENTER key
+   * from submitting the form. ENTER key within a relationships table should
+   * click the "Add" button instead. ESC key should clear the input and hide the
+   * error message.
+   */
+  bindKeyEvents() {
+    let $this = this;
+    let $form = this.$element.parents("form");
+
+    $form.on("keyup keypress", "input.related_works_ids", function(event) {
+      let $row = $(this).parents("tr:first");
+      let key_code = event.keyCode || event.which;
+
+      // ENTER key was pressed, wait for keyup to click the Add button
+      if (key_code === 13) {
+        if (event.type == "keyup") {
+          $this.clickAddbutton($row);
+        }
+        event.preventDefault();
+        return false;
+      }
+
+      // ESC key was pressed, clear the input field and hide the error
+      if (key_code === 27 && event.type == "keyup") {
+        $(this).val("");
+        $this.hideWarningMessage($row);
+      }
+    });
+  }
+
+  /**
+   * Set the warning message related to the appropriate row in the table
+   * @param {jQuery} $row the row containing the warning message to display
+   * @param {String} message the warning message text to set
+   */
+  setWarningMessage($row, message) {
+    $row.find(".message.has-warning").text(message).removeClass("hidden");
+  }
+
+  /**
+   * Hide the warning message on the appropriate row
+   * @param {jQuery} $row the row containing the warning message to hide
+   */
+  hideWarningMessage($row){
+    $row.find(".message").addClass("hidden");
+  }
+
+  /**
+   * Call the server, then call the appropriate callbacks to handle success and errors
+   * @param {Object} args the table, row, input, url, and callbacks
+   */
+  callAjax(args) {
+    let $this = this;
+    // Send only the IDs in this table that aren't in the midst of being "removed"
+    let data = args.table.find("input.related_works_ids:not('.removing')").serialize();
+    $.ajax({
+        type: 'patch',
+        url: args.url,
+        dataType: 'json',
+        data: data
+      })
+      .done(function(json) {
+        args.on_success($this, args, json);
+      })
+      .fail(function(jqxhr, status, err) {
+        args.on_error($this, args, jqxhr, status, err);
+      });
+  }
+
+  /**
+   * Set a warning message to alert the user on an error
+   * @param {jQuery} $this the RelationshipsTable class instance
+   * @param {Object} args the table, row, input, url, and callbacks
+   * @param {Object} jqxhr the jQuery XHR response object
+   * @param {String} status the HTTP error status
+   * @param {String} err the HTTP error
+   */
+  handleError($this, args, jqxhr, status, err) {
+    args.row.find('input.removing').removeClass('removing');
+    let message = jqxhr.statusText;
+    if(jqxhr.responseJSON){
+      message = jqxhr.responseJSON.description;
+    }
+    $this.setWarningMessage(args.row, message);
+  }
+
+  /**
+   * Remove the row when the API returns this type of success
+   * @param {jQuery} $this the RelationshipsTable class instance
+   * @param {Object} args the table, row, input, url, and callbacks
+   * @param {String} json the returned JSON string
+   */
+  handleRemoveRowSuccess($this, args, json) {
+    args.row.remove();
+  }
+
+  /**
+   * Add a new row to the table, query the server for details about the work to
+   * set the title and link for the new work that was added. Hide the input
+   * field and display the title and edit button
+   * @param {jQuery} $this the RelationshipsTable class instance
+   * @param {Object} args the table, row, input, url, and callbacks
+   * @param {String} json the returned JSON string
+   */
+  handleAddRowSuccess($this, args, json) {
+    let new_row = new RelationshipsTableRow(args.table);
+    new_row.clone(args.row);
+    new_row.callAjaxQuery(args.query_url);
+
+    // finally, empty the "add" row input value
+    args.row.find("input.new-form-control").val("");
+    // synch the related_works_values to include the new work relationship
+    $this.existing_related_works_values = $this.$element.find("input.related_works_ids:not(.new-form-control)").map(function(i, e){ return e.value; });
+  }
+}

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

@@ -0,0 +1,79 @@
+export class RelationshipsTableRow {
+  /**
+   * Inititializes a new table row class
+   * @param {jQuery} $table the table which this row is related to
+   */
+  constructor($table){
+    this.table = $table;
+    this.element = null;
+  }
+
+  /**
+   * The title element
+   * @returns {jQuery} the title element
+   */
+  get title() { return this.element.find("a.title:first"); }
+
+  /**
+   * The input field
+   * @returns {jQuery} the input field
+   */
+  get input() { return this.element.find("input.related_works_ids:first"); }
+
+  /**
+   * The "Add" button
+   * @returns {jQuery} the add button element
+   */
+  get addButton() { return this.element.find(".btn-add-row"); }
+
+  /**
+   * The "Remove" button
+   * @returns {jQuery} the remove button element
+   */
+  get removeButton() { return this.element.find(".btn-remove-row"); }
+
+  /**
+   * The "Edit" button
+   * @returns {jQuery} the edit button element
+   */
+  get editButton() { return this.element.find("a.edit:first"); }
+
+  /**
+   * Clone the row, set the element in this instance of the class, and reset the proper styles for this row. Insert
+   * this new row before the row passed in.. leaving the passed in row styled as-is, the caller of this method is responsible
+   * for properly handling adjustment to the passed in row
+   * @param {jQuery} $row the row to be cloned
+   */
+  clone($row){
+    this.element = $row.clone();
+    this.addButton.addClass("hidden");
+    this.removeButton.removeClass("hidden");
+    this.element.insertBefore($row);
+  }
+
+  /**
+   * Make an ajax call to the supplied url.
+   * After a row is cloned, this method could be called to refresh the row with more details (title, appropriate links, etc)
+   * based on the details returned from the server.
+   * @param {String} query_url the url to be called for querying details from the server
+   */
+  callAjaxQuery(query_url) {
+    let $this = this;
+    $.getJSON(query_url, function (data) {
+      // Set the cloned input to have the proper name and value for posting the
+      // form to the server, and hide it.
+      $this.input.removeClass("new-form-control")
+        .addClass("hidden")
+        .val(data.id);
+
+      // Set the linkified title and show.
+      $this.title.text(data.title[0])
+        .attr("href", query_url)
+        .removeClass("hidden");
+
+      // Set the edit button link and show.
+      $this.editButton.attr("href", query_url + "/edit")
+        .removeClass("hidden");
+    });
+  }
+}

data/app/assets/javascripts/sufia/save_work/save_work_control.es6

@@ -104,6 +104,9 @@ export class SaveWorkControl {
 
   // sets the files indicator to complete/incomplete
   validateFiles() {
+    if (!this.uploads.hasFileRequirement) {
+      return true
+    }
     if (!this.isNew || this.uploads.hasFiles) {
       this.requiredFiles.check()
       return true

data/app/assets/javascripts/sufia/save_work/uploaded_files.es6

@@ -5,6 +5,11 @@ export class UploadedFiles {
     $('#fileupload').bind('fileuploadcompleted', callback)
   }
 
+  get hasFileRequirement() {
+    let fileRequirement = this.form.find('li#required-files')
+    return fileRequirement.size() > 0
+  }
+
   get hasFiles() {
     let fileField = this.form.find('input[name="uploaded_files[]"]')
     return fileField.size() > 0