ckeditor5 1.1.7 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a512b289e611ca5d7480b5088b14f83ed459481b6f99f0c15b4467e627c464e7
-  data.tar.gz: dc3969b71fd184b7e9bc39a95fc7d0702280203c940197925d8e8f8d17d22a50
+  metadata.gz: '028a09c0049e3eb489434b0447796369924801d0f5273a400e9783dbd3a8a70c'
+  data.tar.gz: e9a3c65f03a85b1361b612c85b00c5cb9d1d8385eeca716c5cea4f0e5817474b
 SHA512:
-  metadata.gz: d3491c052e7e736f1ed484a67eaf7fae034fd73874977c4bcfd671295e5fe5d9673d7c27845df6877fb527a4a29763ad3529c58e30fcee893f8a174fe066ac84
-  data.tar.gz: e579d1032b12e79d265da252ad74af5b090922aeb0eb4d68ab12c252d9ed173ec9b1f5e4cc904f4fcc62c4dbc0cb20b4b79ae87ee9cfff40afc33b1497caf464
+  metadata.gz: 5bf454b35f45aca3a44a2463d007cea579714c835d82edf7e6ed351db3c93a94aff59489bab7cea69cd78853acf50473ad9f7cf64819ee5c3c5bc5c0ef2d20a8
+  data.tar.gz: e394db6e299f6a48c88f50a306500bcae7c87c0eae6092bdf44c7f62e4a179da542f7299448db18045c086047da16a5818f3915416d9b10bb00747bda9e431ce

data/README.md

