blacklight-gallery 2.0.0 → 3.0.1

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

@@ -1,4 +1,5 @@
-<% # container for all documents in index view -%>
-<div id="documents" class="row gallery">
-  <%= render_gallery_collection documents %>
+<div class="container">
+  <div id="documents" class="<%= (Array(blacklight_config.view_config(document_index_view_type).classes || 'row-cols-2 row-cols-md-3') + ["row documents-#{document_index_view_type}"]).join(' ') %>">
+    <%= render documents, as: :document %>
+  </div>
 </div>

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

@@ -1,4 +1,3 @@
-<% # container for all documents in index view -%>
-<div id="documents" class="row" data-behavior="masonry-gallery">
-  <%= render collection: documents, as: :document, partial: 'index_masonry', locals: {count: documents.count} %>
+<div id="documents" class="<%= (Array(blacklight_config.view_config(document_index_view_type).classes) + ["documents-#{document_index_view_type}"]).join(' ') %>">
+  <%= render documents, as: :document %>
 </div>

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

@@ -1,10 +1,31 @@
-<% # container for all documents in slideshow view -%>
-<div id="documents" class="row slideshow-documents">
+<div id="documents" class="<%= (Array(blacklight_config.view_config(document_index_view_type).classes) + ["documents-#{document_index_view_type}"]).join(' ') %>">
   <div class="grid">
-    <%= render collection: documents, as: :document, partial: 'grid_slideshow' %>
+    <%= render((blacklight_config.view_config(document_index_view_type).preview_component || Blacklight::Gallery::SlideshowPreviewComponent).with_collection(documents)) %>
   </div>
 
-  <%= render layout: 'slideshow_modal', locals: {documents: documents} do %>
-    <%= render partial: 'slideshow', locals: {documents: documents} %>
+  <%= render layout: 'slideshow_modal' do %>
+    <div id="slideshow" class="slideshow-presenter">
+      <!-- Wrapper for slides -->
+      <div class="slideshow-inner">
+        <%= render documents, as: :document %>
+      </div>
+
+      <!-- Controls -->
+      <a class="left carousel-control prev" href="#slideshow" data-slide="prev">
+        <%= 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' }} %>
+      </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' %>
+        </button>
+        <button class="btn btn-sm btn-link" data-behavior="start-slideshow" aria-label="<%= t('blacklight_gallery.catalog.slideshow.start') %>">
+          <%= blacklight_icon 'start_slideshow' %>
+        </button>
+      </div>
+    </div>
   <% end %>
 </div>

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

@@ -3,9 +3,8 @@
     <div class="modal-dialog modal-xl">
       <div class="modal-content">
         <div class="modal-header">
-          <button type="button" class="close" data-dismiss="modal" aria-hidden="true">
-            <span class="sr-only">close</span>
-            <span aria-hidden="true">×</span>
+          <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
+            <span aria-hidden="true">&times;</span>
           </button>
         </div>
         <div class="modal-body">

data/blacklight-gallery.gemspec

@@ -17,10 +17,9 @@ 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'
-  spec.add_dependency 'blacklight', '~> 7.7'
+  spec.add_dependency "rails", '>= 5.1', '< 7'
+  spec.add_dependency 'blacklight', '~> 7.12'
   spec.add_dependency "bootstrap", "~> 4.0"
-  spec.add_dependency "openseadragon", ">= 0.2.0"
 
   spec.add_development_dependency "rake"
   spec.add_development_dependency 'sqlite3'
@@ -31,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "solr_wrapper"
   spec.add_development_dependency "engine_cart", "~> 2.0"
   spec.add_development_dependency "capybara"
-  spec.add_development_dependency 'chromedriver-helper'
+  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/config/locales/blacklight-gallery.ar.yml

@@ -1,16 +1,19 @@
 ar:
   blacklight:
+    icon:
+      chevron_left_previous_image: 'الصورة السابقة' 
+      chevron_right_next_image: 'الصورة التالية' 
     search:
       view:
         gallery: "معرض الصور"
-        slideshow: "عرض متتابع"
+        slideshow: "عرض الصور"
         masonry: "عرض الصور كمجموعة"
   blacklight_gallery:
     catalog:
       grid_slideshow:
