solr_document.rb

# frozen_string_literal: true
#
# Generated from +rails generate hyrax:install+
class SolrDocument
  include Blacklight::Solr::Document
  include BlacklightOaiProvider::SolrDocument

  include Blacklight::Gallery::OpenseadragonSolrDocument

  # Adds Hyrax behaviors to the SolrDocument.
  include Hyrax::SolrDocumentBehavior

  # adds our base attributes
  include Spot::SolrDocumentAttributes

  # self.unique_key = 'id'

  # Email uses the semantic field mappings below to generate the body of an email.
  SolrDocument.use_extension(Blacklight::Document::Email)

  # SMS uses the semantic field mappings below to generate the body of an SMS email.
  SolrDocument.use_extension(Blacklight::Document::Sms)

  # DublinCore uses the semantic field mappings below to assemble an OAI-compliant Dublin Core document
  # Semantic mappings of solr stored fields. Fields may be multi or
  # single valued. See Blacklight::Document::SemanticFields#field_semantics
  # and Blacklight::Document::SemanticFields#to_semantic_values
  # Recommendation: Use field names from Dublin Core
  use_extension(Blacklight::Document::DublinCore)

  # Do content negotiation for AF models.
  use_extension(Hydra::ContentNegotiation)

  # A mapping hash of DC fields (keys) to their Solr document counterparts (values).
  # Values can be strings or arrays of strings (for concatenating multiple fields).
  #
  # @return [Hash<Symbol => String, Array<String>>]
  # @todo PA Digital wants identifiers, permalinks, and thumbnail links to all be
  #       mapped to dc:identifier. Will this just work out of the box?
  # @todo PA Digital guidelines specify ISO 639-3 for language (we're using 639-1);
  #       will we need to revisit that?
  def self.field_semantics
    {
      collection_name: 'member_of_collections_ssim',
      contributor: 'contributor_tesim',
      coverage: 'location_label_ssim',
      creator: 'creator_tesim',
      date: 'date_issued_ssim',
      description: 'description_tesim',
      format: 'file_format_ssim',
      identifier: ['id', 'permalink_ss', 'thumbnail_url_ss'],
      language: 'language_ssim',
      publisher: 'publisher_tesim',
      rights: 'rights_statement_ssim',
      source: 'source_tesim',
      subject: 'subject_label_ssim',
      title: 'title_tesim',
      type: 'resource_type_tesim'
    }
  end

  # Less involved than the same method on WorkShowPresenters,
  # all we want to know is if the item's visibility is "metadata"
  #
  # @return [true, false]
  def discoverable?
    public? || discover_groups.include?(Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC)
  end

  def metadata_only?
    visibility == 'metadata'
  end

  def sets
    Spot::OaiCollectionSolrSet.sets_for(self)
  end

  # Overrides +Hyrax::SolrDocumentBehavior#to_param+ by preferring collection slugs
  # (where present).
  #
  # @return [String]
  def to_param
    return collection_slug if collection? && collection_slug.present?
    super
  end

  # Override Hyrax::SolrDocumentBehavior#visibility to add our custom metadata-only
  # visibility as an option when discover_groups include 'public'
  #
  # @return [String]
  def visibility
    @visibility ||= if embargo_release_date.present?
                      Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_EMBARGO
                    elsif lease_expiration_date.present?
                      Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_LEASE
                    elsif public?
                      Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC
                    elsif registered?
                      Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
                    elsif discoverable?
                      'metadata'
                    else
                      Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE
                    end
  end
end