hyrax 2.1.0.beta1 → 2.1.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e42502331d699a799fad6da0360519ece766d82c
-  data.tar.gz: a15052167c02906f25795e0ca1032d0e3348db91
+  metadata.gz: be1e8653f1cbe02d0084c4e9d5ad3ae86452030c
+  data.tar.gz: 3195a5f77e3b68b97ad86b0d441340037f2c5617
 SHA512:
-  metadata.gz: 935f31ae4c0dd84119ea4166186d1da09b941e96d63c72663d5358485b11416ce3ef5d5dabd940555549898836b46c79e5464ab305986b2a609dc2019999a8de
-  data.tar.gz: dfee962f81193815a33cea4417737f4cf6c08981c323df9b9b3035047ead86163d05fc571992846eeed49ac15a693b0537f6a97a405b0942c0f2b275e4e35d59
+  metadata.gz: eca96b7e93e799c6540995b8607f0c696350e125030475c7e15ac567f1c048ed05a851f656b04c2a72c258e26d1c95cf08e52f79f87c1446269e055d626e8de4
+  data.tar.gz: 155ac39bca91ca478e0856b27a6487ff9976e7dddee5b22a4ed6b3323f109e3dc1310bdd82fb529a542cb9603926d571df8e23b65f73c9a14323025ed502d159

data/.rubocop.yml

@@ -1,12 +1,11 @@
-require: rubocop-rspec
+inherit_gem:
+  bixby: bixby_default.yml
+
 inherit_from: .rubocop_fixme.yml
 
 AllCops:
   TargetRubyVersion: 2.1
   DisplayCopNames: true
-  Include:
-    - '**/Rakefile'
-    - '**/config.ru'
   Exclude:
     - 'db/**/*'
     - 'script/**/*'
@@ -14,25 +13,10 @@ AllCops:
     - 'vendor/**/*'
     - 'lib/hyrax/specs/**/*'
 
-Bundler/DuplicatedGem:  # This doesn't work with engine_cart
-  Enabled: false
-
-Layout/IndentationConsistency:
-  EnforcedStyle: rails
-
 Lint/ImplicitStringConcatenation:
   Exclude:
     - 'lib/generators/hyrax/**/*'
 
-Lint/AmbiguousBlockAssociation:
-  Enabled: false
-
-Metrics/LineLength:
-  Max: 200
-
-Metrics/AbcSize:
-  Max: 26
-
 Metrics/BlockLength:
   ExcludedMethods: ['included']
   Exclude:
@@ -47,12 +31,9 @@ Metrics/BlockLength:
     - 'lib/tasks/*.rake'
     - 'spec/**/*.rb'
 
-Metrics/MethodLength:
-  Max: 13
-
-Naming/FileName: # https://github.com/bbatsov/rubocop/issues/2973
-  Exclude:
-    - 'Gemfile'
+# Naming/FileName: # https://github.com/bbatsov/rubocop/issues/2973
+#   Exclude:
+#     - 'Gemfile'
 
 Style/AsciiComments:
   Enabled: false
@@ -76,21 +57,9 @@ Style/NumericPredicate:
 Style/SymbolArray:
   Enabled: false
 
-Style/WordArray:
-  Enabled: false
-
-Style/RegexpLiteral:
-  Enabled: false
-
-Style/StringLiterals:
-  Enabled: false
-
 Style/ClassAndModuleChildren:
   Enabled: false
 
-Style/Documentation:
-  Enabled: false
-
 Style/SingleLineBlockParams:
   Enabled: false
 
@@ -98,9 +67,6 @@ Style/ZeroLengthPredicate:
   Exclude:
     - 'app/controllers/hyrax/file_sets_controller.rb'
 
-Rails:
-  Enabled: true
-
 Rails/ApplicationJob:
   Enabled: false
 
@@ -141,12 +107,9 @@ RSpec/DescribeClass:
     - 'spec/tasks/rake_spec.rb'
     - 'spec/views/**/*'
 
-RSpec/ContextWording:
-  Enabled: false
-
-# By default RSpec/MessageSpies has the following:
-#   Prefer have_received for setting message expectations. Setup form as a spy using allow or instance_spy.
-# The default assumes EnforcedStyle is 'have_received'. Most of our specs are 'receive'
+# # By default RSpec/MessageSpies has the following:
+# #   Prefer have_received for setting message expectations. Setup form as a spy using allow or instance_spy.
+# # The default assumes EnforcedStyle is 'have_received'. Most of our specs are 'receive'
 RSpec/MessageSpies:
   Enabled: false
 
