hyrax 1.0.0.rc1 → 1.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a838f94e767ce2bce589e28136f4e2d47cddad7c
-  data.tar.gz: a08c3e0312fc897291fc88e869c32c3fcac169de
+  metadata.gz: 99e1fa3e513ad51bdf68404a23597596504fe7bf
+  data.tar.gz: 79efe8dbd4eca246b5b6252f19390dbd86a9dba7
 SHA512:
-  metadata.gz: da822bb260c799a46b44b848ba74a94add9778f95d58cc41f5869e65617f7d52678d4583db2aa481f9259d76139e6eaa297838a72f4fc447afa250188165c2cc
-  data.tar.gz: '02968f3e798d6396b35d54eaddc3a0e009743ea48c2ea092a2491ef8d08951a26c68699f84c74105b25f4e6c2b995ee20bb0fb4b6fa115ccf3b80e3289fcecae'
+  metadata.gz: 363166554478d540eb6afc4c2b5179fc81ce18307c7c88874d11c0f0b9510845bc5e322ab6824dc9c5023b2360d311fbc4437c0d3a1daa559dc32b7119605e1a
+  data.tar.gz: 05c71ebf86f994a796c24833b4d231e31cb2ba1d4d5d91be5e1eeb596c1226e3575fbf31389677f22f5d94be1e210ae941c7a330734c94333bbf5255ad3a2bb5

data/.rubocop.yml

@@ -128,3 +128,6 @@ RSpec/NestedGroups:
 
 RSpec/LeadingSubject:
   Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 sudo: false
+dist: trusty
 
 cache:
   bundler: true

data/README.md

