blacklight 8.0.0.beta1 → 8.0.0

data/config/locales/blacklight.zh.yml

@@ -1,240 +1,221 @@
+---
 zh:
-  views:
-    pagination:
-      first: '« 首页'
-      last: '末页 »'
-      previous: '« 上一页'
-      next: '下一页 »'
-      truncate: '…'
-      aria:
-        container_label: 分页链接
-        current_page: 当前页面，页面%{page}
-        go_to_page: 前往页面%{page}
-        go_to_previous_page: 转到上一页
-        go_to_next_page: 转到下一页
-        go_to_first_page: 转到第一页
-        go_to_last_page: 转到最后一页
-
-    pagination_compact:
-      previous: '« 上一页'
-      next: '下一页 »'
-
   blacklight:
-    application_name: 'Blacklight'
-    skip_links:
-      label: '跳过链接'
-      main_content: '转到主要内容'
-      search_field: '转到搜索'
-      first_result: '转到第一个搜索结果'
-    header_links:
-      login: '登陆'
-      logout: '注销'
-      bookmarks: '书签'
-      search_history: '搜索历史'
-
-    welcome: '欢迎!'
-    and: '和'
-    or: '或'
-
-    modal:
-      close: "关闭"
-
+    and: 和
+    application_name: Blacklight
+    back_to_bookmarks: 返回书签页面
+    back_to_search: 返回搜索页面
     bookmarks:
-      title: '书签'
-      page_title: '书签 - %{application_name}'
-      no_bookmarks: '你还没有任何书签'
       add:
-        button: '书签'
+        button: 书签
+        failure: 抱歉，保存书签时出错。
         success:
-          one: '成功添加书签。'
-          other: '成功添加书签。'
-        failure:  '抱歉，保存书签时出错。'
-      remove:
-        button: '删除书签'
-        success: '成功删除书签。'
-        failure: '抱歉，删除书签时出错。'
-        action_confirm: '删除这个书签？'
-      clear:
-        action_title: '清除书签'
-        action_confirm: '清除所有书签？'
-        success: '已经清除了所有书签。'
-        failure: '抱歉，清除书签时出错。'
-      need_login: '登陆后才能访问你的书签功能。'
-      list_title: '你的书签'
-      delete: '删除'
-
-    search_history:
+          one: 成功添加书签。
+          other: 成功添加书签。
       clear:
-        action_title: '清除搜索历史'
-        action_confirm: '清除搜索历史？'
-        success: '已经清除搜索历史。'
-        failure: '清除搜索历史时出错。'
-      title: ''
-      page_title: '搜索历史 - %{application_name}'
-      no_history: '你没有任何搜索历史'
-      recent: '你最近搜索历史'
-      forget: '去除'
-      save: '保存'
-
-    tools:
-      title: '工具'
-      citation: '引用'
-      email: '电子邮件'
-      sms: '发送短信'
-      clear: '清除'
-
+        action_confirm: 清除所有书签？
+        action_title: 清除书签
+        failure: 抱歉，清除书签时出错。
+        success: 已经清除了所有书签。
+      delete: 删除
+      list_title: 你的书签
+      need_login: 登陆后才能访问你的书签功能。
+      no_bookmarks: 你还没有任何书签
+      page_title: 书签 - %{application_name}
+      remove:
+        action_confirm: 删除这个书签？
+        button: 删除书签
+        failure: 抱歉，删除书签时出错。
+        success: 成功删除书签。
+      title: 书签
     citation:
-      mla: 'MLA'
-      apa: 'APA'
-      chicago: 'Chicago'
-
+      apa: APA
+      chicago: Chicago
+      mla: MLA
+    did_you_mean: 你是要输入： %{options} 吗？
     email:
+      errors:
+        to:
+          blank: 请输入电子邮件接收人才能发送
+          invalid: 请输入合法电子邮件地址
       form:
-        title: '通过电子邮件发送'
-        to: '电子邮件：'
-        message: '正文：'
-        submit: '发送'
+        message: 正文：
+        submit: 发送
+        title: 通过电子邮件发送
+        to: 电子邮件：
+      success: 已发送电子邮件
       text:
-        default_title: '无'
-        title: '标题: %{value}'
-        author: '作者: %{value}'
-        format: '格式: %{value}'
-        language: '语言: %{value}'
+        default_title: 无
+        message: 正文： %{message}
         subject:
           one: '记录: %{title}'
-          other: '记录'
+          other: 记录
         url: '网址: %{url}'
-        message: '正文： %{message}'
-
-      success: "已发送电子邮件"
-
-      errors:
-        to:
-          invalid: '请输入合法电子邮件地址'
-          blank: '请输入电子邮件接收人才能发送'
-    sms:
-      form:
-        title: '通过短信发送'
-        to: '电话号码:'
-        carrier: '运营商'
-        carrier_prompt: '请选择运营商'
-        submit: '发送'
-      text:
-        title: '%{value}'
-        author: ' 来自 %{value}'
-        url: '链接: %{url}'
-      success: "已发送短信"
-      errors:
-        to:
-          invalid: '请输入10位正确电话号码'
-          blank: "请输入接收人电话号码才能发送短信"
-        carrier:
-          blank: '你必须选择一个运营商'
-          invalid: "你必须输入一个运营商"
-
-    back_to_search: '返回搜索页面'
-    back_to_bookmarks: '返回书签页面'
-
+    entry_name:
+      default: 条目
+      grouped:
+        default: 分组结果
+    header_links:
+      bookmarks: 书签
+      login: 登陆
+      logout: 注销
+      search_history: 搜索历史
+    main:
+      aria:
+        main_container: 主要内容
+    modal:
+      close: 关闭
+    or: 或
     search:
-      page_title:
-        title: '%{constraints} - %{application_name} 搜索结果'
-        constraint: '%{label}: %{value}'
-        many_constraint_values: '%{values} 已选'
-      header: '搜'
-      search_constraints_header: '搜索条件'
-      search_results: '搜索结果'
-      errors:
-        invalid_solr_id: "抱歉，你要找的结果不存在。"
-      per_page:
-        label: '%{count}<span class="sr-only visually-hidden"> 每页</span>'
-        button_label: '%{count} 每页' # TODO: Remove during major release
-        button_label_html: '%{count}<span class="d-none d-sm-inline"> 每页</span>'
-        title: '每页显示结果数'
-        submit: '更新'
-        aria_label: '结果导航'
-      sort:
-        label: '按 %{field} 排序' # TODO: Remove during major release
-        label_html: '<span class="d-none d-sm-inline">按 %{field} </span>排序'
-        submit: '排序'
-      form:
-        search_field:
-          label: '搜索字段'
-          title: '设定的搜索选项'
-          post_label: '为'
-        search:
-          label: '搜索'
-          placeholder: '搜索...'
-        submit: '搜索'
-      pagination:
-        title: '搜索结果导航'
-      pagination_info:
-        no_items_found: '没有找到 %{entry_name} '
-        single_item_found: '找到 <strong>1</strong> %{entry_name}'
-        pages:
-          one: '<strong>%{start_num}</strong> - <strong>%{end_num}</strong> 共 <strong>%{total_num}</strong>'
-          other: '<strong>%{start_num}</strong> - <strong>%{end_num}</strong> 共 <strong>%{total_num}</strong>'
-      entry_pagination_info:
-        one: '<strong>1 / 1</strong>'
-        other: '<strong>%{current}</strong> / <strong>%{total}</strong>'
+      atom_feed: 搜索结果Atom
+      bookmarks:
+        absent: 加入书签
+        inprogress: 保存...
+        present: 在书签中
       documents:
         aria:
-          search_results: '搜索结果'
-          limit_search: '限定搜索'
-        counter: '%{counter}. '
+          limit_search: 限定搜索
+          search_results: 搜索结果
+        counter: "%{counter}. "
+      entry_pagination_info:
+        one: "<strong>1 / 1</strong>"
+        other: "<strong>%{current}</strong> / <strong>%{total}</strong>"
+      errors:
+        invalid_solr_id: 抱歉，你要找的结果不存在。
       facets:
-        title: '限定搜索'
-        clear: '清除搜索条件'
-        all: '皆'
-        sort:
-          count: '按数量排序'
-          index: '按字母排序'
-        count: '%{number}'
-        more_html: '更多 <span class="sr-only visually-hidden">%{field_name}</span> »'
-        selected:
-          remove: '[删除]'
+        all: 皆
+        clear: 清除搜索条件
+        count: "%{number}"
+        group:
+          close: 隐藏方面
+          open: 显示方面
+          toggle: 更多 »
         missing: "[未找到]"
+        more_html: 更多 <span class="sr-only visually-hidden">%{field_name}</span> »
         pivot:
-          show: 打开
           hide: 关
-        group:
-          toggle: '更多 »'
-      group:
-        more: '更多 »'
+          show: 打开
+        selected:
+          remove: "[删除]"
+        sort:
+          count: 按数量排序
+          index: 按字母排序
+        title: 限定搜索
       filters:
-        title: '你在搜索：'
-        label: '%{label}:'
+        label: "%{label}:"
         remove:
-          value: '删除限定条件 %{value}'
           label_value: '删除限定条件 %{label}: %{value}'
-      start_over: '重新开始'
+          value: 删除限定条件 %{value}
+        title: 你在搜索：
+      form:
+        search:
+          label: 搜索
+          placeholder: 搜索...
+        search_field:
+          label: 搜索字段
+          post_label: 为
+          title: 设定的搜索选项
+        submit: 搜索
+      group:
+        more: 更多 »
+      header: 搜
       index:
-        label: '%{label}:'
+        label: "%{label}:"
+      page_title:
+        constraint: "%{label}: %{value}"
+        many_constraint_values: "%{values} 已选"
+        title: "%{constraints} - %{application_name} 搜索结果"
+      pagination:
+        title: 搜索结果导航
+      pagination_info:
+        no_items_found: '没有找到 %{entry_name} '
+        pages:
+          one: "<strong>%{start_num}</strong> - <strong>%{end_num}</strong> 共 <strong>%{total_num}</strong>"
+          other: "<strong>%{start_num}</strong> - <strong>%{end_num}</strong> 共 <strong>%{total_num}</strong>"
+        single_item_found: 找到 <strong>1</strong> %{entry_name}
+      per_page:
+        aria_label: 结果导航
+        button_label: "%{count} 每页"
+        button_label_html: '%{count}<span class="d-none d-sm-inline"> 每页</span>'
+        label: '%{count}<span class="sr-only visually-hidden"> 每页</span>'
+        submit: 更新
+        title: 每页显示结果数
+      rss_feed: 搜索结果RSS
+      search_constraints_header: 搜索条件
+      search_results: 搜索结果
       show:
-        title: '%{document_title} - %{application_name}'
-        label: '%{label}:'
-      rss_feed: '搜索结果RSS'
-      atom_feed: '搜索结果Atom'
-      bookmarks:
-        present: "在书签中"
-        absent: "加入书签"
-        inprogress: "保存..."
-      zero_results:
-        title: "未找到任何结果"
-        modify_search: "请更改你的搜索条件"
-        use_fewer_keywords: "使用更少的搜索条件，使用左边的链接来筛选搜索结果。"
-        search_fields: "你在搜索如下字段 %{search_fields}"
-        search_everything: "试一试搜索所有记录"
-      view_title: "以如下方式察看搜索结果: "
+        label: "%{label}:"
+        title: "%{document_title} - %{application_name}"
+      sort:
+        label: 按 %{field} 排序
+        label_html: <span class="d-none d-sm-inline">按 %{field} </span>排序
+        submit: 排序
+      start_over: 重新开始
       view:
-        list: "列表"
-
-    entry_name:
-      default: '条目'
-      grouped:
-        default: '分组结果'
-
-    did_you_mean: '你是要输入： %{options} 吗？'
-
-    main:
+        list: 列表
+      view_title: '以如下方式察看搜索结果: '
+      zero_results:
+        modify_search: 请更改你的搜索条件
+        search_everything: 试一试搜索所有记录
+        search_fields: 你在搜索如下字段 %{search_fields}
+        title: 未找到任何结果
+        use_fewer_keywords: 使用更少的搜索条件，使用左边的链接来筛选搜索结果。
+    search_history:
+      clear:
+        action_confirm: 清除搜索历史？
+        action_title: 清除搜索历史
+        failure: 清除搜索历史时出错。
+        success: 已经清除搜索历史。
+      forget: 去除
+      no_history: 你没有任何搜索历史
+      page_title: 搜索历史 - %{application_name}
+      recent: 你最近搜索历史
+      save: 保存
+      title: ''
+    skip_links:
+      first_result: 转到第一个搜索结果
+      label: 跳过链接
+      main_content: 转到主要内容
+      search_field: 转到搜索
+    sms:
+      errors:
+        carrier:
+          blank: 你必须选择一个运营商
+          invalid: 你必须输入一个运营商
+        to:
+          blank: 请输入接收人电话号码才能发送短信
+          invalid: 请输入10位正确电话号码
+      form:
+        carrier: 运营商
+        carrier_prompt: 请选择运营商
+        submit: 发送
+        title: 通过短信发送
+        to: '电话号码:'
+      success: 已发送短信
+      text:
+        url: '链接: %{url}'
+    tools:
+      citation: 引用
+      clear: 清除
+      email: 电子邮件
+      sms: 发送短信
+      title: 工具
+    welcome: 欢迎!
+  views:
+    pagination:
       aria:
-        main_container: '主要内容'
+        container_label: 分页链接
+        current_page: 当前页面，页面%{page}
+        go_to_first_page: 转到第一页
+        go_to_last_page: 转到最后一页
+        go_to_next_page: 转到下一页
+        go_to_page: 前往页面%{page}
+        go_to_previous_page: 转到上一页
+      first: "&laquo; 首页"
+      last: 末页 &raquo;
+      next: 下一页 &raquo;
+      previous: "&laquo; 上一页"
+      truncate: "…"
+    pagination_compact:
+      next: 下一页 &raquo;
+      previous: "&laquo; 上一页"

data/docker-compose.yml

@@ -17,6 +17,7 @@ services:
     environment:
       - SOLR_URL # Set via environment variable or use default defined in .env file
       - RAILS_VERSION # Set via environment variable or use default defined in .env file
+      - VIEW_COMPONENT_VERSION # Set via environment variable or use default defined in .env file
       - SOLR_ENV=docker-compose
       - ENGINE_CART_RAILS_OPTIONS=--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test --skip-solr
 

data/lib/blacklight/configuration/session_tracking_config.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class Blacklight::Configuration
+  class SessionTrackingConfig < Blacklight::OpenStructWithHashAccess
+    # @!attribute storage
+    #   @return [String, FalseClass] 'server': use server-side tracking; 'client': delegate search tracking and prev/next navigation to client
+    # @!attribute applied_params_component
+    #   @return [Class] component class used to render a facet group
+    # @!attribute item_pagination_component
+    #   @return [Class] component class used to render the constraints
+
+    def initialize(property_hash = {})
+      super({ storage: 'server' }.merge(property_hash))
+    end
+
+    def applied_params_component
+      super || default_applied_params_component(storage)
+    end
+
+    def item_pagination_component
+      super || default_item_pagination_component(storage)
+    end
+
+    def url_helper
+      super || default_url_helper(storage)
+    end
+
+    def default_applied_params_component(storage)
+      return Blacklight::SearchContext::ServerAppliedParamsComponent if storage == 'server'
+
+      nil
+    end
+
+    def default_item_pagination_component(storage)
+      return Blacklight::SearchContext::ServerItemPaginationComponent if storage == 'server'
+
+      nil
+    end
+
+    # extension point for alternative storage types
+    def default_url_helper(_storage)
+      nil
+    end
+  end
+end

data/lib/blacklight/configuration/view_config.rb

@@ -26,10 +26,6 @@ class Blacklight::Configuration
     #   @return [Class] component class used to render the search bar
     # @!attribute search_header_component
     #   @return [Class] component class used to render the header above the documents
-    def search_bar_presenter_class
-      super || Blacklight::SearchBarPresenter
-    end
-
     def display_label(**options)
       I18n.t(
         :"blacklight.search.view_title.#{key}",

data/lib/blacklight/configuration.rb

@@ -20,6 +20,7 @@ module Blacklight
       autoload :DisplayField
       autoload :IndexField
       autoload :ShowField
+      autoload :SessionTrackingConfig
     end
 
     class_attribute :default_values, default: {}
@@ -200,7 +201,9 @@ module Blacklight
         ViewConfig,
         default: { top_level_config: :index },
         show: { top_level_config: :show },
-        citation: { parent_config: :show }
+        citation: { parent_config: :show },
+        email_record: { top_level_config: :email },
+        sms_record: { top_level_config: :sms }
       )
 
       # @!attribute sms
@@ -279,9 +282,10 @@ module Blacklight
       property :raw_endpoint, default: OpenStructWithHashAccess.new(enabled: false)
 
       # @!attribute track_search_session
-      # @since v7.1.0
-      # @return [Boolean]
-      property :track_search_session, default: true
+      # { storage: false } value: do no tracking
+      # @since v8.0.0
+      # @return [Blacklight::Configuration::SessionTrackingConfig]
+      property :track_search_session, default: Blacklight::Configuration::SessionTrackingConfig.new
 
       # @!attribute advanced_search
       # @since v7.15.0

data/lib/blacklight/engine.rb

@@ -19,15 +19,14 @@ module Blacklight
       end
     end
 
-    initializer "blacklight.assets.precompile" do
-      # rubocop:disable Lint/ConstantDefinitionInBlock
-      PRECOMPILE_ASSETS = %w(favicon.ico blacklight/blacklight.js blacklight/blacklight.js.map blacklight/blacklight.esm.js blacklight/blacklight.esm.js.map).freeze
-      # rubocop:enable Lint/ConstantDefinitionInBlock
+    PRECOMPILE_ASSETS = %w(favicon.ico blacklight/blacklight.js blacklight/blacklight.js.map blacklight/blacklight.esm.js blacklight/blacklight.esm.js.map).freeze
 
+    initializer "blacklight.assets.precompile" do |app|
       # When Rails has been generated in API mode, it does not have sprockets available
-      if Rails.application.config.respond_to?(:assets)
-        Rails.application.config.assets.precompile += PRECOMPILE_ASSETS
-      end
+      next unless app.config.respond_to?(:assets)
+
+      app.config.assets.paths << Engine.root.join("app/javascript")
+      app.config.assets.precompile += Blacklight::Engine::PRECOMPILE_ASSETS
     end
 
     initializer "blacklight.importmap", before: "importmap" do |app|

data/lib/blacklight/routes/searchable.rb

@@ -10,6 +10,7 @@ module Blacklight
       def call(mapper, _options = {})
         mapper.match '/', action: 'index', as: 'search', via: [:get, :post]
         mapper.get '/advanced', action: 'advanced_search', as: 'advanced_search'
+        mapper.get '/page_links', action: 'page_links', as: 'page_links'
 
         mapper.post ":id/track", action: 'track', as: 'track'
         mapper.get ":id/raw", action: 'raw', as: 'raw', defaults: { format: 'json' }

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

@@ -14,10 +14,15 @@ module Blacklight
       def import_javascript_assets
         append_to_file 'config/importmap.rb' do
           <<~CONTENT
+            pin "@github/auto-complete-element", to: "https://cdn.skypack.dev/@github/auto-complete-element"
             pin "@popperjs/core", to: "https://ga.jspm.io/npm:@popperjs/core@2.11.6/dist/umd/popper.min.js"
             pin "bootstrap", to: "https://ga.jspm.io/npm:bootstrap@#{(defined?(Bootstrap) && Bootstrap::VERSION) || '5.2.2'}/dist/js/bootstrap.js"
-            pin "blacklight", to: "blacklight/blacklight.js"
-            pin "dialog-polyfill", to: "https://ga.jspm.io/npm:dialog-polyfill@0.5.6/dist/dialog-polyfill.js"
+          CONTENT
+        end
+
+        append_to_file 'app/assets/config/manifest.js' do
+          <<~CONTENT
+            //= link blacklight/manifest.js
           CONTENT
         end
       end
@@ -26,12 +31,8 @@ module Blacklight
         append_to_file 'app/javascript/application.js' do
           <<~CONTENT
             import bootstrap from "bootstrap"
-            import "blacklight"
-            import dialogPolyfill from "dialog-polyfill"
-            Blacklight.onLoad(() => {
-              const dialog = document.querySelector('dialog')
-              dialogPolyfill.registerDialog(dialog)
-            })
+            import githubAutoCompleteElement from "@github/auto-complete-element"
+            import Blacklight from "blacklight"
           CONTENT
         end
       end

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

@@ -4,7 +4,15 @@ module Blacklight
   module Assets
     class PropshaftGenerator < Rails::Generators::Base
       def add_package
-        run 'yarn add blacklight-frontend'
+        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
@@ -16,7 +24,8 @@ module Blacklight
 
         append_to_file 'app/javascript/application.js' do
           <<~CONTENT
-            import Blacklight from "blacklight-frontend/app/assets/javascripts/blacklight/blacklight.esm";
+            import Blacklight from "blacklight-frontend";
+            import githubAutoCompleteElement from "@github/auto-complete-element";
           CONTENT
         end
       end

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

@@ -18,6 +18,7 @@ module Blacklight
         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
 
@@ -42,6 +43,7 @@ module Blacklight
             // Required by Blacklight
             //= require popper
             //= require bootstrap
+            //= require blacklight/blacklight
           CONTENT
         end
       end

data/lib/generators/blacklight/assets_generator.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require 'shellwords'
+
 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 run_asset_pipeline_specific_generator
-      generated_options = "--bootstrap-version='#{options[:'bootstrap-version']}'" if options[:'bootstrap-version']
+      generated_options = "--bootstrap-version='#{Shellwords.escape(options[:'bootstrap-version'])}'" if options[:'bootstrap-version']
 
       generator = if defined?(Propshaft)
                     'blacklight:assets:propshaft'