ckeditor5 1.12.0 → 1.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c39a460f498306970334acf87d4bd8c66a24ddaf79ad0dd9f461ed5d9772de11
-  data.tar.gz: b5a221dbe9dd9d47c649d1b8d78eda335fdeebe4fde6190db9f03cf3f3fe4aca
+  metadata.gz: a2d481ae5f7ed4d671e8d6ade94e9efa0ab5d0b4bba36f24b8052d84eadd21e9
+  data.tar.gz: 3d8ff1d8a23aadc4398e2439996d9a86aa792eec16e33a70837e731e68f6ba9f
 SHA512:
-  metadata.gz: a7368d44b2ed0ce7416c8a4ed0052c9c15b343bf012e39fa24abd5761a61173c4ae95925061dce751c0b6419b19e1a69f2d98266f316b99d1c06479b1cad9b1c
-  data.tar.gz: b0c6f01ac1d2efbc70f11a12997b6d48567293c13689e203ba29f9034dc233d25851e6d0c6bde29f382fbfafcb6f8630e4e51eb47db15922928eb20a199e3274
+  metadata.gz: a407f380c8f2295959533cd08966aace68f1d9d20208608a16269921ae167ba450e719663d918ff725ee10f0be6d020c2130d50873b51cc726b00bf4fa55b573
+  data.tar.gz: 37f51f50d80ce4e51aeed85188b7bf48963723b0b1cf004bc6faceb5ec561c85c79d00887ca50ce4fe2ed702468677718b35c7cdaceb7af9db10fed5ce088381

data/README.md

@@ -62,10 +62,25 @@ In your view:
 
 Voilà! You have CKEditor 5 integrated with your Rails application. 🎉
 
+## Demos 🚀
+
+Interested in more advanced configuration? Visit the demos in the [demo application](https://github.com/Mati365/ckeditor5-rails/tree/main/sandbox/app/views/demos) or take a look at official CKEditor 5 [examples](https://ckeditor.com/docs/ckeditor5/latest/examples/builds/classic-editor.html).
+
+In order to run all demos locally, you can clone the repository and run the following commands:
+
+```bash
+bundle install
+cd sandbox
+bundle exec rails server -p 3000
+```
+
+Then visit [http://localhost:3000/demos](http://localhost:3000/) to see the demos in action. 🚀
+
 ## Table of Contents 📚
 
 - [CKEditor 5 Rails Integration ✨](#ckeditor-5-rails-integration-)
   - [Installation 🛠️](#installation-️)
+  - [Demos 🚀](#demos-)
   - [Table of Contents 📚](#table-of-contents-)
   - [Presets 🎨](#presets-)
     - [Available Configuration Methods ⚙️](#available-configuration-methods-️)
@@ -85,9 +100,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)
+      - [`ckeditor5_preset(&block)` method](#ckeditor5_presetblock-method)
   - [Including CKEditor 5 assets 📦](#including-ckeditor-5-assets-)
     - [Format 📝](#format-)
       - [Using default preset](#using-default-preset)
@@ -534,6 +550,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:
@@ -560,6 +590,21 @@ 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
+```
+
 ### Controller / View helpers 📦
 
 #### `ckeditor5_element_ref(selector)` method
@@ -578,7 +623,7 @@ CKEditor5::Rails.configure do
 end
 ```
 
-### `ckeditor5_preset(&block)` method
+#### `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.
 

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

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

@@ -24,6 +24,19 @@ module CKEditor5::Rails
         instance_eval(&block) if block_given?
       end
 
+      def initialize_copy(source)
+        super
+
+        @translations = source.translations.dup
+        @ckbox = source.ckbox.dup if source.ckbox
+        @config = {
+          plugins: source.config[:plugins].map(&:dup),
+          toolbar: deep_copy_toolbar(source.config[:toolbar])
+        }.merge(
+          source.config.except(:plugins, :toolbar).deep_dup
+        )
+      end
+
       def premium?
         @premium
       end
@@ -137,7 +150,7 @@ module CKEditor5::Rails
 
         return unless block
 
-        builder = ToolbarBuilder.new(@config[:toolbar])
+        builder = ArrayBuilder.new(@config[:toolbar][:items])
         builder.instance_eval(&block)
       end
 
@@ -146,11 +159,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
@@ -161,6 +184,27 @@ 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
+
+      private
+
+      def deep_copy_toolbar(toolbar)
+        return toolbar.dup if toolbar.is_a?(Array)
+        return {} if toolbar.nil?
+
+        {
+          items: toolbar[:items].dup,
+          shouldNotGroupWhenFull: toolbar[:shouldNotGroupWhenFull]
+        }
+      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/version.rb

@@ -2,6 +2,6 @@
 
 module CKEditor5
   module Rails
-    VERSION = '1.12.0'
+    VERSION = '1.14.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.14.1
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -67,7 +67,9 @@ 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