refinerycms-redactor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1534eec50abc900d2e071a831910225af443549
+  data.tar.gz: f65c70b4f42d26d533f038d1889b1d3b746d23ac
+SHA512:
+  metadata.gz: 501e798c7a52039971cbc7a51ffa7da2824e2108a68b134e7dacdf28b864b23a950da73085ddb03925f16ca5d3da0f6ad8ed44d2b5eb828efd2c39deb6e77c3a
+  data.tar.gz: 6ae3ae276fb565ab31597782f9243f176b310c7f13c3a6a7227164198756b83a1f986b38f00f0586e78f7fb96791d277df0592c86af1516657fa3b1e84129d22

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Josh McArthur
+
+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/Rakefile

@@ -0,0 +1,39 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RefineryRedactor'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+ENGINE_PATH = File.dirname(__FILE__)
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+
+if File.exists?(APP_RAKEFILE)
+    load 'rails/tasks/engine.rake'
+end
+
+require "refinerycms-testing"
+Refinery::Testing::Railtie.load_dummy_tasks(ENGINE_PATH)
+
+
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+
+Bundler::GemHelper.install_tasks
+
+
+task default: :spec

data/app/controllers/refinery/redactor/images_controller.rb

@@ -0,0 +1,17 @@
+module Refinery
+  module Redactor
+    class ImagesController < ::Refinery::AdminController
+
+      def create
+        @image = Refinery::Image.new(image: params[:file])
+
+        if @image.save
+          render json: {filelink: @image.url}
+        else
+          render json: {errors: @image.errors}, status: :not_acceptable
+        end
+      end
+
+    end
+  end
+end

data/app/controllers/refinery/redactor/resources_controller.rb

@@ -0,0 +1,17 @@
+module Refinery
+  module Redactor
+    class ResourcesController < ::Refinery::AdminController
+
+      def create
+        @resource = Refinery::Resource.new(file: params[:file])
+
+        if @resource.save
+          render json: {filelink: @resource.url}
+        else
+          render json: {errors: @resource.errors}, status: :not_acceptable
+        end
+      end
+
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+Refinery::Core::Engine.routes.draw do
+  post '/redactor_images/' => 'redactor/images#create'
+  post '/redactor_resources/' => 'redactor/resources#create'
+end

data/lib/generators/refinery/redactor/redactor_generator.rb

@@ -0,0 +1,30 @@
+module Refinery
+  class RedactorGenerator < Rails::Generators::Base
+    desc "Generates configuration file for Redactor to use in Refinery"
+    source_root File.expand_path('../templates', __FILE__)
+
+
+    def create_redactor_stubs
+      say_status "Warning", "
+        Due to licensing, refinery-redactor does not come
+        with Redactor packaged. You need to purchase a license
+        and download Redactor yourself. There are just two files
+        you need: redactor.js and redactor.css. We have generated
+        placeholder files for you in
+        app/assets/javascripts/refinery-redactor
+        and app/assets/stylesheets/refinery-redactor
+        that currently alert you to Redactor not being present -
+        simply replace those files with the respective files from
+        your Redactor download.
+      ", :red
+
+      template "redactor.js", File.join(destination_root, 'app', 'assets', 'javascripts', 'refinery-redactor', 'redactor.js')
+      template "redactor.css", File.join(destination_root, 'app', 'assets', 'stylesheets', 'refinery-redactor', 'redactor.css')
+    end
+
+    def create_config
+      template "config.js", File.join(destination_root, 'app', 'assets', 'javascripts', 'refinery-redactor', 'config.js')
+    end
+  end
+end
+

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

