activeadmin_ckeditor5 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5a7fd340d3e084dd71d0f9b4b88d71c4fa5505b9c4a97acc745829eb8b40e48
+  data.tar.gz: a4ee062638a26c8dc37a3a1f84603ade5fc06ac9b8b8d7a40a6505bef32734dd
+SHA512:
+  metadata.gz: '09275daa69176302f3f2bfc5e3ae79adf3253259e3bb2f8b3e72a72d92b0c0d89230636bb503756ac2c80af37d045539b8d07195438ed7ab3cee4926d4b4a53c'
+  data.tar.gz: 64909501835fec9bed8c41a2820b89533e5a1fe51949ac7502777104a0988935ef386151850be8b8f27f3d06172777bdfe88aa337556dac5af1e2553d3e6c7a9

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-01-06
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 MingXuanSu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+## ActiveadminCkeditor
+
+Rails [activeadmin](https://github.com/activeadmin/activeadmin) integrated [CKEditor 5](https://ckeditor.com/docs/ckeditor5/latest/installation/index.html)
+### Reference
+
+[CKEditor5](https://github.com/SuMingXuan/ckeditor5-build-classic-for-rails/blob/master/build/ckeditor.js)
+
+[activeadmin](https://github.com/activeadmin/activeadmin)
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activeadmin_ckeditor5'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install activeadmin_ckeditor5
+
+### Usage
+
+```ruby
+ActiveAdmin.register Article do
+#...
+  form do |f|
+    f.inputs 'Article' do
+      f.input :title, label: 'title'
+      f.input :content, as: :ckeditor, label: 'content'
+    end
+    actions
+  end
+#...
+end
+```
+
+Define uploading route
+
+```ruby
+  #config/routes.rb
+  post :uploads, to: 'uploads#create'
+```
+
+Then define upload controller
+
+```ruby
+class UploadsController < ApplicationController
+  def create
+    #TODO
+  end
+end
+```
+
+
+You will get a `Can't verify CSRF token authenticity` error when you uploading image
+
+You can redefine `csrf_meta_tag` location
+
+```ruby
+# config/initializers/active_admin_layout.rb
+module AdminPageLayoutOverride
+  def build_active_admin_head
+    within head do
+      # CKEditor simpleUpload components will use csrfToken, but can't find csrf_meta_tag when loading js
+      # so the csrf_meta_tag is generated in advance here.
+      text_node csrf_meta_tag
+    end
+
+    super
+  end
+end
+ActiveAdmin::Views::Pages::Base.send :prepend, AdminPageLayoutOverride
+```
+
+Or skip verify authenticity token
+
+```ruby
+class AdminUploadsController < AdminApplicationController
+  skip_forgery_protection
+  def create
+    #TODO
+  end
+end
+```
+
+

data/activeadmin_ckeditor5.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/activeadmin/ckeditor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activeadmin_ckeditor5"
+  spec.version       = Activeadmin::Ckeditor::VERSION
+  spec.authors       = ["MingXuanSu"]
+  spec.email         = ["ohmyhysss@gmail.com"]
+
+  spec.summary       = "Rails activeadmin integrated CKEditor 5"
+  spec.description   = "Rails activeadmin integrated CKEditor 5"
+  spec.homepage      = "https://github.com/SuMingXuan/activeadmin_ckeditor5"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/SuMingXuan/activeadmin_ckeditor5"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/app/assets/javascripts/activeadmin/ckeditor-init.js

@@ -0,0 +1,12 @@
+//= require ./ckeditor
+
+(function () {
+  function initCkeditors() {
+    ClassicEditor.create(
+      document.querySelector("[data-activeadmin-ckcontent]")
+    );
+  }
+  $(document).ready(initCkeditors);
+  $(document).on("has_many_add:after", ".has_many_container", initCkeditors);
+  $(document).on("turbolinks:load", initCkeditors);
+})();