ckeditor 4.2.4 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8322d6cb4547b48c4919776004ded1a350c05545
-  data.tar.gz: 9ab657aaca72e69a847357666e1da8eb46684295
+SHA256:
+  metadata.gz: b71ac2d1ebfd0eb53c8e24472f22e603c41c3ae8fc5958e44664211ee8e2b6ed
+  data.tar.gz: 8dd8a0c4681b5c76baf6a09d7c4a71426e7fedd9dd5c10e9623af7bd9d4a567d
 SHA512:
-  metadata.gz: c0434a28caf6681dc5a769a12f75019e05042611d62b5ceb0d3f3b5703c07bb10de4ed7b254cfa5cf87ba4dd7e42f0659314acc70de7b319951acf0ed615e19a
-  data.tar.gz: 1842897fba7ae53915db54f91104fa73c71ac1fd2a4390b9fdb72779fa87d858f330ef153c57fbac6a129346c2c1fd3f41d2580222f37c40da05c240457966a1
+  metadata.gz: a609bce33d5a52dfab3d630681ffe9f84cf58f39a1fc219606030f9a618a416ba620f9958345afab23cb76e79958ca4c7c3e8aa5cf3a8c1f701d856491b2cf30
+  data.tar.gz: d2ebba5c7fe3716a65e4af6595da206f52bdee4913fb6ca961d3ae3dcfb5d838664b86067f1dbb265dbe889c4817a15a78624e93e9b2b9bdf5b63f5858830d87

data/Gemfile

@@ -1,36 +1,39 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 gemspec
 
-gem 'rails', '4.2.7'
+gem 'rails', '~> 5.2.4.6'
 
 platforms :ruby do
-  gem 'sqlite3'
   gem 'sass'
-
-  group :development do
-    gem 'unicorn', '~> 4.0.1'
-  end
+  gem 'sqlite3', '~> 1.3.6'
+  gem 'sprockets', '~> 3.7.2'
 
   group :development, :test do
-    gem 'jquery-rails', '~> 4.0.4'
     gem 'capybara', '>= 0.4.0'
+    gem 'jquery-rails', '~> 4.3.3'
     gem 'mynyml-redgreen', '~> 0.7.1', require: 'redgreen'
+    gem 'rails-controller-testing'
+
+    gem 'rubocop-rails'
   end
 
   group :active_record do
-    gem 'paperclip'
     gem 'carrierwave'
     gem 'dragonfly'
     gem 'mini_magick'
-    gem 'refile', require: 'refile/rails'
-    gem 'refile-mini_magick'
+    gem 'paperclip', '~> 6.1.0'
   end
 
   group :mongoid do
-    gem 'mongoid', '~> 5.0.0'
     gem 'bson_ext'
-    gem 'mongoid-paperclip', require: 'mongoid_paperclip'
     gem 'carrierwave-mongoid', require: 'carrierwave/mongoid'
+    gem 'mongoid', '~> 7.0.2'
+    gem 'mongoid-paperclip', require: 'mongoid_paperclip'
+    gem 'shrine'
+    gem 'shrine-mongoid'
+    gem 'image_processing'
   end
 end

data/README.md

