blacklight 7.33.0 → 8.0.0

data/lib/generators/blacklight/assets/propshaft_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Assets
+    class PropshaftGenerator < Rails::Generators::Base
+      def add_package
+        if ENV['CI']
+          run "yarn add blacklight-frontend:#{Blacklight::Engine.root}"
+        else
+          run 'yarn add blacklight-frontend'
+        end
+      end
+
+      def add_third_party_packages
+        run 'yarn add @github/auto-complete-element'
+      end
+
+      def add_package_assets
+        append_to_file 'app/assets/stylesheets/application.bootstrap.scss' do
+          <<~CONTENT
+            @import "blacklight-frontend/app/assets/stylesheets/blacklight/blacklight";
+          CONTENT
+        end
+
+        append_to_file 'app/javascript/application.js' do
+          <<~CONTENT
+            import Blacklight from "blacklight-frontend";
+            import githubAutoCompleteElement from "@github/auto-complete-element";
+          CONTENT
+        end
+      end
+    end
+  end
+end

data/lib/generators/blacklight/assets/sprockets_generator.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Assets
+    class SprocketsGenerator < Rails::Generators::Base
+      class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 5.1'), desc: "Set the generated app's bootstrap version"
+
+      # This could be skipped if you want to use webpacker
+      def add_javascript_dependencies
+        gem 'bootstrap', options[:'bootstrap-version'].presence
+        gem 'jquery-rails' if bootstrap_4? # Bootstrap 4 has a dependency on jquery
+      end
+
+      ##
+      # Remove the empty generated app/assets/images directory. Without doing this,
+      # the default Sprockets 4 manifest will raise an exception.
+      def appease_sprockets4
+        return if Rails.version > '7' || Sprockets::VERSION < '4'
+
+        append_to_file 'app/assets/config/manifest.js', "\n//= link application.js"
+        append_to_file 'app/assets/config/manifest.js', "\n//= link blacklight/manifest.js"
+        empty_directory 'app/assets/images'
+      end
+
+      def assets
+        create_file 'app/assets/stylesheets/blacklight.scss' do
+          <<~CONTENT
+            @import 'bootstrap';
+            @import 'blacklight/blacklight';
+          CONTENT
+        end
+
+        gem "sassc-rails", "~> 2.1" if Rails.version > '7'
+
+        # Ensure this method is idempotent
+        return if has_blacklight_assets?
+
+        create_file 'app/assets/javascripts/application.js' do
+          <<~CONTENT
+            //= require rails-ujs
+            #{'//= require jquery3' if bootstrap_4?}
+
+            // Required by Blacklight
+            //= require popper
+            //= require bootstrap
+            //= require blacklight/blacklight
+          CONTENT
+        end
+      end
+
+      private
+
+      def bootstrap_4?
+        options[:'bootstrap-version'].match?(/\A[^0-9]*4\./)
+      end
+
+      def has_blacklight_assets?
+        application_js.include?('blacklight/blacklight')
+      end
+
+      def application_js
+        path = File.expand_path("app/assets/javascripts/application.js", destination_root)
+
+        File.exist?(path) ? File.read(path) : ''
+      end
+    end
+  end
+end

data/lib/generators/blacklight/assets_generator.rb

@@ -1,97 +1,23 @@
 # frozen_string_literal: true
-module Blacklight
-  class Assets < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
-
-    class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 4.0'), desc: "Set the generated app's bootstrap version"
-
-    # This could be skipped if you want to use webpacker
-    def add_javascript_dependencies
-      gem 'bootstrap', options[:'bootstrap-version']
-      gem 'twitter-typeahead-rails', '0.11.1.pre.corejavascript'
-    end
-
-    def appease_rails7
-      return unless Rails.version > '7'
-
-      gem "sassc-rails", "~> 2.1"
-    end
-
-    # Add sprockets javascript if needed
-    def create_sprockets_javascript
-      # Rails 5 already has an application.js file
-      return if Rails.version < '6'
-
-      create_file 'app/assets/javascripts/application.js' do
-        <<~CONTENT
-          //= require jquery3
-          //= require rails-ujs
-          #{'//= require turbolinks' if Rails.version < '7'}
-        CONTENT
-      end
-    end
-
-    ##
-    # Remove the empty generated app/assets/images directory. Without doing this,
-    # the default Sprockets 4 manifest will raise an exception.
-    def appease_sprockets4
-      return if !defined?(Sprockets::VERSION) || Sprockets::VERSION < '4' || using_importmap?
-
-      append_to_file 'app/assets/config/manifest.js', "\n//= link application.js"
-      empty_directory 'app/assets/images'
-    end
-
-    def assets
-      copy_file "blacklight.scss", "app/assets/stylesheets/blacklight.scss"
 
-      # Ensure this method is idempotent
-      return if has_blacklight_assets?
+require 'shellwords'
 
-      gem 'jquery-rails'
-      contents = "\n//\n// Required by Blacklight\n"
-      contents += "//= require popper\n"
-      contents += "// Twitter Typeahead for autocomplete\n"
-      contents += "//= require twitter/typeahead\n"
-      contents += "//= require bootstrap\n"
-      contents += "//= require blacklight/blacklight\n"
-
-      marker = if turbolinks?
-                 '//= require turbolinks'
-               else
-                 '//= require rails-ujs'
-               end
-
-      insert_into_file "app/assets/javascripts/application.js", after: marker do
-        contents
-      end
-
-      insert_into_file "app/assets/javascripts/application.js", before: '//= require rails-ujs' do
-        "//= require jquery3\n"
-      end
-    end
-
-    private
-
-    def root
-      @root ||= Pathname(destination_root)
-    end
-
-    def using_importmap?
-      @using_importmap ||= root.join('config/importmap.rb').exist?
-    end
-
-    def turbolinks?
-      @turbolinks ||= application_js.include?('turbolinks')
-    end
+module Blacklight
+  class AssetsGenerator < Rails::Generators::Base
+    class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 5.1'), desc: "Set the generated app's bootstrap version"
 
-    def has_blacklight_assets?
-      application_js.include?('blacklight/blacklight')
-    end
+    def run_asset_pipeline_specific_generator
+      generated_options = "--bootstrap-version='#{Shellwords.escape(options[:'bootstrap-version'])}'" if options[:'bootstrap-version']
 
-    def application_js
-      path = File.expand_path("app/assets/javascripts/application.js", destination_root)
+      generator = if defined?(Propshaft)
+                    'blacklight:assets:propshaft'
+                  elsif defined?(Importmap)
+                    'blacklight:assets:importmap'
+                  elsif defined?(Sprockets)
+                    'blacklight:assets:sprockets'
+                  end
 
-      File.exist?(path) ? File.read(path) : ''
+      generate generator, generated_options if generator
     end
   end
 end

data/lib/generators/blacklight/controller_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   class ControllerGenerator < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
@@ -16,8 +17,8 @@ module Blacklight
     def inject_blacklight_controller_behavior
       inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
         "  # Adds a few additional behaviors into the application controller\n" \
-        "  include Blacklight::Controller\n" \
-        "  layout :determine_layout if respond_to? :layout\n\n"
+          "  include Blacklight::Controller\n" \
+          "  layout :determine_layout if respond_to? :layout\n\n"
       end
     end
 

data/lib/generators/blacklight/document_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rails/generators'
 
 module Blacklight

data/lib/generators/blacklight/install_generator.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+
+require 'shellwords'
+
 module Blacklight
   class Install < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
@@ -11,7 +14,7 @@ module Blacklight
     class_option :devise, type: :boolean, default: false, aliases: "-d", desc: "Use Devise as authentication logic."
     class_option :marc, type: :boolean, default: false, aliases: "-m", desc: "Generate MARC-based demo."
     class_option :'bootstrap-version', type: :string, default: nil, desc: "Set the generated app's bootstrap version"
-    class_option :'skip-assets', type: :boolean, default: !defined?(Sprockets), desc: "Skip generating javascript and css assets into the application"
+    class_option :'skip-assets', type: :boolean, default: false, desc: "Skip generating javascript and css assets into the application"
     class_option :'skip-solr', type: :boolean, default: false, desc: "Skip generating solr configurations."
 
     desc <<-EOS
@@ -34,14 +37,14 @@ module Blacklight
     # Call external generator in AssetsGenerator, so we can
     # leave that callable seperately too.
     def copy_public_assets
-      generated_options = "--bootstrap-version #{options[:'bootstrap-version']}" if options[:'bootstrap-version']
+      generated_options = "--bootstrap-version='#{Shellwords.escape(options[:'bootstrap-version'])}'" if options[:'bootstrap-version']
 
       generate "blacklight:assets", generated_options unless options[:'skip-assets']
     end
 
     def bundle_install
       inside destination_root do
-        Bundler.with_clean_env do
+        Bundler.with_unbundled_env do
           run "bundle install"
         end
       end
@@ -84,7 +87,7 @@ module Blacklight
       return unless options[:marc]
 
       blacklight_marc = String.new('blacklight-marc')
-      gem blacklight_marc, '>= 7.0.0.rc1', '< 8'
+      gem blacklight_marc, '~> 8.0'
 
       bundle_install
 

data/lib/generators/blacklight/models_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/migration'
 require 'blacklight/version'

data/lib/generators/blacklight/search_builder_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rails/generators'
 
 module Blacklight

data/lib/generators/blacklight/solr_generator.rb

@@ -36,7 +36,7 @@ module Blacklight
 
     def bundle_install
       inside destination_root do
-        Bundler.with_clean_env do
+        Bundler.with_unbundled_env do
           run "bundle install"
         end
       end

data/lib/generators/blacklight/templates/catalog_controller.rb

@@ -5,7 +5,16 @@ class <%= controller_name.classify %>Controller < ApplicationController
 
   include Blacklight::Catalog
 
+  # If you'd like to handle errors returned by Solr in a certain way,
+  # you can use Rails rescue_from with a method you define in this controller,
+  # uncomment:
+  #
+  # rescue_from Blacklight::Exceptions::InvalidRequest, with: :my_handling_method
+
   configure_blacklight do |config|
+    ## Specify the style of markup to be generated (may be 4 or 5)
+    # config.bootstrap_version = 5
+    #
     ## Class for sending and receiving requests from a search index
     # config.repository_class = Blacklight::Solr::Repository
     #
@@ -15,6 +24,9 @@ class <%= controller_name.classify %>Controller < ApplicationController
     ## Model that maps search index responses to the blacklight response model
     # config.response_model = Blacklight::Solr::Response
     #
+    ## The destination for the link around the logo in the header
+    # config.logo_link = root_path
+    #
     ## Should the raw solr document endpoint (e.g. /catalog/:id/raw) be enabled
     # config.raw_endpoint.enabled = false
 
@@ -32,16 +44,26 @@ class <%= controller_name.classify %>Controller < ApplicationController
 
     # solr field configuration for search results/index views
     config.index.title_field = 'title_tsim'
-    #config.index.display_type_field = 'format'
-    #config.index.thumbnail_field = 'thumbnail_path_ss'
+    # config.index.display_type_field = 'format'
+    # config.index.thumbnail_field = 'thumbnail_path_ss'
+
+    # The presenter is the view-model class for the page
+    # config.index.document_presenter_class = MyApp::IndexPresenter
 
-    config.add_results_document_tool(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
+    # Some components can be configured
+    # config.index.document_component = MyApp::SearchResultComponent
+    # config.index.constraints_component = MyApp::ConstraintsComponent
+    # config.index.search_bar_component = MyApp::SearchBarComponent
+    # config.index.search_header_component = MyApp::SearchHeaderComponent
+    # config.index.document_actions.delete(:bookmark)
+
+    config.add_results_document_tool(:bookmark, component: Blacklight::Document::BookmarkComponent, if: :render_bookmarks_control?)
 
     config.add_results_collection_tool(:sort_widget)
     config.add_results_collection_tool(:per_page_widget)
     config.add_results_collection_tool(:view_type_group)
 
-    config.add_show_tools_partial(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
+    config.add_show_tools_partial(:bookmark, component: Blacklight::Document::BookmarkComponent, if: :render_bookmarks_control?)
     config.add_show_tools_partial(:email, callback: :email_action, validator: :validate_email_params)
     config.add_show_tools_partial(:sms, if: :render_sms_action?, callback: :sms_action, validator: :validate_sms_params)
     config.add_show_tools_partial(:citation)
@@ -50,9 +72,17 @@ class <%= controller_name.classify %>Controller < ApplicationController
     config.add_nav_action(:search_history, partial: 'blacklight/nav/search_history')
 
     # solr field configuration for document/show views
-    #config.show.title_field = 'title_tsim'
-    #config.show.display_type_field = 'format'
-    #config.show.thumbnail_field = 'thumbnail_path_ss'
+    # config.show.title_field = 'title_tsim'
+    # config.show.display_type_field = 'format'
+    # config.show.thumbnail_field = 'thumbnail_path_ss'
+    #
+    # The presenter is a view-model class for the page
+    # config.show.document_presenter_class = MyApp::ShowPresenter
+    #
+    # These components can be configured
+    # config.show.document_component = MyApp::DocumentComponent
+    # config.show.sidebar_component = MyApp::SidebarComponent
+    # config.show.embed_component = MyApp::EmbedComponent
 
     # solr fields that will be treated as facets by the blacklight application
     #   The ordering of the field names is the order of the display

data/lib/generators/blacklight/templates/solr_document.rb

@@ -1,17 +1,11 @@
 # frozen_string_literal: true
 
-# Represent a single document returned from Solr
+# Represents a single document returned from Solr
 class <%= model_name.classify %>
   include Blacklight::Solr::Document
 
   # self.unique_key = 'id'
 
-  # Email uses the semantic field mappings below to generate the body of an email.
-  SolrDocument.use_extension(Blacklight::Document::Email)
-
-  # SMS uses the semantic field mappings below to generate the body of an SMS email.
-  SolrDocument.use_extension(Blacklight::Document::Sms)
-
   # DublinCore uses the semantic field mappings below to assemble an OAI-compliant Dublin Core document
   # Semantic mappings of solr stored fields. Fields may be multi or
   # single valued. See Blacklight::Document::SemanticFields#field_semantics

data/lib/generators/blacklight/test_support_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copy Blacklight test support material in place
 
 # Need the requires here so we can call the generator from environment.rb
@@ -41,9 +42,10 @@ module Blacklight
     end
 
     def configure_action_mailer
-      insert_into_file "config/environments/test.rb", after: "config.action_mailer.delivery_method = :test\n" do <<-EOF
+      insert_into_file "config/environments/test.rb", after: "config.action_mailer.delivery_method = :test\n" do
+        <<-EOF
          config.action_mailer.default_options = {from: 'no-reply@example.org'}
-      EOF
+        EOF
       end
     end
   end

data/lib/generators/blacklight/user_generator.rb

@@ -25,7 +25,7 @@ module Blacklight
       gem "devise-guests", "~> 0.8"
 
       inside destination_root do
-        Bundler.with_clean_env do
+        Bundler.with_unbundled_env do
           run "bundle install"
         end
       end
@@ -36,12 +36,10 @@ module Blacklight
 
       # add the #to_s to the model.
       insert_into_file("app/models/#{model_name}.rb", before: /end(\n| )*$/) do
-        "\n  # Method added by Blacklight; Blacklight uses #to_s on your\n" \
-        "  # user class to get a user-displayable login/identifier for\n" \
-        "  # the account.\n" \
-        "  def to_s\n" \
-        "    email\n" \
-        "  end\n"
+        "\n  # Configuration added by Blacklight; Blacklight::User uses a method key on your\n" \
+          "  # user class to get a user-displayable login/identifier for\n" \
+          "  # the account.\n" \
+          "  self.string_display_key ||= :email\n"
       end
       gsub_file("config/initializers/devise.rb", "config.sign_out_via = :delete", "config.sign_out_via = :get")
     end
@@ -52,10 +50,10 @@ module Blacklight
       if File.exist?(File.expand_path(file_path, destination_root))
         inject_into_class file_path, model_name.classify do
           "\n  # Connects this user object to Blacklights Bookmarks." \
-          "\n  include Blacklight::User\n"
+            "\n  include Blacklight::User\n"
         end
       else
-        say_status "warning", <<-EOS.strip_heredoc, :yellow
+        say_status "warning", <<~EOS, :yellow
           Blacklight authenticated user functionality not installed, as a user model
           could not be found at /app/models/user.rb. If you used a different name,
           please re-run the migration and provide that name as an argument. E.g.:

data/lib/railties/blacklight.rake

@@ -19,9 +19,8 @@ namespace :blacklight do
     task seed: [:environment] do
       require 'yaml'
 
-      app_file = Rails.root && Rails.root + 'spec/fixtures/sample_solr_documents.yml'
-      file = ENV['FILE'] ||
-             (app_file && File.exist?(app_file) && app_file) ||
+      app_file = Rails.root && "#{Rails.root}spec/fixtures/sample_solr_documents.yml"
+      file = ENV.fetch('FILE') { (app_file && File.exist?(app_file) && app_file) } ||
              File.join(Blacklight.root, 'spec', 'fixtures', 'sample_solr_documents.yml')
       docs = YAML.safe_load(File.open(file))
       conn = Blacklight.default_index.connection

data/package.json

@@ -1,10 +1,11 @@
 {
   "name": "blacklight-frontend",
-  "version": "7.32.0",
+  "version": "8.0.0",
   "description": "[![Build Status](https://travis-ci.com/projectblacklight/blacklight.png?branch=main)](https://travis-ci.com/projectblacklight/blacklight) [![Gem Version](https://badge.fury.io/rb/blacklight.png)](http://badge.fury.io/rb/blacklight) [![Coverage Status](https://coveralls.io/repos/github/projectblacklight/blacklight/badge.svg?branch=main)](https://coveralls.io/github/projectblacklight/blacklight?branch=main)",
   "main": "app/assets/javascripts/blacklight",
+  "module": "app/assets/javascripts/blacklight/blacklight.esm.js",
   "scripts": {
-    "js-compile-bundle": "shx cat app/javascript/blacklight/core.js app/javascript/blacklight/autocomplete.js app/javascript/blacklight/bookmark_toggle.js app/javascript/blacklight/button_focus.js app/javascript/blacklight/checkbox_submit.js app/javascript/blacklight/facet_load.js app/javascript/blacklight/modal.js app/javascript/blacklight/search_context.js | shx sed \"s/^(import|export).*//\" | babel --filename app/javascript/blacklight/blacklight.js > app/assets/javascripts/blacklight/blacklight.js"
+    "prepare": "rollup --config rollup.config.js --sourcemap && ESM=true rollup --config rollup.config.js --sourcemap"
   },
   "repository": {
     "type": "git",
@@ -21,15 +22,14 @@
   },
   "homepage": "https://github.com/projectblacklight/blacklight#readme",
   "devDependencies": {
-    "@babel/cli": "^7.2.3",
-    "@babel/core": "^7.2.3",
-    "@babel/preset-env": "^7.16.0",
-    "shx": "^0.3.2"
+    "rollup": "^2.60.0",
+    "rollup-plugin-includepaths": "^0.2.4"
   },
-  "browserslist": "> 0.25%, not dead",
+  "browserslist": [
+    "defaults",
+    "not IE 11"
+  ],
   "dependencies": {
-    "bootstrap": ">=4.3.1 <6.0.0",
-    "jquery": "^3.5.1",
-    "typeahead.js": "^0.11.1"
+    "bootstrap": ">=4.3.1 <6.0.0"
   }
 }

data/rollup.config.js

@@ -0,0 +1,37 @@
+'use strict'
+
+import includePaths from 'rollup-plugin-includepaths';
+
+const path = require('path')
+
+const BUNDLE = process.env.BUNDLE === 'true'
+const ESM = process.env.ESM === 'true'
+
+const fileDest = `blacklight${ESM ? '.esm' : ''}`
+const external = []
+const globals = {}
+
+let includePathOptions = {
+  include: {},
+  paths: ['app/javascript'],
+  external: [],
+  extensions: ['.js']
+};
+
+const rollupConfig = {
+  input: path.resolve(__dirname, `app/javascript/blacklight/index.js`),
+  output: {
+    file: path.resolve(__dirname, `app/assets/javascripts/blacklight/${fileDest}.js`),
+    format: ESM ? 'esm' : 'umd',
+    globals,
+    generatedCode: 'es2015'
+  },
+  external,
+  plugins: [includePaths(includePathOptions)]
+}
+
+if (!ESM) {
+  rollupConfig.output.name = 'Blacklight'
+}
+
+module.exports = rollupConfig

data/spec/components/blacklight/constraints_component_spec.rb

@@ -13,13 +13,21 @@ RSpec.describe Blacklight::ConstraintsComponent, type: :component do
 
   let(:blacklight_config) do
     Blacklight::Configuration.new.configure do |config|
-      config.add_facet_field 'some_facet'
+      config.add_facet_field :some_facet
     end
   end
 
   let(:search_state) { Blacklight::SearchState.new(query_params.with_indifferent_access, blacklight_config) }
   let(:query_params) { {} }
 
+  context 'with no constraints' do
+    describe '#render?' do
+      it 'is false' do
+        expect(component.render?).to be false
+      end
+    end
+  end
+
   context 'with a query' do
     let(:query_params) { { q: 'some query' } }
 
@@ -43,21 +51,17 @@ RSpec.describe Blacklight::ConstraintsComponent, type: :component do
   context 'with a facet' do
     let(:query_params) { { f: { some_facet: ['some value'] } } }
 
-    before do
-      controller.blacklight_config.configure do |config|
-        config.add_facet_field :some_facet
-      end
+    it 'renders the query' do
+      expect(rendered).to have_selector('.constraint-value > .filter-name', text: 'Some Facet').and(have_selector('.constraint-value > .filter-value', text: 'some value'))
     end
 
-    # this has to be cleaned up to prevent leaking class configuration
-    after do
-      controller.blacklight_config.configure do |config|
-        config['facet_fields'].delete('some_facet')
-      end
-    end
+    context 'that is not configured' do
+      let(:query_params) { { f: { some_facet: ['some value'], missing: ['another value'] } } }
 
-    it 'renders the query' do
-      expect(rendered).to have_selector('.constraint-value > .filter-name', text: 'Some Facet').and(have_selector('.constraint-value > .filter-value', text: 'some value'))
+      it 'renders only the configured constraints' do
+        expect(rendered).to have_selector('.constraint-value > .filter-name', text: 'Some Facet').and(have_selector('.constraint-value > .filter-value', text: 'some value'))
+        expect(rendered).not_to have_selector('.constraint-value > .filter-name', text: 'Missing')
+      end
     end
   end