RubyGems - rails_kindeditor - Versions diffs - 0.0.3 → 0.1.0 - Mend

rails_kindeditor 0.0.3 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (223) hide show

data/README.rdoc CHANGED Viewed

@@ -1,27 +1,23 @@
-== kindeditor for rails3
+== Kindeditor(4.x) for Rails3
+Kindeditor for Rails3, including image and file upload with carrierwave.
 == Installation
-add this to your Gemfile
+Add this to your Gemfile
-  gem "carrierwave", "~> 0.5.4"
+  gem "carrierwave"
   gem "rails_kindeditor"
 Run "bundle" command.
   bundle
-After you install rails_kindeditor and add it to your Gemfile, you need to run the generator:
+Run install generator:
   rails generate rails_kindeditor:install
-The generator will copy kindeditor to your application. When you are done, you are ready to add migration using the generator:
-  rails generate rails_kindeditor:migration
-The generator will copy migration to your application. When you are done, remember run rake db:migrate:
-  rake db:migrate
+That's all! By default, rails_kindeditor do not save upload file information into database.
 == Usage
@@ -33,20 +29,123 @@ In your controller, use include_kindeditor method to load kindeditor javascript:
   include_kindeditor
+Assign your textarea with id
+  :id => "kindeditor_id"
+That's all.
+== 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.
+  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:
+  rake db:migrate
+That's all.
+== Configuration options
+When you use include_kindeditor_if_needed function, you can set :lang and :cache options like this:
+  <%= include_kindeditor_if_needed :lang => :en %>
+  <%= include_kindeditor_if_needed :lang => :zh_CN %>
+  <%= include_kindeditor_if_needed :cache => true %>
+  <%= include_kindeditor_if_needed :cache => "my-cache-name"  %>
+  <%= include_kindeditor_if_needed :lang => :zh_CN, :cache => true %>
 You can load kindeditor javascript only in some action if you needed:
   include_kindeditor :only => [:new, :edit]
   include_kindeditor :except => [:index, :show, :destroy, :create]
+You can config kindeditor by rails_kindeditor-init.js file, please read Kindeditor's documents:
-Assign your textarea with id
+  public/javascripts/kindeditor/kindeditor-init.js
+== License
+MIT License. Copyright 2011
+== Kindeditor(4.x) for Rails3 中文文档
+可供Rails3使用的gem, 包括了图片和附件上传功能，文件按照类型、日期进行存储。上传采用了Carrierwave。
+== 安装
+将下面代码加入Gemfile：
+  gem "carrierwave"
+  gem "rails_kindeditor"
+运行"bundle"命令：
+  bundle
+安装Kindeditor，运行下面的代码：
+  rails generate rails_kindeditor:install
+完毕！默认情况下，rails_kindeditor在上传文件时不会把文件信息记录入数据库。
+== 使用
+在你的layout文件中的<head></head>内包含下面代码：
+  <%= include_kindeditor_if_needed %>
+在你需要使用的controller里面，包含下面代码来控制加载javascript:
+  include_kindeditor
+把需要转换的textarea赋予下列id值：
   :id => "kindeditor_id"
-You can config kindeditor by rails_kindeditor-init.js file:
+完毕！
+== 将上传文件信息记录入数据库（可选）
+rails_kindeditor 可以将上传文件信息记录入数据库，以便扩展应用.
+运行下面的代码，有两项选项：1.active_record 2.mongoid，默认是active_record。
+  rails generate rails_kindeditor:migration
+  or
+  rails generate rails_kindeditor:migration -o mongoid
+运行下面的代码：
+  rake db:migrate
+完毕！
+== 配置选项
+当你使用include_kindeditor_if_needed时，你可以像下面一样设置:lang和:cache：
+  <%= include_kindeditor_if_needed :lang => :en %>
+  <%= include_kindeditor_if_needed :lang => :zh_CN %>
+  <%= include_kindeditor_if_needed :cache => true %>
+  <%= include_kindeditor_if_needed :cache => "my-cache-name"  %>
+  <%= include_kindeditor_if_needed :lang => :zh_CN, :cache => true %>
+你可以有选择性地加载kindeditor的javascript：
+  include_kindeditor :only => [:new, :edit]
+  include_kindeditor :except => [:index, :show, :destroy, :create]
+你可以通过修改rails_kindeditor-init.js来配置kindeditor，详细配置方法可以阅读Kindeditor的文档:
   public/javascripts/kindeditor/kindeditor-init.js
 == License
-MIT License. Copyright 2011
+MIT License. Copyright 2011

data/app/controllers/kindeditor/assets_controller.rb CHANGED Viewed

@@ -1,50 +1,127 @@
+#coding: utf-8
+require "find"
 class Kindeditor::AssetsController < ApplicationController
   def create
-    @asset_params = params[:imgFile]
-    case @asset_params.content_type.gsub(/\/[a-z]*/, "")
-    when 'image'
-      @asset = Kindeditor::Image.new(:asset => @asset_params)
-      if @asset.save
-        render :text => ({:error => 0, :url => @asset.asset.url}.to_json)
-      else
-        render :text => ({:error => 1, :message => @asset.errors.full_messages}.to_json)
-      end
-    else # other type files
-      @asset = Kindeditor::File.new(:asset => params[:imgFile])
-      if @asset.save
-        str = "<script type='text/javascript'>parent.KE.plugin['accessory'].insert('" \
-              + request[:id] + "', '" + @asset.asset.url + "','" + @asset.asset.filename \
-              + "','" + File.extname(@asset.asset.to_s).gsub(".","") + "');</script>"
-        render :text => str
-      else
-        render :nothing => true
+    @imgFile = params[:imgFile]
+    @dir = params[:dir]
+    unless @imgFile.nil?
+      if 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
+          show_error("Internal Error!")
+        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
+          show_error("Internal Error!")
+        end
       end
