hyrax 2.0.3 → 2.1.0.beta1

data/app/models/concerns/hyrax/ability/admin_set_ability.rb

@@ -0,0 +1,40 @@
+module Hyrax
+  module Ability
+    module AdminSetAbility
+      def admin_set_abilities # rubocop:disable Metrics/MethodLength
+        if admin?
+          can :manage, AdminSet
+          can :manage_any, AdminSet
+          can :create_any, AdminSet
+          can :view_admin_show_any, AdminSet
+        else
+          can :manage_any, AdminSet if Hyrax::Collections::PermissionsService.can_manage_any_admin_set?(ability: self)
+          can :create_any, AdminSet if Hyrax::CollectionTypes::PermissionsService.can_create_admin_set_collection_type?(ability: self)
+          can :view_admin_show_any, AdminSet if Hyrax::Collections::PermissionsService.can_view_admin_show_for_any_admin_set?(ability: self)
+
+          can [:edit, :update, :destroy], AdminSet do |admin_set| # for test by solr_doc, see solr_document_ability.rb
+            test_edit(admin_set.id)
+          end
+
+          can :deposit, AdminSet do |admin_set| # for test by solr_doc, see collection_ability.rb
+            Hyrax::Collections::PermissionsService.can_deposit_in_collection?(ability: self, collection_id: admin_set.id)
+          end
+
+          can :view_admin_show, AdminSet do |admin_set| # admin show page # for test by solr_doc, see collection_ability.rb
+            Hyrax::Collections::PermissionsService.can_view_admin_show_for_collection?(ability: self, collection_id: admin_set.id)
+          end
+
+          # TODO: I don't think these are needed anymore since there isn't a public show page.  Should be checking :view_admin_show ability
+          can :read, AdminSet do |admin_set| # for test by solr_doc, see solr_document_ability.rb
+            test_read(admin_set.id)
+          end
+        end
+
+        # TODO: I'm not sure why this is checked with AdminSet abilities.  It was before the refactor and since I'm not sure what the connection is, I left it here.
+        can :review, :submissions do
+          can_review_submissions?
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/hyrax/ability/collection_ability.rb

@@ -0,0 +1,40 @@
+module Hyrax
+  module Ability
+    module CollectionAbility
+      def collection_abilities # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        if admin?
+          can :manage, Collection
+          can :manage_any, Collection
+          can :create_any, Collection
+          can :view_admin_show_any, Collection
+        else
+          can :manage_any, Collection if Hyrax::Collections::PermissionsService.can_manage_any_collection?(ability: self)
+          can :create_any, Collection if Hyrax::CollectionTypes::PermissionsService.can_create_any_collection_type?(ability: self)
+          can :view_admin_show_any, Collection if Hyrax::Collections::PermissionsService.can_view_admin_show_for_any_collection?(ability: self)
+
+          can [:edit, :update, :destroy], Collection do |collection| # for test by solr_doc, see solr_document_ability.rb
+            test_edit(collection.id)
+          end
+
+          can :deposit, Collection do |collection|
+            Hyrax::Collections::PermissionsService.can_deposit_in_collection?(ability: self, collection_id: collection.id)
+          end
+          can :deposit, ::SolrDocument do |solr_doc|
+            Hyrax::Collections::PermissionsService.can_deposit_in_collection?(ability: self, collection_id: solr_doc.id) # checks collections and admin_sets
+          end
+
+          can :view_admin_show, Collection do |collection| # admin show page
+            Hyrax::Collections::PermissionsService.can_view_admin_show_for_collection?(ability: self, collection_id: collection.id)
+          end
+          can :view_admin_show, ::SolrDocument do |solr_doc| # admin show page
+            Hyrax::Collections::PermissionsService.can_view_admin_show_for_collection?(ability: self, collection_id: solr_doc.id) # checks collections and admin_sets
+          end
+
+          can :read, Collection do |collection| # public show page  # for test by solr_doc, see solr_document_ability.rb
+            test_read(collection.id)
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/hyrax/ability/collection_type_ability.rb

@@ -0,0 +1,16 @@
+module Hyrax
+  module Ability
+    module CollectionTypeAbility
+      def collection_type_abilities
+        if admin?
+          can :manage, CollectionType
+          can :create_collection_type, CollectionType
+        else
+          can :create_collection_of_type, CollectionType do |collection_type|
+            Hyrax::CollectionTypes::PermissionsService.can_create_collection_of_type?(user: current_user, collection_type: collection_type)
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/hyrax/ability/permission_template_ability.rb

@@ -0,0 +1,18 @@
+module Hyrax
+  module Ability
+    module PermissionTemplateAbility
+      def permission_template_abilities
+        if admin?
+          can :manage, [Hyrax::PermissionTemplate, Hyrax::PermissionTemplateAccess]
+        else
+          can [:create, :edit, :update, :destroy], Hyrax::PermissionTemplate do |template|
+            test_edit(template.source_id)
+          end
+          can [:create, :edit, :update, :destroy], Hyrax::PermissionTemplateAccess do |access|
+            test_edit(access.permission_template.source_id)
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/hyrax/ability/solr_document_ability.rb

@@ -0,0 +1,18 @@
+module Hyrax
+  module Ability
+    module SolrDocumentAbility
+      def solr_document_abilities
+        if admin?
+          can [:manage], ::SolrDocument
+        else
+          can [:edit, :update, :destroy], ::SolrDocument do |solr_doc|
+            test_edit(solr_doc.id)
+          end
+          can :read, ::SolrDocument do |solr_doc|
+            test_read(solr_doc.id)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -10,10 +10,43 @@ module Hyrax
     include Hyrax::HumanReadableType
     include Hyrax::HasRepresentative
     include Hyrax::Permissions
+    include Hyrax::CollectionNesting
 
     included do
       validates_with HasOneTitleValidator
+      after_destroy :destroy_permission_template
+
       self.indexer = Hyrax::CollectionIndexer
+
+      class_attribute :index_collection_type_gid_as, writer: false
+      self.index_collection_type_gid_as = [:symbol]
+
+      property :collection_type_gid, predicate: ::RDF::Vocab::SCHEMA.additionalType, multiple: false do |index|
+        index.as(*index_collection_type_gid_as)
+      end
+
+      # validates that collection_type_gid is present
+      validates :collection_type_gid, presence: true
+
+      # Need to define here in order to override setter defined by ActiveTriples
+      def collection_type_gid=(new_collection_type_gid)
+        raise "Can't modify collection type of this collection" if persisted? && !collection_type_gid_was.nil? && collection_type_gid_was != new_collection_type_gid
+        new_collection_type = Hyrax::CollectionType.find_by_gid!(new_collection_type_gid)
+        super
+        @collection_type = new_collection_type
+        collection_type_gid
+      end
+    end
+
+    delegate(*Hyrax::CollectionType.collection_type_settings_methods, to: :collection_type)
+
+    # Get the collection_type when accessed
+    def collection_type
+      @collection_type ||= Hyrax::CollectionType.find_by_gid!(collection_type_gid)
+    end
+
+    def collection_type=(new_collection_type)
+      self.collection_type_gid = new_collection_type.gid
     end
 
     # Add members using the members association.
@@ -24,10 +57,16 @@ module Hyrax
 
     # Add member objects by adding this collection to the objects' member_of_collection association.
     def add_member_objects(new_member_ids)
-      Array(new_member_ids).each do |member_id|
+      Array(new_member_ids).collect do |member_id|
         member = ActiveFedora::Base.find(member_id)
-        member.member_of_collections << self
-        member.save!
+        message = Hyrax::MultipleMembershipChecker.new(item: member).check(collection_ids: id, include_current_members: true)
+        if message
+          member.errors.add(:collections, message)
+        else
+          member.member_of_collections << self
+          member.save!
+        end
+        member
       end
     end
 
@@ -48,6 +87,10 @@ module Hyrax
           "hyrax/#{collection}/#{element}".freeze
         end
       end
+
+      def collection_type_gid_document_field_name
+        Solrizer.solr_name('collection_type_gid', *index_collection_type_gid_as)
+      end
     end
 
     # Compute the sum of each file in the collection using Solr to
@@ -71,8 +114,42 @@ module Hyrax
       ActiveFedora::Base.search_with_conditions("member_of_collection_ids_ssim:#{id}").map(&:id)
     end
 
