loyal_rails_kindeditor 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.DS_Store

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'carrierwave'
+gem 'mini_magick'

data/README.md

@@ -0,0 +1,317 @@
+# Kindeditor for Ruby on Rails
+
+Kindeditor is a WYSIWYG javascript editor, visit http://www.kindsoft.net for details.
+rails_kindeditor will helps your rails app integrate with kindeditor, includes images and files uploading.
+
+<img src="https://github.com/Macrow/rails_kindeditor/raw/master/screenshots/rails_kindeditor.png" alt="rails_indeditor">
+
+## Installation and usage
+
+### Add this to your Gemfile
+
+```ruby
+  gem 'rails_kindeditor', '~> 0.3.19'
+```
+
+### Run "bundle" command.
+
+```bash
+  bundle
+```
+
+### Run install generator:
+
+```bash
+  rails generate rails_kindeditor:install
+```
+
+### Rails4 in production mode
+
+In Rails 4.0, precompiling assets no longer automatically copies non-JS/CSS assets from vendor/assets and lib/assets. see https://github.com/rails/rails/pull/7968
+In Rails 4.0's production mode, please run 'rake kindeditor:assets', this method just copy kindeditor into public folder.
+
+```bash
+  rake kindeditor:assets
+```
+
+### Usage:
+
+```ruby
+  1. <%= kindeditor_tag :content, 'default content value' %>
+     # or <%= kindeditor_tag :content, 'default content value', :width => 800, :height => 300 %>
+     # or <%= kindeditor_tag :content, 'default content value', :allowFileManager => false %>
+```
+
+```ruby
+  2. <%= form_for @article do |f| %>
+       ...
+       <%= f.kindeditor :content %>
+       # or <%= f.kindeditor :content, :width => 800, :height => 300 %>
+       # or <%= f.kindeditor :content, :allowFileManager => false %>
+       ...
+     <% end %>
+```
+You can use kindeditor's initial parameters as usual, please visit http://www.kindsoft.net/docs/option.html for details.
+
+additionally, rails_kindeditor provides one "simple_mode" parameter for render simple mode quickly.
+
+<img src="https://github.com/Macrow/rails_kindeditor/raw/master/screenshots/simple_mode.png" alt="simple mode">
+
+```ruby
+  kindeditor_tag :content, 'default content value', :simple_mode => true
+  f.kindeditor_tag :content, :simple_mode => true
+  f.input :content, :as => :kindeditor, :input_html => { :simple_mode => true } # simple_form & formtastic
+```
+
+That's all.
+
+### 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:
+
+```ruby
+  <%= f.kindeditor :content, :window_onload => true %>
+```
+
+Warning: Kindeditor will load after all the objects loaded.
+
+## SimpleForm and Formtastic integration
+
+### simple_form:
+
+```ruby
+  <%= form.input :content, :as => :kindeditor %>
+  # or
+  <%= form.input :content, :as => :kindeditor, :label => false, :input_html => { :width => 800, :height => 300 } %>
+```
+  
+### formtastic:
+
+```ruby
+  <%= form.input :content, :as => :kindeditor %>
+  # or
+  <%= form.input :content, :as => :kindeditor, :input_html => { :height => 300 } %>
+```
+
+## How to get kindeditor's content
+
+```ruby
+  <%= form_for @article do |f| %>
+    <%= f.kindeditor :content, :editor_id => 'my_editor' %>
+  <% end %>
+```
+
+You can get content like this:
+
+```javascript
+  // Javascript code
+  my_editor.html();
+```
+
+## Upload options configuration
+
+When you run "rails generate rails_kindeditor:install", installer will copy configuration files in config/initializers folder.
+You can customize some option for uploading. 
+
+```ruby
+  # Specify the subfolders in public directory.
+  # You can customize it , eg: config.upload_dir = 'this/is/my/folder'
+  config.upload_dir = 'uploads'
+
+  # Allowed file types for upload.
+  config.upload_image_ext = %w[gif jpg jpeg png bmp]
+  config.upload_flash_ext = %w[swf flv]
+  config.upload_media_ext = %w[swf flv mp3 wav wma wmv mid avi mpg asf rm rmvb]
+  config.upload_file_ext = %w[doc docx xls xlsx ppt htm html txt zip rar gz bz2]
+
+  # Porcess upload image size, need mini_magick
+  #     before    => after
+  # eg: 1600x1600 => 800x800
+  #     1600x800  => 800x400
+  #     400x400   => 400x400 # No Change
+  # config.image_resize_to_limit = [800, 800]
+```
+
+## Save upload file information into database(optional)
+
+rails_kindeditor can save upload file information into database.
+
+### Just run migration generate, there are two ORM options for you: 1.active_record 2.mongoid, default is active_record.
+
+```bash
+  rails generate rails_kindeditor:migration
+  or
+  rails generate rails_kindeditor:migration -o mongoid
+```
+
+### The generator will copy model and migration to your application. When you are done, remember run rake db:migrate:
+
+```bash
+  rake db:migrate
+```
+
+### If you're using mongoid, please add 'gem "carrierwave-mongoid"' in your Gemfile
+
+```ruby
+  gem 'carrierwave-mongoid'
+```
+
+## License
+
+MIT License.
+
+
+
+# Kindeditor for Ruby on Rails 中文文档
+
+Kindeditor是国产的所见即所得javascript富文本编辑器, 访问 http://www.kindsoft.net 获取更多信息.
+rails_kindeditor可以帮助你的rails程序集成kindeditor,包括了图片和附件上传功能，文件按照类型、日期进行存储。
+
+## 安装及使用
+
+### 将下面代码加入Gemfile：
+
+```ruby
+  gem 'rails_kindeditor', '~> 0.3.19'
+```
+
+### 运行"bundle"命令：
+
+```bash
+  bundle
+```
+
+### 安装Kindeditor，运行下面的代码：
+
+```bash
+  rails generate rails_kindeditor:install
+```
+
+### Rails4 in production mode
+
+从Rails 4.0开始, precompiling assets不再自动从vendor/assets和lib/assets拷贝非JS/CSS文件. 参见 https://github.com/rails/rails/pull/7968
+如果要使用Rails 4.0的生产模式，请运行'rake kindeditor:assets', 此方法可将kindeditor自动拷贝到你的public/assets目录.
+
+```bash
+  rake kindeditor:assets
+```
+
+### 使用方法:
+
+```ruby
+  1. <%= kindeditor_tag :content, 'default content value' %>
+     # or <%= kindeditor_tag :content, 'default content value', :width => 800, :height => 300 %>
+     # or <%= kindeditor_tag :content, 'default content value', :allowFileManager => false %>
+```
+
+```ruby
+  2. <%= form_for @article do |f| -%>
+       ...
+       <%= f.kindeditor :content %>
+       # or <%= f.kindeditor :content, :width => 800, :height => 300 %>
+       # or <%= f.kindeditor :content, :allowFileManager => false %>
+       ...
+     <% end -%>
+```
+你可以像往常那样使用kindeditor自身的初始化参数，请访问 http://www.kindsoft.net/docs/option.html 查看更多参数。
+
+另外，rails_kindeditor还额外提供一个"simple_mode"参数，以便快捷使用简单模式的kindeditor。
+
+```ruby
+  kindeditor_tag :content, 'default content value', :simple_mode => true
+  f.kindeditor_tag :content, :simple_mode => true
+  f.input :content, :as => :kindeditor, :input_html => { :simple_mode => true } # simple_form & formtastic  
+```
+     
+完毕！
+
+### 把javascript放在模板最下方，不放在head里面，如何正确加载kindeditor？
+
+有时候，为了加快页面载入速度，也许你会把javascript引用放在template的底部，rails_kindeditor提供了一个参数可以确保正常加载：
+
+```ruby
+  <%= f.kindeditor :content, :window_onload => true %>
+```
+
+警告：Kindeditor会在页面所有的内容加载完毕后才进行加载，所以需谨慎使用
+
+## SimpleForm与Formtastic集成：
+
+### simple_form:
+
+```ruby
+  <%= form.input :content, :as => :kindeditor, :label => false, :input_html => { :width => 800, :height => 300 } %>
+```
+
+### formtastic:
+
+```ruby
+  <%= form.input :content, :as => :kindeditor %>
+  <%= form.input :content, :as => :kindeditor, :input_html => { :height => 300 } %>
+```
+## 如何获取kindeditor的内容
+
+```ruby
+  <%= form_for @article do |f| %>
+    <%= f.kindeditor :content, :editor_id => 'my_editor' %>
+  <% end %>
+```
+
+可通过下面的Javascript代码获取内容:
+
+```javascript
+  // Javascript code
+  my_editor.html();
+```
+
+## 上传图片及文件配置
+
+当你运行"rails generate rails_kindeditor:install"的时候，安装器会将配置文件拷贝到config/initializers文件夹。
+你可以配置以下上传选项：
+
+```ruby
+  # 指定上传目录，目录可以指定多级，都存储在public目录下.
+  # You can customize it , eg: config.upload_dir = 'this/is/my/folder'
+  config.upload_dir = 'uploads'
+
+  # 指定允许上传的文件类型.
+  config.upload_image_ext = %w[gif jpg jpeg png bmp]
+  config.upload_flash_ext = %w[swf flv]
+  config.upload_media_ext = %w[swf flv mp3 wav wma wmv mid avi mpg asf rm rmvb]
+  config.upload_file_ext = %w[doc docx xls xlsx ppt htm html txt zip rar gz bz2]
+
+  # 处理上传文件，需要mini_magick
+  #     处理以前      => 处理以后
+  # eg: 1600x1600 => 800x800
+  #     1600x800  => 800x400
+  #     400x400   => 400x400 # 图片小于该限制尺寸则不作处理
+  # config.image_resize_to_limit = [800, 800]
+```
+
+## 将上传文件信息记录入数据库（可选）
+
+rails_kindeditor 可以将上传文件信息记录入数据库，以便扩展应用.
+
+### 运行下面的代码，有两项选项：1.active_record 2.mongoid，默认是active_record。
+
+```bash
+  rails generate rails_kindeditor:migration
+  or
+  rails generate rails_kindeditor:migration -o mongoid
+```
+
+### 运行下面的代码：
+
+```bash
+  rake db:migrate
+```
+
+### 如果你使用的是mongoid, 请在你的Gemfile里加入'gem "carrierwave-mongoid"'
+
+```ruby
+  gem 'carrierwave-mongoid'
+```
+
+## License
+
+MIT License.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/kindeditor.js

