hydra-pcdm 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f5cafbc7a34aee391cc86e7df1d8e0d8a1ff6b6
-  data.tar.gz: fb1e8456ae3c899a1b48fb79bf6d787becc0e571
+  metadata.gz: 1f1369bfcb692088efb9def0d8c89c0a1a44b753
+  data.tar.gz: 67ab9ffbc703f41d52cacd272adf6800e624e2f6
 SHA512:
-  metadata.gz: e1c4e5cae84a32c3464f3922fe2de541491b6508b43eaed9b83b08f9ef0adcda912ff3c29040e9d09f1c09dd155cbf3cdeb4191e70d99df204a4e8e7d3521e0b
-  data.tar.gz: 72aa2a31ba96aef2dcabd1237d7558a18e1b8ffadae7cfe8f266ac56235d0eedc9ff531539d3cd47c12c7629ec5c75e4bc7c4777267eb3b18b96ac660ae54e35
+  metadata.gz: 61992b4c2732a5f06985514380caf52787e8ebdeeeebb9bc9d1bfabc3771649b34fc0d945ea97f13f129e3a4564f6a970589cce9c161fa19f4966fe90f8a0646
+  data.tar.gz: fab13605bffea616cbe355a4f4619769dfd8a7d8abeff9c26b380bea74b3f6ed968d6cf328fcfd67177dc1ab7b2955b6b1ca396d81c3248b0463053866b4b093

data/Gemfile

@@ -1,7 +1,6 @@
 source 'https://rubygems.org'
 
 group :development, :test do
-  gem 'haml-lint', require: false
   gem 'rubocop', '~> 0.37.0', require: false
   gem 'rubocop-rspec', '~> 1.3.1', require: false
   gem 'pry' unless ENV['CI']

data/hydra-pcdm.gemspec

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

data/lib/hydra/pcdm.rb

@@ -14,6 +14,8 @@ module Hydra
       end
     end
 
+    autoload :Config
+
     # models
     autoload_under 'models' do
       autoload :Collection
@@ -35,9 +37,6 @@ module Hydra
     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'
-
     # Associations
     autoload :AncestorChecker,                   'hydra/pcdm/ancestor_checker'
     autoload :Validators,                        'hydra/pcdm/validators'

data/lib/hydra/pcdm/ancestor_checker.rb

@@ -1,18 +1,19 @@
 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
+  module AncestorChecker
+    # @param options [Hash]
+    # @option record [#pcdm_behavior?]
+    # @option potential_ancestor [#pcdm_behavior?]
+    # @return Boolean
+    def self.former_is_ancestor_of_latter?(potential_ancestor, record)
+      return true if record == potential_ancestor
+      return false unless potential_ancestor.respond_to?(:members)
+      return true if Array.wrap(potential_ancestor.members).detect { |member| former_is_ancestor_of_latter?(member, record) }
+      false
     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)
+    class << self
+      alias call former_is_ancestor_of_latter?
     end
   end
 end

data/lib/hydra/pcdm/collection_indexer.rb

@@ -2,10 +2,10 @@ module Hydra::PCDM
   class CollectionIndexer < ObjectIndexer
     def generate_solr_document
       super.tap do |solr_doc|
-        solr_doc['member_ids_ssim'] ||= []
-        solr_doc['member_ids_ssim'] += object.member_ids
-        solr_doc['member_ids_ssim'].uniq!
-        solr_doc['collection_ids_ssim'] = object.ordered_collection_ids
+        solr_doc[Config.indexing_member_ids_key] ||= []
+        solr_doc[Config.indexing_member_ids_key] += object.member_ids
+        solr_doc[Config.indexing_member_ids_key].uniq!
+        solr_doc[Config.indexing_collection_ids_key] = object.ordered_collection_ids
       end
     end
   end

data/lib/hydra/pcdm/config.rb

@@ -0,0 +1,21 @@
+module Hydra
+  module PCDM
+    # A container for configuration options (note configuration is not yet determined).
+    module Config
+      INDEXING_MEMBER_IDS_KEY = 'member_ids_ssim'.freeze
+      def self.indexing_member_ids_key
+        INDEXING_MEMBER_IDS_KEY
+      end
+
+      INDEXING_COLLECTION_IDS_KEY = 'collection_ids_ssim'.freeze
+      def self.indexing_collection_ids_key
+        INDEXING_COLLECTION_IDS_KEY
+      end
+
+      INDEXING_OBJECT_IDS_KEY = 'object_ids_ssim'.freeze
+      def self.indexing_object_ids_key
+        INDEXING_OBJECT_IDS_KEY
+      end
+    end
+  end
+end

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

@@ -24,6 +24,7 @@ module Hydra::PCDM
       end
 
       def type_validator
+        Validators::PCDMCollectionValidator
       end
     end
 

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

@@ -25,7 +25,7 @@ module Hydra::PCDM
       end
 
       def type_validator
-        @type_validator ||= Validators::PCDMObjectValidator
+        Validators::PCDMObjectValidator
       end
     end
 

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

@@ -25,7 +25,7 @@ module Hydra::PCDM
 
     def member_of
       return [] if id.nil?
-      ActiveFedora::Base.where(member_ids_ssim: id)
+      ActiveFedora::Base.where(Config.indexing_member_ids_key => id)
     end
 
     def ordered_member_ids
@@ -37,7 +37,7 @@ module Hydra::PCDM
     end
 
     def object_ids
-      members.select(&:pcdm_object?).map(&:id)
+      objects.map(&:id)
     end
 
     def ordered_objects
@@ -56,12 +56,8 @@ module Hydra::PCDM
       in_collections.map(&:id)
     end
 
-    def ancestor?(record)
-      ancestor_checker.ancestor?(record)
-    end
-
-    def ancestor_checker
-      @ancestor_checker ||= ::Hydra::PCDM::AncestorChecker.new(self)
+    def ancestor?(potential_ancestor)
+      ::Hydra::PCDM::AncestorChecker.former_is_ancestor_of_latter?(potential_ancestor, self)
     end
   end
 end

data/lib/hydra/pcdm/object_indexer.rb

@@ -2,10 +2,10 @@ module Hydra::PCDM
   class ObjectIndexer < ActiveFedora::IndexingService
     def generate_solr_document
       super.tap do |solr_doc|
-        solr_doc['member_ids_ssim'] ||= []
-        solr_doc['member_ids_ssim'] += object.member_ids
-        solr_doc['member_ids_ssim'].uniq!
-        solr_doc['object_ids_ssim'] = object.ordered_object_ids
+        solr_doc[Config.indexing_member_ids_key] ||= []
+        solr_doc[Config.indexing_member_ids_key] += object.member_ids
+        solr_doc[Config.indexing_member_ids_key].uniq!
+        solr_doc[Config.indexing_object_ids_key] = object.ordered_object_ids
       end
     end
   end

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

@@ -1,5 +1,5 @@
 module Hydra::PCDM
-  class AddTypeToFile
+  module 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

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

@@ -1,5 +1,5 @@
 module Hydra::PCDM
-  class GetMimeTypeForFile
+  module GetMimeTypeForFile
     def self.call(path)
       raise ArgumentError, 'supplied argument should be a path to a file' unless path.is_a?(String)
       mime_types = ::MIME::Types.of(::File.basename(path))

data/lib/hydra/pcdm/validators.rb

@@ -3,6 +3,7 @@ module Hydra::PCDM
     autoload :AncestorValidator,                 'hydra/pcdm/validators/ancestor_validator'
     autoload :PCDMValidator,                     'hydra/pcdm/validators/pcdm_validator'
     autoload :CompositeValidator,                'hydra/pcdm/validators/composite_validator'
+    autoload :PCDMCollectionValidator,           'hydra/pcdm/validators/pcdm_collection_validator'
     autoload :PCDMObjectValidator,               'hydra/pcdm/validators/pcdm_object_validator'
   end
 end

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

@@ -0,0 +1,7 @@
+module Hydra::PCDM::Validators
+  class PCDMCollectionValidator
+    def self.validate!(_association, _record)
+      true
+    end
+  end
+end

data/lib/hydra/pcdm/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module PCDM
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

data/solr/config/schema.xml

@@ -103,7 +103,7 @@
       http://wiki.apache.org/solr/SolrAdaptersForLuceneSpatial4
     -->
     <fieldType name="location_rpt" class="solr.SpatialRecursivePrefixTreeFieldType"
-      geo="true" distErrPct="0.025" maxDistErr="0.000009" units="degrees" />
+      geo="true" distErrPct="0.025" maxDistErr="0.000009" distanceUnits="degrees" />
     
     <fieldType name="text" class="solr.TextField" omitNorms="false">
       <analyzer>

data/spec/hydra/pcdm/ancestor_checker_spec.rb

@@ -1,29 +1,36 @@
 require 'spec_helper'
 
 RSpec.describe Hydra::PCDM::AncestorChecker do
-  subject { described_class.new(record) }
-
-  describe '#ancestor?' do
+  context '.former_is_ancestor_of_latter?' do
+    subject { described_class.former_is_ancestor_of_latter?(potential_ancestor, record) }
     let(:record) { instance_double(Hydra::PCDM::Object) }
-    let(:member) { record }
-    let(:result) { subject.ancestor?(member) }
+    let(:potential_ancestor) { nil }
+
+    context 'when the potential_ancestor is the record itself' do
+      let(:potential_ancestor) { record }
+      it { is_expected.to eq(true) }
+    end
 
-    context 'when the member is the record itself' do
-      it 'is true' do
-        expect(result).to eq true
-      end
+    context 'when the potential_ancestor has no members' do
+      let(:potential_ancestor) { instance_double(Hydra::PCDM::Object, members: []) }
+      it { is_expected.to eq(false) }
     end
-    context 'when the member is not an ancestor' do
-      let(:member) { instance_double(Hydra::PCDM::Object, members: []) }
-      it 'is false' do
-        expect(result).to eq false
-      end
+
+    context 'when the potential_ancestor includes the given record' do
+      let(:potential_ancestor) { instance_double(Hydra::PCDM::Object, members: [record]) }
+      it { is_expected.to eq(true) }
     end
-    context 'when the member is an ancestor' do
-      let(:member) { instance_double(Hydra::PCDM::Object, members: [record]) }
-      it 'is true' do
-        expect(result).to eq true
-      end
+
+    context 'when the potential_ancestor includes a descendant that includes the given record' do
+      let(:descendant) { instance_double(Hydra::PCDM::Object, members: [record]) }
+      let(:potential_ancestor) { instance_double(Hydra::PCDM::Object, members: [descendant]) }
+      it { is_expected.to eq(true) }
+    end
+
+    context 'when the potential_ancestor only includes descendants that do not include the given record' do
+      let(:descendant) { instance_double(Hydra::PCDM::Object, members: [:another]) }
+      let(:potential_ancestor) { instance_double(Hydra::PCDM::Object, members: [descendant]) }
+      it { is_expected.to eq(false) }
     end
   end
 end

data/spec/hydra/pcdm/collection_indexer_spec.rb

@@ -17,9 +17,9 @@ describe Hydra::PCDM::CollectionIndexer do
     subject { indexer.generate_solr_document }
 
     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)
+      expect(subject[Hydra::PCDM::Config.indexing_collection_ids_key]).to eq %w(123 456)
+      expect(subject[Hydra::PCDM::Config.indexing_object_ids_key]).to eq ['789']
+      expect(subject[Hydra::PCDM::Config.indexing_member_ids_key]).to eq %w(123 456 789)
     end
   end
 end

data/spec/hydra/pcdm/config_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Hydra::PCDM::Config do
+  context '.indexing_member_ids_key' do
+    subject { described_class.indexing_member_ids_key }
+    it { is_expected.to eq(described_class::INDEXING_MEMBER_IDS_KEY) }
+  end
+
+  context '.indexing_collection_ids_key' do
+    subject { described_class.indexing_collection_ids_key }
+    it { is_expected.to eq(described_class::INDEXING_COLLECTION_IDS_KEY) }
+  end
+
+  context '.indexing_object_ids_key' do
+    subject { described_class.indexing_object_ids_key }
+    it { is_expected.to eq(described_class::INDEXING_OBJECT_IDS_KEY) }
+  end
+end

data/spec/hydra/pcdm/object_indexer_spec.rb

@@ -14,7 +14,7 @@ describe Hydra::PCDM::ObjectIndexer do
     subject { indexer.generate_solr_document }
 
     it 'has fields' do
-      expect(subject['object_ids_ssim']).to eq %w(123 456)
+      expect(subject[Hydra::PCDM::Config.indexing_object_ids_key]).to eq %w(123 456)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hydra-pcdm
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - E. Lynette Rayle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-25 00:00:00.000000000 Z
+date: 2016-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora
@@ -16,28 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.6'
+        version: '9.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.6'
-- !ruby/object:Gem::Dependency
-  name: activefedora-aggregation
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '9.11'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -157,7 +143,7 @@ files:
 - lib/hydra/pcdm.rb
 - lib/hydra/pcdm/ancestor_checker.rb
 - lib/hydra/pcdm/collection_indexer.rb
-- lib/hydra/pcdm/deep_member_iterator.rb
+- lib/hydra/pcdm/config.rb
 - lib/hydra/pcdm/models/collection.rb
 - lib/hydra/pcdm/models/concerns/collection_behavior.rb
 - lib/hydra/pcdm/models/concerns/object_behavior.rb
@@ -170,6 +156,7 @@ files:
 - lib/hydra/pcdm/validators.rb
 - lib/hydra/pcdm/validators/ancestor_validator.rb
 - lib/hydra/pcdm/validators/composite_validator.rb
+- lib/hydra/pcdm/validators/pcdm_collection_validator.rb
 - lib/hydra/pcdm/validators/pcdm_object_validator.rb
 - lib/hydra/pcdm/validators/pcdm_validator.rb
 - lib/hydra/pcdm/version.rb
@@ -193,7 +180,7 @@ files:
 - solr/config/xslt/luke.xsl
 - spec/hydra/pcdm/ancestor_checker_spec.rb
 - spec/hydra/pcdm/collection_indexer_spec.rb
-- spec/hydra/pcdm/deep_member_iterator_spec.rb
+- spec/hydra/pcdm/config_spec.rb
 - spec/hydra/pcdm/models/collection_spec.rb
 - spec/hydra/pcdm/models/file_spec.rb
 - spec/hydra/pcdm/models/object_spec.rb
@@ -228,7 +215,7 @@ summary: Portland Common Data Model (PCDM)
 test_files:
 - spec/hydra/pcdm/ancestor_checker_spec.rb
 - spec/hydra/pcdm/collection_indexer_spec.rb
-- spec/hydra/pcdm/deep_member_iterator_spec.rb
+- spec/hydra/pcdm/config_spec.rb
 - spec/hydra/pcdm/models/collection_spec.rb
 - spec/hydra/pcdm/models/file_spec.rb
 - spec/hydra/pcdm/models/object_spec.rb

data/lib/hydra/pcdm/deep_member_iterator.rb

@@ -1,31 +0,0 @@
-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/spec/hydra/pcdm/deep_member_iterator_spec.rb

@@ -1,52 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Hydra::PCDM::DeepMemberIterator do
-  subject { described_class.new(record) }
-  let(:record) { instance_double(Hydra::PCDM::Object, members: members) }
-  let(:members) { [] }
-  describe '#each' do
-    context 'with no members' do
-      it 'returns an empty array' do
-        expect(subject.to_a).to eq []
-      end
-    end
-    context 'with a member' do
-      let(:members) { [instance_double(Hydra::PCDM::Object, members: [])] }
-      it 'returns that member' do
-        expect(subject.to_a).to eq members
-      end
-    end
-    context 'with deep members' do
-      let(:member_1) { instance_double(Hydra::PCDM::Object, members: [member_3]) }
-      let(:member_2) { instance_double(Hydra::PCDM::Object, members: [member_4]) }
-      let(:member_3) { instance_double(Hydra::PCDM::Object, members: []) }
-      let(:member_4) { instance_double(Hydra::PCDM::Object, members: []) }
-      let(:members)  { [member_1, member_2] }
-      it 'does a breadth first iteration of members' do
-        expect(subject.to_a).to eq [member_1, member_2, member_3, member_4]
-      end
-    end
-    context 'with n levels deep' do
-      let(:member_1) { instance_double(Hydra::PCDM::Object, members: [member_2]) }
-      let(:member_2) { instance_double(Hydra::PCDM::Object, members: [member_3]) }
-      let(:member_3) { instance_double(Hydra::PCDM::Object, members: []) }
-      let(:members)  { [member_1] }
-      it 'traverses it' do
-        expect(subject.to_a).to eq [member_1, member_2, member_3]
-      end
-    end
-  end
-  describe '.include?' do
-    context 'with n levels deep' do
-      let(:member_1) { instance_double(Hydra::PCDM::Object, members: [member_2]) }
-      let(:member_2) { instance_double(Hydra::PCDM::Object, members: [member_3]) }
-      let(:member_3) { instance_double(Hydra::PCDM::Object, members: []) }
-      let(:members)  { [member_1] }
-      it 'does not go any deeper than necessary' do
-        expect(subject).to include(member_2)
-        expect(member_2).not_to have_received(:members)
-        expect(member_3).not_to have_received(:members)
-      end
-    end
-  end
-end