blacklight 8.3.0 → 8.5.0

data/config/locales/blacklight.en.yml

@@ -1,257 +1,244 @@
+---
 en:
-  views:
-    pagination:
-      first: '« First'
-      last: 'Last »'
-      previous: '« Previous'
-      next: 'Next »'
-      truncate: '…'
-      aria:
-        container_label: 'pagination links'
-        current_page: 'Current Page, Page %{page}'
-        go_to_page: 'Go to page %{page}'
-        go_to_previous_page: 'Go to previous page'
-        go_to_next_page: 'Go to next page'
-        go_to_first_page: 'Go to first page'
-        go_to_last_page: 'Go to last page'
-
-    pagination_compact:
-      previous: '« Previous'
-      next: 'Next »'
-
   blacklight:
-    application_name: 'Blacklight'
-    skip_links:
-      label: 'Skip links'
-      main_content: 'Skip to main content'
-      search_field: 'Skip to search'
-      first_result: 'Skip to first result'
-    header_links:
-      login: 'Login'
-      logout: 'Log Out'
-      bookmarks: 'Bookmarks'
-      search_history: 'History'
-
-    welcome: 'Welcome!'
-    and: 'and'
-    or: 'or'
-
-    modal:
-      close: "Close"
-
+    advanced_search:
+      any_of: 'Any of:'
+      form:
+        limit_criteria_heading_html: "<strong>AND</strong> have these attributes"
+        query_criteria_heading_html: Match %{select_menu} of the fields below
+        search_btn_html: Search
+        search_context: Within search
+        sort_label: Sort results by
+        start_over_html: Start over
+        title: Advanced search
+      more_options: More options
+      op:
+        label: search operator
+        must: all
+        should: any
+      or_html: " OR "
+      page_title: Advanced search - %{application_name}
+    and: and
+    application_name: Blacklight
+    back_to_bookmarks: Back to Bookmarks
+    back_to_search: Back to Search
     bookmarks:
-      title: 'Bookmarks'
-      page_title: 'Bookmarks - %{application_name}'
-      no_bookmarks: 'You have no bookmarks'
       add:
-        button: 'Bookmark'
+        button: Bookmark
+        failure: Sorry, there was a problem saving the bookmarks.
         success:
-          one: 'Successfully added bookmark.'
-          other: 'Successfully added bookmarks.'
-        failure:  'Sorry, there was a problem saving the bookmarks.'
-      remove:
-        button: 'Remove bookmark'
-        success: 'Successfully removed bookmark.'
-        failure: 'Sorry, there was a problem removing the bookmarks.'
-        action_confirm: 'Remove this bookmark?'
-      clear:
-        action_title: 'Clear Bookmarks'
-        action_confirm: 'Clear your bookmarks?'
-        success: 'Cleared your bookmarks.'
-        failure: 'Sorry, there was a problem clearing your bookmarks.'
-      need_login: 'Please log in to manage and view your bookmarks.'
-      list_title: 'Your Bookmarks'
-      delete: 'Remove'
-
-    search_history:
+          one: Successfully added bookmark.
+          other: Successfully added bookmarks.
       clear:
-        action_title: 'Clear Search History'
-        action_confirm: 'Clear your search history?'
-        success: 'Cleared your search history.'
-        failure: 'There was a problem clearing your search history.'
-      title: 'Search History'
-      page_title: 'Search History - %{application_name}'
-      no_history: 'You have no search history'
-      recent: 'Your recent searches'
-      forget: 'forget'
-      save: 'save'
-
-    tools:
-      title: 'Tools'
-      citation: 'Cite'
-      email: 'Email'
-      sms: 'SMS This'
-      clear: 'Clear'
-
+        action_confirm: Clear your bookmarks?
+        action_title: Clear Bookmarks
+        failure: Sorry, there was a problem clearing your bookmarks.
+        success: Cleared your bookmarks.
+      delete: Remove
+      list_title: Your Bookmarks
+      need_login: Please log in to manage and view your bookmarks.
+      no_bookmarks: You have no bookmarks
+      page_title: Bookmarks - %{application_name}
+      remove:
+        action_confirm: Remove this bookmark?
+        button: Remove bookmark
+        failure: Sorry, there was a problem removing the bookmarks.
+        success: Successfully removed bookmark.
+      title: Bookmarks
     citation:
-      mla: 'MLA'
-      apa: 'APA'
-      chicago: 'Chicago'
-
+      apa: APA
+      chicago: Chicago
+      mla: MLA
+    did_you_mean: 'Did you mean to type: %{options}?'
     email:
+      errors:
+        to:
+          blank: You must enter a recipient in order to send this message
+          invalid: You must enter a valid email address
       form:
-        title: 'Email This'
-        to: 'Email:'
         message: 'Message:'
-        submit: 'Send'
+        submit: Send
+        title: Email This
+        to: 'Email:'
+      success: Email Sent
       text:
-        default_title: 'N/A'
+        default_title: N/A
+        message: 'Message: %{message}'
         subject:
           one: 'Item Record: %{title}'
-          other: 'Item records'
+          other: Item records
         url: 'URL: %{url}'
-        message: 'Message: %{message}'
-
-      success: "Email Sent"
-
-      errors:
-        to:
-          invalid: 'You must enter a valid email address'
-          blank: 'You must enter a recipient in order to send this message'
-    sms:
-      form:
-        title: 'SMS This'
-        to: 'Phone Number:'
-        carrier: 'Carrier'
-        carrier_prompt: 'Please select your carrier'
-        submit: 'Send'
-      text:
-        url: 'Link: %{url}'
-      success: "SMS Sent"
-      errors:
-        to:
-          invalid: 'You must enter a valid 10 digit phone number'
-          blank: "You must enter a recipient's phone number in order to send this message"
-        carrier:
-          blank: 'You must select a carrier'
-          invalid: "You must enter a valid carrier"
-
-    back_to_search: 'Back to Search'
-    back_to_bookmarks: 'Back to Bookmarks'
-
+    entry_name:
+      default:
+        one: entry
+        other: entries
+      grouped:
+        default:
+          one: grouped result
+          other: grouped results
+    header_links:
+      bookmarks: Bookmarks
+      login: Login
+      logout: Log Out
+      search_history: History
+    main:
+      aria:
+        main_container: Main content
+    modal:
+      close: Close
+    or: or
     search:
-      page_title:
-        title: '%{constraints} - %{application_name} Search Results'
-        constraint: '%{label}: %{value}'
-        many_constraint_values: '%{values} selected'
-      header: 'Search'
-      search_constraints_header: 'Search Constraints'
-      search_results: 'Search Results'
-      errors:
-        invalid_solr_id: "Sorry, you have requested a record that doesn't exist."
-      per_page:
-        label: '%{count}<span class="sr-only visually-hidden"> per page</span>'
-        button_label: '%{count} per page' # TODO: Remove during major release
-        button_label_html: '%{count}<span class="d-none d-sm-inline"> per page</span>'
-        title: 'Number of results to display per page'
-        submit: 'Update'
-        aria_label: 'Results navigation'
-      sort:
-        label: 'Sort by %{field}' # TODO: Remove during major release
-        label_html: 'Sort<span class="d-none d-sm-inline"> by %{field}</span>'
-        submit: 'sort results'
-      form:
-        search_field:
-          label: 'Search in'
-          title: 'Targeted search options'
-          post_label: 'for'
-        search:
-          label: 'search for'
-          placeholder: 'Search...'
-        submit: 'Search'
-      pagination:
-        title: 'Results navigation'
-      pagination_info:
-        no_items_found: 'No %{entry_name} found'
-        single_item_found: '<strong>1</strong> %{entry_name} found'
-        pages:
-          one: '<strong>%{start_num}</strong> - <strong>%{end_num}</strong> of <strong>%{total_num}</strong>'
-          other: '<strong>%{start_num}</strong> - <strong>%{end_num}</strong> of <strong>%{total_num}</strong>'
-      entry_pagination_info:
-        one: '<strong>1 of 1</strong>'
-        other: '<strong>%{current}</strong> of <strong>%{total}</strong>'
+      atom_feed: Atom for results
+      bookmarks:
+        absent: Bookmark
+        inprogress: Saving...
+        present: In Bookmarks
       documents:
         aria:
-          search_results: 'search results'
-          limit_search: 'limit your search'
-        counter: '%{counter}. '
+          limit_search: limit your search
+          search_results: search results
+        counter: "%{counter}. "
+      entry_pagination_info:
+        one: "<strong>1 of 1</strong>"
+        other: "<strong>%{current}</strong> of <strong>%{total}</strong>"
+      errors:
+        invalid_solr_id: Sorry, you have requested a record that doesn't exist.
       facets:
-        title: 'Limit your search'
-        clear: 'Clear Filter'
-        sort:
-          count: 'Numerical Sort'
-          index: 'A-Z Sort'
-        count: '%{number}'
-        more_html: 'more <span class="sr-only visually-hidden">%{field_name}</span> »'
-        selected:
-          remove: '[remove]'
-        missing: "[Missing]"
         all: All
-        pivot:
-          show: Show
-          hide: Hide
+        clear: Clear Filter
+        count: "%{number}"
         group:
-          open: Show facets
           close: Hide facets
-      group:
-        more: 'more »'
+          open: Show facets
+        missing: "[Missing]"
+        more_html: more <span class="sr-only visually-hidden">%{field_name}</span> »
+        pivot:
+          hide: Hide
+          show: Show
+        selected:
+          remove: "[remove]"
+        sort:
+          count: Numerical Sort
+          index: A-Z Sort
+        title: Limit your search
       filters:
-        title: 'You searched for:'
-        label: '%{label}:'
+        label: "%{label}:"
         remove:
-          value: 'Remove constraint %{value}'
           label_value: 'Remove constraint %{label}: %{value}'
-      start_over: 'Start Over'
+          value: Remove constraint %{value}
+        title: 'You searched for:'
+      form:
+        search:
+          label: search for
+          placeholder: Search...
+        search_field:
+          label: Search in
+          post_label: for
+          title: Targeted search options
+        submit: Search
+      group:
+        more: more »
+      header: Search
       index:
-        label: '%{label}:'
+        label: "%{label}:"
+      page_title:
+        constraint: "%{label}: %{value}"
+        many_constraint_values: "%{values} selected"
+        title: "%{constraints} - %{application_name} Search Results"
+      pagination:
+        title: Results navigation
+      pagination_info:
+        no_items_found: No %{entry_name} found
+        pages:
+          one: "<strong>%{start_num}</strong> - <strong>%{end_num}</strong> of <strong>%{total_num}</strong>"
+          other: "<strong>%{start_num}</strong> - <strong>%{end_num}</strong> of <strong>%{total_num}</strong>"
+        single_item_found: "<strong>1</strong> %{entry_name} found"
+      per_page:
+        aria_label: Results navigation
+        button_label: "%{count} per page"
+        button_label_html: '%{count}<span class="d-none d-sm-inline"> per page</span>'
+        label: '%{count}<span class="sr-only visually-hidden"> per page</span>'
+        submit: Update
+        title: Number of results to display per page
+      rss_feed: RSS for results
+      search_constraints_header: Search Constraints
+      search_results: Search Results
       show:
-        title: '%{document_title} - %{application_name}'
-        label: '%{label}:'
-      rss_feed: 'RSS for results'
-      atom_feed: 'Atom for results'
-      bookmarks:
-        present: "In Bookmarks"
-        absent: "Bookmark"
-        inprogress: "Saving..."
-      zero_results:
-        title: "No results found for your search"
-        modify_search: "Try modifying your search"
-        use_fewer_keywords: "Use fewer keywords to start, then refine your search using the links on the left."
-        search_fields: "you searched by %{search_fields}"
-        search_everything: "try searching everything"
-      view_title: "View results as: "
+        label: "%{label}:"
+        title: "%{document_title} - %{application_name}"
+      sort:
+        label: Sort by %{field}
+        label_html: Sort<span class="d-none d-sm-inline"> by %{field}</span>
+        submit: sort results
+      start_over: Start Over
       view:
-        list: "List"
-
-    entry_name:
-      default:
-        one: 'entry'
-        other: 'entries'
-      grouped:
-        default:
-          one: 'grouped result'
-          other: 'grouped results'
-
-    did_you_mean: 'Did you mean to type: %{options}?'
-
-    main:
-      aria:
-        main_container: 'Main content'
-
-    advanced_search:
-      or_html: ' OR '
-      more_options: More options
-      any_of: 'Any of:'
-      op:
-        label: search operator
-        must: all
-        should: any
-      page_title: Advanced search - %{application_name}
+        list: List
+      view_title: 'View results as: '
+      zero_results:
+        modify_search: Try modifying your search
+        search_everything: try searching everything
+        search_fields: you searched by %{search_fields}
+        title: No results found for your search
+        use_fewer_keywords: Use fewer keywords to start, then refine your search using the links on the left.
+    search_history:
+      clear:
+        action_confirm: Clear your search history?
+        action_title: Clear Search History
+        failure: There was a problem clearing your search history.
+        success: Cleared your search history.
+      forget: forget
+      no_history: You have no search history
+      page_title: Search History - %{application_name}
+      recent: Your recent searches
+      save: save
+      title: Search History
+    skip_links:
+      first_result: Skip to first result
+      label: Skip links
+      main_content: Skip to main content
+      search_field: Skip to search
+    sms:
+      errors:
+        carrier:
+          blank: You must select a carrier
+          invalid: You must enter a valid carrier
+        to:
+          blank: You must enter a recipient's phone number in order to send this message
+          invalid: You must enter a valid 10 digit phone number
       form:
-        title: Advanced search
-        search_context: Within search
-        limit_criteria_heading_html: "<strong>AND</strong> have these attributes"
-        query_criteria_heading_html: "Match %{select_menu} of the fields below"
-        sort_label: "Sort results by"
-        start_over_html: "Start over"
-        search_btn_html: 'Search'
+        carrier: Carrier
+        carrier_prompt: Please select your carrier
+        submit: Send
+        title: SMS This
+        to: 'Phone Number:'
+      success: SMS Sent
+      text:
+        url: 'Link: %{url}'
+    tools:
+      citation: Cite
+      clear: Clear
+      email: Email
+      sms: SMS This
+      title: Tools
+    top_navbar:
+      aria:
+        container_label: Main navigation
+    welcome: Welcome!
+  views:
+    pagination:
+      aria:
+        container_label: pagination links
+        current_page: Current Page, Page %{page}
+        go_to_first_page: Go to first page
+        go_to_last_page: Go to last page
+        go_to_next_page: Go to next page
+        go_to_page: Go to page %{page}
+        go_to_previous_page: Go to previous page
+      first: "&laquo; First"
+      last: Last &raquo;
+      next: Next &raquo;
+      previous: "&laquo; Previous"
+      truncate: "…"
+    pagination_compact:
+      next: Next &raquo;
+      previous: "&laquo; Previous"

data/config/locales/blacklight.es.yml

@@ -201,6 +201,9 @@ es:
       email: Correo electrónico
       sms: Enviar SMS
       title: Herramientas
+    top_navbar:
+      aria:
+        container_label: Navegación principal
     welcome: "¡Bienvenido!"
   views:
     pagination:

data/config/locales/blacklight.fr.yml

@@ -201,6 +201,9 @@ fr:
       email: Envoyer
       sms: SMS
       title: Outils
+    top_navbar:
+      aria:
+        container_label: Navigation principale
     welcome: Welcome!
   views:
     pagination:

data/config/locales/blacklight.hu.yml

@@ -199,6 +199,9 @@ hu:
       email: Email
       sms: Küldés SMS-ben
       title: Eszközök
+    top_navbar:
+      aria:
+        container_label: Fő navigáció
     welcome: Üdvözöljük!
   views:
     pagination:

data/config/locales/blacklight.it.yml

@@ -202,6 +202,9 @@ it:
       email: Invia per e-mail
       sms: Invia per SMS
       title: Strumenti
+    top_navbar:
+      aria:
+        container_label: Navigazione principale
     welcome: Benvenuti!
   views:
     pagination:

data/config/locales/blacklight.nl.yml

@@ -199,6 +199,9 @@ nl:
       email: Email
       sms: SMS dit
       title: Hulpmiddelen
+    top_navbar:
+      aria:
+        container_label: Hoofdnavigatie
     welcome: Welkom!
   views:
     pagination:

data/config/locales/blacklight.pt-BR.yml

@@ -200,6 +200,9 @@ pt-BR:
       email: Email
       sms: SMS
       title: Ferramentas
