RubyGems - ckeditor5 - Versions diffs - 1.20.1 → 1.22.0 - Mend

ckeditor5 1.20.1 → 1.22.0

Files changed (30) hide show

checksums.yaml +4 -4
data/README.md +99 -2
data/lib/ckeditor5/rails/assets/assets_bundle.rb +11 -1
data/lib/ckeditor5/rails/assets/assets_bundle_html_serializer.rb +5 -10
data/lib/ckeditor5/rails/assets/webcomponent_bundle.rb +10 -3
data/lib/ckeditor5/rails/assets/webcomponents/components/editor.mjs +35 -2
data/lib/ckeditor5/rails/assets/webcomponents/utils.mjs +36 -2
data/lib/ckeditor5/rails/cdn/concerns/bundle_builder.rb +57 -0
data/lib/ckeditor5/rails/cdn/helpers.rb +62 -55
data/lib/ckeditor5/rails/editor/helpers/editor_helpers.rb +25 -19
data/lib/ckeditor5/rails/editor/props.rb +7 -14
data/lib/ckeditor5/rails/engine.rb +13 -0
data/lib/ckeditor5/rails/presets/manager.rb +2 -0
data/lib/ckeditor5/rails/presets/preset_builder.rb +1 -1
data/lib/ckeditor5/rails/presets/toolbar_builder.rb +117 -3
data/lib/ckeditor5/rails/version.rb +1 -1
data/spec/e2e/features/ajax_form_integration_spec.rb +78 -0
data/spec/e2e/features/lazy_assets_spec.rb +54 -0
data/spec/e2e/support/form_helpers.rb +4 -1
data/spec/lib/ckeditor5/rails/assets/assets_bundle_hml_serializer_spec.rb +53 -0
data/spec/lib/ckeditor5/rails/assets/assets_bundle_spec.rb +2 -1
data/spec/lib/ckeditor5/rails/cdn/helpers_spec.rb +95 -3
data/spec/lib/ckeditor5/rails/editor/helpers/editor_helpers_spec.rb +85 -25
data/spec/lib/ckeditor5/rails/editor/props_spec.rb +14 -34
data/spec/lib/ckeditor5/rails/engine_spec.rb +10 -0
data/spec/lib/ckeditor5/rails/hooks/form_spec.rb +15 -2
data/spec/lib/ckeditor5/rails/plugins/wproofreader_spec.rb +2 -0
data/spec/lib/ckeditor5/rails/presets/toolbar_builder_spec.rb +119 -0
data/spec/lib/ckeditor5/rails/version_detector_spec.rb +1 -1
metadata +7 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5a5f9a3ade293a0c872a6fa77b20acd227133d66728bafcc0e6e20e7e55e3b2
-  data.tar.gz: d6cb12217a822993bf1fe8487143c2debdea4061dc1c72424dbef052f78cb216
+  metadata.gz: 541773f43272493bbe29d3baf236cab3e85231f03b31c5d070b4917e6ecdea26
+  data.tar.gz: cb06989fd313768d6c1a5990f3dd49525fd1482b29a6b542c6d2778092eb3ad5
 SHA512:
-  metadata.gz: d985a26adaaf6a86490ab603a4a50fb7c9c06fdd749f48501763dde0c8eaed14bc6989464bc55589b5be90ecb2ac5a8d4b95f259c71df91957799b80e67c0d04
-  data.tar.gz: 149b7da93c090b45cf1c687b96d3579505ba9c131dd3cca2baae6ac995eaff5da99696be3944197e49012abd2c34140abc9de889703018cc4a6505669c2a7ee5
+  metadata.gz: 5855d32cb3fcfd5da47b650683c215bda3dc1842f8e9d10af599eecec515d00ca120adc0be299d6410c5bd5a12df7d8df6c4c49b0d0d5d6477e65ccb3841a99a
+  data.tar.gz: 437632ab7d5599ddcd452b3dfefa218d2541db59896c50cba8ade94081c40ac4c9a9e144c82daa684174f88d50ac300d341eae07e5d675fe6a90f7ef15d667db

data/README.md CHANGED Viewed

@@ -36,7 +36,7 @@ In your layout:
       be included in the head section to ensure proper loading order.
       This is crucial for CKEditor 5 to work correctly.
     -->
-    <%= javascript_importmap_tags %>
+    <!-- javascript_importmap_tags -->
     <%= yield :head %>
   </head>
   <body>
@@ -148,6 +148,7 @@ For extending CKEditor's functionality, refer to the [plugins directory](https:/
       - [Custom preset](#custom-preset)
       - [Inline preset definition](#inline-preset-definition)
     - [Lazy loading 🚀](#lazy-loading-)
+      - [`ckeditor5_lazy_javascript_tags` helper](#ckeditor5_lazy_javascript_tags-helper)
     - [GPL usage 🆓](#gpl-usage-)
     - [Commercial usage 💰](#commercial-usage-)
   - [Editor placement 🏗️](#editor-placement-️)
@@ -172,6 +173,7 @@ For extending CKEditor's functionality, refer to the [plugins directory](https:/
     - [Integrating with Forms 📋](#integrating-with-forms-)
       - [Rails form builder integration](#rails-form-builder-integration)
       - [Simple form integration](#simple-form-integration)
+    - [Integration with Turbolinks 🚀](#integration-with-turbolinks-)
     - [Custom Styling 🎨](#custom-styling-)
     - [Custom plugins 🧩](#custom-plugins-)
   - [Events fired by the editor 🔊](#events-fired-by-the-editor-)
@@ -608,6 +610,39 @@ CKEditor5::Rails.configure do
   end
 end
 ```
+If you want to append groups of items, you can use the `group` method:
+```rb
+# config/initializers/ckeditor5.rb
+CKEditor5::Rails.configure do
+  # ... other configuration
+  toolbar do
+    group :text_formatting, label: 'Text Formatting', icon: 'threeVerticalDots' do
+      append :bold, :italic, :underline, :strikethrough, separator,
+             :subscript, :superscript, :removeFormat
+    end
+  end
+end
+```
+If you want add new line or the separator, you can use the `break_line` or `separator` methods:
+```rb
+# config/initializers/ckeditor5.rb
+CKEditor5::Rails.configure do
+  # ... other configuration
+  toolbar do
+    append :bold, break_line
+    append separator, :italic
+  end
+end
+```
 </details>
 #### `menubar(visible: true)` method
@@ -1136,12 +1171,49 @@ It's possible to define the preset directly in the `ckeditor5_assets` helper met
 ### Lazy loading 🚀
 <details>
-  <summary>Loading JS and CSS Assets</summary>
+  <summary>Expand to show more information about lazy loading</summary>
 All JS assets defined by the `ckeditor5_assets` helper method are loaded **asynchronously**. It means that the assets are loaded in the background without blocking the rendering of the page. However, the CSS assets are loaded **synchronously** to prevent the flash of unstyled content and ensure that the editor is styled correctly.
 It has been achieved by using web components, together with import maps, which are supported by modern browsers. The web components are used to define the editor and its plugins, while the import maps are used to define the dependencies between the assets.
+#### `ckeditor5_lazy_javascript_tags` helper
+**This method is slow as content is being loaded on the fly on the client side. Use it only when necessary.**
+If you want to include the CKEditor 5 JavaScripts and Stylesheets when the editor is being appended to the DOM using Turbolinks, Stimulus, or other JavaScript frameworks, you can use the `ckeditor5_lazy_javascript_tags` helper method.
+This method does not preload the assets, and it's appending web component that loads the assets when the editor is being appended to the DOM. It's useful when turbolinks frame is being replaced or when the editor is being appended to the DOM dynamically.
+The example below shows how to include the CKEditor 5 assets lazily:
+```erb
+<!-- app/views/demos/index.html.erb -->
+<% content_for :head do %>
+  <%= ckeditor5_lazy_javascript_tags %>
+<% end %>
+<%= turbo_frame_tag 'editor' do %>
+  <%= ckeditor5_editor %>
+<% end %>
+```
+⚠️ Keep in mind that the `ckeditor5_lazy_javascript_tags` helper method should be included in the `head` section of the layout and it does not create controller context for the editors. In other words, you have to specify `preset` every time you use `ckeditor5_editor` helper (in `ckeditor5_assets` it's not necessary, as it's inherited by all editors).
+If you want to keep inheritance of the presets and enforce integration to inject CKEditor 5 files on the fly, you can use the `lazy` keyword argument in the `ckeditor5_assets` helper method:
+```erb
+<!-- app/views/demos/index.html.erb -->
+<% content_for :head do %>
+  <%= ckeditor5_assets preset: :custom, lazy: true %>
+<% end %>
+<!-- This time preset will be inherited but stylesheets and js files will be injected on the client side. -->
+<%= ckeditor5_editor %>
+```
 </details>
 ### GPL usage 🆓
@@ -1658,6 +1730,31 @@ You can integrate CKEditor 5 with Rails form builders like `form_for` or `simple
 <% end %>
 ```
+### Integration with Turbolinks 🚀
+If you're using Turbolinks in your Rails application, you may need to load CKEditor 5 in embeds that are loaded dynamically and not on the initial page load. In this case, you can use the `ckeditor5_lazy_javascript_tags` helper method to load CKEditor 5 assets when the editor is appended to the DOM. This method is useful when you're using Turbolinks or Stimulus to load CKEditor 5 dynamically.
+Your view should look like this:
+```erb
+<!-- app/views/demos/index.html.erb -->
+<% content_for :head do %>
+  <%= ckeditor5_lazy_javascript_tags %>
+<% end %>
+```
+Your ajax partial should look like this:
+```erb
+<!-- app/views/demos/_form.html.erb -->
+<!-- Presets and other configuration as usual -->
+<%= ckeditor5_editor %>
+```
+This method does not preload the assets, and it's appending web component that loads the assets when the editor is being appended to the DOM. Please see the [Lazy Loading](#lazy-loading) section for more information and [demos](https://github.com/Mati365/ckeditor5-rails/blob/main/sandbox/app/views/demos/form_ajax.slim) on how to use this method.
 ### Custom Styling 🎨
 You can pass the `style`, `class` and `id` keyword arguments to the `ckeditor5_editor` helper to define the styling of the editor. The example below shows how to set the height, margin, and CSS class of the editor:

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

@@ -30,6 +30,13 @@ module CKEditor5::Rails::Assets
       stylesheets + scripts.map(&:preloads)
     end
+    def to_json(*_args)
+      {
+        scripts: scripts.map(&:to_h),
+        stylesheets: stylesheets
+      }.to_json
+    end
     def <<(other)
       raise TypeError, 'other must be an instance of AssetsBundle' unless other.is_a?(AssetsBundle)
@@ -54,7 +61,10 @@ module CKEditor5::Rails::Assets
     end
     def to_h
-      import_meta.to_h.merge({ url: url })
+      import_meta.to_h.merge({
+                               url: url,
+                               translation: translation?
+                             })
     end
     def preloads

data/lib/ckeditor5/rails/assets/assets_bundle_html_serializer.rb CHANGED Viewed

@@ -9,23 +9,22 @@ module CKEditor5::Rails::Assets
   class AssetsBundleHtmlSerializer
     include ActionView::Helpers::TagHelper
-    attr_reader :bundle, :importmap
+    attr_reader :bundle, :importmap, :lazy
-    def initialize(bundle, importmap: true)
+    def initialize(bundle, importmap: true, lazy: false)
       raise TypeError, 'bundle must be an instance of AssetsBundle' unless bundle.is_a?(AssetsBundle)
       @importmap = importmap
       @bundle = bundle
+      @lazy = lazy
     end
     def to_html
       tags = [
-        preload_tags,
-        styles_tags,
-        window_scripts_tags,
-        web_component_tag
+        WebComponentBundle.instance.to_html
       ]
+      tags.prepend(preload_tags, styles_tags, window_scripts_tags) unless lazy
       tags.prepend(AssetsImportMap.new(bundle).to_html) if importmap
       safe_join(tags)
@@ -41,10 +40,6 @@ module CKEditor5::Rails::Assets
     private
-    def web_component_tag
-      @web_component_tag ||= tag.script(WebComponentBundle.source, type: 'module', nonce: true)
-    end
     def window_scripts_tags
       @window_scripts_tags ||= safe_join(bundle.scripts.filter_map do |script|
         tag.script(src: script.url, nonce: true, crossorigin: 'anonymous') if script.window?

data/lib/ckeditor5/rails/assets/webcomponent_bundle.rb CHANGED Viewed

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
+require 'singleton'
 module CKEditor5::Rails::Assets
-  module WebComponentBundle
+  class WebComponentBundle
+    include ActionView::Helpers::TagHelper
+    include Singleton
     WEBCOMPONENTS_PATH = File.join(__dir__, 'webcomponents')
     WEBCOMPONENTS_MODULES = [
       'utils.mjs',
@@ -11,12 +16,14 @@ module CKEditor5::Rails::Assets
       'components/context.mjs'
     ].freeze
-    module_function
     def source
       @source ||= WEBCOMPONENTS_MODULES.map do |file|
         File.read(File.join(WEBCOMPONENTS_PATH, file))
       end.join("\n").html_safe
     end
+    def to_html
+      @to_html ||= tag.script(source, type: 'module', nonce: true)
+    end
   end
 end

data/lib/ckeditor5/rails/assets/webcomponents/components/editor.mjs CHANGED Viewed

@@ -40,6 +40,9 @@ class CKEditorComponent extends HTMLElement {
   /** @type {String} ID of editor within context */
   #contextEditorId = null;
+  /** @type {Object} Description of ckeditor bundle */
+  #bundle = null;
   /** @type {(event: CustomEvent) => void} Event handler for editor change */
   get oneditorchange() {
     return this.#getEventHandler('editorchange');
@@ -237,6 +240,11 @@ class CKEditorComponent extends HTMLElement {
    * @throws {Error} When initialization fails
    */
   async #initializeEditor(editablesOrContent) {
+    await Promise.all([
+      this.#ensureStylesheetsInjected(),
+      this.#ensureWindowScriptsInjected(),
+    ]);
     const Editor = await this.#getEditorConstructor();
     const [plugins, translations] = await Promise.all([
       this.#getPlugins(),
@@ -550,6 +558,30 @@ class CKEditorComponent extends HTMLElement {
     });
   }
+  /**
+   * Gets bundle JSON description from translations attribute
+   */
+  #getBundle() {
+    return this.#bundle ||= JSON.parse(this.getAttribute('bundle'));
+  }
+  /**
+   * Checks if all required stylesheets are injected. If not, inject.
+   */
+  async #ensureStylesheetsInjected() {
+    await loadAsyncCSS(this.#getBundle().stylesheets || []);
+  }
+  /**
+   * Checks if all required scripts are injected. If not, inject.
+   */
+  async #ensureWindowScriptsInjected() {
+    const windowScripts = (this.#getBundle().scripts || []).filter(script => !!script.window_name);
+    await loadAsyncImports(windowScripts);
+  }
   /**
    * Loads translation modules
    *
@@ -557,8 +589,9 @@ class CKEditorComponent extends HTMLElement {
    * @returns {Promise<Array<any>>}
    */
   async #getTranslations() {
-    const raw = this.getAttribute('translations');
-    return loadAsyncImports(raw ? JSON.parse(raw) : []);
+    const translations = this.#getBundle().scripts.filter(script => script.translation);
+    return loadAsyncImports(translations);
   }
   /**

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

@@ -44,13 +44,21 @@ function loadAsyncImports(imports = []) {
     return module.default;
   };
-  const loadExternalPlugin = async ({ import_name, import_as, window_name, stylesheets }) => {
+  const loadExternalPlugin = async ({ url, import_name, import_as, window_name, stylesheets }) => {
     if (stylesheets?.length) {
       await loadAsyncCSS(stylesheets);
     }
     if (window_name) {
-      if (!Object.prototype.hasOwnProperty.call(window, window_name)) {
+      function isScriptPresent() {
+        return Object.prototype.hasOwnProperty.call(window, window_name);
+      }
+      if (url && !isScriptPresent()) {
+        await injectScript(url);
+      }
+      if (!isScriptPresent()) {
         throw new Error(
           `Plugin window['${window_name}'] not found in global scope. ` +
           'Please ensure the plugin is loaded before CKEditor initialization.'
@@ -129,6 +137,32 @@ function loadAsyncCSS(stylesheets = []) {
   return Promise.all(promises);
 }
+const SCRIPT_LOAD_PROMISES = new Map();
+/**
+ * Dynamically loads script files based on configuration.
+ * Uses caching to avoid loading the same script multiple times.
+ *
+ * @param {string} url - URL of the script to load
+ */
+function injectScript(url) {
+  if (SCRIPT_LOAD_PROMISES.has(url)) {
+    return SCRIPT_LOAD_PROMISES.get(url);
+  }
+  const promise = new Promise((resolve, reject) => {
+    const script = document.createElement('script');
+    script.src = url;
+    script.onload = resolve;
+    script.onerror = reject;
+    document.head.appendChild(script);
+  });
+  SCRIPT_LOAD_PROMISES.set(url, promise);
+  return promise;
+}
 /**
  * Checks if a key is safe to use in configuration objects to prevent prototype pollution
  *

data/lib/ckeditor5/rails/cdn/concerns/bundle_builder.rb ADDED Viewed

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+module CKEditor5::Rails
+  module Cdn::Concerns
+    module BundleBuilder
+      def create_preset_bundle(preset)
+        preset => {
+          cdn:,
+          version:,
+          translations:,
+          ckbox:,
+          premium:
+        }
+        bundle = build_base_cdn_bundle(cdn, version, translations)
+        bundle << build_premium_cdn_bundle(cdn, version, translations) if premium
+        bundle << build_ckbox_cdn_bundle(ckbox) if ckbox
+        bundle << build_plugins_cdn_bundle(preset.plugins.items)
+        bundle
+      end
+      private
+      def build_base_cdn_bundle(cdn, version, translations)
+        Cdn::CKEditorBundle.new(
+          Semver.new(version),
+          'ckeditor5',
+          translations: translations,
+          cdn: cdn
+        )
+      end
+      def build_premium_cdn_bundle(cdn, version, translations)
+        Cdn::CKEditorBundle.new(
+          Semver.new(version),
+          'ckeditor5-premium-features',
+          translations: translations,
+          cdn: cdn
+        )
+      end
+      def build_ckbox_cdn_bundle(ckbox)
+        Cdn::CKBoxBundle.new(
+          Semver.new(ckbox[:version]),
+          theme: ckbox[:theme] || :lark,
+          cdn: ckbox[:cdn] || :ckbox
+        )
+      end
+      def build_plugins_cdn_bundle(plugins)
+        plugins.each_with_object(Assets::AssetsBundle.new(scripts: [], stylesheets: [])) do |plugin, bundle|
+          bundle << plugin.preload_assets_bundle if plugin.preload_assets_bundle.present?
+        end
+      end
+    end
+  end
+end

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

@@ -9,9 +9,13 @@ require_relative '../assets/assets_bundle_html_serializer'
 require_relative 'url_generator'
 require_relative 'ckeditor_bundle'
 require_relative 'ckbox_bundle'
+require_relative 'concerns/bundle_builder'
 module CKEditor5::Rails
   module Cdn::Helpers
+    include Cdn::Concerns::BundleBuilder
+    include ActionView::Helpers::TagHelper
     class ImportmapAlreadyRenderedError < ArgumentError; end
     # The `ckeditor5_assets` helper includes CKEditor 5 assets in your application.
@@ -28,6 +32,8 @@ module CKEditor5::Rails
     #   - license_key: Commercial license key
     #   - premium: Enable premium features
     #   - language: Set editor UI language (e.g. :pl, :es)
+    #   - lazy: Enable lazy loading of dependencies (slower but useful for async partials)
+    #   - importmap: Whether to use importmap for dependencies (default: true)
     #
     # @example Basic usage with default preset
     #   <%= ckeditor5_assets %>
@@ -60,34 +66,63 @@ module CKEditor5::Rails
     def ckeditor5_assets(
       preset: :default,
       importmap: true,
+      lazy: false,
       **kwargs
     )
       ensure_importmap_not_rendered!
       mapped_preset = merge_with_editor_preset(preset, **kwargs)
-      mapped_preset => {
-        cdn:,
-        version:,
-        translations:,
-        ckbox:,
-        license_key:,
-        premium:
-      }
-      bundle = build_base_cdn_bundle(cdn, version, translations)
-      bundle << build_premium_cdn_bundle(cdn, version, translations) if premium
-      bundle << build_ckbox_cdn_bundle(ckbox) if ckbox
-      bundle << build_plugins_cdn_bundle(mapped_preset.plugins.items)
+      bundle = create_preset_bundle(mapped_preset)
       @__ckeditor_context = {
-        license_key: license_key,
+        license_key: mapped_preset.license_key,
         bundle: bundle,
         preset: mapped_preset
       }
-      build_html_tags(bundle, importmap)
+      build_assets_html_tags(bundle, importmap: importmap, lazy: lazy)
     end
+    # Helper for dynamically loading CKEditor assets when working with Turbo/Stimulus.
+    # Adds importmap containing imports from all presets and includes only web component
+    # initialization code. Useful when dynamically adding editors to the page with
+    # unknown preset configuration.
+    #
+    # @note Do not use this helper if ckeditor5_assets is already included on the page
+    #       as it will cause duplicate imports.
+    #
+    # @example With Turbo/Stimulus dynamic editor loading
+    #   <%= ckeditor5_lazy_javascript_tags %>
+    #
+    def ckeditor5_lazy_javascript_tags
+      ensure_importmap_not_rendered!
+      if importmap_available?
+        @__ckeditor_context = {
+          bundle: combined_bundle
+        }
+        return Assets::WebComponentBundle.instance.to_html
+      end
+      safe_join([
+                  Assets::AssetsImportMap.new(combined_bundle).to_html,
+                  Assets::WebComponentBundle.instance.to_html
+                ])
+    end
+    # Dynamically generates helper methods for each third-party CDN provider.
+    # These methods are shortcuts for including CKEditor assets from specific CDNs.
+    # Generated methods follow the pattern: ckeditor5_<cdn>_assets
+    #
+    # @example Using JSDelivr CDN
+    #   <%= ckeditor5_jsdelivr_assets %>
+    #
+    # @example Using UNPKG CDN with version
+    #   <%= ckeditor5_unpkg_assets version: '34.1.0' %>
+    #
+    # @example Using JSDelivr CDN with custom options
+    #   <%= ckeditor5_jsdelivr_assets preset: :custom, translations: [:pl] %>
     Cdn::UrlGenerator::CDN_THIRD_PARTY_GENERATORS.each_key do |key|
       define_method(:"ckeditor5_#{key.to_s.parameterize}_assets") do |**kwargs|
         ckeditor5_assets(**kwargs.merge(cdn: key))
@@ -96,15 +131,18 @@ module CKEditor5::Rails
     private
-    def merge_with_editor_preset(preset, language: nil, **kwargs)
-      found_preset = Engine.find_preset(preset)
+    def combined_bundle
+      acc = Assets::AssetsBundle.new(scripts: [], stylesheets: [])
-      if found_preset.blank?
-        raise ArgumentError,
-              "Poor thing. You forgot to define your #{preset} preset. " \
-              'Please define it in initializer. Thank you!'
+      Engine.presets.to_h.values.each_with_object(acc) do |preset, bundle|
+        bundle << create_preset_bundle(preset)
       end
+      acc
+    end
+    def merge_with_editor_preset(preset, language: nil, **kwargs)
+      found_preset = Engine.find_preset!(preset)
       new_preset = found_preset.clone.merge_with_hash!(**kwargs)
       # Assign default language if not present
@@ -125,38 +163,6 @@ module CKEditor5::Rails
       new_preset
     end
-    def build_base_cdn_bundle(cdn, version, translations)
-      Cdn::CKEditorBundle.new(
-        Semver.new(version),
-        'ckeditor5',
-        translations: translations,
-        cdn: cdn
-      )
-    end
-    def build_premium_cdn_bundle(cdn, version, translations)
-      Cdn::CKEditorBundle.new(
-        Semver.new(version),
-        'ckeditor5-premium-features',
-        translations: translations,
-        cdn: cdn
-      )
-    end
-    def build_ckbox_cdn_bundle(ckbox)
-      Cdn::CKBoxBundle.new(
-        Semver.new(ckbox[:version]),
-        theme: ckbox[:theme] || :lark,
-        cdn: ckbox[:cdn] || :ckbox
-      )
-    end
-    def build_plugins_cdn_bundle(plugins)
-      plugins.each_with_object(Assets::AssetsBundle.new(scripts: [], stylesheets: [])) do |plugin, bundle|
-        bundle << plugin.preload_assets_bundle if plugin.preload_assets_bundle.present?
-      end
-    end
     def importmap_available?
       respond_to?(:importmap_rendered?)
     end
@@ -169,10 +175,11 @@ module CKEditor5::Rails
             'Please move ckeditor5_assets helper before javascript_importmap_tags in your layout.'
     end
-    def build_html_tags(bundle, importmap)
+    def build_assets_html_tags(bundle, importmap:, lazy: nil)
       serializer = Assets::AssetsBundleHtmlSerializer.new(
         bundle,
-        importmap: importmap && !importmap_available?
+        importmap: importmap && !importmap_available?,
+        lazy: lazy
       )
       html = serializer.to_html

data/lib/ckeditor5/rails/editor/helpers/editor_helpers.rb CHANGED Viewed

@@ -7,9 +7,7 @@ require_relative 'config_helpers'
 module CKEditor5::Rails
   module Editor::Helpers::Editor
     include Editor::Helpers::Config
-    class EditorContextError < StandardError; end
-    class PresetNotFoundError < ArgumentError; end
+    include Cdn::Concerns::BundleBuilder
     # Creates a CKEditor 5 editor instance in the view.
     #
@@ -67,17 +65,22 @@ module CKEditor5::Rails
     )
       validate_editor_input!(initial_data, block)
-      controller_context = validate_and_get_editor_context!
+      context = ckeditor5_context_or_fallback(preset)
-      preset = find_preset(preset || controller_context[:preset] || :default)
+      preset = Engine.find_preset!(preset || context[:preset] || :default)
       config = build_editor_config(preset, config, extra_config, initial_data)
       type ||= preset.type
+      # Add some fallbacks
+      config[:licenseKey] ||= context[:license_key]
+      config[:language] = { ui: language } if language
       editor_props = Editor::Props.new(
-        controller_context, type, config,
+        type, config,
+        bundle: context[:bundle],
         watchdog: watchdog,
-        editable_height: editable_height,
-        language: language
+        editable_height: editable_height || preset.editable_height
       )
       tag_attributes = html_attributes.merge(editor_props.to_attributes)
@@ -148,19 +151,22 @@ module CKEditor5::Rails
       editor_config
     end
-    def validate_and_get_editor_context!
-      unless defined?(@__ckeditor_context)
-        raise EditorContextError,
-              'CKEditor installation context is not defined. ' \
-              'Ensure ckeditor5_assets is called in the head section.'
-      end
+    def ckeditor5_context_or_fallback(preset)
+      return @__ckeditor_context if @__ckeditor_context.present?
-      @__ckeditor_context
-    end
+      if preset.present?
+        found_preset = Engine.find_preset(preset)
+        return {
+          bundle: create_preset_bundle(found_preset),
+          preset: found_preset
+        }
+      end
-    def find_preset(preset)
-      Engine.find_preset(preset) or
-        raise PresetNotFoundError, "Preset #{preset} is not defined."
+      {
+        bundle: nil,
+        preset: Engine.default_preset
+      }
     end
   end
 end