hyrax 3.0.0.pre.rc3 → 3.0.0.pre.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80d651ec9f588b25d242b2b6dcb5c1a98695b3eb9f8bb1f4706a9664a4ce6dbd
-  data.tar.gz: a145d9fdce4f1577c02b4a521b11b64a91d0dff6f20f9b63b4a663942410e346
+  metadata.gz: 684ca77fe907962abffc140cd9b96081584650df75282c35e0ccd6fc041473ca
+  data.tar.gz: 661b6c451fa1fbd7f25d91ab56331e88827a4f3e88fddb85bbcb1623a7d9f068
 SHA512:
-  metadata.gz: 6d4ca532232ec1d92221da0dbb738a4d081c5ad94dd316f9b878fb3461909a1a6dbbe9520fab6ea11f3a84b55bef41160b3797a7d2318b505163d51c899885eb
-  data.tar.gz: dc49090b11ff8a4c1c6c57ba97c912d3ae28dd22c3d838154eac4dc76ca20f87fffda64d94f92846342c814bc12fd2bf5fa4ae1265b6243f1bfaacc37899ac71
+  metadata.gz: 2f884204185783729a1d7a8d00dfa41c27e592097749f773418cdecf033aff2804e853ccefadf48d7d0c7c18da7576d3d1fa30aba05a58e687814f6d337b8c7c
+  data.tar.gz: ae5b51cbb3949d03967a5d4aa1650aaf77c8776d799df5456db09ff4b615ed8665699277f092e50267277afb654ca09e75200863f02f91c92b0f8f08465c0a60

data/.dassie/config/locales/hyrax.es.yml

@@ -19,6 +19,7 @@ es:
           date_created_tesim: Fecha de Creacion
           date_modified_dtsi: Fecha Modificada
           date_uploaded_dtsi: Fecha de Subida
+          depositor_tesim: Propietario
           description_tesim: Descripción
           file_format_tesim: Formato de Archivo
           identifier_tesim: Identificador
@@ -35,6 +36,7 @@ es:
           date_created_tesim: Fecha de Creacion
           date_modified_dtsi: Fecha Modificada
           date_uploaded_dtsi: Fecha de Subida
+          depositor_tesim: Propietario
           description_tesim: Descripción
           file_format_tesim: Formato de Archivo
           identifier_tesim: Identificador
@@ -51,7 +53,7 @@ es:
       suffix: "@example.org"
     footer:
       copyright_html: "<strong>Copyright &copy; 2018 Samvera</strong> bajo licencia de Apache, Version 2.0"
-      service_html: Un servicio de <a href="http://samvera.org/" class="navbar-link" target="_blank">Samvera/a>.
+      service_html: Un servicio de <a href="http://samvera.org/" class="navbar-link" target="_blank">Samvera</a>.
     institution_name: institución
     institution_name_full: El nombre de la institución
     product_name: Hyrax

data/.dassie/config/tinymce.yml

@@ -3,10 +3,11 @@ default: &default
 content_block:
   <<: *default
   menubar: false
-  toolbar1: styleselect | bold italic | link image | undo redo
-  toolbar2: table | fullscreen | uploadimage
+  toolbar1: styleselect | bold italic | undo redo
+  toolbar2: table | fullscreen | image
   plugins:
     - table
     - fullscreen
+    - image
 custom:
   <<: *default

data/.regen

@@ -1 +1 @@
-35idx
+36

data/CONTAINERS.md

@@ -42,6 +42,8 @@ To stop the containers for the Hyrax-based application, type <kbd>Ctrl</kbd>+<kb
 
 _**Note:** Starting and stopping Docker in this way will preserve your data between restarts._
 
+_**Note:** I (Jeremy) encountered a problem using `docker-compose build`. I ran `bundle update` in `./hyrax` as well as within `./hyrax/.dassie`. That appeared to clear up the problem of a failure to build a gem._
+
 ### Code Changes and Testing
 
 With `docker-compose up` running, any changes you make to your cloned Hyrax code-base should show up in `http://localhost:3000`; There may be cases where you need to restart your test application (e.g. stop the containers and start them up again).
@@ -95,6 +97,16 @@ docker-compose exec -w /app/samvera/hyrax-engine app sh -c "bundle exec rake -T"
 
 In the two examples, note the difference in the `-w` switch. In the first case, it's referencing the Hyrax-based application. In the latter case, it's referencing the Hyrax engine.
 
+### Debugging
+
+I (Jeremy) find myself wanting to debug the application.  This requires a somewhat different approach than running Hyrax bare-metal.  You need to use `docker attach` to debug the running docker instance.
+
+1. With `docker-compose up` running open a new Terminal session.
+2. In that new Terminal session, using `docker container ls` find the "CONTAINER ID" for the `hyrax-engine-dev`.
+3. With the "CONTAINER ID", run `docker attach <CONTAINER ID>`.
+
+This advice comes from [Debugging Rails App With Docker Compose: How to use Byebug in a dockerized rails app](https://medium.com/gogox-technology/debugging-rails-app-with-docker-compose-39a3767962f4).
+
 <!-- NOTE: This title is referenced in the top-level documentation/developing-your-hyrax-based-app.md. Keep that in mind if you change it. -->
 ## Docker Image for Hyrax-based Applications
 

data/Dockerfile

@@ -1,5 +1,6 @@
 ARG RUBY_VERSION=2.7.2
-FROM ruby:$RUBY_VERSION-alpine as hyrax-base
+# lock at alpine3.12 because 3.13 has dns resolver problems
+FROM ruby:$RUBY_VERSION-alpine3.12 as hyrax-base
 
 ARG DATABASE_APK_PACKAGE="postgresql-dev"
 ARG EXTRA_APK_PACKAGES="git"
@@ -50,8 +51,8 @@ ENV HYRAX_ENGINE_PATH /app/samvera/hyrax-engine
 COPY --chown=1001:101 $APP_PATH /app/samvera/hyrax-webapp
 COPY --chown=1001:101 . /app/samvera/hyrax-engine
 
-RUN cd /app/samvera/hyrax-engine; bundle install --jobs "$(nproc)"
-RUN DB_ADAPTER=nulldb DATABASE_URL='postgresql://fake' bundle exec rake assets:precompile
+RUN cd /app/samvera/hyrax-engine && bundle install --jobs "$(nproc)"
+RUN DB_ADAPTER=nulldb DATABASE_URL='postgresql://fake' bundle exec rake yarn:install
 
 
 FROM hyrax-engine-dev as hyrax-engine-dev-worker
@@ -65,11 +66,12 @@ RUN apk --no-cache add bash \
   mediainfo
 USER app
 
-RUN wget http://projects.iq.harvard.edu/files/fits/files/fits-1.0.5.zip -O fits.zip \
-    && unzip fits.zip -d /app \
-    && rm fits.zip \
-    && mv /app/fits-1.0.5 /app/fits \
-    && chmod a+x /app/fits/fits.sh
+RUN mkdir -p /app/fits && \
+    cd /app/fits && \
+    wget https://github.com/harvard-lts/fits/releases/download/1.5.0/fits-1.5.0.zip -O fits.zip && \
+    unzip fits.zip && \
+    rm fits.zip && \
+    chmod a+x /app/fits/fits.sh
 ENV PATH="${PATH}:/app/fits"
 
 CMD bundle exec sidekiq

data/README.md

@@ -17,6 +17,7 @@ Jump in: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samv
 
 * [What is Hyrax?](#what-is-hyrax)
 * [Feature Documentation](#feature-documentation)
+* [Support Policies](#support-policies)
 * [Help](#help)
 * [Working with Hyrax](#working-with-hyrax)
   * [Developing the Hyrax Engine](#developing-the-hyrax-engine)
@@ -52,6 +53,10 @@ Hyrax offers the ability to:
 * For general information about Hyrax: [Hyrax Site](https://hyrax.samvera.org/)
 * A note about [versions of Hyrax](./documentation/note-about-versions.md)
 
+## Support Policies
+
+* Hyrax 3.x supports the latest browser versions for Chrome, Firefox, Edge, and Safari.
+
 ## Help
 
 The Samvera community is here to help. Please see our [support guide](./.github/SUPPORT.md).

data/app/assets/javascripts/hyrax.js

@@ -30,6 +30,7 @@
 //= require morris/morris.min
 
 //= require clipboard
+//= require tinymce
 
 // This is required for Jasmine tests, specifically to polyfill the Symbol() function
 //= require babel/polyfill

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

@@ -18,22 +18,12 @@ Hyrax = {
         this.collectionTypeEditor();
         this.collectionUtilities();
         this.adminStatisticsGraphs();
-        this.tinyMCE();
         this.sortAndPerPage();
         this.sidebar();
         this.batchSelect();
         this.internationalizationHelper();
     },
 
-    // Add WYSIWYG editor functionality to editable content blocks
-    tinyMCE: function() {
-        if (typeof tinyMCE === "undefined")
-            return;
-        tinyMCE.init({
-            selector: 'textarea.tinymce'
-        });
-    },
-
     // The AdminSet edit page
     adminSetEditor: function() {
       var AdminSetControls = require('hyrax/admin/admin_set_controls');

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

@@ -37,6 +37,7 @@
     .search-result-title {
       display: inline-block;
       margin: 0 15px;
+      font-size: 18px;
     }
 
     @media (max-width: 768px) {

data/app/assets/stylesheets/hyrax/_representative-media.scss

@@ -1,11 +1,11 @@
 .representative-media {
   display: block;
   padding: 0.5em 0;
-  width: 250px;
+  width: 100%;
 }
 
 .canonical-image {
   display: block;
   padding: 0.5em 0;
-  width: 250px;
+  width: 100%;
 }

data/app/controllers/hyrax/file_sets_controller.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 module Hyrax
   class FileSetsController < ApplicationController
+    rescue_from WorkflowAuthorizationException, with: :render_unavailable
+
     include Blacklight::Base
     include Blacklight::AccessControls::Catalog
     include Hyrax::Breadcrumbs
@@ -42,9 +44,11 @@ module Hyrax
 
     # GET /concern/parent/:parent_id/file_sets/:id
     def show
+      presenter
+      guard_for_workflow_restriction_on!(parent: presenter.parent)
       respond_to do |wants|
-        wants.html { presenter }
-        wants.json { presenter }
+        wants.html
+        wants.json
         additional_response_formats(wants)
       end
     end
@@ -52,12 +56,15 @@ module Hyrax
     # DELETE /concern/file_sets/:id
     def destroy
       parent = curation_concern.parent
+      guard_for_workflow_restriction_on!(parent: parent)
       actor.destroy
       redirect_to [main_app, parent], notice: view_context.t('hyrax.file_sets.asset_deleted_flash.message')
     end
 
     # PATCH /concern/file_sets/:id
     def update
+      parent = curation_concern.parent
+      guard_for_workflow_restriction_on!(parent: parent)
       if attempt_update
         after_update_response
       else
@@ -146,11 +153,23 @@ module Hyrax
 
     def initialize_edit_form
       @parent = @file_set.in_objects.first
+      guard_for_workflow_restriction_on!(parent: @parent)
       original = @file_set.original_file
       @version_list = Hyrax::VersionListPresenter.new(original ? original.versions.all : [])
       @groups = current_user.groups
     end
 
+    include WorkflowsHelper # Provides #workflow_restriction?, and yes I mean include not helper; helper exposes the module methods
+    # @param parent [Hyrax::WorkShowPresenter, GenericWork, #suppressed?] an
+    #        object on which we check if the current can take action.
+    #
+    # @return true if we did not encounter any workflow restrictions
+    # @raise WorkflowAuthorizationException if we encountered some workflow_restriction
+    def guard_for_workflow_restriction_on!(parent:)
+      return true unless workflow_restriction?(parent, ability: current_ability)
+      raise WorkflowAuthorizationException
+    end
+
     def actor
       @actor ||= Hyrax::Actors::FileSetActor.new(@file_set, current_user)
     end
@@ -161,8 +180,10 @@ module Hyrax
 
     def presenter
       @presenter ||= begin
-        show_presenter.new(curation_concern_document, current_ability, request)
-      end
+                       presenter = show_presenter.new(curation_concern_document, current_ability, request)
+                       raise WorkflowAuthorizationException if presenter.parent.blank?
+                       presenter
+                     end
     end
 
     def curation_concern_document
@@ -200,5 +221,35 @@ module Hyrax
                end
       File.join(theme, layout)
     end
+
+    # rubocop:disable Metrics/MethodLength
+    def render_unavailable
+      message = I18n.t("hyrax.workflow.unauthorized_parent")
+      respond_to do |wants|
+        wants.html do
+          unavailable_presenter
+          flash[:notice] = message
+          render 'unavailable', status: :unauthorized
+        end
+        wants.json do
+          render plain: message, status: :unauthorized
+        end
+        additional_response_formats(wants)
+        wants.ttl do
+          render plain: message, status: :unauthorized
+        end
+        wants.jsonld do
+          render plain: message, status: :unauthorized
+        end
+        wants.nt do
+          render plain: message, status: :unauthorized
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def unavailable_presenter
+      @presenter ||= show_presenter.new(::SolrDocument.find(params[:id]), current_ability, request)
+    end
   end
 end

data/app/controllers/hyrax/my_controller.rb

@@ -53,7 +53,7 @@ module Hyrax
     # TODO: Extract a presenter object that wrangles all of these instance variables.
     def prepare_instance_variables_for_batch_control_display
       # set up some parameters for allowing the batch controls to show appropriately
-      max_batch_size = 80
+      max_batch_size = Hyrax.config.range_for_number_of_results_to_display_per_page.max
       count_on_page = @document_list.count { |doc| batch.index(doc.id) }
       @disable_select_all = @document_list.count > max_batch_size
       @result_set_size = @response.response["numFound"]

data/app/forms/hyrax/forms/file_manager_form.rb

@@ -6,10 +6,17 @@ module Hyrax
       self.terms = []
       delegate :id, :thumbnail_id, :representative_id, :to_s, to: :model
       attr_reader :current_ability, :request
-      def initialize(work, ability)
+
+      ##
+      # @param work [Object] a work with members
+      # @param ability [::Ability] the current ability
+      # @param member_factory [Class] the member_presenter factory object to use
+      #   when constructing presenters
+      def initialize(work, ability, member_factory: MemberPresenterFactory)
         super(work)
         @current_ability = ability
         @request = nil
+        @member_factory = member_factory
       end
 
       def version
@@ -21,7 +28,7 @@ module Hyrax
       private
 
       def member_presenter_factory
-        MemberPresenterFactory.new(model, current_ability)
+        @member_factory.new(model, current_ability)
       end
     end
   end

data/app/helpers/hyrax/ability_helper.rb

@@ -36,7 +36,8 @@ module Hyrax
         visibility_badge(document.visibility),
         path,
         id: "permission_#{document.id}",
-        class: 'visibility-link'
+        class: 'visibility-link',
+        title: "#{t('hyrax.works.form.tab.share')}: #{document.title_or_label}"
       )
     end
 

data/app/helpers/hyrax/contact_form_helper.rb

@@ -17,8 +17,7 @@ module Hyrax
     #
     # @see https://apidock.com/rails/ActionView/Helpers/FormOptionsHelper/options_for_select
     def contact_form_issue_type_options
-      types = Hyrax::ContactForm.issue_types_for_locale.dup
-      types.unshift([t('hyrax.contact_form.select_type'), nil])
+      Hyrax::ContactForm.issue_types_for_locale.dup
     end
   end
 end

data/app/helpers/hyrax/hyrax_helper_behavior.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 # frozen_string_literal: true
 module Hyrax
   module HyraxHelperBehavior
@@ -17,6 +18,7 @@ module Hyrax
     include Hyrax::MembershipHelper
     include Hyrax::PermissionLevelsHelper
     include Hyrax::WorkFormHelper
+    include Hyrax::WorkflowsHelper
 
     # Which translations are available for the user to select
     # @return [Hash{String => String}] locale abbreviations as keys and flags as values
@@ -192,6 +194,7 @@ module Hyrax
     # *Sometimes* a Blacklight index field helper_method
     # @param [String,User,Hash{Symbol=>Array}] args if a hash, the user_key must be under :value
     # @return [ActiveSupport::SafeBuffer] the html_safe link
+    # rubocop:disable Metrics/CyclomaticComplexity
     def link_to_profile(args)
       user_or_key = args.is_a?(Hash) ? args[:value].first : args
       user = case user_or_key
@@ -202,8 +205,20 @@ module Hyrax
              end
       return user_or_key if user.nil?
       text = user.respond_to?(:name) ? user.name : user_or_key
-      link_to text, Hyrax::Engine.routes.url_helpers.user_path(user)
+      user_path_params = [user]
+
+      # Oh the antics, because in some cases (stares at
+      # jobs/content_deposit_event_job_spec.rb) the controller is nil,
+      # which means calling params will raise a NoMethodError.  I also
+      # suppose it's possible that the controller won't have a set
+      # params. These precautions should help with that.  I'd love to
+      # use params[:locale] in this case, but the & try syntax doesn't
+      # work with that.  So you get this lovely bit of logic.
+      locale = controller&.params&.fetch(:locale, nil) || controller&.params&.fetch('locale', nil)
+      user_path_params << { locale: locale } if locale
+      link_to text, Hyrax::Engine.routes.url_helpers.user_path(*user_path_params)
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     # A Blacklight index field helper_method
     # @param [Hash] options from blacklight helper_method invocation. Maps license URIs to links with labels.

data/app/helpers/hyrax/workflows_helper.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+module Hyrax
+  module WorkflowsHelper
+    # Does a workflow restriction exist for the given :object and
+    # given :ability?
+    #
+    # @note If the object responds to a :workflow_restriction?, we'll
+    #       use that answer.
+    #
+    # This method doesn't answer what kind of restriction is in place
+    # (that requires a far more nuanced permissioning system than
+    # Hyrax presently has).  Instead, it answers is there one in
+    # place.  From that answer, you may opt out of rendering a region
+    # on a view (e.g. don't show links to the edit page).
+    #
+    # @param object [Object]
+    # @param ability [Ability]
+    #
+    # @return [false] when there are no applicable workflow restrictions
+    #
+    # @return [true] when there is an applicable workflow restriction,
+    #         and you likely want to not render something.
+    #
+    # @note This is Jeremy, I encourage you to look at the views that
+    #       call this method to understand the conceptual space this
+    #       method covers.
+    #
+    # @todo As I noodle on this, I'm fairly certain we should be
+    #       registering a CanCan ability check.  I believe in
+    #       promoting this to a helper method it will be easier to
+    #       incorporate this into an ability.
+    #
+    # @see Hyrax::FileSetsController for non-view usage.
+    def workflow_restriction?(object, ability: current_ability)
+      return false if object.nil? # Yup, we may get nil, and there's no restriction on nil
+      return object.workflow_restriction? if object.respond_to?(:workflow_restriction?)
+      return false if ability.can?(:edit, object)
+      return object.suppressed? if object.respond_to?(:suppressed?)
+      false
+    end
+  end
+end