blacklight 7.41.0 → 8.0.0.beta1

data/.babelrc

@@ -1,11 +0,0 @@
-{
-  "presets": [
-    [
-      "@babel/preset-env",
-      {
-        "useBuiltIns": "entry",
-        "corejs": "2.0"
-      }
-    ]
-  ]
-}

data/.github/matrix.json

@@ -1,62 +0,0 @@
-{
-  "ruby": ["3.3"],
-  "rails_version": [
-    "7.1.5.1",
-    "7.2.2.1"
-  ],
-  "bootstrap_version": [
-    null
-  ],
-  "view_component_version": [
-    "~> 3.12"
-  ],
-  "api": [
-    null
-  ],
-  "additional_engine_cart_rails_options": [
-    ""
-  ],
-  "additional_name": [
-    ""
-  ],
-  "include": [
-    {
-      "ruby": "3.2",
-      "rails_version": "7.1.5.1"
-    },
-    {
-      "ruby": "3.3",
-      "rails_version": "7.1.5.1",
-      "bootstrap_version": "~> 5.0",
-      "additional_name": "| bootstrap 5"
-    },
-    {
-      "ruby": "3.4",
-      "rails_version": "7.2.2.1"
-    },
-    {
-      "ruby": "3.4",
-      "rails_version": "8.0.2"
-    },
-    {
-      "ruby": "3.3",
-      "rails_version": "7.1.5.1",
-      "view_component_version": "~> 2.74",
-      "additional_name": "| View Component 2"
-    },
-    {
-      "ruby": "3.2",
-      "rails_version": "7.1.5.1",
-      "api": "true",
-      "additional_engine_cart_rails_options": "--api --skip-yarn",
-      "additional_name": "| API"
-    },
-    {
-      "ruby": "3.3",
-      "rails_version": "7.1.5.1",
-      "api:": "true",
-      "additional_engine_cart_rails_options": "--api --skip-yarn",
-      "additional_name": "| API"
-    }
-  ]
-}

data/.github/workflows/build.yml

@@ -1,16 +0,0 @@
-on:
-  workflow_call:
-    inputs:
-      ref:
-        required: false
-        type: string
-        default: ''
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          ref: ${{ inputs.ref }}
-      - name: Build docker image
-        run: docker compose build app

data/.github/workflows/lint.yml

@@ -1,23 +0,0 @@
-on:
-  workflow_call:
-    inputs:
-      ref:
-        required: false
-        type: string
-        default: ''
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          ref: ${{ inputs.ref }}
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.2
-          bundler: "default"
-      - name: Install dependencies
-        run: bundle install
-      - name: Run linter
-        run: bundle exec rake rubocop

data/.github/workflows/main.yml

@@ -1,23 +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:
-    uses: ./.github/workflows/lint.yml
-  test:
-    uses: ./.github/workflows/test.yml
-  docker_build:
-    uses: ./.github/workflows/build.yml

data/.github/workflows/test.yml

@@ -1,53 +0,0 @@
-on:
-  workflow_call:
-    inputs:
-      ref:
-        required: false
-        type: string
-        default: ''
-        description: The branch or reference to run the workflow against
-jobs:
-  set_matrix:
-    runs-on: ubuntu-latest
-    outputs:
-      matrix: ${{ steps.matrix.outputs.matrix }}
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
-        with:
-          ref: ${{ inputs.ref }}
-      - name: Echo ./.github/matrix.json
-        id: matrix
-        run: |
-          echo "matrix<<EOF" >> $GITHUB_OUTPUT
-          cat ./.github/matrix.json >> $GITHUB_OUTPUT
-          echo "EOF" >> $GITHUB_OUTPUT
-  test:
-    needs: set_matrix
-    runs-on: ubuntu-latest
-    name: ruby ${{ matrix.ruby }} | rails ${{ matrix.rails_version }} ${{ matrix.additional_name }}
-    strategy:
-      fail-fast: false
-      matrix: ${{fromJson(needs.set_matrix.outputs.matrix)}}
-    env:
-      RAILS_VERSION: ${{ matrix.rails_version }}
-      SOLR_VERSION: ${{ matrix.solr_version || 'latest' }}
-      VIEW_COMPONENT_VERSION: ${{ matrix.view_component_version }}
-      BOOTSTRAP_VERSION: ${{ matrix.bootstrap_version }}
-      BLACKLIGHT_API_TEST: ${{ matrix.api }}
-      ENGINE_CART_RAILS_OPTIONS: "--skip-git --skip-listen --skip-spring --skip-keeps --skip-kamal --skip-solid --skip-coffee --skip-test ${{ matrix.additional_engine_cart_rails_options }}"
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          ref: ${{ inputs.ref }}
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler: "latest"
-          ruby-version: ${{ matrix.ruby }}
-      - name: Change permissions
-        run: "chmod -f -R o-w /opt/hostedtoolcache/Ruby/3.2.5/x64/lib/ruby/gems/3.2.0/gems | :"
-      - name: Install dependencies
-        run: bundle install
-      - name: Run tests
-        run: bundle exec rake ci

