ckeditor5 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '028a09c0049e3eb489434b0447796369924801d0f5273a400e9783dbd3a8a70c'
-  data.tar.gz: e9a3c65f03a85b1361b612c85b00c5cb9d1d8385eeca716c5cea4f0e5817474b
+  metadata.gz: c7b18841155e113a731b8b81c953fd13547a9ed25f3d5be662786297fc6a985a
+  data.tar.gz: 8894ffe8876faad795fab39bdae58c03fdfb4dd014337c30c6573e20c881b74b
 SHA512:
-  metadata.gz: 5bf454b35f45aca3a44a2463d007cea579714c835d82edf7e6ed351db3c93a94aff59489bab7cea69cd78853acf50473ad9f7cf64819ee5c3c5bc5c0ef2d20a8
-  data.tar.gz: e394db6e299f6a48c88f50a306500bcae7c87c0eae6092bdf44c7f62e4a179da542f7299448db18045c086047da16a5818f3915416d9b10bb00747bda9e431ce
+  metadata.gz: f2abcac7b7c28c763b095b83078ce25b6d081b59120a8a8e40f48a1711334d9ac59828bd047bb3d727bc85c2e2ce2325a263c18941485f1c062fa98ddb789b22
+  data.tar.gz: e7d0c636c623904202bb3c6a18e5196c90f5c39bffd18f9a24749e764e338032a7ba8f2c2d0367e24e337b8ea03c616fb2a8308b95deae5f2a81f37ca0199ba8

data/README.md

@@ -39,11 +39,9 @@ In your view:
 
 <% content_for :head do %>
   <%= ckeditor5_assets %>
-  <!-- or using inline config: ckeditor5_assets version: '43.3.0', premium: false -->
 <% end %>
 
-<%= ckeditor5_editor style: 'width: 600px', initial_data: '<YOUR DATA>' %>
-<!-- or using inline config: ckeditor5_editor type: :classic, config: { toolbar: [:Bold, :Italic] }, ... -->
+<%= ckeditor5_editor %>
 ```
 
 Voilà! You have CKEditor 5 integrated with your Rails application. 🎉
@@ -55,6 +53,7 @@ Voilà! You have CKEditor 5 integrated with your Rails application. 🎉
   - [Table of Contents 📚](#table-of-contents-)
   - [Presets 🎨](#presets-)
     - [Available Configuration Methods ⚙️](#available-configuration-methods-️)
+      - [`cdn(cdn = nil, &block)` method](#cdncdn--nil-block-method)
       - [`version(version)` method](#versionversion-method)
       - [`gpl` method](#gpl-method)
       - [`license_key(key)` method](#license_keykey-method)
@@ -142,21 +141,48 @@ CKEditor5::Rails.configure do |config|
 
     toolbar do
       remove :underline, :heading
-
-      # prepend :underline
-      # append :heading
     end
   end
 end
 ```
 
-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.
+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.
 
 ### Available Configuration Methods ⚙️
 
 <details>
   <summary>Expand to show available methods 📖</summary>
 
+#### `cdn(cdn = nil, &block)` method
+
+Defines the CDN to be used for CKEditor 5 assets. The example below shows how to set the CDN to `:jsdelivr`:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+config.presets.define :custom do
+  # ... other configuration
+
+  cdn :jsdelivr
+end
+```
+
+It also allows you to define a custom CDN by passing a block with the bundle, version, and path arguments. The example below shows how to define it for the `jsdelivr` CDN:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+config.presets.define :custom do
+  # ... other configuration
+
+  cdn do |bundle, version, path|
+    base_url = "https://cdn.jsdelivr.net/npm/#{bundle}@#{version}/dist"
+
+    "#{base_url}/#{path.start_with?('translations/') ? '' : 'browser/'}#{path}"
+  end
+end
+```
+
 #### `version(version)` method
 
 Defines the version of CKEditor 5 to be used. The example below shows how to set the version to `43.2.0`:
@@ -878,34 +904,25 @@ The example below shows how to define a custom plugin that allows toggling the h
 config.presets.define :custom do
   # ... other configuration
 
-  # 1. You can define it inline like below or in a separate file.
-
-  # In case if plugin is located in external file (recommended), you can simply import it:
-
-  # inline_plugin :MyCustomPlugin, <<~JS
-  #  import MyPlugin from 'app/javascript/custom_plugins/highlight.js';
-  #  export default MyPlugin;
-  # JS
-
-  # 2. You can also use "window_name" option to import plugin from window object:
+  # 1. You can also use "window_name" option to import plugin from window object:
 
   # plugin :MyPlugin, window_name: 'MyPlugin'
 
-  # 3. Create JavaScript file in app/javascript/custom_plugins/highlight.js:
-  # You can also use "plugin" to import plugin from file using 'import_name' option.
-  # Your `my-custom-plugin` must be present in import map.
+  # 2. Create JavaScript file in app/javascript/custom_plugins/highlight.js,
+  #    add it to import map and then load it in initializer:
 
   # plugin :MyCustomPlugin, import_name: 'my-custom-plugin'
 
-  # 4 Create JavaScript file in app/javascript/custom_plugins/highlight.js:
+  # 3 Create JavaScript file in app/javascript/custom_plugins/highlight.js
+  #   and then load it in initializer:
 
   # In Ruby initializer you can also load plugin code directly from file:
-  plugin :MyCustomPlugin, File.read(
+  inline_plugin :MyCustomPlugin, File.read(
     Rails.root.join('app/javascript/custom_plugins/highlight.js')
   )
 
-  # 5. Or even define it inline:
-  # plugin :MyCustomPlugin,  <<~JS
+  # 4. Or even define it inline:
+  # inline_plugin :MyCustomPlugin,  <<~JS
   #    import { Plugin } from 'ckeditor5';
   #
   #    export default class MyCustomPlugin extends Plugin {

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

@@ -19,8 +19,11 @@ module CKEditor5::Rails::Cdn
     }.freeze
 
     CDN_COMMERCIAL_GENERATORS = {
-      cloud: ->(bundle, version, path) { "https://cdn.ckeditor.com/#{bundle}/#{version}/#{path}" },
-      ckbox: ->(bundle, version, path) { "https://cdn.ckbox.io/#{bundle}/#{version}/#{path}" }
+      cloud: lambda { |bundle, version, path|
+        domain = bundle == 'ckbox' ? 'ckbox.io' : 'ckeditor.com'
+
+        "https://cdn.#{domain}/#{bundle}/#{version}/#{path}"
+      }
     }.freeze
 
     included do
@@ -28,7 +31,7 @@ module CKEditor5::Rails::Cdn
     end
 
     def create_cdn_url(bundle, version, path)
-      generator = CDN_THIRD_PARTY_GENERATORS[cdn] || CDN_COMMERCIAL_GENERATORS[cdn]
+      generator = CDN_THIRD_PARTY_GENERATORS[cdn] || CDN_COMMERCIAL_GENERATORS[cdn] || cdn
 
       raise ArgumentError, "Unknown provider: #{cdn}" unless generator
 

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

@@ -67,10 +67,19 @@ module CKEditor5::Rails
         @version = Semver.new(version)
       end
 
-      def cdn(cdn = nil)
-        return @cdn if cdn.nil?
-
-        @cdn = cdn
+      def cdn(cdn = nil, &block)
+        return @cdn if cdn.nil? && block.nil?
+
+        if block_given?
+          unless block.arity == 3
+            raise ArgumentError,
+                  'Block must accept exactly 3 arguments: bundle, version, path'
+          end
+
+          @cdn = block
+        else
+          @cdn = cdn
+        end
       end
 
       def type(type = nil)

data/lib/ckeditor5/rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CKEditor5::Rails
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-01 00:00:00.000000000 Z
+date: 2024-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails