ckeditor 4.0.4 → 4.0.6

data/README.md

@@ -0,0 +1,192 @@
+# Ckeditor
+
+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. 
+[ckeditor.com](http://ckeditor.com/)
+
+## Features
+
+* Ckeditor version 4.2 (full)
+* Rails 4 integration
+* Files browser
+* HTML5 files uploader
+* Hooks for formtastic and simple_form forms generators
+
+## Installation
+
+For basic usage just include ckeditor gem:
+
+```
+gem "ckeditor"
+```
+
+For files uploading support you need generage models for file storage.
+Currently supported next backends:
+
+* ActiveRecord (paperclip, carrierwave, dragonfly)
+* Mongoid (paperclip, carrierwave, dragonfly)
+
+### How generate models for store uploading files
+
+#### ActiveRecord + paperclip
+
+For active_record orm is used paperclip gem (it's by default).
+
+```
+gem "paperclip"
+
+rails generate ckeditor:install --orm=active_record --backend=paperclip
+```
+  
+#### ActiveRecord + carrierwave
+
+```
+gem "carrierwave"
+gem "mini_magick"
+
+rails generate ckeditor:install --orm=active_record --backend=carrierwave
+```
+
+#### Mongoid + paperclip
+
+```
+gem 'mongoid-paperclip', :require => 'mongoid_paperclip'
+
+rails generate ckeditor:install --orm=mongoid --backend=paperclip
+```
+
+#### Mongoid + carrierwave
+
+```
+gem "carrierwave-mongoid", :require => 'carrierwave/mongoid'
+gem "mini_magick"
+
+rails generate ckeditor:install --orm=mongoid --backend=carrierwave
+```
+
+#### Load generated models
+
+All ckeditor models will be generated into app/models/ckeditor folder.
+Autoload ckeditor models folder (application.rb):
+
+```ruby
+config.autoload_paths += %W(#{config.root}/app/models/ckeditor)
+```
+
+Mount engine in your routes (config/routes.rb):
+
+```ruby
+mount Ckeditor::Engine => "/ckeditor"
+```
+
+## Usage
+
+Include ckeditor javascripts rails 3.2 (application.js):
+
+```
+//= require ckeditor/init
+```
+
+Form helpers:
+
+```erb
+<%= 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, :cols => 40, :ckeditor => {:uiColor => "#AADC6E", :toolbar => "mini"} %>
+  ...
+<% end -%>
+```
+
+All ckeditor 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
+```
+
+### AJAX
+
+jQuery sample:
+
+```html
+<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>
+```
+
+### Formtastic integration
+
+```erb
+<%= form.input :content, :as => :ckeditor %>
+<%= form.input :content, :as => :ckeditor, :input_html => { :ckeditor => { :height => 400 } } %>
+```
+
+### SimpleForm integration
+
+```erb
+<%= form.input :content, :as => :ckeditor, :input_html => { :ckeditor => {:toolbar => 'Full'} } %>
+```
+
+### CanCan integration
+
+To use cancan with Ckeditor, add this to an initializer.
+
+```ruby
+# in config/initializers/ckeditor.rb
+
+Ckeditor.setup do |config|
+  config.authorize_with :cancan
+end
+```
+
+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
+
+```ruby
+# 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
+
+```yml
+en:
+  ckeditor:
+    page_title: "CKEditor Files Manager"
+    confirm_delete: "Delete file?"
+    buttons:
+      cancel: "Cancel"
+      upload: "Upload"
+      delete: "Delete"
+```
+
+## Tests
+
+```bash
+$> rake test
+$> rake test CKEDITOR_ORM=mongoid
+$> rake test CKEDITOR_BACKEND=carrierwave
+  
+$> rake test:controllers
+$> rake test:generators
+$> rake test:integration
+$> rake test:models
+```
+
+This project rocks and uses MIT-LICENSE.

data/app/assets/javascripts/ckeditor/init.js.erb

@@ -6,3 +6,11 @@
     window['CKEDITOR_BASEPATH'] = "<%= config.relative_url_root %>/assets/ckeditor/";
   }
 }).call(this);
+
+function ck_load() {
+  $('.ckeditor').each(function(){
+    CKEDITOR.replace( $(this).attr('name') );
+  });
+}
+
+$(document).on('page:load', ck_load);

data/app/helpers/ckeditor/application_helper.rb

@@ -0,0 +1,11 @@
+module Ckeditor::ApplicationHelper
+  def assets_pipeline_enabled?
+    if Gem::Version.new(::Rails.version.to_s) >= Gem::Version.new('4.0.0')
+      defined?(Sprockets::Rails)
+    elsif Gem::Version.new(::Rails.version.to_s) >= Gem::Version.new('3.0.0')
+      Rails.application.config.assets.enabled
+    else
+      false
+    end
+  end
+end

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

@@ -3,29 +3,29 @@
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   <meta name="robots" content="noindex, nofollow">
-	<%= csrf_meta_tag %>
-	<%= tag(:meta, :name => "ckeditor-path", :content => Ckeditor.relative_path) %>
+  <%= csrf_meta_tag %>
+  <%= tag(:meta, :name => "ckeditor-path", :content => Ckeditor.relative_path) %>
   <title><%= I18n.t('page_title', :scope => [:ckeditor]) %></title>
-  
-  <% if Rails.application.config.assets.enabled %>
-      <%= stylesheet_link_tag "ckeditor/application" %>
-      <%= javascript_include_tag "ckeditor/application" %>
-  <% else %>
-     <link href="/javascripts/ckeditor/filebrowser/stylesheets/uploader.css" type="text/css" rel="stylesheet">
-      <% ["jquery.js", "jquery.tmpl.js", "fileuploader.js", "rails.js", "application.js"].each do |js| %>
-          <script src="/javascripts/ckeditor/filebrowser/javascripts/<%= js %>" type="text/javascript"></script>
-      <% end %>
-  <% end %>
+
+  <% if assets_pipeline_enabled? -%>
+    <%= stylesheet_link_tag "ckeditor/application" %>
+    <%= javascript_include_tag "ckeditor/application" %>
+  <% else -%>
+    <link href="/javascripts/ckeditor/filebrowser/stylesheets/uploader.css" type="text/css" rel="stylesheet">
+    <% ["jquery.js", "jquery.tmpl.js", "fileuploader.js", "rails.js", "application.js"].each do |js| -%>
+      <script src="/javascripts/ckeditor/filebrowser/javascripts/<%= js %>" type="text/javascript"></script>
+    <% end -%>
+  <% end -%>
   
   <script type="text/javascript">
     var CKEditorFuncNum = $.QueryString["CKEditorFuncNum"];
-	  var CKEditorName = $.QueryString["CKEditor"];
-	  var CKEDITOR = window.opener.CKEDITOR;
-	  var EDITOR = CKEDITOR.instances[CKEditorName];
+    var CKEditorName = $.QueryString["CKEditor"];
+    var CKEDITOR = window.opener.CKEDITOR;
+    var EDITOR = CKEDITOR.instances[CKEditorName];
   </script>
 </head>
 <body>
-	<%= yield %>
-	<%= render :partial => 'ckeditor/shared/asset_tmpl' %>
+  <%= yield %>
+  <%= render :partial => 'ckeditor/shared/asset_tmpl' %>
 </body>
 </html>

data/config/locales/hu.ckeditor.yml

@@ -0,0 +1,8 @@
+hu:
+  ckeditor:
+    page_title: "CKEditor fájlkezelő"
+    confirm_delete: "Biztosan töröljük a fájlt?"
+    buttons:
+      cancel: "Mégsem"
+      upload: "Feltöltés"
+      delete: "Törlés"

data/config/locales/pt-PT.ckeditor.yml

