blacklight 7.6.0 → 7.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '087bb21bf2c345072d1fade572f09741ab819c5f44e8b563c6818530c1da6da8'
-  data.tar.gz: eebaefbf5c6ec5b3f245ef17ce59c006ac09ffefb047f336aa185cace7bd293e
+  metadata.gz: 0b7f2fb6980380cf12a51209225c105a4553f662015935c12335f7f0092086d6
+  data.tar.gz: fa8de265b2adfc5ca3e1bc6c8f94e6ed7cdbbd3d465b70516924c30aaf6d3a4b
 SHA512:
-  metadata.gz: edce2eb3d01ea8ea635515c70db1b9e584ea96d4a360378897bc8340a94919f9ffa6f7be6824aa644c07929b3623f0f90f14280eef71b180f0d2022da8f0f677
-  data.tar.gz: ac8cc8d0432746cc80b01d330cc6bad45fc54ac4a2386a11c7c54285a1202ced0cd5b0f51f603e0281c4e33520565514ffadc8f549fa66ca0fb45533afe8c774
+  metadata.gz: 3b2a6adc3e2affcfb8e0a193493b37e5b1fac9ccf98c5145a985b4bd8166b1cf2e525d7f603eb1fbca7170ea6f1c32823e9acd6b0f55fa103fe637cba5628ccb
+  data.tar.gz: 126dff3afa6c1db27e4b707952b9ce82926ca66c5882164739e0a5ba63a95c1f8af9c069a151fd0f031705d8757dac57c9013b9c7c64dbd6d6a4ec05fbbff4ab

data/.docker/app/Dockerfile

@@ -0,0 +1,26 @@
+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 \
+  sqlite-dev \
+  tzdata
+
+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

@@ -0,0 +1,6 @@
+#!/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/.env

@@ -0,0 +1,5 @@
+ALPINE_RUBY_VERSION=2.6.5
+RAILS_VERSION=5.2.4.1
+SOLR_PORT=8983
+SOLR_URL=http://solr:8983/solr/blacklight-core
+SOLR_VERSION=latest

data/.gitignore

