hyrax 3.4.2 → 4.0.0.beta2

data/app/controllers/hyrax/dashboard/nest_collections_controller.rb

@@ -70,38 +70,6 @@ module Hyrax
 
       private
 
-      ##
-      # @deprecated
-      def build_within_form
-        authorize! :read, form_params[:child_id]
-        form_class.new(context: self, **form_params.to_h.symbolize_keys)
-      end
-      deprecation_deprecate :build_within_form
-
-      ##
-      # @deprecated
-      def build_under_form
-        authorize! :read, form_params[:parent_id]
-        form_class.new(context: self, **form_params.to_h.symbolize_keys)
-      end
-      deprecation_deprecate :build_under_form
-
-      ##
-      # @deprecated
-      def build_create_collection_form
-        authorize! :deposit, form_params[:parent_id]
-        form_class.new(context: self, **form_params.to_h.symbolize_keys)
-      end
-      deprecation_deprecate :build_create_collection_form
-
-      ##
-      # @deprecated
-      def build_remove_form
-        authorize! :edit, form_params[:parent_id]
-        form_class.new(context: self, **form_params.to_h.symbolize_keys)
-      end
-      deprecation_deprecate :build_create_collection_form
-
       ##
       # @api public
       # @since 3.2.0

data/app/controllers/hyrax/file_sets_controller.rb

@@ -10,6 +10,10 @@ module Hyrax
     before_action :authenticate_user!, except: [:show, :citation, :stats]
     load_and_authorize_resource class: ::FileSet, except: :show
     before_action :build_breadcrumbs, only: [:show, :edit, :stats]
+    before_action do
+      blacklight_config.track_search_session = false
+    end
+    before_action :presenter
 
     # provides the help_text view method
     helper PermissionsHelper

data/app/controllers/hyrax/homepage_controller.rb

@@ -2,7 +2,6 @@
 class Hyrax::HomepageController < ApplicationController
   # Adds Hydra behaviors into the application controller
   include Blacklight::SearchContext
-  include Blacklight::SearchHelper
   include Blacklight::AccessControls::Catalog
 
   class_attribute :presenter_class

data/app/controllers/hyrax/my/collections_controller.rb

@@ -12,6 +12,7 @@ module Hyrax
           config.add_facet_field Hyrax.config.collection_type_index_field,
                                  helper_method: :collection_type_label, limit: 5,
                                  pivot: ['has_model_ssim', Hyrax.config.collection_type_index_field],
+                                 skip_item: ->(item) { item.value == "Collection" },
                                  label: I18n.t('hyrax.dashboard.my.heading.collection_type')
           # This causes AdminSets to also be shown with the Collection Type label
           config.add_facet_field 'has_model_ssim',

data/app/controllers/hyrax/my/works_controller.rb

@@ -7,7 +7,7 @@ module Hyrax
         configure_blacklight do |config|
           config.search_builder_class = Hyrax::My::WorksSearchBuilder
           config.add_facet_field "admin_set_sim", limit: 5
-          config.add_facet_field "member_of_collections_ssim", limit: 5
+          config.add_facet_field "member_of_collections_ssim", limit: 1
         end
       end
       configure_facets

data/app/controllers/hyrax/my_controller.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 module Hyrax
   class MyController < ApplicationController
-    extend Deprecation
     include Hydra::Catalog
     include Hyrax::Collections::AcceptsBatches
 
@@ -63,11 +62,6 @@ module Hyrax
       @add_works_to_collection_label = params.fetch(:add_works_to_collection_label, '')
     end
 
-    def query_solr
-      search_service.search_results
-    end
-    deprecation_deprecate :query_solr
-
     def search_service
       Hyrax::SearchService.new(config: blacklight_config, user_params: params, scope: self)
     end

data/app/controllers/hyrax/permissions_controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module Hyrax
   class PermissionsController < ApplicationController
-    load_resource class: ActiveFedora::Base, instance_name: :curation_concern
+    load_resource class: Hyrax::Resource, instance_name: :curation_concern
 
     attr_reader :curation_concern
     helper_method :curation_concern

data/app/controllers/hyrax/single_use_links_controller.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 module Hyrax
   class SingleUseLinksController < ApplicationController
-    include Blacklight::SearchHelper
     class_attribute :show_presenter
     self.show_presenter = Hyrax::SingleUseLinkPresenter
     before_action :authenticate_user!
@@ -45,7 +44,7 @@ module Hyrax
     end
 
     def asset_show_path
-      polymorphic_path([main_app, fetch(params[:id]).last])
+      polymorphic_path([main_app, search_service.fetch(params[:id]).last])
     end
   end
 end

data/app/controllers/hyrax/transfers_controller.rb

@@ -23,7 +23,6 @@ module Hyrax
       add_breadcrumb t(:'hyrax.controls.home'), root_path
       add_breadcrumb t(:'hyrax.dashboard.breadcrumbs.admin'), hyrax.dashboard_path
       add_breadcrumb t(:'hyrax.transfers.new.header'), hyrax.new_work_transfer_path
-      @work = Hyrax::WorkRelation.new.find(params[:id])
     end
 
     def create
@@ -31,7 +30,6 @@ module Hyrax
       if @proxy_deposit_request.save
         redirect_to hyrax.transfers_path, notice: "Transfer request created"
       else
-        @work = Hyrax::WorkRelation.new.find(params[:id])
         render :new
       end
     end

data/app/forms/hyrax/forms/batch_upload_form.rb

@@ -30,7 +30,7 @@ module Hyrax
       # Override of ActiveModel::Model name that allows us to use our custom name class
       def self.model_name
         @_model_name ||= begin
-          namespace = parents.detect do |n|
+          namespace = module_parents.detect do |n|
             n.respond_to?(:use_relative_model_naming?) && n.use_relative_model_naming?
           end
           Name.new(model_class, namespace)

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

@@ -9,7 +9,7 @@ module Hyrax
       attr_reader :scope
 
       delegate :id, :depositor, :permissions, :human_readable_type, :member_ids, :nestable?,
-               :alternative_title, :visibility, to: :model
+               :alternative_title, to: :model
 
       class_attribute :membership_service_class
 

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

@@ -38,7 +38,6 @@ module Hyrax
         validates :parent, presence: true
         validates :child, presence: true
         validate :parent_and_child_can_be_nested
-        validate :nesting_within_maximum_depth
 
         def save
           return false unless valid?
@@ -83,12 +82,11 @@ module Hyrax
         # rerouting to new_dashboard_collection_path to add the new collection as
         # a child. Since we don't yet have a child collection, the valid? option can't be used here.
         def validate_add
-          if nestable?(parent)
-            nesting_within_maximum_depth
-          else
+          unless nestable?(parent)
             errors.add(:parent, :cannot_have_child_nested)
-            false
+            return false
           end
+          true
         end
 
         def remove
@@ -104,17 +102,6 @@ module Hyrax
 
         attr_accessor :query_service, :persistence_service, :context, :collection
 
-        # ideally we would love to be able to eliminate collections which exceed the
-        # maximum nesting depth from the lists of available collections, but the queries
-        # needed to make the determination are too expensive to do for every possible
-        # collection, so we only test for this situation prior to saving the new
-        # relationship.
-        def nesting_within_maximum_depth
-          return true if query_service.valid_combined_nesting_depth?(parent: parent, child: child, scope: context)
-          errors.add(:collection, :exceeds_maximum_nesting_depth)
-          false
-        end
-
         def parent_and_child_can_be_nested
           if nestable?(parent) && nestable?(child)
             return true if query_service.parent_and_child_can_nest?(parent: parent, child: child, scope: context)
@@ -137,8 +124,7 @@ module Hyrax
         def nestable?(collection)
           return false if collection.blank?
           return collection.nestable? if collection.respond_to? :nestable?
