blacklight-oembed 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5305c4c047c7deeee34c98b2d3197e69d584a6ca7308cb0d80ebebf81d666b9d
-  data.tar.gz: 695d6b4f7dce7c1b516f54653332f9c8b5bbe295c6151eff90be47da2f368fdf
+  metadata.gz: ca622e6493231613d2e1e8709cd59bdd5b092102e8add584aa8729cc62dafd92
+  data.tar.gz: 71350e1b92d7bda34dbd15a9da041c6320d1fe722920e29d72517f3e58774fc5
 SHA512:
-  metadata.gz: 044130e650ac8243abe3f5390d1bdd7b93f94130ecc0a17b1504a071738c8ffbaf6f9cb9979c6e8ec114da60b38d5a657c819c9e536f0af5acb8538e1a09f6b4
-  data.tar.gz: de08d089681ea0fdec9f7446ba702f8f63b32c9e6758fa9f1446cbdb660ffc029abf17fd053e1f4e535036f90776655270e1b8cb00622051f92c18373e4d40c4
+  metadata.gz: e275f3324443f7120656aba199c6da9ee87d175ac00248122a3b75938a1152a22cdc371c30e31fc38f1ab548c376d17b795d5dc62c2ee73065937a23fe460d4a
+  data.tar.gz: 6b5d7d3b20aaa33894e1e30830032e25565e78004af528e09f6ee7ba60f0652a255e7d60125840f79354563a79b13d865755ce8980a96f7beedad136669c2c9d

data/.github/workflows/ruby.yml

@@ -9,20 +9,28 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    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']
+        ruby: ['3.3']
+        rails_version: ['7.1.4', '7.2.1']
         blacklight_version: ['~> 7.0']
+        additional_name: ['']
+        legacy_config: ['']
         include:
-        - ruby: '3.1'
-          rails_version: '7.0.4'
-        - ruby: '3.1'
-          rails_version: '7.0.4'
-          blacklight_version: 'github'
+        - ruby: '3.3'
+          rails_version: '7.2.1'
+          blacklight_version: '~> 8.0'
+          additional_name: ''
+        - ruby: '3.3'
+          rails_version: '7.2.1'
+          blacklight_version: '~> 8.0'
+          additional_name: 'with legacy partial config'
+          legacy_config: 'true'
     env:
       RAILS_VERSION: ${{ matrix.rails_version }}
       BLACKLIGHT_VERSION: ${{ matrix.blacklight_version }}
+      CI_TEST_LEGACY_CONFIGURATION: ${{ matrix.legacy_config }}
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby ${{ matrix.ruby }}

data/.solr_wrapper.yml

@@ -0,0 +1,6 @@
+# Place any default configuration for solr_wrapper here
+# port: 8983
+version: 9.6.1
+collection:
+  dir: .internal_test_app/solr/conf
+  name: blacklight-core

data/app/assets/javascripts/blacklight_oembed/oembed.js

@@ -0,0 +1,31 @@
+export default function oEmbed(elements) {
+  if (!elements) return;
+
+  // Ensure elements is an array-like collection
+  elements = elements instanceof NodeList ? Array.from(elements) : [elements];
+
+  elements.forEach(function(embedViewer) {
+    const embedURL = embedViewer.dataset.embedUrl; // Get the embed URL from the data attribute
+
+    if (!embedURL) return;
+
+    // Fetch JSON data from the embed URL
+    fetch(embedURL)
+      .then(response => {
+        if (!response.ok) {
+          throw new Error('Network response was not ok');
+        }
+        return response.json();
+      })
+      .then(data => {
+        if (data === null) {
+          return;
+        }
+        // Set the inner HTML of the element
+        embedViewer.innerHTML = data.html;
+      })
+      .catch(error => {
+        console.error('Error fetching embed data:', error);
+      });
+  });
+}

data/app/components/blacklight/oembed/document_oembed_component.html.erb

@@ -0,0 +1,3 @@
+<%= tag.div class: class_names(classes) do %>
+  <%= embed %>
+<% end %>

data/app/components/blacklight/oembed/document_oembed_component.rb

@@ -0,0 +1,60 @@
+module Blacklight
+  module Oembed
+    class DocumentOembedComponent < Blacklight::Component
+      attr_reader :document, :presenter, :classes
+
+      def initialize(document:, presenter:, classes: ['oembed-widget'], **kwargs)
+        super
+
+        @document = document
+        @presenter = presenter
+        @classes = classes
+      end
+
+      def embed
+        return if embed_url.blank?
+
+        @embed ||= if Blacklight::Oembed::Engine.config.render_helper != :render_oembed_tag_async && Blacklight::Oembed::Engine.config.render_helper != :render_oembed_tag_embed
+                     legacy_helper_method_embed_markup
+                   elsif view_config.render_oembed_using_async_javascript || Blacklight::Oembed::Engine.config.render_helper == :render_oembed_tag_async
+                     async_embed_markup
+                   else
+                     inline_embed_markup
+                   end
+      end
+
+      def render?
+        embed.present?
+      end
+
+      private
+
+      def view_config
+        presenter.view_config
+      end
+
+      def embed_url
+        document.first(view_config.oembed_field)
+      end
+
+      def async_embed_url(**kwargs)
+        helpers.blacklight_oembed_engine.embed_url(**kwargs)
+      end
+
+      def async_embed_markup
+        content_tag :div, '', data: { async_embed_url: async_embed_url(url: embed_url) }
+      end
+
+      def inline_embed_markup
+        OEmbed::Providers.get(embed_url).html.html_safe
+      rescue OEmbed::NotFound
+        link_to t(:'blacklight_oembed.catalog.view'), embed_url
+      end
+
+      def legacy_helper_method_embed_markup
+        Blacklight::Oembed.deprecator.warn('Subclass Blacklight::Oembed::DocumentOembedComponent instead of using the blacklight-oembed render_helper config')
+        helpers.call(Blacklight::Oembed::Engine.config.render_helper, url)
+      end
+    end
+  end
+end

data/app/controllers/blacklight/oembed/embed_controller.rb

@@ -7,7 +7,7 @@ module Blacklight::Oembed
 
     private
 
-    ruby2_keywords def get_embed_content(url, add_params = {})
+    def get_embed_content(url, add_params = {})
       begin
         OEmbed::Providers.get(url, add_params.transform_values { |v| CGI.escape(v) }).html.html_safe
       rescue OEmbed::NotFound

data/app/helpers/blacklight/oembed/oembed_helper.rb

@@ -1,28 +1,31 @@
 module Blacklight::Oembed
   module OembedHelper
-
-    def render_oembed_solr_document_tag document
+    # @deprecated
+    def render_oembed_solr_document_tag(document)
       url = document.first(blacklight_config.show.oembed_field)
       return if url.blank?
 
       render_oembed_tag url
     end
 
-    def render_oembed_tag url
+    # @deprecated
+    def render_oembed_tag(url)
       send Blacklight::Oembed::Engine.config.render_helper, url
     end
+    Blacklight::Oembed.deprecator.deprecate_methods Blacklight::Oembed::OembedHelper,
+                                                    :render_oembed_solr_document_tag, :render_oembed_tag,
+                                                    'Use Blacklight::Oembed::DocumentOembedComponent instead'
 
     private
-    def render_oembed_tag_embed url
-      begin
-        OEmbed::Providers.get(url).html.html_safe
-      rescue OEmbed::NotFound
-        link_to t(:'blacklight_oembed.catalog.view'), url
-      end
+
+    def render_oembed_tag_embed(url)
+      OEmbed::Providers.get(url).html.html_safe
+    rescue OEmbed::NotFound
+      link_to t(:'blacklight_oembed.catalog.view'), url
     end
 
-    def render_oembed_tag_async url
-      content_tag :div, "", data: { embed_url: blacklight_oembed_engine.embed_url(url: url) }
+    def render_oembed_tag_async(url)
+      content_tag :div, '', data: { embed_url: blacklight_oembed_engine.embed_url(url: url) }
     end
   end
-end
+end

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

@@ -1,5 +1 @@
-<% if rendered = render_oembed_solr_document_tag(document) %>
-<div class="oembed-widget">
-  <%= rendered %>
-</div>
-<% end %>
+<%= render Blacklight::Oembed::DocumentOembedComponent.new(document: document, presenter: document_presenter(document)) %>

data/blacklight-oembed.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails"
-  spec.add_dependency 'blacklight', '>= 7.0', '< 9'
+  spec.add_dependency 'blacklight', '>= 7.25', '< 9'
   spec.add_dependency "ruby-oembed"
 
   spec.add_development_dependency "bundler", ">= 1.5"

data/lib/blacklight/oembed/engine.rb

@@ -3,13 +3,13 @@ require 'blacklight'
 module Blacklight
   module Oembed
     class Engine < Rails::Engine
+      # @deprecated
+      config.render_helper = :render_oembed_tag_async
 
-      Blacklight::Oembed::Engine.config.render_helper = :render_oembed_tag_async
       ##
       # Allows an adopter to pass additional parameters through to an OEmbed
       # service. Examples of this could include `:canvas_index`, or `:max_width`
-      Blacklight::Oembed::Engine.config.additional_params = []
-
+      config.additional_params = []
     end
   end
 end

data/lib/blacklight/oembed/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Oembed
-    VERSION = '1.1.1'
+    VERSION = '1.3.0'
   end
 end

data/lib/blacklight/oembed.rb

@@ -1,7 +1,11 @@
-require "blacklight/oembed/version"
+require 'blacklight/oembed/version'
 require 'oembed'
 module Blacklight
   module Oembed
+    def self.deprecator
+      @deprecator ||= ActiveSupport::Deprecation.new('2.0.0', 'blacklight-oembed')
+    end
+
     require 'blacklight/oembed/engine'
   end
 end

data/lib/generators/blacklight_oembed/install_generator.rb

@@ -19,12 +19,21 @@ module BlacklightOembed
     end
 
     def configuration
-      inject_into_file 'app/controllers/catalog_controller.rb', after: "configure_blacklight do |config|" do
-        <<-EOF
+      inject_into_file 'app/controllers/catalog_controller.rb', after: 'configure_blacklight do |config|' do
+        if ENV['CI_TEST_LEGACY_CONFIGURATION'].present? || Gem::Version.new(Blacklight::VERSION) < Gem::Version.new('8.0')
+          <<-EOF
+
+            config.show.oembed_field = :oembed_url_ssm
+            config.show.partials.insert(1, :oembed)
+          EOF
+        else
+          <<-EOF
 
           config.show.oembed_field = :oembed_url_ssm
-          config.show.partials.insert(1, :oembed)
-        EOF
+          config.show.render_oembed_using_async_javascript = true
+          config.show.embed_component = Blacklight::Oembed::DocumentOembedComponent
+          EOF
+        end
       end
     end
   end

data/lib/generators/blacklight_oembed/templates/blacklight_oembed.js

@@ -1,5 +1,5 @@
-//= require 'blacklight_oembed/jquery.oembed.js'
+import oembed from 'blacklight_oembed/oembed'
 
 Blacklight.onLoad(function() {
-  $('[data-embed-url]').oEmbed();
-});
+  oembed(document.querySelectorAll('[data-embed-url]'));
+});

data/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "blacklight-oembed",
+  "version": "1.3.0",
+  "description": "Oembed behavior for Blacklight",
+  "main": "app/assets/javascripts/blacklight_oembed/oembed.js",
+  "files": [
+    "app/assets/javascripts/blacklight_oembed/*.js"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/projectblacklight/blacklight-oembed.git"
+  },
+  "author": "Chris Beer, Justin Coyne, et al.",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/projectblacklight/blacklight-oembed/issues"
+  },
+  "homepage": "https://github.com/projectblacklight/blacklight-oembed#readme",
+  "dependencies": {}
+}

data/spec/controllers/embed_controller_spec.rb

@@ -7,8 +7,7 @@ describe Blacklight::Oembed::EmbedController do
     render_views
 
     before do
-      Blacklight::Oembed::Engine.config.render_helper = :render_oembed_tag_embed
-      Blacklight::Oembed::Engine.config.additional_params = [:canvas_index, :suggested_search]
+      Blacklight::Oembed::Engine.config.additional_params = %i[canvas_index suggested_search]
     end
 
     let :oembed_obj do

data/spec/features/embed_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe 'Embed', type: :feature do
+  before do
+    CatalogController.blacklight_config.show.oembed_field = :id
+  end
+
+  it 'embeds the widget on the show page' do
+    visit '/catalog/2007020969'
+
+    expect(page).to have_css '.oembed-widget'
+
+    embed_div = find('.oembed-widget div')
+
+    expect(embed_div['data-async-embed-url']).to include '/oembed/embed?url=2007020969'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-oembed
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-16 00:00:00.000000000 Z
+date: 2025-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,7 +30,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.25'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
@@ -40,7 +40,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.25'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
@@ -207,11 +207,15 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".solr_wrapper.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - app/assets/javascripts/blacklight_oembed/jquery.oembed.js
+- app/assets/javascripts/blacklight_oembed/oembed.js
+- app/components/blacklight/oembed/document_oembed_component.html.erb
+- app/components/blacklight/oembed/document_oembed_component.rb
 - app/controllers/blacklight/oembed/embed_controller.rb
 - app/helpers/blacklight/oembed/oembed_helper.rb
 - app/views/catalog/_oembed_default.html.erb
@@ -227,6 +231,7 @@ files:
 - lib/generators/blacklight_oembed/templates/blacklight_oembed.css.scss
 - lib/generators/blacklight_oembed/templates/blacklight_oembed.js
 - lib/generators/blacklight_oembed/templates/oembed_providers.rb
+- package.json
 - solr/conf/_rest_managed.json
 - solr/conf/admin-extra.html
 - solr/conf/elevate.xml
@@ -245,6 +250,7 @@ files:
 - solr/conf/xslt/luke.xsl
 - solr/sample_solr_documents.yml
 - spec/controllers/embed_controller_spec.rb
+- spec/features/embed_spec.rb
 - spec/helpers/oembed_helper_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/Gemfile.extra
@@ -268,12 +274,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Oembed display for Blacklight
 test_files:
 - spec/controllers/embed_controller_spec.rb
+- spec/features/embed_spec.rb
 - spec/helpers/oembed_helper_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/Gemfile.extra