blacklight-spotlight 0.4.1 → 0.5.0

data/spec/models/spotlight/feature_page_spec.rb

@@ -1,30 +1,30 @@
 require 'spec_helper'
 
-describe Spotlight::FeaturePage, :type => :model do
+describe Spotlight::FeaturePage, type: :model do
   let(:exhibit) { FactoryGirl.create(:exhibit) }
-  describe "default_scope" do
+  describe 'default_scope' do
     let!(:page1) { FactoryGirl.create(:feature_page, weight: 5, exhibit: exhibit) }
     let!(:page2) { FactoryGirl.create(:feature_page, weight: 1, exhibit: exhibit) }
     let!(:page3) { FactoryGirl.create(:feature_page, weight: 10, exhibit: exhibit) }
-    it "should order by weight" do
-      expect(Spotlight::FeaturePage.all.map(&:weight)).to eq [1, 5, 10]
+    it 'orders by weight' do
+      expect(described_class.all.map(&:weight)).to eq [1, 5, 10]
     end
   end
 
-  describe "display_sidebar?" do
-    let(:parent)  { FactoryGirl.create(:feature_page, exhibit: exhibit) }
-    let!(:child) { FactoryGirl.create(:feature_page, parent_page: parent, exhibit: exhibit ) }
-    let!(:unpublished_parent)  { FactoryGirl.create(:feature_page, published: false, exhibit: exhibit) }
-    let!(:unpublished_child) { FactoryGirl.create(:feature_page, parent_page: unpublished_parent, published: false, exhibit: exhibit ) }
+  describe 'display_sidebar?' do
+    let(:parent) { FactoryGirl.create(:feature_page, exhibit: exhibit) }
+    let!(:child) { FactoryGirl.create(:feature_page, parent_page: parent, exhibit: exhibit) }
+    let!(:unpublished_parent) { FactoryGirl.create(:feature_page, published: false, exhibit: exhibit) }
+    let!(:unpublished_child) { FactoryGirl.create(:feature_page, parent_page: unpublished_parent, published: false, exhibit: exhibit) }
     before { unpublished_parent.display_sidebar = false }
-    it "should be set to true if the page has a published child" do
+    it 'is set to true if the page has a published child' do
       expect(parent.display_sidebar?).to be_truthy
     end
-    it "should be set to true on the parent of published child pages" do
+    it 'is set to true on the parent of published child pages' do
       parent.display_sidebar = false
       expect(parent.display_sidebar?).to be_truthy
     end
-    it "should be set to true when publishing a child page" do
+    it 'is set to true when publishing a child page' do
       expect(unpublished_parent.display_sidebar?).to be_falsey
       unpublished_parent.published = true
       unpublished_child.published = true
@@ -33,44 +33,44 @@ describe Spotlight::FeaturePage, :type => :model do
     end
   end
 
-  describe "weight" do
+  describe 'weight' do
     let(:good_weight) { FactoryGirl.build(:feature_page, weight: 10, exhibit: exhibit) }
-    let(:low_weight)  { FactoryGirl.build(:feature_page, weight: -1, exhibit: exhibit) }
-    let(:high_weight) { FactoryGirl.build(:feature_page, weight:  51, exhibit: exhibit) }
-    it "should default to 50" do
-      expect(Spotlight::FeaturePage.new.weight).to eq 50
+    let(:low_weight) { FactoryGirl.build(:feature_page, weight: -1, exhibit: exhibit) }
+    let(:high_weight) { FactoryGirl.build(:feature_page, weight: 51, exhibit: exhibit) }
+    it 'defaults to 50' do
+      expect(described_class.new.weight).to eq 50
     end
-    it "should validate when in the 0 to 50 range" do
+    it 'validates when in the 0 to 50 range' do
       expect(good_weight).to be_valid
       expect(good_weight.weight).to eq 10
     end
-    it "should raise an error when outside of the 0 to 50 range" do
-      expect(low_weight ).to_not be_valid
+    it 'raises an error when outside of the 0 to 50 range' do
+      expect(low_weight).to_not be_valid
       expect(high_weight).to_not be_valid
     end
-    it "settable valid maximum" do
-      stub_const("Spotlight::Page::MAX_PAGES", 51)
+    it 'settable valid maximum' do
+      stub_const('Spotlight::Page::MAX_PAGES', 51)
       expect(high_weight).to be_valid
     end
   end
 
-  it {is_expected.to be_feature_page}
-  it {is_expected.not_to be_about_page}
+  it { is_expected.to be_feature_page }
+  it { is_expected.not_to be_about_page }
 
