solidus_product_description_editor 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b1de4cebfca7023de10b3e6e2cb39f91e05b48a
+  data.tar.gz: 864c0324f37c927fb00d22ed8a76e44849873311
+SHA512:
+  metadata.gz: 72fe3070fd8029dd82011602d3bd16894963f645eaac884c6a4472f813070182b77cf68b5b003c9ad94afefea487221c93565f439a722a1ab981cadd6f7aa394
+  data.tar.gz: 30bfc2c35c211c463e4a4fef9ef7d66755db69bf0051b6653927102389664ace29da1d2362ea0de42f23bdd94918898de4080c515f6680ecf01dabf9dfb7e8d4

data/.gitignore

@@ -0,0 +1,14 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy

data/.hound.yml

@@ -0,0 +1,21 @@
+---
+# 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/**/*'
+
+# Avoid contradictory style rules by enforce single quotes.
+StringLiterals:
+  EnforcedStyle: single_quotes

data/.rspec

@@ -0,0 +1,3 @@
+--color
+-r spec_helper
+-f documentation

data/.rubocop.yml

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

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+sudo: false
+cache: bundler
+before_script:
+  - sh -e /etc/init.d/xvfb start
+  - export DISPLAY=:99.0
+  - bundle exec rake test_app
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 1.0.1 / 2016-10-22
+* Initial release

data/CONTRIBUTING.md

@@ -0,0 +1,83 @@
+# Contributing
+
+*(Originally copied from [Spree Static Content's Contribution guidelines](https://github.com/spree-contrib/spree_static_content/blob/master/CONTRIBUTING.md)*
+
+Solidus Product Description Editor is an open source project and we encourage contributions.
+
+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 Solidus *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.
+
+---
+
+## 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/whelton/solidus_product_description_editor/issues
+[3]: https://github.com/whelton/solidus_product_description_editor/tree/master/config/locales

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "solidus", github: "solidusio/solidus", branch: "master"
+
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+guard 'rspec', cmd: 'bundle exec rspec' do
+  watch('spec/spec_helper.rb')                        { 'spec' }
+  watch('config/routes.rb')                           { 'spec/controllers' }
+  watch('app/controllers/application_controller.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|lib)/(.+)(\.rb|\.erb)$})             { |m| "spec/#{m[2]}_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,37 @@
+# Solidus Product Description Editor
+
+Adds a WYSIWYG editor to the product description field in the admin.
+Presently [CKEditor](http://ckeditor.com/).
+
+**Note:** The CKEditor files are accessed from a CDN and not bundled into the gem.
+If you're paranoid about remote javascript, perhaps give it a miss.
+
+![Solidus Product Description Editor Screenshot](https://raw.githubusercontent.com/Whelton/solidus_product_description_editor/master/screenshot.png)
+
+---
+
+## Basic Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'solidus_product_description_editor'
+```
+
+That's it!
+
+---
+
+## Contributing
+
+See corresponding [guidelines][1] and check out the [issues][2].
+
+---
+
+Copyright (c) 2016 [James Whelton][3] and [contributors][4], released under the [New BSD License][5]
+
+[1]: https://github.com/whelton/solidus_product_description_editor/blob/master/CONTRIBUTING.md
+[2]: https://github.com/whelton/solidus_product_description_editor/issues
+[3]: https://github.com/whelton
+[4]: https://github.com/whelton/solidus_product_description_editor/graphs/contributors
+[5]: https://github.com/whelton/solidus_product_description_editor/blob/master/LICENSE.md

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_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_product_description_editor'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/overrides/add_description_editor_to_admin_products_form.rb

@@ -0,0 +1,7 @@
+Deface::Override.new(
+  original: 'ae5fbdbfdad589150842ace6b1f18cc2dde46d5b',
+  virtual_path: 'spree/admin/products/_form',
+  name: 'add_description_editor_to_admin_products_form',
+  insert_bottom: '[data-hook="admin_product_form_description"]',
+  partial: 'spree/admin/products/form/description_editor'
+)

data/app/views/spree/admin/products/form/_description_editor.html.erb

@@ -0,0 +1,45 @@
+<!-- Product Description Editor -->
+<textarea name="product_description_editor" id="product_description_editor" rows="22">
+    <%= @product.description.html_safe %>
+</textarea><!-- /#product_description_editor -->
+
+<!-- Styling -->
+<style>
+  /* Hide Product Description Textarea */
+  textarea#product_description {
+    display: none;
+  }
+</style>
+
+<!-- Scripts -->
+<script src="//cdn.ckeditor.com/4.5.6/full/ckeditor.js"></script>
+<script>
+  $( document ).ready(function() {
+    // Initialize the editor with configuration
+    var productDescriptionEditor = CKEDITOR.replace('product_description_editor', {
+      toolbar: [
+        { name: 'document', groups: [ 'mode', 'document', 'doctools' ], items: [ 'Source', '-', 'Preview', '-', 'Maximize'] },
+        { name: 'clipboard', groups: [ 'clipboard', 'undo' ], items: [ 'Cut', 'Copy', 'Paste', 'PasteText', 'PasteFromWord', '-', 'Undo', 'Redo' ] },
+        { name: 'links', items: [ 'Link', 'Unlink', 'Anchor' ] },
+        { name: 'insert', items: [ 'Image', 'Table', 'HorizontalRule', 'SpecialChar' ] },
+        { name: 'paragraph', groups: [ 'list', 'indent', 'blocks', 'align', 'bidi' ], items: [ 'NumberedList', 'BulletedList', '-', 'Outdent', 'Indent', '-', 'Blockquote', 'CreateDiv', '-', 'JustifyLeft', 'JustifyCenter', 'JustifyRight', 'JustifyBlock' ] },
+        '/',
+        { name: 'styles', items: [ 'Styles', 'Format', 'Font', 'FontSize' ] },
+        { name: 'colors', items: [ 'TextColor', 'BGColor' ] },
+        { name: 'basicstyles', groups: [ 'basicstyles', 'cleanup' ], items: [ 'Bold', 'Italic', 'Underline', 'Strike', 'Subscript', 'Superscript', '-', 'RemoveFormat' ] }
+      ],
+      toolbar_mini : [
+        { name: 'paragraph', groups: [ 'list', 'indent', 'blocks', 'align', 'bidi' ], items: [ 'NumberedList', 'BulletedList', '-', 'Outdent', 'Indent', '-', 'Blockquote', 'CreateDiv', '-', 'JustifyLeft', 'JustifyCenter', 'JustifyRight', 'JustifyBlock' ] },
+        { name: 'styles', items: [ 'Font', 'FontSize' ] },
+        { name: 'colors', items: [ 'TextColor', 'BGColor' ] },
+        { name: 'basicstyles', groups: [ 'basicstyles', 'cleanup' ], items: [ 'Bold', 'Italic', 'Underline', 'Strike', 'Subscript', 'Superscript', '-', 'RemoveFormat' ] },
+        { name: 'insert', items: [ 'Image', 'Table', 'HorizontalRule', 'SpecialChar' ] }
+      ]
+    });
+
+    // On form submit, set the content of the (hidden) description field to the html
+    $('#edit_product_<%= @product.id.to_s %>').on('submit', function(){
+      $('#product_description').val( productDescriptionEditor.getData() );
+    });
+  });
+</script>

data/bin/rails

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

data/lib/solidus_product_description_editor.rb

@@ -0,0 +1,2 @@
+require 'solidus_core'
+require 'solidus_product_description_editor/engine'

data/lib/solidus_product_description_editor/engine.rb

@@ -0,0 +1,15 @@
+module SolidusProductDescriptionEditor
+  class Engine < Rails::Engine
+    engine_name 'solidus_product_description_editor'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+    
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../../app/**/*_decorator*.rb")) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/solidus_product_description_editor/version.rb

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

data/solidus_product_description_editor.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'solidus_product_description_editor/version'
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'solidus_product_description_editor'
+  s.version     = SolidusProductDescriptionEditor.version
+  s.summary     = 'Adds a WYSIWYG editor to the product description field in admin'
+  s.description = s.summary
+  s.required_ruby_version = '>= 2.0.0'
+
+  s.author    = 'James Whelton'
+  s.email     = 'james@whelton.io'
+  s.homepage  = 'https://github.com/whelton/solidus_product_description_editor'
+  s.license   = 'BSD-3'
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_dependency 'solidus_core', '~> 1.1'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+# Run Coverage report
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec/dummy'
+  add_group 'Controllers', 'app/controllers'
+  add_group 'Helpers', 'app/helpers'
+  add_group 'Mailers', 'app/mailers'
+  add_group 'Models', 'app/models'
+  add_group 'Views', 'app/views'
+  add_group 'Libraries', 'lib'
+end
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/environment.rb', __FILE__)
+
+require 'rspec/rails'
+require 'database_cleaner'
+require 'ffaker'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
+
+# Requires factories and other useful helpers defined in spree_core.
+require 'spree/testing_support/authorization_helpers'
+require 'spree/testing_support/capybara_ext'
+require 'spree/testing_support/controller_requests'
+require 'spree/testing_support/factories'
+require 'spree/testing_support/url_helpers'
+
+# Requires factories defined in lib/solidus_product_description_editor/factories.rb
+require 'solidus_product_description_editor/factories'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  # Infer an example group's spec type from the file location.
+  config.infer_spec_type_from_file_location!
+
+  # == URL Helpers
+  #
+  # Allows access to Spree's routes in specs:
+  #
+  # visit spree.admin_path
+  # current_path.should eql(spree.products_path)
+  config.include Spree::TestingSupport::UrlHelpers
+
+  # == Requests support
+  #
+  # Adds convenient methods to request Spree's controllers
+  # spree_get :index
+  config.include Spree::TestingSupport::ControllerRequests, type: :controller
+
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+  config.color = true
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # Capybara javascript drivers require transactional fixtures set to false, and we use DatabaseCleaner
+  # to cleanup after each test instead.  Without transactional fixtures set to false the records created
+  # to setup a test will be unavailable to the browser, which runs under a separate server instance.
+  config.use_transactional_fixtures = false
+
+  # Ensure Suite is set to use transactions for speed.
+  config.before :suite do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  # Before each spec check if it is a Javascript test and switch between using database transactions or not where necessary.
+  config.before :each do
+    DatabaseCleaner.strategy = RSpec.current_example.metadata[:js] ? :truncation : :transaction
+    DatabaseCleaner.start
+  end
+
+  # After each spec clean the database.
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+
+  config.fail_fast = ENV['FAIL_FAST'] || false
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: solidus_product_description_editor
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- James Whelton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solidus_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Adds a WYSIWYG editor to the product description field in admin
+email: james@whelton.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE.md
+- README.md
+- Rakefile
+- app/overrides/add_description_editor_to_admin_products_form.rb
+- app/views/spree/admin/products/form/_description_editor.html.erb
+- bin/rails
+- lib/solidus_product_description_editor.rb
+- lib/solidus_product_description_editor/engine.rb
+- lib/solidus_product_description_editor/version.rb
+- screenshot.png
+- solidus_product_description_editor.gemspec
+- spec/spec_helper.rb
+homepage: https://github.com/whelton/solidus_product_description_editor
+licenses:
+- BSD-3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Adds a WYSIWYG editor to the product description field in admin
+test_files:
+- spec/spec_helper.rb