ckeditor5 1.15.9 → 1.15.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 604312ff3ad324ca5ebbccca70efe7157e9ee67608d6a3b8d3b2d4b7c070213b
-  data.tar.gz: 8c44e0810acd1bb837cdcc8a37c4fb3051b5323a243e7b5a16341e9c8e3ef9a7
+  metadata.gz: 1cdcc72197788bc6dc57bb3b01158c932dbf27621084414bc832c5d772e01701
+  data.tar.gz: 7d6874e08d93346f9d478f46e2240bbc5df78a32700f50087de8fe8e4301cfc8
 SHA512:
-  metadata.gz: 54fc1a049c23a9c45bee8fc307de81f7976407850d068f018e715396b93a47e3c37f77c45682ba7ee4f36fe1d5cef156eeb5791dbf0793c35503a93e09e41f8a
-  data.tar.gz: 23a2299e6b8685cf120fa40be70d23737ec68f732e6e96af4428d785234600ab17a24596f4d4794093b14fdd0625b20e3a2953950659e0ab0c9deda7fc2c1cc9
+  metadata.gz: 7dc9311974b2dd72a05fd61cea086585179e64700f800618d06f4bffd079f31ad99d31f1ea5917d7c28cdd4e03d675122b546d25518ed43a99928f2061afd448
+  data.tar.gz: 199da996b61646c658dbbe0c8119419220b669442a5eba6fc1c973dad7793e3db8e3a1e8808e075e8d0477236fd8741fa2927eae9c141fc7bb87364df6fee7ae

data/lib/ckeditor5/rails/engine.rb

@@ -45,7 +45,7 @@ module CKEditor5::Rails
       def find_preset(preset)
         return preset if preset.is_a?(CKEditor5::Rails::Presets::PresetBuilder)
 
-        Engine.base.presets[preset]
+        base.presets[preset]
       end
     end
 
@@ -54,7 +54,8 @@ module CKEditor5::Rails
 
       delegate :version, :gpl, :premium, :cdn, :translations, :license_key,
                :type, :menubar, :toolbar, :plugins, :plugin, :inline_plugin,
-               :language, :ckbox, :configure, to: :default_preset
+               :language, :ckbox, :configure, :automatic_upgrades, :simple_upload_adapter,
+               :editable_height, to: :default_preset
 
       def initialize(configuration)
         @configuration = configuration

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

@@ -2,10 +2,10 @@
 
 module CKEditor5::Rails
   class Presets::PluginsBuilder
-    attr_reader :plugins
+    attr_reader :items
 
     def initialize(plugins)
-      @plugins = plugins
+      @items = plugins
     end
 
     def self.create_plugin(name, **kwargs)
@@ -17,19 +17,19 @@ module CKEditor5::Rails
     end
 
     def remove(*names)
-      names.each { |name| plugins.delete_if { |plugin| plugin.name == name } }
+      names.each { |name| items.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 }
+        index = items.index { |p| p.name == before }
         raise ArgumentError, "Plugin '#{before}' not found" unless index
 
-        plugins.insert(index, *new_plugins)
+        items.insert(index, *new_plugins)
       else
-        plugins.insert(0, *new_plugins)
+        items.insert(0, *new_plugins)
       end
     end
 
@@ -37,12 +37,12 @@ module CKEditor5::Rails
       new_plugins = names.map { |name| self.class.create_plugin(name, **kwargs) }
 
       if after
-        index = plugins.index { |p| p.name == after }
+        index = items.index { |p| p.name == after }
         raise ArgumentError, "Plugin '#{after}' not found" unless index
 
-        plugins.insert(index + 1, *new_plugins)
+        items.insert(index + 1, *new_plugins)
       else
-        plugins.push(*new_plugins)
+        items.push(*new_plugins)
       end
     end
   end

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

@@ -162,10 +162,9 @@ module CKEditor5::Rails
           }
         end
 
-        return unless block
-
         builder = ToolbarBuilder.new(@config[:toolbar][:items])
