ckeditor5 1.8.0 → 1.10.0

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

@@ -0,0 +1,155 @@
+/**
+ * Executes callback when DOM is ready
+ *
+ * @param {() => void} callback - Function to execute when DOM is ready
+ */
+function execIfDOMReady(callback) {
+  switch (document.readyState) {
+    case 'loading':
+      document.addEventListener('DOMContentLoaded', callback, { once: true });
+      break;
+
+    case 'interactive':
+    case 'complete':
+      setTimeout(callback, 0);
+      break;
+
+    default:
+      console.warn('Unexpected document.readyState:', document.readyState);
+      setTimeout(callback, 0);
+  }
+}
+
+/**
+ * Dynamically imports modules based on configuration
+ *
+ * @param {Array<Object>} imports - Array of import configurations
+ * @param {Object} imports[].name - Name of inline plugin (for inline type)
+ * @param {Object} imports[].code - Source code of inline plugin (for inline type)
+ * @param {Object} imports[].import_name - Module path to import (for external type)
+ * @param {Object} imports[].import_as - Name to import as (for external type)
+ * @param {Object} imports[].window_name - Global window object name (for external type)
+ * @param {('inline'|'external')} imports[].type - Type of import
+ * @returns {Promise<Array<any>>} Array of loaded modules
+ * @throws {Error} When plugin loading fails
+ */
+function loadAsyncImports(imports = []) {
+  const loadInlinePlugin = async ({ name, code }) => {
+    const module = await import(`data:text/javascript,${encodeURIComponent(code)}`);
+
+    if (!module.default) {
+      throw new Error(`Inline plugin "${name}" must export a default class/function!`);
+    }
+
+    return module.default;
+  };
+
+  const loadExternalPlugin = async ({ import_name, import_as, window_name }) => {
+    if (window_name) {
+      if (!Object.prototype.hasOwnProperty.call(window, window_name)) {
+        throw new Error(
+          `Plugin window['${window_name}'] not found in global scope. ` +
+          'Please ensure the plugin is loaded before CKEditor initialization.'
+        );
+      }
+
+      return window[window_name];
+    }
+
+    const module = await import(import_name);
+    const imported = module[import_as || 'default'];
+
+    if (!imported) {
+      throw new Error(`Plugin "${import_as}" not found in the ESM module "${import_name}"!`);
+    }
+
+    return imported;
+  };
+
+  return Promise.all(imports.map(item => {
+    switch(item.type) {
+      case 'inline':
+        return loadInlinePlugin(item);
+
+      case 'external':
+      default:
+        return loadExternalPlugin(item);
+    }
+  }));
+}
+
+/**
+ * Checks if a key is safe to use in configuration objects to prevent prototype pollution
+ *
+ * @param {string} key - Key name to check
+ * @returns {boolean} True if key is safe to use
+ */
+function isSafeKey(key) {
+  return typeof key === 'string' &&
+          key !== '__proto__' &&
+          key !== 'constructor' &&
+          key !== 'prototype';
+}
+
+/**
+ * Resolves element references in configuration object.
+ * Looks for objects with { $element: "selector" } format and replaces them with actual DOM elements.
+ *
+ * @param {Object} obj - Configuration object to process
+ * @returns {Object} Processed configuration object with resolved element references
+ * @throws {Error} When element reference is invalid
+ */
+function resolveElementReferences(obj) {
+  if (!obj || typeof obj !== 'object') {
+    return obj;
+  }
+
+  if (Array.isArray(obj)) {
+    return obj.map(item => resolveElementReferences(item));
+  }
+
+  const result = Object.create(null);
+
+  for (const key of Object.getOwnPropertyNames(obj)) {
+    if (!isSafeKey(key)) {
+      console.warn(`Suspicious key "${key}" detected in config, skipping`);
+      continue;
+    }
+
+    const value = obj[key];
+
+    if (value && typeof value === 'object') {
+      if (value.$element) {
+        const selector = value.$element;
+
+        if (typeof selector !== 'string') {
+          console.warn(`Invalid selector type for "${key}", expected string`);
+          continue;
+        }
+
+        const element = document.querySelector(selector);
+
+        if (!element) {
+          console.warn(`Element not found for selector: ${selector}`);
+        }
+
+        result[key] = element || null;
+      } else {
+        result[key] = resolveElementReferences(value);
+      }
+    } else {
+      result[key] = value;
+    }
+  }
+
+  return result;
+}
+
+/**
+ * Generates a unique identifier string
+ *
+ * @returns {string} Random string that can be used as unique identifier
+ */
+function uid() {
+  return Math.random().toString(36).substring(2);
+}

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

