blacklight-gallery 4.6.0 → 4.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3f0a42b90e61a4eb36e76d0be574f4d8f3f2a8c55afb3de20e69bca1f88a086
-  data.tar.gz: b74abe92f757dd6a2cfd6a7043364915a591030fd1bd6560bb6f64f973d80f94
+  metadata.gz: 8b75282f6589ca914165117342f3f5122f114ec3fcb399dfc5ae660eaeb678ea
+  data.tar.gz: 7f63ed97b52f21db2a92688e8d9e20ad17997c74a98cdacfd0e488c7d675c6ae
 SHA512:
-  metadata.gz: 6bdc5e6d5bb2eba2f1d425513ce9d8623e73968734601c2fc239cb9937b809cfb7b86a6e3334ace2cd4c4a0d3155448597258b259f2d66ed329c95f43d2e5c77
-  data.tar.gz: f8019948c79a90819b928c8548430fd7df8dce919de4f3d3e0a331ab54e344c4d7ed2f987c9df937f308663ca360c6cde6a751b06edeebfc1f3458423b9ad48d
+  metadata.gz: 5122d73ef112b00f340999c31faa6cb572c1ea83dc639164475be9f91596ad64c995cc0acfb9226145c343cf191b4f9f401af5a9912eda82cbdad507a69d24f6
+  data.tar.gz: f83b3438b30ce60a936a5ca98694dc2a50c01d41cf37b8fdc0a8de628f171d0396d5d8de952a65936cff015cafedf482e9ccf963e51df1b958bede7c9e0c4b5e

data/.github/workflows/ruby.yml

@@ -19,6 +19,7 @@ jobs:
         experimental: [false]
         additional_engine_cart_rails_options: [""]
         additional_name: [""]
+        view_component_version: ["~> 3.12"]
         include:
           - ruby: "3.1"
             rails_version: 6.1.7
@@ -35,6 +36,12 @@ jobs:
             blacklight_version: "github"
             experimental: true
             additional_name: Blacklight main branch
+          - ruby: "3.2"
+            rails_version: "7.0.4"
+            blacklight_version: "~> 7.0"
+            experimental: false
+            view_component_version: "~> 2.83"
+            additional_name: "/ ViewComponent 2"
           - ruby: "3.2"
             rails_version: "7.0.4"
             blacklight_version: "github"
@@ -44,6 +51,7 @@ jobs:
     env:
       RAILS_VERSION: ${{ matrix.rails_version }}
       BLACKLIGHT_VERSION: ${{ matrix.blacklight_version }}
+      VIEW_COMPONENT_VERSION: ${{ matrix.view_component_version }}
       ENGINE_CART_RAILS_OPTIONS: "--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test ${{ matrix.additional_engine_cart_rails_options }}"
     steps:
       - uses: actions/checkout@v4

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

@@ -2,18 +2,18 @@
   <div class="osd-toolbar row">
     <div class="col-md-6 pagination">
       <% if count > 1 %>
-        <% osd_config = osd_config_referencestrip.merge(osd_config) %>
-          <a id="<%= id_prefix %>-previous"><%= render Blacklight::Gallery::Icons::ChevronLeftComponent.new %></a>
-          <span id="<%= id_prefix %>-page">1</span> of <%= count %>
-          <a id="<%= id_prefix %>-next"><%= render Blacklight::Gallery::Icons::ChevronRightComponent.new  %></a>
+        <% multi_page_osd_config = osd_config_referencestrip.merge(osd_config) %>
+        <a id="<%= @id_prefix %>-previous"><%= render Blacklight::Gallery::Icons::ChevronLeftComponent.new %></a>
+        <span id="<%= @id_prefix %>-page">1</span>&nbsp; of <%= count %>
+        <a id="<%= @id_prefix %>-next"><%= render Blacklight::Gallery::Icons::ChevronRightComponent.new  %></a>
       <% end %>
     </div>
     <div class="col-md-6 controls">
