ckeditor5 1.19.5 → 1.20.0

data/spec/e2e/spec_helper.rb

@@ -3,6 +3,7 @@
 require 'capybara'
 require 'capybara/rspec'
 require 'capybara/cuprite'
+require 'rspec/retry'
 
 ENV['RAILS_ENV'] ||= 'test'
 
@@ -40,16 +41,10 @@ Capybara.server = :webrick
 Capybara.default_driver = :cuprite
 Capybara.javascript_driver = :cuprite
 
-require 'rspec/retry'
-
 RSpec.configure do |config|
-  config.verbose_retry = true
-
   config.around :each, :js do |example|
-    example.run_with_retry retry: 3, retry_wait: 5
+    example.run_with_retry retry: 4, retry_wait: 5, default_sleep_interval: 2
   end
-
-  config.profile_examples = 10
 end
 
 Dir[File.expand_path('support/**/*.rb', __dir__)].each { |f| require f }

data/spec/lib/ckeditor5/rails/assets/{asset_bundle_hml_serializer_spec.rb → assets_bundle_hml_serializer_spec.rb}

@@ -42,6 +42,13 @@ RSpec.describe CKEditor5::Rails::Assets::AssetsBundleHtmlSerializer do
                                })
     end
 
+    it 'should not include importmap if not requested' do
+      serializer = described_class.new(bundle, importmap: false)
+      html = serializer.to_html
+
+      expect(html).not_to have_tag('script', with: { type: 'importmap' })
+    end
+
     it 'includes import map' do
       expect(html).to have_tag('script', with: { type: 'importmap' }) do
         with_text(%r{"@ckeditor/script2":"https://cdn\.com/script2\.js"})
@@ -131,13 +138,6 @@ RSpec.describe CKEditor5::Rails::Assets::AssetsBundleHtmlSerializer do
                                  nonce: 'true'
                                })
     end
-
-    it 'memoizes scripts import map' do
-      first_call = serializer.send(:scripts_import_map_tag)
-      second_call = serializer.send(:scripts_import_map_tag)
-
-      expect(first_call.object_id).to eq(second_call.object_id)
-    end
   end
 
   describe '.url_resource_preload_type' do
@@ -153,17 +153,60 @@ RSpec.describe CKEditor5::Rails::Assets::AssetsBundleHtmlSerializer do
       expect(described_class.url_resource_preload_type('file.unknown')).to eq('fetch')
     end
   end
+end
 
-  describe '#looks_like_url? (private)' do
-    subject(:serializer) { described_class.new(CKEditor5::Rails::Assets::AssetsBundle.new) }
+RSpec.describe CKEditor5::Rails::Assets::AssetsImportMap do
+  let(:scripts) do
+    [
+      CKEditor5::Rails::Assets::JSUrlImportMeta.new(
+        'https://cdn.com/script1.js',
+        window_name: 'WindowScript'
+      ),
+      CKEditor5::Rails::Assets::JSUrlImportMeta.new(
+        'https://cdn.com/script2.js',
+        import_name: '@ckeditor/module'
+      ),
+      CKEditor5::Rails::Assets::JSUrlImportMeta.new(
+        'https://cdn.com/script3.js',
+        import_name: 'https://example.com/module'
+      )
+    ]
+  end
+
+  let(:bundle) { CKEditor5::Rails::Assets::AssetsBundle.new(scripts: scripts) }
+  subject(:import_map) { described_class.new(bundle) }
+
+  describe '#to_json' do
+    it 'includes only ESM scripts without URL-like imports' do
+      json = JSON.parse(import_map.to_json)
+      expect(json['imports']).to eq({
+                                      '@ckeditor/module' => 'https://cdn.com/script2.js'
+                                    })
+    end
+  end
+
+  describe '#to_html' do
+    it 'generates script tag with import map' do
+      html = import_map.to_html
+      expect(html).to have_tag('script', with: { type: 'importmap', nonce: 'true' }) do
+        with_text('{"imports":{"@ckeditor/module":"https://cdn.com/script2.js"}}')
+      end
+    end
+  end
 
+  describe '#looks_like_url? (private)' do
     it 'returns false for invalid URIs' do
-      expect(serializer.send(:looks_like_url?, '@ckeditor/foo')).to be false
-      expect(serializer.send(:looks_like_url?, 'http')).to be false
-      expect(serializer.send(:looks_like_url?, 'invalid')).to be false
-      expect(serializer.send(:looks_like_url?, 'http://[invalid')).to be false
-      expect(serializer.send(:looks_like_url?, "http://example.com\nmalicious")).to be false
-      expect(serializer.send(:looks_like_url?, 'http://<invalid>')).to be false
+      expect(import_map.send(:looks_like_url?, '@ckeditor/foo')).to be false
+      expect(import_map.send(:looks_like_url?, 'http')).to be false
+      expect(import_map.send(:looks_like_url?, 'invalid')).to be false
+      expect(import_map.send(:looks_like_url?, 'http://[invalid')).to be false
+      expect(import_map.send(:looks_like_url?, "http://example.com\nmalicious")).to be false
+      expect(import_map.send(:looks_like_url?, 'http://<invalid>')).to be false
+    end
+
+    it 'returns true for valid HTTP(S) URLs' do
+      expect(import_map.send(:looks_like_url?, 'http://example.com')).to be true
+      expect(import_map.send(:looks_like_url?, 'https://cdn.com/script.js')).to be true
     end
   end
 end

data/spec/lib/ckeditor5/rails/cdn/helpers_spec.rb

@@ -3,7 +3,16 @@
 require 'spec_helper'
 
 RSpec.describe CKEditor5::Rails::Cdn::Helpers do
-  let(:test_class) { Class.new { include CKEditor5::Rails::Cdn::Helpers } }
+  let(:test_class) do
+    Class.new do
+      include CKEditor5::Rails::Cdn::Helpers
+
+      def importmap_rendered?
+        false
+      end
+    end
+  end
+
   let(:helper) { test_class.new }
   let(:preset) do
     CKEditor5::Rails::Presets::PresetBuilder.new do
@@ -32,10 +41,6 @@ RSpec.describe CKEditor5::Rails::Cdn::Helpers do
 
   describe '#ckeditor5_assets' do
     context 'with valid preset' do
-      it 'returns serialized bundle html' do
-        expect(helper.ckeditor5_assets(preset: :default)).to eq(bundle_html)
-      end
-
       it 'creates base bundle' do
         expect(CKEditor5::Rails::Cdn::CKEditorBundle).to receive(:new)
           .with(
@@ -218,6 +223,37 @@ RSpec.describe CKEditor5::Rails::Cdn::Helpers do
           .to raise_error(ArgumentError, /forgot to define version/)
       end
     end
+
+    context 'when Rails.application.importmap is defined' do
+      before do
+        allow(helper).to receive(:importmap_available?).and_return(true)
+        allow(helper).to receive(:importmap_rendered?).and_return(false)
+      end
+
+      it 'returns nil and stores html tags in context' do
+        result = helper.ckeditor5_assets(preset: :default)
+        expect(result).to be_nil
+        expect(context[:html_tags]).to eq(bundle_html)
+      end
+
+      it 'raise exception if importmap_rendered?' do
+        allow(helper).to receive(:importmap_rendered?).and_return(true)
+        expect { helper.ckeditor5_assets(preset: :default) }
+          .to raise_error(CKEditor5::Rails::Cdn::Helpers::ImportmapAlreadyRenderedError)
+      end
+    end
+
+    context 'when importmap_available? is true returns html' do
+      before do
+        allow(helper).to receive(:importmap_available?).and_return(nil)
+      end
+
+      it 'returns html directly' do
+        result = helper.ckeditor5_assets(preset: :default)
+        expect(result).to eq(bundle_html)
+        expect(context[:html_tags]).to be_nil
+      end
+    end
   end
 
   describe 'cdn helper methods' do

data/spec/lib/ckeditor5/rails/engine_spec.rb

@@ -102,5 +102,37 @@ RSpec.describe CKEditor5::Rails::Engine do
         end
       end
     end
+
+    describe 'importmap initializer' do
+      context 'when Importmap is defined' do
+        module Importmap # rubocop:disable Lint/ConstantDefinitionInBlock
+          module ImportmapTagsHelper; end
+        end
+
+        it 'prepends CKEditor5 importmap helper' do
+          initializer = described_class.initializers.find { |i| i.name == 'ckeditor5.importmap' }
+          initializer.run(Rails.application)
+
+          expect(Importmap::ImportmapTagsHelper.ancestors)
+            .to include(CKEditor5::Rails::Hooks::Importmap::ImportmapTagsHelper)
+        end
+      end
+
+      context 'when Importmap is not defined' do
+        before do
+          @importmap = Importmap if defined?(Importmap)
+          Object.send(:remove_const, :Importmap) if defined?(Importmap)
+        end
+
+        after do
+          Object.const_set(:Importmap, @importmap) if @importmap
+        end
+
+        it 'does not raise error' do
+          initializer = described_class.initializers.find { |i| i.name == 'ckeditor5.importmap' }
+          expect { initializer.run(Rails.application) }.not_to raise_error
+        end
+      end
+    end
   end
 end

data/spec/lib/ckeditor5/rails/hooks/importmap_spec.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe CKEditor5::Rails::Hooks::Importmap::ImportmapTagsHelper do
+  let(:test_class) do
+    Class.new do
+      include ActionView::Helpers::TagHelper
+      include CKEditor5::Rails::Hooks::Importmap::ImportmapTagsHelper
+
+      def javascript_importmap_module_preload_tags(*)
+        '<script type="modulepreload">preload</script>'
+      end
+
+      def javascript_import_module_tag(*)
+        '<script type="module">import</script>'
+      end
+
+      def javascript_inline_importmap_tag(json)
+        "<script type=\"importmap\">#{json}</script>"
+      end
+    end
+  end
+
+  let(:helper) { test_class.new }
+  let(:importmap) { double('Importmap', to_json: '{"imports":{}}') }
+
+  before do
+    allow(Rails.application).to receive(:importmap).and_return(importmap)
+  end
+
+  describe '#javascript_importmap_tags' do
+    context 'without CKEditor context' do
+      it 'generates basic importmap tags' do
+        result = helper.javascript_importmap_tags
+
+        expect(result).to include('modulepreload')
+        expect(result).to include('module')
+        expect(helper).to be_importmap_rendered
+      end
+    end
+
+    context 'with CKEditor context' do
+      let(:bundle) do
+        CKEditor5::Rails::Assets::AssetsBundle.new(
+          scripts: [
+            CKEditor5::Rails::Assets::JSUrlImportMeta.new(
+              'https://cdn.com/script.js',
+              import_name: '@ckeditor/module'
+            )
+          ]
+        )
+      end
+
+      let(:html_tags) { '<script src="ckeditor.js"></script>' }
+
+      before do
+        helper.instance_variable_set(:@__ckeditor_context, {
+                                       bundle: bundle,
+                                       html_tags: html_tags
+                                     })
+      end
+
+      it 'merges CKEditor importmap with base importmap' do
+        result = CGI.unescapeHTML(helper.javascript_importmap_tags)
+
+        expect(result).to include('@ckeditor/module')
+        expect(result).to include('https://cdn.com/script.js')
+        expect(result).to include(html_tags)
+      end
+
+      it 'handles invalid JSON gracefully' do
+        allow(importmap).to receive(:to_json).and_return('invalid json')
+
+        expect(Rails.logger).to receive(:error).with(/Failed to merge import maps/)
+        helper.javascript_importmap_tags
+      end
+
+      it 'processes importmap in correct order when context is present' do
+        html = CGI.unescapeHTML(helper.javascript_importmap_tags)
+        doc = Nokogiri::HTML::DocumentFragment.parse(html)
+        scripts = doc.css('script')
+
+        expect(scripts[0]['type']).to eq('importmap')
+        expect(scripts[1]['type']).to eq('modulepreload')
+        expect(scripts[2]['type']).to eq('module')
+        expect(scripts[3]['src']).to eq('ckeditor.js')
+      end
+
+      it 'adds inline importmap when context is missing' do
+        helper.instance_variable_set(:@__ckeditor_context, nil)
+        html = CGI.unescapeHTML(helper.javascript_importmap_tags)
+        doc = Nokogiri::HTML::DocumentFragment.parse(html)
+        scripts = doc.css('script')
+
+        expect(scripts[0]['type']).to eq('importmap')
+        expect(doc.css('script[src="ckeditor.js"]')).to be_empty
+      end
+    end
+  end
+
+  describe '#importmap_rendered?' do
+    it 'returns false by default' do
+      expect(helper).not_to be_importmap_rendered
+    end
+
+    it 'returns true after rendering importmap' do
+      helper.javascript_importmap_tags
+      expect(helper).to be_importmap_rendered
+    end
+  end
+
+  describe '#merge_import_maps_json (private)' do
+    it 'correctly merges two valid import maps' do
+      map_a = '{"imports":{"a":"1"}}'
+      map_b = '{"imports":{"b":"2"}}'
+
+      result = JSON.parse(helper.send(:merge_import_maps_json, map_a, map_b))
+      expect(result['imports']).to eq('a' => '1', 'b' => '2')
+    end
+
+    it 'returns second map when first is invalid' do
+      map_a = 'invalid json'
+      map_b = '{"imports":{"b":"2"}}'
+
+      expect(Rails.logger).to receive(:error).with(/Failed to merge import maps/)
+      result = helper.send(:merge_import_maps_json, map_a, map_b)
+      expect(result).to eq(map_b)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.19.5
+  version: 1.20.0
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-29 00:00:00.000000000 Z
+date: 2024-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -70,6 +70,7 @@ files:
 - lib/ckeditor5/rails/engine.rb
 - lib/ckeditor5/rails/helpers.rb
 - lib/ckeditor5/rails/hooks/form.rb
+- lib/ckeditor5/rails/hooks/importmap.rb
 - lib/ckeditor5/rails/hooks/simple_form.rb
 - lib/ckeditor5/rails/plugins/simple_upload_adapter.rb
 - lib/ckeditor5/rails/plugins/wproofreader.rb
@@ -89,7 +90,7 @@ files:
 - spec/e2e/spec_helper.rb
 - spec/e2e/support/eventually.rb
 - spec/e2e/support/form_helpers.rb
-- spec/lib/ckeditor5/rails/assets/asset_bundle_hml_serializer_spec.rb
+- spec/lib/ckeditor5/rails/assets/assets_bundle_hml_serializer_spec.rb
 - spec/lib/ckeditor5/rails/assets/assets_bundle_spec.rb
 - spec/lib/ckeditor5/rails/cdn/ckbox_bundle_spec.rb
 - spec/lib/ckeditor5/rails/cdn/ckeditor_bundle_spec.rb
@@ -108,6 +109,7 @@ files:
 - spec/lib/ckeditor5/rails/editor/props_spec.rb
 - spec/lib/ckeditor5/rails/engine_spec.rb
 - spec/lib/ckeditor5/rails/hooks/form_spec.rb
+- spec/lib/ckeditor5/rails/hooks/importmap_spec.rb
 - spec/lib/ckeditor5/rails/hooks/simple_form_spec.rb
 - spec/lib/ckeditor5/rails/plugins/wproofreader_spec.rb
 - spec/lib/ckeditor5/rails/presets/manager_spec.rb
@@ -154,7 +156,7 @@ test_files:
 - spec/e2e/spec_helper.rb
 - spec/e2e/support/eventually.rb
 - spec/e2e/support/form_helpers.rb
-- spec/lib/ckeditor5/rails/assets/asset_bundle_hml_serializer_spec.rb
+- spec/lib/ckeditor5/rails/assets/assets_bundle_hml_serializer_spec.rb
 - spec/lib/ckeditor5/rails/assets/assets_bundle_spec.rb
 - spec/lib/ckeditor5/rails/cdn/ckbox_bundle_spec.rb
 - spec/lib/ckeditor5/rails/cdn/ckeditor_bundle_spec.rb
@@ -173,6 +175,7 @@ test_files:
 - spec/lib/ckeditor5/rails/editor/props_spec.rb
 - spec/lib/ckeditor5/rails/engine_spec.rb
 - spec/lib/ckeditor5/rails/hooks/form_spec.rb
+- spec/lib/ckeditor5/rails/hooks/importmap_spec.rb
 - spec/lib/ckeditor5/rails/hooks/simple_form_spec.rb
 - spec/lib/ckeditor5/rails/plugins/wproofreader_spec.rb
 - spec/lib/ckeditor5/rails/presets/manager_spec.rb