hyrax 3.0.0.pre.beta2 → 3.0.0.pre.beta3

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

@@ -8,10 +8,6 @@ module Hyrax
             type.coerce(self[field])
           end
         end
-
-        def solr_name(*args)
-          ActiveFedora.index_field_mapper.solr_name(*args)
-        end
       end
 
       module Solr
@@ -37,53 +33,55 @@ module Hyrax
             begin
               ::Date.parse(field)
             rescue ArgumentError
-              Rails.logger.info "Unable to parse date: #{field.first.inspect}"
+              Hyrax.logger.info "Unable to parse date: #{field.first.inspect}"
             end
           end
         end
       end
 
       included do
-        attribute :identifier, Solr::Array, solr_name('identifier')
-        attribute :based_near, Solr::Array, solr_name('based_near')
-        attribute :based_near_label, Solr::Array, solr_name('based_near_label')
-        attribute :related_url, Solr::Array, solr_name('related_url')
-        attribute :resource_type, Solr::Array, solr_name('resource_type')
+        attribute :alt_title, Solr::Array, "alt_title_tesim"
+        attribute :identifier, Solr::Array, "identifier_tesim"
+        attribute :based_near, Solr::Array, "based_near_tesim"
+        attribute :based_near_label, Solr::Array, "based_near_label_tesim"
+        attribute :related_url, Solr::Array, "related_url_tesim"
+        attribute :resource_type, Solr::Array, "resource_type_tesim"
         attribute :edit_groups, Solr::Array, ::Ability.edit_group_field
         attribute :edit_people, Solr::Array, ::Ability.edit_user_field
         attribute :read_groups, Solr::Array, ::Ability.read_group_field
         attribute :collection_ids, Solr::Array, 'collection_ids_tesim'
-        attribute :admin_set, Solr::Array, solr_name('admin_set')
-        attribute :member_of_collection_ids, Solr::Array, solr_name('member_of_collection_ids', :symbol)
-        attribute :description, Solr::Array, solr_name('description')
-        attribute :title, Solr::Array, solr_name('title')
-        attribute :contributor, Solr::Array, solr_name('contributor')
-        attribute :subject, Solr::Array, solr_name('subject')
-        attribute :publisher, Solr::Array, solr_name('publisher')
-        attribute :language, Solr::Array, solr_name('language')
-        attribute :keyword, Solr::Array, solr_name('keyword')
-        attribute :license, Solr::Array, solr_name('license')
-        attribute :source, Solr::Array, solr_name('source')
-        attribute :date_created, Solr::Array, solr_name('date_created')
-        attribute :rights_statement, Solr::Array, solr_name('rights_statement')
-        attribute :rights_notes, Solr::Array, solr_name('rights_notes')
-
-        attribute :mime_type, Solr::String, solr_name('mime_type', :stored_sortable)
-        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)
+        attribute :admin_set, Solr::Array, "admin_set_tesim"
+        attribute :member_of_collection_ids, Solr::Array, "member_of_collection_ids_ssim"
+        attribute :description, Solr::Array, "description_tesim"
+        attribute :abstract, Solr::Array, "abstract_tesim"
+        attribute :title, Solr::Array, "title_tesim"
+        attribute :contributor, Solr::Array, "contributor_tesim"
+        attribute :subject, Solr::Array, "subject_tesim"
+        attribute :publisher, Solr::Array, "publisher_tesim"
+        attribute :language, Solr::Array, "language_tesim"
+        attribute :keyword, Solr::Array, "keyword_tesim"
+        attribute :license, Solr::Array, "license_tesim"
+        attribute :source, Solr::Array, "source_tesim"
+        attribute :date_created, Solr::Array, "date_created_tesim"
+        attribute :rights_statement, Solr::Array, "rights_statement_tesim"
+        attribute :rights_notes, Solr::Array, "rights_notes_tesim"
+        attribute :access_right, Solr::Array, "access_right_tesim"
+        attribute :mime_type, Solr::String, "mime_type_ssi"
+        attribute :workflow_state, Solr::String, "workflow_state_name_ssim"
+        attribute :human_readable_type, Solr::String, "human_readable_type_tesim"
+        attribute :representative_id, Solr::String, "hasRelatedMediaFragment_ssim"
         # 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 :rendering_ids, Solr::Array, Hyrax.config.rendering_predicate.value.split(/#|\/|,/).last + "_ssim"
+        attribute :thumbnail_id, Solr::String, "hasRelatedImage_ssim"
         attribute :thumbnail_path, Solr::String, CatalogController.blacklight_config.index.thumbnail_field
-        attribute :label, Solr::String, solr_name('label')
-        attribute :file_format, Solr::String, solr_name('file_format')
-        attribute :suppressed?, Solr::String, solr_name('suppressed', ActiveFedora::Indexing::Descriptor.new(:boolean, :stored, :indexed))
-
-        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 :label, Solr::String, "label_tesim"
+        attribute :file_format, Solr::String, "file_format_tesim"
+        attribute :suppressed?, Solr::String, "suppressed_bsi"
+        attribute :original_file_id, Solr::String, "original_file_id_ssi"
+        attribute :date_modified, Solr::Date, "date_modified_dtsi"
+        attribute :date_uploaded, Solr::Date, "date_uploaded_dtsi"
+        attribute :create_date, Solr::Date, "system_create_dtsi"
+        attribute :modified_date, Solr::Date, "system_modified_dtsi"
         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

@@ -71,21 +71,17 @@ module Hyrax
 
     # Method to return the ActiveFedora model
     def hydra_model
-      first(ActiveFedora.index_field_mapper.solr_name('has_model', :symbol)).constantize
+      first("has_model_ssim").constantize
     end
 
     def depositor(default = '')
-      val = first(ActiveFedora.index_field_mapper.solr_name('depositor'))
+      val = first("depositor_tesim")
       val.present? ? val : default
     end
 
     def creator
-      descriptor = if hydra_model == AdminSet
-                     hydra_model.index_config[:creator].behaviors.first
-                   else
-                     :stored_searchable
-                   end
-      fetch(ActiveFedora.index_field_mapper.solr_name('creator', descriptor), [])
+      solr_term = hydra_model == AdminSet ? "creator_ssim" : "creator_tesim"
+      fetch(solr_term, [])
     end
 
     def visibility

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

@@ -0,0 +1,20 @@
+module Hyrax
+  module VirusCheck
+    extend ActiveSupport::Concern
+
+    included do
+      validate :must_not_detect_viruses
+
+      def viruses?
+        return false unless original_file&.new_record? # We have a new file to check
+        VirusCheckerService.file_has_virus?(original_file)
+      end
+
+      def must_not_detect_viruses
+        return true unless viruses?
+        errors.add(:base, "Failed to verify uploaded file is not a virus")
+        false
+      end
+    end
+  end
+end

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

@@ -24,9 +24,11 @@ module Hyrax
 
     included do
       property :owner, predicate: RDF::URI.new('http://opaquenamespace.org/ns/hydra/owner'), multiple: false
-      class_attribute :human_readable_short_description
+      class_attribute :human_readable_short_description, :default_system_virus_scanner
       # TODO: do we need this line?
       self.indexer = WorkIndexer
+      # Default VirusScanner, configurable for Hyrax work types
+      self.default_system_virus_scanner = Hyrax::VirusScanner
     end
 
     # TODO: This can be removed when we upgrade to ActiveFedora 12.0

data/app/models/file_download_stat.rb

@@ -13,7 +13,8 @@ class FileDownloadStat < Hyrax::Statistic
       end
       profile.hyrax__download(sort: 'date',
                               start_date: start_date,
-                              end_date: Date.yesterday)
+                              end_date: Date.yesterday,
+                              limit: 10_000)
              .for_file(file.id)
     end
 

data/app/models/hyrax/active_job_proxy.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # Support ActiveJob Serialization/Deserialization for `Valkyrie::Resource`
+  # models.
+  #
+  # @example Serializing a Valkyrie::Resource for ActiveJob
+  #   resource = Hyrax.query_service.find_by(id: Valkyrie::ID.new('an_id'))
+  #
+  #   MyJob.perform_later(resource) # #<ActiveJob::SerializationError: Unsupported argument type: >
+  #
+  #   proxy = Hyrax::ActiveJobProxy.new(resource: resource)
+  #   MyJob.perform_later(proxy) # deserializes for `MyJob#perform` as `resource`
+  #
+  # @see https://github.com/rails/globalid
+  class ActiveJobProxy
+    include GlobalID::Identification
+
+    ##
+    # @!attribute [rw] resource
+    #   @return [Hyrax::Resource]
+    attr_accessor :resource
+
+    ##
+    # @param resource [Hyrax::Resource]
+    def initialize(resource:)
+      self.resource = resource
+    end
+
+    ##
+    # @return [Valkyrie::Resource]
+    def self.find(id)
+      Hyrax.query_adapter.find_by(id: id)
+    end
+
+    ##
+    # @return [String]
+    def id
+      resource.id.to_s
+    end
+  end
+end

data/app/models/hyrax/embargo.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # The Valkyrie model for embargoes.
+  #
+  # @note Embargo and Lease can, in principle, be collapsed into a single model
+  #   with a `#visibility_during`, `#visibility_after`, `#end_date`, and
+  #   `#history`. We haven't made this transition in order to simplify legacy
+  #   support for `Hydra::AccessControls`.
+  class Embargo < Valkyrie::Resource
+    attribute :visibility_after_embargo,  Valkyrie::Types::String
+    attribute :visibility_during_embargo, Valkyrie::Types::String
+    attribute :embargo_release_date,      Valkyrie::Types::DateTime
+    attribute :embargo_history,           Valkyrie::Types::Array
+
+    def active?
+      (embargo_release_date.present? && Time.zone.today < embargo_release_date)
+    end
+  end
+end

data/app/models/hyrax/file_metadata.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Hyrax
+  class FileMetadata < Valkyrie::Resource
+    attribute :file_identifiers, ::Valkyrie::Types::Set # id of the file stored by the storage adapter
+    attribute :alternate_id, ::Valkyrie::Types::Set # id of the Hydra::PCDM::File which holds metadata and the file in ActiveFedora
+    attribute :file_set_id, ::Valkyrie::Types::ID # id of parent file set resource
+
+    # all remaining attributes are on AF::File metadata_node unless otherwise noted
+    attribute :label, ::Valkyrie::Types::Set
+    attribute :original_filename, ::Valkyrie::Types::Set
+    attribute :mime_type, ::Valkyrie::Types::Set
+    attribute :use, ::Valkyrie::Types::Set # AF::File type
+
+    # attributes set by fits
+    attribute :format_label, ::Valkyrie::Types::Set
+    attribute :size, ::Valkyrie::Types::Set
+    attribute :well_formed, ::Valkyrie::Types::Set
+    attribute :valid, ::Valkyrie::Types::Set
+    attribute :date_created, ::Valkyrie::Types::Set
+    attribute :fits_version, ::Valkyrie::Types::Set
+    attribute :exif_version, ::Valkyrie::Types::Set
+    attribute :checksum, ::Valkyrie::Types::Set
+
+    # shared attributes across multiple file types
+    attribute :frame_rate, ::Valkyrie::Types::Set # audio, video
+    attribute :bit_rate, ::Valkyrie::Types::Set # audio, video
+    attribute :duration, ::Valkyrie::Types::Set # audio, video
+    attribute :sample_rate, ::Valkyrie::Types::Set # audio, video
+
+    attribute :height, ::Valkyrie::Types::Set # image, video
+    attribute :width, ::Valkyrie::Types::Set # image, video
+
+    # attributes set by fits for audio files
+    attribute :bit_depth, ::Valkyrie::Types::Set
+    attribute :channels, ::Valkyrie::Types::Set
+    attribute :data_format, ::Valkyrie::Types::Set
+    attribute :offset, ::Valkyrie::Types::Set
+
+    # attributes set by fits for documents
+    attribute :file_title, ::Valkyrie::Types::Set
+    attribute :creator, ::Valkyrie::Types::Set
+    attribute :page_count, ::Valkyrie::Types::Set
+    attribute :language, ::Valkyrie::Types::Set
+    attribute :word_count, ::Valkyrie::Types::Set
+    attribute :character_count, ::Valkyrie::Types::Set
+    attribute :line_count, ::Valkyrie::Types::Set
+    attribute :character_set, ::Valkyrie::Types::Set
+    attribute :markup_basis, ::Valkyrie::Types::Set
+    attribute :markup_language, ::Valkyrie::Types::Set
+    attribute :paragraph_count, ::Valkyrie::Types::Set
+    attribute :table_count, ::Valkyrie::Types::Set
+    attribute :graphics_count, ::Valkyrie::Types::Set
+
+    # attributes set by fits for images
+    attribute :byte_order, ::Valkyrie::Types::Set
+    attribute :compression, ::Valkyrie::Types::Set
+    attribute :color_space, ::Valkyrie::Types::Set
+    attribute :profile_name, ::Valkyrie::Types::Set
+    attribute :profile_version, ::Valkyrie::Types::Set
+    attribute :orientation, ::Valkyrie::Types::Set
+    attribute :color_map, ::Valkyrie::Types::Set
+    attribute :image_producer, ::Valkyrie::Types::Set
+    attribute :capture_device, ::Valkyrie::Types::Set
+    attribute :scanning_software, ::Valkyrie::Types::Set
+    attribute :gps_timestamp, ::Valkyrie::Types::Set
+    attribute :latitude, ::Valkyrie::Types::Set
+    attribute :longitude, ::Valkyrie::Types::Set
+
+    # attributes set by fits for video
+    attribute :aspect_ratio, ::Valkyrie::Types::Set
+
+    # @param [ActionDispatch::Http::UploadedFile] file
+    def self.for(file:)
+      new(label: file.original_filename,
+          original_filename: file.original_filename,
+          mime_type: file.content_type,
+          use: file.try(:use) || [::Valkyrie::Vocab::PCDMUse.OriginalFile])
+    end
+
+    def original_file?
+      use.include?(::Valkyrie::Vocab::PCDMUse.OriginalFile)
+    end
+
+    def thumbnail_file?
+      use.include?(::Valkyrie::Vocab::PCDMUse.ThumbnailImage)
+    end
+
+    def extracted_file?
+      use.include?(::Valkyrie::Vocab::PCDMUse.ExtractedImage)
+    end
+
+    def title
+      label
+    end
+
+    def download_id
+      id
+    end
+
+    def valid?
+      file.valid?(size: size.first, digests: { sha256: checksum.first.sha256 })
+    end
+
+    def file
+      ::Valkyrie::StorageAdapter.find_by(id: file_identifiers.first)
+    end
+  end
+end

