ckeditor5 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3f3b6f1bee0c89fcabe50c6fa0597cd2b817967d381a9459f9bf8941d0df75e
-  data.tar.gz: 5fafb6320e6475b8dcbedc3228010f2b1d9da07a6b37004e3cbef2158700b480
+  metadata.gz: 1a430aeac80e44b802a01fd61104356f2a18e401dc6650b14c7c3e5ed8a95f9a
+  data.tar.gz: 16f0147ad4faf2a26224236af5a54875a8fbf86139ce945b2f01c350524bc7df
 SHA512:
-  metadata.gz: f3cf0dd3c9c5fd7c5ce7b234c961a0c807fbe2ddbc0a4b321ce14121dcc72acc122e8351a7d01f283c8efebfeb599d5cd5d25edb0193999682f55ffc186c9a9c
-  data.tar.gz: bd2da5b11be2b6a7011256a1d4bc6af5acad330c4e1b102ee8b01ee786dc97eeb2e89ef71853a6f169ab941e4f95cd1e8ffdb66cfbf52aa10848383afed01c7a
+  metadata.gz: 82860b61ad2da6eba0cf1969c6d1190c7d90e3ce5bfabd5c9c1ad8a9b9449a12c03d83ef65563fe37c0f74c4f75078c7ba867f377186bc35341ccf5fdff97bd7
+  data.tar.gz: 43bdc1f9313154c6c7255a3621523ae1f4bb51d475d381eeece7515464d7bab059a64dd480d9d7e32d9d0a94c177ecb41d4998b47dbb41e5f35880b643966b1f

data/Gemfile

@@ -1,3 +1,23 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
+gem 'bundler', '~> 2.5', '>= 2.5.21'
+
+group :development do
+  gem 'brakeman', '~> 6.1', '>= 6.1.1', require: false
+  gem 'guard'
+  gem 'guard-bundler'
+  gem 'guard-rails'
+  gem 'rake', '~> 13.2', '>= 13.2.1'
+  gem 'rspec', '~> 3.13'
+  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
+end
+
+group :test, :development do
+  gem 'capybara', '~> 3.40'
+end
+
 gemspec

data/README.md

