ddr-models 2.6.2 → 2.7.0.rc1

data/spec/models/structures/agent_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module Ddr::Models::Structures
+  RSpec.describe Agent, type: :model, structure: true do
+
+    let(:attrs) { { id: 'abc', role: 'OTHER', otherrole: 'INVESTIGATOR', type: 'OTHER', othertype: 'SOMETHING',
+                    name: 'Sam Spade' } }
+    let(:doc) { Ddr::Models::Structure.xml_template }
+    let(:node) do
+      node = Nokogiri::XML::Node.new('agent', doc)
+      node['ID'] = attrs[:id]
+      node['ROLE'] = attrs[:role]
+      node['OTHERROLE'] = attrs[:otherrole]
+      node['TYPE'] = attrs[:type]
+      node['OTHERTYPE'] = attrs[:othertype]
+      doc.root.add_child(node)
+      name_node = Nokogiri::XML::Node.new('name', doc)
+      name_node.content = 'Sam Spade'
+      node.add_child(name_node)
+      node
+    end
+
+    describe ".build" do
+      it "should build the correct node" do
+        expect(described_class.build(attrs.merge(document: doc)).to_xml).to be_equivalent_to(node.to_xml)
+      end
+    end
+
+  end
+end

data/spec/models/structures/div_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module Ddr::Models::Structures
+  RSpec.describe Div, type: :model, structure: true do
+
+    let(:attrs) { { id: 'abc', label: 'ghi', order: '5', orderlabel: 'def', type: 'pqr' } }
+    let(:doc) { Ddr::Models::Structure.xml_template }
+    let(:node) do
+      node = Nokogiri::XML::Node.new('div', doc)
+      node['ID'] = attrs[:id]
+      node['LABEL'] = attrs[:label]
+      node['ORDER'] = attrs[:order]
+      node['ORDERLABEL'] = attrs[:orderlabel]
+      node['TYPE'] = attrs[:type]
+      doc.root.add_child(node)
+      node
+    end
+
+    describe ".build" do
+      it "should build the correct node" do
+        expect(described_class.build(attrs.merge(document: doc)).to_xml).to be_equivalent_to(node.to_xml)
+      end
+    end
+
+  end
+end

data/spec/models/structures/f_locat_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+module Ddr::Models::Structures
+  RSpec.describe FLocat, type: :model, structure: true do
+
+    let(:attrs) { { id: 'abc', loctype: 'OTHER', use: 'def', href: 'ijk' } }
+    let(:doc) { Ddr::Models::Structure.xml_template }
+    let(:node) do
+      node = Nokogiri::XML::Node.new('FLocat', doc)
+      node['ID'] = attrs[:id]
+      node['LOCTYPE'] = attrs[:loctype]
+      node['USE'] = attrs[:use]
+      node['xlink:href'] = attrs[:href]
+      doc.root.add_child(node)
+      node
+    end
+
+    describe ".build" do
+      it "should build the correct node" do
+        expect(described_class.build(attrs.merge(document: doc)).to_xml).to be_equivalent_to(node.to_xml)
+      end
+    end
+
+    describe "location" do
+      describe "is not an ARK" do
+        subject { described_class.new(node) }
+        its(:ark?) { is_expected.to eq(false) }
+        its(:ark) { is_expected.to be_nil }
+        its(:repo_id) { is_expected.to be_nil }
+      end
+      describe "is an ARK" do
+        let(:node) do
+          node = Nokogiri::XML::Node.new('FLocat', doc)
+          node['LOCTYPE'] = 'ARK'
+          node['xlink:href'] = 'ark:/99999/fk4edf'
+          doc.root.add_child(node)
+          node
+        end
+        let(:repo_object) { Item.create }
+        before { repo_object.update_attributes(permanent_id: 'ark:/99999/fk4edf') }
+        subject { described_class.new(node) }
+        its(:ark?) { is_expected.to eq(true) }
+        its(:ark) { is_expected.to eq('ark:/99999/fk4edf') }
+        its(:repo_id) { is_expected.to eq(repo_object.id) }
+      end
+    end
+
+    describe "effective use" do
+      before do
+        allow(subject).to receive(:parent) { Nokogiri::XML::Node.new('file', doc) }
+      end
+      describe "use attribute present" do
+        subject { described_class.new(node) }
+        its(:effective_use) { is_expected.to eq(subject.use) }
+      end
+      describe "use attribute not present" do
+        before do
+          allow(subject).to receive(:use) { nil }
+        end
+        describe "parent node has effective use" do
+          subject { described_class.new(node) }
+          before do
+            allow_any_instance_of(File).to receive(:effective_use) { 'xyz' }
+          end
+          its(:effective_use) { is_expected.to eq('xyz') }
+        end
+        describe "parent node does not have an effective use" do
+          subject { described_class.new(node) }
+          before do
+            allow_any_instance_of(File).to receive(:effective_use) { nil }
+          end
+          its(:effective_use) { is_expected.to be_nil }
+        end
+      end
+    end
+
+  end
+end

data/spec/models/structures/file_grp_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module Ddr::Models::Structures
+  RSpec.describe FileGrp, type: :model, structure: true do
+
+    let(:attrs) { { id: 'abc', use: 'efg' } }
+    let(:doc) { Ddr::Models::Structure.xml_template }
+    let(:node) do
+      node = Nokogiri::XML::Node.new('fileGrp', doc)
+      node['ID'] = attrs[:id]
+      node['USE'] = attrs[:use]
+      doc.root.add_child(node)
+      node
+    end
+
+    describe ".build" do
+      it "should build the correct node" do
+        expect(described_class.build(attrs.merge(document: doc)).to_xml).to be_equivalent_to(node.to_xml)
+      end
+    end
+
+  end
+end

data/spec/models/structures/file_sec_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module Ddr::Models::Structures
+  RSpec.describe FileSec, type: :model, structure: true do
+
+    let(:attrs) { { id: 'abc' } }
+    let(:doc) { Ddr::Models::Structure.xml_template }
+    let(:node) do
+      node = Nokogiri::XML::Node.new('fileSec', doc)
+      node['ID'] = attrs[:id]
+      doc.root.add_child(node)
+      node
+    end
+
+    describe ".build" do
+      it "should build the correct node" do
+        expect(described_class.build(attrs.merge(document: doc)).to_xml).to be_equivalent_to(node.to_xml)
+      end
+    end
+
+  end
+end

data/spec/models/structures/file_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+module Ddr::Models::Structures
+  RSpec.describe File, type: :model, structure: true do
+
+    let(:attrs) { { id: 'abc', use: 'efg' } }
+    let(:doc) { Ddr::Models::Structure.xml_template }
+    let(:node) do
+      node = Nokogiri::XML::Node.new('file', doc)
+      node['ID'] = attrs[:id]
+      node['USE'] = attrs[:use]
+      doc.root.add_child(node)
+      node
+    end
+
+    describe ".build" do
+      it "should build the correct node" do
+        expect(described_class.build(attrs.merge(document: doc)).to_xml).to be_equivalent_to(node.to_xml)
+      end
+    end
+
+    describe ".find" do
+      let(:structure) { FactoryGirl.build(:simple_structure) }
+      it "finds the requested File" do
+        expect(File.find(structure, 'def')).to be_a(File)
+        expect(File.find(structure, 'def').id).to eq('def')
+      end
+    end
+
+    describe "effective use" do
+      before do
+        allow(subject).to receive(:parent) { Nokogiri::XML::Node.new('fileGrp', doc) }
+      end
+      describe "use attribute present" do
+        subject { described_class.new(node) }
+        its(:effective_use) { is_expected.to eq(subject.use) }
+      end
+      describe "use attribute not present" do
+        before do
+          allow(subject).to receive(:use) { nil }
+        end
+        describe "parent node has effective use" do
+          subject { described_class.new(node) }
+          before do
+            allow_any_instance_of(FileGrp).to receive(:effective_use) { 'xyz' }
+          end
+          its(:effective_use) { is_expected.to eq('xyz') }
+        end
+        describe "parent node does not have an effective use" do
+          subject { described_class.new(node) }
+          before do
+            allow_any_instance_of(FileGrp).to receive(:effective_use) { nil }
+          end
+          its(:effective_use) { is_expected.to be_nil }
+        end
+      end
+    end
+
+  end
+end

data/spec/models/structures/fptr_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module Ddr::Models::Structures
+  RSpec.describe Fptr, type: :model, structure: true do
+
+    let(:attrs) { { id: 'abc', fileid: 'def' } }
+    let(:doc) { Ddr::Models::Structure.xml_template }
+    let(:node) do
+      node = Nokogiri::XML::Node.new('fptr', doc)
+      node['ID'] = attrs[:id]
+      node['FILEID'] = attrs[:fileid]
+      doc.root.add_child(node)
+      node
+    end
+
+    describe ".build" do
+      it "should build the correct node" do
+        expect(described_class.build(attrs.merge(document: doc)).to_xml).to be_equivalent_to(node.to_xml)
+      end
+    end
+
+  end
+end

data/spec/models/structures/mets_hdr_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module Ddr::Models::Structures
+  RSpec.describe MetsHdr, type: :model, structure: true do
+
+    let(:attrs) { { id: 'abc', createdate: '2017-01-17T16:48:36Z', lastmoddate: '2017-01-18T16:46:48Z',
+                    recordstatus: 'foo' } }
+    let(:doc) { Ddr::Models::Structure.xml_template }
+    let(:node) do
+      node = Nokogiri::XML::Node.new('metsHdr', doc)
+      node['ID'] = attrs[:id]
+      node['CREATEDATE'] = attrs[:createdate]
+      node['LASTMODDATE'] = attrs[:lastmoddate]
+      node['RECORDSTATUS'] = attrs[:recordstatus]
+      doc.root.add_child(node)
+      node
+    end
+
+    describe ".build" do
+      it "should build the correct node" do
+        expect(described_class.build(attrs.merge(document: doc)).to_xml).to be_equivalent_to(node.to_xml)
+      end
+    end
+
+  end
+end

data/spec/models/structures/mptr_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module Ddr::Models::Structures
+  RSpec.describe Mptr, type: :model, structure: true do
+
+    let(:attrs) { { id: 'abc', loctype: 'OTHER', otherloctype: 'def', href: 'ijk' } }
+    let(:doc) { Ddr::Models::Structure.xml_template }
+    let(:node) do
+      node = Nokogiri::XML::Node.new('mptr', doc)
+      node['ID'] = attrs[:id]
+      node['LOCTYPE'] = attrs[:loctype]
+      node['OTHERLOCTYPE'] = attrs[:otherloctype]
+      node['xlink:href'] = attrs[:href]
+      doc.root.add_child(node)
+      node
+    end
+
+    describe ".build" do
+      it "should build the correct node" do
+        expect(described_class.build(attrs.merge(document: doc)).to_xml).to be_equivalent_to(node.to_xml)
+      end
+    end
+
+  end
+end

data/spec/models/structures/struct_map_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+module Ddr::Models::Structures
+  RSpec.describe StructMap, type: :model, structure: true do
+
+    let(:attrs) { { id: 'abc', label: 'ghi', type: 'def' } }
+    let(:doc) { Ddr::Models::Structure.xml_template }
+    let(:node) do
+      node = Nokogiri::XML::Node.new('structMap', doc)
+      node['ID'] = attrs[:id]
+      node['LABEL'] = attrs[:label]
+      node['TYPE'] = attrs[:type]
+      doc.root.add_child(node)
+      node
+    end
+
+    describe ".build" do
+      it "should build the correct node" do
+        expect(described_class.build(attrs.merge(document: doc)).to_xml).to be_equivalent_to(node.to_xml)
+      end
+    end
+
+  end
+end

data/spec/models/target_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Target, type: :model, targets: true do
 
   it_behaves_like "a DDR model"

data/spec/spec_helper.rb

@@ -85,7 +85,7 @@ RSpec.configure do |config|
   # Print the 10 slowest examples and example groups at the
   # end of the spec run, to help surface which specs are running
   # particularly slow.
-  config.profile_examples = 10
+  # config.profile_examples = 10
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing
@@ -108,19 +108,14 @@ RSpec.configure do |config|
       config.update_derivatives = [ :multires_image, :thumbnail ]
     end
     Ddr::Models.configure do |config|
-      config.external_file_store = Dir.mktmpdir
-      config.multires_image_external_file_store = Dir.mktmpdir
-      config.external_file_subpath_pattern = "--"
       config.fits_home = Dir.mktmpdir
     end
+    Ddr::Datastreams::ExternalFileDatastream.file_store = Dir.mktmpdir
   end
 
   config.after(:suite) do
-    if Ddr::Models.external_file_store && Dir.exist?(Ddr::Models.external_file_store)
-      FileUtils.remove_entry_secure(Ddr::Models.external_file_store)
-    end
-    if Ddr::Models.multires_image_external_file_store && Dir.exist?(Ddr::Models.multires_image_external_file_store)
-      FileUtils.remove_entry_secure(Ddr::Models.multires_image_external_file_store)
+    if Ddr::Datastreams::ExternalFileDatastream.file_store
+      FileUtils.rm_rf Ddr::Datastreams::ExternalFileDatastream.file_store
     end
   end
 

data/spec/support/shared_examples_for_ddr_models.rb

@@ -2,10 +2,64 @@ RSpec.shared_examples "a DDR model" do
 
   it_behaves_like "a describable object"
   it_behaves_like "a governable object"
-  it_behaves_like "an access controllable object"
   it_behaves_like "an object that has a display title"
   it_behaves_like "an object that has identifiers"
 
+  describe "ingested by" do
+    let(:user) { User.new(username: "foo@bar.com") }
+    describe "on create" do
+      describe "when :user option passed to #save" do
+        describe "and ingested_by is not set" do
+          it "sets ingested by" do
+            expect { subject.save(user: user) }.to change(subject, :ingested_by).from(nil).to("foo@bar.com")
+          end
+        end
+        describe "and ingested_by is set" do
+          before { subject.ingested_by = "bob@example.com" }
+          it "does not set ingested by" do
+            expect { subject.save(user: user) }.not_to change(subject, :ingested_by)
+          end
+        end
+      end
+      describe "when :user option passed to #save!" do
+        describe "and ingested_by is not set" do
+          it "sets ingested by" do
+            expect { subject.save!(user: user) }.to change(subject, :ingested_by).from(nil).to("foo@bar.com")
+          end
+        end
+        describe "and ingested_by is set" do
+          before { subject.ingested_by = "bob@example.com" }
+          it "does not set ingested by" do
+            expect { subject.save!(user: user) }.not_to change(subject, :ingested_by)
+          end
+        end
+      end
+    end
+    describe "saving after create" do
+      before { subject.save! }
+      it "does not set ingested_by" do
+        expect { subject.save(user: user) }.not_to change(subject, :ingested_by)
+        expect { subject.save!(user: user) }.not_to change(subject, :ingested_by)
+      end
+    end
+  end
+
+  describe "ingestion date" do
+    describe "on create" do
+      describe "when it's set" do
+        before { subject.ingestion_date = "2017-01-13T19:03:15Z" }
+        it "preserves the date" do
+          expect { subject.save! }.not_to change(subject, :ingestion_date)
+        end
+      end
+      describe "when it's not set" do
+        it "sets the date" do
+          expect { subject.save! }.to change(subject, :ingestion_date)
+        end
+      end
+    end
+  end
+
   describe "permanent ID assignment" do
     describe "when auto assignment is enabled" do
       before do
@@ -36,80 +90,55 @@ RSpec.shared_examples "a DDR model" do
     end
   end
 
-  describe "notification on save" do
-    let(:events) { [] }
-    before {
-      @subscriber = ActiveSupport::Notifications.subscribe("save.#{described_class.to_s.underscore}") do |name, start, finish, id, payload|
-        events << payload
-      end
-    }
-    after {
-      ActiveSupport::Notifications.unsubscribe(@subscriber)
-    }
-    it "happens when save succeeds" do
-      subject.title = [ "My Title Changed" ]
-      subject.save
-      subject.title = [ "My Title Changed Again" ]
-      subject.save
-      expect(events.first[:changes]).to eq({"title"=>[[], ["My Title Changed"]]})
-      expect(events.first[:created]).to be true
-      expect(events.first[:pid]).to eq(subject.pid)
-      expect(events.last[:changes]).to eq({"title"=>[["My Title Changed"], ["My Title Changed Again"]]})
-      expect(events.last[:created]).to be false
-      expect(events.last[:pid]).to eq(subject.pid)
-    end
-  end
-
-  describe "notification on workflow state change" do
-    let(:events) { [] }
-    before {
-      @subscriber = ActiveSupport::Notifications.subscribe(/workflow\.#{described_class.to_s.underscore}/) do |*args|
-        events << ActiveSupport::Notifications::Event.new(*args)
+  describe "events" do
+    describe "ingestion" do
+      it "creates an ingestion event" do
+        expect { subject.save! }.to change { Ddr::Events::IngestionEvent.for_object(subject).count }.by(1)
       end
-    }
-    after {
-      ActiveSupport::Notifications.unsubscribe(@subscriber)
-    }
-    it "doesn't happen on create" do
-      subject.workflow_state = "published"
-      subject.save(validate: false)
-      expect(events).to be_empty
     end
-    describe "with a previously persisted object" do
-      before do
-        subject.save(validate: false)
-      end
-      it "happens on publish!" do
-        subject.workflow_state = "published"
-        subject.save(validate: false)
-        expect(events.size).to eq(1)
-        expect(events.first.name).to eq("published.workflow.#{described_class.to_s.underscore}")
-      end
-      it "happens on unpublish!" do
-        subject.workflow_state = "unpublished"
-        subject.save(validate: false)
-        expect(events.size).to eq(1)
-        expect(events.first.name).to eq("unpublished.workflow.#{described_class.to_s.underscore}")
+    describe "update" do
+      before { subject.save! }
+      it "creates an update event" do
+        expect { subject.save! }.to change { Ddr::Events::UpdateEvent.for_object(subject).count }.by(1)
+      end
+      describe "with options" do
+        let(:user) { FactoryGirl.create(:user) }
+        it "creates an update event with options" do
+          subject.title = [ "Changed Title" ]
+          subject.save(user: user, summary: "This event rocks!", comment: "I was testing things", detail: "A bunch of extra stuff I want to record")
+          event = Ddr::Events::UpdateEvent.for_object(subject).last
+          expect(event.user_key).to eq(user.to_s)
+          expect(event.summary).to eq "This event rocks!"
+          expect(event.comment).to eq "I was testing things"
+        end
       end
     end
-  end
-
-  describe "events" do
-    before {
-      subject.save(validate: false)
-    }
     describe "deaccession" do
+      before { subject.save! }
       it "creates a deaccession event" do
         expect { subject.deaccession }.to change { Ddr::Events::DeaccessionEvent.for_object(subject).count }.by(1)
       end
+      it "records attributes with the event" do
+        allow(subject).to receive(:permanent_id) { "foo" }
+        subject.deaccession
+        event = Ddr::Events::DeaccessionEvent.for_object(subject).first
+        expect(event.permanent_id).to eq "foo"
+      end
     end
     describe "on deletion with #destroy" do
+      before { subject.save! }
       it "creates a deletion event" do
         expect { subject.destroy }.to change { Ddr::Events::DeletionEvent.for_object(subject).count }.from(0).to(1)
       end
+      it "records attributes with the event" do
+        allow(subject).to receive(:permanent_id) { "foo" }
+        subject.destroy
+        event = Ddr::Events::DeletionEvent.for_object(subject).first
+        expect(event.permanent_id).to eq "foo"
+      end
     end
-
     describe "last virus check" do
+      before { subject.save! }
       let!(:fixity_check) { Ddr::Events::FixityCheckEvent.new }
       before { allow(subject).to receive(:last_fixity_check) { fixity_check } }
       its(:last_fixity_check_on) { should eq(fixity_check.event_date_time) }
@@ -117,101 +146,12 @@ RSpec.shared_examples "a DDR model" do
     end
   end
 
-  describe "move first desc metadata identifier to local id" do
-    let(:local_id) { 'locl001' }
-    let(:identifiers) { [ 'id001', 'id002' ] }
-    context "no desc metadata identifiers" do
-      context "local id present" do
-        before { subject.local_id = local_id }
-        it "should not change the local id" do
-          result = subject.move_first_identifier_to_local_id
-          expect(result).to be false
-          expect(subject.local_id).to eq(local_id)
-        end
-      end
-    end
-    context "one desc metadata identifier" do
-      before { subject.identifier = Array(identifiers.first) }
-      context "local id not present" do
-        it "sets the local id and removes the identifier" do
-          result = subject.move_first_identifier_to_local_id
-          expect(result).to be true
-          expect(subject.local_id).to eq(identifiers.first)
-          expect(subject.identifier).to be_empty
-        end
-      end
-      context "local id present" do
-        before { subject.local_id = local_id }
-        context "replace option is true" do
-          it "sets the local id and removes the identifier" do
-            result = subject.move_first_identifier_to_local_id
-            expect(result).to be true
-            expect(subject.local_id).to eq(identifiers.first)
-            expect(subject.identifier).to be_empty
-          end
-        end
-        context "replace option is false" do
-          context "local id matches first identifier" do
-            before { subject.identifier = Array(local_id) }
-            it "removes the identifier" do
-              result = subject.move_first_identifier_to_local_id(replace: false)
-              expect(result).to be true
-              expect(subject.local_id).to eq(local_id)
-              expect(subject.identifier).to be_empty
-            end
-          end
-          context "local id does not match first identifier" do
-            it "does not change the local id and does not remove the identifier" do
-              result = subject.move_first_identifier_to_local_id(replace: false)
-              expect(result).to be false
-              expect(subject.local_id).to eq(local_id)
-              expect(subject.identifier).to eq(Array(identifiers.first))
-            end
-          end
-        end
-      end
-    end
-    context "more than one desc metadata identifer" do
-      before { subject.identifier = identifiers }
-      context "local id not present" do
-        it "sets the local id and removes the identifier" do
-          result = subject.move_first_identifier_to_local_id
-          expect(result).to be true
-          expect(subject.local_id).to eq(identifiers.first)
-          expect(subject.identifier).to eq(Array(identifiers.last))
-        end
-      end
-      context "local id present" do
-        before { subject.local_id = local_id }
-        context "replace option is true" do
-          it "sets the local id and removes the identifier" do
-            result = subject.move_first_identifier_to_local_id
-            expect(result).to be true
-            expect(subject.local_id).to eq(identifiers.first)
-            expect(subject.identifier).to eq(Array(identifiers.last))
-          end
-        end
-        context "replace option is false" do
-          context "local id matches first identifier" do
-            before { subject.identifier = [ local_id, identifiers.last ] }
-            it "removes the identifier" do
-              result = subject.move_first_identifier_to_local_id(replace: false)
-              expect(result).to be true
-              expect(subject.local_id).to eq(local_id)
-              expect(subject.identifier).to eq(Array(identifiers.last))
-            end
-          end
-          context "local id does not match first identifier" do
-            it "does not change the local id and does not remove the identifier" do
-              result = subject.move_first_identifier_to_local_id(replace: false)
-              expect(result).to be false
-              expect(subject.local_id).to eq(local_id)
-              expect(subject.identifier).to eq(identifiers)
-            end
-          end
-        end
-      end
-    end
+  describe "thumbnails" do
+    its(:can_have_thumbnail?) { is_expected.to be true }
+    it { is_expected.not_to have_thumbnail }
+    specify {
+      allow(subject.thumbnail).to receive(:has_content?) { true }
+      expect(subject).to have_thumbnail
+    }
   end
-
 end