ckeditor5 1.14.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b4d6c95733dd5744553bb787f20f9efaf474086c6268d6842561905747ec10f
-  data.tar.gz: 17052fae7a4e0e88fcc7c0af8ab397c8fadb3421ce611c64a10fe597d15a9d82
+  metadata.gz: 2a9a17d760584b0e960fe984a39421cb779f6ecbbbff0e01dd996530051e5257
+  data.tar.gz: 9612989fa0d36927280d3d2023499a5944c7cd22cae9f7a3f9eb1b56fb5a5651
 SHA512:
-  metadata.gz: 4dbaefb77863ceaeaad0805d430c86b90c7fbec675a7478fc55994a9706bfc3b8ec59c7791ce916389346da508f47a88ce2ff8c38a79d1c9189aa77405769f9f
-  data.tar.gz: 6b1d599bbfe28b35c81d037b052085c15fe55c1248f8e858efc77b7515c88b5ea2818187082f0db7810192b7d2cdfd3bb45d3dba57f7cf03cd0f53932dfbb202
+  metadata.gz: 7fe424cef2178f16106821edf3f195d2d4a6ba6076c4aa093a7f65aad2cc0fbe9836606bdfdaf2eb65c917bb561375c5f2ab5ab293baeb27f21173bf6a4e739c
+  data.tar.gz: 71b177012a1d865f613b36968f5d8bab3822fb6b8c67dedc04ec05a1f0729228b9c48b568c27ba00632e971e69e645b94f13c9eb3ed07ad6c2a1be52c0445e67

data/README.md

