blacklight-gallery 3.1.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9ee96cd4e180caff7bc9589599eba86cba367459e594f79f5e33feac2030bb7
-  data.tar.gz: 3f088a83957abc39d2a099e8ddd337c09b62bbae65aae26b4ce73d11eaf9c9f6
+  metadata.gz: 2c352955a6ff3422f81258dd566cfe58114da0c93f65241e70ae093ee3a76dfb
+  data.tar.gz: 58707632ea6223e59985771c6cb79f5cfa3a2e410e44cb5f02a631ed24f2c7be
 SHA512:
-  metadata.gz: fa1dc30f79963288cfdd629b5a8cb1db1750aed48ce76a2ffb8bf0cc8d97d6bfa8801dfc88d390e763af331ef59084b12c039a5e84af50544de7a9ce3e2617ab
-  data.tar.gz: e5aa5cd8772332cc98b80d6497875c2899e816baf6e4f5f0f488c98a806b28a6792a005c62a3c12f9bbc8097f4c7712e1248f4a8f198a236937ede9bbf5bae9c
+  metadata.gz: b3220d3e51e3a178532a61678631b3d4dba3b0d38042a0bc4b9a62e447daefce4afa3833b4d2d0cce41442088af8004b4791e1e54e2bd42f2dfdfdfa600a7c51
+  data.tar.gz: dda77c2f7e9e80bb37e4783b6559e53cc0acaa6a403e3b17f66fc8a5db3501f01cc2c9f3844747809bf54f1f8e37648b3099102a428e6d169cd30045090f2b15

data/.github/workflows/ruby.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       matrix:
         rails_version: [6.1.1]
-        ruby: [2.7, 3.0]
+        ruby: [2.7, '3.0']
     env:
       RAILS_VERSION: ${{ matrix.rails_version }}
     steps:

data/app/assets/images/blacklight/slideshow.svg

@@ -1 +1,4 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0V0z"/><path d="M10 16.5l6-4.5-6-4.5v9zM12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm0 18c-4.41 0-8-3.59-8-8s3.59-8 8-8 8 3.59 8 8-3.59 8-8 8z"/></svg>
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 25 24">
+  <path d="m1 9v6h-1v-6zm6-3h12v13h-13v-13zm11 1h-11v11h11zm-13 0v11h-1v-11zm-2 1v9h-1v-9zm18-1v11h-1v-11zm2 1v8h-1v-8zm2 1v5h-1v-5z"/>
+</svg>

data/app/assets/stylesheets/blacklight_gallery/_gallery.scss

@@ -24,6 +24,11 @@
   }
 
   .document-metadata {
+    .document-title-heading {
+      padding-left: 0;
+      padding-right: 0;
+    }
+
     dt, dd {
       flex: 0 0 100%;
       max-width: 100%;

data/app/assets/stylesheets/blacklight_gallery/_slideshow.scss

@@ -12,8 +12,10 @@ $gray-dark: #343a40 !default;
 
     .modal-header {
       border-bottom: none;
+      padding: 0.5rem 1rem;
 
       .close {
+        font-size: 2.5rem;
         color: white;
       }
     }
@@ -57,11 +59,16 @@ $gray-dark: #343a40 !default;
 
   .carousel-control {
     position: absolute;
-    top: 40%;
+    top: 0;
     height: 100%;
     width: 50px;
+
     .blacklight-icons {
+      display: block;
+      position: absolute;
       width: 3rem;
+      top: calc(50% - 3rem);
+
       svg {
         height: 3rem;
         width: 3rem;
@@ -77,7 +84,7 @@ $gray-dark: #343a40 !default;
   }
 
   .caption {
-    font-size: 14px;
+    font-size: 1rem;
     color: $gray-light;
     margin: 10px auto;
     min-width: 200px;
@@ -88,7 +95,7 @@ $gray-dark: #343a40 !default;
     border-radius: 12px;
     border: 1px solid $gray-light;
     color: $gray-light;
-    font-size: 12px;
+    font-size: 1rem;
     overflow: auto;
     padding: 4px 10px;
     text-align: center;
@@ -97,6 +104,8 @@ $gray-dark: #343a40 !default;
   .controls {
     svg {
       fill: $gray-light;
+      width: 32px;
+      height: 32px;
     }
   }
 }

data/app/components/blacklight/gallery/document_component.html.erb

@@ -1,19 +1,16 @@
-<%= render(Blacklight::DocumentComponent.new(classes: 'col', component: :div, document: @document, counter: @counter)) do |component| %>
-  <% component.with(:body) do %>
+<%= render(Blacklight::DocumentComponent.new(classes: 'col', component: :div, document: @document, counter: @counter, presenter: @presenter)) do |component| %>
+  <% component.body do %>
     <div class="thumbnail-container">
-      <% # Checking if #thumbnail takes any args before passing image_options. #thumbnail did not take any args in version 7.14.1 and earlier %>
-      <%= method(:thumbnail).arity.zero? ? thumbnail : thumbnail(class: 'img-thumbnail') %>
+      <%= thumbnail %>
 
       <div class="caption-area">
         <div class="caption container">
-          <header class="documentHeader row">
-            <%= content_tag @title_component, class: 'index_title document-title-heading' do %>
-              <%= before_title %><%= title %><%= after_title %>
-            <% end %>
-            <%= actions %>
-          </header>
+          <%= title %>
           <%= content %>
           <%= metadata %>
+          <% metadata_sections.each do |section| %>
+            <%= section %>
+          <% end %>
         </div>
       </div>
     </div>

data/app/components/blacklight/gallery/document_component.rb

@@ -3,6 +3,11 @@
 module Blacklight
   module Gallery
     class DocumentComponent < Blacklight::DocumentComponent
+      def before_render
+        thumbnail(image_options: { class: 'img-thumbnail' }) unless thumbnail.present?
+        super
+      end
+
       def render_document_class(*args)
         @view_context.render_document_class(*args)
       end

data/app/components/blacklight/gallery/slideshow_preview_component.html.erb

@@ -1,5 +1,5 @@
-<%= render(Blacklight::DocumentComponent.new(classes: 'slideshow-preview-thumbnail', component: :div, document: @document, counter: @counter)) do |component| %>
-  <% component.with(:body) do %>
+<%= render(Blacklight::DocumentComponent.new(classes: 'slideshow-preview-thumbnail', component: :div, document: @document, counter: @counter, presenter: @presenter)) do |component| %>
+  <% component.body do %>
     <%= @view_context.link_to_document(@document, thumbnail, class: 'thumbnail', data: { 'context-href': nil, 'slide-to': @document_counter - 1, toggle: "modal", target: "#slideshow-modal" }) %>
   <% end %>
 <% end %>

data/app/components/blacklight/gallery/slideshow_preview_component.rb

@@ -10,10 +10,23 @@ module Blacklight
         @document_counter = document_counter || @counter
       end
 
-      def thumbnail
-        @thumbnail ||
-          (presenter.thumbnail.exists? && presenter.thumbnail.render({ alt: presenter.heading })) ||
-          content_tag(:div, t('.missing_image', scope: [:blacklight_gallery]), class: 'thumbnail thumbnail-placeholder')
+      def before_render
+        populate_thumbnail_slot if thumbnail.blank?
+        super
+      end
+
+      # populate the thumbnail slot with a value if one wasn't explicitly provided
+      def populate_thumbnail_slot
+        thumbnail_content = presenter.thumbnail.render({ alt: presenter.heading }) if presenter.thumbnail.exists?
+        unless thumbnail_content.present?
+          thumbnail_content = content_tag(
+            :div,
+            t(:missing_image, scope: %i[blacklight_gallery catalog grid_slideshow]),
+            class: 'thumbnail thumbnail-placeholder'
+          )
+        end
+
+        thumbnail(thumbnail_content)
       end
 
       def presenter

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

@@ -1,5 +1,6 @@
+<% view_config = local_assigns[:view_config] || blacklight_config&.view_config(document_index_view_type) %>
 <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 id="documents" class="<%= (Array(view_config.classes || 'row-cols-2 row-cols-md-3') + ["row documents-#{view_config.key}"]).join(' ') %>">
+    <%= render documents, as: :document, view_config: view_config %>
   </div>
 </div>

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

@@ -1,3 +1,4 @@
-<div id="documents" class="<%= (Array(blacklight_config.view_config(document_index_view_type).classes) + ["documents-#{document_index_view_type}"]).join(' ') %>">
-  <%= render documents, as: :document %>
+<% view_config = local_assigns[:view_config] || blacklight_config&.view_config(document_index_view_type) %>
+<div id="documents" class="<%= (Array(view_config.classes) + ["documents-#{view_config.key}"]).join(' ') %>">
+  <%= render documents, as: :document, view_config: view_config %>
 </div>

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

@@ -1,6 +1,8 @@
-<div id="documents" class="<%= (Array(blacklight_config.view_config(document_index_view_type).classes) + ["documents-#{document_index_view_type}"]).join(' ') %>">
+<% view_config = local_assigns[:view_config] || blacklight_config&.view_config(document_index_view_type) %>
+
+<div id="documents" class="<%= (Array(view_config.classes) + ["documents-#{view_config.key}"]).join(' ') %>">
   <div class="grid">
-    <%= render((blacklight_config.view_config(document_index_view_type).preview_component || Blacklight::Gallery::SlideshowPreviewComponent).with_collection(documents)) %>
+    <%= render((view_config.preview_component || Blacklight::Gallery::SlideshowPreviewComponent).with_collection(documents)) %>
   </div>
 
   <%= render layout: 'slideshow_modal' do %>

data/blacklight-gallery.gemspec

@@ -18,8 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails", '>= 5.1', '< 7'
-  spec.add_dependency 'blacklight', '~> 7.12'
-  spec.add_dependency "bootstrap", "~> 4.0"
+  spec.add_dependency 'blacklight', '~> 7.17'
 
   spec.add_development_dependency "rake"
   spec.add_development_dependency 'sqlite3'

data/lib/blacklight/gallery/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Gallery
-    VERSION = "3.1.0"
+    VERSION = "3.4.0"
   end
 end

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

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::Gallery::DocumentComponent, type: :component do
-  subject(:component) { described_class.new(document: document, **attr) }
+  subject(:component) { described_class.new(document: document, presenter: presenter, **attr) }
 
   let(:attr) { {} }
   let(:view_context) { controller.view_context }
@@ -23,6 +23,8 @@ RSpec.describe Blacklight::Gallery::DocumentComponent, type: :component do
     )
   end
 
+  let(:presenter) { Blacklight::IndexPresenter.new(document, view_context, blacklight_config) }
+
   let(:blacklight_config) do
     CatalogController.blacklight_config.deep_copy.tap do |config|
       config.track_search_session = false
@@ -34,6 +36,7 @@ RSpec.describe Blacklight::Gallery::DocumentComponent, type: :component 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({})
+    allow(view_context).to receive(:blacklight_config).and_return(blacklight_config)
 
     # dumb hack to get our stubbing into the thumbnail component
     allow(controller).to receive(:view_context).and_return(view_context)

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

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::Gallery::SlideshowComponent, type: :component do
-  subject(:component) { described_class.new(document: document, **attr) }
+  subject(:component) { described_class.new(document: document, presenter: presenter, **attr) }
 
   let(:attr) { {} }
   let(:view_context) { controller.view_context }
@@ -16,6 +16,7 @@ RSpec.describe Blacklight::Gallery::SlideshowComponent, type: :component do
   end
 
   let(:blacklight_config) { Blacklight::Configuration.new }
+  let(:presenter) { Blacklight::IndexPresenter.new(document, view_context, blacklight_config) }
 
   before do
     allow(view_context).to receive(:blacklight_config).and_return(blacklight_config)

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::Gallery::SlideshowPreviewComponent, type: :component do
+  subject(:component) { described_class.new(document: document, document_counter: 5, presenter: presenter, **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 }
+  let(:presenter) { Blacklight::IndexPresenter.new(document, view_context, blacklight_config) }
+
+  before do
+    allow(view_context).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
+
+  let(:blacklight_config) do
+    Blacklight::Configuration.new.tap do |config|
+      config.index.thumbnail_field = 'thumbnail_path_ss'
+      config.track_search_session = false
+    end
+  end
+
+  describe 'default thumbnail' do
+    let(:document) { SolrDocument.new(id: 'abc', thumbnail_path_ss: 'http://example.com/image.jpg') }
+
+    it 'renders the thumbnail' do
+      puts render
+      expect(rendered).to have_selector '.thumbnail img[@src="http://example.com/image.jpg"]'
+    end
+
+    context 'when the presenter returns nothing' do
+      let(:document) { SolrDocument.new(id: 'abc') }
+
+      subject { rendered }
+      it { is_expected.to have_selector '.thumbnail-placeholder', text: 'Missing' }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-gallery
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-02 00:00:00.000000000 Z
+date: 2022-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,28 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.12'
+        version: '7.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.12'
-- !ruby/object:Gem::Dependency
-  name: bootstrap
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '7.17'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -307,6 +293,7 @@ files:
 - solr/conf/xslt/luke.xsl
 - spec/components/blacklight/gallery/document_component_spec.rb
 - spec/components/blacklight/gallery/slideshow_component_spec.rb
+- spec/components/blacklight/gallery/slideshow_preview_component_spec.rb
 - spec/features/gallery_spec.rb
 - spec/features/masonry_spec.rb
 - spec/features/slideshow_spec.rb
@@ -338,13 +325,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Gallery display for Blacklight
 test_files:
 - spec/components/blacklight/gallery/document_component_spec.rb
 - spec/components/blacklight/gallery/slideshow_component_spec.rb
+- spec/components/blacklight/gallery/slideshow_preview_component_spec.rb
 - spec/features/gallery_spec.rb
 - spec/features/masonry_spec.rb
 - spec/features/slideshow_spec.rb