hyrax 1.0.0.rc1 → 1.0.0.rc2

data/app/helpers/hyrax/hyrax_helper_behavior.rb

@@ -17,7 +17,7 @@ module Hyrax
     # Which translations are available for the user to select
     # @return [Hash<String,String>] locale abbreviations as keys and flags as values
     def available_translations
-      { 'en' => 'English', 'es' => 'Español' }
+      { 'en' => 'English', 'es' => 'Español', 'zh' => '中文' }
     end
 
     delegate :name, :name_full, to: :institution, prefix: :institution

data/app/jobs/attach_files_to_work_job.rb

@@ -21,24 +21,14 @@ class AttachFilesToWorkJob < ActiveJob::Base
   private
 
     # @param [Hyrax::Actors::FileSetActor] actor
-    # @param [UploadedFileUploader] file
+    # @param [Hyrax::UploadedFileUploader] file file.file must be a CarrierWave::SanitizedFile or file.url must be present
     def attach_content(actor, file)
-      case file.file
-      when CarrierWave::SanitizedFile
+      if file.file.is_a? CarrierWave::SanitizedFile
         actor.create_content(file.file.to_file)
-      when CarrierWave::Storage::Fog::File
-        import_url(actor, file)
+      elsif file.url.present?
+        actor.import_url(file.url)
       else
-        raise ArgumentError, "Unknown type of file #{file.class}"
+        raise ArgumentError, "#{file.class} received with #{file.file.class} object and no URL"
       end
     end
-
-    # @param [Hyrax::Actors::FileSetActor] actor
-    # @param [UploadedFileUploader] file
-    def import_url(actor, file)
-      actor.file_set.update(import_url: file.url)
-      operation = Hyrax::Operation.create!(user: actor.user,
-                                           operation_type: "Attach File")
-      ImportUrlJob.perform_later(actor.file_set, operation)
-    end
 end

data/app/models/concerns/hyrax/naming.rb

@@ -1,3 +1,4 @@
+require_dependency 'hyrax/name'
 module Hyrax
   module Naming
     extend ActiveSupport::Concern

data/app/models/hyrax/permission_template_access.rb

@@ -5,16 +5,16 @@ module Hyrax
 
     belongs_to :permission_template
 
-    def view?
-      access == 'view'
-    end
+    VIEW = 'view'.freeze
+    DEPOSIT = 'deposit'.freeze
+    MANAGE = 'manage'.freeze
 
-    def deposit?
-      access == 'deposit'
-    end
-
-    def manage?
-      access == 'manage'
-    end
+    enum(
+      access: {
+        VIEW => VIEW,
+        DEPOSIT => DEPOSIT,
+        MANAGE => MANAGE
+      }
+    )
   end
 end

data/app/models/sipity/workflow.rb

@@ -54,5 +54,35 @@ module Sipity
         workflow.update!(active: true)
       end
     end
+
+    # Grant a workflow responsibility to a set of agents and remove it from any
+    # agents who currently have the workflow responsibility, but are not in the
+    # provided list
+    # @param [Sipity::Role] role the role to grant
+    # @param [Array<Sipity::Agent>] agents the agents to grant it to
+    def update_responsibilities(role:, agents:)
+      add_workflow_responsibilities(role, agents)
+      remove_workflow_responsibilities(role, agents)
+    end
+
+    private
+
+      # Give workflow responsibilites to the provided agents for the given role
+      # @param [Sipity::Role] role
+      # @param [Array<Sipity::Agent>] agents
+      def add_workflow_responsibilities(role, agents)
+        Hyrax::Workflow::PermissionGenerator.call(roles: role,
+                                                  workflow: self,
+                                                  agents: agents)
+      end
+
+      # Find any workflow_responsibilities held by agents not in the allowed_agents
+      # and remove them
+      # @param [Sipity::Role] role
+      # @param [Array<Sipity::Agent>] allowed_agents
+      def remove_workflow_responsibilities(role, allowed_agents)
+        wf_role = Sipity::WorkflowRole.find_by(workflow: self, role_id: role)
+        wf_role.workflow_responsibilities.where.not(agent: allowed_agents).destroy_all
+      end
   end
 end

data/app/presenters/hyrax/admin/workflow_role_presenter.rb

@@ -1,44 +1,30 @@
 module Hyrax
   module Admin
+    # Displays a single workflow role
     class WorkflowRolePresenter
-      def users
-        ::User.registered
+      def initialize(workflow_role)
+        @workflow = workflow_role.workflow
+        @role = workflow_role.role
+        @admin_set_id = workflow.permission_template.admin_set_id
       end
 
-      def presenter_for(user)
-        agent = user.sipity_agent
-        return unless agent
-        AgentPresenter.new(agent)
+      # @todo This is a hack; I don't want to include reference to the admin set;
+      #       However based on the current UI, in which we list all workflows (spanning all admin sets) this is required.
+      # @return [String] A meaningful label for the given WorkflowRole
+      def label
+        "#{admin_set_label(admin_set_id)} - #{role.name} (#{workflow.name})"
       end
 
-      class AgentPresenter
-        def initialize(agent)
-          @agent = agent
-        end
-
-        def responsibilities_present?
-          @agent.workflow_responsibilities.any?
-        end
+      private
 
-        def responsibilities
-          @agent.workflow_responsibilities.each do |responsibility|
-            yield ResponsibilityPresenter.new(responsibility)
-          end
-        end
-      end
+        attr_accessor :workflow, :role, :admin_set_id
 
-      class ResponsibilityPresenter
-        def initialize(responsibility)
-          @responsibility = responsibility
-          @wf_role = responsibility.workflow_role
+        def admin_set_label(id)
+          result = ActiveFedora::Base.search_by_id(id, fl: 'title_tesim')
+          result['title_tesim'].first
+        rescue ActiveFedora::ObjectNotFoundError
+          "[AdminSet ID=#{id}]"
         end
-
-        attr_accessor :responsibility
-
-        def label
-          "#{@wf_role.workflow.name} - #{@wf_role.role.name}"
-        end
-      end
     end
   end
 end

data/app/presenters/hyrax/admin/workflow_roles_presenter.rb

@@ -0,0 +1,43 @@
+module Hyrax
+  module Admin
+    # Displays a list of users and their associated workflow roles
+    class WorkflowRolesPresenter
+      def users
+        ::User.registered
+      end
+
+      def presenter_for(user)
+        agent = user.sipity_agent
+        return unless agent
+        AgentPresenter.new(agent)
+      end
+
+      class AgentPresenter
+        def initialize(agent)
+          @agent = agent
+        end
+
+        def responsibilities_present?
+          @agent.workflow_responsibilities.any?
+        end
+
+        def responsibilities
+          @agent.workflow_responsibilities.each do |responsibility|
+            yield ResponsibilityPresenter.new(responsibility)
+          end
+        end
+      end
+
+      class ResponsibilityPresenter
+        def initialize(responsibility)
+          @responsibility = responsibility
+          @workflow_role_presenter = WorkflowRolePresenter.new(responsibility.workflow_role)
+        end
+
+        attr_accessor :responsibility
+
+        delegate :label, to: :@workflow_role_presenter
+      end
+    end
+  end
+end

data/app/presenters/hyrax/collection_options_presenter.rb

@@ -0,0 +1,30 @@
+module Hyrax
+  # Presents the options for the Collection widget on the create/edit form
+  class CollectionOptionsPresenter
+    # @param [Hyrax::CollectionsService] service
+    def initialize(service)
+      @service = service
+    end
+
+    # Return AdminSet selectbox options based on access type
+    # @param [Symbol] access :read or :edit
+    def select_options(access = :edit)
+      option_values = results(access).map do |solr_doc|
+        [solr_doc.to_s, solr_doc.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
+
+    private
+
+      def results(access)
+        @service.search_results(access)
+      end
+  end
+end

data/app/presenters/hyrax/workflow_presenter.rb

@@ -11,9 +11,9 @@ module Hyrax
       sipity_entity.workflow_state_name if sipity_entity
     end
 
-    # TODO: maybe i18n here?
     def state_label
-      state
+      return unless state
+      I18n.t("hyrax.workflow.state.#{state}", default: state.humanize)
     end
 
     # Returns an array of tuples (key, label) appropriate for a radio group

data/app/search_builders/hyrax/active_works_search_builder.rb

@@ -0,0 +1,13 @@
+module Hyrax
+  # Finds a list of works. It returns no result if you don't have
+  # access to the requested work.  If the work is suppressed (due to being in a
+  # workflow), then it checks to see if the current_user has any workflow role
+  # on the given work.
+  class ActiveWorksSearchBuilder < Hyrax::SearchBuilder
+    include Hyrax::FilterByType
+
+    def only_works?
+      true
+    end
+  end
+end

data/app/search_builders/hyrax/my_works_search_builder.rb

@@ -1,15 +1,12 @@
-# Added to allow for the My controller to show only things I have edit access to
-class Hyrax::MyWorksSearchBuilder < Hyrax::SearchBuilder
-  include Hyrax::FilterByType
+module Hyrax
+  # Added to allow for the Hyrax::My::WorksController to show only things I have deposited
+  # If the work went through mediated deposit, I may no longer have edit access to it.
+  class MyWorksSearchBuilder < ActiveWorksSearchBuilder
+    self.default_processor_chain += [:show_only_resources_deposited_by_current_user]
 
-  self.default_processor_chain += [:show_only_resources_deposited_by_current_user]
-
-  # We remove the access controls filter, because some of the works a user has
-  # deposited may have gone through a workflow which has removed their ability
-  # to edit the work.
-  self.default_processor_chain -= [:add_access_controls_to_solr_params]
-
-  def only_works?
-    true
+    # We remove the access controls filter, because some of the works a user has
+    # deposited may have gone through a workflow which has removed their ability
+    # to edit the work.
+    self.default_processor_chain -= [:add_access_controls_to_solr_params]
   end
 end

data/app/search_builders/hyrax/works_search_builder.rb

@@ -0,0 +1,7 @@
+module Hyrax
+  # Returns all works, either active or suppressed.
+  # This should only be used by an admin user
+  class WorksSearchBuilder < ActiveWorksSearchBuilder
+    self.default_processor_chain -= [:only_active_works]
+  end
+end

data/app/services/hyrax/actor_factory.rb

@@ -26,7 +26,7 @@ module Hyrax
     end
 
     def self.model_actor(curation_concern)
-      actor_identifier = curation_concern.class.to_s.split('::').last
+      actor_identifier = curation_concern.class.to_s
       "Hyrax::Actors::#{actor_identifier}Actor".constantize
     end
   end

data/app/services/hyrax/admin_set_create_service.rb

@@ -58,8 +58,11 @@ module Hyrax
       admin_set.creator = [creating_user.user_key] if creating_user
       admin_set.save.tap do |result|
         if result
-          permission_template = create_permission_template
-          create_workflows_for(permission_template: permission_template)
+          ActiveRecord::Base.transaction do
+            permission_template = create_permission_template
+            workflow = create_workflows_for(permission_template: permission_template)
+            create_default_access_for(permission_template: permission_template, workflow: workflow) if admin_set.default_set?
+          end
         end
       end
     end
@@ -77,9 +80,28 @@ module Hyrax
 
       def create_workflows_for(permission_template:)
         workflow_importer.call(permission_template: permission_template)
+        grant_all_workflow_roles_to_creating_user!(permission_template: permission_template)
         Sipity::Workflow.activate!(permission_template: permission_template, workflow_name: Hyrax.config.default_active_workflow_name)
       end
 
+      def grant_all_workflow_roles_to_creating_user!(permission_template:)
+        # Default admin set has a nil creating_user; guard against that condition
+        return if creating_user.nil?
+        # Grant all workflow roles to the creating_user
+        permission_template.available_workflows.each do |workflow|
+          Sipity::Role.all.each do |role|
+            workflow.update_responsibilities(role: role, agents: creating_user.to_sipity_agent)
+          end
+        end
+      end
+
+      # Gives deposit access to all registered users
+      def create_default_access_for(permission_template:, workflow:)
+        permission_template.access_grants.create(agent_type: 'group', agent_id: 'registered', access: 'deposit')
+        deposit = Sipity::Role.find_by_name!('depositing')
+        workflow.update_responsibilities(role: deposit, agents: Hyrax::Group.new('registered'))
+      end
+
       def default_workflow_importer
         Hyrax::Workflow::WorkflowImporter.method(:load_workflow_for)
       end

data/app/services/hyrax/form_metadata_service.rb

@@ -0,0 +1,13 @@
+module Hyrax
+  # Answers queries about the cardinality of each field on the form.
+  class FormMetadataService < HydraEditor::FieldMetadataService
+    # @param [Class] model_class the class of the object
+    # @param [Symbol] field the field we want to know about
+    # @return [Boolean] true if the passed in field is a multivalued field
+    def self.multiple?(model_class, field)
+      return true if ['ordered_member_ids', 'in_works_ids', 'member_of_collection_ids'].include? field.to_s
+      # Inquire at the model level
+      super
+    end
+  end
+end

data/app/services/hyrax/persist_directly_contained_output_file_service.rb

@@ -5,12 +5,12 @@ module Hyrax
     # This method conforms to the signature of the .call method on Hydra::Derivatives::PersistOutputFileService
     # * Persists the file within the DirectContainer specified by :container
     #
-    # @param [#read] stream the data to be persisted
+    # @param [String] the data to be persisted
     # @param [Hash] directives directions which can be used to determine where to persist to.
     # @option directives [String] url URI for the parent object.
     # @option directives [String] container Name of the container association.
-    def self.call(stream, directives)
-      file = Hydra::Derivatives::IoDecorator.new(stream, new_mime_type(directives.fetch(:format)))
+    def self.call(string, directives)
+      file = Hydra::Derivatives::IoDecorator.new(string, new_mime_type(directives.fetch(:format)))
       o_name = determine_original_name(file)
       m_type = determine_mime_type(file)
       uri = URI(directives.fetch(:url))

data/app/services/hyrax/workflow/abstract_notification.rb

@@ -19,7 +19,9 @@ module Hyrax
       end
 
       def call
-        user.send_message(users_to_notify.uniq, message, subject)
+        users_to_notify.uniq.each do |recipient|
+          user.send_message(recipient, message, subject)
+        end
       end
 
       protected

data/app/services/hyrax/workflow/activate_object.rb

@@ -1,6 +1,6 @@
 module Hyrax
   module Workflow
-    class ActivateObject
+    module ActivateObject
       ##
       # This is a built in function for workflow, setting the `#state`
       # of the target to the Fedora 'active' status URI

data/app/services/hyrax/workflow/deactivate_object.rb

@@ -7,7 +7,7 @@ module Hyrax
     # @param target [#state] an instance of a model that includes `Hyrax::Suppressible`
     #
     # @return [RDF::Vocabulary::Term] the Fedora Resource Status 'inactive' term
-    class DeactivateObject
+    module DeactivateObject
       def self.call(target:, **)
         target.state = Vocab::FedoraResourceStatus.inactive
       end

data/app/services/hyrax/workflow/grant_edit_to_depositor.rb

@@ -2,7 +2,7 @@ module Hyrax
   module Workflow
     # This is a built in function for workflow, so that a workflow action can be created that
     # grants the creator the ability to alter it.
-    class GrantEditToDepositor
+    module GrantEditToDepositor
       def self.call(target:, **)
         target.edit_users += [target.depositor]
       end

data/app/services/hyrax/workflow/grant_read_to_depositor.rb

@@ -0,0 +1,13 @@
+module Hyrax
+  module Workflow
+    # This is a built in function for workflow, so that a workflow action can be created that
+    # grants the creator the ability to view their work.
+    module GrantReadToDepositor
+      # @param [#read_users=, #read_users] target (likely an ActiveRecord::Base) to which we are adding read_users for the depositor
+      # @return void
+      def self.call(target:, **)
+        target.read_users += [target.depositor]
+      end
+    end
+  end
+end