@@ -28,7 +28,12 @@ In your config (the default config is defined [here](https://github.com/Mati365/
 # config/initializers/ckeditor5.rb
 
 CKEditor5::Rails.configure do
-  version '43.3.0'
+  version '43.3.0'  # 🔖 Specify the version of editor you want.
+                    # ⚙️ Configuration includes:
+                    #    📝 Classic editor build
+                    #    🧩 Essential plugins (paragraphs, basic styles)
+                    #    🎛️ Default toolbar layout
+                    #    📜 GPL license
 end
 ```
 
@@ -54,23 +59,42 @@ In your view:
 <!-- app/views/demos/index.html.erb -->
 
 <% content_for :head do %>
+  <!-- 📦 Loads CKEditor assets via importmap based on initializer config -->
   <%= ckeditor5_assets %>
 <% end %>
 
+<!-- 🖋️ Renders rich text editor interface using WebComponent -->
 <%= ckeditor5_editor %>
 ```
 
 Voilà! You have CKEditor 5 integrated with your Rails application. 🎉
 
+## Try Our Demos! 🎮 ✨
+
+Want to see some cool examples? We've got you covered! Check out our interactive [demo application](https://github.com/Mati365/ckeditor5-rails/tree/main/sandbox/app/views/demos) packed with various editor configurations. You can also explore official CKEditor 5 [examples](https://ckeditor.com/docs/ckeditor5/latest/examples/builds/classic-editor.html) for more inspiration! 💡
+
+Ready to play with the demos locally? It's super easy! Just follow these steps: 🚀
+
+```bash
+bundle install # Install all the goodies 📦
+bundle exec guard -g rails # Fire up the server 🔥
+```
+
+Now the fun part - open [http://localhost:3000/](http://localhost:3000/) in your browser and start experimenting! 🎯 Feel free to tweak the code and make it your own! 🎨
+
+Want to extend CKEditor's functionality? Check out our [plugins directory](https://github.com/Mati365/ckeditor5-rails/tree/main/lib/ckeditor5/rails/plugins) and create your own awesome plugins! 🔌 We love community contributions - your plugin could be the next great addition to our ecosystem! ⭐
+
 ## Table of Contents 📚
 
 - [CKEditor 5 Rails Integration ✨](#ckeditor-5-rails-integration-)
   - [Installation 🛠️](#installation-️)
+  - [Try Our Demos! 🎮 ✨](#try-our-demos--)
   - [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)
+      - [`automatic_upgrades(enabled: true)` method](#automatic_upgradesenabled-true-method)
       - [`gpl` method](#gpl-method)
       - [`license_key(key)` method](#license_keykey-method)
       - [`premium` method](#premium-method)
@@ -86,6 +110,7 @@ Voilà! You have CKEditor 5 integrated with your Rails application. 🎉
       - [`plugins(*names, **kwargs)` method](#pluginsnames-kwargs-method)
       - [`inline_plugin(name, code)` method](#inline_pluginname-code-method)
       - [`simple_upload_adapter(url)` method](#simple_upload_adapterurl-method)
+    - [Automatic upgrades 🔄](#automatic-upgrades-)
     - [Controller / View helpers 📦](#controller--view-helpers-)
       - [`ckeditor5_element_ref(selector)` method](#ckeditor5_element_refselector-method)
       - [`ckeditor5_preset(&block)` method](#ckeditor5_presetblock-method)
@@ -149,6 +174,11 @@ CKEditor5::Rails.configure do
   presets.define :blank_preset, inherit: false do
     version '44.0.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
+    # potential security issues.
+    automatic_upgrades
+
     gpl
     type :classic
 
@@ -239,6 +269,24 @@ CKEditor5::Rails.configure do
 end
 ```
 
+#### `automatic_upgrades(enabled: true)` method
+
+Defines if automatic upgrades should be enabled. It's enabled for the `:default` preset by default. The example below shows how to disable automatic upgrades:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... other configuration
+
+  automatic_upgrades enabled: false
+end
+```
+
+It means that the editor will automatically upgrade to the latest version when the gem is updated. It'll upgrade the editor only if the new patch or minor version is released. If you want to disable automatic upgrades, you can pass the `enabled: false` keyword argument to the `automatic_upgrades` method.
+
+Version is checked every nth day, where n is the number of days since the last check. Currently it's 4 days.
+
 #### `gpl` method
 
 Defines the license of CKEditor 5. The example below shows how to set the license to GPL:
@@ -590,7 +638,11 @@ CKEditor5::Rails.configure do
 end
 ```
 
-Remember to remove the `Base64UploadAdapter` plugin from the plugins list if you want to use the simple upload adapter. It may cause issues.
+### Automatic upgrades 🔄
+
+The gem includes a feature that automatically upgrades the CKEditor&nbsp;5 version when it's released. It's enabled by default for the `:default` preset. It means that the editor will automatically check the version of the editor during the initialization and upgrade it to the latest version if the new patch or minor version is released.
+
+If you want to disable automatic upgrades, you can pass the `enabled: false` keyword argument to the `automatic_upgrades` method.
 
 ```rb
 # config/initializers/ckeditor5.rb
@@ -598,9 +650,7 @@ Remember to remove the `Base64UploadAdapter` plugin from the plugins list if you
 CKEditor5::Rails.configure do
   # ... other configuration
 
-  plugins do
-    remove :Base64UploadAdapter
-  end
+  automatic_upgrades enabled: false
 end
 ```
 

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

@@ -76,6 +76,12 @@ module CKEditor5::Rails
       editor_config = config || preset.config
       editor_config = editor_config.deep_merge(extra_config)
       editor_config[:initialData] = initial_data if initial_data
+
+      if preset.automatic_upgrades? && editor_config[:version].present?
+        detected_version = VersionDetector.latest_safe_version(editor_config[:version])
+        editor_config[:version] = detected_version if detected_version
+      end
+
       editor_config
     end
 

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

@@ -42,6 +42,7 @@ module CKEditor5::Rails::Presets
 
     def define_default_preset # rubocop:disable Metrics/MethodLength
       define :default do
+        automatic_upgrades
         gpl
         type :classic
         menubar

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

@@ -16,6 +16,7 @@ module CKEditor5::Rails
         @type = :classic
         @ckbox = nil
         @editable_height = nil
+        @automatic_upgrades = false
         @config = {
           plugins: [],
           toolbar: []
@@ -24,6 +25,19 @@ module CKEditor5::Rails
         instance_eval(&block) if block_given?
       end
 
+      def initialize_copy(source)
+        super
+
+        @translations = source.translations.dup
+        @ckbox = source.ckbox.dup if source.ckbox
+        @config = {
+          plugins: source.config[:plugins].map(&:dup),
+          toolbar: deep_copy_toolbar(source.config[:toolbar])
+        }.merge(
+          source.config.except(:plugins, :toolbar).deep_dup
+        )
+      end
+
       def premium?
         @premium
       end
@@ -92,7 +106,20 @@ module CKEditor5::Rails
       def version(version = nil)
         return @version.to_s if version.nil?
 
-        @version = Semver.new(version)
+        if @automatic_upgrades && version
+          detected = VersionDetector.latest_safe_version(version)
+          @version = Semver.new(detected || version)
+        else
+          @version = Semver.new(version)
+        end
+      end
+
+      def automatic_upgrades(enabled: true)
+        @automatic_upgrades = enabled
+      end
+
+      def automatic_upgrades?
+        @automatic_upgrades
       end
 
       def cdn(cdn = nil, &block)
@@ -174,12 +201,24 @@ module CKEditor5::Rails
 
       def simple_upload_adapter(upload_url = '/uploads')
         plugins do
-          remove :Base64UploadAdapter
+          remove(:Base64UploadAdapter)
         end
 
         plugin(Plugins::SimpleUploadAdapter.new)
         configure(:simpleUpload, { uploadUrl: upload_url })
       end
+
+      private
+
+      def deep_copy_toolbar(toolbar)
+        return toolbar.dup if toolbar.is_a?(Array)
+        return {} if toolbar.nil?
+
+        {
+          items: toolbar[:items].dup,
+          shouldNotGroupWhenFull: toolbar[:shouldNotGroupWhenFull]
+        }
+      end
     end
   end
 end

data/lib/ckeditor5/rails/semver.rb

@@ -1,18 +1,48 @@
 # frozen_string_literal: true
 
-class CKEditor5::Rails::Semver
-  attr_reader :version
+module CKEditor5
+  module Rails
+    class Semver
+      SEMVER_PATTERN = /\A\d+\.\d+\.\d+\z/
 
-  alias to_s :version
+      attr_reader :major, :minor, :patch
 
-  def initialize(version)
-    @version = version.to_s
-    validate!
-  end
+      include Comparable
+
+      def initialize(version_string)
+        validate!(version_string)
+        @major, @minor, @patch = version_string.split('.').map(&:to_i)
+      end
+
+      def <=>(other)
+        return nil unless other.is_a?(Semver)
+
+        [major, minor, patch] <=> [other.major, other.minor, other.patch]
+      end
+
+      def safe_update?(other_version)
+        other = self.class.new(other_version)
+
+        return false if other.major != major
+        return true if other.minor > minor
+        return true if other.minor == minor && other.patch > patch
+
+        false
+      end
+
+      def version
+        "#{major}.#{minor}.#{patch}"
+      end
+
+      alias to_s :version
+
+      private
 
-  private
+      def validate!(version_string)
+        return if version_string.is_a?(String) && version_string.match?(SEMVER_PATTERN)
 
-  def validate!
-    raise ArgumentError, 'invalid version format' unless version.match?(/\A\d+\.\d+\.\d+\z/)
+        raise ArgumentError, 'invalid version format'
+      end
+    end
   end
 end

data/lib/ckeditor5/rails/version.rb

@@ -2,6 +2,6 @@
 
 module CKEditor5
   module Rails
-    VERSION = '1.14.0'
+    VERSION = '1.15.0'
   end
 end

data/lib/ckeditor5/rails/version_detector.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'singleton'
+require 'monitor'
+require_relative 'semver'
+
+module CKEditor5::Rails
+  class VersionDetector
+    include Singleton
+
+    NPM_PACKAGE = 'ckeditor5'
+    CACHE_DURATION = 345_600 # 4 days in seconds
+
+    class << self
+      delegate :latest_safe_version, to: :instance
+    end
+
+    def initialize
+      @cache = {}
+      @monitor = Monitor.new
+    end
+
+    def latest_safe_version(current_version)
+      @monitor.synchronize do
+        cache_key = "#{current_version}_latest"
+        return @cache[cache_key][:version] if valid_cache_entry?(cache_key)
+
+        version = find_latest_safe_version(current_version)
+        @cache[cache_key] = { version: version, timestamp: Time.now.to_i }
+        version
+      end
+    end
+
+    private
+
+    def valid_cache_entry?(key)
+      entry = @cache[key]
+      entry && (Time.now.to_i - entry[:timestamp] < CACHE_DURATION)
+    end
+
+    def find_latest_safe_version(current_version)
+      versions = fetch_all_versions
+      return nil if versions.empty?
+
+      current_semver = Semver.new(current_version)
+      versions
+        .reject { |v| v.include?('nightly') || v.include?('dev') }
+        .select { |v| v.match?(Semver::SEMVER_PATTERN) }
+        .sort_by { |v| Semver.new(v) }
+        .reverse
+        .find { |v| current_semver.safe_update?(v) }
+    end
+
+    def fetch_all_versions
+      uri = URI("https://registry.npmjs.org/#{NPM_PACKAGE}")
+      response = fetch_with_timeout(uri)
+
+      if response.is_a?(Net::HTTPSuccess)
+        data = JSON.parse(response.body)
+        data['versions'].keys
+      else
+        warn 'Failed to fetch CKEditor versions'
+        []
+      end
+    rescue StandardError => e
+      warn "Error fetching versions: #{e.message}"
+      []
+    end
+
+    def fetch_with_timeout(uri)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = (uri.scheme == 'https')
+      http.open_timeout = 1
+      http.read_timeout = 1
+      http.get(uri.request_uri)
+    end
+  end
+end

data/lib/ckeditor5/rails.rb

@@ -3,6 +3,7 @@
 module CKEditor5
   module Rails
     require_relative 'rails/version'
+    require_relative 'rails/version_detector'
     require_relative 'rails/semver'
     require_relative 'rails/assets/assets_bundle'
     require_relative 'rails/assets/assets_bundle_html_serializer'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -74,6 +74,7 @@ files:
 - lib/ckeditor5/rails/presets/toolbar_builder.rb
 - lib/ckeditor5/rails/semver.rb
 - lib/ckeditor5/rails/version.rb
+- lib/ckeditor5/rails/version_detector.rb
 - spec/lib/ckeditor5/rails/cdn/url_generator_spec.rb
 - spec/lib/ckeditor5/rails/semver_spec.rb
 - spec/spec_helper.rb