blacklight 6.25.0 → 7.0.0.rc1

data/.docker/app/Dockerfile

@@ -1,28 +0,0 @@
-ARG ALPINE_RUBY_VERSION
-
-FROM ruby:${ALPINE_RUBY_VERSION}-alpine
-
-RUN apk add --update --no-cache \
-  bash \
-  build-base \
-  git \
-  libxml2-dev \
-  libxslt-dev \
-  nodejs \
-  shared-mime-info \
-  sqlite-dev \
-  tzdata \
-  yarn
-
-RUN mkdir /app
-WORKDIR /app
-
-RUN gem update --system && \
-  gem install bundler && \
-  bundle config build.nokogiri --use-system-libraries
-
-COPY . .
-
-EXPOSE 3000
-
-CMD [".docker/app/entrypoint.sh"]

data/.docker/app/entrypoint.sh

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-rm -f /app/.internal_test_app/tmp/pids/server.pid
-bundle install
-exec bundle exec rake blacklight:server["-p 3000 -b 0.0.0.0"]

data/.dockerignore

@@ -1,3 +0,0 @@
-Gemfile.lock
-.internal_test_app
-.solr_wrapper.yml

data/.env

@@ -1,5 +0,0 @@
-ALPINE_RUBY_VERSION=2.7.6
-RAILS_VERSION=5.2.8.1
-SOLR_PORT=8983
-SOLR_URL=http://solr:8983/solr/blacklight-core
-SOLR_VERSION=8

data/.github/workflows/ruby.yml

@@ -1,61 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: CI
-
-on:
-  push:
-    branches:
-      - main
-      - 'release-*'
-  pull_request:
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.7
-    - name: Install dependencies
-      run: bundle install
-    - name: Run linter
-      run: bundle exec rake rubocop
-  test:
-    runs-on: ubuntu-latest
-    name: test (ruby ${{ matrix.ruby }} / rails ${{ matrix.rails_version }} ${{ matrix.additional_name }})
-    strategy:
-      matrix:
-        ruby: [2.5, 2.6, 2.7]
-        rails_version: ['5.1.7', '5.2.8.1']
-        bootstrap_version: [null]
-        api: [null]
-        additional_engine_cart_rails_options: ['']
-        additional_name: ['']
-    env:
-      RAILS_VERSION: ${{ matrix.rails_version }}
-      BOOTSTRAP_VERSION: ${{ matrix.bootstrap_version }}
-      BLACKLIGHT_API_TEST: ${{ matrix.api }}
-      ENGINE_CART_RAILS_OPTIONS: "--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test ${{ matrix.engine_cart_rails_options }}"
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-    - name: Install dependencies
-      run: bundle install
-    - name: Run tests
-      run: bundle exec rake ci
-  docker_build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - name: Build docker image
-      run: docker-compose build app

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

@@ -1,16 +0,0 @@
-//= require blacklight/core
-(function($) {
-  Blacklight.do_search_autofocus_fallback = function() {
-    if (typeof Modernizer != "undefined") {
-      if (Modernizr.autofocus) {
-        return;
-      }
-    }
-
-    $('input[autofocus]').focus();
-  }
-
-  Blacklight.onLoad(function() {
-    Blacklight.do_search_autofocus_fallback();
-  });
-})(jQuery);

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

@@ -1,23 +0,0 @@
-//= require blacklight/core
-//= require blacklight/checkbox_submit
-(function($) {
-//change form submit toggle to checkbox
-    Blacklight.do_bookmark_toggle_behavior = function() {
-      $(Blacklight.do_bookmark_toggle_behavior.selector).bl_checkbox_submit({
-         //css_class is added to elements added, plus used for id base
-         css_class: "toggle_bookmark",
-         success: function(checked, response) {
-           if (response.bookmarks) {
-             $('[data-role=bookmark-counter]').text(response.bookmarks.count);
-           }
-         }
-      });
-    };
-    Blacklight.do_bookmark_toggle_behavior.selector = "form.bookmark_toggle"; 
-
-Blacklight.onLoad(function() {
-  Blacklight.do_bookmark_toggle_behavior();  
-});
-  
-
-})(jQuery);

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

