blacklight-spotlight 3.0.0.alpha.8 → 3.0.0.rc3

data/config/routes.rb

@@ -100,6 +100,15 @@ Spotlight::Engine.routes.draw do
       end
     end
     resources :browse, only: %i[index show]
+    get 'browse/group/:group_id', to: 'browse#index', as: 'browse_groups'
+    get 'browse/group/:group_id/:id', to: 'browse#show', as: 'browse_group'
+
+    resources :groups, except: %i[show] do
+      collection do
+        patch :update_all
+      end
+    end
+
     resources :tags, only: %i[index destroy]
 
     resources :contacts, only: %i[edit update destroy]
@@ -143,7 +152,13 @@ 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
+    get 'iiif/collection' => 'catalog#index', defaults: { q: '*:*', format: :iiif_json }
   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/db/migrate/20210113092223_create_spotlight_groups.rb

@@ -0,0 +1,23 @@
+class CreateSpotlightGroups < ActiveRecord::Migration[5.2]
+  def self.up
+    create_table :spotlight_groups do |t|
+      t.string     :slug
+      t.text       :title
+      t.references :exhibit
+      t.integer    :weight, default: 50
+      t.boolean    :published
+
+      t.timestamps
+    end
+
+    create_table :spotlight_groups_members, id: false do |t|
+      t.references :group
+      t.references :member, polymorphic: true
+    end
+  end
+
+  def self.down
+    drop_table :spotlight_groups
+    drop_table :spotlight_groups_members
+  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', "\n//= link_directory ../javascripts .js\n"
+      append_to_file 'app/assets/javascripts/application.js', "\n//= require_tree .\n"
+      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
@@ -104,7 +125,7 @@ module Spotlight
     end
 
     def add_osd_viewer
-      gem 'blacklight-gallery', '~> 1.1'
+      gem 'blacklight-gallery', '~> 3.0'
       generate 'blacklight_gallery:install'
     end
 

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,8 +70,10 @@
 # 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
+#   Heading Text List Quote Iframe Video Oembed Rule UploadedItems Browse BrowseGroupCategories
 #   FeaturedPages SolrDocuments SolrDocumentsCarousel SolrDocumentsEmbed
 #   SolrDocumentsFeatures SolrDocumentsGrid SearchResults
 # )

data/lib/spotlight/engine.rb

@@ -38,8 +38,8 @@ module Spotlight
     require 'github/markup'
     require 'sir_trevor_rails'
     require 'openseadragon'
+    require 'handlebars_assets'
     require 'sprockets/es6'
