blacklight 8.0.0.beta5 → 8.0.0.beta6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e3c3bcd542b381b1d7e4c00c653ad1556d4bd2119e1372a3c8545acef980cff
-  data.tar.gz: 285b2f3e0cb5909d696ef91d110b8afcb6e62ca28c0c887cded18df16398c645
+  metadata.gz: ccd45650da142937ce72464e061e05ed63793c553e0d0676d139010dd218cb44
+  data.tar.gz: 5221c9746cf8c4168444c57ca18062be9a6cb95743a58ea53040056ccf8bdee9
 SHA512:
-  metadata.gz: 795eca6d0f26f1e9441d84f1ce7ced56f2f8b459f3ef41a5c34f5c293aab47c43c57e0147b8c57a4051f6be9f1442aea7696c586c4ab41f6b7aa70a0495a5de0
-  data.tar.gz: 00efe72d6d5fdeaf914d667cdd6ac2e278e7083ae6dc4cdaaf3db60a3f7df606617f2df2615fbc28840746404a94f072b1ff20df0c82095246e5869fa9b2abf9
+  metadata.gz: 6dc2e36331089bcd0404a3a34c3a8bf71d6fa103c19a65f7e94620e14ac41a5f8ccfe8c1b750a305bbb7db051c323a7410b693a137579073f776e65debd76c5b
+  data.tar.gz: fb238384ea2c98c6e442b6706c473766118e83e860d3d4509e45b4cd50e993e22da8f67b29d61b4f4a40e6a9502cb8b07f822129ff9f3348f6c5c40cd210ee66

data/.gitignore

@@ -17,3 +17,4 @@ pkg/*
 /spec/examples.txt
 node_modules/*
 package-lock.json
+/app/assets/javascripts/blacklight

data/Gemfile

@@ -32,10 +32,6 @@ else
     end
   end
 
-  unless ENV['VIEW_COMPONENT_VERSION'].to_s == ""
-    gem 'view_component', ENV.fetch('VIEW_COMPONENT_VERSION')
-  end
-
   case ENV['RAILS_VERSION'].to_s
   when /^(~> ?)?6\.0/
     gem 'sass-rails', '>= 6'

data/README.md

@@ -60,7 +60,7 @@ components in the gem are changed, this bundle should be rebuild with the
 following steps:
 1. [Install npm](https://www.npmjs.com/get-npm)
 1. run `npm install` to download dependencies
-1. run `npm run js-compile-bundle` to build the bundle
+1. run `npm run prepare` to build the bundle
 1. run `npm publish` to push the javascript package to https://npmjs.org/package/blacklight-frontend
 
 ## Using the javascript

data/Rakefile

@@ -10,6 +10,24 @@ end
 
 Bundler::GemHelper.install_tasks
 
+# Hook up our NPM tasks to the standard uild and release tasks
+Rake::Task['build'].enhance(['build:npm'])
+Rake::Task['release'].enhance(['release:npm'])
+
+# rubocop:disable Rails/RakeEnvironment
+desc 'build javascript assets'
+task 'build:npm' do
+  sh 'npm install'
+  sh 'npm run prepare'
+end
+
+desc "Publish javascript assets to npm\n" \
+     "To prevent publishing in NPM use e.g. `npm_push=no rake release`"
+task 'release:npm' do
+  sh 'npm publish' unless %w[n no nil false off 0].include?(ENV["npm_push"].to_s.downcase)
+end
+# rubocop:enable Rails/RakeEnvironment
+
 load "tasks/blacklight.rake"
 load "lib/railties/blacklight.rake"
 

data/VERSION

@@ -1 +1 @@
-8.0.0.beta5
+8.0.0.beta6

data/app/assets/config/blacklight/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../../images
+//= link_directory ../../stylesheets .css
+//= link_tree ../../../javascript .js

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

@@ -1,16 +1,36 @@
 .sidenav {
+  --bl-facets-smallish-padding: .25rem;
+  --bl-facets-smallish-border: var(--bs-border-width) solid var(--bs-border-color);
+  --bl-facets-smallish-margin-bottom: #{$spacer};
+  --bl-facets-smallish-border-radius: #{$border-radius};
+
   .navbar-toggler {
-    border-color: $navbar-light-toggler-border-color;
+    --bs-navbar-toggler-padding-x: #{$navbar-toggler-padding-x};
+    --bs-navbar-toggler-padding-y: #{$navbar-toggler-padding-y};
+    --bs-navbar-toggler-border-color: #{$navbar-light-toggler-border-color};
+    --bs-navbar-toggler-border-radius: #{$navbar-toggler-border-radius};
     color: $navbar-light-active-color;
 
     &:hover,
     &:focus {
       color: $navbar-light-active-color;
     }
-  }
 
-  .navbar-toggler-icon {
-    background-image: $navbar-light-toggler-icon-bg;
+    [data-hide-label] {
+      display: inline;
+    }
+    [data-show-label] {
+      display: none;
+    }
+
+    &[aria-expanded="false"] {
+      [data-hide-label] {
+        display: none;
+      }
+      [data-show-label] {
+        display: inline;
+      }
+    }
   }
 }
 
@@ -19,9 +39,16 @@
     $next: breakpoint-next($breakpoint, $grid-breakpoints);
     $infix: breakpoint-infix($breakpoint, $grid-breakpoints);
 
+
     &#{$infix} {
-      @include media-breakpoint-up($next) {
+      @include media-breakpoint-down($next) {
+        border: var(--bl-facets-smallish-border);
+        padding: var(--bl-facets-smallish-padding);
+        margin-bottom: var(--bl-facets-smallish-margin-bottom);
+        border-radius: var(--bl-facets-smallish-border-radius);
 
+      }
+      @include media-breakpoint-up($next) {
         // scss-lint:disable ImportantRule
         .facets-collapse {
           display: block !important;

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

@@ -14,4 +14,4 @@ $remove-icon-font-family: system-ui, -apple-system, "Segoe UI", Roboto, "Helveti
 
 $facet-active-border: $success !default;
 $facet-active-bg: $success !default;
-$facet-active-item-color: $success !default;
+$facet-active-item-color: $success !default;

data/app/components/blacklight/document_component.rb

@@ -3,7 +3,23 @@
 require 'view_component/version'
 
 module Blacklight
+  ##
+  # A component for rendering a single document
+  #
+  # @note when subclassing this component, you must explicitly specify the collection parameter
+  #    as `document` and handle the `document` parameter in your initializer.
+  #
+  # @example
+  #  class MyDocumentComponent < Blacklight::DocumentComponent
+  #    with_collection_parameter :document
+  #
+  #    def initialize(document:, **kwargs)
+  #      super(document: document, **kwargs)
+  #    end
+  #  end
   class DocumentComponent < Blacklight::Component
+    with_collection_parameter :document
+
     # ViewComponent 3 changes iteration counters to begin at 0 rather than 1
     COLLECTION_INDEX_OFFSET = ViewComponent::VERSION::MAJOR < 3 ? 0 : 1
 
@@ -63,6 +79,7 @@ module Blacklight
 
     # rubocop:disable Metrics/ParameterLists
     # @param document [Blacklight::DocumentPresenter]
+    # @param presenter [Blacklight::DocumentPresenter] alias for document
     # @param partials [Array, nil] view partial names that should be used to provide content for the `partials` slot
     # @param id [String] HTML id for the root element
     # @param classes [Array, String] additional HTML classes for the root element
@@ -72,11 +89,13 @@ module Blacklight
     # @param document_counter [Number, nil] provided by ViewComponent collection iteration
     # @param counter_offset [Number] the offset of the start of the collection counter parameter for the component to the overall result set
     # @param show [Boolean] are we showing only a single document (vs a list of search results); used for backwards-compatibility
-    def initialize(document: nil, partials: nil,
+    def initialize(document: nil, presenter: nil, partials: nil,
                    id: nil, classes: [], component: :article, title_component: nil,
                    counter: nil, document_counter: nil, counter_offset: 0,
                    show: false, **args)
-      @presenter = document || args[self.class.collection_parameter]
+      Blacklight.deprecation.warn('the `presenter` argument to DocumentComponent#initialize is deprecated; pass the `presenter` in as document instead') if presenter
+
+      @presenter = presenter || document || args[self.class.collection_parameter]
       @document = @presenter.document
       @view_partials = partials || []
 

data/app/components/blacklight/response/facet_group_component.html.erb

@@ -17,7 +17,8 @@
         expanded: 'false',
         label: t('blacklight.search.facets.group.toggle'),
       } do %>
-      <span class="navbar-toggler-icon"></span>
+      <span data-show-label><%= t('blacklight.search.facets.group.open') %></span>
+      <span data-hide-label><%= t('blacklight.search.facets.group.close') %></span>
     <% end %>
   </div>
 

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -37,9 +37,4 @@ module Blacklight::BlacklightHelperBehavior
     self.formats = old_formats
     nil
   end
-
-  # @return [Class]
-  def search_bar_presenter_class
-    blacklight_config.view_config(action_name: :index).search_bar_presenter_class
-  end
 end

data/app/javascript/blacklight/bookmark_toggle.js

@@ -1,19 +1,12 @@
-import Blacklight from './core'
-import CheckboxSubmit from './checkbox_submit'
+import CheckboxSubmit from 'blacklight/checkbox_submit'
 
-const BookmarkToggle = (() => {
-    // change form submit toggle to checkbox
-    Blacklight.doBookmarkToggleBehavior = function() {
-      document.addEventListener('click', (e) => {
-        if (e.target.matches('[data-checkboxsubmit-target="checkbox"]')) {
-          const form = e.target.closest('form')
-          if (form) new CheckboxSubmit(form).clicked(e);
-        }
-      });
-    };
-    Blacklight.doBookmarkToggleBehavior.selector = 'form.bookmark-toggle';
+const BookmarkToggle = (e) => {
+  if (e.target.matches('[data-checkboxsubmit-target="checkbox"]')) {
+    const form = e.target.closest('form')
+    if (form) new CheckboxSubmit(form).clicked(e);
+  }
+};
 
-    Blacklight.doBookmarkToggleBehavior();
-})()
+document.addEventListener('click', BookmarkToggle);
 
 export default BookmarkToggle

data/app/javascript/blacklight/button_focus.js

@@ -1,12 +1,12 @@
-const ButtonFocus = (() => {
-  document.addEventListener('click', (e) => {
-    // Button clicks should change focus. As of 10/3/19, Firefox for Mac and
-    // Safari both do not set focus to a button on button click.
-    // See https://zellwk.com/blog/inconsistent-button-behavior/ for background information
-    if (e.target.matches('[data-toggle="collapse"]') || e.target.matches('[data-bs-toggle="collapse"]')) {
-      e.target.focus()
-    }
-  })
-})()
+const ButtonFocus = (e) => {
+  // Button clicks should change focus. As of 10/3/19, Firefox for Mac and
+  // Safari both do not set focus to a button on button click.
+  // See https://zellwk.com/blog/inconsistent-button-behavior/ for background information
+  if (e.target.matches('[data-toggle="collapse"]') || e.target.matches('[data-bs-toggle="collapse"]')) {
+    e.target.focus()
+  }
+}
+
+document.addEventListener('click', ButtonFocus)
 
 export default ButtonFocus

data/app/javascript/blacklight/index.js

@@ -1,8 +1,8 @@
-import BookmarkToggle from './bookmark_toggle'
-import ButtonFocus from './button_focus'
-import Modal from './modal'
-import SearchContext from './search_context'
-import Core from './core'
+import BookmarkToggle from 'blacklight/bookmark_toggle'
+import ButtonFocus from 'blacklight/button_focus'
+import Modal from 'blacklight/modal'
+import SearchContext from 'blacklight/search_context'
+import Core from 'blacklight/core'
 
 export default {
   BookmarkToggle,

data/app/javascript/blacklight/modal.js

@@ -52,17 +52,10 @@
   can be a turbo-stream that defines some HTML fragementsand where on the page to put them:
   https://turbo.hotwired.dev/handbook/streams
 */
-import Blacklight from './core'
-import ModalForm from './modalForm'
+import ModalForm from 'blacklight/modalForm'
 
 const Modal = (() => {
-  // We keep all our data in Blacklight.modal object.
-  // Create lazily if someone else created first.
-  if (Blacklight.modal === undefined) {
-    Blacklight.modal = {};
-  }
-
-  const modal = Blacklight.modal
+  const modal = {}
 
   // a Bootstrap modal div that should be already on the page hidden
   modal.modalSelector = '#blacklight-modal';
@@ -147,20 +140,22 @@ const Modal = (() => {
   };
 
   modal.hide = function (el) {
-    const dom = document.querySelector(Blacklight.modal.modalSelector)
+    const dom = document.querySelector(modal.modalSelector)
 
     if (!dom.open) return
     dom.close()
   }
 
   modal.show = function(el) {
-    const dom = document.querySelector(Blacklight.modal.modalSelector)
+    const dom = document.querySelector(modal.modalSelector)
 
     if (dom.open) return
     dom.showModal()
   }
 
   modal.setupModal()
+
+  return modal;
 })()
 
 export default Modal

data/app/javascript/blacklight/search_context.js

@@ -1,59 +1,53 @@
-import Blacklight from './core'
-
-const SearchContext = (() => {
-  Blacklight.doSearchContextBehavior = function() {
-    document.addEventListener('click', (e) => {
-      if (e.target.matches('[data-context-href]')) {
-        Blacklight.handleSearchContextMethod.call(e.target, e)
-      }
-    })
-  };
-
-  Blacklight.csrfToken = () => document.querySelector('meta[name=csrf-token]')?.content
-  Blacklight.csrfParam = () => document.querySelector('meta[name=csrf-param]')?.content
-
-  // this is the Rails.handleMethod with a couple adjustments, described inline:
-  // first, we're attaching this directly to the event handler, so we can check for meta-keys
-  Blacklight.handleSearchContextMethod = function(event) {
-    const link = this
-
-    // instead of using the normal href, we need to use the context href instead
-    let href = link.getAttribute('data-context-href')
-    let target = link.getAttribute('target')
-    let csrfToken = Blacklight.csrfToken()
-    let csrfParam = Blacklight.csrfParam()
-    let form = document.createElement('form')
-    form.method = 'post'
-    form.action = href
-
-
-    let formContent = `<input name="_method" value="post" type="hidden" />
-      <input name="redirect" value="${link.getAttribute('href')}" type="hidden" />`
-
-    // check for meta keys.. if set, we should open in a new tab
-    if(event.metaKey || event.ctrlKey) {
-      target = '_blank';
-    }
-
-    if (csrfParam !== undefined && csrfToken !== undefined) {
-      formContent += `<input name="${csrfParam}" value="${csrfToken}" type="hidden" />`
-    }
-
-    // Must trigger submit by click on a button, else "submit" event handler won't work!
-    // https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit
-    formContent += '<input type="submit" />'
-
-    if (target) { form.setAttribute('target', target); }
-
-    form.style.display = 'none'
-    form.innerHTML = formContent
-    document.body.appendChild(form)
-    form.querySelector('[type="submit"]').click()
-
-    event.preventDefault()
-  };
-
-  Blacklight.doSearchContextBehavior();
-})()
+const SearchContext = (e) => {
+  if (e.target.matches('[data-context-href]')) {
+    SearchContext.handleSearchContextMethod.call(e.target, e)
+  }
+}
+
+SearchContext.csrfToken = () => document.querySelector('meta[name=csrf-token]')?.content
+SearchContext.csrfParam = () => document.querySelector('meta[name=csrf-param]')?.content
+
+// this is the Rails.handleMethod with a couple adjustments, described inline:
+// first, we're attaching this directly to the event handler, so we can check for meta-keys
+SearchContext.handleSearchContextMethod = function(event) {
+  const link = this
+
+  // instead of using the normal href, we need to use the context href instead
+  let href = link.getAttribute('data-context-href')
+  let target = link.getAttribute('target')
+  let csrfToken = SearchContext.csrfToken()
+  let csrfParam = SearchContext.csrfParam()
+  let form = document.createElement('form')
+  form.method = 'post'
+  form.action = href
+
+
+  let formContent = `<input name="_method" value="post" type="hidden" />
+    <input name="redirect" value="${link.getAttribute('href')}" type="hidden" />`
+
+  // check for meta keys.. if set, we should open in a new tab
+  if(event.metaKey || event.ctrlKey) {
+    target = '_blank';
+  }
+
+  if (csrfParam !== undefined && csrfToken !== undefined) {
+    formContent += `<input name="${csrfParam}" value="${csrfToken}" type="hidden" />`
+  }
+
+  // Must trigger submit by click on a button, else "submit" event handler won't work!
+  // https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit
+  formContent += '<input type="submit" />'
+
+  if (target) { form.setAttribute('target', target); }
+
+  form.style.display = 'none'
+  form.innerHTML = formContent
+  document.body.appendChild(form)
+  form.querySelector('[type="submit"]').click()
+
+  event.preventDefault()
+};
+
+document.addEventListener('click', SearchContext)
 
 export default SearchContext

data/app/models/concerns/blacklight/document.rb

@@ -31,6 +31,17 @@ module Blacklight::Document
     class_attribute :inspector_fields, default: [:_source]
   end
 
+  Email = Module.new do
+    def self.included(mod)
+      Blacklight.deprecation.warn("Blacklight::Document::Email is deprecated and will be removed (included in #{mod}).")
+    end
+  end
+  Sms = Module.new do
+    def self.included(mod)
+      Blacklight.deprecation.warn("Blacklight::Document::Sms is deprecated and will be removed (included in #{mod}).")
+    end
+  end
+
   attr_reader :response, :_source
   alias_method :solr_response, :response
 

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

@@ -1,4 +1,4 @@
 <% # container for a single doc -%>
-<% view_config = local_assigns[:view_config] || blacklight_config.view_config(document_index_view_type) %>
-<% document_component = blacklight_config.view_config(:show).document_component -%>
+<% view_config = local_assigns[:view_config] || blacklight_config.view_config(document_index_view_type, action_name: action_name) %>
+<% document_component = view_config.document_component -%>
 <%= render document_component.new(document_component.collection_parameter => document_presenter(document), counter: document_counter_with_offset(document_counter), partials: view_config&.partials) %>

data/app/views/layouts/blacklight/base.html.erb

@@ -19,16 +19,16 @@
       <%= javascript_importmap_tags %>
     <% elsif defined? Propshaft %>
       <%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>
-    <% else %>    
+    <% else %>
       <%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>
       <%= javascript_include_tag "blacklight/blacklight", type: 'module' %>
+      <script type="module">
+        import githubAutoCompleteElement from 'https://cdn.skypack.dev/@github/auto-complete-element';
+      </script>
     <% end %>
 
     <%= csrf_meta_tags %>
     <%= content_for(:head) %>
-    <script type="module">
-      import githubAutoCompleteElement from 'https://cdn.skypack.dev/@github/auto-complete-element';
-    </script>
   </head>
   <body class="<%= render_body_class %>">
     <nav id="skip-link" role="navigation" aria-label="<%= t('blacklight.skip_links.label') %>">

data/blacklight.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
     full text and/or metadata.)
   s.license     = "Apache 2.0"
 
-  s.files         = `git ls-files -z`.split("\x0")
+  s.files         = `git ls-files -z`.split("\x0") + Dir.glob("app/assets/javascript/blacklight/**/*")
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.bindir        = 'exe'
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/config/importmap.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-pin_all_from File.expand_path("../app/javascript/blacklight", __dir__)
+pin_all_from File.expand_path("../app/javascript/blacklight", __dir__), under: "blacklight"