blacklight-gallery 4.0.2 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ffebc1b8d0949d7deaed3ce7d7391815ff694a5c9fe9581043bef8c37917ff3
-  data.tar.gz: 7e7d766b8d517268b2dd5a5a3b018e02fcac14b1a3730ee62d49d865798156e6
+  metadata.gz: d46a1601796a187729339ce0655d2537db43a7319608a2de67cd763b38fcbdcd
+  data.tar.gz: b9f28ea874c0908cfc9e19f7134b7dfc29779ed5c7865af8f96f1becab54a478
 SHA512:
-  metadata.gz: d344db0389fd834cc709f14af45f215fadcaf3c40b0e2dcc46b40121caa9f7ab60b19cf06b657dde1338c46ab99f5cb2eae1d6e64c9735a0f54b919135743b75
-  data.tar.gz: 54c51080b3476aaa4d58601623453cfb33d0716c0d8f9f4dd785b46801cc569d2974ad7e373f928dc7468c08d59db8059d8608b798ed6a9b2e5b508c97a53729
+  metadata.gz: 38912a52ab2cc3a35ec137d5e326e4e92f90228dd8254f9fa7526dc5f565945c08aefe3fcda4d028191dea8a7615b3073865e3c513a1701824deef9a3d4b092f
+  data.tar.gz: 76f328cf6da35f629a2ce99396ec89be2b5d97331f38daee12574201b9a21392f09b366ff38e099b4510bf380a3ed40a9a74509e7be384455d99fb865a73c7b6

data/.github/workflows/ruby.yml

@@ -2,26 +2,46 @@ name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   test:
     runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
+    name: test (ruby ${{ matrix.ruby }} / rails ${{ matrix.rails_version }} / blacklight ${{ matrix.blacklight_version }} ${{ matrix.additional_name }})
     strategy:
       matrix:
-        rails_version: [6.1.4.6]
-        ruby: ['2.7', '3.0']
+        ruby: [2.7, '3.0']
+        rails_version: ['6.1.7', '7.0.4']
+        blacklight_version: ['~> 7.0']
+        experimental: [false]
+        additional_engine_cart_rails_options: ['']
+        additional_name: ['']
         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'
+        - ruby: '3.1'
+          rails_version: '7.0.4'
+          blacklight_version: '~> 7.0'
+          experimental: false
+        - ruby: '3.1'
+          rails_version: '7.0.4'
+          blacklight_version: '8.0.0.beta6'
+          experimental: false
+        - ruby: '3.1'
+          rails_version: '7.0.4'
+          blacklight_version: 'github'
+          experimental: true
+        - ruby: '3.1'
+          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@v2
     - name: Set up Ruby ${{ matrix.ruby }}

data/Gemfile

@@ -11,8 +11,8 @@ end
 gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
 
 # BEGIN ENGINE_CART BLOCK
-# engine_cart: 1.1.0
-# engine_cart stanza: 0.10.0
+# engine_cart: 2.5.0
+# engine_cart stanza: 2.5.0
 # the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
 file = File.expand_path('Gemfile', ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path('.internal_test_app', File.dirname(__FILE__)))
 if File.exist?(file)
@@ -32,17 +32,16 @@ else
     else
       gem 'rails', ENV['RAILS_VERSION']
     end
-  end
 
-  case ENV['RAILS_VERSION']
-  when /^5.[12]/
-    gem 'sass-rails', '~> 5.0'
-  when /^4.2/
-    gem 'responders', '~> 2.0'
-    gem 'sass-rails', '>= 5.0'
-    gem 'coffee-rails', '~> 4.1.0'
-  when /^4.[01]/
-    gem 'sass-rails', '< 5.0'
+    case ENV['RAILS_VERSION']
+    when /^6.0/
+      gem 'sass-rails', '>= 6'
+      gem 'webpacker', '~> 4.0'
+    when /^5.[12]/
+      gem 'sass-rails', '~> 5.0'
+      gem 'sprockets', '~> 3.7'
+      gem 'thor', '~> 0.20'
+    end
   end
 end
 # END ENGINE_CART BLOCK

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

@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm-1 14H9V8h2v8zm4 0h-2V8h2v8z"></path></svg
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm-1 14H9V8h2v8zm4 0h-2V8h2v8z"></path></svg>

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

@@ -1,4 +1,8 @@
-<%= render(Blacklight::DocumentComponent.new(classes: 'col', component: :div, document: @document, counter: @counter, presenter: @presenter)) do |component| %>
+<% component = Blacklight::VERSION > '8' ?
+  Blacklight::DocumentComponent.new(classes: 'col', component: :div, document: @presenter, counter: @counter) :
+  Blacklight::DocumentComponent.new(classes: 'col', component: :div, document: @document, presenter: @presenter, counter: @counter)
+%> 
+<%= render(component) do |component| %>
   <% component.body do %>
     <div class="thumbnail-container">
       <%= thumbnail %>

data/app/components/blacklight/gallery/icons/add_circle_component.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Gallery
+    module Icons
+      # This is the icon for the add button.
+      # You can override the default svg by setting:
+      #   Blacklight::Gallery:Icons::AddCircleComponent.svg = '<svg>your SVG here</svg>'
+      class AddCircleComponent < Blacklight::Icons::IconComponent
+        self.svg = <<~SVG
+          <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="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm5 11h-4v4h-2v-4H7v-2h4V7h2v4h4v2z"/>
+          </svg>
+        SVG
+      end
+    end
+  end
+end

data/app/components/blacklight/gallery/icons/chevron_left_component.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Gallery
+    module Icons
+      # This is the gallery icon for the view type button.
+      # You can override the default svg by setting:
+      #   Blacklight::Gallery:Icons::ChevronLeftComponent.svg = '<svg>your SVG here</svg>'
+      class ChevronLeftComponent < Blacklight::Icons::IconComponent
+        self.svg = <<~SVG
+          <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="M15.41 7.41L14 6l-6 6 6 6 1.41-1.41L10.83 12l4.58-4.59z"/>
+          </svg>
+        SVG
+      end
+    end
+  end
+end

data/app/components/blacklight/gallery/icons/chevron_right_component.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Gallery
+    module Icons
+      # This is the gallery icon for the view type button.
+      # You can override the default svg by setting:
+      #   Blacklight::Gallery:Icons::ChevronRightComponent.svg = '<svg>your SVG here</svg>'
+      class ChevronRightComponent < Blacklight::Icons::IconComponent
+        self.svg = <<~SVG
+          <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 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6-6-6z"/>
+          </svg>
+        SVG
+      end
+    end
+  end
+end

data/app/components/blacklight/gallery/icons/custom_fullscreen_component.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Gallery
+    module Icons
+      # This is the icon for the fullscreen button.
+      # You can override the default svg by setting:
+      #   Blacklight::Gallery:Icons::CustomFullscreenComponent.svg = '<svg>your SVG here</svg>'
+      class CustomFullscreenComponent < Blacklight::Icons::IconComponent
+        self.svg = <<~SVG
+          <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24">
+            <path d="M7,14H5v5h5V17H7Zm7-9V7h3v3h2V5Z" /><path d="M22.517,1.524H1.736V22.37H22.517Zm-2,18.845H3.736V3.524H20.517Z" />
+          </svg>
+        SVG
+      end
+    end
+  end
+end

data/app/components/blacklight/gallery/icons/gallery_component.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Gallery
+    module Icons
+      # This is the gallery icon for the view type button.
+      # You can override the default svg by setting:
+      #   Blacklight::Gallery:Icons::GalleryComponent.svg = '<svg>your SVG here</svg>'
+      class GalleryComponent < Blacklight::Icons::IconComponent
+        self.svg = <<~SVG
+          <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="M4 11h5V5H4v6zm0 7h5v-6H4v6zm6 0h5v-6h-5v6zm6 0h5v-6h-5v6zm-6-7h5V5h-5v6zm6-6v6h5V5h-5z"/>
+          </svg>
+        SVG
+      end
+    end
+  end
+end

data/app/components/blacklight/gallery/icons/masonry_component.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Gallery
+    module Icons
+      # This is the gallery icon for the view type button.
+      # You can override the default svg by setting:
+      #   Blacklight::Gallery:Icons::MasonryComponent.svg = '<svg>your SVG here</svg>'
+      class MasonryComponent < Blacklight::Icons::IconComponent
+        self.svg = <<~SVG
+          <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 18h5v-6h-5v6zm-6 0h5V5H4v13zm12 0h5v-6h-5v6zM10 5v6h11V5H10z"/>
+          </svg>
+        SVG
+      end
+    end
+  end
+end

data/app/components/blacklight/gallery/icons/pause_slideshow_component.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Gallery
+    module Icons
+      # This is the gallery icon for the view type button.
+      # You can override the default svg by setting:
+      #   Blacklight::Gallery:Icons::PauseSlideshowComponent.svg = '<svg>your SVG here</svg>'
+      class PauseSlideshowComponent < Blacklight::Icons::IconComponent
+        self.svg = <<~SVG
+          <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24">
+            <path d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm-1 14H9V8h2v8zm4 0h-2V8h2v8z"></path>
+          </svg>
+        SVG
+      end
+    end
+  end
+end

data/app/components/blacklight/gallery/icons/remove_circle_component.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Gallery
+    module Icons
+      # This is the icon for the remove button.
+      # You can override the default svg by setting:
+      #   Blacklight::Gallery:Icons::RemoveCircleComponent.svg = '<svg>your SVG here</svg>'
+      class RemoveCircleComponent < Blacklight::Icons::IconComponent
+        self.svg = <<~SVG
+          <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="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm5 11H7v-2h10v2z"/>
+          </svg>
+        SVG
+      end
+    end
+  end
+end

data/app/components/blacklight/gallery/icons/resize_small_component.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Gallery
+    module Icons
+      # This is the icon for the resize button.
+      # You can override the default svg by setting:
+      #   Blacklight::Gallery:Icons::ResizeSmallComponent.svg = '<svg>your SVG here</svg>'
+      class ResizeSmallComponent < Blacklight::Icons::IconComponent
+        self.svg = <<~SVG
+          <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24">
+            <path d="M5,16H8v3h2V14H5ZM16,8V5H14v5h5V8Z"/><path d="M22.517,1.524H1.736V22.37H22.517Zm-2,18.845H3.736V3.524H20.517Z"/>
+          </svg>
+        SVG
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Gallery
+    module Icons
+      # This is the gallery icon for the view type button.
+      # You can override the default svg by setting:
+      #   Blacklight::Gallery:Icons::SlideshowComponent.svg = '<svg>your SVG here</svg>'
+      class SlideshowComponent < Blacklight::Icons::IconComponent
+        self.svg = <<~SVG
+          <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>
+        SVG
+      end
+    end
+  end
+end

data/app/components/blacklight/gallery/icons/start_slideshow_component.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Gallery
+    module Icons
+      # This is the gallery icon for the view type button.
+      # You can override the default svg by setting:
+      #   Blacklight::Gallery:Icons::StartSlideshowComponent.svg = '<svg>your SVG here</svg>'
+      class StartSlideshowComponent < Blacklight::Icons::IconComponent
+        self.svg = <<~SVG
+          <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24">
+            <path d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm-2 14.5v-9l6 4.5-6 4.5z"></path>
+          </svg>
+        SVG
+      end
+    end
+  end
+end

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

@@ -1,4 +1,8 @@
-<%= render(Blacklight::DocumentComponent.new(classes: 'slideshow-preview-thumbnail', component: :div, document: @document, counter: @counter, presenter: @presenter)) do |component| %>
+<% component = Blacklight::VERSION > '8' ?
+  Blacklight::DocumentComponent.new(classes: 'slideshow-preview-thumbnail', component: :div, document: @presenter, counter: @counter) :
+  Blacklight::DocumentComponent.new(classes: 'slideshow-preview-thumbnail', component: :div, document: @document, presenter: @presenter, counter: @counter)
+%> 
+<%= render(component) 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 %>

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

@@ -1,6 +1,7 @@
 <% view_config = local_assigns[:view_config] || blacklight_config&.view_config(document_index_view_type) %>
 <div class="container">
   <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 %>
+    <% document_presenters = Blacklight::VERSION > '8' ? documents.map { |doc| document_presenter(doc) } : documents %>
+    <%= render view_config.document_component.with_collection(document_presenters, counter_offset: @response&.start || 0) %>
   </div>
 </div>

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

@@ -1,4 +1,5 @@
 <% 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 %>
+  <% document_presenters = Blacklight::VERSION > '8' ? documents.map { |doc| document_presenter(doc) } : documents%>
+  <%= render view_config.document_component.with_collection(document_presenters, counter_offset: @response&.start || 0) %>
 </div>

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

@@ -1,31 +1,32 @@
 <% 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(' ') %>">
+  <% document_presenters = Blacklight::VERSION > '8' ? documents.map { |document| document_presenter(document) }: documents %>
   <div class="grid">
-    <%= render((view_config.preview_component || Blacklight::Gallery::SlideshowPreviewComponent).with_collection(documents)) %>
+    <%= render((view_config.preview_component || Blacklight::Gallery::SlideshowPreviewComponent).with_collection(document_presenters)) %>
   </div>
 
   <%= render layout: 'slideshow_modal' do %>
     <div id="slideshow" class="slideshow-presenter">
       <!-- Wrapper for slides -->
       <div class="slideshow-inner">
-        <%= render documents, as: :document %>
+        <%= render view_config.document_component.with_collection(document_presenters, counter_offset: @response&.start || 0) %>
       </div>
 
       <!-- Controls -->
       <a class="left carousel-control prev" href="#slideshow" data-slide="prev">
-        <%= blacklight_icon 'chevron_left', additional_options: { label_context: 'previous_image' } %>
+        <%= render Blacklight::Gallery::Icons::ChevronLeftComponent.new 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' } %>
+        <%= render Blacklight::Gallery::Icons::ChevronRightComponent.new 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' %>
+        <%= render Blacklight::Gallery::Icons::PauseSlideshowComponent.new %>
         </button>
         <button class="btn btn-sm btn-link" data-behavior="start-slideshow" aria-label="<%= t('blacklight_gallery.catalog.slideshow.start') %>">
-          <%= blacklight_icon 'start_slideshow' %>
+          <%= render Blacklight::Gallery::Icons::StartSlideshowComponent.new %>
         </button>
       </div>
     </div>

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

@@ -29,16 +29,16 @@
       <div class="col-md-6 pagination">
         <% if count > 1 %>
           <% osd_config = osd_config_referencestrip.merge(osd_config) %>
-            <a id="<%= id_prefix %>-previous"><%= blacklight_icon('chevron_left') %></a>
+            <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"><%= blacklight_icon('chevron_right') %></a>
+            <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"><%= 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>
+        <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 } %>

data/blacklight-gallery.gemspec

@@ -17,12 +17,12 @@ 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', '< 8'
-  spec.add_dependency 'blacklight', '~> 7.17'
+  spec.add_dependency "rails", '>= 6.1', '< 8'
+  spec.add_dependency 'blacklight', '>= 7.17', '< 9'
 
   spec.add_development_dependency "rake"
   spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency "rspec-rails", "~> 3.1"
+  spec.add_development_dependency "rspec-rails", "~> 6"
   spec.add_development_dependency "rspec-its"
   spec.add_development_dependency "rspec-activemodel-mocks"
   spec.add_development_dependency "rspec-collection_matchers"
@@ -30,6 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "engine_cart", "~> 2.0"
   spec.add_development_dependency "capybara"
   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/lib/blacklight/gallery/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Gallery
-    VERSION = "4.0.2"
+    VERSION = "4.2.0"
   end
 end

data/lib/generators/blacklight_gallery/install_generator.rb

@@ -5,20 +5,11 @@ module BlacklightGallery
 
     source_root File.expand_path('../templates', __FILE__)
 
-    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(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.view.gallery(document_component: Blacklight::Gallery::DocumentComponent, icon: Blacklight::Gallery::Icons::GalleryComponent)" \
+        "\n    config.view.masonry(document_component: Blacklight::Gallery::DocumentComponent, icon: Blacklight::Gallery::Icons::MasonryComponent)" \
+        "\n    config.view.slideshow(document_component: Blacklight::Gallery::SlideshowComponent, icon: Blacklight::Gallery::Icons::SlideshowComponent)" \
         "\n    config.show.tile_source_field = :content_metadata_image_iiif_info_ssm" \
         "\n    config.show.partials.insert(1, :openseadragon)"
       end
@@ -35,5 +26,14 @@ module BlacklightGallery
       Bundler.with_clean_env { run 'bundle install' }
       generate 'openseadragon:install'
     end
+
+    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
   end
 end

data/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "blacklight-gallery",
+  "version": "4.2.0",
+  "description": "Gallery views for Blacklight search results",
+  "main": "app/assets/javascripts/blacklight_gallery/default.js",
+  "files": [
+    "app/assets/javascripts/blacklight_gallery/*.js",
+    "vendor/assets/javascripts/*.js",
+    "app/assets/stylesheets/blacklight_gallery/*.scss"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/projectblacklight/blacklight-gallery.git"
+  },
+  "author": "",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/projectblacklight/blacklight-gallery/issues"
+  },
+  "homepage": "https://github.com/projectblacklight/blacklight-gallery#readme",
+  "devDependencies": { },
+  "dependencies": {
+    "blacklight-frontend": ">=7.1.0-alpha",
+    "jquery": ">=3.0"
+  }
+}

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

@@ -3,7 +3,13 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::Gallery::DocumentComponent, type: :component do
-  subject(:component) { described_class.new(document: document, presenter: presenter, **attr) }
+  subject(:component) do
+    if Blacklight::VERSION > '8'
+      described_class.new(document: presenter, **attr)
+    else
+      described_class.new(document: document, presenter: presenter, **attr)
+    end
+  end
 
   let(:attr) { {} }
   let(:view_context) { controller.view_context }
@@ -27,7 +33,11 @@ RSpec.describe Blacklight::Gallery::DocumentComponent, type: :component do
 
   let(:blacklight_config) do
     CatalogController.blacklight_config.deep_copy.tap do |config|
-      config.track_search_session = false
+      if Blacklight::VERSION > '8'
+        config.track_search_session.storage = false
+      else
+        config.track_search_session = false
+      end
       config.index.thumbnail_field = 'thumbnail_path_ss'
     end
   end

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

@@ -3,7 +3,13 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::Gallery::SlideshowComponent, type: :component do
-  subject(:component) { described_class.new(document: document, presenter: presenter, **attr) }
+  subject(:component) do
+    if Blacklight::VERSION > '8'
+      described_class.new(document: presenter, **attr)
+    else
+      described_class.new(document: document, presenter: presenter, **attr)
+    end
+  end
 
   let(:attr) { {} }
   let(:view_context) { controller.view_context }
@@ -36,7 +42,11 @@ RSpec.describe Blacklight::Gallery::SlideshowComponent, type: :component do
       let(:blacklight_config) do
         Blacklight::Configuration.new.tap do |config|
           config.index.slideshow_method = :xyz
-          config.track_search_session = false
+          if Blacklight::VERSION > '8'
+            config.track_search_session.storage = false
+          else
+            config.track_search_session = false
+          end
         end
       end
 
@@ -55,7 +65,11 @@ RSpec.describe Blacklight::Gallery::SlideshowComponent, type: :component do
       let(:blacklight_config) do
         Blacklight::Configuration.new.tap do |config|
           config.index.slideshow_field = :xyz 
-          config.track_search_session = false
+          if Blacklight::VERSION > '8'
+            config.track_search_session.storage = false
+          else
+            config.track_search_session = false
+          end
         end
       end
       let(:document) { SolrDocument.new({ xyz: 'http://example.com/some.jpg', id: 'x' }) }
@@ -70,9 +84,15 @@ RSpec.describe Blacklight::Gallery::SlideshowComponent, type: :component do
     end
 
     context 'with no view_config' do
-      let(:blacklight_config) { Blacklight::Configuration.new.tap { |config| 
-        config.track_search_session = false
-      } }
+      let(:blacklight_config) do
+        Blacklight::Configuration.new.tap do |config| 
+          if Blacklight::VERSION > '8'
+            config.track_search_session.storage = false
+          else
+            config.track_search_session = false
+          end
+        end
+      end
       it { is_expected.not_to have_selector 'img' }
     end
 
@@ -80,7 +100,11 @@ RSpec.describe Blacklight::Gallery::SlideshowComponent, type: :component do
       let(:blacklight_config) do
         Blacklight::Configuration.new.tap do |config|
           config.index.thumbnail_field = :xyz 
-          config.track_search_session = false
+          if Blacklight::VERSION > '8'
+            config.track_search_session.storage = false
+          else
+            config.track_search_session = false
+          end
         end
       end
       let(:document) { SolrDocument.new({ xyz: 'http://example.com/thumb.jpg', id: 'x' }) }

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

@@ -3,7 +3,13 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::Gallery::SlideshowPreviewComponent, type: :component do
-  subject(:component) { described_class.new(document: document, document_counter: 5, presenter: presenter, **attr) }
+  subject(:component) do
+    if Blacklight::VERSION > '8'
+      described_class.new(document: presenter, document_counter: 5, **attr)
+    else
+      described_class.new(document: document, document_counter: 5, presenter: presenter, **attr)
+    end
+  end
 
   let(:attr) { {} }
   let(:view_context) { controller.view_context }
@@ -30,7 +36,11 @@ RSpec.describe Blacklight::Gallery::SlideshowPreviewComponent, type: :component
   let(:blacklight_config) do
     Blacklight::Configuration.new.tap do |config|
       config.index.thumbnail_field = 'thumbnail_path_ss'
-      config.track_search_session = false
+      if Blacklight::VERSION > '8'
+        config.track_search_session.storage = false
+      else
+        config.track_search_session = false
+      end
     end
   end
 
@@ -38,7 +48,6 @@ RSpec.describe Blacklight::Gallery::SlideshowPreviewComponent, type: :component
     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
 

data/spec/features/gallery_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe "Gallery view", :type => :feature do
+RSpec.describe "Gallery view", :type => :feature do
   before { visit search_catalog_path :q => 'medicine', :view => 'gallery' }
 
-  it "should display results in a galley view" do
+  it "displays results in a galley view" do
     expect(page).to have_selector("#documents.documents-gallery")
     expect(page).to have_selector(".caption", text: "Strong Medicine speaks")
   end

data/spec/test_app_templates/Gemfile.extra

@@ -0,0 +1,5 @@
+if ENV['BLACKLIGHT_VERSION'] == 'github'
+  gem 'blacklight', github: 'projectblacklight/blacklight'
+elsif ENV['BLACKLIGHT_VERSION'] && !ENV['BLACKLIGHT_VERSION'].empty?
+  gem 'blacklight', ENV['BLACKLIGHT_VERSION']
+end

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

@@ -1,13 +1,18 @@
 require 'spec_helper'
 
-describe "catalog/_document_slideshow", :type => :view do
+RSpec.describe "catalog/_document_slideshow", :type => :view do
   let(:blacklight_config) do
     Blacklight::Configuration.new do |config|
-      config.track_search_session = false
+      if Blacklight::VERSION > '8'
+        config.track_search_session.storage = false
+      else
+        config.track_search_session = false
+      end
     end
   end
 
   let(:document) { stub_model(::SolrDocument) }
+  let(:view_config) { Blacklight::Configuration::ViewConfig.new(document_component: Blacklight::Gallery::SlideshowComponent) }
 
   before do
     allow(view).to receive_messages(
@@ -19,10 +24,11 @@ describe "catalog/_document_slideshow", :type => :view do
     allow(view).to receive(:current_search_session).and_return(nil)
     allow(view).to receive(:search_session).and_return({})
     allow(view).to receive(:search_state).and_return(Blacklight::SearchState.new({}, blacklight_config))
+    @response = instance_double(Blacklight::Solr::Response, start: 0)
   end
 
   it 'has a modal' do
-    render
+    render 'catalog/document_slideshow', view_config: view_config
     expect(rendered).to have_selector '#slideshow-modal'
     expect(rendered).to have_selector '[data-slide="prev"]'
     expect(rendered).to have_selector '[data-slide="next"]'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-gallery
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.2.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2023-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -34,16 +34,22 @@ dependencies:
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -78,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -184,20 +190,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rexml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -248,6 +240,17 @@ files:
 - app/assets/stylesheets/blacklight_gallery/default.scss
 - app/components/blacklight/gallery/document_component.html.erb
 - app/components/blacklight/gallery/document_component.rb
+- app/components/blacklight/gallery/icons/add_circle_component.rb
+- app/components/blacklight/gallery/icons/chevron_left_component.rb
+- app/components/blacklight/gallery/icons/chevron_right_component.rb
+- app/components/blacklight/gallery/icons/custom_fullscreen_component.rb
+- app/components/blacklight/gallery/icons/gallery_component.rb
+- app/components/blacklight/gallery/icons/masonry_component.rb
+- app/components/blacklight/gallery/icons/pause_slideshow_component.rb
+- app/components/blacklight/gallery/icons/remove_circle_component.rb
+- 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/slideshow_component.html.erb
 - app/components/blacklight/gallery/slideshow_component.rb
 - app/components/blacklight/gallery/slideshow_preview_component.html.erb
@@ -276,6 +279,7 @@ files:
 - lib/generators/blacklight_gallery/install_generator.rb
 - lib/generators/blacklight_gallery/templates/blacklight_gallery.css.scss
 - lib/generators/blacklight_gallery/templates/blacklight_gallery.js
+- package.json
 - solr/conf/_rest_managed.json
 - solr/conf/admin-extra.html
 - solr/conf/elevate.xml
@@ -326,7 +330,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Gallery display for Blacklight