blacklight-spotlight 1.5.1 → 2.0.0.rc1

data/config/routes.rb

@@ -36,6 +36,7 @@ Spotlight::Engine.routes.draw do
     resource :view_configuration, only: [:show]
 
     resources :filters, only: [:create, :update]
+    resources :languages, only: [:create, :destroy]
 
     concern :searchable, Blacklight::Routes::Searchable.new
 
@@ -95,7 +96,16 @@ Spotlight::Engine.routes.draw do
     resources :tags, only: [:index, :destroy]
 
     resources :contacts, only: [:edit, :update, :destroy]
+
+    resources :pages, only: [:update_all] do
+      collection do
+        patch :update_all
+      end
+    end
     resources :about_pages, path: 'about' do
+      member do
+        get :clone
+      end
       collection do
         patch 'contacts' => 'about_pages#update_contacts'
         resources :contacts, only: [:new, :create]
@@ -103,11 +113,18 @@ Spotlight::Engine.routes.draw do
       end
     end
     resources :feature_pages, path: 'feature' do
+      member do
+        get :clone
+      end
       collection do
         patch :update_all
       end
     end
-    resource :home_page, path: 'home', controller: 'home_pages'
+    resource :home_page, path: 'home', controller: 'home_pages' do
+      member do
+        get :clone
+      end
+    end
     post '/pages/:id/preview' => 'pages#preview', as: :preview_block
     get '/pages' => 'pages#index', constraints: { format: 'json' }
 
@@ -119,6 +136,7 @@ Spotlight::Engine.routes.draw do
       end
     end
     post 'solr/update' => 'solr#update'
+    resource :translations, only: [:edit, :update]
   end
 
   get '/:exhibit_id' => 'home_pages#show', as: :exhibit_root

data/db/migrate/20180308203409_create_spotlight_languages.rb

@@ -0,0 +1,12 @@
+class CreateSpotlightLanguages < ActiveRecord::Migration[5.0]
+  def change
+    create_table :spotlight_languages do |t|
+      t.string :locale, null: false
+      t.boolean :public
+      t.string :text
+      t.references :exhibit
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20180403130857_translation_uniqueness.rb

@@ -0,0 +1,5 @@
+class TranslationUniqueness < ActiveRecord::Migration[5.0]
+  def change
+    add_index(:translations, [:exhibit_id, :key, :locale], unique: true)
+  end
+end

data/db/migrate/20180405044000_add_locale_to_pages.rb

@@ -0,0 +1,6 @@
+class AddLocaleToPages < ActiveRecord::Migration[5.0]
+  def change
+    add_column :spotlight_pages, :locale, :string, default: I18n.default_locale
+    add_index :spotlight_pages, :locale
+  end
+end

data/db/migrate/20180406212516_add_default_locale_reference_to_spotlight_pages.rb

@@ -0,0 +1,7 @@
+class AddDefaultLocaleReferenceToSpotlightPages < ActiveRecord::Migration[5.0]
+  def change
+    change_table :spotlight_pages do |t|
+      t.references :default_locale_page
+    end
+  end
+end

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

@@ -17,9 +17,9 @@ class CatalogController < ApplicationController
     # solr field configuration for search results/index views
     config.index.title_field = 'full_title_tesim'
 
-    config.add_search_field 'all_fields', label: 'Everything'
+    config.add_search_field 'all_fields', label: I18n.t('spotlight.search.fields.search.all_fields')
 
-    config.add_sort_field 'relevance', sort: 'score desc', label: 'Relevance'
+    config.add_sort_field 'relevance', sort: 'score desc', label: I18n.t('spotlight.search.fields.sort.relevance')
 
     config.add_field_configuration_to_solr_request!
 

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

@@ -37,11 +37,21 @@
 
 # ==> Uploaded item configuration
 # Spotlight::Engine.config.upload_fields = [
-#   OpenStruct.new(field_name: :spotlight_upload_description_tesim, label: 'Description', form_field_type: :text_area),
-#   OpenStruct.new(field_name: :spotlight_upload_attribution_tesim, label: 'Attribution'),
-#   OpenStruct.new(field_name: :spotlight_upload_date_tesim, label: 'Date')
+#   UploadFieldConfig.new(
+#     field_name: config.upload_description_field,
+#     label: -> { I18n.t(:"spotlight.search.fields.#{config.upload_description_field}") },
+#     form_field_type: :text_area
+#   ),
+#   UploadFieldConfig.new(
+#     field_name: :spotlight_upload_attribution_tesim,
+#     label: -> { I18n.t(:'spotlight.search.fields.spotlight_upload_attribution_tesim') }
+#   ),
+#   UploadFieldConfig.new(
+#     field_name: :spotlight_upload_date_tesim,
+#     label: -> { I18n.t(:'spotlight.search.fields.spotlight_upload_date_tesim') }
+#   )
 # ]
-# Spotlight::Engine.config.upload_title_field = nil # OpenStruct.new(...)
+# Spotlight::Engine.config.upload_title_field = nil # UploadFieldConfig.new(...)
 # Spotlight::Engine.config.uploader_storage = :file
 # Spotlight::Engine.config.allowed_upload_extensions = %w(jpg jpeg png)
 

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

@@ -1,4 +1,5 @@
 require 'i18n/backend/active_record'
+require 'i18n/backend/fallbacks'
 
 Translation = I18n::Backend::ActiveRecord::Translation
 
@@ -7,11 +8,12 @@ if Translation.table_exists?
   # Sets up the new Spotlight Translation backend, backed by ActiveRecord. To
   # turn on the ActiveRecord backend, uncomment the following lines.
 
-  # I18n.backend = I18n::Backend::ActiveRecord.new
+  I18n.backend = I18n::Backend::ActiveRecord.new
   I18n::Backend::ActiveRecord.send(:include, I18n::Backend::Memoize)
   Translation.send(:include, Spotlight::CustomTranslationExtension)
   I18n::Backend::Simple.send(:include, I18n::Backend::Memoize)
   I18n::Backend::Simple.send(:include, I18n::Backend::Pluralization)
+  I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
 
-  # I18n.backend = I18n::Backend::Chain.new(I18n.backend, I18n::Backend::Simple.new)
+  I18n.backend = I18n::Backend::Chain.new(I18n.backend, I18n::Backend::Simple.new)
 end

data/lib/migration/page_language.rb

@@ -0,0 +1,27 @@
+module Migration
+  ##
+  # This migration sets the Spotlight::Page locale to the I18n.default_locale.
+  # Needed for migrating Exhibits to internationalization work.
+  class PageLanguage
+    def self.run
+      new.run
+    end
+
+    def initialize; end
+
+    def run
+      migrate_pages
+    end
+
+    private
+
+    def migrate_pages
+      FriendlyId::Slug.where(sluggable_type: 'Spotlight::Page').find_each do |slug|
+        unless /locale:\w+/ =~ slug.scope
+          slug.scope += ",locale:#{I18n.default_locale}"
+          slug.save
+        end
+      end
+    end
+  end
+end

data/lib/spotlight/engine.rb

@@ -13,6 +13,7 @@ require 'paper_trail'
 require 'clipboard/rails'
 require 'leaflet-rails'
 require 'i18n/active_record'
+require 'spotlight/upload_field_config'
 
 module Spotlight
   ##
@@ -126,13 +127,23 @@ module Spotlight
     config.thumbnail_field = :thumbnail_url_ssm
 
     # Defaults to the blacklight_config.index.title_field:
-    config.upload_title_field = nil # OpenStruct.new(...)
+    config.upload_title_field = nil # UploadFieldConfig.new(...)
     config.upload_description_field = :spotlight_upload_description_tesim
 
     config.upload_fields = [
-      OpenStruct.new(field_name: config.upload_description_field, label: 'Description', form_field_type: :text_area),
-      OpenStruct.new(field_name: :spotlight_upload_attribution_tesim, label: 'Attribution'),
-      OpenStruct.new(field_name: :spotlight_upload_date_tesim, label: 'Date')
+      UploadFieldConfig.new(
+        field_name: config.upload_description_field,
+        label: -> { I18n.t(:"spotlight.search.fields.#{config.upload_description_field}") },
+        form_field_type: :text_area
+      ),
+      UploadFieldConfig.new(
+        field_name: :spotlight_upload_attribution_tesim,
+        label: -> { I18n.t(:'spotlight.search.fields.spotlight_upload_attribution_tesim') }
+      ),
+      UploadFieldConfig.new(
+        field_name: :spotlight_upload_date_tesim,
+        label: -> { I18n.t(:'spotlight.search.fields.spotlight_upload_date_tesim') }
+      )
     ]
 
     config.iiif_manifest_field = :iiif_manifest_url_ssi
@@ -176,6 +187,23 @@ module Spotlight
 
     Blacklight::Engine.config.inject_blacklight_helpers = false
 
+    config.i18n_locales = {
+      de: 'Deutsch',
+      en: 'English',
+      es: 'Español',
+      fr: 'Français',
+      it: 'Italiano',
+      hu: 'Magyar',
+      nl: 'Nederlands',
+      'pt-br': 'Português brasileiro',
+      sq: 'Shqip',
+      zh: '中文'
+    }
+
+    # Whitelisting the available_locales is necessary here, as any dependency we
+    # add could add an available locale which could break things if unexpected.
+    config.i18n.available_locales = config.i18n_locales.keys
+
     # 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',

data/lib/spotlight/upload_field_config.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ##
+  # A class to model the configuration required to build the Document Upload form.
+  # This configuration is also used in other places around the application (e.g. Metadata Field Config)
+  # See Spotlight::Engine.config.upload_fields for where this is consumed
+  # We should look into changing this to a standard blacklight field config in Blacklight 7
+  class UploadFieldConfig
+    attr_reader :blacklight_options, :field_name, :form_field_type
+    def initialize(blacklight_options: {}, field_name:, form_field_type: :text_field, label: nil)
+      @blacklight_options = blacklight_options
+      @field_name = field_name
+      @form_field_type = form_field_type
+      @label = label || field_name
+    end
+
+    # aliasing for backwards compatability and consistency with blacklight config
+    alias solr_field field_name
+
+    # Allows a proc to be set as the label
+    def label
+      return @label.call if @label.is_a?(Proc)
+      @label
+    end
+  end
+end

data/lib/spotlight/version.rb

@@ -1,3 +1,3 @@
 module Spotlight
-  VERSION = '1.5.1'.freeze
+  VERSION = '2.0.0.rc1'.freeze
 end

data/lib/tasks/spotlight_tasks.rake

@@ -69,6 +69,12 @@ namespace :spotlight do
     end
   end
 
+  desc 'Migrate page\'s FriendlyId::Slug to a scoped language'
+  task migrate_pages_language: :environment do
+    require 'migration/page_language'
+    Migration::PageLanguage.run
+  end
+
   def prompt_to_create_user
     Spotlight::Engine.user_class.find_or_create_by!(email: prompt_for_email) do |u|
       puts 'User not found. Enter a password to create the user.'

data/spec/controllers/spotlight/about_pages_controller_spec.rb

@@ -3,13 +3,23 @@ describe Spotlight::AboutPagesController, type: :controller, versioning: true do
   let(:valid_attributes) { { 'title' => 'MyString', thumbnail: { iiif_url: '' } } }
 
   describe 'when not logged in' do
+    let(:exhibit) { FactoryBot.create(:exhibit) }
     describe 'POST update_all' do
-      let(:exhibit) { FactoryBot.create(:exhibit) }
       it 'is not allowed' do
         post :update_all, params: { exhibit_id: exhibit }
         expect(response).to redirect_to main_app.new_user_session_path
       end
     end
+
+    describe 'GET clone' do
+      let(:page) { FactoryBot.create(:about_page, exhibit: exhibit) }
+
+      it 'is not allowed' do
+        get :clone, params: { exhibit_id: exhibit.id, id: page.id, language: 'es' }
+        expect(flash['alert']).to eq 'You need to sign in or sign up before continuing.'
+        expect(response).to redirect_to main_app.new_user_session_path
+      end
+    end
   end
 
   describe 'when signed in as a curator' do
@@ -39,6 +49,50 @@ describe Spotlight::AboutPagesController, type: :controller, versioning: true do
           expect(assigns(:exhibit)).to eq exhibit
         end
       end
+
+      describe 'under a non-default locale' do
+        let!(:page_es) do
+          FactoryBot.create(
+            :about_page,
+            title: page.title,
+            weight: 0,
+            exhibit: exhibit,
+            locale: 'es',
+            default_locale_page: page
+          )
+        end
+
+        it 'renders the locale specific page' do
+          get :show, params: { exhibit_id: exhibit.id, id: page.slug, locale: 'es' }
+
+          expect(assigns[:page]).to eq page_es
+        end
+      end
+
+      describe 'when "switching" locales for pages that have updated their title/slug' do
+        let(:page) { FactoryBot.create(:about_page, exhibit: exhibit) }
+        let!(:page_es) do
+          FactoryBot.create(
+            :about_page,
+            exhibit: exhibit,
+            title: 'Page in spanish',
+            locale: 'es',
+            default_locale_page: page
+          )
+        end
+
+        it 'redirects from the spanish slug to the english page when the english locale is selected' do
+          expect(page_es.slug).not_to eq page.slug # Ensure the slugs are different
+          get :show, params: { exhibit_id: exhibit.id, id: page_es.slug, locale: 'en' }
+          expect(response).to redirect_to(exhibit_about_page_path(exhibit, page))
+        end
+
+        it 'redirects from the english slug to the spanish page when the spanish locale is selected' do
+          expect(page_es.slug).not_to eq page.slug # Ensure the slugs are different
+          get :show, params: { exhibit_id: exhibit.id, id: page.slug, locale: 'es' }
+          expect(response).to redirect_to(exhibit_about_page_path(exhibit, page_es))
+        end
+      end
     end
 
     describe 'GET edit' do
@@ -150,5 +204,17 @@ describe Spotlight::AboutPagesController, type: :controller, versioning: true do
         expect(response).to render_template('index')
       end
     end
+
+    describe 'GET clone' do
+      let(:page) { FactoryBot.create(:about_page, exhibit: exhibit) }
+
+      it 'calls the CloneTranslatedPageFromLocale service' do
+        expect(
+          Spotlight::CloneTranslatedPageFromLocale
+        ).to receive(:call).with(locale: 'es', page: page).and_call_original
+
+        get :clone, params: { exhibit_id: exhibit.id, id: page.id, language: 'es' }
+      end
+    end
   end
 end

data/spec/controllers/spotlight/feature_pages_controller_spec.rb

@@ -1,6 +1,19 @@
 describe Spotlight::FeaturePagesController, type: :controller, versioning: true do
   routes { Spotlight::Engine.routes }
 
+  describe 'when not logged in' do
+    let(:exhibit) { FactoryBot.create(:exhibit) }
+    describe 'GET clone' do
+      let(:page) { FactoryBot.create(:feature_page, exhibit: exhibit) }
+
+      it 'is not allowed' do
+        get :clone, params: { exhibit_id: exhibit.id, id: page.id, language: 'es' }
+        expect(flash['alert']).to eq 'You need to sign in or sign up before continuing.'
+        expect(response).to redirect_to main_app.new_user_session_path
+      end
+    end
+  end
+
   # This should return the minimal set of attributes required to create a valid
   # Page. As you add validations to Page, be sure to
   # adjust the attributes here as well.
@@ -42,6 +55,31 @@ describe Spotlight::FeaturePagesController, type: :controller, versioning: true
           expect(assigns(:page)).to eq(page)
         end
       end
+
+      describe 'when "switching" locales for pages that have updated their title/slug' do
+        let(:page) { FactoryBot.create(:feature_page, exhibit: exhibit) }
+        let!(:page_es) do
+          FactoryBot.create(
+            :feature_page,
+            exhibit: exhibit,
+            title: 'Page in spanish',
+            locale: 'es',
+            default_locale_page: page
+          )
+        end
+
+        it 'redirects from the spanish slug to the english page when the english locale is selected' do
+          expect(page_es.slug).not_to eq page.slug # Ensure the slugs are different
+          get :show, params: { exhibit_id: exhibit.id, id: page_es.slug, locale: 'en' }
+          expect(response).to redirect_to(exhibit_feature_page_path(exhibit, page))
+        end
+
+        it 'redirects from the english slug to the spanish page when the spanish locale is selected' do
+          expect(page_es.slug).not_to eq page.slug # Ensure the slugs are different
+          get :show, params: { exhibit_id: exhibit.id, id: page.slug, locale: 'es' }
+          expect(response).to redirect_to(exhibit_feature_page_path(exhibit, page_es))
+        end
+      end
     end
 
     describe 'GET new' do
@@ -166,5 +204,17 @@ describe Spotlight::FeaturePagesController, type: :controller, versioning: true
         expect(response).to redirect_to(exhibit_feature_pages_path(page.exhibit))
       end
     end
+
+    describe 'GET clone' do
+      let!(:page) { FactoryBot.create(:feature_page, exhibit: exhibit) }
+
+      it 'calls the CloneTranslatedPageFromLocale service' do
+        expect(
+          Spotlight::CloneTranslatedPageFromLocale
+        ).to receive(:call).with(locale: 'es', page: page).and_call_original
+
+        get :clone, params: { exhibit_id: exhibit.id, id: page.id, language: 'es' }
+      end
+    end
   end
 end