-          collection_type = Hyrax::CollectionType.find_by_gid!(collection.collection_type_gid)
-          collection_type.nestable?
+          Hyrax::CollectionType.for(collection: collection).nestable?
         end
       end
     end

data/app/forms/hyrax/forms/embargo.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module Hyrax
+  module Forms
+    ##
+    # Nested form for embargos.
+    class Embargo < Hyrax::ChangeSet
+      property :visibility_after_embargo
+      property :visibility_during_embargo
+      property :embargo_release_date
+      property :embargo_history, default: []
+    end
+  end
+end

data/app/forms/hyrax/forms/lease.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module Hyrax
+  module Forms
+    ##
+    # Nested form for leases.
+    class Lease < Hyrax::ChangeSet
+      property :visibility_after_lease
+      property :visibility_during_lease
+      property :lease_expiration_date
+      property :lease_history, default: []
+    end
+  end
+end

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

@@ -72,7 +72,7 @@ module Hyrax
       property :on_behalf_of
       property :proxy_depositor
 
-      property :visibility, default: VisibilityIntention::PRIVATE
+      property :visibility, default: VisibilityIntention::PRIVATE, populator: :visibility_populator
 
       property :date_modified, readable: false
       property :date_uploaded, readable: false
@@ -85,6 +85,9 @@ module Hyrax
                  populator: :permission_populator,
                  prepopulator: ->(_opts) { self.permissions = Hyrax::AccessControl.for(resource: model).permissions })
 
+      property :embargo, form: Hyrax::Forms::Embargo, populator: :embargo_populator
+      property :lease, form: Hyrax::Forms::Lease, populator: :lease_populator
+
       # virtual properties for embargo/lease;
       property :embargo_release_date, virtual: true, prepopulator: ->(_opts) { self.embargo_release_date = model.embargo&.embargo_release_date }
       property :visibility_after_embargo, virtual: true, prepopulator: ->(_opts) { self.visibility_after_embargo = model.embargo&.visibility_after_embargo }
@@ -208,6 +211,14 @@ module Hyrax
 
       private
 
+      def embargo_populator(**)
+        self.embargo = Hyrax::EmbargoManager.embargo_for(resource: model)
+      end
+
+      def lease_populator(**)
+        self.lease = Hyrax::LeaseManager.lease_for(resource: model)
+      end
+
       def in_collections_populator(fragment:, **_options)
         adds = []
         deletes = []
@@ -227,6 +238,24 @@ module Hyrax
         Hyrax::Forms::Permission.new(collection[index])
       end
 
+      def visibility_populator(fragment:, doc:, **)
+        case fragment
+        when "embargo"
+          self.visibility = doc['visibility_during_embargo']
+
+          doc['embargo'] = doc.slice('visibility_after_embargo',
+                                     'visibility_during_embargo',
+                                     'embargo_release_date')
+        when "lease"
+          self.visibility = doc['visibility_during_lease']
+          doc['lease'] = doc.slice('visibility_after_lease',
+                                     'visibility_during_lease',
+                                     'lease_expiration_date')
+        else
+          self.visibility = fragment
+        end
+      end
+
       def _form_field_definitions
         self.class.definitions
       end

data/app/forms/hyrax/forms/work_embargo_form.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Forms
+    ##
+    # Represents an embargo for edit through a work. That is, this form can
+    # be used to wrap a Work in order to capture state changes related only to
+    # its embargo, ignoring the work's other fields.
+    #
+    # @note this supports the edit functionality of
+    #   +EmbargoesControllerBehavior+.
+    class WorkEmbargoForm < Hyrax::ChangeSet
+      property :embargo, form: Hyrax::Forms::Embargo, populator: :embargo_populator, prepopulator: :embargo_populator
+      property :embargo_release_date, virtual: true, prepopulator: ->(_opts) { self.embargo_release_date = model.embargo&.embargo_release_date }
+      property :visibility_after_embargo, virtual: true, prepopulator: ->(_opts) { self.visibility_after_embargo = model.embargo&.visibility_after_embargo }
+      property :visibility_during_embargo, virtual: true, prepopulator: ->(_opts) { self.visibility_during_embargo = model.embargo&.visibility_during_embargo }
+
+      def embargo_populator(**)
+        self.embargo = Hyrax::EmbargoManager.embargo_for(resource: model)
+      end
+
+      ##
+      # @return [String]
+      def human_readable_type
+        model.to_model.human_readable_type
+      end
+
+      ##
+      # @return [ActiveModel::Name]
+      def model_name
+        model.to_model.model_name
+      end
+    end
+  end
+end

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

@@ -21,7 +21,7 @@ module Hyrax
 
       self.terms = [:title, :alternative_title, :creator, :contributor, :description, :abstract,
                     :keyword, :license, :rights_statement, :access_right, :rights_notes, :publisher, :date_created,
-                    :subject, :language, :identifier, :based_near, :related_url,
+                    :subject, :language, :identifier, :based_near, :related_url, :bibliographic_citation,
                     :representative_id, :thumbnail_id, :rendering_ids, :files,
                     :visibility_during_embargo, :embargo_release_date, :visibility_after_embargo,
                     :visibility_during_lease, :lease_expiration_date, :visibility_after_lease,
@@ -120,7 +120,7 @@ module Hyrax
         primary = (required_fields & terms)
 
         (required_fields - primary).each do |missing|
-          Rails.logger.warn("The form field #{missing} is configured as a " \
+          Hyrax.logger.warn("The form field #{missing} is configured as a " \
                             'required field, but not as a term. This can lead ' \
                             'to unexpected behavior. Did you forget to add it ' \
                             "to `#{self.class}#terms`?")

data/app/forms/hyrax/forms/work_lease_form.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Forms
+    ##
+    # Represents a lease for edit through a work. That is, this form can
+    # be used to wrap a Work in order to capture state changes related only to
+    # its lease, ignoring the work's other fields.
+    #
+    # @note this supports the edit functionality of
+    #   +LeasesControllerBehavior+.
+    class WorkLeaseForm < Hyrax::ChangeSet
+      property :lease, form: Hyrax::Forms::Lease, populator: :lease_populator, prepopulator: :lease_populator
+      property :lease_expiration_date, virtual: true, prepopulator: ->(_opts) { self.lease_expiration_date = model.lease&.lease_expiration_date }
+      property :visibility_after_lease, virtual: true, prepopulator: ->(_opts) { self.visibility_after_lease = model.lease&.visibility_after_lease }
+      property :visibility_during_lease, virtual: true, prepopulator: ->(_opts) { self.visibility_during_lease = model.lease&.visibility_during_lease }
+
+      def lease_populator(**)
+        self.lease = Hyrax::LeaseManager.lease_for(resource: model)
+      end
+
+      ##
+      # @return [String]
+      def human_readable_type
+        model.to_model.human_readable_type
+      end
+
+      ##
+      # @return [ActiveModel::Name]
+      def model_name
+        model.to_model.model_name
+      end
+    end
+  end
+end

data/app/helpers/hyrax/collections_helper.rb

@@ -123,14 +123,7 @@ module Hyrax
     ##
     # @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
+      CollectionType.for(collection: collection).title
     end
 
     ##
@@ -138,14 +131,7 @@ module Hyrax
     #
     # @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
+      CollectionType.for(collection: collection).brandable?
     end
 
     ##
@@ -153,14 +139,7 @@ module Hyrax
     #
     # @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
+      CollectionType.for(collection: collection).discoverable?
     end
 
     ##
@@ -168,14 +147,7 @@ module Hyrax
     #
     # @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
+      CollectionType.for(collection: collection).sharable?
     end
 
     ##

data/app/helpers/hyrax/embargo_helper.rb

@@ -40,5 +40,16 @@ module Hyrax
         Hyrax::EmbargoManager.new(resource: resource).enforced?
       end
     end
+
+    ##
+    # @since 3.5.0
+    #
+    # @param [#embargo_history, #embargo] resource
+    #
+    # @return [Array]
+    def embargo_history(resource)
+      resource.try(:embargo_history) ||
+        Array(resource.embargo&.embargo_history)
+    end
   end
 end

data/app/helpers/hyrax/facets_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module FacetsHelper
+    # Methods in this module are from Blacklight::FacetsHelperBehavior, blacklight v6.24.0
+    # This module is used to ensure Hyrax facet views that rely on deprecated Blacklight helper methods are still functional
+
+    include Blacklight::Facet
+  end
+end

data/app/helpers/hyrax/hyrax_helper_behavior.rb

@@ -8,7 +8,6 @@ module Hyrax
     include Hyrax::TitleHelper
     include Hyrax::FileSetHelper
     include Hyrax::AbilityHelper
-    include Hyrax::UrlHelper
     include Hyrax::EmbargoHelper
     include Hyrax::LeaseHelper
     include Hyrax::CollectionsHelper
@@ -19,6 +18,7 @@ module Hyrax
     include Hyrax::PermissionLevelsHelper
     include Hyrax::WorkFormHelper
     include Hyrax::WorkflowsHelper
+    include Hyrax::FacetsHelper
 
     ##
     # @return [Array<String>] the list of all user groups
@@ -69,7 +69,7 @@ module Hyrax
       unread_notifications = mailbox.unread_count
       link_to(hyrax.notifications_path,
               'aria-label' => mailbox.label(params[:locale]),
-              class: 'notify-number') do
+              class: 'notify-number nav-link') do
         capture do
           concat tag.span('', class: 'fa fa-bell')
           concat "\n"
@@ -195,7 +195,7 @@ module Hyrax
       # this block is only executed when a link is inserted;
       # if we pass text containing no links, it just returns text.
       auto_link(html_escape(text)) do |value|
-        "<span class='glyphicon glyphicon-new-window'></span>#{('&nbsp;' + value) if show_link}"
+        "<span class='fa fa-external-link'></span>#{('&nbsp;' + value) if show_link}"
       end
     end
 
@@ -305,6 +305,21 @@ module Hyrax
         ""
     end
 
+    ##
+    # @param value [Object] the thing we'll attempt to cast to a formatted date.
+    # @param format [String] the `DateTime.strftime` format string
+    # @return [String]
+    #
+    # @see https://github.com/samvera/hyrax/issues/5818
+    # @see https://ruby-doc.org/core-3.0.1/Time.html#method-i-strftime
+    def cast_to_date_time_format(value, format:)
+      return value.strftime(format).to_s if value.respond_to?(:strftime)
+
+      (Time.zone.parse(value)&.strftime(format) || value).to_s
+    rescue ArgumentError, TypeError
+      value.to_s
+    end
+
     private
 
     def user_agent
@@ -312,9 +327,9 @@ module Hyrax
     end
 
     def count_classes_for(unread_count)
-      classes = unread_count.zero? ? 'invisible label-default' : 'label-danger'
+      classes = unread_count.zero? ? 'invisible badge-secondary' : 'badge-danger'
 
-      "count label #{classes}"
+      "count badge #{classes}"
     end
 
     def search_action_for_dashboard

data/app/helpers/hyrax/lease_helper.rb

@@ -40,5 +40,16 @@ module Hyrax
         Hyrax::LeaseManager.new(resource: resource).enforced?
       end
     end
+
+    ##
+    # @since 3.5.0
+    #
+    # @param [#lease_history, #lease] resource
+    #
+    # @return [Array]
+    def lease_history(resource)
+      resource.try(:lease_history) ||
+        Array(resource.lease&.lease_history)
+    end
   end
 end