@@ -0,0 +1 @@
+//= require kindeditor/kindeditor.js

data/app/controllers/kindeditor/assets_controller.rb

@@ -0,0 +1,123 @@
+#coding: utf-8
+require "find"
+class Kindeditor::AssetsController < ApplicationController
+  skip_before_filter :verify_authenticity_token
+  def create
+    @imgFile, @dir = params[:imgFile], params[:dir]
+    unless @imgFile.nil?
+      if Kindeditor::AssetUploader.save_upload_info? # save upload info into database
+        begin
+          @asset = "Kindeditor::#{@dir.camelize}".constantize.new(:asset => @imgFile)
+          if @asset.save
+            render :text => ({:error => 0, :url => @asset.asset.url}.to_json)
+          else
+            show_error(@asset.errors.full_messages)
+          end
+        rescue Exception => e
+          show_error(e.to_s)
+        end
+      else # do not touch database
+        begin
+          uploader = "Kindeditor::#{@dir.camelize}Uploader".constantize.new
+          uploader.store!(@imgFile)
+          render :text => ({:error => 0, :url => uploader.url}.to_json)
+        rescue CarrierWave::UploadError => e
+          show_error(e.message)
+        rescue Exception => e
+          show_error(e.to_s)
+        end
+      end
+    else
+      show_error("No File Selected!")
+    end
+  end
+
+  def list
+    @root_path = "#{Rails.public_path}/#{RailsKindeditor.upload_store_dir}/"
+    @root_url = "/#{RailsKindeditor.upload_store_dir}/"
+    @img_ext = Kindeditor::AssetUploader::EXT_NAMES[:image]
+    @dir = params[:dir].strip || ""
+    unless Kindeditor::AssetUploader::EXT_NAMES.keys.map(&:to_s).push("").include?(@dir)
+      render :text => "Invalid Directory name."
+      return
+    end
+    
+    Dir.chdir(Rails.public_path)
+    RailsKindeditor.upload_store_dir.split('/').each do |dir|
+      Dir.mkdir(dir) unless Dir.exist?(dir)
+      Dir.chdir(dir)
+    end
+    
+    Dir.mkdir(@dir) unless Dir.exist?(@dir)
+    
+    @root_path += @dir + "/"
+    @root_url += @dir + "/"
+    
+    @path = params[:path].strip || ""
+    if @path.empty?
+      @current_path = @root_path
+      @current_url = @root_url
+      @current_dir_path = ""
+      @moveup_dir_path = ""
+    else
+      @current_path = @root_path + @path + "/"      
+      @current_url = @root_url + @path + "/"
+      @current_dir_path = @path
+      @moveup_dir_path = @current_dir_path.gsub(/(.*?)[^\/]+\/$/, "")
+    end
+    @order = %w(name size type).include?(params[:order].downcase) ? params[:order].downcase : "name"
+    if !@current_path.match(/\.\./).nil?
+      render :text => "Access is not allowed."
+      return
+    end
+    if @current_path.match(/\/$/).nil?
+      render :text => "Parameter is not valid."
+      return
+    end
+    if !File.exist?(@current_path) || !File.directory?(@current_path)
+      render :text => "Directory does not exist."
+      return
+    end
+    @file_list = []
+    Dir.foreach(@current_path) do |filename|  
+      hash = {}
+      if filename != "." and filename != ".." and filename != ".DS_Store"
+        file = @current_path + filename
+        if File.directory?(file)
+          hash[:is_dir] = true
+          hash[:has_file] = (Dir.foreach(file).count > 2)
+          hash[:filesize] = 0
+          hash[:is_photo] = false
+          hash[:filetype] = ""
+        else
+          hash[:is_dir] = false
+          hash[:has_file] = false
+          hash[:filesize] = File.size(file)
+          hash[:dir_path] = ""
+          file_ext = file.gsub(/.*\./,"")
+          hash[:is_photo] = @img_ext.include?(file_ext)
+          hash[:filetype] = file_ext
+        end
+        hash[:filename] = filename
+        hash[:datetime] = File.mtime(file).to_s(:db)
+        @file_list << hash
+      end
+    end
+
+    @file_list.sort! {|a, b| a["file#{@order}".to_sym] <=> b["file#{@order}".to_sym]}
+    
+    @result = {}
+    @result[:moveup_dir_path] = @moveup_dir_path
+    @result[:current_dir_path] = @current_dir_path
+    @result[:current_url] = @current_url
+    @result[:total_count] = @file_list.count
+    @result[:file_list] = @file_list
+    render :text => @result.to_json
+  end
+  
+  private
+  def show_error(msg)
+    render :text => ({:error => 1, :message => msg}.to_json)
+  end
+  
+end

