blacklight-gallery 1.7.0 → 3.0.0

data/app/helpers/blacklight/gallery_helper.rb

@@ -1,42 +1,4 @@
 module Blacklight
   module GalleryHelper
-    def render_gallery_collection documents
-      index = -1
-      documents.map do |object|
-        index += 1
-        template = gallery_wrapper_template(object)
-        template.render(self, {document: object, document_counter: index}) if template
-
-      end.join().html_safe
-    end
-
-    def render_slideshow_tag(document, image_options = {}, url_options = {})
-      if blacklight_config.view_config(document_index_view_type).slideshow_method
-        method_name = blacklight_config.view_config(document_index_view_type).slideshow_method
-        send(method_name, document, image_options)
-      elsif blacklight_config.view_config(document_index_view_type).slideshow_field
-        url = slideshow_image_url(document)
-
-        image_tag url, image_options if url.present?
-      elsif has_thumbnail?(document)
-        render_thumbnail_tag(document, image_options, url_options.reverse_merge(suppress_link: true))
-      end
-    end
-
-    def slideshow_image_url(document)
-      if document.has? blacklight_config.view_config(document_index_view_type).slideshow_field
-        document.first(blacklight_config.view_config(document_index_view_type).slideshow_field)
-      end
-    end
-
-    def gallery_wrapper_template(object)
-      format = document_partial_name(object, nil)
-      ['index_gallery_%{format}_wrapper', 'index_gallery'].each do |str|
-        partial = str % { format: format }
-        logger.debug "Looking for gallery document wrapper #{partial}"
-        template = lookup_context.find_all(partial, lookup_context.prefixes, true, [:document, :document_counter], {}).first
-        return template if template
-      end
-    end
   end
 end

data/app/models/concerns/blacklight/gallery/openseadragon_solr_document.rb

@@ -1,6 +1,6 @@
 module Blacklight::Gallery::OpenseadragonSolrDocument
   def to_openseadragon(view_config = nil)
-    return unless view_config.try(:tile_source_field) &&
+    return unless view_config&.tile_source_field &&
                   fetch(view_config.tile_source_field, nil)
     Array(fetch(view_config.tile_source_field))
   end

data/app/views/catalog/_document_gallery.html.erb

@@ -1,4 +1,5 @@
-<% # container for all documents in index view -%>
-<div id="documents" class="row gallery">
-  <%= render_gallery_collection documents %>
+<div class="container">
+  <div id="documents" class="<%= (Array(blacklight_config.view_config(document_index_view_type).classes || 'row-cols-2 row-cols-md-3') + ["row documents-#{document_index_view_type}"]).join(' ') %>">
+    <%= render documents, as: :document %>
+  </div>
 </div>

data/app/views/catalog/_document_masonry.html.erb

@@ -1,4 +1,3 @@
-<% # container for all documents in index view -%>
-<div id="documents" class="row" data-behavior="masonry-gallery">
-  <%= render collection: documents, as: :document, partial: 'index_masonry', locals: {count: documents.count} %>
+<div id="documents" class="<%= (Array(blacklight_config.view_config(document_index_view_type).classes) + ["documents-#{document_index_view_type}"]).join(' ') %>">
+  <%= render documents, as: :document %>
 </div>

data/app/views/catalog/_document_slideshow.html.erb

@@ -1,14 +1,31 @@
-<% # container for all documents in slideshow view -%>
-<div id="documents" class="row slideshow-documents">
-  <div class="info w-100">
-    <h3><%= t(:'blacklight_gallery.catalog.document_slideshow.header') %></h3>
-  </div>
-
+<div id="documents" class="<%= (Array(blacklight_config.view_config(document_index_view_type).classes) + ["documents-#{document_index_view_type}"]).join(' ') %>">
   <div class="grid">
-    <%= render collection: documents, as: :document, partial: 'grid_slideshow' %>
+    <%= render((blacklight_config.view_config(document_index_view_type).preview_component || Blacklight::Gallery::SlideshowPreviewComponent).with_collection(documents)) %>
   </div>
 
-  <%= render layout: 'slideshow_modal', locals: {documents: documents} do %>
-    <%= render partial: 'slideshow', locals: {documents: documents} %>
+  <%= render layout: 'slideshow_modal' do %>
+    <div id="slideshow" class="slideshow-presenter">
+      <!-- Wrapper for slides -->
+      <div class="slideshow-inner">
+        <%= render documents, as: :document %>
+      </div>
+
+      <!-- Controls -->
+      <a class="left carousel-control prev" href="#slideshow" data-slide="prev">
+        <%= blacklight_icon 'chevron_left', { additional_options: { label_context: 'previous_image' }} %>
+      </a>
+      <a class="right carousel-control next" href="#slideshow" data-slide="next">
+        <%= blacklight_icon 'chevron_right', { additional_options: { label_context: 'next_image' }} %>
+      </a>
+
+      <div class="controls text-center">
+        <button class="btn btn-sm btn-link" data-behavior="pause-slideshow" aria-label="<%= t('blacklight_gallery.catalog.slideshow.pause') %>">
+          <%= blacklight_icon 'pause_slideshow' %>
+        </button>
+        <button class="btn btn-sm btn-link" data-behavior="start-slideshow" aria-label="<%= t('blacklight_gallery.catalog.slideshow.start') %>">
+          <%= blacklight_icon 'start_slideshow' %>
+        </button>
+      </div>
+    </div>
   <% end %>
 </div>

data/app/views/catalog/_openseadragon_default.html.erb

@@ -23,21 +23,20 @@
   <% count = Array(image).length %>
   <div class="openseadragon-container <%= osd_container_class %>">
     <div class="osd-toolbar row">
-      <% if count > 1 %>
-        <% osd_config = osd_config_referencestrip.merge(osd_config) %>
-
-        <div class="col-md-6 pagination">
-          <a id="osd-previous"><%= blacklight_icon('chevron_left') %></a>
-          <span id="osd-page">1</span>  of <%= count %>
-          <a id="osd-next"><%= blacklight_icon('chevron_right') %></a>
-        </div>
-      <% end %>
-        <div class="col-md-6 controls">
-          <a id="osd-zoom-in"><%= blacklight_icon('add_circle') %></a>
-          <a id="osd-zoom-out"><%= blacklight_icon('remove_circle') %></a>
-          <a id="osd-home"><%= blacklight_icon('resize_small') %></a>
-          <a id="osd-full-page"><%= blacklight_icon('custom_fullscreen') %></a>
-        </div>
+      <div class="col-md-6 pagination">
+        <% if count > 1 %>
+          <% osd_config = osd_config_referencestrip.merge(osd_config) %>
+            <a id="osd-previous"><%= blacklight_icon('chevron_left') %></a>
+            <span id="osd-page">1</span>  of <%= count %>
+            <a id="osd-next"><%= blacklight_icon('chevron_right') %></a>
+        <% end %>
+      </div>
+      <div class="col-md-6 controls">
+        <a id="osd-zoom-in"><%= blacklight_icon('add_circle') %></a>
+        <a id="osd-zoom-out"><%= blacklight_icon('remove_circle') %></a>
+        <a id="osd-home"><%= blacklight_icon('resize_small') %></a>
+        <a id="osd-full-page"><%= blacklight_icon('custom_fullscreen') %></a>
+      </div>
     </div>
     <%= openseadragon_picture_tag image, class: 'osd-image row', data: { openseadragon: osd_config } %>
   </div>

data/app/views/catalog/_slideshow_modal.html.erb

@@ -3,8 +3,8 @@
     <div class="modal-dialog modal-xl">
       <div class="modal-content">
         <div class="modal-header">
-          <button type="button" class="close" data-dismiss="modal" aria-hidden="true">
-            ×
+          <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
+            <span aria-hidden="true">&times;</span>
           </button>
         </div>
         <div class="modal-body">

data/blacklight-gallery.gemspec

@@ -17,10 +17,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails", '~> 5.1'
-  spec.add_dependency 'blacklight', '~> 7.0'
+  spec.add_dependency "rails", '>= 5.1', '< 7'
+  spec.add_dependency 'blacklight', '~> 7.12'
   spec.add_dependency "bootstrap", "~> 4.0"
-  spec.add_dependency "openseadragon", ">= 0.2.0"
 
   spec.add_development_dependency "rake"
   spec.add_development_dependency 'sqlite3'
@@ -31,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "solr_wrapper"
   spec.add_development_dependency "engine_cart", "~> 2.0"
   spec.add_development_dependency "capybara"
-  spec.add_development_dependency 'chromedriver-helper'
+  spec.add_development_dependency 'webdrivers'
+  spec.add_development_dependency 'rexml' # pending https://github.com/SeleniumHQ/selenium/issues/9001
   spec.add_development_dependency "selenium-webdriver", '>= 3.13.1'
 end

data/config/locales/blacklight-gallery.ar.yml

@@ -1,15 +1,19 @@
 ar:
   blacklight:
+    icon:
+      chevron_left_previous_image: 'الصورة السابقة' 
+      chevron_right_next_image: 'الصورة التالية' 
     search:
       view:
         gallery: "معرض الصور"
-        slideshow: "عرض متتابع"
+        slideshow: "عرض الصور"
         masonry: "عرض الصور كمجموعة"
   blacklight_gallery:
     catalog:
       grid_slideshow:
-        missing_image: "صورة غير موجودة"
-      document_slideshow:
-        header: "حدد صورة لبدء العرض المتتابع"
+        missing_image: 'غير موجود'
       modal_slideshow:
         counter: "%{counter} من %{count}"
+      slideshow:
+        pause: وقف عرض الصور
+        start: بدء عرض الصور

data/config/locales/blacklight-gallery.en.yml

@@ -1,5 +1,8 @@
 en:
   blacklight:
+    icon:
+      chevron_left_previous_image: 'previous image' 
+      chevron_right_next_image: 'next image' 
     search:
       view:
         gallery: "Gallery"
@@ -9,7 +12,8 @@ en:
     catalog:
       grid_slideshow:
         missing_image: 'Missing'
-      document_slideshow:
-        header: "Select an image to start the slideshow"
       modal_slideshow:
         counter: "%{counter} of %{count}"
+      slideshow:
+        pause: Pause slideshow
+        start: Start slideshow

data/config/locales/blacklight-gallery.es.yml

@@ -9,7 +9,8 @@ es:
     catalog:
       grid_slideshow:
         missing_image: No hay nada
-      document_slideshow:
-        header: Selecione una imagen para empezar
       modal_slideshow:
         counter: "%{counter} de %{count}"
+      slideshow:
+        pause: Pausa la Diapositivas
+        start: Empezar la Diapositivas

data/config/locales/blacklight-gallery.fr.yml

@@ -9,7 +9,8 @@ fr:
     catalog:
       grid_slideshow:
         missing_image: 'Image manquante'
-      document_slideshow:
-        header: "Sélectionnez une image pour lancer le diaporama"
       modal_slideshow:
         counter: "%{counter} de %{count}"
+      slideshow:
+        pause: Suspendre le diaporama
+        start: Lancer le diaporama

data/config/locales/blacklight-gallery.it.yml

@@ -9,7 +9,8 @@ it:
     catalog:
       grid_slideshow:
         missing_image: 'Mancante'
-      document_slideshow:
-        header: "Seleziona un immagine per l'avvio del slideshow"
       modal_slideshow:
         counter: "%{counter} di %{count}"
+      slideshow:
+        pause: Pausa del slideshow
+        start: Avvia del slideshow

data/config/locales/blacklight-gallery.pt-BR.yml

@@ -13,3 +13,6 @@ pt-BR:
         header: "Selecione uma imagem para iniciar a apresentação de slides"
       modal_slideshow:
         counter: "%{counter} de %{count}"
+      slideshow:
+        pause: Pausar a apresentação de slides
+        start: Iniciar a apresentação de slides

data/config/locales/blacklight-gallery.zh.yml

@@ -9,7 +9,8 @@ zh:
     catalog:
       grid_slideshow:
         missing_image: '图片缺失'
-      document_slideshow:
-        header: '选择图片启动幻灯展示'
       modal_slideshow:
         counter: "%{counter} of %{count}"
+      slideshow:
+        pause: 暂停幻灯片展示
+        start: 启动幻灯片展示

data/lib/blacklight/gallery/engine.rb

@@ -3,8 +3,6 @@ require 'blacklight'
 module Blacklight
   module Gallery
     class Engine < Rails::Engine
-      require 'openseadragon'
-    
     end
   end
 end

data/lib/blacklight/gallery/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Gallery
-    VERSION = "1.7.0"
+    VERSION = "3.0.0"
   end
 end

data/lib/generators/blacklight_gallery/install_generator.rb

@@ -8,13 +8,18 @@ module BlacklightGallery
     def assets
       copy_file "blacklight_gallery.css.scss", "app/assets/stylesheets/blacklight_gallery.css.scss"
       copy_file "blacklight_gallery.js", "app/assets/javascripts/blacklight_gallery.js"
+
+      insert_into_file "app/assets/javascripts/application.js", after: '//= require blacklight/blacklight' do
+        "\n//= require blacklight_gallery"
+      end
     end
 
     def configuration
       inject_into_file 'app/controllers/catalog_controller.rb', after: "configure_blacklight do |config|" do
-        "\n    config.view.gallery.partials = [:index_header, :index]" \
-        "\n    config.view.masonry.partials = [:index]" \
-        "\n    config.view.slideshow.partials = [:index]\n\n" \
+        "\n    config.view.gallery.document_component = Blacklight::Gallery::DocumentComponent" \
+        "\n    # config.view.gallery.classes = 'row-cols-2 row-cols-md-3'" \
+        "\n    config.view.masonry.document_component = Blacklight::Gallery::DocumentComponent" \
+        "\n    config.view.slideshow.document_component = Blacklight::Gallery::SlideshowComponent" \
         "\n    config.show.tile_source_field = :content_metadata_image_iiif_info_ssm" \
         "\n    config.show.partials.insert(1, :openseadragon)"
       end
@@ -27,6 +32,8 @@ module BlacklightGallery
     end
 
     def add_openseadragon
+      gem "openseadragon", ">= 0.2.0"
+      Bundler.with_clean_env { run 'bundle install' }
       generate 'openseadragon:install'
     end
   end

data/lib/generators/blacklight_gallery/templates/blacklight_gallery.js

@@ -1 +1,2 @@
-//= require blacklight_gallery/default
+//= require blacklight_gallery/default
+//= require blacklight_gallery/osd_viewer

data/spec/components/blacklight/gallery/document_component_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::Gallery::DocumentComponent, type: :component do
+  subject(:component) { described_class.new(document: document, **attr) }
+
+  let(:attr) { {} }
+  let(:view_context) { controller.view_context }
+  let(:render) do
+    component.render_in(view_context)
+  end
+
+  let(:rendered) do
+    Capybara::Node::Simple.new(render)
+  end
+
+  let(:document) do
+    SolrDocument.new(
+      id: 'x',
+      thumbnail_path_ss: 'http://example.com/image.jpg',
+      title_tsim: 'This is my document title'
+    )
+  end
+
+  let(:blacklight_config) do
+    CatalogController.blacklight_config.deep_copy.tap do |config|
+      config.track_search_session = false
+      config.index.thumbnail_field = 'thumbnail_path_ss'
+    end
+  end
+
+  before do
+    allow(controller).to receive(:blacklight_config).and_return(blacklight_config)
+    allow(view_context).to receive(:current_search_session).and_return(nil)
+    allow(view_context).to receive(:search_session).and_return({})
+
+    # dumb hack to get our stubbing into the thumbnail component
+    allow(controller).to receive(:view_context).and_return(view_context)
+  end
+
+  it 'has a thumbnail and caption' do
+    expect(rendered).to have_selector '.document-thumbnail img'
+    expect(rendered).to have_selector '.caption', text: 'This is my document title'
+  end
+end

data/spec/components/blacklight/gallery/slideshow_component_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::Gallery::SlideshowComponent, type: :component do
+  subject(:component) { described_class.new(document: document, **attr) }
+
+  let(:attr) { {} }
+  let(:view_context) { controller.view_context }
+  let(:render) do
+    component.render_in(view_context)
+  end
+
+  let(:rendered) do
+    Capybara::Node::Simple.new(render)
+  end
+
+  let(:blacklight_config) { Blacklight::Configuration.new }
+
+  before do
+    allow(view_context).to receive(:blacklight_config).and_return(blacklight_config)
+  end
+
+  describe '#slideshow_tag' do
+    subject { rendered }
+
+    let(:document) { SolrDocument.new({}) }
+
+    context 'with a slideshow method' do
+      let(:blacklight_config) { Blacklight::Configuration.new.tap { |config| config.index.slideshow_method = :xyz } }
+
+      it 'calls the provided slideshow method' do
+        expect(view_context).to receive_messages(xyz: 'some-slideshow')
+        expect(rendered).to have_text 'some-slideshow'
+      end
+
+      it 'does not render an image if the method returns nothing' do
+        expect(view_context).to receive_messages(xyz: nil)
+        expect(rendered).not_to have_selector 'img'
+      end
+    end
+
+    context 'with a field' do
+      let(:blacklight_config) { Blacklight::Configuration.new.tap { |config| config.index.slideshow_field = :xyz } }
+      let(:document) { SolrDocument.new({ xyz: 'http://example.com/some.jpg' }) }
+
+      it { is_expected.to have_selector 'img[src="http://example.com/some.jpg"]' }
+
+      context 'without data in the field' do
+        let(:document) { SolrDocument.new({}) }
+
+        it { is_expected.not_to have_selector 'img' }
+      end
+    end
+
+    context 'with nothing configured' do
+      it { is_expected.not_to have_selector 'img' }
+    end
+
+    context 'falling back to a thumbnail' do
+      let(:blacklight_config) { Blacklight::Configuration.new.tap { |config| config.index.thumbnail_field = :xyz } }
+      let(:document) { SolrDocument.new({ xyz: 'http://example.com/thumb.jpg' }) }
+
+      it { is_expected.to have_selector 'img[src="http://example.com/thumb.jpg"]' }
+    end
+  end
+end