@@ -3,17 +3,16 @@
 [![Build Status](https://semaphoreci.com/api/v1/igor-galeta/ckeditor/branches/master/shields_badge.svg)](https://semaphoreci.com/igor-galeta/ckeditor)
 [![Code Climate](https://codeclimate.com/github/galetahub/ckeditor/badges/gpa.svg)](https://codeclimate.com/github/galetahub/ckeditor)
 
-CKEditor is a WYSIWYG text editor designed to simplify web content creation. It brings common word processing features directly to your web pages. Enhance your website experience with our community maintained editor.
-[ckeditor.com](http://ckeditor.com/)
+CKEditor is a WYSIWYG text editor designed to simplify web content creation. It brings common word processing features directly to your web pages. Enhance your website experience with our community maintained editor. Currently this gem supports [ckeditor 4](https://ckeditor.com/ckeditor-4/) only.
 
 ## Features
 
-* CKEditor version 4.7.1 full (28 Jun 2017)
-* Rails 5.0.x, 5.1.x, 4.2.x integration
+* CKEditor version 4.x (https://ckeditor.com/ckeditor-4/)
+* Rails 5.x, 4.2.x integration
 * Files browser
 * HTML5 file uploader
 * Hooks for formtastic and simple_form forms generators
-* Integrated with authorization framework CanCan and Pundit
+* Integrated with authorization frameworks [CanCanCan](https://github.com/CanCanCommunity/cancancan) and [Pundit](https://github.com/varvet/pundit)
 
 ## Installation
 
@@ -29,16 +28,16 @@ or if you'd like to use the latest version from Github:
 gem 'ckeditor', github: 'galetahub/ckeditor'
 ```
 
-The last version works with Rails 3.2.x is 4.1.3
+Include this inside your `config/initializers/assets.rb`:
 
-```ruby
-gem 'ckeditor', '4.1.3'
+```
+Rails.application.config.assets.precompile += %w[ckeditor/config.js]
 ```
 
 For file upload support, you must generate the necessary file storage models.
 The currently supported backends are:
 
-* ActiveRecord (paperclip, carrierwave, dragonfly, refile)
+* ActiveRecord (active_storage, paperclip, carrierwave, dragonfly)
 * Mongoid (paperclip, carrierwave, dragonfly)
 
 ### How to generate models to store uploaded files
@@ -53,22 +52,22 @@ gem 'paperclip'
 rails generate ckeditor:install --orm=active_record --backend=paperclip
 ```
 
-#### ActiveRecord + carrierwave
+#### ActiveRecord + active_storage
 
 ```
-gem 'carrierwave'
-gem 'mini_magick'
+gem "mini_magick"
 
-rails generate ckeditor:install --orm=active_record --backend=carrierwave
+rails active_storage:install # if you not install active_storage yet
+rails generate ckeditor:install --orm=active_record --backend=active_storage
 ```
 
-#### ActiveRecord + refile
+#### ActiveRecord + carrierwave
 
 ```
-gem 'refile', require: "refile/rails"
-gem 'refile-mini_magick'
+gem 'carrierwave'
+gem 'mini_magick'
 
-rails generate ckeditor:install --orm=active_record --backend=refile
+rails generate ckeditor:install --orm=active_record --backend=carrierwave
 ```
 
 #### ActiveRecord + dragonfly
@@ -89,6 +88,10 @@ gem 'mongoid-paperclip', require: 'mongoid_paperclip'
 rails generate ckeditor:install --orm=mongoid --backend=paperclip
 ```
 
+#### Mongoid + active_storage
+
+Active Storage support **only** Active Record, see for [more info](https://github.com/rails/rails/issues/31408#issuecomment-351128111)
+
 #### Mongoid + carrierwave
 
 ```
@@ -115,14 +118,6 @@ mount Ckeditor::Engine => '/ckeditor'
 
 ## Usage
 
-### Load editor from gem vendor
-
-Include ckeditor javascripts in your `app/assets/javascripts/application.js`:
-
-```
-//= require ckeditor/init
-```
-
 ### Load editor via CKEditor CDN
 
 Setup editor version to load (more info here http://cdn.ckeditor.com/)
@@ -147,7 +142,7 @@ Precompile ckeditor/config.js:
 ```ruby
 # in config/initializers/assets.rb
 
-Rails.application.config.assets.precompile += %w(ckeditor/config.js)
+Rails.application.config.assets.precompile += %w[ckeditor/config.js]
 ```
 
 ### Form helpers
@@ -159,6 +154,13 @@ Rails.application.config.assets.precompile += %w(ckeditor/config.js)
   = cktext_area :page, :info, cols: 40, ckeditor: { uiColor: '#AADC6E', toolbar: 'mini' }
 ```
 
+*It also works with bootstrap-form*
+
+```slim
+= bootstrap_form_for resource do |form|
+  = form.cktext_area :text, ckeditor: { language: 'uk'}
+```
+
 ### Customize ckeditor
 
 All ckeditor options can be found [here](http://docs.ckeditor.com/#!/api/CKEDITOR.config)
@@ -184,7 +186,7 @@ CKEDITOR.editorConfig = function (config) {
   config.toolbar_mini = [
     ["Bold",  "Italic",  "Underline",  "Strike",  "-",  "Subscript",  "Superscript"],
   ];
-  config.toolbar = "simple";
+  config.toolbar = "mini";
 
   // ... rest of the original config.js  ...
 }
@@ -192,44 +194,15 @@ CKEDITOR.editorConfig = function (config) {
 
 When overriding the default `config.js` file, you must set all configuration options yourself as the bundled `config.js` will not be loaded. To see the default configuration, run `bundle open ckeditor`, copy `app/assets/javascripts/ckeditor/config.js` into your project and customize it to your needs.
 
-### Deployment (only if you use ckeditor from gem vendor)
-
-For Rails 4 and 5, add the following to `config/initializers/assets.rb`:
-
-```ruby
-Rails.application.config.assets.precompile += %w( ckeditor/* )
-```
+#### Install additional plugins
 
-As of version 4.1.0, non-digested assets of Ckeditor will simply be copied after digested assets were compiled.
-For older versions, use gem [non-stupid-digest-assets](https://rubygems.org/gems/non-stupid-digest-assets), to copy non digest assets.
+You should download necessary plugins with all dependencies and extract them in `app/assets/javascripts/ckeditor/plugins/`.
+After that you can include your plugins in `app/assets/javascripts/ckeditor/config.js` in this way:
 
-To reduce the asset precompilation time, you can limit plugins and/or languages to those you need:
-
-```ruby
-# in config/initializers/ckeditor.rb
-
-Ckeditor.setup do |config|
-  config.assets_languages = ['en', 'fr']
-  config.assets_plugins = ['image', 'smiley']
-end
-```
-
-Note that you have to list your plugins, including all their dependencies.
-
-### Include customized CKEDITOR_BASEPATH setting
-
-Add your app/assets/javascripts/ckeditor/basepath.js.erb like
-
-```erb
-<%
-  base_path = ''
-  if ENV['PROJECT'] =~ /editor/i
-    base_path << "/#{Rails.root.basename.to_s}/"
-  end
-  base_path << Rails.application.config.assets.prefix
-  base_path << '/ckeditor/'
-%>
-var CKEDITOR_BASEPATH = '<%= base_path %>';
+```javascript
+CKEDITOR.editorConfig = function (config) {
+  config.extraPlugins = 'eqneditor,autosave,';
+}
 ```
 
 ### AJAX
@@ -256,6 +229,9 @@ jQuery sample:
 ```
 
 ### SimpleForm integration
+Note that the toolbar option should match the case specified in the config. If the config is not found it defaults to all available toolbar items.
+
+i.e. config.toolbar_mini becomes {toolbar: 'mini'} in the form.
 
 ```slim
 = form.input :content, as: :ckeditor, input_html: { ckeditor: { toolbar: 'Full' } }
@@ -274,7 +250,7 @@ $(document).on('page:load', ready)
 ```
 Make sure the file is loaded from your app/assets/javascripts/application.js
 
-### CanCan integration
+### CanCanCan integration
 
 To use cancan with Ckeditor, add this to an initializer:
 
@@ -282,12 +258,12 @@ To use cancan with Ckeditor, add this to an initializer:
 # in config/initializers/ckeditor.rb
 
 Ckeditor.setup do |config|
-  config.authorize_with :cancan
+  config.authorize_with :cancancan
 end
 ```
 
 At this point, all authorization will fail and no one will be able to access the filebrowser pages.
-To grant access, add this to Ability#initialize:
+To grant access, add the following abilities (usually `ability.rb`)
 
 ```ruby
 # Always performed
@@ -298,37 +274,50 @@ can [:read, :create, :destroy], Ckeditor::Picture
 can [:read, :create, :destroy], Ckeditor::AttachmentFile
 ```
 
-### Pundit integration
+### Pundit or Action Policy Integration
 
-Just like CanCan, you can write this code in your config/initializers/ckeditor.rb file:
+Setup Pundit and Action Policy similar.
+Just like CanCanCan, you can write this code in your config/initializers/ckeditor.rb file:
 
 ```ruby
 Ckeditor.setup do |config|
-  config.authorize_with :pundit
+  config.authorize_with :pundit # or :action_policy
 end
 ```
 
 Then, generate the policy files for model **Picture** and **AttachmentFile**
 
 ```
-$ rails g ckeditor:pundit_policy
+$ rails g ckeditor:pundit_policy # or ckeditor:action_policy
 ```
 By this command, you will got two files:
 > app/policies/ckeditor/picture_policy.rb
 app/policies/ckeditor/attachment_file_policy.rb
 
-By default, only the user that logged in can access the models (with actions *index* and *create*) and only the owner of the asset can **destroy** the resource.
+By default, only the user that logged in can access the models.
 
 You can customize these two policy files as you like.
 
 ## Engine configuration
- * To override the default CKEditor routes create a [config.js](https://github.com/galetahub/ckeditor/blob/master/app/assets/javascripts/ckeditor/config.js) file within the host application at `app/assets/javascripts/ckeditor/config.js`
- * To override the default parent controller
+
+* To override the default CKEditor routes create a [config.js](https://github.com/galetahub/ckeditor/blob/master/app/assets/javascripts/ckeditor/config.js) file within the host application at `app/assets/javascripts/ckeditor/config.js`
+
+* By default, the engine inherits from `ApplicationController`. To override the default parent controller:
 ```
 # in config/initializers/ckeditor.rb
 
 Ckeditor.setup do |config|
-  config.parent_controller = 'MyController'
+  config.parent_controller = 'MyCKEditorBaseController'
+end
+```
+
+Based on this, if you want to secure CKEditor controller actions and you can't authenticate in ApplicationController, you could do so with a custom controller after configuring the override above, like so:
+
+```
+class MyCKEditorBaseController < ActionController::Base
+
+  before_action :authenticate_user! # or some other auth/permission logic here, like Pundit
+
 end
 ```
 
@@ -350,9 +339,10 @@ en:
 
 ```bash
 $> rake test CKEDITOR_BACKEND=paperclip
+$> rake test CKEDITOR_BACKEND=active_storage
 $> rake test CKEDITOR_BACKEND=carrierwave
-$> rake test CKEDITOR_BACKEND=refile
 $> rake test CKEDITOR_BACKEND=dragonfly
+$> rake test CKEDITOR_BACKEND=shrine
 $> rake test CKEDITOR_ORM=mongoid
 
 $> rake test:controllers

data/Rakefile

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 require 'rubygems'
 begin
   require 'bundler/setup'
@@ -8,53 +9,60 @@ end
 
 require 'rake'
 require 'rdoc/task'
-
 require 'rake/testtask'
 
+require 'bundler/gem_tasks'
+
+task default: :test
+
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
-Rake::TestTask.new("test:controllers") do |t|
+Rake::TestTask.new('test:controllers') do |t|
   t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/controllers/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
-Rake::TestTask.new("test:generators") do |t|
+Rake::TestTask.new('test:generators') do |t|
   t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/generators/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
-Rake::TestTask.new("test:integration") do |t|
+Rake::TestTask.new('test:integration') do |t|
   t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/integration/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
-Rake::TestTask.new("test:models") do |t|
+Rake::TestTask.new('test:models') do |t|
   t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/models/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
-Rake::TestTask.new("test:functional") do |t|
+Rake::TestTask.new('test:functional') do |t|
   t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/functional/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
-task :default => :test
-
 RDoc::Task.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Ckeditor'

data/app/assets/javascripts/ckeditor/config.js

@@ -32,6 +32,7 @@ CKEDITOR.editorConfig = function( config )
   config.filebrowserUploadUrl = "/ckeditor/attachment_files";
 
   config.allowedContent = true;
+  config.filebrowserUploadMethod = 'form';
 
   // Toolbar groups configuration.
   config.toolbar = [

data/app/controllers/ckeditor/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::ApplicationController < Ckeditor.parent_controller.constantize
   layout Ckeditor.controller_layout
 
@@ -9,6 +11,7 @@ class Ckeditor::ApplicationController < Ckeditor.parent_controller.constantize
 
   def respond_with_asset(asset)
     asset_response = Ckeditor::AssetResponse.new(asset, request)
+    asset.data = asset_response.data
 
     if asset.save
       render asset_response.success(config.relative_url_root)

data/app/controllers/ckeditor/attachment_files_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::AttachmentFilesController < Ckeditor::ApplicationController
   skip_before_action :verify_authenticity_token, only: :create, raise: false
 

data/app/controllers/ckeditor/pictures_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Ckeditor::PicturesController < Ckeditor::ApplicationController
   skip_before_action :verify_authenticity_token, only: :create, raise: false
 

data/app/helpers/ckeditor/application_helper.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 module Ckeditor::ApplicationHelper
 end

data/app/views/ckeditor/attachment_files/index.html.erb

@@ -6,7 +6,7 @@
   </div>
 
   <div class="fileupload-list">
-    <%= render partial: 'ckeditor/shared/asset', collection: @attachments %>
+    <%= render partial: 'ckeditor/shared/asset', collection: @attachments.scoped %>
   </div>
 
   <% unless @attachments.last_page? %>

data/config/locales/da.ckeditor.yml

@@ -0,0 +1,9 @@
+da:
+  ckeditor:
+    page_title: "CKEditor Fil Manager"
+    confirm_delete: "Slet fil?"
+    buttons:
+      cancel: "Annuller"
+      upload: "Upload"
+      delete: "Slet"
+      next: "Næste"

data/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Ckeditor::Engine.routes.draw do
   resources :pictures, only: [:index, :create, :destroy]
   resources :attachment_files, only: [:index, :create, :destroy]

data/lib/ckeditor/asset_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'action_view/helpers/tag_helper'
 require 'action_view/helpers/javascript_helper'
 
@@ -6,17 +8,19 @@ module Ckeditor
     include ActionView::Helpers::TagHelper
     include ActionView::Helpers::JavaScriptHelper
 
-    FUNCTION = 'window.parent.CKEDITOR.tools.callFunction'.freeze
-    JSON_TYPE = 'json'.freeze
+    FUNCTION = 'window.parent.CKEDITOR.tools.callFunction'
+    JSON_TYPE = 'json'
 
-    attr_reader :asset, :params
+    attr_reader :asset, :request, :params
 
     def initialize(asset, request)
       @asset = asset
       @request = request
       @params = request.params
+    end
 
-      @asset.data = Ckeditor::Http.normalize_param(file, @request)
+    def data
+      @data ||= read_data
     end
 
     def json?
@@ -104,5 +108,12 @@ module Ckeditor
         :default
       end
     end
+
+    def read_data
+      data = Ckeditor::Http.normalize_param(file, request)
+      return if data.size.zero? || data.original_filename.blank?
+
+      data
+    end
   end
 end

data/lib/ckeditor/backend/active_storage.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Ckeditor
+  module Backend
+    module ActiveStorage
+      def self.included(base)
+        base.send(:include, Rails.application.routes.url_helpers)
+        base.send(:include, InstanceMethods)
+        base.send(:extend, ClassMethods)
+      end
+
+      module ClassMethods
+        def self.extended(base)
+          base.class_eval do
+            before_save :apply_data
+            validate do
+              if data.nil? || file.nil?
+                errors.add(:data, :not_data_present, message: "data must be present")
+              end
+            end
+          end
+        end
+      end
+
+      module InstanceMethods
+        def url
+          rails_blob_path(self.storage_data, only_path: true)
+        end
+
+        def path
+          rails_blob_path(self.storage_data, only_path: true)
+        end
+
+        def styles
+        end
+
+        def content_type
+          self.storage_data.content_type
+        end
+        def content_type=(_content_type)
+          self.storage_data.content_type = _content_type
+        end
+        protected
+
+        def file
+          @file ||= storage_data
+        end
+
+        def blob
+          @blob ||= ::ActiveStorage::Blob.find(file.attachment.blob_id)
+        end
+
+        def apply_data
+          if data.is_a?(Ckeditor::Http::QqFile)
+            storage_data.attach(io: data, filename: data.original_filename)
+          else
+            storage_data.attach(data)
+          end
+
+          self.data_file_name = storage_data.blob.filename
+          self.data_content_type = storage_data.blob.content_type
+          self.data_file_size = storage_data.blob.byte_size
+        end
+
+      end
+    end
+  end
+end

data/lib/ckeditor/backend/carrierwave.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mini_magick'
 
 module Ckeditor
@@ -11,7 +13,6 @@ module Ckeditor
       module ClassMethods
         def self.extended(base)
           base.class_eval do
-            process :extract_content_type
             process :extract_size
           end
         end
@@ -36,21 +37,10 @@ module Ckeditor
           end
         end
 
-        def extract_content_type
-          model.data_content_type = Utils::ContentTypeDetector.new(file.path).detect
-        end
-
         def extract_size
           model.data_file_size = file.size
         end
 
-        def extract_dimensions
-          if model.image? && model.has_dimensions?
-            model.width = magick[:width]
-            model.height = magick[:height]
-          end
-        end
-
         def magick
           @magick ||= ::MiniMagick::Image.new(current_path)
         end

data/lib/ckeditor/backend/dragonfly.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ckeditor
   module Backend
     module Dragonfly