-        builder.instance_eval(&block)
+        builder.instance_eval(&block) if block_given?
+        builder
       end
 
       def inline_plugin(name, code)
@@ -183,10 +182,9 @@ module CKEditor5::Rails
 
         names.each { |name| plugin(name, **kwargs) } unless names.empty?
 
-        return unless block
-
         builder = PluginsBuilder.new(@config[:plugins])
-        builder.instance_eval(&block)
+        builder.instance_eval(&block) if block_given?
+        builder
       end
 
       def language(ui = nil, content: ui) # rubocop:disable Naming/MethodParameterName

data/lib/ckeditor5/rails/version.rb

@@ -2,7 +2,7 @@
 
 module CKEditor5
   module Rails
-    VERSION = '1.15.9'
+    VERSION = '1.15.10'
 
     DEFAULT_CKEDITOR_VERSION = '43.3.1'
   end

data/spec/lib/ckeditor5/rails/assets/asset_bundle_hml_serializer_spec.rb

@@ -86,6 +86,13 @@ RSpec.describe CKEditor5::Rails::Assets::AssetsBundleHtmlSerializer do
     it 'includes web component script' do
       expect(html).to include('<script type="module" nonce="true">')
     end
+
+    it 'memoizes scripts import map' do
+      first_call = serializer.send(:scripts_import_map_tag)
+      second_call = serializer.send(:scripts_import_map_tag)
+
+      expect(first_call.object_id).to eq(second_call.object_id)
+    end
   end
 
   describe '.url_resource_preload_type' do

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

@@ -160,7 +160,25 @@ RSpec.describe CKEditor5::Rails::Cdn::Helpers do
         )
       end
 
-      it 'raises error when version is missing' do
+      before do
+        allow(helper).to receive(:merge_with_editor_preset).and_return({})
+      end
+
+      it 'raises error about missing required parameters' do
+        expect { helper.ckeditor5_assets(preset: :default) }
+          .to raise_error(NoMatchingPatternKeyError)
+      end
+    end
+
+    context 'with empty hash from preset' do
+      let(:preset) do
+        instance_double(
+          CKEditor5::Rails::Presets::PresetBuilder,
+          to_h_with_overrides: {}
+        )
+      end
+
+      it 'raises error about missing version and type' do
         expect { helper.ckeditor5_assets(preset: :default) }
           .to raise_error(ArgumentError, /forgot to define version/)
       end

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe CKEditor5::Rails::Engine do
+  describe 'configuration' do
+    let(:preset) { instance_double(CKEditor5::Rails::Presets::PresetBuilder) }
+    let(:preset_manager) { instance_double(CKEditor5::Rails::Presets::Manager) }
+
+    before do
+      allow(described_class).to receive(:base).and_return(ActiveSupport::OrderedOptions.new)
+      allow(described_class.base).to receive(:presets).and_return(preset_manager)
+      allow(preset_manager).to receive(:default).and_return(preset)
+    end
+
+    it 'has default configuration' do
+      expect(described_class.base).to be_a(ActiveSupport::OrderedOptions)
+
+      default_preset = described_class.default_preset
+
+      expect(default_preset.type).to eq(:classic)
+      expect(default_preset.toolbar.items).to include(:undo, :redo, :'|', :heading)
+      expect(default_preset.plugins.items.map(&:name)).to include(:Essentials, :Paragraph, :Heading)
+    end
+
+    describe '.configure' do
+      it 'yields configuration proxy' do
+        yielded_config = nil
+        described_class.configure do |config|
+          yielded_config = config
+        end
+        expect(yielded_config).to be_a(described_class::ConfigurationProxy)
+      end
+
+      it 'allows configuring default preset' do
+        described_class.configure do
+          automatic_upgrades enabled: false
+          version '35.0.0'
+          license_key '1234567'
+        end
+
+        expect(described_class.default_preset.version).to eq('35.0.0')
+        expect(described_class.default_preset.license_key).to eq('1234567')
+      end
+    end
+
+    describe '.find_preset' do
+      before do
+        allow(preset_manager).to receive(:[]).with(:custom).and_return(preset)
+        allow(preset_manager).to receive(:[]).with(
+          kind_of(CKEditor5::Rails::Presets::PresetBuilder)
+        ).and_return(preset)
+      end
+
+      it 'returns preset instance if provided' do
+        test_preset = CKEditor5::Rails::Presets::PresetBuilder.new
+        expect(described_class.find_preset(test_preset)).to eq(test_preset)
+      end
+
+      it 'looks up preset by name' do
+        expect(described_class.find_preset(:custom)).to eq(preset)
+      end
+    end
+  end
+
+  describe 'initializers' do
+    describe 'helper initializer' do
+      it 'includes helpers in ActionView and ActionController' do
+        expect(ActionView::Base.included_modules).to include(CKEditor5::Rails::Helpers)
+        expect(ActionController::Base.included_modules).to include(CKEditor5::Rails::Helpers)
+      end
+    end
+
+    describe 'form_builder initializer' do
+      it 'includes FormBuilderExtension in ActionView::Helpers::FormBuilder' do
+        expect(ActionView::Helpers::FormBuilder.included_modules)
+          .to include(CKEditor5::Rails::Hooks::Form::FormBuilderExtension)
+      end
+    end
+
+    describe 'simple_form initializer', if: defined?(SimpleForm) do
+      it 'registers ckeditor5 input type' do
+        expect(SimpleForm::FormBuilder.mappings[:ckeditor5])
+          .to eq(CKEditor5::Rails::Hooks::SimpleForm::CKEditor5Input)
+      end
+    end
+  end
+end

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

@@ -42,6 +42,162 @@ RSpec.describe CKEditor5::Rails::Hooks::Form do
                                               })
         end
       end
+
+      context 'with as parameter' do
+        subject(:rendered_editor) do
+          builder.build_editor(:content, as: 'custom_field')
+        end
+
+        it 'uses custom field name' do
+          expect(rendered_editor).to have_tag('ckeditor-component', with: {
+                                                name: 'post[custom_field]'
+                                              })
+        end
+      end
+
+      context 'without object_name' do
+        let(:builder) { described_class.new('', post, template) }
+
+        it 'uses method name as field name' do
+          expect(rendered_editor).to have_tag('ckeditor-component', with: {
+                                                name: 'content'
+                                              })
+        end
+
+        context 'with as parameter' do
+          subject(:rendered_editor) do
+            builder.build_editor(:content, as: 'custom_field')
+          end
+
+          it 'uses as parameter as field name' do
+            expect(rendered_editor).to have_tag('ckeditor-component', with: {
+                                                  name: 'custom_field'
+                                                })
+          end
+        end
+      end
+
+      context 'with initial data handling' do
+        before do
+          allow(template).to receive(:ckeditor5_editor)
+        end
+
+        context 'when object responds to the method' do
+          it 'passes object method value as initial_data' do
+            builder.build_editor(:content)
+
+            expect(template).to have_received(:ckeditor5_editor)
+              .with(hash_including(initial_data: 'Initial content'))
+          end
+        end
+
+        context 'when object does not respond to the method' do
+          let(:post) { double('Post') }
+
+          it 'passes options initial_data value' do
+            builder.build_editor(:content, initial_data: 'Provided content')
+
+            expect(template).to have_received(:ckeditor5_editor)
+              .with(hash_including(initial_data: 'Provided content'))
+          end
+        end
+      end
+
+      context 'with validation classes handling' do
+        before do
+          allow(template).to receive(:ckeditor5_editor)
+        end
+
+        context 'when object has errors on the field' do
+          let(:post) do
+            instance_double('Post', errors: { content: ['is invalid'] })
+          end
+
+          it 'adds is-invalid class' do
+            builder.build_editor(:content, class: 'custom-class')
+
+            expect(template).to have_received(:ckeditor5_editor)
+              .with(hash_including(class: 'custom-class is-invalid'))
+          end
+
+          it 'adds is-invalid class when no initial class exists' do
+            builder.build_editor(:content)
+
+            expect(template).to have_received(:ckeditor5_editor)
+              .with(hash_including(class: 'is-invalid'))
+          end
+        end
+
+        context 'when object has no errors' do
+          let(:post) do
+            instance_double('Post', errors: {})
+          end
+
+          it 'keeps original class unchanged' do
+            builder.build_editor(:content, class: 'custom-class')
+
+            expect(template).to have_received(:ckeditor5_editor)
+              .with(hash_including(class: 'custom-class'))
+          end
+        end
+
+        context 'when object does not respond to errors' do
+          let(:post) { double('Post') }
+
+          it 'keeps original class unchanged' do
+            builder.build_editor(:content, class: 'custom-class')
+
+            expect(template).to have_received(:ckeditor5_editor)
+              .with(hash_including(class: 'custom-class'))
+          end
+        end
+      end
+    end
+  end
+
+  describe CKEditor5::Rails::Hooks::Form::FormBuilderExtension do
+    let(:template) { instance_double('ActionView::Base') }
+    let(:object) { double('Post') }
+    let(:builder) do
+      Class.new do
+        include CKEditor5::Rails::Hooks::Form::FormBuilderExtension
+        attr_reader :object_name, :object, :template
+
+        def initialize(object_name, object, template)
+          @object_name = object_name
+          @object = object
+          @template = template
+        end
+      end.new('post', object, template)
+    end
+
+    describe '#ckeditor5' do
+      let(:input_builder) { instance_double(CKEditor5::Rails::Hooks::Form::EditorInputBuilder) }
+
+      before do
+        allow(CKEditor5::Rails::Hooks::Form::EditorInputBuilder)
+          .to receive(:new)
+          .with('post', object, template)
+          .and_return(input_builder)
+        allow(input_builder).to receive(:build_editor)
+      end
+
+      it 'creates EditorInputBuilder with correct parameters' do
+        builder.ckeditor5(:content, class: 'custom-class')
+
+        expect(CKEditor5::Rails::Hooks::Form::EditorInputBuilder)
+          .to have_received(:new)
+          .with('post', object, template)
+      end
+
+      it 'calls build_editor with correct parameters' do
+        options = { class: 'custom-class' }
+        builder.ckeditor5(:content, options)
+
+        expect(input_builder)
+          .to have_received(:build_editor)
+          .with(:content, options)
+      end
     end
   end
 end

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe CKEditor5::Rails::Hooks::SimpleForm::CKEditor5Input do
+  let(:template) { instance_double('ActionView::Base') }
+  let(:object) { double('Post', content: 'Initial content') }
+  let(:object_name) { 'post' }
+  let(:builder) do
+    double('FormBuilder',
+           object: object,
+           object_name: object_name,
+           template: template)
+  end
+  let(:attribute_name) { :content }
+  let(:input_html_options) { {} }
+  let(:input_options) { {} }
+
+  subject(:input) do
+    described_class.new(builder, attribute_name, nil, input_html_options, input_options)
+  end
+
+  before do
+    allow(template).to receive(:ckeditor5_editor)
+  end
+
+  describe '#input' do
+    it 'renders ckeditor with default options' do
+      input.input
+
+      expect(template).to have_received(:ckeditor5_editor).with(
+        hash_including(
+          preset: :default,
+          type: :classic,
+          config: nil,
+          initial_data: 'Initial content',
+          name: 'post[content]',
+          class: [{}, :required] # Simple Form adds these classes by default
+        )
+      )
+    end
+
+    context 'with custom options' do
+      let(:input_options) do
+        {
+          preset: :custom_preset,
+          type: :inline,
+          config: { toolbar: [:bold] }
+        }
+      end
+      let(:input_html_options) do
+        { class: 'custom-class', id: 'custom-id' }
+      end
+
+      it 'renders ckeditor with merged options' do
+        input.input
+
+        expect(template).to have_received(:ckeditor5_editor).with(
+          hash_including(
+            preset: :custom_preset,
+            type: :inline,
+            config: { toolbar: [:bold] },
+            initial_data: 'Initial content',
+            name: 'post[content]',
+            class: [{ class: 'custom-class', id: 'custom-id' }, :required]
+          )
+        )
+      end
+    end
+
+    context 'when object does not respond to attribute' do
+      let(:object) { double('Post') }
+      let(:input_options) { { initial_data: 'Provided content' } }
+
+      it 'uses initial_data from options' do
+        input.input
+
+        expect(template).to have_received(:ckeditor5_editor).with(
+          hash_including(initial_data: 'Provided content')
+        )
+      end
+    end
+
+    context 'with wrapper options' do
+      let(:wrapper_options) { { wrapper_class: 'wrapper' } }
+      let(:input_html_options) { { class: 'input' } }
+
+      it 'merges wrapper options with input options' do
+        input.input(wrapper_options)
+
+        expect(template).to have_received(:ckeditor5_editor).with(
+          hash_including(
+            class: [{ class: 'input' }, :required],
+            wrapper_class: 'wrapper'
+          )
+        )
+      end
+    end
+  end
+end

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

