solidus_editor 1.0.0

data/app/overrides/include_rich_text_js.rb

@@ -0,0 +1,7 @@
+Deface::Override.new(
+  original:       'e004c3e716cca1f673d5142bdd7c16dc2dc5b403',
+  virtual_path:   'spree/layouts/admin',
+  name:           'include_rich_text_js',
+  insert_bottom:  '[data-hook="admin_footer_scripts"]',
+  text:           '<%= render partial: "shared/rich_editor_javascript" %>'
+)

data/app/views/shared/_rich_editor_javascript.html.erb

@@ -0,0 +1,8 @@
+<% @editor_setting = Spree::EditorSetting.new %>
+<% is_enabled = @editor_setting[:enabled] %>
+<% current_editor = @editor_setting[:current_editor] %>
+<% ids = @editor_setting[:ids].split %>
+
+<% if is_enabled and ids.any? %>
+  <%= render "shared/editor_engines/#{@editor_setting[:current_editor].underscore}", ids: ids %>
+<% end %>

data/app/views/shared/editor_engines/_ck_editor.html.erb

@@ -0,0 +1,11 @@
+<%= javascript_include_tag 'ckeditor/init' %>
+
+<script>
+  $(function() {
+    <% ids.each do |id| %>
+      if ($("#<%= id %>").length > 0) {
+        CKEDITOR.replace("<%= id %>");
+      }
+    <% end %>
+  });
+</script>

data/app/views/shared/editor_engines/_tiny_mce.html.erb

@@ -0,0 +1,24 @@
+<%= javascript_include_tag 'tinymce-jquery' %>
+
+<script>
+  $(function () {
+    /* Inject each textarea id with .tinymce class required for TinyMCE 4 */
+    $('<%= raw ids.each.map{|id| "textarea##{id}" }.join(", ") %>').addClass('tinymce');
+  });
+
+  $(document).ready(function () {
+    $('<%= raw ids.each.map{|id| "textarea##{id}" }.join(", ") %>').tinymce(
+      <%= raw TinyMCE::Rails.configuration.options.to_json %>);
+  });
+</script>
+
+<style type="text/css">
+  /* Reset TinyMCE menu styles */
+  .mce-tinymce button {
+    font-size: inherit !important;
+    text-transform: inherit !important;
+  }
+  .mce-tinymce button:hover {
+    background-color: inherit !important;
+  }
+</style>

data/app/views/spree/admin/editor_settings/edit.html.erb

@@ -0,0 +1,35 @@
+<%= render :partial => 'spree/admin/shared/configuration_menu' %>
+
+<% content_for :page_title do %>
+  <%= Spree.t(:rich_editor) %>
+<% end %>
+
+<%= form_tag admin_editor_settings_path, method: :put do %>
+  <fieldset class="general no-border-top">
+
+    <div class="field">
+      <%= label_tag(:current_editor, Spree.t(:rich_editor_engine)) %>
+      <br />
+      <%= select_tag(:current_editor, options_for_select(Spree::EditorSetting.editors, SpreeEditor::Config[:current_editor]), class: 'select2') %>
+    </div>
+
+    <div class="field">
+      <%= label_tag(:enabled) do %>
+        <%= preference_field_tag(:enabled, SpreeEditor::Config[:enabled], type: :boolean) %>
+        <%= Spree.t(:enable_rich_editor) %>
+      <% end %>
+    </div>
+
+    <div class="field">
+      <%= label_tag(:ids, Spree.t(:rich_editor_ids_description)) %>
+      <br />
+      <%= preference_field_tag(:ids, SpreeEditor::Config[:ids], class: 'control-form') %>
+    </div>
+
+    <div class="form-buttons filter-actions actions" data-hook="buttons">
+      <%= button Spree.t('actions.update'), 'update' %>
+    </div>
+
+
+  </fieldset>
+<% end %>

data/bin/rails

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/solidus_editor/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/initializers/ckeditor.rb

@@ -0,0 +1,21 @@
+# Use this hook to configure ckeditor
+if Object.const_defined?('Ckeditor')
+  Ckeditor.setup do |config|
+    # ==> ORM configuration
+    # Load and configure the ORM. Supports :active_record (default), :mongo_mapper and
+    # :mongoid (bson_ext recommended) by default. Other ORMs may be
+    # available as additional gems.
+    require 'ckeditor/orm/active_record'
+
+    # Allowed image file types for upload.
+    # Set to nil or [] (empty array) for all file types
+    config.image_file_types = %w(jpg jpeg png gif tiff)
+
+    # Allowed attachment file types for upload.
+    # Set to nil or [] (empty array) for all file types
+    # config.attachment_file_types = %w(doc docx xls odt ods pdf rar zip tar swf)
+
+    # Setup authorization to be run as a before filter
+    config.authorize_with :cancan, Spree::Ability
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,9 @@
+---
+en:
+  spree:
+    enable_rich_editor: Enable Rich Editor
+    rich_editor: Rich Editor
+    rich_editor_description: Configure Rich Editor settings.
+    rich_editor_engine: Rich Editor engine
+    rich_editor_ids: Rich Editor Identificators
+    rich_editor_ids_description: "List textarea's ids splitted by spaces here"

data/config/locales/es.yml

@@ -0,0 +1,9 @@
+---
+es:
+  spree:
+    enable_rich_editor: Activar editor avanzado
+    rich_editor: Editor avanzado
+    rich_editor_description: Configurar opciones del editor.
+    rich_editor_engine: Motor del editor avanzado
+    rich_editor_ids: Identificadores del editor avanzado
+    rich_editor_ids_description: "Listar aquí los ids de los textareas, separados por espacios"

data/config/locales/it.yml

@@ -0,0 +1,9 @@
+---
+it:
+  spree:
+    enable_rich_editor: Abilita Editor di Testo
+    rich_editor: Editor di Testo
+    rich_editor_description: Configura Editor di Testo.
+    rich_editor_engine: Motore dell'Editor di Testo
+    rich_editor_ids: ID per l'Editor di Testo
+    rich_editor_ids_description: Elenca qui gli ID delle textarea divisi da spazi

data/config/locales/nl.yml

@@ -0,0 +1,9 @@
+---
+nl:
+  spree:
+    enable_rich_editor: "HTML Editor inschakelen"
+    rich_editor: "HTML Editor"
+    rich_editor_description: "Configureer HTML Editor."
+    rich_editor_engine: "HTML Editor implementatie"
+    rich_editor_ids: "HTML Editor id's"
+    rich_editor_ids_description: "HTML Editor koppelen aan de volgende id's (gescheiden door spaties)"

data/config/locales/ru.yml

@@ -0,0 +1,9 @@
+---
+ru:
+  spree:
+    enable_rich_editor: Включить визуальный редактор
+    rich_editor: Визуальный редактор
+    rich_editor_description: Настройка визуального редактора.
+    rich_editor_engine: Реализация визуального редактора
+    rich_editor_ids: Идентификаторы
+    rich_editor_ids_description: "Перечислите идентификаторы элементов textarea через пробел"

data/config/locales/sv.yml

@@ -0,0 +1,9 @@
+---
+sv:
+  spree:
+    enable_rich_editor: Aktivera Texthanterare
+    rich_editor: Texthanterare
+    rich_editor_description: Konfigurera Texthanterare inställningar.
+    rich_editor_engine: Texthanterare motor
+    rich_editor_ids: Texthanterare identifierare
+    rich_editor_ids_description: "Lista textfältens id-taggar separerade med blanksteg"

data/config/routes.rb

@@ -0,0 +1,5 @@
+Spree::Core::Engine.routes.draw do
+  namespace :admin do
+    resource :editor_settings, only: [:edit, :update]
+  end
+end

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

@@ -0,0 +1,15 @@
+module SolidusEditor
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../../../templates', __FILE__)
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/solidus_editor\n", before: /\*\//, verbose: true
+      end
+
+      def copy_tinymce_file
+        copy_file 'config/tinymce.yml', 'config/tinymce.yml'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module SolidusEditor
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../../../templates', __FILE__)
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/solidus_editor\n", before: /\*\//, verbose: true
+      end
+
+      def copy_tinymce_file
+        copy_file 'config/tinymce.yml', 'config/tinymce.yml'
+      end
+    end
+  end
+end

data/lib/solidus_editor.rb

@@ -0,0 +1,9 @@
+require 'solidus_backend'
+require 'ckeditor'
+require 'coffee_script'
+require 'sass/rails'
+require 'solidus_core'
+require 'solidus_editor/version'
+require 'spree_editor/config'
+require 'solidus_editor/engine'
+require 'tinymce-rails'

data/lib/solidus_editor/engine.rb

