ckeditor5 1.20.1 → 1.22.0

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

@@ -16,30 +16,69 @@ RSpec.describe CKEditor5::Rails::Editor::Helpers::Editor do
   let(:context) { { preset: :default, cdn: :jsdelivr } }
 
   before do
+    RSpec::Mocks.space.proxy_for(CKEditor5::Rails::Engine).reset
+
     helper.instance_variable_set(:@__ckeditor_context, context)
+
     allow(preset).to receive(:type).and_return(:classic)
     allow(preset).to receive(:config).and_return({})
     allow(preset).to receive(:automatic_upgrades?).and_return(false)
+    allow(preset).to receive(:editable_height).and_return(nil)
   end
 
-  describe '#ckeditor5_editor' do
+  before do
+    test_class.send(:public, :ckeditor5_context_or_fallback)
+  end
+
+  describe '#ckeditor5_context_or_fallback' do
     before do
-      allow(helper).to receive(:find_preset).and_return(preset)
+      if helper.instance_variable_defined?(:@__ckeditor_context)
+        helper.remove_instance_variable(:@__ckeditor_context)
+      end
     end
 
-    it 'raises error when context is not defined' do
-      helper.remove_instance_variable(:@__ckeditor_context)
-      expect { helper.ckeditor5_editor }.to raise_error(
-        described_class::EditorContextError,
-        /CKEditor installation context is not defined/
-      )
+    it 'returns existing context when available' do
+      context = { preset: :custom, bundle: 'custom-bundle' }
+      helper.instance_variable_set(:@__ckeditor_context, context)
+
+      expect(helper.ckeditor5_context_or_fallback(nil)).to eq(context)
     end
 
-    it 'raises error when preset is not found' do
-      allow(helper).to receive(:find_preset).and_raise(described_class::PresetNotFoundError)
-      expect do
-        helper.ckeditor5_editor(preset: :unknown)
-      end.to raise_error(described_class::PresetNotFoundError)
+    it 'creates context from preset when provided' do
+      custom_preset = instance_double(CKEditor5::Rails::Presets::PresetBuilder)
+
+      allow(CKEditor5::Rails::Engine).to receive(:find_preset)
+        .with(:custom)
+        .and_return(custom_preset)
+
+      allow(helper).to receive(:create_preset_bundle)
+        .with(custom_preset)
+        .and_return('custom-bundle')
+
+      result = helper.ckeditor5_context_or_fallback(:custom)
+      expect(result).to match({
+                                bundle: 'custom-bundle',
+                                preset: custom_preset
+                              })
+    end
+
+    it 'returns fallback context when no context or preset is available' do
+      RSpec::Mocks.space.proxy_for(CKEditor5::Rails::Engine).reset
+
+      allow(CKEditor5::Rails::Engine).to receive(:default_preset)
+        .and_return(:default)
+
+      result = helper.ckeditor5_context_or_fallback(nil)
+      expect(result).to match({
+                                bundle: nil,
+                                preset: :default
+                              })
+    end
+  end
+
+  describe '#ckeditor5_editor' do
+    before do
+      allow(CKEditor5::Rails::Engine).to receive(:find_preset).with(:default).and_return(preset)
     end
 
     it 'merges extra configuration with preset config' do
@@ -124,10 +163,6 @@ RSpec.describe CKEditor5::Rails::Editor::Helpers::Editor do
     end
 
     context 'when using preset lookup' do
-      before do
-        RSpec::Mocks.space.proxy_for(helper).remove_stub(:find_preset)
-      end
-
       it 'uses default preset when none specified' do
         expect(CKEditor5::Rails::Engine).to receive(:find_preset)
           .with(:default)
@@ -154,15 +189,40 @@ RSpec.describe CKEditor5::Rails::Editor::Helpers::Editor do
         helper.ckeditor5_editor(preset: :explicit)
       end
 
-      it 'raises error when preset cannot be found' do
-        allow(CKEditor5::Rails::Engine).to receive(:find_preset)
-          .with(:unknown)
-          .and_return(nil)
+      it 'raises error when preset is not found' do
+        allow(CKEditor5::Rails::Engine).to receive(:find_preset).with(:unknown).and_return(nil)
+        expect do
+          helper.ckeditor5_editor(preset: :unknown)
+        end.to raise_error(CKEditor5::Rails::PresetNotFoundError)
+      end
+    end
+
+    it 'uses context from ckeditor5_context_or_fallback' do
+      custom_context = { preset: :custom, bundle: 'custom-bundle' }
+      allow(helper).to receive(:ckeditor5_context_or_fallback)
+        .with(nil)
+        .and_return(custom_context)
+
+      allow(CKEditor5::Rails::Engine).to receive(:find_preset)
+        .with(:custom)
+        .and_return(preset)
+
+      helper.ckeditor5_editor
+    end
+
+    context 'when using editable height' do
+      it 'uses editable height from preset when not explicitly provided' do
+        allow(preset).to receive(:editable_height).and_return(400)
+
+        expect(helper.ckeditor5_editor).to include('editable-height="400px"')
+      end
+
+      it 'uses editable height from options when provided' do
+        expect(helper.ckeditor5_editor(editable_height: 500)).to include('editable-height="500px"')
+
+        allow(preset).to receive(:editable_height).and_return(700)
 
-        expect { helper.ckeditor5_editor(preset: :unknown) }.to raise_error(
-          described_class::PresetNotFoundError,
-          'Preset unknown is not defined.'
-        )
+        expect(helper.ckeditor5_editor(editable_height: 600)).to include('editable-height="600px"')
       end
     end
   end

data/spec/lib/ckeditor5/rails/editor/props_spec.rb

@@ -3,34 +3,29 @@
 require 'spec_helper'
 
 RSpec.describe CKEditor5::Rails::Editor::Props do
-  let(:controller_context) do
-    {
-      bundle: double('Bundle', translations_scripts: [{ path: 'translations/en.js' }]),
-      license_key: nil
-    }
-  end
+  let(:bundle) { CKEditor5::Rails::Assets::AssetsBundle.new }
   let(:type) { :classic }
   let(:config) { { plugins: [], toolbar: { items: [] } } }
 
   describe '#initialize' do
     it 'accepts valid editor type' do
-      expect { described_class.new(controller_context, :classic, {}) }.not_to raise_error
+      expect { described_class.new(type, {}, bundle: bundle) }.not_to raise_error
     end
 
     it 'raises error for invalid editor type' do
-      expect { described_class.new(controller_context, :invalid, {}) }
+      expect { described_class.new(:invalid, {}, bundle: bundle) }
         .to raise_error(ArgumentError, 'Invalid editor type: invalid')
     end
   end
 
   describe '#to_attributes' do
