ddr-models 2.8.0 → 2.9.0.rc1

data/lib/ddr/models/indexing.rb

@@ -128,6 +128,8 @@ module Ddr::Models
       if is_a? Item
         fields[ADMIN_SET_FACET] = admin_set_facet
         fields[COLLECTION_FACET] = collection_facet
+        fields[NESTED_PATH] = nested_path
+        fields[NESTED_PATH_TEXT] = nested_path
         fields[ALL_TEXT] = all_text
       end
       fields

data/lib/ddr/models/solr_document.rb

@@ -141,6 +141,10 @@ module Ddr::Models
       has_datastream?(Ddr::Datastreams::CONTENT)
     end
 
+    def has_intermediate_file?
+      has_datastream?(Ddr::Datastreams::INTERMEDIATE_FILE)
+    end
+
     def has_extracted_text?
       has_datastream?(Ddr::Datastreams::EXTRACTED_TEXT)
     end
@@ -233,10 +237,77 @@ module Ddr::Models
       end
     end
 
+    def intermediate_type
+      if has_intermediate_file?
+        datastreams[Ddr::Datastreams::INTERMEDIATE_FILE]["dsMIME"]
+      end
+    end
+
+    def intermediate_path
+      if has_intermediate_file?
+        Ddr::Utils.path_from_uri(datastreams[Ddr::Datastreams::INTERMEDIATE_FILE]["dsLocation"])
+      end
+    end
+
+    def intermediate_extension
+      if has_intermediate_file?
+        extensions = Ddr::Models.preferred_file_extensions
+        if extensions.include? intermediate_type
+          extensions[intermediate_type]
+        else
+          intermediate_extension_default
+        end
+      end
+    end
+
+    def captionable?
+      has_datastream?(Ddr::Datastreams::CAPTION)
+    end
+
+    def caption_type
+      if captionable?
+        datastreams[Ddr::Datastreams::CAPTION]["dsMIME"]
+      end
+    end
+
+    def caption_extension
+      if captionable?
+        extensions = Ddr::Models.preferred_file_extensions
+        if extensions.include? caption_type
+          extensions[caption_type]
+        else
+          caption_extension_default
+        end
+      end
+    end
+
+    def caption_path
+      if captionable?
+        Ddr::Utils.path_from_uri(datastreams[Ddr::Datastreams::CAPTION]["dsLocation"])
+      end
+    end
+
     def streamable?
       has_datastream?(Ddr::Datastreams::STREAMABLE_MEDIA)
     end
 
+    def streamable_media_extension
+      if streamable?
+        extensions = Ddr::Models.preferred_file_extensions
+        if extensions.include? streamable_media_type
+          extensions[streamable_media_type]
+        else
+          streamable_media_extension_default
+        end
+      end
+    end
+
+    def streamable_media_type
+      if streamable?
+        datastreams[Ddr::Datastreams::STREAMABLE_MEDIA]["dsMIME"]
+      end
+    end
+
     def streamable_media_path
       if streamable?
         Ddr::Utils.path_from_uri(datastreams[Ddr::Datastreams::STREAMABLE_MEDIA]["dsLocation"])
@@ -248,6 +319,10 @@ module Ddr::Models
       self["rights_tesim"]
     end
 
+    def children
+      children_query.docs rescue []
+    end
+
     private
 
     def targets_query
@@ -296,5 +371,29 @@ module Ddr::Models
       structure['default'] || structure.values.first
     end
 
+    def intermediate_extension_default
+      datastreams[Ddr::Datastreams::INTERMEDIATE_FILE].default_file_extension
+    end
+
+    def caption_extension_default
+      datastreams[Ddr::Datastreams::CAPTION].default_file_extension
+    end
+
+    def streamable_media_extension_default
+      datastreams[Ddr::Datastreams::STREAMABLE_MEDIA].default_file_extension
+    end
+
+    def children_query
+      case self[Ddr::Index::Fields::ACTIVE_FEDORA_MODEL]
+        when 'Collection'
+          Ddr::Index::Query.build(self) do |parent|
+            is_member_of_collection parent.id
+          end
+        when 'Item'
+          Ddr::Index::Query.build(self) do |parent|
+            is_part_of parent.id
+          end
+      end
+    end
   end
 end

data/lib/ddr/models/streamable.rb

@@ -14,9 +14,24 @@ module Ddr::Models
       datastreams[Ddr::Datastreams::STREAMABLE_MEDIA].mimeType
     end
 
+    def streamable_media_extension
+      extensions = Ddr::Models.preferred_file_extensions
+      if extensions.include? streamable_media_type
+        extensions[streamable_media_type]
+      else
+        streamable_media_extension_default
+      end
+    end
+
     def streamable_media_path
       datastreams[Ddr::Datastreams::STREAMABLE_MEDIA].file_path
     end
 
+    private
+
+    def streamable_media_extension_default
+      datastreams[Ddr::Datastreams::STREAMABLE_MEDIA].default_file_extension
+    end
+
   end
 end

data/lib/ddr/models/version.rb

@@ -1,5 +1,5 @@
 module Ddr
   module Models
-    VERSION = "2.8.0"
+    VERSION = "2.9.0.rc1"
   end
 end

data/lib/ddr/vocab/asset.rb

@@ -43,5 +43,9 @@ module Ddr::Vocab
              label: "Affiliation",
              comment: "An organizational entity associated with the object content."
 
+    property "nestedPath",
+             label: "Nested Path",
+             comment: "The nested/tree path to the object to be reflected in structural metadata."
+
   end
 end

data/spec/fixtures/abcd1234.vtt

@@ -0,0 +1,38 @@
+WEBVTT
+
+00:01.835 --> 00:02.736
+Lorem ipsum dolor sit amet.
+
+00:02.736 --> 00:03.837
+Vestibulum pretium ligula quis nunc commodo dictum.
+
+00:03.837 --> 00:04.637
+Donec sit amet eros rutrum, elementum neque vitae, volutpat sapien.
+
+00:04.637 --> 00:05.939
+Vivamus sed turpis ut nisi cursus volutpat in non arcu.
+
+00:05.939 --> 00:07.574
+Praesent dignissim lectus sed dignissim ultricies.
+
+00:07.574 --> 00:08.942
+>> ♪ Quisque eget neque maximus, lobortis sem quis, dapibus ipsum.
+
+00:08.942 --> 00:09.542
+Pellentesque eu risus id tellus placerat maximus.
+
+00:09.542 --> 00:11.778
+♪ Proin dapibus purus et magna euismod, non vestibulum ligula pellentesque.
+
+00:11.778 --> 00:13.980
+Vivamus porttitor nibh eget nunc semper, ac tristique arcu scelerisque.
+
+00:13.980 --> 00:15.882
+♪ Maecenas gravida justo sit amet urna scelerisque, eget porttitor mauris interdum.
+
+00:15.882 --> 00:18.752
+Pellentesque consectetur lacus eget bibendum rutrum.
+
+00:18.752 --> 00:20.387
+♪ Quisque semper magna ultrices libero iaculis fermentum.
+

data/spec/models/active_fedora_base_spec.rb

@@ -24,6 +24,9 @@ RSpec.describe ActiveFedora::Base do
     end
   end
 
+  its(:captionable?) { is_expected.to be false }
+  it { is_expected.not_to be_captioned }
+
   its(:can_be_streamable?) { is_expected.to be false }
   it { is_expected.not_to be_streamable }
 

data/spec/models/collection_spec.rb

@@ -101,4 +101,156 @@ RSpec.describe Collection, type: :model do
     }
   end
 