data/app/assets/images/blacklight/list.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M3 13h2v-2H3v2zm0 4h2v-2H3v2zm0-8h2V7H3v2zm4 4h14v-2H7v2zm0 4h14v-2H7v2zM7 7v2h14V7H7z"/><path d="M0 0h24v24H0z" fill="none"/></svg>

data/app/assets/images/blacklight/search.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0V0z"/><path d="M15.5 14h-.79l-.28-.27C15.41 12.59 16 11.11 16 9.5 16 5.91 13.09 3 9.5 3S3 5.91 3 9.5 5.91 16 9.5 16c1.61 0 3.09-.59 4.23-1.57l.27.28v.79l5 4.99L20.49 19l-4.99-5zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"/></svg>

data/app/assets/stylesheets/blacklight/_twitter_typeahead.scss

@@ -1,37 +0,0 @@
-.twitter-typeahead {
-  display: inline-flex !important;
-  flex-grow: 2;
-  z-index: $zindex-typeahead;
-
-  input.tt-input.form-control {
-    width: 100%;
-  }
-
-  input.tt-hint.form-control {
-    width: 100%;
-    filter: opacity(0.33);
-  }
-
-  .tt-menu {
-    @extend .dropdown-menu;
-    font-family: $font-family-base;
-    width: 100%;
-  }
-
-  .tt-cursor {
-    background-color: $dropdown-link-hover-bg;
-    color: $dropdown-link-hover-color;
-    text-decoration: none;
-  }
-
-  .tt-suggestion {
-    font-size: 14px;
-    padding: 5px 5px 5px 10px;
-  }
-
-  .tt-suggestion:hover {
-    background-color: $dropdown-link-hover-bg;
-    color: $dropdown-link-hover-color;
-    cursor: pointer;
-  }
-}

data/app/components/blacklight/content_areas_shim.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Blacklight
-  # Shim to support ViewComponent v2 slots using the content_areas API for backwards compatibility
-  module ContentAreasShim
-    # Shim the `with` helper to write content into slots instead
-    def with(slot_name, *args, **kwargs, &block)
-      Deprecation.warn(Blacklight::ContentAreasShim,
-                       'ViewComponents deprecated `with` and it will be removed in ViewComponents 3.0. content_areas. Use slots (https://viewcomponent.org/guide/slots.html) instead.')
-      public_send("with_#{slot_name}", *args, **kwargs, &block)
-    end
-  end
-end

data/app/components/blacklight/search/per_page_component.html.erb

@@ -1,2 +0,0 @@
-<span class="sr-only visually-hidden"><%= t('blacklight.search.per_page.title') %></span>
-<%= dropdown %>

data/app/components/blacklight/search/per_page_component.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module Blacklight
-  module Search
-    class PerPageComponent < Blacklight::Component
-      def initialize(blacklight_config:, response:, search_state:)
-        @blacklight_config = blacklight_config
-        @response = response
-        @search_state = search_state
-      end
-
-      def render?
-        helpers.show_sort_and_per_page?
-      end
-
-      # You may override this method in a subclass if you want to use a different dropdown component
-      def dropdown_class
-        Blacklight::System::DropdownComponent
-      end
-
-      def dropdown
-        render(dropdown_class.new(
-                 param: :per_page,
-                 choices: per_page_options_for_select,
-                 id: 'per_page-dropdown',
-                 search_state: @search_state,
-                 selected: current_per_page,
-                 interpolation: :count
-               ))
-      end
-
-      #
-      # @return [Integer]
-      def current_per_page
-        (@response.rows if @response && @response.rows > 0) || # rubocop:disable Style/NumericPredicate
-          params.fetch(:per_page, @blacklight_config.default_per_page).to_i
-      end
-
-      ##
-      # The available options for results per page, in the style of #options_for_select
-      def per_page_options_for_select
-        return [] if @blacklight_config.per_page.blank?
-
-        @blacklight_config.per_page.map do |count|
-          [t(:'blacklight.search.per_page.label', count: count).html_safe, count]
-        end
-      end
-    end
-  end
-end

data/app/components/blacklight/search_context/server_item_pagination_component.html.erb

@@ -1,10 +0,0 @@
-<div class='pagination-search-widgets'>
-
-  <div class="page-links">
-    <%= link_to_previous_document %> |
-
-    <%= item_page_entry_info %> |
-
-    <%= link_to_next_document %>
-  </div>
-</div>

data/app/components/blacklight/search_context/server_item_pagination_component.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Blacklight
-  module SearchContext
-    class ServerItemPaginationComponent < Blacklight::SearchContextComponent
-      with_collection_parameter :search_context
-
-      def initialize(search_context:, search_session:, current_document:)
-        @search_context = search_context
-        @search_session = search_session
-        @current_document_id = current_document.id
-      end
-    end
-  end
-end

