ckeditor 4.0.6 → 4.0.7

data/README.md

@@ -1,11 +1,11 @@
 # Ckeditor
 
-CKEditor is a ready-for-use HTML text editor designed to simplify web content creation. It's a WYSIWYG editor that brings common word processor features directly to your web pages. Enhance your website experience with our community maintained editor. 
+CKEditor is a ready-for-use HTML text editor designed to simplify web content creation. It's a WYSIWYG editor that brings common word processor features directly to your web pages. Enhance your website experience with our community maintained editor.
 [ckeditor.com](http://ckeditor.com/)
 
 ## Features
 
-* Ckeditor version 4.2 (full)
+* Ckeditor version 4.3 (full)
 * Rails 4 integration
 * Files browser
 * HTML5 files uploader
@@ -36,7 +36,7 @@ gem "paperclip"
 
 rails generate ckeditor:install --orm=active_record --backend=paperclip
 ```
-  
+
 #### ActiveRecord + carrierwave
 
 ```
@@ -110,13 +110,61 @@ app/assets/javascripts/ckeditor/config.js
 app/assets/javascripts/ckeditor/contents.css
 ```
 
+### Usage with Rails 4 assets
+
+In order to use rails 4 assets with digest in production environment you need some preparing.
+
+First, you need to include in `application.js` **before** `ckeditor/init`
+
+```
+//= require ckeditor/override
+```
+
+It forces ckeditor core to respect digested assets.
+
+Next you need to check, that some non-core plugins and skins don't use core ckeditor functions
+to determine path to assets. Therefore we have to create a rake task thats copies the original assets and creates a non-digest version of it. Some example of such rake task is:
+
+```ruby
+namespace :ckeditor do
+  desc 'Create nondigest versions of some ckeditor assets (e.g. moono skin png)'
+  task :create_nondigest_assets do
+    fingerprint = /\-[0-9a-f]{32}\./
+    for file in Dir['public/assets/ckeditor/contents-*.css', 'public/assets/ckeditor/skins/moono/*.png']
+      next unless file =~ fingerprint
+      nondigest = file.sub fingerprint, '.' # contents-0d8ffa186a00f5063461bc0ba0d96087.css => contents.css
+      FileUtils.cp file, nondigest, verbose: true
+    end
+  end
+end
+
+# auto run ckeditor:create_nondigest_assets after assets:precompile
+Rake::Task['assets:precompile'].enhance do
+  Rake::Task['ckeditor:create_nondigest_assets'].invoke
+end
+```
+This also works on heroku. Even after restarting dynos running on a cedar stack, the assets will remain.
+
+You can include this rake task in a capistrano task (if you are deploying via capistrano):
+
+```ruby
+desc 'copy ckeditor nondigest assets'
+task :copy_nondigest_assets, roles: :app do
+  run "cd #{latest_release} && #{rake} RAILS_ENV=#{rails_env} ckeditor:copy_nondigest_assets"
+end
+after 'deploy:assets:precompile', 'copy_nondigest_assets'
+```
+
+Periodically check your error monitoring tool, if you see some part of ckeditor try to load
+unexisting non-digest asset - if so just add it in the ckeditor rake task.
+
 ### AJAX
 
 jQuery sample:
 
 ```html
 <script type='text/javascript' charset='UTF-8'>
-  $(document).ready(function(){  
+  $(document).ready(function(){
     $('form[data-remote]').bind("ajax:before", function(){
       for (instance in CKEDITOR.instances){
         CKEDITOR.instances[instance].updateElement();
@@ -182,11 +230,11 @@ en:
 $> rake test
 $> rake test CKEDITOR_ORM=mongoid
 $> rake test CKEDITOR_BACKEND=carrierwave
-  
+
 $> rake test:controllers
 $> rake test:generators
 $> rake test:integration
 $> rake test:models
 ```
 
-This project rocks and uses MIT-LICENSE.
+This project rocks and uses MIT-LICENSE.

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

@@ -8,7 +8,7 @@ CKEDITOR.editorConfig = function( config )
   // Define changes to default configuration here. For example:
   // config.language = 'fr';
   // config.uiColor = '#AADC6E';
-  
+
   /* Filebrowser routes */
   // The location of an external file browser, that should be launched when "Browse Server" button is pressed.
   config.filebrowserBrowseUrl = "/ckeditor/attachment_files";
@@ -18,7 +18,7 @@ CKEDITOR.editorConfig = function( config )
 
   // The location of a script that handles file uploads in the Flash dialog.
   config.filebrowserFlashUploadUrl = "/ckeditor/attachment_files";
-  
+
   // The location of an external file browser, that should be launched when "Browse Server" button is pressed in the Link tab of Image dialog.
   config.filebrowserImageBrowseLinkUrl = "/ckeditor/pictures";
 
@@ -27,16 +27,16 @@ CKEDITOR.editorConfig = function( config )
 
   // The location of a script that handles file uploads in the Image dialog.
   config.filebrowserImageUploadUrl = "/ckeditor/pictures";
-  
+
   // The location of a script that handles file uploads.
   config.filebrowserUploadUrl = "/ckeditor/attachment_files";
-  
+
   // Rails CSRF token
   config.filebrowserParams = function(){
     var csrf_token, csrf_param, meta,
         metas = document.getElementsByTagName('meta'),
         params = new Object();
-    
+
     for ( var i = 0 ; i < metas.length ; i++ ){
       meta = metas[i];
 
@@ -55,10 +55,10 @@ CKEDITOR.editorConfig = function( config )
     if (csrf_param !== undefined && csrf_token !== undefined) {
       params[csrf_param] = csrf_token;
     }
-    
+
     return params;
   };
-  
+
   config.addQueryString = function( url, params ){
     var queryString = [];
 
@@ -71,18 +71,18 @@ CKEDITOR.editorConfig = function( config )
 
     return url + ( ( url.indexOf( "?" ) != -1 ) ? "&" : "?" ) + queryString.join( "&" );
   };
-  
+
   // Integrate Rails CSRF token into file upload dialogs (link, image, attachment and flash)
   CKEDITOR.on( 'dialogDefinition', function( ev ){
     // Take the dialog name and its definition from the event data.
     var dialogName = ev.data.name;
     var dialogDefinition = ev.data.definition;
     var content, upload;
-    
+
     if (CKEDITOR.tools.indexOf(['link', 'image', 'attachment', 'flash'], dialogName) > -1) {
       content = (dialogDefinition.getContents('Upload') || dialogDefinition.getContents('upload'));
       upload = (content == null ? null : content.get('upload'));
-      
+
       if (upload && upload.filebrowser && upload.filebrowser['params'] === undefined) {
         upload.filebrowser['params'] = config.filebrowserParams();
         upload.action = config.addQueryString(upload.action, upload.filebrowser['params']);

data/app/assets/javascripts/ckeditor/filebrowser/javascripts/{application.js → application.js.erb}

@@ -76,7 +76,6 @@ qq.FileUploaderInput = function(o){
     this._classes = this._options.classes;
         
     this._button = this._createUploadButton(this._find(this._element, 'button'));  
-    this._path = $('meta[name="ckeditor-path"]').attr('content');
     
     //this._setupDragDrop();
     
@@ -188,7 +187,7 @@ qq.extend(qq.FileUploaderInput.prototype, {
             format_created_at: '',
             url_content: "#",
             controller: "assets",
-            url_thumb: this._path + "/filebrowser/images/preloader.gif"
+            url_thumb: "<%= asset_path('ckeditor/filebrowser/images/preloader.gif') %>"
           };
           
           var item = $(this._options.template_id)

data/app/assets/javascripts/ckeditor/filebrowser/stylesheets/{uploader.css → uploader.css.erb}

@@ -56,7 +56,7 @@ img {
 .gal-holder .gal-item .gal-upload-holder .add {
   display: block;
   color: #2e5aff;
-  background: url(/assets/ckeditor/filebrowser/images/gal_add.png) no-repeat left center;
+  background: url(<%= asset_path('ckeditor/filebrowser/images/gal_add.png') %>) no-repeat left center;
   padding-left: 33px;
   line-height: 25px;
   text-decoration: none;
@@ -108,7 +108,7 @@ img {
 }
 .gal-more a {
 	color: #2e5aff;
-	background: url(/assets/ckeditor/filebrowser/images/gal_more.gif) no-repeat left center;
+	background: url(<%= asset_path('ckeditor/filebrowser/images/gal_more.gif') %>) no-repeat left center;
 	padding-left: 15px;
 	font-size: 14px;
 	text-decoration: none;

data/app/assets/javascripts/ckeditor/init.js.erb

@@ -3,7 +3,7 @@
 
 (function() {
   if (typeof window['CKEDITOR_BASEPATH'] === "undefined" || window['CKEDITOR_BASEPATH'] === null) {
-    window['CKEDITOR_BASEPATH'] = "<%= config.relative_url_root %>/assets/ckeditor/";
+    window['CKEDITOR_BASEPATH'] = "<%= asset_path('ckeditor') %>/";
   }
 }).call(this);
 
@@ -13,4 +13,4 @@ function ck_load() {
   });
 }
 
-$(document).on('page:load', ck_load);
+$(document).on('page:load', ck_load);

data/app/assets/javascripts/ckeditor/override.js.erb

@@ -0,0 +1,21 @@
+window['CKEDITOR_BASEPATH'] = "/assets/ckeditor/";
+
+window.CKEDITOR_ASSETS_MAPPING = {
+<% Rails.application.assets.each_logical_path(->(path){ path =~ /ckeditor/ && path != 'ckeditor/override.js' }) do |asset| %>
+  "<%= asset %>": "<%= asset_path(asset) %>",
+<% end %>
+}
+
+window.CKEDITOR_GETURL = function( resource ) {
+  // If this is not a full or absolute path.
+  if ( resource.indexOf( ':/' ) == -1 && resource.indexOf( '/' ) !== 0 )
+    resource = this.basePath + resource;
+
+  // Add the timestamp, except for directories.
+  if ( resource.charAt( resource.length - 1 ) != '/'  ){
+    var url = resource.match( /^(.*?:\/\/[^\/]*)\/assets\/(.+)/ );
+    if(url) resource = url[1] + (CKEDITOR_ASSETS_MAPPING[url[2]] || '/assets/' + url[2]);
+  }
+
+  return resource;
+}

data/app/controllers/ckeditor/application_controller.rb

@@ -1,5 +1,6 @@
 class Ckeditor::ApplicationController < ::ApplicationController
   respond_to :html, :json
+  layout 'ckeditor/application'
   
   before_filter :find_asset, :only => [:destroy]
   before_filter :ckeditor_authorize!
@@ -15,7 +16,7 @@ class Ckeditor::ApplicationController < ::ApplicationController
 
       if callback && asset.save
         body = params[:CKEditor].blank? ? asset.to_json(:only=>[:id, :type]) : %Q"<script type='text/javascript'>
-          window.parent.CKEDITOR.tools.callFunction(#{params[:CKEditorFuncNum]}, '#{Ckeditor::Utils.escape_single_quotes(asset.url_content)}');
+          window.parent.CKEDITOR.tools.callFunction(#{params[:CKEditorFuncNum]}, '#{config.relative_url_root}#{Ckeditor::Utils.escape_single_quotes(asset.url_content)}');
         </script>"
         
         render :text => body

data/app/controllers/ckeditor/attachment_files_controller.rb

@@ -1,12 +1,12 @@
 class Ckeditor::AttachmentFilesController < Ckeditor::ApplicationController
 
   def index
-    @attachments = Ckeditor.attachment_file_model.find_all(ckeditor_attachment_files_scope)
+    @attachments = Ckeditor.attachment_file_adapter.find_all(ckeditor_attachment_files_scope)
     respond_with(@attachments)
   end
   
   def create
-    @attachment = Ckeditor::AttachmentFile.new
+    @attachment = Ckeditor.attachment_file_model.new
 	  respond_with_asset(@attachment)
   end
   
@@ -18,11 +18,11 @@ class Ckeditor::AttachmentFilesController < Ckeditor::ApplicationController
   protected
   
     def find_asset
-      @attachment = Ckeditor.attachment_file_model.get!(params[:id])
+      @attachment = Ckeditor.attachment_file_adapter.get!(params[:id])
     end
 
     def authorize_resource
-      model = (@attachment || Ckeditor::AttachmentFile)
+      model = (@attachment || Ckeditor.attachment_file_model)
       @authorization_adapter.try(:authorize, params[:action], model)
     end
 end

data/app/controllers/ckeditor/pictures_controller.rb

@@ -1,12 +1,12 @@
 class Ckeditor::PicturesController < Ckeditor::ApplicationController
 
   def index
-    @pictures = Ckeditor.picture_model.find_all(ckeditor_pictures_scope)
+    @pictures = Ckeditor.picture_adapter.find_all(ckeditor_pictures_scope)
     respond_with(@pictures) 
   end
   
   def create
-    @picture = Ckeditor::Picture.new
+    @picture = Ckeditor.picture_model.new
 	  respond_with_asset(@picture)
   end
   
@@ -18,11 +18,11 @@ class Ckeditor::PicturesController < Ckeditor::ApplicationController
   protected
   
     def find_asset
-      @picture = Ckeditor.picture_model.get!(params[:id])
+      @picture = Ckeditor.picture_adapter.get!(params[:id])
     end
 
     def authorize_resource
-      model = (@picture || Ckeditor::Picture)
+      model = (@picture || Ckeditor.picture_model)
       @authorization_adapter.try(:authorize, params[:action], model)
     end
 end

data/app/views/ckeditor/shared/_asset.html.erb

@@ -1,5 +1,5 @@
 <%= content_tag(:div, :id => dom_id(asset), :class => "gal-item", :"data-url" => image_path(asset.url_content)) do %>
-  <%= link_to image_tag("/assets/ckeditor/filebrowser/images/gal_del.png",
+  <%= link_to image_tag('ckeditor/filebrowser/images/gal_del.png',
     :title => I18n.t('ckeditor.buttons.delete')),
           polymorphic_path(asset, :format => :json),
           :remote => true,

data/app/views/ckeditor/shared/_asset_tmpl.html.erb

@@ -1,6 +1,6 @@
 <script id="fileupload_tmpl" type="text/x-jquery-tmpl">
 <div id="asset_${id}" class="gal-item" data-url="${url_content}">
-  <%= link_to image_tag("/assets/ckeditor/filebrowser/images/gal_del.png", 
+  <%= link_to image_tag('ckeditor/filebrowser/images/gal_del.png',
     :title => I18n.t('ckeditor.buttons.delete')), 
           "/ckeditor/${controller}/${id}.json", 
           :remote => true,
@@ -9,7 +9,7 @@
           :class => "fileupload-cancel gal-del" %>
 	
 	<div class="fileupload-file gal-inner-holder">
-		<div class="img"><img src="<%= Rails.configuration.action_controller.asset_host %>${url_thumb}" title="${filename}"></div>
+		<div class="img"><img src="${url_thumb}" title="${filename}"></div>
 		<div class="img-data">
 			<div class="img-name">${filename}</div>
 			<div class="time-size">

data/app/views/layouts/ckeditor/application.html.erb

@@ -4,7 +4,6 @@
   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   <meta name="robots" content="noindex, nofollow">
   <%= csrf_meta_tag %>
-  <%= tag(:meta, :name => "ckeditor-path", :content => Ckeditor.relative_path) %>
   <title><%= I18n.t('page_title', :scope => [:ckeditor]) %></title>
 
   <% if assets_pipeline_enabled? -%>

data/lib/ckeditor.rb

@@ -55,7 +55,11 @@ module Ckeditor
   # Turn on/off filename parameterize
   mattr_accessor :parameterize_filenames
   @@parameterize_filenames = true
-  
+
+  # Model classes
+  @@picture_model = nil
+  @@attachment_file_model = nil
+
   # Default way to setup Ckeditor. Run rails generate ckeditor to create
   # a fresh initializer with all configuration values.
   #
@@ -77,13 +81,51 @@ module Ckeditor
   def self.assets
     @@assets ||= Utils.select_assets("ckeditor", "vendor/assets/javascripts") << "ckeditor/init.js"
   end
-  
-  def self.picture_model
-    Ckeditor::Picture.to_adapter
+
+  def self.picture_model(&block)
+    if block_given?
+      self.picture_model = block
+    else
+      @@picture_model_class ||= begin
+        if @@picture_model.respond_to? :call
+          @@picture_model.call
+        else
+          @@picture_model || Ckeditor::Picture
+        end
+      end
+    end
   end
-  
-  def self.attachment_file_model
-    Ckeditor::AttachmentFile.to_adapter
+
+  def self.picture_model=(value)
+    @@picture_model_class = nil
+    @@picture_model = value
+  end
+
+  def self.picture_adapter
+    picture_model.to_adapter
+  end
+
+  def self.attachment_file_model(&block)
+    if block_given?
+      self.attachment_file_model = block
+    else
+      @@attachment_file_model_class ||= begin
+        if @@attachment_file_model.respond_to? :call
+          @@attachment_file_model.call
+        else
+          @@attachment_file_model || Ckeditor::AttachmentFile
+        end
+      end
+    end
+  end
+
+  def self.attachment_file_model=(value)
+    @@attachment_file_model_class = nil
+    @@attachment_file_model = value
+  end
+
+  def self.attachment_file_adapter
+    attachment_file_model.to_adapter
   end
 
   # Setup authorization to be run as a before filter

data/lib/ckeditor/utils.rb

@@ -77,7 +77,7 @@ module Ckeditor
         folder = File.join(relative_path, path, '**')
         relative_folder = Ckeditor.root_path.join(relative_path)
       
-        Dir[Ckeditor.root_path.join(folder, '*.{js,css}')].inject([]) do |list, file|
+        Dir[Ckeditor.root_path.join(folder, '*.{js,css,png,gif,jpg}')].inject([]) do |list, file|
           list << Pathname.new(file).relative_path_from(relative_folder).to_s
           list
         end

data/lib/ckeditor/version.rb

@@ -1,6 +1,6 @@
 module Ckeditor
   module Version
-    GEM = "4.0.6".freeze
-    EDITOR = "4.2".freeze
+    GEM = "4.0.7".freeze
+    EDITOR = "4.3".freeze
   end
 end

data/lib/generators/ckeditor/templates/ckeditor.rb

@@ -16,4 +16,8 @@ Ckeditor.setup do |config|
 
   # Setup authorization to be run as a before filter
   # config.authorize_with :cancan
+
+  # Asset model classes
+  # config.picture_model { Ckeditor::Picture }
+  # config.attachment_file_model { Ckeditor::AttachmentFile }
 end