data/app/models/hyrax/lease.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # The Valkyrie model for leases.
+  #
+  # @note Embargo and Lease can, in principle, be collapsed into a single model
+  #   with a `#visibility_during`, `#visibility_after`, `#end_date`, and
+  #   `#history`. We haven't made this transition in order to simplify legacy
+  #   support for `Hydra::AccessControls`.
+  class Lease < Valkyrie::Resource
+    attribute :visibility_after_lease,  Valkyrie::Types::String
+    attribute :visibility_during_lease, Valkyrie::Types::String
+    attribute :lease_expiration_date,   Valkyrie::Types::DateTime
+    attribute :lease_history,           Valkyrie::Types::Array
+
+    def active?
+      (lease_expiration_date.present? && Time.zone.today < lease_expiration_date)
+    end
+  end
+end

data/app/models/hyrax/permission_template.rb

@@ -30,31 +30,31 @@ module Hyrax
 
     # A bit of an analogue for a `belongs_to :source_model` as it crosses from Fedora to the DB
     # @return [AdminSet | Collection]
-    # @raise [ActiveFedora::ObjectNotFoundError] when neither an AdminSet or Collection is found
+    # @raise [Hyrax::ObjectNotFoundError] when neither an AdminSet or Collection is found
     def source_model
       admin_set
-    rescue ActiveFedora::ObjectNotFoundError
+    rescue Hyrax::ObjectNotFoundError
       collection
     end
 
     # A bit of an analogue for a `belongs_to :admin_set` as it crosses from Fedora to the DB
     # @return [AdminSet]
-    # @raise [ActiveFedora::ObjectNotFoundError] when the we cannot find the AdminSet
+    # @raise [Hyrax::ObjectNotFoundError] when the we cannot find the AdminSet
     def admin_set
       return AdminSet.find(source_id) if AdminSet.exists?(source_id)
-      raise ActiveFedora::ObjectNotFoundError
+      raise Hyrax::ObjectNotFoundError
     rescue ActiveFedora::ActiveFedoraError # TODO: remove the rescue when active_fedora issue #1276 is fixed
-      raise ActiveFedora::ObjectNotFoundError
+      raise Hyrax::ObjectNotFoundError
     end
 
     # A bit of an analogue for a `belongs_to :collection` as it crosses from Fedora to the DB
     # @return [Collection]
-    # @raise [ActiveFedora::ObjectNotFoundError] when the we cannot find the Collection
+    # @raise [Hyrax::ObjectNotFoundError] when the we cannot find the Collection
     def collection
       return Collection.find(source_id) if Collection.exists?(source_id)
-      raise ActiveFedora::ObjectNotFoundError
+      raise Hyrax::ObjectNotFoundError
     rescue ActiveFedora::ActiveFedoraError # TODO: remove the rescue when active_fedora issue #1276 is fixed
-      raise ActiveFedora::ObjectNotFoundError
+      raise Hyrax::ObjectNotFoundError
     end
 
     # Valid Release Period values

data/app/models/hyrax/resource.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # The base Valkyrie model for Hyrax.
+  class Resource < Valkyrie::Resource
+    include Valkyrie::Resource::AccessControls
+
+    attribute :alternate_ids, ::Valkyrie::Types::Array
+    attribute :embargo,       Hyrax::Embargo
+    attribute :lease,         Hyrax::Lease
+
+    def visibility=(value)
+      visibility_writer.assign_access_for(visibility: value)
+    end
+
+    def visibility
+      visibility_reader.read
+    end
+
+    protected
+
+      def visibility_writer
+        Hyrax::VisibilityWriter.new(resource: self)
+      end
+
+      def visibility_reader
+        Hyrax::VisibilityReader.new(resource: self)
+      end
+  end
+end