hyrax 2.8.0 → 3.0.0.pre.rc2

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
@@ -14,28 +15,24 @@ class Hyrax::My::FindWorksSearchBuilder < Hyrax::My::SearchBuilder
 
   def filter_on_title(solr_parameters)
     solr_parameters[:fq] ||= []
-    solr_parameters[:fq] += [ActiveFedora::SolrQueryBuilder.construct_query(title_tesim: @q)]
+    solr_parameters[:fq] += [Hyrax::SolrQueryBuilderService.construct_query(title_tesim: @q)]
   end
 
   def show_only_other_works(solr_parameters)
     solr_parameters[:fq] ||= []
-    solr_parameters[:fq] += [
-      "-" + ActiveFedora::SolrQueryBuilder.construct_query_for_ids([@id])
-    ]
+    solr_parameters[:fq] += ["-#{Hyrax::SolrQueryBuilderService.construct_query_for_ids([@id])}"]
   end
 
   def show_only_works_not_child(solr_parameters)
-    ids = ActiveFedora::SolrService.query("{!field f=id}#{@id}", fl: "member_ids_ssim", rows: 10_000).flat_map { |x| x.fetch("member_ids_ssim", []) }
+    ids = Hyrax::SolrService.query("{!field f=id}#{@id}", fl: "member_ids_ssim", rows: 10_000).flat_map { |x| x.fetch("member_ids_ssim", []) }
     solr_parameters[:fq] ||= []
-    solr_parameters[:fq]  += [
-      "-" + ActiveFedora::SolrQueryBuilder.construct_query_for_ids(ids)
-    ]
+    solr_parameters[:fq] += ["-#{Hyrax::SolrQueryBuilderService.construct_query_for_ids([ids])}"]
   end
 
   def show_only_works_not_parent(solr_parameters)
     solr_parameters[:fq] ||= []
     solr_parameters[:fq]  += [
-      "-" + ActiveFedora::SolrQueryBuilder.construct_query(member_ids_ssim: @id)
+      "-" + Hyrax::SolrQueryBuilderService.construct_query(member_ids_ssim: @id)
     ]
   end
 

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
@@ -7,8 +8,6 @@ class Hyrax::My::HighlightsSearchBuilder < Hyrax::SearchBuilder
   def show_only_highlighted_works(solr_parameters)
     ids = scope.current_user.trophies.pluck(:work_id)
     solr_parameters[:fq] ||= []
-    solr_parameters[:fq] += [
-      ActiveFedora::SolrQueryBuilder.construct_query_for_ids(ids)
-    ]
+    solr_parameters[:fq] += [Hyrax::SolrQueryBuilderService.construct_query_for_ids([ids])]
   end
 end

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
@@ -15,7 +16,7 @@ module Hyrax
     # Filters the query to only include the parent collections
     def parent_collections_only(solr_parameters)
       solr_parameters[:fq] ||= []
-      solr_parameters[:fq] << ActiveFedora::SolrQueryBuilder.construct_query_for_ids(child.member_of_collection_ids)
+      solr_parameters[:fq] += [Hyrax::SolrQueryBuilderService.construct_query_for_ids(child.member_of_collection_ids)]
     end
     self.default_processor_chain += [:parent_collections_only]
 

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
@@ -6,7 +7,7 @@ module Hyrax
     # include filters into the query to only include the collections containing this item
     def include_item_ids(solr_parameters)
       solr_parameters[:fq] ||= []
-      solr_parameters[:fq] << ActiveFedora::SolrQueryBuilder.construct_query_for_ids(item.member_of_collection_ids)
+      solr_parameters[:fq] += [Hyrax::SolrQueryBuilderService.construct_query_for_ids([item.member_of_collection_ids])]
     end
   end
 end

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