ckeditor5 1.15.10 → 1.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cdcc72197788bc6dc57bb3b01158c932dbf27621084414bc832c5d772e01701
-  data.tar.gz: 7d6874e08d93346f9d478f46e2240bbc5df78a32700f50087de8fe8e4301cfc8
+  metadata.gz: 95f068ef75561d88a26a68c5aafa6e6f86b55405984e83bf35909085f288f9ba
+  data.tar.gz: d72e733641c5ac8c4f9d1e20731d54ffd2c0e4d88bc3b82618eb62b8c2820049
 SHA512:
-  metadata.gz: 7dc9311974b2dd72a05fd61cea086585179e64700f800618d06f4bffd079f31ad99d31f1ea5917d7c28cdd4e03d675122b546d25518ed43a99928f2061afd448
-  data.tar.gz: 199da996b61646c658dbbe0c8119419220b669442a5eba6fc1c973dad7793e3db8e3a1e8808e075e8d0477236fd8741fa2927eae9c141fc7bb87364df6fee7ae
+  metadata.gz: 31fb63fa1ac20061e1c28150178b7b8f92ca54e99073f2e180a7823d7f76f58c75a9f55e70b9a6f729d9715389b1a349305027e6d6c0c56bb2f7539d1a6bc0ad
+  data.tar.gz: 4019ffcc8e326be64930092815d5ff68436e4c242a67853adf735b4667aa7bec624df66fe9614d0f7e4bb00c67c2c0cf0e1195c43647d397b9f99ab8a0637479

data/Gemfile

@@ -24,6 +24,7 @@ end
 
 group :test, :development do
   gem 'capybara', '~> 3.40'
+  gem 'cuprite', '~> 0.15.0'
   gem 'rspec', '~> 3.13'
   gem 'rspec-expectations', '~> 3.13'
   gem 'rspec-html-matchers', '~> 0.10.0'

data/lib/ckeditor5/rails/version.rb

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

