blacklight-spotlight 3.0.0.alpha.6 → 3.0.0.rc1

data/config/i18n-tasks.yml

@@ -34,6 +34,7 @@ ignore_unused:
   - activerecord.attributes.spotlight/page.{display_sidebar\?,display_title} # app/views/spotlight/home_pages/_page_options.html.erb
   - activerecord.attributes.spotlight/language.locale # app/views/spotlight/exhibits/_languages.html.erb
   - activerecord.attributes.spotlight/contact.avatar # app/views/spotlight/contacts/_form.html.erb
+  - activerecord.attributes.spotlight/exhibit.contact_emails # app/views/spotlight/exhibits/_form.html.erb
   - activerecord.attributes.spotlight/exhibit.published # app/views/spotlight/sites/_exhibit.html.erb
   - activerecord.attributes.spotlight/masthead.display # app/views/spotlight/appearances/edit.html.erb
   - activerecord.attributes.spotlight/custom_field.is_multiple # app/views/spotlight/custom_fields/_form.html.erb
@@ -66,6 +67,7 @@ ignore_unused:
   - helpers.submit.{submit,update} # Generically used set defaults
   - helpers.submit.contact.create # app/views/spotlight/contacts/_form.html.erb
   - helpers.action.exhibit.contact.submit # helpers.action.exhibit.contact.submit
+  - helpers.label.contact_form.{email,name} # app/views/spotlight/shared/_report_a_problem.html.erb
 
   # TODO Look into these as its unclear
   - activerecord.models.spotlight.page

data/config/locales/spotlight.ar.yml

@@ -1,40 +1,63 @@
+---
 ar:
-  activemodel:
-    attributes:
-      spotlight/contact_form:
-        email: البريد الإلكتروني
-        message: الرسالة
-        name: الاسم
   helpers:
     action:
       cancel: إلغاء
     submit:
       contact_form:
-        create: إرسال
-        created: .نشكرك على رسالتك. لقد تم إرسال ملاحظاتك واقتراحاتك
+        create: ارسل
+        created: شكراً. لقد تم إرسال ملاحظاتك واقتراحاتك.
   spotlight:
     about_pages:
       contacts:
-        header: عنوان فرعي
-    header_links:
-      contact: ملاحظات واقتراحات
-    shared:
-      report_a_problem:
-        honeypot_field_explanation: .تجاهل هذا المربع النصي، فهو يُستخدم فقط لكشف المحتالين. إذا كتبت أي شيء في هذا المربع النصي، فلن يتم إرسال رسالتك
-        title: عنوان
+        header: جهات الاتصال
+    breadcrumb:
+      label: مسار التنقل
     browse:
       search:
         item_count:
-          one: "%{count} مادة"
-          other: "%{count} مواد"
+          zero: "%{count} عنصر"
+          one: "%{count} عنصر"
+          two: "%{count} عنصرين"
+          few: "%{count} عناصر"
+          many: "%{count} عنصراً"
+          other: "%{count} عنصراً"
+
       search_box:
-        label: البحث في فئة التصفح الحالية
-        placeholder: ...بحث
+        label: ابحث في فئة التصفح الحالية
+        placeholder: بحث...
         reset: مسح استعلام البحث
-        submit: البحث في فئة التصفح
+        submit: ابحث في فئة التصفح
         success:
-          expand_html: يمكنك <a href="%{expand_search_url}">البحث في كل مواد المعرض عن "%{browse_query}"</a>.
-          result_number_html: طابق استعلام البحث <strong> %{search_size} من %{parent_search_count} مادة</strong> .في هذه الفئة
+          expand_html: "يمكنك ايضاً <a href=\"%{expand_search_url}\">البحث في كل مواد المعرض عن \"%{browse_query}\"</a>."
+          result_number_html: "طابق استعلام البحث <strong> %{search_size} من %{parent_search_count} عنصر</strong> في هذه الفئة."
         zero_results:
-          expand_html: <a href="%{clear_search_url}"> امسح استعلام المسح </a> أو حاول <a href="%{expand_search_url}">.البحث في كل المواد المعروضة لاستعلام البحث "%{browse_query}"</a>
-          result_number: .لم يتطابق بحثك مع أي مادة في هذه الفئة
+          expand_html: "تستطيع أن <a href=\"%{clear_search_url}\"> تمسح استعلام البحث </a> أو محاولة <a href=\"%{expand_search_url}\"> البحث في كل المواد المعروضة لاستعلام البحث ل\"%{browse_query}\"</a>"
+          result_number: لم يتطابق بحثك مع أي عنصر في هذه الفئة.
+    header_links:
+      contact: ملاحظات واقتراحات
+      login: تسجيل الدخول
+      logout: تسجيل الخروج
+    shared:
+      report_a_problem:
+        honeypot_field_explanation: تجاهل هذا المربع النصي، فهو يُستخدم فقط لكشف المحتالين. إذا كتبت أي شيء في هذا المربع النصي، فلن يتم إرسال رسالتك.
+        title: تواصل معنا
+    sir_trevor:
+      blocks:
+        browse_block:
+          items:
+            zero: "%{count} عنصر"
+            one: "%{count} عنصر"
+            two: "%{count} عنصرين"
+            few: "%{count} عناصر"
+            many: "%{count} عنصراً"
+            other: "%{count} عنصراً"
+
+        link_to_search_block:
+          items:
+            zero: "%{count} عنصر"
+            one: "%{count} عنصر"
+            two: "%{count} عنصرين"
+            few: "%{count} عناصر"
+            many: "%{count} عنصراً"
+            other: "%{count} عنصراً"

data/config/locales/spotlight.en.yml

@@ -9,6 +9,7 @@ en:
       spotlight/custom_search_field:
         field: Solr specification
       spotlight/exhibit:
+        contact_emails: Feedback recipients
         published: Published?
       spotlight/language:
         locale: Language
@@ -52,6 +53,9 @@ en:
       update_all: Save changes
       view: View
     label:
+      contact_form:
+        email: Your email
+        name: Your name
       solr_document:
         exhibit_tag_list: Tags
       spotlight/filter:
@@ -187,7 +191,6 @@ en:
         page_title: Manage users
         pending: pending
         save: Add role
-        section: Manage exhibits
         update: Make user an administrator
     appearances:
       edit:
@@ -195,7 +198,6 @@ en:
         main_navigation:
           help: Select the menu items you want to be displayed in the main navigation menu (menu items are only displayed when published pages exist for that item). Click a menu item to change its display label. Drag and drop a menu item to change their order in the menu.
           menu: Main menu
-        restore_default: Restore default
         site_masthead:
           heading: Exhibit masthead
           help: You can select and crop an image to use as a background in your exhibit site's masthead. To use an image as a masthead background, you should use an image that is at least 120 pixels tall and 1200 pixels wide. For best results use an image at least 1800 pixels wide. You can crop larger images using the cropping tool below.
@@ -373,10 +375,10 @@ en:
         not_validated: Not validated.
         resend: Resend confirmation?
       contact:
-        email_delete_button: Delete contact
-        email_delete_confirmation: Delete contact email address?
-        email_delete_error: 'Problem deleting contact email:'
-        email_input_aria_label: Contact email %{index}
+        email_delete_button: Delete recipient
+        email_delete_confirmation: Delete recipient email address?
+        email_delete_error: 'Problem deleting recipient:'
+        email_input_aria_label: Recipient email %{index}
       delete:
         heading: Delete exhibit
         warning_html: This action is irreversible. Be sure to back up the exhibit settings and content using the %{export_link} feature before proceeding.
@@ -394,10 +396,10 @@ en:
         heading: Filter items
         instructions: You can limit the items included in this exhibit by applying a filter to your Solr index. When you apply a filter, only items with values that match the filter will be included in your exhibit. To apply a filter, enter both a field and a value that match the names used in your Solr index.
       form:
-        add_contact_email_button: Add new contact
+        add_contact_email_button: Add new recipient
         fields:
           contact_emails:
-            help_block: Each contact email will receive feedback submissions
+            help_block: Each recipient will receive submissions made through the feedback form
           published:
             help_block: ''
         uneditable_non_default_language: This field is not editable in the current language. Switch to the default language to edit it.
@@ -424,7 +426,7 @@ en:
           language: Language
           public: Public
       new:
-        header: Create a new exhibit
+        page_title: Create a new exhibit
       new_exhibit_form:
         fields:
           slug:
@@ -435,59 +437,6 @@ en:
             label: Title
       tags:
         all: All
-      translations:
-        browse_categories:
-          default_language_column_label: English language title
-          description_label: Description
-          label: Browse categories
-          translation_column_label: "%{language} translation"
-        general:
-          basic_settings:
-            description: Description
-            label: Basic Settings
-            subtitle: Subtitle
-            title: Title
-          label: General
-          main_menu:
-            about: About
-            browse: Browse
-            curated_features: Curated Features
-            home: Home
-            label: Main Menu
-        metadata:
-          exhibit_specific_fields:
-            label: Exhibit-Specific Fields
-          label: Metadata field labels
-        pages:
-          about_pages:
-            label: About Pages
-          destroy: Delete
-          destroy_are_you_sure: Are you sure you want to delete this page? If you delete this page all content, including any existing translations you have made in it, will be lost.
-          edit: Edit
-          feature_pages:
-            label: Feature Pages
-          help_html: Before exhibit visitors can view translated pages you must create, edit, and publish each page translation. When you create a translated page, a copy of the default language version of the page is made to serve as the initial translated page. You can then edit that translated page to replace the page title and any text fields with translated text. A translated page will not be visible to exhibit visitors until you publish it.  To replace a translated page with a current copy of the default language version of the page, use the <i>Recreate</i> action.
-          home_page:
-            label: Home Page
-          label: Pages
-          new: Create one now.
-          no_translated_page: No translated page.
-          recreate: Recreate
-          recreate_are_you_sure: Are you sure you want to recreate this page? If you recreate this page all content, including any existing translations you have made, will be replaced with the content of the English version of the page.
-          table_header:
-            actions: Actions
-            default_published: Published
-            language_published: Published
-            last_updated: "%{language} title / Last update"
-        search_fields:
-          facet_fields:
-            label: Facet Fields
-          field_based_search_fields:
-            label: Field-Based Search Fields
-          label: Search field labels
-          sort_fields:
-            label: Sort Fields
-        title: Translations
     exhibits_admin_invitation_mailer:
       invitation_instructions:
         accept: Accept invitation
@@ -540,6 +489,8 @@ en:
         body:
           one: "%{count} document has been indexed from the CSV file and added to the exhibit %{title}."
           other: "%{count} documents have been indexed from the CSV file and added to the exhibit %{title}."
+        error: 'Row %{index}: %{message}'
+        errors: Errors
         title: Your CSV file has just finished being processed.
     invitation_mailer:
       invitation_instructions:
@@ -766,10 +717,13 @@ en:
           other: "%{count} items"
         missing_description_html: "%{link} to add a description."
     shared:
+      dd3_item:
+        restore_default: Restore default
       exhibit_sidebar:
         header: Administration menu
       report_a_problem:
         honeypot_field_explanation: Ignore this text box. It is used to detect spammers. If you enter anything into this text box, your message will not be sent.
+        reporting_from: 'Reporting from: %{url}'
         title: Contact Us
     sir_trevor:
       blocks:
@@ -786,7 +740,6 @@ en:
         basic_settings:
           heading: Title
         page_title: Customize appearance
-        section: Manage exhibits
         site_masthead:
           heading: Site masthead
           help: |
@@ -795,13 +748,10 @@ en:
       edit_exhibits:
         instructions: Drag and drop the exhibits below to specify the order in which they are displayed on the exhibits homepage.
         page_title: Order exhibits
-        section: Manage exhibits
       exhibit:
         published: Published
         unpublished: Unpublished
-      new:
-        page_title: Create a new exhibit
-        section: Manage exhibits
+      home: Exhibits
     tags:
       index:
         actions: Actions
@@ -812,6 +762,71 @@ en:
           count: Items tagged
     topbar:
       label: Utilities
+    translations:
+      browse_categories:
+        default_language_column_label: English language title
+        description_label: Description
+        label: Browse categories
+        subtitle_label: Subtitle
+        translation_column_label: "%{language} translation"
+      edit:
+        title: Translations
+      general:
+        basic_settings:
+          description: Description
+          label: Basic Settings
+          subtitle: Subtitle
+          title: Title
+        label: General
+        main_menu:
+          about: About
+          browse: Browse
+          curated_features: Curated Features
+          home: Home
+          label: Main Menu
+      import:
+        description: You can import and export Rails-based YAML files containing the translated label values for the currently selected language for use in internationalization tools such as Transifex and i18n-tools. This feature does not include importing or exporting translations for Pages.
+        export_current_locale: Export %{language}
+        export_default_locale: Export %{language}
+        export_label: Export a YAML file
+        header: Import and export translations
+        import_label: Import a YAML file
+        import_submit: Import translations
+      metadata:
+        exhibit_specific_fields:
+          label: Exhibit-Specific Fields
+        label: Metadata field labels
+      page:
+        destroy: Delete
+        destroy_are_you_sure: Are you sure you want to delete this page? If you delete this page all content, including any existing translations you have made in it, will be lost.
+        edit: Edit
+        new: Create one now.
+        no_translated_page: No translated page.
+        recreate: Recreate
+        recreate_are_you_sure: Are you sure you want to recreate this page? If you recreate this page all content, including any existing translations you have made, will be replaced with the content of the English version of the page.
+      pages:
+        about_pages:
+          label: About Pages
+        feature_pages:
+          label: Feature Pages
+        help_html: Before exhibit visitors can view translated pages you must create, edit, and publish each page translation. When you create a translated page, a copy of the default language version of the page is made to serve as the initial translated page. You can then edit that translated page to replace the page title and any text fields with translated text. A translated page will not be visible to exhibit visitors until you publish it.  To replace a translated page with a current copy of the default language version of the page, use the <i>Recreate</i> action.
+        home_page:
+          label: Home Page
+        label: Pages
+      pages_table:
+        header:
+          actions: Actions
+          default_published: Published
+          language_published: Published
+          last_updated: "%{language} title / Last update"
+      search_fields:
+        facet_fields:
+          label: Facet Fields
+        field_based_search_fields:
+          label: Field-Based Search Fields
+        label: Search field labels
+        sort_fields:
+          label: Sort Fields
     versions:
       redo: Redo changes
       undo: Undo changes

data/config/routes.rb

@@ -143,7 +143,12 @@ Spotlight::Engine.routes.draw do
       end
     end
     post 'solr/update' => 'solr#update'
-    resource :translations, only: %i[edit update]
+    resource :translations, only: %i[edit update show] do
+      collection do
+        post 'import'
+        patch 'import'
+      end
+    end
   end
 
   get '/:exhibit_id' => 'home_pages#show', as: :exhibit_root

data/db/migrate/20200403161512_add_subtitle_to_searches.rb

@@ -0,0 +1,7 @@
+class AddSubtitleToSearches < ActiveRecord::Migration[5.2]
+  def change
+    change_table :spotlight_searches do |t|
+      t.string :subtitle
+    end
+  end
+end

data/lib/generators/spotlight/install_generator.rb

@@ -10,6 +10,25 @@ module Spotlight
     class_option :solr_update_class, type: :string, default: 'Spotlight::SolrDocument::AtomicUpdates'
     class_option :mailer_default_url_host, type: :string, default: '' # e.g. localhost:3000
 
+    # we're not (yet) using webpacker, so we need to re-add sprockets functionality
+    def add_js
+      return unless Rails.version.to_i == 6
+
+      gem 'coffee-rails', '~> 4.2'
+      gem 'uglifier', '>= 1.3.0'
+
+      append_to_file 'app/assets/config/manifest.js', '//= link_directory ../javascripts .js'
+      append_to_file 'app/assets/javascripts/application.js', '//= require_tree .'
+      gsub_file 'app/views/layouts/application.html.erb', /pack/, 'include'
+      inject_into_file 'config/environments/production.rb', after: '  # config.assets.css_compressor = :sass' do
+        "\n  config.assets.js_compressor = :uglifier"
+      end
+
+      # but since webpacker exists in the gemfile, we still need to run the
+      # install before rails will start
+      run 'bundle exec rails webpacker:install'
+    end
+
     def inject_spotlight_routes
       route "mount Spotlight::Engine, at: 'spotlight'"
       gsub_file 'config/routes.rb', /^\s*root.*/ do |match|
@@ -53,7 +72,9 @@ module Spotlight
     end
 
     def add_roles_to_user
-      inject_into_class 'app/models/user.rb', User, '  include Spotlight::User'
+      inject_into_file 'app/models/user.rb', after: 'include Blacklight::User' do
+        "\n  include Spotlight::User\n"
+      end
     end
 
     def add_controller_mixin

data/lib/generators/spotlight/templates/config/initializers/sir_trevor_rails.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Required for 0.6 and up:
+# https://github.com/madebymany/sir-trevor-rails#upgrade-guide-to-v060
+class SirTrevorRails::Block
+  def self.custom_block_types
+    # You can define your custom block types directly here or in your engine config.
+    Spotlight::Engine.config.sir_trevor_widgets
+  end
+end

data/lib/generators/spotlight/templates/config/initializers/spotlight_initializer.rb

@@ -70,6 +70,8 @@
 # Spotlight::Engine.config.ga_anonymize_ip = false # false for backwards compatibility
 
 # ==> Sir Trevor Widget Configuration
+# These are set by default by Spotlight's configuration,
+# but you can customize them here, or in the SirTrevorRails::Block#custom_block_types method
 # Spotlight::Engine.config.sir_trevor_widgets = %w(
 #   Heading Text List Quote Iframe Video Oembed Rule UploadedItems Browse
 #   FeaturedPages SolrDocuments SolrDocumentsCarousel SolrDocumentsEmbed

data/lib/spotlight/engine.rb

@@ -160,6 +160,7 @@ module Spotlight
 
     # Configure the CarrierWave file storage mechanism
     config.uploader_storage = :file
+    config.featured_image_masthead_size = [1800, 180]
     config.featured_image_thumb_size = [400, 300]
     config.featured_image_square_size = [400, 400]
     config.contact_square_size = [70, 70]
@@ -192,6 +193,7 @@ module Spotlight
     config.ga_analytics_options = {}
     config.ga_page_analytics_options = config.ga_analytics_options.merge(limit: 5)
     config.ga_anonymize_ip = false # false for backwards compatibility
+    config.max_pages = 1000
 
     Blacklight::Engine.config.inject_blacklight_helpers = false
 
@@ -213,6 +215,25 @@ module Spotlight
     # add could add an available locale which could break things if unexpected.
     config.i18n.available_locales = config.i18n_locales.keys
 
+    # Copy of JbuilderHandler tweaked to spit out YAML for translation exports
+    class TranslationYamlHandler
+      cattr_accessor :default_format
+      self.default_format = :yaml
+
+      def self.call(template, source = nil)
+        source ||= template.source
+        # this juggling is required to keep line numbers right in the error
+        %{__already_defined = defined?(json); json||=JbuilderTemplate.new(self); #{source}
+          json.attributes!.to_yaml unless (__already_defined && __already_defined != "method")}
+      end
+    end
+
+    initializer :yamlbuilder do
+      ActiveSupport.on_load :action_view do
+        ActionView::Template.register_template_handler :yamlbuilder, TranslationYamlHandler
+      end
+    end
+
     # Query parameters for autocomplete requests
     config.autocomplete_search_field = 'autocomplete'
     config.default_autocomplete_params = { qf: 'id^1000 full_title_tesim^100 id_ng full_title_ng',
@@ -242,6 +263,9 @@ module Spotlight
     config.exhibit_themes = ['default']
 
     config.default_page_content_type = 'SirTrevor'
+
+    # Added here for backwards compatability with SirTrevor 0.6
+    # and apps who have customized their avaialble widgets
     config.sir_trevor_widgets = %w[
       Heading Text List Quote Iframe Video Oembed Rule UploadedItems Browse LinkToSearch
       FeaturedPages SolrDocuments SolrDocumentsCarousel SolrDocumentsEmbed
@@ -251,6 +275,8 @@ module Spotlight
     config.routes = OpenStruct.new
     config.routes.solr_documents = {}
 
+    config.controller_tracking_method = 'track_catalog_path'
+
     config.exports = {
       attachments: true,
       blacklight_configuration: true,