hyrax 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6a1824b56a3a850771584a1c9a8d7c8dfa5a6fed
-  data.tar.gz: ff1c6594682a4e018d4f987a9e6c1c30a87561b8
+SHA256:
+  metadata.gz: 22ddfe8e8c1460fde698f49262a96de5ed83e1e6123dca1c9fdc202936b04e4e
+  data.tar.gz: 0e8ebfc5c1f48013d9c5513edee21abe45d019794f278cec0e2a42480e05075e
 SHA512:
-  metadata.gz: 60f7edf74e9bcd1ad42792326983952c8333d1918cd668253eadde53e166099b21fb692460cf92c0e1a74b69afea613a1c24075d6f18b34ee07aff3dca63ad1f
-  data.tar.gz: a61030d3933e733b0ada6910dfd2d0d1f5ee6e785c985392ec67eb58c354d644885df7acb6c79288f433d644d712ad599d79eb30b1cc6bb4e5b853be1ec5210e
+  metadata.gz: 3eb864d6b6bba16982ac67c2121324861b8a7b64ed17d64d8bf145554494509bf886aff95102f6d8b96893380723d81d740140e7dfbe2a6ba650cd09dd39ddfb
+  data.tar.gz: a8c02242bd7627bb2d04a694fe2405fe5927acd39d8c41939cae76043948d4b4d7caeec8f142d4c3d14b5969fcb8c10cd24644b8d77ab296585052b2e5a8c2a4

data/.github/ISSUE_TEMPLATE.md

@@ -13,7 +13,7 @@ Provide the rationale or user story that describes "why" this issue should be ad
 ### Steps to reproduce the behavior
 
 1. Do this
-1. Then do this...
+2. Then do this...
 
 ### Related work
 

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -19,4 +19,9 @@ Changes proposed in this pull request:
 *
 *
 
+Guidance for testing, such as acceptance criteria or new user interface behaviors:
+*
+*
+*
+
 @samvera/hyrax-code-reviewers

data/.rubocop.yml

@@ -4,7 +4,7 @@ inherit_gem:
 inherit_from: .rubocop_fixme.yml
 
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.3
   DisplayCopNames: true
   Exclude:
     - 'db/**/*'
@@ -47,6 +47,13 @@ Style/CollectionMethods:
     detect: 'find'
     find_all: 'select'
 
+# disable frozen string literal comment. We can't safely introduce this
+# system-wide until a major version because it freezes strings that downstream
+# users might be mutating. Please use the frozen string literal pragma on new
+# files
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
 Style/MethodMissing:
   Exclude:
     - 'app/models/concerns/hyrax/file_set/characterization.rb'

data/README.md

