spotlight-dor-resources 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 182216d0851743e3b7309ddc05271a0ba7c16cea
-  data.tar.gz: 21bf71fe88cb1e52a766404f60476519eddbe6f9
+  metadata.gz: c7c9626527848a815f94b5e897c644439a4130b5
+  data.tar.gz: a5bb46bce723dbdb76d9799a06954854a588f351
 SHA512:
-  metadata.gz: bd1fd4bfe26544a6e344d0195abb4c74bc8ced7cc8bf70e7a910926c08e48ed8928a90cf1429dab4c7022398d2f149ad6cbf483fad54a0a34681abb0dbd94f6a
-  data.tar.gz: 4fa9a09684202c7894f99f00cfb5bb2c10c7db5475c8adf3b19a257ce1e1d442228db2ea753d2746af52b50cb580f1961939376b5ec6218210802f8de702c7bd
+  metadata.gz: e4f617b75c4659fb64a368eddf055168af6fcac6e9a8053aa3cd0d1c8d421ddf1e6083a3ce4f313dc453b246e9d59af9e1b90667325965d5566c40ce841a5e21
+  data.tar.gz: 8aae9489098370a7ce5982813ded06b216ecc29d1b8f9d33909041a9f6dc82abcf2de25e975b6a07468acfc63b47764d7fc685df1de635095107e6289111796d

data/.gitignore

@@ -2,7 +2,6 @@
 *.sassc
 .sass-cache
 capybara-*.html
-.rspec
 .rvmrc
 .ruby-version
 /.bundle

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -11,8 +11,6 @@ AllCops:
     - '.internal_test_app/**/*'
     - 'spec/test_app_templates/**/*'
     - 'spec/spec_helper.rb'
-    - 'spec/teaspoon_env.rb'
-    - 'vendor/**/*'
   TargetRubyVersion: 2.2
 
 Rails:

data/app/models/spotlight/resources/dor_harvester.rb

@@ -1,7 +1,7 @@
 module Spotlight::Resources
-  # Base Resource indexer for objects in DOR
+  # Base Resource harvester for objects in DOR
   class DorHarvester < Spotlight::Resource
-    include ActiveSupport::Benchmarkable
+    self.document_builder_class = Spotlight::Resources::DorSolrDocumentBuilder
 
     store :data, accessors: [:druid_list]
 
@@ -11,25 +11,6 @@ module Spotlight::Resources
       end
     end
 
-    ##
-    # Generate solr documents for the DOR resources identified by this object
-    #
-    # @return [Enumerator] an enumerator of solr document hashes for indexing
-    def to_solr
-      return to_enum(:to_solr) { size } unless block_given?
-
-      benchmark "Indexing resource #{inspect} (est. #{size} items)" do
-        base_doc = super
-
-        indexable_resources.each_with_index do |res, idx|
-          benchmark "Indexing item #{res.druid} in resource #{id} (#{idx} / #{size})" do
-            doc = to_solr_document(res)
-            yield base_doc.merge(doc) if doc
-          end
-        end
-      end
-    end
-
     def resources
       @resources ||= druids.map do |d|
         Spotlight::Dor::Resources.indexer.resource d
@@ -37,11 +18,9 @@ module Spotlight::Resources
     end
 
     def druids
-      @druids ||= druid_list.split("\n").map(&:strip)
+      @druids ||= druid_list.split(/\s+/).reject(&:blank?)
     end
 
-    private
-
     ##
     # Enumerate the resource, and any collection members, that should be indexed
     # into this exhibit
@@ -58,32 +37,5 @@ module Spotlight::Resources
         end
       end
     end
-
-    ##
-    # Estimate the number of documents this resource will create
-    def size
-      indexable_resources.size
-    end
-
-    ##
-    # Generate the solr document hash for a given resource by applying the current
-    # indexer steps.
-    #
-    # @return [Hash]
-    def to_solr_document(resource)
-      Spotlight::Dor::Resources.indexer.solr_document(resource)
-    rescue RuntimeError => e
-      logger.error("Error processing #{resource.druid}: #{e}")
-      nil
-    rescue => e
-      logger.error("Error processing #{resource.druid}: #{e}")
-      raise e
-    end
-
-    ##
-    # Write any logs (or benchmarking information) from this class to the gdor logs
-    def logger
-      Spotlight::Dor::Resources.indexer.logger
-    end
   end
 end

data/app/services/spotlight/resources/dor_solr_document_builder.rb

@@ -0,0 +1,62 @@
+module Spotlight
+  module Resources
+    # Base Resource indexer for objects in DOR
+    class DorSolrDocumentBuilder < Spotlight::SolrDocumentBuilder
+      include ActiveSupport::Benchmarkable
+
+      delegate :indexable_resources, to: :resource
+
+      ##
+      # Generate solr documents for the DOR resources identified by this object
+      #
+      # @return [Enumerator] an enumerator of solr document hashes for indexing
+      def to_solr
+        return to_enum(:to_solr) { size } unless block_given?
+
+        benchmark "Indexing resource #{inspect} (est. #{size} items)" do
+          base_doc = super
+
+          indexable_resources.each_with_index do |res, idx|
+            benchmark "Indexing item #{res.druid} in resource #{resource_id} (#{idx} / #{size})" do
+              doc = to_solr_document(res)
+              yield base_doc.merge(doc) if doc
+            end
+          end
+        end
+      end
+
+      private
+
+      def resource_id
+        resource.id
+      end
+
+      ##
+      # Estimate the number of documents this resource will create
+      def size
+        indexable_resources.size
+      end
+
+      ##
+      # Generate the solr document hash for a given resource by applying the current
+      # indexer steps.
+      #
+      # @return [Hash]
+      def to_solr_document(resource)
+        Spotlight::Dor::Resources.indexer.solr_document(resource)
+      rescue RuntimeError => e
+        logger.error("Error processing #{resource.druid}: #{e}")
+        nil
+      rescue => e
+        logger.error("Error processing #{resource.druid}: #{e}")
+        raise e
+      end
+
+      ##
+      # Write any logs (or benchmarking information) from this class to the gdor logs
+      def logger
+        Spotlight::Dor::Resources.indexer.logger
+      end
+    end
+  end
+end

data/lib/spotlight/dor/resources/version.rb

@@ -2,7 +2,7 @@ module Spotlight
   module Dor
     # :nodoc:
     module Resources
-      VERSION = '1.1.0'.freeze
+      VERSION = '2.0.0'.freeze
     end
   end
 end

data/spec/controllers/spotlight/resources/dor_harvester_controller_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Spotlight::Resources::DorHarvesterController, type: :controller do
   routes { Spotlight::Dor::Resources::Engine.routes }
   let(:resource) { double }
@@ -10,14 +8,11 @@ RSpec.describe Spotlight::Resources::DorHarvesterController, type: :controller d
   before do
     sign_in user
     allow(Spotlight::Resources::DorHarvester).to receive(:instance).and_return(resource)
+    expect(resource).to receive(:update).with(attributes)
+    allow(resource).to receive(:save_and_index).and_return(save_status)
   end
 
   describe '#create' do
-    before do
-      expect(resource).to receive(:update).with(attributes)
-      allow(resource).to receive(:save_and_index).and_return(save_status)
-    end
-
     context 'when save is successful' do
       let(:save_status) { true }
 
@@ -40,11 +35,6 @@ RSpec.describe Spotlight::Resources::DorHarvesterController, type: :controller d
   end
 
   describe '#update' do
-    before do
-      expect(resource).to receive(:update).with(attributes)
-      allow(resource).to receive(:save_and_index).and_return(save_status)
-    end
-
     context 'when save is successful' do
       let(:save_status) { true }
 

data/spec/integration/gdor_integration_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe 'gdor indexing integration test', :vcr do
   let :exhibit do
     double(solr_data: {}, blacklight_config: Blacklight::Configuration.new)
@@ -9,7 +7,7 @@ describe 'gdor indexing integration test', :vcr do
     r = Spotlight::Resources::DorHarvester.new(druid_list: 'xf680rd3068')
     allow(r).to receive(:to_global_id).and_return('x')
     allow(r).to receive(:exhibit).and_return(exhibit)
-    r.to_solr.first
+    r.document_builder.to_solr.first
   end
 
   it 'has a doc id' do

data/spec/lib/spotlight/dor/indexer_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe Spotlight::Dor::Indexer do
   subject { described_class.new }
 

data/spec/models/spotlight/resources/dor_harvester_spec.rb

@@ -24,8 +24,28 @@ describe Spotlight::Resources::DorHarvester do
   end
 
   describe '#druids' do
-    it 'extracts an array of DRUIDs from the list of druids' do
-      expect(subject.druids).to match_array 'xf680rd3068'
+    context 'with a single item' do
+      subject { described_class.new druid_list: 'xf680rd3068' }
+
+      it 'extracts an array of DRUIDs from the list of druids' do
+        expect(subject.druids).to match_array 'xf680rd3068'
+      end
+    end
+
+    context 'with multiple items' do
+      subject { described_class.new druid_list: "xf680rd3068\nxf680rd3069" }
+
+      it 'extracts an array of DRUIDs from the list of druids' do
+        expect(subject.druids).to match_array %w(xf680rd3068 xf680rd3069)
+      end
+    end
+
+    context 'with crazy whitespace' do
+      subject { described_class.new druid_list: "\t xf680rd3068\t\r\nxf680rd3067\t\t" }
+
+      it 'extracts an array of DRUIDs from the list of druids' do
+        expect(subject.druids).to match_array %w(xf680rd3068 xf680rd3067)
+      end
     end
   end
 
@@ -61,53 +81,4 @@ describe Spotlight::Resources::DorHarvester do
       subject.reindex
     end
   end
-
-  describe '#to_solr' do
-    before do
-      allow(Spotlight::Dor::Resources.indexer).to receive(:solr_document)
-    end
-
-    context 'with a collection' do
-      before do
-        allow(resource).to receive(:collection?).and_return(true)
-      end
-
-      it 'provides a solr document for the collection' do
-        allow(resource).to receive(:items).and_return([])
-        expect(Spotlight::Dor::Resources.indexer).to receive(:solr_document).with(resource).and_return(upstream: true)
-        expect(subject.to_solr.first).to include :upstream, :spotlight_resource_id_ssim, :spotlight_resource_type_ssim
-      end
-
-      it 'provides a solr document for the items too' do
-        item = double(druid: 'xyz')
-        allow(resource).to receive(:items).and_return([item])
-        expect(Spotlight::Dor::Resources.indexer).to receive(:solr_document).with(resource).and_return(collection: true)
-        expect(Spotlight::Dor::Resources.indexer).to receive(:solr_document).with(item).and_return(item: true)
-        solr_doc = subject.to_solr.to_a
-        expect(solr_doc.first).to include :collection
-        expect(solr_doc.last).to include :item
-      end
-
-      it 'traps indexing errors' do
-        allow(resource).to receive(:items).and_return([])
-        expect(Spotlight::Dor::Resources.indexer).to receive(:solr_document).and_raise(RuntimeError.new)
-        expect { subject.to_solr.to_a }.not_to raise_error
-      end
-
-      it 'log and raises other types of errors errors' do
-        allow(resource).to receive(:items).and_return([])
-        expect(Spotlight::Dor::Resources.indexer).to receive(:solr_document).and_raise(StandardError.new)
-        expect(subject.send(:logger)).to receive(:error).with(/Error processing xf680rd3068/)
-        expect { subject.to_solr.to_a }.to raise_error StandardError
-      end
-    end
-
-    context 'with a single item' do
-      it 'provides a solr document for the resource' do
-        allow(resource).to receive(:collection?).and_return(false)
-        expect(Spotlight::Dor::Resources.indexer).to receive(:solr_document).with(resource).and_return(upstream: true)
-        expect(subject.to_solr.first).to include :upstream, :spotlight_resource_id_ssim, :spotlight_resource_type_ssim
-      end
-    end
-  end
 end

