blacklight-spotlight 0.31.0 → 0.32.0

data/spec/models/spotlight/reindexing_log_entry_spec.rb

@@ -0,0 +1,135 @@
+describe Spotlight::ReindexingLogEntry, type: :model do
+  subject { FactoryGirl.build(:reindexing_log_entry) }
+
+  describe 'scope' do
+    before(:all) do
+      # we only want to persist these rows for the duration a given test run...
+      DatabaseCleaner.start
+      # create (and save) entries in the log that can be queried, so that we can test our scopes
+      (0..10).to_a.each { FactoryGirl.create(:recent_reindexing_log_entry) }
+      FactoryGirl.create(:unstarted_reindexing_log_entry)
+      (0..10).to_a.each { FactoryGirl.create(:recent_reindexing_log_entry) }
+    end
+
+    after(:all) do
+      # ...remove the entries we created, now that we're done with them
+      DatabaseCleaner.clean
+    end
+
+    let(:sorted_log_entry_list) do
+      unstarted_entries = Spotlight::ReindexingLogEntry.where(start_time: nil).to_a
+      started_entries = Spotlight::ReindexingLogEntry.where.not(start_time: nil).to_a.sort_by(&:start_time).reverse
+      unstarted_entries + started_entries # null start times should be first
+    end
+
+    context 'default' do
+      it 'sorts by start_time in descending order' do
+        default_log_entry_list = Spotlight::ReindexingLogEntry.all.to_a
+        expect(default_log_entry_list).to eq sorted_log_entry_list
+      end
+    end
+
+    context 'recent' do
+      it 'returns the most recent 5 entries (sorted by start_time descending)' do
+        recent_log_entry_list = Spotlight::ReindexingLogEntry.recent.to_a
+        expect(recent_log_entry_list).to eq sorted_log_entry_list[0..4]
+      end
+    end
+  end
+
+  describe '#duration' do
+    context 'when end_time is present' do
+      it 'is calculated as difference between end_time and start_time' do
+        expect(subject.duration).to eq 300
+      end
+    end
+
+    context 'when end_time is not present' do
+      subject { FactoryGirl.build(:in_progress_reindexing_log_entry) }
+
+      it 'is nil' do
+        expect(subject.duration).to be nil
+      end
+    end
+  end
+
+  describe 'state updating methods' do
+    describe '#in_progress!' do
+      subject { FactoryGirl.build(:unstarted_reindexing_log_entry) }
+
+      context 'executes normally' do
+        it 'sets start_time and job_status' do
+          lower_time_bound = Time.zone.now
+          subject.in_progress!
+          upper_time_bound = Time.zone.now
+
+          expect(subject.start_time).to be_between(lower_time_bound, upper_time_bound)
+          expect(subject.job_status).to eq 'in_progress'
+        end
+      end
+
+      context 'encounters an unexpected error' do
+        it "traps the exception and logs an error so that the caller doesn't have to deal with it" do
+          expect(subject).to receive(:'start_time=').and_raise StandardError.new # try to blow up the in_progress! call
+          expect(Rails.logger).to receive(:error) do |arg|
+            expect(arg).to match(/^unexpected error updating log entry to :in_progress from \[".*reindexing_log_entry.rb/)
+          end
+
+          expect { subject.in_progress! }.not_to raise_error
+        end
+      end
+    end
+
+    describe '#succeeded!' do
+      subject { FactoryGirl.build(:in_progress_reindexing_log_entry) }
+
+      context 'executes normally' do
+        it 'sets end_time and job_status' do
+          lower_time_bound = Time.zone.now
+          subject.succeeded!
+          upper_time_bound = Time.zone.now
+
+          expect(subject.end_time).to be_between(lower_time_bound, upper_time_bound)
+          expect(subject.job_status).to eq 'succeeded'
+        end
+      end
+
+      context 'encounters an unexpected error' do
+        it "traps the exception and logs an error so that the caller doesn't have to deal with it" do
+          expect(subject).to receive(:'end_time=').and_raise StandardError.new # try to blow up the succeeded! call
+          expect(Rails.logger).to receive(:error) do |arg|
+            expect(arg).to match(/^unexpected error updating log entry to :succeeded from \[".*reindexing_log_entry.rb/)
+          end
+
+          expect { subject.succeeded! }.not_to raise_error
+        end
+      end
+    end
+
+    describe '#failed!' do
+      subject { FactoryGirl.build(:in_progress_reindexing_log_entry) }
+
+      context 'executes normally' do
+        it 'sets end_time and job_status' do
+          lower_time_bound = Time.zone.now
+          subject.failed!
+          upper_time_bound = Time.zone.now
+
+          expect(subject.end_time).to be_between(lower_time_bound, upper_time_bound)
+          expect(subject.job_status).to eq 'failed'
+        end
+      end
+
+      context 'encounters an unexpected error' do
+        it "traps the exception and logs an error so that the caller doesn't have to deal with it" do
+          expect(subject).to receive(:'end_time=').and_raise StandardError.new # try to blow up the failed! call
+          expect(Rails.logger).to receive(:error) do |arg|
+            expect(arg).to match(/^unexpected error updating log entry to :failed from \[".*reindexing_log_entry.rb/)
+          end
+
+          expect { subject.failed! }.not_to raise_error
+        end
+      end
+    end
+  end
+end

data/spec/models/spotlight/resource_spec.rb

@@ -4,29 +4,6 @@ describe Spotlight::Resource, type: :model do
   end
   let(:exhibit) { FactoryGirl.create(:exhibit) }
 
-  describe '#enqueued_at' do
-    it 'casts values to Time objects' do
-      t = Time.zone.now.at_beginning_of_minute
-      subject.enqueued_at = t
-
-      expect(subject.enqueued_at).to eq t
-    end
-
-    it 'handles blank values' do
-      subject.enqueued_at = nil
-      expect(subject.enqueued_at).to be_nil
-    end
-  end
-
-  describe '#last_indexed_finished' do
-    it 'casts values to Time objects' do
-      t = Time.zone.now.at_beginning_of_minute
-      subject.last_indexed_finished = t
-
-      expect(subject.last_indexed_finished).to eq t
-    end
-  end
-
   describe '#reindex' do
     context 'with a provider that generates ids' do
       subject do
@@ -55,6 +32,18 @@ describe Spotlight::Resource, type: :model do
         subject.reindex
       end
 
+      context 'reindexing_log_entry is provided' do
+        before do
+          allow(subject.send(:blacklight_solr)).to receive(:update)
+        end
+
+        it 'updates the count of reindexed items in the log entry' do
+          reindexing_log_entry = double(Spotlight::ReindexingLogEntry)
+          expect(reindexing_log_entry).to receive(:update).with(items_reindexed_count: 1)
+          subject.reindex reindexing_log_entry
+        end
+      end
+
       context 'when the index is not writable' do
         before do
           allow(Spotlight::Engine.config).to receive_messages(writable_index: false)
@@ -83,13 +72,12 @@ describe Spotlight::Resource, type: :model do
           subject.reindex
         end
 
-        it 'records indexing metadata as document attributes' do
+        it 'touches the exhibit to clear any caches' do
+          allow(subject.exhibit).to receive(:touch)
+
           subject.reindex
 
-          expect(subject.indexed_at).to be > Time.zone.now - 5.seconds
-          expect(subject.last_indexed_estimate).to eq 2
-          expect(subject.last_indexed_count).to eq 2
-          expect(subject.last_index_elapsed_time).to be < 1
+          expect(subject.exhibit).to have_received(:touch)
         end
       end
     end

data/spec/support/views/test_view_helpers.rb

@@ -4,6 +4,7 @@ module Spotlight
 
     included do
       before do
+        view.send(:extend, Spotlight::RenderingHelper)
         view.send(:extend, Spotlight::MainAppHelpers)
         view.send(:extend, Spotlight::CrudLinkHelpers)
         view.send(:extend, Spotlight::TitleHelper)

data/spec/views/spotlight/browse/show.html.erb_spec.rb

@@ -45,6 +45,12 @@ describe 'spotlight/browse/show', type: :view do
     expect(response).to have_selector 'p', text: search.long_description
   end
 
+  it 'renders the long description as markdown' do
+    allow(search).to receive_messages(long_description: '[some link](/somewhere)')
+    render
+    expect(response).to have_selector 'p a', text: 'some link'
+  end
+
   it 'displays search results actions' do
     render
     expect(response).to have_content 'Sort and Per Page actions'

data/spec/views/spotlight/dashboards/_reindexing_activity.html.erb_spec.rb

@@ -0,0 +1,87 @@
+describe 'spotlight/dashboards/_reindexing_activity.html.erb', type: :view do
+  # recent reindexing entries should be sorted by start_time in descending order, so mock that behavior
+  let(:recent_reindexing) do
+    [FactoryGirl.build(:unstarted_reindexing_log_entry)] + # nil start_time is trouble for the sort_by used to create the rest of the fixture's rows
+      [
+        FactoryGirl.build(:reindexing_log_entry),
+        FactoryGirl.build(:in_progress_reindexing_log_entry),
+        FactoryGirl.build(:recent_reindexing_log_entry),
+        FactoryGirl.build(:failed_reindexing_log_entry)
+      ].sort_by(&:start_time).reverse
+  end
+  let(:p) { 'spotlight/dashboards/reindexing_activity' }
+
+  context 'the reindexing log is empty' do
+    before do
+      assign(:recent_reindexing, [])
+      render p
+    end
+
+    it 'displays the section header' do
+      expect(rendered).to have_css('h3', text: 'Recent Item Indexing Activity')
+    end
+
+    it 'displays an explanatory message when there are no reindexing attempts in the log' do
+      expect(rendered).to have_content 'There has been no reindexing activity'
+    end
+  end
+
+  context 'the reindexing log has entries' do
+    before do
+      assign(:recent_reindexing, recent_reindexing)
+      render p
+    end
+
+    it 'displays the correct localized column headings when there are reindexing attempts in the log' do
+      expect(rendered).to have_css('table.table-striped th.col-md-3', text: 'Date', count: 1)
+      expect(rendered).to have_css('table.table-striped th.col-md-2', text: 'Requested By', count: 1)
+      expect(rendered).to have_css('table.table-striped th.col-md-1', text: 'Items Indexed', count: 1)
+      expect(rendered).to have_css('table.table-striped th.col-md-2', text: 'Elapsed Time', count: 1)
+      expect(rendered).to have_css('table.table-striped th.col-md-2', text: 'Status', count: 1)
+    end
+
+    it 'formats the start time correctly' do
+      expect(rendered).to have_css('table.table-striped td', text: '05 Jan 23:00', count: 1)
+      expect(rendered).to have_css('table.table-striped td', text: '10 Jan 23:00', count: 1)
+    end
+
+    it 'displays the user that initiated the reindexing' do
+      expect(rendered).to have_css('table.table-striped td', text: /user\d+@example.com/, count: 5)
+    end
+
+    it 'displays the count of reindexed items' do
+      expect(rendered).to have_css('table.table-striped td', text: /^10$/, count: 2)
+      expect(rendered).to have_css('table.table-striped td', text: /^100$/, count: 1)
+    end
+
+    it 'displays the duration of completed reindexing attempts' do
+      expect(rendered).to have_css('table.table-striped td', text: '5 minutes', count: 3)
+    end
+
+    it 'displays nothing in the duration column or start time column when the info is unavailable (e.g. unstarted or in_progress attempts)' do
+      # we expect 2 blank durations, and 1 blank start time (1 unstarted log entry w/ blank start and duration, 1 in_progress w/ blank duration)
+      expect(rendered).to have_css('table.table-striped td', text: /^$/, count: 3)
+    end
+
+    it 'displays the status of the reindexing attempt using localized text' do
+      expect(rendered).to have_css('table.table-striped td', text: 'Not Yet Started', count: 1)
+      expect(rendered).to have_css('table.table-striped td', text: 'Successful', count: 2)
+      expect(rendered).to have_css('table.table-striped td', text: 'In Progress', count: 1)
+      expect(rendered).to have_css('table.table-striped td', text: 'Failed', count: 1)
+    end
+  end
+
+  context 'a reindexing log entry has a null user' do
+    it 'displays blank in the user field and renders without error' do
+      assign(:recent_reindexing, [FactoryGirl.build(:reindexing_log_entry_no_user)])
+      expect { render p }.not_to raise_error
+
+      # we expect one blank table cell for the user, and values for everything else
+      expect(rendered).to have_css('table.table-striped td', text: /^$/, count: 1)
+      expect(rendered).to have_css('table.table-striped td', text: '05 Jan 23:00', count: 1)
+      expect(rendered).to have_css('table.table-striped td', text: /^10$/, count: 1)
+      expect(rendered).to have_css('table.table-striped td', text: '5 minutes', count: 1)
+      expect(rendered).to have_css('table.table-striped td', text: 'Successful', count: 1)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-spotlight
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.32.0
 platform: ruby
 authors:
 - Chris Beer
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -249,6 +249,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: roar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: roar-rails
   requirement: !ruby/object:Gem::Requirement
@@ -825,6 +839,7 @@ files:
 - app/helpers/spotlight/meta_helper.rb
 - app/helpers/spotlight/navbar_helper.rb
 - app/helpers/spotlight/pages_helper.rb
+- app/helpers/spotlight/rendering_helper.rb
 - app/helpers/spotlight/roles_helper.rb
 - app/helpers/spotlight/search_configurations_helper.rb
 - app/helpers/spotlight/searches_helper.rb
@@ -888,6 +903,7 @@ files:
 - app/models/spotlight/masthead.rb
 - app/models/spotlight/page.rb
 - app/models/spotlight/reindex_progress.rb
+- app/models/spotlight/reindexing_log_entry.rb
 - app/models/spotlight/resource.rb
 - app/models/spotlight/resources/csv_upload.rb
 - app/models/spotlight/resources/json_upload.rb
@@ -973,6 +989,7 @@ files:
 - app/views/spotlight/dashboards/_analytics.html.erb
 - app/views/spotlight/dashboards/_page.html.erb
 - app/views/spotlight/dashboards/_page_activity.html.erb
+- app/views/spotlight/dashboards/_reindexing_activity.html.erb
 - app/views/spotlight/dashboards/_solr_document_activity.html.erb
 - app/views/spotlight/dashboards/analytics.html.erb
 - app/views/spotlight/dashboards/show.html.erb
@@ -1122,6 +1139,7 @@ files:
 - db/migrate/20160815165432_add_resource_to_solr_document_sidecar.rb
 - db/migrate/20160816165432_add_index_status_to_solr_document_sidecar.rb
 - db/migrate/20160929180534_add_document_index_to_solr_document_sidecar.rb
+- db/migrate/20170105222939_create_spotlight_reindexing_log_entries.rb
 - lib/blacklight/spotlight.rb
 - lib/generators/spotlight/install_generator.rb
 - lib/generators/spotlight/scaffold_resource_generator.rb
@@ -1173,6 +1191,7 @@ files:
 - spec/factories/exhibits.rb
 - spec/factories/featured_images.rb
 - spec/factories/pages.rb
+- spec/factories/reindexing_log_entries.rb
 - spec/factories/resources.rb
 - spec/factories/roles.rb
 - spec/factories/searches.rb
@@ -1277,6 +1296,7 @@ files:
 - spec/models/spotlight/masthead_spec.rb
 - spec/models/spotlight/page_spec.rb
 - spec/models/spotlight/reindex_progress_spec.rb
+- spec/models/spotlight/reindexing_log_entry_spec.rb
 - spec/models/spotlight/resource_spec.rb
 - spec/models/spotlight/resources/open_graph_spec.rb
 - spec/models/spotlight/resources/upload_spec.rb
@@ -1325,6 +1345,7 @@ files:
 - spec/views/spotlight/catalog/edit.html.erb_spec.rb
 - spec/views/spotlight/contacts/edit.html.erb_spec.rb
 - spec/views/spotlight/dashboards/_analytics.html.erb_spec.rb
+- spec/views/spotlight/dashboards/_reindexing_activity.html.erb_spec.rb
 - spec/views/spotlight/dashboards/analytics.html.erb_spec.rb
 - spec/views/spotlight/exhibits/_exhibit_card_front.html.erb_spec.rb
 - spec/views/spotlight/exhibits/edit.html.erb_spec.rb
@@ -1446,6 +1467,7 @@ test_files:
 - spec/factories/exhibits.rb
 - spec/factories/featured_images.rb
 - spec/factories/pages.rb
+- spec/factories/reindexing_log_entries.rb
 - spec/factories/resources.rb
 - spec/factories/roles.rb
 - spec/factories/searches.rb
@@ -1550,6 +1572,7 @@ test_files:
 - spec/models/spotlight/masthead_spec.rb
 - spec/models/spotlight/page_spec.rb
 - spec/models/spotlight/reindex_progress_spec.rb
+- spec/models/spotlight/reindexing_log_entry_spec.rb
 - spec/models/spotlight/resource_spec.rb
 - spec/models/spotlight/resources/open_graph_spec.rb
 - spec/models/spotlight/resources/upload_spec.rb
@@ -1598,6 +1621,7 @@ test_files:
 - spec/views/spotlight/catalog/edit.html.erb_spec.rb
 - spec/views/spotlight/contacts/edit.html.erb_spec.rb
 - spec/views/spotlight/dashboards/_analytics.html.erb_spec.rb
+- spec/views/spotlight/dashboards/_reindexing_activity.html.erb_spec.rb
 - spec/views/spotlight/dashboards/analytics.html.erb_spec.rb
 - spec/views/spotlight/exhibits/_exhibit_card_front.html.erb_spec.rb
 - spec/views/spotlight/exhibits/edit.html.erb_spec.rb