+  describe "#default_structure" do
+    before do
+      allow(SecureRandom).to receive(:uuid).and_return("abc-def", "ghi-jkl", "mno-pqr", "stu-vwx", "yza-bcd", "efg-hij")
+    end
+    describe "when the collection has no items" do
+      let(:expected) do
+        xml = <<-EOS
+            <mets xmlns="http://www.loc.gov/METS/" xmlns:xlink="http://www.w3.org/1999/xlink">
+              <metsHdr>
+                <agent ROLE="#{Ddr::Models::Structures::Agent::ROLE_CREATOR}">
+                  <name>#{Ddr::Models::Structures::Agent::NAME_REPOSITORY_DEFAULT}</name>
+                </agent>
+              </metsHdr>
+              <structMap TYPE="#{Ddr::Models::Structure::TYPE_DEFAULT}" />
+            </mets>
+        EOS
+        xml
+      end
+      it "should be the appropriate structure" do
+        expect(subject.default_structure.to_xml).to be_equivalent_to(expected)
+      end
+    end
+    describe "when the collection has items" do
+      let(:item1) { FactoryGirl.create(:item) }
+      let(:item2) { FactoryGirl.create(:item) }
+      before do
+        item1.local_id = "test002"
+        item1.permanent_id = "ark:/99999/fk4aaa"
+        item1.save!
+        item2.local_id = "test001"
+        item2.permanent_id = "ark:/99999/fk4bbb"
+        item2.save!
+        subject.children << item1
+        subject.children << item2
+        subject.save!
+      end
+      after do
+        item1.destroy
+        item2.destroy
+      end
+      describe "without nested paths" do
+        let(:expected) do
+          xml = <<-EOS
+            <mets xmlns="http://www.loc.gov/METS/" xmlns:xlink="http://www.w3.org/1999/xlink">
+              <metsHdr>
+                <agent ROLE="#{Ddr::Models::Structures::Agent::ROLE_CREATOR}">
+                  <name>#{Ddr::Models::Structures::Agent::NAME_REPOSITORY_DEFAULT}</name>
+                </agent>
+              </metsHdr>
+              <structMap TYPE="#{Ddr::Models::Structure::TYPE_DEFAULT}">
+                <div ORDER="1">
+                  <mptr LOCTYPE="ARK" xlink:href="ark:/99999/fk4bbb" />
+                </div>
+                <div ORDER="2">
+                  <mptr LOCTYPE="ARK" xlink:href="ark:/99999/fk4aaa" />
+                </div>
+              </structMap>
+            </mets>
+          EOS
+          xml
+        end
+        it "should be the appropriate structure" do
+          expect(subject.default_structure.to_xml).to be_equivalent_to(expected)
+        end
+      end
+      describe "with nested paths" do
+        let(:item3) { FactoryGirl.create(:item) }
+        let(:item4) { FactoryGirl.create(:item) }
+        let(:item5) { FactoryGirl.create(:item) }
+        let(:item6) { FactoryGirl.create(:item) }
+        let(:expected) do
+          xml = <<-EOS
+            <mets xmlns="http://www.loc.gov/METS/" xmlns:xlink="http://www.w3.org/1999/xlink">
+              <metsHdr>
+                <agent ROLE="#{Ddr::Models::Structures::Agent::ROLE_CREATOR}">
+                  <name>#{Ddr::Models::Structures::Agent::NAME_REPOSITORY_DEFAULT}</name>
+                </agent>
+              </metsHdr>
+              <structMap TYPE="#{Ddr::Models::Structure::TYPE_DEFAULT}">
+                <div LABEL="foo" ORDER="1" TYPE="Directory">
+                  <div LABEL="b&amp;apos;a&amp;quot;r&amp;quot;" ORDER="1" TYPE="Directory">
+                    <div ORDER="1">
+                      <mptr LOCTYPE="ARK" xlink:href="ark:/99999/fk4aaa" />
+                    </div>
+                    <div ORDER="2">
+                      <mptr LOCTYPE="ARK" xlink:href="ark:/99999/fk4bbb" />
+                    </div>
+                  </div>
+                  <div LABEL="baz" ORDER="2" TYPE="Directory">
+                    <div ORDER="1">
+                      <mptr LOCTYPE="ARK" xlink:href="ark:/99999/fk4ddd" />
+                    </div>
+                    <div ORDER="2">
+                      <mptr LOCTYPE="ARK" xlink:href="ark:/99999/fk4ccc" />
+                    </div>
+                  </div>
+                  <div ORDER="3">
+                    <mptr LOCTYPE="ARK" xlink:href="ark:/99999/fk4fff" />
+                  </div>
+                  <div ORDER="4">
+                    <mptr LOCTYPE="ARK" xlink:href="ark:/99999/fk4eee" />
+                  </div>
+                </div>
+              </structMap>
+            </mets>
+          EOS
+          xml
+        end
+        before do
+          item3.local_id = "test003"
+          item3.permanent_id = "ark:/99999/fk4ccc"
+          item3.save!
+          item4.local_id = "test004"
+          item4.permanent_id = "ark:/99999/fk4ddd"
+          item4.save!
+          item5.local_id = "test005"
+          item5.permanent_id = "ark:/99999/fk4eee"
+          item5.save!
+          item6.local_id = "test006"
+          item6.permanent_id = "ark:/99999/fk4fff"
+          item6.save!
+          subject.children << item3
+          subject.children << item4
+          subject.children << item5
+          subject.children << item6
+          subject.save!
+          item1.nested_path = %Q[foo/b'a"r"/a.doc]
+          item1.save!
+          item2.nested_path = %Q[foo/b'a"r"/b.txt]
+          item2.save!
+          item3.nested_path = %Q[foo/baz/d.pdf]
+          item3.save!
+          item4.nested_path = %Q[foo/baz/c.txt]
+          item4.save!
+          item5.nested_path = %Q[foo/f.doc]
+          item5.save!
+          item6.nested_path = %Q[foo/e.pdf]
+          item6.save!
+        end
+        after do
+          item3.destroy
+          item4.destroy
+          item5.destroy
+          item6.destroy
+        end
+        it "should be the appropriate structure" do
+          expect(subject.default_structure.to_xml).to be_equivalent_to(expected)
+        end
+      end
+    end
+  end
+
 end

data/spec/models/component_spec.rb

@@ -6,6 +6,7 @@ RSpec.describe Component, type: :model, components: true do
   it_behaves_like "it has an association", :belongs_to, :target, :has_external_target, "Target"
   it_behaves_like "a non-collection model"
   it_behaves_like "a potentially publishable object"
+  it_behaves_like "an object that can be captioned"
   it_behaves_like "an object that can have an intermediate file"
   it_behaves_like "an object that can be streamable"
 
@@ -19,8 +20,21 @@ RSpec.describe Component, type: :model, components: true do
 
   describe "default structure" do
     describe "no content" do
-      it "should be nil" do
-        expect(subject.default_structure).to be_nil
+      let(:expected) do
+        xml = <<-EOS
+            <mets xmlns="http://www.loc.gov/METS/" xmlns:xlink="http://www.w3.org/1999/xlink">
+              <metsHdr>
+                <agent ROLE="#{Ddr::Models::Structures::Agent::ROLE_CREATOR}">
+                  <name>#{Ddr::Models::Structures::Agent::NAME_REPOSITORY_DEFAULT}</name>
+                </agent>
+              </metsHdr>
+              <structMap TYPE="#{Ddr::Models::Structure::TYPE_DEFAULT}" />
+            </mets>
+        EOS
+        xml
+      end
+      it "should be the appropriate structure" do
+        expect(described_class.new.default_structure.to_xml).to be_equivalent_to(expected)
       end
     end
     describe "has content" do
@@ -80,6 +94,22 @@ RSpec.describe Component, type: :model, components: true do
           end
         end
       end
+      describe "transcript" do
+        describe "with caption file" do
+          before do
+            allow(subject).to receive(:captioned?) { true }
+          end
+          it "has the correct structure file" do
+            expect(struct.uses[Ddr::Models::Structure::USE_TRANSCRIPT].first.href)
+                .to eq(Ddr::Datastreams::CAPTION)
+          end
+        end
+        describe "without caption file" do
+          it "has the correct structure file" do
+            expect(struct.uses[Ddr::Models::Structure::USE_TRANSCRIPT]).to be nil
+          end
+        end
+      end
       it "has the correct thumbnail image" do
         expect(struct.uses[Ddr::Models::Structure::USE_THUMBNAIL_IMAGE].first.href).to eq(Ddr::Datastreams::THUMBNAIL)
       end

data/spec/models/has_children_spec.rb

@@ -27,56 +27,5 @@ module Ddr::Models
       end
     end
 
-    describe "#default_structure" do
-      describe "when the object has no children" do
-        it "should be nil" do
-          expect(subject.default_structure).to be_nil
-        end
-      end
-      describe "when the object has children" do
-        let(:child1) { FactoryGirl.create(:item) }
-        let(:child2) { FactoryGirl.create(:item) }
-        let(:expected) do
-          xml = <<-EOS
-            <mets xmlns="http://www.loc.gov/METS/" xmlns:xlink="http://www.w3.org/1999/xlink">
-              <metsHdr>
-                <agent ROLE="#{Ddr::Models::Structures::Agent::ROLE_CREATOR}">
-                  <name>#{Ddr::Models::Structures::Agent::NAME_REPOSITORY_DEFAULT}</name>
-                </agent>
-              </metsHdr>
-              <structMap TYPE="#{Ddr::Models::Structure::TYPE_DEFAULT}">
-                <div ORDER="1">
-                  <mptr LOCTYPE="ARK" xlink:href="ark:/99999/fk4bbb" />
-                </div>
-                <div ORDER="2">
-                  <mptr LOCTYPE="ARK" xlink:href="ark:/99999/fk4aaa" />
-                </div>
-              </structMap>
-            </mets>
-          EOS
-          xml
-        end
-        before do
-          child1.local_id = "test002"
-          child1.permanent_id = "ark:/99999/fk4aaa"
-          child1.save!
-          child2.local_id = "test001"
-          child2.permanent_id = "ark:/99999/fk4bbb"
-          child2.save!
-          subject.children << child1
-          subject.children << child2
-          subject.save!
-          allow(SecureRandom).to receive(:uuid).and_return("abc-def", "ghi-jkl")
-        end
-        after do
-          child1.destroy
-          child2.destroy
-        end
-        it "should be the appropriate structure" do
-          expect(subject.default_structure.to_xml).to be_equivalent_to(expected)
-        end
-      end
-    end
-
   end
 end