data/spec/services/spotlight/resources/dor_solr_document_builder_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Spotlight::Resources::DorSolrDocumentBuilder do
+  let(:exhibit) { FactoryGirl.create(:exhibit) }
+
+  let :blacklight_solr do
+    double
+  end
+
+  subject { described_class.new harvester }
+  let(:harvester) { Spotlight::Resources::DorHarvester.new druid_list: 'xf680rd3068', exhibit: exhibit }
+
+  before do
+    allow(harvester).to receive(:blacklight_solr).and_return(blacklight_solr)
+    allow(harvester).to receive(:to_global_id).and_return('x')
+  end
+
+  let(:resource) { harvester.resources.first }
+
+  describe '#to_solr' do
+    before do
+      allow(Spotlight::Dor::Resources.indexer).to receive(:solr_document)
+    end
+
+    context 'with a collection' do
+      before do
+        allow(resource).to receive(:collection?).and_return(true)
+      end
+
+      it 'provides a solr document for the collection' do
+        allow(resource).to receive(:items).and_return([])
+        expect(Spotlight::Dor::Resources.indexer).to receive(:solr_document).with(resource).and_return(upstream: true)
+        expect(subject.to_solr.first).to include :upstream, :spotlight_resource_id_ssim, :spotlight_resource_type_ssim
+      end
+
+      context 'with items' do
+        let(:item) { instance_double('Harvestdor::Indexer::Resource', druid: 'xyz') }
+
+        before do
+          allow(resource).to receive(:items).and_return([item])
+        end
+
+        it 'provides a solr document for the items too' do
+          expect(Spotlight::Dor::Resources.indexer).to receive(:solr_document).with(resource).and_return(collection: true)
+          expect(Spotlight::Dor::Resources.indexer).to receive(:solr_document).with(item).and_return(item: true)
+          solr_doc = subject.to_solr.to_a
+          expect(solr_doc.first).to include :collection
+          expect(solr_doc.last).to include :item
+        end
+      end
+
+      it 'traps indexing errors' do
+        allow(resource).to receive(:items).and_return([])
+        expect(Spotlight::Dor::Resources.indexer).to receive(:solr_document).and_raise(RuntimeError.new)
+        expect { subject.to_solr.to_a }.not_to raise_error
+      end
+
+      it 'log and raises other types of errors errors' do
+        allow(resource).to receive(:items).and_return([])
+        expect(Spotlight::Dor::Resources.indexer).to receive(:solr_document).and_raise(StandardError.new)
+        expect(subject.send(:logger)).to receive(:error).with(/Error processing xf680rd3068/)
+        expect { subject.to_solr.to_a }.to raise_error StandardError
+      end
+    end
+
+    context 'with a single item' do
+      it 'provides a solr document for the resource' do
+        allow(resource).to receive(:collection?).and_return(false)
+        expect(Spotlight::Dor::Resources.indexer).to receive(:solr_document).with(resource).and_return(upstream: true)
+        expect(subject.to_solr.first).to include :upstream, :spotlight_resource_id_ssim, :spotlight_resource_type_ssim
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -30,7 +30,6 @@ FactoryGirl.find_definitions
 require 'database_cleaner'
 require 'spotlight'
 
-
 Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
 
 VCR.configure do |config|
@@ -56,8 +55,13 @@ RSpec.configure do |config|
     DatabaseCleaner.clean
   end
 
-  config.include Devise::TestHelpers, type: :controller
-  config.include Devise::TestHelpers, type: :view
+  if defined? Devise::Test::ControllerHelpers
+    config.include Devise::Test::ControllerHelpers, type: :controller
+    config.include Devise::Test::ControllerHelpers, type: :view
+  else
+    config.include Devise::TestHelpers, type: :controller
+    config.include Devise::TestHelpers, type: :view
+  end
   config.include Warden::Test::Helpers, type: :feature
   config.after(:each, type: :feature) { Warden.test_reset! }
   config.include Capybara::DSL

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -36,7 +36,11 @@ class TestAppGenerator < Rails::Generators::Base
   def configure_gdor
     copy_file 'gdor.yml', 'config/gdor.yml', force: true
   end
-  
+
+  def configure_papertrail
+    copy_file 'paper_trail.rb', 'config/initializers/paper_trail.rb'
+  end
+
   def run_spotlight_dor_resources_generator
     generate 'spotlight:dor:resources:install'
   end

data/spec/test_app_templates/paper_trail.rb

@@ -0,0 +1 @@
+PaperTrail.config.track_associations = false

data/spotlight-dor-resources.gemspec

@@ -24,9 +24,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'solrizer'
   spec.add_dependency 'gdor-indexer', '>=0.5.0' # for new pub date methods
   # newer versions of harvestdor-indexer have performance improvements for collections
-  spec.add_dependency 'harvestdor-indexer', '~> 2.3'
+  spec.add_dependency 'harvestdor-indexer', '~> 2.3', '>= 2.3.2'
   spec.add_dependency 'rails'
-  spec.add_dependency 'blacklight-spotlight', '~> 0.18'
+  spec.add_dependency 'blacklight-spotlight', '~> 0.19'
   spec.add_dependency 'parallel'
   spec.add_dependency 'stanford-mods', '~> 2.1'
   spec.add_development_dependency 'bundler', '~> 1.5'
@@ -42,10 +42,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'exhibits_solr_conf', '~> 0.1'
   spec.add_development_dependency 'factory_girl_rails'
   spec.add_development_dependency 'rubocop', '~> 0.36'
+  spec.add_development_dependency 'riiif', '~> 0.4.0' # optional dependency in production
 
   # FIXME: we shouldn't need explicit sitemap_generator dependency here as it should come with spotlight
   #   but travis fails without it (though tests run fine locally)
-  # cbeer:  "we're injecting the dependency into the host app. maybe we're just
-  #   missing a `bundle install` somewhere to fix that up"
+  # cbeer: "we're injecting the dependency into the host app.
+  #        maybe we're just missing a `bundle install` somewhere to fix that up"
   spec.add_development_dependency 'sitemap_generator'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spotlight-dor-resources
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-08 00:00:00.000000000 Z
+date: 2016-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -59,6 +59,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -66,6 +69,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -304,6 +310,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.36'
+- !ruby/object:Gem::Dependency
+  name: riiif
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: sitemap_generator
   requirement: !ruby/object:Gem::Requirement
@@ -327,6 +347,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".hound.yml"
+- ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".travis.yml"
@@ -336,6 +357,7 @@ files:
 - Rakefile
 - app/controllers/spotlight/resources/dor_harvester_controller.rb
 - app/models/spotlight/resources/dor_harvester.rb
+- app/services/spotlight/resources/dor_solr_document_builder.rb
 - app/views/spotlight/resources/dor_harvester/_form.html.erb
 - config/locales/spotlight-dor-resources.en.yml
 - config/routes.rb
@@ -348,10 +370,12 @@ files:
 - spec/integration/gdor_integration_spec.rb
 - spec/lib/spotlight/dor/indexer_spec.rb
 - spec/models/spotlight/resources/dor_harvester_spec.rb
+- spec/services/spotlight/resources/dor_solr_document_builder_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/catalog_controller.rb
 - spec/test_app_templates/gdor.yml
 - spec/test_app_templates/lib/generators/test_app_generator.rb
+- spec/test_app_templates/paper_trail.rb
 - spec/vcr_cassettes/gdor_indexing_integration_test/has_a_doc_id.yml
 - spec/vcr_cassettes/gdor_indexing_integration_test/has_exhibit-specific_indexing.yml
 - spec/vcr_cassettes/gdor_indexing_integration_test/has_spotlight_data.yml
@@ -377,7 +401,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Spotlight resource indexer for DOR resources.
@@ -386,10 +410,12 @@ test_files:
 - spec/integration/gdor_integration_spec.rb
 - spec/lib/spotlight/dor/indexer_spec.rb
 - spec/models/spotlight/resources/dor_harvester_spec.rb
+- spec/services/spotlight/resources/dor_solr_document_builder_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/catalog_controller.rb
 - spec/test_app_templates/gdor.yml
 - spec/test_app_templates/lib/generators/test_app_generator.rb
+- spec/test_app_templates/paper_trail.rb
 - spec/vcr_cassettes/gdor_indexing_integration_test/has_a_doc_id.yml
 - spec/vcr_cassettes/gdor_indexing_integration_test/has_exhibit-specific_indexing.yml
 - spec/vcr_cassettes/gdor_indexing_integration_test/has_spotlight_data.yml