data/app/uploaders/kindeditor/asset_uploader.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+
+class Kindeditor::AssetUploader < CarrierWave::Uploader::Base
+  
+  EXT_NAMES = {:image => RailsKindeditor.upload_image_ext,
+               :flash => RailsKindeditor.upload_flash_ext,
+               :media => RailsKindeditor.upload_media_ext,
+               :file  => RailsKindeditor.upload_file_ext}
+
+  # Include RMagick or ImageScience support:
+  # include CarrierWave::RMagick
+  # include CarrierWave::ImageScience
+  # include CarrierWave::MiniMagick
+
+  # Choose what kind of storage to use for this uploader:
+  storage :file
+  # storage :fog
+
+  # Override the directory where uploaded files will be stored.
+  # 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")}"
+    else
+      "#{RailsKindeditor.upload_store_dir}/#{self.class.to_s.underscore.gsub(/(kindeditor\/)|(_uploader)/, '')}/#{Time.now.strftime("%Y%m")}"
+    end
+  end
+
+  def cache_dir
+    "#{Rails.root}/tmp/uploads"
+  end
+
+  # Provide a default URL as a default if there hasn't been a file uploaded:
+  # def default_url
+  #   "/images/fallback/" + [version_name, "default.png"].compact.join('_')
+  # end
+
+  # Process files as they are uploaded:
+  # process :scale => [200, 300]
+  #
+  # def scale(width, height)
+  #   # do something
+  # end
+
+  # Create different versions of your uploaded files:
+  # version :thumb do
+  #   process :scale => [50, 50]
+  # end
+
+  # Add a white list of extensions which are allowed to be uploaded.
+  # For images you might use something like this:
+
+  # Override the filename of the uploaded files:
+  # Avoid using model.id or version_name here, see uploader/store.rb for details.
+  before :store, :remember_cache_id
+  after :store, :delete_tmp_dir
+
+  # store! nil's the cache_id after it finishes so we need to remember it for deletition
+  def remember_cache_id(new_file)
+    @cache_id_was = cache_id
+  end
+
+  def delete_tmp_dir(new_file)
+    # make sure we don't delete other things accidentally by checking the name pattern
+    if @cache_id_was.present? && @cache_id_was =~ /\A[\d]{8}\-[\d]{4}\-[\d]+\-[\d]{4}\z/
+      FileUtils.rm_rf(File.join(cache_dir, @cache_id_was))
+    end
+  end
+
+  def filename
+    if original_filename 
+      @name ||= Digest::MD5.hexdigest(File.dirname(current_path)).slice(0, 12)
+      "#{@name}.#{file.extension}"
+    end
+  end
+  
+  def self.save_upload_info?
+    begin
+      %w(asset file flash image media).each do |s|
+        "Kindeditor::#{s.camelize}".constantize
+      end
+      return true
+    rescue
+      return false
+    end
+  end
+
+end
+

