ckeditor 4.3.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e0859ba591884d87b9c0d3c0386ed67cd6419238
-  data.tar.gz: d4b3ab8320b65df32738a3246c3126e7cf95dcbe
+SHA256:
+  metadata.gz: 734b0633bf0f5ec5a2633daa8bbc896f6f622a3087caed5f809de9a842fcc96f
+  data.tar.gz: '04799c75bf84cda818b076ff8aa97801cfa0705810b8dd7eb603afd5c902ab10'
 SHA512:
-  metadata.gz: f9674244fbcf776014e69716f57b5fd5b39db2351d4cd16862f61dbd93004ca505906d4b758c84414c5268e84deaf926b858e2be329a6991cb6e5c8b85056727
-  data.tar.gz: 66cd6a44cda87202adbf813f4d09745b7b4e535be003a30547b6afbc0b05e620975dae6cd4e5c12f5eb6d1a0366c86cabe73d6cbabdea6f45200653552bbe74c
+  metadata.gz: d5c69df81799a368961f9a98d484a84b4c4cc34fc628ef02e801be47e26d89c03358a0e127ff6091544146cf25ca643df470a5f6b468213d5c812feaa9d9467b
+  data.tar.gz: 5710a5abf940363202dc679b4fc37cd0e4781d2c24d3088e0162095d668e9b69985c481b9bc60cb56a05d1157585812bc179dd2fbeb0c5e78fe0c4b539a82dcb

data/Gemfile

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

data/README.md

@@ -7,12 +7,12 @@ CKEditor is a WYSIWYG text editor designed to simplify web content creation. It
 
 ## Features
 
-* CKEditor version 4.11.1 full (8 November 2018)
-* 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
 
@@ -37,13 +37,13 @@ gem 'ckeditor', '4.1.3'
 Include this inside your `config/initializers/assets.rb`:
 
 ```
-Rails.application.config.assets.precompile += %w( ckeditor/*)
+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 (paperclip, carrierwave, dragonfly)
 * Mongoid (paperclip, carrierwave, dragonfly)
 
 ### How to generate models to store uploaded files
@@ -67,15 +67,6 @@ gem 'mini_magick'
 rails generate ckeditor:install --orm=active_record --backend=carrierwave
 ```
 
-#### ActiveRecord + refile
-
-```
-gem 'refile', require: "refile/rails"
-gem 'refile-mini_magick'
-
-rails generate ckeditor:install --orm=active_record --backend=refile
-```
-
 #### ActiveRecord + dragonfly
 
 Requires Dragonfly 1.0 or greater.
@@ -120,20 +111,6 @@ mount Ckeditor::Engine => '/ckeditor'
 
 ## Usage
 
-### Load editor from gem vendor
-
-Include ckeditor javascripts in your `app/assets/javascripts/application.js`:
-
-```
-//= require ckeditor/init
-```
-
-Make sure that you put it before:
-
-```
-//= require_tree .
-```
-
 ### Load editor via CKEditor CDN
 
 Setup editor version to load (more info here http://cdn.ckeditor.com/)
@@ -158,7 +135,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
@@ -221,46 +198,6 @@ CKEDITOR.editorConfig = function (config) {
 }
 ```
 
-### 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/* )
-```
-
-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.
-
-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 %>';
-```
-
 ### AJAX
 
 jQuery sample:
@@ -285,7 +222,7 @@ 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. 
+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.
 
@@ -306,7 +243,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:
 
@@ -314,12 +251,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
@@ -332,7 +269,7 @@ can [:read, :create, :destroy], Ckeditor::AttachmentFile
 
 ### Pundit integration
 
-Just like CanCan, you can write this code in your config/initializers/ckeditor.rb file:
+Just like CanCanCan, you can write this code in your config/initializers/ckeditor.rb file:
 
 ```ruby
 Ckeditor.setup do |config|
@@ -354,13 +291,25 @@ By default, only the user that logged in can access the models (with actions *in
 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
 ```
 
@@ -383,7 +332,6 @@ en:
 ```bash
 $> rake test CKEDITOR_BACKEND=paperclip
 $> rake test CKEDITOR_BACKEND=carrierwave
-$> rake test CKEDITOR_BACKEND=refile
 $> rake test CKEDITOR_BACKEND=dragonfly
 $> rake test CKEDITOR_ORM=mongoid
 

data/Rakefile

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 require 'rubygems'
 begin
   require 'bundler/setup'
@@ -11,50 +12,56 @@ require 'rdoc/task'
 
 require 'rake/testtask'
 
+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/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/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.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'orm_adapter'
 require 'pathname'
 
@@ -25,7 +27,6 @@ module Ckeditor
     autoload :Paperclip, 'ckeditor/backend/paperclip'
     autoload :CarrierWave, 'ckeditor/backend/carrierwave'
     autoload :Dragonfly, 'ckeditor/backend/dragonfly'
-    autoload :Refile, 'ckeditor/backend/refile'
   end
 
   IMAGE_TYPES = %w[image/jpeg image/png image/gif image/jpg image/pjpeg image/tiff image/x-png].freeze
@@ -69,15 +70,9 @@ module Ckeditor
   mattr_accessor :default_per_page
   @@default_per_page = 24
 
-  # Asset restrictions
-  mattr_accessor :assets_languages
-  mattr_accessor :assets_plugins
-  @@assets_languages = nil
-  @@assets_plugins = nil
-
   # CKEditor CDN
   mattr_accessor :cdn_url
-  @@cdn_url = nil
+  @@cdn_url = '//cdn.ckeditor.com/4.11.3/standard/ckeditor.js'
 
   # Url to ckeditor config, used when CDN enabled
   mattr_accessor :js_config_url
@@ -123,11 +118,7 @@ module Ckeditor
 
   # All css and js files from ckeditor folder
   def self.assets
-    @assets ||= if Ckeditor.cdn_enabled?
-                  ['ckeditor/config.js']
-                else
-                  Utils.select_assets('ckeditor', 'vendor/assets/javascripts') << 'ckeditor/init.js'
-                end
+    @assets ||= Ckeditor.cdn_enabled? ? ['ckeditor/config.js'] : []
   end
 
   def self.assets=(value)
@@ -201,11 +192,11 @@ module Ckeditor
   #   end
   #
   # To use an authorization adapter, pass the name of the adapter. For example,
-  # to use with CanCan[https://github.com/ryanb/cancan], pass it like this.
+  # to use with CanCanCan[https://github.com/CanCanCommunity/cancancan], pass it like this.
   #
-  # @example CanCan
+  # @example CanCanCan
   #   Ckeditor.setup do |config|
-  #     config.authorize_with :cancan
+  #     config.authorize_with :cancancan
   #   end
   #
   def self.authorize_with(*args, &block)

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