ddr-models 3.0.0.beta.18 → 3.0.0.beta.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16f19bb0a9c0d7569797de024db2638a3e1b4e2a
-  data.tar.gz: 1e83fcc5c343aeed276d1a36de4d99f9b95dc125
+  metadata.gz: 83e427c337952549de62787a1e38025b6a41153e
+  data.tar.gz: 57656751812c73a3360e5122eddf22bc317f02f1
 SHA512:
-  metadata.gz: 4abaf0450a6f928fc6c3c52da7c4a570028c82dcd58fedeff07bf24262bdce23d6a4b6c7ee30f49894120c52381d6d93c174515f2ea49ec726ae8ac8de347c34
-  data.tar.gz: 6975b9bf6181df4407f480b44f21f4d697fef2c989fc2f878c63c1d524f247210239042e751572530028af6b2deab2bc9c4f8827cc5054d777ef1f38423b0511
+  metadata.gz: f27a59cee19c3b97e19a36347ee37aabd216d0a566cbb0cf840a998e80053d29d0a088e753d08fd8f6a3107be4be714ca30e9ae8542ce2db81a110253dc89089
+  data.tar.gz: cbe43fb12c173fc4c0eff9727d033ed60eea022b0a8d827cdae305a4a76995f7582e5fc61268ddcc2496b81f251526dcca482e625e3f25f4afd2dd74bb104a78

data/lib/ddr/index/fields.rb

@@ -29,6 +29,7 @@ module Ddr::Index
     EAD_ID                      = Field.new :ead_id, :stored_sortable
     EXTRACTED_TEXT              = Field.new :extracted_text, solr_name: "extracted_text_tsm"
     FCREPO3_PID                 = Field.new :fcrepo3_pid, :stored_sortable
+    FORMAT_FACET                = Field.new :format_facet, :facetable
     HAS_MODEL                   = Field.new :has_model, :symbol
     IDENTIFIER_ALL              = Field.new :identifier_all, :symbol
     IS_ATTACHED_TO              = Field.new :is_attached_to, solr_name: "isAttachedTo_ssim"

data/lib/ddr/models.rb

@@ -51,6 +51,7 @@ module Ddr
     autoload :Indexing
     autoload :NotFoundError, 'ddr/models/error'
     autoload :ObjectApi
+    autoload :Relation
     autoload :SolrDocument
     autoload :StructDiv
     autoload :Structure

data/lib/ddr/models/attached_file_profile.rb

@@ -5,7 +5,7 @@ module Ddr::Models
     include ActiveModel::Serializers::JSON
 
     def attributes
-      { "size" => nil }
+      { "size" => nil, "mime_type" => nil }
     end
 
   end

data/lib/ddr/models/base.rb

@@ -11,6 +11,7 @@ module Ddr::Models
     include Hydra::Validations
     include HasAdminMetadata
     extend AutoVersion
+    extend Relation
 
     after_destroy do
       notify_event :deletion

data/lib/ddr/models/indexing.rb

@@ -22,7 +22,7 @@ module Ddr
           ASPACE_ID             => aspace_id,
           ATTACHED_FILES        => attached_files_profile.to_json,
           BOX_NUMBER_FACET      => desc_metadata.values('box_number'),
-          CONTRIBUTOR_FACET     => desc_metadata.values('contributor'),
+          CONTRIBUTOR_FACET     => desc_metadata.contributor,
           CREATOR_FACET         => desc_metadata.creator,
           DATE_FACET            => desc_metadata.date,
           ATTACHED_FILES_HAVING_CONTENT => attached_files_having_content.keys,
@@ -32,6 +32,7 @@ module Ddr
           DOI                   => doi,
           EAD_ID                => ead_id,
           FCREPO3_PID           => fcrepo3_pid,
+          FORMAT_FACET          => desc_metadata.format,
           IDENTIFIER_ALL        => all_identifiers,
           LICENSE               => license,
           LOCAL_ID              => local_id,
@@ -43,7 +44,7 @@ module Ddr
           RESOURCE_ROLE         => roles.in_resource_scope.agents,
           SERIES_FACET          => desc_metadata.values('series'),
           SPATIAL_FACET         => desc_metadata.values('spatial'),
-          SUBJECT_FACET         => desc_metadata.values('subject'),
+          SUBJECT_FACET         => desc_metadata.subject,
           TITLE                 => title_display,
           TYPE_FACET            => desc_metadata.type,
           UNIQUE_ID             => unique_ids,

data/lib/ddr/models/relation.rb

@@ -0,0 +1,18 @@
+module Ddr::Models
+  #
+  # Since ActiveFedora does not yet (as of at least v9.9.1)
+  # have named scopes, this module extends Base and is
+  # included in AF::Relation for chainability.
+  #
+  module Relation
+    def having_local_id(local_id)
+      where(Ddr::Index::Fields::LOCAL_ID => local_id)
+    end
+
+    def in_collection(coll)
+      where(Ddr::Index::Fields::IS_MEMBER_OF_COLLECTION => coll.respond_to?(:id) ? coll.id : coll)
+    end
+  end
+end
+
+ActiveFedora::Relation.include(Ddr::Models::Relation)

data/lib/ddr/models/solr_document.rb

@@ -151,7 +151,7 @@ module Ddr::Models
     end
 
     def content_mime_type
-      content_ds["dsMIME"] rescue nil
+      content_ds["mime_type"] rescue nil
     end
     # For duck-typing with Ddr::Models::HasContent
     alias_method :content_type, :content_mime_type

data/lib/ddr/models/version.rb

@@ -1,5 +1,5 @@
 module Ddr
   module Models
-    VERSION = "3.0.0.beta.18"
+    VERSION = "3.0.0.beta.20"
   end
 end

data/lib/ddr/utils.rb

@@ -1,6 +1,7 @@
 require 'openssl'
 
 module Ddr::Utils
+  extend Deprecation
 
   DEFAULT_MIME_TYPE = "application/octet-stream"
 
@@ -90,6 +91,7 @@ module Ddr::Utils
   #      direct children of that collection (i.e., effectively searches a collection and its
   #      items for an object with the given identifier)
   def self.pid_for_identifier(identifier, opts={})
+    Deprecation.warn(self, "`Ddr::Utils.pid_for_identifier` is deprecated. Use .having_local_id model class method and get id from result object(s). (#{caller.first})")
     model = opts.fetch(:model, nil)
     collection = opts.fetch(:collection, nil)
     objs = []

data/spec/models/item_spec.rb

@@ -6,6 +6,27 @@ RSpec.describe Item, type: :model do
   it_behaves_like "a non-collection model"
   it_behaves_like "a potentially publishable object"
 
+  describe ".in_collection scope" do
+    let(:coll) { FactoryGirl.create(:collection) }
+    let(:item1) { FactoryGirl.create(:item) }
+    let(:item2) { FactoryGirl.build(:item) }
+    before {
+      item2.parent = coll
+      item2.local_id = "item2"
+      item2.save
+    }
+    specify {
+      expect(Item.in_collection(coll)).not_to include(item1)
+      expect(Item.in_collection(coll)).to include(item2)
+    }
+    describe "chainability with .having_local_id" do
+      specify {
+        expect(Item.in_collection(coll).having_local_id("item2")).to include(item2)
+        expect(Item.in_collection(coll).having_local_id("item1")).not_to include(item2)
+      }
+    end
+  end
+
   describe "indexing text" do
     let(:children) { FactoryGirl.build_list(:component, 5) }
 

data/spec/support/shared_examples_for_ddr_models.rb

@@ -1,10 +1,57 @@
 RSpec.shared_examples "a DDR model" do
-
-  it_behaves_like "a describable object"
-  it_behaves_like "a governable object"
-  it_behaves_like "an object that has a display title"
-  it_behaves_like "an object that has identifiers"
-  it_behaves_like "a fixity checkable object"
+  describe "#desc_metadata_terms" do
+    it "should have a default value" do
+      expect(subject.desc_metadata_terms).to match_array(Ddr::Models::DescriptiveMetadata.unqualified_names)
+    end
+    describe "arguments" do
+      it "with fixed results" do
+        expect(subject.desc_metadata_terms(:dcterms))
+          .to eq(Ddr::Models::MetadataMapping.dc11.unqualified_names + (Ddr::Models::MetadataMapping.dcterms.unqualified_names - Ddr::Models::MetadataMapping.dc11.unqualified_names))
+        expect(subject.desc_metadata_terms(:dcterms))
+          .to match_array(Ddr::Models::MetadataMapping.dcterms.unqualified_names)
+        expect(subject.desc_metadata_terms(:duke)).to eq Ddr::Vocab::Vocabulary.term_names(Ddr::Vocab::DukeTerms)
+        expect(subject.desc_metadata_terms(:dcterms_elements11)).to eq Ddr::Vocab::Vocabulary.term_names(RDF::DC11)
+        expect(subject.desc_metadata_terms(:defined_attributes)).to match_array Ddr::Vocab::Vocabulary.term_names(RDF::DC11)
+      end
+      context "with variable results" do
+        before do
+          subject.desc_metadata.title = ["Object Title"]
+          subject.desc_metadata.creator = ["Duke University Libraries"]
+          subject.desc_metadata.identifier = ["id001"]
+          subject.save
+        end
+        it "should accept an :empty argument" do
+          expect(subject.desc_metadata_terms(:empty)).to eq(subject.desc_metadata_terms - [:title, :creator, :identifier])
+        end
+        it "should accept a :present argument" do
+          expect(subject.desc_metadata_terms(:present)).to match_array [:title, :creator, :identifier]
+        end
+      end
+    end
+  end
+  describe "#set_desc_metadata" do
+    let(:term_values_hash) { subject.desc_metadata_terms.each_with_object({}) {|t, memo| memo[t] = ["Value"]} }
+    it "should set the desc_metadata terms to the values of the matching keys in the hash" do
+      subject.desc_metadata_terms.each do |t|
+        expect(subject.desc_metadata).to receive(:set_values).with(t, ["Value"])
+      end
+      subject.set_desc_metadata(term_values_hash)
+    end
+  end
+  describe "#set_desc_metadata_values" do
+    context "when values == nil" do
+      it "should set the term to an empty value" do
+        subject.set_desc_metadata_values(:title, nil)
+        expect(subject.desc_metadata.title).to be_empty
+      end
+    end
+    context "when values is an array" do
+      it "should reject empty values from the array" do
+        subject.set_desc_metadata_values(:title, ["Object Title", nil, "Alternative Title", ""])
+        expect(subject.desc_metadata.title).to eq ["Object Title", "Alternative Title"]
+      end
+    end
+  end
 
   describe "#to_param" do
     before {
@@ -25,6 +72,68 @@ RSpec.shared_examples "a DDR model" do
     end
   end
 
+  describe "#title_display" do
+    context "when it has a title" do
+      before { subject.desc_metadata.title = [ 'Title' ] }
+      its(:title_display) { is_expected.to eq('Title') }
+    end
+    context "when it has no title, but has an identifier" do
+      before { subject.desc_metadata.identifier = [ 'id001' ] }
+      its(:title_display) { is_expected.to eq('id001') }
+    end
+    # Only objects with content implement :original_filename
+    # This test worked before b/c allowing rspec to stub methods
+    # that aren't defined on object. This rspec-mocks config setting prevents that:
+    #
+    #   verify_partial_doubles = true
+    #
+    # context "has no title, no identifier, has original_filename" do
+    #   before { allow(object).to receive(:original_filename) { "file.txt" } }
+    #   it "should return original_filename" do
+    #     expect(subject).to eq "file.txt"
+    #   end
+    # end
+    context "when it has no title, no identifier, and no original_filename" do
+      subject { described_class.new(id: 'duke-test') }
+      its(:title_display) { is_expected.to eq "[duke-test]" }
+    end
+  end
+
+  describe "#all_identifiers" do
+    subject { described_class.new(id: 'test-3') }
+    context "when it has descriptive identifiers, local ID, permanent ID, and id" do
+      before do
+        subject.desc_metadata.identifier = [ 'ID001', 'ID002' ]
+        subject.local_id = 'LOCAL_ID_A'
+        subject.permanent_id = 'ark:/999999/cd3'
+      end
+      its(:all_identifiers) {
+        is_expected.to match_array([ 'ID001', 'ID002', 'LOCAL_ID_A', 'ark:/999999/cd3', 'test-3' ])
+      }
+    end
+    context "when it has no descriptive identifiers or local ID" do
+      before { subject.permanent_id = 'ark:/999999/cd3' }
+      its(:all_identifiers) {
+        is_expected.to match_array([ 'ark:/999999/cd3', 'test-3' ])
+      }
+    end
+  end
+
+  describe ".having_local_id" do
+    let(:obj1) {
+      described_class.new(local_id: "obj1").tap { |obj| obj.save(validate: false) }
+    }
+    let(:obj2) {
+      described_class.new(local_id: "obj2").tap { |obj| obj.save(validate: false) }
+    }
+    specify {
+      expect(described_class.having_local_id("obj1")).to include(obj1)
+      expect(described_class.having_local_id("obj1")).not_to include(obj2)
+      expect(described_class.having_local_id("obj2")).not_to include(obj1)
+      expect(described_class.having_local_id("obj2")).to include(obj2)
+    }
+  end
+
   describe ".find_by_unique_id" do
     before {
       subject.permanent_id = "ark:/99999/fk4rx95k8w"
@@ -77,4 +186,30 @@ RSpec.shared_examples "a DDR model" do
     end
   end
 
+  describe "fixity check" do
+    before do
+      subject.thumbnail.content = '1234567890'
+      subject.save(validate: false)
+    end
+    specify {
+      expect { subject.check_fixity }.to change(subject.fixity_checks, :count).from(0).to(1)
+    }
+    describe "results" do
+      let(:results) { subject.check_fixity }
+      specify {
+        expect(results).to be_success
+      }
+      specify {
+        expect(results[:thumbnail]).to be true
+      }
+      describe "failure" do
+        before {
+          allow(subject.thumbnail).to receive(:check_fixity) { false }
+        }
+        specify {
+          expect(results).not_to be_success
+        }
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ddr-models
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta.18
+  version: 3.0.0.beta.20
 platform: ruby
 authors:
 - Jim Coble
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-11 00:00:00.000000000 Z
+date: 2016-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -554,6 +554,7 @@ files:
 - lib/ddr/models/metadata/metadata_vocabularies.rb
 - lib/ddr/models/metadata/metadata_vocabulary.rb
 - lib/ddr/models/object_api.rb
+- lib/ddr/models/relation.rb
 - lib/ddr/models/search/catalog.rb
 - lib/ddr/models/search/search_builder.rb
 - lib/ddr/models/solr_document.rb
@@ -718,12 +719,8 @@ files:
 - spec/support/ezid_mock_identifier.rb
 - spec/support/shared_examples_for_auth_contexts.rb
 - spec/support/shared_examples_for_ddr_models.rb
-- spec/support/shared_examples_for_describables.rb
 - spec/support/shared_examples_for_events.rb
-- spec/support/shared_examples_for_fixity_checkable_spec.rb
-- spec/support/shared_examples_for_governables.rb
 - spec/support/shared_examples_for_has_content.rb
-- spec/support/shared_examples_for_indexing.rb
 - spec/support/shared_examples_for_non_collection_models.rb
 - spec/support/shared_examples_for_publication.rb
 - spec/support/shared_examples_for_role_sets.rb
@@ -896,12 +893,8 @@ test_files:
 - spec/support/ezid_mock_identifier.rb
 - spec/support/shared_examples_for_auth_contexts.rb
 - spec/support/shared_examples_for_ddr_models.rb
-- spec/support/shared_examples_for_describables.rb
 - spec/support/shared_examples_for_events.rb
-- spec/support/shared_examples_for_fixity_checkable_spec.rb
-- spec/support/shared_examples_for_governables.rb
 - spec/support/shared_examples_for_has_content.rb
-- spec/support/shared_examples_for_indexing.rb
 - spec/support/shared_examples_for_non_collection_models.rb
 - spec/support/shared_examples_for_publication.rb
 - spec/support/shared_examples_for_role_sets.rb

data/spec/support/shared_examples_for_describables.rb

@@ -1,58 +0,0 @@
-RSpec.shared_examples "a describable object" do
-
-  let(:object) { described_class.new }
-
-  describe "#desc_metadata_terms" do
-    it "should have a default value" do
-      expect(object.desc_metadata_terms).to match_array(Ddr::Models::DescriptiveMetadata.unqualified_names)
-    end
-    describe "arguments" do
-      it "with fixed results" do
-        expect(object.desc_metadata_terms(:dcterms))
-          .to eq(Ddr::Models::MetadataMapping.dc11.unqualified_names + (Ddr::Models::MetadataMapping.dcterms.unqualified_names - Ddr::Models::MetadataMapping.dc11.unqualified_names))
-        expect(object.desc_metadata_terms(:dcterms))
-          .to match_array(Ddr::Models::MetadataMapping.dcterms.unqualified_names)
-        expect(object.desc_metadata_terms(:duke)).to eq Ddr::Vocab::Vocabulary.term_names(Ddr::Vocab::DukeTerms)
-        expect(object.desc_metadata_terms(:dcterms_elements11)).to eq Ddr::Vocab::Vocabulary.term_names(RDF::DC11)
-        expect(object.desc_metadata_terms(:defined_attributes)).to match_array Ddr::Vocab::Vocabulary.term_names(RDF::DC11)
-      end
-      context "with variable results" do
-        before do
-          object.desc_metadata.title = ["Object Title"]
-          object.desc_metadata.creator = ["Duke University Libraries"]
-          object.desc_metadata.identifier = ["id001"]
-          object.save
-        end
-        it "should accept an :empty argument" do
-          expect(object.desc_metadata_terms(:empty)).to eq(object.desc_metadata_terms - [:title, :creator, :identifier])
-        end
-        it "should accept a :present argument" do
-          expect(object.desc_metadata_terms(:present)).to match_array [:title, :creator, :identifier]
-        end
-      end
-    end
-  end
-  describe "#set_desc_metadata" do
-    let(:term_values_hash) { object.desc_metadata_terms.each_with_object({}) {|t, memo| memo[t] = ["Value"]} }
-    it "should set the desc_metadata terms to the values of the matching keys in the hash" do
-      object.desc_metadata_terms.each do |t|
-        expect(object.desc_metadata).to receive(:set_values).with(t, ["Value"])
-      end
-      object.set_desc_metadata(term_values_hash)
-    end
-  end
-  describe "#set_desc_metadata_values" do
-    context "when values == nil" do
-      it "should set the term to an empty value" do
-        object.set_desc_metadata_values(:title, nil)
-        expect(object.desc_metadata.title).to be_empty
-      end
-    end
-    context "when values is an array" do
-      it "should reject empty values from the array" do
-        object.set_desc_metadata_values(:title, ["Object Title", nil, "Alternative Title", ""])
-        expect(object.desc_metadata.title).to eq ["Object Title", "Alternative Title"]
-      end
-    end
-  end
-end

data/spec/support/shared_examples_for_fixity_checkable_spec.rb

@@ -1,30 +0,0 @@
-RSpec.shared_examples "a fixity checkable object" do
-
-  describe "fixity check" do
-    before do
-      subject.thumbnail.content = '1234567890'
-      subject.save(validate: false)
-    end
-    specify {
-      expect { subject.check_fixity }.to change(subject.fixity_checks, :count).from(0).to(1)
-    }
-    describe "results" do
-      let(:results) { subject.check_fixity }
-      specify {
-        expect(results).to be_success
-      }
-      specify {
-        expect(results[:thumbnail]).to be true
-      }
-      describe "failure" do
-        before {
-          allow(subject.thumbnail).to receive(:check_fixity) { false }
-        }
-        specify {
-          expect(results).not_to be_success
-        }
-      end
-    end
-  end
-
-end

data/spec/support/shared_examples_for_governables.rb

@@ -1,17 +0,0 @@
-RSpec.shared_examples "a governable object" do
-  let(:object) do
-    described_class.new.tap do |obj|
-      obj.desc_metadata.title = [ 'Describable' ]
-      obj.desc_metadata.identifier = [ 'id001' ]
-      obj.save(validate: false)
-    end
-  end
-  describe "can have an admin policy" do
-    let(:coll) { FactoryGirl.create(:collection) }
-    it "should set its admin policy with #admin_policy= and get with #admin_policy" do
-      object.admin_policy = coll
-      object.save(validate: false)
-      expect(ActiveFedora::Base.find(object.id).admin_policy).to eq(coll)
-    end
-  end
-end

data/spec/support/shared_examples_for_indexing.rb

@@ -1,59 +0,0 @@
-RSpec.shared_examples "an object that has a display title" do
-  describe "#title_display" do
-    let(:object) { described_class.new }
-    subject { object.title_display }
-    context "has title" do
-      before { object.desc_metadata.title = [ 'Title' ] }
-      it "should return the first title" do
-        expect(subject).to eq('Title')
-      end
-    end
-    context "has no title, has identifier" do
-      before { object.desc_metadata.identifier = [ 'id001' ] }
-      it "should return the first identifier" do
-        expect(subject).to eq('id001')
-      end
-    end
-    # Only objects with content implement :original_filename
-    # This test worked before b/c allowing rspec to stub methods
-    # that aren't defined on object. This rspec-mocks config setting prevents that:
-    #
-    #   verify_partial_doubles = true
-    #
-    # context "has no title, no identifier, has original_filename" do
-    #   before { allow(object).to receive(:original_filename) { "file.txt" } }
-    #   it "should return original_filename" do
-    #     expect(subject).to eq "file.txt"
-    #   end
-    # end
-    context "has no title, no identifier, no original_filename" do
-      let(:object) { described_class.new(id: 'duke-test') }
-      it "should return the id in square brackets" do
-        expect(subject).to eq "[duke-test]"
-      end
-    end
-  end
-end
-
-RSpec.shared_examples "an object that has identifiers" do
-  describe "#all_identifiers" do
-    let(:object) { described_class.new(id: 'test-3') }
-    subject { object.all_identifiers }
-    context "has descriptive identifiers, local ID, permanent ID, and id" do
-      before do
-        object.desc_metadata.identifier = [ 'ID001', 'ID002' ]
-        object.local_id = 'LOCAL_ID_A'
-        object.permanent_id = 'ark:/999999/cd3'
-      end
-      it "should return all the identifiers" do
-        expect(subject).to match_array([ 'ID001', 'ID002', 'LOCAL_ID_A', 'ark:/999999/cd3', 'test-3' ])
-      end
-    end
-    context "no descriptive identifiers or local ID" do
-      before { object.permanent_id = 'ark:/999999/cd3' }
-      it "should return the permanent ID and PID" do
-        expect(subject).to match_array([ 'ark:/999999/cd3', 'test-3' ])
-      end
-    end
-  end
-end