hydra-pcdm 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c4ca4330987a12626e2dd8a45e54d08e83b8c07
-  data.tar.gz: 99e3953956fe7a5a45b6c14bbee233d14e32eb2a
+  metadata.gz: c08bc42e4a5ea8d987f0830db5474b9e2d7c1ada
+  data.tar.gz: 7f3e582637ddb0254b8cc399ab71d45f9f7ac482
 SHA512:
-  metadata.gz: 5a0af66d3e277f5d2f05dbb2e96043742f1faeec169641cf64058c3a89dc7762bfd93ca7ed48055c621fa0cc3a463b8492d5dc3d0351a996e248a138c081ae66
-  data.tar.gz: 43f4e5f13d121da66b59c54a496b538d2cd8bbb74b4be5fa8bfb60944f793d485313e2aa1d0aec23e5bceb6dbd0a6f4ae09f7eaaff141f355ff913ff650d31bc
+  metadata.gz: 70d9932eddb9b3c3581ef2d14e7628fa15b6034d4dc607d3d92df74ea92ce19d40b5f5712b6eb2ef8421f3f4cd59a382dc683368eec2a2a123f8a4790bdcd913
+  data.tar.gz: b5b4827cc4a421cb9f35821d48504c0cbf4c072e191fad3bf29bcdbcdcb76275de3846c0e124f60e47c45d606a8a4b80967f6ee2cb780c29a03a1c84009e41a3

data/.travis.yml

@@ -5,6 +5,8 @@ bundler_args: --without debug
 env:
   global:
     - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+jdk:
+  - oraclejdk8
 rvm:
   - 2.1
   - 2.2
@@ -12,3 +14,5 @@ rvm:
 matrix:
   allow_failures:
       - rvm: jruby-head
+jdk:
+  - oraclejdk8

data/Gemfile

@@ -1,9 +1,5 @@
 source 'https://rubygems.org'
 
-gem 'activefedora-aggregation', github: 'projecthydra-labs/activefedora-aggregation'
-gem 'active-fedora', github: 'projecthydra/active_fedora'
-
-
 unless ENV['CI']
   gem 'pry'
   gem 'pry-byebug'

data/README.md

@@ -33,12 +33,12 @@ We are using [Web ACL](http://www.w3.org/wiki/WebAccessControl) as implemented b
 
 ## PCDM Model
 
-Reference:  [Portland Common Data Model](https://wiki.duraspace.org/x/9IoOB)
+Reference:  [Portland Common Data Model](https://github.com/duraspace/pcdm/wiki)
 
 
 ### Model Definition
 
-![PCDM Model Definition](https://wiki.duraspace.org/download/attachments/68061940/coll-object-file.png?version=1&modificationDate=1425932362178&api=v2)
+![PCDM Model Definition](https://raw.githubusercontent.com/wiki/duraspace/pcdm/images/coll-object-file.png)
 
 
 ### Example

data/hydra-pcdm.gemspec

@@ -19,7 +19,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activefedora-aggregation', '~> 0.2.0'
+  spec.add_dependency 'activefedora-aggregation', '~> 0.4'
+  spec.add_dependency 'mime-types', '>= 1'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'jettywrapper', '>= 2.0.0'

data/lib/hydra/pcdm.rb

@@ -1,4 +1,7 @@
 require 'active_support'
+require 'mime/types'
+require 'active_fedora/aggregation'
+
 
 module Hydra
   module PCDM
@@ -10,59 +13,47 @@ module Hydra
     autoload :SweetjplVocabularies,   'hydra/pcdm/vocab/sweetjpl_terms'
 
     # models
-    autoload :Collection,             'hydra/pcdm/models/collection'
-    autoload :Object,                 'hydra/pcdm/models/object'
-    autoload :File,                   'hydra/pcdm/models/file'
+    autoload_under 'models' do
+      autoload :Collection
+      autoload :Object
+      autoload :File
+    end
 
     # behavior concerns
-    autoload :CollectionBehavior,     'hydra/pcdm/models/concerns/collection_behavior'
-    autoload :ObjectBehavior,         'hydra/pcdm/models/concerns/object_behavior'
+    autoload_under 'models/concerns' do
+      autoload :CollectionBehavior
+      autoload :ObjectBehavior
+      autoload :PcdmBehavior
+    end
 
     autoload :CollectionIndexer
     autoload :ObjectIndexer
 
-    # collection services
-    autoload :AddCollectionToCollection,         'hydra/pcdm/services/collection/add_collection'
-    autoload :AddObjectToCollection,             'hydra/pcdm/services/collection/add_object'
-    autoload :AddRelatedObjectToCollection,      'hydra/pcdm/services/collection/add_related_object'
-    autoload :GetCollectionsFromCollection,      'hydra/pcdm/services/collection/get_collections'
-    autoload :GetObjectsFromCollection,          'hydra/pcdm/services/collection/get_objects'
-    autoload :GetRelatedObjectsFromCollection,   'hydra/pcdm/services/collection/get_related_objects'
-    autoload :RemoveCollectionFromCollection,    'hydra/pcdm/services/collection/remove_collection'
-    autoload :RemoveObjectFromCollection,        'hydra/pcdm/services/collection/remove_object'
-    autoload :RemoveRelatedObjectFromCollection, 'hydra/pcdm/services/collection/remove_related_object'
-
     # file services
     autoload :AddTypeToFile,                     'hydra/pcdm/services/file/add_type'
     autoload :GetMimeTypeForFile,                'hydra/pcdm/services/file/get_mime_type'
 
+    # Iterators
+    autoload :DeepMemberIterator,                'hydra/pcdm/deep_member_iterator'
 
-    # object services
-    autoload :AddFileToObject,                   'hydra/pcdm/services/object/add_file'
-    autoload :AddObjectToObject,                 'hydra/pcdm/services/object/add_object'
-    autoload :AddRelatedObjectToObject,          'hydra/pcdm/services/object/add_related_object'
-    autoload :CreateObject,                      'hydra/pcdm/services/object/create'
-    autoload :GetObjectsFromObject,              'hydra/pcdm/services/object/get_objects'
-    autoload :GetRelatedObjectsFromObject,       'hydra/pcdm/services/object/get_related_objects'
-    autoload :GetFilesFromObject,                'hydra/pcdm/services/object/get_collections'
-    autoload :RemoveObjectFromObject,            'hydra/pcdm/services/object/remove_object'
-    autoload :RemoveRelatedObjectFromObject,     'hydra/pcdm/services/object/remove_related_object'
-
+    # Associations
+    autoload :AncestorChecker,                   'hydra/pcdm/ancestor_checker'
+    autoload :Validators,                        'hydra/pcdm/validators'
 
     # model validations
     def self.collection? collection
       return false unless collection.respond_to? :type
-      collection.type.include? RDFVocabularies::PCDMTerms.Collection
+      Array(collection.type).include? RDFVocabularies::PCDMTerms.Collection
     end
 
     def self.object? object
       return false unless object.respond_to? :type
-      object.type.include? RDFVocabularies::PCDMTerms.Object
+      Array(object.type).include? RDFVocabularies::PCDMTerms.Object
     end
 
     def self.file? file
       return false unless file.respond_to? :metadata_node
-      file.metadata_node.type.include? RDFVocabularies::PCDMTerms.File
+      Array(file.metadata_node.type).include? RDFVocabularies::PCDMTerms.File
     end
 
   end

data/lib/hydra/pcdm/ancestor_checker.rb

@@ -0,0 +1,18 @@
+module Hydra::PCDM
+  ##
+  # Checks whether or not one object is an ancestor of another.
+  class AncestorChecker
+    attr_reader :record
+
+    # @param [ActiveFedora::Base] record The object which may have ancestors.
+    def initialize(record)
+      @record = record
+    end
+
+    # @param [#members] potential_ancestor Object which may be the ancestor of
+    #   the initialized record.
+    def ancestor?(potential_ancestor)
+      record == potential_ancestor || Hydra::PCDM::DeepMemberIterator.new(potential_ancestor).include?(record)
+    end
+  end
+end

data/lib/hydra/pcdm/collection_indexer.rb

@@ -3,8 +3,8 @@ module Hydra::PCDM
 
     def generate_solr_document
       super.tap do |solr_doc|
-        solr_doc["members_ssim"]        = object.member_ids
-        solr_doc["child_collections_ssim"] = object.child_collections.map { |o| o.id }
+        solr_doc["member_ids_ssim"]           = object.member_ids
+        solr_doc["child_collection_ids_ssim"] = object.child_collection_ids
       end
     end
 

data/lib/hydra/pcdm/deep_member_iterator.rb

@@ -0,0 +1,31 @@
+module Hydra::PCDM
+  ## 
+  # Iterates over a record's members and all of their members in a breadth-first
+  # search.
+  class DeepMemberIterator
+    include Enumerable
+    attr_reader :record
+    # @param [#members] record The object whose members are iterated across.
+    def initialize(record)
+      @record = HasMembers.new(record)
+    end
+
+    def each
+      record.members.each do |member|
+        yield member
+      end
+      record.members.each do |member|
+        DeepMemberIterator.new(member).each do |deep_member|
+          yield deep_member
+        end
+      end
+    end
+  end
+  ##
+  # Small decorator to ensure that #members isn't undefined.
+  class HasMembers < SimpleDelegator
+    def members
+      __getobj__.try(:members) || []
+    end
+  end
+end

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

@@ -1,79 +1,42 @@
-require 'active_fedora/aggregation'
-
 module Hydra::PCDM
+
+  # behavior:
+  #   1) Hydra::PCDM::Collection can aggregate (pcdm:hasMember)  Hydra::PCDM::Collection (no infinite loop, e.g., A -> B -> C -> A)
+  #   2) Hydra::PCDM::Collection can aggregate (pcdm:hasMember)  Hydra::PCDM::Object
+  #   3) Hydra::PCDM::Collection can aggregate (ore:aggregates) Hydra::PCDM::Object  (Object related to the Collection)
+
+  #   4) Hydra::PCDM::Collection can NOT aggregate non-PCDM object
+  #   5) Hydra::PCDM::Collection can NOT contain (pcdm:hasFile)  Hydra::PCDM::File
+
+  #   6) Hydra::PCDM::Collection can have descriptive metadata
+  #   7) Hydra::PCDM::Collection can have access metadata
+  #
   module CollectionBehavior
     extend ActiveSupport::Concern
 
     included do
       type RDFVocabularies::PCDMTerms.Collection
+      include ::Hydra::PCDM::PcdmBehavior
 
-      aggregates :members, predicate: RDFVocabularies::PCDMTerms.hasMember,
-        class_name: "ActiveFedora::Base"
-
-      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
+      filters_association :members, as: :child_collections, condition: :pcdm_collection?
     end
 
     module ClassMethods
       def indexer
         Hydra::PCDM::CollectionIndexer
       end
-    end
-
-    # behavior:
-    #   1) Hydra::PCDM::Collection can aggregate (pcdm:hasMember)  Hydra::PCDM::Collection (no infinite loop, e.g., A -> B -> C -> A)
-    #   2) Hydra::PCDM::Collection can aggregate (pcdm:hasMember)  Hydra::PCDM::Object
-    #   3) Hydra::PCDM::Collection can aggregate (ore:aggregates) Hydra::PCDM::Object  (Object related to the Collection)
-
-    #   4) Hydra::PCDM::Collection can NOT aggregate non-PCDM object
-    #   5) Hydra::PCDM::Collection can NOT contain (pcdm:hasFile)  Hydra::PCDM::File
-
-    #   6) Hydra::PCDM::Collection can have descriptive metadata
-    #   7) Hydra::PCDM::Collection can have access metadata
-
-    def child_collections= collections
-      raise ArgumentError, "each collection must be a pcdm collection" unless collections.all? { |c| Hydra::PCDM.collection? c }
-      raise ArgumentError, "a collection can't be an ancestor of itself" if collection_ancestor?(collections)
-      self.members = objects + collections
-    end
-
-    def child_collections
-      members.to_a.select { |m| Hydra::PCDM.collection? m }
-    end
-
-    def objects= objects
-      raise ArgumentError, "each object must be a pcdm object" unless objects.all? { |o| Hydra::PCDM.object? o }
-      self.members = child_collections + objects
-    end
-
-    def objects
-      members.to_a.select { |m| Hydra::PCDM.object? m }
-    end
-
-    def collection_ancestor? collections
-      collections.each do |check|
-        return true if check.id == self.id
-        return true if ancestor?(check)
+      
+      def type_validator
       end
-      false
     end
 
-    def ancestor? collection
-      return true if collection.id == self.id
-      return false if collection.child_collections.empty?
-      current_collections = collection.child_collections
-      next_batch = []
-      while !current_collections.empty? do
-        current_collections.each do |c|
-          return true if c.id == self.id
-          next_batch += c.child_collections
-        end
-        current_collections = next_batch
-      end
+    def pcdm_object?
       false
     end
 
+    def pcdm_collection?
+      true
+    end
   end
 end
 

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

@@ -1,5 +1,3 @@
-require 'active_fedora/aggregation'
-
 module Hydra::PCDM
 
   # behavior:
@@ -16,56 +14,34 @@ module Hydra::PCDM
 
     included do
       type RDFVocabularies::PCDMTerms.Object
-
-      aggregates :members, predicate: RDFVocabularies::PCDMTerms.hasMember,
-        class_name: "ActiveFedora::Base"
-
-      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
+      include ::Hydra::PCDM::PcdmBehavior
 
       directly_contains :files, has_member_relation: RDFVocabularies::PCDMTerms.hasFile,
         class_name: "Hydra::PCDM::File"
-
     end
 
     module ClassMethods
       def indexer
         Hydra::PCDM::ObjectIndexer
       end
-    end
 
-    def objects= objects
-      raise ArgumentError, "each object must be a pcdm object" unless objects.all? { |o| Hydra::PCDM.object? o }
-      raise ArgumentError, "an object can't be an ancestor of itself" if object_ancestor?(objects)
-      self.members = objects
+      def type_validator
+        @type_validator ||= Validators::PCDMObjectValidator
+      end
     end
 
-    def objects
-      members.to_a.select { |m| Hydra::PCDM.object? m }
+    # @return [Boolean] whether this instance is a PCDM Object.
+    def pcdm_object?
+      true
     end
 
-    def object_ancestor? objects
-      objects.each do |check|
-        return true if check.id == self.id
-        return true if ancestor?(check)
-      end
+    # @return [Boolean] whether this instance is a PCDM Collection.
+    def pcdm_collection?
       false
     end
 
-    def ancestor? object
-      return true if object.id == self.id
-      return false if object.objects.empty?
-      current_objects = object.objects
-      next_batch = []
-      while !current_objects.empty? do
-        current_objects.each do |c|
-          return true if c.id == self.id
-          next_batch += c.objects
-        end
-        current_objects = next_batch
-      end
-      false
+    def parent_objects
+      aggregated_by.select(&:pcdm_object?)
     end
 
     def contains= files
@@ -81,7 +57,7 @@ module Hydra::PCDM
     #   filter_files_by_type(::RDF::URI("http://pcdm.org/ExtractedText"))
     def filter_files_by_type uri
       self.files.reject do |file|
-        file.metadata_node.query(predicate: RDF.type, object: uri).map(&:object).empty?
+        !file.metadata_node.type.include?(uri)
       end
     end
 
@@ -98,7 +74,6 @@ module Hydra::PCDM
         return matching_files.first
       end
     end
-
   end
 end
 

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

@@ -0,0 +1,34 @@
+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?
+      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
+    end
+
+    module ClassMethods
+      def type_validator
+        @type_validator ||= Validators::CompositeValidator.new(
+          super,
+          Validators::PCDMValidator,
+          Validators::AncestorValidator
+        )
+      end
+    end
+
+    def parents
+      aggregated_by
+    end
+
+    def parent_collections
+      aggregated_by.select(&:pcdm_collection?)
+    end
+
+  end
+end

data/lib/hydra/pcdm/object_indexer.rb

@@ -2,7 +2,7 @@ module Hydra::PCDM
   class ObjectIndexer < ActiveFedora::IndexingService
     def generate_solr_document
       super.tap do |solr_doc|
-        solr_doc["objects_ssim"]     = object.objects.map { |o| o.id }
+        solr_doc["child_object_ids_ssim"] = object.child_object_ids
       end
     end