@@ -1,139 +0,0 @@
-/* A JQuery plugin (should this be implemented as a widget instead? not sure)
-   that will convert a "toggle" form, with single submit button to add/remove
-   something, like used for Bookmarks, into an AJAXy checkbox instead. 
-   
-   Apply to a form. Does require certain assumption about the form:
-    1) The same form 'action' href must be used for both ADD and REMOVE
-       actions, with the different being the hidden input name="_method"
-       being set to "put" or "delete" -- that's the Rails method to pretend
-       to be doing a certain HTTP verb. So same URL, PUT to add, DELETE
-       to remove. This plugin assumes that. 
-       
-       Plus, the form this is applied to should provide a data-doc-id 
-       attribute (HTML5-style doc-*) that contains the id/primary key
-       of the object in question -- used by plugin for a unique value for
-       DOM id's. 
-
-  Uses HTML for a checkbox compatible with Bootstrap 3. 
-       
-   Pass in options for your class name and labels:
-   $("form.something").bl_checkbox_submit({    
-        checked_label: "Selected",
-        unchecked_label: "Select",
-        progress_label: "Saving...",
-        //css_class is added to elements added, plus used for id base
-        css_class: "toggle_my_kinda_form",
-        error: function() {
-          #optional callback
-        },
-        success: function(after_success_check_state) {
-          #optional callback
-        }
-   });
-*/
-(function($) {    
-    $.fn.bl_checkbox_submit = function(arg_opts) {              
-      
-      this.each(function() {
-        var options = $.extend({}, $.fn.bl_checkbox_submit.defaults, arg_opts);
-                                  
-          
-        var form = $(this);
-        form.children().hide();
-        //We're going to use the existing form to actually send our add/removes
-        //This works conveneintly because the exact same action href is used
-        //for both bookmarks/$doc_id.  But let's take out the irrelevant parts
-        //of the form to avoid any future confusion. 
-        form.find("input[type=submit]").remove();
-        form.addClass('form-horizontal');
-        
-        //View needs to set data-doc-id so we know a unique value
-        //for making DOM id
-        var unique_id = form.attr("data-doc-id") || Math.random();
-        // if form is currently using method delete to change state, 
-        // then checkbox is currently checked
-        var checked = (form.find("input[name=_method][value=delete]").length != 0);
-            
-        var checkbox = $('<input type="checkbox">')	    
-          .addClass( options.css_class )
-          .attr("id", options.css_class + "_" + unique_id);	  
-        var label = $('<label>')
-          .addClass( options.css_class )
-          .attr("for", options.css_class + '_' + unique_id)
-          .attr("title", form.attr("title") || "");
-        var span = $('<span>');
-
-        label.append(checkbox);
-        label.append(" ");
-        label.append(span);  
-
-        var checkbox_div = $("<div class='checkbox' />")
-          .addClass(options.css_class)
-          .append(label);
-          
-        function update_state_for(state) {
-            checkbox.prop("checked", state);
-            label.toggleClass("checked", state);
-            if (state) {    
-               //Set the Rails hidden field that fakes an HTTP verb
-               //properly for current state action. 
-               form.find("input[name=_method]").val("delete");
-               span.text(form.attr('data-present'));
-            } else {
-               form.find("input[name=_method]").val("put");
-               span.text(form.attr('data-absent'));
-            }
-          }
-        
-        form.append(checkbox_div);
-        update_state_for(checked);
-        
-        checkbox.click(function() {
-            span.text(form.attr('data-inprogress'));
-            label.attr("disabled", "disabled");  
-            checkbox.attr("disabled", "disabled");
-                            
-            $.ajax({
-                url: form.attr("action"),
-                dataType: 'json',
-                type: form.attr("method").toUpperCase(),
-                data: form.serialize(),
-                error: function() {
-                   label.removeAttr("disabled");
-                   checkbox.removeAttr("disabled");
-                   options.error.call();
-                },
-                success: function(data, status, xhr) {
-                  //if app isn't running at all, xhr annoyingly
-                  //reports success with status 0. 
-                  if (xhr.status != 0) {
-                    checked = ! checked;
-                    update_state_for(checked);
-                    label.removeAttr("disabled");
-                    checkbox.removeAttr("disabled");
-                    options.success.call(form, checked, xhr.responseJSON);
-                  } else {
-                    label.removeAttr("disabled");
-                    checkbox.removeAttr("disabled");
-                    options.error.call();
-                  }
-                }
-            });
-            
-            return false;
-        }); //checkbox.click
-        
-        
-      }); //this.each      
-      return this;
-    };
-	
-  $.fn.bl_checkbox_submit.defaults =  {
-            //css_class is added to elements added, plus used for id base
-            css_class: "bl_checkbox_submit",
-            error: function() {
-              alert("Error");
-            },
-            success: function() {} //callback
-  };
-})(jQuery);

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

@@ -1,30 +0,0 @@
-Blacklight = function() {
-  var buffer = new Array;
-  return {
-    onLoad: function(func) {
-      buffer.push(func);
-    },
-
-    activate: function() {
-      for(var i = 0; i < buffer.length; i++) {
-        buffer[i].call();
-      }
-    }
-  };
-}();
-
-// turbolinks triggers page:load events on page transition
-// If app isn't using turbolinks, this event will never be triggered, no prob.
-// $(document).on('ready') is deprecated in JQuery 1.8
-if (typeof Turbolinks !== 'undefined' && Turbolinks.supported) {
-  // Turbolinks 5
-  if (Turbolinks.BrowserAdapter) {
-    $(document).on('turbolinks:load', function() { Blacklight.activate(); });
-  } else {
-    // Turbolinks < 5
-    $(document).on('page:load', function() { Blacklight.activate(); });
-    $(document).ready(function() { Blacklight.activate(); });
-  }
-} else {
-  $(document).ready(function() { Blacklight.activate(); });
-}

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

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-module Blacklight
-  module RequestBuilders
-    extend ActiveSupport::Concern
-
-    included do
-      if self.respond_to?(:helper_method)
-        helper_method(:facet_limit_for)
-      end
-    end
-
-    # Override this method to use a search builder other than the one in the config
-    delegate :search_builder_class, to: :blacklight_config
-
-    def search_builder
-      search_builder_class.new(self)
-    end
-
-    ##
-    # Opensearch autocomplete parameters for plucking a field's value from the results
-    def solr_opensearch_params(field)
-      solr_params = {}
-      solr_params[:rows] ||= 10
-      solr_params[:fl] = field || blacklight_config.view_config('opensearch').title_field
-      solr_params
-    end
-
-    ##
-    # Pagination parameters for selecting the previous and next documents
-    # out of a result set.
-    def previous_and_next_document_params(index, window = 1)
-      solr_params = blacklight_config.document_pagination_params.dup
-
-      if solr_params.empty?
-        solr_params[:fl] = '*'
-      end
-
-      if index > 0
-        solr_params[:start] = index - window # get one before
-        solr_params[:rows] = 2*window + 1 # and one after
-      else
-        solr_params[:start] = 0 # there is no previous doc
-        solr_params[:rows] = 2*window # but there should be one after
-      end
-
-      solr_params[:facet] = false
-      solr_params
-    end
-    
-    DEFAULT_FACET_LIMIT = 10
-
-    # Look up facet limit for given facet_field. Will look at config, and
-    # if config is 'true' will look up from Solr @response if available. If
-    # no limit is avaialble, returns nil. Used from #add_facetting_to_solr
-    # to supply f.fieldname.facet.limit values in solr request (no @response
-    # available), and used in display (with @response available) to create
-    # a facet paginator with the right limit.
-    def facet_limit_for(facet_field)
-      facet = blacklight_config.facet_fields[facet_field]
-      return if facet.blank?
-
-      if facet.limit and @response and @response.aggregations[facet.field]
-        limit = @response.aggregations[facet.field].limit
-
-        if limit.nil? # we didn't get or a set a limit, so infer one.
-          facet.limit if facet.limit != true
-        elsif limit == -1 # limit -1 is solr-speak for unlimited
-          nil
-        else
-          limit.to_i - 1 # we added 1 to find out if we needed to paginate
-        end
-      elsif facet.limit
-        facet.limit == true ? DEFAULT_FACET_LIMIT : facet.limit
-      end
-    end
-  end
-end

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

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-module Blacklight
-  module SavedSearches
-    extend ActiveSupport::Concern
-    include Blacklight::Configurable
-
-    included do
-      copy_blacklight_config_from(CatalogController)
-      before_action :require_user_authentication_provider
-      before_action :verify_user
-    end
-
-    def index
-      @searches = current_user.searches
-    end
-
-    def save
-      current_user.searches << searches_from_history.find(params[:id])
-      if current_user.save
-        flash[:notice] = I18n.t('blacklight.saved_searches.add.success')
-      else
-        flash[:error] = I18n.t('blacklight.saved_searches.add.failure')
-      end
-      if respond_to? :redirect_back
-        redirect_back fallback_location: blacklight.saved_searches_path
-      else
-        # Deprecated in Rails 5.0
-        redirect_to :back
-      end
-    end
-
-    # Only dereferences the user rather than removing the item in case it
-    # is in the session[:history]
-    def forget
-      search = current_user.searches.find(params[:id])
-
-      if search.present?
-        search.user_id = nil
-        search.save
-
-        flash[:notice] = I18n.t('blacklight.saved_searches.remove.success')
-      else
-        flash[:error] = I18n.t('blacklight.saved_searches.remove.failure')
-      end
-      if respond_to? :redirect_back
-        redirect_back fallback_location: blacklight.saved_searches_path
-      else
-        # Deprecated in Rails 5.0
-        redirect_to :back
-      end
-    end
-
-    # Only dereferences the user rather than removing the items in case they
-    # are in the session[:history]
-    def clear
-      if current_user.searches.update_all("user_id = NULL")
-        flash[:notice] = I18n.t('blacklight.saved_searches.clear.success')
-      else
-        flash[:error] = I18n.t('blacklight.saved_searches.clear.failure')
-      end
-      redirect_to blacklight.saved_searches_url
-    end
-
-    protected
-
-      def verify_user
-        flash[:notice] = I18n.t('blacklight.saved_searches.need_login') and raise Blacklight::Exceptions::AccessDenied unless current_user
-      end
-  end
-end

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

@@ -1,161 +0,0 @@
-# frozen_string_literal: true
-# SearchHelper is a controller layer mixin. It is in the controller scope: request params, session etc.
-#
-# NOTE: Be careful when creating variables here as they may be overriding something that already exists.
-# The ActionController docs: http://api.rubyonrails.org/classes/ActionController/Base.html
-#
-# Override these methods in your own controller for customizations:
-#
-#   class CatalogController < ActionController::Base
-#     include Blacklight::Catalog
-#
-#     def repository_class
-#       MyAlternativeRepo
-#     end
-#   end
-#
-# Or by including in local extensions:
-#   module LocalSearchHelperExtension
-#     [ local overrides ]
-#   end
-#
-#   class CatalogController < ActionController::Base
-#     include Blacklight::Catalog
-#     include LocalSearchHelperExtension
-#
-#     def repository_class
-#       MyAlternativeRepo
-#     end
-#   end
-#
-# Or by using ActiveSupport::Concern:
-#
-#   module LocalSearchHelperExtension
-#     extend ActiveSupport::Concern
-#     include Blacklight::SearchHelper
-#
-#     [ local overrides ]
-#   end
-#
-#   class CatalogController < ApplicationController
-#     include LocalSearchHelperExtension
-#     include Blacklight::Catalog
-#   end
-
-module Blacklight::SearchHelper
-  extend ActiveSupport::Concern
-  include Blacklight::RequestBuilders
-
-  # a solr query method
-  # @param [Hash] user_params ({}) the user provided parameters (e.g. query, facets, sort, etc)
-  # @yield [search_builder] optional block yields configured SearchBuilder, caller can modify or create new SearchBuilder to be used. Block should return SearchBuilder to be used.
-  # @return [Blacklight::Solr::Response] the solr response object
-  def search_results(user_params)
-    builder = search_builder.with(user_params)
-    builder.page = user_params[:page] if user_params[:page]
-    builder.rows = (user_params[:per_page] || user_params[:rows]) if user_params[:per_page] || user_params[:rows]
-
-    builder = yield(builder) if block_given?
-    response = repository.search(builder)
-
-    if response.grouped? && grouped_key_for_results
-      [response.group(grouped_key_for_results), []]
-    elsif response.grouped? && response.grouped.length == 1
-      [response.grouped.first, []]
-    else
-      [response, response.documents]
-    end
-  end
-
-  # retrieve a document, given the doc id
-  # @param [Array{#to_s},#to_s] id
-  # @return [Blacklight::Solr::Response, Blacklight::SolrDocument] the solr response object and the first document
-  def fetch(id = nil, extra_controller_params = {})
-    if id.is_a? Array
-      fetch_many(id, search_state.to_h, extra_controller_params)
-    else
-      fetch_one(id, extra_controller_params)
-    end
-  end
-
-  ##
-  # Get the solr response when retrieving only a single facet field
-  # @return [Blacklight::Solr::Response] the solr response
-  def get_facet_field_response(facet_field, user_params = params || {}, extra_controller_params = {})
-    query = search_builder.with(user_params).facet(facet_field)
-    repository.search(query.merge(extra_controller_params))
-  end
-
-  # Get the previous and next document from a search result
-  # @return [Blacklight::Solr::Response, Array<Blacklight::SolrDocument>] the solr response and a list of the first and last document
-  def get_previous_and_next_documents_for_search(index, request_params, extra_controller_params={})
-    p = previous_and_next_document_params(index)
-    query = search_builder.with(request_params).start(p.delete(:start)).rows(p.delete(:rows)).merge(extra_controller_params).merge(p)
-    response = repository.search(query)
-    document_list = response.documents
-
-    # only get the previous doc if there is one
-    prev_doc = document_list.first if index > 0
-    next_doc = document_list.last if (index + 1) < response.total
-    [response, [prev_doc, next_doc]]
-  end
-
-  # a solr query method
-  # does a standard search but returns a simplified object.
-  # an array is returned, the first item is the query string,
-  # the second item is an other array. This second array contains
-  # all of the field values for each of the documents...
-  # where the field is the "field" argument passed in.
-  def get_opensearch_response(field = nil, request_params = params || {}, extra_controller_params = {})
-    field ||= blacklight_config.view_config('opensearch').title_field
-
-    query = search_builder.with(request_params).merge(solr_opensearch_params(field)).merge(extra_controller_params)
-    response = repository.search(query)
-
-    [response.params[:q], response.documents.flat_map {|doc| doc[field] }.uniq]
-  end
-
-  ##
-  # The key to use to retrieve the grouped field to display
-  def grouped_key_for_results
-    blacklight_config.index.group
-  end
-
-  delegate :repository_class, to: :blacklight_config
-
-  def repository
-    repository_class.new(blacklight_config)
-  end
-
-  private
-
-    ##
-    # Retrieve a set of documents by id
-    # @param [Array] ids
-    # @param [HashWithIndifferentAccess] user_params
-    # @param [HashWithIndifferentAccess] extra_controller_params
-    def fetch_many(ids, user_params, extra_controller_params)
-      user_params ||= params
-      extra_controller_params ||= {}
-
-      query = search_builder.
-                with(user_params).
-                where(blacklight_config.document_model.unique_key => ids).
-                merge(blacklight_config.fetch_many_document_params || deprecated_fetch_many_document_params).
-                merge(extra_controller_params)
-
-      solr_response = repository.search(query)
-
-      [solr_response, solr_response.documents]
-    end
-
-    def fetch_one(id, extra_controller_params)
-      solr_response = repository.find id, extra_controller_params
-      [solr_response, solr_response.documents.first]
-    end
-
-    def deprecated_fetch_many_document_params
-      Deprecation.warn(self, 'You should configure blacklight_config.fetch_many_document_params; defaulting to { fl: "*" }, but this will be removed in Blacklight 7')
-      { fl: '*' }
-    end
-end

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-module Blacklight
-  module Suggest
-    extend ActiveSupport::Concern
-
-    included do
-      include Blacklight::Configurable
-      include Blacklight::SearchHelper
-
-      copy_blacklight_config_from(CatalogController)
-    end
-
-    def index
-      respond_to do |format|
-        format.json do
-          render json: suggestions_service.suggestions
-        end
-      end
-    end
-
-    def suggestions_service
-      Blacklight::SuggestSearch.new(params, repository).suggestions
-    end
-  end
-end

data/app/controllers/saved_searches_controller.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-class SavedSearchesController < ApplicationController
-  include Blacklight::SavedSearches
-end

data/app/controllers/suggest_controller.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-class SuggestController < ApplicationController
-  include Blacklight::Suggest
-end