rails_wangeditor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b62dd1f411fa847f9e4f5497d8f449d2899d7875
+  data.tar.gz: 8b1f76430c435b4d6730eecb00ae48a3470db6a4
+SHA512:
+  metadata.gz: 46c5058aa41d8b9129234cb4f4d2738da734227a20d6d0589a1a6ecd778683514fd6142e28b18e3f577f728cb93a4bf7ba95a018a0971a51e0025d5e768e3e3f
+  data.tar.gz: abe1356868c313f5282b83d64971c19d03248a831146e3e8b8e9bdb0983b986136ba03429b3fed8f64745d84097610a9ae7e3cef1b7f77d7ac988e99a5a8430a

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/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 RubyCat
+
+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.md

@@ -0,0 +1,172 @@
+# wangEditor for Ruby on Rails  [![Gem Version](https://badge.fury.io/rb/rails_wangeditor.png)](http://badge.fury.io/rb/rails_wangeditor)
+
+wangEditor is an easy, fast and beautiful WYSIWYG javascript editor, visit [https://github.com/wangfupeng1988/wangEditor](https://github.com/wangfupeng1988/wangEditor) for details.
+rails_wangeditor will helps your rails app integrate with wangEditor, includes images uploading.
+
+![](http://images2015.cnblogs.com/blog/138012/201509/138012-20150910004209122-1645253022.png)
+
+## Installation and usage
+
+### Add this to your Gemfile
+
+```ruby
+  gem 'rails_wangeditor'
+```
+
+### Run "bundle" command.
+
+```bash
+  bundle
+```
+
+### Run install generator:
+
+```bash
+  rails generate rails_wangeditor: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 wangeditor:assets', this method just copy wangeditor into public folder.
+
+```bash
+  rake wangeditor:assets
+```
+
+### Usage:
+
+```ruby
+  1. <%= wangeditor_tag :content, 'default content value' %>
+     # or <%= wangeditor_tag :content, 'default content value', :input_html =>{style: "500px"} %>
+```
+
+```ruby
+  2. <%= form_for @article do |f| %>
+       ...
+       <%= f.wangeditor :content %>
+       # or <%= f.wangeditor :content, style: "500px"%>
+       ...
+     <% end %>
+```
+
+When you need to specify the owner_id：
+
+```ruby
+<%= f.wangeditor :content, owner: @article%>
+```
+
+## SimpleForm integration
+
+### simple_form:
+
+```ruby
+  <%= f.wangeditor :content, style: "500px"%>
+```
+
+## Upload options configuration
+
+When you run "rails generate rails_wangeditor: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]
+
+  # replace to your own baidu mapAk
+  config.mapAk = 'zlXbfvvyWN0vrO5toWqGhLspGHMIeFgn';
+
+  # 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]
+
+```
+
+## Asset host options configuration
+
+```ruby
+  # if you have config in your rails application like this:
+  # /config/enviroments/production.rb
+  #   # config.action_controller.asset_host = "http://asset.example.com"
+  #   # config.assets.prefix = "assets_prefx"
+  # then you should:
+  #
+  config.asset_url_prefix = "http://asset.example.com/assets_prefx/" if Rails.env.production?
+```
+
+
+## Save upload file information into database(optional)
+
+rails_wangeditor 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_wangeditor:migration
+  or
+  rails generate rails_wangeditor: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
+```
+
+### 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 wangeditor
+
+```ruby
+   <%= form_for @article do |f| %>
+     ...
+     <%= f.wangeditor :content, :owner => @article  %>
+     ...
+   <% end %>
+```
+
+```ruby
+Warnning: the @article must be created before this scene, the @article.id should not be empty.
+```
+
+####2. add has_many_wangeditor_assets in your own model
+
+```ruby
+  class Article < ActiveRecord::Base
+    has_many_wangeditor_assets :attachments, :dependent => :destroy
+    # has_many_wangeditor_assets :attachments, :dependent => :nullify
+    # has_many_wangeditor_assets :your_name, :dependent => :destroy
+  end
+```
+
+####3. relationship
+
+```ruby
+  article = Article.first
+  article.attachments # => the article's assets uploaded by wangeditor
+  asset = article.attachments.first
+  asset.owner # => aritcle
+```
+
+### If you're using mongoid, please add 'gem "carrierwave-mongoid"' in your Gemfile
+
+```ruby
+  gem 'carrierwave-mongoid'
+```
+
+## Thanks
+- 1.Macrow, https://github.com/Macrow/rails_kindeditor
+- 2.wangfupeng1988, https://github.com/wangfupeng1988/wangEditor/
+
+## License
+
+MIT License.

data/Rakefile

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

data/app/assets/javascripts/wangeditor.js

@@ -0,0 +1 @@
+//= require wangEditor

data/app/assets/stylesheets/wangeditor.css

@@ -0,0 +1,3 @@
+/*
+ *= require wangEditor
+ */

data/app/controllers/wangeditor/assets_controller.rb

@@ -0,0 +1,45 @@
+#coding: utf-8
+require "find"
+class Wangeditor::AssetsController < ApplicationController
+  skip_before_filter :verify_authenticity_token
+  def create
+    @imgFile, @dir = params[:imgFile]
+    @dir = 'Image'
+    unless @imgFile.nil?
+      if Wangeditor::AssetUploader.save_upload_info? # save upload info into database
+        begin
+          @asset = "Wangeditor::#{@dir.camelize}".constantize.new(:asset => @imgFile)
+          @asset.owner_id = params[:owner_id] ? params[:owner_id] : 0
+          @asset.owner_type = params[:owner_type] ? params[:owner_type] : ''
+          logger.warn '=====Warning: the owner have not been created, "delete uploaded files automatically" will not work. ====' if defined?(logger) && @asset.owner_id == 0
+          @asset.asset_type = @dir
+          if @asset.save
+            render :text => @asset.asset.url
+          else
+            show_error(@asset.errors.full_messages)
+          end
+        rescue Exception => e
+          show_error(e.to_s)
+        end
+      else # do not touch database
+        begin
+          uploader = "Wangeditor::#{@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
+
+  private
+  def show_error(msg)
+    render :text => ("error|#{msg}")
+  end
+
+end

data/app/uploaders/wangeditor/asset_uploader.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+require 'carrierwave/processing/mime_types'
+
+class Wangeditor::AssetUploader < CarrierWave::Uploader::Base
+
+  EXT_NAMES = {:image => RailsWangeditor.upload_image_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 Wangeditor::AssetUploader.save_upload_info?
+      "#{RailsWangeditor.upload_store_dir}/#{model.asset_type.to_s.underscore.gsub(/(wangeditor\/)|(_uploader)/, '')}/#{model.created_at.strftime("%Y%m")}"
+    else
+      "#{RailsWangeditor.upload_store_dir}/#{self.class.to_s.underscore.gsub(/(wangeditor\/)|(_uploader)/, '')}/#{Time.now.strftime("%Y%m")}"
+    end
+  end
+
+  def cache_dir
+    "#{Rails.root}/tmp/uploads"
+  end
+
+  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 image).each do |s|
+        "Wangeditor::#{s.camelize}".constantize
+      end
+      return true
+    rescue
+      return false
+    end
+  end
+
+end
+

data/app/uploaders/wangeditor/image_uploader.rb

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

data/config/routes.rb

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

data/lib/generators/rails_wangeditor/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    install wangEditor for your application
+
+Example:
+    rails generate rails_wangeditor:install
+
+    This will create:
+        config/rails_wangeditor.rb

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

@@ -0,0 +1,30 @@
+module RailsWangeditor
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    desc "Install wangEditor for your application."
+
+    def copy_wangeditor_files
+      if ::Rails.version < "3.1.0"
+        warn "Warning: rails_wangeditor  only support Rails3.1+!"
+      else
+        template "rails_wangeditor.rb", "config/initializers/rails_wangeditor.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 wangEditor\n", :after => "jquery_ujs\n"
+      else
+        copy_file "application.js", "app/assets/javascripts/application.js"
+      end
+    end
+
+    def insert_or_copy_css_files
+      if File.exist?('app/assets/stylesheets/application.css')
+        insert_into_file "app/assets/stylesheets/application.css", "*= require wangEditor\n", :before => "*= require_self"
+      else
+        copy_file "application.css", "app/assets/stylesheets/application.css"
+      end
+    end
+  end
+end

data/lib/generators/rails_wangeditor/install/templates/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *= require wangEditor
+ *= require_tree .
+ *= require_self
+ */

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

@@ -0,0 +1,16 @@
+// 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 wangEditor
+//= require_tree .
+

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

@@ -0,0 +1,27 @@
+RailsWangeditor.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]
+
+  # replace to your own baidu mapAk
+  config.mapAk = 'zlXbfvvyWN0vrO5toWqGhLspGHMIeFgn';
+
+  # Porcess upload image size
+  # eg: 1600x1600 => 800x800
+  #     1600x800  => 800x400
+  #     400x400   => 400x400  # No Change
+  # config.image_resize_to_limit = [800, 800]
+
+  # if you have config in your rails application like this:
+  # /config/enviroments/production.rb
+  #   # config.action_controller.asset_host = "http://asset.example.com"
+  #   # config.assets.prefix = "assets_prefx"
+  # then you should:
+  #
+  # config.asset_url_prefix = "http://asset.example.com/assets_prefx/" if Rails.env.production?
+
+end

data/lib/generators/rails_wangeditor/migration/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Copy model, migration and uploader to your application.
+
+Example:
+    rails generate rails_wangeditor:migration
+
+    This will create:
+        app/models/wangeditor/asset.rb
+        app/models/wangeditor/image.rb
+        db/migrate/xxxxxxxxx_create_wangeditor_assets.rb
+

data/lib/generators/rails_wangeditor/migration/migration_generator.rb

@@ -0,0 +1,36 @@
+module RailsWangeditor
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+    desc "Copy model and migration to your application."
+    class_option :orm, :type => :string, :aliases => "-o", :default => "active_record", :desc => "ORM options: active_record or mongoid"
+
+    def copy_files
+      orm = options[:orm].to_s
+      orm = "active_record" unless %w{active_record mongoid}.include?(orm)
+      %w(asset image).each do |file|
+        copy_model(orm, file)
+      end
+      if Rails.version < '4.0.0' && Rails.version >= '3.0.0' # insert code for rails3
+        insert_into_file "app/models/wangeditor/asset.rb", "  attr_accessible :asset\n", :after => "before_save :update_asset_attributes\n"
+      end
+      if orm == "active_record"
+        migration_template "migration/migration.rb", "db/migrate/create_wangeditor_assets.rb"
+      end
+    end
+
+   def self.next_migration_number(dirname)
+     if ActiveRecord::Base.timestamped_migrations
+       Time.now.utc.strftime("%Y%m%d%H%M%S")
+     else
+       "%.3d" % (current_migration_number(dirname) + 1)
+     end
+   end
+   
+   private
+   def copy_model(orm, name)
+     template "models/#{orm}/wangeditor/#{name}.rb", "app/models/wangeditor/#{name}.rb"
+   end
+  end
+end
+

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

@@ -0,0 +1,18 @@
+class CreateWangeditorAssets < ActiveRecord::Migration
+  def self.up
+    create_table :wangeditor_assets do |t|
+      t.string :asset
+      t.integer :file_size
+      t.string :file_type
+      t.integer :owner_id
+      t.string :owner_type
+      t.string :asset_type
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :wangeditor_assets
+  end
+end
+

data/lib/generators/rails_wangeditor/migration/templates/models/active_record/wangeditor/asset.rb

@@ -0,0 +1,14 @@
+class Wangeditor::Asset < ActiveRecord::Base
+  self.table_name = 'wangeditor_assets'
+  mount_uploader :asset, Wangeditor::AssetUploader
+  validates_presence_of :asset
+  before_save :update_asset_attributes
+
+  private
+  def update_asset_attributes
+    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_wangeditor/migration/templates/models/active_record/wangeditor/image.rb

@@ -0,0 +1,3 @@
+class Wangeditor::Image < Wangeditor::Asset
+  mount_uploader :asset, Wangeditor::ImageUploader
+end

data/lib/generators/rails_wangeditor/migration/templates/models/mongoid/wangeditor/asset.rb

@@ -0,0 +1,27 @@
+require 'carrierwave/mongoid'
+
+class Wangeditor::Asset
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :file_size, :type => Integer
+  field :file_type, :type => String
+  field :owner_id, :type => Integer
+  field :asset_type, :type => String
+
+  mount_uploader :asset, Wangeditor::AssetUploader
+  validates_presence_of :asset
+  before_save :update_asset_attributes
+
+  def self.collection_name
+    :wangeditor_assets
+  end
+
+  private
+  def update_asset_attributes
+    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_wangeditor/migration/templates/models/mongoid/wangeditor/image.rb

@@ -0,0 +1,3 @@
+class Wangeditor::Image < Wangeditor::Asset
+  mount_uploader :asset, Wangeditor::ImageUploader
+end

data/lib/rails_wangeditor/active_record.rb

@@ -0,0 +1,13 @@
+if defined?(ActiveRecord)
+  ActiveRecord::Base.class_eval do
+    def self.has_many_wangeditor_assets(*args)
+      options = args.extract_options!
+      asset_name = args[0] ? args[0].to_s : 'assets'
+      has_many asset_name.to_sym, :class_name => 'Wangeditor::Asset', :as => :owner, :dependent => options[:dependent]
+      class_name = self.name
+      Wangeditor::Asset.class_eval do
+        belongs_to :owner, :polymorphic => true
+      end
+    end
+  end
+end

data/lib/rails_wangeditor/engine.rb

@@ -0,0 +1,32 @@
+require "rails_wangeditor"
+require "rails"
+require "action_controller"
+
+module RailsWangeditor
+  class Engine < Rails::Engine
+
+    initializer "rails_wangeditor.assets_precompile" do |app|
+      app.config.assets.precompile += RailsWangeditor.assets
+    end
+
+    initializer "rails_wangeditor.simple_form" do
+      require "rails_wangeditor/simple_form" if Object.const_defined?("SimpleForm")
+    end
+
+    initializer "rails_wangeditor.helper_and_builder" do
+      ActiveSupport.on_load :action_view do
+        ActionView::Base.send(:include, RailsWangeditor::Helper)
+        ActionView::Helpers::FormBuilder.send(:include, RailsWangeditor::Builder)
+      end
+    end
+
+    initializer "rails_wangeditor.image_process" do
+      unless RailsWangeditor.image_resize_to_limit.nil?
+        Wangeditor::ImageUploader.class_eval do
+          include CarrierWave::MiniMagick
+          process :resize_to_limit => RailsWangeditor.resize_to_limit
+        end
+      end
+    end
+  end
+end