@@ -75,6 +75,7 @@ Voilà! You have CKEditor 5 integrated with your Rails application. 🎉
     - [Commercial usage 💰](#commercial-usage-)
   - [Editor placement 🏗️](#editor-placement-️)
     - [Setting Initial Content 📝](#setting-initial-content-)
+    - [Watchdog 🐕](#watchdog-)
     - [Classic editor 📝](#classic-editor-)
     - [Multiroot editor 🌳](#multiroot-editor-)
     - [Inline editor 📝](#inline-editor-)
@@ -490,7 +491,7 @@ If you want to use CKEditor 5 under the GPL license, you can include the assets
 <!-- app/views/demos/index.html.erb -->
 
 <% content_for :head do %>
-  <%= ckeditor5_assets %>
+  <%= ckeditor5_assets version: '43.3.0' %>
 <% end %>
 ```
 
@@ -562,9 +563,6 @@ end
 
 ### Commercial usage 💰
 
-<details>
-  <summary>Expand to show more</summary>
-
 If you want to use CKEditor 5 under a commercial license, you can include the assets using the `ckeditor5_assets` helper method with the `license_key` keyword argument. The example below shows how to include the assets for the commercial license:
 
 ```erb
@@ -577,8 +575,6 @@ If you want to use CKEditor 5 under a commercial license, you can include the as
 
 In this scenario, the assets are included from the official CKEditor 5 CDN which is more reliable and provides better performance, especially for commercial usage.
 
-</details>
-
 ## Editor placement 🏗️
 
 The `ckeditor5_editor` helper renders CKEditor 5 instances in your views. Before using it, ensure you've included the necessary assets in your page's head section otherwise the editor won't work as there are no CKEditor 5 JavaScript and CSS files loaded.
@@ -605,6 +601,18 @@ The example below shows how to set the initial content of the editor using the `
 <% end %>
 ```
 
+### Watchdog 🐕
+
+CKEditor 5 uses a watchdog utility to protect you from data loss in case the editor crashes. It saves your content just before the crash and creates a new instance of the editor with your content intact. It's enabled by default in the gem.
+
+If you want to disable the watchdog, you can pass the `watchdog` keyword argument with the value `false`:
+
+```erb
+<!-- app/views/demos/index.html.erb -->
+
+<%= ckeditor5_editor watchdog: false %>
+```
+
 ### Classic editor 📝
 
 The classic editor is the most common type of editor. It provides a toolbar with various formatting options like bold, italic, underline, and link.
@@ -741,6 +749,8 @@ Decoupled editor is a variant of classic editor that allows you to separate the
 If you want to use a decoupled editor, you can pass the `type` keyword argument with the value `:decoupled`:
 
 ```erb
+<!-- app/views/demos/index.html.erb -->
+
 <% content_for :head do %>
   <%= ckeditor5_assets %>
 <% end %>

data/lib/ckeditor5/rails/assets/webcomponent.mjs

@@ -45,6 +45,9 @@ class CKEditorComponent extends HTMLElement {
   /** @type {Promise<import('ckeditor5').Editor>|null} Promise to initialize editor instance */
   instancePromise = Promise.withResolvers();
 
+  /** @type {import('ckeditor5').Watchdog|null} Editor watchdog */
+  watchdog = null;
+
   /** @type {import('ckeditor5').Editor|null} Current editor instance */
   instance = null;
 
@@ -93,6 +96,7 @@ class CKEditorComponent extends HTMLElement {
   async disconnectedCallback() {
     try {
       await this.instance?.destroy();
+      await this.watchdog?.destroy();
     } catch (error) {
       console.error('Failed to destroy editor:', error);
     }
@@ -129,10 +133,11 @@ class CKEditorComponent extends HTMLElement {
   }
 
   /**
-   * Initializes a new CKEditor instance
+   * Creates a new CKEditor instance
+   *
    * @private
    * @param {Record<string, HTMLElement>|CKEditorMultiRootEditablesTracker} editablesOrContent - Editable or content
-   * @returns {Promise<import('ckeditor5').Editor>} Initialized editor instance
+   * @returns {Promise<{ editor: import('ckeditor5').Editor, watchdog: editor: import('ckeditor5').EditorWatchdog }>} Initialized editor instance
    * @throws {Error} When initialization fails
    */
   async #initializeEditor(editablesOrContent) {
@@ -142,6 +147,9 @@ class CKEditorComponent extends HTMLElement {
       this.#getTranslations()
     ]);
 
+    // Depending on the type of the editor the content supplied on the first
+    // argument is different. For ClassicEditor it's a element or string, for MultiRootEditor
+    // it's an object with editables, for DecoupledEditor it's string.
     let content = editablesOrContent;
 
     if (editablesOrContent instanceof CKEditorMultiRootEditablesTracker) {
@@ -158,13 +166,29 @@ class CKEditorComponent extends HTMLElement {
       plugins,
     };
 
-    console.warn('Initializing CKEditor with config:', config);
+    console.warn('Initializing CKEditor with:', { config, watchdog: this.hasWatchdog() });
+
+    // Initialize watchdog if needed
+    let watchdog = null;
+    let instance = null;
 
-    const instance = await Editor.create(content, config);
+    if (this.hasWatchdog()) {
+      const { EditorWatchdog } = await import('ckeditor5');
+      const watchdog = new EditorWatchdog(Editor);
+
+      await watchdog.create(content, config);
+
+      instance = watchdog.editor;
+    } else {
+      instance = await Editor.create(content, config);
+    }
 
     this.dispatchEvent(new CustomEvent('editor-ready', { detail: instance }));
 
-    return instance;
+    return {
+      instance,
+      watchdog,
+    };
   }
 
   /**
@@ -198,7 +222,11 @@ class CKEditorComponent extends HTMLElement {
     }
 
     try {
-      this.instance = await this.#initializeEditor(this.editables || this.#getConfig().initialData || '');
+      const { watchdog, instance } = await this.#initializeEditor(this.editables || this.#getConfig().initialData || '');
+
+      this.watchdog = watchdog;
+      this.instance = instance;
+
       this.#setupContentSync();
 
       this.instancePromise.resolve(this.instance);
@@ -228,6 +256,16 @@ class CKEditorComponent extends HTMLElement {
     return this.getAttribute('type') === 'DecoupledEditor';
   }
 
+  /**
+   * Checks if current editor has watchdog enabled
+   *
+   * @private
+   * @returns {boolean}
+   */
+  hasWatchdog() {
+    return this.getAttribute('watchdog') === 'true';
+  }
+
   /**
    * Parses editor configuration from config attribute
    *

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

@@ -9,13 +9,13 @@ module CKEditor5::Rails
     class EditorContextError < StandardError; end
     class PresetNotFoundError < ArgumentError; end
 
-    def ckeditor5_editor(
+    def ckeditor5_editor( # rubocop:disable Metrics/ParameterLists
       config: nil, extra_config: {},
       type: nil, preset: :default,
-      initial_data: nil,
+      initial_data: nil, watchdog: true,
       **html_attributes, &block
     )
-      context = validate_and_get_editor_context!
+      controller_context = validate_and_get_editor_context!
       preset = fetch_editor_preset(preset)
 
       config ||= preset.config
@@ -26,10 +26,9 @@ module CKEditor5::Rails
 
       raise ArgumentError, 'Cannot pass initial data and block at the same time.' if initial_data && block
 
-      editor_props = build_editor_props(
-        config: config,
-        type: type,
-        context: context
+      editor_props = Editor::Props.new(
+        controller_context, type, config,
+        watchdog: watchdog
       )
 
       render_editor_component(editor_props, html_attributes, &block)
@@ -68,10 +67,6 @@ module CKEditor5::Rails
         raise PresetNotFoundError, "Preset #{preset} is not defined."
     end
 
-    def build_editor_props(config:, type:, context:)
-      Editor::Props.new(context, type, config)
-    end
-
     def render_editor_component(props, html_attributes, &block)
       tag.send(:'ckeditor-component', **props.to_attributes, **html_attributes, &block)
     end

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

@@ -12,10 +12,11 @@ module CKEditor5::Rails::Editor
       multiroot: 'MultiRootEditor'
     }.freeze
 
-    def initialize(context, type, config)
+    def initialize(controller_context, type, config, watchdog: true)
       raise ArgumentError, "Invalid editor type: #{type}" unless Props.valid_editor_type?(type)
 
-      @context = context
+      @controller_context = controller_context
+      @watchdog = watchdog
       @type = type
       @config = config
     end
@@ -33,18 +34,19 @@ module CKEditor5::Rails::Editor
 
     private
 
-    attr_reader :context, :type, :config
+    attr_reader :controller_context, :watchdog, :type, :config
 
     def serialized_attributes
       {
         translations: serialize_translations,
         plugins: serialize_plugins,
-        config: serialize_config
+        config: serialize_config,
+        watchdog: watchdog
       }
     end
 
     def serialize_translations
-      context[:bundle].translations_scripts.map(&:to_h).to_json
+      controller_context[:bundle].translations_scripts.map(&:to_h).to_json
     end
 
     def serialize_plugins
@@ -54,7 +56,7 @@ module CKEditor5::Rails::Editor
     def serialize_config
       config
         .except(:plugins)
-        .tap { |cfg| cfg[:licenseKey] = context[:license_key] if context[:license_key] }
+        .tap { |cfg| cfg[:licenseKey] = controller_context[:license_key] if controller_context[:license_key] }
         .to_json
     end
   end

data/lib/ckeditor5/rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CKEditor5::Rails
-  VERSION = '1.1.7'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.2.0
 platform: ruby
 authors:
 - Mateusz Bagiński