blacklight-gallery 4.5.4 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3be75dee9c5f78414f77d47940c36dc5ddf47725dd09547ea4e03cd8d5b803d
-  data.tar.gz: 4dfb92722fcaf7233321db99aa46316accd61972da2160da2b7dfebc5548046e
+  metadata.gz: b3f0a42b90e61a4eb36e76d0be574f4d8f3f2a8c55afb3de20e69bca1f88a086
+  data.tar.gz: b74abe92f757dd6a2cfd6a7043364915a591030fd1bd6560bb6f64f973d80f94
 SHA512:
-  metadata.gz: dc5997b7fea7e04c1d3d5cf2124daa02aec25a784411df4ea8904fc6db82550bcbcb670d7d46f2ecba63a51575a67363dfdd8780162b8b8e1c6ecf502d4d3a0e
-  data.tar.gz: 957e12b77b748b861e9e55de8390a4339ae7fa95837eed47c2ad71d1185e74587bea54ff282e08773e7c989df04789b2fb64a446747e3ba6dbe29dc015402cbb
+  metadata.gz: 6bdc5e6d5bb2eba2f1d425513ce9d8623e73968734601c2fc239cb9937b809cfb7b86a6e3334ace2cd4c4a0d3155448597258b259f2d66ed329c95f43d2e5c77
+  data.tar.gz: f8019948c79a90819b928c8548430fd7df8dce919de4f3d3e0a331ab54e344c4d7ed2f987c9df937f308663ca360c6cde6a751b06edeebfc1f3458423b9ad48d

data/.github/workflows/ruby.yml

@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
   test:
@@ -13,42 +13,45 @@ jobs:
     name: test (ruby ${{ matrix.ruby }} / rails ${{ matrix.rails_version }} / blacklight ${{ matrix.blacklight_version }} ${{ matrix.additional_name }})
     strategy:
       matrix:
-        ruby: [2.7, '3.0']
-        rails_version: ['6.1.7', '7.0.4']
-        blacklight_version: ['~> 7.0']
+        ruby: ["3.2", "3.3"]
+        rails_version: ["7.0.4"]
+        blacklight_version: ["~> 7.0"]
         experimental: [false]
-        additional_engine_cart_rails_options: ['']
-        additional_name: ['']
+        additional_engine_cart_rails_options: [""]
+        additional_name: [""]
         include:
-        - ruby: '3.1'
-          rails_version: '7.0.4'
-          blacklight_version: '~> 7.0'
-          experimental: false
-        - ruby: '3.2'
-          rails_version: '7.0.4'
-          blacklight_version: '~> 8.0'
-          experimental: false
-        - ruby: '3.2'
-          rails_version: '7.0.4'
-          blacklight_version: 'github'
-          experimental: true
-        - ruby: '3.2'
-          rails_version: '7.0.4'
-          blacklight_version: 'github'
-          experimental: true
-          additional_engine_cart_rails_options: -a propshaft
-          additional_name: '/ Propshaft'
+          - ruby: "3.1"
+            rails_version: 6.1.7
+            blacklight_version: "~> 7.0"
+            experimental: false
+            additional_name: Rails 6.1, Ruby 3.1
+          - ruby: "3.2"
+            rails_version: "7.0.4"
+            blacklight_version: "~> 8.0"
+            experimental: false
+            additional_name: Blacklight 8
+          - ruby: "3.2"
+            rails_version: "7.0.4"
+            blacklight_version: "github"
+            experimental: true
+            additional_name: Blacklight main branch
+          - ruby: "3.2"
+            rails_version: "7.0.4"
+            blacklight_version: "github"
+            experimental: true
+            additional_engine_cart_rails_options: -a propshaft
+            additional_name: "/ Propshaft"
     env:
       RAILS_VERSION: ${{ matrix.rails_version }}
       BLACKLIGHT_VERSION: ${{ matrix.blacklight_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
-    - 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
+      - uses: actions/checkout@v4
+      - 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

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

@@ -0,0 +1,19 @@
+<div class="openseadragon-container <%= class_names(classes) %>">
+  <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>
+      <% 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>
+    </div>
+  </div>
+  <%= helpers.openseadragon_picture_tag image, class: 'osd-image row', data: { openseadragon: osd_config } %>
+</div>

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Gallery
+    class OpenseadragonEmbedComponent < Blacklight::Component
+      attr_reader :document, :presenter, :classes
+
+      def initialize(document:, presenter:, view_config: nil, classes: [], **kwargs)
+        super
+
+        @document = document
+        @presenter = presenter
+        @view_config = view_config
+        @classes = classes
+      end
+
+      def image
+        @image ||= document.to_openseadragon(view_config)
+      end
+
+      def count
+        Array(image).length
+      end
+
+      def view_config
+        @view_config || presenter.view_config
+      end
+
+      def render?
+        !image.nil?
+      end
+
+      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"
+        }
+      end
+
+      def osd_config_referencestrip
+        {
+          showReferenceStrip: true,
+          referenceStripPosition: 'OUTSIDE',
+          referenceStripScroll: 'vertical',
+          referenceStripWidth: 100,
+          referenceStripBackgroundColor: 'transparent'
+        }
+      end
+
+      def id_prefix
+        "osd-#{Blacklight::OpenseadragonHelper.mint_id}".to_param
+      end
+    end
+  end
+end

data/app/helpers/blacklight/openseadragon_helper.rb

@@ -14,9 +14,10 @@ module Blacklight
     end
 
     def osd_container_class
-      "col-md-6"
+      'col-md-6'
     end
 
+    # @deprecated
     def osd_html_id_prefix
       "osd-#{Blacklight::OpenseadragonHelper.mint_id}".to_param
     end

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

@@ -1,48 +1 @@
-<%
-  view_config = local_assigns[:view_config] || blacklight_config&.view_config(:show)
-  image = document.to_openseadragon(view_config)
-  id_prefix = osd_html_id_prefix
-%>
-<%
-  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"
-  }
-
-  osd_config_referencestrip = {
-    showReferenceStrip:             true,
-    referenceStripPosition:         'OUTSIDE',
-    referenceStripScroll:           'vertical',
-    referenceStripWidth:            100,
-    referenceStripBackgroundColor:  'transparent'
-  }
-%>
-
-<% unless image.nil? %>
-  <% count = Array(image).length %>
-  <div class="openseadragon-container <%= osd_container_class %>">
-    <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>
-        <% 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>
-      </div>
-    </div>
-    <%= openseadragon_picture_tag image, class: 'osd-image row', data: { openseadragon: osd_config } %>
-  </div>
-
-<% end %>
+<%= render Blacklight::Gallery::OpenseadragonEmbedComponent.new(document: document, presenter: document_presenter(document), view_config: local_assigns[:view_config], classes: [osd_container_class]) %>

data/lib/blacklight/gallery/version.rb

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

data/spec/features/slideshow_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe 'Slideshow', default_max_wait_time: 10, js: true do
+RSpec.describe 'Slideshow', default_max_wait_time: 20, js: true do
 
   it 'opens when one of the grid panes is clicked' do
     visit search_catalog_path( q: 'medicine', view: 'slideshow' )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-gallery
 version: !ruby/object:Gem::Version
-  version: 4.5.4
+  version: 4.6.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-18 00:00:00.000000000 Z
+date: 2024-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -239,6 +239,8 @@ files:
 - app/components/blacklight/gallery/icons/resize_small_component.rb
 - app/components/blacklight/gallery/icons/slideshow_component.rb
 - app/components/blacklight/gallery/icons/start_slideshow_component.rb
+- app/components/blacklight/gallery/openseadragon_embed_component.html.erb
+- app/components/blacklight/gallery/openseadragon_embed_component.rb
 - app/components/blacklight/gallery/slideshow_component.html.erb
 - app/components/blacklight/gallery/slideshow_component.rb
 - app/components/blacklight/gallery/slideshow_preview_component.html.erb
@@ -319,7 +321,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Gallery display for Blacklight