@@ -163,9 +126,6 @@ RSpec/LetSetup:
 RSpec/MessageExpectation:
   Enabled: false
 
-RSpec/MultipleExpectations:
-  Enabled: false
-
 RSpec/NestedGroups:
   Enabled: false
 

data/.rubocop_fixme.yml

@@ -6,6 +6,7 @@ Metrics/ClassLength:
   Exclude:
     - 'app/controllers/hyrax/dashboard/collections_controller.rb'
     - 'app/controllers/hyrax/admin/admin_sets_controller.rb'
+    - 'app/controllers/hyrax/downloads_controller.rb'
     - 'app/controllers/hyrax/file_sets_controller.rb'
     - 'app/forms/hyrax/forms/permission_template_form.rb'
     - 'app/presenters/hyrax/work_show_presenter.rb'

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
-sudo: false
+sudo: required
 dist: trusty
 
 addons:

data/Gemfile

@@ -10,6 +10,7 @@ group :development, :test do
   gem "simplecov", require: false
 end
 
+# rubocop:disable Bundler/DuplicatedGem
 # BEGIN ENGINE_CART BLOCK
 # engine_cart: 1.1.0
 # engine_cart stanza: 0.10.0
@@ -44,7 +45,6 @@ else
   end
 end
 # END ENGINE_CART BLOCK
+# rubocop:enable Bundler/DuplicatedGem
 
-unless File.exist?(file)
-  eval_gemfile File.expand_path('spec/test_app_templates/Gemfile.extra', File.dirname(__FILE__))
-end
+eval_gemfile File.expand_path('spec/test_app_templates/Gemfile.extra', File.dirname(__FILE__)) unless File.exist?(file)

data/README.md

