solidus_dev_support 2.2.0 → 2.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bf90c2bc57b80b7ac05afe68db8c72f7c5156ac479e8fee99d61f38d48ce3b4
-  data.tar.gz: '0830edb6f1562d5b58345c9b79702f1d70aab2c5051cc03570772f5dbbef789d'
+  metadata.gz: c114329424b9f471d8ac9c41c3d757a788b32b3bcdf57b383f9f6400a6a66881
+  data.tar.gz: 99668378fb9a6124a2f3b21df7311179466411b58de431814e15af78bcac2690
 SHA512:
-  metadata.gz: 2afaf6d12de41f7748891da69a9b02a769af1b30bd8124e65378c1633a79a951c608a7d30a5e47267ac3c631029c781a96e6f07e61405e970c7434dd136e27dc
-  data.tar.gz: 4db74c432e1bc63e853c195d95d24e3ee7ed97854e0386ebea3ea4533bed82dbe23ee4eff46040d8b7603a126154a9d8fe91c7d899ca81e04a752ff49f40c48b
+  metadata.gz: ffb1dd05af39f72148c299ac03616837a215e7b4754871f2bfc078e9a14e458dd89e351c5ad29450e61f068cc5baca6c614b8d2caeee4e46b30ccc9758616d7d
+  data.tar.gz: a7d4466e3fbec9e9d6a18f9a6cfc6bd28da198aaeb7cdce2104cd0c4c0349b78abf1b2165ef9aef8ad9a1d746ad9caaa49bd2737888ff049e160029e4fcac946

data/CHANGELOG.md

@@ -1,8 +1,38 @@
 # Changelog
 
-## [2.2.0](https://github.com/solidusio/solidus_dev_support/tree/2.2.0) (2020-11-27)
+## [v2.4.0](https://github.com/solidusio/solidus_dev_support/tree/v2.4.0) (2021-02-05)
 
-[Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v2.1.0...2.2.0)
+[Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v2.3.0...v2.4.0)
+
+**Implemented enhancements:**
+
+- Improve engine's requires to remove double inclusions [\#165](https://github.com/solidusio/solidus_dev_support/pull/165) ([kennyadsl](https://github.com/kennyadsl))
+- Remove double require of core factories from rails\_helper [\#164](https://github.com/solidusio/solidus_dev_support/pull/164) ([kennyadsl](https://github.com/kennyadsl))
+
+**Fixed bugs:**
+
+- Fix typo in configuration.rb.tt [\#166](https://github.com/solidusio/solidus_dev_support/pull/166) ([brchristian](https://github.com/brchristian))
+
+**Merged pull requests:**
+
+- Rename spree:install to solidus:install in the sandbox template [\#167](https://github.com/solidusio/solidus_dev_support/pull/167) ([blocknotes](https://github.com/blocknotes))
+
+## [v2.3.0](https://github.com/solidusio/solidus_dev_support/tree/v2.3.0) (2021-01-14)
+
+[Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v2.2.0...v2.3.0)
+
+**Implemented enhancements:**
+
+- Do not raise if source\_code\_uri is missing in the gemspec [\#163](https://github.com/solidusio/solidus_dev_support/pull/163) ([kennyadsl](https://github.com/kennyadsl))
+- Factory bot fixes for latest Solidus 2.11 release [\#162](https://github.com/solidusio/solidus_dev_support/pull/162) ([elia](https://github.com/elia))
+
+**Fixed bugs:**
+
+- use rubocop-rspec 2.x [\#161](https://github.com/solidusio/solidus_dev_support/pull/161) ([ccarruitero](https://github.com/ccarruitero))
+
+## [v2.2.0](https://github.com/solidusio/solidus_dev_support/tree/v2.2.0) (2020-11-27)
+
+[Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v2.1.0...v2.2.0)
 
 **Implemented enhancements:**
 
@@ -44,7 +74,7 @@
 
 ## [v2.0.0](https://github.com/solidusio/solidus_dev_support/tree/v2.0.0) (2020-09-22)
 
-[Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v1.5.0...v2.0.0)
+[Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v1.6.0...v2.0.0)
 
 **Breaking changes:**
 
@@ -55,6 +85,19 @@
 - Enable new RuboCop cops automatically [\#143](https://github.com/solidusio/solidus_dev_support/pull/143) ([aldesantis](https://github.com/aldesantis))
 - Don't forcefully close issues via stale-bot [\#139](https://github.com/solidusio/solidus_dev_support/pull/139) ([elia](https://github.com/elia))
 - Add the approximate recommendation for dev-support to the gemspec [\#137](https://github.com/solidusio/solidus_dev_support/pull/137) ([elia](https://github.com/elia))
+
+**Fixed bugs:**
+
+- fix capybara driver declaration [\#141](https://github.com/solidusio/solidus_dev_support/pull/141) ([ccarruitero](https://github.com/ccarruitero))
+- Bump RuboCop to latest 0.90.0 version [\#138](https://github.com/solidusio/solidus_dev_support/pull/138) ([peterberkenbosch](https://github.com/peterberkenbosch))
+- Fix missing backslash in solidus install command [\#135](https://github.com/solidusio/solidus_dev_support/pull/135) ([nirebu](https://github.com/nirebu))
+
+## [v1.6.0](https://github.com/solidusio/solidus_dev_support/tree/v1.6.0) (2020-08-26)
+
+[Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v1.5.0...v1.6.0)
+
+**Implemented enhancements:**
+
 - Let the extension name include spaces [\#133](https://github.com/solidusio/solidus_dev_support/pull/133) ([elia](https://github.com/elia))
 - Add precompiled badges fro CI and coverage [\#132](https://github.com/solidusio/solidus_dev_support/pull/132) ([elia](https://github.com/elia))
 - Add Changelog Rake task [\#128](https://github.com/solidusio/solidus_dev_support/pull/128) ([tvdeyen](https://github.com/tvdeyen))
@@ -62,16 +105,9 @@
 
 **Fixed bugs:**
 
-- fix capybara driver declaration [\#141](https://github.com/solidusio/solidus_dev_support/pull/141) ([ccarruitero](https://github.com/ccarruitero))
-- Bump RuboCop to latest 0.90.0 version [\#138](https://github.com/solidusio/solidus_dev_support/pull/138) ([peterberkenbosch](https://github.com/peterberkenbosch))
-- Fix missing backslash in solidus install command [\#135](https://github.com/solidusio/solidus_dev_support/pull/135) ([nirebu](https://github.com/nirebu))
 - Don't install a payment-method in the sandbox [\#131](https://github.com/solidusio/solidus_dev_support/pull/131) ([elia](https://github.com/elia))
 - Run extension generator in sandbox [\#127](https://github.com/solidusio/solidus_dev_support/pull/127) ([elia](https://github.com/elia))
 
-**Merged pull requests:**
-
-- Update readme template [\#109](https://github.com/solidusio/solidus_dev_support/pull/109) ([aldesantis](https://github.com/aldesantis))
-
 ## [v1.5.0](https://github.com/solidusio/solidus_dev_support/tree/v1.5.0) (2020-06-13)
 
 [Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v1.4.0...v1.5.0)

data/Gemfile

@@ -15,7 +15,6 @@ gem 'rails', '>0.a'
 
 # These gems will be used by the temporary extensions generated by tests
 group :test do
-  gem 'factory_bot', '> 4.10.0'
   gem 'mysql2'
   gem 'pg'
   gem 'solidus_auth_devise'

data/lib/solidus_dev_support/rake_tasks.rb

@@ -83,6 +83,16 @@ module SolidusDevSupport
         config.user = repo.owner
         config.project = repo.name
         config.future_release = "v#{ENV['UNRELEASED_VERSION'] || gemspec.version}"
+
+      rescue Octokit::InvalidRepository
+        warn <<~WARN
+          It won't be possible to automatically generate the CHANGELOG for this extension because the
+          gemspec is missing the `source_code_uri` metadata. Please add this line to the gemspec to
+          enable automatic CHANGELOG generation:
+
+              s.metadata["source_code_uri"] = 'https://github.com/org/repo'
+
+        WARN
       end
     end
   end

data/lib/solidus_dev_support/rspec/rails_helper.rb

@@ -16,14 +16,12 @@ require 'factory_bot'
 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 'spree/testing_support/controller_requests'
+require 'solidus_dev_support/testing_support/factories'
 require 'solidus_dev_support/testing_support/preferences'
 
-FactoryBot.find_definitions
-
 RSpec.configure do |config|
   config.infer_spec_type_from_file_location!
 

data/lib/solidus_dev_support/templates/extension/README.md

@@ -42,10 +42,17 @@ bundle exec rubocop
 ```
 
 When testing your application's integration with this extension you may use its factories.
-Simply add this require statement to your spec_helper:
+Simply add this require statement to your `spec/spec_helper.rb`:
 
 ```ruby
-require '<%= file_name %>/factories'
+require '<%= file_name %>/testing_support/factories'
+```
+
+Or, if you are using `FactoryBot.definition_file_paths`, you can load Solidus core
+factories along with this extension's factories using this statement:
+
+```ruby
+SolidusDevSupport::TestingSupport::Factories.load_for(<%= class_name %>::Engine)
 ```
 
 ### Running the sandbox

data/lib/solidus_dev_support/templates/extension/bin/sandbox.tt

@@ -67,7 +67,7 @@ unbundled bundle install --gemfile Gemfile
 
 unbundled bundle exec rake db:drop db:create
 
-unbundled bundle exec rails generate spree:install \
+unbundled bundle exec rails generate solidus:install \
   --auto-accept \
   --user_class=Spree::User \
   --enforce_available_locales=true \

data/lib/solidus_dev_support/templates/extension/lib/%file_name%.rb.tt

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'solidus_core'
-require 'solidus_support'
-
 require '<%=file_name%>/configuration'
 require '<%=file_name%>/version'
 require '<%=file_name%>/engine'

data/lib/solidus_dev_support/templates/extension/lib/%file_name%/configuration.rb.tt

@@ -2,7 +2,7 @@
 
 module <%= class_name %>
   class Configuration
-    # Define here the settings for this extensions, e.g.:
+    # Define here the settings for this extension, e.g.:
     #
     # attr_accessor :my_setting
   end

data/lib/solidus_dev_support/templates/extension/lib/%file_name%/engine.rb.tt

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/core'
-require '<%= file_name %>'
+require 'solidus_core'
+require 'solidus_support'
 
 module <%= class_name %>
   class Engine < Rails::Engine

data/lib/solidus_dev_support/templates/extension/spec/spec_helper.rb.tt

@@ -19,7 +19,7 @@ require 'solidus_dev_support/rspec/feature_helper'
 Dir["#{__dir__}/support/**/*.rb"].sort.each { |f| require f }
 
 # Requires factories defined in lib/<%= file_name %>/testing_support/factories.rb
-require '<%= file_name %>/testing_support/factories'
+SolidusDevSupport::TestingSupport::Factories.load_for(<%= class_name %>::Engine)
 
 RSpec.configure do |config|
   config.infer_spec_type_from_file_location!

data/lib/solidus_dev_support/testing_support/factories.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+
+Spree::Deprecation.silence do
+  require 'spree/testing_support/factories'
+  puts <<~MSG
+    We are transitioning to a new way of loading factories for extensions.
+    Be sure this extension does not load factories using require but uses
+    the load_for() method in its spec_helper.rb, eg:
+
+      SolidusDevSupport::TestingSupport::Factories.load_for(ExtensionName1::Engine, ExtensionName2::Engine)
+
+    This will load Solidus Core factories right before the ones defined in
+    lib/extension_name/testing_support/factories/*_factory.rb or
+    lib/extension_name/testing_support/factories.rb
+
+    This message will be removed when all extensions are updated.
+  MSG
+end
+
+begin
+  require 'spree/testing_support/factory_bot'
+rescue LoadError
+  # Do nothing, we are testing the extension against an old version of Solidus
+end
+
+module SolidusDevSupport
+  module TestingSupport
+    module Factories
+      def self.load_for(*engines)
+        paths = engines.flat_map do |engine|
+          # Check if the extension has a lib/*/factories.rb. If it does, we emit a
+          # deprecation warning and just use it.
+          obsolete_factories_file = engine.root.glob('lib/*/factories.rb').first # 'lib/*/factories/*_factory.rb'
+          if obsolete_factories_file.present?
+            ActiveSupport::Deprecation.warn <<-WARN.squish, caller(4)
+              SolidusDevSupport::TestingSupport::Factories.load_for() is automatically loading
+              all factories present in #{obsolete_factories_file.dirname.to_s.gsub(engine.root.to_s, '')}/testing_support/factories/.
+              Please move the content of #{obsolete_factories_file.to_s.gsub(engine.root.to_s, '')} to that directory.
+            WARN
+
+            [obsolete_factories_file]
+          else
+            # If there are both a lib/*/testing_support/factories.rb and a lib/*/testing_support/factories/,
+            # we assume that the factories.rb file is only used to load all factories prensent in the directory.
+            # That file can be removed from the extension, in fact, we ignore it and emit a message asking to
+            # remove it.
+            factories_file_or_folder = engine.root.glob('lib/*/testing_support/factories{,.rb}')
+            if factories_file_or_folder.size == 2
+              folder, file = factories_file_or_folder.partition(&:directory?).map(&:first).map { |path| path.to_s.gsub(engine.root.to_s, '') }
+              ActiveSupport::Deprecation.warn <<-WARN.squish, caller(4)
+                SolidusDevSupport::TestingSupport::Factories.load_for() is automatically loading
+                all factories present into #{folder}. You should now safely remove #{file} if it
+                is only used to load ./factories content.
+              WARN
+
+              engine.root.glob('lib/*/testing_support/factories/**/*_factory.rb')
+            elsif factories_file_or_folder.first.directory?
+              engine.root.glob('lib/*/testing_support/factories/**/*_factory.rb')
+            else
+              factories_file_or_folder
+            end
+          end
+        end.map { |path| path.sub(/.rb\z/, '').to_s }
+
+        if using_factory_bot_definition_file_paths?
+          FactoryBot.definition_file_paths = [
+            Spree::TestingSupport::FactoryBot.definition_file_paths,
+            paths,
+          ].flatten
+
+          FactoryBot.reload
+        else
+          FactoryBot.find_definitions
+
+          paths.each { |path| require path }
+        end
+      end
+
+      def self.using_factory_bot_definition_file_paths?
+        defined?(Spree::TestingSupport::FactoryBot) &&
+          Spree::TestingSupport::FactoryBot.respond_to?(:definition_file_paths)
+      end
+    end
+  end
+end

data/lib/solidus_dev_support/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SolidusDevSupport
-  VERSION = "2.2.0"
+  VERSION = "2.4.3"
 
   def self.gem_version
     Gem::Version.new(VERSION)

data/solidus_dev_support.gemspec

@@ -32,7 +32,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'capybara-screenshot', '~> 1.0'
   spec.add_dependency 'codecov', '~> 0.2'
   spec.add_dependency 'database_cleaner', '~> 1.7'
-  spec.add_dependency 'factory_bot_rails', '~> 5.1'
+  spec.add_dependency 'factory_bot', '~> 4.8'
+  spec.add_dependency 'factory_bot_rails'
   spec.add_dependency 'ffaker', '~> 2.13'
   spec.add_dependency 'gem-release', '~> 2.1'
   spec.add_dependency 'github_changelog_generator', '~> 1.15'
@@ -42,7 +43,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rubocop', '~> 1.0'
   spec.add_dependency 'rubocop-performance', '~> 1.5'
   spec.add_dependency 'rubocop-rails', '~> 2.3'
-  spec.add_dependency 'rubocop-rspec', '~> 1.36'
+  spec.add_dependency 'rubocop-rspec', '~> 2.0'
   spec.add_dependency 'solidus_core', ['>= 2.0', '< 3']
   spec.add_dependency 'webdrivers', '~> 4.4'
 

data/spec/features/create_extension_spec.rb

@@ -122,11 +122,16 @@ RSpec.describe 'Create extension' do
   end
 
   def check_run_specs
+    install_path.join('lib', 'solidus_test_extension', 'testing_support', 'factories.rb').open('a') do |factories_file|
+      factories_file.write "\n puts 'loading test_extension factories'"
+    end
+
     install_path.join('spec', 'some_spec.rb').write(
       "require 'spec_helper'\nRSpec.describe 'Some test' do it { expect(true).to be_truthy } end\n"
     )
     cd(install_path) do
       output = sh('bundle exec rspec')
+      expect(output).to include('loading test_extension factories')
       expect(output).to include('1 example, 0 failures')
       expect(output).to include(ENV['CODECOV_TOKEN'] ? 'Coverage reports upload successfully' : 'Provide a CODECOV_TOKEN environment variable to enable Codecov uploads')
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_dev_support
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.4.3
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-27 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -67,19 +67,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: factory_bot_rails
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '4.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ffaker
   requirement: !ruby/object:Gem::Requirement
@@ -212,14 +226,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: solidus_core
   requirement: !ruby/object:Gem::Requirement
@@ -356,6 +370,7 @@ files:
 - lib/solidus_dev_support/templates/extension/rspec
 - lib/solidus_dev_support/templates/extension/rubocop.yml
 - lib/solidus_dev_support/templates/extension/spec/spec_helper.rb.tt
+- lib/solidus_dev_support/testing_support/factories.rb
 - lib/solidus_dev_support/testing_support/preferences.rb
 - lib/solidus_dev_support/version.rb
 - solidus_dev_support.gemspec