rails_kindeditor 0.3.20 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66ce0b82bd4863150a143d291636ef6267e039c7
-  data.tar.gz: cbd50c7c0129e8c60526bdd77250ca7c4171aeed
+  metadata.gz: 1a331d5aea83a1d33f5ed64b196994908278ec25
+  data.tar.gz: 2f16cd3b105895b10c7f068e7f229f45774619e4
 SHA512:
-  metadata.gz: b5c25553dc71eaee18a1b7c4d11c1411110d624c90b15525aae0ffe3c5171ba563cf63c2e29d37123a23e906b1f1de5236fcb724ad511963dbc2f17384fa66eb
-  data.tar.gz: 302641a3e917f8d38dc8964a8cb016f6cc30b5a2405a543b2ca97eac495a1f2467abb4191458ec8dbd48b5a3cfbeec8587b9e5f0b4c8d0f59966d6751d513a0b
+  metadata.gz: 65dffa2931494481a74d4dde52049510da0ae71ca2a0343f77aee4c33d7e0f9478ca5b6fc39c60a878f2eb98368bb1fa7f790abf10f37a48a8e7d7b2d60764b1
+  data.tar.gz: e55a273242e89548448f0b9eab0116acc51dece12c6791f425043b705a00016e3a2f3f8a9693dd6b40040d4d2dcb7a3270eb554980475d47e4aed27b453259e0

data/README.md

@@ -10,7 +10,7 @@ rails_kindeditor will helps your rails app integrate with kindeditor, includes i
 ### Add this to your Gemfile
 
 ```ruby
-  gem 'rails_kindeditor', '~> 0.3.20'
+  gem 'rails_kindeditor', '~> 0.4.0'
 ```
 
 ### Run "bundle" command.
@@ -65,6 +65,57 @@ additionally, rails_kindeditor provides one "simple_mode" parameter for render s
 
 That's all.
 
+### Work with turbolinks
+
+rails_kindeditor will not load the scripts under the turbolinks, there's two way to solve this problem:
+
+1.use "'data-no-turbolink' => true" when we need to load kindeditor，this will shut down the turbolinks in this page
+
+```ruby
+  <%= link_to 'Edit', edit_article_path(article), 'data-no-turbolink' => true %>
+```
+
+2.load kindeditor manually, but you should specify the parameters again, include the textarea's id.
+
+```coffeescript
+  # coffeescript code
+  $(document).on 'page:load', ->
+    if $('#article_content').length > 0
+      KindEditor.create '#article_content', "width":"100%", "height":300, "allowFileManager":true, "uploadJson":"/kindeditor/upload", "fileManagerJson":"/kindeditor/filemanager"
+```
+
+simple mode
+```coffeescript
+  # coffeescript code
+  $(document).on 'page:load', ->
+    if $('#article_content').length > 0
+      KindEditor.create '#article_content',
+                      "width":"100%",
+                      "height":300,
+                      "allowFileManager":true,
+                      "uploadJson":"/kindeditor/upload",
+                      "fileManagerJson":"/kindeditor/filemanager",
+                      "items":["fontname","fontsize","|","forecolor","hilitecolor","bold","italic","underline","removeformat","|","justifyleft","justifycenter","justifyright","insertorderedlist","insertunorderedlist","|","emoticons","image","link"]
+```
+
+When you need to specify the owner_id：
+
+```ruby
+f.kindeditor :content, owner_id: @article.id, data: {upload: kindeditor_upload_json_path(owner_id: @article.id), filemanager: kindeditor_file_manager_json_path}
+```
+
+```coffeescript
+  # coffeescript code
+  $(document).on 'page:load', ->
+    if $('#article_content').length > 0
+      KindEditor.create '#article_content',
+                        "width" : "100%",
+                        "height" : 300,
+                        "allowFileManager" : true,
+                        "uploadJson" : $('#article_content').data('upload'),
+                        "fileManagerJson" : $('#article_content').data('filemanager')
+```
+
 ### Include javascript files at bottom ? Not in the head tag ? How can I load kindeditor correctly ?
 
 For some reasons, you includes javascript files at bottom in your template, rails_kindeditor provides a options for lazyload:
@@ -150,6 +201,40 @@ rails_kindeditor can save upload file information into database.
   rake db:migrate
 ```
 
+### Delete uploaded files automatically (only for active_record)
+
+You can specify the owner for uploaded files, when the owner was destroying, all the uploaded files(belongs to the owner) will be destroyed automatically.
+
+1. specify the owner_id for kindeditor
+
+```ruby
+   <%= form_for @article do |f| %>
+     ...
+     <%= f.kindeditor :content, :owner_id => @article.id  %>
+     ...
+   <% end %>
+```
+Warnning: the @article must be created before this scene, the @article.id should not be empty.
+
+2. add has_many_kindeditor_assets in your own model
+
+```ruby
+  class Article < ActiveRecord::Base
+    has_many_kindeditor_assets :attachments, :dependent => :destroy
+    # has_many_kindeditor_assets :attachments, :dependent => :nullify
+    # has_many_kindeditor_assets :your_name, :dependent => :destroy
+  end
+```
+
+3. relationship
+
+```ruby
+  article = Article.first
+  article.attachments # => the article's assets uploaded by kindeditor
+  asset = article.attachments.first
+  asset.owner # => aritcle
+```
+
 ### If you're using mongoid, please add 'gem "carrierwave-mongoid"' in your Gemfile
 
 ```ruby
@@ -172,7 +257,7 @@ rails_kindeditor可以帮助你的rails程序集成kindeditor,包括了图片和
 ### 将下面代码加入Gemfile：
 
 ```ruby
-  gem 'rails_kindeditor', '~> 0.3.20'
+  gem 'rails_kindeditor', '~> 0.4.0'
 ```
 
 ### 运行"bundle"命令：
@@ -225,6 +310,59 @@ rails_kindeditor可以帮助你的rails程序集成kindeditor,包括了图片和
      
 完毕！
 
+### 如何在turbolinks下使用
+
+rails_kindeditor在turbolinks下不会正常加载，只有当页面刷新时才正常。turbolinks的机制就是这样的，页面根本没刷新，这和pjax是一样的，所以kindeditor没加载很正常。
+
+有两个办法可以解决：
+
+1.在需要加载kindeditor的链接加入 'data-no-turbolink' => true ，此时相当在这个页面于关闭turbolinks。
+
+```ruby
+  <%= link_to 'Edit', edit_article_path(article), 'data-no-turbolink' => true %>
+```
+
+2.在turbolinks载入完毕后手动加载kindeditor，不过所有参数都要设置，而且需要知道并设定textarea的id。
+
+```coffeescript
+  # coffeescript code
+  $(document).on 'page:load', ->
+    if $('#article_content').length > 0
+      KindEditor.create '#article_content', "width":"100%", "height":300, "allowFileManager":true, "uploadJson":"/kindeditor/upload", "fileManagerJson":"/kindeditor/filemanager"
+```
+
+simple模式也需要手动设定
+```coffeescript
+  # coffeescript code
+  $(document).on 'page:load', ->
+    if $('#article_content').length > 0
+      KindEditor.create '#article_content',
+                      "width":"100%",
+                      "height":300,
+                      "allowFileManager":true,
+                      "uploadJson":"/kindeditor/upload",
+                      "fileManagerJson":"/kindeditor/filemanager",
+                      "items":["fontname","fontsize","|","forecolor","hilitecolor","bold","italic","underline","removeformat","|","justifyleft","justifycenter","justifyright","insertorderedlist","insertunorderedlist","|","emoticons","image","link"]
+```
+
+需要指定owner_id的方法：
+
+```ruby
+f.kindeditor :content, owner_id: @article.id, data: {upload: kindeditor_upload_json_path(owner_id: @article.id), filemanager: kindeditor_file_manager_json_path}
+```
+
+```coffeescript
+  # coffeescript code
+  $(document).on 'page:load', ->
+    if $('#article_content').length > 0
+      KindEditor.create '#article_content',
+                        "width" : "100%",
+                        "height" : 300,
+                        "allowFileManager" : true,
+                        "uploadJson" : $('#article_content').data('upload'),
+                        "fileManagerJson" : $('#article_content').data('filemanager')
+```
+
 ### 把javascript放在模板最下方，不放在head里面，如何正确加载kindeditor？
 
 有时候，为了加快页面载入速度，也许你会把javascript引用放在template的底部，rails_kindeditor提供了一个参数可以确保正常加载：
@@ -306,6 +444,40 @@ rails_kindeditor 可以将上传文件信息记录入数据库，以便扩展应
   rake db:migrate
 ```
 
+### 自动删除上传的文件(仅在active_record下工作)
+
+你可以为上传的文件指定归属，比如一名用户，或者一篇文章，当用户或者文章被删除时，所有属于该用户或者该文章的上传文件将会被自动删除。
+
+1. 为kindeditor指定owner_id
+
+```ruby
+   <%= form_for @article do |f| %>
+     ...
+     <%= f.kindeditor :content, :owner_id => @article.id  %>
+     ...
+   <% end %>
+```
+警告: @article应该事先被创建，@article.id不应该是空的。
+
+2. 在你自己的模型里加入has_many_kindeditor_assets
+
+```ruby
+  class Article < ActiveRecord::Base
+    has_many_kindeditor_assets :attachments, :dependent => :destroy
+    # has_many_kindeditor_assets :attachments, :dependent => :nullify
+    # has_many_kindeditor_assets :your_name, :dependent => :destroy
+  end
+```
+
+3. 相互关系
+
+```ruby
+  article = Article.first
+  article.attachments # => the article's assets uploaded by kindeditor
+  asset = article.attachments.first
+  asset.owner # => aritcle
+```
+
 ### 如果你使用的是mongoid, 请在你的Gemfile里加入'gem "carrierwave-mongoid"'
 
 ```ruby

data/app/controllers/kindeditor/assets_controller.rb

@@ -8,6 +8,8 @@ class Kindeditor::AssetsController < ApplicationController
       if Kindeditor::AssetUploader.save_upload_info? # save upload info into database
         begin
           @asset = "Kindeditor::#{@dir.camelize}".constantize.new(:asset => @imgFile)
+          @asset.owner_id = params[:owner_id] ? params[:owner_id] : 0
+          @asset.asset_type = @dir
           if @asset.save
             render :text => ({:error => 0, :url => @asset.asset.url}.to_json)
           else

data/app/uploaders/kindeditor/asset_uploader.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require 'carrierwave/processing/mime_types'
+
 class Kindeditor::AssetUploader < CarrierWave::Uploader::Base
   
   EXT_NAMES = {:image => RailsKindeditor.upload_image_ext,
@@ -20,7 +22,7 @@ class Kindeditor::AssetUploader < CarrierWave::Uploader::Base
   # This is a sensible default for uploaders that are meant to be mounted:
   def store_dir
     if Kindeditor::AssetUploader.save_upload_info?
-      "#{RailsKindeditor.upload_store_dir}/#{model.class.to_s.underscore.gsub(/(kindeditor\/)|(_uploader)/, '')}/#{model.created_at.strftime("%Y%m")}"
+      "#{RailsKindeditor.upload_store_dir}/#{model.asset_type.to_s.underscore.gsub(/(kindeditor\/)|(_uploader)/, '')}/#{model.created_at.strftime("%Y%m")}"
     else
       "#{RailsKindeditor.upload_store_dir}/#{self.class.to_s.underscore.gsub(/(kindeditor\/)|(_uploader)/, '')}/#{Time.now.strftime("%Y%m")}"
     end

data/lib/generators/rails_kindeditor/migration/templates/migration/migration.rb

@@ -4,6 +4,8 @@ class CreateKindeditorAssets < ActiveRecord::Migration
       t.string :asset
       t.integer :file_size
       t.string :file_type
+      t.integer :owner_id
+      t.string :asset_type # list by kindeditor: image, file, media, flash
       t.timestamps
     end
   end

data/lib/generators/rails_kindeditor/migration/templates/models/active_record/kindeditor/asset.rb

@@ -6,7 +6,9 @@ class Kindeditor::Asset < ActiveRecord::Base
   
   private
   def update_asset_attributes
-    self.file_size = asset.file.size
-    self.file_type = asset.file.content_type
+    if asset.present? && asset_changed?
+      self.file_size = asset.file.size
+      self.file_type = asset.file.content_type
+    end
   end
 end

data/lib/generators/rails_kindeditor/migration/templates/models/mongoid/kindeditor/asset.rb

@@ -15,7 +15,9 @@ class Kindeditor::Asset
 
   private
   def update_asset_attributes
-    self.file_size = asset.file.size
-    self.file_type = asset.file.content_type
+    if asset.present? && asset_changed?
+      self.file_size = asset.file.size
+      self.file_type = asset.file.content_type
+    end
   end
 end

data/lib/rails_kindeditor.rb

@@ -1,5 +1,6 @@
 require 'rails_kindeditor/engine'
 require 'rails_kindeditor/helper'
+require 'rails_kindeditor/active_record'
 require 'carrierwave'
 require 'mini_magick'
 

data/lib/rails_kindeditor/active_record.rb

@@ -0,0 +1,14 @@
+if defined?(ActiveRecord)
+  ActiveRecord::Base.class_eval do
+    def self.has_many_kindeditor_assets(*args)
+      options = args.extract_options!
+      asset_name = args[0] ? args[0].to_s : 'assets'
+      has_many asset_name.to_sym, :class_name => 'Kindeditor::Asset', :foreign_key => 'owner_id', :dependent => options[:dependent]
+    
+      class_name = self.name
+      Kindeditor::Asset.class_eval do
+        belongs_to :owner, :class_name => class_name, :foreign_key => 'owner_id'
+      end
+    end
+  end
+end

data/lib/rails_kindeditor/helper.rb

@@ -16,7 +16,22 @@ module RailsKindeditor
       output_buffer << javascript_tag(js_replace(input_html['id'], options))
     end
     
+    def kindeditor_upload_json_path(*args)
+      options = args.extract_options!
+      owner_id_query_string = options[:owner_id] ? "?owner_id=#{options[:owner_id]}" : ''
+      "#{root_url}kindeditor/upload#{owner_id_query_string}"
+    end
+    
+    def kindeditor_file_manager_json_path
+      "#{root_url}kindeditor/filemanager"
+    end
+    
     private
+    
+    def root_url
+      main_app.respond_to?(:root_url) ? main_app.root_url : '/'
+    end
+    
     def js_replace(dom_id, options = {})
       editor_id = options[:editor_id].nil? ? '' : "#{options[:editor_id].to_s.downcase} = "
       if options[:window_onload]
@@ -36,8 +51,8 @@ module RailsKindeditor
       options.reverse_merge!(:width => '100%')
       options.reverse_merge!(:height => 300)
       options.reverse_merge!(:allowFileManager => true)
-      options.merge!(:uploadJson => "#{main_app.root_url}kindeditor/upload")
-      options.merge!(:fileManagerJson => "#{main_app.root_url}kindeditor/filemanager")
+      options.merge!(:uploadJson => kindeditor_upload_json_path(:owner_id => options.delete(:owner_id)))
+      options.merge!(:fileManagerJson => kindeditor_file_manager_json_path)
       if options[:simple_mode] == true
         options.merge!(:items => %w{fontname fontsize | forecolor hilitecolor bold italic underline removeformat | justifyleft justifycenter justifyright insertorderedlist insertunorderedlist | emoticons image link})
       end

data/lib/rails_kindeditor/version.rb

@@ -1,4 +1,4 @@
 module RailsKindeditor
-  VERSION = "0.3.20"
+  VERSION = "0.4.0"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_kindeditor
 version: !ruby/object:Gem::Version
-  version: 0.3.20
+  version: 0.4.0
 platform: ruby
 authors:
 - Macrow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-27 00:00:00.000000000 Z
+date: 2013-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carrierwave
@@ -75,6 +75,7 @@ files:
 - lib/generators/rails_kindeditor/migration/templates/models/mongoid/kindeditor/image.rb
 - lib/generators/rails_kindeditor/migration/templates/models/mongoid/kindeditor/media.rb
 - lib/rails_kindeditor.rb
+- lib/rails_kindeditor/active_record.rb
 - lib/rails_kindeditor/engine.rb
 - lib/rails_kindeditor/formtastic.rb
 - lib/rails_kindeditor/helper.rb
@@ -305,3 +306,4 @@ signing_key:
 specification_version: 4
 summary: Kindeditor for Ruby on Rails
 test_files: []
+has_rdoc: