blacklight 6.14.0 → 7.0.0

data/spec/helpers/{configuration_helper_spec.rb → blacklight/configuration_helper_behavior_spec.rb}

@@ -1,36 +1,31 @@
 # frozen_string_literal: true
 
-describe BlacklightConfigurationHelper do
+RSpec.describe Blacklight::ConfigurationHelperBehavior do
   let(:blacklight_config) { Blacklight::Configuration.new }
-  let(:config_value) { double() }
+  let(:config_value) { double }
 
-  before :each do
+  before do
     allow(helper).to receive_messages(blacklight_config: blacklight_config)
   end
 
   describe "#index_fields" do
     it "passes through the configuration" do
+      allow(Deprecation).to receive(:warn)
       allow(blacklight_config).to receive_messages(index_fields: config_value)
       expect(helper.index_fields).to eq config_value
     end
   end
 
-  describe "#sort_fields" do
-    it "converts the sort fields to select-ready values" do
-      allow(blacklight_config).to receive_messages(sort_fields: { 'a' => double(key: 'a', label: 'a'), 'b' => double(key: 'b', label: 'b'), c: double(key: 'c', if: false)  })
-      expect(helper.sort_fields).to eq [['a', 'a'], ['b', 'b']]
-    end
-  end
-
   describe "#active_sort_fields" do
     it "restricts the configured sort fields to only those that should be displayed" do
-      allow(blacklight_config).to receive_messages(sort_fields: { a: double(if: false, unless: false), b: double(if:true, unless: true) })
+      allow(blacklight_config).to receive_messages(sort_fields: { a: double(if: false, unless: false), b: double(if: true, unless: true) })
       expect(helper.active_sort_fields).to be_empty
     end
   end
 
   describe "#document_show_fields" do
     it "passes through the configuration" do
+      allow(Deprecation).to receive(:warn)
       allow(blacklight_config).to receive_messages(show_fields: config_value)
       expect(helper.document_show_fields).to eq config_value
     end
@@ -43,13 +38,13 @@ describe BlacklightConfigurationHelper do
       blacklight_config.view.b.default = true
       expect(helper.default_document_index_view_type).to eq :b
     end
-    
+
     it "defaults to the first configured index view" do
-      allow(blacklight_config).to receive_messages(view: { a: true, b: true})
+      allow(blacklight_config).to receive_messages(view: { a: true, b: true })
       expect(helper.default_document_index_view_type).to eq :a
     end
   end
-  
+
   describe "#document_index_views" do
     before do
       blacklight_config.view.abc = false
@@ -59,9 +54,9 @@ describe BlacklightConfigurationHelper do
 
     it "filters views using :if/:unless configuration" do
       expect(helper.document_index_views).to have_key :list
-      expect(helper.document_index_views).to_not have_key :abc
-      expect(helper.document_index_views).to_not have_key :def
-      expect(helper.document_index_views).to_not have_key :xyz
+      expect(helper.document_index_views).not_to have_key :abc
+      expect(helper.document_index_views).not_to have_key :def
+      expect(helper.document_index_views).not_to have_key :xyz
     end
   end
 
@@ -78,9 +73,14 @@ describe BlacklightConfigurationHelper do
   end
 
   describe "#has_alternative_views?" do
-    subject { helper.has_alternative_views?}
+    subject { helper.has_alternative_views? }
+
+    before do
+      blacklight_config.view.clear
+    end
+
     describe "with a single view defined" do
-      it { should be false }
+      it { is_expected.to be false }
     end
 
     describe "with multiple views defined" do
@@ -89,7 +89,7 @@ describe BlacklightConfigurationHelper do
         blacklight_config.view.xyz
       end
 
-      it { should be true }
+      it { is_expected.to be true }
     end
   end
 
@@ -108,7 +108,7 @@ describe BlacklightConfigurationHelper do
       f = helper.document_show_link_field document
       expect(f).to eq :a
     end
-    
+
     it "retrieves the first field with data" do
       blacklight_config.index.title_field = [:zzz, :b]
       f = helper.document_show_link_field document
@@ -122,36 +122,9 @@ describe BlacklightConfigurationHelper do
     end
   end
 
-  describe "#index_field_label" do
-    let(:document) { instance_double(SolrDocument) }
-    it "looks up the label to display for the given document and field" do
-      allow(helper).to receive(:index_fields).and_return({ "my_field" => double(label: "some label") })
-      allow(helper).to receive(:field_label).with(:"blacklight.search.fields.index.my_field", :"blacklight.search.fields.my_field", "some label", "My field")
-      helper.index_field_label document, "my_field"
-    end
-  end
-
-  describe "#document_show_field_label" do
-    let(:document) { instance_double(SolrDocument) }
-    it "looks up the label to display for the given document and field" do
-      allow(helper).to receive(:document_show_fields).and_return({ "my_field" => double(label: "some label") })
-      allow(helper).to receive(:field_label).with(:"blacklight.search.fields.show.my_field", :"blacklight.search.fields.my_field", "some label", "My field")
-      helper.document_show_field_label document, "my_field"
-    end
-  end
-
-  describe "#facet_field_label" do
-    let(:document) { instance_double(SolrDocument) }
-    it "looks up the label to display for the given document and field" do
-      allow(blacklight_config).to receive(:facet_fields).and_return({ "my_field" => double(label: "some label") })
-      allow(helper).to receive(:field_label).with(:"blacklight.search.fields.facet.my_field", :"blacklight.search.fields.my_field", "some label", "My field")
-      helper.facet_field_label "my_field"
-    end
-  end
-
   describe "#view_label" do
     it "looks up the label to display for the view" do
-      allow(blacklight_config).to receive(:view).and_return({ "my_view" => double(label: "some label", title: nil) })
+      allow(blacklight_config).to receive(:view).and_return("my_view" => double(label: "some label", title: nil))
       allow(helper).to receive(:field_label).with(:"blacklight.search.view_title.my_view", :"blacklight.search.view.my_view", "some label", nil, "My view")
 
       helper.view_label "my_view"
@@ -160,50 +133,68 @@ describe BlacklightConfigurationHelper do
 
   describe "#field_label" do
     it "looks up the label as an i18n string" do
-      allow(helper).to receive(:t).with(:some_key, default: []).and_return "my label"
+      expect(helper).to receive(:t).with(:some_key, default: []).and_return "my label"
       label = helper.field_label :some_key
 
       expect(label).to eq "my label"
     end
 
     it "passes the provided i18n keys to I18n.t" do
-      allow(helper).to receive(:t).with(:key_a, default: [:key_b, "default text"])
+      expect(helper).to receive(:t).with(:key_a, default: [:key_b, "default text"])
 
-      label = helper.field_label :key_a, :key_b, "default text"
+      helper.field_label :key_a, :key_b, "default text"
     end
 
     it "compacts nil keys (fixes rails/rails#19419)" do
-      allow(helper).to receive(:t).with(:key_a, default: [:key_b])
-
-      label = helper.field_label :key_a, nil, :key_b
+      expect(helper).to receive(:t).with(:key_a, default: [:key_b])
 
+      helper.field_label :key_a, nil, :key_b
     end
   end
-  
+
   describe "#default_per_page" do
-    it "is the configured default per page" do
-      allow(helper).to receive_messages(blacklight_config: double(default_per_page: 42))
-      expect(helper.default_per_page).to eq 42
+    before do
+      expect(Deprecation).to receive(:warn)
+    end
+
+    context "when default_per_page is configured" do
+      before do
+        blacklight_config.default_per_page = 42
+      end
+
+      it "is the configured value" do
+        expect(helper.default_per_page).to eq 42
+      end
     end
-    
-    it "is the first per-page value if a default isn't set" do
-      allow(helper).to receive_messages(blacklight_config: double(default_per_page: nil, per_page: [11, 22]))
-      expect(helper.default_per_page).to eq 11
+
+    context "when default_per_page is not configured" do
+      before do
+        blacklight_config.per_page = [11, 22]
+      end
+
+      it "is the first per-page value if a default isn't set" do
+        expect(helper.default_per_page).to eq 11
+      end
     end
   end
-  
+
   describe "#default_sort_field" do
     it "is the configured default field" do
       allow(helper).to receive_messages(blacklight_config: double(sort_fields: { a: double(default: nil), b: double(key: 'b', default: true) }))
       expect(helper.default_sort_field.key).to eq 'b'
     end
-    
-    it "is the first per-page value if a default isn't set" do
+
+    it "is the first active sort field value if a default isn't set" do
       allow(helper).to receive_messages(blacklight_config: double(sort_fields: { a: double(key: 'a', default: nil), b: double(key: 'b', default: nil) }))
       expect(helper.default_sort_field.key).to eq 'a'
     end
+
+    it "is the first active sort field value if the configured default field is not active" do
+      allow(helper).to receive_messages(blacklight_config: double(sort_fields: { a: double(default: nil, key: 'a'), b: double(key: 'b', default: true, if: false) }))
+      expect(helper.default_sort_field.key).to eq 'a'
+    end
   end
-  
+
   describe "#per_page_options_for_select" do
     it "is the per-page values formatted as options_for_select" do
       allow(helper).to receive_messages(blacklight_config: double(per_page: [11, 22, 33]))
@@ -212,23 +203,24 @@ describe BlacklightConfigurationHelper do
       expect(helper.per_page_options_for_select).to include ["33<span class=\"sr-only\"> per page</span>", 33]
     end
   end
-  
+
   describe "#should_render_field?" do
     let(:field_config) { double('field config', if: true, unless: false) }
-    
+
     before do
+      allow(Deprecation).to receive(:warn)
       allow(helper).to receive_messages(document_has_value?: true)
     end
 
     it "is true" do
       expect(helper.should_render_field?(field_config)).to be true
     end
-    
+
     it "is false if the :if condition is false" do
       allow(field_config).to receive_messages(if: false)
       expect(helper.should_render_field?(field_config)).to be false
     end
-    
+
     it "is false if the :unless condition is true" do
       allow(field_config).to receive_messages(unless: true)
       expect(helper.should_render_field?(field_config)).to be false
@@ -236,32 +228,29 @@ describe BlacklightConfigurationHelper do
   end
 
   describe "#search_field_options_for_select" do
-    
     before do
-    
       @config = Blacklight::Configuration.new do |config|
-        config.default_solr_params = { :qt => 'search' }
-        
-        config.add_search_field 'all_fields', :label => 'All Fields'
-        config.add_search_field 'title', :qt => 'title_search'
-        config.add_search_field 'author', :qt => 'author_search'
-        config.add_search_field 'subject', :qt => 'subject_search'
-        config.add_search_field 'no_display', :qt => 'something', :include_in_simple_select => false
+        config.default_solr_params = { qt: 'search' }
+
+        config.add_search_field 'all_fields', label: 'All Fields'
+        config.add_search_field 'title', qt: 'title_search'
+        config.add_search_field 'author', qt: 'author_search'
+        config.add_search_field 'subject', qt: 'subject_search'
+        config.add_search_field 'no_display', qt: 'something', include_in_simple_select: false
       end
 
       allow(helper).to receive_messages(blacklight_config: @config)
     end
-    
-    it "returns proper options_for_select arguments" do
 
+    it "returns proper options_for_select arguments" do
       select_arguments = helper.search_field_options_for_select
 
       select_arguments.each do |(label, key)|
-         config_hash = @config.search_fields[key]
+        config_hash = @config.search_fields[key]
 
-         expect(label).to eq config_hash.label
-         expect(key).to eq config_hash.key
-      end    
+        expect(label).to eq config_hash.label
+        expect(key).to eq config_hash.key
+      end
     end
 
     it "does not include fields in select if :display_in_simple_search=>false" do
@@ -271,17 +260,33 @@ describe BlacklightConfigurationHelper do
     end
   end
 
-  describe "#label_for_search_field" do
+  context 'labels' do
+    let(:field_config) { { 'my-key' => double('field', display_label: 'My Field') } }
+
     before do
-      blacklight_config.add_search_field 'title', :qt => 'title_search'
+      allow(helper).to receive_messages(blacklight_config: config)
     end
 
-    it "finds label by key" do
-      expect(helper.label_for_search_field("title")).to eq "Title"
+    describe '#label_for_search_field' do
+      let(:config) { double('Blacklight configuration', search_fields: field_config) }
+
+      it 'handles a found key' do
+        expect(helper.label_for_search_field('my-key')).to eq 'My Field'
+      end
+      it 'handles a missing key' do
+        expect(helper.label_for_search_field('not-found')).to eq 'Not Found'
+      end
     end
 
-    it "supplies default label for key not found" do
-      expect(helper.label_for_search_field("non_existent_key")).to eq "Non existent key"
+    describe '#sort_field_label' do
+      let(:config) { double('Blacklight configuration', sort_fields: field_config) }
+
+      it 'handles a found key' do
+        expect(helper.sort_field_label('my-key')).to eq 'My Field'
+      end
+      it 'handles a missing key' do
+        expect(helper.sort_field_label('not-found')).to eq 'Not Found'
+      end
     end
   end
 end