blacklight-gallery 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67559224cded645a3d4cdcbacf6d2ee5caa94d6168ebf320e15c317eac00cac6
-  data.tar.gz: 34f56fb978b1db760dc813fc85e5b99cae783b872924824bddeffeccdc09827a
+  metadata.gz: 0fe613439f90948ab6f8348ebd898a8dbcd50a39b09f537f26208b998ac7ca28
+  data.tar.gz: b87f85234155f5757efd197c22ba7ee8ab1663d9e9f6b19a1a38a03e59a76206
 SHA512:
-  metadata.gz: c62a4b9c3cfeba14ee254cb07d6359adbc1b012c13ea8c061760ddf083b27da2c4867dba951100c2af0362e56441635c2099014695bd69a3c525cee22ead8e92
-  data.tar.gz: acf86862e45f1c2537d4047b7d8cc31cc849cb8cedd9678de5aea58a6dd35e018b9641b487a4995be160d8115ae46270f9eb58754e2b977b358e9efce61b3d55
+  metadata.gz: 213771e22b7aad6533c89ec7e360d1e20134d90560d89826c2db0b326f88d8c3e8dcf1b71c94fb17ea5c6fe1212d922337f001fa97a1fa8cd60a7f7457ca1214
+  data.tar.gz: c0991767ff1d83f0c08b61f36b6473796666e39748270b3bb42be6632ec97bc788f91e5b0bcc993560630b3e876c621387f81a7f9966f3c88065f6ff4658751c

data/.github/workflows/ruby.yml

@@ -2,26 +2,36 @@ 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 }}
     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]
         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
     env:
       RAILS_VERSION: ${{ matrix.rails_version }}
+      BLACKLIGHT_VERSION: ${{ matrix.blacklight_version }}
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby ${{ matrix.ruby }}

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/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,23 +1,24 @@
 <% 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' }} %>
+        <%= blacklight_icon 'chevron_left', 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' }} %>
+        <%= blacklight_icon 'chevron_right', additional_options: { label_context: 'next_image' } %>
       </a>
 
       <div class="controls text-center">

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.1"
+    VERSION = "4.1.0"
   end
 end

data/lib/generators/blacklight_gallery/install_generator.rb

@@ -5,15 +5,6 @@ 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)" \
@@ -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/solr/conf/solrconfig.xml

@@ -18,6 +18,7 @@
 
   <!-- solr lib dirs -->
   <lib dir="${solr.install.dir:../../../..}/contrib/analysis-extras/lib" />
+  <lib dir="${solr.install.dir:../../../..}/modules/analysis-extras/lib" />
   <lib dir="${solr.install.dir:../../../..}/contrib/analysis-extras/lucene-libs" />
 
   <dataDir>${solr.data.dir:}</dataDir>

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.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2023-02-23 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
@@ -326,7 +318,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Gallery display for Blacklight