blacklight-spotlight 1.5.1 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6283454c62ce693d7859d54abf0f6b8f231872a2
-  data.tar.gz: b3614482d805ac181bdd85908786897a83998413
+  metadata.gz: 43aa7318e230cbd7070a23b77fc8f2758251955d
+  data.tar.gz: 5746230c90332de03ca53665ce41ded0779a41b9
 SHA512:
-  metadata.gz: bc6add80eb86ad87548c3c4b40c9f73dd15de59b8b0443b9fcbdec2860ea1ef5c820190f8c288e471f8e7c021f4fd611be103ac66a39640c9d5d80600aa7194f
-  data.tar.gz: ac68408582986b2115ea46832b6ee2271501ecf99311bb56c2a37bb7dfee7337679850264217e76948e1afd03956732c9a3d643a09f940569d41491dcc4752cc
+  metadata.gz: e974e1406d141557044df899294a30804b8a05b47b2ae833619236d530fa7dbf6b794ae057996e3ab9a2c099705ce6386d444870f34b435d73cdb16b68786e65
+  data.tar.gz: 802dcd0807263030ff2ae9371d552e6330826b4fce26a516dafdacef728aea2e5a7784c914c35c0adab99021a04120afd8e8fb6a84007c33409223a274f39a44

data/README.md

@@ -9,8 +9,8 @@ Read more about what Spotlight is, our motivations for creating it, and how to i
 
 ## Requirements
 
-1. Ruby (2.2.0 or greater)
-2. Rails (5.0 or greater)
+1. Ruby (2.3.0 or greater)
+2. Rails (5.1 or greater)
 3. Java (7 or greater) *for Solr*
 4. ImageMagick (http://www.imagemagick.org/script/index.php) due to [carrierwave](https://github.com/carrierwaveuploader/carrierwave#adding-versions)
 
@@ -45,7 +45,7 @@ $ rake db:migrate
 Start Solr (possibly using `solr_wrapper` in development or testing):
 
 ```
-$ solr_wrapper 
+$ solr_wrapper
 ```
 
 and the Rails development server:
@@ -88,3 +88,11 @@ $ rake
 ```
 
 This utilizes Solr and the testing rails app automatically.
+
+## Translations
+
+Spotlight ships with [`i18n-tasks`](https://github.com/glebm/i18n-tasks) to help manage translations. To run a translation health check:
+
+```sh
+$ bundle exec i18n-tasks health
+```

data/app/assets/javascripts/spotlight/translation_progress.js

@@ -0,0 +1,23 @@
+Spotlight.onLoad(function() {
+  $('[data-behavior="translation-progress"]').translationProgress();
+});
+
+// translationProgress is a plugin that updates the "3/14" progress
+// counters in the tabs of the translation adminstration dashboard.
+// This works by counting the number of progress items and translations
+// present (indicated by data attributes) in each tab's content
+(function($) {
+  $.fn.translationProgress = function() {
+    var translationTabs = this;
+    $(translationTabs).each(function(){
+      var currentTab = $(this);
+      var tabName = $(this).attr('aria-controls');
+      var translationFields = $('#' + tabName).find('[data-translation-progress-item="true"]');
+      var completedTranslations = $('#' + tabName).find('[data-translation-present="true"]');
+
+      currentTab.find('span').text(completedTranslations.length + '/' + translationFields.length);
+    });
+
+    return this;
+  };
+})(jQuery);

data/app/assets/stylesheets/spotlight/_spotlight.scss

@@ -30,6 +30,8 @@
 @import "spotlight/report_a_problem";
 @import "spotlight/exhibits_index";
 @import "spotlight/collapse_toggle";
+@import "spotlight/translations";
+@import "spotlight/utilities";
 
 
 

data/app/assets/stylesheets/spotlight/_translations.scss

@@ -0,0 +1,47 @@
+.translation-edit-form {
+  .glyphicon-ok {
+    color: $translation-available-color;
+  }
+}
+
+.translation-subheading {
+  border-bottom: 1px solid $navbar-default-border;
+  margin-bottom: 20px;
+}
+
+.form-group.translation-form {
+  .control-label {
+    padding-top: $panel-body-padding + $padding-base-vertical;
+  }
+
+  .glyphicon-ok {
+    padding-top: $panel-body-padding + $padding-base-vertical;
+  }
+}
+
+.tanslation-description-toggle {
+  margin: 0;
+  padding: 0;
+
+  &.collapsed {
+    .caret {
+      transform: rotate(-90deg);
+    }
+  }
+
+  label { cursor: pointer; }
+}
+
+.panel-translation {
+  background-color: $translation-panel-bg;
+  padding-bottom: 0;
+
+  .help-block {
+    color: $translation-help-color;
+    padding-left: 12px;
+  }
+}
+
+.default-page-outdated {
+  font-weight: 700;
+}

data/app/assets/stylesheets/spotlight/_utilities.scss

@@ -0,0 +1,3 @@
+.inline-block {
+  display: inline-block;
+}

data/app/assets/stylesheets/spotlight/_variables.scss

@@ -36,3 +36,8 @@ $navbar-transparent-brand-hover-bg: transparent !default;
 $navbar-transparent-toggle-hover-bg: $navbar-default-toggle-hover-bg !default;
 $navbar-transparent-toggle-icon-bar-bg: $navbar-default-toggle-icon-bar-bg !default;
 $navbar-transparent-toggle-border-color: $navbar-default-toggle-border-color !default;
+
+// Translations
+$translation-available-color: #80bf77;
+$translation-panel-bg: #f5f5f5;
+$translation-help-color: #555;

data/app/controllers/concerns/spotlight/controller.rb

@@ -8,7 +8,7 @@ module Spotlight
 
     included do
       helper_method :current_site, :current_exhibit, :current_masthead, :exhibit_masthead?, :resource_masthead?
-      before_action :set_exhibit_locale_scope
+      before_action :set_exhibit_locale_scope, :set_locale
     end
 
     def set_exhibit_locale_scope
@@ -48,6 +48,17 @@ module Spotlight
       current_exhibit && current_exhibit.masthead && current_exhibit.masthead.display?
     end
 
+    def set_locale
+      I18n.locale = params[:locale] || I18n.default_locale
+    end
+
+    def default_url_options
+      return super unless current_exhibit
+      return super if current_exhibit.languages.accessible_by(current_ability).none? || I18n.locale == I18n.default_locale
+
+      super.merge(locale: I18n.locale)
+    end
+
     # overwrites Blacklight::Controller#blacklight_config
     def blacklight_config
       if current_exhibit

data/app/controllers/spotlight/about_pages_controller.rb

@@ -5,6 +5,12 @@ module Spotlight
     load_and_authorize_resource through: :exhibit, instance_name: 'page'
     before_action :attach_breadcrumbs, except: [:update_contacts]
 
+    # We're oddly getting an unknown action
+    # error w/o explicitly defining this here
+    def clone
+      super
+    end
+
     def update_contacts
       if @exhibit.update(contact_params)
         redirect_to exhibit_about_pages_path(@exhibit), notice: t(:'helpers.submit.contact.batch_updated')

data/app/controllers/spotlight/browse_controller.rb

@@ -56,7 +56,7 @@ module Spotlight
     end
 
     def attach_breadcrumbs
-      add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), @exhibit
+      add_breadcrumb t(:'spotlight.curation.nav.home', title: @exhibit.title), @exhibit
       add_breadcrumb(@exhibit.main_navigations.browse.label_or_default, exhibit_browse_index_path(@exhibit))
     end
 

data/app/controllers/spotlight/catalog_controller.rb

@@ -133,7 +133,12 @@ module Spotlight
       # /exhibits/1?f%5Bgenre_sim%5D%5B%5D=map&q= is not the same as /exhibits/1
       # Otherwise the exhibit breadcrumb won't be a link.
       # see http://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-current_page-3F
-      add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), exhibit_root_path(@exhibit, q: '')
+      if view_context.current_page?(action: :admin)
+        add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), exhibit_root_path(@exhibit, q: '')
+      else
+        # When not on the admin page, get the translated value for the "Home" breadcrumb
+        add_breadcrumb t(:'spotlight.curation.nav.home', title: @exhibit.title), exhibit_root_path(@exhibit, q: '')
+      end
     end
 
     ##

data/app/controllers/spotlight/exhibits_controller.rb

@@ -3,6 +3,7 @@ module Spotlight
   # Administrative CRUD actions for an exhibit
   class ExhibitsController < Spotlight::ApplicationController
     before_action :authenticate_user!, except: [:index]
+    before_action :set_tab, only: [:edit, :update]
     include Blacklight::SearchHelper
 
     load_and_authorize_resource
@@ -63,7 +64,9 @@ module Spotlight
 
     def update
       if @exhibit.update(exhibit_params)
-        redirect_to edit_exhibit_path(@exhibit), notice: t(:'helpers.submit.exhibit.updated', model: @exhibit.class.model_name.human.downcase)
+        redirect_to edit_exhibit_path(@exhibit, tab: @tab),
+                    notice: t(:'helpers.submit.exhibit.updated',
+                              model: @exhibit.class.model_name.human.downcase)
       else
         flash[:alert] = @exhibit.errors.full_messages.join('<br>'.html_safe)
         render action: :edit
@@ -89,10 +92,15 @@ module Spotlight
         :description,
         :published,
         :tag_list,
-        contact_emails_attributes: [:id, :email]
+        contact_emails_attributes: [:id, :email],
+        languages_attributes: [:id, :public]
       )
     end
 
+    def set_tab
+      @tab = params[:tab]
+    end
+
     def create_params
       params.require(:exhibit).permit(
         :title,

data/app/controllers/spotlight/feature_pages_controller.rb

@@ -5,6 +5,12 @@ module Spotlight
     load_and_authorize_resource through: :exhibit, instance_name: 'page'
     before_action :attach_breadcrumbs
 
+    # We're oddly getting an unknown action
+    # error w/o explicitly defining this here
+    def clone
+      super
+    end
+
     protected
 
     def attach_breadcrumbs

data/app/controllers/spotlight/filters_controller.rb

@@ -11,14 +11,14 @@ module Spotlight
       else
         flash[:alert] = @filter.errors.full_messages.join('<br/>'.html_safe)
       end
-      redirect_to spotlight.edit_exhibit_path @exhibit, anchor: 'filter'
+      redirect_to spotlight.edit_exhibit_path @exhibit, tab: 'filter'
     end
 
     def update
       unless @filter.update(filter_params)
         flash[:alert] = @filter.errors.full_messages.join('<br/>'.html_safe)
       end
-      redirect_to spotlight.edit_exhibit_path @exhibit, anchor: 'filter'
+      redirect_to spotlight.edit_exhibit_path @exhibit, tab: 'filter'
     end
 
     def filter_params

data/app/controllers/spotlight/home_pages_controller.rb

@@ -29,11 +29,21 @@ module Spotlight
       end
     end
 
+    # We're oddly getting an unknown action
+    # error w/o explicitly defining this here
+    def clone
+      super
+    end
+
     private
 
     alias search_action_url exhibit_search_action_url
     alias search_facet_url exhibit_search_facet_url
 
+    def load_locale_specific_page
+      @page = Spotlight::HomePage.for_locale.find_by(exhibit: current_exhibit)
+    end
+
     def allowed_page_params
       super.concat [:display_title, :display_sidebar]
     end

data/app/controllers/spotlight/languages_controller.rb

@@ -0,0 +1,46 @@
+module Spotlight
+  # Create and update languages for an exhibit
+  class LanguagesController < ApplicationController
+    before_action :authenticate_user!
+    load_and_authorize_resource :exhibit, class: 'Spotlight::Exhibit'
+    load_and_authorize_resource through: :exhibit
+
+    # This is being done in a before action to de-couple the Page creation from Language creation.
+    # A language can be created in tests, console, etc. w/o necessarily requiring an associated page is created.
+    # This ties the home page creation explicitly to the action in the dashboard.
+    before_action only: :create do
+      @cloned_home_page = CloneTranslatedPageFromLocale.call(
+        locale: @language.locale,
+        page: @language.exhibit.home_page
+      )
+      @cloned_home_page.published = true
+    end
+
+    def create
+      if @language.save && @cloned_home_page.save
+        flash[:notice] = t('helpers.submit.language.created', model: @language.model_name.human.downcase)
+      else
+        flash[:alert] = [
+          @language.errors.full_messages,
+          @cloned_home_page.errors.full_messages
+        ].join('<br/>'.html_safe)
+      end
+      redirect_to spotlight.edit_exhibit_path @exhibit, tab: 'language'
+    end
+
+    def destroy
+      @language.destroy
+
+      redirect_to(
+        spotlight.edit_exhibit_path(@exhibit, tab: 'language'),
+        notice: t(:'helpers.submit.language.destroyed', model: @language.model_name.human.downcase)
+      )
+    end
+
+    private
+
+    def create_params
+      params.require(:language).permit(:locale)
+    end
+  end
+end

data/app/controllers/spotlight/pages_controller.rb

@@ -1,8 +1,12 @@
 module Spotlight
   ##
   # Base CRUD controller for pages
+  # rubocop:disable Metrics/ClassLength
+  # Disableing class length because this is a base
+  # controller that gives other controllers their behavior
   class PagesController < Spotlight::ApplicationController
     before_action :authenticate_user!, except: [:show]
+    before_action :load_locale_specific_page, only: [:destroy, :edit, :show, :update]
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
     load_and_authorize_resource through: :exhibit, instance_name: 'page', only: [:index]
 
@@ -19,7 +23,7 @@ module Spotlight
 
       respond_to do |format|
         format.html
-        format.json { render json: @pages.published.to_json(methods: [:thumbnail_image_url]) }
+        format.json { render json: @pages.for_locale.published.to_json(methods: [:thumbnail_image_url]) }
       end
     end
 
@@ -85,6 +89,20 @@ module Spotlight
       redirect_back fallback_location: spotlight.exhibit_dashboard_path(@exhibit), notice: notice
     end
 
+    def clone
+      new_page = CloneTranslatedPageFromLocale.call(locale: clone_params, page: @page)
+
+      model_name = @page.class.model_name.human.downcase
+      if new_page.save
+        redirect_to(
+          edit_exhibit_translations_path(current_exhibit, new_page, language: clone_params, tab: 'pages'),
+          notice: t(:'helpers.submit.page.created', model: model_name)
+        )
+      else
+        redirect_to :back, error: t(:'helpers.submit.page.clone_error', model: model_name)
+      end
+    end
+
     protected
 
     def _prefixes
@@ -100,6 +118,10 @@ module Spotlight
       view_context.safe_join([t(:"helpers.submit.page.#{key}", model: @page.class.model_name.human.downcase), undo_link], ' ')
     end
 
+    def clone_params
+      params.require(:language)
+    end
+
     ##
     # Browsing an exhibit should start a new search session
     def start_new_search_session?
@@ -129,17 +151,49 @@ module Spotlight
 
     def attach_breadcrumbs
       if view_context.current_page? '/'
-        add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: current_exhibit.title), main_app.root_path
+        add_breadcrumb t(:'spotlight.curation.nav.home', title: current_exhibit.title), main_app.root_path
+      elsif @page
+        # Use curator-accessible i18n key for user-facing breadcrumb
+        breadcrumb_to_exhibit_root(:'spotlight.curation.nav.home')
       else
-        add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: current_exhibit.title), spotlight.exhibit_root_path(current_exhibit)
+        # Use admin interface language for dashboard breadcrumb
+        breadcrumb_to_exhibit_root(:'spotlight.exhibits.breadcrumb')
       end
     end
 
+    def load_locale_specific_page
+      @page = current_exhibit.pages.for_locale.find(params[:id])
+    rescue ActiveRecord::RecordNotFound
+      redirect_page_to_related_locale_version
+    end
+
     private
 
+    def update_all_page_params
+      params.require(:exhibit).permit(
+        pages_attributes: [:id, :published]
+      )
+    end
+
+    def breadcrumb_to_exhibit_root(key)
+      add_breadcrumb t(key, title: current_exhibit.title), spotlight.exhibit_root_path(current_exhibit)
+    end
+
     # Only allow a trusted parameter "white list" through.
     def page_params
       params.require(controller_name.singularize).permit(allowed_page_params)
     end
+
+    def redirect_page_to_related_locale_version
+      pages_for_id = current_exhibit.pages.find(params[:id])
+      if pages_for_id.default_locale_page
+        redirect_to polymorphic_path([current_exhibit, pages_for_id.default_locale_page])
+      elsif pages_for_id.translated_page_for(I18n.locale)
+        redirect_to polymorphic_path([current_exhibit, pages_for_id.translated_page_for(I18n.locale)])
+      else
+        raise ActiveRecord::RecordNotFound
+      end
+    end
   end
+  # rubocop:enable Metrics/ClassLength
 end