solidus_support 0.3.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32902c75bfdc08a3c98057acc7a3ad00195192193069e1d82f1b313ebe838928
-  data.tar.gz: 4d6ef910489780004e48196d07a3da7c0f105d106753bf66c80dcaf8a57a1b9f
+  metadata.gz: 52891f7c46410b049481d932d3936da5530d1eabd601d0af44760398b4560200
+  data.tar.gz: 47b62f091de89edaf01b1e57ce6b1fdf10c558f801ead911822b88bbd8baffa7
 SHA512:
-  metadata.gz: 1122450b8f36e775258033a303fa56ab125f7856c24de99f35d2cb2f890a126ac10c57e75346c568e3a81a04e27bdd40ff2a0ce7e8009a8d8433c6143a89aa00
-  data.tar.gz: 58f2ef36a526e9d31873cc89efe76a06c3061731d816c7caae1a3b45d17940db6199229857a745989068029d3de13bf44a5f65f3ed388b929e4827120f647a80
+  metadata.gz: 2e55cb09d122d874ae9548420477d71a001fa7835f0027c976fca6cfef89351f0546b9477a5d219b9c80c15858e46edf510763b97301adf633dcaa97512d7237
+  data.tar.gz: 965ee76ae136fe8fc11987327044994b4fb1162a9f5516b1c50a47103ecc068acbf8cdc5ba5af68cb1b6e11bf41eb3c10bb50b0291f249dcee0c45341e0cfcd4

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2.1
+
+orbs:
+  # Always take the latest version of the orb, this allows us to
+  # run specs against Solidus supported versions only without the need
+  # to change this configuration every time a Solidus version is released
+  # or goes EOL.
+  solidusio_extensions: solidusio/extensions@volatile
+
+jobs:
+  run-specs-with-postgres:
+    executor: solidusio_extensions/postgres
+    steps:
+      - solidusio_extensions/run-tests
+  run-specs-with-mysql:
+    executor: solidusio_extensions/mysql
+    steps:
+      - solidusio_extensions/run-tests
+
+workflows:
+  "Run specs on supported Solidus versions":
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql
+  "Weekly run specs against master":
+    triggers:
+      - schedule:
+          cron: "0 0 * * 4" # every Thursday
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql

data/.gem_release.yml

@@ -0,0 +1,5 @@
+bump:
+  recurse: false
+  file: 'lib/solidus_support/version.rb'
+  message: Bump SolidusSupport to %{version}
+  branch: false

data/.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.gitignore

@@ -1,10 +1,17 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/log/
+*.gem
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+spec/examples.txt
+log

data/.rspec

@@ -1 +1,2 @@
 --require spec_helper
+--color

data/.rubocop.yml

@@ -1,8 +1,2 @@
-Metrics/BlockLength:
-  ExcludedMethods: ['describe', 'context']
-
-Metrics/LineLength:
-  Max: 100
-
-Style/Documentation:
-  Enabled: false
+require:
+  - solidus_dev_support/rubocop

data/CHANGELOG.md

@@ -0,0 +1,114 @@
+# Changelog
+
+## [v0.5.0](https://github.com/solidusio/solidus_support/tree/v0.5.0) (2020-02-18)
+
+[Full Changelog](https://github.com/solidusio/solidus_support/compare/v0.4.1...v0.5.0)
+
+**Merged pull requests:**
+
+- Load Solidus engine extension files automatically [\#42](https://github.com/solidusio/solidus_support/pull/42) ([aldesantis](https://github.com/aldesantis))
+- Deprecate SolidusSupport.solidus\_gem\_version [\#37](https://github.com/solidusio/solidus_support/pull/37) ([kennyadsl](https://github.com/kennyadsl))
+
+## [v0.4.1](https://github.com/solidusio/solidus_support/tree/v0.4.1) (2020-01-16)
+
+[Full Changelog](https://github.com/solidusio/solidus_support/compare/v0.4.0...v0.4.1)
+
+**Closed issues:**
+
+- Should use require\_dependency instead of require/load [\#34](https://github.com/solidusio/solidus_support/issues/34)
+- Add a LICENSE [\#20](https://github.com/solidusio/solidus_support/issues/20)
+
+**Merged pull requests:**
+
+- Update solidus\_dev\_support [\#41](https://github.com/solidusio/solidus_support/pull/41) ([aldesantis](https://github.com/aldesantis))
+- Replace manual cache checks w/ require\_dependency [\#39](https://github.com/solidusio/solidus_support/pull/39) ([elia](https://github.com/elia))
+- Fixes isse when zeitwerk is not enabled [\#38](https://github.com/solidusio/solidus_support/pull/38) ([softr8](https://github.com/softr8))
+- Spring cleaning [\#33](https://github.com/solidusio/solidus_support/pull/33) ([aldesantis](https://github.com/aldesantis))
+
+## [v0.4.0](https://github.com/solidusio/solidus_support/tree/v0.4.0) (2019-12-16)
+
+[Full Changelog](https://github.com/solidusio/solidus_support/compare/v0.3.2...v0.4.0)
+
+**Closed issues:**
+
+- Configure CircleCI [\#30](https://github.com/solidusio/solidus_support/issues/30)
+- Models::SolidusGlobalize::Spree::TaxonomyDecorator \(NameError\) [\#26](https://github.com/solidusio/solidus_support/issues/26)
+
+**Merged pull requests:**
+
+- Fix issues with test runs [\#32](https://github.com/solidusio/solidus_support/pull/32) ([aldesantis](https://github.com/aldesantis))
+- Add CircleCI configuration [\#31](https://github.com/solidusio/solidus_support/pull/31) ([aldesantis](https://github.com/aldesantis))
+- Introduce solidus\_extension\_dev\_tools [\#29](https://github.com/solidusio/solidus_support/pull/29) ([aldesantis](https://github.com/aldesantis))
+- Remove support for testing and extensions [\#28](https://github.com/solidusio/solidus_support/pull/28) ([MinasMazar](https://github.com/MinasMazar))
+- Add SolidusSupport::EngineExtension::Decorators to load decorators [\#27](https://github.com/solidusio/solidus_support/pull/27) ([kennyadsl](https://github.com/kennyadsl))
+- Add support for Codecov [\#24](https://github.com/solidusio/solidus_support/pull/24) ([aldesantis](https://github.com/aldesantis))
+- Add `capybara-screenshot` dependency [\#23](https://github.com/solidusio/solidus_support/pull/23) ([spaghetticode](https://github.com/spaghetticode))
+
+## [v0.3.2](https://github.com/solidusio/solidus_support/tree/v0.3.2) (2019-08-08)
+
+[Full Changelog](https://github.com/solidusio/solidus_support/compare/v0.2.1...v0.3.2)
+
+**Merged pull requests:**
+
+- Do not reset spree preferences starting from v2.9 [\#22](https://github.com/solidusio/solidus_support/pull/22) ([kennyadsl](https://github.com/kennyadsl))
+- Update Travis config [\#19](https://github.com/solidusio/solidus_support/pull/19) ([aitbw](https://github.com/aitbw))
+- Override Capybara JS driver via `CAPYBARA\_DRIVER` ENV variable [\#18](https://github.com/solidusio/solidus_support/pull/18) ([spaghetticode](https://github.com/spaghetticode))
+- Migrate from Poltergeist to Headless Chrome [\#16](https://github.com/solidusio/solidus_support/pull/16) ([aitbw](https://github.com/aitbw))
+- Remove running rubocop on rake task [\#14](https://github.com/solidusio/solidus_support/pull/14) ([kennyadsl](https://github.com/kennyadsl))
+- Cleanup extension [\#13](https://github.com/solidusio/solidus_support/pull/13) ([kennyadsl](https://github.com/kennyadsl))
+- Fix how we compare gem versions to determine new gateway code usage [\#12](https://github.com/solidusio/solidus_support/pull/12) ([kennyadsl](https://github.com/kennyadsl))
+- Add payment method parent class [\#8](https://github.com/solidusio/solidus_support/pull/8) ([tvdeyen](https://github.com/tvdeyen))
+- Improve gem documentation [\#7](https://github.com/solidusio/solidus_support/pull/7) ([kennyadsl](https://github.com/kennyadsl))
+
+## [v0.2.1](https://github.com/solidusio/solidus_support/tree/v0.2.1) (2018-02-22)
+
+[Full Changelog](https://github.com/solidusio/solidus_support/compare/v0.2.0...v0.2.1)
+
+**Merged pull requests:**
+
+- Ensure database cleaning is very last in each spec [\#9](https://github.com/solidusio/solidus_support/pull/9) ([jhawthorn](https://github.com/jhawthorn))
+
+## [v0.2.0](https://github.com/solidusio/solidus_support/tree/v0.2.0) (2017-10-25)
+
+[Full Changelog](https://github.com/solidusio/solidus_support/compare/v0.1.5...v0.2.0)
+
+**Merged pull requests:**
+
+- Rename FactoryBot [\#6](https://github.com/solidusio/solidus_support/pull/6) ([tvdeyen](https://github.com/tvdeyen))
+- Remove unused files [\#5](https://github.com/solidusio/solidus_support/pull/5) ([tvdeyen](https://github.com/tvdeyen))
+
+## [v0.1.5](https://github.com/solidusio/solidus_support/tree/v0.1.5) (2017-07-27)
+
+[Full Changelog](https://github.com/solidusio/solidus_support/compare/v0.1.4...v0.1.5)
+
+## [v0.1.4](https://github.com/solidusio/solidus_support/tree/v0.1.4) (2017-07-26)
+
+[Full Changelog](https://github.com/solidusio/solidus_support/compare/v0.1.3...v0.1.4)
+
+## [v0.1.3](https://github.com/solidusio/solidus_support/tree/v0.1.3) (2017-07-26)
+
+[Full Changelog](https://github.com/solidusio/solidus_support/compare/v0.1.2...v0.1.3)
+
+**Merged pull requests:**
+
+- Add a basic spec\_helper for extensions to include [\#2](https://github.com/solidusio/solidus_support/pull/2) ([jhawthorn](https://github.com/jhawthorn))
+
+## [v0.1.2](https://github.com/solidusio/solidus_support/tree/v0.1.2) (2017-07-24)
+
+[Full Changelog](https://github.com/solidusio/solidus_support/compare/v0.1.1...v0.1.2)
+
+**Merged pull requests:**
+
+- Add SolidusSupport.payment\_source\_parent\_class [\#1](https://github.com/solidusio/solidus_support/pull/1) ([jordan-brough](https://github.com/jordan-brough))
+
+## [v0.1.1](https://github.com/solidusio/solidus_support/tree/v0.1.1) (2017-05-03)
+
+[Full Changelog](https://github.com/solidusio/solidus_support/compare/v0.1.0...v0.1.1)
+
+## [v0.1.0](https://github.com/solidusio/solidus_support/tree/v0.1.0) (2017-03-21)
+
+[Full Changelog](https://github.com/solidusio/solidus_support/compare/b34d603b2b603e8799ce801913b577322bd39bdc...v0.1.0)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -1,10 +1,18 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
 gem 'solidus_core', github: 'solidusio/solidus', branch: branch
 
-# Specify your gem's dependencies in solidus_support.gemspec
-gemspec
+case ENV['DB']
+when 'mysql'
+  gem 'mysql2'
+when 'postgresql'
+  gem 'pg'
+else
+  gem 'sqlite3'
+end
 
-gem 'sprockets-rails'
-gem 'sqlite3'
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2017 Solidus
+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 Solidus 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

@@ -1,16 +1,18 @@
 # SolidusSupport
 
-This gem holds some common functionality for Solidus Extensions.
+This gem contains common runtime functionality for Solidus extensions.
 
-It has some utilities to make it easier to support multiple versions of Solidus.
+If you are looking for development tools instead, see
+[solidus_dev_support](https://github.com/solidusio-contrib/solidus_dev_support).
 
 ## Usage
 
 ### `SolidusSupport::Migration`
 
-Rails >= 5 introduced the concept of specifying what rails version your migration was written for, like `ActiveRecord::Migration[5.0]`.
-Not specifying a version is deprecated in Rails 5.0 and removed in rails 5.1.
-This wasn't backported to Rails 4.2, but Rails 4.2 _is_ Rails 4.2. So we provide this helper.
+Rails >= 5 introduced the concept of specifying what Rails version your migration was written for,
+like `ActiveRecord::Migration[5.0]`. Not specifying a version is deprecated in Rails 5.0 and removed
+in Rails 5.1. This wasn't backported to Rails 4.2, so we provide this helper to return the right
+parent class:
 
 ``` ruby
 # On Rails 4.2
@@ -22,69 +24,65 @@ SolidusSupport::Migration[4.2] # same as `ActiveRecord::Migration[4.2]`
 SolidusSupport::Migration[5.0] # same as `ActiveRecord::Migration[5.0]`
 ```
 
-There's no reason to use `SolidusSupport::Migration[5.0]` over `ActiveRecord::Migration[5.0]`, but it is provided.
+There's no reason to use `SolidusSupport::Migration[5.0]` over `ActiveRecord::Migration[5.0]`, but
+it is provided.
 
-### Testing Helpers
+### Engine extensions
 
-This gem provides some useful helpers for RSpec to setup an extension's test
-environment easily.
-
-Into your extension's spec/spec_helper.rb:
+This extension provides a module that decorates `Rails::Engine` to seamlessly support autoloading
+decorators both with the classic autoloader and with Zeitwerk on Rails 6. In order to use it, just
+include the provided module in your `Engine` class:
 
 ```ruby
-require "solidus_support/extension/feature_helper"
-```
-
-This helper loads configuration needed to run extensions feature specs
-correctly, setting up Capybara and configuring Rails test application
-to precompile assets before the first feature spec.
+module SolidusExtensionName
+  class Engine < Rails::Engine
+    engine_name 'solidus_extension_name'
 
-This helper requires the `rails_helper`, also provided by this gem and
-requireable as a stand-alone helper.
+    include SolidusSupport::EngineExtensions
 
-By doing:
-
-```ruby
-require "solidus_support/extension/rails_helper"
+    # ...
+  end
+end
 ```
 
-extension's test suite will have all Rails related tests configuration,
-like authorization helpers, Solidus core factories, url helpers, and
-other helpers to easily work with Solidus Config.
-
-This `rails_helper` in turn requires the basic `spec_helper`, which is
-responsible to load a basic RSpec configuration, which could be needed
-in all extensions. It is also requireable as a stand-alone helper with:
+If needed, also ensure to remove the original implementation of `.activate`:
 
 ```ruby
-require "solidus_support/extension/spec_helper"
+def self.activate
+  Dir.glob(File.join(root, "app/**/*_decorator*.rb")) do |c|
+    Rails.configuration.cache_classes ? require(c) : load(c)
+  end
+end
+
+config.to_prepare(&method(:activate).to_proc)
 ```
 
-### Coverage Collection
+#### Loading files conditionally
 
-The gem also includes a SimpleCov configuration that will send your test
-coverage information directly to Codecov.io. Simply add this at the top
-of your `spec/spec_helper.rb`:
+If you include `EngineExtensions` in your extension and structure your files according to the
+expected paths, they will be loaded automagically only when the relevant Solidus engines are
+available.
 
-```ruby
-require "solidus_support/extension/coverage"
-```
+Here's what an example structure may look like:
 
-**Note: Make sure to add this at the VERY TOP of your spec_helper,
-otherwise you'll get skewed coverage reports!**
+- `lib/views/backend`: will only be added to the view paths when `solidus_backend` is available.
+- `lib/controllers/backend`: will only be added to the controller paths when `solidus_backend` is
+  available.
+- `lib/decorators/backend`: will only be added to the decorator paths when `solidus_backend` is
+  available.
 
-If your extension is in a public repo and being tested on Travis or
-CircleCI, there's nothing else you need to do - you'll get coverage
-reports for free!
+The same goes for `frontend` and `api`.
 
-If your setup is more complex, look at the [SimpleCov](https://github.com/colszowka/simplecov)
-and [codecov-ruby](https://github.com/codecov/codecov-ruby) docs.
+We strongly recommend following this structure and making your extensions so that they're not
+dependent on anything other than `solidus_core`, only augmenting the functionality of the other
+engines when they are available.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new
+version, update the version number in `version.rb`, and then run `bundle exec rake release`, which
+will create a git tag for the version, push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler'
 
 begin

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solidus_support"
+
+# 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.
+$LOAD_PATH.unshift(*Dir["#{__dir__}/../app/*"])
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler --conservative
+bundle update

data/lib/solidus_support.rb

@@ -1,29 +1,29 @@
+# frozen_string_literal: true
+
 require 'solidus_support/version'
 require 'solidus_support/migration'
+require 'solidus_support/engine_extensions'
 require 'solidus_core'
 
 module SolidusSupport
   class << self
     def solidus_gem_version
-      if Spree.respond_to?(:solidus_gem_version)
-        Spree.solidus_gem_version
-      elsif Spree.respond_to?(:gem_version)
-        # 1.1 doesn't have solidus_gem_version
-        Gem::Version.new(Spree.solidus_version)
-      else
-        # 1.0 doesn't have gem_version
-        Gem::Specification.detect { |x| x.name == 'solidus_core' }.version
-      end
+      ActiveSupport::Deprecation.warn <<-WARN.squish, caller
+        SolidusSupport.solidus_gem_version is deprecated and will be removed
+        in solidus_support 1.0. Please use Spree.solidus_gem_version instead.
+      WARN
+
+      Spree.solidus_gem_version
     end
 
     def reset_spree_preferences_deprecated?
       first_version_without_reset = Gem::Requirement.new('>= 2.9')
-      first_version_without_reset.satisfied_by?(solidus_gem_version)
+      first_version_without_reset.satisfied_by?(Spree.solidus_gem_version)
     end
 
     def new_gateway_code?
       first_version_with_new_gateway_code = Gem::Requirement.new('>= 2.3')
-      first_version_with_new_gateway_code.satisfied_by?(solidus_gem_version)
+      first_version_with_new_gateway_code.satisfied_by?(Spree.solidus_gem_version)
     end
 
     def payment_source_parent_class

data/lib/solidus_support/engine_extensions.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module SolidusSupport
+  module EngineExtensions
+    include ActiveSupport::Deprecation::DeprecatedConstantAccessor
+    deprecate_constant 'Decorators', 'SolidusSupport::EngineExtensions'
+
+    def self.included(engine)
+      engine.extend ClassMethods
+
+      engine.class_eval do
+        solidus_decorators_root.glob('*') do |decorators_folder|
+          config.autoload_paths += [decorators_folder]
+        end
+
+        config.to_prepare(&method(:activate))
+
+        enable_solidus_engine_support('backend') if SolidusSupport.backend_available?
+        enable_solidus_engine_support('frontend') if SolidusSupport.frontend_available?
+        enable_solidus_engine_support('api') if SolidusSupport.api_available?
+      end
+    end
+
+    module ClassMethods
+      def activate
+        load_solidus_decorators_from(solidus_decorators_root)
+        load_solidus_subscribers_from(solidus_subscribers_root)
+      end
+
+      # Loads Solidus event subscriber files.
+      #
+      # This allows to add event subscribers to extensions without explicitly subscribing them,
+      # similarly to what happens in Solidus core.
+      def load_solidus_subscribers_from(path)
+        if defined? Spree::Event
+          path.glob("**/*_subscriber.rb") do |subscriber_path|
+            require_dependency(subscriber_path)
+          end
+          Spree::Event.subscribers.each(&:subscribe!)
+        end
+      end
+
+      # Loads decorator files.
+      #
+      # This is needed since they are never explicitly referenced in the application code and
+      # won't be loaded by default. We need them to be executed regardless in order to decorate
+      # existing classes.
+      def load_solidus_decorators_from(path)
+        path.glob('**/*.rb') do |decorator_path|
+          require_dependency(decorator_path)
+        end
+      end
+
+      private
+
+      # Returns the root for this engine's decorators.
+      #
+      # @return [Path]
+      def solidus_decorators_root
+        root.join('app/decorators')
+      end
+
+      # Returns the root for this engine's Solidus event subscribers.
+      #
+      # @return [Path]
+      def solidus_subscribers_root
+        root.join("app/subscribers")
+      end
+
+      # Enables support for a Solidus engine.
+      #
+      # This will tell Rails to:
+      #
+      #   * add +lib/controllers/[engine]+ to the controller paths;
+      #   * add +lib/views/[engine]+ to the view paths;
+      #   * load the decorators in +lib/decorators/[engine]+.
+      #
+      # @see #load_solidus_decorators_from
+      def enable_solidus_engine_support(engine)
+        paths['app/controllers'] << "lib/controllers/#{engine}"
+        paths['app/views'] << "lib/views/#{engine}"
+
+        path = root.join("lib/decorators/#{engine}")
+
+        config.autoload_paths += path.glob('*')
+
+        engine_context = self
+        config.to_prepare do
+          engine_context.instance_eval do
+            load_solidus_decorators_from(path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solidus_support/migration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidusSupport
   module Migration
     def self.[](version)

data/lib/solidus_support/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidusSupport
-  VERSION = '0.3.3'.freeze
+  VERSION = '0.6.0'
 end

data/solidus_support.gemspec

@@ -1,29 +1,33 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+$:.push File.expand_path('lib', __dir__)
 require 'solidus_support/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = 'solidus_support'
-  spec.version       = SolidusSupport::VERSION
-  spec.authors       = ['John Hawthorn']
-  spec.email         = ['john@stembolt.com']
+Gem::Specification.new do |s|
+  s.name = 'solidus_support'
+  s.version = SolidusSupport::VERSION
+  s.summary = 'Common runtime helpers for Solidus extensions.'
+  s.license = 'BSD-3-Clause'
 
-  spec.summary       = 'A common functionality for solidus extensions'
-  spec.description   = 'Collection of common functionality for solidus extensions'
-  spec.homepage      = 'https://solidus.io'
+  s.author = 'John Hawthorn'
+  s.email = 'john@stembolt.com'
+  s.homepage = 'https://github.com/solidusio/solidus_support'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.require_paths = ['lib']
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.test_files = Dir['spec/**/*']
+  s.bindir = "exe"
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler', '~> 1.14'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec-rails', '~> 3.7'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-rspec'
-  spec.add_development_dependency 'solidus_core'
+  s.add_dependency 'activesupport', ['>= 5.2', '< 7.0.x']
 
-  spec.add_dependency 'capybara-screenshot'
-  spec.add_dependency 'codecov'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-rspec'
+  s.add_development_dependency 'solidus_core'
+  s.add_development_dependency 'solidus_dev_support'
 end

data/spec/solidus_support_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe SolidusSupport do
   describe '.payment_method_parent_class' do
     subject { described_class.payment_method_parent_class(credit_card: credit_card) }
@@ -5,37 +7,39 @@ RSpec.describe SolidusSupport do
     let(:credit_card) { nil }
 
     before do
-      allow(described_class).to receive(:solidus_gem_version) do
+      allow(Spree).to receive(:solidus_gem_version) do
         Gem::Version.new(solidus_version)
       end
     end
 
-    context 'For Solidus < 2.3' do
+    context 'with Solidus < 2.3' do
       let(:solidus_version) { '2.2.1' }
 
       it { is_expected.to eq(Spree::Gateway) }
     end
 
-    context 'For Solidus >= 2.3' do
+    context 'with Solidus >= 2.3' do
       let(:solidus_version) { '2.3.1' }
 
       it { is_expected.to eq(Spree::PaymentMethod) }
     end
 
+    # rubocop:disable RSpec/NestedGroups
     context 'with credit_card: true' do
       let(:credit_card) { true }
 
-      context 'For Solidus < 2.3' do
+      context 'with Solidus < 2.3' do
         let(:solidus_version) { '2.2.1' }
 
         it { is_expected.to eq(Spree::Gateway) }
       end
 
-      context 'For Solidus >= 2.3' do
+      context 'with Solidus >= 2.3' do
         let(:solidus_version) { '2.3.1' }
 
         it { is_expected.to eq(Spree::PaymentMethod::CreditCard) }
       end
     end
+    # rubocop:enable RSpec/NestedGroups
   end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,17 @@
+# frozen_string_literal: true
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+# Run Coverage report
+require 'solidus_dev_support/rspec/coverage'
+
+# Load dummy app
 require_relative 'support/dummy_app'
-require 'solidus_support/extension/spec_helper'
+
+# Requires factories and other useful helpers defined in spree_core.
+require 'solidus_dev_support/rspec/spec_helper'
+
+# 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 }

data/spec/support/dummy_app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ENV['RAILS_ENV'] = 'test'
 ENV['DISABLE_DATABASE_ENVIRONMENT_CHECK'] = '1'
 

data/spec/support/dummy_app/database.yml

@@ -1,4 +1,16 @@
+<% if ENV['DB'] == 'postgresql' %>
+test:
+  adapter: postgresql
+  database: circle_test
+  username: root
+<% elsif ENV['DB'] == 'mysql' %>
+test:
+  adapter: mysql2
+  database: circle_test
+  username: root
+<% else %>
 test:
   adapter: sqlite3
   database: ':memory:'
   timeout: 10000
+<% end %>

metadata

@@ -1,59 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: solidus_support
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.6.0
 platform: ruby
 authors:
 - John Hawthorn
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2019-11-04 00:00:00.000000000 Z
+date: 2020-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.x
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: 7.0.x
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +73,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +87,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: solidus_core
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,13 +101,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: capybara-screenshot
+  name: solidus_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -109,50 +115,52 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: solidus_dev_support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Collection of common functionality for solidus extensions
-email:
-- john@stembolt.com
+description:
+email: john@stembolt.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".gem_release.yml"
+- ".github/stale.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - lib/solidus_support.rb
-- lib/solidus_support/extension/coverage.rb
-- lib/solidus_support/extension/feature_helper.rb
-- lib/solidus_support/extension/rails_helper.rb
-- lib/solidus_support/extension/spec_helper.rb
+- lib/solidus_support/engine_extensions.rb
 - lib/solidus_support/migration.rb
-- lib/solidus_support/testing_support/preferences.rb
 - lib/solidus_support/version.rb
 - solidus_support.gemspec
 - spec/solidus_support_spec.rb
 - spec/spec_helper.rb
 - spec/support/dummy_app.rb
 - spec/support/dummy_app/database.yml
-homepage: https://solidus.io
-licenses: []
+homepage: https://github.com/solidusio/solidus_support
+licenses:
+- BSD-3-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -167,8 +175,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
-summary: A common functionality for solidus extensions
-test_files: []
+summary: Common runtime helpers for Solidus extensions.
+test_files:
+- spec/spec_helper.rb
+- spec/solidus_support_spec.rb
+- spec/support/dummy_app.rb
+- spec/support/dummy_app/database.yml

data/.travis.yml

@@ -1,18 +0,0 @@
-sudo: false
-language: ruby
-dist: trusty
-cache:
-  bundler: true
-before_install:
-  - "gem install bundler --pre"
-  - "bundler -v"
-rvm:
-  - 2.4.2
-env:
-  matrix:
-    - SOLIDUS_BRANCH=v2.4
-    - SOLIDUS_BRANCH=v2.5
-    - SOLIDUS_BRANCH=v2.6
-    - SOLIDUS_BRANCH=v2.7
-    - SOLIDUS_BRANCH=v2.8
-    - SOLIDUS_BRANCH=master

data/lib/solidus_support/extension/coverage.rb

@@ -1,16 +0,0 @@
-# A SimpleCov and Codecov configuration to track code coverage in your extension
-#
-# Include it AT THE TOP of your spec/spec_helper.rb:
-#
-#     require 'solidus_support/extension/coverage'
-#
-# Note that things may not work properly if you don't include this at the very top!
-#
-
-require 'simplecov'
-SimpleCov.start 'rails'
-
-if ENV['CI']
-  require 'codecov'
-  SimpleCov.formatter = SimpleCov::Formatter::Codecov
-end

data/lib/solidus_support/extension/feature_helper.rb

@@ -1,44 +0,0 @@
-# A basic feature_helper to be included as the starting point for extensions
-#
-# Can be required from an extension's spec/feature_helper.rb
-#
-#     require 'solidus_support/extension/feature_helper'
-#
-
-require 'solidus_support/extension/rails_helper'
-
-require 'capybara-screenshot/rspec'
-require 'selenium/webdriver'
-
-Capybara.register_driver :selenium_chrome_headless do |app|
-  capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
-    chromeOptions: { args: %w[headless start-maximized] }
-  )
-
-  Capybara::Selenium::Driver.new(
-    app,
-    browser: :chrome,
-    desired_capabilities: capabilities
-  )
-end
-
-Capybara.javascript_driver = (ENV['CAPYBARA_DRIVER'] || :selenium_chrome_headless).to_sym
-Capybara.default_max_wait_time = 10
-
-require 'spree/testing_support/capybara_ext'
-
-RSpec.configure do |config|
-  config.when_first_matching_example_defined(type: :feature) do
-    config.before :suite do
-      # Preload assets
-      if Rails.application.respond_to?(:precompiled_assets)
-        Rails.application.precompiled_assets
-      else
-        # For older sprockets 2.x
-        Rails.application.config.assets.precompile.each do |asset|
-          Rails.application.assets.find_asset(asset)
-        end
-      end
-    end
-  end
-end

data/lib/solidus_support/extension/rails_helper.rb

@@ -1,45 +0,0 @@
-# A basic rails_helper to be included as the starting point for extensions
-#
-# Can be required from an extension's spec/rails_helper.rb
-#
-#     require 'solidus_support/extension/rails_helper'
-#
-
-require 'solidus_support/extension/spec_helper'
-
-require 'rspec/rails'
-require 'database_cleaner'
-require 'ffaker'
-
-require 'spree/testing_support/authorization_helpers'
-require 'spree/testing_support/factories'
-require 'spree/testing_support/url_helpers'
-require 'spree/testing_support/preferences'
-require 'solidus_support/testing_support/preferences'
-
-RSpec.configure do |config|
-  config.include FactoryBot::Syntax::Methods
-
-  # visit spree.admin_path
-  # current_path.should eql(spree.products_path)
-  config.include Spree::TestingSupport::UrlHelpers
-
-  config.include Spree::TestingSupport::Preferences
-  config.include SolidusSupport::TestingSupport::Preferences
-
-  config.before :suite do
-    DatabaseCleaner.clean_with :truncation
-  end
-
-  # Around each spec check if it is a Javascript test and switch between using
-  # database transactions or not where necessary.
-  config.around(:each) do |example|
-    DatabaseCleaner.strategy = RSpec.current_example.metadata[:js] ? :truncation : :transaction
-
-    DatabaseCleaner.cleaning do
-      reset_spree_preferences unless SolidusSupport.reset_spree_preferences_deprecated?
-
-      example.run
-    end
-  end
-end

data/lib/solidus_support/extension/spec_helper.rb

@@ -1,19 +0,0 @@
-# A basic spec_helper to be included as the starting point for extensions
-#
-# Can be required from an extension's spec/spec_helper.rb
-#
-#     require 'solidus_support/extension/spec_helper'
-#
-
-RSpec.configure do |config|
-  config.filter_run focus: true
-  config.run_all_when_everything_filtered = true
-
-  config.mock_with :rspec
-  config.color = true
-
-  config.fail_fast = ENV['FAIL_FAST'] || false
-  config.order = 'random'
-
-  Kernel.srand config.seed
-end

data/lib/solidus_support/testing_support/preferences.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module SolidusSupport
-  module TestingSupport
-    module Preferences
-      # This wrapper method allows to stub spree preferences using
-      # the new standard way of solidus core but also works with
-      # old versions that does not have the stub_spree_preferences
-      # method yet. This way we can start using this method in our
-      # extensions safely.
-      #
-      # To have this available, it is needed to require in the
-      # spec/spec_helper.rb of the extension both:
-      #
-      # require 'spree/testing_support/preferences'
-      # require 'solidus_support/testing_support/preferences'
-      #
-      # @example Set a preference on Spree::Config
-      #   stub_spree_preferences(allow_guest_checkout: false)
-      #
-      # @example Set a preference on Spree::Api::Config
-      #   stub_spree_preferences(Spree::Api::Config, requires_authentication: false)
-      #
-      # @example Set a preference on a custom Spree::CustomExtension::Config
-      #  stub_spree_preferences(Spree::CustomExtension::Config, custom_pref: true)
-      #
-      # @param prefs_or_conf_class [Class, Hash] the class we want to stub
-      #   preferences for or the preferences hash (see prefs param). If this
-      #   param is an Hash, preferences will be stubbed on Spree::Config.
-      # @param prefs [Hash, nil] names and values to be stubbed
-      def stub_spree_preferences(prefs_or_conf_class, prefs = nil)
-        super && return if SolidusSupport.reset_spree_preferences_deprecated?
-
-        if prefs_or_conf_class.is_a?(Hash)
-          preference_store_class = Spree::Config
-          preferences = prefs_or_conf_class
-        else
-          preference_store_class = prefs_or_conf_class
-          preferences = prefs
-        end
-        preference_store_class.set(preferences)
-      end
-    end
-  end
-end