blacklight 7.7.0 → 7.8.0

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

@@ -4,10 +4,6 @@ module Blacklight::Document
     extend ActiveSupport::Concern
 
     module ClassMethods
-      # Returns array of hashes of registered extensions. Each hash
-      # has a :module_obj key and a :condition_proc key. Usually this
-      # method is only used internally in #apply_extensions, but if you
-
       # Class-level method for accessing/setting semantic mappings
       # for solr stored fields. Can be set by local app, key is
       # a symbol for a semantic, value is a solr _stored_ field.

data/app/presenters/blacklight/facet_field_presenter.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class FacetFieldPresenter
+    attr_reader :facet_field, :display_facet, :view_context, :search_state
+
+    delegate :key, to: :facet_field
+    delegate :field_name, to: :display_facet
+
+    def initialize(facet_field, display_facet, view_context, search_state = view_context.search_state)
+      @facet_field = facet_field
+      @display_facet = display_facet
+      @view_context = view_context
+      @search_state = search_state
+    end
+
+    def collapsed?
+      Deprecation.silence(Blacklight::FacetsHelperBehavior) do
+        view_context.should_collapse_facet?(facet_field)
+      end
+    end
+
+    def active?
+      Deprecation.silence(Blacklight::FacetsHelperBehavior) do
+        view_context.facet_field_in_params?(key)
+      end
+    end
+
+    def in_modal?
+      search_state.params[:action] == "facet"
+    end
+
+    def modal_path
+      return unless paginator
+
+      view_context.search_facet_path(id: key) unless paginator&.last_page?
+    end
+
+    def label
+      view_context.facet_field_label(key)
+    end
+
+    # @private
+    # @deprecated
+    def html_id
+      Deprecation.silence(Blacklight::FacetsHelperBehavior) do
+        view_context.facet_field_id(facet_field)
+      end
+    end
+
+    def paginator
+      return unless display_facet
+
+      @paginator ||= view_context.facet_paginator(facet_field, display_facet)
+    end
+  end
+end

data/app/presenters/blacklight/facet_item_presenter.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class FacetItemPresenter
+    attr_reader :facet_item, :facet_config, :view_context, :search_state, :facet_field
+
+    delegate :hits, to: :facet_item
+
+    def initialize(facet_item, facet_config, view_context, facet_field, search_state = view_context.search_state)
+      @facet_item = facet_item
+      @facet_config = facet_config
+      @view_context = view_context
+      @facet_field = facet_field
+      @search_state = search_state
+    end
+
+    ##
+    # Check if the query parameters have the given facet field with the
+    # given value.
+    def selected?
+      search_state.has_facet? facet_config, value: facet_value
+    end
+
+    ##
+    # Get the displayable version of a facet's value
+    #
+    # @return [String]
+    def label
+      return @view_context.facet_display_value(@facet_field, @facet_item) unless @view_context.method(:facet_display_value).owner == Blacklight::FacetsHelperBehavior
+
+      value = if facet_item.respond_to? :label
+                facet_item.label
+              else
+                facet_value
+              end
+
+      if facet_config.helper_method
+        view_context.public_send(facet_config.helper_method, value)
+      elsif facet_config.query && facet_config.query[value]
+        facet_config.query[value][:label]
+      elsif facet_config.date
+        localization_options = facet_config.date == true ? {} : facet_config.date
+        I18n.l(Time.zone.parse(value), localization_options)
+      else
+        value
+      end
+    end
+
+    def href(path_options = {})
+      if selected?
+        remove_href
+      else
+        add_href(path_options)
+      end
+    end
+
+    # @private
+    def remove_href(path = search_state)
+      view_context.search_action_path(path.remove_facet_params(facet_config.key, facet_item))
+    end
+
+    # @private
+    def add_href(path_options = {})
+      if facet_config.url_method
+        view_context.public_send(facet_config.url_method, facet_config.key, facet_item)
+      else
+        view_context.search_action_path(search_state.add_facet_params_and_redirect(facet_config.key, facet_item).merge(path_options))
+      end
+    end
+
+    private
+
+    def facet_value
+      if facet_item.respond_to? :value
+        facet_item.value
+      else
+        facet_item
+      end
+    end
+  end
+end

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

@@ -5,7 +5,7 @@
   </button>
 </div>
 <div class="modal-body">
-  <% @documents.each do |document| %>
+  <% @documents&.each do |document| %>
     <h1 class="modal-title"><%= document_heading(document) %></h1>
 
     <% if document.respond_to?(:export_as_mla_citation_txt) %>

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

@@ -4,6 +4,6 @@
 
     <%= render 'start_over' %>
     <span class="constraints-label sr-only"><%= t('blacklight.search.filters.title') %></span>
-    <%= render_constraints(params) %>
+    <%= render_constraints(controller.params != params ? params : search_state) %>
   </div>
 <% end %>

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

@@ -7,27 +7,8 @@
     options ||= {}
 %>
 
-<span class="btn-group applied-filter constraint <%= options[:classes].join(" ") if options[:classes] %>">
-  <span class="constraint-value btn btn-outline-secondary btn-disabled">
-    <% unless label.blank? %>
-      <span class="filter-name"><%= label %></span>
-    <% end %>
-    <% unless value.blank? %>
-      <%= content_tag :span, value, class: 'filter-value', title: strip_tags(value) %>
-    <% end %>
-  </span>
-  <% unless options[:remove].blank? %>
-    <% accessible_remove_label = content_tag :span, class: 'sr-only' do
-        if label.blank?
-          t('blacklight.search.filters.remove.value', value: value)
-        else
-          t('blacklight.search.filters.remove.label_value', label: label, value: value)
-        end
-      end
-    %>
-
-    <%= link_to(content_tag(:span, '✖', class: 'remove-icon') + accessible_remove_label,
-			options[:remove], class: 'btn btn-outline-secondary remove'
-		) %>
-  <%- end -%>
-</span>
+<%= render(Blacklight::ConstraintLayoutComponent.new(
+      classes: options[:classes],
+      label: label,
+      value: value,
+      remove_path: options[:remove])) %>

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

@@ -24,7 +24,7 @@
       </div>
     </div>
 
-    <% @documents.each do |doc| %>
+    <% @documents&.each do |doc| %>
       <%=hidden_field_tag "id[]", doc.id %>
     <% end %>
     <%- if params[:sort] -%>

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

@@ -1,17 +1,8 @@
-<div class="card facet-limit blacklight-<%= facet_field.key.parameterize %> <%= 'facet-limit-active' if facet_field_in_params?(facet_field.key) %>">
-  <h3 class="card-header p-0 facet-field-heading" id="<%= facet_field_id(facet_field) %>-header">
-    <button
-      class="btn btn-block p-2 text-left collapse-toggle <%= "collapsed" if should_collapse_facet?(facet_field) %>"
-      data-toggle="collapse"
-      data-target="#<%= facet_field_id(facet_field) %>"
-      aria-expanded="<%= should_collapse_facet?(facet_field) ? 'false' : 'true' %>"
-    >
-      <%= facet_field_label(facet_field.key) %>
-    </button>
-  </h3>
-  <div id="<%= facet_field_id(facet_field) %>" aria-labelledby="<%= facet_field_id(facet_field) %>-header" class="panel-collapse facet-content collapse <%= "show" unless should_collapse_facet?(facet_field) %>">
-    <div class="card-body">
-      <%= yield %>
-    </div>
-  </div>
-</div>
+<%= render(Blacklight::FacetFieldComponent.new(facet_field: facet_field_presenter(facet_field, nil))) do |component| %>
+  <% component.with(:label) do %>
+    <%= facet_field_label(facet_field.key) %>
+  <% end %>
+  <% component.with(:body) do %>
+    <%= yield %>
+  <% end %>
+<% end %>

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

@@ -1,12 +1,3 @@
-<ul class="facet-values list-unstyled">
-  <% paginator = facet_paginator(facet_field, display_facet) %>
-  <%= render_facet_limit_list paginator, facet_field.key %>
-
-  <% unless paginator.last_page? || params[:action] == "facet" %>
-    <li class="more_facets">
-      <%= link_to t("more_#{field_name}_html", scope: 'blacklight.search.facets', default: :more_html, field_name: facet_field_label(facet_field.key)), 
-        search_facet_path(id: facet_field.key),
-        data: { blacklight_modal: 'trigger' } %>
-    </li>
-  <% end %>
-</ul>
+<%= render(Blacklight::FacetFieldListComponent.new(
+      facet_field: facet_field_presenter(facet_field, display_facet),
+      layout: false)) %>

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

@@ -1,10 +1,10 @@
 <div class="prev_next_links btn-group">
   <%= link_to_previous_page @pagination, raw(t('views.pagination.previous')), params: search_state.to_h, param_name: blacklight_config.facet_paginator_class.request_keys[:page], class: 'btn btn-link', data: { blacklight_modal: "preserve" } do %>
-    <%= content_tag :span, raw(t('views.pagination.previous')), class: 'disabled btn btn-disabled' %>
+    <%= content_tag :span, raw(t('views.pagination.previous')), class: 'disabled btn' %>
   <% end %>
 
   <%= link_to_next_page @pagination, raw(t('views.pagination.next')), params: search_state.to_h, param_name: blacklight_config.facet_paginator_class.request_keys[:page], class: 'btn btn-link',  data: { blacklight_modal: "preserve" } do %>
-    <%= content_tag :span, raw(t('views.pagination.next')), class: 'disabled btn btn-disabled' %>
+    <%= content_tag :span, raw(t('views.pagination.next')), class: 'disabled btn' %>
   <% end %>
 </div>
 

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

@@ -2,10 +2,10 @@
   <% display_facet.items.each do |item| -%>
     <li>
     <span class="facet-values">
-    <% if facet_in_params?(field_name, item) %>              
-        <%= render_selected_facet_value(field_name, item) %>              
-      <% else %>              
-        <%= render_facet_value(field_name, item) %>              
+    <% if facet_in_params?(field_name, item) %>
+        <%= render_selected_facet_value(field_name, item) %>
+      <% else %>
+        <%= render_facet_value(field_name, item) %>
     <% end -%>
     </span>
 

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

@@ -22,7 +22,7 @@
       </div>
 
     </div>
-    <% @documents.each do |doc| %>
+    <% @documents&.each do |doc| %>
        <%=hidden_field_tag "id[]", doc.id %>
     <% end %>
 </div>

data/blacklight.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
   s.add_dependency "jbuilder", '~> 2.7'
   s.add_dependency "kaminari", ">= 0.15" # the pagination (page 1,2,3, etc..) of our search results
   s.add_dependency "deprecation"
+  s.add_dependency "view_component"
 
   s.add_development_dependency "rsolr", ">= 1.0.6", "< 3"  # Library for interacting with rSolr.
   s.add_development_dependency "rspec-rails", "~> 4.0.0.beta2"

data/config/locales/blacklight.ar.yml

@@ -3,8 +3,8 @@ ar:
     pagination:
       first: 'الأولى «'
       last: 'الأخيرة »'
-      previous: '« السابقة'
-      next: 'التالية »'
+      previous: '« السابق'
+      next: 'التالي »'
       truncate: '…'
       aria:
         container_label: 'روابط الصفحات'
@@ -52,7 +52,8 @@ ar:
           few: 'أضيفت الصفحات المفضلة بنجاح.'
           many: 'أضيفت الصفحات المفضلة بنجاح.'
           other: 'أضيفت الصفحات المفضلة بنجاح.'
-        failure: 'معذرة! حدثت مشكلة في حفظ الصفحات المفضلة.'
+
+        failure:  'معذرة! حدثت مشكلة في حفظ الصفحات المفضلة.'
       remove:
         button: 'إزالة الصفحة المفضلة'
         success: 'أزيلت الصفحة المفضلة بنجاح.'
@@ -61,7 +62,7 @@ ar:
       clear:
         action_title: 'مسح الصفحات المفضلة'
         action_confirm: 'هل ترغب في مسح الصفحات المفضلة؟'
-        success: 'ُمسِحَت صفحاتك المفضلة.'
+        success: 'تم مسح صفحاتك المفضلة.'
         failure: 'معذرة! حدثت مشكلة في مسح صفحاتك المفضلة.'
       need_login: 'يُرجى تسجيل الدخول لتنظيم صفحاتك المفضلة وعرضها.'
       list_title: 'صفحاتك المفضلة'
@@ -69,14 +70,14 @@ ar:
 
     search_history:
       clear:
-        action_title: 'مسح سجل البحث السابق'
+        action_title: 'امسح سجل البحث السابق'
         action_confirm: 'هل ترغب في مسح سجل البحث السابق؟'
-        success: 'ُمسِحَ سجل بحثك السابق.'
+        success: 'تم مسح سجل بحثك السابق.'
         failure: 'حدثت مشكلة في مسح سجل بحثك السابق.'
       title: 'سجل البحث'
       page_title: 'سجل البحث - %{application_name}'
-      no_history: 'ليس لديك سجل بحث'
-      recent: 'استعلامات البحث الأخيرة'
+      no_history: 'لا يوجد لديك سجل بحث'
+      recent: 'سجل ابحاثك السابقة'
       forget: 'تراجع'
       save: 'حفظ'
 
@@ -84,7 +85,7 @@ ar:
       title: 'أدوات'
       citation: 'استشهاد مرجعي'
       email: 'بريد إلكتروني'
-      sms: 'إرسال كرسالة نصية قصيرة'
+      sms: 'إرسله كرسالة نصية قصيرة'
       clear: 'مسح'
 
     citation:
@@ -94,12 +95,12 @@ ar:
 
     email:
       form:
-        title: 'إرسال بالبريد الإلكتروني'
+        title: 'إرسله عبرالبريد الإلكتروني'
         to: 'بريد إلكتروني:'
         message: 'الرسالة:'
         submit: 'إرسال'
       text:
-        default_title: 'لا ينطبق'
+        default_title: 'لا يوجد'
         title: 'العنوان: %{value}'
         author: 'المؤلف: %{value}'
         format: 'الصيغة: %{value}'
@@ -111,30 +112,31 @@ ar:
           few: 'سجلات المادة'
           many: 'سجلات المادة'
           other: 'سجلات المادة'
+
         url: 'الرابط: %{url}'
         message: 'الرسالة: %{message}'
 
-      success: 'تم إرسال البريد الإلكتروني'
+      success: "تم إرسال البريد الإلكتروني"
+
       errors:
         to:
           invalid: 'يجب إدخال عنوان بريد إلكتروني صحيح'
           blank: 'يجب إدخال مُستلم من أجل إرسال هذه الرسالة'
-
     sms:
       form:
-        title: 'إرسال كرسالة نصية قصيرة'
+        title: 'إرسله كرسالة نصية قصيرة'
         to: 'رقم الهاتف:'
         carrier: 'شركة الاتصالات'
         carrier_prompt: 'يرجى تحديد شركة الاتصالات'
         submit: 'إرسال'
       text:
         title: '%{value}'
-        author: ' حسب %{value}'
+        author: ' بواسطة %{value}'
         url: 'الرابط: %{url}'
-      success: 'تم الإرسال كرسالة نصية قصيرة'
+      success: "تم الإرسال كرسالة نصية قصيرة"
       errors:
         to:
-          invalid: 'يجب إدخال رقم هاتف صحيح من 10 أعداد'
+          invalid: 'يجب إدخال رقم هاتف صحيح من 10 أرقام'
           blank: "يجب إدخال رقم هاتف المستلم لإرسال هذه الرسالة"
         carrier:
           blank: 'يجب تحديد شركة الاتصالات'
@@ -148,11 +150,11 @@ ar:
         title: '%{constraints} - %{application_name} نتائج البحث'
         constraint: '%{label}: %{value}'
         many_constraint_values: 'تم تحديد %{values}'
-      header: 'البحث'
+      header: 'ابحث'
       search_constraints_header: 'قيود البحث'
       search_results: 'نتائج البحث'
       errors:
-        request_error: "معذرة، لا أفهم ما تبحث عنه."
+        request_error: "معذرة، لم أفهم ما تبحث عنه."
         invalid_solr_id: "معذرة! لقد طلبت سجلًا غير موجود."
       per_page:
         label: '%{count}<span class="sr-only"> لكل صفحة</span>'
@@ -160,18 +162,18 @@ ar:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> لكل صفحة</span>'
         title: 'عدد النتائج المعروضة في الصفحة'
         submit: 'تحديث'
-        aria_label: 'الملاحة النتائج'
+        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: 'بحث في'
+          label: 'ابحث في'
           title: 'خيارات البحث المستهدفة'
           post_label: 'عن'
         search:
-          label: 'بحث عن'
+          label: 'ابحث عن'
           placeholder: 'بحث...'
         submit: 'بحث'
       pagination:
@@ -186,6 +188,7 @@ ar:
           few: '<strong>%{start_num}</strong> - <strong>%{end_num}</strong> من <strong>%{total_num}</strong>'
           many: '<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:
         zero: '<strong>%{current}</strong> من <strong>%{total}</strong>'
         one: '<strong>%{current}</strong> من <strong>%{total}</strong>'
@@ -193,10 +196,11 @@ ar:
         few: '<strong>%{current}</strong> من <strong>%{total}</strong>'
         many: '<strong>%{current}</strong> من <strong>%{total}</strong>'
         other: '<strong>%{current}</strong> من <strong>%{total}</strong>'
+
       documents:
         aria:
           search_results: 'نتائج البحث'
-          limit_search: 'تحديد نطاق البحث'
+          limit_search: '...ابحث عن العناصر حسب'
         counter: '%{counter}. '
       facets:
         title: 'تحديد نطاق البحث'
@@ -233,9 +237,9 @@ ar:
       zero_results:
         title: "لا توجد نتائج للبحث"
         modify_search: "حاول تعديل معايير البحث"
-        use_fewer_keywords: "استخدم كلمات مفتاحية أقل في البداية، ثم أعد تنقيح البحث باستخدام الروابط على اليسار."
+        use_fewer_keywords: "استخدم كلمات أساسية أقل أولاً، ثم أعد تحديد البحث باستخدام الروابط على اليسار."
         search_fields: "لقد بحثت باستخدام %{search_fields}"
-        search_everything: "أعد البحث عن كل شيء"
+        search_everything: "حاول البحث عن كل شيء"
       view_title: "عرض النتائج ك: "
       view:
         list: "قائمة"