ckeditor5 0.0.1 → 1.0.0

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'url_generator'
+require_relative 'ckeditor_bundle'
+require_relative 'ckbox_bundle'
+
+module CKEditor5::Rails
+  module Cdn::Helpers
+    def ckeditor5_cdn_assets(version:, cdn:, license_key: 'GPL', premium: false, translations: [], ckbox: nil)
+      bundle = build_base_cdn_bundle(cdn, version, translations)
+      bundle << build_premium_cdn_bundle(cdn, version, translations) if premium
+      bundle << build_ckbox_cdn_bundle(ckbox) if ckbox
+
+      @__ckeditor_context = {
+        license_key: license_key,
+        bundle: bundle
+      }
+
+      Assets::AssetsBundleHtmlSerializer.new(bundle).to_html
+    end
+
+    Cdn::UrlGenerator::CDN_THIRD_PARTY_GENERATORS.each_key do |key|
+      define_method(:"ckeditor5_#{key.to_s.parameterize}_assets") do |**kwargs|
+        ckeditor5_cdn_assets(**kwargs.merge(cdn: key))
+      end
+    end
+
+    def ckeditor5_assets(**kwargs)
+      if kwargs[:license_key] && kwargs[:license_key] != 'GPL'
+        ckeditor5_cloud_assets(**kwargs)
+      else
+        ckeditor5_cdn_assets(**kwargs.merge(cdn: Engine.base.default_cdn))
+      end
+    end
+
+    private
+
+    def build_base_cdn_bundle(cdn, version, translations)
+      Cdn::CKEditorBundle.new(
+        Semver.new(version),
+        'ckeditor5',
+        translations: translations,
+        cdn: cdn
+      )
+    end
+
+    def build_premium_cdn_bundle(cdn, version, translations)
+      Cdn::CKEditorBundle.new(
+        Semver.new(version),
+        'ckeditor5-premium-features',
+        translations: translations,
+        cdn: cdn
+      )
+    end
+
+    def build_ckbox_cdn_bundle(ckbox)
+      Cdn::CKBoxBundle.new(
+        Semver.new(ckbox[:version]),
+        theme: ckbox[:theme] || :lark,
+        cdn: ckbox[:cdn] || :ckbox
+      )
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+module CKEditor5::Rails::Cdn
+  module UrlGenerator
+    extend ActiveSupport::Concern
+
+    CDN_THIRD_PARTY_GENERATORS = {
+      jsdelivr: lambda { |bundle, version, path|
+        base_url = "https://cdn.jsdelivr.net/npm/#{bundle}@#{version}/dist"
+        "#{base_url}/#{path.start_with?('translations/') ? '' : 'browser/'}#{path}"
+      },
+
+      unpkg: lambda { |bundle, version, path|
+        base_url = "https://unpkg.com/#{bundle}@#{version}/dist"
+        "#{base_url}/#{path.start_with?('translations/') ? '' : 'browser/'}#{path}"
+      }
+    }.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}" }
+    }.freeze
+
+    included do
+      attr_reader :cdn
+    end
+
+    def create_cdn_url(bundle, version, path)
+      generator = CDN_THIRD_PARTY_GENERATORS[cdn] || CDN_COMMERCIAL_GENERATORS[cdn]
+
+      raise ArgumentError, "Unknown provider: #{cdn}" unless generator
+
+      generator.call(bundle, version, path)
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CKEditor5::Rails
+  module Cloud
+    module Helpers
+      def ckeditor5_cloud_assets(license_key:, **kwargs)
+        raise 'Cloud assets are not permitted in GPL license!' if license_key == 'GPL'
+
+        ckeditor5_cdn_assets(cdn: :cloud, license_key: license_key, **kwargs)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'props_plugin'
+require_relative 'props'
+
+module CKEditor5::Rails
+  module Editor::Helpers
+    class EditorContextError < StandardError; end
+    class PresetNotFoundError < ArgumentError; end
+
+    def ckeditor5_editor(
+      config: nil, extra_config: {},
+      type: nil, preset: :default,
+      **html_attributes, &block
+    )
+      context = validate_and_get_editor_context!
+      preset = fetch_editor_preset(preset)
+
+      config ||= preset.config
+      type ||= preset.type
+
+      editor_props = build_editor_props(
+        config: config.deep_merge(extra_config),
+        type: type,
+        context: context
+      )
+
+      render_editor_component(editor_props, html_attributes, &(type == :multiroot ? block : nil))
+    end
+
+    def ckeditor5_editable(name, **kwargs, &block)
+      tag.send(:'ckeditor-editable-component', name: name, **kwargs, &block)
+    end
+
+    def ckeditor5_toolbar(**kwargs)
+      tag.send(:'ckeditor-toolbar-component', **kwargs)
+    end
+
+    private
+
+    def validate_and_get_editor_context!
+      unless defined?(@__ckeditor_context)
+        raise EditorContextError,
+              'CKEditor installation context is not defined. ' \
+              'Ensure ckeditor5_assets is called in the head section.'
+      end
+
+      @__ckeditor_context
+    end
+
+    def fetch_editor_preset(preset)
+      Engine.base.presets[preset] or
+        raise PresetNotFoundError, "Preset #{preset} is not defined."
+    end
+
+    def build_editor_props(config:, type:, context:)
+      Editor::Props.new(context, type, config)
+    end
+
+    def render_editor_component(props, html_attributes, &block)
+      tag.send(:'ckeditor-component', **props.to_attributes, **html_attributes, &block)
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative 'props_plugin'
+
+module CKEditor5::Rails::Editor
+  class Props
+    EDITOR_TYPES = {
+      classic: 'ClassicEditor',
+      inline: 'InlineEditor',
+      balloon: 'BalloonEditor',
+      decoupled: 'DecoupledEditor',
+      multiroot: 'MultiRootEditor'
+    }.freeze
+
+    def initialize(context, type, config)
+      raise ArgumentError, "Invalid editor type: #{type}" unless Props.valid_editor_type?(type)
+
+      @context = context
+      @type = type
+      @config = config
+    end
+
+    def to_attributes
+      {
+        type: EDITOR_TYPES[@type],
+        **serialized_attributes
+      }
+    end
+
+    def self.valid_editor_type?(type)
+      EDITOR_TYPES.key?(type)
+    end
+
+    private
+
+    attr_reader :context, :type, :config
+
+    def serialized_attributes
+      {
+        translations: serialize_translations,
+        plugins: serialize_plugins,
+        config: serialize_config
+      }
+    end
+
+    def serialize_translations
+      context[:bundle].translations_scripts.map { |script| script.import_meta.to_h }.to_json
+    end
+
+    def serialize_plugins
+      (config[:plugins] || []).map { |plugin| PropsPlugin.normalize(plugin).to_h }.to_json
+    end
+
+    def serialize_config
+      config
+        .except(:plugins)
+        .merge(licenseKey: context[:license_key] || 'GPL')
+        .to_json
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module CKEditor5::Rails::Editor
+  class PropsPlugin
+    delegate :to_h, to: :import_meta
+
+    def initialize(name, premium: false)
+      @name = name
+      @premium = premium
+    end
+
+    def self.normalize(plugin)
+      case plugin
+      when String, Symbol then new(plugin)
+      when PropsPlugin then plugin
+      else raise ArgumentError, "Invalid plugin: #{plugin}"
+      end
+    end
+
+    private
+
+    attr_reader :name, :premium
+
+    def import_meta
+      ::CKEditor5::Rails::Assets::JSImportMeta.new(
+        import_as: name,
+        import_name: premium ? 'ckeditor5-premium-features' : 'ckeditor5'
+      )
+    end
+  end
+end

data/lib/ckeditor5/rails/engine.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'rails/engine'
+require_relative 'presets'
+
+module CKEditor5::Rails
+  class Engine < ::Rails::Engine
+    config.ckeditor5 = ActiveSupport::OrderedOptions.new
+
+    # Specifies which CDN should be used to load CKEditor 5 using the ckeditor5_assets helper.
+    # It is possible to use the following CDNs:
+    # - :unpkg
+    # - :jsdelivr (default)
+    config.ckeditor5.default_cdn = :jsdelivr
+
+    # Specifies configuration of editors generated by gem.
+    config.ckeditor5.presets = PresetsManager.new
+
+    initializer 'helper' do
+      ActiveSupport.on_load(:action_view) do
+        include Helpers
+      end
+    end
+
+    def self.base
+      config.ckeditor5
+    end
+
+    def self.configure
+      yield config.ckeditor5
+    end
+  end
+end

data/lib/ckeditor5/rails/helpers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'cdn/helpers'
+require_relative 'cloud/helpers'
+require_relative 'editor/helpers'
+
+module CKEditor5::Rails
+  module Helpers
+    include Cdn::Helpers
+    include Cloud::Helpers
+    include Editor::Helpers
+  end
+end

data/lib/ckeditor5/rails/presets.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module CKEditor5::Rails
+  class PresetsManager
+    attr_reader :presets
+
+    def initialize
+      @presets = {}
+      define_default_preset
+    end
+
+    def define(name, &block)
+      preset = PresetBuilder.new
+      preset.instance_eval(&block)
+      @presets[name] = preset
+    end
+
+    def override(name, &block)
+      @presets[name].instance_eval(&block)
+    end
+
+    def default
+      @presets[:default] || {}
+    end
+
+    def [](name)
+      @presets[name] || {}
+    end
+
+    private
+
+    def define_default_preset
+      define :default do
+        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
+  end
+
+  class PresetBuilder
+    attr_reader :type, :config
+
+    def initialize
+      @type = :classic
+      @config = {
+        plugins: [],
+        toolbar: []
+      }
+    end
+
+    def shape(type)
+      raise ArgumentError, "Invalid editor type: #{type}" unless Editor::Props.valid_editor_type?(type)
+
+      @type = type
+    end
+
+    def menubar(visible: true)
+      @config[:menuBar] = {
+        isVisible: visible
+      }
+    end
+
+    def toolbar(*items)
+      @config[:toolbar] = items
+    end
+
+    def plugin(name, premium: false)
+      @config[:plugins] << Editor::PropsPlugin.new(name, premium: premium)
+    end
+
+    def plugins(*names, premium: false)
+      names.each { |name| plugin(name, premium: premium) }
+    end
+
+    def language(lang)
+      @config[:language] = lang
+    end
+  end
+end

data/lib/ckeditor5/rails/semver.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class CKEditor5::Rails::Semver
+  attr_reader :version
+
+  alias to_s :version
+
+  def initialize(version)
+    @version = version
+    validate!
+  end
+
+  private
+
+  def validate!
+    raise ArgumentError, 'version must be a string' unless version.is_a?(String)
+    raise ArgumentError, 'invalid version format' unless version.match?(/\A\d+\.\d+\.\d+\z/)
+  end
+end

data/lib/ckeditor5/rails/version.rb

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

data/lib/ckeditor5/rails.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CKEditor5
+  module Rails
+    require_relative 'rails/version'
+    require_relative 'rails/semver'
+    require_relative 'rails/assets/assets_bundle'
+    require_relative 'rails/assets/assets_bundle_html_serializer'
+    require_relative 'rails/helpers'
+    require_relative 'rails/engine'
+  end
+end

data/lib/{ckeditor5.rb → ckeditor5_rails.rb}

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'ckeditor5/version'
+require 'ckeditor5/rails'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -9,23 +9,50 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-09 00:00:00.000000000 Z
-dependencies: []
+date: 2024-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description:
 email: cziken58@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
-- ".github/workflows/ruby.yml"
-- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- ckeditor5.gemspec
-- lib/ckeditor5.rb
-- lib/ckeditor5/version.rb
+- lib/ckeditor5/rails.rb
+- lib/ckeditor5/rails/assets/assets_bundle.rb
+- lib/ckeditor5/rails/assets/assets_bundle_html_serializer.rb
+- lib/ckeditor5/rails/assets/webcomponent.mjs
+- lib/ckeditor5/rails/cdn/ckbox_bundle.rb
+- lib/ckeditor5/rails/cdn/ckeditor_bundle.rb
+- lib/ckeditor5/rails/cdn/helpers.rb
+- lib/ckeditor5/rails/cdn/url_generator.rb
+- lib/ckeditor5/rails/cloud/helpers.rb
+- lib/ckeditor5/rails/editor/helpers.rb
+- lib/ckeditor5/rails/editor/props.rb
+- lib/ckeditor5/rails/editor/props_plugin.rb
+- lib/ckeditor5/rails/engine.rb
+- lib/ckeditor5/rails/helpers.rb
+- lib/ckeditor5/rails/presets.rb
+- lib/ckeditor5/rails/semver.rb
+- lib/ckeditor5/rails/version.rb
+- lib/ckeditor5_rails.rb
 homepage: https://github.com/Mati365/ckeditor5-rails
 licenses:
 - MIT
@@ -38,14 +65,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: CKEditor 5 for Rails

data/.github/workflows/ruby.yml

@@ -1,28 +0,0 @@
-name: Ruby
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-
-permissions:
-  contents: read
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
-
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rake

data/.gitignore

@@ -1,56 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-# Ignore Byebug command history file.
-.byebug_history
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*

data/Rakefile

@@ -1,3 +0,0 @@
-require 'bundler/gem_tasks'
-
-task :gem => :build

data/ckeditor5.gemspec

@@ -1,23 +0,0 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'ckeditor5/version'
-
-Gem::Specification.new do |s|
-  s.name = 'ckeditor5'
-  s.version = CKEditor5::VERSION
-  s.platform = Gem::Platform::RUBY
-  s.summary = 'CKEditor 5 for Rails'
-  s.authors = [
-    'Mateusz Bagiński',
-    'Łukasz Modliński'
-  ]
-
-  s.license = 'MIT'
-  s.email = 'cziken58@gmail.com'
-  s.homepage = 'https://github.com/Mati365/ckeditor5-rails'
-  s.files = `git ls-files`.split("\n")
-  s.executables  = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-  s.require_paths = ['lib']
-  s.required_ruby_version = '>= 2.7.0'
-end

data/lib/ckeditor5/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module CKEditor5
-  VERSION = '0.0.1'
-end