ckeditor5 1.17.0 → 1.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 843e4c645212f665f1c8e1efe8ae6b623d84e8a42cfd5c4e8181def8450e0dde
-  data.tar.gz: b0980b0adcf055278856758e38e304d5eaa3927d3dd75a703abec2bd7366d5fb
+  metadata.gz: 78094e2b7cf2ec9677a1eb9ee629918df4b6e9de62104cd6e2c8713b02ae7776
+  data.tar.gz: 63816a1caf2f2c42f08321f0169fb14e54e2f6424bc80834890dfde68a76f22f
 SHA512:
-  metadata.gz: 315c863ea830f41cc5b68e6bbfbd736fdb89facab2233d75648313befecaa419ffe9e42a84545da347e0575db6c6da58f0f690ce32c6fc989fa5408a48d8110d
-  data.tar.gz: 6dafb2dc99b0cb3496e5e106f0a90a0d8cd93f25ee78e86d5e4d2a3f67cd987c59af0aad45d1d4b0651cf237606856e4399f48d1d6a0a20b3a31639f094641f1
+  metadata.gz: b3691b024f1cedc6da4086fea1754f6f4d7acdc2d3d9a10f5628b0b54c539e941073cff74459dd776956c758fe4da1f78b54a6c8ab0128248e1ecc9b308ba168
+  data.tar.gz: a5d4109cc5f559144a66abd7ba1b672a27d1ad41131bdead590c144d4c4b2d1eb518953267bfee9fb6fa14c9cce027416de28dece065ed852c198fd4587e08dc

data/README.md

@@ -234,6 +234,8 @@ CKEditor5::Rails.configure do
 end
 ```
 
+You can define presets in the controller using the `ckeditor5_preset` helper method. See it in the section below ([Controller / View helpers](#controller--view-helpers-)).
+
 Configuration of the editor can be complex, and it's recommended to use the [CKEditor 5 online builder](https://ckeditor.com/ckeditor-5/online-builder/) to generate the configuration. It allows you to select the features you want to include and generate the configuration code in JavaScript format. Keep in mind that you need to convert the JavaScript configuration to Ruby format before using it in this gem.
 
 ### Automatic upgrades 🔄
@@ -866,9 +868,31 @@ In order to use the preset in the view, you can pass it to the `ckeditor5_assets
 
 <%= ckeditor5_editor %>
 ```
-</details>
 
-If `name` is provided then the preset is returned.
+If you want to override the preset defined in the initializer, you can search for the preset by name and then override it (it'll create copy of the preset):
+
+```rb
+# app/controllers/application_controller.rb
+
+class ApplicationController < ActionController::Base
+  def show
+    @preset = ckeditor5_preset(:default).override do
+      version '43.3.1'
+
+      toolbar :sourceEditing, :|, :bold, :italic, :underline, :strikethrough,
+              :subscript, :superscript, :removeFormat, :|, :bulletedList, :numberedList,
+              :fontFamily, :fontSize, :|, :link, :anchor, :|,
+              :fontColor, :fontBackgroundColor
+
+      plugins :Essentials, :Paragraph, :Bold, :Italic, :Underline, :Strikethrough,
+              :Subscript, :Superscript, :RemoveFormat, :List, :Link, :Font,
+              :FontFamily, :FontSize, :FontColor, :FontBackgroundColor, :SourceEditing, :Essentials, :Paragraph
+    end
+  end
+end
+```
+
+</details>
 
 ## Including CKEditor 5 assets 📦
 

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

@@ -55,6 +55,12 @@ module CKEditor5::Rails
         end
       end
 
+      def override(&block)
+        clone.tap do |preset|
+          preset.instance_eval(&block)
+        end
+      end
+
       def merge_with_hash!(language: nil, **overrides) # rubocop:disable Metrics/AbcSize
         @version = Semver.new(overrides[:version]) if overrides.key?(:version)
         @premium = overrides.fetch(:premium, premium)

data/lib/ckeditor5/rails/version.rb

@@ -2,7 +2,7 @@
 
 module CKEditor5
   module Rails
-    VERSION = '1.17.0'
+    VERSION = '1.17.1'
 
     DEFAULT_CKEDITOR_VERSION = '43.3.1'
   end

data/spec/e2e/features/locale_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'e2e/spec_helper'
+
+RSpec.describe 'Editor localization', type: :system do
+  describe 'setting locale via assets' do
+    it 'displays menubar in Polish' do
+      visit '/locale_via_assets'
+
+      expect(page).to have_css('.ck-editor__main')
+
+      within('.ck-menu-bar') do
+        expect(page).to have_content('Zmiana')
+        expect(page).to have_content('Wstaw')
+        expect(page).to have_content('Format')
+      end
+    end
+  end
+
+  describe 'setting locale via editor prop' do
+    it 'displays menubar in Spanish' do
+      visit '/locale_via_editor'
+
+      expect(page).to have_css('.ck-editor__main')
+
+      within('.ck-menu-bar') do
+        expect(page).to have_content('Editar')
+        expect(page).to have_content('Insertar')
+        expect(page).to have_content('Formato')
+      end
+    end
+  end
+
+  describe 'setting locale via preset' do
+    it 'displays menubar in Russian' do
+      visit '/locale_via_preset'
+
+      expect(page).to have_css('.ck-editor__main')
+
+      within('.ck-menu-bar') do
+        expect(page).to have_content('Редактировать')
+        expect(page).to have_content('Вставить')
+        expect(page).to have_content('Формат')
+      end
+    end
+  end
+end

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

@@ -70,6 +70,22 @@ RSpec.describe CKEditor5::Rails::Presets::PresetBuilder do
     end
   end
 
+  describe '#override' do
+    it 'returns a new instance with overridden values' do
+      builder.version '35.0.0'
+      builder.translations :en, :pl
+
+      overridden = builder.override do
+        version '36.0.0'
+        translations :de
+      end
+
+      expect(builder.version).to eq('35.0.0')
+      expect(overridden.version).to eq('36.0.0')
+      expect(overridden.translations).to eq([:de])
+    end
+  end
+
   describe 'configuration methods' do
     describe '#automatic_upgrades' do
       it 'enables automatic upgrades' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.17.1
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -82,6 +82,7 @@ files:
 - spec/e2e/features/context_spec.rb
 - spec/e2e/features/editor_types_spec.rb
 - spec/e2e/features/form_integration_spec.rb
+- spec/e2e/features/locale_spec.rb
 - spec/e2e/spec_helper.rb
 - spec/e2e/support/eventually.rb
 - spec/e2e/support/form_helpers.rb
@@ -139,6 +140,7 @@ test_files:
 - spec/e2e/features/context_spec.rb
 - spec/e2e/features/editor_types_spec.rb
 - spec/e2e/features/form_integration_spec.rb
+- spec/e2e/features/locale_spec.rb
 - spec/e2e/spec_helper.rb
 - spec/e2e/support/eventually.rb
 - spec/e2e/support/form_helpers.rb