blacklight-spotlight 1.5.1 → 2.0.0.rc1

data/app/controllers/spotlight/solr_controller.rb

@@ -21,10 +21,10 @@ module Spotlight
 
       repository.connection.update params: { commitWithin: 500 }, data: data.to_json, headers: { 'Content-Type' => 'application/json' } unless data.empty?
 
-      if respond_to? :head
-        head :ok
+      if params[:resources_json_upload]
+        redirect_back fallback_location: exhibit_resources_path(@exhibit)
       else
-        render nothing: true
+        head :ok
       end
     end
 

data/app/controllers/spotlight/translations_controller.rb

@@ -0,0 +1,34 @@
+module Spotlight
+  ##
+  # Base CRUD controller for translations
+  class TranslationsController < Spotlight::ApplicationController
+    before_action :authenticate_user!, :set_language, :set_tab
+    load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
+
+    def edit; end
+
+    def update
+      if current_exhibit.update(exhibit_params)
+        I18n.reload! # reload since we're memoizing
+        notice = t(:'helpers.submit.spotlight_default.updated', model: current_exhibit.class.model_name.human.downcase)
+        redirect_to edit_exhibit_translations_path(current_exhibit, language: @language, tab: @tab), notice: notice
+      else
+        render 'edit'
+      end
+    end
+
+    private
+
+    def exhibit_params
+      params.require(:exhibit).permit(translations_attributes: [:id, :locale, :key, :value])
+    end
+
+    def set_language
+      @language = params[:language] || current_exhibit.available_locales.first
+    end
+
+    def set_tab
+      @tab = params[:tab]
+    end
+  end
+end

data/app/helpers/spotlight/application_helper.rb

@@ -6,6 +6,7 @@ module Spotlight
     include TitleHelper
     include MetaHelper
     include CropHelper
+    include LanguagesHelper
 
     ##
     # Give the application name a chance to include the exhibit title

data/app/helpers/spotlight/languages_helper.rb

@@ -0,0 +1,33 @@
+module Spotlight
+  ##
+  # Helpers for the Language form and UI elements
+  module LanguagesHelper
+    def add_exhibit_language_dropdown_options
+      non_default_or_current_exhibit_languages = I18n.available_locales.reject do |locale|
+        locale == I18n.default_locale || current_exhibit.available_locales.include?(locale.to_s)
+      end
+
+      non_default_or_current_exhibit_languages_with_labels = non_default_or_current_exhibit_languages.map do |locale|
+        [t("locales.#{locale.downcase}"), locale]
+      end
+
+      non_default_or_current_exhibit_languages_with_labels.sort_by { |label, _locale| label }
+    end
+
+    def locale_selecter_dropown_options
+      languages = current_exhibit.languages.accessible_by(current_ability).to_a << Spotlight::Language.default_instance
+
+      # String#casecmp returns 0 when the two strings compared are identical (ignoring case)
+      languages.reject { |language| language.locale.to_s.casecmp(I18n.locale.to_s).zero? }.sort_by(&:to_native)
+    end
+
+    ##
+    # Can determine whether the current page is using the application's default
+    # locale
+    # @return [Boolean]
+    def default_language?
+      return true unless params[:locale]
+      params[:locale].to_s == I18n.default_locale.to_s
+    end
+  end
+end

data/app/helpers/spotlight/translations_helper.rb

@@ -0,0 +1,13 @@
+module Spotlight
+  ##
+  # Helper module for the Translations admin UI
+  module TranslationsHelper
+    def non_custom_metadata_fields
+      custom_field_keys = current_exhibit.custom_fields.pluck(:field)
+
+      current_exhibit.blacklight_config.show_fields.reject do |key, _|
+        custom_field_keys.include?(key)
+      end
+    end
+  end
+end

data/app/models/concerns/spotlight/custom_translation_extension.rb

@@ -8,6 +8,10 @@ module Spotlight
     included do
       default_scope { where(exhibit: current_exhibit) }
       belongs_to :exhibit, class_name: 'Spotlight::Exhibit', inverse_of: :translations
+
+      before_validation do
+        mark_for_destruction if value.blank?
+      end
     end
 
     class_methods do

data/app/models/concerns/spotlight/translatables.rb

@@ -0,0 +1,30 @@
+module Spotlight
+  # Mixin for adding translatable ActiveRecord accessors
+  module Translatables
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def translates(*attr_names)
+        attr_names.map(&:to_sym)
+        attr_names.map(&method(:define_translated_attr_reader))
+      end
+
+      ##
+      # Set up a reader for the specified attribute that uses the I18n backend,
+      # and defaults to the ActiveRecord value
+      def define_translated_attr_reader(attr_name)
+        define_method(:"#{attr_name}") do
+          I18n.translate(attr_name, scope: slug, default: attr_translation(attr_name))
+        end
+      end
+    end
+
+    private
+
+    ##
+    # Will return the default ActiveRecord value for the value
+    def attr_translation(attr_name)
+      self[attr_name]
+    end
+  end
+end

data/app/models/spotlight/ability.rb

@@ -14,7 +14,7 @@ module Spotlight
 
       # exhibit admin
       can [:update, :import, :export, :destroy], Spotlight::Exhibit, id: user.admin_roles.pluck(:resource_id)
-      can :manage, [Spotlight::BlacklightConfiguration, Spotlight::ContactEmail], exhibit_id: user.admin_roles.pluck(:resource_id)
+      can :manage, [Spotlight::BlacklightConfiguration, Spotlight::ContactEmail, Spotlight::Language], exhibit_id: user.admin_roles.pluck(:resource_id)
       can :manage, Spotlight::Role, resource_id: user.admin_roles.pluck(:resource_id), resource_type: 'Spotlight::Exhibit'
 
       can :manage, PaperTrail::Version if user.roles.any?
@@ -26,11 +26,13 @@ module Spotlight
         Spotlight::Resource,
         Spotlight::Page,
         Spotlight::Contact,
-        Spotlight::CustomField
+        Spotlight::CustomField,
+        Translation
       ], exhibit_id: user.exhibit_roles.pluck(:resource_id)
 
       can :manage, Spotlight::Lock, by: user
 
+      can :read, Spotlight::Language, exhibit_id: user.exhibit_roles.pluck(:resource_id)
       can [:read, :curate, :tag], Spotlight::Exhibit, id: user.exhibit_roles.pluck(:resource_id)
 
       # public
@@ -38,6 +40,7 @@ module Spotlight
       can :read, Spotlight::Exhibit, published: true
       can :read, Spotlight::Page, published: true
       can :read, Spotlight::Search, published: true
+      can :read, Spotlight::Language, public: true
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
   end

data/app/models/spotlight/about_page.rb

@@ -3,6 +3,6 @@ module Spotlight
   # About pages
   class AboutPage < Spotlight::Page
     extend FriendlyId
-    friendly_id :title, use: [:slugged, :scoped, :finders, :history], scope: :exhibit
+    friendly_id :title, use: [:slugged, :scoped, :finders, :history], scope: [:exhibit, :locale]
   end
 end

data/app/models/spotlight/exhibit.rb

@@ -6,6 +6,9 @@ module Spotlight
     include Spotlight::ExhibitAnalytics
     include Spotlight::ExhibitDefaults
     include Spotlight::ExhibitDocuments
+    include Spotlight::Translatables
+
+    translates :title, :subtitle, :description
 
     has_paper_trail
 
@@ -17,7 +20,7 @@ module Spotlight
 
     extend FriendlyId
     friendly_id :title, use: [:slugged, :finders]
-    validates :title, presence: true
+    validates :title, presence: true, if: -> { I18n.locale == I18n.default_locale }
     validates :slug, uniqueness: true
     validates :theme, inclusion: { in: Spotlight::Engine.config.exhibit_themes }, allow_blank: true
 
@@ -27,12 +30,12 @@ module Spotlight
     serialize :facets, Array
 
     # Note: friendly id associations need to be 'destroy'ed to reap the slug history
-    has_many :about_pages, extend: FriendlyId::FinderMethods
+    has_many :about_pages, -> { for_default_locale }, extend: FriendlyId::FinderMethods
     has_many :attachments, dependent: :destroy
     has_many :contact_emails, dependent: :delete_all # These are the contacts who get "Contact us" emails
     has_many :contacts, dependent: :delete_all # These are the contacts who appear in the sidebar
     has_many :custom_fields, dependent: :delete_all
-    has_many :feature_pages, extend: FriendlyId::FinderMethods
+    has_many :feature_pages, -> { for_default_locale }, extend: FriendlyId::FinderMethods
     has_many :main_navigations, dependent: :delete_all
     has_many :reindexing_log_entries, dependent: :destroy
     has_many :resources
@@ -43,16 +46,17 @@ module Spotlight
     has_many :pages, dependent: :destroy
     has_many :filters, dependent: :delete_all
     has_many :translations, class_name: 'I18n::Backend::ActiveRecord::Translation', dependent: :destroy, inverse_of: :exhibit
+    has_many :languages, dependent: :destroy
 
     has_one :blacklight_configuration, class_name: 'Spotlight::BlacklightConfiguration', dependent: :delete
-    has_one :home_page
+    has_one :home_page, -> { for_default_locale }
 
     belongs_to :site, optional: true
     belongs_to :masthead, dependent: :destroy, optional: true
     belongs_to :thumbnail, class_name: 'Spotlight::ExhibitThumbnail', dependent: :destroy, optional: true
 
-    accepts_nested_attributes_for :about_pages, :attachments, :contacts, :custom_fields, :feature_pages,
-                                  :main_navigations, :owned_taggings, :resources, :searches, :solr_document_sidecars
+    accepts_nested_attributes_for :about_pages, :attachments, :contacts, :custom_fields, :feature_pages, :languages,
+                                  :main_navigations, :owned_taggings, :pages, :resources, :searches, :solr_document_sidecars, :translations
     accepts_nested_attributes_for :blacklight_configuration, :home_page, :filters, update_only: true
     accepts_nested_attributes_for :masthead, :thumbnail, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }
     accepts_nested_attributes_for :contact_emails, reject_if: proc { |attr| attr['email'].blank? }
@@ -103,6 +107,10 @@ module Spotlight
       @reindex_progress ||= ReindexProgress.new(current_reindexing_log_entry)
     end
 
+    def available_locales
+      @available_locales ||= languages.pluck(:locale)
+    end
+
     protected
 
     def sanitize_description

data/app/models/spotlight/feature_page.rb

@@ -3,7 +3,7 @@ module Spotlight
   # Feature pages
   class FeaturePage < Spotlight::Page
     extend FriendlyId
-    friendly_id :title, use: [:slugged, :scoped, :finders, :history], scope: :exhibit
+    friendly_id :title, use: [:slugged, :scoped, :finders, :history], scope: [:exhibit, :locale]
 
     has_many :child_pages, class_name: 'Spotlight::FeaturePage', inverse_of: :parent_page, foreign_key: 'parent_page_id'
     belongs_to :parent_page, class_name: 'Spotlight::FeaturePage', optional: true
@@ -11,7 +11,6 @@ module Spotlight
     accepts_nested_attributes_for :child_pages
 
     belongs_to :thumbnail, class_name: 'Spotlight::FeaturedImage', dependent: :destroy, optional: true
-    accepts_nested_attributes_for :thumbnail, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }
 
     before_validation unless: :top_level_page? do
       self.exhibit = top_level_page_or_self.exhibit

data/app/models/spotlight/home_page.rb

@@ -3,13 +3,11 @@ module Spotlight
   # Exhibit home page
   class HomePage < Spotlight::Page
     extend FriendlyId
-    friendly_id :title, use: [:slugged, :scoped, :finders], scope: :exhibit
+    friendly_id :title, use: [:slugged, :scoped, :finders], scope: [:exhibit, :locale]
 
     before_save :publish
     before_create :default_content
 
-    accepts_nested_attributes_for :thumbnail, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }
-
     class << self
       def default_title_text
         I18n.t('spotlight.pages.index.home_pages.title')

data/app/models/spotlight/language.rb

@@ -0,0 +1,24 @@
+module Spotlight
+  # A language for an exhibit
+  class Language < ActiveRecord::Base
+    belongs_to :exhibit
+    has_many :pages, ->(page) { where(locale: page.locale) }, through: :exhibit
+    has_many :translations, ->(translation) { where(locale: translation.locale) }, through: :exhibit
+    validates :locale, presence: true
+
+    # Doing this instead of dependent: :destroy because
+    # has_many :through can't associate a has_many reflection
+    after_destroy do
+      pages.map(&:destroy)
+      translations.map(&:destroy)
+    end
+
+    def to_native
+      Spotlight::Engine.config.i18n_locales[locale.downcase.to_sym] || ''
+    end
+
+    def self.default_instance
+      new(locale: I18n.default_locale)
+    end
+  end
+end

data/app/models/spotlight/main_navigation.rb

@@ -2,11 +2,15 @@ module Spotlight
   ##
   # Exhibit navbar links
   class MainNavigation < ActiveRecord::Base
+    include Spotlight::Translatables
+
     belongs_to :exhibit, touch: true
     default_scope { order('weight ASC') }
     scope :browse, -> { find_by(nav_type: 'browse') }
     scope :about, -> { find_by(nav_type: 'about') }
+    scope :curated_features, -> { find_by(nav_type: 'curated_features') }
     scope :displayable, -> { where(display: true) }
+    translates :label
 
     def displayable?
       display?
@@ -23,5 +27,13 @@ module Spotlight
     def default_label
       I18n.t(:"spotlight.main_navigation.#{nav_type}")
     end
+
+    private
+
+    ##
+    # Allows us to scope translations namespace.
+    def slug
+      ['main_navigation', nav_type].join('.')
+    end
   end
 end

data/app/models/spotlight/page.rb

@@ -1,16 +1,23 @@
 module Spotlight
   ##
   # Base page class. See {Spotlight::AboutPage}, {Spotlight::FeaturePage}, {Spotlight::HomePage}
+  # rubocop:disable Metrics/ClassLength
   class Page < ActiveRecord::Base
     MAX_PAGES = 50
 
     extend FriendlyId
-    friendly_id :title, use: [:slugged, :scoped, :finders, :history], scope: :exhibit
+    friendly_id :title, use: [:slugged, :scoped, :finders, :history], scope: [:exhibit, :locale]
 
     belongs_to :exhibit, touch: true
     belongs_to :created_by, class_name: Spotlight::Engine.config.user_class, optional: true
     belongs_to :last_edited_by, class_name: Spotlight::Engine.config.user_class, optional: true
     belongs_to :thumbnail, class_name: 'Spotlight::FeaturedImage', dependent: :destroy, optional: true
+    belongs_to :default_locale_page, class_name: 'Spotlight::Page', optional: true, inverse_of: :translated_pages
+    has_many :translated_pages,
+             class_name: 'Spotlight::Page',
+             foreign_key: :default_locale_page_id,
+             dependent: :destroy,
+             inverse_of: :default_locale_page
 
     validates :weight, inclusion: { in: proc { 0..Spotlight::Page::MAX_PAGES } }
 
@@ -18,17 +25,23 @@ module Spotlight
     scope :at_top_level, -> { where(parent_page_id: nil) }
     scope :published, -> { where(published: true) }
     scope :recent, -> { order('updated_at DESC').limit(10) }
+    scope :for_locale, ->(locale = I18n.locale) { unscope(where: :locale).where(locale: locale) }
+    scope :for_default_locale, -> { for_locale(I18n.default_locale) }
 
     has_one :lock, as: :on, dependent: :destroy
     sir_trevor_content :content
     has_paper_trail
 
+    accepts_nested_attributes_for :thumbnail, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }
+
     # display_sidebar should be set to true by default
     before_create do
       self.content ||= [].to_json
       self.display_sidebar = true
     end
 
+    after_update :update_translated_pages_weights_and_parent_page
+
     def content_changed!
       @content = nil
     end
@@ -74,6 +87,10 @@ module Spotlight
       is_a? AboutPage
     end
 
+    def home_page?
+      is_a? HomePage
+    end
+
     def top_level_page?
       try(:parent_page).blank?
     end
@@ -93,5 +110,40 @@ module Spotlight
     def lock!(user)
       create_lock(by: user).tap(&:current_session!) unless lock.present?
     end
+
+    def updated_after?(other_page)
+      return false unless other_page
+      updated_at > other_page.updated_at
+    end
+
+    def translated_page_for(locale)
+      translated_pages.for_locale(locale).first
+    end
+
+    def clone_for_locale(locale)
+      dup.tap do |np|
+        np.locale = locale
+        np.default_locale_page = self
+        np.published = false
+
+        if !top_level_page? && (parent_translation = parent_page.translated_page_for(locale)).present?
+          np.parent_page = parent_translation
+        end
+
+        child_pages.for_locale(locale).update(parent_page: np) if top_level_page? && respond_to?(:child_pages)
+      end
+    end
+
+    private
+
+    def update_translated_pages_weights_and_parent_page
+      return unless locale.to_sym == I18n.default_locale
+      return unless saved_change_to_weight? || saved_change_to_parent_page_id?
+      update_params = {}
+      update_params[:weight] = weight if saved_change_to_weight?
+      update_params[:parent_page_id] = parent_page_id if saved_change_to_parent_page_id?
+      translated_pages.update(update_params)
+    end
   end
+  # rubocop:enable Metrics/ClassLength
 end