RubyGems - ckeditor5 - Versions diffs - 1.23.0 → 1.23.2 - Mend

ckeditor5 1.23.0 → 1.23.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

checksums.yaml +4 -4
data/Gemfile +16 -12
data/README.md +57 -10
data/lib/ckeditor5/rails/assets/webcomponents/components/editor.mjs +10 -1
data/lib/ckeditor5/rails/editor/editable_height_normalizer.rb +2 -2
data/lib/ckeditor5/rails/presets/preset_builder.rb +38 -4
data/lib/ckeditor5/rails/version.rb +2 -2
data/spec/lib/ckeditor5/rails/editor/editable_height_normalizer_spec.rb +13 -5
data/spec/lib/ckeditor5/rails/presets/preset_builder_spec.rb +44 -0
metadata +2 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6209f7ab70666ad0c3e5c368f47832871d740429238bb62199c5956ca73fe77
-  data.tar.gz: 3e3af0099b5150b6c2df7bb578a11cd63b81f88cb9ded596806e5ea980ebf90a
+  metadata.gz: d4e4581fc1d9ebbf70b9213ce10a444b5ad2633f45334a7e343f875a8f7180ee
+  data.tar.gz: 251313b3f5eb8152f9385b9f4e159e30223b9a2bf0edff5009d3b85459d062c4
 SHA512:
-  metadata.gz: 1d7f113a286468066aa941cba9d735c5312d8558ed83a1d3f9fa7e4a2959d7c58a843f6b0bf8fd4e296b0ab34dedc303f0a6533c5adf6af1c60a1a77dbe4c5e9
-  data.tar.gz: c4304b80a54b9bf94629b9aa8c27d640e2ff0783e3d78d2a577400d3cd29df337aa1a8b40fc7bc8f050bc3ee3c528becfa0a12b68158fdb980df5ea2b897b6f8
+  metadata.gz: bdce490b8f96f7c365b3cdb782afccb02c8b372c93df042c76cfb10540d56f742b355af8c4d55a638399db4bccf661469117ae55c9cdd1a92b16e993bab37980
+  data.tar.gz: 9d54670405e3030075495bc0cbceb60524803658e23535f84bf5a72570917cbbdc32ab7130b0c1d1554c5f3065b3d7067afef3df4ae93df260608d20de8b6725

data/Gemfile CHANGED Viewed

@@ -3,26 +3,30 @@
 source 'https://rubygems.org'
 gem 'bundler', '~> 2.5', '>= 2.5.21'
+gem 'importmap-rails'
+gem 'propshaft'
+gem 'pry', '~> 0.15', '>= 0.15.0'
+gem 'pry-rails', '~> 0.3', '>= 0.3.11'
+gem 'rails', '~> 8.0', '>= 8.0.0'
+gem 'rake', '~> 13.2', '>= 13.2.1'
+gem 'simple_form', '~> 5.3', '>= 5.3.0'
+gem 'slim', '~> 5.2', '>= 5.2.0'
+gem 'sqlite3', '~> 2.4', '>= 2.4.1'
+gem 'stimulus-rails'
+gem 'terser', '~> 1.1', '>= 1.1.1'
+gem 'turbo-rails'
+group :production do
+  gem 'puma', '~> 6.5'
+end
 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 'importmap-rails'
-  gem 'propshaft'
-  gem 'pry', '~> 0.15', '>= 0.15.0'
-  gem 'pry-rails', '~> 0.3', '>= 0.3.11'
-  gem 'rails', '~> 8.0', '>= 8.0.0'
-  gem 'rake', '~> 13.2', '>= 13.2.1'
   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 'simple_form', '~> 5.3', '>= 5.3.0'
-  gem 'slim', '~> 5.2', '>= 5.2.0'
-  gem 'sqlite3', '>= 1.4'
-  gem 'stimulus-rails'
-  gem 'terser', '~> 1.1', '>= 1.1.1'
-  gem 'turbo-rails'
 end
 group :test, :development do

data/README.md CHANGED Viewed

@@ -32,9 +32,8 @@ In your layout:
   <head>
     <!--
       ⚠️ **Important**: When using `importmap-rails`, make sure the importmap
-      tags are rendered after `ckeditor5_assets` helper. The importmap must
-      be included in the head section to ensure proper loading order.
-      This is crucial for CKEditor 5 to work correctly.
+      tags are rendered after `ckeditor5_assets` helper. In this scenario,
+      content is yielded before rendering `javascript_importmap_tags`.
     -->
     <!-- javascript_importmap_tags -->
     <%= yield :head %>
@@ -81,7 +80,7 @@ CKEditor5::Rails.configure do
   # Optionally, you can specify version of CKEditor 5 to use.
   # If it's not specified the default version specified in the gem will be used.
-  # version '44.0.0'
+  # version '44.1.0'
   # Upload images to the server using the simple upload adapter, instead of Base64 encoding.
   # simple_upload_adapter
@@ -131,6 +130,8 @@ For extending CKEditor's functionality, refer to the [plugins directory](https:/
       - [`ckbox` method](#ckbox-method)
       - [`type(type)` method](#typetype-method)
       - [`toolbar(*items, should_group_when_full: true, &block)` method](#toolbaritems-should_group_when_full-true-block-method)
+      - [`block_toolbar(*items, should_group_when_full: true, &block)` method](#block_toolbaritems-should_group_when_full-true-block-method)
+      - [`balloon_toolbar(*items, should_group_when_full: true, &block)` method](#balloon_toolbaritems-should_group_when_full-true-block-method)
       - [`menubar(visible: true)` method](#menubarvisible-true-method)
       - [`configure(name, value)` method](#configurename-value-method)
       - [`plugin(name, premium:, import_name:)` method](#pluginname-premium-import_name-method)
@@ -197,7 +198,7 @@ You can create your own by defining it in the `config/initializers/ckeditor5.rb`
 CKEditor5::Rails.configure do
   # It's possible to override the default preset right in the initializer.
-  version '44.0.0'
+  version '44.1.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:
@@ -207,7 +208,7 @@ CKEditor5::Rails.configure do
   # 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'
+    version '44.1.0'
     # It tells the integration to fetch the newest security patches and bug fixes.
     # It may be disabled, but it's highly recommended to keep it enabled to avoid
@@ -329,7 +330,7 @@ Defines the version of CKEditor 5 to be used. The example below shows how to set
 CKEditor5::Rails.configure do
   # ... other configuration
-  version '44.0.0'
+  version '44.1.0'
 end
 ```
 </details>
@@ -645,6 +646,52 @@ end
 </details>
+#### `block_toolbar(*items, should_group_when_full: true, &block)` method
+<details>
+  <summary>Define block toolbar items and their grouping behavior</summary>
+<br />
+API is identical to the `toolbar` method, but it's used for block toolbar items. The example below shows how to define block toolbar items:
+```rb
+# config/initializers/ckeditor5.rb
+CKEditor5::Rails.configure do
+  # ... other configuration
+  block_toolbar :paragraph, :heading, :blockQuote, :|, :bulletedList, :numberedList, :todoList
+end
+```
+It is useful when you want to use Block Balloon Editor or Block Toolbar features.
+</details>
+#### `balloon_toolbar(*items, should_group_when_full: true, &block)` method
+<details>
+  <summary>Define balloon toolbar items and their grouping behavior</summary>
+<br />
+API is identical to the `toolbar` method, but it's used for balloon toolbar items. The example below shows how to define balloon toolbar items:
+```rb
+# config/initializers/ckeditor5.rb
+CKEditor5::Rails.configure do
+  # ... other configuration
+  balloon_toolbar :bold, :italic, :underline, :link, :insertImage, :mediaEmbed, :insertTable, :blockQuote
+end
+```
+It is useful when you want to use Balloon Editor or Balloon Toolbar features.
+</details>
 #### `menubar(visible: true)` method
 <details>
@@ -1029,7 +1076,7 @@ It may be useful when you want to define a preset based on the current user or r
 class ApplicationController < ActionController::Base
   def show
     @preset = ckeditor5_preset do
-      version '44.0.0'
+      version '44.1.0'
       toolbar :sourceEditing, :|, :bold, :italic, :underline, :strikethrough,
               :subscript, :superscript, :removeFormat, :|, :bulletedList, :numberedList,
@@ -1064,7 +1111,7 @@ If you want to override the preset defined in the initializer, you can search fo
 class ApplicationController < ActionController::Base
   def show
     @preset = ckeditor5_preset(:default).override do
-      version '44.0.0'
+      version '44.1.0'
       toolbar :sourceEditing, :|, :bold, :italic, :underline, :strikethrough,
               :subscript, :superscript, :removeFormat, :|, :bulletedList, :numberedList,
@@ -1237,7 +1284,7 @@ In that scenario it's recommended to add `gpl` method to the initializer along w
 CKEditor5::Rails.configure do
   gpl
-  version '44.0.0'
+  version '44.1.0'
 end
 ```

data/lib/ckeditor5/rails/assets/webcomponents/components/editor.mjs CHANGED Viewed

@@ -407,6 +407,15 @@ class CKEditorComponent extends HTMLElement {
     return this.getAttribute('type') === 'ClassicEditor';
   }
+  /**
+   * Checks if current editor is balloon type
+   *
+   * @returns {boolean}
+   */
+  isBallon() {
+    return this.getAttribute('type') === 'BalloonEditor';
+  }
   /**
    * Checks if current editor is multiroot type
    *
@@ -542,7 +551,7 @@ class CKEditorComponent extends HTMLElement {
    * @private
    */
   #setupEditableHeight() {
-    if (!this.isClassic()) {
+    if (!this.isClassic() && !this.isBallon()) {
       return;
     }

data/lib/ckeditor5/rails/editor/editable_height_normalizer.rb CHANGED Viewed

@@ -20,10 +20,10 @@ module CKEditor5::Rails::Editor
     attr_reader :editor_type
     def validate_editor_type!
-      return if editor_type == :classic
+      return if %i[classic balloon].include?(editor_type)
       raise InvalidEditableHeightError,
-            'editable_height can be used only with ClassicEditor'
+            'editable_height can be used only with ClassicEditor or BalloonEditor'
     end
     def convert_to_pixel_value(value)

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

@@ -263,19 +263,53 @@ module CKEditor5::Rails
       #     remove :heading
       #   end
       # @return [ToolbarBuilder] Toolbar configuration
-      def toolbar(*items, should_group_when_full: true, &block)
-        if @config[:toolbar].blank? || !items.empty?
-          @config[:toolbar] = {
+      def toolbar(*items, should_group_when_full: true, type: :toolbar, &block)
+        if @config[type].blank? || !items.empty?
+          @config[type] = {
             items: items,
             shouldNotGroupWhenFull: !should_group_when_full
           }
         end
-        builder = ToolbarBuilder.new(@config[:toolbar][:items])
+        builder = ToolbarBuilder.new(@config[type][:items])
         builder.instance_eval(&block) if block_given?
         builder
       end
+      # Configure block toolbar items and grouping
+      # @param items [Array<Symbol>] Toolbar items to include
+      # @param kwargs [Hash] Additional toolbar configuration options
+      # @option kwargs [Boolean] :should_group_when_full Enable/disable toolbar item grouping
+      # @yield Optional block for additional toolbar configuration
+      # @return [ToolbarBuilder] Toolbar configuration
+      # @example Configure block toolbar items
+      #   block_toolbar :heading, :paragraph, :blockQuote
+      # @example Configure with block
+      #   block_toolbar do
+      #     append :table
+      #     remove :paragraph
+      #   end
+      def block_toolbar(*items, **kwargs, &block)
+        toolbar(*items, **kwargs, type: :blockToolbar, &block)
+      end
+      # Configure balloon toolbar items and grouping
+      # @param items [Array<Symbol>] Toolbar items to include
+      # @param kwargs [Hash] Additional toolbar configuration options
+      # @option kwargs [Boolean] :should_group_when_full Enable/disable toolbar item grouping
+      # @yield Optional block for additional toolbar configuration
+      # @return [ToolbarBuilder] Toolbar configuration
+      # @example Configure balloon toolbar items
+      #   balloon_toolbar :bold, :italic, :link
+      # @example Configure with block
+      #   balloon_toolbar do
+      #     append :textColor
+      #     remove :italic
+      #   end
+      def balloon_toolbar(*items, **kwargs, &block)
+        toolbar(*items, **kwargs, type: :balloonToolbar, &block)
+      end
       # Check if language is configured
       # @return [Boolean]
       def language?

data/lib/ckeditor5/rails/version.rb CHANGED Viewed

@@ -2,8 +2,8 @@
 module CKEditor5
   module Rails
-    VERSION = '1.23.0'
+    VERSION = '1.23.2'
-    DEFAULT_CKEDITOR_VERSION = '44.0.0'
+    DEFAULT_CKEDITOR_VERSION = '44.1.0'
   end
 end

data/spec/lib/ckeditor5/rails/editor/editable_height_normalizer_spec.rb CHANGED Viewed

@@ -6,9 +6,7 @@ RSpec.describe CKEditor5::Rails::Editor::EditableHeightNormalizer do
   subject(:normalizer) { described_class.new(editor_type) }
   describe '#normalize' do
-    context 'when editor type is classic' do
-      let(:editor_type) { :classic }
+    shared_examples 'height normalization' do
       it 'returns nil when value is nil' do
         expect(normalizer.normalize(nil)).to be_nil
       end
@@ -36,13 +34,23 @@ RSpec.describe CKEditor5::Rails::Editor::EditableHeightNormalizer do
       end
     end
-    context 'when editor type is not classic' do
+    context 'when editor type is classic' do
+      let(:editor_type) { :classic }
+      include_examples 'height normalization'
+    end
+    context 'when editor type is balloon' do
+      let(:editor_type) { :balloon }
+      include_examples 'height normalization'
+    end
+    context 'when editor type is not supported' do
       let(:editor_type) { :inline }
       it 'raises error' do
         expect { normalizer.normalize(500) }.to raise_error(
           CKEditor5::Rails::Editor::InvalidEditableHeightError,
-          'editable_height can be used only with ClassicEditor'
+          'editable_height can be used only with ClassicEditor or BalloonEditor'
         )
       end
     end

data/spec/lib/ckeditor5/rails/presets/preset_builder_spec.rb CHANGED Viewed

@@ -194,6 +194,50 @@ RSpec.describe CKEditor5::Rails::Presets::PresetBuilder do
         expect(plugin_names).to include(:SimpleUploadAdapter)
       end
     end
+    describe '#block_toolbar' do
+      it 'configures block toolbar items' do
+        builder.block_toolbar(:heading, :paragraph, should_group_when_full: false)
+        expect(builder.config[:blockToolbar]).to eq({
+                                                      items: %i[heading paragraph],
+                                                      shouldNotGroupWhenFull: true
+                                                    })
+      end
+      it 'accepts a configuration block' do
+        builder.block_toolbar do
+          append :table
+          remove :paragraph
+        end
+        expect(builder.config[:blockToolbar][:items]).to include(:table)
+      end
+      it 'returns ToolbarBuilder instance if no block provided' do
+        expect(builder.block_toolbar).to be_a(CKEditor5::Rails::Presets::ToolbarBuilder)
+      end
+    end
+    describe '#balloon_toolbar' do
+      it 'configures balloon toolbar items' do
+        builder.balloon_toolbar(:bold, :italic, should_group_when_full: false)
+        expect(builder.config[:balloonToolbar]).to eq({
+                                                        items: %i[bold italic],
+                                                        shouldNotGroupWhenFull: true
+                                                      })
+      end
+      it 'accepts a configuration block' do
+        builder.balloon_toolbar do
+          append :textColor
+          remove :italic
+        end
+        expect(builder.config[:balloonToolbar][:items]).to include(:textColor)
+      end
+      it 'returns ToolbarBuilder instance if no block provided' do
+        expect(builder.balloon_toolbar).to be_a(CKEditor5::Rails::Presets::ToolbarBuilder)
+      end
+    end
   end
   describe '#inline_plugin' do

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.23.0
+  version: 1.23.2
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-04 00:00:00.000000000 Z
+date: 2024-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails