ckeditor5 1.28.1 → 1.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c28d638338e7bdb2e029d6eb1a81a65126dfbe16b31828563e5d7a0efc3a51e
-  data.tar.gz: c87327aa99851db71ff50f0d12c606c58194b3840a4c13eb99e7ca22c6e87734
+  metadata.gz: 256f9adbf5e78de031f065ddb9b752cfbf10cd3dac9e684e6d18058fef7f6576
+  data.tar.gz: 6049c1d13ba8366999c877b926676414426938377163e921b957f252372c32a2
 SHA512:
-  metadata.gz: 015fd8f7850a4620aa13d62c8ffee059a417fb8d6e2808f3699753843eb99eeb7c281ee03c949e0bf3458690a406d9854e56190bc0960dd1e2729f4ef56a008b
-  data.tar.gz: 914079678cd53137163f389df3d6a2a42992b7c1f9d84cdd6cd628b878973210eb442de79c5bea4b8cc7e01b0f05534afe0763fdd56534e3c4041c8703d20776
+  metadata.gz: f66a5c790311abf91166063825f3b7c6b3708d2f472748538b77abce68c56f42038bc163a133d989358d27a57370bac89db0ee77d6da0dd8b64bb62b6922263a
+  data.tar.gz: af90ae4ff64f99b2d8c5bc6f04baede52d7351f4bfa3e62e88125311806ceb66147caefb454e374f891b6ed7383943414c75e81b391aacf2e9f05131963f6dd3

data/README.md

@@ -146,10 +146,10 @@ For extending CKEditor's functionality, refer to the [plugins directory](https:/
       - [`inline_plugin(name, code)` method](#inline_pluginname-code-method)
       - [`external_plugin(name, script:, import_as: nil, window_name: nil, stylesheets: [])` method](#external_pluginname-script-import_as-nil-window_name-nil-stylesheets--method)
       - [`patch_plugin(plugin)`](#patch_pluginplugin)
-      - [`simple_upload_adapter(url)` method](#simple_upload_adapterurl-method)
-      - [`special_characters(&block)` method](#special_charactersblock-method)
-      - [`wproofreader(version: nil, cdn: nil, **config)` method](#wproofreaderversion-nil-cdn-nil-config-method)
-      - [`custom_translations(lang_code = nil, translations = {})` method](#custom_translationslang_code--nil-translations---method)
+      - [`simple_upload_adapter(url, compress: true)` method](#simple_upload_adapterurl-compress-true-method)
+      - [`special_characters(compress: true, &block)` method](#special_characterscompress-true-block-method)
+      - [`wproofreader(version: nil, cdn: nil, compress: true, **config)` method](#wproofreaderversion-nil-cdn-nil-compress-true-config-method)
+      - [`custom_translations(lang_code = nil, translations = {}, compress: true)` method](#custom_translationslang_code--nil-translations---compress-true-method)
     - [Controller / View helpers 📦](#controller--view-helpers-)
       - [`ckeditor5_translation_ref(key)` method](#ckeditor5_translation_refkey-method)
       - [`ckeditor5_element_ref(selector)` method](#ckeditor5_element_refselector-method)
@@ -1031,13 +1031,12 @@ class YourPatch < CKEditor5::Rails::Editor::PropsPatchPlugin
 
   def initialize
     super(:YourPatch, PLUGIN_CODE, min_version: nil, max_version: '45.0.0')
-    compress!
   end
 end
 ```
 </details>
 
-#### `simple_upload_adapter(url)` method
+#### `simple_upload_adapter(url, compress: true)` method
 
 <details>
   <summary>Configure server-side image upload endpoint</summary>
@@ -1060,7 +1059,7 @@ end
 ```
 </details>
 
-#### `special_characters(&block)` method
+#### `special_characters(compress: true, &block)` method
 
 <details>
   <summary>Configure special characters plugin</summary>
@@ -1106,7 +1105,7 @@ For more info about the special characters plugin, check the [official documenta
 
 </details>
 
-#### `wproofreader(version: nil, cdn: nil, **config)` method
+#### `wproofreader(version: nil, cdn: nil, compress: true, **config)` method
 
 <details>
   <summary>Configure WProofreader plugin</summary>
@@ -1160,7 +1159,7 @@ For more info about the WProofreader plugin, check the [official documentation](
 
 </details>
 
-#### `custom_translations(lang_code = nil, translations = {})` method
+#### `custom_translations(lang_code = nil, translations = {}, compress: true)` method
 
 <details>
   <summary>Define custom translations for CKEditor components and UI</summary>

data/lib/ckeditor5/rails/editor/props_inline_plugin.rb

@@ -4,17 +4,20 @@ require_relative 'props_base_plugin'
 
 module CKEditor5::Rails::Editor
   class PropsInlinePlugin < PropsBasePlugin
-    attr_reader :code
+    attr_reader :code, :compress
 
-    def initialize(name, code)
+    def initialize(name, code, compress: true)
       super(name)
 
       raise ArgumentError, 'Code must be a String' unless code.is_a?(String)
 
-      @code = "(async () => { #{code.html_safe} })()"
+      @code = "(async () => { #{code} })()"
+      @compress = compress
     end
 
-    def compress!
+    def try_compress!
+      return unless @compress
+
       @code = Terser.new(compress: false, mangle: true).compile(@code)
     end
 
@@ -33,19 +36,17 @@ module CKEditor5::Rails::Editor
     end
 
     def to_html(nonce: nil)
-      code = wrap_with_handlers(@plugin.code)
-
-      tag.script(code.html_safe, type: 'module', nonce: nonce)
-    end
-
-    private
-
-    def wrap_with_handlers(code)
-      <<~JS
+      code = <<~JS
         window.addEventListener('ckeditor:request-cjs-plugin:#{@plugin.name}', () => {
-          window['#{@plugin.name}'] = #{code.html_safe};
+          try {
+            window['#{@plugin.name}'] = #{@plugin.code};
+          } catch(e) {
+            console.error('Error initializing CKEditor plugin #{@plugin.name}:', e);
+          }
         }, { once: true });
       JS
+
+      tag.script(code.html_safe, nonce: nonce)
     end
   end
 end

data/lib/ckeditor5/rails/editor/props_patch_plugin.rb

@@ -12,8 +12,6 @@ module CKEditor5::Rails::Editor
 
       @min_version = min_version && CKEditor5::Rails::Semver.new(min_version)
       @max_version = max_version && CKEditor5::Rails::Semver.new(max_version)
-
-      compress!
     end
 
     def self.applicable_for_version?(editor_version, min_version: nil, max_version: nil)

data/lib/ckeditor5/rails/plugins/custom_translations_loader.rb

@@ -4,7 +4,7 @@ require_relative '../editor/props_inline_plugin'
 
 module CKEditor5::Rails::Plugins
   class CustomTranslationsLoader < CKEditor5::Rails::Editor::PropsInlinePlugin
-    def initialize(translations) # rubocop:disable Metrics/MethodLength
+    def initialize(translations, **kwargs) # rubocop:disable Metrics/MethodLength
       code = <<~JS.freeze
         const { Plugin } = await import('ckeditor5');
 
@@ -90,8 +90,7 @@ module CKEditor5::Rails::Plugins
         }
       JS
 
-      super(:CustomTranslationsLoader, code)
-      compress!
+      super(:CustomTranslationsLoader, code, **kwargs)
     end
   end
 end

data/lib/ckeditor5/rails/plugins/simple_upload_adapter.rb

@@ -82,9 +82,8 @@ module CKEditor5::Rails::Plugins
       }
     JS
 
-    def initialize
-      super(:SimpleUploadAdapter, PLUGIN_CODE)
-      compress!
+    def initialize(**kwargs)
+      super(:SimpleUploadAdapter, PLUGIN_CODE, **kwargs)
     end
   end
 end

data/lib/ckeditor5/rails/plugins/special_characters_bootstrap.rb

@@ -50,9 +50,8 @@ module CKEditor5::Rails::Plugins
       }
     JS
 
-    def initialize
-      super(:SpecialCharactersBootstrap, PLUGIN_CODE)
-      compress!
+    def initialize(**kwargs)
+      super(:SpecialCharactersBootstrap, PLUGIN_CODE, **kwargs)
     end
   end
 end

data/lib/ckeditor5/rails/plugins/wproofreader.rb

@@ -67,9 +67,8 @@ module CKEditor5::Rails::Plugins
       }
     JS
 
-    def initialize
-      super(:WProofreaderSync, PLUGIN_CODE)
-      compress!
+    def initialize(**kwargs)
+      super(:WProofreaderSync, PLUGIN_CODE, **kwargs)
     end
   end
 end

data/lib/ckeditor5/rails/presets/concerns/plugin_methods.rb

@@ -12,6 +12,7 @@ module CKEditor5::Rails
         class MissingInlinePluginError < StandardError; end
         class UnsupportedESModuleError < StandardError; end
         class InvalidPatchPluginError < ArgumentError; end
+        class CompressionDisabledError < StandardError; end
 
         included do
           attr_reader :disallow_inline_plugin_compression
@@ -35,6 +36,7 @@ module CKEditor5::Rails
         #
         # @param name [Symbol] Plugin name
         # @param code [String] JavaScript code defining the plugin
+        # @param compress [Boolean] Whether to compress the code (default: true)
         # @example Define custom highlight plugin
         #   inline_plugin :MyCustomPlugin, <<~JS
         #     const { Plugin } = await import( 'ckeditor5' );
@@ -49,7 +51,7 @@ module CKEditor5::Rails
         #       }
         #     }
         #   JS
-        def inline_plugin(name, code)
+        def inline_plugin(name, code, compress: true)
           if code.match?(/export default/)
             raise UnsupportedESModuleError,
                   'Inline plugins must not use ES module syntax!' \
@@ -61,8 +63,8 @@ module CKEditor5::Rails
                   'Plugin code must return a class that extends Plugin!'
           end
 
-          plugin = Editor::PropsInlinePlugin.new(name, code)
-          plugin.compress! unless disallow_inline_plugin_compression
+          compress = false if @disallow_inline_plugin_compression
+          plugin = Editor::PropsInlinePlugin.new(name, code, compress: compress)
 
           register_plugin(plugin)
         end
@@ -121,6 +123,23 @@ module CKEditor5::Rails
           builder
         end
 
+        # Compresses inline plugins to reduce bundle size
+        #
+        # @raise [CompressionDisabledError] If inline plugin compression is disabled
+        # @example Compress inline plugins
+        #   try_compress_inline_plugins!
+        # @return [void]
+        # @note This method is called automatically when defining a preset
+        def try_compress_inline_plugins!
+          raise CompressionDisabledError if @disallow_inline_plugin_compression
+
+          config[:plugins].each do |plugin|
+            next unless plugin.is_a?(Editor::PropsInlinePlugin)
+
+            plugin.try_compress!
+          end
+        end
+
         private
 
         # Register a plugin in the editor configuration.

data/lib/ckeditor5/rails/presets/manager.rb

@@ -40,6 +40,8 @@ module CKEditor5::Rails::Presets
                end
 
       preset.instance_eval(&block)
+      preset.try_compress_inline_plugins!
+
       @presets[name] = preset
     end
 
@@ -54,7 +56,10 @@ module CKEditor5::Rails::Presets
     #     end
     #   end
     def override(name, &block)
-      @presets[name].instance_eval(&block)
+      preset = @presets[name]
+
+      preset.instance_eval(&block)
+      preset.try_compress_inline_plugins!
     end
 
     alias extend override

data/lib/ckeditor5/rails/presets/preset_builder.rb

@@ -328,6 +328,7 @@ module CKEditor5::Rails
       # Configure custom translations for the editor
       # @param lang_code [Symbol] Language code for translations (e.g. :en, :pl)
       # @param translations [Hash] A hash containing translations in format { key => translation }
+      # @param compress [Boolean] Whether to compress the translations
       # @example Add multiple translations
       #   custom_translations :en, {
       #     'my.button': 'My Button'
@@ -346,14 +347,14 @@ module CKEditor5::Rails
       #     ]
       #   }
       # @return [void]
-      def custom_translations(lang_code = nil, translations = {})
+      def custom_translations(lang_code = nil, translations = {}, compress: true)
         return @custom_translations if lang_code.blank?
 
         @custom_translations[lang_code.to_sym] ||= {}
         @custom_translations[lang_code.to_sym].merge!(translations)
 
         plugins.remove(:CustomTranslationsLoader)
-        plugins.prepend(Plugins::CustomTranslationsLoader.new(@custom_translations))
+        plugins.prepend(Plugins::CustomTranslationsLoader.new(@custom_translations, compress: compress))
       end
 
       # Configure editor language
@@ -381,34 +382,37 @@ module CKEditor5::Rails
 
       # Configure simple upload adapter
       # @param upload_url [String] Upload endpoint URL
+      # @param compress [Boolean] Enable compression
       # @example Enable upload adapter
       #   simple_upload_adapter '/uploads'
-      def simple_upload_adapter(upload_url = '/uploads')
+      def simple_upload_adapter(upload_url = '/uploads', compress: true)
         plugins do
           remove(:Base64UploadAdapter)
         end
 
-        plugin(Plugins::SimpleUploadAdapter.new)
+        plugin(Plugins::SimpleUploadAdapter.new(compress: compress))
         configure(:simpleUpload, { uploadUrl: upload_url })
       end
 
       # Configure WProofreader plugin
       # @param version [String, nil] Plugin version
       # @param cdn [String, nil] CDN URL
+      # @param compress [Boolean] Enable compression
       # @param config [Hash] Plugin configuration
       # @example Basic configuration
       #   wproofreader serviceId: 'your-service-ID',
       #              srcUrl: 'https://svc.webspellchecker.net/spellcheck31/wscbundle/wscbundle.js'
-      def wproofreader(version: nil, cdn: nil, **config)
+      def wproofreader(version: nil, cdn: nil, compress: true, **config)
         configure :wproofreader, config
         plugins do
-          prepend(Plugins::WProofreaderSync.new)
+          prepend(Plugins::WProofreaderSync.new(compress: compress))
           append(Plugins::WProofreader.new(version: version, cdn: cdn))
         end
       end
 
       # Configure special characters plugin
       #
+      # @param compress [Boolean] Enable compression
       # @yield Block for configuring special characters
       # @example Basic configuration with block
       #   special_characters do
@@ -434,14 +438,14 @@ module CKEditor5::Rails
       #       item 'heart', '❤️'
       #     end
       #   end
-      def special_characters(&block)
+      def special_characters(compress: true, &block)
         builder = SpecialCharactersBuilder.new
         builder.instance_eval(&block) if block_given?
 
         plugins do
           append(:SpecialCharacters)
           builder.packs_plugins.each { |pack| append(pack) }
-          prepend(Plugins::SpecialCharactersBootstrap.new)
+          prepend(Plugins::SpecialCharactersBootstrap.new(compress: compress))
         end
 
         configure(:specialCharactersBootstrap, builder.to_h)

data/lib/ckeditor5/rails/version.rb

@@ -2,7 +2,7 @@
 
 module CKEditor5
   module Rails
-    VERSION = '1.28.1'
+    VERSION = '1.29.0'
 
     DEFAULT_CKEDITOR_VERSION = '44.3.0'
   end

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

@@ -361,7 +361,7 @@ RSpec.describe CKEditor5::Rails::Cdn::Helpers do
 
   describe '#ckeditor5_inline_plugins_tags' do
     let(:preset) do
-      CKEditor5::Rails::Presets::PresetBuilder.new do
+      preset = CKEditor5::Rails::Presets::PresetBuilder.new do
         inline_plugin 'Plugin1', <<~JAVASCRIPT
           const { Plugin } = await import( 'ckeditor5' );
 
@@ -382,10 +382,13 @@ RSpec.describe CKEditor5::Rails::Cdn::Helpers do
           }
         JAVASCRIPT
       end
+
+      preset.try_compress_inline_plugins!
+      preset
     end
 
     let(:another_preset) do
-      CKEditor5::Rails::Presets::PresetBuilder.new do
+      preset = CKEditor5::Rails::Presets::PresetBuilder.new do
         inline_plugin 'Plugin3', <<~JAVASCRIPT
           const { Plugin } = await import( 'ckeditor5' );
 
@@ -396,6 +399,9 @@ RSpec.describe CKEditor5::Rails::Cdn::Helpers do
           }
         JAVASCRIPT
       end
+
+      preset.try_compress_inline_plugins!
+      preset
     end
 
     before do

data/spec/lib/ckeditor5/rails/context/preset_builder_spec.rb

@@ -83,6 +83,24 @@ RSpec.describe CKEditor5::Rails::Context::PresetBuilder do
     end
   end
 
+  describe 'try_compress_inline_plugins!' do
+    let(:plugin_code) do
+      <<~JAVASCRIPT
+        const { Plugin } = await import( 'ckeditor5' );
+
+        return class Abc extends Plugin {}
+      JAVASCRIPT
+    end
+
+    it 'raises CompressionDisabledError when compression is disabled' do
+      builder.instance_variable_set(:@disallow_inline_plugin_compression, true)
+
+      expect do
+        builder.try_compress_inline_plugins!
+      end.to raise_error(CKEditor5::Rails::Presets::Concerns::PluginMethods::CompressionDisabledError)
+    end
+  end
+
   describe '#inline_plugin' do
     let(:plugin_code) do
       <<~JAVASCRIPT

data/spec/lib/ckeditor5/rails/editor/props_inline_plugin_spec.rb

@@ -26,6 +26,34 @@ RSpec.describe CKEditor5::Rails::Editor::PropsInlinePlugin do
     end
   end
 
+  describe '#try_compress!' do
+    let(:plugin) { described_class.new(:CustomPlugin, valid_code) }
+    let(:compiled_code) { '(async()=>{const compressed_code})()' }
+    let(:terser_instance) { instance_double('Terser') }
+
+    context 'when compression is enabled' do
+      it 'compresses the code using Terser' do
+        expect(Terser).to receive(:new).with(compress: false, mangle: true).and_return(terser_instance)
+        expect(terser_instance).to receive(:compile).with(plugin.code).and_return(compiled_code)
+
+        plugin.try_compress!
+        expect(plugin.code).to eq(compiled_code)
+      end
+    end
+
+    context 'when compression is disabled' do
+      let(:plugin) { described_class.new(:CustomPlugin, valid_code, compress: false) }
+      let(:original_code) { plugin.code.dup }
+
+      it 'does not modify the code' do
+        expect(Terser).not_to receive(:new)
+
+        plugin.try_compress!
+        expect(plugin.code).to eq(original_code)
+      end
+    end
+  end
+
   describe '#to_h' do
     it 'returns correct hash representation' do
       plugin = described_class.new(:CustomPlugin, valid_code)

data/spec/lib/ckeditor5/rails/presets/preset_builder_spec.rb

@@ -280,7 +280,8 @@ RSpec.describe CKEditor5::Rails::Presets::PresetBuilder do
     end
 
     it 'adds inline plugin to configuration' do
-      builder.inline_plugin(:CustomPlugin, plugin_code)
+      builder.inline_plugin(:CustomPlugin, plugin_code, compress: true)
+      builder.try_compress_inline_plugins!
 
       plugin = builder.config[:plugins].first
       expect(plugin).to be_a(CKEditor5::Rails::Editor::PropsInlinePlugin)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.28.1
+  version: 1.29.0
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-11 00:00:00.000000000 Z
+date: 2025-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails