ckeditor5 1.17.4 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 882d02a7893248e643ac6549d344940b08c946ef9e64193ca227551f4a9ed174
-  data.tar.gz: d6e17a5e168c474c76f53b1be819c5a3248b46cb41e6144097088123aefeba6f
+  metadata.gz: e22407a5c1e37a744b94252008f0cba4be068964b5503661ef5441fb090831c7
+  data.tar.gz: eeb8757cf2c15de70ed40b9652071bfb1aa7bb9224a14842238d2d0670fa3f9e
 SHA512:
-  metadata.gz: 48ded629378991aa8fac441598dac72a8006dd7cf11c094ac910eb0fe295bc099594dc36921563a37796132b483b05d74dba5f760980d1ce7d833ba0f33fb182
-  data.tar.gz: 6ebf7b52994e7da6b52922f7cb970260deee6cc65c0a0e87f136f768e9d0abc5180431f2350a3608d22962ae888e58bf7bf410e2c310ff25fdde88dcdcc1c49e
+  metadata.gz: 06a0b97e9bd86bbba3c905b283f9fdebcf83dd5014bec69caca4898141f937db802b5036d5671dc2e72aa7c7f31b4174876e9ac9499696cf61a85e05d8c65e94
+  data.tar.gz: '09c16514d790101da1069e1de3db5a1ba59b28e70d322f41958cd62be12fc5ceb2fea06a7d474d566845186b468161cca1d596f2c764780baa09f1174ff49305'

data/Gemfile

@@ -8,7 +8,6 @@ group :development do
   gem 'brakeman', '~> 6.1', '>= 6.1.1', require: false
   gem 'guard', '~> 2.19', '>= 2.19.0'
   gem 'guard-process', '~> 1.2'
-  gem 'guard-rspec', '~> 4.7', '>= 4.7.3'
   gem 'pry', '~> 0.15', '>= 0.15.0'
   gem 'pry-rails', '~> 0.3', '>= 0.3.11'
   gem 'rails', '~> 7.0', '>= 7.0.0'

data/README.md

@@ -129,7 +129,9 @@ For extending CKEditor's functionality, refer to the [plugins directory](https:/
       - [`plugin(name, premium:, import_name:)` method](#pluginname-premium-import_name-method)
       - [`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)
       - [`simple_upload_adapter(url)` method](#simple_upload_adapterurl-method)
+      - [`wproofreader(version: nil, cdn: nil, **config)` method](#wproofreaderversion-nil-cdn-nil-config-method)
     - [Controller / View helpers 📦](#controller--view-helpers-)
       - [`ckeditor5_element_ref(selector)` method](#ckeditor5_element_refselector-method)
       - [`ckeditor5_preset(name = nil, &block)` method](#ckeditor5_presetname--nil-block-method)
@@ -790,6 +792,84 @@ end
 This approach is resistant to XSS attacks as it avoids inline JavaScript.
 </details>
 
+#### `external_plugin(name, script:, import_as: nil, window_name: nil, stylesheets: [])` method
+
+<details>
+  <summary>Define external CKEditor plugins directly in the configuration</summary>
+
+<br />
+
+Defines an external plugin to be included in the editor. You can pass the name of the plugin as an argument. The `script` keyword argument specifies the URL of the script to import the plugin from. The `import_as` keyword argument specifies the name of the package to import the plugin from. The `window_name` keyword argument specifies the name of the plugin in the window object. The `stylesheets` keyword argument specifies the URLs of the stylesheets to import.
+
+The example below shows how to define an external plugin that highlights the text:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... other configuration
+
+  external_plugin :MyExternalPlugin,
+                  script: 'https://example.com/my-external-plugin.js'
+end
+```
+
+In order to import a plugin from a custom ESM package, you can pass the `import_as` keyword argument:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... other configuration
+
+  external_plugin :MyExternalPlugin,
+                  script: 'https://example.com/my-external-plugin.js',
+                  import_as: 'Plugin'
+end
+```
+
+It's equivalent to the following JavaScript code:
+
+```js
+import { Plugin } from 'my-external-plugin';
+```
+
+In order to import a plugin from a custom Window entry, you can pass the `window_name` keyword argument:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... other configuration
+
+  external_plugin :MyExternalPlugin,
+                  script: 'https://example.com/my-external-plugin.js',
+                  window_name: 'MyExternalPlugin'
+end
+```
+
+It's equivalent to the following JavaScript code:
+
+```js
+const Plugin = window.MyExternalPlugin;
+```
+
+In order to import a plugin with stylesheets, you can pass the `stylesheets` keyword argument:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... other configuration
+
+  external_plugin :MyExternalPlugin,
+                  script: 'https://example.com/my-external-plugin.js',
+                  stylesheets: ['https://example.com/my-external-plugin.css']
+end
+```
+
+</details>
+
 #### `simple_upload_adapter(url)` method
 
 <details>
@@ -813,6 +893,43 @@ end
 ```
 </details>
 
+#### `wproofreader(version: nil, cdn: nil, **config)` method
+
+<details>
+  <summary>Configure WProofreader plugin</summary>
+
+<br />
+
+Defines the WProofreader plugin to be included in the editor. The example below shows how to include the WProofreader plugin:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... other configuration
+
+  wproofreader serviceId: 'your-service-ID',
+               srcUrl: 'https://svc.webspellchecker.net/spellcheck31/wscbundle/wscbundle.js'
+end
+```
+
+The `version` keyword argument allows you to specify the version of the WProofreader plugin. The `cdn` keyword argument allows you to specify the CDN to be used for the WProofreader plugin.
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... other configuration
+
+  wproofreader version: '2.0.0',
+               cdn: :jsdelivr,
+               serviceId: 'your-service-ID',
+               srcUrl: 'https://svc.webspellchecker.net/spellcheck31/wscbundle/wscbundle.js'
+end
+```
+
+</details>
+
 ### Controller / View helpers 📦
 
 #### `ckeditor5_element_ref(selector)` method

data/lib/ckeditor5/rails/assets/assets_bundle.rb

@@ -41,7 +41,7 @@ module CKEditor5::Rails::Assets
   class JSUrlImportMeta
     attr_reader :url, :import_meta
 
-    delegate :esm?, :window?, :import_name, :window_name, :import_as, :to_h, to: :import_meta
+    delegate :esm?, :window?, :import_name, :window_name, :import_as, to: :import_meta
 
     def initialize(url, translation: false, **import_options)
       @url = url
@@ -52,6 +52,10 @@ module CKEditor5::Rails::Assets
     def translation?
       @translation
     end
+
+    def to_h
+      import_meta.to_h.merge({ url: url })
+    end
   end
 
   class JSImportMeta
@@ -64,14 +68,14 @@ module CKEditor5::Rails::Assets
       @window_name = window_name
     end
 
-    def esm?
-      import_name.present?
-    end
-
     def window?
       window_name.present?
     end
 
+    def esm?
+      import_name.present?
+    end
+
     def to_h
       {
         import_as: import_as,

data/lib/ckeditor5/rails/assets/webcomponents/utils.mjs

@@ -44,7 +44,11 @@ function loadAsyncImports(imports = []) {
     return module.default;
   };
 
-  const loadExternalPlugin = async ({ import_name, import_as, window_name }) => {
+  const loadExternalPlugin = async ({ import_name, import_as, window_name, stylesheets }) => {
+    if (stylesheets?.length) {
+      await loadAsyncCSS(stylesheets);
+    }
+
     if (window_name) {
       if (!Object.prototype.hasOwnProperty.call(window, window_name)) {
         throw new Error(
@@ -60,7 +64,11 @@ function loadAsyncImports(imports = []) {
     const imported = module[import_as || 'default'];
 
     if (!imported) {
-      throw new Error(`Plugin "${import_as}" not found in the ESM module "${import_name}"!`);
+      throw new Error(
+        `Plugin "${import_as || 'default'}" not found in the ESM module ` +
+        `"${import_name}"! Available imports: ${Object.keys(module).join(', ')}! ` +
+        'Consider changing "import_as" value.'
+      );
     }
 
     return imported;
@@ -78,6 +86,35 @@ function loadAsyncImports(imports = []) {
   }));
 }
 
+/**
+ * Dynamically loads CSS files based on configuration
+ *
+ * @param {Array<string>} imports - Array of CSS file URLs to load
+ * @returns {Promise<Array<void>>} Array of promises for each CSS file load
+ * @throws {Error} When CSS file loading fails
+ */
+function loadAsyncCSS(stylesheets = []) {
+  const promises = stylesheets.map(href =>
+    new Promise((resolve, reject) => {
+      const link = document.createElement('link');
+
+      link.rel = 'stylesheet';
+      link.href = href;
+
+      link.onerror = reject;
+      link.onload = () => {
+        resolve();
+      };
+
+      document.head.appendChild(link);
+
+      return link;
+    })
+  );
+
+  return Promise.all(promises);
+}
+
 /**
  * Checks if a key is safe to use in configuration objects to prevent prototype pollution
  *

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

@@ -19,7 +19,7 @@ module CKEditor5::Rails
       delegate :config, to: :@preset
 
       def serialize_plugins
-        (config[:plugins] || []).map { |plugin| Editor::PropsPlugin.normalize(plugin).to_h }.to_json
+        (config[:plugins] || []).map { |plugin| Editor::PropsBasePlugin.normalize(plugin).to_h }.to_json
       end
 
       def serialize_config

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

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

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

@@ -57,7 +57,7 @@ module CKEditor5::Rails::Editor
     end
 
     def serialize_plugins
-      (config[:plugins] || []).map { |plugin| PropsPlugin.normalize(plugin).to_h }.to_json
+      (config[:plugins] || []).map { |plugin| PropsBasePlugin.normalize(plugin).to_h }.to_json
     end
 
     def serialize_config

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CKEditor5::Rails::Editor
+  class PropsBasePlugin
+    attr_reader :name, :assets_bundle
+
+    def initialize(name)
+      @name = name
+    end
+
+    def preload_assets_urls
+      []
+    end
+
+    def to_h
+      raise NotImplementedError, 'Method #to_h must be implemented in a subclass'
+    end
+
+    def self.normalize(plugin, **kwargs)
+      case plugin
+      when String, Symbol then PropsPlugin.new(plugin, **kwargs)
+      when PropsBasePlugin then plugin
+      else raise ArgumentError, "Invalid plugin: #{plugin}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'props_base_plugin'
+
+module CKEditor5::Rails::Editor
+  class PropsExternalPlugin < PropsBasePlugin
+    attr_reader :stylesheets, :js_import_meta
+
+    def initialize(name, script:, import_as: nil, window_name: nil, stylesheets: [])
+      super(name)
+
+      @stylesheets = stylesheets
+      @js_import_meta = CKEditor5::Rails::Assets::JSUrlImportMeta.new(
+        script,
+        import_name: script,
+        import_as: import_as,
+        window_name: window_name
+      )
+    end
+
+    def preload_assets_urls
+      @stylesheets + [@js_import_meta.url]
+    end
+
+    def to_h
+      @js_import_meta.to_h.merge(
+        type: :external,
+        stylesheets: @stylesheets
+      )
+    end
+  end
+end

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

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require_relative 'props_base_plugin'
+
 module CKEditor5::Rails::Editor
-  class PropsInlinePlugin
-    attr_reader :name, :code
+  class PropsInlinePlugin < PropsBasePlugin
+    attr_reader :code
 
     def initialize(name, code)
-      @name = name
+      super(name)
+
       @code = code
       validate_code!
     end

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

@@ -1,36 +1,26 @@
 # frozen_string_literal: true
 
-module CKEditor5::Rails::Editor
-  class PropsPlugin
-    attr_reader :name, :js_import_meta
+require_relative 'props_base_plugin'
 
-    delegate :to_h, to: :import_meta
+module CKEditor5::Rails::Editor
+  class PropsPlugin < PropsBasePlugin
+    def initialize(name, premium: false, **js_import_meta_attrs)
+      super(name)
 
-    def initialize(name, premium: false, **js_import_meta)
-      @name = name
-      @js_import_meta = if js_import_meta.empty?
-                          { import_name: premium ? 'ckeditor5-premium-features' : 'ckeditor5' }
-                        else
-                          js_import_meta
-                        end
-    end
+      js_import_meta_attrs[:import_name] ||= if premium
+                                               'ckeditor5-premium-features'
+                                             else
+                                               'ckeditor5'
+                                             end
 
-    def self.normalize(plugin)
-      case plugin
-      when String, Symbol then new(plugin)
-      when PropsPlugin, PropsInlinePlugin then plugin
-      else raise ArgumentError, "Invalid plugin: #{plugin}"
-      end
+      @js_import_meta = ::CKEditor5::Rails::Assets::JSImportMeta.new(
+        import_as: js_import_meta_attrs[:window_name] ? nil : name,
+        **js_import_meta_attrs
+      )
     end
 
     def to_h
-      meta = ::CKEditor5::Rails::Assets::JSImportMeta.new(
-        import_as: js_import_meta[:window_name] ? nil : name,
-        **js_import_meta
-      ).to_h
-
-      meta.merge!({ type: :external })
-      meta
+      @js_import_meta.to_h.merge(type: :external)
     end
   end
 end

data/lib/ckeditor5/rails/engine.rb

@@ -4,7 +4,9 @@ require 'rails/engine'
 
 require_relative 'presets/manager'
 require_relative 'hooks/form'
+
 require_relative 'plugins/simple_upload_adapter'
+require_relative 'plugins/wproofreader'
 
 module CKEditor5::Rails
   class Engine < ::Rails::Engine

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative '../editor/props_external_plugin'
+
+module CKEditor5::Rails::Plugins
+  class WProofreader < CKEditor5::Rails::Editor::PropsExternalPlugin
+    DEFAULT_VERSION = '3.1.2'
+    DEFAULT_CDN = 'https://cdn.jsdelivr.net/npm/@webspellchecker/wproofreader-ckeditor5'
+
+    def initialize(version: nil, cdn: nil)
+      cdn ||= DEFAULT_CDN
+      version ||= DEFAULT_VERSION
+
+      script_url = "#{cdn}@#{version}/dist/browser/index.js"
+      style_url = "#{cdn}@#{version}/dist/browser/index.css"
+
+      super(
+        :WProofreader,
+        script: script_url,
+        import_as: 'WProofreader',
+        stylesheets: [style_url],
+      )
+    end
+  end
+end

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

@@ -4,14 +4,25 @@ module CKEditor5::Rails
   module Presets
     module Concerns
       module PluginMethods
+        private
+
+        def register_plugin(plugin_obj)
+          config[:plugins] << plugin_obj
+          plugin_obj
+        end
+
+        public
+
+        def external_plugin(name, **kwargs)
+          register_plugin(Editor::PropsExternalPlugin.new(name, **kwargs))
+        end
+
         def inline_plugin(name, code)
-          config[:plugins] << Editor::PropsInlinePlugin.new(name, code)
+          register_plugin(Editor::PropsInlinePlugin.new(name, code))
         end
 
         def plugin(name, **kwargs)
-          plugin_obj = PluginsBuilder.create_plugin(name, **kwargs)
-          config[:plugins] << plugin_obj
-          plugin_obj
+          register_plugin(PluginsBuilder.create_plugin(name, **kwargs))
         end
 
         def plugins(*names, **kwargs, &block)

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

@@ -9,7 +9,7 @@ module CKEditor5::Rails
     end
 
     def self.create_plugin(name, **kwargs)
-      if name.is_a?(Editor::PropsInlinePlugin) || name.is_a?(Editor::PropsPlugin)
+      if name.is_a?(Editor::PropsBasePlugin)
         name
       else
         Editor::PropsPlugin.new(name, **kwargs)

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

@@ -204,6 +204,11 @@ module CKEditor5::Rails
         configure(:simpleUpload, { uploadUrl: upload_url })
       end
 
+      def wproofreader(version: nil, cdn: nil, **config)
+        plugin(Plugins::WProofreader.new(version: version, cdn: cdn))
+        configure :wproofreader, config
+      end
+
       private
 
       def deep_copy_toolbar(toolbar)

data/lib/ckeditor5/rails/version.rb

@@ -2,7 +2,7 @@
 
 module CKEditor5
   module Rails
-    VERSION = '1.17.4'
+    VERSION = '1.18.0'
 
     DEFAULT_CKEDITOR_VERSION = '43.3.1'
   end

data/spec/lib/ckeditor5/rails/assets/assets_bundle_spec.rb

@@ -157,6 +157,17 @@ RSpec.describe CKEditor5::Rails::Assets::JSUrlImportMeta do
       expect(meta).to be_translation
     end
   end
+
+  describe '#to_h' do
+    it 'returns hash with url and import meta' do
+      meta = described_class.new(url, import_name: 'module', import_as: 'alias')
+      expect(meta.to_h).to eq({
+                                url: url,
+                                import_name: 'module',
+                                import_as: 'alias'
+                              })
+    end
+  end
 end
 
 RSpec.describe CKEditor5::Rails::Assets::JSImportMeta do

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

@@ -54,7 +54,7 @@ RSpec.describe CKEditor5::Rails::Context::PresetBuilder do
     it 'accepts plugin options' do
       plugin = builder.plugin('Test', premium: true)
 
-      expect(plugin.js_import_meta[:import_name]).to eq('ckeditor5-premium-features')
+      expect(plugin.to_h[:import_name]).to eq('ckeditor5-premium-features')
     end
   end
 
@@ -82,4 +82,41 @@ RSpec.describe CKEditor5::Rails::Context::PresetBuilder do
       expect(builder.config[:plugins].map(&:name)).to eq(%w[Test1 Test2])
     end
   end
+
+  describe '#inline_plugin' do
+    it 'adds inline plugin to config' do
+      plugin = builder.inline_plugin('Test', 'export default class Abc {}')
+
+      expect(builder.config[:plugins]).to include(plugin)
+      expect(plugin).to be_a(CKEditor5::Rails::Editor::PropsInlinePlugin)
+    end
+
+    it 'accepts plugin options' do
+      plugin = builder.inline_plugin('Test', 'export default class Abc {}')
+
+      expect(plugin.code).to eq('export default class Abc {}')
+    end
+  end
+
+  describe '#external_plugin' do
+    it 'adds external plugin to config' do
+      plugin = builder.external_plugin('Test', script: 'https://example.org/script.js')
+
+      expect(builder.config[:plugins]).to include(plugin)
+      expect(plugin).to be_a(CKEditor5::Rails::Editor::PropsExternalPlugin)
+    end
+
+    it 'accepts plugin options' do
+      plugin = builder.external_plugin(
+        'Test',
+        script: 'https://example.org/script.js',
+        import_as: 'ABC',
+        stylesheets: ['https://example.org/style.css']
+      )
+
+      expect(plugin.to_h[:import_name]).to eq('https://example.org/script.js')
+      expect(plugin.to_h[:import_as]).to eq('ABC')
+      expect(plugin.to_h[:stylesheets]).to include('https://example.org/style.css')
+    end
+  end
 end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe CKEditor5::Rails::Editor::PropsBasePlugin do
+  describe '.normalize' do
+    it 'converts string to plugin instance' do
+      plugin = described_class.normalize('Bold')
+      expect(plugin).to be_a(described_class)
+      expect(plugin.name).to eq('Bold')
+    end
+
+    it 'converts symbol to plugin instance' do
+      plugin = described_class.normalize(:Bold)
+      expect(plugin).to be_a(described_class)
+      expect(plugin.name).to eq(:Bold)
+    end
+
+    it 'returns existing plugin instances unchanged' do
+      original = described_class.new(:Bold)
+      plugin = described_class.normalize(original)
+      expect(plugin).to be(original)
+    end
+
+    it 'returns inline plugin instances unchanged' do
+      inline = CKEditor5::Rails::Editor::PropsInlinePlugin.new(:Custom, 'export default class {}')
+      plugin = described_class.normalize(inline)
+      expect(plugin).to be(inline)
+    end
+
+    it 'raises error for invalid input' do
+      expect { described_class.normalize({}) }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#preload_assets_urls' do
+    it 'returns empty array' do
+      plugin = described_class.new(:Bold)
+
+      expect(plugin.preload_assets_urls).to eq([])
+    end
+  end
+
+  describe '#to_h' do
+    it 'raises NotImplementedError' do
+      plugin = described_class.new(:Bold)
+      expect do
+        plugin.to_h
+      end.to raise_error(NotImplementedError, 'Method #to_h must be implemented in a subclass')
+    end
+  end
+
+  describe '#name' do
+    it 'returns the plugin name' do
+      plugin = described_class.new(:Bold)
+      expect(plugin.name).to eq(:Bold)
+    end
+
+    it 'preserves the type of name argument' do
+      string_plugin = described_class.new('Bold')
+      symbol_plugin = described_class.new(:Bold)
+
+      expect(string_plugin.name).to eq('Bold')
+      expect(symbol_plugin.name).to eq(:Bold)
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe CKEditor5::Rails::Editor::PropsExternalPlugin do
+  describe '#initialize' do
+    it 'creates plugin with required parameters' do
+      plugin = described_class.new('Test', script: 'https://example.org/plugin.js')
+
+      expect(plugin.name).to eq('Test')
+      expect(plugin.preload_assets_urls).to include('https://example.org/plugin.js')
+    end
+
+    it 'accepts optional parameters' do
+      plugin = described_class.new(
+        'Test',
+        script: 'https://example.org/plugin.js',
+        import_as: 'TestPlugin',
+        window_name: 'TestWindow',
+        stylesheets: ['https://example.org/style.css']
+      )
+
+      expect(plugin.preload_assets_urls).to include('https://example.org/style.css')
+    end
+  end
+
+  describe '#preload_assets_urls' do
+    it 'returns array with script and stylesheets urls' do
+      plugin = described_class.new(
+        'Test',
+        script: 'https://example.org/plugin.js',
+        stylesheets: ['https://example.org/style1.css', 'https://example.org/style2.css']
+      )
+
+      expect(plugin.preload_assets_urls).to eq([
+                                                 'https://example.org/style1.css',
+                                                 'https://example.org/style2.css',
+                                                 'https://example.org/plugin.js'
+                                               ])
+    end
+  end
+
+  describe '#to_h' do
+    it 'returns hash with plugin configuration' do
+      plugin = described_class.new(
+        'Test',
+        script: 'https://example.org/plugin.js',
+        import_as: 'TestPlugin',
+        window_name: 'TestWindow',
+        stylesheets: ['https://example.org/style.css']
+      )
+
+      expect(plugin.to_h).to include(
+        type: :external,
+        import_name: 'https://example.org/plugin.js',
+        import_as: 'TestPlugin',
+        window_name: 'TestWindow',
+        stylesheets: ['https://example.org/style.css']
+      )
+    end
+  end
+end

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

@@ -3,36 +3,6 @@
 require 'spec_helper'
 
 RSpec.describe CKEditor5::Rails::Editor::PropsPlugin do
-  describe '.normalize' do
-    it 'converts string to plugin instance' do
-      plugin = described_class.normalize('Bold')
-      expect(plugin).to be_a(described_class)
-      expect(plugin.name).to eq('Bold')
-    end
-
-    it 'converts symbol to plugin instance' do
-      plugin = described_class.normalize(:Bold)
-      expect(plugin).to be_a(described_class)
-      expect(plugin.name).to eq(:Bold)
-    end
-
-    it 'returns existing plugin instances unchanged' do
-      original = described_class.new(:Bold)
-      plugin = described_class.normalize(original)
-      expect(plugin).to be(original)
-    end
-
-    it 'returns inline plugin instances unchanged' do
-      inline = CKEditor5::Rails::Editor::PropsInlinePlugin.new(:Custom, 'export default class {}')
-      plugin = described_class.normalize(inline)
-      expect(plugin).to be(inline)
-    end
-
-    it 'raises error for invalid input' do
-      expect { described_class.normalize({}) }.to raise_error(ArgumentError)
-    end
-  end
-
   describe '#to_h' do
     it 'generates hash for standard plugin' do
       plugin = described_class.new(:Bold)

data/spec/lib/ckeditor5/rails/plugins/wproofreader_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe CKEditor5::Rails::Plugins::WProofreader do
+  let(:default_cdn) { 'https://cdn.jsdelivr.net/npm/@webspellchecker/wproofreader-ckeditor5' }
+  let(:default_version) { '3.1.2' }
+
+  describe '#initialize' do
+    context 'with default parameters' do
+      subject(:plugin) { described_class.new }
+
+      it 'has correct name' do
+        expect(plugin.name).to eq(:WProofreader)
+      end
+
+      it 'returns correct preload assets urls' do
+        expected_urls = [
+          "#{default_cdn}@#{default_version}/dist/browser/index.css",
+          "#{default_cdn}@#{default_version}/dist/browser/index.js"
+        ]
+        expect(plugin.preload_assets_urls).to eq(expected_urls)
+      end
+
+      it 'returns correct hash representation' do
+        expected_hash = {
+          type: :external,
+          stylesheets: ["#{default_cdn}@#{default_version}/dist/browser/index.css"],
+          url: "#{default_cdn}@#{default_version}/dist/browser/index.js",
+          import_name: "#{default_cdn}@#{default_version}/dist/browser/index.js",
+          import_as: 'WProofreader'
+        }
+        expect(plugin.to_h).to eq(expected_hash)
+      end
+    end
+
+    context 'with custom parameters' do
+      let(:custom_cdn) { 'https://custom-cdn.com/wproofreader' }
+      let(:custom_version) { '4.0.0' }
+      subject(:plugin) { described_class.new(version: custom_version, cdn: custom_cdn) }
+
+      it 'returns correct preload assets urls with custom CDN' do
+        expected_urls = [
+          "#{custom_cdn}@#{custom_version}/dist/browser/index.css",
+          "#{custom_cdn}@#{custom_version}/dist/browser/index.js"
+        ]
+        expect(plugin.preload_assets_urls).to eq(expected_urls)
+      end
+
+      it 'returns correct hash representation with custom CDN' do
+        expected_hash = {
+          type: :external,
+          stylesheets: ["#{custom_cdn}@#{custom_version}/dist/browser/index.css"],
+          url: "#{custom_cdn}@#{custom_version}/dist/browser/index.js",
+          import_name: "#{custom_cdn}@#{custom_version}/dist/browser/index.js",
+          import_as: 'WProofreader'
+        }
+        expect(plugin.to_h).to eq(expected_hash)
+      end
+    end
+  end
+end

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

@@ -380,4 +380,22 @@ RSpec.describe CKEditor5::Rails::Presets::PresetBuilder do
       end
     end
   end
+
+  describe 'wproofreader' do
+    it 'configures WProofreader plugin' do
+      builder.wproofreader(version: '1.0.0', cdn: 'https://cdn.example.com')
+      plugin = builder.config[:plugins].first
+
+      expect(plugin).to be_a(CKEditor5::Rails::Editor::PropsExternalPlugin)
+      expect(plugin.name).to eq(:WProofreader)
+      expect(plugin.to_h[:import_name]).to eq('https://cdn.example.com@1.0.0/dist/browser/index.js')
+      expect(plugin.to_h[:stylesheets]).to eq(['https://cdn.example.com@1.0.0/dist/browser/index.css'])
+    end
+
+    it 'sets proper editor configuration in wproofreader key' do
+      builder.wproofreader(version: '1.0.0', cdn: 'https://cdn.example.com', language: 'en')
+
+      expect(builder.config[:wproofreader]).to eq({ language: 'en' })
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.17.4
+  version: 1.18.0
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -63,6 +63,8 @@ files:
 - lib/ckeditor5/rails/editor/helpers/config_helpers.rb
 - lib/ckeditor5/rails/editor/helpers/editor_helpers.rb
 - lib/ckeditor5/rails/editor/props.rb
+- 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_plugin.rb
 - lib/ckeditor5/rails/engine.rb
@@ -70,6 +72,7 @@ files:
 - lib/ckeditor5/rails/hooks/form.rb
 - lib/ckeditor5/rails/hooks/simple_form.rb
 - lib/ckeditor5/rails/plugins/simple_upload_adapter.rb
+- lib/ckeditor5/rails/plugins/wproofreader.rb
 - lib/ckeditor5/rails/presets/concerns/configuration_methods.rb
 - lib/ckeditor5/rails/presets/concerns/plugin_methods.rb
 - lib/ckeditor5/rails/presets/manager.rb
@@ -98,12 +101,15 @@ files:
 - spec/lib/ckeditor5/rails/editor/editable_height_normalizer_spec.rb
 - spec/lib/ckeditor5/rails/editor/helpers/config_helpers_spec.rb
 - spec/lib/ckeditor5/rails/editor/helpers/editor_helpers_spec.rb
+- 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_plugin_spec.rb
 - 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/simple_form_spec.rb
+- spec/lib/ckeditor5/rails/plugins/wproofreader_spec.rb
 - spec/lib/ckeditor5/rails/presets/manager_spec.rb
 - spec/lib/ckeditor5/rails/presets/plugins_builder_spec.rb
 - spec/lib/ckeditor5/rails/presets/preset_builder_spec.rb
@@ -160,12 +166,15 @@ test_files:
 - spec/lib/ckeditor5/rails/editor/editable_height_normalizer_spec.rb
 - spec/lib/ckeditor5/rails/editor/helpers/config_helpers_spec.rb
 - spec/lib/ckeditor5/rails/editor/helpers/editor_helpers_spec.rb
+- 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_plugin_spec.rb
 - 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/simple_form_spec.rb
+- spec/lib/ckeditor5/rails/plugins/wproofreader_spec.rb
 - spec/lib/ckeditor5/rails/presets/manager_spec.rb
 - spec/lib/ckeditor5/rails/presets/plugins_builder_spec.rb
 - spec/lib/ckeditor5/rails/presets/preset_builder_spec.rb