ddr-models 2.8.0 → 2.9.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4826c97c7faaee06b8ecd52dc5a322bc5a56acb9
-  data.tar.gz: 42e1c7666e775cd37451848e53cc07e378022d77
+  metadata.gz: 0cc0364fbbf04479e361ddf450e21d70aa9d9f21
+  data.tar.gz: a18facc359b48603080daf6cbf8f82b22e41a15e
 SHA512:
-  metadata.gz: 1e6d24131304e7d017acd556de2db085496b103f59f58dc5d8350d9a9e95caea811254dc44be950c758629fcc97665a971803926a7ee5d1ef263e73f07fa064b
-  data.tar.gz: a13fa84b44a46e9890135443b36780d30e39c3923ed7eed54712b29069b556a5f94e6dfb87833103950600088f66e4dfe85143e5fd43f4b529e74652a4fc0148
+  metadata.gz: 08988037c01145241f52c2914b5f0330d93b79865e1effbdcea509f79b42b2a926956ec8aa049b406a788385d534f252f180aad054899618175598eefd1fcc87
+  data.tar.gz: 4bdc44aaf67465193eac2c5302a5f30abcefe6b60df8bb44653083f8f3f0441346a907df6a7b74fa53c880dd8cf9820537ca1365a0ca8d9802c7d5f7233c6864

data/app/models/collection.rb

@@ -1,3 +1,4 @@
+require 'htmlentities'
 #
 # A Collection is a conceptual and administrative entity containing a set of items.
 #
@@ -51,6 +52,10 @@ class Collection < Ddr::Models::Base
     true
   end
 
+  def default_structure
+    build_default_structure
+  end
+
   private
 
   def default_roles
@@ -69,4 +74,54 @@ class Collection < Ddr::Models::Base
     save!
   end
 
+  def build_default_structure
+    document = Ddr::Models::Structure.xml_template
+    structure = Ddr::Models::Structure.new(document)
+    metshdr = structure.add_metshdr
+    structure.add_agent(parent: metshdr, role: Ddr::Models::Structures::Agent::ROLE_CREATOR,
+                        name: Ddr::Models::Structures::Agent::NAME_REPOSITORY_DEFAULT)
+    structmap = structure.add_structmap(type: Ddr::Models::Structure::TYPE_DEFAULT)
+    add_items_to_structure(structure, structmap)
+    structure
+  end
+
+  def add_items_to_structure(structure, structmap)
+    sorted_items_for_structure.each do |item|
+      if path = item[Ddr::Index::Fields::NESTED_PATH]
+        nest = path.split(File::SEPARATOR)
+      else
+        nest = []
+      end
+      find_or_create_div(structure, structmap, nest, item[Ddr::Index::Fields::PERMANENT_ID])
+    end
+  end
+
+  def find_or_create_div(structure, parent, nest, permanent_id)
+    label = nest.shift
+    order = parent.elements.count + 1
+    if nest.empty?
+      div = structure.add_div(parent: parent, order: order)
+      add_mptr(structure, div, permanent_id)
+    else
+      label = HTMLEntities.new.encode(label)
+      div = parent.xpath(%Q[xmlns:div[@LABEL="#{label}"]]).first ||
+            structure.add_div(parent: parent, type: 'Directory', label: label, order: order)
+      find_or_create_div(structure, div, nest, permanent_id)
+    end
+  end
+
+  def add_mptr(structure, div, permanent_id)
+    structure.add_mptr(parent: div, href: permanent_id)
+  end
+
+  def sorted_items_for_structure
+    ActiveFedora::SolrService.query(association_query(:children), sort: item_sort_for_structure, rows: 999999)
+  end
+
+  def item_sort_for_structure
+    "#{Ddr::Index::Fields::NESTED_PATH} ASC,
+     #{Ddr::Index::Fields::LOCAL_ID} ASC,
+     #{Ddr::Index::Fields::OBJECT_CREATE_DATE} ASC"
+  end
+
 end

data/app/models/component.rb

@@ -5,6 +5,7 @@
 #
 class Component < Ddr::Models::Base
 
+  include Ddr::Models::Captionable
   include Ddr::Models::HasContent
   include Ddr::Models::HasIntermediateFile
   include Ddr::Models::HasMultiresImage
@@ -17,6 +18,10 @@ class Component < Ddr::Models::Base
   alias_method :item, :parent
   alias_method :item=, :parent=
 
+  STRUCTURALLY_RELEVANT_DATASTREAMS = [ Ddr::Datastreams::CAPTION, Ddr::Datastreams::CONTENT,
+                                        Ddr::Datastreams::INTERMEDIATE_FILE, Ddr::Datastreams::MULTIRES_IMAGE,
+                                        Ddr::Datastreams::STREAMABLE_MEDIA, Ddr::Datastreams::THUMBNAIL ]
+
   def collection
     self.parent.parent rescue nil
   end
@@ -30,7 +35,7 @@ class Component < Ddr::Models::Base
   end
 
   def default_structure
-    build_default_structure if has_content?
+    build_default_structure
   end
 
   private
@@ -41,19 +46,24 @@ class Component < Ddr::Models::Base
     metshdr = structure.add_metshdr
     structure.add_agent(parent: metshdr, role: Ddr::Models::Structures::Agent::ROLE_CREATOR,
                         name: Ddr::Models::Structures::Agent::NAME_REPOSITORY_DEFAULT)
-    filesec = structure.add_filesec
     structmap = structure.add_structmap(type: Ddr::Models::Structure::TYPE_DEFAULT)
-    div = structure.add_div(parent: structmap)
-    filegrp = structure.add_filegrp(parent: filesec)
-    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?
+    if has_content?
+      filesec = structure.add_filesec
+      div = structure.add_div(parent: structmap)
+      filegrp = structure.add_filegrp(parent: filesec)
+      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?
+      add_use_to_structure(structure, filegrp, div, Ddr::Models::Structure::USE_TRANSCRIPT,
+                           Ddr::Datastreams::CAPTION) if captioned?
+
+    end
     structure
   end
 

data/app/models/item.rb

@@ -11,6 +11,8 @@ class Item < Ddr::Models::Base
   has_many :children, property: :is_part_of, class_name: 'Component'
   belongs_to :parent, property: :is_member_of_collection, class_name: 'Collection'
 
+  has_attributes :nested_path, datastream: Ddr::Datastreams::ADMIN_METADATA, multiple: false
+
   alias_method :components, :children
   alias_method :component_ids, :child_ids
 
@@ -37,4 +39,30 @@ class Item < Ddr::Models::Base
     children_having_extracted_text.docs.map(&:extracted_text).flatten
   end
 
+  def default_structure
+    build_default_structure
+  end
+
+  private
+
+  def build_default_structure
+    document = Ddr::Models::Structure.xml_template
+    structure = Ddr::Models::Structure.new(document)
+    metshdr = structure.add_metshdr
+    structure.add_agent(parent: metshdr, role: Ddr::Models::Structures::Agent::ROLE_CREATOR,
+                        name: Ddr::Models::Structures::Agent::NAME_REPOSITORY_DEFAULT)
+    structmap = structure.add_structmap(type: Ddr::Models::Structure::TYPE_DEFAULT)
+    add_components_to_structure(structure, structmap)
+    structure
+  end
+
+  def add_components_to_structure(structure, structmap)
+    count = 0
+    sorted_children.each do |child|
+      count += 1
+      div = structure.add_div(parent: structmap, order: count)
+      structure.add_mptr(parent: div, href: child[Ddr::Index::Fields::PERMANENT_ID])
+    end
+  end
+
 end

data/config/initializers/active_fedora_base.rb

@@ -69,6 +69,14 @@ module ActiveFedora
       can_have_thumbnail? && thumbnail.has_content?
     end
 
+    def captionable?
+      datastreams.include? Ddr::Datastreams::CAPTION
+    end
+
+    def captioned?
+      captionable? && datastreams[Ddr::Datastreams::CAPTION].has_content?
+    end
+
     def can_be_streamable?
       datastreams.include? Ddr::Datastreams::STREAMABLE_MEDIA
     end

data/lib/ddr/datastreams.rb

@@ -5,6 +5,7 @@ module Ddr
     extend ActiveSupport::Autoload
 
     ADMIN_METADATA    = "adminMetadata"
+    CAPTION           = "caption"
     CONTENT           = "content"
     DC                = "DC"
     DESC_METADATA     = "descMetadata"
@@ -29,6 +30,7 @@ module Ddr
     CHECKSUM_TYPES = [ CHECKSUM_TYPE_MD5, CHECKSUM_TYPE_SHA1, CHECKSUM_TYPE_SHA256, CHECKSUM_TYPE_SHA384, CHECKSUM_TYPE_SHA512 ]
 
     autoload :AdministrativeMetadataDatastream
+    autoload :CaptionDatastream
     autoload :ContentDatastream
     autoload :DatastreamBehavior
     autoload :DeleteExternalFiles

data/lib/ddr/datastreams/administrative_metadata_datastream.rb

@@ -15,6 +15,9 @@ module Ddr
         index.as :stored_sortable
       end
 
+      property :nested_path,
+               predicate: Ddr::Vocab::Asset.nestedPath
+
       property :workflow_state,
                predicate: Ddr::Vocab::Asset.workflowState
 

data/lib/ddr/datastreams/caption_datastream.rb

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

data/lib/ddr/index/fields.rb

@@ -74,6 +74,8 @@ module Ddr::Index
     MEDIA_TYPE                  = Field.new :content_media_type, :symbol
     MEDIUM_FACET                = Field.new :medium_facet, :facetable
     MULTIRES_IMAGE_FILE_PATH    = Field.new :multires_image_file_path, :stored_sortable
+    NESTED_PATH                 = Field.new :nested_path, :stored_sortable
+    NESTED_PATH_TEXT            = Field.new :nested_path_text, :searchable
     OBJECT_PROFILE              = Field.new :object_profile, :displayable
     OBJECT_STATE                = Field.new :object_state, :stored_sortable
     OBJECT_CREATE_DATE          = Field.new :system_create, :stored_sortable, type: :date

data/lib/ddr/models.rb

@@ -37,6 +37,7 @@ module Ddr
     autoload :AdminSet
     autoload :Base
     autoload :Cache
+    autoload :Captionable
     autoload :ChecksumInvalid, 'ddr/models/error'
     autoload :Contact
     autoload :ContentModelError, 'ddr/models/error'
@@ -134,15 +135,36 @@ module Ddr
     # 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',
+        '.flv'  => 'video/flv',
+        '.m4a'  => 'audio/mp4',
+        '.mov'  => 'video/quicktime',
         '.mp3'  => 'audio/mpeg',
-        '.ogg'  => 'audio/ogg',
+        '.mp4'  => 'video/mp4',
         '.oga'  => 'audio/ogg',
+        '.ogg'  => 'audio/ogg',
+        '.srt'  => 'text/plain',
+        '.vtt'  => 'text/vtt',
+        '.wav'  => 'audio/wav',
+        '.webm' => 'video/webm',
+        '.zip'  => 'application/zip'
+      }
+    end
+
+    # Maps media types to preferred file extensions
+    mattr_accessor :preferred_file_extensions do
+      {
+        'application/zip' => 'zip',
+        'audio/mp4'       => 'm4a',
+        'audio/mpeg'      => 'mp3',
+        'audio/ogg'       => 'ogg',
+        'audio/wav'       => 'wav',
+        'text/vtt'        => 'vtt',
+        'video/flv'       => 'flv',
+        'video/mp4'       => 'mp4',
+        'video/quicktime' => 'mov',
+        'video/webm'      => 'webm'
       }
     end
 

data/lib/ddr/models/base.rb

@@ -31,8 +31,8 @@ module Ddr
       before_create :set_ingested_by, if: :performed_by, unless: :ingested_by
       before_create :grant_default_roles
 
-      after_create :notify_ingest
       after_create :assign_permanent_id!, if: :assign_permanent_id?
+      after_create :notify_ingest
 
       around_save :notify_update, unless: :new_record?
 
@@ -95,6 +95,10 @@ module Ddr
         datastreams.select { |dsid, ds| ds.changed? }
       end
 
+      def new_datastreams_having_content
+        datastreams.select { |dsid, ds| ds.new? && ds.has_content? }
+      end
+
       def datastreams_having_content
         datastreams.select { |dsid, ds| ds.has_content? }
       end
@@ -108,6 +112,12 @@ module Ddr
         end
       end
 
+      def parent_id
+        parent.id
+      rescue NoMethodError
+        nil
+      end
+
       private
 
       def grant_default_roles
@@ -141,7 +151,9 @@ module Ddr
           .merge(pid: pid,
                  user_key: performed_by,
                  permanent_id: permanent_id,
-                 model: self.class.to_s)
+                 model: self.class.to_s,
+                 parent: parent_id,
+                 skip_structure_updates: cache.fetch(:skip_structure_updates, false))
       end
 
       def notify_ingest
@@ -156,6 +168,7 @@ module Ddr
         event_params = default_notification_payload.merge(
           attributes_changed: changes,
           datastreams_changed: datastreams_changed.keys,
+          new_datastreams: new_datastreams_having_content.keys,
           skip_update_derivatives: cache.fetch(:skip_update_derivatives, false)
         )
         ActiveSupport::Notifications.instrument(UPDATE, event_params) do |payload|

data/lib/ddr/models/captionable.rb

@@ -0,0 +1,37 @@
+module Ddr::Models
+  module Captionable
+    extend ActiveSupport::Concern
+
+    included do
+      has_file_datastream name: Ddr::Datastreams::CAPTION,
+                          type: Ddr::Datastreams::CaptionDatastream,
+                          versionable: true,
+                          label: "Caption file for this object",
+                          control_group: "E"
+    end
+
+    def caption_type
+      datastreams[Ddr::Datastreams::CAPTION].mimeType
+    end
+
+    def caption_extension
+      extensions = Ddr::Models.preferred_file_extensions
+      if extensions.include? caption_type
+        extensions[caption_type]
+      else
+        caption_extension_default
+      end
+    end
+
+    def caption_path
+      datastreams[Ddr::Datastreams::CAPTION].file_path
+    end
+
+    private
+    
+    def caption_extension_default
+      datastreams[Ddr::Datastreams::CAPTION].default_file_extension
+    end
+
+  end
+end

data/lib/ddr/models/has_children.rb

@@ -8,38 +8,10 @@ module Ddr
         ActiveFedora::SolrService.lazy_reify_solr_results(sorted_children).first
       end
 
-      def default_structure
-        if children.present?
-          build_default_structure
-        end
-      end
-
       def sorted_children
         ActiveFedora::SolrService.query(association_query(:children), sort: DEFAULT_SORT, rows: 999999)
       end
 
-      private
-
-      def build_default_structure
-        document = Ddr::Models::Structure.xml_template
-        structure = Ddr::Models::Structure.new(document)
-        metshdr = structure.add_metshdr
-        structure.add_agent(parent: metshdr, role: Ddr::Models::Structures::Agent::ROLE_CREATOR,
-                            name: Ddr::Models::Structures::Agent::NAME_REPOSITORY_DEFAULT)
-        structmap = structure.add_structmap(type: Ddr::Models::Structure::TYPE_DEFAULT)
-        add_children(structure, structmap, sorted_children)
-        structure
-      end
-
-      def add_children(structure, structmap, children)
-        count = 0
-        children.each do |child|
-          count += 1
-          div = structure.add_div(parent: structmap, order: count)
-          structure.add_mptr(parent: div, href: child[Ddr::Index::Fields::PERMANENT_ID])
-        end
-      end
-
     end
   end
 end

data/lib/ddr/models/has_intermediate_file.rb

@@ -13,6 +13,29 @@ module Ddr
         include FileManagement
       end
 
+      def intermediate_type
+        datastreams[Ddr::Datastreams::INTERMEDIATE_FILE].mimeType
+      end
+
+      def intermediate_extension
+        extensions = Ddr::Models.preferred_file_extensions
+        if extensions.include? intermediate_type
+          extensions[intermediate_type]
+        else
+          intermediate_extension_default
+        end
+      end
+
+      def intermediate_path
+        datastreams[Ddr::Datastreams::INTERMEDIATE_FILE].file_path
+      end
+
+      private
+
+      def intermediate_extension_default
+        datastreams[Ddr::Datastreams::INTERMEDIATE_FILE].default_file_extension
+      end
+
     end
   end
 end