@@ -0,0 +1,8 @@
+"pt-PT":
+  ckeditor:
+    page_title: "Gestor de arquivos do CKEditor"
+    confirm_delete: "Apagar arquivo?"
+    buttons:
+      cancel: "Cancelar"
+      upload: "Enviar"
+      delete: "Apagar"

data/lib/ckeditor.rb

@@ -4,6 +4,7 @@ require 'pathname'
 module Ckeditor
   autoload :Utils, 'ckeditor/utils'
   autoload :Http, 'ckeditor/http'
+  autoload :TextArea, 'ckeditor/text_area'
   
   module Helpers
     autoload :ViewHelper, 'ckeditor/helpers/view_helper'

data/lib/ckeditor/helpers/controllers.rb

@@ -14,7 +14,7 @@ module Ckeditor
         end
         
         def ckeditor_before_create_asset(asset)
-          asset.assetable = ckeditor_current_user
+          asset.assetable = ckeditor_current_user  if respond_to?(:current_user)
           return true
         end
         

data/lib/ckeditor/helpers/form_helper.rb

@@ -3,20 +3,8 @@ module Ckeditor
     module FormHelper
       extend ActiveSupport::Concern
       
-      include ActionView::Helpers::TagHelper
-      include ActionView::Helpers::JavaScriptHelper
-      
       def cktext_area(object_name, method, options = {})
-        options = (options || {}).stringify_keys
-        ck_options = (options.delete('ckeditor') || {}).stringify_keys
-        
-        instance_tag = ActionView::Base::InstanceTag.new(object_name, method, self, options.delete('object'))
-        instance_tag.send(:add_default_name_and_id, options) if options['id'].blank?
-        
-        output_buffer = ActiveSupport::SafeBuffer.new
-        output_buffer << instance_tag.to_text_area_tag(options)
-        output_buffer << javascript_tag(Utils.js_replace(options['id'], ck_options))
-        output_buffer
+        TextArea.new(self, options).render_instance_tag(object_name, method)
       end
     end
   end

data/lib/ckeditor/helpers/view_helper.rb

@@ -4,18 +4,7 @@ module Ckeditor
       extend ActiveSupport::Concern
       
       def cktext_area_tag(name, content = nil, options = {})
-        element_id = sanitize_to_id(options[:id] || name)
-        options = { :language => I18n.locale.to_s }.merge(options)
-        input_html = { :id => element_id }.merge( options.delete(:input_html) || {} )
-        js_content_for_section = options.delete(:js_content_for)
-        
-        output_buffer = ActiveSupport::SafeBuffer.new
-        output_buffer << text_area_tag(name, content, input_html)
-        
-        js = Utils.js_replace(element_id, options)
-        
-        output_buffer << (js_content_for_section ? content_for(js_content_for_section, js) : javascript_tag(js))
-        output_buffer
+        TextArea.new(self, options).render_tag(name, content)
       end
     end
   end

data/lib/ckeditor/hooks/cancan.rb

@@ -19,7 +19,7 @@ module Ckeditor
       # action as a symbol (:create, :destroy, etc.). The second argument is the actual model
       # instance if it is available.
       def authorize(action, model_object = nil)
-        @controller.current_ability.authorize!(action.to_sym, model_object) if action
+        @controller.authorize!(action.to_sym, model_object) if action
       end
 
       # This method is called primarily from the view to determine whether the given user
@@ -43,4 +43,4 @@ module Ckeditor
   end
 end
 
-Ckeditor::AUTHORIZATION_ADAPTERS[:cancan] = Ckeditor::Hooks::CanCanAuthorization
+Ckeditor::AUTHORIZATION_ADAPTERS[:cancan] = Ckeditor::Hooks::CanCanAuthorization

data/lib/ckeditor/http.rb

@@ -46,6 +46,7 @@ module Ckeditor
         @request = request
         
         super Digest::SHA1.hexdigest(filename), tmpdir
+        binmode
         fetch
       end
      

data/lib/ckeditor/text_area.rb

@@ -0,0 +1,52 @@
+require 'active_support'
+require 'action_view/helpers/tag_helper'
+require 'action_view/helpers/form_tag_helper'
+
+module Ckeditor
+  class TextArea
+    include ActionView::Helpers::TagHelper
+    include ActionView::Helpers::FormTagHelper
+    include ActionView::Helpers::JavaScriptHelper
+
+    attr_reader :template, :options, :ck_options
+
+    def initialize(template, options)
+      @template = template
+      @options = options.stringify_keys
+      @ck_options = (@options.delete('ckeditor') || {}).stringify_keys
+    end
+
+    def render_instance_tag(object_name, method)
+      tag = build_tag(object_name, method)
+      tag.send(:add_default_name_and_id, options) if options['id'].blank?
+
+      render tag.respond_to?(:to_text_area_tag) ? tag.to_text_area_tag(options) : tag.render
+    end
+
+    def render_tag(name, content)
+      options['id'] = sanitize_to_id(options['id'] || name)
+
+      render text_area_tag(name, content, options)
+    end
+
+    protected
+
+      def render(input)
+        output_buffer << input
+        output_buffer << javascript_tag(Utils.js_replace(options['id'], ck_options))
+        output_buffer
+      end
+
+      def output_buffer
+        @output_buffer ||= ActiveSupport::SafeBuffer.new
+      end
+
+      def build_tag(object_name, method)
+        if defined?(ActionView::Base::Tags::TextArea)
+          ActionView::Base::Tags::TextArea.new(object_name, method, template, options.symbolize_keys)
+        else
+          ActionView::Base::InstanceTag.new(object_name, method, template, options.delete('object'))
+        end
+      end
+  end
+end

data/lib/ckeditor/version.rb

@@ -1,6 +1,6 @@
 module Ckeditor
   module Version
-    GEM = "4.0.4".freeze
-    EDITOR = "4.1.0".freeze
+    GEM = "4.0.6".freeze
+    EDITOR = "4.2".freeze
   end
 end

data/lib/generators/ckeditor/templates/ckeditor.rb

@@ -1,21 +1,19 @@
 # Use this hook to configure ckeditor
-if Object.const_defined?("Ckeditor")
-  Ckeditor.setup do |config|
-    # ==> ORM configuration
-    # Load and configure the ORM. Supports :active_record (default), :mongo_mapper and
-    # :mongoid (bson_ext recommended) by default. Other ORMs may be
-    # available as additional gems.
-    require "ckeditor/orm/<%= options[:orm] %>"
+Ckeditor.setup do |config|
+  # ==> ORM configuration
+  # Load and configure the ORM. Supports :active_record (default), :mongo_mapper and
+  # :mongoid (bson_ext recommended) by default. Other ORMs may be
+  # available as additional gems.
+  require "ckeditor/orm/<%= options[:orm] %>"
 
-    # Allowed image file types for upload.
-    # Set to nil or [] (empty array) for all file types
-    # config.image_file_types = ["jpg", "jpeg", "png", "gif", "tiff"]
+  # Allowed image file types for upload.
+  # Set to nil or [] (empty array) for all file types
+  # config.image_file_types = ["jpg", "jpeg", "png", "gif", "tiff"]
 
-    # Allowed attachment file types for upload.
-    # Set to nil or [] (empty array) for all file types
-    # config.attachment_file_types = ["doc", "docx", "xls", "odt", "ods", "pdf", "rar", "zip", "tar", "swf"]
+  # Allowed attachment file types for upload.
+  # Set to nil or [] (empty array) for all file types
+  # config.attachment_file_types = ["doc", "docx", "xls", "odt", "ods", "pdf", "rar", "zip", "tar", "swf"]
 
-    # Setup authorization to be run as a before filter
-    # config.authorize_with :cancan
-  end
+  # Setup authorization to be run as a before filter
+  # config.authorize_with :cancan
 end