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

data/app/search_builders/hyrax/dashboard/works_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Dashboard
     class WorksSearchBuilder < Hyrax::WorksSearchBuilder

data/app/search_builders/hyrax/deactivated_embargo_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class DeactivatedEmbargoSearchBuilder < EmbargoSearchBuilder
     self.default_processor_chain += [:with_deactivated_embargos]

data/app/search_builders/hyrax/deactivated_lease_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class DeactivatedLeaseSearchBuilder < LeaseSearchBuilder
     self.default_processor_chain += [:with_deactivated_leases]

data/app/search_builders/hyrax/deposit_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class DepositSearchBuilder < ::SearchBuilder
     # includes the depositor_facet to get information on deposits.
@@ -22,8 +23,8 @@ module Hyrax
 
     private
 
-      def only_works?
-        true
-      end
+    def only_works?
+      true
+    end
   end
 end

data/app/search_builders/hyrax/embargo_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Finds embargoed objects
   class EmbargoSearchBuilder < Blacklight::SearchBuilder

data/app/search_builders/hyrax/expired_embargo_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Finds embargoed objects with release dates in the past
   class ExpiredEmbargoSearchBuilder < EmbargoSearchBuilder

data/app/search_builders/hyrax/expired_lease_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Finds embargoed objects with release dates in the past
   class ExpiredLeaseSearchBuilder < LeaseSearchBuilder

data/app/search_builders/hyrax/exposed_models_relation.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module Hyrax
   # A relation that scopes to all user visible models (e.g. works + collections + file sets)
   class ExposedModelsRelation < AbstractTypeRelation
     def allowable_types
-      Hyrax.config.curation_concerns + [Collection, ::FileSet]
+      Hyrax.config.curation_concerns + [::Collection, ::FileSet]
     end
   end
 end

data/app/search_builders/hyrax/file_set_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class FileSetSearchBuilder < ::SearchBuilder
     include SingleResult

data/app/search_builders/hyrax/filter_by_type.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module FilterByType
     extend ActiveSupport::Concern
@@ -14,45 +15,44 @@ module Hyrax
 
     private
 
-      def only_collections?
-        generic_type_field.include?('Collection')
-      end
-
-      def only_works?
-        generic_type_field.include?('Work')
-      end
-
-      # Override this method if you want to filter for a different set of models.
-      # @return [Array<Class>] a list of classes to include
-      def models
-        work_classes + collection_classes
-      end
-
-      def models_to_solr_clause
-        # to_class_uri is deprecated in AF 11
-        [ActiveFedora::Base.respond_to?(:to_rdf_representation) ? models.map(&:to_rdf_representation) : models.map(&:to_class_uri)].join(',')
-      end
-
-      def generic_type_field
-        Array.wrap(blacklight_params.fetch(:f, {}).fetch(:generic_type_sim, []))
-      end
-
-      # Override this method if you want to limit some of the registered
-      # types from appearing in search results
-      # @return [Array<Class>] the list of work types to include in searches
-      def work_types
-        Hyrax.config.curation_concerns
-      end
-
-      def work_classes
-        return [] if only_collections?
-        work_types
-      end
-
-      def collection_classes
-        return [] if only_works?
-        # to_class_uri is deprecated in AF 11
-        [::Collection]
-      end
+    def only_collections?
+      generic_type_field.include?('Collection')
+    end
+
+    def only_works?
+      generic_type_field.include?('Work')
+    end
+
+    # Override this method if you want to filter for a different set of models.
+    # @return [Array<Class>] a list of classes to include
+    def models
+      work_classes + collection_classes
+    end
+
+    def models_to_solr_clause
+      models.map { |model| model.try(:to_rdf_representation) || model.name }.join(',')
+    end
+
+    def generic_type_field
+      Array.wrap(blacklight_params.fetch(:f, {}).fetch(:generic_type_sim, []))
+    end
+
+    # Override this method if you want to limit some of the registered
+    # types from appearing in search results
+    # @return [Array<Class>] the list of work types to include in searches
+    def work_types
+      Hyrax.config.curation_concerns
+    end
+
+    def work_classes
+      return [] if only_collections?
+      work_types
+    end
+
+    def collection_classes
+      return [] if only_works?
+      # to_class_uri is deprecated in AF 11
+      [::Collection]
+    end
   end
 end

data/app/search_builders/hyrax/filter_suppressed.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Injects a search builder filter to hide documents marked as suppressed
   module FilterSuppressed

data/app/search_builders/hyrax/filter_suppressed_with_roles.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Overrides FilterSuppressed filter to hide documents marked as
   # suppressed when the current user is permitted to take no workflow
@@ -9,33 +10,39 @@ module Hyrax
     extend ActiveSupport::Concern
     include FilterSuppressed
 
-    # Skip the filter if the current user is permitted to take
-    # workflow actions on the work corresponding to the SolrDocument
-    # with id = `blacklight_params[:id]`
+    # Skip the filter if the current user is:
+    #
+    # *  permitted to take workflow actions on the work
+    # *  the depositor
+    #
+    # corresponding to the SolrDocument with id = `blacklight_params[:id]`
+    #
+    # @note This is another case in which the Sipity workflows and the
+    #       SOLR permissions are not adequately synchronized.  Sipity COULD
+    #       be used to include that information, however that is not
+    #       presently scoped work.
     def only_active_works(solr_parameters)
-      return if user_has_active_workflow_role? || depositor?
+      current_work = ::SolrDocument.find(blacklight_params[:id])
+      return if user_has_active_workflow_role?(current_work: current_work)
+      return if depositor?(current_work: current_work)
       super
     end
 
     private
 
-      def current_work
-        ::SolrDocument.find(blacklight_params[:id])
-      end
-
-      def user_has_active_workflow_role?
-        Hyrax::Workflow::PermissionQuery.scope_permitted_workflow_actions_available_for_current_state(user: current_ability.current_user, entity: current_work).any?
-      rescue PowerConverter::ConversionError
-        # The current_work doesn't have a sipity workflow entity
-        false
-      end
+    def user_has_active_workflow_role?(current_work:)
+      Hyrax::Workflow::PermissionQuery.scope_permitted_workflow_actions_available_for_current_state(user: current_ability.current_user, entity: current_work).any?
+    rescue PowerConverter::ConversionError
+      # The current_work doesn't have a sipity workflow entity
+      false
+    end
 
-      def depositor?
-        depositors = current_work[DepositSearchBuilder.depositor_field]
+    def depositor?(current_work:)
+      depositors = current_work[DepositSearchBuilder.depositor_field]
 
-        return false if depositors.nil?
+      return false if depositors.nil?
 
-        depositors.first == current_ability.current_user.user_key
-      end
+      depositors.first == current_ability.current_user.user_key
+    end
   end
 end

data/app/search_builders/hyrax/homepage_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Added to allow for the My controller to show only things I have edit access to
 class Hyrax::HomepageSearchBuilder < Hyrax::SearchBuilder
   include Hyrax::FilterByType

data/app/search_builders/hyrax/lease_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Finds objects under lease
   class LeaseSearchBuilder < Blacklight::SearchBuilder

data/app/search_builders/hyrax/member_with_files_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Finds the child objects contained within a collection
   class MemberWithFilesSearchBuilder < ::SearchBuilder
@@ -19,8 +20,8 @@ module Hyrax
 
     private
 
-      def collection_id
-        blacklight_params.fetch('id')
-      end
+    def collection_id
+      blacklight_params.fetch('id')
+    end
   end
 end

data/app/search_builders/hyrax/my/collections_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Added to allow for the My controller to show only things I have edit access to
 class Hyrax::My::CollectionsSearchBuilder < ::SearchBuilder
   include Hyrax::My::SearchBuilderBehavior

data/app/search_builders/hyrax/my/find_works_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Search for possible works that user can edit and could be a work's child or parent.
 class Hyrax::My::FindWorksSearchBuilder < Hyrax::My::SearchBuilder
   include Hyrax::FilterByType

data/app/search_builders/hyrax/my/highlights_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Added to allow for the My controller to show only things I have edit access to
 class Hyrax::My::HighlightsSearchBuilder < Hyrax::SearchBuilder
   include Hyrax::My::SearchBuilderBehavior

data/app/search_builders/hyrax/my/search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module My
     # Search builder for things that the current user has deposited and has edit access to

data/app/search_builders/hyrax/my/search_builder_behavior.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Behavior for the my controller search builder to allow the my controller to only get access to
 # items I have edit access to.
 #

data/app/search_builders/hyrax/my/shares_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Added to allow for the My controller to show only things I have edit access to
 class Hyrax::My::SharesSearchBuilder < Hyrax::SearchBuilder
   include Hyrax::My::SearchBuilderBehavior

data/app/search_builders/hyrax/my/works_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 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.

data/app/search_builders/hyrax/nested_collections_parent_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Searches for all collections that are parents of a given collection.
   class NestedCollectionsParentSearchBuilder < ::SearchBuilder

data/app/search_builders/hyrax/parent_collection_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Given the id of a work, find the collections it is a member of
   class ParentCollectionSearchBuilder < Hyrax::CollectionSearchBuilder

data/app/search_builders/hyrax/search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class SearchBuilder < Blacklight::SearchBuilder
     include Blacklight::Solr::SearchBuilderBehavior

data/app/search_builders/hyrax/search_filters.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module SearchFilters
     extend ActiveSupport::Concern
@@ -21,14 +22,14 @@ module Hyrax
 
     private
 
-      # TODO: could this be moved to Blacklight::AccessControls::Enforcement?
-      def current_user_key
-        current_user.user_key
-      end
+    # TODO: could this be moved to Blacklight::AccessControls::Enforcement?
+    def current_user_key
+      current_user.user_key
+    end
 
-      # TODO: could this be moved to Blacklight::AccessControls::Enforcement?
-      def current_user
-        scope.current_user
-      end
+    # TODO: could this be moved to Blacklight::AccessControls::Enforcement?
+    def current_user
+      scope.current_user
+    end
   end
 end

data/app/search_builders/hyrax/single_admin_set_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class SingleAdminSetSearchBuilder < Hyrax::AdminSetSearchBuilder
     include Hyrax::SingleResult

data/app/search_builders/hyrax/single_collection_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class SingleCollectionSearchBuilder < ::SearchBuilder
     include SingleResult

data/app/search_builders/hyrax/single_result.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module SingleResult
     extend ActiveSupport::Concern

data/app/search_builders/hyrax/single_use_link_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class SingleUseLinkSearchBuilder < ::SearchBuilder
     include Hyrax::SingleResult

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Stats
     class WorkStatusSearchBuilder < ::SearchBuilder
@@ -17,9 +18,9 @@ module Hyrax
 
       private
 
-        def only_works?
-          true
-        end
+      def only_works?
+        true
+      end
     end
   end
 end

data/app/search_builders/hyrax/work_relation.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class WorkRelation < AbstractTypeRelation
     def allowable_types

data/app/search_builders/hyrax/work_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Finds a single work result. It returns no result if you don't have
   # access to the requested work.  If the work is suppressed (due to being in a

data/app/search_builders/hyrax/works_search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Returns all works, either active or suppressed.
   # This should only be used by an admin user

data/app/services/hyrax/abstract_message_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class AbstractMessageService
     attr_reader :file_set, :user
@@ -26,8 +27,8 @@ module Hyrax
 
     private
 
-      def job_user
-        ::User.audit_user
-      end
+    def job_user
+      ::User.audit_user
+    end
   end
 end

data/app/services/hyrax/access_control_list.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # @api public
+  #
+  # ACLs for `Hyrax::Resource` models
+  #
+  # Allows managing `Hyrax::Permission` entries referring to a specific
+  # `Hyrax::Resource` using a simple add/delete model.
+  #
+  # @example Using the Grant DSL
+  #   my_resource = Hyrax.query_service.find_by(id: 'my_id')
+  #
+  #   acl = Hyrax::AccessControlList.new(resource: resource)
+  #   acl.permissions # => #<Set: {}>
+  #
+  #   user  = User.first
+  #   group = Group.new('public')
+  #
+  #   acl.grant(:read).to(group)
+  #   acl.grant(:edit).to(user)
+  #
+  #   acl.permissions
+  #   # => #<Set: {#<Hyrax::Permission access_to=#<Valkyrie::ID:0x000055628b0ae0b8 @id="my_id"> agent="group/public" mode=:read>,
+  #     #<Hyrax::Permission access_to=#<Valkyrie::ID:0x000055628be41388 @id="my_id"> agent="user1@example.com" mode=:edit>}>
+  #
+  #   acl.revoke(:edit).from(user)
+  #
+  #   acl.permissions
+  #   # => #<Set: {#<Hyrax::Permission access_to=#<Valkyrie::ID:0x000055628b0ae0b8 @id="my_id"> agent="group/public" mode=:read>}>
+  class AccessControlList
+    ##
+    # @!attribute [rw] resource
+    #   @return [Valkyrie::Resource]
+    # @!attribute [r] persister
+    #   @return [#save]
+    # @!attribute [r] query_service
+    #   @return [#find_inverse_references_by]
+    attr_reader :persister, :query_service
+    attr_accessor :resource
+
+    ##
+    # @api public
+    #
+    # @param resource [Valkyrie::Resource]
+    # @param persister [#save] defaults to the configured Hyrax persister
+    # @param query_service [#find_inverse_references_by] defaults to the
+    #   configured Hyrax query service
+    def initialize(resource:, persister: Hyrax.persister, query_service: Hyrax.query_service)
+      self.resource  = resource
+      @persister     = persister
+      @query_service = query_service
+    end
+
+    ##
+    # @api public
+    #
+    # @param permission [Hyrax::Permission]
+    #
+    # @return [Boolean]
+    def <<(permission)
+      permission.access_to = resource.id
+
+      change_set.permissions += [permission]
+
+      true
+    end
+    alias add <<
+
+    ##
+    # @api public
+    #
+    # @param permission [Hyrax::Permission]
+    #
+    # @return [Boolean]
+    def delete(permission)
+      change_set.permissions -= [permission]
+
+      true
+    end
+
+    ##
+    # @api public
+    #
+    # @example
+    #    user = User.find('user_id')
+    #
+    #    acl.grant(:read).to(user)
+    def grant(mode)
+      ModeGrant.new(self, mode)
+    end
+
+    ##
+    # @api public
+    #
+    # @return [Boolean]
+    def pending_changes?
+      change_set.changed?
+    end
+
+    ##
+    # @api public
+    #
+    # @return [Set<Hyrax::Permission>]
+    def permissions
+      Set.new(change_set.permissions)
+    end
+
+    ##
+    # @api public
+    #
+    # @return [Array<Hyrax::Permission>]
+    def permissions=(new_permissions)
+      change_set.permissions = new_permissions.to_a
+    end
+
+    ##
+    # @api public
+    #
+    # @example
+    #    user = User.find('user_id')
+    #
+    #    acl.revoke(:read).from(user)
+    def revoke(mode)
+      ModeRevoke.new(self, mode)
+    end
+
+    ##
+    # @api public
+    #
+    # Saves the ACL for the resource, by saving each permission policy
+    #
+    # @return [Boolean]
+    def save
+      return true unless pending_changes?
+
+      change_set.sync
+      persister.save(resource: change_set.resource)
+      Hyrax.publisher.publish('object.acl.updated', acl: self, result: :success)
+      @change_set = nil
+
+      true
+    end
+
+    private
+
+    ##
+    # @abstract
+    # @api private
+    class ModeEditor
+      def initialize(acl, mode)
+        @acl  = acl
+        @mode = mode.to_sym
+      end
+
+      private
+
+      def id_for(agent: user_or_group)
+        case agent
+        when Hyrax::Group
+          "#{Hyrax::Group.name_prefix}#{agent.name}"
+        else
+          agent.user_key.to_s
+        end
+      end
+    end
+
+    ##
+    # @api private
+    #
+    # A short-term memory object for the permission granting DSL. Use with
+    # method chaining, as in: `acl.grant(:edit).to(user)`.
+    class ModeGrant < ModeEditor
+      ##
+      # @api public
+      # @return [Hyrax::AccessControlList]
+      def to(user_or_group)
+        agent_id = id_for(agent: user_or_group)
+
+        @acl << Hyrax::Permission.new(access_to: @acl.resource.id, agent: agent_id, mode: @mode)
+        @acl
+      end
+    end
+
+    ##
+    # @api private
+    #
+    # A short-term memory object for the permission revoking DSL. Use with
+    # method chaining, as in: `acl.revoke(:edit).from(user)`.
+    class ModeRevoke < ModeEditor
+      ##
+      # @api public
+      # @return [Hyrax::AccessControlList]
+      def from(user_or_group)
+        permission_for_deletion = @acl.permissions.find do |p|
+          p.mode == @mode &&
+            p.agent.to_s == id_for(agent: user_or_group)
+        end
+
+        @acl.delete(permission_for_deletion) if permission_for_deletion
+        @acl
+      end
+    end
+
+    ##
+    # @api private
+    def access_control_model
+      AccessControl.for(resource: resource, query_service: query_service)
+    end
+
+    ##
+    # @api private
+    def change_set
+      @change_set ||= Hyrax::ChangeSet.for(access_control_model)
+    end
+  end
+end