blacklight 6.3.0 → 6.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38e64adb886cc4afffadc21d807dd85b7f919bef
-  data.tar.gz: 6d422b5862b493b3f5b4db3d163c3dbed749bae3
+  metadata.gz: e5f399d49a4b81d638fd3a6b7dd2a79595895ef6
+  data.tar.gz: 3ab2a5bfb36436d5c2febb62c6fa24f1b3026830
 SHA512:
-  metadata.gz: 0b9ff4de640f01ff5ee90d2a10b6b8d2d36b7c746890ab7f19403c85a6cc92a1afe058d5ea79a616aaefe4c8f4f777210c5452e112b26c066e2743cfb99f154c
-  data.tar.gz: 6ff37f57181bd54aa43531ef7beae404c787b2c94bab6a2fbe3d0652420ab3f3c1f03b1efb3e7a934ae09ba1c82c7bb381b87d992796742e899b81fc203cccb1
+  metadata.gz: e83719b79cde64ee06a25074789458719b414c34c9eee9b4ae693c8b1a0bbdfe321acd0002421331aec2725c8d1fd957175dc1dda11873d1d79f79096fbccff6
+  data.tar.gz: d90c449b77e6a30c0aee64967f6cb9b4048e131d1ff2e94b4238ad133505994606ce00da1ea90d5cc1359e39797d49d318d304550ebf9e4890fe15aad25e422b

data/Gemfile

@@ -35,7 +35,7 @@ else
   end
 
   if ENV['RAILS_VERSION'].nil? || ENV['RAILS_VERSION'] =~ /^5\.0/ || ENV['RAILS_VERSION'] == 'edge'
-    gem 'rspec-rails', '>= 3.5.0.beta4', '~> 3.5'
+    # noop
   elsif ENV['RAILS_VERSION'] =~ /^4\.2/
     gem 'responders', "~> 2.0"
     gem 'sass-rails', ">= 5.0"

data/VERSION

@@ -1 +1 @@
-6.3.0
+6.3.1

data/app/assets/javascripts/blacklight/core.js

@@ -13,7 +13,7 @@ Blacklight = function() {
 
     listeners: function () {
       var listeners = [];
-      if (Turbolinks && Turbolinks.supported) {
+      if (typeof Turbolinks !== 'undefined' && Turbolinks.supported) {
         // Turbolinks 5
         if (Turbolinks.BrowserAdapter) {
           listeners.push('turbolinks:load');

data/app/controllers/concerns/blacklight/search_context.rb

@@ -12,7 +12,7 @@ module Blacklight::SearchContext
   module ClassMethods
     # Save the submitted search parameters in the search session
     def record_search_parameters opts = { only: :index}
-      before_action :current_search_session, opts
+      before_action :set_current_search_session, opts
     end
   end
 
@@ -28,10 +28,16 @@ module Blacklight::SearchContext
 
   # The current search session
   def current_search_session
+    @current_search_session ||= find_search_session
+  end
 
-    @current_search_session ||= if start_new_search_session?
-      find_or_initialize_search_session_from_params search_state.to_h
-    elsif params[:search_context].present?
+  # Persist the current search session id to the user's session
+  def set_current_search_session
+    search_session['id'] = current_search_session.id if current_search_session
+  end
+
+  def find_search_session
+    if params[:search_context].present?
       find_or_initialize_search_session_from_params JSON.load(params[:search_context])
     elsif params[:search_id].present?
       begin
@@ -40,6 +46,8 @@ module Blacklight::SearchContext
       rescue ActiveRecord::RecordNotFound
         nil
       end
+    elsif start_new_search_session?
+      find_or_initialize_search_session_from_params search_state.to_h
     elsif search_session['id']
       begin
         searches_from_history.find(search_session['id'])
@@ -47,10 +55,6 @@ module Blacklight::SearchContext
         nil
       end
     end
-
-    search_session['id'] = @current_search_session.id if @current_search_session
-
-    @current_search_session
   end
 
   ##

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -160,11 +160,13 @@ module Blacklight::BlacklightHelperBehavior
   #   @param [String] field
   #   @param [Hash] opts
   #   @options opts [String] :value
-  # TODO: deprecate and use render_field_value
+  # @deprecated use IndexPresenter#field_value
   def render_index_field_value *args
     render_field_value(*args)
   end
+  deprecation_deprecate render_index_field_value: 'replaced by IndexPresenter#field_value'
 
+  # @deprecated use IndexPresenter#field_value
   def render_field_value(*args)
     options = args.extract_options!
     document = args.shift || options[:document]
@@ -172,6 +174,7 @@ module Blacklight::BlacklightHelperBehavior
     field = args.shift || options[:field]
     presenter(document).field_value field, options.except(:document, :field)
   end
+  deprecation_deprecate render_field_value: 'replaced by IndexPresenter#field_value'
 
   ##
   # Render the show field label for a document
@@ -218,10 +221,12 @@ module Blacklight::BlacklightHelperBehavior
   #   @param [String] field
   #   @param [Hash] opts
   #   @options opts [String] :value
-  # TODO: deprecate and use render_field_value
+  # @deprecated use ShowPresenter#field_value
   def render_document_show_field_value *args
     render_field_value(*args)
   end
+  deprecation_deprecate render_document_show_field_value: 'replaced by ShowPresenter#field_value'
+
 
   ##
   # Get the value of the document's "title" field, or a placeholder
@@ -332,7 +337,8 @@ module Blacklight::BlacklightHelperBehavior
     when 'index'
       index_presenter(document)
     else
-      raise "Unable to determine presenter type for #{action_name} on #{controller_name}"
+      Deprecation.warn(Blacklight::BlacklightHelperBehavior, "Unable to determine presenter type for #{action_name} on #{controller_name}, falling back on deprecated Blacklight::DocumentPresenter")
+      presenter_class.new(document, self)
     end
   end
 

data/app/presenters/blacklight/document_presenter.rb

@@ -127,10 +127,16 @@ module Blacklight
 
     # @deprecated
     def render_field_value(values, field_config = Configuration::NullField.new)
-      FieldPresenter.new(@controller, @document, field_config, value: values).render
+      field_values(field_config, value: Array(values))
     end
     deprecation_deprecate render_field_value: 'Use FieldPresenter instead'
 
+    # @deprecated
+    def render_values(values, field_config = Configuration::NullField.new)
+      field_values(field_config, value: Array(values))
+    end
+    deprecation_deprecate render_values: 'Use FieldPresenter instead'
+
     private
 
       def index_presenter

data/app/presenters/blacklight/index_presenter.rb

@@ -1,13 +1,18 @@
 # frozen_string_literal: true
 module Blacklight
   class IndexPresenter
+    extend Deprecation
+    self.deprecation_horizon = 'Blacklight version 7.0.0'
+
+    attr_reader :document, :configuration, :view_context
+
     # @param [SolrDocument] document
-    # @param [ActionController::Base] controller scope for linking and generating urls
+    # @param [ActionView::Base] view context scope for linking and generating urls
     # @param [Blacklight::Configuration] configuration
-    def initialize(document, controller, configuration = controller.blacklight_config)
+    def initialize(document, view_context, configuration = view_context.blacklight_config)
       @document = document
+      @view_context = view_context
       @configuration = configuration
-      @controller = controller
     end
 
     ##
@@ -21,17 +26,23 @@ module Blacklight
       value = case field_or_string_or_proc
       when Symbol
         config = field_config(field_or_string_or_proc)
-        @document[field_or_string_or_proc]
+        document[field_or_string_or_proc]
       when Proc
-        field_or_string_or_proc.call(@document, opts)
+        field_or_string_or_proc.call(document, opts)
       when String
         field_or_string_or_proc
       end
 
-      value ||= @document.id
+      value ||= document.id
       field_values(config, value: value)
     end
 
+    # @deprecated
+    def render_document_index_label(*args)
+      label(*args)
+    end
+    deprecation_deprecate render_document_index_label: 'Use #label instead'
+
     ##
     # Render the index field label for a document
     #
@@ -45,6 +56,30 @@ module Blacklight
       field_values(field_config, options)
     end
 
+    # @deprecated
+    def render_index_field_value(*args)
+      field_value(*args)
+    end
+    deprecation_deprecate render_index_field_value: 'replaced by #field_value'
+
+    # @deprecated
+    def get_field_values(field_config, options={})
+      field_values(field_config, options)
+    end
+    deprecation_deprecate get_field_values: "replaced by #field_value"
+
+    # @deprecated
+    def render_field_values(values, field_config = Configuration::NullField.new)
+      field_values(field_config, value: Array(values))
+    end
+    deprecation_deprecate render_field_values: "replaced by #field_value"
+
+    # @deprecated
+    def render_values(values, field_config = Configuration::NullField.new)
+      field_values(field_config, value: Array(values))
+    end
+    deprecation_deprecate render_values: "replaced by #field_value"
+
     private
 
       ##
@@ -59,11 +94,11 @@ module Blacklight
       # @param [Blacklight::Configuration::Field] solr field configuration
       # @param [Hash] options additional options to pass to the rendering helpers
       def field_values(field_config, options={})
-        FieldPresenter.new(@controller, @document, field_config, options).render
+        FieldPresenter.new(view_context, document, field_config, options).render
       end
 
       def field_config(field)
-        @configuration.index_fields.fetch(field) { Configuration::NullField.new(field) }
+        configuration.index_fields.fetch(field) { Configuration::NullField.new(field) }
       end
   end
 end

data/app/presenters/blacklight/show_presenter.rb

@@ -1,13 +1,18 @@
 # frozen_string_literal: true
 module Blacklight
   class ShowPresenter
+    extend Deprecation
+    self.deprecation_horizon = 'Blacklight version 7.0.0'
+
+    attr_reader :document, :configuration, :view_context
+
     # @param [SolrDocument] document
-    # @param [ActionController::Base] controller scope for linking and generating urls
+    # @param [ActionView::Base] view context scope for linking and generating urls
     # @param [Blacklight::Configuration] configuration
-    def initialize(document, controller, configuration = controller.blacklight_config)
+    def initialize(document, view_context, configuration = view_context.blacklight_config)
       @document = document
+      @view_context = view_context
       @configuration = configuration
-      @controller = controller
     end
 
     ##
@@ -20,7 +25,7 @@ module Blacklight
     # @option options [Array<String>] :exclude array of format shortnames to not include in the output
     # @deprecated moved to ShowPresenter#link_rel_alternates
     def link_rel_alternates(options = {})
-      LinkAlternatePresenter.new(@controller, @document, options).render
+      LinkAlternatePresenter.new(view_context, document, options).render
     end
 
     ##
@@ -32,7 +37,7 @@ module Blacklight
     def html_title
       if view_config.html_title_field
         fields = Array.wrap(view_config.html_title_field)
-        f = fields.detect { |field| @document.has? field }
+        f = fields.detect { |field| document.has? field }
         f ||= 'id'
         field_values(field_config(f))
       else
@@ -40,6 +45,12 @@ module Blacklight
       end
     end
 
+    # @deprecated
+    def document_show_html_title
+      html_title
+    end
+    deprecation_deprecate document_show_html_title: "use #html_title"
+
     ##
     # Get the value of the document's "title" field, or a placeholder
     # value (if empty)
@@ -48,11 +59,17 @@ module Blacklight
     # @return [String]
     def heading
       fields = Array.wrap(view_config.title_field)
-      f = fields.detect { |field| @document.has? field }
-      f ||= @configuration.document_model.unique_key
-      field_values(field_config(f), value: @document[f])
+      f = fields.detect { |field| document.has? field }
+      f ||= configuration.document_model.unique_key
+      field_values(field_config(f), value: document[f])
     end
 
+    # @deprecated
+    def document_heading
+      heading
+    end
+    deprecation_deprecate document_heading: "replaced by #heading"
+
     ##
     # Render the show field value for a document
     #
@@ -65,6 +82,30 @@ module Blacklight
       field_values(field_config(field), options)
     end
 
+    # @deprecated
+    def render_document_show_field_value(*args)
+      field_value(*args)
+    end
+    deprecation_deprecate render_document_show_field_value: 'replaced by #field_value'
+
+    # @deprecated
+    def get_field_values(field_config, options={})
+      field_values(field_config, options)
+    end
+    deprecation_deprecate get_field_values: "replaced by #field_value"
+
+    # @deprecated
+    def render_field_values(values, field_config = Configuration::NullField.new)
+      field_values(field_config, value: Array(values))
+    end
+    deprecation_deprecate render_field_values: "replaced by #field_value"
+
+    # @deprecated
+    def render_values(values, field_config = Configuration::NullField.new)
+      field_values(field_config, value: Array(values))
+    end
+    deprecation_deprecate render_values: "replaced by #field_value"
+
     private
 
       ##
@@ -79,15 +120,15 @@ module Blacklight
       # @param [Blacklight::Configuration::Field] solr field configuration
       # @param [Hash] options additional options to pass to the rendering helpers
       def field_values(field_config, options={})
-        FieldPresenter.new(@controller, @document, field_config, options).render
+        FieldPresenter.new(view_context, document, field_config, options).render
       end
 
       def view_config
-        @configuration.view_config(:show)
+        configuration.view_config(:show)
       end
 
       def field_config(field)
-        @configuration.show_fields.fetch(field) { Configuration::NullField.new(field) }
+        configuration.show_fields.fetch(field) { Configuration::NullField.new(field) }
       end
   end
 end

data/app/views/catalog/_index_default.html.erb

@@ -1,10 +1,11 @@
+<% doc_presenter = index_presenter(document) %> 
 <%# default partial to display solr document fields in catalog index view -%>
 <dl class="document-metadata dl-horizontal dl-invert">
   
   <% index_fields(document).each do |field_name, field| -%>
     <% if should_render_index_field? document, field %>
 	    <dt class="blacklight-<%= field_name.parameterize %>"><%= render_index_field_label document, field: field_name %></dt>
-	    <dd class="blacklight-<%= field_name.parameterize %>"><%= render_index_field_value document, field: field_name %></dd>
+	    <dd class="blacklight-<%= field_name.parameterize %>"><%= doc_presenter.field_value field_name %></dd>
     <% end -%>
   <% end -%>
 

data/app/views/catalog/_show_default.html.erb

@@ -1,9 +1,10 @@
+<% doc_presenter = show_presenter(document) %>
 <%# default partial to display solr document fields in catalog show view -%>
 <dl class="dl-horizontal  dl-invert">
   <% document_show_fields(document).each do |field_name, field| -%>
     <% if should_render_show_field? document, field %>
 	    <dt class="blacklight-<%= field_name.parameterize %>"><%= render_document_show_field_label document, field: field_name %></dt>
-	    <dd class="blacklight-<%= field_name.parameterize %>"><%= render_document_show_field_value document, field: field_name %></dd>
+	    <dd class="blacklight-<%= field_name.parameterize %>"><%= doc_presenter.field_value field_name %></dd>
     <% end -%>
   <% end -%>
 </dl>

data/blacklight.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |s|
   s.add_dependency "twitter-typeahead-rails", '~> 0.11'
 
   s.add_development_dependency "solr_wrapper"
-  s.add_development_dependency "rspec-rails", ">= 3.4", "< 4"
+  s.add_development_dependency "rspec-rails", "~> 3.5"
   s.add_development_dependency "rspec-its"
   s.add_development_dependency "rspec-collection_matchers", ">= 1.0"
   s.add_development_dependency "capybara", '~> 2.6.0'

data/db/migrate/20140202020201_create_searches.rb

@@ -2,7 +2,7 @@
 class CreateSearches < ActiveRecord::Migration
   def self.up
     create_table :searches do |t|
-      t.text  :query_params
+      t.binary  :query_params
       t.integer :user_id, index: true
       t.string :user_type
 

data/db/migrate/20140202020202_create_bookmarks.rb

@@ -6,7 +6,7 @@ class CreateBookmarks < ActiveRecord::Migration
       t.string :user_type
       t.string :document_id, index: true
       t.string :document_type
-      t.string :title
+      t.binary :title
       t.timestamps null: false
     end
   end

data/spec/helpers/blacklight_helper_spec.rb

@@ -165,6 +165,7 @@ describe BlacklightHelper do
   describe "#render_index_field_value" do
     let(:presenter) { double }
     before do
+      allow(Deprecation).to receive(:warn)
       allow(helper).to receive(:presenter).with(doc).and_return(presenter)
     end
 
@@ -191,6 +192,7 @@ describe BlacklightHelper do
     let(:presenter) { double }
     before do
       allow(helper).to receive(:presenter).with(doc).and_return(presenter)
+      allow(Deprecation).to receive(:warn)
     end
 
     let(:doc) { double }

data/spec/presenters/document_presenter_spec.rb

@@ -428,4 +428,12 @@ describe Blacklight::DocumentPresenter do
       end
     end
   end
+
+  describe '#render_values' do
+    it 'renders field values as a string' do
+      expect(subject.render_values('x')).to eq 'x'
+      expect(subject.render_values(['x', 'y'])).to eq 'x and y'
+      expect(subject.render_values(['x', 'y', 'z'])).to eq 'x, y, and z'
+    end
+  end
 end

data/spec/presenters/index_presenter_spec.rb

@@ -143,5 +143,31 @@ describe Blacklight::IndexPresenter do
       end
     end
   end
+
+  describe 'deprecated methods' do
+    before do
+      allow(Deprecation).to receive(:warn)
+    end
+
+    let(:field_config) { config.add_index_field 'qwerty' }
+
+    describe '#get_field_values' do
+      it 'renders values for the given field' do
+        expect(subject.get_field_values(field_config, value: ['x', 'y'])).to eq 'x and y'
+      end
+    end
+
+    describe '#render_field_values' do
+      it 'renders values for the given field' do
+        expect(subject.render_field_values('x')).to eq 'x'
+      end
+    end
+
+    describe '#render_values' do
+      it 'renders values for the given field' do
+        expect(subject.render_values(['x', 'y', 'z'])).to eq 'x, y, and z'
+      end
+    end
+  end
 end
 

data/spec/presenters/show_presenter_spec.rb

@@ -283,5 +283,31 @@ describe Blacklight::ShowPresenter do
       end
     end
   end
+
+  describe 'deprecated methods' do
+    before do
+      allow(Deprecation).to receive(:warn)
+    end
+
+    let(:field_config) { config.add_index_field 'qwerty' }
+
+    describe '#get_field_values' do
+      it 'renders values for the given field' do
+        expect(subject.get_field_values(field_config, value: ['x', 'y'])).to eq 'x and y'
+      end
+    end
+
+    describe '#render_field_values' do
+      it 'renders values for the given field' do
+        expect(subject.render_field_values('x')).to eq 'x'
+      end
+    end
+
+    describe '#render_values' do
+      it 'renders values for the given field' do
+        expect(subject.render_values(['x', 'y', 'z'])).to eq 'x, y, and z'
+      end
+    end
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 6.3.1
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-01 00:00:00.000000000 Z
+date: 2016-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -161,22 +161,16 @@ dependencies:
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.4'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.4'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement