solidus_support 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32902c75bfdc08a3c98057acc7a3ad00195192193069e1d82f1b313ebe838928
-  data.tar.gz: 4d6ef910489780004e48196d07a3da7c0f105d106753bf66c80dcaf8a57a1b9f
+  metadata.gz: 06f44b07249f357975f818d24cd533b0e4419c957c1608c6dfd398956176a456
+  data.tar.gz: 7a5c3c693cb6a9c0d36a056bbab25338c54a756a4a2f745a997a3ae1f1a221cc
 SHA512:
-  metadata.gz: 1122450b8f36e775258033a303fa56ab125f7856c24de99f35d2cb2f890a126ac10c57e75346c568e3a81a04e27bdd40ff2a0ce7e8009a8d8433c6143a89aa00
-  data.tar.gz: 58f2ef36a526e9d31873cc89efe76a06c3061731d816c7caae1a3b45d17940db6199229857a745989068029d3de13bf44a5f65f3ed388b929e4827120f647a80
+  metadata.gz: aa4396cf0f842d9c14a3a846cb6e49b053eeaebbfc43d7f6f9b42523054f0d1574eaaa8756a433d2c62902fed6b8ac0539bcb4a6da87d4671285d2db87fff866
+  data.tar.gz: 2674c879410db8025d8dba10e961598c7bc28b7b17e8bb6d771ece89ae280aad1c257acb948c5ee6c0c810e9574874529c66c3563968bcefc15dc54c5e3162e1

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/.gitignore

@@ -8,3 +8,5 @@
 /spec/reports/
 /tmp/
 /log/
+/spec/
+

data/.rubocop.yml

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

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
@@ -6,5 +8,15 @@ gem 'solidus_core', github: 'solidusio/solidus', branch: branch
 # Specify your gem's dependencies in solidus_support.gemspec
 gemspec
 
+gem 'solidus_extension_dev_tools', github: 'solidusio-contrib/solidus_extension_dev_tools'
+gem 'sprockets', '~> 3'
 gem 'sprockets-rails'
-gem 'sqlite3'
+
+case ENV['DB']
+when 'postgresql'
+  gem 'pg'
+when 'mysql'
+  gem 'mysql2'
+else
+  gem 'sqlite3'
+end

data/README.md

@@ -24,62 +24,38 @@ 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.
 
-### Testing Helpers
+### Engine Extensions
 
-This gem provides some useful helpers for RSpec to setup an extension's test
-environment easily.
+This extension provides a module that extends `Rails::Engine` functionalities
+to support loading correctly the decorators class created into an extension
+both for development and production enviroments.
 
-Into your extension's spec/spec_helper.rb:
+To use it just include the provided module in the Engine as follow:
 
 ```ruby
-require "solidus_support/extension/feature_helper"
+module SolidusExtensionName
+  class Engine < Rails::Engine
+    engine_name 'solidus_extension_name'
+
+    include SolidusSupport::EngineExtensions::Decorators
+    # ...
+  end
+end
 ```
 
-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.
-
-This helper requires the `rails_helper`, also provided by this gem and
-requireable as a stand-alone helper.
-
-By doing:
-
-```ruby
-require "solidus_support/extension/rails_helper"
-```
-
-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:
+To make it work, be sure to remove the previous implementation from the
+Engine, that should be something like:
 
 ```ruby
-require "solidus_support/extension/spec_helper"
-```
-
-### Coverage Collection
+def self.activate
+  Dir.glob(File.join(root, "app/**/*_decorator*.rb")) do |c|
+    Rails.configuration.cache_classes ? require(c) : load(c)
+  end
+end
 
-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`:
-
-```ruby
-require "solidus_support/extension/coverage"
+config.to_prepare(&method(:activate).to_proc)
 ```
 
-**Note: Make sure to add this at the VERY TOP of your spec_helper,
-otherwise you'll get skewed coverage reports!**
-
-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!
-
-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.
-
 ## 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.

data/Rakefile

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

data/lib/solidus_support.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'solidus_support/version'
 require 'solidus_support/migration'
+require 'solidus_support/engine_extensions'
 require 'solidus_core'
 
 module SolidusSupport

data/lib/solidus_support/engine_extensions.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'engine_extensions/decorators'

data/lib/solidus_support/engine_extensions/decorators.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SolidusSupport
+  module EngineExtensions
+    module Decorators
+      def self.included(engine)
+        engine.class_eval do
+          extend ClassMethods
+          config.to_prepare(&method(:activate).to_proc)
+        end
+      end
+
+      module ClassMethods
+        def activate
+          base_path = root.join('app/decorators')
+
+          if Rails.respond_to?(:autoloaders)
+            # Add decorators folder to the Rails autoloader. This
+            # allows Zeitwerk to resolve decorators paths correctly,
+            # when used.
+            Dir.glob(base_path.join('*')) do |decorators_folder|
+              Rails.autoloaders.main.push_dir(decorators_folder)
+            end
+          end
+
+          # Load decorator files. This is needed since they are
+          # never explicitely referenced in the application code
+          # and won't be loaded by default. We need them to be
+          # executed anyway to extend exisiting classes.
+          Dir.glob(base_path.join('**/*.rb')) do |decorator_path|
+            Rails.configuration.cache_classes ? require(decorator_path) : load(decorator_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.4.0'
 end

data/solidus_support.gemspec

@@ -17,13 +17,11 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0")
   spec.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 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'solidus_core'
-
-  spec.add_dependency 'capybara-screenshot'
-  spec.add_dependency 'codecov'
+  spec.add_development_dependency 'solidus_extension_dev_tools'
 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) }
@@ -10,32 +12,34 @@ RSpec.describe SolidusSupport do
       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,4 @@
+# frozen_string_literal: true
+
 require_relative 'support/dummy_app'
-require 'solidus_support/extension/spec_helper'
+require 'solidus_extension_dev_tools/rspec/spec_helper'

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,45 @@
 --- !ruby/object:Gem::Specification
 name: solidus_support
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - John Hawthorn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-04 00:00:00.000000000 Z
+date: 2019-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   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
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +53,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 +67,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 +81,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,13 +95,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: solidus_extension_dev_tools
   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:
@@ -129,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -137,12 +124,9 @@ files:
 - README.md
 - Rakefile
 - 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/engine_extensions/decorators.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

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