ckeditor 3.7.3 → 4.0.0.rc1

data/README.rdoc

@@ -1,7 +1,6 @@
 = Ckeditor
 
-CKEditor is a text editor to be used inside web pages. It's a WYSIWYG editor, which means that the text being edited on it looks as similar as possible to 
-the results users have when publishing it. It brings to the web common editing features found on desktop editing applications like Microsoft Word and OpenOffice.
+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. http://ckeditor.com/
 
 == Features
 
@@ -9,20 +8,20 @@ the results users have when publishing it. It brings to the web common editing f
 * Files browser
 * HTML5 files uploader
 * Hooks for formtastic and simple_form forms generators
-* Extra plugins: attachment and embed.
-* Assets pagination (under construction)
 
-== Install
+== Installation
 
-Rails 3.2:
+For basic usage just include ckeditor gem:
 
-  gem "ckeditor", "3.7.1"
+  gem "ckeditor"
 
-Rails <= 3.0:
+For files uploading support you need generage models for file storage.
+Currently supported next backends:
 
-  gem "ckeditor", "3.6.3"
+* ActiveRecord (paperclip, carrierwave, dragonfly)
+* Mongoid (paperclip, carrierwave, dragonfly)
 
-=== Now generate models for store uploading files
+=== How generate models for store uploading files
 
 ==== ActiveRecord + paperclip
 
@@ -52,65 +51,41 @@ For active_record orm is used paperclip gem (it's by default).
 
   rails generate ckeditor:install --orm=mongoid --backend=carrierwave
 
-Available orms:
-* active_record
-* mongoid (Thanks Dmitry Lihachev https://github.com/lda)
-* mongo_mapper (under construction)
-
-
+All ckeditor models will be generated into app/models/ckeditor folder.
 Autoload ckeditor models folder (application.rb):
 
   config.autoload_paths += %W(#{config.root}/app/models/ckeditor)
 
-== Usage
-
 Mount engine in your routes (config/routes.rb):
 
   mount Ckeditor::Engine => "/ckeditor"
 
-Procompile ckeditor js and css files (config/environments/production.rb):
-
-  config.assets.precompile += Ckeditor.assets
+== Usage
 
-Include ckeditor javascripts rails 3.2:
+Include ckeditor javascripts rails 3.2 (application.js):
 
   //= require ckeditor/init
 
-or
-
-  <%= javascript_include_tag "ckeditor/init" %>  
-
-
-Rails <= 3.0:
-
-  <%= javascript_include_tag :ckeditor %>
-
 Form helpers:
 
-  cktext_area_tag("test_area", "Ckeditor is the best")
+  <%= form_for @page do |form| -%>
+    ...
+    <%= form.cktext_area :notes, :class => "someclass", :ckeditor => {:language => "uk"} %>
+    ...
+    <%= form.cktext_area :content, :value => "Default value", :id => "sometext" %>
+    ...
+    <%= cktext_area :page, :info, :ckeditor => {:uiColor => "#AADC6E", :toolbar => "mini"} %>
+    ...
+  <% end -%>
+
 
-  cktext_area_tag("content", "Ckeditor", :input_html => {:cols => 10, :rows => 20}, :toolbar => 'Easy')
-  
-* input_html - Options for text_area tag, others for ckeditor javascript configuration.
-* language - appends automatically, by default it's I18n.locale
-* available ckeditor options - http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html
+All ckeditor 4.0 options here http://docs.ckeditor.com/#!/api/CKEDITOR.config
 
 In order to configure the ckeditor default options, create files:
 
   app/assets/javascripts/ckeditor/config.js
 
   app/assets/javascripts/ckeditor/contents.css
-  
-Here's a FormBuilder helper example:
-
-  <%= form_for @page do |form| -%>
-    ...
-    <%= form.cktext_area :notes, :toolbar => 'Full', :width => 800, :height => 400 %>
-    ...
-    <%= form.cktext_area :content, :input_html => { :value => "Default value" } %>
-    ...
-    <%= cktext_area :page, :info %>
-  <% end -%>
 
 === AJAX
 
@@ -129,61 +104,33 @@ jQuery sample:
 === Formtastic integration
 
   <%= form.input :content, :as => :ckeditor %>
-  <%= form.input :content, :as => :ckeditor, :input_html => { :height => 400 } %>
+  <%= form.input :content, :as => :ckeditor, :input_html => { :ckeditor => { :height => 400 } } %>
 
 === SimpleForm integration
 
-  <%= form.input :content, :as => :ckeditor, :label => false, :input_html => { :toolbar => 'Full' } %>
+  <%= form.input :content, :as => :ckeditor, :input_html => { :ckeditor => {:toolbar => 'Full'} } %>
 
-=== Default scope
+=== CanCan integration
 
-For example, you need split assets collection for each user.
+To use cancan with Ckeditor, add this to an initializer.
 
-  class ApplicationController < ActionController::Base
-  
-    protected
-      
-      def ckeditor_filebrowser_scope(options = {})
-        super({ :assetable_id => current_user.id, :assetable_type => 'User' }.merge(options))
-      end
-  end
-  
-If you want to filter only pictures or attachment_files - redefine methods "ckeditor_pictures_scope" or "ckeditor_attachment_files_scope" respectively.
-By default, both these methods call "ckeditor_filebrowser_scope" method:
+  # in config/initializers/ckeditor.rb
 
-  class ApplicationController < ActionController::Base
-  
-    protected
-
-      def ckeditor_pictures_scope(options = {})
-        ckeditor_filebrowser_scope(options)
-      end
-          
-      def ckeditor_attachment_files_scope(options = {})
-        ckeditor_filebrowser_scope(options)
-      end
+  Ckeditor.setup do |config|
+    config.authorize_with :cancan
   end
 
-=== Callbacks
-
-  class ApplicationController < ActionController::Base
+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
   
-    protected
-      
-      # Cancan example
-      def ckeditor_authenticate
-        authorize! action_name, @asset
-      end
-      
-      # Set current_user as assetable
-      def ckeditor_before_create_asset(asset)
-        asset.assetable = current_user
-        return true
-      end
-  end
+  # Always performed
+  can :access, :ckeditor   # needed to access Ckeditor filebrowser
 
+  # Performed checks for actions:
+  can [:read, :create, :destroy], Ckeditor::Picture
+  can [:read, :create, :destroy], Ckeditor::AttachmentFile
 
-== I18n  
+== I18n
 
   en:
     ckeditor:

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

@@ -90,10 +90,6 @@ CKEDITOR.editorConfig = function( config )
     }
   });
   
-  /* Extra plugins */
-  // works only with en, ru, uk locales
-  config.extraPlugins = "embed,attachment";
-  
   /* Toolbars */
   config.toolbar = 'Easy';
   
@@ -105,7 +101,7 @@ CKEDITOR.editorConfig = function( config )
         ['Styles','Format'], ['Subscript', 'Superscript', 'TextColor'], ['Maximize','-','About'], '/',
         ['Bold','Italic','Underline','Strike'], ['NumberedList','BulletedList','-','Outdent','Indent','Blockquote'],
         ['JustifyLeft','JustifyCenter','JustifyRight','JustifyBlock'],
-        ['Link','Unlink','Anchor'], ['Image', 'Attachment', 'Flash', 'Embed'],
+        ['Link','Unlink','Anchor'], ['Image', 'Flash'],
         ['Table','HorizontalRule','Smiley','SpecialChar','PageBreak']
     ];
 };

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

@@ -3,6 +3,6 @@
 
 (function() {
   if (typeof window['CKEDITOR_BASEPATH'] === "undefined" || window['CKEDITOR_BASEPATH'] === null) {
-    window['CKEDITOR_BASEPATH'] = "/assets/ckeditor/";
+    window['CKEDITOR_BASEPATH'] = "<%= config.relative_url_root %>/assets/ckeditor/";
   }
 }).call(this);

data/app/controllers/ckeditor/application_controller.rb

@@ -1,18 +1,12 @@
 class Ckeditor::ApplicationController < ::ApplicationController
   respond_to :html, :json
   
-  before_filter :set_locale
   before_filter :find_asset, :only => [:destroy]
-  before_filter :ckeditor_authenticate
+  before_filter :ckeditor_authorize!
+  before_filter :authorize_resource
 
   protected
     
-    def set_locale
-      if !params[:langCode].blank? && I18n.available_locales.include?(params[:langCode].to_sym)
-        I18n.locale = params[:langCode]
-      end
-    end
-    
     def respond_with_asset(asset)
       file = params[:CKEditor].blank? ? params[:qqfile] : params[:upload]
 	    asset.data = Ckeditor::Http.normalize_param(file, request)

data/app/controllers/ckeditor/attachment_files_controller.rb

@@ -20,4 +20,9 @@ class Ckeditor::AttachmentFilesController < Ckeditor::ApplicationController
     def find_asset
       @attachment = Ckeditor.attachment_file_model.get!(params[:id])
     end
+
+    def authorize_resource
+      model = (@attachment || Ckeditor::AttachmentFile)
+      @authorization_adapter.try(:authorize, params[:action], model)
+    end
 end

data/app/controllers/ckeditor/pictures_controller.rb

@@ -20,4 +20,9 @@ class Ckeditor::PicturesController < Ckeditor::ApplicationController
     def find_asset
       @picture = Ckeditor.picture_model.get!(params[:id])
     end
+
+    def authorize_resource
+      model = (@picture || Ckeditor::Picture)
+      @authorization_adapter.try(:authorize, params[:action], model)
+    end
 end

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

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

data/lib/ckeditor.rb

@@ -2,8 +2,6 @@ require 'orm_adapter'
 require 'pathname'
 
 module Ckeditor
-  IMAGE_TYPES = ['image/jpeg', 'image/png', 'image/gif', 'image/jpg', 'image/pjpeg', 'image/tiff', 'image/x-png']
-  
   autoload :Utils, 'ckeditor/utils'
   autoload :Http, 'ckeditor/http'
   
@@ -16,6 +14,7 @@ module Ckeditor
   
   module Hooks
     autoload :SimpleFormBuilder, 'ckeditor/hooks/simple_form'
+    autoload :CanCanAuthorization, 'ckeditor/hooks/cancan'
   end
   
   module Backend
@@ -23,6 +22,16 @@ module Ckeditor
     autoload :CarrierWave, 'ckeditor/backend/carrierwave'
     autoload :Dragonfly, 'ckeditor/backend/dragonfly'
   end
+
+  IMAGE_TYPES = ['image/jpeg', 'image/png', 'image/gif', 'image/jpg', 'image/pjpeg', 'image/tiff', 'image/x-png']
+
+  DEFAULT_AUTHORIZE = Proc.new {}
+
+  AUTHORIZATION_ADAPTERS = {}
+
+  DEFAULT_CURRENT_USER = Proc.new do
+    request.env["warden"].try(:user) || respond_to?(:current_user) && current_user
+  end
   
   # Allowed image file types for upload. 
   # Set to nil or [] (empty array) for all file types
@@ -48,19 +57,24 @@ module Ckeditor
   
   # Default way to setup Ckeditor. Run rails generate ckeditor to create
   # a fresh initializer with all configuration values.
+  #
+  # @example
+  #   Ckeditor.setup do |config|
+  #     config.parameterize_filenames = false
+  #     config.attachment_file_types += ["xml"]
+  #   end
+  #
   def self.setup
     yield self
   end
   
   def self.root_path
-    @root_path ||= Pathname.new( File.dirname(File.expand_path('../', __FILE__)) )
+    @root_path ||= Pathname.new(File.dirname(File.expand_path('../', __FILE__)))
   end
   
+  # All css and js files from ckeditor folder
   def self.assets
-    @@assets ||= begin
-      Utils.select_assets("vendor/assets/javascripts/ckeditor", "vendor/assets/javascripts") +
-      Utils.select_assets("app/assets/javascripts/ckeditor/plugins", "app/assets/javascripts")
-    end
+    @@assets ||= Utils.select_assets("ckeditor", "vendor/assets/javascripts") << "ckeditor/init.js"
   end
   
   def self.picture_model
@@ -70,6 +84,57 @@ module Ckeditor
   def self.attachment_file_model
     Ckeditor::AttachmentFile.to_adapter
   end
+
+  # Setup authorization to be run as a before filter
+  # This is run inside the controller instance so you can setup any authorization you need to.
+  #
+  # By default, there is no authorization.
+  #
+  # @example Custom
+  #   Ckeditor.setup do |config|
+  #     config.authorize_with do
+  #       redirect_to root_path unless warden.user.is_admin?
+  #     end
+  #   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.
+  #
+  # @example CanCan
+  #   Ckeditor.setup do |config|
+  #     config.authorize_with :cancan
+  #   end
+  #
+  def self.authorize_with(*args, &block)
+    extension = args.shift
+    
+    if extension
+      @authorize = Proc.new {
+        @authorization_adapter = Ckeditor::AUTHORIZATION_ADAPTERS[extension].new(*([self] + args).compact)
+      }
+    else
+      @authorize = block if block
+    end
+
+    @authorize || DEFAULT_AUTHORIZE
+  end
+
+  # Setup a different method to determine the current user or admin logged in.
+  # This is run inside the controller instance and made available as a helper.
+  #
+  # By default, request.env["warden"].user or current_user will be used.
+  #
+  # @example Custom
+  #   Ckeditor.setup do |config|
+  #     config.current_user_method do
+  #       current_account
+  #     end
+  #   end
+  #
+  def self.current_user_method(&block)
+    @current_user = block if block
+    @current_user || DEFAULT_CURRENT_USER
+  end
 end
 
 require 'ckeditor/engine'

data/lib/ckeditor/engine.rb

@@ -5,9 +5,7 @@ module Ckeditor
   class Engine < ::Rails::Engine
     isolate_namespace Ckeditor
     
-    config.action_view.javascript_expansions[:ckeditor] = "ckeditor/ckeditor"
-    
-    initializer "ckeditor.assets_precompile", :group => :assets do |app|
+    initializer "ckeditor.assets_precompile", :group => :all do |app|
       app.config.assets.precompile += Ckeditor.assets
     end
     
@@ -24,14 +22,17 @@ module Ckeditor
     end
     
     initializer "ckeditor.hooks" do
-      # Don't load the hook for Formtastic < 2.0.0 that (it crashes), apparently, didn't define a Formtastic::Inputs.
-      if Object.const_defined?("Formtastic") && Formtastic.const_defined?("Inputs")
+      if Object.const_defined?("Formtastic")
         require "ckeditor/hooks/formtastic"
       end
       
       if Object.const_defined?("SimpleForm")
         require "ckeditor/hooks/simple_form"
       end
+
+      if Object.const_defined?("CanCan")
+        require "ckeditor/hooks/cancan"
+      end
     end
   end
 end

data/lib/ckeditor/helpers/controllers.rb

@@ -5,12 +5,16 @@ module Ckeditor
       
       protected
         
-        def ckeditor_authenticate
-          return true
+        def ckeditor_current_user
+          instance_eval &Ckeditor.current_user_method
+        end
+
+        def ckeditor_authorize!
+          instance_eval &Ckeditor.authorize_with
         end
         
         def ckeditor_before_create_asset(asset)
-          asset.assetable = current_user if respond_to?(:current_user)
+          asset.assetable = ckeditor_current_user
           return true
         end