@@ -3,8 +3,8 @@
 require 'spec_helper'
 
 RSpec.describe CKEditor5::Rails::Presets::PluginsBuilder do
-  let(:plugins) { [] }
-  let(:builder) { described_class.new(plugins) }
+  let(:items) { [] }
+  let(:builder) { described_class.new(items) }
 
   describe '.create_plugin' do
     context 'when name is a string' do
@@ -27,7 +27,7 @@ RSpec.describe CKEditor5::Rails::Presets::PluginsBuilder do
 
   describe '#remove' do
     before do
-      plugins.push(
+      items.push(
         CKEditor5::Rails::Editor::PropsPlugin.new('Plugin1'),
         CKEditor5::Rails::Editor::PropsPlugin.new('Plugin2'),
         CKEditor5::Rails::Editor::PropsPlugin.new('Plugin3')
@@ -36,7 +36,7 @@ RSpec.describe CKEditor5::Rails::Presets::PluginsBuilder do
 
     it 'removes specified plugins' do
       builder.remove('Plugin1', 'Plugin3')
-      expect(plugins.map(&:name)).to eq(['Plugin2'])
+      expect(items.map(&:name)).to eq(['Plugin2'])
     end
   end
 
@@ -44,20 +44,20 @@ RSpec.describe CKEditor5::Rails::Presets::PluginsBuilder do
     let(:existing_plugin) { CKEditor5::Rails::Editor::PropsPlugin.new('ExistingPlugin') }
 
     before do
-      plugins.push(existing_plugin)
+      items.push(existing_plugin)
     end
 
     context 'without before option' do
       it 'adds plugins at the beginning' do
         builder.prepend('NewPlugin1', 'NewPlugin2')
-        expect(plugins.map(&:name)).to eq(%w[NewPlugin1 NewPlugin2 ExistingPlugin])
+        expect(items.map(&:name)).to eq(%w[NewPlugin1 NewPlugin2 ExistingPlugin])
       end
     end
 
     context 'with before option' do
       it 'adds plugins before specified plugin' do
         builder.prepend('NewPlugin', before: 'ExistingPlugin')
-        expect(plugins.map(&:name)).to eq(%w[NewPlugin ExistingPlugin])
+        expect(items.map(&:name)).to eq(%w[NewPlugin ExistingPlugin])
       end
 
       it 'raises error when target plugin not found' do
@@ -72,20 +72,20 @@ RSpec.describe CKEditor5::Rails::Presets::PluginsBuilder do
     let(:existing_plugin) { CKEditor5::Rails::Editor::PropsPlugin.new('ExistingPlugin') }
 
     before do
-      plugins.push(existing_plugin)
+      items.push(existing_plugin)
     end
 
     context 'without after option' do
       it 'adds plugins at the end' do
         builder.append('NewPlugin1', 'NewPlugin2')
-        expect(plugins.map(&:name)).to eq(%w[ExistingPlugin NewPlugin1 NewPlugin2])
+        expect(items.map(&:name)).to eq(%w[ExistingPlugin NewPlugin1 NewPlugin2])
       end
     end
 
     context 'with after option' do
       it 'adds plugins after specified plugin' do
         builder.append('NewPlugin', after: 'ExistingPlugin')
-        expect(plugins.map(&:name)).to eq(%w[ExistingPlugin NewPlugin])
+        expect(items.map(&:name)).to eq(%w[ExistingPlugin NewPlugin])
       end
 
       it 'raises error when target plugin not found' do

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

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+require_relative './plugins_builder_spec'
+require_relative './toolbar_builder_spec'
 
 RSpec.describe CKEditor5::Rails::Presets::PresetBuilder do
   let(:builder) { described_class.new }
@@ -139,6 +141,10 @@ RSpec.describe CKEditor5::Rails::Presets::PresetBuilder do
         end
         expect(builder.config[:toolbar][:items]).to include(:bold, :italic, :undo)
       end
+
+      it 'returns ToolbarBuilder instance if no block provided' do
+        expect(builder.toolbar).to be_a(CKEditor5::Rails::Presets::ToolbarBuilder)
+      end
     end
 
     describe '#plugins' do
@@ -157,6 +163,10 @@ RSpec.describe CKEditor5::Rails::Presets::PresetBuilder do
         plugin_names = builder.config[:plugins].map { |p| p.name.to_s }
         expect(plugin_names).to eq(%w[Paragraph Essentials])
       end
+
+      it 'returns PluginsBuilder instance if no block provided' do
+        expect(builder.plugins).to be_a(CKEditor5::Rails::Presets::PluginsBuilder)
+      end
     end
 
     describe '#simple_upload_adapter' do

data/spec/spec_helper.rb

@@ -14,7 +14,7 @@ SimpleCov.start do
 
   track_files 'lib/**/*.rb'
 
-  minimum_coverage 98
+  minimum_coverage 100
 
   formatters = [
     SimpleCov::Formatter::HTMLFormatter,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.15.9
+  version: 1.15.10
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -90,7 +90,9 @@ files:
 - spec/lib/ckeditor5/rails/editor/props_inline_plugin_spec.rb
 - spec/lib/ckeditor5/rails/editor/props_plugin_spec.rb
 - spec/lib/ckeditor5/rails/editor/props_spec.rb
+- spec/lib/ckeditor5/rails/engine_spec.rb
 - spec/lib/ckeditor5/rails/hooks/form_spec.rb
+- spec/lib/ckeditor5/rails/hooks/simple_form_spec.rb
 - spec/lib/ckeditor5/rails/presets/manager_spec.rb
 - spec/lib/ckeditor5/rails/presets/plugins_builder_spec.rb
 - spec/lib/ckeditor5/rails/presets/preset_builder_spec.rb
@@ -138,7 +140,9 @@ test_files:
 - spec/lib/ckeditor5/rails/editor/props_inline_plugin_spec.rb
 - spec/lib/ckeditor5/rails/editor/props_plugin_spec.rb
 - spec/lib/ckeditor5/rails/editor/props_spec.rb
+- spec/lib/ckeditor5/rails/engine_spec.rb
 - spec/lib/ckeditor5/rails/hooks/form_spec.rb
+- spec/lib/ckeditor5/rails/hooks/simple_form_spec.rb
 - spec/lib/ckeditor5/rails/presets/manager_spec.rb
 - spec/lib/ckeditor5/rails/presets/plugins_builder_spec.rb
 - spec/lib/ckeditor5/rails/presets/preset_builder_spec.rb