hydra-pcdm 0.1.0 → 0.2.0

data/lib/hydra/pcdm/models/concerns/pcdm_behavior.rb

@@ -2,14 +2,14 @@ module Hydra::PCDM
   module PcdmBehavior
     extend ActiveSupport::Concern
     included do
-      aggregates :members, predicate: RDFVocabularies::PCDMTerms.hasMember,
-        class_name: "ActiveFedora::Base",
-        type_validator: type_validator
-      filters_association :members, as: :child_objects, condition: :pcdm_object?
+      aggregates :members, predicate: Vocab::PCDMTerms.hasMember,
+                           class_name: 'ActiveFedora::Base',
+                           type_validator: type_validator
+      filters_association :members, as: :objects, condition: :pcdm_object?
       indirectly_contains :related_objects, has_member_relation: RDF::Vocab::ORE.aggregates,
-        inserted_content_relation: RDF::Vocab::ORE.proxyFor, class_name: "ActiveFedora::Base",
-        through: 'ActiveFedora::Aggregation::Proxy', foreign_key: :target,
-        type_validator: Validators::PCDMObjectValidator
+                                            inserted_content_relation: RDF::Vocab::ORE.proxyFor, class_name: 'ActiveFedora::Base',
+                                            through: 'ActiveFedora::Aggregation::Proxy', foreign_key: :target,
+                                            type_validator: Validators::PCDMObjectValidator
     end
 
     module ClassMethods
@@ -22,13 +22,54 @@ module Hydra::PCDM
       end
     end
 
-    def parents
+    def member_of
       aggregated_by
     end
 
-    def parent_collections
+    def parents
+      warn '[DEPRECATION] `parents` is deprecated in Hydra::PCDM.  Please use `member_of` instead.  This has a target date for removal of 10-31-2015'
+      member_of
+    end
+
+    def in_collections
       aggregated_by.select(&:pcdm_collection?)
     end
 
+    def parent_collections
+      warn '[DEPRECATION] `parent_collections` is deprecated in Hydra::PCDM.  Please use `in_collections` instead.  This has a target date for removal of 10-31-2015'
+      in_collections
+    end
+
+    def in_collection_ids
+      in_collections.map(&:id)
+    end
+
+    def parent_collection_ids
+      warn '[DEPRECATION] `parent_collection_ids` is deprecated in Hydra::PCDM.  Please use `in_collection_ids` instead.  This has a target date for removal of 10-31-2015'
+      in_collection_ids
+    end
+
+    def ancestor?(record)
+      ancestor_checker.ancestor?(record)
+    end
+
+    def ancestor_checker
+      @ancestor_checker ||= ::Hydra::PCDM::AncestorChecker.new(self)
+    end
+
+    def child_objects
+      warn '[DEPRECATION] `child_objects` is deprecated in Hydra::PCDM.  Please use `objects` instead.  This has a target date for removal of 10-31-2015'
+      objects
+    end
+
+    def child_objects=(new_objects)
+      warn '[DEPRECATION] `child_objects=` is deprecated in Hydra::PCDM.  Please use `objects=` instead.  This has a target date for removal of 10-31-2015'
+      self.objects = new_objects
+    end
+
+    def child_object_ids
+      warn '[DEPRECATION] `child_object_ids` is deprecated in Hydra::PCDM.  Please use `object_ids` instead.  This has a target date for removal of 10-31-2015'
+      object_ids
+    end
   end
 end

data/lib/hydra/pcdm/models/file.rb

@@ -3,15 +3,15 @@ module Hydra::PCDM
     include ActiveFedora::WithMetadata
 
     metadata do
-      configure type: RDFVocabularies::PCDMTerms.File
+      configure type: Vocab::PCDMTerms.File
       property :label, predicate: ::RDF::RDFS.label
 
-      property :file_name, predicate: EBUCoreVocabularies::EBUCoreTerms.filename 
-      property :file_size, predicate: EBUCoreVocabularies::EBUCoreTerms.fileSize 
-      property :date_created, predicate: EBUCoreVocabularies::EBUCoreTerms.dateCreated
-      property :has_mime_type, predicate: EBUCoreVocabularies::EBUCoreTerms.hasMimeType
-      property :date_modified, predicate: EBUCoreVocabularies::EBUCoreTerms.dateModified
-      property :byte_order, predicate: SweetjplVocabularies::SweetjplTerms.byteOrder
+      property :file_name, predicate: RDF::Vocab::EBUCore.filename
+      property :file_size, predicate: RDF::Vocab::EBUCore.fileSize
+      property :date_created, predicate: RDF::Vocab::EBUCore.dateCreated
+      property :has_mime_type, predicate: RDF::Vocab::EBUCore.hasMimeType
+      property :date_modified, predicate: RDF::Vocab::EBUCore.dateModified
+      property :byte_order, predicate: Vocab::SweetJPLTerms.byteOrder
 
       # This is a server-managed predicate which means Fedora does not let us change it.
       property :file_hash, predicate: RDF::Vocab::PREMIS.hasMessageDigest

data/lib/hydra/pcdm/models/object.rb

@@ -3,4 +3,3 @@ module Hydra::PCDM
     include Hydra::PCDM::ObjectBehavior
   end
 end
-

data/lib/hydra/pcdm/object_indexer.rb

@@ -2,9 +2,8 @@ module Hydra::PCDM
   class ObjectIndexer < ActiveFedora::IndexingService
     def generate_solr_document
       super.tap do |solr_doc|
-        solr_doc["child_object_ids_ssim"] = object.child_object_ids
+        solr_doc['object_ids_ssim'] = object.object_ids
       end
     end
-
   end
 end

data/lib/hydra/pcdm/services/file/add_type.rb

@@ -1,6 +1,5 @@
 module Hydra::PCDM
   class AddTypeToFile
-
     # This adds an additional RDF type to an exsiting Hydra::PCDM::File
     #
     # @param [Hydra::PCDM::File] the file object you want to add it to
@@ -12,9 +11,8 @@ module Hydra::PCDM
       t = file.metadata_node.get_values(:type)
       return file if t.include?(uri)
       t << uri
-      file.metadata_node.set_value(:type,t)
+      file.metadata_node.set_value(:type, t)
       file
     end
-
   end
 end

data/lib/hydra/pcdm/services/file/get_mime_type.rb

@@ -1,11 +1,9 @@
 module Hydra::PCDM
   class GetMimeTypeForFile
-
     def self.call(path)
-      raise ArgumentError, "supplied argument should be a path to a file" unless path.is_a?(String)
+      fail ArgumentError, 'supplied argument should be a path to a file' unless path.is_a?(String)
       mime_types = ::MIME::Types.of(::File.basename(path))
-      mime_types.empty? ? "application/octet-stream" : mime_types.first.content_type
+      mime_types.empty? ? 'application/octet-stream' : mime_types.first.content_type
     end
-
   end
 end

data/lib/hydra/pcdm/validators/ancestor_validator.rb

@@ -1,26 +1,18 @@
 module Hydra::PCDM::Validators
   class AncestorValidator
-    def self.validate!(association,record)
+    def self.validate!(association, record)
       new(association.owner, record).validate!
     end
 
     attr_reader :owner, :record
-    delegate :ancestor?, to: :ancestor_checker
     def initialize(owner, record)
       @owner = owner
       @record = record
     end
 
     def validate!
-      if ancestor?(record)
-        raise ArgumentError, "#{record.class} with ID: #{record.id} failed to pass AncestorChecker validation"
-      end
-    end
-
-    private
-
-    def ancestor_checker
-      @ancestor_checker ||= ::Hydra::PCDM::AncestorChecker.new(owner)
+      return unless owner.ancestor?(record)
+      fail ArgumentError, "#{record.class} with ID: #{record.id} failed to pass AncestorChecker validation"
     end
   end
 end

data/lib/hydra/pcdm/validators/pcdm_object_validator.rb

@@ -1,8 +1,8 @@
 module Hydra::PCDM::Validators
   class PCDMObjectValidator
-    def self.validate!(association, record)
+    def self.validate!(_association, record)
       unless record.try(:pcdm_object?)
-        raise ActiveFedora::AssociationTypeMismatch.new "#{record} is not a PCDM object."
+        fail ActiveFedora::AssociationTypeMismatch, "#{record} is not a PCDM object."
       end
     end
   end

data/lib/hydra/pcdm/validators/pcdm_validator.rb

@@ -1,8 +1,8 @@
 module Hydra::PCDM::Validators
   class PCDMValidator
-    def self.validate!(reflection, record)
+    def self.validate!(_reflection, record)
       if !record.try(:pcdm_object?) && !record.try(:pcdm_collection?)
-        raise ActiveFedora::AssociationTypeMismatch.new "#{record} is not a PCDM object or collection."
+        fail ActiveFedora::AssociationTypeMismatch, "#{record} is not a PCDM object or collection."
       end
     end
   end

data/lib/hydra/pcdm/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module PCDM
-    VERSION = "0.1.0"
+    VERSION = '0.2.0'
   end
 end

data/lib/hydra/pcdm/vocab/pcdm_terms.rb

@@ -1,87 +1,88 @@
 # -*- encoding: utf-8 -*-
 # This file generated automatically using vocab-fetch from https://raw.githubusercontent.com/duraspace/pcdm/master/models.rdf
 require 'rdf'
-module RDFVocabularies
-  class PCDMTerms < RDF::StrictVocabulary("http://pcdm.org/models#")
+module Hydra::PCDM
+  module Vocab
+    class PCDMTerms < RDF::StrictVocabulary('http://pcdm.org/models#')
+      # Class definitions
+      term :AdministrativeSet,
+           comment: %(
+             An Administrative Set is a grouping of resources that an administrative unit is ultimately
+             responsible for managing. The set itself helps to manage the items within it. An Object
+             or Collection may be contained by only one AdministrativeSet.
+           ).freeze,
+           label: 'Administrative Set'.freeze,
+           'rdfs:isDefinedBy' => %(http://pcdm.org/models#).freeze,
+           subClassOf: 'http://www.w3.org/ns/ldp#Container'.freeze,
+           type: 'rdfs:Class'.freeze
+      term :Collection,
+           comment: %(
+             A Collection is a group of resources. Collections have descriptive metadata, access metadata,
+             and may links to works and/or collections. By default, member works and collections are an
+             unordered set, but can be ordered using the ORE Proxy class.
+           ).freeze,
+           label: 'Collection'.freeze,
+           'rdfs:isDefinedBy' => %(http://pcdm.org/models#).freeze,
+           subClassOf: 'http://www.openarchives.org/ore/terms/Aggregation'.freeze,
+           type: 'rdfs:Class'.freeze
+      term :File,
+           comment: %(
+             A File is a sequence of binary data and is described by some accompanying metadata.
+             The metadata typically includes at least basic technical metadata \(size, content type,
+             modification date, etc.\), but can also include properties related to preservation,
+             digitization process, provenance, etc. Files MUST be contained by exactly one Object.
+           ).freeze,
+           label: 'File'.freeze,
+           'rdfs:isDefinedBy' => %(http://pcdm.org/models#).freeze,
+           type: 'rdfs:Class'.freeze
+      term :Object,
+           comment: %(
+             An Object is an intellectual entity, sometimes called a "work", "digital object", etc.
+             Objects have descriptive metadata, access metadata, may contain files and other Objects as
+             member "components". Each level of a work is therefore represented by an Object instance,
+             and is capable of standing on its own, being linked to from Collections and other Objects.
+             Member Objects can be ordered using the ORE Proxy class.
+           ).freeze,
+           label: 'Object'.freeze,
+           'rdfs:isDefinedBy' => %(http://pcdm.org/models#).freeze,
+           subClassOf: 'http://www.openarchives.org/ore/terms/Aggregation'.freeze,
+           type: 'rdfs:Class'.freeze
 
-    # Class definitions
-    term :AdministrativeSet,
-      comment: %(
-        An Administrative Set is a grouping of resources that an administrative unit is ultimately
-        responsible for managing. The set itself helps to manage the items within it. An Object
-        or Collection may be contained by only one AdministrativeSet.
-      ).freeze,
-      label: "Administrative Set".freeze,
-      "rdfs:isDefinedBy" => %(http://pcdm.org/models#).freeze,
-      subClassOf: "http://www.w3.org/ns/ldp#Container".freeze,
-      type: "rdfs:Class".freeze
-    term :Collection,
-      comment: %(
-        A Collection is a group of resources. Collections have descriptive metadata, access metadata,
-        and may links to works and/or collections. By default, member works and collections are an
-        unordered set, but can be ordered using the ORE Proxy class.
-      ).freeze,
-      label: "Collection".freeze,
-      "rdfs:isDefinedBy" => %(http://pcdm.org/models#).freeze,
-      subClassOf: "http://www.openarchives.org/ore/terms/Aggregation".freeze,
-      type: "rdfs:Class".freeze
-    term :File,
-      comment: %(
-        A File is a sequence of binary data and is described by some accompanying metadata.
-        The metadata typically includes at least basic technical metadata \(size, content type,
-        modification date, etc.\), but can also include properties related to preservation,
-        digitization process, provenance, etc. Files MUST be contained by exactly one Object.
-      ).freeze,
-      label: "File".freeze,
-      "rdfs:isDefinedBy" => %(http://pcdm.org/models#).freeze,
-      type: "rdfs:Class".freeze
-    term :Object,
-      comment: %(
-        An Object is an intellectual entity, sometimes called a "work", "digital object", etc.
-        Objects have descriptive metadata, access metadata, may contain files and other Objects as
-        member "components". Each level of a work is therefore represented by an Object instance,
-        and is capable of standing on its own, being linked to from Collections and other Objects.
-        Member Objects can be ordered using the ORE Proxy class.
-      ).freeze,
-      label: "Object".freeze,
-      "rdfs:isDefinedBy" => %(http://pcdm.org/models#).freeze,
-      subClassOf: "http://www.openarchives.org/ore/terms/Aggregation".freeze,
-      type: "rdfs:Class".freeze
+      # Property definitions
+      property :hasFile,
+               comment: %(Links to a File contained by this Object.).freeze,
+               domain: 'http://pcdm.org/models#Object'.freeze,
+               label: 'has file'.freeze,
+               range: 'http://pcdm.org/models#File'.freeze,
+               'rdfs:isDefinedBy' => %(http://pcdm.org/models#).freeze,
+               subPropertyOf: 'http://www.w3.org/ns/ldp#contains'.freeze,
+               type: 'rdf:Property'.freeze
+      property :hasMember,
+               comment: %(Links to a related Object. Typically used to link to component parts, such as a book linking to a page.).freeze,
+               domain: 'http://www.openarchives.org/ore/terms/Aggregation'.freeze,
+               label: 'has member'.freeze,
+               range: 'http://www.openarchives.org/ore/terms/Aggregation'.freeze,
+               'rdfs:isDefinedBy' => %(http://pcdm.org/models#).freeze,
+               subPropertyOf: 'http://www.openarchives.org/ore/terms/aggregates'.freeze,
+               type: 'rdf:Property'.freeze
+      property :hasRelatedFile,
+               comment: %(Links to a File which is related to this Object but doesn't directly describe or represent it, such as technical metadata about other files.).freeze,
+               domain: 'http://pcdm.org/models#Object'.freeze,
+               label: 'has related file'.freeze,
+               range: 'http://pcdm.org/models#File'.freeze,
+               'rdfs:isDefinedBy' => %(http://pcdm.org/models#).freeze,
+               subPropertyOf: 'http://www.w3.org/ns/ldp#contains'.freeze,
+               type: 'rdf:Property'.freeze
 
-    # Property definitions
-    property :hasFile,
-      comment: %(Links to a File contained by this Object.).freeze,
-      domain: "http://pcdm.org/models#Object".freeze,
-      label: "has file".freeze,
-      range: "http://pcdm.org/models#File".freeze,
-      "rdfs:isDefinedBy" => %(http://pcdm.org/models#).freeze,
-      subPropertyOf: "http://www.w3.org/ns/ldp#contains".freeze,
-      type: "rdf:Property".freeze
-    property :hasMember,
-      comment: %(Links to a related Object. Typically used to link to component parts, such as a book linking to a page.).freeze,
-      domain: "http://www.openarchives.org/ore/terms/Aggregation".freeze,
-      label: "has member".freeze,
-      range: "http://www.openarchives.org/ore/terms/Aggregation".freeze,
-      "rdfs:isDefinedBy" => %(http://pcdm.org/models#).freeze,
-      subPropertyOf: "http://www.openarchives.org/ore/terms/aggregates".freeze,
-      type: "rdf:Property".freeze
-    property :hasRelatedFile,
-      comment: %(Links to a File which is related to this Object but doesn't directly describe or represent it, such as technical metadata about other files.).freeze,
-      domain: "http://pcdm.org/models#Object".freeze,
-      label: "has related file".freeze,
-      range: "http://pcdm.org/models#File".freeze,
-      "rdfs:isDefinedBy" => %(http://pcdm.org/models#).freeze,
-      subPropertyOf: "http://www.w3.org/ns/ldp#contains".freeze,
-      type: "rdf:Property".freeze
-
-    # Extra definitions
-    term :"",
-      comment: %(Ontology for the Portland Common Data Model, intended to underlie a wide array of repository and DAMS applications.).freeze,
-      "dc:modified" => %(2015-03-16).freeze,
-      "dc:publisher" => %(http://www.duraspace.org/).freeze,
-      "dc:title" => %(Portland Common Data Model).freeze,
-      label: "".freeze,
-      "owl:versionInfo" => %(2015/03/16).freeze,
-      "rdfs:seeAlso" => %(https://github.com/duraspace/pcdm/wiki).freeze
+      # Extra definitions
+      term :"",
+           comment: %(Ontology for the Portland Common Data Model, intended to underlie a wide array of repository and DAMS applications.).freeze,
+           'dc:modified' => %(2015-03-16).freeze,
+           'dc:publisher' => %(http://www.duraspace.org/).freeze,
+           'dc:title' => %(Portland Common Data Model).freeze,
+           label: ''.freeze,
+           'owl:versionInfo' => %(2015/03/16).freeze,
+           'rdfs:seeAlso' => %(https://github.com/duraspace/pcdm/wiki).freeze
+    end
   end
 end

data/lib/hydra/pcdm/vocab/sweet_jpl_terms.rb

@@ -0,0 +1,12 @@
+require 'rdf'
+module Hydra::PCDM
+  module Vocab
+    class SweetJPLTerms < RDF::StrictVocabulary('http://sweet.jpl.nasa.gov/2.2/reprDataFormat.owl#')
+      # Property definitions
+      property :byteOrder,
+               comment: ['Byte Order.'.freeze],
+               range: 'xsd:string'.freeze,
+               label: 'Byte Order'.freeze
+    end
+  end
+end

data/spec/hydra/pcdm/ancestor_checker_spec.rb

@@ -3,25 +3,25 @@ require 'spec_helper'
 RSpec.describe Hydra::PCDM::AncestorChecker do
   subject { described_class.new(record) }
 
-  describe "#ancestor?" do
+  describe '#ancestor?' do
     let(:record) { instance_double(Hydra::PCDM::Object) }
     let(:member) { record }
     let(:result) { subject.ancestor?(member) }
 
-    context "when the member is the record itself" do
-      it "is true" do
+    context 'when the member is the record itself' do
+      it 'is true' do
         expect(result).to eq true
       end
     end
-    context "when the member is not an ancestor" do
+    context 'when the member is not an ancestor' do
       let(:member) { instance_double(Hydra::PCDM::Object, members: []) }
-      it "is false" do
+      it 'is false' do
         expect(result).to eq false
       end
     end
-    context "when the member is an ancestor" do
+    context 'when the member is an ancestor' do
       let(:member) { instance_double(Hydra::PCDM::Object, members: [record]) }
-      it "is true" do
+      it 'is true' do
         expect(result).to eq true
       end
     end

data/spec/hydra/pcdm/collection_indexer_spec.rb

@@ -1,26 +1,25 @@
 require 'spec_helper'
 
 describe Hydra::PCDM::CollectionIndexer do
-  let(:collection)         { Hydra::PCDM::Collection.new }
-  let(:child_collection_ids) { ['123', '456'] }
-  let(:child_object_ids) { ['789'] }
-  let(:member_ids) { ['123', '456', '789'] }
-  let(:indexer)            { described_class.new(collection) }
+  let(:collection) { Hydra::PCDM::Collection.new }
+  let(:collection_ids) { %w(123 456) }
+  let(:object_ids) { ['789'] }
+  let(:member_ids) { %w(123 456 789) }
+  let(:indexer) { described_class.new(collection) }
 
   before do
-    allow(collection).to receive(:child_collection_ids).and_return(child_collection_ids)
-    allow(collection).to receive(:child_object_ids).and_return(child_object_ids)
+    allow(collection).to receive(:collection_ids).and_return(collection_ids)
+    allow(collection).to receive(:object_ids).and_return(object_ids)
     allow(collection).to receive(:member_ids).and_return(member_ids)
   end
 
-  describe "#generate_solr_document" do
+  describe '#generate_solr_document' do
     subject { indexer.generate_solr_document }
 
-    it "has fields" do
-      expect(subject['child_collection_ids_ssim']).to eq ['123', '456']
-      expect(subject['child_object_ids_ssim']).to eq ['789']
-      expect(subject['member_ids_ssim']).to eq ['123', '456', '789']
+    it 'has fields' do
+      expect(subject['collection_ids_ssim']).to eq %w(123 456)
+      expect(subject['object_ids_ssim']).to eq ['789']
+      expect(subject['member_ids_ssim']).to eq %w(123 456 789)
     end
   end
 end
-