-        missing_image: "صورة غير موجودة"
+        missing_image: 'غير موجود'
       modal_slideshow:
         counter: "%{counter} من %{count}"
       slideshow:
-        pause: "وقفة عرض الشرائح"
-        start: "بدء عرض الشرائح"
+        pause: وقف عرض الصور
+        start: بدء عرض الصور

data/lib/blacklight/gallery/engine.rb

@@ -3,7 +3,6 @@ require 'blacklight'
 module Blacklight
   module Gallery
     class Engine < Rails::Engine
-      require 'openseadragon'
     end
   end
 end

data/lib/blacklight/gallery/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Gallery
-    VERSION = "2.0.0"
+    VERSION = "3.0.1"
   end
 end

data/lib/generators/blacklight_gallery/install_generator.rb

@@ -8,13 +8,18 @@ module BlacklightGallery
     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.partials = [:index_header, :index]" \
-        "\n    config.view.masonry.partials = [:index]" \
-        "\n    config.view.slideshow.partials = [:index]\n\n" \
+        "\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.show.tile_source_field = :content_metadata_image_iiif_info_ssm" \
         "\n    config.show.partials.insert(1, :openseadragon)"
       end
@@ -27,6 +32,8 @@ module BlacklightGallery
     end
 
     def add_openseadragon
+      gem "openseadragon", ">= 0.2.0"
+      Bundler.with_clean_env { run 'bundle install' }
       generate 'openseadragon:install'
     end
   end

data/lib/generators/blacklight_gallery/templates/blacklight_gallery.js

@@ -1 +1,2 @@
-//= require blacklight_gallery/default
+//= require blacklight_gallery/default
+//= require blacklight_gallery/osd_viewer

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::Gallery::DocumentComponent, type: :component do
+  subject(:component) { described_class.new(document: document, **attr) }
+
+  let(:attr) { {} }
+  let(:view_context) { 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',
+      thumbnail_path_ss: 'http://example.com/image.jpg',
+      title_tsim: 'This is my document title'
+    )
+  end
+
+  let(:blacklight_config) do
+    CatalogController.blacklight_config.deep_copy.tap do |config|
+      config.track_search_session = false
+      config.index.thumbnail_field = 'thumbnail_path_ss'
+    end
+  end
+
+  before do
+    allow(controller).to receive(:blacklight_config).and_return(blacklight_config)
+    allow(view_context).to receive(:current_search_session).and_return(nil)
+    allow(view_context).to receive(:search_session).and_return({})
+
+    # dumb hack to get our stubbing into the thumbnail component
+    allow(controller).to receive(:view_context).and_return(view_context)
+  end
+
+  it 'has a thumbnail and caption' do
+    expect(rendered).to have_selector '.document-thumbnail img'
+    expect(rendered).to have_selector '.caption', text: 'This is my document title'
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::Gallery::SlideshowComponent, type: :component do
+  subject(:component) { described_class.new(document: document, **attr) }
+
+  let(:attr) { {} }
+  let(:view_context) { controller.view_context }
+  let(:render) do
+    component.render_in(view_context)
+  end
+
+  let(:rendered) do
+    Capybara::Node::Simple.new(render)
+  end
+
+  let(:blacklight_config) { Blacklight::Configuration.new }
+
+  before do
+    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 } }
+
+      it 'calls the provided slideshow method' do
+        expect(view_context).to receive_messages(xyz: 'some-slideshow')
+        expect(rendered).to have_text 'some-slideshow'
+      end
+
+      it 'does not render an image if the method returns nothing' do
+        expect(view_context).to receive_messages(xyz: nil)
+        expect(rendered).not_to have_selector 'img'
+      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' }) }
+
+      it { is_expected.to have_selector 'img[src="http://example.com/some.jpg"]' }
+
+      context 'without data in the field' do
+        let(:document) { SolrDocument.new({}) }
+
+        it { is_expected.not_to have_selector 'img' }
+      end
+    end
+
+    context 'with nothing configured' do
+      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' }) }
+
+      it { is_expected.to have_selector 'img[src="http://example.com/thumb.jpg"]' }
+    end
+  end
+end

data/spec/features/gallery_spec.rb

@@ -4,8 +4,7 @@ describe "Gallery view", :type => :feature do
   before { visit search_catalog_path :q => 'medicine', :view => 'gallery' }
 
   it "should display results in a galley view" do
-    expect(page).to have_selector("#documents.gallery")
-    expect(page).to have_selector(".gallery .document .thumbnail .caption")
-    expect(page).to have_content("Strong Medicine speaks")
+    expect(page).to have_selector("#documents.documents-gallery")
+    expect(page).to have_selector(".caption", text: "Strong Medicine speaks")
   end
-end
+end

data/spec/features/masonry_spec.rb

@@ -4,8 +4,7 @@ describe "Masonry view", :type => :feature do
   before { visit search_catalog_path :q => 'medicine', :view => 'masonry' }
 
   it "should display results in a galley view" do
-    expect(page).to have_selector("#documents[data-behavior='masonry-gallery']")
-    expect(page).to have_selector(".masonry.document .thumbnail")
-    expect(page).to have_selector('.masonry.document .caption', text: "Strong Medicine speaks", visible: false)
+    expect(page).to have_selector("#documents.documents-masonry")
+    expect(page).to have_selector('.document .caption', text: "Strong Medicine speaks", visible: false)
   end
 end

data/spec/features/slideshow_spec.rb

@@ -3,7 +3,6 @@ require 'spec_helper'
 describe "Slideshow", :js, :type => :feature do
 
   it "should open when one of the grid panes are clicked" do
-    pending 'flappy test'
     visit search_catalog_path( :q => 'medicine', :view => 'slideshow' )
     expect(page).to have_content "You searched for:"
     within ".view-type" do
@@ -11,7 +10,6 @@ describe "Slideshow", :js, :type => :feature do
     end
 
     find('.grid [data-slide-to="0"]').click
-    expect(page).to have_selector '#slideshow', visible: true
   end
 
 end

data/spec/models/concerns/openseadragon_solr_document_spec.rb

@@ -13,7 +13,7 @@ describe Blacklight::Gallery::OpenseadragonSolrDocument do
 
   context 'when not configured for the view' do
     let(:fields) { { some_field: 'data' } }
-    let(:view_config) { double('ViewConfig') }
+    let(:view_config) { double('ViewConfig', tile_source_field: nil) }
     it 'returns nil' do
       expect(subject).to be_nil
     end

data/spec/spec_helper.rb

@@ -9,19 +9,11 @@ require 'rspec/rails'
 require 'rspec/active_model/mocks'
 
 require 'selenium-webdriver'
-require 'chromedriver-helper'
+require 'webdrivers'
 
-Capybara.javascript_driver = :headless_chrome
 
-Capybara.register_driver :headless_chrome do |app|
-  capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
-    chromeOptions: { args: %w[headless disable-gpu no-sandbox] }
-  )
-
-  Capybara::Selenium::Driver.new(app,
-                                 browser: :chrome,
-                                 desired_capabilities: capabilities)
-end
+Capybara.javascript_driver = :selenium_chrome_headless
+Capybara.disable_animation = true
 
 require 'blacklight'
 require 'blacklight/gallery'
@@ -29,5 +21,6 @@ require 'blacklight/gallery'
 RSpec.configure do |c|
   c.infer_spec_type_from_file_location!
   c.full_backtrace = true
+  c.include ViewComponent::TestHelpers, type: :component
   #onfig.assets.precompile += %w(spotlight/default_thumbnail.jpg spotlight/default_browse_thumbnail.jpg)
 end

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

@@ -1,17 +1,27 @@
 require 'spec_helper'
 
 describe "catalog/_document_slideshow.html.erb", :type => :view do
-  let(:blacklight_config) { Blacklight::Configuration.new }
+  let(:blacklight_config) do
+    Blacklight::Configuration.new do |config|
+      config.track_search_session = false
+    end
+  end
 
   let(:document) { stub_model(::SolrDocument) }
 
   before do
-    allow(view).to receive_messages(blacklight_config: blacklight_config)
-    allow(view).to receive_messages(documents: [document])
-    allow(view).to receive(:blacklight_configuration_context).and_return(double(evaluate_if_unless_configuration: true))
+    allow(view).to receive_messages(
+      blacklight_config: blacklight_config,
+      documents: [document],
+      document_index_view_type: 'slideshow',
+      document_counter_with_offset: 1
+    )
+    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))
   end
 
-  it "should have a edit tag form" do
+  it 'has a modal' do
     render
     expect(rendered).to have_selector '#slideshow-modal'
     expect(rendered).to have_selector '[data-slide="prev"]'

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-gallery
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Chris Beer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2021-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.7'
+        version: '7.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.7'
+        version: '7.12'
 - !ruby/object:Gem::Dependency
   name: bootstrap
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +58,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: openseadragon
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -193,7 +185,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: chromedriver-helper
+  name: webdrivers
+  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: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -220,16 +226,16 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.13.1
-description: 
+description:
 email:
 - cabeer@stanford.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".solr_wrapper.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -254,19 +260,19 @@ files:
 - app/assets/stylesheets/blacklight_gallery/_osd_viewer.scss
 - app/assets/stylesheets/blacklight_gallery/_slideshow.scss
 - 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/slideshow_component.html.erb
+- app/components/blacklight/gallery/slideshow_component.rb
+- app/components/blacklight/gallery/slideshow_preview_component.html.erb
+- app/components/blacklight/gallery/slideshow_preview_component.rb
 - app/helpers/blacklight/gallery_helper.rb
 - app/helpers/blacklight/openseadragon_helper.rb
 - app/models/concerns/blacklight/gallery/openseadragon_solr_document.rb
 - app/views/catalog/_document_gallery.html.erb
 - app/views/catalog/_document_masonry.html.erb
 - app/views/catalog/_document_slideshow.html.erb
-- app/views/catalog/_grid_slideshow.html.erb
-- app/views/catalog/_index_gallery.html.erb
-- app/views/catalog/_index_masonry.html.erb
-- app/views/catalog/_index_masonry_default.html.erb
-- app/views/catalog/_index_slideshow.html.erb
 - app/views/catalog/_openseadragon_default.html.erb
-- app/views/catalog/_slideshow.html.erb
 - app/views/catalog/_slideshow_modal.html.erb
 - blacklight-gallery.gemspec
 - config/locales/blacklight-gallery.ar.yml
@@ -299,17 +305,16 @@ files:
 - solr/conf/xslt/example_atom.xsl
 - solr/conf/xslt/example_rss.xsl
 - solr/conf/xslt/luke.xsl
+- spec/components/blacklight/gallery/document_component_spec.rb
+- spec/components/blacklight/gallery/slideshow_component_spec.rb
 - spec/features/gallery_spec.rb
 - spec/features/masonry_spec.rb
 - spec/features/slideshow_spec.rb
-- spec/helpers/blacklight/gallery_helper_spec.rb
 - spec/models/concerns/openseadragon_solr_document_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb
 - spec/views/catalog/_document_slideshow.html.erb_spec.rb
-- spec/views/catalog/_index_gallery.html.erb_spec.rb
-- spec/views/catalog/_index_masonry.html.erb_spec.rb
 - spec/views/catalog/_openseadragon_default.html.erb_spec.rb
 - vendor/assets/javascripts/imagesloaded.min.js
 - vendor/assets/javascripts/masonry.min.js
@@ -317,7 +322,7 @@ homepage: https://github.com/projectblacklight/blacklight-gallery
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -332,20 +337,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Gallery display for Blacklight
 test_files:
+- spec/components/blacklight/gallery/document_component_spec.rb
+- spec/components/blacklight/gallery/slideshow_component_spec.rb
 - spec/features/gallery_spec.rb
 - spec/features/masonry_spec.rb
 - spec/features/slideshow_spec.rb
-- spec/helpers/blacklight/gallery_helper_spec.rb
 - spec/models/concerns/openseadragon_solr_document_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb
 - spec/views/catalog/_document_slideshow.html.erb_spec.rb
-- spec/views/catalog/_index_gallery.html.erb_spec.rb
-- spec/views/catalog/_index_masonry.html.erb_spec.rb
 - spec/views/catalog/_openseadragon_default.html.erb_spec.rb