hyrax 2.8.0 → 3.0.0.pre.rc2

data/app/services/hyrax/visibility_intention.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+module Hyrax
+  ##
+  # Provides tools for interpreting form input as a visibility.
+  #
+  # @since 3.0.0
+  class VisibilityIntention
+    PUBLIC          = Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC
+    PRIVATE         = Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE
+    LEASE_REQUEST   = Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_LEASE
+    EMBARGO_REQUEST = Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_EMBARGO
+
+    ##
+    # @!attribute [rw] after
+    #   @return [String] the visibility requested after the embargo/lease release
+    # @!attribute [rw] during
+    #   @return [String] the visibility requested while the embargo/lease is in effect
+    # @!attribute [rw] release_date
+    #   @return [String]
+    # @!attribute [rw] visibility
+    #   @return [String]
+    attr_accessor :after, :during, :release_date, :visibility
+
+    ##
+    # @param [String] after
+    # @param [String] during
+    # @param [String] release_date
+    # @param [String] visibility
+    def initialize(visibility: PRIVATE, release_date: nil, during: nil, after: nil)
+      self.after        = after
+      self.during       = during
+      self.release_date = release_date
+      self.visibility   = visibility
+    end
+
+    ##
+    # @return [Array] the parameters for the requested embargo
+    def embargo_params
+      return []           unless wants_embargo?
+      raise ArgumentError unless valid_embargo?
+
+      [release_date, (during || PRIVATE), (after || PUBLIC)]
+    end
+
+    ##
+    # @return [Array] the parameters for the requested embargo
+    def lease_params
+      return []           unless wants_lease?
+      raise ArgumentError unless valid_lease?
+
+      [release_date, (during || PUBLIC), (after || PRIVATE)]
+    end
+
+    ##
+    # @return [Boolean]
+    def valid_embargo?
+      wants_embargo? && release_date.present?
+    end
+
+    ##
+    # @return [Boolean]
+    def wants_embargo?
+      visibility == EMBARGO_REQUEST
+    end
+
+    ##
+    # @return [Boolean]
+    def valid_lease?
+      wants_lease? && release_date.present?
+    end
+
+    ##
+    # @return [Boolean]
+    def wants_lease?
+      visibility == LEASE_REQUEST
+    end
+  end
+end

data/app/services/hyrax/visibility_intention_applicator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+module Hyrax
+  ##
+  # Applies a `VisibilityIntention` to a repository object.
+  class VisibilityIntentionApplicator
+    ##
+    # @!attribute [rw] intention
+    #   @return [VisibilityIntention]
+    attr_accessor :intention
+
+    ##
+    # @param [VisibilityIntention] intention
+    def initialize(intention:)
+      self.intention = intention
+    end
+
+    ##
+    # @param [VisibilityIntention] intention
+    #
+    # @return [VisibilityIntentionApplicator]
+    def self.apply(intention)
+      new(intention: intention)
+    end
+
+    ##
+    # @param [Object] model an object; this probably needs to be leasable,
+    #   embargoable, has visibility, and an AdminSet/PermissionTemplate.
+    def apply_to(model:)
+      if intention.wants_embargo?
+        raise InvalidIntentionError unless intention.valid_embargo?
+        model.apply_embargo(*intention.embargo_params)
+      elsif intention.wants_lease?
+        raise InvalidIntentionError unless intention.valid_lease?
+        model.apply_lease(*intention.lease_params)
+      else
+        model.visibility = intention.visibility
+      end
+    end
+    alias to apply_to
+
+    class InvalidIntentionError < ArgumentError; end
+  end
+end

data/app/services/hyrax/visibility_map.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # Defines a map from a visibility string value to appropriate permissions
+  # representing that visibility.
+  #
+  # @see Hyrax::VisibilityReader
+  # @see Hyrax::VisibilityWriter
+  # @see Hyrax::Resource#visibility
+  class VisibilityMap
+    DEFAULT_MAP = {
+      Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC => {
+        permission: Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC,
+        additions: [Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC].freeze,
+        deletions: [].freeze
+      }.freeze,
+      Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED => {
+        permission: Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_AUTHENTICATED,
+        additions: [Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_AUTHENTICATED].freeze,
+        deletions: [Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC].freeze
+      }.freeze,
+      Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE => {
+        permission: :PRIVATE,
+        additions: [].freeze,
+        deletions: [Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC,
+                    Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_AUTHENTICATED].freeze
+      }.freeze
+    }.freeze
+
+    extend Forwardable
+    include Singleton
+
+    def_delegators :@map, :[]
+
+    ##
+    # @!attribute [r] map
+    #   @return [Hash<String, Hash>]
+    attr_reader :map
+
+    ##
+    # @param map [Hash<String, String>]
+    def initialize(map: DEFAULT_MAP)
+      @map = map
+    end
+
+    ##
+    # Reverse lookup a visibility stirng from the permission group value
+    def visibility_for(group:)
+      @map.find { |_, v| v[:permission] == group }&.first
+    end
+
+    def additions_for(visibility:)
+      self[visibility][:additions]
+    end
+
+    def deletions_for(visibility:)
+      self[visibility][:deletions]
+    end
+
+    def visibilities
+      @map.keys
+    end
+  end
+end

data/app/services/hyrax/visibility_propagator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Hyrax
+  ##
+  # @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 propagate visibility from
+    #
+    # @return [#propagate]
+    def self.for(source:)
+      case source
+      when Hyrax::WorkBehavior # ActiveFedora
+        FileSetVisibilityPropagator.new(source: source)
+      when Hyrax::Resource # Valkyrie
+        ResourceVisibilityPropagator.new(source: source)
+      end
+    end
+  end
+end

data/app/services/hyrax/visibility_reader.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # Translates a set of ACLs into a visibility string.
+  #
+  # @example
+  #   resource = Hyrax::Resource.new
+  #   reader   = Hyrax::VisibilityReader.new(resource: resource)
+  #   reader.read # => "restricted"
+  #
+  #   resource.read_groups = ["public"]
+  #   reader.read # => "open"
+  #
+  class VisibilityReader
+    ##
+    # @!attribute [r] permission_manager
+    #   @return [Hyrax::PermissionManager]
+    # @!attribute [rw] resource
+    #   @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 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 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)
+      end
+    end
+
+    def visibility_map
+      Hyrax::VisibilityMap.instance
+    end
+  end
+end

data/app/services/hyrax/visibility_writer.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # Sets ACLs from a visibility string
+  #
+  # @example
+  #   resource = Hyrax::Resource.new
+  #   writer   = Hyrax::VisibilityWriter.new(resource: resource)
+  #   resource.read_groups # => []
+  #
+  #   writer.assign_access_for(visibility: 'open')
+  #   resource.read_groups # => ["public"]
+  #
+  #   writer.assign_access_for(visibility: 'authenticated')
+  #   resource.read_groups # => ["registered"]
+  #
+  class VisibilityWriter
+    ##
+    # @!attribute [r] permission_manager
+    #   @return [Hyrax::PermissionManager]
+    # @!attribute [rw] resource
+    #   @return [Valkyrie::Resource]
+    attr_accessor :resource
+    attr_reader   :permission_manager
+
+    ##
+    # @param resource [Valkyrie::Resource]
+    def initialize(resource:)
+      self.resource       = resource
+      @permission_manager = resource.permission_manager
+    end
+
+    ##
+    # @param visibility [String]
+    #
+    # @return [void]
+    def assign_access_for(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
+      Hyrax::VisibilityMap.instance
+    end
+  end
+end

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,10 +1,11 @@
+# frozen_string_literal: true
 module Hyrax
   # Responsible for retrieving information based on the given work.
   #
   # @see ProxyDepositRequest
   # @see Hyrax::WorkRelation
   # @see SolrDocument
-  # @see ActiveFedora::SolrService
+  # @see Hyrax::SolrService
   # @see ActiveFedora::SolrQueryBuilder
   # @note This was extracted from the ProxyDepositRequest, which was coordinating lots of effort. It was also an ActiveRecord object that required lots of Fedora/Solr interactions.
   class WorkQueryService
@@ -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 ||= ActiveFedora::SolrService.get(query)
-      end
+    def solr_response
+      @solr_response ||= Hyrax::SolrService.get(query)
+    end
 
-      def query
-        ActiveFedora::SolrQueryBuilder.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,20 +1,23 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     class ChangesRequiredNotification < AbstractNotification
       private
 
-        def subject
-          'Your deposit requires changes'
-        end
+      def subject
+        I18n.t('hyrax.notifications.workflow.changes_required.subject')
+      end
 
-        def message
-          "#{title} (#{link_to work_id, document_path}) requires additional changes before approval.\n\n '#{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