dust-ckeditor 3.5.0

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.rdoc

@@ -0,0 +1,140 @@
+= 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.5 (http://ckeditor.com)
+
+SWFUpload version: 2.2.0.1 Core (http://swfupload.org)
+
+Rails version: 3.0.3
+
+Demo appication (Rails 2.3.8):
+http://github.com/galetahub/rails-ckeditor-demo-app
+
+== Install
+
+=== Rails 3
+
+In your appication "Gemfile":
+
+  gem 'dust-ckeditor', '3.5.0'
+  
+or
+  gem 'dust-ckeditor', :git => 'git://github.com/hificreative/rails-3-ckeditor.git', :branch => 'rails3'
+
+Next step is generate ckeditor js files and configuration file
+Check "config/initializers/ckeditor.rb" for more configuration options:
+
+  rails generate ckeditor:base
+
+Generate ckeditor models for file upload support:
+For paperclip:
+
+  rails generate ckeditor:migration
+
+For attachment_fu:
+
+  rails generate ckeditor:migration --backend=attachment_fu
+
+Don't forget about migration:
+
+  rake db:migarte
+
+== 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', :height=>'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
+  :index        # element id index 
+
+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 %>
+    ...
+    <%= form.submit "Save" %>
+  <% 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/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+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 = "dust-ckeditor"
+    gemspec.version = Ckeditor::Version.dup
+    gemspec.summary = "Rails plugin for integration ckeditor 3.x"
+    gemspec.description = "CKEditor is a WYSIWYG editor to be used inside web pages"
+    gemspec.email = "axcess1@me.com"
+    gemspec.homepage = "http://github.com/hificreative/rails-3-ckeditor"
+    gemspec.authors = ["Ross Nelson"]
+    gemspec.files = FileList["[A-Z]*", "{app,config,lib}/**/*"]
+    
+    gemspec.add_dependency('mime-types', '>= 1.16')
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/app/controllers/ckeditor/attachments_controller.rb

@@ -0,0 +1,28 @@
+class Ckeditor::AttachmentsController < Ckeditor::BaseController
+
+  def index
+    @attachments = Ckeditor.file_model.order("id DESC")
+    respond_with(@attachments)
+  end
+  
+	def edit_files
+		@attachments = Ckeditor.file_model.order("id DESC")
+		respond_with(@attachments)
+	end
+
+  def create
+    @attachment = Ckeditor.file_model.new
+	  respond_with_asset(@attachment)
+  end
+  
+  def destroy
+    @attachment.destroy
+    respond_with(@attachment)
+  end
+  
+  protected
+  
+    def find_asset
+      @attachment = Ckeditor.file_model.find(params[:id])
+    end
+end

data/app/controllers/ckeditor/base_controller.rb

@@ -0,0 +1,60 @@
+class Ckeditor::BaseController < ApplicationController
+  skip_before_filter :verify_authenticity_token, :only => [:create]
+  
+  before_filter :swf_options, :only => [:index, :create]
+  before_filter :find_asset, :only => [:destroy]
+  
+  respond_to :html, :xml, :json
+  
+  layout "ckeditor"
+
+  protected
+    
+    def swf_options
+      @swf_file_post_name = Ckeditor.swf_file_post_name
+      
+      if params[:controller] == 'ckeditor/pictures'
+        @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 respond_with_asset(record)
+      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
+        body = params[:CKEditor].blank? ? record.to_json(:only=>[:id, :type], :methods=>[:url, :content_type, :size, :filename, :format_created_at], :root => "asset") : %Q"<script type='text/javascript'>
+          window.parent.CKEDITOR.tools.callFunction(#{params[:CKEditorFuncNum]}, '#{Ckeditor::Utils.escape_single_quotes(record.url_content)}');
+        </script>"
+        
+        render :text => body
+      else
+        render :nothing => true
+      end
+    end
+end

data/app/controllers/ckeditor/pictures_controller.rb

@@ -0,0 +1,28 @@
+class Ckeditor::PicturesController < Ckeditor::BaseController
+
+  def index
+    @pictures = Ckeditor.image_model.order("id DESC")
+    respond_with(@pictures) 
+  end
+  
+	def edit_images
+    @pictures = Ckeditor.image_model.order("id DESC")
+    respond_with(@pictures)
+	end
+
+  def create
+    @picture = Ckeditor.image_model.new
+	  respond_with_asset(@picture)
+  end
+  
+  def destroy
+    @picture.destroy
+    respond_with(@picture)
+  end
+  
+  protected
+  
+    def find_asset
+      @picture = Ckeditor.image_model.find(params[:id])
+    end
+end

data/app/helpers/ckeditor/base_helper.rb

@@ -0,0 +1,21 @@
+module Ckeditor::BaseHelper
+  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/attachments'
+    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] = Rack::Utils.escape(cookies[session_key])
+    
+    if protect_against_forgery?
+      options[request_forgery_protection_token] = Rack::Utils.escape(form_authenticity_token)
+    end
+    
+    url_for(options)
+  end
+end

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

@@ -0,0 +1,48 @@
+<div class="FCKThumb">
+	<% if controller.action_name == 'edit_images' %>
+		<%= link_to '', "/ckeditor/pictures/#{asset.id}", :class => 'progressCancel remote-delete'%>
+ 
+		<script type="text/javascript" charset="utf-8">
+			$(document).ready(function() {
+			  $('a.remote-delete').click(function() {
+			    // we just need to add the key/value pair for the DELETE method
+			    // as the second argument to the JQuery $.post() call
+
+	            $.post(this.href, { _method: 'delete' }, null, "script");
+							$(this).closest(".FCKThumb").hide();
+
+			    return false;
+			  });
+			});
+		</script>
+	<% elsif controller.action_name == 'edit_files' -%>
+		<%= link_to '', "/ckeditor/attachments/#{asset.id}", :class => 'progressCancel remote-delete'%>
+ 
+		<script type="text/javascript" charset="utf-8">
+			$(document).ready(function() {
+			  $('a.remote-delete').click(function() {
+			    // we just need to add the key/value pair for the DELETE method
+			    // as the second argument to the JQuery $.post() call
+
+	            $.post(this.href, { _method: 'delete' }, null, "script");
+							$(this).closest(".FCKThumb").hide();
+
+			    return false;
+			  });
+			});
+		</script>
+	<% end -%>
+  <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/_swfupload.html.erb

@@ -0,0 +1,51 @@
+<script type="text/javascript">
+		var swfu = null;
+	
+		function init_swfupload() {
+		  var params = editor.config['swf_params'];
+		
+			swfu = new SWFUpload({
+				// Backend settings
+				upload_url: upload_path,
+				post_params: params,
+				file_post_name: "<%= @swf_file_post_name %>",
+
+				// Flash file settings
+				file_size_limit : "<%= @file_size_limit %>",
+				file_types : "<%= @file_types %>",
+				file_types_description : "<%= @file_types_description %>",
+				file_upload_limit : "<%= @file_upload_limit %>",
+				file_queue_limit : 0,
+
+				// The event handler functions are defined in handlers.js
+				//swfupload_loaded_handler : swfUploadLoaded,
+				file_queued_handler : fileQueued,
+				file_queue_error_handler : fileQueueError,
+				file_dialog_complete_handler : fileDialogComplete,
+				upload_start_handler : uploadStart,
+				upload_progress_handler : uploadProgress,
+				upload_error_handler : uploadError,
+				upload_success_handler : uploadSuccess,
+				upload_complete_handler : uploadComplete,
+				queue_complete_handler : queueComplete,	// Queue plugin event
+
+				// Button Settings
+				button_image_url : "/javascripts/ckeditor/images/select_files.png",
+				button_placeholder_id : "spanButtonPlaceholder",
+				button_width: 117,
+				button_height: 29,
+				button_window_mode: SWFUpload.WINDOW_MODE.TRANSPARENT,
+				button_cursor: SWFUpload.CURSOR.HAND,
+				
+				// Flash Settings
+				flash_url : "/javascripts/ckeditor/swfupload/swfupload.swf",
+
+				custom_settings : { 
+					progressTarget : "divFileProgressContainer"
+				},
+				
+				// Debug settings
+				debug: false
+			});
+		};
+</script>