ckeditor 3.5.4 → 3.6.0.pre

data/Gemfile

@@ -0,0 +1,23 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "rails", "3.0.9"
+
+platforms :ruby do
+  gem "mysql2", '0.2.11'
+    
+  group :development, :test do
+    gem "capybara", ">= 0.4.0"
+    gem "redgreen", "~> 1.2.2"
+    gem "paperclip", "~> 2.3.12"
+    
+    # To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+    # gem 'ruby-debug'
+    # gem 'ruby-debug19'
+  end
+  
+  group :development do
+    gem "mongrel"
+  end
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 AIMBULANCE
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -1,89 +1,59 @@
-= Rails CKEditor integration plugin with SWFUpload support
+= 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.
 
-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.
+== Features
 
-CKEditor version: any (http://ckeditor.com/download/releases)
+* Rails 3 integration
+* Files browser
+* HTML5 files uploader
+* Hooks for formtastic and simple_form forms generators
+* Extra plugins: attachment and embed.
+* Assets pagination (under construction)
 
-SWFUpload version: 2.2.0.1 Core (http://swfupload.org)
+== Install (not currently available, under construction)
 
-Rails version: 3.x
-
-Demo appication (Rails 2.3.8):
-http://github.com/galetahub/rails-ckeditor-demo-app
-
-Demo appication (Rails 3.x):
-http://github.com/galetahub/ckeditor-demo-app
-
-== Install
-
-=== Rails 3
-
-In your appication "Gemfile":
-
-  gem 'ckeditor'
+  gem "ckeditor", "~> 3.6.0"
   
-or
-  gem 'ckeditor', :git => 'git://github.com/galetahub/rails-ckeditor.git', :branch => 'rails3'
+  rails generate ckeditor:install
 
-Next step is download ckeditor core files and generate configuration file
-Check "config/initializers/ckeditor.rb" for more configuration options:
+You can pass version of ckeditor to download (http://ckeditor.com/download/releases):
 
-  rails generate ckeditor:base
+  rails generate ckeditor:install --version=3.5.4
 
-You can pass version of ckeditor to download (http://ckeditor.com/download/releases):
+Now generate models for store uploading files:
 
-  rails generate ckeditor:base --version=3.5.4
+  rails generate ckeditor:models --orm=active_record
 
-Generate ckeditor models for file upload support:
-For paperclip:
+Available orms:
+* active_record
+* mongo_mapper (under construction)
+* mongoid (under construction)
 
-  rails generate ckeditor:migration
+Autoload ckeditor models folder (application.rb):
 
-For attachment_fu:
+  config.autoload_paths += %W(#{config.root}/app/models/ckeditor)
 
-  rails generate ckeditor:migration --backend=attachment_fu
+=== Dependencies
 
-Don't forget about migration:
+For active_record orm is used paperclip gem (it's by default).
 
-  rake db:migrate
+  gem "paperclip"
+  
+For gem "carrierwave" shortly I will give an example.
 
 == Usage
 
-Basically include this in the page you wish to use the editor in:
-
   <%= javascript_include_tag :ckeditor %>
+  
+  cktext_area_tag("test_area", "Ckeditor is the best")
 
-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 -%>
+  cktext_area_tag("content", "Ckeditor", :input_html => {:cols => 10, :rows => 20}, :toolbar => 'Easy')
   
-=== 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 
+* input_html - Options for text_area tag, others for ckeditor javascript configuration.
+* language - appends automatically, by default is I18n.locale
+* available ckeditor options - http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html
 
 For configure ckeditor default options check:
 
@@ -92,22 +62,21 @@ For configure ckeditor default options check:
 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:
+FormBuilder helper for more usefully:
 
-  <%= form_for @page, :remote => true do |form| -%>
-    <%= form.cktext_area("note", "content") %>
+  <%= form_for @page do |form| -%>
     ...
-    <%= form.cktext_area("note", "about") %>
+    <%= form.cktext_area :notes, :toolbar => 'Full', :width => 800, :height => 400 %>
     ...
-    <%= ckeditor_ajax_script %>
+    <%= form.cktext_area :content, :input_html => { :value => "Default value" } %>
     ...
-    <%= form.submit "Save" %>
-  <% end %>
+    <%= cktext_area :page, :info %>
+  <% end -%>
+
+=== AJAX
 
-Helper "ckeditor_ajax_script" generate next script (jquery):
+Jquery sample:
 
   <script type='text/javascript' charset='UTF-8'>
     $(document).ready(function(){  
@@ -119,46 +88,76 @@ Helper "ckeditor_ajax_script" generate next script (jquery):
     });
   </script>
 
-== File uploads
+=== Formtastic integration
 
-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
+  <%= form.input :content, :as => :ckeditor %>
+  <%= form.input :content, :as => :ckeditor, :input_html => { :height => 400 } %>
 
-For S3 storage look at "../ckeditor/examples/s3"
+=== SimpleForm integration
 
-== Formtastic integration
+  <%= form.ckeditor :content, :label => false, :input_html => { :toolbar => 'Full' } %>
 
-  <%= form.input :content, :as => :ckeditor %>
-  <%= form.input :content, :as => :ckeditor, :input_html => { :height => 400, :swf_params => { ... } } %>
+=== Default scope
 
-== SimpleForm integration
+For example, you need split assets collection for each user.
 
-  <%= form.ckeditor :content, :label => false, :input_html => { :height => 400, :toolbar=>'Full' } %>
+  class ApplicationController < ActionController::Base
+  
+    protected
+      
+      def ckeditor_filebrowser_scope(options = {})
+        super { :assetable_id => current_user.id, :assetable_type => 'User' }.merge(options)
+      end
+  end
+  
+If your wont 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:
 
-== Middleware
+  class ApplicationController < ActionController::Base
+  
+    protected
 
-Ckeditor appends middleware ("Ckeditor::Middleware") before session store to 
-support swf upload with AuthenticityToken.
+      def ckeditor_pictures_scope(options = {})
+        ckeditor_filebrowser_scope(options)
+      end
+          
+      def ckeditor_attachment_files_scope(options = {})
+        ckeditor_filebrowser_scope(options)
+      end
+  end
 
-  rake middleware
+=== Callbacks
 
-== I18n
+  class ApplicationController < ActionController::Base
+  
+    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
+
+
+== I18n  
 
   en:
     ckeditor:
       page_title: "CKEditor Files Manager"
-      upload_files: "Upload New Files"
+      confirm_delete: "Delete file?"
       buttons:
         cancel: "Cancel"
-        refresh:
-          title: "Refresh"
-          hint: "Refresh page"
-        upload:
-          title: "Upload"
-          hint: "Upload New File"
+        upload: "Upload"
+        delete: "Delete"
+
+== Tests
 
-== TODOs
+  rake test
 
-1. HTML5 File uploads
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -1,46 +1,29 @@
-# encoding: utf-8
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
 require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require File.join(File.dirname(__FILE__), 'lib', 'ckeditor', 'version')
+require 'rdoc/task'
 
-desc 'Default: run unit tests.'
-task :default => :test
+require 'rake/testtask'
 
-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
+  t.verbose = false
 end
 
-desc 'Generate documentation for the rails-ckeditor plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
+task :default => :test
+
+RDoc::Task.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Rails Ckeditor'
+  rdoc.title    = 'Ckeditor'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.textile')
+  rdoc.rdoc_files.include('README.rdoc')
   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 WYSIWYG editor to be used inside web pages"
-    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"
-    
-    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/attachment_files_controller.rb

@@ -1,23 +1,23 @@
 class Ckeditor::AttachmentFilesController < Ckeditor::BaseController
 
   def index
-    @attachments = Ckeditor.file_model.order("id DESC")
+    @attachments = Ckeditor.attachment_file_model.find_all(ckeditor_attachment_files_scope)
     respond_with(@attachments)
   end
   
   def create
-    @attachment = Ckeditor.file_model.new
+    @attachment = Ckeditor::AttachmentFile.new
 	  respond_with_asset(@attachment)
   end
   
   def destroy
     @attachment.destroy
-    respond_with(@attachment, :location => ckeditor_attachments_path)
+    respond_with(@attachment, :location => ckeditor_attachment_files_path)
   end
   
   protected
   
     def find_asset
-      @attachment = Ckeditor.file_model.find(params[:id])
+      @attachment = Ckeditor.attachment_file_model.get!(params[:id])
     end
 end

data/app/controllers/ckeditor/base_controller.rb

@@ -1,55 +1,28 @@
 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, :json
-  
   layout "ckeditor"
+  
+  before_filter :set_locale
+  before_filter :find_asset, :only => [:destroy]
+  before_filter :ckeditor_authenticate
 
   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
+    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(record)
-      unless params[:CKEditor].blank?	  
-	      params[@swf_file_post_name] = params.delete(:upload)
-	    end
+    def respond_with_asset(asset)
+      file = params[:CKEditor].blank? ? params[:qqfile] : params[:upload]
+	    asset.data = Ckeditor::Http.normalize_param(file, request)
 	    
-	    options = {}
+	    callback = ckeditor_before_create_asset(asset)
 	    
-	    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)}');
+      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)}');
         </script>"
         
         render :text => body