@@ -14,6 +14,6 @@ log/*
 tmp/*
 pkg/*
 .internal_test_app
-.vagrant
 /spec/examples.txt
 node_modules/*
+package-lock.json

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-02-03 11:07:48 -0800 using RuboCop version 0.63.1.
+# on 2020-03-30 10:03:33 -0700 using RuboCop version 0.63.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -177,7 +177,7 @@ Lint/UselessComparison:
   Exclude:
     - 'spec/models/blacklight/document/active_model_shim_spec.rb'
 
-# Offense count: 59
+# Offense count: 60
 Metrics/AbcSize:
   Max: 49
 
@@ -201,20 +201,20 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Max: 11
 
-# Offense count: 54
+# Offense count: 56
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
-  Max: 31
+  Max: 30
 
 # Offense count: 8
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
   Max: 212
 
-# Offense count: 2
+# Offense count: 5
 # Configuration parameters: CountKeywordArgs.
 Metrics/ParameterLists:
-  Max: 6
+  Max: 7
 
 # Offense count: 16
 Metrics/PerceivedComplexity:
@@ -287,7 +287,7 @@ RSpec/BeforeAfterAll:
 RSpec/ContextWording:
   Enabled: false
 
-# Offense count: 55
+# Offense count: 56
 RSpec/DescribeClass:
   Enabled: false
 
@@ -297,7 +297,7 @@ RSpec/EmptyExampleGroup:
   Exclude:
     - 'spec/models/blacklight/solr/search_builder_spec.rb'
 
-# Offense count: 129
+# Offense count: 130
 # Configuration parameters: Max.
 RSpec/ExampleLength:
   Enabled: false
@@ -321,7 +321,7 @@ RSpec/FilePath:
     - 'spec/presenters/pipeline_spec.rb'
     - 'spec/presenters/thumbnail_presenter_spec.rb'
 
-# Offense count: 192
+# Offense count: 191
 # Configuration parameters: AssignmentOnly.
 RSpec/InstanceVariable:
   Enabled: false
@@ -371,12 +371,12 @@ RSpec/MessageSpies:
     - 'spec/presenters/blacklight/field_presenter_spec.rb'
     - 'spec/presenters/thumbnail_presenter_spec.rb'
 
-# Offense count: 340
+# Offense count: 343
 # Configuration parameters: AggregateFailuresByDefault.
 RSpec/MultipleExpectations:
   Max: 16
 
-# Offense count: 337
+# Offense count: 341
 # Configuration parameters: IgnoreSharedExamples.
 RSpec/NamedSubject:
   Enabled: false
@@ -412,7 +412,7 @@ RSpec/SubjectStub:
     - 'spec/models/blacklight/search_builder_spec.rb'
     - 'spec/services/blacklight/search_service_spec.rb'
 
-# Offense count: 120
+# Offense count: 118
 # Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
 RSpec/VerifiedDoubles:
   Enabled: false
@@ -497,7 +497,7 @@ Style/ConditionalAssignment:
   Exclude:
     - 'lib/blacklight/solr/response/spelling.rb'
 
-# Offense count: 94
+# Offense count: 99
 Style/Documentation:
   Enabled: false
 

data/.travis.yml

@@ -1,50 +1,42 @@
 dist: bionic
+
 addons:
   chrome: stable
-language: ruby
 
-notifications:
-  email: false
+language: ruby
 
 matrix:
   include:
     - rvm: 2.7.0
-      env: "RAILS_VERSION=6.0.2.1"
+      env: "RAILS_VERSION=6.0.2.2"
     - rvm: 2.6.5
-      env: "RAILS_VERSION=6.0.2.1 ENGINE_CART_RAILS_OPTIONS=\"--skip-webpack-install\""
+      env: "RAILS_VERSION=6.0.2.2"
     - rvm: 2.6.5
-      env: "RAILS_VERSION=5.2.4.1"
+      env: "RAILS_VERSION=5.2.4.2"
     - rvm: 2.5.7
-      env: "RAILS_VERSION=5.2.4.1 BLACKLIGHT_API_TEST=true ENGINE_CART_RAILS_OPTIONS=\"--api --skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-test\""
+      env: "RAILS_VERSION=5.2.4.2 BLACKLIGHT_API_TEST=true ENGINE_CART_RAILS_OPTIONS=\"--api --skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-test\""
     - rvm: 2.4.9
-      env: "RAILS_VERSION=5.2.4.1"
+      env: "RAILS_VERSION=5.2.4.2"
     - rvm: jruby-9.2.8.0
-      env: "RAILS_VERSION=5.2.4.1 JRUBY_OPTS=\"-J-Xms512m -J-Xmx1024m\""
+      env: "RAILS_VERSION=5.2.4.2 JRUBY_OPTS=\"-J-Xms512m -J-Xmx1024m\""
   allow_failures:
     - rvm: jruby-9.2.8.0
   fast_finish: true
 
 before_install:
-  - docker pull solr:7
-  - docker run -d -p 8983:8983 -v $PWD/lib/generators/blacklight/templates/solr/conf:/myconfig solr:7 solr-create -c blacklight-core -d /myconfig
-  - docker ps -a
   - google-chrome-stable --headless --disable-gpu --no-sandbox --remote-debugging-port=9222 http://localhost &
 
-notifications:
-  irc: "irc.freenode.org#blacklight"
-  email:
-      - blacklight-commits@googlegroups.com
-
-global_env:
-  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-  - ENGINE_CART_RAILS_OPTIONS='--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
-  - CC_TEST_REPORTER_ID=5042c7358c96b0b926088a4cda3e132fffe7a66ce8047cdb1dc6f0b4b6676b79
-
-jdk: openjdk11
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+    - ENGINE_CART_RAILS_OPTIONS='--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+    - CC_TEST_REPORTER_ID=5042c7358c96b0b926088a4cda3e132fffe7a66ce8047cdb1dc6f0b4b6676b79
 
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter
   - ./cc-test-reporter before-build
+
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+  - docker-compose build app || travis_terminate 1 # validates application Dockerfile

data/Gemfile

@@ -34,7 +34,10 @@ else
   end
 
   case ENV['RAILS_VERSION']
-  when /^5.[12]/, /^6.0/
+  when /^6.0/
+    gem 'sass-rails', '>= 6'
+    gem 'webpacker', '~> 4.0'
+  when /^5.[12]/
     gem 'sass-rails', '~> 5.0'
   when /^4.2/
     gem 'responders', '~> 2.0'

data/README.md

@@ -38,6 +38,10 @@ rails generate blacklight:install
 * Bundler
 * Rails 5.1+
 
+## Contributing Code
+
+Code contributions are always welcome, instructions for contributing can be found at [CONTRIBUTING.md](https://github.com/projectblacklight/blacklight/blob/master/CONTRIBUTING.md).
+
 ## Configuring Apache Solr
 You'll also want some information about how Blacklight expects [Apache Solr](http://lucene.apache.org/solr ) to run, which you can find in [README_SOLR](https://github.com/projectblacklight/blacklight/wiki/README_SOLR)
 

data/VERSION

@@ -1 +1 @@
-7.6.0
+7.10.0

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

@@ -150,10 +150,26 @@
 
 .pivot-facet {
   @extend .list-unstyled;
+  @extend .py-1;
+  @extend .px-4;
+}
+
+.facet-leaf-node {
+  margin-left: 1rem;
+  padding-right: 1rem;
+  margin-top: -1.5rem;
+}
 
-  ul, .pivot-facet {
-    @extend .list-unstyled;
-    @extend .py-1;
-    @extend .px-3;
+.facet-toggle-handle {
+  margin: 0;
+  margin-left: -5px;
+  padding: 0;
+
+  &.collapsed {
+    .show { display: block; }
+    .hide { display: none; }
   }
+
+  .show { display: none; }
+  .hide { display: block; }
 }

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

@@ -5,6 +5,10 @@
   padding-left: 0;
 }
 
+.record-padding {
+  margin-top: $spacer / 2;
+}
+
 .pagination {
   @media (max-width: breakpoint-max(sm)) {
     flex-wrap: wrap;

data/app/components/blacklight/constraint_layout_component.html.erb

@@ -0,0 +1,23 @@
+<span class="btn-group applied-filter constraint <%= @classes %>">
+  <span class="constraint-value btn btn-outline-secondary">
+    <% if @label.present? %>
+      <span class="filter-name"><%= @label %></span>
+    <% end %>
+    <% if @value.present? %>
+      <%= content_tag :span, @value, class: 'filter-value', title: strip_tags(@value) %>
+    <% end %>
+  </span>
+  <% if @remove_path.present? %>
+    <%= link_to(@remove_path, class: 'btn btn-outline-secondary remove') do %>
+      <span class="remove-icon">✖</span>
+      <span class="sr-only">
+        <%= if @label.blank?
+            t('blacklight.search.filters.remove.value', value: @value)
+          else
+            t('blacklight.search.filters.remove.label_value', label: @label, value: @value)
+          end
+        %>
+      </span>
+    <% end %>
+  <% end %>
+</span>

data/app/components/blacklight/constraint_layout_component.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class ConstraintLayoutComponent < ::ViewComponent::Base
+    def initialize(value:, label: nil, remove_path: nil, classes: nil)
+      @value = value
+      @label = label
+      @remove_path = remove_path
+      @classes = Array(classes).join(' ')
+    end
+
+    def render?
+      @value.present?
+    end
+  end
+end

data/app/components/blacklight/facet_field_component.html.erb

@@ -0,0 +1,25 @@
+<div class="card facet-limit blacklight-<%= @facet_field.key %> <%= 'facet-limit-active' if @facet_field.active? %>">
+  <h3 class="card-header p-0 facet-field-heading" id="<%= @facet_field.html_id %>-header">
+    <button
+      class="btn btn-block p-2 text-left collapse-toggle <%= "collapsed" if @facet_field.collapsed? %>"
+      data-toggle="collapse"
+      data-target="#<%= @facet_field.html_id %>"
+      aria-expanded="<%= @facet_field.collapsed? ? 'false' : 'true' %>"
+    >
+      <%= label %>
+    </button>
+  </h3>
+  <div id="<%= @facet_field.html_id %>" aria-labelledby="<%= @facet_field.html_id %>-header" class="panel-collapse facet-content collapse <%= "show" unless @facet_field.collapsed? %>">
+    <div class="card-body">
+      <%= body %>
+
+      <% if @facet_field.modal_path %>
+        <div class="more_facets">
+          <%= link_to t("more_#{@facet_field.key}_html", scope: 'blacklight.search.facets', default: :more_html, field_name: @facet_field.label),
+            @facet_field.modal_path,
+            data: { blacklight_modal: 'trigger' } %>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/components/blacklight/facet_field_component.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class FacetFieldComponent < ::ViewComponent::Base
+    with_content_areas :label, :body
+
+    def initialize(facet_field:)
+      @facet_field = facet_field
+    end
+  end
+end

data/app/components/blacklight/facet_field_list_component.html.erb

@@ -0,0 +1,18 @@
+<%= render(@layout.new(facet_field: @facet_field)) do |component| %>
+  <% component.with(:label) do %>
+    <%= @facet_field.label %>
+  <% end %>
+  <% component.with(:body) do %>
+    <ul class="facet-values list-unstyled">
+      <%= render_facet_limit_list @facet_field.paginator, @facet_field.key %>
+    </ul>
+    <%# backwards compatibility, ugh %>
+    <% if @layout == Blacklight::FacetFieldNoLayoutComponent && !@facet_field.in_modal? && @facet_field.modal_path %>
+      <div class="more_facets">
+        <%= link_to t("more_#{@facet_field.key}_html", scope: 'blacklight.search.facets', default: :more_html, field_name: @facet_field.label),
+          @facet_field.modal_path,
+          data: { blacklight_modal: 'trigger' } %>
+      </div>
+    <% end %>
+  <% end %>
+<% end %>

data/app/components/blacklight/facet_field_list_component.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class FacetFieldListComponent < ::ViewComponent::Base
+    def initialize(facet_field:, layout: nil)
+      @facet_field = facet_field
+      @layout = layout == false ? FacetFieldNoLayoutComponent : Blacklight::FacetFieldComponent
+    end
+
+    # Here for backwards compatibility only.
+    # @private
+    def render_facet_limit_list(*args)
+      Deprecation.silence(Blacklight::FacetsHelperBehavior) do
+        @view_context.render_facet_limit_list(*args)
+      end
+    end
+
+    def render?
+      @facet_field.paginator.items.any?
+    end
+  end
+end

data/app/components/blacklight/facet_field_no_layout_component.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class FacetFieldNoLayoutComponent < ::ViewComponent::Base
+    with_content_areas :label, :body
+
+    def initialize(**); end
+
+    def call
+      body
+    end
+  end
+end

data/app/components/blacklight/facet_item_component.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class FacetItemComponent < ::ViewComponent::Base
+    with_collection_parameter :facet_item
+
+    def initialize(facet_item:, wrapping_element: 'li', suppress_link: false)
+      @facet_item = facet_item
+      @label = facet_item.label
+      @hits = facet_item.hits
+      @href = facet_item.href
+      @selected = facet_item.selected?
+      @wrapping_element = wrapping_element
+      @suppress_link = suppress_link
+    end
+
+    def call
+      # if the downstream app has overridden the helper methods we'd usually call,
+      # use the helpers to preserve compatibility
+      content = if overridden_helper_methods?
+                  content_from_legacy_view_helper
+                elsif @selected
+                  render_selected_facet_value
+                else
+                  render_facet_value
+                end
+
+      return if content.blank?
+      return content unless @wrapping_element
+
+      content_tag @wrapping_element, content
+    end
+
+    # This is a little shim to let us call the render methods below outside the
+    # usual component rendering cycle (for backward compatibility)
+    # @private
+    # @deprecated
+    def with_view_context(view_context)
+      @view_context = view_context
+      self
+    end
+
+    # Check if the downstream application has overridden these methods
+    # @deprecated
+    # @private
+    def overridden_helper_methods?
+      return false if explicit_component_configuration?
+
+      @view_context.method(:render_facet_item).owner != Blacklight::FacetsHelperBehavior ||
+        @view_context.method(:render_facet_value).owner != Blacklight::FacetsHelperBehavior ||
+        @view_context.method(:render_selected_facet_value).owner != Blacklight::FacetsHelperBehavior
+    end
+
+    # Call out to the helper method equivalent of this component
+    # @deprecated
+    # @private
+    def content_from_legacy_view_helper
+      Deprecation.warn('Calling out to the #render_facet_item helper for backwards compatibility.')
+      Deprecation.silence(Blacklight::FacetsHelperBehavior) do
+        @view_context.render_facet_item(@facet_item.facet_field, @facet_item.facet_item)
+      end
+    end
+
+    ##
+    # Standard display of a facet value in a list. Used in both _facets sidebar
+    # partial and catalog/facet expanded list. Will output facet value name as
+    # a link to add that to your restrictions, with count in parens.
+    #
+    # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
+    # @param [Blacklight::Solr::Response::Facets::FacetItem] item
+    # @param [Hash] options
+    # @option options [Boolean] :suppress_link display the facet, but don't link to it
+    # @return [String]
+    # @private
+    def render_facet_value
+      content_tag(:span, class: "facet-label") do
+        link_to_unless(@suppress_link, @label, @href, class: "facet-select")
+      end + render_facet_count
+    end
+
+    ##
+    # Standard display of a SELECTED facet value (e.g. without a link and with a remove button)
+    # @see #render_facet_value
+    # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
+    # @param [String] item
+    # @private
+    def render_selected_facet_value
+      content_tag(:span, class: "facet-label") do
+        content_tag(:span, @label, class: "selected") +
+          # remove link
+          link_to(@href, class: "remove") do
+            content_tag(:span, '✖', class: "remove-icon") +
+              content_tag(:span, '[remove]', class: 'sr-only')
+          end
+      end + render_facet_count(classes: ["selected"])
+    end
+
+    ##
+    # Renders a count value for facet limits. Can be over-ridden locally
+    # to change style. And can be called by plugins to get consistent display.
+    #
+    # @param [Integer] num number of facet results
+    # @param [Hash] options
+    # @option options [Array<String>]  an array of classes to add to count span.
+    # @return [String]
+    # @private
+    def render_facet_count(options = {})
+      return @view_context.render_facet_count(@hits, options) unless @view_context.method(:render_facet_count).owner == Blacklight::FacetsHelperBehavior || explicit_component_configuration?
+
+      classes = (options[:classes] || []) << "facet-count"
+      content_tag("span", t('blacklight.search.facets.count', number: number_with_delimiter(@hits)), class: classes)
+    end
+
+    private
+
+    def explicit_component_configuration?
+      @facet_item.facet_config.item_component.present?
+    end
+  end
+end