-  describe "relationships" do
-    let(:parent)  { FactoryGirl.create(:feature_page, exhibit: exhibit) }
-    let!(:child1) { FactoryGirl.create(:feature_page, parent_page: parent, exhibit: exhibit ) }
-    let!(:child2) { FactoryGirl.create(:feature_page, parent_page: parent, exhibit: exhibit ) }
-    it "child pages should have a parent_page" do
+  describe 'relationships' do
+    let(:parent) { FactoryGirl.create(:feature_page, exhibit: exhibit) }
+    let!(:child1) { FactoryGirl.create(:feature_page, parent_page: parent, exhibit: exhibit) }
+    let!(:child2) { FactoryGirl.create(:feature_page, parent_page: parent, exhibit: exhibit) }
+    it 'child pages should have a parent_page' do
       [child1, child2].each do |child|
-         expect(child.parent_page).to eq parent
+        expect(child.parent_page).to eq parent
       end
     end
-    it "parent pages should have child_pages" do
+    it 'parent pages should have child_pages' do
       expect(parent.child_pages.length).to eq 2
       expect(parent.child_pages.map(&:id)).to eq [child1.id, child2.id]
     end
-    it "should define top_level_page? properly" do
+    it 'defines top_level_page? properly' do
       expect(parent.top_level_page?).to be_truthy
       expect(child1.top_level_page?).to be_falsey
       expect(child2.top_level_page?).to be_falsey

data/spec/models/spotlight/featured_image_spec.rb

@@ -1,15 +1,15 @@
 require 'spec_helper'
 
 describe Spotlight::FeaturedImage do
-  context "with an uploaded resource" do
+  context 'with an uploaded resource' do
     subject { described_class.new }
     let(:document) { double(uploaded_resource?: true) }
 
-    it "should replace the remote_image_url fragment with the local path to the file" do
-      allow(document).to receive_message_chain(:uploaded_resource, :url, file: File.open(File.join(FIXTURES_PATH, "avatar.png")))
+    it 'replaces the remote_image_url fragment with the local path to the file' do
+      allow(document).to receive_message_chain(:uploaded_resource, :url, file: File.open(File.join(FIXTURES_PATH, 'avatar.png')))
       allow(subject).to receive(:document).and_return(document)
 
-      subject.remote_image_url = "/some/path"
+      subject.remote_image_url = '/some/path'
       expect(subject.remote_image_url).to be_nil
 
       subject.validate
@@ -17,4 +17,4 @@ describe Spotlight::FeaturedImage do
       expect(subject.image.filename).to eq 'avatar.png'
     end
   end
-end
+end

data/spec/models/spotlight/field_metadata_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Spotlight::FieldMetadata do
+  let(:repository) { double }
+  let(:blacklight_config) do
+    Blacklight::Configuration.new do |config|
+      config.add_facet_field 'a'
+      config.add_facet_field 'b'
+      config.add_facet_field 'c'
+    end
+  end
+
+  let(:luke_response) do
+    {
+      fields: {
+        a: {
+          distinct: 100,
+          topTerms: %w(q w e)
+        },
+        b: {
+          distinct: 50,
+          topTerms: %w(r t y)
+        },
+        c: {
+          distinct: 3,
+          topTerms: [7, 8, 9]
+        }
+      }
+    }.with_indifferent_access
+  end
+
+  let(:facet_response) do
+    {
+      facet_counts: {
+        facet_queries: {
+          'a:[* TO *]' => 5,
+          'b:[* TO *]' => 10,
+          'c:[* TO *]' => 15
+        }
+      }
+    }.with_indifferent_access
+  end
+
+  subject { described_class.new(repository, blacklight_config) }
+
+  before do
+    allow(repository).to receive(:send_and_receive).with('admin/luke', hash_including(fl: '*')).and_return(luke_response)
+    allow(repository).to receive(:search).with(hash_including('facet' => true)).and_return(facet_response)
+  end
+
+  describe '#field' do
+    it 'has a document count' do
+      expect(subject.field('a')[:document_count]).to eq 5
+      expect(subject.field('b')[:document_count]).to eq 10
+      expect(subject.field('c')[:document_count]).to eq 15
+    end
+
+    it 'has a value count' do
+      expect(subject.field('a')[:value_count]).to eq 100
+      expect(subject.field('b')[:value_count]).to eq 50
+      expect(subject.field('c')[:value_count]).to eq 3
+    end
+
+    it 'gets a list of top terms' do
+      expect(subject.field('a')[:terms]).to match_array %w(q w e)
+      expect(subject.field('b')[:terms]).to match_array %w(r t y)
+      expect(subject.field('c')[:terms]).to match_array [7, 8, 9]
+    end
+
+    context 'for a missing field' do
+      it 'has reasonable default values' do
+        expect(subject.field('d')[:document_count]).to eq 0
+        expect(subject.field('d')[:value_count]).to eq 0
+        expect(subject.field('d')[:terms]).to be_empty
+      end
+    end
+  end
+end

data/spec/models/spotlight/home_page_spec.rb

@@ -1,22 +1,22 @@
 require 'spec_helper'
 
-describe Spotlight::HomePage, :type => :model do
+describe Spotlight::HomePage, type: :model do
   let(:home_page) { FactoryGirl.create(:home_page) }
-  it {is_expected.not_to be_feature_page}
-  it {is_expected.not_to be_about_page}
-  it "should display the sidebar" do
+  it { is_expected.not_to be_feature_page }
+  it { is_expected.not_to be_about_page }
+  it 'displays the sidebar' do
     expect(home_page.display_sidebar?).to be_truthy
   end
-  it "should be published" do
+  it 'is published' do
     expect(home_page.published).to be_truthy
   end
-  describe "title" do
-    it "should include default text" do
-      expect(home_page.title).to eq Spotlight::HomePage.default_title_text
+  describe 'title' do
+    it 'includes default text' do
+      expect(home_page.title).to eq described_class.default_title_text
     end
   end
-  describe "should_display_title?" do
-    it "should return the display_title attribute" do
+  describe 'should_display_title?' do
+    it 'returns the display_title attribute' do
       home_page.display_title = true
       expect(home_page.should_display_title?).to be_truthy
       home_page.display_title = false
@@ -24,18 +24,9 @@ describe Spotlight::HomePage, :type => :model do
     end
   end
   describe 'display_sidebar?' do
-
-    it 'should be false when the page disabled the display_sidebar' do
+    it 'is false when the page disabled the display_sidebar' do
       home_page.display_sidebar = false
       expect(home_page.display_sidebar?).to be_falsey
     end
-    it 'should be true when the exhibit is searchable' do
-      home_page.exhibit.searchable = true
-      expect(home_page.display_sidebar?).to be_truthy
-    end
-    it 'should be false when the exhibit is not searchable' do
-      home_page.exhibit.searchable = false
-      expect(home_page.display_sidebar?).to be_falsey
-    end
   end
 end

data/spec/models/spotlight/{spotlight_image_derivatives_spec.rb → image_derivatives_spec.rb}

@@ -1,4 +1,4 @@
-require "spec_helper"
+require 'spec_helper'
 
 class TestSpotlightImageDerivatives
   include Spotlight::ImageDerivatives
@@ -7,7 +7,7 @@ end
 describe Spotlight::ImageDerivatives do
   let(:subject) { TestSpotlightImageDerivatives.new }
   describe '#spotlight_image_derivatives' do
