spree_dev_tools 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50f54b64fcc142327f7381d41040efb511bad5154122eb5c4944081204d98d4b
-  data.tar.gz: da9cbcc206dcb37873f0bdeb4a0fb7278c66be4a430fb5fbf21bd0d10a6396ad
+  metadata.gz: f07ca8bc10a4d253c954b6ef0a54be9adfce8b531376302007cc855a30a85c4c
+  data.tar.gz: 6b2e41cc7eb9f9f15967f2115cc480f7def3c1ca78f4c7083adaafa35eb7640a
 SHA512:
-  metadata.gz: '092a498a35913e6bc9a6fbd5d41c859c70dc299d1706d7cf264192f40bcb420d00ab00a0dc42548240638ee1830df250a02e76b79cd3b4daaf9355d84ae19cb6'
-  data.tar.gz: 41d5a28f16a6d447f06ad57656b69be77a8dac19ef909a61fdc2895b1d611ab801783a1c58b17477bc1b0a9a78f4857328a353cbc067f62e0fd0148fbb207455
+  metadata.gz: add3bd3cebd21c9af8a113d7619fbeec505b0c9d116cc40875beb5729896047d03b49fabc9d8301e6b13454f242c681251191f1ab09fcb1f73baee9e53a6c2e7
+  data.tar.gz: b0113636d6d81a1676d5f740129a1986e18f99331bd8d393f098f39068c8f6761f1dc17d89d7a1413cf5c485e648c9d96c3d779dbf0733978df435cc4e962c55

data/README.md

@@ -1,25 +1,27 @@
 # Spree Developer Tools
 
-This gem includes:
-
-* all dependencies to run Spree applications in development and test environments
-* configuration for testing environment
-* rspec and capybara helpers
+This is a Spree development tools gem. It helps you work with Spree applications, both extensions and standard Rails applications.
 
 ## Installation
 
-Add it to your `Gemfile`
+Add it to your `Gemfile`:
 
 ```ruby
-gem 'spree_dev_tools'
+gem 'spree_dev_tools', group: [:development, :test]
 ```
 
-And run...
+Run:
 
 ```bash
 bundle install
 ```
 
+And finally run the generator:
+
+```bash
+bundle exec rails g spree_dev_tools:install
+```
+
 ## Configuring
 
 If you want to disable Simplecov set the `SPREE_DEV_TOOLS_DISABLE_SIMPLECOV` ENV variable to any value.

data/lib/spree_dev_tools/engine.rb

@@ -0,0 +1,12 @@
+module SpreeDevTools
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_dev_tools'
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot, dir: "spec/factories"
+    end
+  end
+end

data/lib/spree_dev_tools/generators/install/install_generator.rb

@@ -0,0 +1,49 @@
+require 'rails/generators'
+
+module SpreeDevTools
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def self.source_paths
+      paths = superclass.source_paths
+      paths << File.expand_path('templates', __dir__)
+      paths << File.expand_path('../../rspec/support', __dir__)
+      paths.flatten
+    end
+
+    desc 'Configures Rails generators for RSpec and FactoryBot'
+
+    def run_rspec_install
+      return if File.exist?(Rails.root.join('spec/spec_helper.rb'))
+
+      rails_command 'rspec:install'
+    end
+
+    def install_spree_dev_tools
+      return if File.exist?(Rails.root.join('config/initializers/spree_dev_tools.rb'))
+
+      template 'spree_dev_tools.rb', 'config/initializers/spree_dev_tools.rb'
+    end
+
+    def inject_rspec_support_files
+      empty_directory 'spec/support'
+
+      template 'capybara.rb', 'spec/support/capybara.rb'
+      template 'action_text.rb', 'spec/support/action_text.rb'
+      template 'active_job.rb', 'spec/support/active_job.rb'
+      template 'database_cleaner.rb', 'spec/support/database_cleaner.rb'
+      template 'devise.rb', 'spec/support/devise.rb'
+      template 'factory_bot.rb', 'spec/support/factory_bot.rb'
+      template 'spree.rb', 'spec/support/spree.rb'
+    end
+
+    def enable_support_files_loading
+      rails_helper_path = Rails.root.join('spec/rails_helper.rb')
+      return unless File.exist?(rails_helper_path)
+
+      gsub_file 'spec/rails_helper.rb',
+                "# Rails.root.glob('spec/support/**/*.rb').sort_by(&:to_s).each { |f| require f }",
+                "Rails.root.glob('spec/support/**/*.rb').sort_by(&:to_s).each { |f| require f }"
+    end
+  end
+end

data/lib/spree_dev_tools/generators/install/templates/spree_dev_tools.rb

@@ -0,0 +1,4 @@
+Rails.application.config.generators do |g|
+  g.test_framework :rspec
+  g.fixture_replacement :factory_bot, dir: "spec/factories"
+end

data/lib/spree_dev_tools/rspec/spec_helper.rb

@@ -3,43 +3,13 @@
 ENV['RAILS_ENV'] ||= 'test'
 
 require 'rspec/rails'
-require 'database_cleaner/active_record'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
-require 'ffaker'
 require 'pry'
 
-require 'webdrivers/chromedriver'
-require 'spree/testing_support/authorization_helpers'
-require 'spree/testing_support/factories'
-require 'spree/api/testing_support/factories'
-require 'spree/testing_support/preferences'
-require 'spree/testing_support/jobs'
-require 'spree/testing_support/store'
-require 'spree/testing_support/controller_requests'
-require 'spree/testing_support/url_helpers'
-require 'spree/testing_support/order_walkthrough'
-require 'spree/admin/testing_support/capybara_utils'
-require 'spree/admin/testing_support/tom_select'
-require 'spree/testing_support/capybara_config'
-require 'spree/testing_support/rspec_retry_config'
-require 'spree/testing_support/image_helpers'
-
-require 'jsonapi/rspec'
-require 'spree/api/testing_support/v2/base'
-require 'spree/api/testing_support/matchers/webhooks'
-require 'spree/api/testing_support/factories'
-require 'spree/api/testing_support/v2/current_order'
-require 'spree/api/testing_support/v2/platform_contexts'
-require 'spree/api/testing_support/v2/serializers_params'
-
-require 'spree/core/controller_helpers/strong_parameters'
-
-require 'action_text/system_test_helper'
-
 RSpec.configure do |config|
   config.color = true
   config.default_formatter = 'doc'
@@ -53,43 +23,6 @@ RSpec.configure do |config|
   # instead of true.
   config.use_transactional_fixtures = true
 
-  config.before(:suite) do
-    Capybara.match = :smart
-    Capybara.javascript_driver = :selenium_chrome_headless
-    Capybara.default_max_wait_time = 10
-    Capybara.raise_server_errors = false
-    # Clean out the database state before the tests run
-    DatabaseCleaner.strategy = :transaction
-    DatabaseCleaner.clean_with(:truncation)
-  end
-
-  config.around(:each) do |example|
-    DatabaseCleaner.cleaning do
-      example.run
-    end
-  end
-
-  config.before(:each) do
-    Spree::Webhooks.disabled = true
-    reset_spree_preferences
-  end
-
-  config.include FactoryBot::Syntax::Methods
-
-  config.include Spree::Admin::TestingSupport::CapybaraUtils
-  config.include Spree::Admin::TestingSupport::TomSelect
-  config.include Spree::TestingSupport::Preferences
-  config.include Spree::TestingSupport::UrlHelpers
-  config.include Spree::TestingSupport::ControllerRequests, type: :controller
-  config.include Spree::TestingSupport::ImageHelpers
-
-  config.include Spree::Core::ControllerHelpers::StrongParameters, type: :controller
-
-  config.include ActionText::SystemTestHelper, type: :feature
-
-  config.include JSONAPI::RSpec, type: :request # required for API v2 request specs
-  config.include Spree::TestingSupport::ApiHelpers, type: :request
-
   config.order = :random
   Kernel.srand config.seed
 

data/lib/spree_dev_tools/rspec/support/action_text.rb

@@ -0,0 +1,7 @@
+require 'capybara'
+require 'rspec/rails'
+require 'action_text/system_test_helper'
+
+RSpec.configure do |config|
+  config.include ActionText::SystemTestHelper, type: :feature
+end

data/lib/spree_dev_tools/rspec/support/active_job.rb

@@ -1,3 +1,6 @@
+require 'rspec/rails'
+require 'active_job/test_helper'
+
 RSpec.configure do |config|
   config.include ActiveJob::TestHelper
 end

data/lib/spree_dev_tools/rspec/support/capybara.rb

@@ -0,0 +1,11 @@
+require 'webdrivers/chromedriver'
+require 'capybara'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Capybara.match = :smart
+    Capybara.javascript_driver = :selenium_chrome_headless
+    Capybara.default_max_wait_time = 10
+    Capybara.raise_server_errors = false
+  end
+end

data/lib/spree_dev_tools/rspec/support/database_cleaner.rb

@@ -0,0 +1,16 @@
+require 'rspec/rails'
+require 'database_cleaner/active_record'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    # Clean out the database state before the tests run
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+end

data/lib/spree_dev_tools/rspec/support/devise.rb

@@ -1,3 +1,5 @@
+require 'rspec/rails'
+
 if defined?(Warden)
   include Warden::Test::Helpers
   Warden.test_mode!

data/lib/spree_dev_tools/rspec/support/factory_bot.rb

@@ -1,4 +1,5 @@
 require 'factory_bot'
+require 'rspec/rails'
 
 FactoryBot.find_definitions
 

data/lib/spree_dev_tools/rspec/support/spree.rb

@@ -0,0 +1,58 @@
+require 'rspec/rails'
+require 'ffaker'
+
+require 'spree/testing_support/authorization_helpers'
+require 'spree/testing_support/factories'
+require 'spree/testing_support/preferences'
+require 'spree/testing_support/jobs'
+require 'spree/testing_support/store'
+require 'spree/testing_support/controller_requests'
+require 'spree/testing_support/url_helpers'
+require 'spree/testing_support/order_walkthrough'
+require 'spree/admin/testing_support/capybara_utils'
+require 'spree/admin/testing_support/tom_select'
+require 'spree/testing_support/capybara_config'
+require 'spree/testing_support/rspec_retry_config'
+require 'spree/testing_support/image_helpers'
+
+require 'jsonapi/rspec'
+require 'spree/api/testing_support/v2/base'
+require 'spree/api/testing_support/matchers/webhooks'
+require 'spree/api/testing_support/factories'
+require 'spree/api/testing_support/v2/current_order'
+require 'spree/api/testing_support/v2/platform_contexts'
+require 'spree/api/testing_support/v2/serializers_params'
+require 'spree/core/controller_helpers/strong_parameters'
+
+module Spree
+  module TestingSupport
+    module ApiHelpers
+      def json_response
+        case body = JSON.parse(response.body)
+        when Hash
+          body.with_indifferent_access
+        when Array
+          body
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Spree::Admin::TestingSupport::CapybaraUtils
+  config.include Spree::Admin::TestingSupport::TomSelect
+  config.include Spree::TestingSupport::Preferences
+  config.include Spree::TestingSupport::UrlHelpers
+  config.include Spree::TestingSupport::ControllerRequests, type: :controller
+  config.include Spree::TestingSupport::ImageHelpers
+  config.include Spree::Core::ControllerHelpers::StrongParameters, type: :controller
+
+  config.include JSONAPI::RSpec, type: :request # required for API v2 request specs
+  config.include Spree::TestingSupport::ApiHelpers, type: :request
+
+  config.before(:each) do
+    Spree::Webhooks.disabled = true
+    reset_spree_preferences
+  end
+end

data/lib/spree_dev_tools/version.rb

@@ -1,5 +1,5 @@
 module SpreeDevTools
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
 
   # Returns the version of the currently loaded SpreeDevTools as a
   # <tt>Gem::Version</tt>.

data/lib/spree_dev_tools.rb

@@ -1 +1,5 @@
+require 'spree_core'
+require 'spree_api'
+require 'spree_dev_tools/engine'
 require 'spree_dev_tools/version'
+require 'spree_dev_tools/generators/install/install_generator'

data/spree_dev_tools.gemspec

@@ -21,15 +21,14 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
   s.requirements << 'none'
 
-  s.add_dependency 'appraisal'
   s.add_dependency 'awesome_print'
   s.add_dependency 'brakeman'
   s.add_dependency 'capybara'
   s.add_dependency 'capybara-screenshot'
-  s.add_dependency 'capybara-select-2'
   s.add_dependency 'database_cleaner'
   s.add_dependency 'dotenv'
-  s.add_dependency 'factory_bot', '~> 6.2'
+  s.add_dependency 'factory_bot'
+  s.add_dependency 'factory_bot_rails'
   s.add_dependency 'ffaker'
   s.add_dependency 'gem-release'
   s.add_dependency 'github_changelog_generator'
@@ -42,8 +41,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'rspec_junit_formatter'
   s.add_dependency 'rspec-rails'
   s.add_dependency 'rspec-retry'
-  s.add_dependency 'rubocop'
-  s.add_dependency 'rubocop-rails'
   s.add_dependency 'selenium-webdriver', '>= 4.10'
   s.add_dependency 'simplecov'
   s.add_dependency 'spree', '>= 5.0'

metadata

@@ -1,29 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_dev_tools
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Spark Solutions
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  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: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: capybara-select-2
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +80,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +94,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,19 +108,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_bot
+  name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ffaker
   requirement: !ruby/object:Gem::Requirement
@@ -304,34 +289,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  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: rubocop-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: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -415,19 +372,24 @@ files:
 - LICENSE
 - README.md
 - lib/spree_dev_tools.rb
+- lib/spree_dev_tools/engine.rb
+- lib/spree_dev_tools/generators/install/install_generator.rb
+- lib/spree_dev_tools/generators/install/templates/spree_dev_tools.rb
 - lib/spree_dev_tools/rspec/spec_helper.rb
+- lib/spree_dev_tools/rspec/support/action_text.rb
 - lib/spree_dev_tools/rspec/support/active_job.rb
+- lib/spree_dev_tools/rspec/support/capybara.rb
+- lib/spree_dev_tools/rspec/support/database_cleaner.rb
 - lib/spree_dev_tools/rspec/support/devise.rb
 - lib/spree_dev_tools/rspec/support/factory_bot.rb
 - lib/spree_dev_tools/rspec/support/simplecov.rb
-- lib/spree_dev_tools/rspec/support/spree_api_helpers.rb
+- lib/spree_dev_tools/rspec/support/spree.rb
 - lib/spree_dev_tools/version.rb
 - spree_dev_tools.gemspec
 homepage: https://github.com/spree/spree_dev_tools
 licenses:
 - BSD-3-Clause
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -443,8 +405,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - none
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Spree Dev Tools
 test_files: []

data/lib/spree_dev_tools/rspec/support/spree_api_helpers.rb

@@ -1,14 +0,0 @@
-module Spree
-  module TestingSupport
-    module ApiHelpers
-      def json_response
-        case body = JSON.parse(response.body)
-        when Hash
-          body.with_indifferent_access
-        when Array
-          body
-        end
-      end
-    end
-  end
-end