ckeditor5 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ca43e4ca91ad0af4aab412f708f87189bf13b16604e2abb8e39b9805a03e3c6
-  data.tar.gz: f2374481093fc8cffd6ecd25b083d3ee1dcf6bb184efb4a5f482fd5d1152828b
+  metadata.gz: ffcf4f20d7134eefdd8ed70322d880862886c260c5b68295154e5932eb7aed8f
+  data.tar.gz: 63c20e49867be66eee43e90a0b473e13971648216675927408d82265f483d8b8
 SHA512:
-  metadata.gz: 26f30df68efa28155834fec3355577b6819132b787f05c87ce701bf3a15e7965ca3f42527ac5970cb226cb9ac934b9d91fa40ca2c5382fc76851038ed8d5a3e0
-  data.tar.gz: 0b4f7a9b47578137eaa4238329797730a434ba2afba8edfda1b314fc956853ce13c0f8ec7edc79cf634ba460c4add35c3db913587dbd2ec9a7f478db82fbc9be
+  metadata.gz: f5d9f8eb254a1210c9792ddfea0885f58b4c11c9d049a14ee9e269f753204f7a10e3eacade18f502497becb02544f7440641414f6dd1495798428ef10fa40c47
+  data.tar.gz: 88fb52bde4a26017c7e122ac71dcaad9568ccbd1a4163f41a55cbf5d9f67ee19a2acdc8f7a37edfde92444fbbc230a34f20bfde005630d95cd7f29b52085b16b

data/README.md

@@ -1,6 +1,6 @@
 # CKEditor 5 Rails Integration ✨
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://opensource.org/licenses/MIT)
+[![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)
 [![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)
@@ -20,15 +20,13 @@ Add this line to your application's Gemfile:
 gem 'ckeditor5'
 ```
 
-In your config:
+In your config (the default config is defined [here](https://github.com/Mati365/ckeditor5-rails/blob/main/lib/ckeditor5/rails/presets/manager.rb)):
 
 ```rb
 # config/initializers/ckeditor5.rb
 
-CKEditor5::Rails.configure do |config|
-  config.presets.override :default do
-    version '43.3.0'
-  end
+CKEditor5::Rails.configure do
+  version '43.3.0'
 end
 ```
 
@@ -69,6 +67,10 @@ Voilà! You have CKEditor 5 integrated with your Rails application. 🎉
       - [`plugins(*names, **kwargs)` method](#pluginsnames-kwargs-method)
       - [`inline_plugin(name, code)` method](#inline_pluginname-code-method)
   - [Including CKEditor 5 assets 📦](#including-ckeditor-5-assets-)
+    - [Format 📝](#format-)
+      - [Using default preset](#using-default-preset)
+      - [Custom preset](#custom-preset)
+      - [Inline preset definition](#inline-preset-definition)
     - [Lazy loading 🚀](#lazy-loading-)
     - [GPL usage 🆓](#gpl-usage-)
     - [Commercial usage 💰](#commercial-usage-)
@@ -91,6 +93,7 @@ Voilà! You have CKEditor 5 integrated with your Rails application. 🎉
   - [Events fired by the editor 🔊](#events-fired-by-the-editor-)
     - [`editor-ready` event](#editor-ready-event)
     - [`editor-error` event](#editor-error-event)
+  - [Trademarks 📜](#trademarks-)
   - [License 📜](#license-)
 
 ## Presets 🎨
@@ -102,8 +105,20 @@ You can create your own by defining it in the `config/initializers/ckeditor5.rb`
 ```rb
 # config/initializers/ckeditor5.rb
 
-CKEditor5::Rails.configure do |config|
-  config.presets.define :custom
+CKEditor5::Rails.configure do
+  # It's possible to override the default preset right in the initializer.
+  version '43.3.0'
+
+  # New presets inherit properties from the default preset defined in the initializer.
+  # In this example, the custom preset inherits everything from default but disables the menubar:
+  presets.define :inherited_custom
+    menubar visible: false
+  end
+
+  # In order to define preset from scratch, you can use the `inherit: false` option.
+  presets.define :blank_preset, inherit: false do
+    version '44.0.0'
+
     gpl
     type :classic
 
@@ -130,13 +145,13 @@ CKEditor5::Rails.configure do |config|
 end
 ```
 
-In order to override existing presets, you can use the `config.presets.override` method. The method takes the name of the preset you want to override and a block with the old configuration. The example below shows how to hide the menubar in the default preset:
+In order to override existing presets, you can use the `presets.override` method. The method takes the name of the preset you want to override and a block with the old configuration. The example below shows how to hide the menubar in the default preset:
 
 ```rb
 # config/initializers/ckeditor5.rb
 
-CKEditor5::Rails.configure do |config|
-  config.presets.override :default do
+CKEditor5::Rails.configure do
+  presets.override :custom do
     menubar visible: false
 
     toolbar do
@@ -160,7 +175,7 @@ Defines the CDN to be used for CKEditor 5 assets. The example below shows how to
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   cdn :jsdelivr
@@ -172,7 +187,7 @@ It also allows you to define a custom CDN by passing a block with the bundle, ve
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   cdn do |bundle, version, path|
@@ -190,7 +205,7 @@ Defines the version of CKEditor 5 to be used. The example below shows how to set
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   version '43.2.0'
@@ -204,7 +219,7 @@ Defines the license of CKEditor 5. The example below shows how to set the licens
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   gpl
@@ -218,7 +233,7 @@ Defines the license key of CKEditor 5. It calls `premium` method internally. The
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   license_key 'your-license-key'
@@ -232,7 +247,7 @@ Defines if premium package should be included in JS assets. The example below sh
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   premium
@@ -246,7 +261,7 @@ Defines the translations of CKEditor 5. You can pass the language codes as argum
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   translations :pl, :es
@@ -258,9 +273,10 @@ end
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
-  translations :pl
+CKEditor5::Rails.configure do
+  # ... other configuration
 
+  translations :pl
   language :pl
 end
 ```
@@ -272,7 +288,7 @@ Defines the CKBox plugin to be included in the editor. The example below shows h
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   ckbox '2.5.4', theme: :lark
@@ -294,7 +310,7 @@ The example below sets the editor type to `multiroot` in the custom preset:
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   type :multiroot
@@ -313,7 +329,7 @@ The `should_group_when_full` keyword argument determines whether the toolbar sho
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   toolbar :undo, :redo, :|, :heading, :|, :bold, :italic, :underline, :|,
@@ -329,7 +345,7 @@ If you want to add or prepend items to the existing toolbar, you can use the blo
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.override :default do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   toolbar do
@@ -344,7 +360,7 @@ If you want to remove items from the toolbar, you can use the `remove` method:
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.override :default do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   toolbar do
@@ -360,7 +376,7 @@ Defines the visibility of the menubar. By default, it's set to `true`.
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   toolbar :undo, :redo, :|, :heading, :|, :bold, :italic, :underline, :|,
@@ -376,7 +392,7 @@ Defines the language of the editor. You can pass the language code as an argumen
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   language :pl
@@ -388,7 +404,7 @@ In order to set the language for the content, you can pass the `content` keyword
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   language :en, content: :pl
@@ -402,7 +418,7 @@ Allows you to set custom configuration options. You can pass the name of the opt
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   configure :link, {
@@ -420,7 +436,7 @@ The example below show how to import Bold plugin from the `ckeditor5` npm packag
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   plugin :Bold
@@ -432,7 +448,7 @@ In order to import a plugin from a custom ESM package, you can pass the `import_
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   plugin :YourPlugin, import_name: 'your-package'
@@ -444,7 +460,7 @@ In order to import a plugin from a custom Window entry, you can pass the `window
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   plugin :YourPlugin, window_name: 'YourPlugin'
@@ -458,7 +474,7 @@ Defines the plugins to be included in the editor. You can specify multiple plugi
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   plugins :Bold, :Italic, :Underline, :Link
@@ -472,7 +488,7 @@ Use with caution as this is an inline definition of the plugin code, and you can
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   inline_plugin :MyCustomPlugin, <<~JS
@@ -498,6 +514,72 @@ To include CKEditor 5 assets in your application, you can use the `ckeditor5_ass
 
 Keep in mind that you need to include the helper result in the `head` section of your layout. In examples below, we use `content_for` helper to include the assets in the `head` section of the view.
 
+### Format 📝
+
+#### Using default preset
+
+The example below users the default preset defined [here](https://github.com/Mati365/ckeditor5-rails/blob/main/lib/ckeditor5/rails/presets/manager.rb).
+
+```erb
+<!-- app/views/demos/index.html.erb -->
+
+<% content_for :head do %>
+  <%= ckeditor5_assets %>
+<% end %>
+```
+
+If you want to fetch some additional translations, you can extend your initializer with the following configuration:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... rest of the configuration
+
+  translations :pl, :es
+end
+```
+
+#### Custom preset
+
+To specify a custom preset, you need to pass the `preset` keyword argument with the name of the preset. The example below shows how to include the assets for the custom preset:
+
+```erb
+<!-- app/views/demos/index.html.erb -->
+
+<% content_for :head do %>
+  <%= ckeditor5_assets preset: :custom %>
+<% end %>
+```
+
+In order to define such preset, you can use the following configuration:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... rest of the configuration
+
+  presets.define :custom do
+    # ... your preset configuration
+
+    translations :pl, :es
+  end
+end
+```
+
+#### Inline preset definition
+
+It's possible to define the preset directly in the `ckeditor5_assets` helper method. It allows you to dynamically specify version, cdn provider or even translations in the view. The example below inherits the default preset and adds Polish translations and other options:
+
+```erb
+<!-- app/views/demos/index.html.erb -->
+
+<% content_for :head do %>
+  <%= ckeditor5_assets version: '43.3.0', cdn: :jsdelivr, translations: [:pl], license_key: '<YOUR KEY> OR GPL' %>
+<% end %>
+```
+
 ### Lazy loading 🚀
 
 <details>
@@ -511,41 +593,42 @@ It has been achieved by using web components, together with import maps, which a
 
 ### GPL usage 🆓
 
-If you want to use CKEditor 5 under the GPL license, you can include the assets using the `ckeditor5_assets` without passing any arguments. However you can pass the `version` keyword argument with the version of CKEditor 5 you want to use:
+If you want to use CKEditor 5 under the GPL license, you can include the assets using the `ckeditor5_assets` without passing any arguments. It'll include the necessary assets for the GPL license from one of the most popular CDNs. In our scenario, we use the `jsdelivr` CDN which is the default one.
+
+Example:
 
 ```erb
 <!-- app/views/demos/index.html.erb -->
 
 <% content_for :head do %>
-  <%= ckeditor5_assets version: '43.3.0' %>
+  <%= ckeditor5_assets %>
 <% end %>
 ```
 
-It'll include the necessary assets for the GPL license from one of the most popular CDNs. In our scenario, we use the `jsdelivr` CDN which is the default one.
+In that scenario it's recommended to add `gpl` method to the initializer along with the version:
 
-Version is optional as long as you defined it in the `config/initializers/ckeditor5.rb` file. If you want to use the default version, you can omit the `version` keyword argument:
-
-```erb
-<!-- app/views/demos/index.html.erb -->
+```rb
+# config/initializers/ckeditor5.rb
 
-<% content_for :head do %>
-  <%= ckeditor5_assets %>
-<% end %>
+CKEditor5::Rails.configure do
+  gpl
+  version '43.3.0'
+end
 ```
 
-Set the version in the `config/initializers/ckeditor5.rb` file:
+In order to use `unpkg` CDN, you can extend your initializer with the following configuration:
 
 ```rb
 # config/initializers/ckeditor5.rb
 
 CKEditor5::Rails.configure do
-  presets.override :default do
-    version '43.3.0'
-  end
+  # ... rest of the configuration
+
+  cdn :unpkg
 end
 ```
 
-In order to use `unpkg` CDN, you can pass the `cdn` keyword argument with the value `:unpkg`:
+However, you can also specify the CDN directly in the view:
 
 ```erb
 <!-- app/views/demos/index.html.erb -->
@@ -565,31 +648,27 @@ or using helper function:
 <% end %>
 ```
 
-Translating CKEditor 5 is possible by passing the `translations` keyword argument with the languages codes array. The example below shows how to include the Polish translations:
-
-```erb
-<!-- app/views/demos/index.html.erb -->
-
-<% content_for :head do %>
-  <%= ckeditor5_assets translations: [:pl] %>
-<% end %>
-```
+### Commercial usage 💰
 
-Keep in mind, that you need to include the translations in the `config/initializers/ckeditor5.rb` file:
+If you want to use CKEditor 5 under a commercial license, you have to specify license key. It can be done in the initializer:
 
 ```rb
 # config/initializers/ckeditor5.rb
 
 CKEditor5::Rails.configure do
-  presets.override :default do
-    language :pl
-  end
+  license_key 'your-license-key'
 end
 ```
 
-### Commercial usage 💰
+```erb
+<!-- app/views/demos/index.html.erb -->
 
-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:
+<% content_for :head do %>
+  <%= ckeditor5_assets %>
+<% end %>
+```
+
+or directly in the view:
 
 ```erb
 <!-- app/views/demos/index.html.erb -->
@@ -1073,6 +1152,14 @@ document.getElementById('editor').addEventListener('editor-error', () => {
 });
 ```
 
+## Trademarks 📜
+
+CKEditor® is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com/) All rights reserved. For more information about the license of CKEditor® please visit [CKEditor's licensing page](https://ckeditor.com/legal/ckeditor-oss-license/).
+
+This gem is not owned by CKSource and does not use the CKEditor® trademark for commercial purposes. It should not be associated with or considered an official CKSource product.
+
 ## License 📜
 
 This project is licensed under the terms of the [GNU General Public License v2.0](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html). See the [LICENSE](LICENSE) file for details.
+
+This project uses CKEditor 5 which is licensed under the terms of [GNU General Public License Version 2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html). For more information about CKEditor 5 licensing, please see their [official documentation](https://ckeditor.com/legal/ckeditor-oss-license/).

data/lib/ckeditor5/rails/engine.rb

@@ -33,8 +33,25 @@ module CKEditor5::Rails
         config.ckeditor5.presets.default
       end
 
-      def configure
-        yield config.ckeditor5
+      def configure(&block)
+        proxy = ConfigurationProxy.new(config.ckeditor5)
+        proxy.instance_eval(&block)
+      end
+    end
+
+    class ConfigurationProxy
+      delegate :presets, to: :@configuration
+
+      delegate :version, :gpl, :premium, :cdn, :translations, :license_key,
+               :type, :menubar, :toolbar, :plugins, :plugin, :inline_plugin,
+               :language, :ckbox, :configure, to: :default_preset
+
+      def initialize(configuration)
+        @configuration = configuration
+      end
+
+      def default_preset
+        presets.default
       end
     end
   end

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

@@ -12,8 +12,13 @@ module CKEditor5::Rails::Presets
       define_default_preset
     end
 
-    def define(name, &block)
-      preset = PresetBuilder.new
+    def define(name, inherit: true, &block)
+      preset = if inherit && default.present?
+                 default.clone
+               else
+                 PresetBuilder.new
+               end
+
       preset.instance_eval(&block)
       @presets[name] = preset
     end
@@ -22,12 +27,14 @@ module CKEditor5::Rails::Presets
       @presets[name].instance_eval(&block)
     end
 
+    alias extend override
+
     def default
-      @presets[:default] || {}
+      @presets[:default]
     end
 
     def [](name)
-      @presets[name] || {}
+      @presets[name]
     end
 
     private

data/lib/ckeditor5/rails/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -9,28 +9,28 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-03 00:00:00.000000000 Z
+date: 2024-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.3
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.3
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 description:
 email: cziken58@gmail.com
 executables: []