ckeditor5 1.15.8 → 1.15.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 127f81c39ea4df2b13a4095bd335f7b8698549249851de0f90ed948e309b2ca0
-  data.tar.gz: cd9711cd4b70b4c89091b166a694065973b4d12eff6d587e8cb761abdcd5b43e
+  metadata.gz: 604312ff3ad324ca5ebbccca70efe7157e9ee67608d6a3b8d3b2d4b7c070213b
+  data.tar.gz: 8c44e0810acd1bb837cdcc8a37c4fb3051b5323a243e7b5a16341e9c8e3ef9a7
 SHA512:
-  metadata.gz: 0b0fd8c78086d0f46b10b63a01a6394b493958d82d022d9cdebae203df0f57fbe396ed02609fc7049d0dbf6415deb8a35eddc88593dcbda51a84f0ae3fbf4f56
-  data.tar.gz: 8eeea41e9de0d98c7d3613c915f3fb7e93bb55fd80ebe24aa97d7a3761af1a9ed0f6a1f4e502dcff53bc11d4eb04f7776f26d768da2adfdfe73868f1becd3b65
+  metadata.gz: 54fc1a049c23a9c45bee8fc307de81f7976407850d068f018e715396b93a47e3c37f77c45682ba7ee4f36fe1d5cef156eeb5791dbf0793c35503a93e09e41f8a
+  data.tar.gz: 23a2299e6b8685cf120fa40be70d23737ec68f732e6e96af4428d785234600ab17a24596f4d4794093b14fdd0625b20e3a2953950659e0ab0c9deda7fc2c1cc9

data/Gemfile

@@ -13,14 +13,9 @@ group :development do
   gem 'pry-rails', '~> 0.3', '>= 0.3.11'
   gem 'rails', '~> 7.0', '>= 7.0.0'
   gem 'rake', '~> 13.2', '>= 13.2.1'
-  gem 'rspec', '~> 3.13'
-  gem 'rspec-expectations', '~> 3.13'
-  gem 'rspec-rails', '~> 7.0'
   gem 'rubocop', '~> 1.66', require: false
   gem 'rubocop-rails', '~> 2.26', '>= 2.26.2', require: false
   gem 'rubocop-rails-omakase', '~> 1.0.0', require: false
-  gem 'simplecov', '~> 0.21', '>= 0.21.2', require: false
-  gem 'simplecov_json_formatter', '~> 0.1.4', require: false
   gem 'simple_form', '~> 5.3', '>= 5.3.0'
   gem 'slim', '~> 5.2', '>= 5.2.0'
   gem 'sprockets-rails', '~> 3.2', '>= 3.2.2'
@@ -29,6 +24,12 @@ end
 
 group :test, :development do
   gem 'capybara', '~> 3.40'
+  gem 'rspec', '~> 3.13'
+  gem 'rspec-expectations', '~> 3.13'
+  gem 'rspec-html-matchers', '~> 0.10.0'
+  gem 'rspec-rails', '~> 7.0'
+  gem 'simplecov', '~> 0.21', '>= 0.21.2', require: false
+  gem 'simplecov_json_formatter', '~> 0.1.4', require: false
 end
 
 gemspec

data/README.md