-    it 'should include default derivatives' do
+    it 'includes default derivatives' do
       expect(subject.spotlight_image_derivatives.length).to eq 3
       expect(subject.spotlight_image_derivatives.map do |d|
         d[:field]

data/spec/models/spotlight/main_navigation_spec.rb

@@ -1,21 +1,19 @@
 require 'spec_helper'
 
-describe Spotlight::MainNavigation, :type => :model do
+describe Spotlight::MainNavigation, type: :model do
   before do
     subject.exhibit = FactoryGirl.create(:exhibit)
   end
 
-  it "should have a default_label" do
+  it 'has a default_label' do
     subject.nav_type = :curated_features
-    expect(subject.default_label).to eq "Curated Features"
+    expect(subject.default_label).to eq 'Curated Features'
   end
 
-  it "should return the use the default label in the absence of a label" do
+  it 'returns the use the default label in the absence of a label' do
     expect(subject.label).to be_blank
     expect(subject.label_or_default).to eq subject.default_label
-    subject.label = "something else"
-    expect(subject.label_or_default).to eq "something else"
+    subject.label = 'something else'
+    expect(subject.label_or_default).to eq 'something else'
   end
-
-  
-end
+end

data/spec/models/spotlight/masthead_spec.rb

@@ -1,22 +1,22 @@
 require 'spec_helper'
 
-describe Spotlight::Masthead, :type => :model do
+describe Spotlight::Masthead, type: :model do
   describe '#masthead_exists?' do
-    let(:masthead) { stub_model(Spotlight::Masthead) }
+    let(:masthead) { stub_model(described_class) }
     let(:image) { OpenStruct.new }
-    it 'should return false when the masthead is set to not display' do
+    it 'returns false when the masthead is set to not display' do
       expect(masthead.display?).to be_falsey
     end
-    it 'should return false when the cropped image is not present' do
+    it 'returns false when the cropped image is not present' do
       masthead.display = true
       expect(masthead.display?).to be_falsey
     end
-    it 'should return false when the cropped image is present but the masthead is set to not display' do
+    it 'returns false when the cropped image is present but the masthead is set to not display' do
       allow(masthead).to receive(:image).and_return(image)
       allow(image).to receive(:cropped).and_return([0])
       expect(masthead.display?).to be_falsey
     end
-    it 'should return true when the cropped image is present and the masthead is set to display' do
+    it 'returns true when the cropped image is present and the masthead is set to display' do
       masthead.display = true
       expect(masthead).to receive(:image).and_return(image)
       expect(image).to receive(:cropped).and_return([0])

data/spec/models/spotlight/page_spec.rb

@@ -1,80 +1,77 @@
 require 'spec_helper'
 
-describe Spotlight::Page, :type => :model do
-
+describe Spotlight::Page, type: :model do
   let(:exhibit) { FactoryGirl.create(:exhibit) }
-  let!(:parent_page) {  Spotlight::FeaturePage.create! exhibit: exhibit, published: true }
-  let!(:child_page) {  Spotlight::FeaturePage.create! exhibit: exhibit, published: false, parent_page: parent_page }
+  let!(:parent_page) { Spotlight::FeaturePage.create! exhibit: exhibit, published: true }
+  let!(:child_page) { Spotlight::FeaturePage.create! exhibit: exhibit, published: false, parent_page: parent_page }
 
-  describe ".at_top_level" do
-    it "should scope results to only top level pages" do
-      expect(Spotlight::Page.at_top_level).to_not include child_page
+  describe '.at_top_level' do
+    it 'scopes results to only top level pages' do
+      expect(described_class.at_top_level).to_not include child_page
     end
   end
 
-  describe ".published" do
-    it "should scope results to only published pages" do
-      expect(Spotlight::Page.at_top_level).to_not include child_page
+  describe '.published' do
+    it 'scopes results to only published pages' do
+      expect(described_class.at_top_level).to_not include child_page
     end
   end
 
-  describe "#top_level_page?" do
-    it "should check if the page is a top-level page" do
+  describe '#top_level_page?' do
+    it 'checks if the page is a top-level page' do
       expect(parent_page).to be_a_top_level_page
       expect(child_page).not_to be_a_top_level_page
     end
   end
 
-  describe "#top_level_page_or_self" do  
-    it "should fetch the top level page" do
+  describe '#top_level_page_or_self' do
+    it 'fetches the top level page' do
       expect(child_page.top_level_page_or_self).to be parent_page
     end
 
-    it "should be the same object if the page is a top level page" do 
+    it 'is the same object if the page is a top level page' do
       expect(parent_page.top_level_page_or_self).to be parent_page
-
     end
   end
-  describe ".display_sidebar" do
-    it "should be set to true by default" do
+  describe '.display_sidebar' do
+    it 'is set to true by default' do
       expect(parent_page.display_sidebar?).to be_truthy
     end
   end
-  describe "should_display_title?" do
+  describe 'should_display_title?' do
     let(:page) { FactoryGirl.create(:feature_page) }
-    it "should return if the title is present or not" do
+    it 'returns if the title is present or not' do
       expect(page.title).not_to be_blank
       expect(page.should_display_title?).to be_truthy
-      page.title = ""
+      page.title = ''
       expect(page.should_display_title?).to be_falsey
     end
   end
 
-  describe "#content=" do
+  describe '#content=' do
     let(:page) { FactoryGirl.create(:feature_page) }
 
-    it "should work with a serialized JSON array" do
+    it 'works with a serialized JSON array' do
       page.content = [].to_json
       expect(page.content).to be_a_kind_of SirTrevorRails::BlockArray
     end
-    it "should work with an array" do
+    it 'works with an array' do
       page.content = []
       expect(page.content).to be_a_kind_of SirTrevorRails::BlockArray
     end
   end
 
-  describe "#has_content?" do
+  describe '#content?' do
     let(:page) { FactoryGirl.create(:feature_page) }
 
-    it "should not have content when the page is empty" do
+    it 'does not have content when the page is empty' do
       page.content = []
       expect(page).not_to have_content
     end
 
-    it "should have content when the page has a widget" do
-      page.content = [{type: 'rule'}]
+    it 'has content when the page has a widget' do
+      page.content = [{ type: 'rule' }]
       expect(page).to have_content
     end
-
   end
 end