blacklight-gallery 3.3.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 293ba63382be492c6f0e70f34542b75cd37b3c21904ef7f4482ae90e59709a69
-  data.tar.gz: 9f930cbb7b02a7353bb98aec29393b7f0bee7febefcff4b53e919ae294becd25
+  metadata.gz: 3920e96baf118137203d9e67fafc19564991399b4cf2082d8fc0409e0095982a
+  data.tar.gz: 7435e227a144f08d25b1748f1a1d3eddf9ef958e7b25a5e8460fd1e6a8a98c64
 SHA512:
-  metadata.gz: e18434c888670a0925c24fbfd7ad0ca57c341a40dc91ea138bed735ed208ef236989509b76d6971a8856a8126a9b7282fa3c480fbf98677bd624df4d71c62892
-  data.tar.gz: 9caafa8f14d044098c1d1b7c94d221b6398004a63d72bd580992498f12ca580882e1417977e3e64b2d61d52ae2caf9d9c79b3a8a1e2c4cc121d93ae5cc7780b0
+  metadata.gz: 9f19253bc16e2ed53b6d5b1d6a96f9df64cc0708cc0197b01b3031a877a0bf89427212036450c6d0acaecf4b647f8b79c3f09cbe9ddfbd43f5463be93dd478b5
+  data.tar.gz: 94d41d45a7e516a84634607d891580bd8dc66f2347f4604633643bd94df3a80f6695224b5559f5a4bc974a32b78c9464da361870351c5b44525eb2fe3dbf0884

data/.github/workflows/ruby.yml

@@ -11,26 +11,15 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rails_version: [6.1.1]
-        ruby: [2.7, 3.0]
-    env:
-      RAILS_VERSION: ${{ matrix.rails_version }}
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby ${{ matrix.ruby }}
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-    - name: Install dependencies with Rails ${{ matrix.rails_version }}
-      run: bundle install
-    - name: Run tests
-      run: bundle exec rake
-  test_rails52:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        rails_version: [5.2.4.4, 6.0.3.4]
-        ruby: [2.7]
+        rails_version: [6.1.4.6]
+        ruby: ['2.7', '3.0']
+        include:
+          - rails_version: 7.0.2.2
+            ruby: '3.0'
+          - rails_version: 5.2.4.4
+            ruby: '2.7'
+          - rails_version: 6.0.3.4
+            ruby: '2.7'
     env:
       RAILS_VERSION: ${{ matrix.rails_version }}
     steps:

data/README.md

@@ -1,5 +1,5 @@
 # Blacklight::Gallery
-[![Gem Version](https://badge.fury.io/rb/blacklight-gallery.svg)](http://badge.fury.io/rb/blacklight-gallery)  [![Build Status](https://travis-ci.org/projectblacklight/blacklight-gallery.svg?branch=master)](https://travis-ci.org/projectblacklight/blacklight-gallery)
+[![Gem Version](https://badge.fury.io/rb/blacklight-gallery.svg)](http://badge.fury.io/rb/blacklight-gallery) [![CI](https://github.com/projectblacklight/blacklight-gallery/actions/workflows/ruby.yml/badge.svg)](https://github.com/projectblacklight/blacklight-gallery/actions/workflows/ruby.yml)
 
 Gallery views for Blacklight search results
 

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

@@ -2,9 +2,7 @@
   .document {
     border-bottom: none;
     display: flex;
-
     min-height: 250px;
-    -webkit-flex: 1 0 250px;
   }
 
   .caption {

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,18 +84,24 @@ $gray-dark: #343a40 !default;
   }
 
   .caption {
-    font-size: 14px;
-    color: $gray-light;
+    font-size: 1rem;
     margin: 10px auto;
     min-width: 200px;
     max-width: 50%;
+    a {
+      color: $gray-light;
+      text-decoration: underline;
+      &:hover, &:focus {
+        color: #ffffff;
+      }
+    }
   }
 
   .counter {
     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 +110,8 @@ $gray-dark: #343a40 !default;
   .controls {
     svg {
       fill: $gray-light;
+      width: 32px;
+      height: 32px;
     }
   }
 }

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

@@ -2,7 +2,7 @@
   <div class="frame">
       <%= slideshow_tag %>
       <div class="caption">
-        <%= presenter.heading %>
+        <%= helpers.link_to_document(presenter.document, presenter.heading, counter: @counter) %>
       </div>
 
       <span class="counter">

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

@@ -20,11 +20,11 @@ module Blacklight
           method_name = view_config.slideshow_method
           @view_context.send(method_name, @document, image_options)
         elsif view_config.slideshow_field
-          url = slideshow_image_url
-
-          image_tag url, image_options if url.present?
+          return if slideshow_image_url.blank?
+          image = image_tag slideshow_image_url, image_options
+          helpers.link_to_document(@document, image)
         elsif presenter.thumbnail.exists?
-          presenter.thumbnail.thumbnail_tag(image_options, url_options.reverse_merge(suppress_link: true))
+          presenter.thumbnail.thumbnail_tag(image_options)
         end
       end
 

data/app/helpers/blacklight/openseadragon_helper.rb

@@ -1,7 +1,24 @@
 module Blacklight
   module OpenseadragonHelper
+    # Somewhat arbitrary number; the only important thing is that
+    # it is bigger than the number of embedded viewers on a page
+    ID_COUNTER_MAX = (2**20) - 1
+
+    # Mint a (sufficiently) unique identifier, so we can associate
+    # the expand/collapse control with labels
+    def self.mint_id
+      @id_counter = ((@id_counter || 0) + 1) % ID_COUNTER_MAX
+
+      # We convert the ID to hex for markup compactness
+      @id_counter.to_s(16)
+    end
+
     def osd_container_class
       "col-md-6"
     end
+
+    def osd_html_id_prefix
+      "osd-#{Blacklight::OpenseadragonHelper.mint_id}".to_param
+    end
   end
-end
+end

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

@@ -1,13 +1,16 @@
-<% image = document.to_openseadragon(blacklight_config.view_config(:show)) %>
+<%
+  image = document.to_openseadragon(blacklight_config.view_config(:show))
+  id_prefix = osd_html_id_prefix
+%>
 <%
   osd_config = {
     crossOriginPolicy: false,
-    zoomInButton:     "osd-zoom-in",
-    zoomOutButton:    "osd-zoom-out",
-    homeButton:       "osd-home",
-    fullPageButton:   "osd-full-page",
-    nextButton:       "osd-next",
-    previousButton:   "osd-previous"
+    zoomInButton:     "#{id_prefix}-zoom-in",
+    zoomOutButton:    "#{id_prefix}-zoom-out",
+    homeButton:       "#{id_prefix}-home",
+    fullPageButton:   "#{id_prefix}-full-page",
+    nextButton:       "#{id_prefix}-next",
+    previousButton:   "#{id_prefix}-previous"
   }
 
   osd_config_referencestrip = {
@@ -26,16 +29,16 @@
       <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>
+            <a id="<%= id_prefix %>-previous"><%= blacklight_icon('chevron_left') %></a>
+            <span id="<%= id_prefix %>-page">1</span>  of <%= count %>
+            <a id="<%= id_prefix %>-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>
+        <a id="<%= id_prefix %>-zoom-in"><%= blacklight_icon('add_circle') %></a>
+        <a id="<%= id_prefix %>-zoom-out"><%= blacklight_icon('remove_circle') %></a>
+        <a id="<%= id_prefix %>-home"><%= blacklight_icon('resize_small') %></a>
+        <a id="<%= id_prefix %>-full-page"><%= blacklight_icon('custom_fullscreen') %></a>
       </div>
     </div>
     <%= openseadragon_picture_tag image, class: 'osd-image row', data: { openseadragon: osd_config } %>

data/blacklight-gallery.gemspec

@@ -17,9 +17,8 @@ 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', '< 7'
+  spec.add_dependency "rails", '>= 5.1', '< 8'
   spec.add_dependency 'blacklight', '~> 7.17'
-  spec.add_dependency "bootstrap", "~> 4.0"
 
   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.3.1"
+    VERSION = "4.0.0"
   end
 end

data/lib/generators/blacklight_gallery/install_generator.rb

@@ -16,10 +16,9 @@ module BlacklightGallery
 
     def configuration
       inject_into_file 'app/controllers/catalog_controller.rb', after: "configure_blacklight do |config|" do
-        "\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.view.gallery(document_component: Blacklight::Gallery::DocumentComponent)" \
+        "\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

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

@@ -15,20 +15,30 @@ RSpec.describe Blacklight::Gallery::SlideshowComponent, type: :component do
     Capybara::Node::Simple.new(render)
   end
 
-  let(:blacklight_config) { Blacklight::Configuration.new }
+  let(:document) do
+    SolrDocument.new(
+      id: 'x',
+    )
+  end
+
   let(:presenter) { Blacklight::IndexPresenter.new(document, view_context, blacklight_config) }
 
   before do
+    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)
   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 } }
+      let(:blacklight_config) do
+        Blacklight::Configuration.new.tap do |config|
+          config.index.slideshow_method = :xyz
+          config.track_search_session = false
+        end
+      end
 
       it 'calls the provided slideshow method' do
         expect(view_context).to receive_messages(xyz: 'some-slideshow')
@@ -41,26 +51,39 @@ RSpec.describe Blacklight::Gallery::SlideshowComponent, type: :component do
       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' }) }
+    context 'with a slideshow field' do
+      let(:blacklight_config) do
+        Blacklight::Configuration.new.tap do |config|
+          config.index.slideshow_field = :xyz 
+          config.track_search_session = false
+        end
+      end
+      let(:document) { SolrDocument.new({ xyz: 'http://example.com/some.jpg', id: 'x' }) }
 
       it { is_expected.to have_selector 'img[src="http://example.com/some.jpg"]' }
 
       context 'without data in the field' do
-        let(:document) { SolrDocument.new({}) }
+        let(:document) { SolrDocument.new({id: 'x'}) }
 
         it { is_expected.not_to have_selector 'img' }
       end
     end
 
-    context 'with nothing configured' do
+    context 'with no view_config' do
+      let(:blacklight_config) { Blacklight::Configuration.new.tap { |config| 
+        config.track_search_session = false
+      } }
       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' }) }
+      let(:blacklight_config) do
+        Blacklight::Configuration.new.tap do |config|
+          config.index.thumbnail_field = :xyz 
+          config.track_search_session = false
+        end
+      end
+      let(:document) { SolrDocument.new({ xyz: 'http://example.com/thumb.jpg', id: 'x' }) }
 
       it { is_expected.to have_selector 'img[src="http://example.com/thumb.jpg"]' }
     end

data/spec/test_app_templates/Gemfile.extra

@@ -1 +0,0 @@
-gem 'sprockets', '< 4'

data/spec/views/catalog/_document_slideshow.html.erb_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "catalog/_document_slideshow.html.erb", :type => :view do
+describe "catalog/_document_slideshow", :type => :view do
   let(:blacklight_config) do
     Blacklight::Configuration.new do |config|
       config.track_search_session = false

data/spec/views/catalog/_openseadragon_default.html.erb_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe "catalog/openseadragon_default" do
   let(:document) { SolrDocument.new }
   let(:blacklight_config) { Blacklight::Configuration.new }
-  let(:p) { "catalog/openseadragon_default.html.erb" }
+  let(:p) { "catalog/openseadragon_default" }
 
   before do
     allow(view).to receive_messages(blacklight_config: blacklight_config, openseadragon_picture_tag: "<img />")
@@ -14,9 +14,9 @@ describe "catalog/openseadragon_default" do
     render partial: p, locals: { document: document }
     expect(rendered).to have_selector ".openseadragon-container"
   end
-  
+
   it "should support passing a container class" do
     render partial: p, locals: { document: document, osd_container_class: "custom-container" }
     expect(rendered).to have_selector ".custom-container"
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-gallery
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2022-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,7 +19,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
@@ -44,20 +44,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.17'
-- !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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -339,7 +325,7 @@ 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