@@ -74,6 +74,9 @@ 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 '43.3.1'
+
+  # Upload images to the server using the simple upload adapter, instead of Base64 encoding.
+  # simple_upload_adapter
 end
 ```
 

data/lib/ckeditor5/rails/cdn/ckbox_bundle.rb

@@ -22,9 +22,9 @@ module CKEditor5::Rails
         @scripts ||= [
           Assets::JSExportsMeta.new(
             create_cdn_url('ckbox', version, 'ckbox.js'),
-            *translations_js_exports_meta,
             window_name: 'CKBox'
-          )
+          ),
+          *translations_js_exports_meta
         ]
       end
 

data/lib/ckeditor5/rails/cdn/helpers.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+require_relative '../semver'
+require_relative '../editor/props'
+require_relative '../editor/helpers/config_helpers'
+require_relative '../presets/manager'
+require_relative '../assets/assets_bundle_html_serializer'
+
 require_relative 'url_generator'
 require_relative 'ckeditor_bundle'
 require_relative 'ckbox_bundle'

data/lib/ckeditor5/rails/context/helpers.rb

@@ -7,7 +7,7 @@ module CKEditor5::Rails::Context
     def ckeditor5_context(**config, &block)
       context_props = Props.new(config)
 
-      tag.send(:'ckeditor-context-component', **context_props.to_attributes, &block)
+      tag.public_send(:'ckeditor-context-component', **context_props.to_attributes, &block)
     end
   end
 end

data/lib/ckeditor5/rails/editor/editable_height_normalizer.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module CKEditor5::Rails::Editor
+  class InvalidEditableHeightError < ArgumentError; end
+
+  class EditableHeightNormalizer
+    def initialize(editor_type)
+      @editor_type = editor_type
+    end
+
+    def normalize(value)
+      return nil if value.nil?
+
+      validate_editor_type!
+      convert_to_pixel_value(value)
+    end
+
+    private
+
+    attr_reader :editor_type
+
+    def validate_editor_type!
+      return if editor_type == :classic
+
+      raise InvalidEditableHeightError,
+            'editable_height can be used only with ClassicEditor'
+    end
+
+    def convert_to_pixel_value(value)
+      case value
+      when Integer then "#{value}px"
+      when String then convert_string_to_pixel_value(value)
+      else
+        raise_invalid_height_error(value)
+      end
+    end
+
+    def convert_string_to_pixel_value(value)
+      return value if value.match?(/^\d+px$/)
+
+      raise_invalid_height_error(value)
+    end
+
+    def raise_invalid_height_error(value)
+      raise InvalidEditableHeightError,
+            "editable_height must be an integer representing pixels or string ending with 'px'\n" \
+            "(e.g. 500 or '500px'). Got: #{value.inspect}"
+    end
+  end
+end

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-module CKEditor5::Rails
-  module Editor::Helpers::Config
+module CKEditor5::Rails::Editor::Helpers
+  module Config
     def ckeditor5_element_ref(selector)
       { '$element': selector }
     end
 
     def ckeditor5_preset(name = nil, &block)
-      return Engine.find_preset(name) if name
+      return CKEditor5::Rails::Engine.find_preset(name) if name
 
       raise ArgumentError, 'Configuration block is required for preset definition' unless block_given?
 

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative '../../version_detector'
+require_relative '../../presets/preset_builder'
 require_relative 'config_helpers'
 
 module CKEditor5::Rails
@@ -8,7 +10,6 @@ module CKEditor5::Rails
 
     class EditorContextError < StandardError; end
     class PresetNotFoundError < ArgumentError; end
-    class InvalidEditableHeightError < ArgumentError; end
 
     # Creates a CKEditor 5 editor instance
     #
@@ -45,15 +46,15 @@ module CKEditor5::Rails
 
       tag_attributes = html_attributes.merge(editor_props.to_attributes)
 
-      tag.send(:'ckeditor-component', **tag_attributes, &block)
+      tag.public_send(:'ckeditor-component', **tag_attributes, &block)
     end
 
     def ckeditor5_editable(name = nil, **kwargs, &block)
-      tag.send(:'ckeditor-editable-component', name: name, **kwargs, &block)
+      tag.public_send(:'ckeditor-editable-component', name: name, **kwargs, &block)
     end
 
     def ckeditor5_ui_part(name, **kwargs, &block)
-      tag.send(:'ckeditor-ui-part-component', name: name, **kwargs, &block)
+      tag.public_send(:'ckeditor-ui-part-component', name: name, **kwargs, &block)
     end
 
     def ckeditor5_toolbar(**kwargs)

data/lib/ckeditor5/rails/editor/props.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'props_plugin'
+require_relative 'editable_height_normalizer'
 
 module CKEditor5::Rails::Editor
   class Props
@@ -19,7 +20,7 @@ module CKEditor5::Rails::Editor
       @watchdog = watchdog
       @type = type
       @config = config
-      @editable_height = normalize_editable_height(editable_height)
+      @editable_height = EditableHeightNormalizer.new(type).normalize(editable_height)
     end
 
     def to_attributes
@@ -48,7 +49,7 @@ module CKEditor5::Rails::Editor
     end
 
     def serialize_translations
-      controller_context[:bundle].translations_scripts.map(&:to_h).to_json
+      controller_context[:bundle]&.translations_scripts&.map(&:to_h).to_json || '[]'
     end
 
     def serialize_plugins
@@ -61,23 +62,5 @@ module CKEditor5::Rails::Editor
         .tap { |cfg| cfg[:licenseKey] = controller_context[:license_key] if controller_context[:license_key] }
         .to_json
     end
-
-    def normalize_editable_height(editable_height)
-      return nil if editable_height.nil?
-
-      unless type == :classic
-        raise InvalidEditableHeightError,
-              'editable_height can be used only with ClassicEditor'
-      end
-
-      case editable_height
-      when String, /^\d+px$/ then editable_height
-      when Integer, /^\d+$/ then "#{editable_height}px"
-      else
-        raise InvalidEditableHeightError,
-              "editable_height must be an integer representing pixels or string ending with 'px'\n" \
-              "(e.g. 500 or '500px'). Got: #{editable_height.inspect}"
-      end
-    end
   end
 end

data/lib/ckeditor5/rails/plugins/simple_upload_adapter.rb

@@ -81,7 +81,7 @@ module CKEditor5::Rails::Plugins
     JAVASCRIPT
 
     def initialize
-      super(:SimpleUpload, PLUGIN_CODE)
+      super(:SimpleUploadAdapter, PLUGIN_CODE)
     end
   end
 end

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

@@ -104,7 +104,7 @@ module CKEditor5::Rails
       end
 
       def version(version = nil)
-        return @version.to_s if version.nil?
+        return @version&.to_s if version.nil?
 
         if @automatic_upgrades && version
           detected = VersionDetector.latest_safe_version(version)
@@ -164,7 +164,7 @@ module CKEditor5::Rails
 
         return unless block
 
-        builder = ArrayBuilder.new(@config[:toolbar][:items])
+        builder = ToolbarBuilder.new(@config[:toolbar][:items])
         builder.instance_eval(&block)
       end
 
@@ -174,7 +174,6 @@ module CKEditor5::Rails
 
       def plugin(name, **kwargs)
         plugin_obj = PluginsBuilder.create_plugin(name, **kwargs)
-
         @config[:plugins] << plugin_obj
         plugin_obj
       end

data/lib/ckeditor5/rails/version.rb

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

data/lib/ckeditor5/rails/version_detector.rb

@@ -4,6 +4,8 @@ require 'net/http'
 require 'json'
 require 'singleton'
 require 'monitor'
+
+require_relative 'version'
 require_relative 'semver'
 
 module CKEditor5::Rails
@@ -22,6 +24,10 @@ module CKEditor5::Rails
       @monitor = Monitor.new
     end
 
+    def clear_cache!
+      @monitor.synchronize { @cache.clear }
+    end
+
     def latest_safe_version(current_version)
       @monitor.synchronize do
         cache_key = "#{current_version}_latest"

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

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe CKEditor5::Rails::Assets::AssetsBundleHtmlSerializer do
+  let(:test_bundle_class) do
+    Class.new(CKEditor5::Rails::Assets::AssetsBundle) do
+      attr_accessor :scripts, :stylesheets
+
+      def initialize(scripts, stylesheets)
+        @scripts = scripts
+        @stylesheets = stylesheets
+        super()
+      end
+    end
+  end
+
+  let(:bundle) { test_bundle_class.new(scripts, stylesheets) }
+
+  let(:scripts) do
+    [
+      CKEditor5::Rails::Assets::JSExportsMeta.new(
+        'https://cdn.com/script1.js',
+        window_name: 'CKEditor5'
+      ),
+      CKEditor5::Rails::Assets::JSExportsMeta.new(
+        'https://cdn.com/script2.js',
+        import_name: '@ckeditor/script2'
+      )
+    ]
+  end
+
+  let(:stylesheets) { ['https://cdn.com/style1.css', 'https://cdn.com/style2.css'] }
+  let(:preloads) { bundle.preloads }
+
+  subject(:serializer) { described_class.new(bundle) }
+
+  describe '#initialize' do
+    context 'with invalid bundle' do
+      let(:bundle) { 'not a bundle' }
+
+      it 'raises TypeError' do
+        expect { serializer }.to raise_error(TypeError, 'bundle must be an instance of AssetsBundle')
+      end
+    end
+  end
+
+  describe '#to_html' do
+    subject(:html) { serializer.to_html }
+
+    it 'includes window scripts' do
+      expect(html).to include(
+        '<script src="https://cdn.com/script1.js" nonce="true" crossorigin="anonymous">'
+      )
+    end
+
+    it 'includes import map' do
+      expect(html).to include('type="importmap"')
+      expect(html).to include('"@ckeditor/script2":"https://cdn.com/script2.js"')
+    end
+
+    it 'includes stylesheet links' do
+      stylesheets.each do |url|
+        expect(html).to include("<link href=\"#{url}\" rel=\"stylesheet\" crossorigin=\"anonymous\">")
+      end
+    end
+
+    it 'includes preload links' do
+      expect(html).to include(
+        '<link href="https://cdn.com/style1.css" rel="preload" as="style" crossorigin="anonymous">'
+      )
+
+      expect(html).to include(
+        '<link href="https://cdn.com/style2.css" rel="preload" as="style" crossorigin="anonymous">'
+      )
+
+      expect(html).to include(
+        '<link href="https://cdn.com/script1.js" rel="preload" as="script" crossorigin="anonymous">'
+      )
+
+      expect(html).to include(
+        '<link href="https://cdn.com/script2.js" rel="preload" as="script" crossorigin="anonymous">'
+      )
+    end
+
+    it 'includes web component script' do
+      expect(html).to include('<script type="module" nonce="true">')
+    end
+  end
+
+  describe '.url_resource_preload_type' do
+    it 'returns correct type for js files' do
+      expect(described_class.url_resource_preload_type('file.js')).to eq('script')
+    end
+
+    it 'returns correct type for css files' do
+      expect(described_class.url_resource_preload_type('file.css')).to eq('style')
+    end
+
+    it 'returns fetch for unknown extensions' do
+      expect(described_class.url_resource_preload_type('file.unknown')).to eq('fetch')
+    end
+  end
+end

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

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe CKEditor5::Rails::Assets::AssetsBundle do
+  let(:concrete_class) do
+    Class.new(described_class) do
+      def scripts
+        []
+      end
+
+      def stylesheets
+        []
+      end
+    end
+  end
+
+  describe '#initialize' do
+    it 'raises error when required methods are not implemented' do
+      expect { described_class.new }.to raise_error(NotImplementedError)
+    end
+
+    it 'initializes successfully when required methods are implemented' do
+      expect { concrete_class.new }.not_to raise_error
+    end
+  end
+
+  describe '#empty?' do
+    subject(:bundle) { concrete_class.new }
+
+    it 'returns true when no assets are present' do
+      expect(bundle).to be_empty
+    end
+  end
+
+  describe '#translations_scripts' do
+    let(:bundle) { concrete_class.new }
+    let(:translation_script) { instance_double(CKEditor5::Rails::Assets::JSExportsMeta, translation?: true) }
+    let(:regular_script) { instance_double(CKEditor5::Rails::Assets::JSExportsMeta, translation?: false) }
+
+    before do
+      allow(bundle).to receive(:scripts).and_return([translation_script, regular_script])
+    end
+
+    it 'returns only translation scripts' do
+      expect(bundle.translations_scripts).to eq([translation_script])
+    end
+  end
+
+  describe '#<<' do
+    let(:script1) { instance_double(CKEditor5::Rails::Assets::JSExportsMeta) }
+    let(:script2) { instance_double(CKEditor5::Rails::Assets::JSExportsMeta) }
+    let(:stylesheet1) { '/path/to/style1.css' }
+    let(:stylesheet2) { '/path/to/style2.css' }
+
+    let(:bundle1) do
+      Class.new(described_class) do
+        attr_writer :scripts, :stylesheets
+
+        def scripts
+          @scripts ||= []
+        end
+
+        def stylesheets
+          @stylesheets ||= []
+        end
+      end.new
+    end
+
+    let(:bundle2) do
+      Class.new(described_class) do
+        attr_writer :scripts, :stylesheets
+
+        def scripts
+          @scripts ||= []
+        end
+
+        def stylesheets
+          @stylesheets ||= []
+        end
+      end.new
+    end
+
+    before do
+      bundle1.scripts = [script1]
+      bundle1.stylesheets = [stylesheet1]
+      bundle2.scripts = [script2]
+      bundle2.stylesheets = [stylesheet2]
+    end
+
+    it 'raises TypeError when argument is not an AssetsBundle' do
+      expect { bundle1 << 'not a bundle' }.to raise_error(TypeError)
+    end
+
+    it 'merges scripts and stylesheets from both bundles' do
+      bundle1 << bundle2
+
+      expect(bundle1.scripts).to eq([script1, script2])
+      expect(bundle1.stylesheets).to eq([stylesheet1, stylesheet2])
+    end
+  end
+
+  describe '#preloads' do
+    let(:script1) { instance_double(CKEditor5::Rails::Assets::JSExportsMeta, url: '/js/script1.js') }
+    let(:script2) { instance_double(CKEditor5::Rails::Assets::JSExportsMeta, url: '/js/script2.js') }
+    let(:stylesheet1) { '/css/style1.css' }
+    let(:stylesheet2) { '/css/style2.css' }
+
+    let(:bundle) do
+      Class.new(described_class) do
+        attr_writer :scripts, :stylesheets
+
+        def scripts
+          @scripts ||= []
+        end
+
+        def stylesheets
+          @stylesheets ||= []
+        end
+      end.new
+    end
+
+    before do
+      bundle.scripts = [script1, script2]
+      bundle.stylesheets = [stylesheet1, stylesheet2]
+    end
+
+    it 'returns array of stylesheet paths and script urls' do
+      expect(bundle.preloads).to eq([
+                                      '/css/style1.css',
+                                      '/css/style2.css',
+                                      '/js/script1.js',
+                                      '/js/script2.js'
+                                    ])
+    end
+  end
+end
+
+RSpec.describe CKEditor5::Rails::Assets::JSExportsMeta do
+  let(:url) { '/path/to/script.js' }
+
+  describe '#initialize' do
+    it 'creates instance with import_name' do
+      meta = described_class.new(url, import_name: 'module')
+      expect(meta.import_name).to eq('module')
+    end
+
+    it 'creates instance with window_name' do
+      meta = described_class.new(url, window_name: 'MyModule')
+      expect(meta.window_name).to eq('MyModule')
+    end
+
+    it 'marks as translation when specified' do
+      meta = described_class.new(url, translation: true, import_name: 'module')
+      expect(meta).to be_translation
+    end
+  end
+end
+
+RSpec.describe CKEditor5::Rails::Assets::JSImportMeta do
+  describe '#initialize' do
+    it 'raises error when neither import_name nor window_name is provided' do
+      expect { described_class.new }.to raise_error(ArgumentError)
+    end
+
+    it 'raises error when import_as is present without import_name' do
+      expect { described_class.new(import_as: 'alias', window_name: 'Module') }
+        .to raise_error(ArgumentError)
+    end
+
+    it 'creates valid instance with import_name' do
+      meta = described_class.new(import_name: 'module')
+      expect(meta).to be_esm
+    end
+
+    it 'creates valid instance with window_name' do
+      meta = described_class.new(window_name: 'Module')
+      expect(meta).to be_window
+    end
+  end
+
+  describe '#to_h' do
+    it 'returns hash with only present values' do
+      meta = described_class.new(import_name: 'module', import_as: 'alias')
+      expect(meta.to_h).to eq({
+                                import_name: 'module',
+                                import_as: 'alias'
+                              })
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe CKEditor5::Rails::Cdn::CKBoxBundle do
+  let(:version) { CKEditor5::Rails::Semver.new('2.6.0') }
+  let(:cdn) { :jsdelivr }
+  let(:theme) { :lark }
+  let(:translations) { [] }
+  let(:bundle) { described_class.new(version, theme: theme, cdn: cdn, translations: translations) }
+
+  describe '#initialize' do
+    context 'with valid parameters' do
+      it 'creates bundle successfully' do
+        expect { bundle }.not_to raise_error
+      end
+    end
+
+    context 'with invalid parameters' do
+      it 'raises error for invalid version' do
+        expect { described_class.new('invalid', theme: theme) }
+          .to raise_error(ArgumentError, 'version must be semver')
+      end
+
+      it 'raises error for invalid theme type' do
+        expect { described_class.new(version, theme: 123) }
+          .to raise_error(ArgumentError, 'theme must be a string or symbol')
+      end
+
+      it 'raises error for invalid translations type' do
+        expect { described_class.new(version, theme: theme, translations: 'invalid') }
+          .to raise_error(ArgumentError, 'translations must be an array')
+      end
+    end
+  end
+
+  describe '#scripts' do
+    it 'returns array with main script' do
+      expect(bundle.scripts.first).to be_a(CKEditor5::Rails::Assets::JSExportsMeta)
+      expect(bundle.scripts.first.url).to include('ckbox.js')
+      expect(bundle.scripts.first.window_name).to eq('CKBox')
+    end
+
+    context 'with translations' do
+      let(:translations) { [:pl] }
+
+      it 'includes translation scripts' do
+        translation_script = bundle.scripts.last
+        expect(translation_script.url).to include('translations/pl.js')
+        expect(translation_script.window_name).to eq('CKBOX_TRANSLATIONS')
+        expect(translation_script.translation?).to be true
+      end
+    end
+  end
+
+  describe '#stylesheets' do
+    it 'returns array with theme stylesheet' do
+      expect(bundle.stylesheets.first).to include('styles/themes/lark.css')
+    end
+
+    context 'with custom theme' do
+      let(:theme) { :custom }
+
+      it 'uses custom theme in stylesheet path' do
+        expect(bundle.stylesheets.first).to include('styles/themes/custom.css')
+      end
+    end
+  end
+end