hyrax 3.0.0.pre.rc1 → 3.0.0.pre.rc2

data/app/services/hyrax/visibility_propagator.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
 module Hyrax
   ##
-  # @abstract Propogates visibility from a provided object (e.g. a Work) to some
+  # @abstract Propagates visibility from a provided object (e.g. a Work) to some
   # group of its members (e.g. file_sets).
   class VisibilityPropagator
     ##
-    # @param source [#visibility] the object to propogate visibility from
+    # @param source [#visibility] the object to propagate visibility from
     #
-    # @return [#propogate]
+    # @return [#propagate]
     def self.for(source:)
       case source
       when Hyrax::WorkBehavior # ActiveFedora

data/app/services/hyrax/visibility_reader.rb

@@ -14,22 +14,26 @@ module Hyrax
   #
   class VisibilityReader
     ##
+    # @!attribute [r] permission_manager
+    #   @return [Hyrax::PermissionManager]
     # @!attribute [rw] resource
-    #   @return [Valkyrie::Resource::AccessControls]
+    #   @return [Valkyrie::Resource]
+    attr_reader   :permission_manager
     attr_accessor :resource
 
     ##
     # @param resource [Valkyrie::Resource::AccessControls]
     def initialize(resource:)
       self.resource = resource
+      @permission_manager = resource.permission_manager
     end
 
     ##
     # @return [String]
     def read
-      if resource.read_groups.include? Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC
+      if permission_manager.read_groups.include? Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC
         visibility_map.visibility_for(group: Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC)
-      elsif resource.read_groups.include? Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_AUTHENTICATED
+      elsif permission_manager.read_groups.include? Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_AUTHENTICATED
         visibility_map.visibility_for(group: Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_AUTHENTICATED)
       else
         visibility_map.visibility_for(group: :PRIVATE)

data/app/services/hyrax/visibility_writer.rb

@@ -17,14 +17,18 @@ module Hyrax
   #
   class VisibilityWriter
     ##
+    # @!attribute [r] permission_manager
+    #   @return [Hyrax::PermissionManager]
     # @!attribute [rw] resource
-    #   @return [Valkyrie::Resource::AccessControls]
+    #   @return [Valkyrie::Resource]
     attr_accessor :resource
+    attr_reader   :permission_manager
 
     ##
-    # @param resource [Valkyrie::Resource::AccessControls]
+    # @param resource [Valkyrie::Resource]
     def initialize(resource:)
-      self.resource = resource
+      self.resource       = resource
+      @permission_manager = resource.permission_manager
     end
 
     ##
@@ -32,8 +36,11 @@ module Hyrax
     #
     # @return [void]
     def assign_access_for(visibility:)
-      resource.read_groups -= visibility_map.deletions_for(visibility: visibility)
-      resource.read_groups += visibility_map.additions_for(visibility: visibility)
+      permission_manager.read_groups =
+        permission_manager.read_groups.to_a - visibility_map.deletions_for(visibility: visibility)
+
+      permission_manager.read_groups =
+        permission_manager.read_groups.to_a + visibility_map.additions_for(visibility: visibility)
     end
 
     def visibility_map

data/app/services/hyrax/work_form_service.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
 module Hyrax
+  ##
+  # A factory that builds work forms based on the `#model_name` of the work.
   class WorkFormService
     def self.build(curation_concern, current_ability, *extra)
       form_class(curation_concern).new(curation_concern, current_ability, *extra)

data/app/services/hyrax/work_query_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Responsible for retrieving information based on the given work.
   #
@@ -18,9 +19,9 @@ module Hyrax
 
     private
 
-      def default_work_relation
-        Hyrax::WorkRelation.new
-      end
+    def default_work_relation
+      Hyrax::WorkRelation.new
+    end
 
     public
 
@@ -43,16 +44,16 @@ module Hyrax
 
     private
 
-      def solr_doc
-        @solr_doc ||= ::SolrDocument.new(solr_response['response']['docs'].first, solr_response)
-      end
+    def solr_doc
+      @solr_doc ||= ::SolrDocument.new(solr_response['response']['docs'].first, solr_response)
+    end
 
-      def solr_response
-        @solr_response ||= Hyrax::SolrService.get(query)
-      end
+    def solr_response
+      @solr_response ||= Hyrax::SolrService.get(query)
+    end
 
-      def query
-        Hyrax::SolrQueryBuilderService.construct_query_for_ids([id])
-      end
+    def query
+      Hyrax::SolrQueryBuilderService.construct_query_for_ids([id])
+    end
   end
 end

data/app/services/hyrax/work_thumbnail_path_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class WorkThumbnailPathService < Hyrax::ThumbnailPathService
     class << self

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     # @abstract A notification that happens when a state transition occurs. Subclass AbstractNotification to create a notification.
@@ -55,27 +56,27 @@ module Hyrax
 
       private
 
-        def subject
-          raise NotImplementedError, "Implement #subject in a child class"
-        end
+      def subject
+        raise NotImplementedError, "Implement #subject in a child class"
+      end
 
-        def message
-          "#{title} (#{link_to work_id, document_path}) was advanced in the workflow by #{user.user_key} and is awaiting approval #{comment}"
-        end
+      def message
+        "#{title} (#{link_to work_id, document_path}) was advanced in the workflow by #{user.user_key} and is awaiting approval #{comment}"
+      end
 
-        # @return [ActiveFedora::Base] the document (work) the the Abstract WorkFlow is creating a notification for
-        def document
-          @entity.proxy_for
-        end
+      # @return [Object] the document (work) the the Abstract WorkFlow is creating a notification for
+      def document
+        @entity.proxy_for
+      end
 
-        def document_path
-          key = document.model_name.singular_route_key
-          Rails.application.routes.url_helpers.send(key + "_path", document.id)
-        end
+      def document_path
+        key = document.model_name.singular_route_key
+        Rails.application.routes.url_helpers.send(key + "_path", document.id)
+      end
 
-        def users_to_notify
-          recipients.fetch(:to, []) + recipients.fetch(:cc, [])
-        end
+      def users_to_notify
+        recipients.fetch(:to, []) + recipients.fetch(:cc, [])
+      end
     end
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     # Responsible for performing additional functions when the given criteria is met.

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     module ActivateObject

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

@@ -1,22 +1,23 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     class ChangesRequiredNotification < AbstractNotification
       private
 
-        def subject
-          I18n.t('hyrax.notifications.workflow.changes_required.subject')
-        end
+      def subject
+        I18n.t('hyrax.notifications.workflow.changes_required.subject')
+      end
 
-        def message
-          I18n.t('hyrax.notifications.workflow.changes_required.message', title: title,
-                                                                          link: (link_to work_id, document_path),
-                                                                          comment: comment)
-        end
+      def message
+        I18n.t('hyrax.notifications.workflow.changes_required.message', title: title,
+                                                                        link: (link_to work_id, document_path),
+                                                                        comment: comment)
+      end
 
-        def users_to_notify
-          user_key = document.depositor
-          super << ::User.find_by(email: user_key)
-        end
+      def users_to_notify
+        user_key = document.depositor
+        super << ::User.find_by(email: user_key)
+      end
     end
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     ##

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

@@ -1,21 +1,22 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     class DepositedNotification < AbstractNotification
       private
 
-        def subject
-          I18n.t('hyrax.notifications.workflow.deposited.subject')
-        end
+      def subject
+        I18n.t('hyrax.notifications.workflow.deposited.subject')
+      end
 
-        def message
-          I18n.t('hyrax.notifications.workflow.deposited.message', title: title, link: (link_to work_id, document_path),
-                                                                   user: user.user_key, comment: comment)
-        end
+      def message
+        I18n.t('hyrax.notifications.workflow.deposited.message', title: title, link: (link_to work_id, document_path),
+                                                                 user: user.user_key, comment: comment)
+      end
 
-        def users_to_notify
-          user_key = Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: work_id).depositor
-          super << ::User.find_by(email: user_key)
-        end
+      def users_to_notify
+        user_key = Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: work_id).depositor
+        super << ::User.find_by(email: user_key)
+      end
     end
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     # This is a built in function for workflow, so that a workflow action can be created that

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     # This is a built in function for workflow, so that a workflow action can be created that

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     class InvalidStateRemovalException < ::RuntimeError

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     # Responsible for writing the database records for the given :action and :method list.
@@ -29,27 +30,27 @@ module Hyrax
 
       private
 
-        def update_list
-          update_from = list.dup
-          nodes_to_update = action.triggered_methods.order(:weight)
-          nodes_to_update.each do |node|
-            node.update!(service_name: update_from.shift)
-          end
+      def update_list
+        update_from = list.dup
+        nodes_to_update = action.triggered_methods.order(:weight)
+        nodes_to_update.each do |node|
+          node.update!(service_name: update_from.shift)
+        end
 
-          count = nodes_to_update.count
-          # If there are more new values than old values, add them.
-          until update_from.empty?
-            action.triggered_methods.create!(service_name: update_from.shift, weight: count)
-            count += 1
-          end
+        count = nodes_to_update.count
+        # If there are more new values than old values, add them.
+        until update_from.empty?
+          action.triggered_methods.create!(service_name: update_from.shift, weight: count)
+          count += 1
         end
+      end
 
-        def replace_list
-          action.triggered_methods.destroy_all
-          list.each_with_index do |name, i|
-            action.triggered_methods.create!(service_name: name, weight: i)
-          end
+      def replace_list
+        action.triggered_methods.destroy_all
+        list.each_with_index do |name, i|
+          action.triggered_methods.create!(service_name: name, weight: i)
         end
+      end
     end
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     # Helps consolidate and map a notification configuration.

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     # Responsible for writing the database records for the given :workflow and :notification_configuration.
@@ -28,37 +29,37 @@ module Hyrax
 
       private
 
-        def persist_notification
-          Sipity::Notification.find_or_create_by!(
-            name: notification_configuration.notification_name,
-            notification_type: notification_configuration.notification_type
-          )
-        end
+      def persist_notification
+        Sipity::Notification.find_or_create_by!(
+          name: notification_configuration.notification_name,
+          notification_type: notification_configuration.notification_type
+        )
+      end
 
-        def assign_recipients_to(notification:)
-          notification_configuration.recipients.slice(:to, :cc, :bcc).each do |(recipient_strategy, recipient_roles)|
-            Array.wrap(recipient_roles).each do |role|
-              notification.recipients.find_or_create_by!(
-                role: PowerConverter.convert_to_sipity_role(role), recipient_strategy: recipient_strategy.to_s
-              )
-            end
+      def assign_recipients_to(notification:)
+        notification_configuration.recipients.slice(:to, :cc, :bcc).each do |(recipient_strategy, recipient_roles)|
+          Array.wrap(recipient_roles).each do |role|
+            notification.recipients.find_or_create_by!(
+              role: Sipity::Role(role), recipient_strategy: recipient_strategy.to_s
+            )
           end
         end
+      end
 
-        def assign_scope_and_reason_to(notification:)
-          Sipity::NotifiableContext.find_or_create_by!(
-            scope_for_notification: scope,
-            reason_for_notification: notification_configuration.reason,
-            notification: notification
-          )
-        end
+      def assign_scope_and_reason_to(notification:)
+        Sipity::NotifiableContext.find_or_create_by!(
+          scope_for_notification: scope,
+          reason_for_notification: notification_configuration.reason,
+          notification: notification
+        )
+      end
 
-        attr_accessor :workflow, :notification_configuration
-        attr_reader :scope
+      attr_accessor :workflow, :notification_configuration
+      attr_reader :scope
 
-        def assign_scope!
-          @scope = PowerConverter.convert_to_sipity_action(notification_configuration.scope, scope: workflow)
-        end
+      def assign_scope!
+        @scope = Sipity::WorkflowAction(notification_configuration.scope, workflow)
+      end
     end
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     # Responsible for determining the appropriate notification(s) to deliver based on the given

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

@@ -1,21 +1,22 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     class PendingReviewNotification < AbstractNotification
       private
 
-        def subject
-          I18n.t('hyrax.notifications.workflow.pending_review.subject')
-        end
+      def subject
+        I18n.t('hyrax.notifications.workflow.pending_review.subject')
+      end
 
-        def message
-          I18n.t('hyrax.notifications.workflow.pending_review.message', title: title,
-                                                                        link: (link_to work_id, document_path),
-                                                                        user: user.user_key, comment: comment)
-        end
+      def message
+        I18n.t('hyrax.notifications.workflow.pending_review.message', title: title,
+                                                                      link: (link_to work_id, document_path),
+                                                                      user: user.user_key, comment: comment)
+      end
 
-        def users_to_notify
-          super << user
-        end
+      def users_to_notify
+        super << user
+      end
     end
   end
 end