test_data 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4178759cb111f2f83cad983712c1b82220aa09ecdbd7d710b7517974c63fee8c
-  data.tar.gz: dc83bc5526b88239ba2d55661a8ab61865a7a8d19f8c195d2caa41e00125b7e5
+  metadata.gz: 9e046c25f181fc9022139cd1d009142b390d7da348d9eb00dc18f03291927c35
+  data.tar.gz: 60dfa3ca0fbbf8389d009ceec584f2239eb01391c2e3fb88badd063669c48d28
 SHA512:
-  metadata.gz: 7aba197cb61bff3286913de3678a6df0f4595774bb7283228de6e26ae64fb03586e8233362bf9cea3ef041cc1e53a539a323e3c5d59fb6d16470f6db904402e5
-  data.tar.gz: bc49d93f8dc68d09612ba36220dd7f380a2f8cc4657f968dc9a8220d96f07532c912f119fed9e2d25ba0840b9480f82a12954ea30a54bd1c1fe357bea8920154
+  metadata.gz: 5d3727bbd0f8bf7cb3d32c042864a624c0cf5ebcd956f7abf158aeb0cabbbc97505a4c18b5f4345a8ea4570d56384532f2ecfeed03d1319850f92a61602ecb63
+  data.tar.gz: dab23d60d8c459bc756e532e35e7de0e499a3b760a1f3ec652d5aea866503b6ccdac670edcc0bba0fafc1cc4f7c3281b98b21760ce84b808d5c5428b25f1d64b

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.3.2
+
+- Improve the flexibility of the webpacker config generator
+- Improve failure output when an error is raised during rake tests that fork
+  into a `test_data` env
+
 # 0.3.1
 
 - Loosen railties dependencies after verifying basic Rails 7 support

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    test_data (0.3.1)
+    test_data (0.3.2)
       railties (>= 6.0, < 8.0)
 
 GEM
@@ -33,7 +33,7 @@ GEM
     erubi (1.10.0)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    loofah (2.15.0)
+    loofah (2.16.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
@@ -66,9 +66,9 @@ GEM
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.3.0)
     rexml (3.2.5)
-    rubocop (1.26.0)
+    rubocop (1.26.1)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -77,14 +77,14 @@ GEM
       rubocop-ast (>= 1.16.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+    rubocop-ast (1.17.0)
       parser (>= 3.1.1.0)
     rubocop-performance (1.13.3)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
-    standard (1.9.0)
-      rubocop (= 1.26.0)
+    standard (1.9.1)
+      rubocop (= 1.26.1)
       rubocop-performance (= 1.13.3)
     thor (1.2.1)
     tzinfo (2.0.4)

data/README.md

@@ -19,8 +19,8 @@ What it does:
   app**
 
 * Exposes a simple API for ensuring that your data will be pristine for each of
-  your tests, whether the test depends on test_data, an empty database, or Rails
-  fixtures
+  your tests, whether the test depends on test_data, factories, fixtures, or an
+  empty database
 
 * Safeguards your tests from flaky failures and supercharges your build by
   providing a sophisticated transaction manager that isolates each test while
@@ -41,11 +41,11 @@ are required**—so it may not work for every project just yet.]_
 
 This gem requires a lot of documentation—not because `test_data` does a lot of
 things, but because managing one's test data is an inherently complex task. If
-one reason Rails apps chronically suffer from slow tests is that other
-approaches oversimplify test data management, it stands to reason that any
-discomfort caused by `test_data`'s scope may not be _unnecessary complexity_ but
-instead be an indication of how little of the problem's _essential complexity_
-we have reckoned with to this point.
+there's one reason Rails apps often suffer from slow tests, it's that the most
+popular approaches to test data management oversimplify the problem—they might
+save time up front, but tend to cost you later. The `test_data` gem, meanwhile,
+is designed to tackle the problem head on: it takes longer to set up, but it'll
+scale along with your application for years to come.
 
 1. [Getting Started Guide](#getting-started-guide)
     1. [Install and initialize `test_data`](#step-1-install-and-initialize-test_data)
@@ -106,22 +106,42 @@ And if you get stuck or need help as you're getting started, please feel free to
 
 ### Step 1: Install and initialize `test_data`
 
-#### Adding the gem
+#### Adding a `:test_data` group to your Gemfile
+
+Before even installing anything, it's important to understand that because
+`test_data` defines a new Rails environment and because Rails expects
+a gem group (like `:development`, `:test`, and `:production`) for each
+environment, any gems we want to be available to the `test_data` gem need to be
+installed with a `:test_data` group.
 
-First, add `test_data` to your Gemfile. Either include it in all groups or add
-it to the `:development`, `:test`, and (the all new!) `:test_data` gem groups:
+Since the `test_data` environment is designed to be used similarly to
+`development` (i.e. with a running server and interacting via a browser), any
+gems in your `:development` gem group should likely be included in a
+`:test_data` gem group as well.
+
+For example, this:
 
 ```ruby
-group :development, :test, :test_data do
+group :development, :test do
+  gem "standard"
+  gem "cypress-rails"
   gem "test_data"
-  # … other gems available to development & test
 end
 ```
 
-Since the `test_data` environment is designed to be used similarly to
-`development` (i.e. with a running server and interacting via a browser), any
-gems in your `:development` gem group should likely be included in a
-`:test_data` gem group as well.
+Should have its first line changed to:
+
+```ruby
+group :development, :test, :test_data do
+```
+
+#### Adding the gem
+
+Finally, add `test_data` to your Gemfile and `bundle install` it:
+
+```ruby
+gem "test_data"
+```
 
 #### Configuring the gem and initializing the database
 

data/example/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    test_data (0.3.1)
+    test_data (0.3.2)
       railties (>= 6.0, < 8.0)
 
 GEM
@@ -103,8 +103,7 @@ GEM
       activesupport (>= 5.0)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    io-wait (0.2.1)
-    loofah (2.15.0)
+    loofah (2.16.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -115,7 +114,7 @@ GEM
     mini_mime (1.1.2)
     mini_portile2 (2.8.0)
     minitest (5.15.0)
-    msgpack (1.4.5)
+    msgpack (1.5.1)
     net-imap (0.2.3)
       digest
       net-protocol
@@ -124,8 +123,7 @@ GEM
       digest
       net-protocol
       timeout
-    net-protocol (0.1.2)
-      io-wait
+    net-protocol (0.1.3)
       timeout
     net-smtp (0.3.1)
       digest
@@ -139,14 +137,14 @@ GEM
     parallel (1.22.1)
     parser (3.1.1.0)
       ast (~> 2.4.1)
-    pg (1.3.4)
+    pg (1.3.5)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-rails (0.3.9)
       pry (>= 0.10.4)
     public_suffix (4.0.6)
-    puma (5.6.2)
+    puma (5.6.4)
       nio4r (~> 2.0)
     racc (1.6.0)
     rack (2.2.3)
@@ -180,14 +178,14 @@ GEM
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.3.0)
     rexml (3.2.5)
     rspec-core (3.11.0)
       rspec-support (~> 3.11.0)
     rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-rails (5.1.1)
@@ -199,7 +197,7 @@ GEM
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
     rspec-support (3.11.0)
-    rubocop (1.26.0)
+    rubocop (1.26.1)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -208,7 +206,7 @@ GEM
       rubocop-ast (>= 1.16.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+    rubocop-ast (1.17.0)
       parser (>= 3.1.1.0)
     rubocop-performance (1.13.3)
       rubocop (>= 1.7.0, < 2.0)
@@ -219,8 +217,8 @@ GEM
       childprocess (>= 0.5, < 5.0)
       rexml (~> 3.2, >= 3.2.5)
       rubyzip (>= 1.2.2)
-    standard (1.9.0)
-      rubocop (= 1.26.0)
+    standard (1.9.1)
+      rubocop (= 1.26.1)
       rubocop-performance (= 1.13.3)
     strscan (3.0.1)
     thor (1.2.1)

data/lib/generators/test_data/webpacker_yaml_generator.rb

@@ -4,22 +4,36 @@ require_relative "../../test_data/generator_support"
 module TestData
   class WebpackerYamlGenerator < Rails::Generators::Base
     AFTER_DEVELOPMENT_WEBPACK_STANZA_REGEX = /^development:/
+    AFTER_TEST_DATA_WEBPACK_STANZA_REGEX = /^test_data:\n  <<: \*development/
 
     def call
-      if Configurators::WebpackerYaml.new.verify.looks_good?
-        TestData.log.debug "'test_data' section not needed in config/webpacker.yml"
+      configurator = Configurators::WebpackerYaml.new
+      webpacker_config = Wrap::WebpackerConfig.new
+
+      if configurator.verify.looks_good?
+        TestData.log.debug "'test_data' section looks good in `config/webpacker.yml'"
       else
-        inject_into_file "config/webpacker.yml", after: AFTER_DEVELOPMENT_WEBPACK_STANZA_REGEX do
-          " &development"
-        end
-        inject_into_file "config/webpacker.yml", before: BEFORE_TEST_STANZA_REGEX do
-          <<~YAML
+        unless webpacker_config.user_config.key?("test_data")
+          inject_into_file "config/webpacker.yml", after: AFTER_DEVELOPMENT_WEBPACK_STANZA_REGEX do
+            " &development"
+          end
+          inject_into_file "config/webpacker.yml", before: BEFORE_TEST_STANZA_REGEX do
+            <<~YAML
 
-            # Used in conjunction with the test_data gem
-            test_data:
-              <<: *development
+              # Used in conjunction with the test_data gem
+              test_data:
+                <<: *development
+
+            YAML
+          end
+        end
 
-          YAML
+        if (missing_entries = webpacker_config.required_entries_missing_from_test_data_config)
+          inject_into_file "config/webpacker.yml", after: /^test_data:\n/ do
+            missing_entries.map { |(key, val)|
+              "  #{key}: #{val.inspect}\n"
+            }.join
+          end
         end
       end
     end

data/lib/test_data/configurators/webpacker_yaml.rb

@@ -3,21 +3,23 @@ module TestData
     class WebpackerYaml
       def initialize
         @generator = WebpackerYamlGenerator.new
-        @config = TestData.config
+        @webpacker_config = Wrap::WebpackerConfig.new
       end
 
       def verify
-        path = "config/webpacker.yml"
-        pathname = Pathname.new("#{@config.pwd}/#{path}")
-        return ConfigurationVerification.new(looks_good?: true) unless pathname.readable?
-        yaml = load_yaml(pathname)
-        if yaml.nil?
+        if @webpacker_config.no_user_config_exists?
+          ConfigurationVerification.new(looks_good?: true)
+        elsif (user_config = @webpacker_config.user_config).nil?
+          ConfigurationVerification.new(problems: [
+            "`#{@webpacker_config.relative_user_config_path}' is not valid YAML"
+          ])
+        elsif !user_config.key?("test_data")
           ConfigurationVerification.new(problems: [
-            "'#{path}' is not valid YAML"
+            "`#{@webpacker_config.relative_user_config_path}' does not contain a `test_data' section"
           ])
-        elsif !yaml.key?("test_data")
+        elsif (entries = @webpacker_config.required_entries_missing_from_test_data_config)
           ConfigurationVerification.new(problems: [
-            "'#{path}' does not contain a 'test_data' section"
+            "`#{@webpacker_config.relative_user_config_path}' is missing #{"entry".pluralize(entries.size)} #{entries.map { |(k, v)| "`#{k}' (default: #{v.inspect})" }.join(", ")} in its `test_data' section"
           ])
         else
           ConfigurationVerification.new(looks_good?: true)
@@ -27,13 +29,6 @@ module TestData
       def configure
         @generator.call
       end
-
-      private
-
-      def load_yaml(pathname)
-        YAML.load_file(pathname)
-      rescue
-      end
     end
   end
 end

data/lib/test_data/rake.rb

@@ -3,7 +3,7 @@ def wrong_env?
 end
 
 def run_in_test_data_env(task_name)
-  command = "RAILS_ENV=test_data #{Rails.root}/bin/rake #{task_name}"
+  command = "RAILS_ENV=test_data #{Rails.root}/bin/rake #{task_name} --trace"
   unless system(command)
     fail "An error ocurred when running: #{command}"
   end

data/lib/test_data/version.rb

@@ -1,3 +1,3 @@
 module TestData
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/lib/test_data/wrap/webpacker_config.rb

@@ -0,0 +1,42 @@
+module TestData
+  module Wrap
+    class WebpackerConfig
+      def initialize
+        @user_config_path = Pathname.new("#{TestData.config.pwd}/config/webpacker.yml")
+      end
+
+      def relative_user_config_path
+        @user_config_path.relative_path_from(Rails.root)
+      end
+
+      def no_user_config_exists?
+        !@user_config_path.readable?
+      end
+
+      def user_config
+        load_yaml(@user_config_path)
+      end
+
+      def webpacker_gem_spec_loaded?
+        !!Gem.loaded_specs["webpacker"]
+      end
+
+      def builtin_config
+        webpacker_path = Gem.loaded_specs["webpacker"].full_gem_path
+        load_yaml(File.join(webpacker_path, "lib/install/config/webpacker.yml"))
+      end
+
+      def required_entries_missing_from_test_data_config
+        missing_keys = builtin_config["development"].keys - user_config["test_data"].keys
+        builtin_config["development"].slice(*missing_keys).presence
+      end
+
+      private
+
+      def load_yaml(path)
+        YAML.load_file(path)
+      rescue
+      end
+    end
+  end
+end

data/lib/test_data.rb

@@ -11,6 +11,7 @@ require_relative "test_data/configurators/secrets_yaml"
 require_relative "test_data/configurators/webpacker_yaml"
 require_relative "test_data/custom_loaders/abstract_base"
 require_relative "test_data/custom_loaders/rails_fixtures"
+require_relative "test_data/wrap/webpacker_config"
 require_relative "test_data/detects_database_emptiness"
 require_relative "test_data/detects_database_existence"
 require_relative "test_data/determines_when_sql_dump_was_made"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test_data
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-27 00:00:00.000000000 Z
+date: 2022-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -164,6 +164,7 @@ files:
 - lib/test_data/version.rb
 - lib/test_data/warns_if_database_is_newer_than_dump.rb
 - lib/test_data/warns_if_dump_is_newer_than_database.rb
+- lib/test_data/wrap/webpacker_config.rb
 - script/reset_example_app
 - script/test
 - test_data.gemspec