-    subject(:props) { described_class.new(controller_context, type, config) }
+    subject(:props) { described_class.new(type, config, bundle: bundle) }
 
     it 'includes required attributes' do
       attributes = props.to_attributes
       expect(attributes).to include(
         type: 'ClassicEditor',
-        translations: String,
+        bundle: String,
         plugins: String,
         config: String,
         watchdog: true
@@ -38,33 +33,18 @@ RSpec.describe CKEditor5::Rails::Editor::Props do
     end
 
     context 'with editable height' do
-      subject(:props) { described_class.new(controller_context, type, config, editable_height: '500px') }
+      subject(:props) { described_class.new(type, config, bundle: bundle, editable_height: '500px') }
 
       it 'includes editable-height attribute' do
         expect(props.to_attributes['editable-height']).to eq('500px')
       end
     end
 
-    context 'with language' do
-      subject(:props) { described_class.new(controller_context, type, config, language: 'pl') }
-
-      it 'includes language in config' do
-        config_json = props.to_attributes[:config]
-
-        expect(config_json).to include('language')
-        expect(JSON.parse(config_json)['language']).to eq({ 'ui' => 'pl' })
-      end
-    end
-
-    context 'with license key' do
-      let(:controller_context) do
-        { bundle: double('Bundle', translations_scripts: []), license_key: 'ABC123' }
-      end
+    context 'with watchdog disabled' do
+      subject(:props) { described_class.new(type, config, bundle: bundle, watchdog: false) }
 
-      it 'includes license key in config' do
-        config_json = props.to_attributes[:config]
-        expect(config_json).to include('licenseKey')
-        expect(JSON.parse(config_json)['licenseKey']).to eq('ABC123')
+      it 'includes watchdog: false in attributes' do
+        expect(props.to_attributes[:watchdog]).to be false
       end
     end
   end
@@ -87,7 +67,7 @@ RSpec.describe CKEditor5::Rails::Editor::Props do
 
       it 'raises error when editable height is set' do
         expect do
-          described_class.new(controller_context, type, config, editable_height: '500px')
+          described_class.new(type, config, bundle: bundle, editable_height: '500px')
         end.to raise_error(CKEditor5::Rails::Editor::InvalidEditableHeightError)
       end
     end
@@ -96,18 +76,18 @@ RSpec.describe CKEditor5::Rails::Editor::Props do
       let(:type) { :classic }
 
       it 'accepts integer values' do
-        props = described_class.new(controller_context, type, config, editable_height: 500)
+        props = described_class.new(type, config, bundle: bundle, editable_height: 500)
         expect(props.to_attributes['editable-height']).to eq('500px')
       end
 
       it 'accepts pixel string values' do
-        props = described_class.new(controller_context, type, config, editable_height: '500px')
+        props = described_class.new(type, config, bundle: bundle, editable_height: '500px')
         expect(props.to_attributes['editable-height']).to eq('500px')
       end
 
       it 'raises error for invalid values' do
         expect do
-          described_class.new(controller_context, type, config, editable_height: '500em')
+          described_class.new(type, config, bundle: bundle, editable_height: '500em')
         end.to raise_error(CKEditor5::Rails::Editor::InvalidEditableHeightError)
       end
     end

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

@@ -61,6 +61,16 @@ RSpec.describe CKEditor5::Rails::Engine do
         expect(described_class.find_preset(:custom)).to eq(preset)
       end
     end
+
+    describe '.presets' do
+      before do
+        RSpec::Mocks.space.proxy_for(described_class).reset
+      end
+
+      it 'returns presets from configuration' do
+        expect(described_class.presets).to eq(described_class.base.presets)
+      end
+    end
   end
 
   describe 'initializers' do

data/spec/lib/ckeditor5/rails/hooks/form_spec.rb

@@ -11,18 +11,31 @@ RSpec.describe CKEditor5::Rails::Hooks::Form do
     end
 
     before do
-      template.ckeditor5_assets(version: '34.1.0')
+      template.ckeditor5_assets(version: '34.1.0', automatic_upgrades: false, cdn: :jsdelivr)
     end
 
     describe '#build_editor' do
       subject(:rendered_editor) { builder.build_editor(:content) }
 
       it 'renders ckeditor element' do
+        bundle_json = {
+          scripts: [
+            {
+              import_name: 'ckeditor5',
+              url: 'https://cdn.jsdelivr.net/npm/ckeditor5@34.1.0/dist/browser/ckeditor5.js',
+              translation: false
+            }
+          ],
+          stylesheets: [
+            'https://cdn.jsdelivr.net/npm/ckeditor5@34.1.0/dist/browser/ckeditor5.css'
+          ]
+        }.to_json
+
         attrs = {
           name: 'post[content]',
           id: 'post_content',
           type: 'ClassicEditor',
-          translations: '[]',
+          bundle: bundle_json,
           watchdog: 'true'
         }
 

data/spec/lib/ckeditor5/rails/plugins/wproofreader_spec.rb

@@ -24,6 +24,7 @@ RSpec.describe CKEditor5::Rails::Plugins::WProofreader do
         expected_hash = {
           type: :external,
           stylesheets: ["#{default_cdn}@#{default_version}/dist/browser/index.css"],
+          translation: false,
           url: "#{default_cdn}@#{default_version}/dist/browser/index.js",
           import_name: "#{default_cdn}@#{default_version}/dist/browser/index.js",
           import_as: 'WProofreader'
@@ -47,6 +48,7 @@ RSpec.describe CKEditor5::Rails::Plugins::WProofreader do
         expected_hash = {
           type: :external,
           stylesheets: ["#{custom_cdn}@#{custom_version}/dist/browser/index.css"],
+          translation: false,
           url: "#{custom_cdn}@#{custom_version}/dist/browser/index.js",
           import_name: "#{custom_cdn}@#{custom_version}/dist/browser/index.js",
           import_as: 'WProofreader'

data/spec/lib/ckeditor5/rails/presets/toolbar_builder_spec.rb

@@ -67,4 +67,123 @@ RSpec.describe CKEditor5::Rails::Presets::ToolbarBuilder do
       end
     end
   end
+
+  describe '#break_line' do
+    it 'returns line break symbol' do
+      expect(builder.break_line).to eq(:-)
+    end
+  end
+
+  describe '#separator' do
+    it 'returns separator symbol' do
+      expect(builder.separator).to eq(:|)
+    end
+  end
+
+  describe '#group' do
+    it 'creates and adds a new group' do
+      builder.group(:text, label: 'Text') do
+        append(:bold, :italic)
+      end
+
+      group = builder.items.last
+      expect(group).to be_a(CKEditor5::Rails::Presets::ToolbarGroupItem)
+      expect(group.name).to eq(:text)
+      expect(group.items).to eq(%i[bold italic])
+      expect(group.label).to eq('Text')
+    end
+
+    it 'creates group without configuration block' do
+      group = builder.group(:text, label: 'Text')
+
+      expect(group).to be_a(CKEditor5::Rails::Presets::ToolbarGroupItem)
+      expect(group.items).to be_empty
+    end
+  end
+
+  describe '#find_group' do
+    it 'returns group by name' do
+      builder.group(:text, label: 'Text')
+      builder.group(:formatting, label: 'Format')
+
+      group = builder.find_group(:formatting)
+      expect(group).to be_a(CKEditor5::Rails::Presets::ToolbarGroupItem)
+      expect(group.name).to eq(:formatting)
+    end
+
+    it 'returns nil when group not found' do
+      expect(builder.find_group(:nonexistent)).to be_nil
+    end
+  end
+
+  describe '#remove_group' do
+    it 'removes group by name' do
+      builder.group(:text, label: 'Text')
+      builder.group(:formatting, label: 'Format')
+
+      builder.remove_group(:text)
+      expect(builder.find_group(:text)).to be_nil
+      expect(builder.find_group(:formatting)).to be_present
+    end
+
+    it 'ignores non-existent groups' do
+      builder.group(:text, label: 'Text')
+
+      expect { builder.remove_group(:nonexistent) }.not_to(change { builder.items.count })
+    end
+  end
+
+  describe 'interacting with groups' do
+    let(:text_group) do
+      builder.group(:text, label: 'Text') do
+        append(:bold, :italic)
+      end
+    end
+
+    before do
+      text_group
+    end
+
+    it 'prepends items before group' do
+      builder.prepend(:undo, :redo, before: :text)
+      expect(builder.items.map { |i| i.is_a?(CKEditor5::Rails::Presets::ToolbarGroupItem) ? i.name : i })
+        .to eq(%i[bold italic | link undo redo text])
+    end
+
+    it 'appends items after group' do
+      builder.append(:undo, :redo, after: :text)
+      expect(builder.items.map { |i| i.is_a?(CKEditor5::Rails::Presets::ToolbarGroupItem) ? i.name : i })
+        .to eq(%i[bold italic | link text undo redo])
+    end
+
+    it 'removes group using remove method' do
+      builder.remove(:text)
+      expect(builder.items).to eq(%i[bold italic | link])
+    end
+  end
+end
+
+RSpec.describe CKEditor5::Rails::Presets::ToolbarGroupItem do
+  let(:items) { %i[bold italic] }
+  let(:group) { described_class.new(:formatting, items, label: 'Format', icon: 'format') }
+
+  describe '#initialize' do
+    it 'creates a group with given parameters' do
+      expect(group.name).to eq(:formatting)
+      expect(group.items).to eq(items)
+      expect(group.label).to eq('Format')
+      expect(group.icon).to eq('format')
+    end
+  end
+
+  it 'inherits toolbar manipulation methods' do
+    group.append(:underline)
+    expect(group.items).to eq(%i[bold italic underline])
+
+    group.prepend(:heading)
+    expect(group.items).to eq(%i[heading bold italic underline])
+
+    group.remove(:italic)
+    expect(group.items).to eq(%i[heading bold underline])
+  end
 end

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

@@ -118,7 +118,7 @@ RSpec.describe CKEditor5::Rails::VersionDetector do
 
   private
 
-  def setup_http_mock(response) # rubocop:disable Metrics/AbcSize
+  def setup_http_mock(response)
     allow(Net::HTTP).to receive(:new).and_return(
       double('Net::HTTP').tap do |http|
         allow(http).to receive(:use_ssl=)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.20.1
+  version: 1.22.0
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-02 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,6 +53,7 @@ files:
 - 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/concerns/bundle_builder.rb
 - lib/ckeditor5/rails/cdn/helpers.rb
 - lib/ckeditor5/rails/cdn/url_generator.rb
 - lib/ckeditor5/rails/context/helpers.rb
@@ -83,9 +84,11 @@ files:
 - lib/ckeditor5/rails/semver.rb
 - lib/ckeditor5/rails/version.rb
 - lib/ckeditor5/rails/version_detector.rb
+- spec/e2e/features/ajax_form_integration_spec.rb
 - spec/e2e/features/context_spec.rb
 - spec/e2e/features/editor_types_spec.rb
 - spec/e2e/features/form_integration_spec.rb
+- spec/e2e/features/lazy_assets_spec.rb
 - spec/e2e/features/locale_spec.rb
 - spec/e2e/spec_helper.rb
 - spec/e2e/support/eventually.rb
@@ -149,9 +152,11 @@ signing_key:
 specification_version: 4
 summary: CKEditor 5 for Rails
 test_files:
+- spec/e2e/features/ajax_form_integration_spec.rb
 - spec/e2e/features/context_spec.rb
 - spec/e2e/features/editor_types_spec.rb
 - spec/e2e/features/form_integration_spec.rb
+- spec/e2e/features/lazy_assets_spec.rb
 - spec/e2e/features/locale_spec.rb
 - spec/e2e/spec_helper.rb
 - spec/e2e/support/eventually.rb