@@ -4,7 +4,6 @@ Code: [![Version](https://badge.fury.io/rb/hyrax.png)](http://badge.fury.io/rb/h
 [![Build Status](https://travis-ci.org/samvera/hyrax.png?branch=master)](https://travis-ci.org/samvera/hyrax)
 [![Coverage Status](https://coveralls.io/repos/github/samvera/hyrax/badge.svg?branch=master)](https://coveralls.io/github/samvera/hyrax?branch=master)
 [![Code Climate](https://codeclimate.com/github/samvera/hyrax/badges/gpa.svg)](https://codeclimate.com/github/samvera/hyrax)
-[![Dependency Update Status](https://gemnasium.com/samvera/hyrax.png)](https://gemnasium.com/samvera/hyrax)
 [![Dependency Maintenance Status](https://dependencyci.com/github/samvera/hyrax/badge)](https://dependencyci.com/github/samvera/hyrax)
 
 Docs: [![Documentation Status](https://inch-ci.org/github/samvera/hyrax.svg?branch=master)](https://inch-ci.org/github/samvera/hyrax)
@@ -63,7 +62,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__. If you are looking for instructions on installing a different
+v2.2.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.
 
@@ -132,7 +131,7 @@ Note here that the following commands assume you're setting up Hyrax in a develo
 
 First, you'll need a working Ruby installation. You can install this via your operating system's package manager -- you are likely to get farther with OSX, Linux, or UNIX than Windows but your mileage may vary -- but we recommend using a Ruby version manager such as [RVM](https://rvm.io/) or [rbenv](https://github.com/sstephenson/rbenv).
 
-We recommend either Ruby 2.5 or the latest 2.4 version.
+Hyrax supports Ruby 2.3, 2.4 and 2.5. When starting a new project, we recommend using the latest Ruby 2.5 version.
 
 ## Redis
 
@@ -162,7 +161,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.1.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.1.0/template.rb
+rails _5.1.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.2.0/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:
@@ -188,13 +187,6 @@ Notes:
 * This web server is purely for development purposes. You will want to use a more fully featured [web server](#web-server) for production-like environments.
 * You have the option to start each of these services individually.  More information on [solr_wrapper](https://github.com/cbeer/solr_wrapper) and [fcrepo_wrapper](https://github.com/cbeer/fcrepo_wrapper) will help you set this up.  Start rails with `rails s`.
 
-### Avoid Performance Issues with solr-suggest
-
-*Recommended for all Hyrax apps.*
-
-It is strongly suggested that you turn off solr-suggest.  Details on why and how to do this are in 
-[Fix performance issue caused by solr-suggest](https://github.com/samvera/hyrax/wiki/Troubleshooting-Migration-from-2.0.x-to-2.1.0#fix-performance-issue-caused-by-solr-suggest-after-200-objects-are-in-the-repository).
-
 ## Start background workers
 
 Many of the services performed by Hyrax are resource intensive, and therefore are well suited to running as background jobs that can be managed and executed by a message queuing system. Examples include:

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

@@ -54,7 +54,7 @@ module Hyrax
       # @param [Hash] file_set_params specifying the visibility, lease and/or embargo of the file set.
       #   Without visibility, embargo_release_date or lease_expiration_date, visibility will be copied from the parent.
       def create_metadata(file_set_params = {})
-        file_set.apply_depositor_metadata(user)
+        file_set.depositor = depositor_id(user)
         now = TimeService.time_in_utc
         file_set.date_uploaded = now
         file_set.date_modified = now
@@ -144,6 +144,11 @@ module Hyrax
           !((file_set_params || {}).keys.map(&:to_s) & %w[visibility embargo_release_date lease_expiration_date]).empty?
         end
 
+        # replaces file_set.apply_depositor_metadata(user)from hydra-access-controls so depositor doesn't automatically get edit access
+        def depositor_id(depositor)
+          depositor.respond_to?(:user_key) ? depositor.user_key : depositor
+        end
+
         # 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.

data/app/assets/javascripts/hyrax.js

@@ -31,7 +31,7 @@
 
 //= require clipboard
 
-// TODO: Consider removing? jcoyne thinks this is primarily needed for testing with PhantomJS:
+// This is required for Jasmine tests, specifically to polyfill the Symbol() function
 //= require babel/polyfill
 // CustomElements polyfill is a dependency of time-elements
 //= require webcomponentsjs/0.5.4/CustomElements.min

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

@@ -25,8 +25,16 @@ export default class {
     this.saveWorkControl()
     this.saveWorkFixed()
     this.authoritySelect()
+    this.formInProgress()
   }
 
+  // Immediate feedback after work creation, editing.
+  formInProgress() {
+    $('[data-behavior~=work-form]').on('submit', function(event){
+      $('.panel-footer').toggleClass('hidden');
+    });
+  }
+  
   // Used when you have a linked data field that can have terms from multiple
   // authorities.
   authoritySelect() {

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

@@ -92,6 +92,20 @@ export default class SaveWorkControl {
     this.preventSubmit()
     this.watchMultivaluedFields()
     this.formChanged()
+    this.addFileUploadEventListeners();
+  }
+
+  addFileUploadEventListeners() {
+    let $uploadsEl = this.uploads.element;
+    const $cancelBtn = this.uploads.form.find('#file-upload-cancel-btn');
+
+    $uploadsEl.bind('fileuploadstart', () => {
+      $cancelBtn.removeClass('hidden');
+    });
+
+    $uploadsEl.bind('fileuploadstop', () => {
+      $cancelBtn.addClass('hidden');
+    });
   }
 
   preventSubmit() {
@@ -108,7 +122,7 @@ export default class SaveWorkControl {
 
   // Called when a file has been uploaded, the deposit agreement is clicked or a form field has had text entered.
   formStateChanged() {
-    this.saveButton.prop("disabled", !this.isValid());
+    this.saveButton.prop("disabled", !this.isSaveButtonEnabled);
   }
 
   // called when a new field has been added to the form.
@@ -117,6 +131,11 @@ export default class SaveWorkControl {
     this.formStateChanged();
   }
 
+  // Indicates whether the "Save" button should be enabled: a valid form and no uploads in progress
+  get isSaveButtonEnabled() {
+    return this.isValid() && !this.uploads.inProgress;
+  }
+
   isValid() {
     // avoid short circuit evaluation. The checkboxes should be independent.
     let metadataValid = this.validateMetadata()

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

@@ -4,6 +4,7 @@ export class UploadedFiles {
     this.form = form
     this.element = $('#fileupload')
     this.element.bind('fileuploadcompleted', callback)
+    this.element.bind('fileuploaddestroyed', callback)
   }
 
   get hasFileRequirement() {

data/app/assets/stylesheets/hyrax/_breadcrumbs.scss

@@ -0,0 +1,25 @@
+.breadcrumb {
+  border: 1px solid $admin-panel-border-color;
+  border-radius: 3px;
+  margin-top: 0.5em;
+  padding: 0.8em 1em;
+
+  ol {
+    list-style: none;
+    margin: 0;
+    padding-left: 0;
+  }
+
+  li {
+    display: inline;
+
+    +::before {
+      border-right: 0.1em solid #ccc;
+      content: '';
+      display: inline-block;
+      height: 0.8em;
+      margin: 0 0.5em;
+      transform: rotate(15deg);
+    }
+  }
+}

data/app/assets/stylesheets/hyrax/_collections.scss

@@ -154,12 +154,18 @@ button.branding-banner-remove:hover {
     td {
       text-align: center;
       vertical-align: top;
+      padding: 8px 2px;
 
+      &:nth-child(1),
       &:nth-child(2) {
         text-align: left;
       }
     }
 
+    .check-all-checkbox {
+      margin-right: 5px !important;
+    }
+
     .modal {
       text-align: left;
     }

data/app/assets/stylesheets/hyrax/_file-listing.scss

@@ -109,6 +109,11 @@ input#check_all {
 
 .check-all {
   white-space: nowrap;
+
+  label {
+    margin: 0;
+  }
+
   .caret {
     margin-left: 0;
   }

data/app/assets/stylesheets/hyrax/_file_upload.scss

@@ -20,3 +20,17 @@
 }
 
 .files .name span { word-break: break-all; }
+
+.add-batch-work-file-wrapper {
+  .add-batch-work-file-row {
+    padding-bottom: 10px;
+  }
+
+  .resource_type_dropdown {
+    margin-bottom: 10px;
+  }
+
+  .padding-bottom {
+    padding-bottom: 10px;
+  }
+}

data/app/assets/stylesheets/hyrax/_form-progress.scss

@@ -44,3 +44,9 @@ aside.form-progress {
     padding-right: 5px;
   }
 }
+
+.progress-bar-complete {
+  width: 100%;
+}
+
+

data/app/assets/stylesheets/hyrax/_hyrax.scss

@@ -9,7 +9,7 @@
         'hyrax/fixedsticky', 'hyrax/file_upload', 'hyrax/representative-media',
         'hyrax/footer', 'hyrax/select_work_type', 'hyrax/users', 'hyrax/dashboard',
         'hyrax/sidebar', 'hyrax/controlled_vocabulary', 'hyrax/accessibility',
-        'hyrax/recent', 'hyrax/viewer';
+        'hyrax/recent', 'hyrax/viewer', 'hyrax/breadcrumbs';
 @import 'typeahead';
 @import 'sharing_buttons';
 

data/app/assets/stylesheets/hyrax/_styles.scss

@@ -56,3 +56,9 @@ label.disabled {
   text-decoration:underline;
   background-color:#0088CC;
 }
+
+// Vertically center child elements
+.centerizer {
+  align-items: center;
+  display: flex;
+}

data/app/assets/stylesheets/hyrax/dashboard.scss

@@ -29,6 +29,10 @@ $admin-panel-border-color: #dedede !default;
   .media-body {
     width: 18vw;
   }
+
+  .works-list-batch-checkbox-label-text {
+    margin: 0 5px;
+  }
 }
 
 body.dashboard {
@@ -41,11 +45,6 @@ body.dashboard {
 }
 
 .dashboard {
-  .breadcrumb {
-    border: 1px solid $admin-panel-border-color;
-    margin-top: 0.5em;
-  }
-
   .count-display {
     font-size: 1.1em;
   }

data/app/builders/hyrax/bootstrap_breadcrumbs_builder.rb

@@ -11,16 +11,22 @@ class Hyrax::BootstrapBreadcrumbsBuilder < BreadcrumbsOnRails::Breadcrumbs::Buil
   def render
     return "" if @elements.blank?
 
-    @context.content_tag(:ul, class: 'breadcrumb') do
-      safe_join(@elements.uniq.collect { |e| render_element(e) })
+    @context.content_tag(:nav, breadcrumbs_options) do
+      @context.content_tag(:ol) do
+        safe_join(@elements.uniq.collect { |e| render_element(e) })
+      end
     end
   end
 
   def render_element(element)
-    html_class = 'active' if @context.current_page?(compute_path(element))
+    html_class = 'active' if @context.current_page?(compute_path(element)) || element.options["aria-current"] == "page"
 
     @context.content_tag(:li, class: html_class) do
-      @context.link_to_unless_current(@context.truncate(compute_name(element), length: 30, separator: ' '), compute_path(element), element.options)
+      @context.link_to_unless(html_class == 'active', @context.truncate(compute_name(element), length: 30, separator: ' '), compute_path(element), element.options)
     end
   end
+
+  def breadcrumbs_options
+    { class: 'breadcrumb', role: "region", "aria-label" => "Breadcrumb" }
+  end
 end

data/app/controllers/concerns/hyrax/admin/stats_behavior.rb

@@ -1,20 +1,44 @@
 module Hyrax
   module Admin
+    ##
+    # @example using a custom presenter and stats services
+    #   class MyStatsController < ApplicationController
+    #     include Hyrax::Admin::StatsBehavior
+    #
+    #     self.admin_stats_presenter = MyCustomStatsPresenter
+    #     self.admin_stats_services = { by_depositor:      CustomDepositorService,
+    #                                   depositor_summary: CustomSummaryService }
+    #     # see AdminStatsPresenter#initialize for supported services
+    #   end
+    #
     module StatsBehavior
       extend ActiveSupport::Concern
       included do
         with_themed_layout 'dashboard'
+
+        class_attribute :admin_stats_presenter, :admin_stats_services
+        self.admin_stats_presenter = AdminStatsPresenter
+        self.admin_stats_services  = {}
       end
 
       def show
         authorize! :read, Hyrax::Statistics
         stats_filters = params.fetch(:stats_filters, {})
         limit = params.fetch(:limit, "5").to_i
-        @presenter = AdminStatsPresenter.new(stats_filters, limit)
+        @presenter = build_presenter(stats_filters, limit)
         add_breadcrumb t(:'hyrax.controls.home'), root_path
         add_breadcrumb t(:'hyrax.dashboard.breadcrumbs.admin'), hyrax.dashboard_path
         add_breadcrumb t(:'hyrax.admin.sidebar.statistics'), hyrax.admin_stats_path
       end
+
+      private
+
+        def build_presenter(stats_filters, limit)
+          presenter_class = self.class.admin_stats_presenter
+          services_opts   = self.class.admin_stats_services
+
+          presenter_class.new(stats_filters, limit, **services_opts)
+        end
     end
   end
 end

data/app/controllers/concerns/hyrax/breadcrumbs_for_collections.rb

@@ -14,10 +14,14 @@ module Hyrax
     def add_breadcrumb_for_action
       case action_name
       when 'edit'.freeze
-        add_breadcrumb I18n.t("hyrax.collection.browse_view"), collection_path(params["id"])
+        add_breadcrumb I18n.t("hyrax.collection.browse_view"), collection_path(params["id"]), mark_active_action
       when 'show'.freeze
-        add_breadcrumb presenter.to_s, polymorphic_path(presenter)
+        add_breadcrumb presenter.to_s, polymorphic_path(presenter), mark_active_action
       end
     end
+
+    def mark_active_action
+      { "aria-current" => "page" }
+    end
   end
 end

data/app/controllers/concerns/hyrax/controller.rb

@@ -52,7 +52,7 @@ module Hyrax::Controller
       # For the JSON message, we don't want to display the default CanCan messages,
       # just custom Hydra messages such as "This item is under embargo.", etc.
       json_message = exception.message if exception.is_a? Hydra::AccessDenied
-      if current_user && current_user.persisted?
+      if current_user&.persisted?
         deny_access_for_current_user(exception, json_message)
       else
         deny_access_for_anonymous_user(exception, json_message)

data/app/controllers/concerns/hyrax/deny_access_override_behavior.rb

@@ -2,7 +2,7 @@ module Hyrax
   module DenyAccessOverrideBehavior
     # Overriding the default behavior from Hydra::Core::ControllerBehavior
     def deny_access(exception)
-      if current_user && current_user.persisted?
+      if current_user&.persisted?
         redirect_to root_path, alert: exception.message
       else
         session['user_return_to'.freeze] = request.url