solidus_dev_support 2.3.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58949d06dbd9443030d57e6f70894aed059f00684f865d7f0b7b631590adddc8
-  data.tar.gz: 2963edee739c9fd30df63e896a1794f5765e2cb6f243e2093d59c9a3458224aa
+  metadata.gz: 72a33b9cca402cd6724c7b9c95cfc826dc4bc011272654a67a72487a43eb8936
+  data.tar.gz: 77725ac4faffd63e4b480d2d5964a1084c09eac6c1350d5b08fc15c4e9ad615b
 SHA512:
-  metadata.gz: e0a31ee39a78e7738f12a17d1cb0e75fe66e70a6249027f540f28c488ea3a21f826e6631b5233792b6b18f4802cc98dd86fbd6cab4bf39611f18acc8911f5ae8
-  data.tar.gz: 620fc9ec7cb78af1bd94ea12da18cb3452db2a6114e81b58d7e7f2bad46bd5744f3f18b6800d06d55b353bc65354fa8d054c5ebcc5e328f8dc1617e5962b8f58
+  metadata.gz: 0f87121188ad5f7d5046e2d4f1f6172ed9cedc4f70dbd66ee648d97bfcac55765be764db8afcc154fc98209e15c6efbf92fcaf082263bd341b5a439dd04c13ef
+  data.tar.gz: 9a4d51ae3458794ff639f7a990a8d5b1e4df0548889b67bc3a2c5228d6fa3db5e5bde9ca938fa367e680d0aff0202a725b2bf604715a494a8b13d5dde956b901

data/CHANGELOG.md

@@ -1,8 +1,59 @@
 # Changelog
 
-## [2.3.0](https://github.com/solidusio/solidus_dev_support/tree/2.3.0) (2021-01-14)
+## [v2.5.0](https://github.com/solidusio/solidus_dev_support/tree/v2.5.0) (2021-04-20)
 
-[Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v2.2.0...2.3.0)
+[Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v2.4.3...v2.5.0)
+
+**Implemented enhancements:**
+
+- Allow Solidus 3 [\#176](https://github.com/solidusio/solidus_dev_support/pull/176) ([kennyadsl](https://github.com/kennyadsl))
+- Relax Ruby version requirement [\#174](https://github.com/solidusio/solidus_dev_support/pull/174) ([gauravtiwari](https://github.com/gauravtiwari))
+
+## [v2.4.3](https://github.com/solidusio/solidus_dev_support/tree/v2.4.3) (2021-02-23)
+
+[Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v2.4.2...v2.4.3)
+
+**Implemented enhancements:**
+
+- Add instruction on how to use the new factories in apps [\#172](https://github.com/solidusio/solidus_dev_support/pull/172) ([kennyadsl](https://github.com/kennyadsl))
+
+**Fixed bugs:**
+
+- Explode directories into individual files [\#171](https://github.com/solidusio/solidus_dev_support/pull/171) ([kennyadsl](https://github.com/kennyadsl))
+- Fix factories loading, part 2 [\#170](https://github.com/solidusio/solidus_dev_support/pull/170) ([kennyadsl](https://github.com/kennyadsl))
+
+## [v2.4.2](https://github.com/solidusio/solidus_dev_support/tree/v2.4.2) (2021-02-19)
+
+[Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v2.4.1...v2.4.2)
+
+## [v2.4.1](https://github.com/solidusio/solidus_dev_support/tree/v2.4.1) (2021-02-19)
+
+[Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v2.4.0...v2.4.1)
+
+**Fixed bugs:**
+
+- Fix loading factories in extensions after the last changes in Solidus [\#169](https://github.com/solidusio/solidus_dev_support/pull/169) ([kennyadsl](https://github.com/kennyadsl))
+
+## [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.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:**
 
@@ -40,7 +91,7 @@
 **Implemented enhancements:**
 
 - Add standard github\_changelog\_generator configuration [\#151](https://github.com/solidusio/solidus_dev_support/pull/151) ([aldesantis](https://github.com/aldesantis))
-- Move generated factories to `testing\_support/` [\#150](https://github.com/solidusio/solidus_dev_support/pull/150) ([aldesantis](https://github.com/aldesantis))
+- Move generated factories to `testing_support/` [\#150](https://github.com/solidusio/solidus_dev_support/pull/150) ([aldesantis](https://github.com/aldesantis))
 - Add extension configuration boilerplate [\#149](https://github.com/solidusio/solidus_dev_support/pull/149) ([aldesantis](https://github.com/aldesantis))
 
 **Fixed bugs:**

data/lib/solidus_dev_support/rspec/rails_helper.rb

@@ -16,7 +16,6 @@ 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'

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/extension.gemspec.tt

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'solidus_core', ['>= 2.0.0', '< 3']
+  spec.add_dependency 'solidus_core', ['>= 2.0.0', '< 4']
   spec.add_dependency 'solidus_support', '~> 0.5'
 
   spec.add_development_dependency 'solidus_dev_support', '<%= SolidusDevSupport.gem_version.approximate_recommendation %>'

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/testing_support/factories.rb

@@ -1,20 +1,75 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factories'
 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|
-          engine.root.glob('lib/**/factories.rb')
-        end
+          # 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
 
-        if Spree::TestingSupport.respond_to? :load_all_factories
-          FactoryBot.definition_file_paths.concat(
-            paths.map { |path| path.sub(/.rb\z/, '').to_s }
-          )
           FactoryBot.reload
         else
           FactoryBot.find_definitions
@@ -22,6 +77,11 @@ module SolidusDevSupport
           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.3.0"
+  VERSION = "2.5.0"
 
   def self.gem_version
     Gem::Version.new(VERSION)

data/solidus_dev_support.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.metadata['source_code_uri'] = 'https://github.com/solidusio/solidus_dev_support'
   spec.metadata['changelog_uri'] = 'https://github.com/solidusio/solidus_dev_support/blob/master/CHANGELOG.md'
 
-  spec.required_ruby_version = Gem::Requirement.new('~> 2.5')
+  spec.required_ruby_version = '>= 2.5.0'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -44,7 +44,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rubocop-performance', '~> 1.5'
   spec.add_dependency 'rubocop-rails', '~> 2.3'
   spec.add_dependency 'rubocop-rspec', '~> 2.0'
-  spec.add_dependency 'solidus_core', ['>= 2.0', '< 3']
+  spec.add_dependency 'solidus_core', ['>= 2.0', '< 4']
   spec.add_dependency 'webdrivers', '~> 4.4'
 
   spec.add_development_dependency 'bundler'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_dev_support
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-14 00:00:00.000000000 Z
+date: 2021-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -243,7 +243,7 @@ dependencies:
         version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -253,7 +253,7 @@ dependencies:
         version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: webdrivers
   requirement: !ruby/object:Gem::Requirement
@@ -390,9 +390,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="