ckeditor_rails 4.8.0 → 4.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bf093848986984b8a70e5ae9f6a3d338b160a0d4
-  data.tar.gz: 58997c626c47f28d672d01e06ef734f9a1bba771
+SHA256:
+  metadata.gz: 962b65a400bbc6fa001fdd3804b8ff11fd719a4e82b43a6aa0cd813345797e40
+  data.tar.gz: 4bc7553ac1f7d7fe98de3f0d0d586c50dd94a3bef77f80da85fc209cbdf2ec2e
 SHA512:
-  metadata.gz: 63aeed86ea216edbe50fa7ed27c42133b6ca0a4800167a3e6573ba331bdd71b20ecbb315ceefdf2cfcb56b67689c87e254fe2bc31d540042583ecba6c0e456c8
-  data.tar.gz: 250bf8b17f9d9f5e5ca03787db4f6ee634aacd4217cd8f9003edbca47c657acefa12476938e4eaf1ef2e39de985bde75ae22d0bf273d86dd7d24227c7ea62345
+  metadata.gz: df23a0f24b77bd2072863da7e8fda7fdd5231a23f7155a7d4f7a60d8e52dc00d9290931eabf60a43422f3b666e33b1ce1c3d2dd9dcc23e36236be7b2e9102696
+  data.tar.gz: 0d6ab662a1c275a58553cdcf8992c5d6e5e295a7fd228592c38cc4e734ed8aa105acc1d8fe4cca8d93ba80f2f3d02754f8c6a11d96660a5d0cad61498fc139a1

data/README.md

@@ -64,22 +64,6 @@ CKEDITOR.editorConfig = (config) ->
   true
 ```
 
-### Include customized CKEDITOR_BASEPATH setting
-
-Add your `app/assets/javascripts/ckeditor/basepath.js.erb` like
-
-``` ruby
-<%
-  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 %>';
-```
-
 ### Include customized stylesheet for contents of CKEditor
 
 Add your `app/assets/stylesheets/ckeditor/contents.css.scss` like
@@ -96,7 +80,48 @@ ol,ul,dl {
 }
 ```
 
-### Configure plugins, languages, and skins of CKEditor assets
+### Remove CKEditor addon services
+
+To avoid see warnings like
+
+``` js
+ckeditor.source.js:21 [CKEDITOR] Error code: exportpdf-no-token-url.
+ckeditor.source.js:21 [CKEDITOR] For more information about this error go to https://ckeditor.com/docs/ckeditor4/latest/guide/dev_errors.html#exportpdf-no-token-url
+```
+
+Edit your `app/assets/javascripts/ckeditor/config.js.coffee` like
+
+``` coffee
+CKEDITOR.editorConfig = (config) ->
+  config.removePlugins = 'exportpdf'
+  true
+```
+
+Ref: https://ckeditor.com/cke4/addon/exportpdf
+
+### Configure CKEditor addon services
+
+Install the plugin manually by copy to Rails asset pathes like
+
+``` shell
+vendor/assets/images/ckeditor/plugins/exportpdf/icons
+vendor/assets/javascripts/ckeditor/plugins/exportpdf/lang
+vendor/assets/javascripts/ckeditor/plugins/exportpdf/plugin.js
+vendor/assets/javascripts/ckeditor/plugins/exportpdf/LICENSE.md
+```
+
+Edit your `app/assets/javascripts/ckeditor/config.js.coffee` like
+
+``` coffee
+CKEDITOR.editorConfig = (config) ->
+  # config.extraPlugins = 'exportpdf'
+  config.exportPdf_tokenUrl = 'https://example.com/cs-token-endpoint'
+  true
+```
+
+Ref: https://ckeditor.com/docs/ckeditor4/latest/features/exporttopdf.html#configuration
+
+### Configure plugins, languages, skins and base_path of CKEditor assets
 
 Add `ckeditor_rails.rb` to `config/initializers/`
 
@@ -112,16 +137,47 @@ Ckeditor::Rails.configure do |config|
 
   # default is nil for all skins, or set as %w[moono-lisa]
   config.assets_skins = nil
+
+  # default is nil and it will be "#{::Sprockets::Railtie.config.assets.prefix}/ckeditor",
+  # or set as String like '/assets/ckeditor',
+  # or set as Proc / Lambda
+  # no slash in the end
+  config.assets_base_path = nil
 end
 ```
 
+### Configure customized CKEDITOR_BASEPATH setting
+
+It is important to keep these two the same.
+
+  * `Ckeditor::Rails::AssetUrlProcessor` will post process css `url()` attribute in all css files of ckeditor based on `Ckeditor::Rails.assets_base_path`.
+  * `CKEDITOR_BASEPATH` will be defined with `Ckeditor::Rails.assets_base_path` directly.
+
+Edit your `config/initializers/ckeditor_rails.rb` like
+
+``` ruby
+Ckeditor::Rails.configure do |config|
+  config.assets_base_path = Proc.new {
+    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'
+    base_path
+  }
+end
+```
+
+Note: if `Rails.application.config.action_controller.relative_url_root` is set, it will prepend to `Ckeditor::Rails.assets_base_path` automatically.
+
 ## Gem maintenance
 
 Maintain `ckeditor_rails` gem with `Rake` commands.
 
 Update origin CKEditor source files.
 
-    rake update_ckeditor VERSION=4.8.0
+    rake update_ckeditor VERSION=4.16.2
 
 Publish gem.
 

data/ckeditor-rails.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{Integrate CKEditor javascript library with Rails asset pipeline}
   gem.homepage      = 'https://github.com/tsechingho/ckeditor-rails'
 
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- exe/*`.split("\n").map { |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n").reject { |f| f.start_with?('test') }
+  gem.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
   gem.name          = 'ckeditor_rails'
   gem.require_paths = ['lib']
   gem.version       = Ckeditor::Rails::VERSION

data/lib/assets/javascripts/ckeditor/basepath.js.erb

@@ -1,6 +1 @@
-<%
-  base_path = File.join(Rails.application.config.assets.prefix, 'ckeditor/')
-  base_path = File.join(Rails.application.config.action_controller.relative_url_root, base_path) if Rails.application.config.action_controller.relative_url_root
-%>
-
-var CKEDITOR_BASEPATH = "<%= base_path %>";
+var CKEDITOR_BASEPATH = "<%= "#{::Ckeditor::Rails.assets_base_path}/" %>";

data/lib/assets/javascripts/ckeditor-jquery.js

@@ -1,3 +1,3 @@
 //= require ckeditor/basepath
 //= require ckeditor/ckeditor
-//= require ckeditor/jquery
+//= require ckeditor/adapters/jquery

data/lib/ckeditor-rails/asset.rb

@@ -11,10 +11,10 @@ module Ckeditor
 
       def image_files
         path = root.join('images', name)
-        files = Dir.glob(path.join('plugins', '**', '*.{png,gif,jpg}')).reject { |file|
+        files = Dir.glob(path.join('plugins', '**', '*.{png,gif,jpg,svg}')).reject { |file|
           invalid_plugin_file?(file)
         }
-        files += Dir.glob(path.join('skins', '**', '*.{png,gif,jpg}')).reject { |file|
+        files += Dir.glob(path.join('skins', '**', '*.{png,gif,jpg,svg}')).reject { |file|
           invalid_skin_file?(file)
         }
         files

data/lib/ckeditor-rails/asset_url_processor.rb

@@ -0,0 +1,39 @@
+module Ckeditor
+  module Rails
+    # Rewrites urls in CSS files with the digested paths
+    class AssetUrlProcessor
+      REGEX = /url\(\s*["']?(?!(?:\#|data|http))([^"'\s)]+)\s*["']?\)/
+
+      def self.stylesheet_files
+        @stylesheet_files ||= ::Ckeditor::Rails::Asset.new.stylesheet_files
+      end
+
+      def self.assets_base_path(context = nil)
+        return ::Ckeditor::Rails.assets_base_path unless context
+
+        "#{context.assets_prefix}/ckeditor"
+      end
+
+      def self.call(input)
+        return { data: input[:data] } unless stylesheet_files.include?(input[:filename])
+
+        context = input[:environment].context_class.new(input)
+        path_prefix = assets_base_path()
+        matched_folders = input[:filename].match(/\/ckeditor\/(plugins|skins)\/([\w-]+)\//)
+
+        data = input[:data].gsub(REGEX) { |_match|
+          raw_asset_path = context.asset_path($1)
+          if raw_asset_path.starts_with?(path_prefix)
+            "url(#{raw_asset_path})"
+          elsif matched_folders
+            "url(#{path_prefix}/#{matched_folders[1]}/#{matched_folders[2]}#{raw_asset_path.gsub('/..', '')})"
+          else
+            "url(#{path_prefix}#{raw_asset_path})"
+          end
+        }
+
+        { data: data }
+      end
+    end
+  end
+end

data/lib/ckeditor-rails/engine.rb

@@ -1,3 +1,5 @@
+require 'ckeditor-rails/asset_url_processor'
+
 module Ckeditor
   module Rails
     class Engine < ::Rails::Engine
@@ -5,6 +7,16 @@ module Ckeditor
         app.config.assets.precompile += Ckeditor::Rails::Asset.new.files
       end
 
+      # Follow sprockets-rails 3.3.0+ to use postprocessor of Sprockets
+      # https://github.com/rails/sprockets-rails/blob/v3.3.0/lib/sprockets/railtie.rb#L121
+      initializer 'ckeditor.asset_url_processor' do |app|
+        # Processors of Sprockets 2.x should inherit from Tilt::Template
+        # Processors of Sprockets 3+ should respond to :call
+        if Gem::Version.new(::Sprockets::VERSION) > Gem::Version.new('3')
+          ::Sprockets.register_postprocessor 'text/css', ::Ckeditor::Rails::AssetUrlProcessor
+        end
+      end
+
       rake_tasks do
         load "ckeditor-rails/tasks.rake"
       end

data/lib/ckeditor-rails/source_file.rb

@@ -26,9 +26,11 @@ class SourceFile < Thor
   def move
     FileUtils.rm_rf destination_root
     copy_files_in_source_root
+    copy_adapters
     copy_langs
     copy_plugins
     copy_skins
+    copy_vendors
   end
 
   desc 'fix_css', 'fix some css caused precompilation error'
@@ -77,6 +79,10 @@ class SourceFile < Thor
     end
   end
 
+  def copy_adapters
+    directory 'ckeditor/adapters', 'javascripts/ckeditor/adapters'
+  end
+
   def copy_langs
     directory 'ckeditor/lang', 'javascripts/ckeditor/lang'
   end
@@ -91,6 +97,8 @@ class SourceFile < Thor
     # ckeditor.js would lookup 'plugins/icons.png'
     file = 'ckeditor/plugins/icons.png'
     copy_file file, "images/#{file}"
+    file = 'ckeditor/plugins/icons_hidpi.png'
+    copy_file file, "images/#{file}"
   end
 
   def copy_skins
@@ -99,12 +107,17 @@ class SourceFile < Thor
     end
   end
 
+  def copy_vendors
+    directory 'ckeditor/vendor', 'javascripts/ckeditor/vendor'
+  end
+
   def copy_assets path
     batch_copy path, 'css', 'stylesheets'
     batch_copy path, 'js', 'javascripts'
     batch_copy path, 'png', 'images'
     batch_copy path, 'gif', 'images'
     batch_copy path, 'jpg', 'images'
+    batch_copy path, 'svg', 'images'
   end
 
   def batch_copy path, type, asset_path, pattern = nil

data/lib/ckeditor-rails/version.rb

@@ -1,6 +1,6 @@
 module Ckeditor
   module Rails
-    VERSION = '4.8.0'
-    EDITOR_VERSION = '4.8.0'
+    VERSION = '4.16.2'
+    EDITOR_VERSION = '4.16.2'
   end
 end

data/lib/ckeditor-rails.rb

@@ -12,6 +12,9 @@ module Ckeditor
     mattr_accessor :assets_skins
     @@assets_skins = nil
 
+    mattr_writer :assets_base_path
+    @@assets_base_path = nil
+
     class << self
       def configure
         yield self
@@ -49,7 +52,30 @@ module Ckeditor
       end
 
       def default_skins
-        %w[moono]
+        %w[moono-lisa]
+      end
+
+      def default_base_path
+        return "#{::Sprockets::Railtie.config.assets.prefix}/ckeditor" if defined? ::Sprockets
+
+        "#{::Rails.application.config.assets.prefix}/ckeditor"
+      end
+
+      def assets_base_path
+        return @@assets_base_path unless @@assets_base_path.nil?
+
+        if @@assets_base_path.respond_to? :call
+          self.assets_base_path = @@assets_base_path.call
+        elsif !@@assets_base_path.is_a? String
+          self.assets_base_path = default_base_path
+        end
+
+        relative_path = ::Rails.application.config.action_controller.relative_url_root
+        self.assets_base_path = File.join(relative_path, @@assets_base_path) if relative_path && @@assets_base_path
+
+        self.assets_base_path = @@assets_base_path.sub(/\/\z/, '') if @@assets_base_path.ends_with?('/')
+
+        @@assets_base_path
       end
     end
 
@@ -59,7 +85,7 @@ end
 require 'ckeditor-rails/asset'
 
 case ::Rails.version.to_s
-when /^[45]/
+when /^[456]/
   require 'ckeditor-rails/engine'
 when /^3\.[12]/
   require 'ckeditor-rails/engine3'

data/vendor/assets/images/ckeditor/plugins/copyformatting/cursors/cursor-disabled.svg

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg width="16px" height="16px" viewBox="0 0 256 256" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+
+    <title>cursor_disabled</title>
+    <desc></desc>
+    <defs></defs>
+    <g id="Page-4" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="cursor_disabled_5">
+            <g id="cursor_disabled_illustrator" transform="translate(24.000000, 2.000000)">
+                <g id="Layer_1">
+                    <path d="M225,14 C227.8,14 230,11.8 230,9 L230,5 C230,2.2 227.8,0 225,0 L127,0 C124.2,0 122,2.2 122,5 L122,9 C122,11.8 124.2,14 127,14 L158,14 L158,26.3 C172.4,34 185,44.6 195,57.4 L195,14 L225,14 L225,14 Z" id="Shape" fill="#000000"></path>
+                    <path d="M158,228.7 L158,238 L134.5,238 C130.6,239.1 126.7,239.9 122.6,240.6 C122.2,241.3 121.9,242.1 121.9,243 L121.9,247 C121.9,249.8 124.1,252 126.9,252 L224.9,252 C227.7,252 229.9,249.8 229.9,247 L229.9,243 C229.9,240.2 227.7,238 224.9,238 L194.9,238 L194.9,197.6 C185,210.4 172.4,221 158,228.7 L158,228.7 Z" id="Shape" fill="#000000"></path>
+                    <path d="M54.7,107.6 C53.9,110.7 51.1,112.9 41.8,116.1 C35.6,118.3 31.9,121.1 29.5,124.5 C29.5,125.5 29.4,126.4 29.4,127.4 C29.4,134.1 30.3,140.7 32,146.9 L93.9,146.9 L54.7,107.6 L54.7,107.6 Z" id="Shape" fill="#000000"></path>
+                    <path d="M70.8,13 C70.7,13 70.6,13.1 70.5,13.3 C65.9,13.7 58.9,15.5 54.6,24.4 C63.2,20.2 72.5,17.1 82.2,15.1 C77.4,12.7 72.6,13 70.8,13 L70.8,13 Z" id="Shape" fill="#000000"></path>
+                    <path d="M55,170 L55,183.7 C58.7,187 62.7,189.9 67,192.3 L67,170 L78,170 L78,197.6 C81.9,199.1 85.9,200.2 90,201 L90,170 L101,170 L101,202.4 C102.2,202.5 103.3,202.5 104.5,202.5 C109.4,202.5 114.3,202 119.1,201.1 C119.3,193.5 119.5,182.8 119.6,172.6 L105.1,158 L36.1,158 C38.3,162.8 40.9,167.4 44,171.7 L44,170 L55,170 L55,170 Z" id="Shape" fill="#000000"></path>
+                    <path d="M26.3,211.5 C26.3,211.5 24.6,222.6 36.8,222.6 L40.8,222.6 C35.7,219.1 30.8,215.3 26.3,211.1 L26.3,211.5 L26.3,211.5 Z" id="Shape" fill="#000000"></path>
+                    <path d="M172.1,159.8 C176.9,149.8 179.4,138.7 179.4,127.5 C179.4,107.1 171.2,88.6 158,75.1 L158,145.7 L172.1,159.8 L172.1,159.8 Z" id="Shape" fill="#000000"></path>
+                    <path d="M72.2,59.9 L91.2,78.9 C92.3,73 93.7,65.4 94.1,53.3 C86.5,54.3 79.1,56.6 72.2,59.9 L72.2,59.9 Z" id="Shape" fill="#000000"></path>
+                    <path d="M119.7,158 L119.2,158 L119.7,158.5 L119.7,158 L119.7,158 Z" id="Shape" fill="#FF0000"></path>
+                    <path d="M195,75.3 C186.1,59.9 173.3,46.9 158,37.8 C142.3,28.4 124,23 104.5,23 C99.7,23 95,23.3 90.4,24 C86.3,24.6 82.3,25.3 78.3,26.4 C73.4,27.7 68.7,29.3 64.1,31.2 C59.6,33.1 55.3,35.3 51.2,37.7 C20.6,55.9 0,89.3 0,127.5 C0,153.8 9.8,177.9 25.9,196.3 C31.3,202.4 37.3,207.9 44,212.6 C47.5,215.1 51.2,217.4 55,219.5 C57,220.6 59,221.6 61.1,222.5 C74.3,228.6 89,231.9 104.5,231.9 C124,231.9 142.3,226.5 158,217.1 C173.3,207.9 186.1,195 195,179.6 C203.9,164.2 209,146.4 209,127.4 C209,108.5 203.9,90.7 195,75.3 L195,75.3 Z M151.2,198.5 C141.4,205 130.4,209.3 118.9,211.3 C114.2,212.1 109.4,212.5 104.5,212.5 C103.3,212.5 102.2,212.5 101,212.4 C97.3,212.2 93.6,211.8 90,211.2 C85.9,210.5 81.9,209.5 78,208.2 C74.2,207 70.5,205.5 67,203.7 C62.8,201.6 58.8,199.2 55,196.5 C51.1,193.7 47.4,190.5 44,187.1 C36,179 29.6,169.2 25.4,158.4 C21.6,148.8 19.6,138.4 19.6,127.5 C19.6,110.8 24.4,94.7 33.6,80.8 L37,75.7 L55.7,94.4 L108.4,147.1 L119.4,158.1 L119.9,158.1 L119.9,158.6 L156.5,195.2 L151.2,198.5 L151.2,198.5 Z M177.7,170.7 L174.4,176.2 L158,159.9 L89.4,91.3 L55.8,57.6 L61.3,54.3 C71.4,48.3 82.6,44.6 94.2,43.1 C97.6,42.7 101,42.5 104.5,42.5 C124.8,42.5 143.4,49.6 158,61.5 C177.2,77.1 189.4,100.8 189.4,127.4 C189.4,142.7 185.4,157.7 177.7,170.7 L177.7,170.7 Z" id="Shape" fill="#FF0000"></path>
+                </g>
+            </g>
+        </g>
+    </g>
+</svg>

data/vendor/assets/images/ckeditor/plugins/copyformatting/cursors/cursor.svg

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg width="16px" height="16px" viewBox="0 0 205 252" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>cursor</title>
+    <desc></desc>
+    <defs></defs>
+    <g id="Page-4" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="Artboard-1" transform="translate(-49.000000, -2.000000)" fill="#000000">
+            <g id="cursor" transform="translate(49.000000, 2.000000)">
+                <path d="M170,14 L200.007537,14 C202.769057,14 205,11.7636493 205,9.00497092 L205,4.99502908 C205,2.23382212 202.764798,0 200.007537,0 L101.992463,0 C99.2309431,0 97,2.23635069 97,4.99502908 L97,9.00497092 C97,11.7661779 99.2352017,14 101.992463,14 L133,14 L133,238 L101.992463,238 C99.2309431,238 97,240.236351 97,242.995029 L97,247.004971 C97,249.766178 99.2352017,252 101.992463,252 L200.007537,252 C202.769057,252 205,249.763649 205,247.004971 L205,242.995029 C205,240.233822 202.764798,238 200.007537,238 L170,238 L170,14 Z" id="Combined-Shape"></path>
+                <path d="M65,222.280829 C60.6131176,222.280829 56.3742162,222.280828 52.9999995,222.280828 L53,170 L42,170 L42,222.560593 C38.6130246,222.560593 34.3763308,222.560593 30.0000005,222.560594 L30,170 L19,170 L19,222.560595 C16.324865,222.560595 13.8463369,222.560595 11.7612725,222.560596 C-0.369586438,222.560599 1.28381746,211.509313 1.28381746,211.509313 C1.28381746,211.509313 0.389689944,177.756 0.396571277,158 L94.7408232,158 C94.7392736,177.793089 93.8535396,211.229548 93.8535396,211.229548 C93.8535396,211.229548 95.5069435,222.280834 83.3760845,222.280831 C81.2553782,222.28083 78.7276415,222.28083 76.0000002,222.28083 L76,170 L65,170 L65,222.280829 Z M0.574534036,147 C0.579768387,146.896149 0.585131638,146.794755 0.590625514,146.695866 C1.28381748,134.218409 -0.797112286,122.434146 16.8792816,116.195422 C34.5556755,109.956698 28.6662536,107.530522 30.3978792,95.7462576 C32.1295048,83.961993 25.8921298,78.069863 25.8921315,44.7966496 C25.892133,17.9607206 38.5169467,13.9220173 45.5220939,13.3637617 C45.6089814,13.1340727 45.7002506,13.0164391 45.7960631,13.0164391 C49.8372056,13.0164389 69.2452237,11.2436713 69.2452255,44.5168847 C69.2452273,77.7900982 63.0078523,83.6822281 64.7394778,95.4664928 C66.4711034,107.250757 60.5816815,109.676933 78.2580754,115.915657 C95.9344693,122.154381 93.8535395,133.938644 94.5467315,146.416101 C94.5570586,146.601989 94.5669242,146.796724 94.5763397,147 L0.574534036,147 Z M47.5,41 C52.1944204,41 56,37.1944204 56,32.5 C56,27.8055796 52.1944204,24 47.5,24 C42.8055796,24 39,27.8055796 39,32.5 C39,37.1944204 42.8055796,41 47.5,41 Z" id="Combined-Shape"></path>
+            </g>
+        </g>
+    </g>
+</svg>