data/spec/e2e/features/editor_types_spec.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require 'e2e/spec_helper'
+
+RSpec.describe 'CKEditor5 Types Integration', type: :feature, js: true do
+  shared_examples 'an editor' do |path|
+    before { visit path }
+
+    it 'loads and initializes the editor' do
+      expect(page).to have_css('.ck-editor__editable', wait: 10)
+    end
+  end
+
+  shared_examples 'an editor that fires change event with main payload' do |path|
+    before { visit path }
+
+    it 'sends properly change events with proper payload' do
+      editor = first('.ck-editor__editable')
+
+      # Set up detailed change event listener
+      page.execute_script(<<~JS)
+        window._editorEvents = [];
+        document.querySelector('ckeditor-component').addEventListener('editor-change', (e) => {
+          window._editorEvents.push({
+            data: e.detail.data,
+            hasEditor: !!e.detail.editor
+          });
+        });
+      JS
+
+      # Clear editor and type text
+      editor.click
+      editor.send_keys([[:control, 'a'], :backspace])
+      editor.send_keys('Hello from keyboard!')
+
+      # Wait for change events and verify the last one
+      eventually do
+        events = page.evaluate_script('window._editorEvents')
+        last_event = events.last
+
+        expect(last_event['data']).to eq('main' => '<p>Hello from keyboard!</p>')
+        expect(last_event['hasEditor']).to be true
+      end
+    end
+  end
+
+  shared_examples 'a multiroot editor that fires change events' do |path, editables| # rubocop:disable Metrics/BlockLength
+    before { visit path }
+
+    it 'sends properly change events with proper payload for editables' do # rubocop:disable Metrics/BlockLength
+      editors = editables.map do |name|
+        find("[data-testid='#{name}-editable']")
+      end
+
+      # Set up detailed change event listener
+      page.execute_script(<<~JS)
+        window._editorEvents = [];
+        document.querySelector('ckeditor-component').addEventListener('editor-change', (e) => {
+          window._editorEvents.push({
+            data: e.detail.data,
+            hasEditor: !!e.detail.editor
+          });
+        });
+      JS
+
+      # Test each editable
+      expected_data = {}
+      editors.each_with_index do |editor, index|
+        editor.click
+        editor.send_keys([[:control, 'a'], :backspace])
+        content = "Content for #{editables[index]}"
+        editor.send_keys(content)
+        expected_data[editables[index]] = "<p>#{content}</p>"
+      end
+
+      # Wait for change events and verify the last one
+      eventually do
+        events = page.evaluate_script('window._editorEvents')
+        last_event = events.last
+
+        expect(last_event['data']).to eq(expected_data)
+        expect(last_event['hasEditor']).to be true
+      end
+    end
+  end
+
+  describe 'Classic Editor' do
+    it_behaves_like 'an editor', 'classic'
+    it_behaves_like 'an editor that fires change event with main payload', 'classic'
+  end
+
+  describe 'Decoupled Editor' do
+    before { visit 'decoupled' }
+
+    it_behaves_like 'an editor', 'decoupled'
+    it_behaves_like 'an editor that fires change event with main payload', 'decoupled'
+
+    it 'has separate toolbar' do
+      expect(page).to have_css('.toolbar-container .ck-toolbar')
+    end
+  end
+
+  describe 'Balloon Editor' do
+    before { visit 'balloon' }
+
+    it_behaves_like 'an editor', 'balloon'
+    it_behaves_like 'an editor that fires change event with main payload', 'balloon'
+
+    it 'shows balloon toolbar on selection' do
+      editor = first('.ck-editor__editable')
+      editor.click
+
+      expect(page).to have_css('.ck-balloon-panel', wait: 5)
+    end
+  end
+
+  describe 'Inline Editor' do
+    it_behaves_like 'an editor', 'inline'
+    it_behaves_like 'an editor that fires change event with main payload', 'inline'
+  end
+
+  describe 'Multiroot Editor' do
+    before { visit 'multiroot' }
+
+    it_behaves_like 'an editor', 'multiroot'
+    it_behaves_like 'a multiroot editor that fires change events', 'multiroot', %w[toolbar content]
+
+    it 'supports multiple editable areas' do
+      expect(page).to have_css('.ck-editor__editable', minimum: 2)
+    end
+
+    it 'shares toolbar between editables' do
+      expect(page).to have_css('.ck-toolbar', count: 1)
+    end
+
+    it 'handles dynamically added editables' do # rubocop:disable Metrics/BlockLength
+      # Set up event listener
+      page.execute_script(<<~JS)
+        window._newEditableEvents = [];
+        document.querySelector('ckeditor-component').addEventListener('editor-change', (e) => {
+          window._newEditableEvents.push({
+            data: e.detail.data,
+            hasEditor: !!e.detail.editor
+          });
+        });
+      JS
+
+      # Add new editable component
+      page.execute_script(<<~JS)
+        const container = document.querySelector('[data-testid="multiroot-editor"]');
+        const newEditable = document.createElement('ckeditor-editable-component');
+        newEditable.setAttribute('name', 'new-root');
+        container.appendChild(newEditable);
+      JS
+
+      sleep 0.1 # Wait for component initialization
+
+      # Find and interact with new editable
+      new_editable = find("[name='new-root']")
+      new_editable.click
+      new_editable.send_keys('Content for new root')
+
+      # Verify the change event
+      eventually do
+        events = page.evaluate_script('window._newEditableEvents')
+        last_event = events.last
+
+        expect(last_event['data']).to include(
+          'content' => '',
+          'new-root' => '<p>Content for new root</p>',
+          'toolbar' => '<p>This is a toolbar editable</p>'
+        )
+
+        expect(last_event['hasEditor']).to be true
+      end
+    end
+  end
+end

data/spec/e2e/features/form_integration_spec.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'e2e/spec_helper'
+
+RSpec.describe 'Form Integration', type: :feature, js: true do
+  before do
+    visit('form')
+    setup_form_tracking(page)
+  end
+
+  shared_examples 'a form with CKEditor' do |form_testid, editor_testid, submit_testid| # rubocop:disable Metrics/BlockLength
+    let(:form) { find("[data-testid='#{form_testid}']") }
+    let(:editor) { find("[data-testid='#{editor_testid}']") }
+    let(:editable) { editor.find('.ck-editor__editable') }
+    let(:text_field) { editor.find('textarea', visible: :hidden) }
+    let(:submit_button) { find("[data-testid='#{submit_testid}']") }
+
+    it 'loads editor properly' do
+      expect(page).to have_css("[data-testid='#{editor_testid}'] .ck-editor__editable")
+      expect(editor).to have_invisible_textarea
+    end
+
+    it 'validates required fields' do
+      editable.click
+      editable.send_keys([[:control, 'a'], :backspace])
+
+      text_field.set('')
+      submit_button.click
+
+      expect(form).not_to have_been_submitted
+      expect(text_field).to be_invalid
+    end
+
+    it 'submits with valid data' do
+      editable.click
+      editable.send_keys('New content')
+      text_field.set('Second field value')
+
+      submit_button.click
+
+      eventually do
+        expect(form).to have_been_submitted
+      end
+    end
+  end
+
+  describe 'Rails form' do
+    it_behaves_like 'a form with CKEditor',
+                    'rails-form',
+                    'rails-form-editor',
+                    'rails-form-submit'
+  end
+
+  describe 'Simple form' do
+    it_behaves_like 'a form with CKEditor',
+                    'simple-form',
+                    'simple-form-editor',
+                    'simple-form-submit'
+  end
+end

data/spec/e2e/spec_helper.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'capybara'
+require 'capybara/rspec'
+require 'capybara/cuprite'
+
+ENV['RAILS_ENV'] ||= 'test'
+
+require File.expand_path('../../sandbox/config/environment', __dir__)
+
+require 'capybara/rails'
+
+Capybara.app = Rails.application
+
+Capybara.register_driver(:cuprite) do |app|
+  driver = Capybara::Cuprite::Driver.new(
+    app,
+    window_size: [1200, 800],
+    headless: ENV['HEADLESS'] == 'true',
+    browser_options: {
+      'no-sandbox': nil,
+      'disable-gpu': nil,
+      'enable-logging': nil
+    },
+    process_timeout: 20,
+    timeout: 20,
+    inspector: true
+  )
+
+  process = driver.browser.process
+  puts ''
+  puts "Browser: #{process.browser_version}"
+  puts "Protocol: #{process.protocol_version}"
+  puts "V8: #{process.v8_version}"
+  puts "Webkit: #{process.webkit_version}"
+  driver
+end
+
+Capybara.server = :webrick
+Capybara.default_driver = :cuprite
+Capybara.javascript_driver = :cuprite
+
+Dir[File.expand_path('support/**/*.rb', __dir__)].each { |f| require f }

data/spec/e2e/support/eventually.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Add eventually helper for async operations
+def eventually(timeout: 5, delay: 0.1)
+  deadline = Time.zone.now + timeout
+  loop do
+    yield
+    break
+  rescue RSpec::Expectations::ExpectationNotMetError, StandardError => e
+    raise e if Time.zone.now >= deadline
+
+    sleep delay
+  end
+end

data/spec/e2e/support/form_helpers.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module FormHelpers
+  def setup_form_tracking(driver)
+    driver.execute_script <<~JS
+      window.lastSubmittedForm = null;
+
+      document.addEventListener('submit', (e) => {
+        e.preventDefault();
+        window.lastSubmittedForm = e.target.id;
+      });
+    JS
+  end
+end
+
+RSpec.configure do |config|
+  config.include FormHelpers, type: :feature
+end
+
+RSpec::Matchers.define :be_invalid do
+  match do |element|
+    element[:validity] == 'false' ||
+      element.evaluate_script('!this.validity.valid')
+  end
+end
+
+RSpec::Matchers.define :have_been_submitted do
+  match do |form|
+    page.evaluate_script('window.lastSubmittedForm') == form['id']
+  end
+end
+
+RSpec::Matchers.define :have_invisible_textarea do
+  match do |element|
+    element.has_css?('textarea', visible: :hidden)
+  end
+end

data/spec/spec_helper.rb

@@ -36,7 +36,7 @@ require 'rspec-html-matchers'
 
 Dir[File.expand_path('support/**/*.rb', __dir__)].each { |f| require f }
 
-Rails.application.initialize!
+Rails.application.initialize! unless Rails.application.initialized?
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.15.10
+  version: 1.16.1
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -76,6 +76,11 @@ files:
 - lib/ckeditor5/rails/semver.rb
 - lib/ckeditor5/rails/version.rb
 - lib/ckeditor5/rails/version_detector.rb
+- spec/e2e/features/editor_types_spec.rb
+- spec/e2e/features/form_integration_spec.rb
+- spec/e2e/spec_helper.rb
+- spec/e2e/support/eventually.rb
+- spec/e2e/support/form_helpers.rb
 - spec/lib/ckeditor5/rails/assets/asset_bundle_hml_serializer_spec.rb
 - spec/lib/ckeditor5/rails/assets/assets_bundle_spec.rb
 - spec/lib/ckeditor5/rails/cdn/ckbox_bundle_spec.rb
@@ -126,6 +131,11 @@ signing_key:
 specification_version: 4
 summary: CKEditor 5 for Rails
 test_files:
+- spec/e2e/features/editor_types_spec.rb
+- spec/e2e/features/form_integration_spec.rb
+- spec/e2e/spec_helper.rb
+- spec/e2e/support/eventually.rb
+- spec/e2e/support/form_helpers.rb
 - spec/lib/ckeditor5/rails/assets/asset_bundle_hml_serializer_spec.rb
 - spec/lib/ckeditor5/rails/assets/assets_bundle_spec.rb
 - spec/lib/ckeditor5/rails/cdn/ckbox_bundle_spec.rb