-      <a id="<%= id_prefix %>-zoom-in"><%= render Blacklight::Gallery::Icons::AddCircleComponent.new %></a>
-      <a id="<%= id_prefix %>-zoom-out"><%= render Blacklight::Gallery::Icons::RemoveCircleComponent.new %></a>
-      <a id="<%= id_prefix %>-home"><%= render Blacklight::Gallery::Icons::ResizeSmallComponent.new %></a>
-      <a id="<%= id_prefix %>-full-page"><%= render Blacklight::Gallery::Icons::CustomFullscreenComponent.new %></a>
+      <a id="<%= @id_prefix %>-zoom-in"><%= render Blacklight::Gallery::Icons::AddCircleComponent.new %></a>
+      <a id="<%= @id_prefix %>-zoom-out"><%= render Blacklight::Gallery::Icons::RemoveCircleComponent.new %></a>
+      <a id="<%= @id_prefix %>-home"><%= render Blacklight::Gallery::Icons::ResizeSmallComponent.new %></a>
+      <a id="<%= @id_prefix %>-full-page"><%= render Blacklight::Gallery::Icons::CustomFullscreenComponent.new %></a>
     </div>
   </div>
-  <%= helpers.openseadragon_picture_tag image, class: 'osd-image row', data: { openseadragon: osd_config } %>
+  <%= helpers.openseadragon_picture_tag image, class: 'osd-image row', data: { openseadragon: multi_page_osd_config ? multi_page_osd_config : osd_config } %>
 </div>

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

@@ -12,6 +12,7 @@ module Blacklight
         @presenter = presenter
         @view_config = view_config
         @classes = classes
+        @id_prefix = id_prefix
       end
 
       def image
@@ -33,21 +34,20 @@ module Blacklight
       def osd_config
         {
           crossOriginPolicy: false,
-          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"
+          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"
         }
       end
 
       def osd_config_referencestrip
         {
           showReferenceStrip: true,
-          referenceStripPosition: 'OUTSIDE',
+          sequenceMode: true,
           referenceStripScroll: 'vertical',
-          referenceStripWidth: 100,
           referenceStripBackgroundColor: 'transparent'
         }
       end

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

@@ -7,7 +7,8 @@ module Blacklight
 
       def initialize(document:, document_counter: nil, **args)
         super(document: document, document_counter: document_counter, **args)
-        @document_counter = document_counter || @counter
+
+        @slide_to = @counter - 1
       end
 
       def before_render
@@ -45,8 +46,8 @@ module Blacklight
         {
           'context-href': nil,
           context_href: nil,
-          'slide-to': @document_counter,
-          'bs-slide-to': @document_counter,
+          'slide-to': @slide_to,
+          'bs-slide-to': @slide_to,
           toggle: "modal",
           'bs-toggle': "modal",
           target: "#slideshow-modal",

data/lib/blacklight/gallery/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Gallery
-    VERSION = "4.6.0"
+    VERSION = "4.6.1"
   end
 end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::Gallery::OpenseadragonEmbedComponent, type: :component do
+  subject(:component) do
+    described_class.new(
+      document: document,
+      presenter: presenter,
+      **attr
+    )
+  end
+
+  let(:attr) { {} }
+  let(:view_context) { vc_test_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'
+    )
+  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 'openseadragon viewer' do
+    let(:blacklight_config) do
+      Blacklight::Configuration.new.tap do |config|
+        config.index.slideshow_method = :xyz
+        if Blacklight::VERSION > '8'
+          config.track_search_session.storage = false
+        else
+          config.track_search_session = false
+        end
+      end
+    end
+    it 'uses a single @id_prefix to generate unique control ids' do
+      expect(component.osd_config[:zoomInButton]).to include(component.instance_variable_get(:@id_prefix))
+      expect(component.osd_config[:zoomOutButton]).to include(component.instance_variable_get(:@id_prefix))
+      expect(component.osd_config[:homeButton]).to include(component.instance_variable_get(:@id_prefix))
+      expect(component.osd_config[:fullPageButton]).to include(component.instance_variable_get(:@id_prefix))
+      expect(component.osd_config[:nextButton]).to include(component.instance_variable_get(:@id_prefix))
+      expect(component.osd_config[:previousButton]).to include(component.instance_variable_get(:@id_prefix))
+    end
+  end
+end

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

@@ -51,6 +51,14 @@ RSpec.describe Blacklight::Gallery::SlideshowPreviewComponent, type: :component
       expect(rendered).to have_selector '.thumbnail img[@src="http://example.com/image.jpg"]'
     end
 
+    it 'renders the correct slide number' do
+      if VIEW_COMPONENT_VERSION < 3
+        expect(rendered).to have_css '[data-slide-to=\"4\"][data-bs-slide-to=\"4\"]'
+      else
+        expect(rendered).to have_css '[data-slide-to=\"5\"][data-bs-slide-to=\"5\"]'
+      end
+    end
+
     context 'when the presenter returns nothing' do
       let(:document) { SolrDocument.new(id: 'abc') }
 

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ require 'rspec/collection_matchers'
 require 'rspec/its'
 require 'rspec/rails'
 require 'rspec/active_model/mocks'
+require 'view_component_v2_test_helpers'
 
 require 'selenium-webdriver'
 
@@ -19,4 +20,9 @@ require 'blacklight/gallery'
 RSpec.configure do |c|
   c.infer_spec_type_from_file_location!
   c.include ViewComponent::TestHelpers, type: :component
+  view_component_version = Gem.loaded_specs['view_component'].version
+  VIEW_COMPONENT_VERSION = view_component_version.segments.first
+  if VIEW_COMPONENT_VERSION < 3
+    c.include ViewComponentV2TestHelpers, type: :component
+  end
 end

data/spec/test_app_templates/Gemfile.extra

@@ -3,3 +3,7 @@ if ENV['BLACKLIGHT_VERSION'] == 'github'
 elsif ENV['BLACKLIGHT_VERSION'] && !ENV['BLACKLIGHT_VERSION'].empty?
   gem 'blacklight', ENV['BLACKLIGHT_VERSION']
 end
+
+unless ENV['VIEW_COMPONENT_VERSION'].to_s == ""
+  gem 'view_component', ENV.fetch('VIEW_COMPONENT_VERSION')
+end

data/spec/view_component_v2_test_helpers.rb

@@ -0,0 +1,20 @@
+module ViewComponentV2TestHelpers
+  def vc_test_controller
+    @vc_test_controller ||= __vc_test_helpers_build_controller(ViewComponent::Base.test_controller.constantize)
+  end
+
+  def __vc_test_helpers_build_controller(klass)
+    klass.new.tap { |c| c.request = vc_test_request }.extend(Rails.application.routes.url_helpers)
+  end
+
+  def vc_test_request
+    require "action_controller/test_case"
+
+    @vc_test_request ||=
+      begin
+        out = ActionDispatch::TestRequest.create
+        out.session = ActionController::TestSession.new
+        out
+      end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-gallery
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 4.6.1
 platform: ruby
 authors:
 - Chris Beer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-25 00:00:00.000000000 Z
+date: 2024-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -288,6 +288,7 @@ files:
 - solr/conf/xslt/example_rss.xsl
 - solr/conf/xslt/luke.xsl
 - spec/components/blacklight/gallery/document_component_spec.rb
+- spec/components/blacklight/gallery/openseadragon_embed_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
@@ -298,6 +299,7 @@ files:
 - spec/spec_helper.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb
+- spec/view_component_v2_test_helpers.rb
 - spec/views/catalog/_document_slideshow.html.erb_spec.rb
 - spec/views/catalog/_openseadragon_default.html.erb_spec.rb
 - vendor/assets/javascripts/imagesloaded.min.js
@@ -327,6 +329,7 @@ specification_version: 4
 summary: Gallery display for Blacklight
 test_files:
 - spec/components/blacklight/gallery/document_component_spec.rb
+- spec/components/blacklight/gallery/openseadragon_embed_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
@@ -337,5 +340,6 @@ test_files:
 - spec/spec_helper.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb
+- spec/view_component_v2_test_helpers.rb
 - spec/views/catalog/_document_slideshow.html.erb_spec.rb
 - spec/views/catalog/_openseadragon_default.html.erb_spec.rb