+    else
+      show_error("No File Selected!")
     end
   end
   def list
-    order = case params[:order]
-            when "NAME"
-              "asset"
-            when "TYPE"
-              "file_type"
-            when "SIZE"
-              "file_size"
-            else
-              "id"
-            end
-    @images = Kindeditor::Image.where("file_type LIKE '%image%'").order(order).all
-    @json = []
-    for image in @images
-      temp = %Q{{"filesize":#{image.file_size},
-                 "filename":"#{image.asset.to_s}",
-                 "dir_path":"#{image.asset.url}",
-                 "datetime":"#{image.created_at.to_date}"}}
-      @json << temp
-    end
-    render :text => ("{\"file_list\":[" << @json.join(",") << "]}")
-  end
-end
+    @root_path = Rails.public_path + "/uploads/"
+    @root_url = "/uploads/"
+    @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
+    unless @dir.empty?
+      @root_path += @dir + "/"
+      @root_url += @dir + "/"
+      Dir.mkdir(@root_path) unless File.exist?(@root_path)
+    end
+    @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
+  def 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/asset_uploader.rb ADDED Viewed

@@ -0,0 +1,68 @@
+# encoding: utf-8
+class Kindeditor::AssetUploader < CarrierWave::Uploader::Base
+  EXT_NAMES = {:image => %w[gif jpg jpeg png bmp],
+               :flash => %w[swf flv],
+               :media => %w[swf flv mp3 wav wma wmv mid avi mpg asf rm rmvb],
+               :file  => %w[doc docx xls xlsx ppt htm html txt zip rar gz bz2]}
+  # Include RMagick or ImageScience support:
+  # include CarrierWave::RMagick
+  # include CarrierWave::ImageScience
+  # 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 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
+    @name ||= Time.now.to_s(:number)
+    "#{@name}#{File.extname(original_filename).downcase}" if original_filename
+  end
+end

data/app/uploaders/kindeditor/file_uploader.rb CHANGED Viewed

@@ -1,68 +1,13 @@
 # encoding: utf-8
-class Kindeditor::FileUploader < CarrierWave::Uploader::Base
+class Kindeditor::FileUploader < Kindeditor::AssetUploader
-  # Include RMagick or ImageScience support:
-  # include CarrierWave::RMagick
-  # include CarrierWave::ImageScience
-  # 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
-    "uploads/File/#{Time.now.strftime("%Y-%m")}"
-  end
-  def cache_dir
-    "#{Rails.root}/tmp/uploads"
+    "uploads/file/#{Time.now.strftime("%Y%m")}"
   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:
   def extension_white_list
-    %w(doc xls ppt docx xlsx pptx pdf txt rar zip mp3)
-  end
-  # 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
-    @name ||= Time.now.to_s(:number)
-    "#{@name}#{File.extname(original_filename).downcase}" if original_filename
+    EXT_NAMES[:file]
   end
 end

data/app/uploaders/kindeditor/flash_uploader.rb ADDED Viewed

@@ -0,0 +1,14 @@
+# encoding: utf-8
+class Kindeditor::FlashUploader < Kindeditor::AssetUploader
+  def store_dir
+    "uploads/flash/#{Time.now.strftime("%Y%m")}"
+  end
+  def extension_white_list
+    EXT_NAMES[:flash]
+  end
+end

data/app/uploaders/kindeditor/image_uploader.rb CHANGED Viewed

@@ -1,68 +1,13 @@
 # encoding: utf-8
-class Kindeditor::ImageUploader < CarrierWave::Uploader::Base
+class Kindeditor::ImageUploader < Kindeditor::AssetUploader
-  # Include RMagick or ImageScience support:
-  # include CarrierWave::RMagick
-  # include CarrierWave::ImageScience
-  # 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
-    "uploads/Image/#{Time.now.strftime("%Y-%m")}"
-  end
-  def cache_dir
-    "#{Rails.root}/tmp/uploads"
+    "uploads/image/#{Time.now.strftime("%Y%m")}"
   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:
   def extension_white_list
-    %w(jpg gif png bmp)
-  end
-  # 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
-    @name ||= Time.now.to_s(:number)
-    "#{@name}#{File.extname(original_filename).downcase}" if original_filename
+    EXT_NAMES[:image]
   end
 end

data/app/uploaders/kindeditor/media_uploader.rb ADDED Viewed

@@ -0,0 +1,14 @@
+# encoding: utf-8
+class Kindeditor::MediaUploader < Kindeditor::AssetUploader
+  def store_dir
+    "uploads/media/#{Time.now.strftime("%Y%m")}"
+  end
+  def extension_white_list
+    EXT_NAMES[:media]
+  end
+end

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

@@ -7,5 +7,4 @@ module RailsKindeditor
       directory "kindeditor", "public/javascripts/kindeditor"
     end
   end
-end
+end

data/lib/generators/rails_kindeditor/install/templates/kindeditor/kindeditor-init.js CHANGED Viewed

@@ -1,8 +1,9 @@
-KE.show({
-  id : 'kindeditor_id',
-  width: "100%",
-  allowFileManager: true,
-	imageUploadJson : '/kindeditor/upload',
-	fileManagerJson: '/kindeditor/filemanager'
-});
+KindEditor.ready(function(K) {
+	K.create('#kindeditor_id', {
+		width: "100%",
+		allowFileManager: true,
+		langType: "zh_CN",
+		uploadJson: '/kindeditor/upload',
+		fileManagerJson: '/kindeditor/filemanager'
+	});
+});