ckeditor5 1.25.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51c0f877edf5aa0ddc0c6b2333f5b631f1ce04144a84eb20c4555bfe63d3206b
-  data.tar.gz: 5d477a6bdf0d8fd05fc3bfedfe34f33398a1c58a015a5de8f6871afd1f38f4bb
+  metadata.gz: ae47ab2c50827fd1a0716bc093475ce4e55a237ad3a9f4c35ba0b66d8ea46f7c
+  data.tar.gz: 13e648a1a348203b84f7220b7160c9d98e25753a97a207e4c5260d8d4d598571
 SHA512:
-  metadata.gz: 401eb14e4e732e5ac3bd1d249372234b0d134277ad934e1cf38968a121824004266acf00ec71699ef3325288a28346fa42254735480207bc3d3a1c901b4b49d9
-  data.tar.gz: 21679ec808b05ff0c052fe419799e47a44b6587b66119cc43d2092c969f0634f52ee8f34c2a8a93eb5300e50c2c7e258cb3d8a4d073898b86ca07d4f1070839b
+  metadata.gz: c311294593a9de01ba525eab43d6dbf0418f454e6c7754a8c2a607464539ca82ed39f61a66d58f5c3a977f89a39c591adfb60b63711c47f3c2657e6c3442c49e
+  data.tar.gz: 64f021c1316971588676e9819d422b09d83bea982d74e94544ccbcc703ffb381778dc08aa308620559701a030d88423c20b5b3a678abfc1854daebb33f9fccc1

data/README.md

@@ -119,8 +119,7 @@ For extending CKEditor's functionality, refer to the [plugins directory](https:/
     - [Automatic upgrades 🔄](#automatic-upgrades-)
     - [Available Configuration Methods ⚙️](#available-configuration-methods-️)
       - [`cdn(cdn = nil, &block)` method](#cdncdn--nil-block-method)
-      - [`version(version)` method](#versionversion-method)
-      - [`automatic_upgrades(enabled: true)` method](#automatic_upgradesenabled-true-method)
+      - [`version(version, apply_patches: true)` method](#versionversion-apply_patches-true-method)
       - [`gpl` method](#gpl-method)
       - [`license_key(key)` method](#license_keykey-method)
       - [`premium` method](#premium-method)
@@ -138,6 +137,8 @@ For extending CKEditor's functionality, refer to the [plugins directory](https:/
       - [`plugins(*names, **kwargs)` method](#pluginsnames-kwargs-method)
       - [`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` method](#apply_integration_patches-method)
       - [`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)
@@ -317,7 +318,7 @@ end
 ```
 </details>
 
-#### `version(version)` method
+#### `version(version, apply_patches: true)` method
 
 <details>
   <summary>Set up the version of CKEditor 5 to be used by the integration</summary>
@@ -335,6 +336,23 @@ CKEditor5::Rails.configure do
   version '44.1.0'
 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.1.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.
+
+```rb
+
 </details>
 
 #### `automatic_upgrades(enabled: true)` method
@@ -979,6 +997,76 @@ end
 
 </details>
 
+#### `patch_plugin(plugin)`
+
+<details>
+  <summary>Appends plugin that applies patch to the specific versions of CKEditor 5</summary>
+
+<br />
+
+Defines a plugin that applies a patch to the specific versions of CKEditor 5. The example below shows how to define a plugin that applies a patch to the `44.1.0` version:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... other configuration
+
+  patch_plugin MyPatchPlugin.new
+end
+```
+
+where the `MyPatchPlugin` should inherit from `KEditor5::Rails::Editor::PropsPatchPlugin` and implement the `initialize` method. For example:
+
+```rb
+class YourPatch < CKEditor5::Rails::Editor::PropsPatchPlugin
+  PLUGIN_CODE = <<~JS
+    const { Plugin, ColorPickerView, debounce } = await import( 'ckeditor5' );
+
+    return class YourPatch extends Plugin {
+      static get pluginName() {
+        return 'YourPatch';
+      }
+
+      constructor(editor) {
+        super(editor);
+
+        // ... your patch
+      }
+    }
+  JS
+
+  def initialize
+    super(:YourPatch, PLUGIN_CODE, min_version: nil, max_version: '45.0.0')
+    compress!
+  end
+end
+```
+</details>
+
+#### `apply_integration_patches` 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)` method
 
 <details>

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

@@ -3,6 +3,7 @@
 require_relative 'props_plugin'
 require_relative 'props_inline_plugin'
 require_relative 'props_external_plugin'
+require_relative 'props_patch_plugin'
 require_relative 'props'
 
 module CKEditor5::Rails::Editor::Helpers

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../semver'
+require_relative 'props_inline_plugin'
+
+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)
+
+      @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)
+      return true if min_version.nil? && max_version.nil?
+
+      current_version = CKEditor5::Rails::Semver.new(editor_version)
+
+      min_check = min_version.nil? || current_version >= CKEditor5::Rails::Semver.new(min_version)
+      max_check = max_version.nil? || current_version <= CKEditor5::Rails::Semver.new(max_version)
+
+      min_check && max_check
+    end
+
+    def applicable_for_version?(editor_version)
+      self.class.applicable_for_version?(
+        editor_version,
+        min_version: @min_version&.to_s,
+        max_version: @max_version&.to_s
+      )
+    end
+  end
+end

data/lib/ckeditor5/rails/engine.rb

@@ -3,9 +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'
 
 module CKEditor5::Rails
   class PresetNotFoundError < ArgumentError; end

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

@@ -0,0 +1,51 @@
+# 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
+      super(:FixColorPickerRaceCondition, PLUGIN_CODE)
+      compress!
+    end
+  end
+end

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../editor/props_external_plugin'
 require_relative '../editor/props_inline_plugin'
 
 module CKEditor5::Rails::Plugins

data/lib/ckeditor5/rails/plugins.rb

@@ -0,0 +1,14 @@
+# 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'
+
+# Plugin patches and fixes
+require_relative 'plugins/patches/fix_color_picker_race_condition'

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

@@ -12,6 +12,7 @@ module CKEditor5::Rails
         class DisallowedInlinePluginError < ArgumentError; end
         class MissingInlinePluginError < StandardError; end
         class UnsupportedESModuleError < StandardError; end
+        class InvalidPatchPluginError < ArgumentError; end
 
         included do
           attr_reader :disallow_inline_plugins, :disallow_inline_plugin_compression
@@ -67,6 +68,23 @@ module CKEditor5::Rails
           register_plugin(plugin)
         end
 
+        # Registers a patch plugin that modifies CKEditor behavior for specific versions
+        #
+        # @param plugin [Editor::PropsPatchPlugin] Patch plugin instance to register
+        # @raise [InvalidPatchPluginError] When provided plugin is not a PropsPatchPlugin
+        # @return [Editor::PropsPatchPlugin, nil] Returns plugin if registered, nil if not applicable
+        # @example Apply patch for specific CKEditor versions
+        #   patch_plugin PropsPatchPlugin.new(:PatchName, code, min_version: '35.0.0', max_version: '36.0.0')
+        def patch_plugin(plugin)
+          unless plugin.is_a?(Editor::PropsPatchPlugin)
+            raise InvalidPatchPluginError, 'Provided plugin must be a PropsPatchPlugin instance'
+          end
+
+          return unless plugin.applicable_for_version?(config[:version])
+
+          register_plugin(plugin)
+        end
+
         # Register a single plugin by name
         #
         # @param name [Symbol, Editor::PropsBasePlugin] Plugin name or instance

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

@@ -172,11 +172,16 @@ module CKEditor5::Rails
       end
 
       # Set or get editor version
-      # @param version [String, nil] 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 '43.3.1'
-      # @return [String, nil] Current version
-      def version(version = nil)
+      # @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, apply_patches: true)
         return @version&.to_s if version.nil?
 
         if @automatic_upgrades && version
@@ -185,6 +190,14 @@ module CKEditor5::Rails
         else
           @version = Semver.new(version)
         end
+
+        apply_integration_patches if apply_patches
+      end
+
+      # Apply integration patches for the current version
+      # @return [void]
+      def apply_integration_patches
+        patch_plugin Plugins::Patches::FixColorPickerRaceCondition.new
       end
 
       # Enable or disable automatic version upgrades

data/lib/ckeditor5/rails/version.rb

@@ -2,7 +2,7 @@
 
 module CKEditor5
   module Rails
-    VERSION = '1.25.0'
+    VERSION = '1.26.0'
 
     DEFAULT_CKEDITOR_VERSION = '44.1.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/editor/props_patch_plugin_spec.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe CKEditor5::Rails::Editor::PropsPatchPlugin do
+  let(:plugin_name) { 'testPlugin' }
+  let(:plugin_code) { 'console.log("test");' }
+
+  describe '#initialize' do
+    it 'creates plugin with version constraints' do
+      plugin = described_class.new(plugin_name, plugin_code, min_version: '29.0.0', max_version: '30.0.0')
+
+      expect(plugin.min_version.to_s).to eq('29.0.0')
+      expect(plugin.max_version.to_s).to eq('30.0.0')
+    end
+
+    it 'creates plugin without version constraints' do
+      plugin = described_class.new(plugin_name, plugin_code)
+
+      expect(plugin.min_version).to be_nil
+      expect(plugin.max_version).to be_nil
+    end
+  end
+
+  describe '.applicable_for_version?' do
+    it 'returns true when no version constraints' do
+      expect(described_class.applicable_for_version?('29.0.0')).to be true
+    end
+
+    it 'returns true when version is within constraints' do
+      result = described_class.applicable_for_version?(
+        '29.1.0',
+        min_version: '29.0.0',
+        max_version: '30.0.0'
+      )
+      expect(result).to be true
+    end
+
+    it 'returns false when version is too low' do
+      result = described_class.applicable_for_version?(
+        '28.9.9',
+        min_version: '29.0.0',
+        max_version: '30.0.0'
+      )
+      expect(result).to be false
+    end
+
+    it 'returns false when version is too high' do
+      result = described_class.applicable_for_version?(
+        '30.0.1',
+        min_version: '29.0.0',
+        max_version: '30.0.0'
+      )
+      expect(result).to be false
+    end
+  end
+
+  describe '#applicable_for_version?' do
+    let(:plugin) do
+      described_class.new(plugin_name, plugin_code, min_version: '29.0.0', max_version: '30.0.0')
+    end
+
+    it 'returns true for version within constraints' do
+      expect(plugin.applicable_for_version?('29.1.0')).to be true
+    end
+
+    it 'returns false for version outside constraints' do
+      expect(plugin.applicable_for_version?('28.9.9')).to be false
+    end
+  end
+end

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,7 +32,7 @@ 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')

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

@@ -593,4 +593,70 @@ RSpec.describe CKEditor5::Rails::Presets::PresetBuilder do
       )
     end
   end
+
+  describe '#patch_plugin' do
+    let(:patch_plugin) do
+      CKEditor5::Rails::Editor::PropsPatchPlugin.new(
+        :TestPatch,
+        <<~JAVASCRIPT
+          const { Plugin } = await import('ckeditor5');
+          return class TestPatch extends Plugin {
+            init() {}
+          }
+        JAVASCRIPT
+      )
+    end
+
+    it 'raises error when plugin is not a PropsPatchPlugin' do
+      invalid_plugin = CKEditor5::Rails::Editor::PropsPlugin.new(:InvalidPatch)
+
+      expect { builder.patch_plugin(invalid_plugin) }
+        .to raise_error(
+          CKEditor5::Rails::Presets::Concerns::PluginMethods::InvalidPatchPluginError,
+          'Provided plugin must be a PropsPatchPlugin instance'
+        )
+    end
+
+    it 'applies patch when applicable' do
+      allow(patch_plugin).to receive(:applicable_for_version?).and_return(true)
+
+      builder.version('35.0.0', apply_patches: false)
+      builder.patch_plugin(patch_plugin)
+
+      plugin_names = builder.config[:plugins].map(&:name)
+      expect(plugin_names).to include(:TestPatch)
+    end
+
+    it 'skips patch when not applicable' do
+      allow(patch_plugin).to receive(:applicable_for_version?).and_return(false)
+
+      builder.version('35.0.0')
+      builder.patch_plugin(patch_plugin)
+
+      plugin_names = builder.config[:plugins].map(&:name)
+      expect(plugin_names).not_to include(:TestPatch)
+    end
+
+    it 'applies patch when version is not set' do
+      builder.patch_plugin(patch_plugin)
+
+      plugin_names = builder.config[:plugins].map(&:name)
+      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.25.0
+  version: 1.26.0
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-05 00:00:00.000000000 Z
+date: 2025-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -82,12 +82,15 @@ files:
 - lib/ckeditor5/rails/editor/props_base_plugin.rb
 - lib/ckeditor5/rails/editor/props_external_plugin.rb
 - lib/ckeditor5/rails/editor/props_inline_plugin.rb
+- lib/ckeditor5/rails/editor/props_patch_plugin.rb
 - lib/ckeditor5/rails/editor/props_plugin.rb
 - 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.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
@@ -125,6 +128,7 @@ files:
 - spec/lib/ckeditor5/rails/editor/props_base_plugin_spec.rb
 - spec/lib/ckeditor5/rails/editor/props_external_plugin_spec.rb
 - spec/lib/ckeditor5/rails/editor/props_inline_plugin_spec.rb
+- spec/lib/ckeditor5/rails/editor/props_patch_plugin_spec.rb
 - spec/lib/ckeditor5/rails/editor/props_plugin_spec.rb
 - spec/lib/ckeditor5/rails/editor/props_spec.rb
 - spec/lib/ckeditor5/rails/engine_spec.rb
@@ -194,6 +198,7 @@ test_files:
 - spec/lib/ckeditor5/rails/editor/props_base_plugin_spec.rb
 - spec/lib/ckeditor5/rails/editor/props_external_plugin_spec.rb
 - spec/lib/ckeditor5/rails/editor/props_inline_plugin_spec.rb
+- spec/lib/ckeditor5/rails/editor/props_patch_plugin_spec.rb
 - spec/lib/ckeditor5/rails/editor/props_plugin_spec.rb
 - spec/lib/ckeditor5/rails/editor/props_spec.rb
 - spec/lib/ckeditor5/rails/engine_spec.rb