hyrax 2.0.0.rc1 → 2.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a96b72971c72adabf7c92ab360d35bb5d98eb63
-  data.tar.gz: 3292d8aaf5784bcdd8e061f2446ad321e84a64f7
+  metadata.gz: 96df4577f120f0763bf3216037a0dc709b80c316
+  data.tar.gz: 953bbd05cdda6a6f180249e38d9803392552fdf2
 SHA512:
-  metadata.gz: a12c44a6f0bb8b928a40666fbe8e0f3dbdc0d7c2a84410aff8e550c65916a2644910258160cca03ca806fc4b7f5c17d0fa963fa278dbb7ac49c06ee341f19abc
-  data.tar.gz: bf7f7762658984fe13a62829dc706eeb32a070a13c57c8e8320988aa0f0e3a7fe289b12b647626e634871a2e3a7bfffb8427a4d49b3a0e894d7cac4ce5d40cde
+  metadata.gz: d82b1d0a1dbd9918594b5d1e68bef52bdbb2a1cba9ef0ccb73a7ce2dce642ce332b23dc8d3381e2a017838c91168ca49530eb9e5a6c1bb501c866617ef4dd661
+  data.tar.gz: 4518771b62f4def96f0cab00e4e562193c80cd1898fdcea4b2133a862b10ae2753320c06ae367d960d9c1c1c75757d03cd840e5602b80cf33ead75c491c9a359

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.0.0.rc1__. If you are looking for instructions on installing a different
+v2.0.0.rc2__. 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.
 
@@ -160,7 +160,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.0.0.rc1/template.rb
+rails _5.0.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.0.0.rc2/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/create_with_remote_files_actor.rb

@@ -1,6 +1,10 @@
 module Hyrax
   module Actors
-    # Attaches remote files to the work
+    # If there is a key `:remote_files' in the attributes, it attaches the files at the specified URIs
+    # to the work. e.g.:
+    #     attributes[:remote_files] = filenames.map do |name|
+    #       { url: "https://example.com/file/#{name}", file_name: name }
+    #     end
     class CreateWithRemoteFilesActor < Hyrax::Actors::AbstractActor
       # @param [Hyrax::Actors::Environment] env
       # @return [Boolean] true if create was successful

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

@@ -20,3 +20,9 @@
 .nav > li > .notify-number {
   padding-right: 0;
 }
+
+.dropdown-toggle:focus {
+  outline: 2px auto  Highlight; // FireFox
+  outline: 5px auto -webkit-focus-ring-color; // Chrome, Safari
+  outline: -2px;
+}

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

@@ -6,13 +6,13 @@ module Hyrax
 
     included do
       layout :decide_layout
-
       copy_blacklight_config_from(::CatalogController)
 
       class_attribute :_curation_concern_type, :show_presenter, :work_form_service, :search_builder_class
       self.show_presenter = Hyrax::WorkShowPresenter
       self.work_form_service = Hyrax::WorkFormService
       self.search_builder_class = WorkSearchBuilder
+      self.theme = 'hyrax/1_column'
       attr_accessor :curation_concern
       helper_method :curation_concern, :contextual_path
 

data/app/controllers/hyrax/admin/permission_template_accesses_controller.rb

@@ -6,7 +6,7 @@ module Hyrax
       def destroy
         ActiveRecord::Base.transaction do
           @permission_template_access.destroy
-          update_management if @permission_template_access.manage?
+          remove_access!
         end
 
         if @permission_template_access.destroyed?
@@ -28,8 +28,9 @@ module Hyrax
           @admin_set_id ||= @permission_template_access.permission_template.admin_set_id
         end
 
-        def update_management
-          Forms::PermissionTemplateForm.new(@permission_template_access.permission_template).update_management
+        def remove_access!
+          Forms::PermissionTemplateForm.new(@permission_template_access.permission_template)
+                                       .remove_access!(@permission_template_access)
         end
     end
   end

data/app/controllers/hyrax/collections_controller.rb

@@ -5,6 +5,8 @@ module Hyrax
     layout :decide_layout
     load_and_authorize_resource except: [:index, :show, :create], instance_name: :collection
 
+    self.theme = 'hyrax/1_column'
+
     # Renders a JSON response with a list of files in this collection
     # This is used by the edit form to populate the thumbnail_id dropdown
     def files

data/app/forms/hyrax/forms/permission_template_form.rb

@@ -20,6 +20,9 @@ module Hyrax
       # Stores the selected
       attr_writer :workflow_id
 
+      # Adding attributes hash to state to avoid having to pass it around
+      attr_accessor :attributes
+
       def workflow_id
         @workflow_id || active_workflow.try(:id)
       end
@@ -41,54 +44,114 @@ module Hyrax
       # @return [Hash{Symbol => String, Boolean}] { :content_tab (for confirmation message),
       #                                             :updated (true/false),
       #                                               :error_code (for flash error lookup) }
+      # rubocop:disable Metrics/MethodLength
       def update(attributes)
-        return_info = { content_tab: tab_to_update(attributes) }
+        @attributes = attributes
+        return_info = { content_tab: tab_to_update }
         error_code = nil
         case return_info[:content_tab]
         when "participants"
-          update_participants_options(attributes)
+          update_participants_options
         when "visibility"
-          error_code = update_visibility_options(attributes)
+          error_code = update_visibility_options
         when "workflow"
-          grant_workflow_roles(attributes)
+          grant_workflow_roles
         end
         return_info[:error_code] = error_code if error_code
         return_info[:updated] = error_code ? false : true
         return_info
       end
+      # rubocop:enable Metrics/MethodLength
 
-      # If management roles have been granted or removed, then copy this access
-      # to the edit permissions of the AdminSet and to the WorkflowResponsibilities
-      # of the active workflow
       def update_management
         admin_set.update_access_controls!
-        update_workflow_approving_responsibilities
+        update_workflow_responsibilities
+      end
+
+      # This method is used to revoke access to an Admin Set and its workflows
+      #
+      # @return [Void]
+      def remove_access!(permission_template_access)
+        construct_attributes_from_template_access!(permission_template_access)
+        admin_set.update_access_controls!
+        update_workflow_responsibilities(remove_agent: true)
       end
 
       private
 
         # @return [String]
-        def tab_to_update(attributes)
+        def tab_to_update
           return "participants" if attributes[:access_grants_attributes].present?
           return "workflow" if attributes[:workflow_id].present?
           return "visibility" if attributes.key?(:visibility)
         end
 
+        # This method is used to build the attributes that this class
+        # relies on using the passed-in PermissionTemplateAccess
+        # instance. This allows the class to use the same methods for
+        # granting access (when a new Admin Set manager is added, for
+        # instance), when called via #update, for revoking access as
+        # well when called via #remove_access!
+        #
         # @return [Void]
-        def update_participants_options(attributes)
-          update_permission_template(attributes)
-          # if managers were added, recalculate update the access controls on the AdminSet
-          return unless managers_updated?(attributes)
-          update_management
+        def construct_attributes_from_template_access!(permission_template_access)
+          @attributes = {
+            access_grants_attributes: {
+              "0" => {
+                access: permission_template_access.access,
+                agent_type: permission_template_access.agent_type,
+                agent_id: permission_template_access.agent_id
+              }
+            }
+          }
+        end
+
+        # @return [Void]
+        def update_participants_options
+          update_permission_template
+          update_workflow_responsibilities
+          # if managers were added or removed, recalculate update the access controls on the AdminSet
+          admin_set.update_access_controls! if managers_updated?
+        end
+
+        # Grant appropriate workflow roles based on access specified
+        def update_workflow_responsibilities(remove_agent: false)
+          return unless available_workflows
+          roles = roles_for_agent
+          return if roles.none?
+          agents = remove_agent ? manager_agents - agents_from_attributes : manager_agents + agents_from_attributes
+          available_workflows.each do |workflow|
+            roles.each do |role|
+              workflow.update_responsibilities(role: role, agents: agents)
+            end
+          end
+        end
+
+        def roles_for_agent
+          roles = []
+          grants_as_collection.each do |grant|
+            case grant[:access]
+            when Hyrax::PermissionTemplateAccess::DEPOSIT
+              roles << Sipity::Role.find_by(name: Hyrax::RoleRegistry::DEPOSITING)
+            when Hyrax::PermissionTemplateAccess::MANAGE
+              roles += Sipity::Role.where(name: Hyrax::RoleRegistry.new.role_names)
+              # TODO: Figure out what to do here
+              # when Hyrax::PermissionTemplateAccess::VIEW
+            end
+          end
+          roles.uniq
         end
 
-        # Grant workflow approve roles for any admin set managers
-        # and revoke the approving role for non-managers
-        def update_workflow_approving_responsibilities
-          return unless active_workflow
-          approving_role = Sipity::Role.find_by_name('approving')
-          return unless approving_role
-          active_workflow.update_responsibilities(role: approving_role, agents: manager_agents)
+        # @return [Array<Sipity::Agent>] a list sipity agents extracted from attrs
+        def agents_from_attributes
+          grants_as_collection.map do |grant|
+            agent = if grant[:agent_type] == 'user'
+                      ::User.find_by_user_key(grant[:agent_id])
+                    else
+                      Hyrax::Group.new(grant[:agent_id])
+                    end
+            PowerConverter.convert_to_sipity_agent(agent)
+          end
         end
 
         # @return [Array<Sipity::Agent>] a list of sipity agents corresponding to the manager role of the permission_template
@@ -107,17 +170,17 @@ module Hyrax
 
         # @return [Array<PermissionTemplateAccess>] a list of grants corresponding to the manager role of the permission_template
         def manager_grants
-          model.access_grants.where(access: 'manage'.freeze)
+          model.access_grants.where(access: Hyrax::PermissionTemplateAccess::MANAGE)
         end
 
         # @return [String, Nil] error_code if validation fails, nil otherwise
-        def update_visibility_options(attributes)
-          error_code = validate_visibility_combinations(attributes)
+        def update_visibility_options
+          error_code = validate_visibility_combinations
           return error_code if error_code
-          update_permission_template(attributes)
+          update_permission_template
         end
 
-        def activate_workflow_from(attributes)
+        def activate_workflow_from_attributes
           new_active_workflow_id = attributes[:workflow_id] || attributes['workflow_id']
           if active_workflow
             return active_workflow if new_active_workflow_id.to_s == active_workflow.id.to_s
@@ -131,28 +194,29 @@ module Hyrax
         # have all the roles for the new workflow
         # @return [Void]
         # @todo Instead of granting the manage users all of the roles (which means lots of emails), can we agree on a Managing role that all workflows should have?
-        def grant_workflow_roles(attributes)
-          new_active_workflow = activate_workflow_from(attributes)
+        def grant_workflow_roles
+          new_active_workflow = activate_workflow_from_attributes
           return unless new_active_workflow
           manager_agents.each do |agent|
-            active_workflow.workflow_roles.each do |role|
-              Sipity::WorkflowResponsibility.find_or_create_by!(workflow_role: role, agent: agent)
+            active_workflow.workflow_roles.each do |workflow_role|
+              new_workflow_role = Sipity::WorkflowRole.find_or_create_by!(workflow: new_active_workflow, role: workflow_role.role)
+              Sipity::WorkflowResponsibility.find_or_create_by!(workflow_role: new_workflow_role, agent: agent)
             end
           end
         end
 
         # @return [Nil]
-        def update_permission_template(attributes)
-          model.update(permission_template_update_params(attributes))
+        def update_permission_template
+          model.update(permission_template_update_params)
           nil
         end
 
-        def managers_updated?(attributes)
-          grants_as_collection(attributes).any? { |x| x[:access] == 'manage' }
+        def managers_updated?
+          grants_as_collection.any? { |x| x[:access] == Hyrax::PermissionTemplateAccess::MANAGE }
         end
 
         # This allows the attributes
-        def grants_as_collection(attributes)
+        def grants_as_collection
           return [] unless attributes[:access_grants_attributes]
           attributes_collection = attributes[:access_grants_attributes]
           if attributes_collection.respond_to?(:permitted?)
@@ -188,36 +252,36 @@ module Hyrax
         # @return [Hash] attributes used to update the model
         # rubocop:disable Metrics/CyclomaticComplexity
         # rubocop:disable Metrics/PerceivedComplexity
-        def permission_template_update_params(raw_attributes)
-          attributes = raw_attributes.except(:release_varies, :release_embargo)
+        def permission_template_update_params
+          filtered_attributes = attributes.except(:release_varies, :release_embargo)
           # If 'varies' before date option selected, then set release_period='before' and save release_date as-is
-          if raw_attributes[:release_varies] == Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_BEFORE_DATE
-            attributes[:release_period] = Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_BEFORE_DATE
+          if attributes[:release_varies] == Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_BEFORE_DATE
+            filtered_attributes[:release_period] = Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_BEFORE_DATE
           # Else if 'varies' + embargo selected, save embargo as the release_period
-          elsif raw_attributes[:release_varies] == Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_EMBARGO &&
-                raw_attributes[:release_embargo]
-            attributes[:release_period] = raw_attributes[:release_embargo]
+          elsif attributes[:release_varies] == Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_EMBARGO &&
+                attributes[:release_embargo]
+            filtered_attributes[:release_period] = attributes[:release_embargo]
             # In an embargo, the release_date should be unspecified as it is based on deposit date
-            attributes[:release_date] = nil
+            filtered_attributes[:release_date] = nil
           end
 
-          if attributes[:release_period] == Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_NO_DELAY || (attributes[:release_period].blank? && raw_attributes[:release_varies].blank?)
+          if filtered_attributes[:release_period] == Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_NO_DELAY || (filtered_attributes[:release_period].blank? && attributes[:release_varies].blank?)
             # If release is "no delay" or is "varies" and "allow depositor to decide",
             # then a release_date should never be allowed/specified
-            attributes[:release_date] = nil
+            filtered_attributes[:release_date] = nil
           end
 
-          attributes
+          filtered_attributes
         end
         # rubocop:enable Metrics/CyclomaticComplexity
         # rubocop:enable Metrics/PerceivedComplexity
 
         # validate the hash of attributes used to update the visibility tab of the model
-        # @param [Hash] attributes
         # @return [String, Nil] the error code if invalid, nil if valid
         # rubocop:disable Metrics/CyclomaticComplexity
         # rubocop:disable Metrics/PerceivedComplexity
-        def validate_visibility_combinations(attributes)
+        # rubocop:disable Metrics/AbcSize
+        def validate_visibility_combinations
           return unless attributes.key?(:visibility) # only the visibility tab has validations
 
           # if "save" without any selections - none of the attributes are present
@@ -234,6 +298,7 @@ module Hyrax
         end
       # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/PerceivedComplexity
+      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/app/jobs/ingest_local_file_job.rb

@@ -10,7 +10,6 @@ class IngestLocalFileJob < Hyrax::ApplicationJob
     actor = Hyrax::Actors::FileSetActor.new(file_set, user)
 
     if actor.create_content(File.open(path))
-      FileUtils.rm(path)
       Hyrax.config.callback.run(:after_import_local_file_success, file_set, user, path)
     else
       Hyrax.config.callback.run(:after_import_local_file_failure, file_set, user, path)

data/app/renderers/hyrax/renderers/rights_statement_attribute_renderer.rb

@@ -0,0 +1,25 @@
+module Hyrax
+  module Renderers
+    # This is used by PresentsAttributes to show licenses
+    #   e.g.: presenter.attribute_to_html(:rights_statement, render_as: :rights_statement)
+    class RightsStatementAttributeRenderer < AttributeRenderer
+      private
+
+        ##
+        # Special treatment for license/rights.  A URL from the Hyrax gem's config/hyrax.rb is stored in the descMetadata of the
+        # curation_concern.  If that URL is valid in form, then it is used as a link.  If it is not valid, it is used as plain text.
+        def attribute_value_to_html(value)
+          begin
+            parsed_uri = URI.parse(value)
+          rescue
+            nil
+          end
+          if parsed_uri.nil?
+            ERB::Util.h(value)
+          else
+            %(<a href=#{ERB::Util.h(value)} target="_blank">#{Hyrax.config.rights_statement_service_class.new.label(value)}</a>)
+          end
+        end
+    end
+  end
+end

data/app/search_builders/hyrax/deposit_search_builder.rb

@@ -12,9 +12,6 @@ module Hyrax
       # the number of users in the database
       solr_parameters[:"facet.limit"] = ::User.count
 
-      # only get work information
-      solr_parameters[:fq] = Hyrax::WorkRelation.new.search_model_clause
-
       # we only want the facte counts not the actual data
       solr_parameters[:rows] = 0
     end
@@ -22,5 +19,11 @@ module Hyrax
     def self.depositor_field
       @depositor_field ||= Solrizer.solr_name('depositor', :symbol).freeze
     end
+
+    private
+
+      def only_works?
+        true
+      end
   end
 end

data/app/search_builders/hyrax/stats/work_status_search_builder.rb

@@ -1,7 +1,8 @@
 module Hyrax
   module Stats
     class WorkStatusSearchBuilder < ::SearchBuilder
-      self.default_processor_chain = [:include_suppressed_facet]
+      self.default_processor_chain = [:include_suppressed_facet, :filter_models]
+
       # includes the suppressed facet to get information on deposits.
       # use caution when combining this with other searches as it sets the rows to
       # zero to just get the facet information
@@ -9,8 +10,6 @@ module Hyrax
       def include_suppressed_facet(solr_parameters)
         solr_parameters[:"facet.field"].concat([IndexesWorkflow.suppressed_field])
         solr_parameters[:'facet.missing'] = true
-        # only get work information
-        solr_parameters[:fq] = work_relation.search_model_clause
 
         # we only want the facet counts not the actual data
         solr_parameters[:rows] = 0
@@ -18,8 +17,8 @@ module Hyrax
 
       private
 
-        def work_relation
-          Hyrax::WorkRelation.new
+        def only_works?
+          true
         end
     end
   end