solidus_editor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d308b4d5299a2742e796bca49e0c64e7f191dca
+  data.tar.gz: e9388636b98d6c598fcdc890a5df7d1241f13ef7
+SHA512:
+  metadata.gz: 3b5139ad7c3090c0cc997b9a07d2f3dbfed67bdd7df98029a67da0faeda4c565bf4a875113398969eb9b3fdca896a704032fe4e877e87b7f37b4547ea7815d6a
+  data.tar.gz: daf696a7c81bf4d240e9134e3842a73c8715be6826b224218e1774fa9a5cd493fc0e8b5bb9a554ea6e94d5e16c30078a5024714f6c35ed6f34e8ce69d43cb47a

data/.gitignore

@@ -0,0 +1,13 @@
+\#*
+*~
+.#*
+.DS_Store
+tmp
+*.gem
+Gemfile.lock
+.rvmrc
+.sass-cache
+coverage
+spec/dummy
+.ruby-version
+.ruby-gemset

data/.hound.yml

@@ -0,0 +1,28 @@
+---
+# Too picky.
+LineLength:
+  Enabled: false
+
+# This should truly be on for well documented gems.
+Documentation:
+  Enabled: false
+
+# Neatly aligned code is to swell.
+SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+# Don't mess with RSpec DSL.
+Blocks:
+  Exclude:
+    - 'spec/**/*'
+
+# We really like the readability with newline in beginning of classes.
+EmptyLinesAroundBlockBody:
+  Enabled: false
+
+EmptyLinesAroundClassBody:
+  Enabled: false
+
+# Avoid contradictory style rules by enforce single quotes.
+StringLiterals:
+  EnforcedStyle: single_quotes

data/.rspec

@@ -0,0 +1,4 @@
+--color
+-f documentation
+-r spec_helper
+-r pry

data/.rubocop.yml

@@ -0,0 +1,8 @@
+---
+inherit_from: .hound.yml
+
+AllCops:
+  Exclude:
+    - spec/dummy/**/*
+    - bin/*
+    - Guardfile

data/.travis.yml

@@ -0,0 +1,21 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - 2.3.1
+env:
+  matrix:
+    - SOLIDUS_BRANCH=v1.0 DB=postgres
+    - SOLIDUS_BRANCH=v1.1 DB=postgres
+    - SOLIDUS_BRANCH=v1.2 DB=postgres
+    - SOLIDUS_BRANCH=v1.3 DB=postgres
+    - SOLIDUS_BRANCH=v1.4 DB=postgres
+    - SOLIDUS_BRANCH=v2.0 DB=postgres
+    - SOLIDUS_BRANCH=master DB=postgres
+    - SOLIDUS_BRANCH=v1.0 DB=mysql
+    - SOLIDUS_BRANCH=v1.1 DB=mysql
+    - SOLIDUS_BRANCH=v1.2 DB=mysql
+    - SOLIDUS_BRANCH=v1.3 DB=mysql
+    - SOLIDUS_BRANCH=v1.4 DB=mysql
+    - SOLIDUS_BRANCH=v2.0 DB=mysql
+    - SOLIDUS_BRANCH=master DB=mysql

data/CONTRIBUTING.md

@@ -0,0 +1,83 @@
+# Contributing
+
+Spree Editor is an open source project and we encourage contributions. Please see the [contributors guidelines](http://spreecommerce.com/documentation/contributing_to_spree.html) for more information before contributing.
+
+In the spirit of [free software][1], **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using prerelease versions
+* by reporting [bugs][2]
+* by suggesting new features
+* by writing [translations][3]
+* by writing or editing documentation
+* by writing specifications
+* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by resolving [issues][2]
+* by reviewing patches
+
+---
+
+## Filing an issue
+
+When filing an issue on this extension, please first do these things:
+
+* Verify you can reproduce this issue in a brand new application.
+* Run through the steps to reproduce the issue again.
+
+In the issue itself please provide:
+
+* A comprehensive list of steps to reproduce the issue.
+* What you're *expecting* to happen compared with what's *actually* happening.
+* The version of Spree *and* the version of Rails.
+* A list of all extensions.
+* Any relevant stack traces ("Full trace" preferred)
+* Your `Gemfile`
+
+In 99% of cases, this information is enough to determine the cause and solution to the problem that is being described.
+
+Any issue that is open for 14 days without actionable information or activity will be marked as "stalled" and then closed. Stalled issues can be re-opened if the information requested is provided.
+
+---
+
+## Pull requests
+
+We gladly accept pull requests to fix bugs and, in some circumstances, add new features to this extension.
+
+Here's a quick guide:
+
+1. Fork the repo.
+
+2. Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate.
+
+3. Create new branch then make changes and add tests for your changes. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need tests!
+
+4. Push to your fork and submit a pull request. If the changes will apply cleanly to the latest stable branches and master branch, you will only need to submit one pull request.
+
+At this point you're waiting on us. We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted, taken straight from the Ruby on Rails guide:
+
+* Use Rails idioms and helpers.
+* Include tests that fail without your code, and pass with it.
+* Update the documentation, the surrounding one, examples elsewhere, guides, whatever is affected by your contribution.
+
+---
+
+## TL;DR
+
+* Fork the repo
+* Clone your repo
+* Run `bundle install`
+* Run `bundle exec rake test_app` to create the test application in `spec/dummy`
+* Make your changes
+* Ensure specs pass by running `bundle exec rspec spec`
+* Ensure all syntax ok by running `rubocop .`
+* Submit your pull request
+
+And in case we didn't emphasize it enough: **we love tests!**
+
+[1]: http://www.fsf.org/licensing/essays/free-sw.html
+[2]: https://github.com/spree-contrib/solidus_editor/issues
+[3]: https://github.com/spree-contrib/solidus_editor/tree/master/config/locales

data/Gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
+gem "solidus", github: "solidusio/solidus", branch: branch
+
+if branch == 'master' || branch >= "v2.0"
+  gem "rails-controller-testing", group: :test
+end
+
+gem 'pg'
+gem 'mysql2'
+
+group :development, :test do
+  gem "pry-rails"
+end
+
+gemspec

data/Guardfile

@@ -0,0 +1,10 @@
+guard "rspec", cmd: "bundle exec rspec", all_on_start: false, all_after_pass: false do
+  watch("spec/spec_helper.rb")                        { "spec" }
+  watch("config/routes.rb")                           { "spec/controllers" }
+  watch(%r{^spec/(.+)_spec\.rb$})                     { |m| "spec/#{m[1]}_spec.rb"}
+  watch(%r{^app/(.+)_decorator\.rb$})                 { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb)$})                        { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb" }
+end

data/LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2016 James Whelton and contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,99 @@
+# Solidus Editor
+
+This extension provides an inline rich-text editor for Solidus. It is based off [spree_editor](https://github.com/spree-contrib/spree_editor). It implements different types of editors:
+
+- [CKEditor][1]
+- [TinyMCE][2]
+
+Please not that this extension is just a simple integration of some pretty complex gems: [`ckeditor`][9] and [`tinymce-rails`][10].
+
+If you have issues, please check their issues trackers first.
+
+---
+
+## Installation
+
+1. Add the Solidus Editor gem to your `Gemfile`:
+  ```ruby
+  gem 'solidus_editor', github: 'solidusio-contrib/solidus_editor', branch: 'master'
+  ```
+
+2. Run:
+  ```sh
+  $ bundle install
+  $ rails g solidus_editor:install
+  ```
+
+3. If using CKEditor, and would like to enable file uploads run the ckeditor generator:
+  ```sh
+  $ rails g ckeditor:install --orm=active_record --backend=paperclip && rake db:migrate
+  ```
+
+4. In order to secure your file uploads to only be accessed by admins you will also need to configure config/initializers/ckeditor.rb:
+  ```ruby
+  config.authorize_with :cancan, Spree::Ability
+  ```
+
+5. In order to precompile CKEditor's generated assets, you will need to add a line in config/initializers/assets.rb:
+  ```ruby
+  Rails.application.config.assets.precompile += %w( ckeditor/*)
+  ```
+---
+
+## Configuration
+
+Preferences can be updated within the admin panel under "configuration" then "rich editor".
+
+Or you may set them with an initializer within your application:
+
+```ruby
+SpreeEditor::Config.tap do |config|
+  config.ids = 'product_description page_body event_body'
+
+  # change the editor to CKEditor
+  config.current_editor = 'CKEditor'
+end
+```
+
+The default preference is:
+
+```ruby
+{
+  enabled: true,
+  current_editor: 'TinyMCE',
+  ids: 'product_description page_body'
+}
+```
+
+---
+
+## Language-Support
+
+To obtain support for multiple languages with TinyMCE add tinymce-rails-langs to your Gemfile:
+
+```ruby
+gem 'tinymce-rails-langs'
+```
+
+TinyMCE will not be loaded unless it finds a language package matching your `Spree::Config.default_locale`.
+
+---
+
+## Contributing
+
+See corresponding [guidelines][8]
+
+---
+
+Copyright (c) 2016 [James Whelton][5] and other [contributors][6], released under the [New BSD License][7]
+
+[1]: http://ckeditor.com
+[2]: http://www.tinymce.com
+[3]: http://www.fsf.org/licensing/essays/free-sw.html
+[4]: https://github.com/solidusio-contrib/solidus_editor/issues
+[5]: https://github.com/Whelton
+[6]: https://github.com/solidusio-contrib/solidus_editor/graphs/contributors
+[7]: https://github.com/solidusio-contrib/solidus_editor/blob/master/LICENSE.md
+[8]: https://github.com/solidusio-contrib/v/blob/master/CONTRIBUTING.md
+[9]: https://github.com/galetahub/ckeditor
+[10]: https://github.com/spohlenz/tinymce-rails

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/common_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus_editor'
+  Rake::Task['common:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/solidus_editor.js

@@ -0,0 +1 @@
+//= require spree/backend

data/app/assets/stylesheets/spree/backend/solidus_editor.css

@@ -0,0 +1,6 @@
+/*
+ *= require spree/backend
+*/
+
+form.edit_product div.left { width: 67%; }
+form.edit_product div.right { width: 30%; }

data/app/controllers/spree/admin/editor_settings_controller.rb

@@ -0,0 +1,21 @@
+module Spree
+  module Admin
+    class EditorSettingsController < ResourceController
+      def update
+        config = Spree::EditorSetting.new
+        preferences = params && params.key?(:preferences) ? params.delete(:preferences) : params
+        preferences.each do |name, value|
+          next unless config.has_preference? name
+          config[name] = value
+        end
+
+        if Spree::Config.has_preference? :show_raw_product_description
+          Spree::Config[:show_raw_product_description] = config[:enabled]
+        end
+
+        flash[:success] = Spree.t(:successfully_updated, resource: Spree.t(:rich_editor))
+        redirect_to edit_admin_editor_settings_path
+      end
+    end
+  end
+end

data/app/models/ckeditor/asset.rb

@@ -0,0 +1,4 @@
+class Ckeditor::Asset < ActiveRecord::Base
+  include Ckeditor::Orm::ActiveRecord::AssetBase
+  include Ckeditor::Backend::Paperclip
+end

data/app/models/ckeditor/attachment_file.rb

@@ -0,0 +1,13 @@
+class Ckeditor::AttachmentFile < Ckeditor::Asset
+  has_attached_file :data
+
+  Ckeditor::AttachmentFile.attachment_definitions[:data][:path] = '/:class/:id/:style/:basename.:extension'
+  Ckeditor::AttachmentFile.attachment_definitions[:data][:url] = '/:class/:id/:style/:basename.:extension'
+
+  validates_attachment_size :data, less_than: 100.megabytes
+  validates_attachment_presence :data
+
+  def url_thumb
+    @url_thumb ||= Ckeditor::Utils.filethumb(filename)
+  end
+end

data/app/models/ckeditor/picture.rb

@@ -0,0 +1,13 @@
+class Ckeditor::Picture < Ckeditor::Asset
+  has_attached_file :data, styles: { content: '800>', thumb: '118x100#' }
+
+  Ckeditor::Picture.attachment_definitions[:data][:path] = '/:class/:id/:style/:basename.:extension'
+  Ckeditor::Picture.attachment_definitions[:data][:url] = '/:class/:id/:style/:basename.:extension'
+
+  validates_attachment_size :data, less_than: 2.megabytes
+  validates_attachment_presence :data
+
+  def url_content
+    url(:content)
+  end
+end

data/app/models/spree/editor_setting.rb

@@ -0,0 +1,11 @@
+module Spree
+  class EditorSetting < Preferences::Configuration
+    preference :enabled,        :boolean, default: true
+    preference :current_editor, :string,  default: 'TinyMCE'
+    preference :ids,            :string,  default: 'product_description page_body'
+
+    def self.editors
+      %w(TinyMCE CKEditor)
+    end
+  end
+end

data/app/overrides/add_rich_editor_tab.rb

@@ -0,0 +1,7 @@
+Deface::Override.new(
+  original:      '35a14f18ffd91f105e1133ec54aec7ce25fcd79e',
+  virtual_path:  'spree/admin/shared/_configuration_menu',
+  name:          'add_rich_editor_tab',
+  insert_bottom: '[data-hook="admin_configurations_sidebar_menu"]',
+  text:          '<%= configurations_sidebar_menu_item Spree.t(:rich_editor), edit_admin_editor_settings_path %>'
+)