-    require 'almond-rails'
 
     config.assets.precompile += %w[spotlight/fallback/*.png]
 
@@ -55,6 +55,7 @@ module Spotlight
       require 'acts-as-taggable-on'
 
       Mime::Type.register 'application/solr+json', :solr_json
+      Mime::Type.register 'application/iiif+json', :iiif_json
     end
 
     initializer 'spotlight.factories', after: 'factory_bot.set_factory_paths' do
@@ -64,7 +65,7 @@ module Spotlight
     initializer 'spotlight.assets.precompile' do |app|
       app.config.assets.precompile += %w[spotlight/default_thumbnail.jpg spotlight/default_browse_thumbnail.jpg]
 
-      Sprockets::ES6.configuration = { 'modules' => 'amd', 'moduleIds' => true }
+      Sprockets::ES6.configuration = { 'modules' => 'umd', 'moduleIds' => true }
       # When we upgrade to Sprockets 4, we can ditch sprockets-es6 and config AMD
       # in this way:
       # https://github.com/rails/sprockets/issues/73#issuecomment-139113466
@@ -160,6 +161,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]
@@ -214,6 +216,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',
@@ -243,8 +264,11 @@ 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
+      Heading Text List Quote Iframe Video Oembed Rule UploadedItems Browse BrowseGroupCategories LinkToSearch
       FeaturedPages SolrDocuments SolrDocumentsCarousel SolrDocumentsEmbed
       SolrDocumentsFeatures SolrDocumentsGrid SearchResults
     ]

data/lib/spotlight/upload_field_config.rb

@@ -8,6 +8,7 @@ module Spotlight
   # 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, solr_fields: nil)
       @blacklight_options = blacklight_options
       @field_name = field_name

data/lib/spotlight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spotlight
-  VERSION = '3.0.0.alpha.8'
+  VERSION = '3.0.0.rc3'
 end

data/spec/controllers/spotlight/about_pages_controller_spec.rb

@@ -112,7 +112,7 @@ describe Spotlight::AboutPagesController, type: :controller, versioning: true do
       describe 'on the main about page' do
         it 'is successful' do
           expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_root_path(exhibit))
-          expect(controller).to receive(:add_breadcrumb).with('About Pages', exhibit_about_pages_path(exhibit))
+          expect(controller).to receive(:add_breadcrumb).with('About pages', exhibit_about_pages_path(exhibit))
           get :edit, params: { id: page, exhibit_id: exhibit }
           expect(assigns(:page)).to eq page
           expect(assigns(:exhibit)).to eq exhibit
@@ -122,7 +122,7 @@ describe Spotlight::AboutPagesController, type: :controller, versioning: true do
       describe 'on a different about page' do
         it 'is successful' do
           expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_root_path(exhibit))
-          expect(controller).to receive(:add_breadcrumb).with('About Pages', exhibit_about_pages_path(exhibit))
+          expect(controller).to receive(:add_breadcrumb).with('About pages', exhibit_about_pages_path(exhibit))
           expect(controller).to receive(:add_breadcrumb).with(page2.title, [:edit, exhibit, page2])
           get :edit, params: { id: page2, exhibit_id: exhibit }
           expect(assigns(:page)).to eq page2
@@ -137,7 +137,7 @@ describe Spotlight::AboutPagesController, type: :controller, versioning: true do
       it 'is successful' do
         expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_root_path(exhibit))
         expect(controller).to receive(:add_breadcrumb).with('Curation', exhibit_dashboard_path(exhibit))
-        expect(controller).to receive(:add_breadcrumb).with('About Pages', exhibit_about_pages_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with('About pages', exhibit_about_pages_path(exhibit))
         get :index, params: { exhibit_id: exhibit }
         expect(assigns(:page)).to be_kind_of Spotlight::Page
         expect(assigns(:page)).to be_new_record

data/spec/controllers/spotlight/browse_controller_spec.rb

@@ -4,6 +4,8 @@ describe Spotlight::BrowseController, type: :controller do
   routes { Spotlight::Engine.routes }
   let(:exhibit) { FactoryBot.create(:exhibit) }
   let!(:search) { FactoryBot.create(:published_search, exhibit: exhibit) }
+  let(:group) { FactoryBot.create(:group, published: true, title: 'Good group', exhibit: exhibit, searches: [search]) }
+  let(:group_unpublished) { FactoryBot.create(:group, title: 'Secret group', exhibit: exhibit, searches: [search]) }
   let!(:unpublished) { FactoryBot.create(:search, exhibit: exhibit) }
   let(:admin) { FactoryBot.create(:site_admin) }
 
@@ -53,6 +55,16 @@ describe Spotlight::BrowseController, type: :controller do
         expect(assigns[:exhibit]).to eq exhibit
         expect(response).to render_template 'spotlight/browse/index'
       end
+
+      it 'includes the browse groups' do
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
+        expect(controller).to receive(:add_breadcrumb).with('Browse', exhibit_browse_index_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with('Good group', exhibit_browse_groups_path(exhibit, group))
+        get :index, params: { exhibit_id: exhibit, group_id: group.id }
+        expect(response).to be_successful
+        expect(assigns[:groups]).to eq [group]
+        expect(response).to render_template 'spotlight/browse/index'
+      end
     end
   end
 
@@ -90,6 +102,17 @@ describe Spotlight::BrowseController, type: :controller do
         expect(response).to render_template 'spotlight/browse/show'
       end
 
+      it 'includes the browse group when a group_id is provided' do
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
+        expect(controller).to receive(:add_breadcrumb).with('Browse', exhibit_browse_index_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with('Good group', exhibit_browse_groups_path(exhibit, group))
+        expect(controller).to receive(:add_breadcrumb).with(search.title, exhibit_browse_group_path(exhibit, group, search))
+        get :show, params: { id: search, exhibit_id: exhibit, group_id: group.id }
+        expect(response).to be_successful
+        expect(assigns[:group]).to eq group
+        expect(response).to render_template 'spotlight/browse/show'
+      end
+
       it 'removes all the document actions' do
         get :show, params: { id: search, exhibit_id: exhibit }
         expect(controller.blacklight_config.index.document_actions).to be_blank
@@ -100,7 +123,7 @@ describe Spotlight::BrowseController, type: :controller do
           c.browse.document_actions = %i[a b c]
         end
 
-        allow(controller). to receive(:blacklight_config).and_return(config)
+        allow(controller).to receive(:blacklight_config).and_return(config)
 
         get :show, params: { id: search, exhibit_id: exhibit }
         expect(controller.blacklight_config.index.document_actions).to match_array %i[a b c]

data/spec/controllers/spotlight/catalog_controller_spec.rb

@@ -81,7 +81,7 @@ describe Spotlight::CatalogController, type: :controller do
     describe 'GET index' do
       it 'shows the index when there are parameters' do
         expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit, q: ''))
-        expect(controller).to receive(:add_breadcrumb).with('Search Results', search_exhibit_catalog_path(exhibit, q: 'map'))
+        expect(controller).to receive(:add_breadcrumb).with('Search results', search_exhibit_catalog_path(exhibit, q: 'map'))
         get :index, params: { exhibit_id: exhibit, q: 'map' }
         expect(response).to be_successful
       end

data/spec/controllers/spotlight/contacts_controller_spec.rb

@@ -24,7 +24,7 @@ describe Spotlight::ContactsController, type: :controller do
       it 'is successful' do
         expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
         expect(controller).to receive(:add_breadcrumb).with('Curation', exhibit_dashboard_path(exhibit))
-        expect(controller).to receive(:add_breadcrumb).with('About Pages', exhibit_about_pages_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with('About pages', exhibit_about_pages_path(exhibit))
         expect(controller).to receive(:add_breadcrumb).with(contact.name, edit_exhibit_contact_path(exhibit, contact))
         get :edit, params: { id: contact, exhibit_id: contact.exhibit }
         expect(response).to be_successful
@@ -76,7 +76,7 @@ describe Spotlight::ContactsController, type: :controller do
       it 'is successful' do
         expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
         expect(controller).to receive(:add_breadcrumb).with('Curation', exhibit_dashboard_path(exhibit))
-        expect(controller).to receive(:add_breadcrumb).with('About Pages', exhibit_about_pages_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with('About pages', exhibit_about_pages_path(exhibit))
         expect(controller).to receive(:add_breadcrumb).with('Add contact', new_exhibit_contact_path(exhibit))
         get :new, params: { exhibit_id: exhibit }
         expect(response).to be_successful

data/spec/controllers/spotlight/feature_pages_controller_spec.rb

@@ -92,6 +92,17 @@ describe Spotlight::FeaturePagesController, type: :controller, versioning: true
           expect(response).to redirect_to(exhibit_feature_page_path(exhibit, page_es))
         end
       end
+
+      context 'when the sidebar is set to not display' do
+        let(:page) { FactoryBot.create(:feature_page, exhibit: exhibit, published: true) }
+
+        before { page.update(display_sidebar: false) }
+
+        it 'injects custom classes into the gallery view' do
+          get :show, params: { exhibit_id: exhibit.id, id: page.id }
+          expect(assigns(:exhibit).blacklight_config.view.gallery.classes).to eq 'row-cols-2 row-cols-md-4'
+        end
+      end
     end
 
     describe 'GET new' do

data/spec/controllers/spotlight/groups_controller_spec.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+describe Spotlight::GroupsController, type: :controller do
+  routes { Spotlight::Engine.routes }
+  let(:exhibit) { FactoryBot.create(:exhibit) }
+  let!(:group) { FactoryBot.create(:group, exhibit: exhibit) }
+
+  describe 'when the user is not authorized' do
+    before do
+      sign_in FactoryBot.create(:exhibit_visitor)
+    end
+
+    describe 'GET index' do
+      it 'returns authorized groups (none)' do
+        get :index, params: { exhibit_id: exhibit }, format: :json
+        expect(response).to be_successful
+        expect(JSON.parse(response.body).length).to eq 0
+      end
+    end
+
+    describe 'POST create' do
+      it 'denies access' do
+        post :create, params: { exhibit_id: exhibit, group: { title: 'Hello' } }
+        expect(response).to redirect_to main_app.root_path
+        expect(flash[:alert]).to be_present
+      end
+    end
+
+    describe 'PUT update' do
+      it 'denies access' do
+        patch :update, params: { exhibit_id: exhibit, id: group.id }
+        expect(response).to redirect_to main_app.root_path
+        expect(flash[:alert]).to be_present
+      end
+    end
+  end
+
+  describe 'when the user is a curator' do
+    before do
+      sign_in FactoryBot.create(:exhibit_curator, exhibit: exhibit)
+    end
+
+    describe 'GET index' do
+      it 'returns json response of groups' do
+        get :index, params: { exhibit_id: exhibit }, format: :json
+        expect(JSON.parse(response.body).length).to eq 1
+      end
+    end
+
+    describe 'POST create' do
+      it 'creates a saved search' do
+        post :create, params: { exhibit_id: exhibit, group: { title: 'Hello' } }
+        expect(response).to redirect_to spotlight.exhibit_searches_path(exhibit, anchor: 'browse-groups')
+        expect(flash[:notice]).to eq 'The browse group was created.'
+      end
+    end
+
+    describe 'PATCH update' do
+      it 'shows edit page' do
+        patch :update, params: {
+          id: group.id,
+          exhibit_id: group.exhibit,
+          group: {
+            title: 'Hello world'
+          }
+        }
+
+        expect(group.reload.title).to eq 'Hello world'
+        expect(response).to redirect_to exhibit_searches_path(exhibit, anchor: 'browse-groups')
+      end
+    end
+
+    describe 'PATCH update_all' do
+      let!(:group2) { FactoryBot.create(:group, exhibit: exhibit, published: true) }
+      let!(:group3) { FactoryBot.create(:group, exhibit: exhibit, published: true) }
+
+      it 'shows edit page' do
+        patch :update_all, params: {
+          exhibit_id: group.exhibit,
+          exhibit: {
+            groups_attributes: [
+              { id: group.id, published: true, weight: '1' },
+              { id: group2.id, published: false, weight: '0' }
+            ]
+          }
+        }
+
+        expect(group.reload.weight).to eq 1
+        expect(group2.reload.published).to be false
+        expect(response).to redirect_to exhibit_searches_path(exhibit, anchor: 'browse-groups')
+      end
+    end
+
+    describe 'DELETE delete' do
+      it 'removes the group' do
+        group
+        expect do
+          delete :destroy, params: { id: group.id, exhibit_id: group.exhibit }
+        end.to change { Spotlight::Group.count }.by(-1)
+      end
+    end
+  end
+end