blacklight-gallery 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fe613439f90948ab6f8348ebd898a8dbcd50a39b09f537f26208b998ac7ca28
-  data.tar.gz: b87f85234155f5757efd197c22ba7ee8ab1663d9e9f6b19a1a38a03e59a76206
+  metadata.gz: d46a1601796a187729339ce0655d2537db43a7319608a2de67cd763b38fcbdcd
+  data.tar.gz: b9f28ea874c0908cfc9e19f7134b7dfc29779ed5c7865af8f96f1becab54a478
 SHA512:
-  metadata.gz: 213771e22b7aad6533c89ec7e360d1e20134d90560d89826c2db0b326f88d8c3e8dcf1b71c94fb17ea5c6fe1212d922337f001fa97a1fa8cd60a7f7457ca1214
-  data.tar.gz: c0991767ff1d83f0c08b61f36b6473796666e39748270b3bb42be6632ec97bc788f91e5b0bcc993560630b3e876c621387f81a7f9966f3c88065f6ff4658751c
+  metadata.gz: 38912a52ab2cc3a35ec137d5e326e4e92f90228dd8254f9fa7526dc5f565945c08aefe3fcda4d028191dea8a7615b3073865e3c513a1701824deef9a3d4b092f
+  data.tar.gz: 76f328cf6da35f629a2ce99396ec89be2b5d97331f38daee12574201b9a21392f09b366ff38e099b4510bf380a3ed40a9a74509e7be384455d99fb865a73c7b6

data/.github/workflows/ruby.yml

@@ -10,12 +10,15 @@ 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:
         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:
         - ruby: '3.1'
           rails_version: '7.0.4'
@@ -29,9 +32,16 @@ jobs:
           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/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/views/catalog/_document_slideshow.html.erb

@@ -15,18 +15,18 @@
 
       <!-- 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/lib/blacklight/gallery/version.rb

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

data/lib/generators/blacklight_gallery/install_generator.rb

@@ -7,9 +7,9 @@ module BlacklightGallery
 
     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

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"
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-gallery
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-23 00:00:00.000000000 Z
+date: 2023-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -240,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
@@ -268,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