ckeditor5 1.29.2 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b38d2ecbbcf76c7aaed4dcd2ffacfb0d231448c5bb77cc45321547591be47744
-  data.tar.gz: 213130a96df2e7bfd30777443f26f841fe7900b4859e17d1c47f33159ecd92f8
+  metadata.gz: e3153496741eaf1fd9b8713998c1078e52d96c6e863ffe710d215e7e3b098816
+  data.tar.gz: 35a1bc0b3e29d51876b4e906a38db93073a65a59ee3ab4436d5e394664bcd833
 SHA512:
-  metadata.gz: d7949733e1c3355c2e6a59c058d43355275bac8b720c4f7c9072f273eb6ebc7e1c405a654ee6e5db9a9873cf387fdfd4706d61f82b7f11086a352fd3ac1815f4
-  data.tar.gz: de5ecb9fad00f7a9a14f0c500d936a5b2a3d67b202e5fe6a922c232c8b8c8f50873c7bc9fb5ffb3b21f214d287cf01662740692a872707eae9ea16602e29d5f4
+  metadata.gz: 7e7d014c98e5c49572be2d2ccd2affcf57d9d91b0cd4f3ffd1cba2cc6834461075c5262aa112768d43ab5a0a9072dcded1fc7daf50beeb19e039b5ad2ff5b40d
+  data.tar.gz: a0d7ddf8085a98b4dc9d60e1606b1a9721e3cf9625b24743aca9fba0eb89ca15036b4f1664ed4e9e6c3d98eb6fc0e86b59c80705096a053738d3204c0bcc9063

data/README.md

@@ -146,10 +146,12 @@ 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)
+      - [`apply_integration_patches(compress: false)` method](#apply_integration_patchescompress-false-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)
+      - [`compression(enabled: true)` method](#compressionenabled-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)
@@ -346,6 +348,20 @@ CKEditor5::Rails.configure do
 end
 ```
 
+In order to disable default patches, you can pass the `apply_patches: false` keyword argument to the `version` method.
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... other configuration
+
+  version '44.3.0', apply_patches: false
+end
+```
+
+The patches are defined in the `lib/ckeditor5/rails/plugins/patches` directory. If you want to apply custom patches, you can use the `patch_plugin` method.
+
 </details>
 
 #### `automatic_upgrades(enabled: true)` method
@@ -1038,6 +1054,29 @@ end
 ```
 </details>
 
+#### `apply_integration_patches(compress: false)` method
+
+<details>
+  <summary>Apply patches to the specific versions of CKEditor 5</summary>
+
+<br />
+
+Defines a method that applies patches to the specific versions of CKEditor 5. The example below shows how to apply patches to the `44.1.0` version:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... other configuration
+
+  apply_integration_patches
+end
+```
+
+It's useful when you want to apply patches to the specific versions of CKEditor 5. The patches are defined in the `lib/ckeditor5/rails/plugins/patches` directory.
+
+</details>
+
 #### `simple_upload_adapter(url, compress: true)` method
 
 <details>
@@ -1194,6 +1233,40 @@ end
 
 </details>
 
+#### `compression(enabled: true)` method
+
+<details>
+  <summary>Enable or disable compression of the inline plugins or patches</summary>
+
+<br />
+
+Defines whether the inline plugins should be compressed. It **must** be called before the `inline_plugin` and `version` methods. The example below shows how to disable compression:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  compression enabled: false
+
+  # ... other configuration
+end
+```
+
+:warning: Compression is enabled by default, and it's recommended to keep it enabled for production environments. It reduces the size of the inline plugins and patches, which improves the loading time of the editor.
+If you want to disable compression for a specific plugin, you can pass the `compress: false` keyword argument to the `inline_plugin` method:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... other configuration
+
+  inline_plugin :MyCustomPlugin, plugin_code, compress: false
+end
+```
+
+</details>
+
 ### Controller / View helpers 📦
 
 #### `ckeditor5_translation_ref(key)` method

data/lib/ckeditor5/rails/cdn/helpers.rb

@@ -55,7 +55,7 @@ module CKEditor5::Rails
     #
     # @example Using preset builder object
     #   <% @preset = ckeditor5_preset do
-    #     version '44.3.0'
+    #     version '43.3.1'
     #     toolbar :bold, :italic
     #     plugins :Bold, :Italic
     #   end %>

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

@@ -12,7 +12,7 @@ module CKEditor5::Rails
     #
     # @example Basic preset definition
     #   preset = PresetBuilder.new do
-    #     version '44.3.0'
+    #     version '43.3.1'
     #     gpl
     #     type :classic
     #     toolbar :bold, :italic
@@ -35,7 +35,7 @@ module CKEditor5::Rails
       # @param block [Proc] Optional configuration block
       # @example Initialize with block
       #   PresetBuilder.new do
-      #     version '44.3.0'
+      #     version '43.3.1'
       #     toolbar :bold, :italic
       #   end
       def initialize(&block)

data/lib/ckeditor5/rails/editor/helpers/config_helpers.rb

@@ -44,7 +44,7 @@ module CKEditor5::Rails::Editor::Helpers
     #
     # @example Creating a custom preset in controller
     #   @preset = ckeditor5_preset do
-    #     version '44.3.0'
+    #     version '43.3.1'
     #     toolbar :sourceEditing, :|, :bold, :italic
     #     plugins :Essentials, :Paragraph, :Bold, :Italic
     #   end

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

@@ -7,8 +7,8 @@ module CKEditor5::Rails::Editor
   class PropsPatchPlugin < PropsInlinePlugin
     attr_reader :min_version, :max_version
 
-    def initialize(name, code, min_version: nil, max_version: nil)
-      super(name, code)
+    def initialize(name, code, min_version: nil, max_version: nil, compress: true)
+      super(name, code, compress: compress)
 
       @min_version = min_version && CKEditor5::Rails::Semver.new(min_version)
       @max_version = max_version && CKEditor5::Rails::Semver.new(max_version)

data/lib/ckeditor5/rails/engine.rb

@@ -3,10 +3,7 @@
 require 'rails/engine'
 
 require_relative 'presets/manager'
-require_relative 'plugins/simple_upload_adapter'
-require_relative 'plugins/wproofreader'
-require_relative 'plugins/special_characters_bootstrap'
-require_relative 'plugins/custom_translations_loader'
+require_relative 'plugins'
 
 module CKEditor5::Rails
   class PresetNotFoundError < ArgumentError; end
@@ -84,7 +81,8 @@ module CKEditor5::Rails
                :type, :menubar, :plugins, :plugin, :inline_plugin,
                :toolbar, :block_toolbar, :balloon_toolbar,
                :language, :ckbox, :configure, :automatic_upgrades, :simple_upload_adapter,
-               :editable_height, :wproofreader, :custom_translations, to: :default_preset
+               :editable_height, :wproofreader, :custom_translations, :apply_integration_patches,
+               :compression, :compression?, to: :default_preset
 
       def initialize(configuration)
         @configuration = configuration

data/lib/ckeditor5/rails/plugins/patches/fix_color_picker_race_condition.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative '../../editor/props_patch_plugin'
+
+module CKEditor5::Rails::Plugins::Patches
+  # Fixes focus management issues in the CKEditor5 color picker component
+  # by ensuring proper focus handling when the color picker is opened.
+  #
+  # The patch modifies the ColorPickerView's focus behavior to properly
+  # focus either the hex input field (when visible) or the first slider.
+  #
+  # @see https://github.com/ckeditor/ckeditor5/issues/17069
+  class FixColorPickerRaceCondition < CKEditor5::Rails::Editor::PropsPatchPlugin
+    PLUGIN_CODE = <<~JS
+      const { Plugin, ColorPickerView, debounce } = await import( 'ckeditor5' );
+
+      return class FixColorPickerRaceCondition extends Plugin {
+        static get pluginName() {
+          return 'FixColorPickerRaceCondition';
+        }
+
+        constructor(editor) {
+          super(editor);
+          this.editor = editor;
+          this.#applyPatch();
+        }
+
+        #applyPatch() {
+          const { focus } = ColorPickerView.prototype;
+
+          ColorPickerView.prototype.focus = function() {
+              try {
+                if (!this._config.hideInput) {
+                  this.hexInputRow.children.get( 1 ).focus();
+                }
+
+                this.slidersView.first.focus();
+              } catch (error) {
+                focus.apply(this, arguments);
+              }
+          }
+        }
+      }
+    JS
+
+    def initialize(**kwargs)
+      super(:FixColorPickerRaceCondition, PLUGIN_CODE, max_version: '44.4.0', **kwargs)
+    end
+  end
+end

data/lib/ckeditor5/rails/plugins.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CKEditor5::Rails::Plugins
+  module Patches
+  end
+end
+
+# Core plugins
+require_relative 'plugins/simple_upload_adapter'
+require_relative 'plugins/wproofreader'
+require_relative 'plugins/special_characters_bootstrap'
+require_relative 'plugins/custom_translations_loader'
+
+# Plugin patches and fixes
+require_relative 'plugins/patches/fix_color_picker_race_condition'

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

@@ -18,6 +18,24 @@ module CKEditor5::Rails
           attr_reader :disallow_inline_plugin_compression
         end
 
+        # Sets compression of inline plugin code. Make sure that it is called before setting the version
+        # or adding plugins.
+        # @example Disable compression
+        #   compression(enabled: false)
+        # @return [void]
+        # @note This method is useful for debugging purposes, as it allows you to see the uncompressed code.
+        def compression(enabled: false)
+          @disallow_inline_plugin_compression = !enabled
+        end
+
+        # Check if compression is enabled
+        # @return [Boolean] True if compression is enabled, false otherwise
+        # @example Check if compression is enabled
+        #  compression? # => true
+        def compression?
+          !@disallow_inline_plugin_compression
+        end
+
         # Registers an external plugin loaded from a URL
         #
         # @param name [Symbol] Plugin name
@@ -51,7 +69,7 @@ module CKEditor5::Rails
         #       }
         #     }
         #   JS
-        def inline_plugin(name, code, compress: true)
+        def inline_plugin(name, code, compress: !@disallow_inline_plugin_compression)
           if code.match?(/export default/)
             raise UnsupportedESModuleError,
                   'Inline plugins must not use ES module syntax!' \
@@ -63,7 +81,6 @@ module CKEditor5::Rails
                   'Plugin code must return a class that extends Plugin!'
           end
 
-          compress = false if @disallow_inline_plugin_compression
           plugin = Editor::PropsInlinePlugin.new(name, code, compress: compress)
 
           register_plugin(plugin)

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

@@ -27,7 +27,7 @@ module CKEditor5::Rails::Presets
     #   end
     # @example Define preset from scratch
     #   presets.define :blank, inherit: false do
-    #     version '44.3.0'
+    #     version '43.3.1'
     #     gpl
     #     type :classic
     #   end
@@ -40,7 +40,7 @@ module CKEditor5::Rails::Presets
                end
 
       preset.instance_eval(&block)
-      preset.try_compress_inline_plugins!
+      preset.try_compress_inline_plugins! if preset.compression?
 
       @presets[name] = preset
     end
@@ -59,7 +59,7 @@ module CKEditor5::Rails::Presets
       preset = @presets[name]
 
       preset.instance_eval(&block)
-      preset.try_compress_inline_plugins!
+      preset.try_compress_inline_plugins! if preset.compression?
     end
 
     alias extend override
@@ -83,7 +83,7 @@ module CKEditor5::Rails::Presets
     # @example Basic configuration
     #   CKEditor5::Rails.configure do
     #     presets.define :default do
-    #       version '44.3.0'
+    #       version '43.3.1'
     #       gpl
     #       type :classic
     #       menubar

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

@@ -6,14 +6,14 @@ require_relative 'special_characters_builder'
 
 module CKEditor5::Rails
   module Presets
-    class PresetBuilder
+    class PresetBuilder # rubocop:disable Metrics/ClassLength
       include Editor::Helpers::Config
       include Concerns::ConfigurationMethods
       include Concerns::PluginMethods
 
       # @example Basic initialization
       #   PresetBuilder.new do
-      #     version '44.3.0'
+      #     version '43.3.1'
       #     gpl
       #     type :classic
       #   end
@@ -27,6 +27,7 @@ module CKEditor5::Rails
         @ckbox = nil
         @editable_height = nil
         @automatic_upgrades = false
+        @disallow_inline_plugin_compression = false
         @custom_translations = {}
         @config = {
           plugins: [],
@@ -174,12 +175,15 @@ module CKEditor5::Rails
 
       # Set or get editor version
       # @param version [String, nil] Editor version to set
+      # @param apply_patches [Boolean] Whether to apply integration patches after setting version
       # @example Set specific version
-      #   version '44.3.0'
+      #   version '43.3.1'
+      # @example Set version without applying patches
+      #   version '43.3.1', apply_patches: false
       # @example Get current version
       #   version # => "43.3.1"
       # @return [String, nil] Current version string or nil if not set
-      def version(version = nil)
+      def version(version = nil, apply_patches: true)
         return @version&.to_s if version.nil?
 
         if @automatic_upgrades && version
@@ -192,6 +196,13 @@ module CKEditor5::Rails
         # If there is no license key set, and the version if newer than 44.0.0, switch to GPL
         # as the license key is now required in all versions
         gpl if license_key.nil? && @version.major >= 44
+        apply_integration_patches if apply_patches
+      end
+
+      # Apply integration patches for the current version
+      # @return [void]
+      def apply_integration_patches(compress: !@disallow_inline_plugin_compression)
+        patch_plugin(Plugins::Patches::FixColorPickerRaceCondition.new(compress: compress))
       end
 
       # Enable or disable automatic version upgrades
@@ -347,7 +358,8 @@ module CKEditor5::Rails
       #     ]
       #   }
       # @return [void]
-      def custom_translations(lang_code = nil, translations = {}, compress: true)
+      def custom_translations(lang_code = nil, translations = {},
+                              compress: !@disallow_inline_plugin_compression)
         return @custom_translations if lang_code.blank?
 
         @custom_translations[lang_code.to_sym] ||= {}
@@ -385,7 +397,7 @@ module CKEditor5::Rails
       # @param compress [Boolean] Enable compression
       # @example Enable upload adapter
       #   simple_upload_adapter '/uploads'
-      def simple_upload_adapter(upload_url = '/uploads', compress: true)
+      def simple_upload_adapter(upload_url = '/uploads', compress: !@disallow_inline_plugin_compression)
         plugins do
           remove(:Base64UploadAdapter)
         end
@@ -402,7 +414,7 @@ module CKEditor5::Rails
       # @example Basic configuration
       #   wproofreader serviceId: 'your-service-ID',
       #              srcUrl: 'https://svc.webspellchecker.net/spellcheck31/wscbundle/wscbundle.js'
-      def wproofreader(version: nil, cdn: nil, compress: true, **config)
+      def wproofreader(version: nil, cdn: nil, compress: !@disallow_inline_plugin_compression, **config)
         configure :wproofreader, config
         plugins do
           prepend(Plugins::WProofreaderSync.new(compress: compress))
@@ -438,7 +450,7 @@ module CKEditor5::Rails
       #       item 'heart', '❤️'
       #     end
       #   end
-      def special_characters(compress: true, &block)
+      def special_characters(compress: !@disallow_inline_plugin_compression, &block)
         builder = SpecialCharactersBuilder.new
         builder.instance_eval(&block) if block_given?
 

data/lib/ckeditor5/rails/version.rb

@@ -2,7 +2,7 @@
 
 module CKEditor5
   module Rails
-    VERSION = '1.29.2'
+    VERSION = '1.30.0'
 
     DEFAULT_CKEDITOR_VERSION = '45.0.0'
   end

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

@@ -20,7 +20,7 @@ RSpec.describe CKEditor5::Rails::Cdn::Helpers do
   let(:helper) { test_class.new }
   let(:preset) do
     CKEditor5::Rails::Presets::PresetBuilder.new do
-      version '34.1.0'
+      version '34.1.0', apply_patches: false
       type :classic
       translations :pl
       cdn :cloud
@@ -151,7 +151,7 @@ RSpec.describe CKEditor5::Rails::Cdn::Helpers do
     context 'when overriding preset values' do
       let(:preset) do
         CKEditor5::Rails::Presets::PresetBuilder.new do
-          version '34.1.0'
+          version '34.1.0', apply_patches: false
           type :classic
           language :pl
           cdn :cloud

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

@@ -20,7 +20,7 @@ RSpec.describe CKEditor5::Rails::Presets::Manager do
       it 'creates new preset based on default' do
         manager.define(:custom) do
           automatic_upgrades enabled: false
-          version '36.0.0'
+          version '36.0.0', apply_patches: false
         end
 
         expect(manager[:custom].version).to eq('36.0.0')
@@ -32,13 +32,42 @@ RSpec.describe CKEditor5::Rails::Presets::Manager do
       it 'creates completely new preset' do
         manager.define(:custom, inherit: false) do
           automatic_upgrades enabled: false
-          version '36.0.0'
+          version '36.0.0', apply_patches: false
         end
 
         expect(manager[:custom].version).to eq('36.0.0')
         expect(manager[:custom].config).to eq({ plugins: [], toolbar: [] })
       end
     end
+
+    context 'with compression settings' do
+      it 'attempts compression when compression? returns true' do
+        preset = manager.define(:with_compression, inherit: false) do
+          version '36.0.0', apply_patches: true
+          inline_plugin 'Test', <<~JAVASCRIPT
+            const { Plugin } = await import( 'ckeditor5' );
+
+            return class Abc extends Plugin {}
+          JAVASCRIPT
+        end
+
+        expect(preset.config[:plugins].first.code).to include('const{Plugin:t,ColorPickerView:i,debounce:o}=')
+      end
+
+      it 'does not attempt compression when compression? returns false' do
+        preset = manager.define(:without_compression, inherit: false) do
+          compression enabled: false
+          version '36.0.0', apply_patches: true
+          inline_plugin 'Test', <<~JAVASCRIPT
+            const { Plugin } = await import( 'ckeditor5' );
+
+            return class Abc extends Plugin {}
+          JAVASCRIPT
+        end
+
+        expect(preset.config[:plugins].first.code).to include('const { Plugin, ColorPickerView, debounce }')
+      end
+    end
   end
 
   describe '#override/#extend' do
@@ -69,6 +98,33 @@ RSpec.describe CKEditor5::Rails::Presets::Manager do
 
       expect(manager[:custom].version).to eq('36.0.0')
     end
+
+    context 'with compression settings' do
+      let(:preset_builder) { instance_double(CKEditor5::Rails::Presets::PresetBuilder) }
+
+      before do
+        allow(preset_builder).to receive(:instance_eval)
+        manager.instance_variable_set(:@presets, { custom: preset_builder })
+      end
+
+      it 'attempts compression when compression? returns true' do
+        allow(preset_builder).to receive(:compression?).and_return(true)
+        allow(preset_builder).to receive(:try_compress_inline_plugins!)
+
+        manager.override(:custom) {}
+
+        expect(preset_builder).to have_received(:try_compress_inline_plugins!).once
+      end
+
+      it 'does not attempt compression when compression? returns false' do
+        allow(preset_builder).to receive(:compression?).and_return(false)
+        allow(preset_builder).to receive(:try_compress_inline_plugins!)
+
+        manager.override(:custom) {}
+
+        expect(preset_builder).not_to have_received(:try_compress_inline_plugins!)
+      end
+    end
   end
 
   describe '#[]' do

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

@@ -332,6 +332,14 @@ RSpec.describe CKEditor5::Rails::Presets::PresetBuilder do
     end
   end
 
+  describe '#disable_compression' do
+    it 'disables compression for inline plugins' do
+      builder.compression(enabled: false)
+      expect(builder.compression?).to be false
+      expect(builder.disallow_inline_plugin_compression).to be true
+    end
+  end
+
   describe '#external_plugin' do
     it 'adds external plugin to config' do
       plugin = builder.external_plugin('Test', script: 'https://example.org/script.js')
@@ -710,7 +718,7 @@ RSpec.describe CKEditor5::Rails::Presets::PresetBuilder do
     it 'applies patch when applicable' do
       allow(patch_plugin).to receive(:applicable_for_version?).and_return(true)
 
-      builder.version('35.0.0')
+      builder.version('35.0.0', apply_patches: false)
       builder.patch_plugin(patch_plugin)
 
       plugin_names = builder.config[:plugins].map(&:name)
@@ -734,4 +742,19 @@ RSpec.describe CKEditor5::Rails::Presets::PresetBuilder do
       expect(plugin_names).to include(:TestPatch)
     end
   end
+
+  describe '#apply_integration_patches' do
+    it 'applies known integration patches' do
+      builder.version('35.0.0', apply_patches: false)
+      expect { builder.apply_integration_patches }
+        .to change { builder.config[:plugins].count }
+        .by(1)
+    end
+
+    it 'apply patches when version is not set' do
+      expect { builder.apply_integration_patches }
+        .to change { builder.config[:plugins].count }
+        .by(1)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.29.2
+  version: 1.30.0
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-08 00:00:00.000000000 Z
+date: 2025-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -89,7 +89,9 @@ files:
 - lib/ckeditor5/rails/hooks/form.rb
 - lib/ckeditor5/rails/hooks/importmap.rb
 - lib/ckeditor5/rails/hooks/simple_form.rb
+- lib/ckeditor5/rails/plugins.rb
 - lib/ckeditor5/rails/plugins/custom_translations_loader.rb
+- lib/ckeditor5/rails/plugins/patches/fix_color_picker_race_condition.rb
 - lib/ckeditor5/rails/plugins/simple_upload_adapter.rb
 - lib/ckeditor5/rails/plugins/special_characters_bootstrap.rb
 - lib/ckeditor5/rails/plugins/wproofreader.rb