@@ -0,0 +1,25 @@
+module SolidusEditor
+  class Engine < Rails::Engine
+    isolate_namespace Spree
+    engine_name 'solidus_editor'
+
+    initializer 'solidus_editor.preferences', before: :load_config_initializers do
+      SpreeEditor::Config = Spree::EditorSetting.new
+
+      if Spree::Config.has_preference? :show_raw_product_description
+        Spree::Config[:show_raw_product_description] = SpreeEditor::Config[:enabled]
+      end
+    end
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    def self.activate
+      cache_klasses = %W(#{config.root}/app/**/*_decorator*.rb)
+      Dir.glob(cache_klasses) do |klass|
+        Rails.configuration.cache_classes ? require(klass) : load(klass)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/solidus_editor/version.rb

@@ -0,0 +1,18 @@
+module SolidusEditor
+  module_function
+
+  # Returns the version of the currently loaded SpreeEditor as a
+  # <tt>Gem::Version</tt>.
+  def version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/lib/spree_editor/config.rb

@@ -0,0 +1,3 @@
+module SpreeEditor
+
+end

data/lib/templates/config/tinymce.yml

@@ -0,0 +1,40 @@
+# Spree Editor TinyMCE Configuration
+#
+# These are the options that will automatically be passed into the tinyMCE.init function
+# whenever TinyMCE is loaded in one of your spree pages. Please edit this file to
+# customise your TinyMCE setup in your spree installation. If you wish to see the full
+# range of configuration options then please go here:
+#
+#    http://www.tinymce.com/wiki.php/configuration
+
+# TinyMCE Options
+mode: "exact"
+theme: "modern"
+language: "<%= I18n.locale.to_s.split('-')[0].downcase %>"
+skin: "lightgray"
+schema: "html5-strict"
+element_format: "html"
+resize: true
+plugins:
+  - layer
+  - table
+  - insertdatetime
+  - preview
+  - media
+  - searchreplace
+  - contextmenu
+  - paste
+  - directionality
+  - fullscreen
+  - noneditable
+  - visualchars
+  - nonbreaking
+  - template
+
+# Each line is a toolbar
+toolbar:
+  - cut copy paste pastetext pasteword | search replace | undo redo | link unlink anchor image cleanup help code | insertdate inserttime preview
+  - bold italic underline strikethrough | justifyleft justifycenter justifyright justifyfull | sub sup | bullist numlist | outdent indent blockquote"
+  - styleselect formatselect fontselect fontsizeselect | forecolor backcolor
+  - tablecontrols | hr removeformat visualaid
+  - fullscreen | charmap media | visualchars blockquote

data/spec/controllers/spree/admin/editor_settings_controller_spec.rb

@@ -0,0 +1,46 @@
+RSpec.describe Spree::Admin::EditorSettingsController, type: :controller do
+  stub_authorization!
+
+  before do
+    reset_spree_preferences
+    user = create(:admin_user)
+    allow(controller).to receive(:try_spree_current_user).and_return(user)
+  end
+
+  context '#update' do
+    it 'redirects to editor settings page' do
+      spree_put :update, preferences: { enabled: true }
+      expect(response).to redirect_to spree.edit_admin_editor_settings_path
+    end
+
+    context 'For parameters:
+              current_editor: CKEditor
+              enabled: true
+              ids: product_description page_body' do
+
+      subject { SpreeEditor::Config }
+
+      it 'sets preferred_current_editor to "CKEditor"' do
+        spree_put :update, preferences: { current_editor: 'CKEditor' }
+        expect(subject.preferred_current_editor).to eq('CKEditor')
+      end
+
+      it 'sets preferred_enabled to true' do
+        spree_put :update, preferences: { enabled: true }
+        expect(subject.preferred_enabled).to be(true)
+      end
+
+      it 'sets preferred_ids to product_description page_body' do
+        spree_put :update, preferences: { ids: 'product_description page_body' }
+        expect(subject.preferred_ids).to eq('product_description page_body')
+      end
+    end
+  end
+
+  context '#edit' do
+    it 'renders the edit template' do
+      spree_get :edit
+      expect(response).to be_success
+    end
+  end
+end

data/spec/features/admin/editor_settings_spec.rb

@@ -0,0 +1,12 @@
+RSpec.feature 'Rich Editor Settings', :js do
+  stub_authorization!
+
+  context '#edit' do
+    scenario 'have default elements' do
+      visit spree.edit_admin_editor_settings_path
+
+      expect(page).to have_field 'ids', with: 'product_description page_body'
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'simplecov'
+SimpleCov.start 'rails'
+
+ENV['RAILS_ENV'] ||= 'test'
+
+begin
+  require File.expand_path('../dummy/config/environment', __FILE__)
+rescue LoadError
+  abort 'Could not load dummy application. Please ensure you have run `bundle exec rake test_app`'
+end
+
+require 'rspec/rails'
+require 'i18n-spec'
+require 'ffaker'
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+  config.mock_with :rspec
+  config.raise_errors_for_deprecations!
+  config.use_transactional_fixtures = false
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+end
+
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |file| require file }

data/spec/support/capybara.rb

@@ -0,0 +1,17 @@
+require 'capybara/rspec'
+require 'capybara/rails'
+require 'capybara/poltergeist'
+
+RSpec.configure do |config|
+  Capybara.javascript_driver = :poltergeist
+
+  Capybara.register_driver(:poltergeist) do |app|
+    Capybara::Poltergeist::Driver.new app, js_errors: true, timeout: 40
+  end
+
+  config.before(:each, :js) do
+    if Capybara.javascript_driver == :selenium
+      page.driver.browser.manage.window.maximize
+    end
+  end
+end

data/spec/support/database_cleaner.rb

@@ -0,0 +1,25 @@
+require 'database_cleaner'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  config.before do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, :js) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before do
+    DatabaseCleaner.start
+  end
+
+  config.after do
+    DatabaseCleaner.clean
+  end
+
+  Capybara.javascript_driver = :poltergeist
+end