@@ -63,7 +63,7 @@ The Samvera community is here to help. Please see our [support guide](./.github/
 # Getting started
 
 This document contains instructions specific to setting up an app with __Hyrax
-v2.1.0.beta1__. If you are looking for instructions on installing a different
+v2.1.0.beta2__. 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.
 
@@ -122,6 +122,8 @@ On OSX, you can use Homebrew to install ffmpeg:
 
 Otherwise, to compile ffmpeg yourself, see the [ffmpeg compilation guide](https://trac.ffmpeg.org/wiki/CompilationGuide).
 
+Once ffmpeg has been installed, enable transcoding by setting `config.enable_ffmpeg = true` in `config/initializers/hyrax.rb`.  You may also configure the location of ffmpeg using `config.ffmpeg_path`.
+
 ## Environments
 
 Note here that the following commands assume you're setting up Hyrax in a development environment (using the Rails built-in development environment). If you're setting up a production or production-like environment, you may wish to tell Rails that by prepending `RAILS_ENV=production` to the commands that follow, e.g., `rails`, `rake`, `bundle`, and so on.
@@ -160,7 +162,7 @@ NOTE: The steps need to be done in order to create a new Hyrax based app.
 Generate a new Rails application using the template.
 
 ```
-rails _5.0.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.1.0.beta1/template.rb
+rails _5.0.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.1.0.beta2/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:

data/app/actors/hyrax/actors/file_set_actor.rb

@@ -147,7 +147,6 @@ module Hyrax
         # Must clear the fileset from the thumbnail_id, representative_id and rendering_ids fields on the work
         #   and force it to be re-solrized.
         # Although ActiveFedora clears the children nodes it leaves those fields in Solr populated.
-        # rubocop:disable Metrics/AbcSize
         # rubocop:disable Metrics/CyclomaticComplexity
         def unlink_from_work
           work = file_set.parent

data/app/actors/hyrax/actors/interpret_visibility_actor.rb

@@ -114,9 +114,7 @@ module Hyrax
 
         def apply_visibility(env, intention)
           result = apply_lease(env, intention) && apply_embargo(env, intention)
-          if env.attributes[:visibility]
-            env.curation_concern.visibility = env.attributes[:visibility]
-          end
+          env.curation_concern.visibility = env.attributes[:visibility] if env.attributes[:visibility]
           result
         end
 

data/app/actors/hyrax/actors/model_actor.rb

@@ -2,6 +2,9 @@ module Hyrax
   module Actors
     # This is a proxy for the model specific actor
     class ModelActor < AbstractActor
+      # See: https://github.com/bbatsov/rubocop/issues/5393
+      # rubocop:disable Rails/Delegate
+
       # @param [Hyrax::Actors::Environment] env
       # @return [Boolean] true if update was successful
       def update(env)
@@ -19,6 +22,7 @@ module Hyrax
       def destroy(env)
         model_actor(env).destroy(env)
       end
+      # rubocop:enable Rails/Delegate
 
       private
 

data/app/assets/javascripts/hyrax.js

@@ -86,7 +86,6 @@
 //= require hyrax/relationships
 //= require hyrax/select_work_type
 //= require hyrax/collections
-//= require hyrax/collections_forms
 //= require hyrax/collection_types
 //= require hyrax/select_collection_type
 //= require hydra-editor/hydra-editor
@@ -100,6 +99,7 @@
 //= require hyrax/thumbnail_select
 //= require hyrax/batch_select
 //= require hyrax/tabbed_form
+//= require hyrax/turbolinks_events
 
 // this needs to be after batch_select so that the form ids get setup correctly
 //= require hyrax/batch_edit

data/app/assets/javascripts/hyrax/app.js.erb

@@ -46,7 +46,7 @@ Hyrax = {
     // The Collection edit page
     collectionEditor: function() {
       var CollectionControls = require('hyrax/collections/editor');
-      var controls = new CollectionControls($('#collection-controls'));
+      var controls = new CollectionControls($('#collection_permissions'));
     },
 
     // Collection types

data/app/assets/javascripts/hyrax/authority_select.es6

@@ -1,3 +1,5 @@
+import Autocomplete from 'hyrax/autocomplete'
+
 /** Class for authority selection on an input field */
 export default class AuthoritySelect {
     /**
@@ -6,8 +8,7 @@ export default class AuthoritySelect {
      * @param {string} selectBox - The selector for the select box
      * @param {string} inputField - The selector for the input field
      */
-    constructor(editor, options) {
-      this.editor = editor
+    constructor(options) {
     	this.selectBox = options.selectBox
     	this.inputField = options.inputField
     	this.selectBoxChange();
@@ -24,8 +25,10 @@ export default class AuthoritySelect {
         var _this2 = this
       	$(selectBox).on('change', function(data) {
       	    var selectBoxValue = $(this).val();
-      	    $(inputField).each(function (data) { $(this).data('autocomplete-url', selectBoxValue) });
-      	    _this2.setupAutocomplete();
+      	    $(inputField).each(function (data) {
+              $(this).data('autocomplete-url', selectBoxValue);
+      	       _this2.setupAutocomplete()
+            });
       	});
     }
 
@@ -35,11 +38,14 @@ export default class AuthoritySelect {
     observeAddedElement() {
       	var selectBox = this.selectBox;
       	var inputField = this.inputField;
+        var _this2 = this
 
       	var observer = new MutationObserver((mutations) => {
       	    mutations.forEach((mutation) => {
-      		      $(inputField).each(function (data) { $(this).data('autocomplete-url', $(selectBox).val()) });
-      		      this.setupAutocomplete();
+      		      $(inputField).each(function (data) {
+                  $(this).data('autocomplete-url', $(selectBox).val())
+      		        _this2.setupAutocomplete();
+                });
       	    });
       	});
 
@@ -51,6 +57,8 @@ export default class AuthoritySelect {
      * intialize the Hyrax autocomplete with the fields that you are using
      */
     setupAutocomplete() {
-      this.editor.autocomplete()
+      var inputField = $(this.inputField);
+      var autocomplete = new Autocomplete()
+      autocomplete.setup(inputField, inputField.data('autocomplete'), inputField.data('autocompleteUrl'))
     }
 }

data/app/assets/javascripts/hyrax/collections.js

@@ -1,11 +1,59 @@
 Blacklight.onLoad(function () {
 
+  /**
+   * Post modal data via Ajax to avoid nesting <forms> in edit collections tabs screen
+   * @param  {string} url   URL where to submit the AJAX request
+   * @param  {string} type  The type of network request: 'POST', 'DELETE', etc.
+   * @param  {object} data  Data object to send with network request.  Should default to {}
+   * @param  {jQuery object} $self Reference to the jQuery context ie. $(this) of calling statemnt
+   * @return {void}
+   */
+  function submitModalAjax(url, type, data, $self) {
+    $.ajax({
+      type: type,
+      url: url,
+      data: data
+    }).done(function(response) {
+    }).fail(function(err) {
+      var alertNode = buildModalErrorAlert(err);
+      var $alert = $self.closest('.modal').find('.modal-ajax-alert');
+      $alert.html(alertNode);
+    });
+  }
+
+  /**
+   * HTML for ajax error alert message, in case the AJAX request fails
+   * @param  {object} err AJAX response object
+   * @return {string}     The constructed HTML alert string
+   */
+  function buildModalErrorAlert(err) {
+    var message = (err.responseText ? err.responseText : 'An unknown error has occurred');
+    var elHtml = '<div class="alert alert-danger alert-dismissible" role="alert"><button type="button" class="close" data-dismiss="alert" aria-label="Close"><span aria-hidden="true">&times;</span></button><span class="message">' + message + '</span></div>';
+    return elHtml;
+  }
+
+  /**
+   * Handle delete collection submit button click from within a generic modal
+   * @return {void}
+   */
+  function handleModalDeleteCollection() {
+    var $self = $(this),
+      $modal = $self.closest('.modal'),
+      url = $modal.data('postDeleteUrl'),
+      data = {};
+    if (url.length === 0) {
+      return;
+    }
+    $self.prop('disabled', true);
+    submitModalAjax(url, 'DELETE', data, $self);
+  }
+
   /**
    * Sync collection data attributes to the singular instance of the modal so it knows what data to post
    * @param {string} modalId - The id of modal to target, ie. #add_collection_modal
    * @param {[string]} dataAttributes - An string array of "data-xyz" data attributes WITHOUT
    * the "data-" prefix. ie. ['id', 'some-var']
-   * @param {jquery Object} $tr - jQuery object reference to a table row
+   * @param {jquery Object} $dataEl - jQuery object reference which has values of data attributes we're copying over
    * @return {void}
    */
   function addDataAttributesToModal(modalId, dataAttributes, $dataEl) {
@@ -24,7 +72,7 @@ Blacklight.onLoad(function () {
     var options = collsHash.map(function(col) {
       return '<option value="' + col.id + '">' + col.title_first + '</option>';
     });
-    markup = options.join('');
+    var markup = options.join('');
     return markup;
   }
 
@@ -66,7 +114,7 @@ Blacklight.onLoad(function () {
 
     // Disable the submit button in modal by default
     $('#add-to-collection-modal').find('.modal-submit-button').prop('disabled', true);
-    
+
     // Show modal
     $('#add-to-collection-modal').modal('show');
   }
@@ -104,6 +152,31 @@ Blacklight.onLoad(function () {
     $(modalId).modal('show');
   }
 
+  /**
+   * Generically disable modal submit buttons unless their select element
+   * has a valid value.
+   *
+   * To Use:
+   * 1.) Put the '.disable-unless-selected' class on the '.modal' element you wish to protect.
+   * 2.) Add the 'disabled' attribute to your protected submit button ie. <button disabled ...>.
+   * 3.) Put the '.modal-submit-button' class on whichever button you wish to disable for an invalid
+   * <select> value ie. <button disabled class="... modal-submit-button" ...>
+   *
+   * @return {void}
+   */
+  $('.modal.disable-unless-selected select').on('change', function() {
+    var selectValue = $(this).val(),
+      emptyValues = ['', 'none'],
+      selectHasAValue = emptyValues.indexOf(selectValue) === -1,
+      $submitButton = $(this).parents('.modal').find('.modal-submit-button');
+
+    $submitButton.prop('disabled', !selectHasAValue);
+  });
+
+  // Add click listeners for collections buttons which initiate modal action windows
+  $('.add-to-collection').on('click', handleAddToCollection);
+  $('.delete-collection-button').on('click', handleDeleteCollection);
+
   // change the action based which collection is selected
   // This expects the form to have a path that includes the string 'collection_replace_id'
   $('[data-behavior="updates-collection"]').on('click', function() {
@@ -115,18 +188,46 @@ Blacklight.onLoad(function () {
       form.append('<input type="hidden" value="add" name="collection[members]"></input>');
   });
 
-
-  // Set up click listeners for collections buttons which initiate modal action windows
-  $('.add-to-collection').on('click', handleAddToCollection);
-  $('.delete-collection-button').on('click', handleDeleteCollection);
-
-
   // Display access deny for edit request.
   $('#documents').find('.edit-collection-deny-button').on('click', function (e) {
     e.preventDefault();
     $('#collections-to-edit-deny-modal').modal('show');
   });
 
+  // Remove this parent collection list button clicked
+  $('#parent-collections-wrapper')
+    .find('.remove-from-collection-button')
+    .on('click', function (e) {
+    var $dataEl = $(this).closest('li'),
+      modalId = '#collection-remove-from-collection-modal';
+
+    addDataAttributesToModal(modalId, ['id', 'parent-id', 'post-url'], $dataEl);
+    $(modalId).modal('show');
+  });
+
+  // Remove this sub-collection list button clicked
+  $('#sub-collections-wrapper')
+    .find('.remove-subcollection-button')
+    .on('click', function (e) {
+    var $dataEl = $(this).closest('li'),
+      modalId = '#collection-remove-subcollection-modal';
+
+    addDataAttributesToModal(modalId, ['id', 'parent-id', 'post-url'], $dataEl);
+    $(modalId).modal('show');
+  });
+
+  // Remove collection from list modal "Submit/Remove" button clicked
+  $('.modal-button-remove-collection').on('click', function(e) {
+    var $self = $(this),
+      $modal = $self.closest('.modal'),
+      url = $modal.data('postUrl'),
+      data = {};
+    if (url.length === 0) {
+      return;
+    }
+    $self.prop('disabled', true);
+    submitModalAjax(url, 'POST', data, $self);
+  });
 
   // Delete selected collections button click
   $('#delete-collections-button').on('click', function () {
@@ -174,4 +275,82 @@ Blacklight.onLoad(function () {
     $("#more-parent-collections").hide();
     $("#show-more-parent-collections").show();
   });
+
+  // Add to collection modal form post
+  $('#add-to-collection-modal').find('.modal-add-button').on('click', function (e) {
+    var $self = $(this),
+      $modal = $self.closest('.modal'),
+      url = $modal.data('postUrl'),
+      parentId = $modal.find('[name="parent_id"]').val(),
+      data = {
+        parent_id: parentId,
+        source: $self.data('source')
+      };
+    if (url.length === 0) {
+      return;
+    }
+    submitModalAjax(url, 'POST', data, $self);
+  });
+
+  // Handle delete collection modal submit button click event
+  ['#collection-to-delete-modal', '#collection-empty-to-delete-modal'].forEach(function(id) {
+    $(id).find('.modal-delete-button').on('click', handleModalDeleteCollection);
+  });
+
+  // Add sub collection to collection form post
+  $('[id^="add-subcollection-modal-"]').find('.modal-add-button').on('click', function (e) {
+    var url = $(this).data('postUrl'),
+      childId = $(this).closest('.modal').find('[name="child_id"]').val(),
+      data = {
+      child_id: childId,
+      source: $(this).data('source')
+    };
+    if (url.length === 0) {
+      return;
+    }
+    submitModalAjax(url, 'POST', data, $(this));
+  });
+
+
+  // Handle add a subcollection button click on the collections show page
+  $('.sub-collections-wrapper button.add-subcollection').on('click', function (e) {
+    $('#add-subcollection-modal-' + $(this).data('presenterId')).modal('show');
+  });
+
+
+  // Edit Collection: Sharing tab: Add Sharing section click handlers
+  /*
+  Notes:
+  This is a workaround for a scoping issue with 'simple_form' and nested forms in the
+  'Edit Collections' partials.  All tabs were wrapped in a 'simple_form'. Nested forms, for example inside a tab partial,
+  have behaved erratically, so the pattern has been to remove nested form instances for relatively non-complex forms
+  and replace with AJAX requests.  For this instance of Add Sharing > Add user and Add group, seem more complex in how
+  the form is built from '@form.permission_template', so since it's not working, but the form is already built, this
+  code listens for a click event on the nested form submit button, prevents Default submit behavior, and manually makes
+  the form post.
+   */
+  $('#participants').find('.edit-collection-add-sharing-button').on('click', function(e) {
+    e.preventDefault();
+    var $wrapEl = $(e.target).parents('.form-add-sharing-wrapper');
+    if ($wrapEl.length === 0) {
+      return;
+    }
+    var serialized = $wrapEl.find(':input').serialize(),
+      url = '/dashboard/collections/' + $wrapEl.data('id') + '/permission_template?locale=en';
+
+    if (serialized.length === 0) {
+      return;
+    }
+
+    $.ajax({
+      type: 'POST',
+      url: url,
+      data: serialized
+    }).done(function(response) {
+      // Success handler here, possibly show alert success if page didn't reload?
+    }).fail(function(err) {
+      console.error(err);
+    });
+
+  });
 });