redactor2_rails 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef4640dd375e7602b6a40cddc7e8a81a519bc870
+  data.tar.gz: bb50d1f5a411cbc3e3c363d136f18f76aac9cd0e
+SHA512:
+  metadata.gz: fbf6e2dc5d1a213a7b81f7084d198fab70e9bfcea63dbc15084e93c932428c55fa6e977547e72f22580649c62874b2c3b3db48fa7196c2059edf4dadd8542bdf
+  data.tar.gz: 37a5f23deae830e924b09fabcc4f8a5e145acb3dc7c379f6253879d26fdf5dbd5783875ee2f01dbd2f7dcf75a54d94e324a61d39644aa54583febf979ab7859d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redactor2_rails.gemspec
+gemspec
+gem 'rails', '>= 3.2'
+
+platforms :ruby do
+  group :active_record do
+    gem 'carrierwave'
+    gem 'mini_magick'
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Oleg Sulyanov
+
+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,207 @@
+# Imperavi Redactor for Rails 3.x - 4 Asset Pipeline 
+
+redactor2_rails integrates Imperavi Redactor for Rails Asset Pipeline (Rails 4, 3.x versions are supported)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redactor2_rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redactor2_rails
+
+### Generate models for store uploading files
+
+#### ActiveRecord + carrierwave
+Add this lines to your application's Gemfile:
+
+    gem "carrierwave"
+    gem "mini_magick"
+
+And then execute:
+    
+    $ rails generate redactor2:install
+
+or
+
+    $ rails generate redactor2:install --devise
+
+    # --devise option generate user_id attribute for asset(Imeg, File) 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 Images and Files
+
+    $ rake db:migrate
+
+#### Mongoid + carrierwave
+Add this lines to your application's Gemfile:
+
+    gem "carrierwave"
+    gem "carrierwave-mongoid", :require => "carrierwave/mongoid"
+    gem "mini_magick"
+
+    $ rails generate redactor2:install
+
+### Include the Redactor assets
+
+Add to your `application.js`:
+
+      //= require redactor2_rails
+
+Add to your `application.css`:
+
+      *= require redactor2_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 redactor2:config
+
+Then generate `app\assets\redactor2_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\redactor2_rails\config.js` set option
+
+    "lang":'ru'
+
+and
+
+Add to your `application.js`:
+
+    //= require redactor2_rails/langs/ru
+
+#### 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/redactor2_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
+- 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 redactor2_rails/plugins
+
+and add to your `application.css`:
+
+        *= redactor2_rails/plugins
+
+If you would prefer to pick and choose which plugins to include you can
+add for example:
+
+      //= require redactor2_rails/plugins/clips
+
+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": ['fullscreen',
+                    'textdirection',
+                    'clips']
+        });
+
+### Defining a Devise User Model
+
+By default redactor2_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 :redactor2_assets, :user_id, :admin_user_id
+      end
+
+      def down
+        rename_column :redactor2_assets, :admin_user_id, :user_id
+      end
+    end
+
+    # config/initializers/redactor2.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 redactor2_authenticate_user!
+        authenticate_admin_user! # devise before_filter
+      end
+
+      def redactor2_current_user
+        current_admin_user # devise user helper
+      end
+    end
+
+## Statement
+
+`redactor2_rails` base on [SammyLin/redactor-rails](https://github.com/SammyLin/redactor-rails) project.
+
+
+## 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
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+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,2 @@
+require "bundler"
+Bundler::GemHelper.install_tasks

data/app/controller/redactor2_rails/files_controller.rb

@@ -0,0 +1,28 @@
+class Redactor2Rails::FilesController < ApplicationController
+  before_filter :redactor2_authenticate_user!
+
+  def create
+    @file = Redactor2Rails.file_model.new
+
+    file = params[:file]
+    @file.data = Redactor2Rails::Http.normalize_param(file, request)
+    if @file.has_attribute?(:"#{Redactor2Rails.devise_user_key}")
+      @file.send("#{Redactor2Rails.devise_user}=", redactor_current_user)
+      @file.assetable = redactor_current_user
+    end
+
+    if @file.save
+      render json: { url: @file.url, name: @file.filename }
+    else
+      render json: { error: @file.errors }
+    end
+  end
+
+  private
+
+  def redactor2_authenticate_user!
+    if Redactor2Rails.file_model.new.has_attribute?(Redactor2Rails.devise_user)
+      super
+    end
+  end
+end

data/app/controller/redactor2_rails/images_controller.rb

@@ -0,0 +1,28 @@
+class Redactor2Rails::ImagesController < ApplicationController
+  before_filter :redactor2_authenticate_user!
+
+  def create
+    @image = Redactor2Rails.image_model.new
+
+    file = params[:file]
+    @image.data = Redactor2Rails::Http.normalize_param(file, request)
+    if @image.has_attribute?(:"#{Redactor2Rails.devise_user_key}")
+      @image.send("#{Redactor2Rails.devise_user}=", redactor_current_user)
+      @image.assetable = redactor_current_user
+    end
+
+    if @image.save
+      render json: { id: @image.id, url: @image.url(:content) }
+    else
+      render json: { error: @image.errors }
+    end
+  end
+
+  private
+
+  def redactor2_authenticate_user!
+    if Redactor2Rails.image_model.new.has_attribute?(Redactor2Rails.devise_user)
+      super
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redactor2_rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,4 @@
+Redactor2Rails::Engine.routes.draw do
+  resources :images, :only => :create
+  resources :files, :only => :create
+end

data/lib/generators/redactor2/config_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+
+module Redactor2
+  module Generators
+    class ConfigGenerator < ::Rails::Generators::Base
+      desc 'Generates redactor2_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/redactor2_rails', 'config.js')
+      end
+    end
+  end
+end

data/lib/generators/redactor2/install_generator.rb

@@ -0,0 +1,75 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+module Redactor2
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include ::Rails::Generators::Migration
+      desc 'Generates redactor2_rails models, uploaders and migration'
+
+      class_option :orm, :type => :string, :default => 'active_record',
+                   :desc => 'ORM (active_record/mongoid)'
+
+      class_option :upload_processor, :type => :string, :default => 'carrierwave',
+                   :desc => 'Image processor (carrierwave)'
+
+      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 Redactor2Rails::Engine => '/redactor2_rails'"
+      end
+
+      def create_models
+        [:asset, :image, :file].each do |filename|
+          template "#{generator_dir}/redactor2/#{filename}.rb",
+                   File.join('app/models', redactor2_dir, "#{filename}.rb")
+        end
+
+        if upload_processor.to_s == 'carrierwave'
+          [:image, :file].each do |filename|
+            template "#{uploaders_dir}/uploaders/redactor2_rails_#{filename}_uploader.rb",
+                     File.join("app/uploaders", "redactor2_rails_#{filename}_uploader.rb")
+          end
+        end
+      end
+
+      def create_migrations
+        if orm.to_s == "active_record"
+          if ARGV.include?('--devise')
+            migration_template "#{generator_dir}/devise_migration.rb", File.join('db/migrate', 'create_redactor2_assets.rb')
+          else
+            migration_template "#{generator_dir}/migration.rb", File.join('db/migrate', 'create_redactor2_assets.rb')
+          end
+        end
+      end
+
+      protected
+
+      def redactor2_dir
+        'redactor2_rails'
+      end
+
+      def generator_dir
+        @generator_dir ||= [orm, upload_processor].join('/')
+      end
+
+      def uploaders_dir
+        @uploaders_dir ||= ['base', 'carrierwave'].join('/')
+      end
+
+      def orm
+        options[:orm] || 'active_record'
+      end
+
+      def upload_processor
+        options[:upload_processor] || 'carrierwave'
+      end
+
+    end
+  end
+end