ckeditor5 1.17.1 → 1.17.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78094e2b7cf2ec9677a1eb9ee629918df4b6e9de62104cd6e2c8713b02ae7776
-  data.tar.gz: 63816a1caf2f2c42f08321f0169fb14e54e2f6424bc80834890dfde68a76f22f
+  metadata.gz: 789a4ca2ac0428fa31866a6fd99433577137e9ccbe64e321e86c20126814dc80
+  data.tar.gz: f4d3bc6f16777dd8dc03c4e62aada4c772021fc72bc99eeecbc668ac0dcc39b6
 SHA512:
-  metadata.gz: b3691b024f1cedc6da4086fea1754f6f4d7acdc2d3d9a10f5628b0b54c539e941073cff74459dd776956c758fe4da1f78b54a6c8ab0128248e1ecc9b308ba168
-  data.tar.gz: a5d4109cc5f559144a66abd7ba1b672a27d1ad41131bdead590c144d4c4b2d1eb518953267bfee9fb6fa14c9cce027416de28dece065ed852c198fd4587e08dc
+  metadata.gz: '02238ab74fc9982f48177b33bc20b59332ca58f9cb594868649e72ec5e504760d41e5a0ce4afee0cbeb5463335e34fb4303e5e30fd6b21abd96968a017ba715f'
+  data.tar.gz: f4a331e7b9afca50f1063626a73c083ed521521333e7492eaf252bd30a360b435459fe5a8d321c4b5a4355c291272c2ee352a01bbd15d8c916434222fbdaa804

data/README.md

@@ -44,8 +44,9 @@ In your view:
 <!-- app/views/demos/index.html.erb -->
 
 <% content_for :head do %>
-  <!-- 📦 Adds importmap with CKEditor 5 assets. Language is optional. -->
-  <%= ckeditor5_assets language: :en %>
+  <!-- 📦 Adds importmap with CKEditor 5 assets. -->
+  <!-- 🌍 It'll automatically use your `I18n.locale` language. -->
+  <%= ckeditor5_assets %>
 <% end %>
 
 <!-- 🖋️ CKEditor 5 might be placed using simple view helper ... -->
@@ -77,6 +78,11 @@ CKEditor5::Rails.configure do
 
   # Upload images to the server using the simple upload adapter, instead of Base64 encoding.
   # simple_upload_adapter
+
+  # Specify global language for the editor.
+  # It can be done here, in controller or in the view.
+  # By default the `I18n.locale` is used.
+  # language :pl
 end
 ```
 
@@ -149,6 +155,10 @@ For extending CKEditor's functionality, refer to the [plugins directory](https:/
   - [How to access editor instance? 🤔](#how-to-access-editor-instance-)
   - [Common Tasks and Solutions 💡](#common-tasks-and-solutions-)
     - [Setting Editor Language 🌐](#setting-editor-language-)
+      - [Setting the language in the assets helper](#setting-the-language-in-the-assets-helper)
+      - [Setting the language in the initializer](#setting-the-language-in-the-initializer)
+      - [Setting the language on the editor level](#setting-the-language-on-the-editor-level)
+      - [Preloading multiple translation packs](#preloading-multiple-translation-packs)
     - [Integrating with Forms 📋](#integrating-with-forms-)
       - [Rails form builder integration](#rails-form-builder-integration)
       - [Simple form integration](#simple-form-integration)
@@ -443,7 +453,7 @@ In order to set the language for the content, you can pass the `content` keyword
 CKEditor5::Rails.configure do
   # ... other configuration
 
-  language :pl
+  language :pl, content: :en
 end
 ```
 
@@ -1089,7 +1099,7 @@ The `ckeditor5_editor` helper renders CKEditor 5 instances in your views. Before
 
 You can set the initial content of the editor using the `initial_data` keyword argument or by passing the content directly to the `ckeditor5_editor` helper block.
 
-The example below shows how to set the initial content of the editor using the `initial_data` keyword argument:
+The example below shows how to set the initial content of the editor using the `initial_data` and `language` keyword arguments:
 
 ```erb
 <!-- app/views/demos/index.html.erb -->
@@ -1407,7 +1417,11 @@ This section covers frequent questions and scenarios when working with CKEditor
 
 ### Setting Editor Language 🌐
 
-You can set the language of the editor using the `language` keyword argument. The example below shows how to set the language of the editor to Polish:
+By default, CKEditor 5 uses the language specified in your `I18n.locale` configuration. However, you can override the language of the editor by passing the `language` keyword in few places.
+
+#### Setting the language in the assets helper
+
+Language specified here will be used for all editor instances on the page.
 
 ```erb
 <!-- app/views/demos/index.html.erb -->
@@ -1419,7 +1433,9 @@ You can set the language of the editor using the `language` keyword argument. Th
 <%= ckeditor5_editor %>
 ```
 
-It can be also set in the initializer:
+#### Setting the language in the initializer
+
+Language specified here will be used for all editor instances in your application.
 
 ```rb
 # config/initializers/ckeditor5.rb
@@ -1430,7 +1446,9 @@ CKEditor5::Rails.configure do
 end
 ```
 
-... or on the editor level (keep in mind to load translations in the assets helper):
+#### Setting the language on the editor level
+
+Language specified here will be used only for this editor instance. Keep in mind that you have to load the translation pack in the assets helper using the `translations` initializer method.
 
 ```erb
 <!-- app/views/demos/index.html.erb -->
@@ -1438,6 +1456,18 @@ end
 <%= ckeditor5_editor language: :pl %>
 ```
 
+#### Preloading multiple translation packs
+
+You can preload multiple translation packs in the initializer using the `translations` method:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  translations :pl, :es
+end
+```
+
 ### Integrating with Forms 📋
 
 You can integrate CKEditor 5 with Rails form builders like `form_for` or `simple_form`. The example below shows how to integrate CKEditor 5 with a Rails form using the `form_for` helper:

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

@@ -44,7 +44,7 @@ module CKEditor5::Rails
 
     private
 
-    def merge_with_editor_preset(preset, **kwargs)
+    def merge_with_editor_preset(preset, language: nil, **kwargs)
       found_preset = Engine.find_preset(preset)
 
       if found_preset.blank?
@@ -55,6 +55,13 @@ module CKEditor5::Rails
 
       new_preset = found_preset.clone.merge_with_hash!(**kwargs)
 
+      # Assign default language if not present
+      if language.present?
+        new_preset.language(language)
+      elsif !new_preset.language?
+        new_preset.language(I18n.locale)
+      end
+
       %i[version type].each do |key|
         next if new_preset.public_send(key).present?
 

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

@@ -40,7 +40,7 @@ module CKEditor5::Rails::Presets
 
     private
 
-    def define_default_preset # rubocop:disable Metrics/MethodLength
+    def define_default_preset
       define :default do
         version CKEditor5::Rails::DEFAULT_CKEDITOR_VERSION
 

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

@@ -61,7 +61,7 @@ module CKEditor5::Rails
         end
       end
 
-      def merge_with_hash!(language: nil, **overrides) # rubocop:disable Metrics/AbcSize
+      def merge_with_hash!(**overrides) # rubocop:disable Metrics/AbcSize
         @version = Semver.new(overrides[:version]) if overrides.key?(:version)
         @premium = overrides.fetch(:premium, premium)
         @cdn = overrides.fetch(:cdn, cdn)
@@ -73,8 +73,6 @@ module CKEditor5::Rails
         @ckbox = overrides.fetch(:ckbox, ckbox) if overrides.key?(:ckbox) || ckbox
         @config = config.merge(overrides.fetch(:config, {}))
 
-        language(language) if language
-
         self
       end
 
@@ -182,6 +180,10 @@ module CKEditor5::Rails
         builder
       end
 
+      def language?
+        config[:language].present?
+      end
+
       def language(ui = nil, content: ui) # rubocop:disable Naming/MethodParameterName
         return config[:language] if ui.nil?
 

data/lib/ckeditor5/rails/version.rb

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

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

@@ -16,6 +16,10 @@ RSpec.describe CKEditor5::Rails::Cdn::Helpers do
     end
   end
 
+  let(:context) do
+    helper.instance_variable_get(:@__ckeditor_context)
+  end
+
   let(:bundle_html) { '<script src="test.js"></script>' }
   let(:serializer) do
     instance_double(CKEditor5::Rails::Assets::AssetsBundleHtmlSerializer, to_html: bundle_html)
@@ -37,7 +41,7 @@ RSpec.describe CKEditor5::Rails::Cdn::Helpers do
           .with(
             instance_of(CKEditor5::Rails::Semver),
             'ckeditor5',
-            translations: [:pl],
+            translations: %i[pl en],
             cdn: :cloud
           )
           .and_call_original
@@ -61,7 +65,7 @@ RSpec.describe CKEditor5::Rails::Cdn::Helpers do
             .with(
               instance_of(CKEditor5::Rails::Semver),
               'ckeditor5',
-              translations: [:pl],
+              translations: %i[pl en],
               cdn: :cloud
             )
             .and_call_original
@@ -71,7 +75,7 @@ RSpec.describe CKEditor5::Rails::Cdn::Helpers do
             .with(
               instance_of(CKEditor5::Rails::Semver),
               'ckeditor5-premium-features',
-              translations: [:pl],
+              translations: %i[pl en],
               cdn: :cloud
             )
             .and_call_original
@@ -111,7 +115,7 @@ RSpec.describe CKEditor5::Rails::Cdn::Helpers do
         CKEditor5::Rails::Presets::PresetBuilder.new do
           version '34.1.0'
           type :classic
-          translations :pl
+          language :pl
           cdn :cloud
           license_key 'preset-license'
           premium false
@@ -121,20 +125,43 @@ RSpec.describe CKEditor5::Rails::Cdn::Helpers do
       it 'allows overriding preset values' do
         helper.ckeditor5_assets(preset: :default, license_key: 'overridden-license')
 
-        expect(helper.instance_variable_get(:@__ckeditor_context)[:preset].license_key)
-          .to eq('overridden-license')
+        expect(context[:preset].license_key).to eq('overridden-license')
       end
 
       it 'preserves non-overridden preset values' do
         helper.ckeditor5_assets(preset: :default, license_key: 'overridden-license')
-        preset_context = helper.instance_variable_get(:@__ckeditor_context)[:preset]
+        preset_context = context[:preset]
 
         expect(preset_context.version).to eq('34.1.0')
         expect(preset_context.premium?).to be false
         expect(preset_context.cdn).to eq(:cloud)
-        expect(preset_context.translations).to eq([:pl])
+        expect(preset_context.translations).to eq(%i[en pl])
         expect(preset_context.type).to eq(:classic)
       end
+
+      it 'allows to override language using language parameter' do
+        preset.language(:en)
+        helper.ckeditor5_assets(preset: :default, language: :pl)
+
+        expect(context[:preset].language).to eq({ ui: :pl, content: :pl })
+      end
+
+      it 'should not override language if it\'s specified in preset and not passed to helper' do
+        preset.language(:en)
+        helper.ckeditor5_assets(preset: :default)
+
+        expect(context[:preset].language).to eq({ ui: :en, content: :en })
+      end
+
+      it 'should use I18n.locale as default language if it\'s not specified in preset' do
+        preset.configure :language, nil
+
+        allow(I18n).to receive(:locale).and_return(:pl)
+
+        helper.ckeditor5_assets(preset: :default)
+
+        expect(context[:preset].language).to eq({ ui: :pl, content: :pl })
+      end
     end
 
     context 'with missing required parameters' do

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

@@ -293,11 +293,6 @@ RSpec.describe CKEditor5::Rails::Presets::PresetBuilder do
       expect(builder.merge_with_hash!(version: '35.0.0')).to eq(builder)
     end
 
-    it 'merges language configuration' do
-      builder.merge_with_hash!(language: :pl)
-      expect(builder.config[:language]).to eq({ ui: :pl, content: :pl })
-    end
-
     it 'preserves existing values when not overridden' do
       builder.version '34.0.0'
       builder.translations :en, :pl
@@ -328,6 +323,17 @@ RSpec.describe CKEditor5::Rails::Presets::PresetBuilder do
     end
   end
 
+  describe '#language?' do
+    it 'returns false when language is not set' do
+      expect(builder.language?).to be false
+    end
+
+    it 'returns true when language is set' do
+      builder.language(:pl)
+      expect(builder.language?).to be true
+    end
+  end
+
   describe '#language' do
     it 'returns language config when called without arguments' do
       builder.language(:pl, content: :en)

metadata

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