+    top_navbar:
+      aria:
+        container_label: Navegação principal
     welcome: Bem-Vindo!
   views:
     pagination:

data/config/locales/blacklight.sq.yml

@@ -199,6 +199,9 @@ sq:
       email: Email
       sms: Dërgo SMS
       title: Veglat
+    top_navbar:
+      aria:
+        container_label: Lundrimi kryesor
     welcome: Mirësevini!
   views:
     pagination:

data/config/locales/blacklight.zh.yml

@@ -199,6 +199,9 @@ zh:
       email: 电子邮件
       sms: 发送短信
       title: 工具
+    top_navbar:
+      aria:
+        container_label: 主导航
     welcome: 欢迎!
   views:
     pagination:

data/lib/blacklight/abstract_repository.rb

@@ -35,6 +35,12 @@ module Blacklight
       raise NotImplementedError
     end
 
+    # Find multiple documents by their ids
+    # @param [Hash] _params query parameters
+    def find_many(params, **kwargs)
+      search(params, **kwargs)
+    end
+
     ##
     # Execute a search query against a search index
     # @param [Hash] _params query parameters

data/lib/blacklight/component.rb

@@ -3,57 +3,20 @@
 module Blacklight
   class Component < ViewComponent::Base
     class << self
-      # Workaround for https://github.com/ViewComponent/view_component/issues/1565
-      def config
-        @config ||= ViewComponent::Config.defaults.merge(ViewComponent::Base.config)
-      end
+      alias upstream_sidecar_files sidecar_files
 
-      # rubocop:disable Naming/MemoizedInstanceVariableName
-      def compiler
-        @__vc_compiler ||= EngineCompiler.new(self)
+      def reset_compiler!
+        @__vc_compiler = nil
       end
-      # rubocop:enable Naming/MemoizedInstanceVariableName
-
-      alias sidecar_files _sidecar_files unless ViewComponent::Base.respond_to? :sidecar_files
-    end
-
-    EXCLUDE_VARIABLES = [
-      :@lookup_context, :@view_renderer, :@view_flow, :@view_context,
-      :@tag_builder, :@current_template,
-      :@__vc_set_slots, :@__vc_original_view_context,
-      :@__vc_variant, :@__vc_content_evaluated,
-      :@__vc_render_in_block, :@__vc_content, :@__vc_helpers
-    ].freeze
-
-    def inspect
-      # Exclude variables added by render_in
-      render_variables = instance_variables - EXCLUDE_VARIABLES
-      fields = render_variables.map { |ivar| "#{ivar}:#{instance_variable_get(ivar).inspect}" }.join(', ')
-      "#<#{self.class.name}:#{object_id} #{fields}>"
-    end
-
-    class EngineCompiler < ::ViewComponent::Compiler
-      # ViewComponent::Compiler locates and caches templates from sidecar files to the component source file.
-      # While this is sensible in a Rails application, it prevents component templates defined in an Engine
-      # from being overridden by an installing application without subclassing the component, which may also
-      # require modifying any partials rendering the component. This subclass of compiler overrides the template
-      # location algorithm to take the sidecar file names from the Engine, but look to see if a file of the
-      # same name existing in the installing application (ie, under Rails.root). If the latter exists, this
-      # compiler will cache that template instead of the engine-defined file; if not, the compiler will fall
-      # back to the engine-defined file.
-      def templates
-        @templates ||= begin
-          extensions = ActionView::Template.template_handler_extensions
 
-          component_class.sidecar_files(extensions).each_with_object([]) do |path, memo|
-            pieces = File.basename(path).split(".")
-            app_path = Rails.root.join(path.slice(path.index(component_class.view_component_path)..-1).to_s).to_s
+      def sidecar_files(*args, **kwargs)
+        upstream_sidecar_files(*args, **kwargs).map do |path|
+          app_path = Rails.root.join(path.slice(path.index(view_component_path)..-1).to_s).to_s
 
-            memo << {
-              path: File.exist?(app_path) ? app_path : path,
-              variant: pieces.second.split("+").second&.to_sym,
-              handler: pieces.last
-            }
+          if File.exist?(app_path)
+            app_path
+          else
+            path
           end
         end
       end