data/app/uploaders/kindeditor/file_uploader.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+class Kindeditor::FileUploader < Kindeditor::AssetUploader
+
+  def extension_white_list
+    EXT_NAMES[:file]
+  end
+
+end
+

data/app/uploaders/kindeditor/flash_uploader.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+class Kindeditor::FlashUploader < Kindeditor::AssetUploader
+
+  def extension_white_list
+    EXT_NAMES[:flash]
+  end
+
+end
+

data/app/uploaders/kindeditor/image_uploader.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+class Kindeditor::ImageUploader < Kindeditor::AssetUploader
+
+  def extension_white_list
+    EXT_NAMES[:image]
+  end
+
+end
+

data/app/uploaders/kindeditor/media_uploader.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+class Kindeditor::MediaUploader < Kindeditor::AssetUploader
+
+  def extension_white_list
+    EXT_NAMES[:media]
+  end
+
+end
+

data/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+  namespace :kindeditor do
+    post "/upload" => "assets#create"
+    get  "/filemanager" => "assets#list"
+  end
+end

data/lib/generators/rails_kindeditor/install/USAGE

@@ -0,0 +1,10 @@
+Description:
+    install kindeditor for your application
+
+Example:
+    rails generate rails_kindeditor:install
+
+    This will create:
+        config/kindeditor.rb
+
+

data/lib/generators/rails_kindeditor/install/install_generator.rb

@@ -0,0 +1,23 @@
+module RailsKindeditor
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    desc "Install kindeditor for your application."
+
+    def copy_kindeditor_files
+      if ::Rails.version < "3.1.0"
+        warn "Warning: rails_kindeditor ~> v0.3.0 only support Rails3.1+!"
+        warn "If you're using rails3.0.x, please check rails_kindeditor v0.2.8"
+      else
+        template "rails_kindeditor.rb", "config/initializers/rails_kindeditor.rb"
+      end
+    end
+    
+    def insert_or_copy_js_files
+      if File.exist?('app/assets/javascripts/application.js')
+        insert_into_file "app/assets/javascripts/application.js", "//= require kindeditor\n", :after => "jquery_ujs\n"
+      else
+        copy_file "application.js", "app/assets/javascripts/application.js"
+      end
+    end
+  end
+end

data/lib/generators/rails_kindeditor/install/templates/application.js

@@ -0,0 +1,17 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require kindeditor
+//= require_tree .
+

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

@@ -0,0 +1,19 @@
+RailsKindeditor.setup do |config|
+
+  # Specify the subfolders in public directory.
+  # You can customize it , eg: config.upload_dir = 'this/is/my/folder'
+  config.upload_dir = 'uploads'
+
+  # Allowed file types for upload.
+  config.upload_image_ext = %w[gif jpg jpeg png bmp]
+  config.upload_flash_ext = %w[swf flv]
+  config.upload_media_ext = %w[swf flv mp3 wav wma wmv mid avi mpg asf rm rmvb]
+  config.upload_file_ext = %w[doc docx xls xlsx ppt htm html txt zip rar gz bz2]
+  
+  # Porcess upload image size
+  # eg: 1600x1600 => 800x800
+  #     1600x800  => 800x400
+  #     400x400   => 400x400  # No Change
+  # config.image_resize_to_limit = [800, 800]
+
+end

data/lib/generators/rails_kindeditor/migration/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Copy model, migration and uploader to your application.
+
+Example:
+    rails generate rails_kindeditor:migration
+
+    This will create:
+        app/models/kindeditor/asset.rb
+        app/models/kindeditor/file.rb
+        app/models/kindeditor/flash.rb
+        app/models/kindeditor/image.rb
+        app/models/kindeditor/media.rb
+        db/migrate/xxxxxxxxx_create_kindeditor_assets.rb
+