+    # @api public
+    # Retrieve the permission template for this collection.
+    # @return [Hyrax::PermissionTemplate]
+    # @raise [ActiveRecord::RecordNotFound]
+    def permission_template
+      Hyrax::PermissionTemplate.find_by!(source_id: id)
+    end
+
+    # Calculate and update who should have read/edit access to the collections based on who
+    # has access in PermissionTemplateAccess
+    def reset_access_controls!
+      edit_users = permission_template.agent_ids_for(access: 'manage', agent_type: 'user')
+      edit_groups = permission_template.agent_ids_for(access: 'manage', agent_type: 'group')
+      read_users = permission_template.agent_ids_for(access: 'view', agent_type: 'user') +
+                   permission_template.agent_ids_for(access: 'deposit', agent_type: 'user')
+      read_groups = (permission_template.agent_ids_for(access: 'view', agent_type: 'group') +
+                     permission_template.agent_ids_for(access: 'deposit', agent_type: 'group') +
+                     visibility_group).uniq
+      update!(edit_users: edit_users,
+              edit_groups: edit_groups,
+              read_users: read_users,
+              read_groups: read_groups)
+      # added because the collection indexing happens before Hydra::AccessControls::Permission is
+      # saved, and the after_update_index callback in the nested_relationship_reindexer removes the
+      # permissions from the Solr document.
+      update_index
+    end
+
     private
 
+      def visibility_group
+        return [Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC] if visibility == Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC
+        return [Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_AUTHENTICATED] if visibility == Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
+        []
+      end
+
       # Calculate the size of all the files in the work
       # @param work_id [String] identifer for a work
       # @return [Integer] the size in bytes
@@ -93,5 +170,11 @@ module Hyrax
       def member_ids_field
         Solrizer.solr_name('member_ids', :symbol)
       end
+
+      def destroy_permission_template
+        permission_template.destroy
+      rescue ActiveRecord::RecordNotFound
+        true
+      end
   end
 end

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

@@ -0,0 +1,41 @@
+module Hyrax
+  # Responsible for adding the necessary callbacks for updating the nested collection information
+  # This is part of the after update index because it is a potentially very expensive process.
+  #
+  # @todo Consider extracting the update_index callback to ActiveFedora::Base
+  module CollectionNesting
+    extend ActiveSupport::Concern
+
+    included do
+      extend ActiveModel::Callbacks
+      include ActiveModel::Validations::Callbacks
+
+      define_model_callbacks :update_index, only: :after
+      after_update_index :update_nested_collection_relationship_indices
+      after_destroy :update_child_nested_collection_relationship_indices
+
+      def update_nested_collection_relationship_indices
+        Hyrax.config.nested_relationship_reindexer.call(id: id)
+      end
+
+      def update_child_nested_collection_relationship_indices
+        children = find_children_of(destroyed_id: id)
+        children.each do |child|
+          Hyrax.config.nested_relationship_reindexer.call(id: child.id)
+        end
+      end
+    end
+
+    def update_index(*args)
+      _run_update_index_callbacks { super }
+    end
+
+    def find_children_of(destroyed_id:)
+      ActiveFedora::SolrService.query(ActiveFedora::SolrQueryBuilder.construct_query(member_of_collection_ids_ssim: destroyed_id))
+    end
+
+    def use_nested_reindexing?
+      true
+    end
+  end
+end

data/app/models/concerns/hyrax/file_set/belongs_to_works.rb

@@ -3,10 +3,6 @@ module Hyrax
     module BelongsToWorks
       extend ActiveSupport::Concern
 
-      included do
-        before_destroy :remove_representative_relationship
-      end
-
       def parents
         in_works
       end
@@ -33,17 +29,6 @@ module Hyrax
           end
         end
       end
-
-      # If any parent objects are pointing at this object as their
-      # representative, remove that pointer.
-      def remove_representative_relationship
-        parent_objects = parents
-        return if parent_objects.empty?
-        parent_objects.each do |work|
-          work.update(representative_id: nil) if work.representative_id == id
-        end
-      end
     end
   end
 end
-\

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

@@ -22,7 +22,6 @@ module Hyrax
 
     included do
       attr_accessor :file
-      self.human_readable_type = 'File'
     end
 
     def representative_id

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

@@ -0,0 +1,11 @@
+module Hyrax::HasRendering
+  extend ActiveSupport::Concern
+
+  included do
+    # rubocop:disable Rails/HasAndBelongsToMany
+    has_and_belongs_to_many :renderings,
+                            predicate: Hyrax.config.rendering_predicate,
+                            class_name: 'ActiveFedora::Base'
+    # rubocop:enable Rails/HasAndBelongsToMany
+  end
+end

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

@@ -11,6 +11,9 @@ module Hyrax
       def human_readable_type=(val)
         @_human_readable_type = val
       end
+      deprecation_deprecate :human_readable_type= => 'human_readable_type is deprecated. ' \
+        'Set the i18n key for activefedora.models.#{model_name.i18n_key} instead. ' \
+        'This will be removed in Hyrax 3'
     end
 
     def human_readable_type

data/app/models/concerns/hyrax/solr_document/metadata.rb

@@ -71,6 +71,8 @@ module Hyrax
         attribute :workflow_state, Solr::String, solr_name('workflow_state_name', :symbol)
         attribute :human_readable_type, Solr::String, solr_name('human_readable_type', :stored_searchable)
         attribute :representative_id, Solr::String, solr_name('hasRelatedMediaFragment', :symbol)
+        # extract the term name from the rendering_predicate (it might be after the final / or #)
+        attribute :rendering_ids, Solr::Array, solr_name(Hyrax.config.rendering_predicate.value.split(/#|\/|,/).last, :symbol)
         attribute :thumbnail_id, Solr::String, solr_name('hasRelatedImage', :symbol)
         attribute :thumbnail_path, Solr::String, CatalogController.blacklight_config.index.thumbnail_field
         attribute :label, Solr::String, solr_name('label')
@@ -80,6 +82,7 @@ module Hyrax
         attribute :date_modified, Solr::Date, solr_name('date_modified', :stored_sortable, type: :date)
         attribute :date_uploaded, Solr::Date, solr_name('date_uploaded', :stored_sortable, type: :date)
         attribute :create_date, Solr::Date, solr_name('system_create', :stored_sortable, type: :date)
+        attribute :modified_date, Solr::Date, solr_name('system_modified', :stored_sortable, type: :date)
         attribute :embargo_release_date, Solr::Date, Hydra.config.permissions.embargo.release_date
         attribute :lease_expiration_date, Solr::Date, Hydra.config.permissions.lease.expiration_date
       end

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

@@ -1,5 +1,3 @@
-# -*- encoding : utf-8 -*-
-
 module Hyrax
   module SolrDocumentBehavior
     extend ActiveSupport::Concern
@@ -67,6 +65,10 @@ module Hyrax
       hydra_model == ::Collection
     end
 
+    def admin_set?
+      hydra_model == ::AdminSet
+    end
+
     # Method to return the ActiveFedora model
     def hydra_model
       first(Solrizer.solr_name('has_model', :symbol)).constantize
@@ -99,5 +101,9 @@ module Hyrax
                         Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE
                       end
     end
+
+    def collection_type_gid
+      first('collection_type_gid_ssim')
+    end
   end
 end

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

@@ -16,13 +16,17 @@ module Hyrax::User
     acts_as_messageable
 
     # Set up proxy-related relationships
-    has_many :proxy_deposit_requests, foreign_key: 'receiving_user_id'
+    has_many :proxy_deposit_requests,
+             foreign_key: 'receiving_user_id',
+             dependent: :destroy
     has_many :deposit_rights_given, foreign_key: 'grantor_id', class_name: 'ProxyDepositRights', dependent: :destroy
     has_many :can_receive_deposits_from, through: :deposit_rights_given, source: :grantee
     has_many :deposit_rights_received, foreign_key: 'grantee_id', class_name: 'ProxyDepositRights', dependent: :destroy
     has_many :can_make_deposits_for, through: :deposit_rights_received, source: :grantor
 
-    has_many :job_io_wrappers, inverse_of: 'user'
+    has_many :job_io_wrappers,
+             inverse_of: 'user',
+             dependent: :destroy
 
     scope :guests, ->() { where(guest: true) }
     scope :registered, ->() { where(guest: false) }
@@ -39,7 +43,8 @@ module Hyrax::User
     # Add token to authenticate Arkivo API calls
     after_initialize :set_arkivo_token, unless: :persisted? if Hyrax.config.arkivo_api?
 
-    has_many :trophies
+    has_many :trophies,
+             dependent: :destroy
     has_one :sipity_agent, as: :proxy_for, dependent: :destroy, class_name: 'Sipity::Agent'
   end
 
@@ -107,10 +112,10 @@ module Hyrax::User
     { id: user_key, text: display_name ? "#{display_name} (#{user_key})" : user_key }
   end
 
+  ##
+  # @return [String] a name for the user
   def name
-    display_name.titleize || raise
-  rescue
-    user_key
+    display_name || user_key
   end
 
   # Redefine this for more intuitive keys in Redis