@@ -0,0 +1,117 @@
+/*
+ * This is your config file for the Redactor editor within Refinery ONLY.
+ * It accepts any of the settings listed here: http://imperavi.com/redactor/docs/settings/
+ *
+ * NOTE: Image and file upload settings are already set for you in order to support
+ * uploading to Refinery (you don't need to provide settings for these here.
+ */
+RefineryRedactor.CONFIG = {
+  lang: 'en',
+  direction: 'ltr', // ltr or rtl
+
+  // By default the following plugins are available by default:
+  // - textdirection
+  // - fullscreen
+  // - clips
+  // - fontfamily
+  // - fontsize
+  // - fontcolor
+  plugins: false, // array
+
+  focus: false,
+  focusEnd: false,
+
+  placeholder: false,
+
+  visual: true,
+  tabindex: false,
+
+  minHeight: false,
+  maxHeight: false,
+
+  linebreaks: false,
+  replaceDivs: true,
+  paragraphize: true,
+  cleanStyleOnEnter: false,
+  enterKey: true,
+
+  cleanOnPaste: true,
+  cleanSpaces: true,
+  pastePlainText: false,
+
+  autosave: false, // false or url
+  autosaveName: false,
+  autosaveInterval: 60, // seconds
+  autosaveOnChange: false,
+
+  linkTooltip: true,
+  linkProtocol: 'http',
+  linkNofollow: false,
+  linkSize: 50,
+
+  imageEditable: true,
+  imageLink: true,
+  imagePosition: true,
+  imageFloatMargin: '10px',
+  imageResizable: true,
+
+  dragImageUpload: true,
+
+  convertLinks: true,
+  convertUrlLinks: true,
+  convertImageLinks: true,
+  convertVideoLinks: true,
+
+  preSpaces: 4, // or false
+  tabAsSpaces: false, // true or number of spaces
+  tabFocus: true,
+
+  scrollTarget: false,
+
+  toolbar: true,
+  toolbarFixed: true,
+  toolbarFixedTarget: document,
+  toolbarFixedTopOffset: 0, // pixels
+  toolbarExternal: false, // ID selector
+  toolbarOverflow: false,
+
+  buttonSource: true,
+  buttons: ['html', 'formatting', 'bold', 'italic', 'deleted', 'unorderedlist', 'orderedlist',
+    'outdent', 'indent', 'image', 'file', 'link', 'alignment', 'horizontalrule'], // + 'underline'
+
+  buttonsHide: [],
+  buttonsHideOnMobile: [],
+
+  formatting: ['p', 'blockquote', 'pre', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6'],
+  formattingAdd: false,
+
+  tabifier: true,
+
+  deniedTags: ['html', 'head', 'link', 'body', 'meta', 'script', 'style', 'applet'],
+  allowedTags: false, // or array
+
+  removeComments: false,
+  removeDataAttr: false,
+
+  removeAttr: false, // or multi array
+  allowedAttr: false, // or multi array
+
+  removeWithoutAttr: ['span'], // or false
+  removeEmpty: ['p'], // or false;
+
+  activeButtons: ['deleted', 'italic', 'bold', 'underline', 'unorderedlist', 'orderedlist',
+    'alignleft', 'aligncenter', 'alignright', 'justify'],
+  activeButtonsStates: {
+    b: 'bold',
+    strong: 'bold',
+    i: 'italic',
+    em: 'italic',
+    del: 'deleted',
+    strike: 'deleted',
+    ul: 'unorderedlist',
+    ol: 'orderedlist',
+    u: 'underline'
+  }
+};
+
+

data/lib/generators/refinery/redactor/templates/redactor.css

@@ -0,0 +1,9 @@
+#admin_container #page:before {
+  content: "Redactor stylesheet is missing - see https://github.com/rabid/refinerycms-redactor#installing-redactor";
+  padding: 10px;
+  margin-bottom: 10px;
+  display: block;
+  border: 1px solid #A00027;
+  color: #A00027;
+  background: #FFB1B1;
+}

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

@@ -0,0 +1,3 @@
+if ($.fn.redactor === undefined) {
+  console.error("Redactor javascript is missing - see https://github.com/rabid/refinerycms-redactor#installing-redactor");
+}

data/lib/refinery/redactor.rb

@@ -0,0 +1,12 @@
+module Refinery
+  module Redactor
+    class << self
+      def root
+        @root ||= Pathname.new(File.expand_path('../../../', __FILE__))
+      end
+    end
+
+    require 'refinery/redactor/version'
+    require 'refinery/redactor/engine'
+  end
+end

data/lib/refinery/redactor/engine.rb

@@ -0,0 +1,44 @@
+module Refinery
+  module Redactor
+    class Engine < ::Rails::Engine
+      include Refinery::Engine
+
+      isolate_namespace Refinery
+      engine_name :refinery_redactor
+
+      # set the manifests and assets to be precompiled
+      config.to_prepare do
+        Rails.application.config.assets.precompile += %w(
+          refinery-redactor/index.css
+          refinery-redactor/plugins.css
+          refinery-redactor/plugins.js
+          refinery-redactor/index.js
+        )
+      end
+
+      before_inclusion do
+        Refinery::Plugin.register do |plugin|
+          plugin.pathname = root
+          plugin.name = "refinerycms_redactor"
+          plugin.hide_from_menu = true
+          plugin.menu_match = %r{refinery/redactor/(images|resources)}
+          plugin.always_allow_access = true
+        end
+      end
+
+      config.after_initialize do
+        Refinery.register_engine Refinery::Redactor
+      end
+
+      after_inclusion do
+        %w(refinery-redactor/plugins refinery-redactor/index).each do |stylesheet|
+          Refinery::Core.config.register_visual_editor_stylesheet stylesheet
+        end
+
+        %W(refinery-redactor/plugins refinery-redactor/index).each do |javascript|
+          Refinery::Core.config.register_visual_editor_javascript javascript
+        end
+      end
+    end
+  end
+end

data/lib/refinery/redactor/version.rb

@@ -0,0 +1,5 @@
+module Refinery
+  module Redactor
+    VERSION = "0.0.1"
+  end
+end

data/lib/refinerycms-redactor.rb

@@ -0,0 +1,2 @@
+require 'refinerycms-core'
+require 'refinery/redactor'

data/lib/tasks/refinery_redactor_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :refinery_redactor do
+#   # Task goes here
+# end

data/spec/controller/refinery/redactor/images_controller_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+module Refinery
+  module Redactor
+    describe ImagesController, type: :controller do
+      refinery_login_with :refinery
+
+      describe "POST create" do
+        subject { post :create, file: file }
+
+        context "is valid" do
+          let(:file) do
+            fixture_file_upload(File.join(Refinery::Redactor.root, 'spec', 'fixtures', 'image.jpg'))
+          end
+
+          it "persists record" do
+            expect {
+              subject
+            }.to change(Refinery::Image, :count).by(1)
+          end
+
+          it "responds with correct JSON" do
+            subject
+            expect(JSON.parse(response.body)).to have_key "filelink"
+          end
+        end
+
+        context "is not valid" do
+          let(:file) { nil }
+          it "returns correct status code" do
+            subject
+            expect(response.status).to eq 406
+          end
+
+          it "returns errors" do
+            subject
+            expect(JSON.parse(response.body)).to have_key "errors"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/controller/refinery/redactor/resources_controller_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+module Refinery
+  module Redactor
+    describe ResourcesController, type: :controller do
+      refinery_login_with :refinery
+
+      describe "POST create" do
+        subject { post :create, file: file }
+
+        context "is valid" do
+          let(:file) do
+            fixture_file_upload(File.join(Refinery::Redactor.root, 'spec', 'fixtures', 'file.csv'))
+          end
+
+          it "persists record" do
+            expect {
+              subject
+            }.to change(Refinery::Resource, :count).by(1)
+          end
+
+          it "responds with correct JSON" do
+            subject
+            expect(JSON.parse(response.body)).to have_key "filelink"
+          end
+        end
+
+        context "is not valid" do
+          let(:file) { nil }
+          it "returns correct status code" do
+            subject
+            expect(response.status).to eq 406
+          end
+
+          it "returns errors" do
+            subject
+            expect(JSON.parse(response.body)).to have_key "errors"
+          end
+        end
+      end
+    end
+  end
+end