@@ -1,4 +1,4 @@
-# ckeditor5
+# CKEditor 5 Rails Integration
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://opensource.org/licenses/MIT)
 ![Gem Version](https://img.shields.io/gem/v/ckeditor5-rails?style=flat-square)
@@ -6,9 +6,9 @@
 ![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.
+Unofficial CKEditor 5 Ruby on Rails integration gem. Provides seamless integration of CKEditor 5 with Rails applications through web components and helper methods.
 
-## Install
+## Installation
 
 Add this line to your application's Gemfile:
 
@@ -16,20 +16,101 @@ Add this line to your application's Gemfile:
 gem 'ckeditor5'
 ```
 
-## :construction: Planned features
+## Basic Usage
 
-- [ ] Add support for CKEditor 5 `Classic` / `Multi-Root` / `Balloon` / `Inline` / `Document editors`.
-- [ ] Add support for CKEditor 5 Watchdog and Context.
-- [ ] Add support for CKEditor 5 CDN and NPM packages.
-- [ ] Add support for CKEditor 5 Collaboration.
-- [ ] Add support for SSR.
+### Presets
 
-## :construction: Planned usage
+Override default preset configuration:
 
-Classic editor:
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails::Engine.configure do |config|
+  config.presets.override :default do |preset|
+    preset.menubar visible: false
+  end
+end
+```
+
+Create new preset:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails::Engine.configure do |config|
+  config.presets.define :custom do |preset|
+    shape :classic
+
+    menubar
+
+    toolbar :undo, :redo, :|, :heading, :|, :bold, :italic, :underline, :|,
+            :link, :insertImage, :ckbox, :mediaEmbed, :insertTable, :blockQuote, :|,
+            :bulletedList, :numberedList, :todoList, :outdent, :indent
+
+    plugins :AccessibilityHelp, :Autoformat, :AutoImage, :Autosave,
+            :BlockQuote, :Bold, :CKBox, :CKBoxImageEdit, :CloudServices,
+            :Essentials, :Heading, :ImageBlock, :ImageCaption, :ImageInline,
+            :ImageInsert, :ImageInsertViaUrl, :ImageResize, :ImageStyle,
+            :ImageTextAlternative, :ImageToolbar, :ImageUpload, :Indent,
+            :IndentBlock, :Italic, :Link, :LinkImage, :List, :ListProperties,
+            :MediaEmbed, :Paragraph, :PasteFromOffice, :PictureEditing,
+            :SelectAll, :Table, :TableCaption, :TableCellProperties,
+            :TableColumnResize, :TableProperties, :TableToolbar,
+            :TextTransformation, :TodoList, :Underline, :Undo, :Base64UploadAdapter
+  end
+end
+
+# Somewhere in your view
+
+= ckeditor5_editor preset: :custom
+```
+
+### CDN Configuration
+
+#### jsDelivr (Default)
+
+```slim
+- content_for :head
+  = ckeditor5_assets version: '43.2.0'
+```
+
+#### unpkg
+
+```slim
+- content_for :head
+  = ckeditor5_unpkg_assets version: '43.2.0'
+```
+
+#### CKEditor Cloud
+
+It's available only for licensed users.
+
+```slim
+- content_for :head
+  = ckeditor5_assets version: '43.2.0', license_key: 'YOUR-LICENSE-KEY'
+```
+
+### Editor type
+
+#### Classic Editor
+
+```slim
+- content_for :head
+  = ckeditor5_assets version: '43.2.0' # Optional: translations: [ :pl, :es ]
+
+= ckeditor5_editor
+```
+
+#### Multiroot Editor
 
 ```slim
-= render ckeditor5 :classic, id: 'editor', config: { toolbar: 'bold italic | link' }
+= ckeditor5_editor type: :multiroot do
+  = ckeditor5_toolbar
+  br
+  = ckeditor5_editable 'editable-a' do
+    | This is a toolbar editable
+  br
+  = ckeditor5_editable 'editable-b'
 ```
 
 ## License

data/lib/ckeditor5/rails/assets/assets_bundle.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module'
+
+module CKEditor5::Rails::Assets
+  class AssetsBundle
+    def initialize
+      validate_implementation!
+    end
+
+    def empty?
+      scripts.empty? && stylesheets.empty?
+    end
+
+    def translations_scripts
+      scripts.select(&:translation?)
+    end
+
+    def preloads
+      stylesheets + scripts.map(&:url)
+    end
+
+    def <<(other)
+      raise TypeError, 'other must be an instance of AssetsBundle' unless other.is_a?(AssetsBundle)
+
+      @scripts = scripts + other.scripts
+      @stylesheets = stylesheets + other.stylesheets
+    end
+
+    private
+
+    def validate_implementation!
+      %i[scripts stylesheets].each do |method|
+        unless respond_to?(method, true)
+          raise NotImplementedError, "#{self.class} must implement the ##{method} method"
+        end
+      end
+    end
+  end
+
+  class JSExportsMeta
+    attr_reader :url, :import_meta
+
+    delegate :esm?, :window?, :import_name, :window_name, :import_as, to: :import_meta
+
+    def initialize(url, translation: false, **import_options)
+      @url = url
+      @import_meta = JSImportMeta.new(**import_options)
+      @translation = translation
+    end
+
+    def translation?
+      @translation
+    end
+  end
+
+  class JSImportMeta
+    attr_reader :import_as, :import_name, :window_name
+
+    def initialize(import_as: nil, import_name: nil, window_name: nil)
+      validate_arguments!(import_as, import_name, window_name)
+      @import_as = import_as
+      @import_name = import_name
+      @window_name = window_name
+    end
+
+    def esm?
+      import_name.present?
+    end
+
+    def window?
+      window_name.present?
+    end
+
+    def to_h
+      {
+        import_as: import_as,
+        import_name: import_name,
+        window_name: window_name
+      }.compact
+    end
+
+    private
+
+    def validate_arguments!(import_as, import_name, window_name)
+      if import_name.nil? && window_name.nil?
+        raise ArgumentError,
+              'import_name or window_name must be present'
+      end
+
+      raise ArgumentError, 'import_name required when import_as is present' if import_as && import_name.nil?
+    end
+  end
+end

data/lib/ckeditor5/rails/assets/assets_bundle_html_serializer.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+module CKEditor5::Rails::Assets
+  WEBCOMPONENT_SOURCE = File.read(File.join(__dir__, 'webcomponent.mjs')).html_safe
+
+  class AssetsBundleHtmlSerializer
+    include ActionView::Helpers::TagHelper
+
+    attr_reader :bundle
+
+    def initialize(bundle)
+      raise TypeError, 'bundle must be an instance of AssetsBundle' unless bundle.is_a?(AssetsBundle)
+
+      @bundle = bundle
+    end
+
+    def to_html
+      safe_join([
+                  preload_tags,
+                  styles_tags,
+                  window_scripts_tags,
+                  scripts_import_map_tag,
+                  web_component_tag
+                ])
+    end
+
+    def self.url_resource_preload_type(url)
+      case File.extname(url)
+      when '.js' then 'script'
+      when '.css' then 'style'
+      else 'fetch'
+      end
+    end
+
+    private
+
+    def web_component_tag
+      @web_component_tag ||= tag.script(WEBCOMPONENT_SOURCE, type: 'module', nonce: true)
+    end
+
+    def window_scripts_tags
+      @window_scripts_tags ||= safe_join(bundle.scripts.filter_map do |script|
+        tag.script(src: script.url, nonce: true, async: true) if script.window?
+      end)
+    end
+
+    def scripts_import_map_tag
+      return @scripts_import_map_tag if defined?(@scripts_import_map_tag)
+
+      import_map = bundle.scripts.each_with_object({}) do |script, map|
+        map[script.import_name] = script.url if script.esm?
+      end
+
+      @scripts_import_map_tag = tag.script(
+        { imports: import_map }.to_json.html_safe,
+        type: 'importmap',
+        nonce: true
+      )
+    end
+
+    def styles_tags
+      @styles_tags ||= safe_join(bundle.stylesheets.map do |url|
+        tag.link(href: url, rel: 'stylesheet')
+      end)
+    end
+
+    def preload_tags
+      @preload_tags ||= safe_join(bundle.preloads.map do |url|
+        tag.link(href: url, rel: 'preload', as: self.class.url_resource_preload_type(url))
+      end)
+    end
+  end
+end