ckeditor 3.2.1

data/CHANGELOG

@@ -0,0 +1,15 @@
+0.9.0 - Replaced FCKeditor with CKEditor
+
+0.8.1 - Remove plugin files on uninstall
+
+0.8.0 - Added uninstall rake task
+
+0.8.0 - Refactoring for fckeditor controller
+
+0.8.0 - Added Easy upload plugin http://martinezdelizarrondo.com/easyupload/
+
+0.8.0 - Change for works with FCKeditor 2.6.3
+
+0.2.2 - Added fckeditor_form_remote_tag helper to allow multiple editors in a single form
+
+0.2.1 - Added spell check from Ken Pratt

data/README.textile

@@ -0,0 +1,225 @@
+h1. 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
+SWFUpload version: 2.2.0
+Rails version: 2.3.x
+
+"ckeditor.com":http://ckeditor.com/
+"swfupload.org":http://swfupload.org/
+
+Demo appication:
+"rails-ckeditor-demo-app":http://github.com/galetahub/rails-ckeditor-demo-app
+
+h2. Install
+
+h3. Rails 3.0
+
+@gem install ckeditor@
+
+In "Gemfile":
+@gem 'ckeditor', '3.2.1'@
+
+@rails generate ckeditor [options]@
+
+Runtime options:
+  -f, [--force]    # Overwrite files that already exist
+  -p, [--pretend]  # Run but do not make any changes
+  -q, [--quiet]    # Supress status output
+  -s, [--skip]     # Skip files that already exist
+
+Check @config/initializers/ckeditor.rb@ for more configuration options
+
+h3. Rails 2.x
+
+@./script/plugin install git://github.com/galetahub/rails-ckeditor.git@
+
+@rake ckeditor:install@
+
+@rake ckeditor:config@
+
+Last rake generated file config/ckeditor.yml:
+
+For attachment_fu: @swf_file_post_name: "uploaded_data"@
+
+h2. Usage
+
+Basically include this in the page you wish to use the editor in
+<pre><code>
+  <%= javascript_include_tag :ckeditor %>
+</code></pre>
+
+Then instead of the normal textarea helper from Rails use this one
+<pre><code>
+  <%= ckeditor_textarea("object", "field", :width => '100%', :height => '200px') %>
+</code></pre>
+
+FormBuilder helper for more usefully 
+
+<pre><code>  
+  <%= form_for :page, :url => pages_path 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 -%>
+</code></pre>
+  
+h3. Support options
+<pre><code> 
+  :cols    # Textarea cols
+  :rows    # Textarea rows
+  :width   # Editor width
+  :height  # Editor height
+  :class   # Textarea css class name
+  :toolbar # Toolbar name
+  :skin    # Editor skin
+  :language # Editor language
+  :swf_params # SWFUpload additional params
+</code></pre>
+
+Check @public/javascripts/ckeditor/config.js@ for config default options.
+Modify @public/javascripts/ckeditor/contents.css@ - this stylesheet use editor
+
+h3. AJAX
+
+To use a remote form you need to do something like this
+<pre><code>
+  <%= form_remote_tag :url => @options.merge(:controller => @scaffold_controller),
+                    :before => Ckeditor_before_js('note', 'text') %>
+
+    <%= ckeditor_textarea( "note", "text", :ajax => true ) %>
+
+  <%= end_form_tag %>
+</code></pre>
+
+If you forget to put in the :before it won't work, you can also use the Ckeditor_form_remote_tag described below
+
+h3. Multiple Editors in a form
+
+To create a form using multiple editors use the Ckeditor_form_remote_tag helper and pass the :editors option. This takes an hash of model symbol keys with each having
+an array as its value. The array should contain the list of fields that will have editors attached to them.
+<pre><code>
+  <%= ckeditor_form_remote_tag :url => @options.merge(:controller => @scaffold_controller),
+                              :editors => { :multinote => ['text1', 'text2'] } %>
+
+    <%= ckeditor_textarea( "multinote", "text1", :ajax => true ) %>
+    <%= ckeditor_textarea( "multinote", "text2", :ajax => true ) %>
+
+  <%= end_form_tag %>
+</code></pre>
+
+h3. 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":http://github.com/thoughtbot/paperclip
+
+For S3 storage look at @../rails-ckeditor/examples/s3@
+
+For paperclip:
+ActiveRecord model Asset (asset.rb):
+<pre><code>
+class Asset < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :assetable, :polymorphic => true
+
+  def url(*args)
+    data.url(*args)
+  end
+  alias :public_filename :url
+
+  def filename
+    data_file_name
+  end
+  
+  def content_type
+    data_content_type
+  end
+  
+  def size
+    data_file_size
+  end
+  
+  def path
+    data.path
+  end
+  
+  def styles
+    data.styles
+  end
+  
+  def format_created_at
+    I18n.l(self.created_at, :format=>"%d.%m.%Y %H:%M")
+  end
+  
+  def to_xml(options = {})
+    xml = options[:builder] ||= Builder::XmlMarkup.new(:indent => options[:indent])
+
+    xml.tag!(self.type.to_s.downcase) do
+      xml.filename{ xml.cdata!(self.filename) }
+      xml.size self.size
+      xml.path{ xml.cdata!(self.url) }
+      
+      xml.styles do
+        self.styles.each do |style|
+          xml.tag!(style.first, self.url(style.first))
+        end
+      end unless self.styles.empty?
+    end
+  end
+end
+</pre></code>
+
+ActiveRecord model AttachmentFile (attachment_file.rb):
+<pre><code>
+class AttachmentFile < Asset
+  has_attached_file :data,
+                    :url => "/assets/attachments/:id/:filename",
+                    :path => ":rails_root/public/assets/attachments/:id/:filename"
+
+  validates_attachment_size :data, :less_than => 10.megabytes
+end
+</pre></code>
+
+ActiveRecord model Picture (picture.rb):
+<pre><code>
+class Picture < Asset
+  has_attached_file :data,
+                    :url  => "/assets/pictures/:id/:style_:basename.:extension",
+                    :path => ":rails_root/public/assets/pictures/:id/:style_:basename.:extension",
+	            :styles => { :content => '575>', :thumb => '100x100' }
+	
+  validates_attachment_size :data, :less_than => 2.megabytes
+  
+  def url_content
+    url(:content)
+  end
+  
+  def url_thumb
+    url(:thumb)
+  end
+  
+  def to_json(options = {})
+    options[:methods] ||= []
+    options[:methods] << :url_content
+    options[:methods] << :url_thumb
+    super options
+  end
+end
+</code></pre>
+
+More info in @../rails-ckeditor/examples/models@. 
+Do not forget about migration @../rails-ckeditor/examples/migrations@.
+
+h2. TODOs
+
+1. Add support for choose filemanager storage
+2. More integration upload system

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require File.join(File.dirname(__FILE__), 'lib', 'ckeditor', 'version')
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the rails-ckeditor plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the rails-ckeditor plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Rails Ckeditor'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.textile')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "ckeditor"
+    gemspec.version = Ckeditor::Version.dup
+    gemspec.summary = "Rails plugin for integration ckeditor 3.x"
+    gemspec.description = "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."
+    gemspec.email = "galeta.igor@gmail.com"
+    gemspec.homepage = "http://github.com/galetahub/rails-ckeditor"
+    gemspec.authors = ["Igor Galeta"]
+    gemspec.files = FileList["[A-Z]*", "{app,config,lib}/**/*"]
+    gemspec.rubyforge_project = "ckeditor"
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/TODO

@@ -0,0 +1,3 @@
+# Select different file upload process (currently is only swfupload)
+# Select file storage
+# Add more config options

data/app/controllers/ckeditor_controller.rb

@@ -0,0 +1,87 @@
+class CkeditorController < ApplicationController
+  before_filter :swf_options, :only => [:images, :files, :create]
+  layout "ckeditor"
+  
+  # GET /ckeditor/images
+  def images
+    @images = Picture.find(:all, :order=>"id DESC")
+    
+    respond_to do |format|
+      format.html {}
+      format.xml { render :xml=>@images }
+    end
+  end
+  
+  # GET /ckeditor/files
+  def files
+    @files = AttachmentFile.find(:all, :order=>"id DESC")
+    
+    respond_to do |format|
+      format.html {}
+      format.xml { render :xml=>@files }
+    end
+  end
+  
+  # POST /ckeditor/create/:kind
+  def create
+    @kind = params[:kind] || 'file'
+    
+    @record = case @kind.downcase
+      when 'file'  then AttachmentFile.new
+			when 'image' then Picture.new
+	  end
+	  
+	  unless params[:CKEditor].blank?	  
+	    params[@swf_file_post_name] = params.delete(:upload)
+	  end
+	  
+	  options = {}
+	  
+	  params.each do |k, v|
+	    key = k.to_s.downcase
+	    options[key] = v if @record.respond_to?("#{key}=")
+	  end
+    
+    @record.attributes = options
+    @record.user ||= current_user if respond_to?(:current_user)
+    
+    if @record.valid? && @record.save
+      @text = params[:CKEditor].blank? ? @record.to_json(:only=>[:id, :type], :methods=>[:url, :content_type, :size, :filename, :format_created_at]) : %Q"<script type='text/javascript'>
+        window.parent.CKEDITOR.tools.callFunction(#{params[:CKEditorFuncNum]}, '#{escape_single_quotes(@record.url(:content))}');
+      </script>"
+      
+      render :text => @text
+    else
+      render :nothing => true
+    end
+  end
+
+  private
+    
+    def swf_options
+      @swf_file_post_name = Ckeditor.swf_file_post_name
+      
+      if params[:action] == 'images'
+        @file_size_limit        = Ckeditor.swf_image_file_size_limit
+			  @file_types             = Ckeditor.swf_image_file_types
+			  @file_types_description = Ckeditor.swf_image_file_types_description
+			  @file_upload_limit      = Ckeditor.swf_image_file_upload_limit
+		  else
+		    @file_size_limit        = Ckeditor.swf_file_size_limit
+		    @file_types             = Ckeditor.swf_file_types
+		    @file_types_description = Ckeditor.swf_file_types_description
+		    @file_upload_limit      = Ckeditor.swf_file_upload_limit
+		  end
+      
+      @swf_file_post_name ||= 'data'
+      @file_size_limit ||= "5 MB"
+      @file_types ||= "*.jpg;*.jpeg;*.png;*.gif"
+      @file_types_description ||= "Images"
+      @file_upload_limit ||= 10
+    end
+    
+    def escape_single_quotes(str)
+      str.gsub('\\','\0\0').gsub('</','<\/').gsub(/\r\n|\n|\r/, "\\n").gsub(/["']/) { |m| "\\#{m}" }
+    end
+  
+end

data/app/helpers/ckeditor_helper.rb

@@ -0,0 +1,37 @@
+module CkeditorHelper
+  def ckeditor_attachment_path(kind)
+    path = case kind
+      when :image then Ckeditor.file_manager_image_upload_uri
+      when :file  then Ckeditor.file_manager_upload_uri
+      else '/ckeditor/create/default'
+    end
+    
+    session_key = Rails.application.config.send(:session_options)[:key]
+    
+    options = Rails.application.routes.recognize_path(path, :method => :post)
+    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)
+    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/_file.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">
+          <%= file_image_tag(file.filename, file.url) %>
+        </td>
+       </tr>
+     </tbody>
+   </table>
+   
+   <div class="FCKFileName"><%= file.filename %></div>
+   <div class="FCKFileDate"><%= file.format_created_at %></div>
+   <div class="FCKFileSize"><%= number_to_human_size(file.size, :precision => 2) %></div>
+</div>

data/app/views/ckeditor/_image.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(image.url(:thumb), :alt=>image.url(:content), :title=>image.filename, :onerror=>"this.src='/javascripts/ckeditor/images/ckfnothumb.gif'", :class=>'image' ) %>
+        </td>
+       </tr>
+     </tbody>
+   </table>
+   
+   <div class="FCKFileName"><%= image.filename %></div>
+   <div class="FCKFileDate"><%= image.format_created_at %></div>
+   <div class="FCKFileSize"><%= number_to_human_size(image.size, :precision => 2) %></div>
+</div>