ckeditor5 1.26.0 → 1.26.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae47ab2c50827fd1a0716bc093475ce4e55a237ad3a9f4c35ba0b66d8ea46f7c
-  data.tar.gz: 13e648a1a348203b84f7220b7160c9d98e25753a97a207e4c5260d8d4d598571
+  metadata.gz: 8e46c611bc11950481442cb335ae063943043937c9792b6eeedd731e030cdf1c
+  data.tar.gz: d16b561470173168c325457a00f5e83d5ca8689b0644f0d96533c05b7075193f
 SHA512:
-  metadata.gz: c311294593a9de01ba525eab43d6dbf0418f454e6c7754a8c2a607464539ca82ed39f61a66d58f5c3a977f89a39c591adfb60b63711c47f3c2657e6c3442c49e
-  data.tar.gz: 64f021c1316971588676e9819d422b09d83bea982d74e94544ccbcc703ffb381778dc08aa308620559701a030d88423c20b5b3a678abfc1854daebb33f9fccc1
+  metadata.gz: 6769430ee90f270077c474bf1999e7d5fc4d2ec5c62918063e6503c39956e63a9f0bfb948de3dd376bc2bcb7212fc505a61e94cf04e46a1c2e85867d8e037e9a
+  data.tar.gz: 93071afc776e615781cc9ff845b631bc823653f229ee9dbba22ccc2f9e9b2c5b9813c4cfaf6d672dfc9764a8db6d205631cf992b2d94a16fe8aba9df230681ad

data/README.md

@@ -8,7 +8,10 @@
 ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/mati365/ckeditor5-rails?style=flat-square)
 [![GitHub issues](https://img.shields.io/github/issues/mati365/ckeditor5-rails?style=flat-square)](https://github.com/Mati365/ckeditor5-rails/issues)
 
-Unofficial CKEditor 5 Ruby on Rails integration gem. Provides seamless integration of CKEditor 5 with Rails applications through web components and helper methods.
+CKEditor 5 Ruby on Rails integration gem. Provides seamless integration of CKEditor 5 with Rails applications through web components and helper methods. This gem supports various editor types, including classic, inline, balloon, and decoupled editors. It also includes support for custom plugins, translations, and configuration options.
+
+> [!IMPORTANT]
+> This gem is unofficial and not maintained by CKSource. For official CKEditor 5 documentation, visit [ckeditor.com](https://ckeditor.com/docs/ckeditor5/latest/). If you encounter any issues in integration, please report them on the [GitHub repository](https://github.com/Mati365/ckeditor5-rails/issues).
 
 <p align="center">
   <img src="docs/intro-classic-editor.png" alt="CKEditor 5 Classic Editor in Ruby on Rails application">
@@ -22,6 +25,10 @@ Add this line to your application's Gemfile:
 gem 'ckeditor5'
 ```
 
+> [!NOTE]
+> This gem uses importmaps and does not require Webpacker or any other JavaScript bundler. It's compatible with Rails 6.0+ and `importmap-rails` gem.
+> While installation is simplified, it's recommended to check if jsdelivr or unpkg CDN is accessible in your environment, otherwise, you may need to configure a custom CDN (or use a commercial one).
+
 In your layout:
 
 ```erb
@@ -80,7 +87,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.1.0'
+  # version '44.2.0'
 
   # Upload images to the server using the simple upload adapter, instead of Base64 encoding.
   # simple_upload_adapter
@@ -201,7 +208,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.1.0'
+  version '44.2.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:
@@ -211,7 +218,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.1.0'
+    version '44.2.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
@@ -333,7 +340,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.1.0'
+  version '44.2.0'
 end
 ```
 
@@ -345,7 +352,7 @@ In order to disable default patches, you can pass the `apply_patches: false` key
 CKEditor5::Rails.configure do
   # ... other configuration
 
-  version '44.1.0', apply_patches: false
+  version '44.2.0', apply_patches: false
 end
 ```
 
@@ -1229,7 +1236,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.1.0'
+      version '44.2.0'
 
       toolbar :sourceEditing, :|, :bold, :italic, :underline, :strikethrough,
               :subscript, :superscript, :removeFormat, :|, :bulletedList, :numberedList,
@@ -1264,7 +1271,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.1.0'
+      version '44.2.0'
 
       toolbar :sourceEditing, :|, :bold, :italic, :underline, :strikethrough,
               :subscript, :superscript, :removeFormat, :|, :bulletedList, :numberedList,
@@ -1437,7 +1444,7 @@ In that scenario it's recommended to add `gpl` method to the initializer along w
 
 CKEditor5::Rails.configure do
   gpl
-  version '44.1.0'
+  version '44.2.0'
 end
 ```
 

data/lib/ckeditor5/rails/editor/helpers/config_helpers.rb

@@ -50,10 +50,7 @@ module CKEditor5::Rails::Editor::Helpers
 
       raise ArgumentError, 'Configuration block is required for preset definition' unless block_given?
 
-      CKEditor5::Rails::Presets::PresetBuilder.new(
-        disallow_inline_plugins: true,
-        &block
-      )
+      CKEditor5::Rails::Presets::PresetBuilder.new(&block)
     end
   end
 end

data/lib/ckeditor5/rails/editor/helpers/editor_helpers.rb

@@ -73,7 +73,7 @@ module CKEditor5::Rails
       type ||= preset.type
 
       # Add some fallbacks
-      config[:licenseKey] ||= context[:license_key]
+      config[:licenseKey] ||= context[:license_key] || preset.license_key
       config[:language] = { ui: language } if language
 
       editor_props = Editor::Props.new(

data/lib/ckeditor5/rails/plugins/patches/fix_color_picker_race_condition.rb

@@ -44,7 +44,7 @@ module CKEditor5::Rails::Plugins::Patches
     JS
 
     def initialize
-      super(:FixColorPickerRaceCondition, PLUGIN_CODE)
+      super(:FixColorPickerRaceCondition, PLUGIN_CODE, max_version: '44.4.0')
       compress!
     end
   end

data/lib/ckeditor5/rails/presets/concerns/plugin_methods.rb

@@ -9,13 +9,12 @@ module CKEditor5::Rails
       module PluginMethods
         extend ActiveSupport::Concern
 
-        class DisallowedInlinePluginError < ArgumentError; end
         class MissingInlinePluginError < StandardError; end
         class UnsupportedESModuleError < StandardError; end
         class InvalidPatchPluginError < ArgumentError; end
 
         included do
-          attr_reader :disallow_inline_plugins, :disallow_inline_plugin_compression
+          attr_reader :disallow_inline_plugin_compression
         end
 
         # Registers an external plugin loaded from a URL
@@ -80,7 +79,7 @@ module CKEditor5::Rails
             raise InvalidPatchPluginError, 'Provided plugin must be a PropsPatchPlugin instance'
           end
 
-          return unless plugin.applicable_for_version?(config[:version])
+          return unless !@version || plugin.applicable_for_version?(@version)
 
           register_plugin(plugin)
         end
@@ -124,26 +123,11 @@ module CKEditor5::Rails
 
         private
 
-        # Check if the plugin looks like an inline plugin
-        # @param plugin [Editor::PropsBasePlugin] Plugin instance
-        # @return [Boolean] True if the plugin is an inline plugin
-        def looks_like_inline_plugin?(plugin)
-          plugin.respond_to?(:code) && plugin.code.present?
-        end
-
         # Register a plugin in the editor configuration.
         #
-        # It will raise an error if inline plugins are not allowed and the plugin is an inline plugin.
-        # Most likely, this is being thrown when you use inline_plugin definition in a place where
-        # it's not allowed (e.g. in a preset definition placed in controller).
-        #
         # @param plugin_obj [Editor::PropsBasePlugin] Plugin instance to register
         # @return [Editor::PropsBasePlugin] The registered plugin
         def register_plugin(plugin_obj)
-          if disallow_inline_plugins && looks_like_inline_plugin?(plugin_obj)
-            raise DisallowedInlinePluginError, 'Inline plugins are not allowed here.'
-          end
-
           config[:plugins] ||= []
           config[:plugins] << plugin_obj
           plugin_obj

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

@@ -17,8 +17,7 @@ module CKEditor5::Rails
       #     gpl
       #     type :classic
       #   end
-      def initialize(disallow_inline_plugins: false, &block)
-        @disallow_inline_plugins = disallow_inline_plugins
+      def initialize(&block)
         @version = nil
         @premium = false
         @cdn = :jsdelivr
@@ -191,6 +190,9 @@ module CKEditor5::Rails
           @version = Semver.new(version)
         end
 
+        # If there is no license key set, and the version if newer than 44.0.0, switch to GPL
+        # as the license key is now required in all versions
+        gpl if license_key.nil? && @version.major >= 44
         apply_integration_patches if apply_patches
       end
 

data/lib/ckeditor5/rails/semver.rb

@@ -10,6 +10,13 @@ module CKEditor5
       include Comparable
 
       def initialize(version_string)
+        if version_string.is_a?(Semver)
+          @major = version_string.major
+          @minor = version_string.minor
+          @patch = version_string.patch
+          return
+        end
+
         validate!(version_string)
         @major, @minor, @patch = version_string.split('.').map(&:to_i)
       end

data/lib/ckeditor5/rails/version.rb

@@ -2,8 +2,8 @@
 
 module CKEditor5
   module Rails
-    VERSION = '1.26.0'
+    VERSION = '1.26.2'
 
-    DEFAULT_CKEDITOR_VERSION = '44.1.0'
+    DEFAULT_CKEDITOR_VERSION = '44.2.0'
   end
 end

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

@@ -38,23 +38,6 @@ RSpec.describe CKEditor5::Rails::Editor::Helpers::Config do
       it 'yields the block to PresetBuilder' do
         expect { |b| helper.ckeditor5_preset(&b) }.to yield_control
       end
-
-      it 'does not allow inline plugins definition' do
-        expect do
-          helper.ckeditor5_preset do
-            inline_plugin :CustomPlugin, <<~JS
-              const { Plugin } = await import( 'ckeditor5' );
-
-              return class CustomPlugin extends Plugin {
-                static get pluginName() { return 'CustomPlugin'; }
-              }
-            JS
-          end
-        end.to raise_error(
-          CKEditor5::Rails::Presets::Concerns::PluginMethods::DisallowedInlinePluginError,
-          'Inline plugins are not allowed here.'
-        )
-      end
     end
 
     context 'when neither name nor block is provided' do

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

@@ -24,6 +24,7 @@ RSpec.describe CKEditor5::Rails::Editor::Helpers::Editor do
     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)
+    allow(preset).to receive(:license_key).and_return(nil)
   end
 
   before do
@@ -225,6 +226,18 @@ RSpec.describe CKEditor5::Rails::Editor::Helpers::Editor do
         expect(helper.ckeditor5_editor(editable_height: 600)).to include('editable-height="600px"')
       end
     end
+
+    context 'when using license key' do
+      it 'uses license key from preset when no other license key is provided' do
+        custom_context = { preset: :default, bundle: 'custom-bundle' }
+        allow(helper).to receive(:ckeditor5_context_or_fallback).and_return(custom_context)
+
+        allow(preset).to receive(:license_key).and_return('preset-license-key')
+
+        result = helper.ckeditor5_editor
+        expect(result).to include('preset-license-key')
+      end
+    end
   end
 
   describe '#ckeditor5_editable' do

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

@@ -36,6 +36,62 @@ RSpec.describe CKEditor5::Rails::Editor::PropsPatchPlugin do
       expect(result).to be true
     end
 
+    it 'returns true when version is equal to min constraint' do
+      result = described_class.applicable_for_version?(
+        '29.0.0',
+        min_version: '29.0.0'
+      )
+      expect(result).to be true
+    end
+
+    it 'returns true when version is equal to max constraint' do
+      result = described_class.applicable_for_version?(
+        '30.0.0',
+        max_version: '30.0.0'
+      )
+      expect(result).to be true
+    end
+
+    it 'returns true when version is higher than min constraint (patch)' do
+      result = described_class.applicable_for_version?(
+        '29.0.1',
+        min_version: '29.0.0'
+      )
+      expect(result).to be true
+    end
+
+    it 'returns true when version is higher than min constraint (minor)' do
+      result = described_class.applicable_for_version?(
+        '29.1.0',
+        min_version: '29.0.0'
+      )
+      expect(result).to be true
+    end
+
+    it 'returns true when version is higher than min constraint (major)' do
+      result = described_class.applicable_for_version?(
+        '30.0.0',
+        min_version: '29.0.0'
+      )
+      expect(result).to be true
+    end
+
+    it 'returns false when version is not equal to max constraint (patch)' do
+      result = described_class.applicable_for_version?(
+        '30.0.1',
+        max_version: '30.0.0'
+      )
+      expect(result).to be false
+    end
+
+    it 'returns false when version is not equal to min constraint (minor)' do
+      result = described_class.applicable_for_version?(
+        '29.1.0',
+        max_version: '29.0.0'
+      )
+      expect(result).to be false
+    end
+
     it 'returns false when version is too low' do
       result = described_class.applicable_for_version?(
         '28.9.9',
@@ -56,16 +112,46 @@ RSpec.describe CKEditor5::Rails::Editor::PropsPatchPlugin do
   end
 
   describe '#applicable_for_version?' do
-    let(:plugin) do
-      described_class.new(plugin_name, plugin_code, min_version: '29.0.0', max_version: '30.0.0')
+    context 'with both version constraints' do
+      let(:plugin) do
+        described_class.new(plugin_name, plugin_code, min_version: '29.0.0', max_version: '30.0.0')
+      end
+
+      it 'returns true for version within constraints' do
+        expect(plugin.applicable_for_version?('29.1.0')).to be true
+      end
+
+      it 'returns false for version outside constraints' do
+        expect(plugin.applicable_for_version?('28.9.9')).to be false
+      end
     end
 
-    it 'returns true for version within constraints' do
-      expect(plugin.applicable_for_version?('29.1.0')).to be true
+    context 'with only min_version constraint' do
+      let(:plugin) do
+        described_class.new(plugin_name, plugin_code, min_version: '29.0.0')
+      end
+
+      it 'returns true for version above min_version' do
+        expect(plugin.applicable_for_version?('30.0.0')).to be true
+      end
+
+      it 'returns false for version below min_version' do
+        expect(plugin.applicable_for_version?('28.9.9')).to be false
+      end
     end
 
-    it 'returns false for version outside constraints' do
-      expect(plugin.applicable_for_version?('28.9.9')).to be false
+    context 'with only max_version constraint' do
+      let(:plugin) do
+        described_class.new(plugin_name, plugin_code, max_version: '30.0.0')
+      end
+
+      it 'returns true for version below max_version' do
+        expect(plugin.applicable_for_version?('29.0.0')).to be true
+      end
+
+      it 'returns false for version above max_version' do
+        expect(plugin.applicable_for_version?('30.0.1')).to be false
+      end
     end
   end
 end

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

@@ -31,6 +31,34 @@ RSpec.describe CKEditor5::Rails::Presets::PresetBuilder do
     end
   end
 
+  describe '#version' do
+    it 'sets version' do
+      builder.version '35.0.0'
+      expect(builder.version).to eq('35.0.0')
+    end
+
+    context 'with version >= 44.0.0' do
+      it 'sets GPL license when no license key is set' do
+        builder.version('44.0.0')
+        expect(builder.license_key).to eq('GPL')
+        expect(builder.premium?).to be false
+      end
+
+      it 'does not change license when license key is already set' do
+        builder.license_key('commercial-key')
+        builder.version('44.0.0')
+        expect(builder.license_key).to eq('commercial-key')
+      end
+    end
+
+    context 'with version < 44.0.0' do
+      it 'does not set GPL license automatically' do
+        builder.version('43.0.0')
+        expect(builder.license_key).to be_nil
+      end
+    end
+  end
+
   describe '#initialize_copy' do
     let(:original) do
       described_class.new do
@@ -520,6 +548,10 @@ RSpec.describe CKEditor5::Rails::Presets::PresetBuilder do
   end
 
   describe '#special_characters' do
+    it 'should not crash if block is not provided' do
+      expect { builder.special_characters }.not_to raise_error
+    end
+
     it 'configures special characters with groups and items' do # rubocop:disable Metrics/BlockLength
       builder.special_characters do
         group 'Emoji', label: 'Emoticons' do
@@ -542,36 +574,38 @@ RSpec.describe CKEditor5::Rails::Presets::PresetBuilder do
         order :Text, :Arrows, :Emoji, :Mixed
       end
 
-      expect(builder.config[:specialCharactersBootstrap]).to eq({
-                                                                  groups: [
-                                                                    {
-                                                                      name: 'Emoji',
-                                                                      items: [
-                                                                        { title: 'smiley', character: '😊' },
-                                                                        { title: 'heart', character: '❤️' }
-                                                                      ],
-                                                                      options: { label: 'Emoticons' }
-                                                                    },
-                                                                    {
-                                                                      name: 'Arrows',
-                                                                      items: [
-                                                                        { title: 'right', character: '→' },
-                                                                        { title: 'left', character: '←' }
-                                                                      ],
-                                                                      options: {}
-                                                                    },
-                                                                    {
-                                                                      name: 'Mixed',
-                                                                      items: [
-                                                                        { title: 'star', character: '⭐' },
-                                                                        { title: 'heart', character: '❤️' }
-                                                                      ],
-                                                                      options: { label: 'Mixed Characters' }
-                                                                    }
-                                                                  ],
-                                                                  order: %w[Text Arrows Emoji Mixed],
-                                                                  packs: []
-                                                                })
+      data = {
+        groups: [
+          {
+            name: 'Emoji',
+            items: [
+              { title: 'smiley', character: '😊' },
+              { title: 'heart', character: '❤️' }
+            ],
+            options: { label: 'Emoticons' }
+          },
+          {
+            name: 'Arrows',
+            items: [
+              { title: 'right', character: '→' },
+              { title: 'left', character: '←' }
+            ],
+            options: {}
+          },
+          {
+            name: 'Mixed',
+            items: [
+              { title: 'star', character: '⭐' },
+              { title: 'heart', character: '❤️' }
+            ],
+            options: { label: 'Mixed Characters' }
+          }
+        ],
+        order: %w[Text Arrows Emoji Mixed],
+        packs: []
+      }
+
+      expect(builder.config[:specialCharactersBootstrap]).to eq(data)
 
       plugin_names = builder.config[:plugins].map(&:name)
       expect(plugin_names).to include(:SpecialCharacters)

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

@@ -8,6 +8,15 @@ RSpec.describe CKEditor5::Rails::Semver do
       it 'accepts version in x.y.z format' do
         expect { described_class.new('1.2.3') }.not_to raise_error
       end
+
+      it 'accepts Semver object' do
+        original = described_class.new('1.2.3')
+        copied = described_class.new(original)
+
+        expect(copied.major).to eq(1)
+        expect(copied.minor).to eq(2)
+        expect(copied.patch).to eq(3)
+      end
     end
 
     context 'with invalid version' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.26.0
+  version: 1.26.2
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 2025-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails