new_ckeditor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0eefeeb12aad3cb29959f2cefb57379afd52a6928bff017b806386868e565a84
+  data.tar.gz: 3cd4044f33ebe962f8dedd6a9397ccfefbdff42fe2b657763658bfc5979e9eb1
+SHA512:
+  metadata.gz: 38a80c133ec4f995a44b200240f5411cf6acae391defba6dbafaff4afbb16100a685471f135ec769b42bf636c9de847107ec84b30b0577ff832c617ae5366c1e
+  data.tar.gz: 686028c8fe5e689e9146fd5d1a7ca2612fc9bbff04232bd2d222b791013248be0bb426fef5fc9a64baaca353caaca4ae3cf9df99f1f8e2bf052b8efa9a12aa0c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Igor Kasyanchuk
+
+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,149 @@
+# Rails + CKEditor 5
+
+Short description and motivation.
+
+## Usage
+
+How to use my plugin.
+
+## Installation
+
+Add this line to your application's Gemfile and run `bundle`:
+
+```ruby
+gem 'new_ckeditor'
+```
+
+## Configuration
+
+## File Upload with CKEditor 5
+
+Gem doesn't have any strict dependency on any library. It's implemented this way on purpose to let developer use gem which he wants. Maybe in the future we can improve it.
+
+But you can get a base skeleton where you can put your own logic.
+
+Below I'll put an example of code which works with CKEditor.
+
+1. Let's start with new controller `rails g controller file_uploads upload`
+
+```ruby
+class FileUploadsController < ApplicationController
+  # note
+  # that method must return json with URL to an uploaded image
+  # or error message
+  def upload
+    image = CkEditorImage.new(file: params["upload"])
+    if image.save
+      render json: {
+        url: image.file.url
+      }
+    else
+      render json: {
+        "error": {
+          "message": image.errors.full_messages.join(", ")
+        }
+      }
+    end
+  end
+end
+```
+
+2. Create a new model where images will be stored: `rails g model CkEditorImage file:string user_id:integer parent_id:integer parent_type:string`
+
+```ruby
+class CkEditorImage < ApplicationRecord
+  mount_uploader :file, CkEditorImageUploader
+  belongs_to :user, optional: true
+  validates_presence_of :file
+end
+```
+
+Code of migration may look like:
+
+```ruby
+class CreateCkEditorImages < ActiveRecord::Migration[6.0]
+  def change
+    create_table :ck_editor_images do |t|
+      t.string :file
+      t.integer :user_id, index: true
+      t.integer :parent_id
+      t.string :parent_type
+
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+    add_index :ck_editor_images, :user_id
+    add_index :ck_editor_images, [:parent_id, :parent_type]
+  end
+end
+```
+
+Run this migration.
+
+3. Create Carrierwave uploader `rails g uploader CkEditorImage`. Open and edit it if needed.
+
+4. Open again controller, edit logic, check user, check params, etc. You have a full control how to implement logic of storing files.
+
+## Output
+
+### Output RAW HTML from CKEditor
+
+To use same CSS as in editor, to keep consistent UI:
+
+Require CSS file in `application.css`:
+
+```css
+ *= require new_ckeditor/ckeditor.css
+```
+
+And in the view wrap output in `.ck-content` class:
+
+```erb
+<p>
+  <strong>About:</strong>
+  <div class="ck-content">
+    <%= raw @user.about %>
+  </div>
+</p>
+```
+
+More documentation: https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/content-styles.html
+
+## Styling
+
+### CKEditor 5 set min-height, height, width
+
+```css
+.ck-editor__editable {
+  min-height: 500px;
+}
+```
+
+You can editor in some parent div and set height explicitly for editor inside.
+
+## TODO
+
+- different types of ckeditors
+- generator for toolbar
+- configuration to specify toolbar
+- generator for controller?
+- store files using active storage
+- store with user_id, and parent?
+- readme, samples
+- gif with demo
+- sample with ajax? and with ballon?
+- tests
+- CSFR-Token
+- support inline editor?
+- remove title plugin
+- check how it works with turbolinks
+
+## Customization
+
+https://ckeditor.com/ckeditor-5/online-builder/
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NewCkeditor'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/new_ckeditor_manifest.js

@@ -0,0 +1,6 @@
+//= link_tree ../images
+//= link_tree ../images/new_ckeditor
+//= link_directory ../images
+//= link_directory ../images/new_ckeditor
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css