hyrax 3.0.2 → 3.1.0

data/app/forms/hyrax/forms/collection_form.rb

@@ -18,7 +18,7 @@ module Hyrax
 
       self.model_class = ::Collection
 
-      self.membership_service_class = Collections::CollectionMemberService
+      self.membership_service_class = Collections::CollectionMemberSearchService
 
       delegate :blacklight_config, to: Hyrax::CollectionsController
 
@@ -123,6 +123,11 @@ module Hyrax
         collection_member_service.available_member_subcollections.documents
       end
 
+      ##
+      # @deprecated this implementation requires an extra db round trip, had a
+      #   buggy cacheing mechanism, and was largely duplicative of other code.
+      #   all versions of this code are replaced by
+      #   {CollectionsHelper#available_parent_collections_data}.
       def available_parent_collections(scope:)
         return @available_parents if @available_parents.present?
 
@@ -130,8 +135,7 @@ module Hyrax
         colls = Hyrax::Collections::NestedCollectionQueryService.available_parent_collections(child: collection, scope: scope, limit_to_id: nil)
         @available_parents = colls.map do |col|
           { "id" => col.id, "title_first" => col.title.first }
-        end
-        @available_parents.to_json
+        end.to_json
       end
 
       private

data/app/forms/hyrax/forms/dashboard/nest_collection_form.rb

@@ -32,18 +32,40 @@ module Hyrax
 
         def save
           return false unless valid?
-          persistence_service.persist_nested_collection_for(parent: parent, child: child)
+          persistence_service.persist_nested_collection_for(parent: parent, child: child, user: context.current_user)
         end
 
+        ##
+        # @deprecated this method is unused by hyrax, and is effectively a
+        #   delegation to `Hyrax::Collections::NestedCollectionQueryService`.
+        #   if you want to be sure to use nested indexing to generate this list,
+        #   use the query service directly.
+        #
         # For the given parent, what are all of the available collections that
         # can be added as sub-collection of the parent.
         def available_child_collections
+          Deprecation.warn "#{self.class}#available_child_collections " \
+                           "is deprecated. the helper of the same name or " \
+                           "Hyrax::Collections::NestedCollectionQueryService " \
+                           "instead."
+
           query_service.available_child_collections(parent: parent, scope: context)
         end
 
+        ##
+        # @deprecated this method is unused by hyrax, and is effectively a
+        #   delegation to `Hyrax::Collections::NestedCollectionQueryService`.
+        #   if you want to be sure to use nested indexing to generate this list,
+        #   use the query service directly.
+        #
         # For the given child, what are all of the available collections to
         # which the child can be added as a sub-collection.
         def available_parent_collections
+          Deprecation.warn "#{self.class}#available_parent_collections " \
+                           "is deprecated. the helper of the same name or " \
+                           "Hyrax::Collections::NestedCollectionQueryService " \
+                           "instead."
+
           query_service.available_parent_collections(child: child, scope: context)
         end
 
@@ -61,7 +83,7 @@ module Hyrax
 
         def remove
           if context.can? :edit, parent
-            persistence_service.remove_nested_relationship_for(parent: parent, child: child)
+            persistence_service.remove_nested_relationship_for(parent: parent, child: child, user: context.current_user)
           else
             errors.add(:parent, :cannot_remove_relationship)
             false

data/app/forms/hyrax/forms/file_set_form.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Forms
+    ##
+    # @api public
+    class FileSetForm < Hyrax::ChangeSet
+      include Hyrax::FormFields(:core_metadata)
+
+      class << self
+        ##
+        # @return [Array<Symbol>] list of required field names as symbols
+        def required_fields
+          definitions
+            .select { |_, definition| definition[:required] }
+            .keys.map(&:to_sym)
+        end
+      end
+
+      property :creator, required: true
+      property :license, required: true
+
+      property :based_near
+      property :contributor
+      property :date_created
+      property :description
+      property :identifier
+      property :keyword
+      property :language
+      property :publisher
+      property :related_url
+      property :subject
+
+      property :permissions, virtual: true
+      property :visibility, default: VisibilityIntention::PRIVATE
+
+      # virtual properties for embargo/lease;
+      property :embargo_release_date, virtual: true
+      property :visibility_after_embargo, virtual: true
+      property :visibility_during_embargo, virtual: true
+      property :lease_expiration_date, virtual: true
+      property :visibility_after_lease, virtual: true
+      property :visibility_during_lease, virtual: true
+    end
+  end
+end

data/app/forms/hyrax/forms/permission.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module Hyrax
+  module Forms
+    ##
+    # Nested form for permissions.
+    #
+    # @note due to historical oddities with Hydra::AccessControls and Hydra
+    #   Editor, Hyrax's views rely on `agent_name` and `access` as field
+    #   names. we provide these as virtual fields and prepopulate these from
+    #   `Hyrax::Permission`.
+    class Permission < Hyrax::ChangeSet
+      property :agent_name, virtual: true, prepopulator: ->(_opts) { self.agent_name = model.agent }
+      property :access, virtual: true, prepopulator: ->(_opts) { self.access = model.mode }
+
+      ##
+      # @note support a {#to_hash} method for compatibility with
+      #   {Hydra::AccessControl::Permissions}
+      def to_hash
+        { name: agent_name, access: access }
+      end
+    end
+  end
+end

data/app/forms/hyrax/forms/permission_template_form.rb

@@ -12,7 +12,13 @@ module Hyrax
       # @return [#to_s] the primary key of the associated admin_set or collection
       # def source_id (because you might come looking for this method)
       delegate :id, to: :source_model, prefix: :source
-      delegate :reset_access_controls!, to: :source_model
+
+      ##
+      # @deprecated  use PermissionTemplate#reset_access_controls instead.
+      def reset_access_controls!
+        Deprecation.warn("reset_access_controls! is deprecated; use PermissionTemplate#reset_access_controls instead.")
+        source_model.reset_access_controls!
+      end
 
       # Stores which radio button under release "Varies" option is selected
       attr_accessor :release_varies
@@ -67,7 +73,7 @@ module Hyrax
       # Copy this access to the permissions of the Admin Set or Collection and to
       # the WorkflowResponsibilities of the active workflow if this is an Admin Set
       def update_access(remove_agent: false)
-        reset_access_controls!
+        source_model.reset_access_controls!
         update_workflow_responsibilities(remove_agent: remove_agent) if source_model.is_a?(AdminSet)
       end
 

data/app/forms/hyrax/forms/resource_form.rb

@@ -31,18 +31,6 @@ module Hyrax
     #
     # This form wraps `Hyrax::ChangeSet` in the `HydraEditor::Form` interface.
     class ResourceForm < Hyrax::ChangeSet
-      ##
-      # Nested form for permissions.
-      #
-      # @note due to historical oddities with Hydra::AccessControls and Hydra
-      #   Editor, Hyrax's views rely on `agent_name` and `access` as field
-      #   names. we provide these as virtual fields and prepopulate these from
-      #   `Hyrax::Permission`.
-      class Permission < Hyrax::ChangeSet
-        property :agent_name, virtual: true, prepopulator: ->(_opts) { self.agent_name = model.agent }
-        property :access, virtual: true, prepopulator: ->(_opts) { self.access = model.mode }
-      end
-
       ##
       # @api private
       InWorksPopulator = lambda do |_options|
@@ -94,7 +82,7 @@ module Hyrax
       collection(:permissions,
                  virtual: true,
                  default: [],
-                 form: Permission,
+                 form: Hyrax::Forms::Permission,
                  populator: :permission_populator,
                  prepopulator: ->(_opts) { self.permissions = Hyrax::AccessControl.for(resource: model).permissions })
 
@@ -136,10 +124,15 @@ module Hyrax
         # @example
         #   monograph  = Monograph.new
         #   change_set = Hyrax::Forms::ResourceForm.for(monograph)
-        def for(work)
-          "#{work.class}Form".constantize.new(work)
+        def for(resource)
+          "#{resource.class.name}Form".constantize.new(resource)
         rescue NameError => _err
-          Hyrax::Forms::ResourceForm(work.class).new(work)
+          case resource
+          when Hyrax::FileSet
+            Hyrax::Forms::FileSetForm.new(resource)
+          else
+            Hyrax::Forms::ResourceForm(resource.class).new(resource)
+          end
         end
 
         ##
@@ -208,7 +201,7 @@ module Hyrax
 
       # https://trailblazer.to/2.1/docs/reform.html#reform-populators-populator-collections
       def permission_populator(collection:, index:, **)
-        Permission.new(collection[index])
+        Hyrax::Forms::Permission.new(collection[index])
       end
 
       def _form_field_definitions

data/app/forms/hyrax/forms/work_form.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
-# rubocop:disable Metrics/ClassLength
 module Hyrax
   module Forms
     # @abstract
-    class WorkForm
+    class WorkForm # rubocop:disable Metrics/ClassLength
       include HydraEditor::Form
       include HydraEditor::Form::Permissions
       attr_accessor :current_ability
@@ -176,6 +175,10 @@ module Hyrax
             based_near_attributes: [:id, :_destroy],
             member_of_collections_attributes: [:id, :_destroy],
             work_members_attributes: [:id, :_destroy]
+          },
+          {
+            file_set: [:visibility, :visibility_during_embargo, :embargo_release_date, :visibility_after_embargo,
+                       :visibility_during_lease, :lease_expiration_date, :visibility_after_lease, :uploaded_file_id]
           }
         ]
       end

data/app/helpers/hyrax/batch_edits_helper.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
-# View Helpers for Hydra Batch Edit functionality
+
 module Hyrax
+  ##
+  # View Helpers for Hydra Batch Edit functionality
   module BatchEditsHelper
     # Displays the delete button for batch editing
     def batch_delete

data/app/helpers/hyrax/collections_helper.rb

@@ -1,6 +1,29 @@
 # frozen_string_literal: true
 module Hyrax
-  module CollectionsHelper
+  module CollectionsHelper # rubocop:disable Metrics/ModuleLength
+    ##
+    # @since 3.1.0
+    # @return [Array<SolrDocument>]
+    def available_child_collections(collection:)
+      Hyrax::Collections::NestedCollectionQueryService
+        .available_child_collections(parent: collection, scope: controller, limit_to_id: nil)
+    end
+
+    ##
+    # @since 3.1.0
+    #
+    # @note provides data for handleAddToCollection javascript
+    #
+    # @return [String] JSON document containing id/title pairs for eligible
+    #   parent collections to be displayed in an "Add to Collection" dropdown
+    def available_parent_collections_data(collection:)
+      Hyrax::Collections::NestedCollectionQueryService
+        .available_parent_collections(child: collection, scope: controller, limit_to_id: nil)
+        .map do |result|
+        { "id" => result.id, "title_first" => result.title.first }
+      end.to_json
+    end
+
     ##
     # @since 3.0.0
     # @return [#to_s]
@@ -97,6 +120,69 @@ module Hyrax
       single_item_action_form_fields(form, document, 'remove')
     end
 
+    ##
+    # @param collection [Object]
+    def collection_type_label_for(collection:)
+      case collection
+      when Valkyrie::Resource
+        CollectionType
+          .find_by_gid!(collection.collection_type_gid)
+          .title
+      else
+        collection.collection_type.title
+      end
+    end
+
+    ##
+    # @param collection [Object]
+    #
+    # @return [Boolean]
+    def collection_brandable?(collection:)
+      case collection
+      when Valkyrie::Resource
+        CollectionType
+          .find_by_gid!(collection.collection_type_gid)
+          .brandable?
+      else
+        collection.try(:brandable?)
+      end
+    end
+
+    ##
+    # @param collection [Object]
+    #
+    # @return [Boolean]
+    def collection_discoverable?(collection:)
+      case collection
+      when Valkyrie::Resource
+        CollectionType
+          .find_by_gid!(collection.collection_type_gid)
+          .discoverable?
+      else
+        collection.try(:discoverable?)
+      end
+    end
+
+    ##
+    # @param collection [Object]
+    #
+    # @return [Boolean]
+    def collection_sharable?(collection:)
+      case collection
+      when Valkyrie::Resource
+        CollectionType
+          .find_by_gid!(collection.collection_type_gid)
+          .sharable?
+      else
+        collection.try(:sharable?)
+      end
+    end
+
+    ##
+    # @note this helper is primarily intended for use with blacklight facet
+    #   fields. it assumes we index a `collection_type_gid` and the helper
+    #   can be passed as as a `helper_method:` to `add_facet_field`.
+    #
     # @param collection_type_gid [String] The gid of the CollectionType to be looked up
     # @return [String] The CollectionType's title if found, else the gid
     def collection_type_label(collection_type_gid)
@@ -112,4 +198,4 @@ module Hyrax
       render 'hyrax/dashboard/collections/single_item_action_fields', form: form, document: document, action: action
     end
   end
-end
+end # rubocop:enable Metrics/ModuleLength

data/app/helpers/hyrax/dashboard_helper_behavior.rb

@@ -12,7 +12,7 @@ module Hyrax
     def number_of_works(user = current_user, where: { generic_type_sim: "Work" })
       field_pairs = field_pairs(user)
       field_pairs.merge!(where)
-      count(Hyrax::SolrQueryBuilderService.construct_query(field_pairs))
+      Hyrax::SolrQueryService.new.with_field_pairs(field_pairs: field_pairs).count
     rescue RSolr::Error::ConnectionRefused
       'n/a'
     end
@@ -20,7 +20,7 @@ module Hyrax
     # @param user [User]
     # @return [Integer] number of FileSets the user deposited
     def number_of_files(user = current_user)
-      count(Hyrax::SolrQueryBuilderService.construct_query_for_model(::FileSet, field_pairs(user)))
+      Hyrax::SolrQueryService.new.with_field_pairs(field_pairs: field_pairs(user)).count
     rescue RSolr::Error::ConnectionRefused
       'n/a'
     end
@@ -28,7 +28,7 @@ module Hyrax
     # @param user [User]
     # @return [Integer] number of Collections the user created
     def number_of_collections(user = current_user)
-      count(Hyrax::SolrQueryBuilderService.construct_query_for_model(::Collection, field_pairs(user)))
+      Hyrax::SolrQueryService.new.with_field_pairs(field_pairs: field_pairs(user)).count
     rescue RSolr::Error::ConnectionRefused
       'n/a'
     end
@@ -38,9 +38,5 @@ module Hyrax
     def field_pairs(user)
       { DepositSearchBuilder.depositor_field => user.user_key }
     end
-
-    def count(query)
-      Hyrax::SolrService.count(query)
-    end
   end
 end

data/app/helpers/hyrax/file_set_helper.rb

@@ -1,5 +1,18 @@
 # frozen_string_literal: true
 module Hyrax::FileSetHelper
+  ##
+  # @todo inline the "workflow restriction" into the `can?(:download)` check.
+  #
+  # @param file_set [#id]
+  #
+  # @return [Boolean] whether to display the download link for the given file
+  #   set
+  def display_media_download_link?(file_set:)
+    Hyrax.config.display_media_download_link? &&
+      can?(:download, file_set) &&
+      !workflow_restriction?(file_set.try(:parent))
+  end
+
   def parent_path(parent)
     if parent.is_a?(::Collection)
       main_app.collection_path(parent)
@@ -8,12 +21,19 @@ module Hyrax::FileSetHelper
     end
   end
 
-  # REVIEW: Since this media display could theoretically work for
-  #         any object that inplements to_s and the Mime Type methos (image? audio? ...),
-  #         Should this really be in file_set or could it be in it's own helper class like media_helper?
+  ##
+  # @deprecated use render(media_display_partial(file_set), file_set: file_set)
+  #   instead
+  #
+  # @param presenter [Object]
+  # @param locals [Hash{Symbol => Object}]
   def media_display(presenter, locals = {})
-    render media_display_partial(presenter),
-           locals.merge(file_set: presenter)
+    Deprecation.warn("the helper `media_display` renders a partial name " \
+                     "provided by `media_display_partial`. Callers " \
+                     "should render `media_display_partial(file_set) directly
+                     instead.")
+
+    render(media_display_partial(presenter), locals.merge(file_set: presenter))
   end
 
   def media_display_partial(file_set)
@@ -32,5 +52,4 @@ module Hyrax::FileSetHelper
         'default'
       end
   end
-  # rubocop:enable Metrics/MethodLength
 end