shixian-redactor-rails 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 250a4f35c00570b8d83e9079447f08533b560d2de82a51cac96c1cfe699ce8b6
+  data.tar.gz: 0ccc037e7650d29f765f7b61b60e3c7e6e07f05594eca5907592353aa2070baa
+SHA512:
+  metadata.gz: 66d35588eb47e3747d51a894d81610283bf98008f8256f860f4acea0a5dc6ff10de2a5b90a999227474c75bf26b0ea34f6cecbb7fab4ec54a20c90f57d77d8d4
+  data.tar.gz: 3aba1eebe273bd2d9f6f79a5921fcb5a7a0de6cb9497a6b1190b376e008777dddc5c3a5687f2423b95c63d999d70d7caf61751e175eebcacddd9be668b40f211

data/.gitignore

@@ -0,0 +1,19 @@
+/.idea/*
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,25 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redactor-rails.gemspec
+gemspec
+gem "rails", "3.2.3"
+
+
+platforms :ruby do
+  gem "sqlite3"
+
+  group :development do
+    gem "unicorn", "~> 4.0.1"
+  end
+
+  group :development, :test do
+    gem "capybara", ">= 0.4.0"
+    gem "mynyml-redgreen", "~> 0.7.1", :require => 'redgreen'
+  end
+
+  group :active_record do
+    gem "carrierwave"
+    gem "mini_magick"
+  end
+
+end

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sammy
+
+MIT License
+
+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,234 @@
+
+# Rails 3.2 Integration for Redactor (Devise Edition)
+
+The redactor-rails gem integrates the [Redactor](http://redactorjs.com/) editor with the Rails 3.2 asset pipeline.
+
+This gem bundles Redactor version 10.0.4 which is the most recent version as of January 9, 2015. Check [Redactor's changelog](http://imperavi.com/redactor/log/) for further updates.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redactor-rails'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install redactor-rails
+
+### Now generate models for store uploading files
+
+#### ActiveRecord + carrierwave
+
+    gem "carrierwave"
+    gem "mini_magick"
+
+    $ rails generate redactor:install
+
+    or
+
+    $ rails generate redactor:install --devise
+
+    # --devise option generate user_id attribute for asset(Picture, Document) models. For more details show Devise gem.
+    # Now, Pictures and Documents uploading available only for signed in users
+    # All uploaded files will stored with current user_id
+    # User will choose only own uploaded Pictures and Documents
+
+    $ rake db:migrate
+
+#### Mongoid + carrierwave
+    gem "carrierwave"
+    gem "carrierwave-mongoid", :require => "carrierwave/mongoid"
+    gem "mini_magick"
+
+    $ rails generate redactor:install
+
+### Include the Redactor assets
+
+Add to your `application.js`:
+
+      //= require redactor-rails
+
+Add to your `application.css`:
+
+      *= require redactor-rails
+
+### Initialize Redactor
+
+For each textarea that you want to use with Redactor, add the "redactor" class and ensure it has a unique ID:
+
+    <%= text_area_tag :editor, "", :class => "redactor", :rows => 40, :cols => 120 %>
+
+### Custom Your redactor
+
+If you need change some config in redactor, you can
+
+    $ rails generate redactor:config
+
+Then generate `app\assets\redactor-rails\config.js`.
+
+See the [Redactor Documentation](http://imperavi.com/redactor/docs/settings/) for a full list of configuration options.
+
+
+If You Want To setup a new language in Redactor you should do two things:
+
+In you file `app\assets\redactor-rails\config.js` set option
+
+    "lang":'zh_tw'
+
+and
+
+if redactor-rails gem version <= 0.3.7
+
+Add to your layout
+
+
+    <%= redactor_lang('zh_tw') %>
+
+elsif redactor-rails gem version >= 0.4
+
+Add to your `application.js`:
+
+    //= require redactor-rails/langs/zh_tw
+
+#### Setting a max image size with carrierwave
+
+If you want to set a maximum image size used when a user uploads an image via carrierwave, open the uploader file and add add the following:
+
+    # app/uploaders/redactor_rails_picture_uploader.rb:33
+
+    process :resize_to_limit => [500, -1]
+
+The above example will set the image to have a maximum width of 500px.
+
+### Using plugins
+
+This gem comes bundled with several Redactor plugins:
+
+- Fullscreen
+- Clips
+- FontColor
+- FontSize
+- FontFamily
+- Text direction
+
+Full details of these can be found at [Redactor Plugins](http://imperavi.com/redactor/plugins/)
+
+To include all the plugins just add to your `application.js`:
+
+        //= require redactor-rails/plugins
+
+and add to your `application.css`:
+
+        *= redactor-rails/plugins
+
+If you would prefer to pick and choose which plugins to include you can
+add for example:
+
+      //= require redactor-rails/plugins/fontsize
+      //= require redactor-rails/plugins/fontfamily
+
+After including the desired plugins they can be configured in the redactor config file as normal.
+
+To add it into the editor just add 'plugins' attributes to config.js file and specify which ones do you want to use:
+
+      $('.redactor').redactor(
+        { "plugins": ['fontsize',
+                    'fontcolor',
+                    'fontfamily',
+                    'fullscreen',
+                    'textdirection',
+                    'clips']
+        });
+
+### Defining a Devise User Model
+
+By default redactor-rails uses the `User` model.
+
+You may use a different model by:
+
+1. Run a migration to update the user_id column in the
+2. Overriding the user class in an initializer.
+3. Overriding the authentication helpers in your controller.
+
+    Create a new Migration: `rails g rename_user_id_to_new_user_id`
+
+    ```
+    # db/migrate/...rename_user_id_to_new_user_id.rb
+
+    class RenameUserIdToNewUserId < ActiveRecord::Migration
+      def up
+        rename_column :redactor_assets, :user_id, :admin_user_id
+      end
+
+      def down
+        rename_column :redactor_assets, :admin_user_id, :user_id
+      end
+    end
+    ```
+
+    ```
+    # config/initializers/redactor.rb
+    # Overrides the user class
+
+    module RedactorRails
+      def self.devise_user
+        %s(admin_user) # name of your user class
+      end
+
+      # You may override this to support legacy schema.
+      # def self.devise_user_key
+      #   "#{self.devise_user.to_s}_id".to_sym
+      # end
+    end
+    ```
+
+    ```
+    # app/controllers/application_controller.rb
+
+    class ApplicationController < ActionController::Base
+      ...
+
+      def redactor_authenticate_user!
+        authenticate_admin_user! # devise before_filter
+      end
+
+      def redactor_current_user
+        current_admin_user # devise user helper
+      end
+    end
+    ```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Contributors
+
+[Sebastian Wilgosz](https://github.com/wilgoszpl)
+
+## Special Thanks
+
+[wildjcrt (Jerry Lee)](https://github.com/wildjcrt/)
+
+## Statement
+
+`redactor-rails` part of reference [galetahub/ckeditor](https://github.com/galetahub/ckeditor) project.
+
+`redactor-rails` uses MIT-LICENSE. Rock!!!!!
+
+## License
+
+the `redactor-rails` project is MIT-LICENSE.
+
+You may use `Redactor` for non-commercial websites for free, however, we do not guarantee any technical support.
+
+Redactor has [3 different licenses](http://imperavi.com/redactor/download/) for commercial use.
+For details please see [License Agreement](http://imperavi.com/redactor/license/).

data/Rakefile

@@ -0,0 +1,3 @@
+#!/usr/bin/env rake
+require "bundler"
+Bundler::GemHelper.install_tasks

data/app/controller/redactor_rails/documents_controller.rb

@@ -0,0 +1,34 @@
+class RedactorRails::DocumentsController < ApplicationController
+  before_filter :redactor_authenticate_user!
+
+  def index
+    @documents = RedactorRails.document_model.where(
+        RedactorRails.document_model.new.respond_to?(RedactorRails.devise_user) ? { RedactorRails.devise_user_key => redactor_current_user.id } : { })
+    render :json => @documents.to_json
+  end
+
+  def create
+    @document = RedactorRails.document_model.new
+
+    file = params[:file]
+    @document.data = RedactorRails::Http.normalize_param(file, request)
+    if @document.has_attribute?(:"#{RedactorRails.devise_user_key}")
+      @document.send("#{RedactorRails.devise_user}=", redactor_current_user)
+      @document.assetable = redactor_current_user
+    end
+
+    if @document.save
+      render :text => { :filelink => @document.url, :filename => @document.filename }.to_json
+    else
+      render json: { error: @document.errors }
+    end
+  end
+
+  private
+
+  def redactor_authenticate_user!
+    if RedactorRails.document_model.new.has_attribute?(RedactorRails.devise_user)
+      super
+    end
+  end
+end

data/app/controller/redactor_rails/pictures_controller.rb

@@ -0,0 +1,39 @@
+class RedactorRails::PicturesController < ApplicationController
+  before_filter :redactor_authenticate_user!
+
+  def index
+    @pictures = RedactorRails.picture_model.where(
+        RedactorRails.picture_model.new.respond_to?(RedactorRails.devise_user) ? { RedactorRails.devise_user_key => redactor_current_user.id } : { })
+    render :json => @pictures.to_json
+  end
+
+  def create
+    @picture = RedactorRails.picture_model.new
+
+    p "-------------"
+
+    file = params[:file]
+    @picture.data = RedactorRails::Http.normalize_param(file, request)
+    if @picture.has_attribute?(:"#{RedactorRails.devise_user_key}")
+      p 'uuuuuuuu'
+      @picture.send("#{RedactorRails.devise_user}=", redactor_current_user)
+      @picture.assetable = redactor_current_user
+    end
+
+    if @picture.save
+      p "ssssssssss"
+      render :text => { :file_path => @picture.url }.to_json
+    else
+      p "eeeeeeeeeee"
+      render json: { error: @picture.errors }
+    end
+  end
+
+  private
+
+  def redactor_authenticate_user!
+    if RedactorRails.picture_model.new.has_attribute?(RedactorRails.devise_user)
+      super
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+RedactorRails::Engine.routes.draw do
+  resources :pictures,  :only => [:index, :create]
+  resources :documents, :only => [:index, :create]
+end

data/lib/generators/redactor/config_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+
+module Redactor
+  module Generators
+    class ConfigGenerator < ::Rails::Generators::Base
+      desc "Generates redactor-rails config"
+
+      def self.source_root
+	      @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+
+
+      def create_config
+	      template "config.js", File.join('app/assets/javascripts/redactor-rails', "config.js")
+      end
+    end
+  end
+end

data/lib/generators/redactor/install_generator.rb

@@ -0,0 +1,75 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+module Redactor
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include ::Rails::Generators::Migration
+      desc "Generates migration for Tag and Tagging models"
+
+      class_option :orm, :type => :string, :default => "active_record",
+  :desc => "Backend processor for upload support"
+
+      class_option :backend, :type => :string, :default => 'carrierwave',
+  :desc => "carrierwave(default)"
+
+      def self.source_root
+  @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+
+      def self.next_migration_number(dirname)
+  Time.now.strftime("%Y%m%d%H%M%S")
+      end
+
+      def mount_engine
+  route "mount RedactorRails::Engine => '/redactor_rails'"
+      end
+
+      def create_models
+  [:asset, :picture, :document].each do |filename|
+    template "#{generator_dir}/redactor/#{filename}.rb",
+    File.join('app/models', redactor_dir, "#{filename}.rb")
+  end
+
+  if backend == "carrierwave"
+    [:picture, :document].each do |filename|
+      template "#{uploaders_dir}/uploaders/redactor_rails_#{filename}_uploader.rb",
+        File.join("app/uploaders", "redactor_rails_#{filename}_uploader.rb")
+    end
+  end
+      end
+
+      def create_redactor_migration
+        if orm.to_s == "active_record"
+          if ARGV.include?('--devise')
+            migration_template "#{generator_dir}/devise_migration.rb", File.join('db/migrate', "create_redactor_assets.rb")
+          else
+            migration_template "#{generator_dir}/migration.rb", File.join('db/migrate', "create_redactor_assets.rb")
+          end
+        end
+      end
+
+      protected
+
+      def redactor_dir
+  'redactor_rails'
+      end
+
+      def generator_dir
+  @generator_dir ||= [orm, backend].join('/')
+      end
+
+      def uploaders_dir
+  @uploaders_dir ||= ['base', 'carrierwave'].join('/')
+      end
+
+      def orm
+  options[:orm] || "active_record"
+      end
+
+      def backend
+  options[:backend] || "carrierwave"
+      end
+
+    end
+  end
+end

data/lib/generators/redactor/templates/active_record/carrierwave/devise_migration.rb

@@ -0,0 +1,30 @@
+class CreateRedactorAssets < ActiveRecord::Migration
+  def self.up
+    create_table :redactor_assets do |t|
+      t.integer :user_id
+      t.string  :data_file_name, :null => false
+      t.string  :data_content_type
+      t.integer :data_file_size
+
+      t.integer :assetable_id
+      t.string  :assetable_type, :limit => 30
+      t.string  :type, :limit => 30
+
+      # Uncomment	it to save images dimensions, if your need it
+      t.integer :width
+      t.integer :height
+
+      t.timestamps
+    end
+
+    # Uncomment it to add foreign key. gem 'foreigner' is required in your .Gemfile
+    # add_foreign_key(:redactor_assets, :users, dependent: :delete)
+    add_index "redactor_assets", ["assetable_type", "type", "assetable_id"], :name => "idx_redactor_assetable_type"
+    add_index "redactor_assets", ["assetable_type", "assetable_id"], :name => "idx_redactor_assetable"
+  end
+
+  def self.down
+    drop_table :redactor_assets
+  end
+end
+

data/lib/generators/redactor/templates/active_record/carrierwave/migration.rb

@@ -0,0 +1,28 @@
+class CreateRedactorAssets < ActiveRecord::Migration
+  def self.up
+    create_table :redactor_assets do |t|
+      t.string  :data_file_name, :null => false
+      t.string  :data_content_type
+      t.integer :data_file_size
+
+      t.integer :assetable_id
+      t.string  :assetable_type, :limit => 30
+      t.string  :type, :limit => 30
+
+      # Uncomment	it to save images dimensions, if your need it
+      t.integer :width
+      t.integer :height
+
+      t.timestamps
+    end
+
+    # Uncomment it to add foreign key. gem 'foreigner' is required in your .Gemfile
+    # add_foreign_key(:redactor_assets, :users, dependent: :delete)
+    add_index "redactor_assets", ["assetable_type", "type", "assetable_id"], :name => "idx_redactor_assetable_type"
+    add_index "redactor_assets", ["assetable_type", "assetable_id"], :name => "idx_redactor_assetable"
+  end
+
+  def self.down
+    drop_table :redactor_assets
+  end
+end

data/lib/generators/redactor/templates/active_record/carrierwave/redactor/asset.rb

@@ -0,0 +1,5 @@
+class RedactorRails::Asset < ActiveRecord::Base
+  include RedactorRails::Orm::ActiveRecord::AssetBase
+  delegate :url, :current_path, :size, :content_type, :filename, :to => :data
+  validates_presence_of :data
+end

data/lib/generators/redactor/templates/active_record/carrierwave/redactor/document.rb

@@ -0,0 +1,11 @@
+class RedactorRails::Document < RedactorRails::Asset
+  mount_uploader :data, RedactorRailsDocumentUploader, :mount_on => :data_file_name
+
+  def url_content
+    url(:content)
+  end
+
+  def as_json_methods
+    [:image]
+  end
+end

data/lib/generators/redactor/templates/active_record/carrierwave/redactor/picture.rb

@@ -0,0 +1,7 @@
+class RedactorRails::Picture < RedactorRails::Asset
+  mount_uploader :data, RedactorRailsPictureUploader, :mount_on => :data_file_name
+
+  def url_content
+    url(:content)
+  end
+end

data/lib/generators/redactor/templates/base/carrierwave/uploaders/redactor_rails_document_uploader.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+class RedactorRailsDocumentUploader < CarrierWave::Uploader::Base
+  include RedactorRails::Backend::CarrierWave
+
+  # storage :fog
+  storage :file
+
+  def store_dir
+    "system/redactor_assets/documents/#{model.id}"
+  end
+
+  def extension_white_list
+    RedactorRails.document_file_types
+  end
+end

data/lib/generators/redactor/templates/base/carrierwave/uploaders/redactor_rails_picture_uploader.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+class RedactorRailsPictureUploader < CarrierWave::Uploader::Base
+  include RedactorRails::Backend::CarrierWave
+
+  # Include RMagick or ImageScience support:
+  # include CarrierWave::RMagick
+  include CarrierWave::MiniMagick
+  # include CarrierWave::ImageScience
+
+  # Choose what kind of storage to use for this uploader:
+  storage :file
+
+  # 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
+    "system/redactor_assets/pictures/#{model.id}"
+  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
+
+  process :read_dimensions
+
+  # Create different versions of your uploaded files:
+  version :thumb do
+    process :resize_to_fill => [118, 100]
+  end
+
+  version :content do
+    process :resize_to_limit => [800, 800]
+  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
+    RedactorRails.image_file_types
+  end
+
+  # Override the filename of the uploaded files:
+  # Avoid using model.id or version_name here, see uploader/store.rb for details.
+  # def filename
+  #   "something.jpg" if original_filename
+  # end
+end

data/lib/generators/redactor/templates/config.js

@@ -0,0 +1,22 @@
+window.init_redactor = function(){
+  var csrf_token = $('meta[name=csrf-token]').attr('content');
+  var csrf_param = $('meta[name=csrf-param]').attr('content');
+  var params;
+  if (csrf_param !== undefined && csrf_token !== undefined) {
+      params = csrf_param + "=" + encodeURIComponent(csrf_token);
+  }
+  $('.redactor').redactor({
+        // You can specify, which ones plugins you need.
+        // If you want to use plugins, you have add plugins to your
+        // application.js and application.css files and uncomment the line below:
+        // "plugins": ['fontsize', 'fontcolor', 'fontfamily', 'fullscreen', 'textdirection', 'clips'],
+        "imageUpload":"/redactor_rails/pictures?" + params,
+        "imageGetJson":"/redactor_rails/pictures",
+        "fileUpload":"/redactor_rails/documents?" + params,
+        "fileGetJson":"/redactor_rails/documents",
+        "path":"/assets/redactor-rails",
+        "css":"style.css"
+      });
+}
+
+$(document).on( 'ready page:load', window.init_redactor );

data/lib/generators/redactor/templates/mongoid/carrierwave/redactor/asset.rb

@@ -0,0 +1,9 @@
+class RedactorRails::Asset
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  include RedactorRails::Orm::Mongoid::AssetBase
+
+  delegate :url, :current_path, :size, :content_type, :filename, :to => :data
+  validates_presence_of :data
+end