ddr-models 2.7.6 → 2.8.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb09816423a70527f2896ba5ada6668bf0cc3725
-  data.tar.gz: a989e2330e2bc993e73af0e75efba97be293bf2d
+  metadata.gz: b0a6fc7039cab0864972b389421c54237721aa5a
+  data.tar.gz: b3d4b6c668ea5df6435848d18421e324d49ee1ac
 SHA512:
-  metadata.gz: 2fd4878f7451fe570bc7c3a26126656c0b66e378c765987ff3d1438d35cb060baa23274446dd70a4b2c0626f66f692e398d0c133cfcc210fd6c5d8219e51744b
-  data.tar.gz: c182db4d3dcedccee776cae12616788692723a56cbd761481aa7b62eab6ae7de7a808d23e5ed14182e95927248bc780e4a805e424c3cb4d42292d26adfd7b88b
+  metadata.gz: 40416d278fcb502dab7e4e36d2436b52ed0bacefe51f5bf8fd15fd1a3f0e413ff18e812f56c8269cf0c81bf03b7a1c938a4620609b79d5f98f4e1275332da82a
+  data.tar.gz: 53a3e965d7ee5bfa142dc112fb6983d6d616a634b4119283a2de9c04b5437004b0427a677f38fb3d3f81a764196d834275210ce2abe59415b561c4bf98f3e111

data/app/models/collection.rb

@@ -15,7 +15,7 @@ class Collection < Ddr::Models::Base
 
   after_create :set_admin_policy, unless: :admin_policy
 
-  validates_presence_of :title
+  validates_presence_of :admin_set, :title
 
   # Returns the SolrDocuments for Components associated with the Collection.
   #

data/app/models/component.rb

@@ -9,6 +9,7 @@ class Component < Ddr::Models::Base
   include Ddr::Models::HasIntermediateFile
   include Ddr::Models::HasMultiresImage
   include Ddr::Models::HasStructMetadata
+  include Ddr::Models::Streamable
 
   belongs_to :parent, :property => :is_part_of, :class_name => 'Item'
   belongs_to :target, :property => :has_external_target, :class_name => 'Target'
@@ -44,42 +45,32 @@ class Component < Ddr::Models::Base
     structmap = structure.add_structmap(type: Ddr::Models::Structure::TYPE_DEFAULT)
     div = structure.add_div(parent: structmap)
     filegrp = structure.add_filegrp(parent: filesec)
-    add_original_file(structure, filegrp, div)
-    add_preservation_master_file(structure, filegrp, div)
-    add_intermediate_file(structure, filegrp, div) if has_intermediate_file?
-    add_service_file(structure, filegrp, div)
-    add_thumbnail_image(structure, filegrp, div) if has_thumbnail?
+    add_use_to_structure(structure, filegrp, div, Ddr::Models::Structure::USE_ORIGINAL_FILE,
+                              Ddr::Datastreams::CONTENT)
+    add_use_to_structure(structure, filegrp, div, Ddr::Models::Structure::USE_PRESERVATION_MASTER_FILE,
+                              Ddr::Datastreams::CONTENT)
+    add_use_to_structure(structure, filegrp, div, Ddr::Models::Structure::USE_INTERMEDIATE_FILE,
+                              Ddr::Datastreams::INTERMEDIATE_FILE) if has_intermediate_file?
+    add_service_file_uses_to_default_structure(structure, filegrp, div)
+    add_use_to_structure(structure, filegrp, div, Ddr::Models::Structure::USE_THUMBNAIL_IMAGE,
+                         Ddr::Datastreams::THUMBNAIL) if has_thumbnail?
     structure
   end
 
-  def add_original_file(structure, filegrp, div)
-    file = structure.add_file(parent: filegrp, use: Ddr::Models::Structure::USE_ORIGINAL_FILE)
-    structure.add_flocat(parent: file, loctype: 'OTHER', otherloctype: 'AttachedFile', href: Ddr::Datastreams::CONTENT)
-    structure.add_fptr(parent: div, fileid: file['ID'])
-  end
-
-  def add_preservation_master_file(structure, filegrp, div)
-    file = structure.add_file(parent: filegrp, use: Ddr::Models::Structure::USE_PRESERVATION_MASTER_FILE)
-    structure.add_flocat(parent: file, loctype: 'OTHER', otherloctype: 'AttachedFile', href: Ddr::Datastreams::CONTENT)
-    structure.add_fptr(parent: div, fileid: file['ID'])
-  end
-
-  def add_intermediate_file(structure, filegrp, div)
-    file = structure.add_file(parent: filegrp, use: Ddr::Models::Structure::USE_INTERMEDIATE_FILE)
-    structure.add_flocat(parent: file, loctype: 'OTHER', otherloctype: 'AttachedFile', href: Ddr::Datastreams::INTERMEDIATE_FILE)
-    structure.add_fptr(parent: div, fileid: file['ID'])
-  end
-
-  def add_service_file(structure, filegrp, div)
-    file = structure.add_file(parent: filegrp, use: Ddr::Models::Structure::USE_SERVICE_FILE)
-    service_file = has_multires_image? ? Ddr::Datastreams::MULTIRES_IMAGE : Ddr::Datastreams::CONTENT
-    structure.add_flocat(parent: file, loctype: 'OTHER', otherloctype: 'AttachedFile', href: service_file)
-    structure.add_fptr(parent: div, fileid: file['ID'])
+  def add_service_file_uses_to_default_structure(structure, filegrp, div)
+    add_use_to_structure(structure, filegrp, div, Ddr::Models::Structure::USE_SERVICE_FILE,
+                         Ddr::Datastreams::MULTIRES_IMAGE) if has_multires_image?
+    add_use_to_structure(structure, filegrp, div, Ddr::Models::Structure::USE_SERVICE_FILE,
+                         Ddr::Datastreams::STREAMABLE_MEDIA) if streamable?
+    if !has_multires_image? && !streamable?
+      add_use_to_structure(structure, filegrp, div, Ddr::Models::Structure::USE_SERVICE_FILE,
+                           Ddr::Datastreams::CONTENT)
+    end
   end
 
-  def add_thumbnail_image(structure, filegrp, div)
-    file = structure.add_file(parent: filegrp, use: Ddr::Models::Structure::USE_THUMBNAIL_IMAGE)
-    structure.add_flocat(parent: file, loctype: 'OTHER', otherloctype: 'AttachedFile', href: Ddr::Datastreams::THUMBNAIL)
+  def add_use_to_structure(structure, filegrp, div, use, datastream_name)
+    file = structure.add_file(parent: filegrp, use: use)
+    structure.add_flocat(parent: file, loctype: 'OTHER', otherloctype: 'AttachedFile', href: datastream_name)
     structure.add_fptr(parent: div, fileid: file['ID'])
   end
 

data/config/initializers/active_fedora_base.rb

@@ -69,6 +69,14 @@ module ActiveFedora
       can_have_thumbnail? && thumbnail.has_content?
     end
 
+    def can_be_streamable?
+      datastreams.include? Ddr::Datastreams::STREAMABLE_MEDIA
+    end
+
+    def streamable?
+      can_be_streamable? && datastreams[Ddr::Datastreams::STREAMABLE_MEDIA].has_content?
+    end
+
     def safe_id
       id.sub(/:/, "-")
     end

data/config/locales/ddr-models.en.yml

@@ -8,6 +8,8 @@ en:
         active_fedora_model:
           label: Model
           heading: model
+        aleph_id:
+          label: "Aleph ID"
         aspace_id:
           label: "ArchivesSpace ID"
         doi:
@@ -16,6 +18,8 @@ en:
           label: "EAD ID"
         local_id:
           label: "Local ID"
+        streamable_media_url:
+          label: "Streamable Media URL"
         system_create:
           label: "Creation Date"
           heading: creation_date

data/lib/ddr/datastreams.rb

@@ -4,17 +4,18 @@ module Ddr
   module Datastreams
     extend ActiveSupport::Autoload
 
-    ADMIN_METADATA = "adminMetadata"
-    CONTENT = "content"
-    DC = "DC"
-    DESC_METADATA = "descMetadata"
-    EXTRACTED_TEXT = "extractedText"
-    FITS = "fits".freeze
+    ADMIN_METADATA    = "adminMetadata"
+    CONTENT           = "content"
+    DC                = "DC"
+    DESC_METADATA     = "descMetadata"
+    EXTRACTED_TEXT    = "extractedText"
+    FITS              = "fits".freeze
     INTERMEDIATE_FILE = "intermediateFile".freeze
-    MULTIRES_IMAGE = "multiresImage"
-    RELS_EXT = "RELS-EXT"
-    STRUCT_METADATA = "structMetadata"
-    THUMBNAIL = "thumbnail"
+    MULTIRES_IMAGE    = "multiresImage"
+    RELS_EXT          = "RELS-EXT"
+    STREAMABLE_MEDIA  = "streamableMedia"
+    STRUCT_METADATA   = "structMetadata"
+    THUMBNAIL         = "thumbnail"
 
     SAVE = "save.repo_file"
     DELETE = "delete.repo_file"
@@ -38,6 +39,7 @@ module Ddr
     autoload :MetadataDatastream
     autoload :MultiresImageDatastream
     autoload :PlainTextDatastream
+    autoload :StreamableMediaDatastream
     autoload :StructuralMetadataDatastream
 
     mattr_accessor :update_derivatives_on_changed do

data/lib/ddr/datastreams/administrative_metadata_datastream.rb

@@ -61,6 +61,12 @@ module Ddr
       property :rights_note,
                predicate: Ddr::Vocab::Asset.rightsNote
 
+      property :aleph_id,
+               predicate: Ddr::Vocab::Asset.alephId
+
+      property :affiliation,
+               predicate: Ddr::Vocab::Asset.affiliation
+
     end
   end
 end

data/lib/ddr/datastreams/streamable_media_datastream.rb

@@ -0,0 +1,5 @@
+module Ddr::Datastreams
+  class StreamableMediaDatastream < ExternalFileDatastream
+
+  end
+end

data/lib/ddr/index/fields.rb

@@ -9,6 +9,9 @@ module Ddr::Index
     ADMIN_SET                   = Field.new :admin_set, :stored_sortable
     ADMIN_SET_FACET             = Field.new :admin_set_facet, :facetable
     ADMIN_SET_TITLE             = Field.new :admin_set_title, :stored_sortable
+    AFFILIATION                 = Field.new :affiliation, :stored_searchable
+    AFFILIATION_FACET           = Field.new :affiliation_facet, :facetable
+    ALEPH_ID                    = Field.new :aleph_id, :stored_sortable
     ALL_TEXT                    = Field.new :all_text, solr_name: "all_text_timv"
     ARRANGER_FACET              = Field.new :arranger_facet, :facetable
     ASPACE_ID                   = Field.new :aspace_id, :stored_sortable
@@ -56,6 +59,8 @@ module Ddr::Index
     IS_MEMBER_OF                = Field.new :is_member_of, :symbol
     IS_MEMBER_OF_COLLECTION     = Field.new :is_member_of_collection, :symbol
     IS_PART_OF                  = Field.new :is_part_of, :symbol
+    LANGUAGE_FACET              = Field.new :language_facet, :facetable
+    LANGUAGE_NAME               = Field.new :language_name, :stored_searchable
     LAST_FIXITY_CHECK_ON        = Field.new :last_fixity_check_on, :stored_sortable, type: :date
     LAST_FIXITY_CHECK_OUTCOME   = Field.new :last_fixity_check_outcome, :symbol
     LAST_VIRUS_CHECK_ON         = Field.new :last_virus_check_on, :stored_sortable, type: :date
@@ -89,11 +94,8 @@ module Ddr::Index
     SERIES_FACET                = Field.new :series_facet, :facetable
     SETTING_FACET               = Field.new :setting_facet, :facetable
     SPATIAL_FACET               = Field.new :spatial_facet, :facetable
-    # STRUCT is interim index field to facilitate conversion of the STRUCTURE index field from
-    # stored and indexed to just stored.  The STRUCTURE field will eventually be pointed to this
-    # Field definition.
-    STRUCT                      = Field.new :structure, solr_name: "structure_ss"
-    STRUCTURE                   = Field.new :structure, :stored_sortable
+    STREAMABLE_MEDIA_TYPE       = Field.new :streamable_media_type, :stored_sortable
+    STRUCTURE                   = Field.new :structure, solr_name: "structure_ss"
     STRUCTURE_SOURCE            = Field.new :structure_source, :stored_sortable
     SUBJECT_FACET               = Field.new :subject_facet, :facetable
     SUBSERIES_FACET             = Field.new :subseries_facet, :facetable

data/lib/ddr/managers/derivatives_manager.rb

@@ -45,12 +45,12 @@ module Ddr::Managers
       tempdir_path = File.join(Dir.tmpdir, Dir::Tmpname.make_tmpname('',nil))
       begin
         tempdir = FileUtils.mkdir(tempdir_path).first
-        generator_source = create_source_file(tempdir)
-        generator_output = File.new(File.join(tempdir, "output.out"), 'wb')
-        exitstatus = derivative.generator.new(generator_source.path, generator_output.path, derivative.options).generate
-        generator_source.close unless generator_source.closed?
+        generator_source_path = source_datastream.external? ? source_datastream.file_path
+                                                            : create_source_file(source_datastream,tempdir)
+        generator_output_path = File.new(File.join(tempdir, "output.out"), 'wb').path
+        exitstatus = derivative.generator.new(generator_source_path, generator_output_path, derivative.options).generate
         if exitstatus == 0
-          generator_output = File.open(generator_output, 'rb')
+          generator_output = File.open(generator_output_path, 'rb')
           object.reload if object.persisted?
           object.add_file generator_output, derivative.datastream, mime_type: derivative.generator.output_mime_type
           object.save!
@@ -75,6 +75,11 @@ module Ddr::Managers
 
     alias_method :delete_derivative, :delete_derivative!
 
+    def source_datastream
+      @source_datastream ||= object.has_intermediate_file? ? object.datastreams[Ddr::Datastreams::INTERMEDIATE_FILE]
+                                                           : object.datastreams[Ddr::Datastreams::CONTENT]
+    end
+
     class DerivativeJob
       @queue = :derivatives
       def self.perform(pid, derivative_name)
@@ -86,9 +91,9 @@ module Ddr::Managers
 
     private
 
-    def create_source_file(dir)
+    def create_source_file(datastream, dir)
       generator_source = File.new(File.join(dir, "source"), "wb")
-      source_content = object.has_intermediate_file? ? object.intermediateFile.content : object.content.content
+      source_content = datastream.content
       generator_source.write(source_content)
       generator_source.close
       generator_source

data/lib/ddr/models.rb

@@ -58,24 +58,19 @@ module Ddr
     autoload :HasStructMetadata
     autoload :HasThumbnail
     autoload :Indexing
+    autoload :Language
+    autoload :MediaType
     autoload :NotFoundError, 'ddr/models/error'
     autoload :PermanentId
+    autoload :RightsStatement
     autoload :SolrDocument
+    autoload :Streamable
     autoload :Structure
     autoload :WithContentFile
     autoload :YearFacet
 
-    autoload_under "licenses" do
-      autoload :AdminPolicyLicense
-      autoload :EffectiveLicense
-      autoload :License
-      autoload :InheritedLicense
-      autoload :ParentLicense
-    end
-
     module Structures
       extend ActiveSupport::Autoload
-
       autoload :Agent
       autoload :Div
       autoload :File
@@ -136,6 +131,21 @@ module Ddr
       "application/octet-stream"
     end
 
+    # Maps file extensions to preferred media types
+    mattr_accessor :preferred_media_types do
+      {
+        '.mp4'  => 'video/mp4',
+        '.flv'  => 'video/flv',
+        '.webm' => 'video/webm',
+        '.aac'  => 'audio/mp4',
+        '.m4a'  => 'audio/mp4',
+        '.f4a'  => 'audio/mp4',
+        '.mp3'  => 'audio/mpeg',
+        '.ogg'  => 'audio/ogg',
+        '.oga'  => 'audio/ogg',
+      }
+    end
+
     # Yields an object with module configuration accessors
     def self.configure
       yield self

data/lib/ddr/models/base.rb

@@ -1,6 +1,9 @@
 module Ddr
   module Models
     class Base < ActiveFedora::Base
+      extend Deprecation
+
+      self.deprecation_horizon = 'ddr-models v3.0'
 
       # Lifecycle events
       INGEST = "ingest.repo_object"
@@ -36,6 +39,12 @@ module Ddr
       around_deaccession :notify_deaccession
       around_destroy :notify_delete
 
+      def rights_statement
+        RightsStatement.call(self)
+      end
+      alias_method :effective_license, :rights_statement
+      deprecation_deprecate :effective_license
+
       def deaccession
         run_callbacks :deaccession do
           delete
@@ -102,9 +111,7 @@ module Ddr
       private
 
       def grant_default_roles
-        if default_roles.present?
-          roles.grant *default_roles
-        end
+        roles.grant *default_roles
       end
 
       def default_roles

data/lib/ddr/models/file_management.rb

@@ -20,7 +20,7 @@ module Ddr::Models
     #   Not required for external datastream classes
     #   or datastream instances having controlGroup 'E'.
     def add_file(file, dsid, mime_type: nil, external: false, original_filename: nil)
-      mime_type         ||= Ddr::Utils.mime_type_for(file)
+      mime_type         ||= MediaType.call(file) # XXX Should we use original_filename, if present?
       source_path         = Ddr::Utils.file_path(file)
       original_filename ||= Ddr::Utils.file_name(file)
       file_to_add = FileToAdd.new(dsid, source_path, original_filename)

data/lib/ddr/models/has_admin_metadata.rb

@@ -1,6 +1,9 @@
 module Ddr::Models
   module HasAdminMetadata
     extend ActiveSupport::Concern
+    extend Deprecation
+
+    self.deprecation_horizon = 'ddr-models v3.0'
 
     included do
       has_metadata "adminMetadata",
@@ -23,10 +26,14 @@ module Ddr::Models
                      :doi,
                      :ingested_by,
                      :ingestion_date,
+                     :aleph_id,
                      datastream: "adminMetadata",
                      multiple: false
 
-      has_attributes :rights_note, datastream: "adminMetadata", multiple: true
+      has_attributes :affiliation,
+                     :rights_note,
+                     datastream: "adminMetadata",
+                     multiple: true
 
       delegate :publish!, :unpublish!, :published?, :unpublished?,
                to: :workflow
@@ -62,14 +69,6 @@ module Ddr::Models
       Ddr::Models::Contact.call(research_help_contact) if research_help_contact
     end
 
-    def effective_license
-      EffectiveLicense.call(self)
-    end
-
-    def inherited_license
-      InheritedLicense.call(self)
-    end
-
     def finding_aid
       if ead_id
         FindingAid.new(ead_id)

data/lib/ddr/models/indexing.rb

@@ -19,6 +19,9 @@ module Ddr::Models
         ACCESS_ROLE             => roles.to_json,
         ADMIN_SET               => admin_set,
         ADMIN_SET_TITLE         => admin_set_title,
+        AFFILIATION             => affiliation,
+        AFFILIATION_FACET       => affiliation,
+        ALEPH_ID                => aleph_id,
         ARRANGER_FACET          => desc_metadata_values('arranger'),
         ASPACE_ID               => aspace_id,
         ATTACHED_FILES_HAVING_CONTENT => attached_files_having_content.keys,
@@ -50,6 +53,8 @@ module Ddr::Models
         INTERVIEWER_NAME_FACET  => desc_metadata_values('interviewer_name'),
         IS_FORMAT_OF            => desc_metadata_values('isFormatOf'),
         IS_LOCKED               => is_locked,
+        LANGUAGE_FACET          => language_name,
+        LANGUAGE_NAME           => language_name,
         LICENSE                 => license,
         LITHOGRAPHER_FACET      => desc_metadata_values('lithographer'),
         LOCAL_ID                => local_id,
@@ -103,14 +108,16 @@ module Ddr::Models
         fields[MULTIRES_IMAGE_FILE_PATH] = multires_image_file_path
       end
       if has_struct_metadata?
-        # STRUCT is an interim index field to facilitate conversion of STRUCTURE field definition.
-        fields[STRUCT] = fields[STRUCTURE] = structure.dereferenced_structure.to_json
+        fields[STRUCTURE] = structure.dereferenced_structure.to_json
         fields[STRUCTURE_SOURCE] = structure.repository_maintained? ? Ddr::Models::Structure::REPOSITORY_MAINTAINED
                                                                     : Ddr::Models::Structure::EXTERNALLY_PROVIDED
       end
       if has_extracted_text?
         fields[EXTRACTED_TEXT] = extractedText.content
       end
+      if streamable?
+        fields[STREAMABLE_MEDIA_TYPE] = streamable_media_type
+      end
       if is_a? Component
         fields[COLLECTION_URI] = collection_uri
       end
@@ -156,8 +163,10 @@ module Ddr::Models
                admin_set
              elsif associated_collection.present?
                associated_collection.admin_set
+             else
+               nil
              end
-      if as = AdminSet.find_by_code(code)
+      if code && ( as = AdminSet.find_by_code(code) )
         as.title
       end
     end
@@ -178,6 +187,12 @@ module Ddr::Models
       date.first
     end
 
+    def language_name
+      language.map do |lang|
+        Language.find_by_code(lang).to_s rescue lang
+      end
+    end
+
     def year_facet
       YearFacet.call(self)
     end