@@ -6,7 +6,7 @@ require_relative 'ckbox_bundle'
 
 module CKEditor5::Rails
   module Cdn::Helpers
-    def ckeditor5_cdn_assets(preset: :default, **kwargs)
+    def ckeditor5_assets(preset: :default, **kwargs)
       merge_with_editor_preset(preset, **kwargs) => {
         cdn:,
         version:,
@@ -32,15 +32,7 @@ module CKEditor5::Rails
 
     Cdn::UrlGenerator::CDN_THIRD_PARTY_GENERATORS.each_key do |key|
       define_method(:"ckeditor5_#{key.to_s.parameterize}_assets") do |**kwargs|
-        ckeditor5_cdn_assets(**kwargs.merge(cdn: key))
-      end
-    end
-
-    def ckeditor5_assets(**kwargs)
-      if kwargs[:license_key] && kwargs[:license_key] != 'GPL'
-        ckeditor5_cloud_assets(**kwargs)
-      else
-        ckeditor5_cdn_assets(**kwargs.merge(cdn: Engine.default_preset.cdn))
+        ckeditor5_assets(**kwargs.merge(cdn: key))
       end
     end
 
@@ -62,7 +54,7 @@ module CKEditor5::Rails
 
         raise ArgumentError,
               "Poor thing. You forgot to define #{key}. Make sure you passed `#{key}:` parameter to " \
-              "`ckeditor5_cdn_assets` or defined default one in your `#{preset}` preset!"
+              "`ckeditor5_assets` or defined default one in your `#{preset}` preset!"
       end
 
       hash

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'props'
+
+module CKEditor5::Rails::Context
+  module Helpers
+    def ckeditor5_context(**config, &block)
+      context_props = Props.new(config)
+
+      tag.send(:'ckeditor-context-component', **context_props.to_attributes, &block)
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module CKEditor5::Rails
+  module Context
+    class Props
+      def initialize(config)
+        @config = config
+      end
+
+      def to_attributes
+        {
+          plugins: serialize_plugins,
+          config: serialize_config
+        }
+      end
+
+      private
+
+      attr_reader :config
+
+      def serialize_plugins
+        (config[:plugins] || []).map { |plugin| Editor::PropsPlugin.normalize(plugin).to_h }.to_json
+      end
+
+      def serialize_config
+        config.except(:plugins).to_json
+      end
+    end
+  end
+end

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

@@ -29,16 +29,13 @@ module CKEditor5::Rails
       type ||= preset.type
 
       validated_height = validate_editable_height(type, editable_height) || preset.editable_height
-      editor_props = Editor::Props.new(
-        controller_context, type, config,
-        watchdog: watchdog
-      )
-
-      render_editor_component(
-        editor_props,
-        html_attributes.merge(validated_height ? { 'editable-height' => validated_height } : {}),
-        &block
-      )
+      editor_props = Editor::Props.new(controller_context, type, config, watchdog: watchdog)
+
+      tag_attributes = html_attributes
+                       .merge(editor_props.to_attributes)
+                       .merge(validated_height ? { 'editable-height' => validated_height } : {})
+
+      tag.send(:'ckeditor-component', **tag_attributes, &block)
     end
 
     def ckeditor5_editable(name = nil, **kwargs, &block)
@@ -91,10 +88,6 @@ module CKEditor5::Rails
         raise PresetNotFoundError, "Preset #{preset} is not defined."
     end
 
-    def render_editor_component(props, html_attributes, &block)
-      tag.send(:'ckeditor-component', **props.to_attributes, **html_attributes, &block)
-    end
-
     def validate_editable_height(type, height)
       return nil if height.nil?
 

data/lib/ckeditor5/rails/helpers.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 require_relative 'cdn/helpers'
-require_relative 'cloud/helpers'
 require_relative 'editor/helpers'
+require_relative 'context/helpers'
 
 module CKEditor5::Rails
   module Helpers
     include Cdn::Helpers
-    include Cloud::Helpers
     include Editor::Helpers
+    include Context::Helpers
   end
 end

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

@@ -22,6 +22,18 @@ module CKEditor5::Rails
         }
       end
 
+      def premium?
+        @premium
+      end
+
+      def gpl?
+        license_key == 'GPL'
+      end
+
+      def menubar?
+        @config.dig(:menuBar, :isVisible) || false
+      end
+
       def to_h_with_overrides(**overrides)
         {
           version: overrides.fetch(:version, version),
@@ -51,6 +63,8 @@ module CKEditor5::Rails
         return @license_key if license_key.nil?
 
         @license_key = license_key
+
+        cdn(:cloud) unless gpl?
       end
 
       def gpl
@@ -134,7 +148,9 @@ module CKEditor5::Rails
         names.each { |name| plugin(name, **kwargs) }
       end
 
-      def language(ui, content: ui) # rubocop:disable Naming/MethodParameterName
+      def language(ui = nil, content: ui) # rubocop:disable Naming/MethodParameterName
+        return @config[:language] if ui.nil?
+
         @config[:language] = {
           ui: ui,
           content: content

data/lib/ckeditor5/rails/version.rb

@@ -2,6 +2,6 @@
 
 module CKEditor5
   module Rails
-    VERSION = '1.8.0'
+    VERSION = '1.10.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-14 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,12 +45,18 @@ files:
 - lib/ckeditor5/rails.rb
 - lib/ckeditor5/rails/assets/assets_bundle.rb
 - lib/ckeditor5/rails/assets/assets_bundle_html_serializer.rb
-- lib/ckeditor5/rails/assets/webcomponent.mjs
+- lib/ckeditor5/rails/assets/webcomponent_bundle.rb
+- lib/ckeditor5/rails/assets/webcomponents/components/context.mjs
+- lib/ckeditor5/rails/assets/webcomponents/components/editable.mjs
+- lib/ckeditor5/rails/assets/webcomponents/components/editor.mjs
+- lib/ckeditor5/rails/assets/webcomponents/components/ui-part.mjs
+- lib/ckeditor5/rails/assets/webcomponents/utils.mjs
 - lib/ckeditor5/rails/cdn/ckbox_bundle.rb
 - lib/ckeditor5/rails/cdn/ckeditor_bundle.rb
 - lib/ckeditor5/rails/cdn/helpers.rb
 - lib/ckeditor5/rails/cdn/url_generator.rb
-- lib/ckeditor5/rails/cloud/helpers.rb
+- lib/ckeditor5/rails/context/helpers.rb
+- lib/ckeditor5/rails/context/props.rb
 - lib/ckeditor5/rails/editor/config_helpers.rb
 - lib/ckeditor5/rails/editor/helpers.rb
 - lib/ckeditor5/rails/editor/props.rb

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

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module CKEditor5::Rails
-  module Cloud
-    module Helpers
-      def ckeditor5_cloud_assets(license_key:, **kwargs)
-        raise 'Cloud assets are not permitted in GPL license!' if license_key == 'GPL'
-
-        ckeditor5_cdn_assets(cdn: :cloud, license_key: license_key, **kwargs)
-      end
-    end
-  end
-end