@@ -59,7 +59,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 __Hyrax
-v1.0.0.alpha__. If you are looking for instructions on installing a different
+v1.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,6 +160,12 @@ or
 rails generate hyrax:work MovingImage
 ```
 
+Namespaces can be included in the work My::MovingImage by adding the path.
+
+```
+rails generate hyrax:work My/MovingImage
+```
+
 You may wish to [customize your work type](https://github.com/projecthydra/sufia/wiki/Customizing-your-work-types) now that it's been generated.
 
 ## Start servers

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

@@ -3,7 +3,6 @@ module Hyrax
     # Actions are decoupled from controller logic so that they may be called from a controller or a background job.
     class FileSetActor
       include Lockable
-
       attr_reader :file_set, :user, :attributes
 
       def initialize(file_set, user)
@@ -12,21 +11,17 @@ module Hyrax
       end
 
       # Adds the appropriate metadata, visibility and relationships to file_set
-      #
-      # *Note*: In past versions of Hyrax this method did not perform a save because it is mainly used in conjunction with
-      # create_content, which also performs a save.  However, due to the relationship between Hydra::PCDM objects,
-      # we have to save both the parent work and the file_set in order to record the "metadata" relationship
-      # between them.
+      # @note In past versions of Hyrax this method did not perform a save because it is mainly used in conjunction with
+      #   create_content, which also performs a save.  However, due to the relationship between Hydra::PCDM objects,
+      #   we have to save both the parent work and the file_set in order to record the "metadata" relationship between them.
       # @param [Hash] file_set_params specifying the visibility, lease and/or embargo of the file set.
-      #                        If you don't provide at least one of visibility, embargo_release_date or
-      #                        lease_expiration_date, visibility will be copied from the parent.
+      #   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)
         now = TimeService.time_in_utc
         file_set.date_uploaded = now
         file_set.date_modified = now
         file_set.creator = [user.user_key]
-
         Actors::ActorStack.new(file_set, ability, [InterpretVisibilityActor]).create(file_set_params) if assign_visibility?(file_set_params)
         yield(file_set) if block_given?
       end
@@ -39,29 +34,21 @@ module Hyrax
         # If the file set doesn't have a title or label assigned, set a default.
         file_set.label ||= file.respond_to?(:original_filename) ? file.original_filename : ::File.basename(file)
         file_set.title = [file_set.label] if file_set.title.blank?
-
-        # Need to save the file_set in order to get an id
-        return false unless file_set.save
-
+        return false unless file_set.save # Need to save the file_set in order to get an id
         file_actor_class.new(file_set, relation, user).ingest_file(file, asynchronous)
         true
       end
 
       # Adds a FileSet to the work using ore:Aggregations.
-      # Locks to ensure that only one process is operating on
-      # the list at a time.
+      # Locks to ensure that only one process is operating on the list at a time.
       def attach_file_to_work(work, file_set_params = {})
         acquire_lock_for(work.id) do
-          # Ensure we have an up-to-date copy of the members association, so
-          # that we append to the end of the list.
+          # Ensure we have an up-to-date copy of the members association, so that we append to the end of the list.
           work.reload unless work.new_record?
-          unless assign_visibility?(file_set_params)
-            copy_visibility(work, file_set)
-          end
+          copy_visibility(work, file_set) unless assign_visibility?(file_set_params)
           work.ordered_members << file_set
           set_representative(work, file_set)
           set_thumbnail(work, file_set)
-
           # Save the work so the association between the work and the file_set is persisted (head_id)
           # NOTE: the work may not be valid, in which case this save doesn't do anything.
           work.save
@@ -72,12 +59,9 @@ module Hyrax
       # @param [String] relation ('original_file')
       def revert_content(revision_id, relation = 'original_file')
         file_actor = file_actor_class.new(file_set, relation, user)
-        if file_actor.revert_to(revision_id)
-          Hyrax.config.callback.run(:after_revert_content, file_set, user, revision_id)
-          true
-        else
-          false
-        end
+        return false unless file_actor.revert_to(revision_id)
+        Hyrax.config.callback.run(:after_revert_content, file_set, user, revision_id)
+        true
       end
 
       # @param [File, ActionDigest::HTTP::UploadedFile, Tempfile] file the file uploaded by the user.
@@ -105,6 +89,14 @@ module Hyrax
         Hyrax::Actors::FileActor
       end
 
+      # Spawns async job to attach file to fileset
+      # @param [#to_s] url
+      def import_url(url)
+        file_set.update(import_url: url.to_s)
+        operation = Hyrax::Operation.create!(user: user, operation_type: "Attach File")
+        ImportUrlJob.perform_later(file_set, operation)
+      end
+
       private
 
         def ability
@@ -112,7 +104,7 @@ module Hyrax
         end
 
         # Takes an optional block and executes the block if the save was successful.
-        # returns false if the save was unsuccessful
+        # @return [Boolean] false if the save was unsuccessful
         def save
           on_retry = ->(exception, _, _, _) { ActiveFedora::Base.logger.warn "Hyrax::Actors::FileSetActor#save Caught RSOLR error #{exception.inspect}" }
           Retriable.retriable on: RSolr::Error::Http,
@@ -147,10 +139,8 @@ module Hyrax
         def unlink_from_work
           work = file_set.parent
           return unless work && (work.thumbnail_id == file_set.id || work.representative_id == file_set.id)
-          # This is required to clear the thumbnail_id and representative_id
-          # fields on the work and force it to be re-solrized. Although
-          # ActiveFedora clears the children nodes it leaves the work's
-          # thumbnail_id and representative_id fields in Solr populated.
+          # Must clear the thumbnail_id and representative_id fields on the work and force it to be re-solrized.
+          # Although ActiveFedora clears the children nodes it leaves those fields in Solr populated.
           work.thumbnail = nil if work.thumbnail_id == file_set.id
           work.representative = nil if work.representative_id == file_set.id
           work.save!

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

@@ -17,7 +17,7 @@ export default class {
   // Display the sharing tab if they select an admin set that permits sharing
   sharingTab() {
     if(this.adminSetWidget && !this.adminSetWidget.isEmpty()) {
-      this.adminSetWidget.on('change', (data) => this.sharingTabVisiblity(data))
+      this.adminSetWidget.on('change', () => this.sharingTabVisiblity(this.adminSetWidget.isSharing()))
       this.sharingTabVisiblity(this.adminSetWidget.isSharing())
     }
   }

data/app/assets/javascripts/hyrax/monkey_patch_turbolinks.js.coffee

@@ -1,10 +1,11 @@
 # Monkey patch Turbolinks to render 401
 # See https://github.com/turbolinks/turbolinks/issues/179
 #     https://github.com/projecthydra-labs/hyrax/issues/617
-Turbolinks.HttpRequest.prototype.requestLoaded = ->
-  @endRequest =>
-    if 200 <= @xhr.status < 300 or @xhr.status == 401
-      @delegate.requestCompletedWithResponse(@xhr.responseText, @xhr.getResponseHeader("Turbolinks-Location"))
-    else
-      @failed = true
-      @delegate.requestFailedWithStatusCode(@xhr.status, @xhr.responseText)
+if Turbolinks?
+  Turbolinks.HttpRequest.prototype.requestLoaded = ->
+    @endRequest =>
+      if 200 <= @xhr.status < 300 or @xhr.status == 401
+        @delegate.requestCompletedWithResponse(@xhr.responseText, @xhr.getResponseHeader("Turbolinks-Location"))
+      else
+        @failed = true
+        @delegate.requestFailedWithStatusCode(@xhr.status, @xhr.responseText)

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

@@ -14,6 +14,7 @@ export default class SelectWorkType {
           e.preventDefault()
           this.modal.modal()
           // ensure the type is set for the last clicked element
+          // type is either "batch" or "single" (work)
           this.type = element.data('create-type')
           // add custom routing logic when the modal is shown
           this.form.on('submit', this.routingLogic.bind(this))
@@ -34,6 +35,9 @@ export default class SelectWorkType {
       window.location.href = this.destination()
   }
 
+  // Each input has two attributes that contain paths, one for the batch and one
+  // for a single work.  So, given the value of 'this.type', return the appropriate
+  // path.
   destination() {
       return this.form.find('input[type="radio"]:checked').data(this.type)
   }

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

@@ -141,3 +141,13 @@ ul.collapsing > li > a {
     }
   }
 }
+
+.works-list {
+  .workflow-state {
+    white-space: nowrap;
+  }
+
+  .media-body {
+    width: 18vw;
+  }
+}

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

@@ -52,6 +52,14 @@ form {
   label { font-weight: normal; }
   & .form-group { padding: 0 1.75em; }
 
+  #collapseEmbargo .form-group {
+    padding: 0;
+
+    &.generic_work_visibility_after_embargo {
+      margin-top: 6px;
+    }
+  }
+
   .form-inline {
     .control-label, label {
       padding-left: 0;

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

@@ -4,6 +4,8 @@ module Hyrax::Controller
   included do
     class_attribute :create_work_presenter_class
     self.create_work_presenter_class = Hyrax::SelectTypeListPresenter
+    self.search_state_class = Hyrax::SearchState
+
     # Adds Hydra behaviors into the application controller
     include Hydra::Controller::ControllerBehavior
     helper_method :create_work_presenter
@@ -28,11 +30,6 @@ module Hyrax::Controller
     super.merge(locale: I18n.locale)
   end
 
-  # Override Blacklight to use the Hyrax::SearchState
-  def search_state
-    @search_state ||= Hyrax::SearchState.new(self)
-  end
-
   private
 
     def set_locale

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

@@ -8,7 +8,7 @@ module Hyrax
         add_breadcrumb t(:'hyrax.controls.home'), root_path
         add_breadcrumb t(:'hyrax.toolbar.admin.menu'), hyrax.admin_path
         add_breadcrumb t(:'hyrax.admin.workflow_roles.header'), hyrax.admin_workflow_roles_path
-        @presenter = WorkflowRolePresenter.new
+        @presenter = WorkflowRolesPresenter.new
       end
 
       def destroy

data/app/controllers/hyrax/workflow_actions_controller.rb

@@ -3,16 +3,19 @@ module Hyrax
     before_action :authenticate_user!
 
     def update
-      work = ActiveFedora::Base.find(params[:id])
+      @curation_concern = ActiveFedora::Base.find(params[:id])
       workflow_action_form = Hyrax::Forms::WorkflowActionForm.new(
         current_ability: current_ability,
-        work: work,
+        work: @curation_concern,
         attributes: workflow_action_params
       )
       if workflow_action_form.save
-        redirect_to [main_app, work], notice: "The #{work.human_readable_type} has been updated."
+        after_update_response
       else
-        render 'hyrax/base/unauthorized', status: :unauthorized
+        respond_to do |wants|
+          wants.html { render 'hyrax/base/unauthorized', status: :unauthorized }
+          wants.json { render_json_response(response_type: :unprocessable_entity, options: { errors: @curation_concern.errors }) }
+        end
       end
     end
 
@@ -21,5 +24,12 @@ module Hyrax
       def workflow_action_params
         params.require(:workflow_action).permit(:name, :comment)
       end
+
+      def after_update_response
+        respond_to do |wants|
+          wants.html { redirect_to [main_app, @curation_concern], notice: "The #{@curation_concern.human_readable_type} has been updated." }
+          wants.json { render 'hyrax/base/show', status: :ok, location: polymorphic_path([main_app, @curation_concern]) }
+        end
+      end
   end
 end

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

@@ -57,6 +57,14 @@ module Hyrax
         return_info
       end
 
+      # 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
+      end
+
       private
 
         # @return [String]
@@ -70,7 +78,36 @@ module Hyrax
         def update_participants_options(attributes)
           update_permission_template(attributes)
           # if managers were added, recalculate update the access controls on the AdminSet
-          admin_set.update_access_controls! if managers_updated?(attributes)
+          return unless managers_updated?(attributes)
+          update_management
+        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)
+        end
+
+        # @return [Array<Sipity::Agent>] a list of sipity agents corresponding to the manager role of the permission_template
+        def manager_agents
+          @manager_agents ||= begin
+            authorized_agents = manager_grants.map do |access|
+              if access.agent_type == 'user'
+                ::User.find_by_user_key(access.agent_id)
+              else
+                Hyrax::Group.new(access.agent_id)
+              end
+            end
+            authorized_agents.map { |agent| PowerConverter.convert_to_sipity_agent(agent) }
+          end
+        end
+
+        # @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)
         end
 
         # @return [String, Nil] error_code if validation fails, nil otherwise

data/app/forms/hyrax/forms/work_form.rb

@@ -31,6 +31,9 @@ module Hyrax
 
       self.required_fields = [:title, :creator, :keyword, :rights]
 
+      # The service that determines the cardinality of each field
+      self.field_metadata_service = Hyrax::FormMetadataService
+
       def initialize(model, current_ability, controller)
         @current_ability = current_ability
         @agreement_accepted = !model.new_record?
@@ -81,41 +84,12 @@ module Hyrax
       # Get a list of collection id/title pairs for the select form
       def collections_for_select
         service = Hyrax::CollectionsService.new(@controller)
-        convert_solr_docs_to_select_options(service.search_results(:edit))
-      end
-
-      def convert_solr_docs_to_select_options(results)
-        option_values = results.map do |r|
-          [r.to_s, r.id]
-        end
-        option_values.sort do |a, b|
-          if a.first && b.first
-            a.first <=> b.first
-          else
-            a.first ? -1 : 1
-          end
-        end
-      end
-
-      # This determines whether the allowed parameters are single or multiple.
-      # We are returning true for properties that are backed by methods, for
-      # which the HydraEditor::FieldMetadataService cannot determine are multiple.
-      # The instance variable is used when choosing which UI widget to draw.
-      def multiple?(field)
-        return true if ['ordered_member_ids', 'in_works_ids', 'member_of_collection_ids'].include? field.to_s
-        super
-      end
-
-      # The class method _multiple?_ is used for building the permitted params
-      # for the update action
-      def self.multiple?(field)
-        return true if ['ordered_member_ids', 'in_works_ids', 'member_of_collection_ids'].include? field.to_s
-        super
+        CollectionOptionsPresenter.new(service).select_options(:edit)
       end
 
       def self.sanitize_params(form_params)
         admin_set_id = form_params[:admin_set_id]
-        if admin_set_id && Sipity::Workflow.find_by!(id: Hyrax::PermissionTemplate.find_by!(admin_set_id: admin_set_id).active_workflow).allows_access_grant?
+        if admin_set_id && workflow_for(admin_set_id: admin_set_id).allows_access_grant?
           return super
         end
         params_without_permissions = permitted_params.reject { |arg| arg.respond_to?(:key?) && arg.key?(:permissions_attributes) }
@@ -132,6 +106,17 @@ module Hyrax
         ]
       end
 
+      def self.workflow_for(admin_set_id:)
+        begin
+          workflow = Hyrax::PermissionTemplate.find_by!(admin_set_id: admin_set_id).active_workflow
+        rescue ActiveRecord::RecordNotFound
+          raise "Missing permission template for AdminSet(id:#{admin_set_id})"
+        end
+        raise Hyrax::MissingWorkflowError, "PermissionTemplate for AdminSet(id:#{admin_set_id}) does not have an active_workflow" unless workflow
+        workflow
+      end
+      private_class_method :workflow_for
+
       private
 
         # @return [Array<FileSetPresenter>] presenters for the file sets in order of the ids

data/app/forms/hyrax/forms/workflow_responsibility_form.rb

@@ -26,9 +26,12 @@ module Hyrax
         ::User.all
       end
 
-      # The select options for choosing a responsibility
+      # The select options for choosing a responsibility sorted by label
       def workflow_role_options
-        Sipity::WorkflowRole.all.map { |wf_role| [label(wf_role), wf_role.id] }
+        options = Sipity::WorkflowRole.all.map do |wf_role|
+          [Hyrax::Admin::WorkflowRolePresenter.new(wf_role).label, wf_role.id]
+        end
+        options.sort_by(&:first)
       end
 
       private