ckeditor 3.2.1 → 3.2.3

data/README.rdoc

@@ -0,0 +1,136 @@
+=Rails CKEditor integration plugin with SWFUpload support
+
+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.
+
+Because CKEditor is licensed under flexible Open Source and commercial licenses, you'll be able to integrate and use it inside any kind of application. 
+This is the ideal editor for developers, created to provide easy and powerful solutions to their users.
+
+CKEditor version: 3.2.1 (http://ckeditor.com)
+
+SWFUpload version: 2.2.0.1 Core (http://swfupload.org)
+
+Rails version: 3.0.0.beta3
+
+Demo appication (Rails 2.3.x):
+http://github.com/galetahub/rails-ckeditor-demo-app
+
+==Install
+
+===Rails 3
+
+In your appication "Gemfile":
+  gem 'ckeditor', '3.2.3'
+
+Next step is generate ckeditor js files and configuration file
+Check "config/initializers/ckeditor.rb" for more configuration options:
+  rails generate ckeditor_core
+
+Generate ckeditor models for file upload support:
+For paperclip:
+  rails generate ckeditor_models
+
+For attachment_fu:
+  rails generate ckeditor_models --backend=attachment_fu
+
+Don't forget about migration:
+  rake db:migarte
+
+===Rails 2.3.x
+
+Install plugin:
+  ./script/plugin install git://github.com/galetahub/rails-ckeditor.git
+
+Generate ckeditor core files:
+  rake ckeditor:install
+
+This rake generated file config/ckeditor.yml:
+  rake ckeditor:config
+
+For attachment_fu option "swf_file_post_name" must be "uploaded_data".
+
+==Usage
+
+Basically include this in the page you wish to use the editor in:
+  <%= javascript_include_tag :ckeditor %>
+
+Then instead of the normal textarea helper from Rails use this one:
+  <%= ckeditor_textarea("object", "field", :width => '100%', :height => '200px') %>
+
+FormBuilder helper for more usefully:
+
+  <%= form_for @page do |form| -%>
+    ...
+    <%= form.cktext_area :notes, :toolbar=>'Full', :width=>'400px', :heigth=>'200px' %>
+    ...
+    <%= form.cktext_area :content, :swf_params=>{:assetable_type=>'User', :assetable_id=>current_user.id} %>
+    ...
+  <% end -%>
+  
+===Support options
+  :cols         # Textarea cols (default: 70)
+  :rows         # Textarea rows (default: 20)
+  :width        # Editor width (default: 100%)
+  :height       # Editor height (default: 100%)
+  :class        # Textarea css class name
+  :toolbar      # Toolbar name
+  :skin         # Editor skin
+  :language     # Editor language (default: I18n.locale)
+  :swf_params   # SWFUpload additional params (Hash)
+  :id           # textarea DOM element id
+
+For configure ckeditor default options check:
+  public/javascripts/ckeditor/config.js
+  
+This stylesheet use editor for displaying edit area:
+  public/javascripts/ckeditor/contents.css
+  
+===AJAX
+
+To use a remote form you need to call "ckeditor_ajax_script" helper method:
+
+  <%= form_for @page, :remote => true do |form| -%>
+    <%= form.cktext_area("note", "content") %>
+    ...
+    <%= form.cktext_area("note", "about") %>
+    ...
+    <%= ckeditor_ajax_script %>
+  <% end %>
+
+Helper "ckeditor_ajax_script" generate next script (jquery):
+
+  <script type='text/javascript' charset='UTF-8'>
+    $(document).ready(function(){  
+      $('form[data-remote]').bind("ajax:before", function(){
+        for (instance in CKEDITOR.instances){
+          CKEDITOR.instances[instance].updateElement();
+        }
+      });
+    });
+  </script>
+
+==File uploads
+
+We recommend using a paperclip plugin for file storage and processing images. Controller @../rails-ckeditor/app/controllers/ckeditor_controller.rb@ has actions 
+for displaying and uploading files. It uses classes Picture and AttachmentFile, who are descendants of the Asset class. So, your project must have these classes.
+
+  http://github.com/thoughtbot/paperclip
+
+For S3 storage look at "../ckeditor/examples/s3"
+
+==Formtastic integration
+Ckeditor detects if your use Formtastic and appends "Ckeditor::CustomFormBuilder".
+
+  <%= form.input :content, :as => :ckeditor %>
+
+==Middleware
+
+Ckeditor appends middleware ("Ckeditor::Middleware") before session store to 
+support swf upload with AuthenticityToken.
+
+  rake middleware
+
+==TODOs
+
+1. Add support for choose filemanager storage
+2. More integration upload system

data/app/controllers/ckeditor_controller.rb

@@ -1,10 +1,11 @@
 class CkeditorController < ApplicationController
+  skip_before_filter :verify_authenticity_token, :only => [:create]
   before_filter :swf_options, :only => [:images, :files, :create]
   layout "ckeditor"
   
   # GET /ckeditor/images
   def images
-    @images = Picture.find(:all, :order=>"id DESC")
+    @images = Ckeditor.image_model.find(:all, :order=>"id DESC")
     
     respond_to do |format|
       format.html {}
@@ -14,7 +15,7 @@ class CkeditorController < ApplicationController
   
   # GET /ckeditor/files
   def files
-    @files = AttachmentFile.find(:all, :order=>"id DESC")
+    @files = Ckeditor.file_model.find(:all, :order=>"id DESC")
     
     respond_to do |format|
       format.html {}
@@ -27,8 +28,8 @@ class CkeditorController < ApplicationController
     @kind = params[:kind] || 'file'
     
     @record = case @kind.downcase
-      when 'file'  then AttachmentFile.new
-			when 'image' then Picture.new
+      when 'file'  then Ckeditor.file_model.new
+			when 'image' then Ckeditor.image_model.new
 	  end
 	  
 	  unless params[:CKEditor].blank?	  

data/app/helpers/ckeditor_helper.rb

@@ -12,26 +12,10 @@ module CkeditorHelper
     options[:protocol] = "http://"
     options[session_key] = CGI.unescape(cookies[session_key])
     
-    unless request_forgery_protection_token.nil?
-      options[request_forgery_protection_token] = CGI.unescape(form_authenticity_token)
+    if protect_against_forgery?
+      options[request_forgery_protection_token] = form_authenticity_token
     end
     
     url_for(options)
   end
-  
-  def file_image_tag(filename, path)
-    extname = File.extname(filename)
-    
-    image = case extname.to_s
-      when '.swf' then '/javascripts/ckeditor/images/swf.gif'
-      when '.pdf' then '/javascripts/ckeditor/images/pdf.gif'
-      when '.doc', '.txt' then '/javascripts/ckeditor/images/doc.gif'
-      when '.mp3' then '/javascripts/ckeditor/images/mp3.gif'
-      when '.rar', '.zip', '.tg' then '/javascripts/ckeditor/images/rar.gif'
-      when '.xls' then '/javascripts/ckeditor/images/xls.gif'
-      else '/javascripts/ckeditor/images/ckfnothumb.gif'
-    end
-    
-    image_tag(image, :alt => path, :title => filename, :onerror => "this.src='/javascripts/ckeditor/images/ckfnothumb.gif'", :class => 'image')
-  end
 end

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

@@ -0,0 +1,15 @@
+<div class="FCKThumb">
+  <table border="0" cellpadding="0" cellspacing="0" height="100" width="100">
+    <tbody>
+      <tr>
+        <td align="center" valign="middle">
+          <%= image_tag(asset.url_thumb, :alt => asset.url_content, :title => asset.filename, :onerror=>"this.src='/javascripts/ckeditor/images/ckfnothumb.gif'", :class=>'image') %>
+        </td>
+       </tr>
+     </tbody>
+   </table>
+   
+   <div class="FCKFileName"><%= asset.filename %></div>
+   <div class="FCKFileDate"><%= asset.format_created_at %></div>
+   <div class="FCKFileSize"><%= number_to_human_size(asset.size, :precision => 2) %></div>
+</div>

data/app/views/ckeditor/files.html.erb

@@ -83,7 +83,7 @@
 	<tr>
 		<td style="height: 100%;" id="qu">
 		  <div style="overflow:auto; height:550px;" id='container'>
-			 <%= render :partial => "file", :collection => @files %>
+			 <%= render :partial => "asset", :collection => @files, :as => :asset %>
 		  </div>
 		</td>
 	</tr>

data/app/views/ckeditor/images.html.erb

@@ -83,7 +83,7 @@
 	<tr>
 		<td style="height: 100%;" id="qu">
 		  <div style="overflow:auto; height:550px;" id='container'>
-			 <%= render :partial => "image", :collection => @images %>
+			 <%= render :partial => "asset", :collection => @images, :as => :asset %>
 		  </div>
 		</td>
 	</tr>

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

@@ -10,7 +10,6 @@
 	
 	<script src="/javascripts/ckeditor/swfupload/mootools-1.2.3-core-yc.js" type="text/javascript"></script>
 	<script src="/javascripts/ckeditor/swfupload/swfupload.js" type="text/javascript"></script>
-	<script src="/javascripts/ckeditor/swfupload/swfupload.swfobject.js" type="text/javascript"></script>
 	<script src="/javascripts/ckeditor/swfupload/swfupload.queue.js" type="text/javascript"></script>
 	<script src="/javascripts/ckeditor/swfupload/fileprogress.js" type="text/javascript"></script>
 	<script src="/javascripts/ckeditor/swfupload/handlers.js" type="text/javascript"></script>

data/lib/ckeditor.rb

@@ -47,6 +47,22 @@ module Ckeditor
   mattr_accessor :file_manager_image_uri
   @@file_manager_image_uri = "/ckeditor/images"
   
+  mattr_accessor :file_manager_image_model
+  @@file_manager_image_model = "Ckeditor::Picture"
+  
+  mattr_accessor :file_manager_file_model
+  @@file_manager_file_model = "Ckeditor::AttachmentFile"
+  
+  def self.image_model
+    @@image_model ||= @@file_manager_image_model.to_s.constantize
+    @@image_model
+  end
+  
+  def self.file_model
+    @@file_model ||= @@file_manager_file_model.to_s.constantize
+    @@file_model
+  end
+  
   # Default way to setup Ckeditor. Run rails generate ckeditor to create
   # a fresh initializer with all configuration values.
   def self.setup
@@ -55,3 +71,7 @@ module Ckeditor
 end
 
 require 'ckeditor/engine'
+
+if Object.const_defined?("Formtastic")
+  require "ckeditor/formtastic"
+end

data/lib/ckeditor/engine.rb

@@ -1,10 +1,21 @@
 module Ckeditor
   class Engine < ::Rails::Engine
+    initializer "ckeditor_engine.add_middleware" do |app|
+      app.middleware.insert_before(
+        ActionDispatch::Cookies,
+        Ckeditor::Middleware,
+        app.config.send(:session_options)[:key])
+    end
+
     config.after_initialize do
       ActionView::Base.send :include, Ckeditor::ViewHelper
       ActionView::Helpers::FormBuilder.send :include, Ckeditor::FormBuilder
       
       ActionView::Helpers::AssetTagHelper.register_javascript_expansion :ckeditor => ["ckeditor/ckeditor"]
+      
+      if Object.const_defined?("Formtastic")
+        Formtastic::SemanticFormHelper.builder = Ckeditor::CustomFormBuilder
+      end
     end
   end
 end

data/lib/ckeditor/formtastic.rb

@@ -0,0 +1,12 @@
+module Ckeditor
+  class CustomFormBuilder < Formtastic::SemanticFormBuilder
+
+    private
+
+    def ckeditor_input(method, options)
+      html_options = options.delete(:input_html) || {}
+      self.label(method, options_for_label(options)) <<
+      self.send(:ckeditor_textarea, sanitized_object_name, method, html_options)
+    end
+  end
+end

data/lib/ckeditor/middleware.rb

@@ -0,0 +1,18 @@
+require 'rack/utils'
+
+module Ckeditor
+  class Middleware
+    def initialize(app, session_key = '_session_id')
+      @app = app
+      @session_key = session_key
+    end
+   
+    def call(env)
+      if env['HTTP_USER_AGENT'] =~ /^(Adobe|Shockwave) Flash/
+        params = ::Rack::Utils.parse_query(env['QUERY_STRING'])
+        env['HTTP_COOKIE'] = [ @session_key, ::Rack::Utils.escape(params[@session_key]) ].join('=').freeze unless params[@session_key].nil?
+      end
+      @app.call(env)
+    end
+  end
+end

data/lib/ckeditor/version.rb

@@ -2,7 +2,7 @@ module Ckeditor
   module Version
     MAJOR = 3
     MINOR = 2
-    RELEASE = 1
+    RELEASE = 3
 
     def self.dup
       "#{MAJOR}.#{MINOR}.#{RELEASE}"

data/lib/ckeditor/view_helper.rb

@@ -2,16 +2,18 @@ module Ckeditor
   module ViewHelper
     include ActionView::Helpers
     
-    # Example:
+    # Ckeditor helper:
     # <%= ckeditor_textarea("object", "field", :width => '100%', :height => '200px') %>
     #
-    # To use a remote form you need to do something like this
-    # <%= form_remote_tag :url => @options.merge(:controller => @scaffold_controller),
-    #              :before => Ckeditor_before_js('note', 'text') %>
+    # Two forms on one page:
+    # <%= form_tag "one" %>
+    #   <%= ckeditor_textarea("object", "field", :id => "demo1") %>
+    # <% end %>
+    # ...
+    # <%= form_tag "two" %>
+    #   <%= ckeditor_textarea("object", "field", :id => "demo2") %>
+    # <% end %>
     #
-    #   <%= ckeditor_textarea( "note", "text", :ajax => true ) %>
-    #
-    # <%= end_form_tag %>
     def ckeditor_textarea(object, field, options = {})
       options.symbolize_keys!
       
@@ -21,9 +23,9 @@ module Ckeditor
       value = var.send(field.to_sym) if var
       value ||= options[:value] || ""
       
-      id = ckeditor_element_id(object, field)
+      element_id = options[:id] || ckeditor_element_id(object, field)
       
-      textarea_options = { :id => id }
+      textarea_options = { :id => element_id }
       
       textarea_options[:cols] = options[:cols].nil? ? 70 : options[:cols].to_i
       textarea_options[:rows] = options[:rows].nil? ? 20 : options[:rows].to_i
@@ -50,70 +52,45 @@ module Ckeditor
       
       output_buffer = ActiveSupport::SafeBuffer.new
       
-      if options[:ajax]
-        textarea_options.update(:name => id)
-        
-        output_buffer << tag(:input, { "type" => "hidden", "name" => "#{object}[#{field}]", "id" => "#{id}_hidden"})
-        output_buffer << ActionView::Base::InstanceTag.new(object, field, self, var).to_text_area_tag(textarea_options)
-      else
-        textarea_options.update(:style => "width:#{width};height:#{height}")
+      textarea_options.update(:style => "width:#{width};height:#{height}")
         
-        output_buffer << ActionView::Base::InstanceTag.new(object, field, self, var).to_text_area_tag(textarea_options)
-      end
+      output_buffer << ActionView::Base::InstanceTag.new(object, field, self, var).to_text_area_tag(textarea_options)
       
-      output_buffer << javascript_tag("CKEDITOR.replace('#{object}[#{field}]', { 
+      output_buffer << javascript_tag("CKEDITOR.replace('#{element_id}', { 
           #{ckeditor_applay_options(ckeditor_options)}
         });\n")
         
       output_buffer
     end
-
-    def ckeditor_form_remote_tag(options = {})
-      editors = options[:editors]
-      before = ""
-      editors.keys.each do |e|
-        editors[e].each do |f|
-          before += ckeditor_before_js(e, f)
-        end
-      end
-      options[:before] = options[:before].nil? ? before : before + options[:before]
-      form_remote_tag(options)
-    end
-
-    def ckeditor_remote_form_for(object_name, *args, &proc)
-      options = args.last.is_a?(Hash) ? args.pop : {}
-      concat(ckeditor_form_remote_tag(options), proc.binding)
-      fields_for(object_name, *(args << options), &proc)
-      concat('</form>', proc.binding)
-    end
-    alias_method :ckeditor_form_remote_for, :ckeditor_remote_form_for
-
-    def ckeditor_element_id(object, field)
-      "#{object}_#{field}_editor"
-    end
-
-    def ckeditor_div_id(object, field)
-      id = eval("@#{object}.id")
-      "div-#{object}-#{id}-#{field}-editor"
-    end
-
-    def ckeditor_before_js(object, field)
-      id = ckeditor_element_id(object, field)
-      "var oEditor = CKEDITOR.instances.#{id}.getData();"
+    
+    def ckeditor_ajax_script(backend = 'jquery')
+      javascript_tag("$(document).ready(function(){  
+        $('form[data-remote]').bind('ajax:before', function(){
+          for (instance in CKEDITOR.instances){
+            CKEDITOR.instances[instance].updateElement();
+          }
+        });
+      });")
     end
     
-    def ckeditor_applay_options(options={})
-      str = []
-      options.each do |k, v|
-        value = case v.class.to_s.downcase
-          when 'string' then "'#{v}'"
-          when 'hash' then "{ #{ckeditor_applay_options(v)} }"
-          else v
-        end
-        str << "#{k}: #{value}"
+    protected
+      
+      def ckeditor_element_id(object, field)
+        "#{object}_#{field}_editor"
       end
       
-      str.join(',')
-    end
+      def ckeditor_applay_options(options={})
+        str = []
+        options.each do |k, v|
+          value = case v.class.to_s.downcase
+            when 'string' then "'#{v}'"
+            when 'hash' then "{ #{ckeditor_applay_options(v)} }"
+            else v
+          end
+          str << "#{k}: #{value}"
+        end
+        
+        str.join(',')
+      end
   end
 end