data/app/components/blacklight/system/dropdown_button_component.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Blacklight
-  module System
-    class DropdownButtonComponent < Blacklight::Component
-      def initialize(label:, classes: %w[btn btn-outline-secondary dropdown-toggle])
-        @classes = classes
-        @label = label
-      end
-
-      def call
-        button_tag class: @classes, aria: { expanded: false }, data: { toggle: 'dropdown', 'bs-toggle': 'dropdown' } do
-          safe_join([@label, content_tag(:span, '', class: 'caret')])
-        end
-      end
-    end
-  end
-end

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

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-module Blacklight::Base
-  extend ActiveSupport::Concern
-
-  include Blacklight::Configurable
-  include Blacklight::SearchContext
-
-  def self.included(mod)
-    Deprecation.warn(Blacklight::Base, "Blacklight::Base is deprecated and will be removed in Blacklight 8.0.0.
-	Include Blacklight::Configurable and Blacklight::SearchContext as needed (included in #{mod}).")
-  end
-end

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

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-module Blacklight
-  module DefaultComponentConfiguration
-    extend ActiveSupport::Concern
-
-    included do
-      Deprecation.warn(self, "Blacklight::DefaultComponentConfiguration is deprecated and will be removed in the next release." \
-                             "this means you must call add_results_document_tool, add_results_collection_tool, " \
-                             "add_show_tools_partial and add_nav_action manually in your config")
-      add_results_document_tool(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
-
-      add_results_collection_tool(:sort_widget)
-      add_results_collection_tool(:per_page_widget)
-      add_results_collection_tool(:view_type_group)
-
-      add_show_tools_partial(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
-      add_show_tools_partial(:email, callback: :email_action, validator: :validate_email_params)
-      add_show_tools_partial(:sms, if: :render_sms_action?, callback: :sms_action, validator: :validate_sms_params)
-      add_show_tools_partial(:citation)
-
-      add_nav_action(:bookmark, partial: 'blacklight/nav/bookmark', if: :render_bookmarks_control?)
-      add_nav_action(:search_history, partial: 'blacklight/nav/search_history')
-    end
-
-    module ClassMethods
-      # YARD will include inline disabling as docs, cannot do multiline inside @!macro.  AND this must be separate from doc block.
-      # rubocop:disable Layout/LineLength
-
-      # @!macro partial_if_unless
-      #   @param name [String] the name of the document partial
-      #   @param opts [Hash]
-      #   @option opts [Symbol,Proc] :if render this action if the method identified by the symbol or the proc evaluates to true. The proc will receive the action configuration and the document or documents for the action.
-      #   @option opts [Symbol,Proc] :unless render this action unless the method identified by the symbol or the proc evaluates to true. The proc will receive the action configuration and the document or documents for the action.
-
-      # Add a partial to the tools for rendering a document
-      # @!macro partial_if_unless
-      # @option opts [Boolean] :define_method define a controller method as named, default: true
-      # @option opts [Symbol]  :validator method for toggling between success and failure, should return Boolean (true if valid)
-      # @option opts [Symbol]  :callback method for further processing of documents, receives Array of documents
-      def add_show_tools_partial(name, opts = {})
-        blacklight_config.add_show_tools_partial(name, opts)
-        ActionBuilder.new(self, name, opts).build
-      end
-      # rubocop:enable Layout/LineLength
-
-      deprecation_deprecate add_show_tools_partial: 'use blacklight_config.add_show_tools_partial instead'
-
-      # Add a tool to be displayed for each document in the search results.
-      # @!macro partial_if_unless
-      delegate :add_results_document_tool, to: :blacklight_config
-      deprecation_deprecate add_results_document_tool: 'use blacklight_config.add_results_document_tool instead'
-
-      # Add a tool to be displayed for the list of search results themselves.
-      # @!macro partial_if_unless
-      delegate :add_results_collection_tool, to: :blacklight_config
-      deprecation_deprecate add_results_collection_tool: 'use blacklight_config.add_results_collection_tool instead'
-
-      # Add a partial to the header navbar.
-      # @!macro partial_if_unless
-      delegate :add_nav_action, to: :blacklight_config
-      deprecation_deprecate add_nav_action: 'use blacklight_config.add_nav_action instead'
-    end
-  end
-end

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

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-module Blacklight
-  # These are methods that are used at both the view helper and controller layers
-  # They are only dependent on `blacklight_config` and `@response`
-  #
-  module Facet
-    extend Deprecation
-    delegate :facet_configuration_for_field, :facet_field_names, to: :blacklight_config
-
-    # @deprecated
-    # @param [Blacklight::Configuration::Facet] field_config
-    # @param [Object] response_data
-    # @return [Blacklight::FacetPaginator]
-    def facet_paginator(field_config, response_data)
-      blacklight_config.facet_paginator_class.new(
-        response_data.items,
-        sort: response_data.sort,
-        offset: response_data.offset,
-        prefix: response_data.prefix,
-        limit: Deprecation.silence(Blacklight::Catalog) { facet_limit_for(field_config.key) }
-      )
-    end
-    deprecation_deprecate facet_paginator: 'Use Blacklight::FacetFieldPresenter#paginator instead'
-
-    # @param fields [Array<String>] a list of facet field names
-    # @return [Array<Solr::Response::Facets::FacetField>]
-    # @deprecated
-    def facets_from_request(fields = facet_field_names, response = nil)
-      unless response
-        Deprecation.warn(self, 'Calling facets_from_request without passing the ' \
-          'second argument (response) is deprecated and will be removed in Blacklight ' \
-          '8.0.0')
-        response = @response
-      end
-
-      Deprecation.silence(Blacklight::Facet) do
-        fields.map { |field| facet_by_field_name(field, response) }.compact
-      end
-    end
-    deprecation_deprecate facets_from_request: 'Removed without replacement'
-
-    delegate :facet_group_names, to: :blacklight_config
-    deprecation_deprecate facet_group_names: 'Use blacklight_config.facet_group_names instead'
-
-    # Get a FacetField object from the @response
-    # @deprecated
-    # @private
-    # @return [Blacklight::Solr::Response::Facets::FacetField]
-    def facet_by_field_name(field_or_field_name, response = nil)
-      unless response
-        Deprecation.warn(self, 'Calling facet_by_field_name without passing the ' \
-          'second argument (response) is deprecated and will be removed in Blacklight ' \
-          '8.0.0')
-        response = @response
-      end
-      case field_or_field_name
-      when String, Symbol
-        facet_field = facet_configuration_for_field(field_or_field_name)
-        response.aggregations[facet_field.field]
-      when Blacklight::Configuration::FacetField
-        response.aggregations[field_or_field_name.field]
-      else
-        # is this really a useful case?
-        field_or_field_name
-      end
-    end
-    deprecation_deprecate facet_by_field_name: 'Removed without replacement'
-  end
-end

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

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-##
-# Module to deal with accessing (and setting some defaults) in an array of
-# hashes that describe Blacklight search fields.  Requires the base class this
-# module is added to implements a #blacklight_config method that returns a hash, where
-# blacklight_config[:search_fields] will be an array of hashes describing search fields.
-#
-# = Search Field blacklight_configuration Hash =
-# [:key]
-#   "title", required, unique key used in search URLs to specify search_field
-# [:label]
-#   "Title",  # user-displayable label, optional, if not supplied :key.titlecase will be used
-# [:qt]
-#   "search", # Solr qt param, request handler, usually can be left blank; defaults to nil if not explicitly specified
-# [:solr_parameters]
-#   { :qf => "something" } # optional hash of additional parameters to pass to solr for searches on this field.
-# [:solr_local_parameters]
-#   { :qf => "$something" } # optional hash of additional parameters that will be passed using Solr LocalParams syntax, that can use dollar sign to reference other solr variables.
-# [:include_in_simple_select]
-#   false.  Defaults to true, but you can set to false to have a search field defined for deep-links or BL extensions, but not actually included in the HTML select for simple search choice.
-#
-# Optionally you can supply a :key, which is what Blacklight will use
-# to identify this search field in HTTP query params. If no :key is
-# supplied, one will be computed from the :label. If that will
-# result in a collision of keys, you should supply one explicitly.
-#
-##
-module Blacklight::SearchFields
-  extend Deprecation
-
-  # Looks up search field config list from blacklight_config[:search_fields], and
-  # 'normalizes' all field config hashes using normalize_config method.
-  # @deprecated
-  def search_field_list
-    blacklight_config.search_fields.values
-  end
-  deprecation_deprecate search_field_list: 'Use blacklight_config.search_fields instead'
-
-  # Returns default search field, used for simpler display in history, etc.
-  # if not set in blacklight_config, defaults to first field listed in #search_field_list
-  # @deprecated
-  def default_search_field
-    blacklight_config.default_search_field || (Deprecation.silence(Blacklight::SearchFields) { search_field_list.first })
-  end
-  deprecation_deprecate default_search_field: 'Use Blacklight::Configuration#default_search_field'
-end

data/app/helpers/blacklight/hash_as_hidden_fields_helper_behavior.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-# Rails Helper methods to take a hash and turn it to form <input type="hidden">
-# fields, works with hash nested with other hashes and arrays, standard rails
-# serialization style.  Oddly while Hash#to_query will do this for a URL
-# query parameters, there seems to be no built in way to do it to create
-# hidden form fields instead.
-#
-# Code taken from http://marklunds.com/articles/one/314
-#
-# This is used to serialize a complete current query from current params
-# to form fields used for sort and change per-page
-module Blacklight::HashAsHiddenFieldsHelperBehavior
-  extend Deprecation
-
-  ##
-  # Writes out zero or more <input type="hidden"> elements, completely
-  # representing a hash passed in using Rails-style request parameters
-  # for hashes nested with arrays and other hashes.
-  #
-  # @deprecated
-  # @param [Hash] hash
-  # @return [String]
-  def render_hash_as_hidden_fields(hash)
-    render Blacklight::HiddenSearchStateComponent.new(params: hash)
-  end
-  deprecation_deprecate render_hash_as_hidden_fields: 'Use Blacklight::HiddenSearchStateComponent instead'
-end