ckeditor5 1.11.1 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ff16eff85125b3b08d827a0dc6f25f85c84535ffdc37fada565a256e9a494c6
-  data.tar.gz: 505f43e893d3fa0119fd23365c83a01b729edbbc9236adcaa282c5e6a0791ac4
+  metadata.gz: 6b4d6c95733dd5744553bb787f20f9efaf474086c6268d6842561905747ec10f
+  data.tar.gz: 17052fae7a4e0e88fcc7c0af8ab397c8fadb3421ce611c64a10fe597d15a9d82
 SHA512:
-  metadata.gz: 7d93cdc48b6c6f8d10af216f4c0622dbd99ac08c82267ab6c3d5089f1a70395cda15b9ec345b097b40ae59b8611c492711fefc8b6a33d09a42110bf294077465
-  data.tar.gz: 60ea317d04dbc4305cf878925234b28eeb380e508f1991f9021be042e1d88d35ae11914947e1aeca088846b2cad91d2625b79cfb09dafe661fcd32b1e4080acf
+  metadata.gz: 4dbaefb77863ceaeaad0805d430c86b90c7fbec675a7478fc55994a9706bfc3b8ec59c7791ce916389346da508f47a88ce2ff8c38a79d1c9189aa77405769f9f
+  data.tar.gz: 6b1d599bbfe28b35c81d037b052085c15fe55c1248f8e858efc77b7515c88b5ea2818187082f0db7810192b7d2cdfd3bb45d3dba57f7cf03cd0f53932dfbb202

data/Gemfile

@@ -8,7 +8,9 @@ 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'
   gem 'rake', '~> 13.2', '>= 13.2.1'
   gem 'rspec', '~> 3.13'
@@ -17,6 +19,8 @@ group :development do
   gem 'rubocop', '~> 1.66', require: false
   gem 'rubocop-rails', '~> 2.26', '>= 2.26.2', require: false
   gem 'rubocop-rails-omakase', '~> 1.0.0', require: false
+  gem 'simplecov', '~> 0.21', '>= 0.21.2', require: false
+  gem 'simplecov_json_formatter', '~> 0.1.4', require: false
   gem 'simple_form', '~> 5.3', '>= 5.3.0'
   gem 'slim', '~> 5.2', '>= 5.2.0'
   gem 'sprockets-rails', '~> 3.2', '>= 3.2.2'

data/README.md

@@ -3,6 +3,7 @@
 [![License: GPL v2](https://img.shields.io/badge/License-GPL_v2-blue.svg?style=flat-square)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
 ![Gem Version](https://img.shields.io/gem/v/ckeditor5?style=flat-square)
 ![Gem Total Downloads](https://img.shields.io/gem/dt/ckeditor5?style=flat-square&color=orange)
+[![Coverage](https://img.shields.io/codecov/c/github/mati365/ckeditor5-rails?style=flat-square)](https://codecov.io/gh/mati365/ckeditor5-rails)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg?style=flat-square)](http://makeapullrequest.com)
 ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/mati365/ckeditor5-rails?style=flat-square)
 [![GitHub issues](https://img.shields.io/github/issues/mati365/ckeditor5-rails?style=flat-square)](https://github.com/Mati365/ckeditor5-rails/issues)
@@ -84,7 +85,10 @@ Voilà! You have CKEditor 5 integrated with your Rails application. 🎉
       - [`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)
+      - [`simple_upload_adapter(url)` method](#simple_upload_adapterurl-method)
+    - [Controller / View helpers 📦](#controller--view-helpers-)
       - [`ckeditor5_element_ref(selector)` method](#ckeditor5_element_refselector-method)
+      - [`ckeditor5_preset(&block)` method](#ckeditor5_presetblock-method)
   - [Including CKEditor 5 assets 📦](#including-ckeditor-5-assets-)
     - [Format 📝](#format-)
       - [Using default preset](#using-default-preset)
@@ -118,6 +122,7 @@ Voilà! You have CKEditor 5 integrated with your Rails application. 🎉
     - [`editor-change` event](#editor-change-event)
     - [Inline event handling](#inline-event-handling)
   - [Gem Development 🛠](#gem-development-)
+    - [Running tests 🧪](#running-tests-)
   - [Trademarks 📜](#trademarks-)
   - [License 📜](#license-)
 
@@ -327,7 +332,7 @@ Defines the CKBox plugin to be included in the editor. The example below shows h
 CKEditor5::Rails.configure do
   # ... other configuration
 
-  ckbox '2.5.4', theme: :lark
+  ckbox '2.6.0', theme: :lark
 end
 ```
 
@@ -530,6 +535,20 @@ CKEditor5::Rails.configure do
 end
 ```
 
+Methods such as `remove`, `append`, and `prepend` can be used to modify the plugins configuration. To remove a plugin, you can use the `remove` method with the plugin name as an argument:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... other configuration
+
+  plugins do
+    remove :Heading
+  end
+end
+```
+
 #### `inline_plugin(name, code)` method
 
 Use with caution as this is an inline definition of the plugin code, and you can define a custom class or function for the plugin here. The example below shows how to define a custom plugin that highlights the text:
@@ -556,6 +575,37 @@ CKEditor5::Rails.configure do
 end
 ```
 
+#### `simple_upload_adapter(url)` method
+
+Defines the URL for the simple upload adapter. The default endpoint is `/uploads` and the method is `POST`. The example below shows how to set the URL to `/uploads`:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... other configuration
+
+  simple_upload_adapter
+  # or: simple_upload_adapter '/uploads'
+end
+```
+
+Remember to remove the `Base64UploadAdapter` plugin from the plugins list if you want to use the simple upload adapter. It may cause issues.
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... other configuration
+
+  plugins do
+    remove :Base64UploadAdapter
+  end
+end
+```
+
+### Controller / View helpers 📦
+
 #### `ckeditor5_element_ref(selector)` method
 
 Defines a reference to a CKEditor 5 element. In other words, it allows you to reference DOM elements that will be used by the editor's features. It's particularly useful for features that need to check element presence or operate on specific DOM elements. The primary example is the `presence list` feature that requires a reference to the element that will be used to display the list.
@@ -572,6 +622,43 @@ CKEditor5::Rails.configure do
 end
 ```
 
+#### `ckeditor5_preset(&block)` method
+
+The `ckeditor5_preset` method allows you to define a custom preset in your application controller. It may be useful when you want to define a preset based on the current user or request.
+
+```rb
+# app/controllers/application_controller.rb
+
+class ApplicationController < ActionController::Base
+  def show
+    @preset = ckeditor5_preset do
+      version '43.3.0'
+
+      toolbar :sourceEditing, :|, :bold, :italic, :underline, :strikethrough,
+              :subscript, :superscript, :removeFormat, :|, :bulletedList, :numberedList,
+              :fontFamily, :fontSize, :|, :link, :anchor, :|,
+              :fontColor, :fontBackgroundColor
+
+      plugins :Essentials, :Paragraph, :Bold, :Italic, :Underline, :Strikethrough,
+              :Subscript, :Superscript, :RemoveFormat, :List, :Link, :Font,
+              :FontFamily, :FontSize, :FontColor, :FontBackgroundColor, :SourceEditing, :Essentials, :Paragraph
+    end
+  end
+end
+```
+
+In order to use the preset in the view, you can pass it to the `ckeditor5_assets` helper method:
+
+```erb
+<!-- app/views/demos/index.html.erb -->
+
+<% content_for :head do %>
+  <%= ckeditor5_assets preset: @preset %>
+<% end %>
+
+<%= ckeditor5_editor %>
+```
+
 ## Including CKEditor 5 assets 📦
 
 To include CKEditor 5 assets in your application, you can use the `ckeditor5_assets` helper method. This method takes the version of CKEditor 5 as an argument and includes the necessary resources of the editor. Depending on the specified configuration, it includes the JS and CSS assets from the official CKEditor 5 CDN or one of the popular CDNs.
@@ -1329,7 +1416,21 @@ If you want to contribute to the gem, you can clone the repository and run the f
 ```sh
 gem install bundler -v 2.5.22
 bundle install
-bundle exec guard
+bundle exec guard -g rails
+```
+
+### Running tests 🧪
+
+You can run the tests using the following command:
+
+```sh
+bundle exec rspec
+```
+
+If you want to watch the tests, you can use the following command:
+
+```sh
+bundle exec guard -g rspec
 ```
 
 ## Trademarks 📜

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

@@ -39,7 +39,7 @@ module CKEditor5::Rails
     private
 
     def merge_with_editor_preset(preset, **kwargs)
-      found_preset = Engine.base.presets[preset]
+      found_preset = Engine.find_preset(preset)
 
       if found_preset.blank?
         raise ArgumentError,

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CKEditor5::Rails
+  module Editor::Helpers::Config
+    def ckeditor5_element_ref(selector)
+      { '$element': selector }
+    end
+
+    def ckeditor5_preset(name = nil, &block)
+      return Engine.find_preset(name) if name
+
+      raise ArgumentError, 'Configuration block is required for preset definition' unless block_given?
+
+      CKEditor5::Rails::Presets::PresetBuilder.new(&block)
+    end
+  end
+end

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

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require_relative 'config_helpers'
+
+module CKEditor5::Rails
+  module Editor::Helpers::Editor
+    include Editor::Helpers::Config
+
+    class EditorContextError < StandardError; end
+    class PresetNotFoundError < ArgumentError; end
+    class InvalidEditableHeightError < ArgumentError; end
+
+    # Creates a CKEditor 5 editor instance
+    #
+    # @param preset [Symbol] High-level configuration preset that defines base editor setup,
+    #   including editor type, plugins, and default configuration
+    # @param config [Hash] Editor-specific configuration that overrides preset defaults
+    # @param extra_config [Hash] Additional configuration to be merged with the base config
+    # @param type [Symbol] Editor type (:classic, :inline, :balloon, :decoupled, :multiroot),
+    #   defaults to preset's type if not specified
+    # @param initial_data [String] Initial content for the editor
+    # @param watchdog [Boolean] Whether to enable the CKEditor watchdog feature
+    # @param editable_height [String, Integer] Height of the editable area (Classic editor only)
+    # @param html_attributes [Hash] Additional HTML attributes for the editor element
+    def ckeditor5_editor( # rubocop:disable Metrics/ParameterLists
+      preset: nil,
+      config: nil, extra_config: {}, type: nil,
+      initial_data: nil, watchdog: true,
+      editable_height: nil,
+      **html_attributes, &block
+    )
+      validate_editor_input!(initial_data, block)
+
+      controller_context = validate_and_get_editor_context!
+
+      preset = find_preset(preset || controller_context[:preset] || :default)
+      config = build_editor_config(preset, config, extra_config, initial_data)
+      type ||= preset.type
+
+      editor_props = Editor::Props.new(
+        controller_context, type, config,
+        watchdog: watchdog,
+        editable_height: editable_height
+      )
+
+      tag_attributes = html_attributes.merge(editor_props.to_attributes)
+
+      tag.send(:'ckeditor-component', **tag_attributes, &block)
+    end
+
+    def ckeditor5_editable(name = nil, **kwargs, &block)
+      tag.send(:'ckeditor-editable-component', name: name, **kwargs, &block)
+    end
+
+    def ckeditor5_ui_part(name, **kwargs, &block)
+      tag.send(:'ckeditor-ui-part-component', name: name, **kwargs, &block)
+    end
+
+    def ckeditor5_toolbar(**kwargs)
+      ckeditor5_ui_part('toolbar', **kwargs)
+    end
+
+    def ckeditor5_menubar(**kwargs)
+      ckeditor5_ui_part('menuBarView', **kwargs)
+    end
+
+    private
+
+    def validate_editor_input!(initial_data, block)
+      return unless initial_data && block
+
+      raise ArgumentError, 'Cannot pass initial data and block at the same time.'
+    end
+
+    def build_editor_config(preset, config, extra_config, initial_data)
+      editor_config = config || preset.config
+      editor_config = editor_config.deep_merge(extra_config)
+      editor_config[:initialData] = initial_data if initial_data
+      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
+
+      @__ckeditor_context
+    end
+
+    def find_preset(preset)
+      Engine.find_preset(preset) or
+        raise PresetNotFoundError, "Preset #{preset} is not defined."
+    end
+  end
+end

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

@@ -3,107 +3,9 @@
 require_relative 'props_plugin'
 require_relative 'props_inline_plugin'
 require_relative 'props'
-require_relative 'config_helpers'
 
-module CKEditor5::Rails
-  module Editor::Helpers
-    include Editor::ConfigHelpers
-
-    class EditorContextError < StandardError; end
-    class PresetNotFoundError < ArgumentError; end
-    class InvalidEditableHeightError < ArgumentError; end
-
-    def ckeditor5_editor( # rubocop:disable Metrics/ParameterLists
-      config: nil, extra_config: {},
-      type: nil, preset: nil,
-      initial_data: nil, watchdog: true,
-      editable_height: nil,
-      **html_attributes, &block
-    )
-      validate_editor_input!(initial_data, block)
-
-      controller_context = validate_and_get_editor_context!
-
-      preset = resolve_editor_preset(preset || controller_context[:preset])
-      config = build_editor_config(preset, config, extra_config, initial_data)
-      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)
-
-      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)
-      tag.send(:'ckeditor-editable-component', name: name, **kwargs, &block)
-    end
-
-    def ckeditor5_ui_part(name, **kwargs, &block)
-      tag.send(:'ckeditor-ui-part-component', name: name, **kwargs, &block)
-    end
-
-    def ckeditor5_toolbar(**kwargs)
-      ckeditor5_ui_part('toolbar', **kwargs)
-    end
-
-    def ckeditor5_menubar(**kwargs)
-      ckeditor5_ui_part('menuBarView', **kwargs)
-    end
-
-    private
-
-    def validate_editor_input!(initial_data, block)
-      return unless initial_data && block
-
-      raise ArgumentError, 'Cannot pass initial data and block at the same time.'
-    end
-
-    def resolve_editor_preset(preset_name)
-      fetch_editor_preset(preset_name || :default)
-    end
-
-    def build_editor_config(preset, config, extra_config, initial_data)
-      editor_config = config || preset.config
-      editor_config = editor_config.deep_merge(extra_config)
-      editor_config[:initialData] = initial_data if initial_data
-      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
-
-      @__ckeditor_context
-    end
-
-    def fetch_editor_preset(preset)
-      Engine.base.presets[preset] or
-        raise PresetNotFoundError, "Preset #{preset} is not defined."
-    end
-
-    def validate_editable_height(type, height)
-      return nil if height.nil?
-
-      unless type == :classic
-        raise InvalidEditableHeightError,
-              'editable_height can be used only with ClassicEditor'
-      end
-
-      case height
-      when String, /^\d+px$/ then height
-      when Integer, /^\d+$/ then "#{height}px"
-      else
-        raise InvalidEditableHeightError,
-              "editable_height must be an integer representing pixels or string ending with 'px'\n" \
-              "(e.g. 500 or '500px'). Got: #{height.inspect}"
-      end
-    end
-  end
+module CKEditor5::Rails::Editor::Helpers
 end
+
+require_relative 'helpers/config_helpers'
+require_relative 'helpers/editor_helpers'

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

@@ -12,13 +12,14 @@ module CKEditor5::Rails::Editor
       multiroot: 'MultiRootEditor'
     }.freeze
 
-    def initialize(controller_context, type, config, watchdog: true)
+    def initialize(controller_context, type, config, watchdog: true, editable_height: nil)
       raise ArgumentError, "Invalid editor type: #{type}" unless Props.valid_editor_type?(type)
 
       @controller_context = controller_context
       @watchdog = watchdog
       @type = type
       @config = config
+      @editable_height = normalize_editable_height(editable_height)
     end
 
     def to_attributes
@@ -34,7 +35,7 @@ module CKEditor5::Rails::Editor
 
     private
 
-    attr_reader :controller_context, :watchdog, :type, :config
+    attr_reader :controller_context, :watchdog, :type, :config, :editable_height
 
     def serialized_attributes
       {
@@ -43,6 +44,7 @@ module CKEditor5::Rails::Editor
         config: serialize_config,
         watchdog: watchdog
       }
+        .merge(editable_height ? { 'editable-height' => editable_height } : {})
     end
 
     def serialize_translations
@@ -59,5 +61,23 @@ module CKEditor5::Rails::Editor
         .tap { |cfg| cfg[:licenseKey] = controller_context[:license_key] if controller_context[:license_key] }
         .to_json
     end
+
+    def normalize_editable_height(editable_height)
+      return nil if editable_height.nil?
+
+      unless type == :classic
+        raise InvalidEditableHeightError,
+              'editable_height can be used only with ClassicEditor'
+      end
+
+      case editable_height
+      when String, /^\d+px$/ then editable_height
+      when Integer, /^\d+$/ then "#{editable_height}px"
+      else
+        raise InvalidEditableHeightError,
+              "editable_height must be an integer representing pixels or string ending with 'px'\n" \
+              "(e.g. 500 or '500px'). Got: #{editable_height.inspect}"
+      end
+    end
   end
 end

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

@@ -2,6 +2,8 @@
 
 module CKEditor5::Rails::Editor
   class PropsInlinePlugin
+    attr_reader :name, :code
+
     def initialize(name, code)
       @name = name
       @code = code
@@ -18,8 +20,6 @@ module CKEditor5::Rails::Editor
 
     private
 
-    attr_reader :name, :code
-
     def validate_code!
       raise ArgumentError, 'Code must be a String' unless code.is_a?(String)
 

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

@@ -2,6 +2,8 @@
 
 module CKEditor5::Rails::Editor
   class PropsPlugin
+    attr_reader :name, :js_import_meta
+
     delegate :to_h, to: :import_meta
 
     def initialize(name, premium: false, **js_import_meta)
@@ -30,9 +32,5 @@ module CKEditor5::Rails::Editor
       meta.merge!({ type: :external })
       meta
     end
-
-    private
-
-    attr_reader :name, :js_import_meta
   end
 end

data/lib/ckeditor5/rails/engine.rb

@@ -4,6 +4,7 @@ require 'rails/engine'
 
 require_relative 'presets/manager'
 require_relative 'hooks/form'
+require_relative 'plugins/simple_upload_adapter'
 
 module CKEditor5::Rails
   class Engine < ::Rails::Engine
@@ -12,6 +13,7 @@ module CKEditor5::Rails
 
     initializer 'helper' do
       ActiveSupport.on_load(:action_view) { include Helpers }
+      ActiveSupport.on_load(:action_controller) { include Helpers }
     end
 
     initializer 'ckeditor5.simple_form', after: :load_config_initializers do
@@ -39,6 +41,12 @@ module CKEditor5::Rails
         proxy = ConfigurationProxy.new(config.ckeditor5)
         proxy.instance_eval(&block)
       end
+
+      def find_preset(preset)
+        return preset if preset.is_a?(CKEditor5::Rails::Presets::PresetBuilder)
+
+        Engine.base.presets[preset]
+      end
     end
 
     class ConfigurationProxy

data/lib/ckeditor5/rails/helpers.rb

@@ -7,7 +7,8 @@ require_relative 'context/helpers'
 module CKEditor5::Rails
   module Helpers
     include Cdn::Helpers
-    include Editor::Helpers
+    include Editor::Helpers::Config
+    include Editor::Helpers::Editor
     include Context::Helpers
   end
 end

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module CKEditor5::Rails::Plugins
+  class SimpleUploadAdapter < CKEditor5::Rails::Editor::PropsInlinePlugin
+    PLUGIN_CODE = <<~JAVASCRIPT
+      import { Plugin, FileRepository } from 'ckeditor5';
+
+      export default class SimpleUploadAdapter extends Plugin {
+        static get requires() {
+          return [FileRepository];
+        }
+
+        static get pluginName() {
+          return 'SimpleUploadAdapter';
+        }
+
+        init() {
+          const fileRepository = this.editor.plugins.get(FileRepository);
+          const config = this.editor.config.get('simpleUpload');
+
+          if (!config || !config.uploadUrl) {
+            console.warn('Upload URL is not configured');
+            return;
+          }
+
+          fileRepository.createUploadAdapter = (loader) => ({
+            async upload() {
+              try {
+                const file = await loader.file;
+                const formData = new FormData();
+                formData.append('upload', file);
+
+                return new Promise((resolve, reject) => {
+                  const xhr = new XMLHttpRequest();
+
+                  xhr.open('POST', config.uploadUrl, true);
+                  xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
+
+                  xhr.upload.onprogress = (evt) => {
+                    if (evt.lengthComputable) {
+                      loader.uploadTotal = evt.total;
+                      loader.uploaded = evt.loaded;
+                    }
+                  };
+
+                  xhr.onload = () => {
+                    if (xhr.status >= 200 && xhr.status < 300) {
+                      const data = JSON.parse(xhr.response);
+                      resolve({ default: data.url });
+                    } else {
+                      reject(`Upload failed: ${xhr.statusText}`);
+                    }
+                  };
+
+                  xhr.onerror = () => reject('Upload failed');
+                  xhr.onabort = () => reject('Upload aborted');
+
+                  xhr.send(formData);
+                  this._xhr = xhr;
+                });
+              } catch (error) {
+                throw error;
+              }
+            },
+
+            abort() {
+              if (this._xhr) {
+                this._xhr.abort();
+              }
+            }
+          });
+        }
+      }
+    JAVASCRIPT
+
+    def initialize
+      super(:SimpleUpload, PLUGIN_CODE)
+    end
+  end
+end

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

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require_relative 'preset_builder'
 require_relative 'toolbar_builder'
+require_relative 'plugins_builder'
+require_relative 'preset_builder'
 
 module CKEditor5::Rails::Presets
   class Manager

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module CKEditor5::Rails
+  class Presets::PluginsBuilder
+    attr_reader :plugins
+
+    def initialize(plugins)
+      @plugins = plugins
+    end
+
+    def self.create_plugin(name, **kwargs)
+      if name.is_a?(Editor::PropsInlinePlugin) || name.is_a?(Editor::PropsPlugin)
+        name
+      else
+        Editor::PropsPlugin.new(name, **kwargs)
+      end
+    end
+
+    def remove(*names)
+      names.each { |name| plugins.delete_if { |plugin| plugin.name == name } }
+    end
+
+    def prepend(*names, before: nil, **kwargs)
+      new_plugins = names.map { |name| self.class.create_plugin(name, **kwargs) }
+
+      if before
+        index = plugins.index { |p| p.name == before }
+        raise ArgumentError, "Plugin '#{before}' not found" unless index
+
+        plugins.insert(index, *new_plugins)
+      else
+        plugins.insert(0, *new_plugins)
+      end
+    end
+
+    def append(*names, after: nil, **kwargs)
+      new_plugins = names.map { |name| self.class.create_plugin(name, **kwargs) }
+
+      if after
+        index = plugins.index { |p| p.name == after }
+        raise ArgumentError, "Plugin '#{after}' not found" unless index
+
+        plugins.insert(index + 1, *new_plugins)
+      else
+        plugins.push(*new_plugins)
+      end
+    end
+  end
+end

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

@@ -3,15 +3,15 @@
 module CKEditor5::Rails
   module Presets
     class PresetBuilder
-      include Editor::ConfigHelpers
+      include Editor::Helpers::Config
 
       attr_reader :config
 
-      def initialize
+      def initialize(&block)
         @version = nil
         @premium = false
         @cdn = :jsdelivr
-        @translations = []
+        @translations = [:en]
         @license_key = nil
         @type = :classic
         @ckbox = nil
@@ -20,6 +20,8 @@ module CKEditor5::Rails
           plugins: [],
           toolbar: []
         }
+
+        instance_eval(&block) if block_given?
       end
 
       def premium?
@@ -135,7 +137,7 @@ module CKEditor5::Rails
 
         return unless block
 
-        builder = ToolbarBuilder.new(@config[:toolbar])
+        builder = ArrayBuilder.new(@config[:toolbar][:items])
         builder.instance_eval(&block)
       end
 
@@ -144,11 +146,21 @@ module CKEditor5::Rails
       end
 
       def plugin(name, **kwargs)
-        @config[:plugins] << Editor::PropsPlugin.new(name, **kwargs)
+        plugin_obj = PluginsBuilder.create_plugin(name, **kwargs)
+
+        @config[:plugins] << plugin_obj
+        plugin_obj
       end
 
-      def plugins(*names, **kwargs)
-        names.each { |name| plugin(name, **kwargs) }
+      def plugins(*names, **kwargs, &block)
+        @config[:plugins] ||= []
+
+        names.each { |name| plugin(name, **kwargs) } unless names.empty?
+
+        return unless block
+
+        builder = PluginsBuilder.new(@config[:plugins])
+        builder.instance_eval(&block)
       end
 
       def language(ui = nil, content: ui) # rubocop:disable Naming/MethodParameterName
@@ -159,6 +171,15 @@ module CKEditor5::Rails
           content: content
         }
       end
+
+      def simple_upload_adapter(upload_url = '/uploads')
+        plugins do
+          remove :Base64UploadAdapter
+        end
+
+        plugin(Plugins::SimpleUploadAdapter.new)
+        configure(:simpleUpload, { uploadUrl: upload_url })
+      end
     end
   end
 end

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

@@ -2,12 +2,10 @@
 
 module CKEditor5::Rails::Presets
   class ToolbarBuilder
-    def initialize(toolbar_config)
-      @toolbar_config = toolbar_config
-    end
+    attr_reader :items
 
-    def items
-      @toolbar_config[:items]
+    def initialize(items)
+      @items = items
     end
 
     def remove(*removed_items)
@@ -17,7 +15,7 @@ module CKEditor5::Rails::Presets
     def prepend(*prepended_items, before: nil)
       if before
         index = items.index(before)
-        raise ArgumentError, "Item '#{before}' not found in toolbar" unless index
+        raise ArgumentError, "Item '#{before}' not found in array" unless index
 
         items.insert(index, *prepended_items)
       else
@@ -28,7 +26,7 @@ module CKEditor5::Rails::Presets
     def append(*appended_items, after: nil)
       if after
         index = items.index(after)
-        raise ArgumentError, "Item '#{after}' not found in toolbar" unless index
+        raise ArgumentError, "Item '#{after}' not found in array" unless index
 
         items.insert(index + 1, *appended_items)
       else

data/lib/ckeditor5/rails/semver.rb

@@ -13,7 +13,6 @@ class CKEditor5::Rails::Semver
   private
 
   def validate!
-    raise ArgumentError, 'version must be a string' unless version.is_a?(String)
     raise ArgumentError, 'invalid version format' unless version.match?(/\A\d+\.\d+\.\d+\z/)
   end
 end

data/lib/ckeditor5/rails/version.rb

@@ -2,6 +2,6 @@
 
 module CKEditor5
   module Rails
-    VERSION = '1.11.1'
+    VERSION = '1.14.0'
   end
 end

data/spec/lib/ckeditor5/rails/cdn/url_generator_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe CKEditor5::Rails::Cdn::UrlGenerator do
+  let(:test_class) do
+    Class.new do
+      include CKEditor5::Rails::Cdn::UrlGenerator
+
+      attr_writer :cdn
+    end
+  end
+
+  let(:instance) { test_class.new }
+
+  shared_examples 'a CDN provider' do |cdn, url_pattern|
+    before { instance.cdn = cdn }
+
+    it 'generates correct URL' do
+      expect(instance.create_cdn_url('ckeditor5', '34.1.0', 'ckeditor.js'))
+        .to eq(format(url_pattern, version: '34.1.0'))
+    end
+  end
+
+  describe '#create_cdn_url' do
+    context 'with open-source CDNs' do
+      it_behaves_like 'a CDN provider', :jsdelivr,
+                      'https://cdn.jsdelivr.net/npm/ckeditor5@%<version>s/dist/browser/ckeditor.js'
+
+      it_behaves_like 'a CDN provider', :unpkg,
+                      'https://unpkg.com/ckeditor5@%<version>s/dist/browser/ckeditor.js'
+
+      context 'with translations' do
+        it 'handles translation paths correctly for jsdelivr' do
+          instance.cdn = :jsdelivr
+          expect(instance.create_cdn_url('ckeditor5', '34.1.0', 'translations/pl.js'))
+            .to eq('https://cdn.jsdelivr.net/npm/ckeditor5@34.1.0/dist/translations/pl.js')
+        end
+
+        it 'handles translation paths correctly for unpkg' do
+          instance.cdn = :unpkg
+          expect(instance.create_cdn_url('ckeditor5', '34.1.0', 'translations/pl.js'))
+            .to eq('https://unpkg.com/ckeditor5@34.1.0/dist/translations/pl.js')
+        end
+      end
+    end
+
+    context 'with commercial CDNs' do
+      it_behaves_like 'a CDN provider', :cloud,
+                      'https://cdn.ckeditor.com/ckeditor5/%<version>s/ckeditor.js'
+
+      it 'generates correct CKBox URL' do
+        instance.cdn = :ckbox
+        expect(instance.create_cdn_url('ckbox', '34.1.0', 'ckeditor.js'))
+          .to eq('https://cdn.ckbox.io/ckbox/34.1.0/ckeditor.js')
+      end
+    end
+
+    context 'with invalid configuration' do
+      it 'raises ArgumentError for unknown CDN provider' do
+        instance.cdn = :invalid_cdn
+        expect { instance.create_cdn_url('ckeditor5', '34.1.0', 'ckeditor.js') }
+          .to raise_error(ArgumentError, 'Unknown provider: invalid_cdn')
+      end
+    end
+  end
+end

data/spec/lib/ckeditor5/rails/semver_spec.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe CKEditor5::Rails::Semver do
+  describe '#initialize' do
+    context 'with valid version string' do
+      it 'accepts version in x.y.z format' do
+        expect { described_class.new('1.2.3') }.not_to raise_error
+      end
+    end
+
+    context 'with invalid version' do
+      it 'raises error for numeric input' do
+        expect { described_class.new(123) }
+          .to raise_error(ArgumentError, 'invalid version format')
+      end
+
+      it 'raises error for invalid string format' do
+        invalid_versions = ['1', '1.2', '1.2.3.4', 'x.y.z', '1.2.x', '1.a.3']
+
+        invalid_versions.each do |version|
+          expect { described_class.new(version) }
+            .to raise_error(ArgumentError, 'invalid version format')
+        end
+      end
+    end
+  end
+
+  describe '#to_s' do
+    it 'returns the version string' do
+      version = '1.2.3'
+      semver = described_class.new(version)
+      expect(semver.to_s).to eq(version)
+    end
+  end
+
+  describe '#version' do
+    it 'returns the version string' do
+      version = '1.2.3'
+      semver = described_class.new(version)
+      expect(semver.version).to eq(version)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'simplecov_json_formatter'
+
+SimpleCov.start do
+  enable_coverage :branch
+  enable_coverage :line
+
+  add_filter 'sandbox/'
+  add_group 'Library', 'lib/'
+
+  track_files 'lib/**/*.rb'
+
+  # minimum_coverage 90
+  # minimum_coverage_by_file 80
+
+  formatters = [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::JSONFormatter
+  ]
+
+  formatter SimpleCov::Formatter::MultiFormatter.new(formatters)
+end
+
+ENV['RAILS_ENV'] ||= 'test'
+
+require File.expand_path('../sandbox/config/application', __dir__)
+
+require 'pry'
+require 'spec_helper'
+require 'rspec/rails'
+require 'rspec/expectations'
+
+Rails.application.initialize!
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.disable_monkey_patching!
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.rand config.seed
+
+  config.before(:each) do
+    Rails.application.load_seed
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.11.1
+  version: 1.14.0
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -57,8 +57,9 @@ files:
 - lib/ckeditor5/rails/cdn/url_generator.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/helpers/config_helpers.rb
+- lib/ckeditor5/rails/editor/helpers/editor_helpers.rb
 - lib/ckeditor5/rails/editor/props.rb
 - lib/ckeditor5/rails/editor/props_inline_plugin.rb
 - lib/ckeditor5/rails/editor/props_plugin.rb
@@ -66,11 +67,16 @@ files:
 - lib/ckeditor5/rails/helpers.rb
 - lib/ckeditor5/rails/hooks/form.rb
 - lib/ckeditor5/rails/hooks/simple_form.rb
+- lib/ckeditor5/rails/plugins/simple_upload_adapter.rb
 - lib/ckeditor5/rails/presets/manager.rb
+- lib/ckeditor5/rails/presets/plugins_builder.rb
 - lib/ckeditor5/rails/presets/preset_builder.rb
 - lib/ckeditor5/rails/presets/toolbar_builder.rb
 - lib/ckeditor5/rails/semver.rb
 - lib/ckeditor5/rails/version.rb
+- spec/lib/ckeditor5/rails/cdn/url_generator_spec.rb
+- spec/lib/ckeditor5/rails/semver_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/Mati365/ckeditor5-rails
 licenses:
 - GPL-2.0
@@ -94,4 +100,7 @@ rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: CKEditor 5 for Rails
-test_files: []
+test_files:
+- spec/lib/ckeditor5/rails/cdn/url_generator_spec.rb
+- spec/lib/ckeditor5/rails/semver_spec.rb
+- spec/spec_helper.rb

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

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module CKEditor5::Rails
-  module Editor::ConfigHelpers
-    def ckeditor5_element_ref(selector)
-      { '$element': selector }
-    end
-  end
-end