sewing_kit 0.93.0 → 0.94.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2332ea58c71355f50a1c488183042654146d15c5de2a760e878947e0f34f94fd
-  data.tar.gz: 8bab2fe8bac88e5685c6a61f9a7f925a486b0dd6d864e30bb88a71c9c6003e59
+  metadata.gz: e3b2b21c04f2ce3043bc5ff0c27dc61b301ab3585e4f84347d1edfeef0f92121
+  data.tar.gz: d378424249b09da4747a81281d2ba3f703790f23ac8fa2732e0a39ef655224a7
 SHA512:
-  metadata.gz: 12a99b5d80d7ad42943dda11faad69f2df93a682c48a36d9e14c9d1ff21ad31409119f210148b7b64c8f8d1e449adde9fce24aa4e2cf70954b777dd7fd876b13
-  data.tar.gz: c347db6c58d7b1152fcfc9e8243694d6597a8161a6b21ffc3806b7ff484d6396847151ec40cbc18ece73daa517aabf125bb6fa756f2886cd1b9ab22552b01cef
+  metadata.gz: f5beb6976e7812ebef7adc31040a1c5c08178af88118d3952d7aaaea5c740172a6e381b89cf1a388c1ed7e4e6d026e21effdc321e196587613fc0a56233b7be3
+  data.tar.gz: 2b2a62b6e61004d24571e4b5b14319100e5bfc3a60c392a2fcec30912e1e71c4ca3e2142de49d25d14d64d438384e2d3c51385ad7b413d0a5f60a898b195d852

data/README.md

@@ -179,6 +179,39 @@ afterAll(() => {
 
 For more complete documentation of the jest plugin see [it's documentation](/docs/plugins/jest.md).
 
+### Rails tests
+
+Building JavaScript assets for Rails tests adds friction to test driven development, but some projects rely on tests that intermingle erb / JavaScript behaviour. To accommodate different test styles, sewing_kit offers two test modes.
+
+#### `:return_no_assets` - sewing_kit helpers return empty arrays (default)
+
+As noted above, the Web Foundation team highly recommends `sewing-kit test` for front end testing. Projects following this recommendation can use sewing_kit's default behaviour for controller, integration tests, and e2e tests. Note that no sewing_kit content will appear in pages with this mode enabled.
+
+The default behaviour is equivalent to this configuration:
+
+```rb
+# config/initializers/sewing_kit.rb
+SewingKit.configure do |config|
+  config.test_manifest_mode = :return_no_asets
+end
+```
+
+#### Use precompiled assets
+
+If end-to-end tests are unavoidable:
+
+- Add extra steps to your test commands and CI pipelines that run `sewing-kit build --mode test` before test startup
+- Configure sewing_kit's `test_manifest_mode` to use precompiled assets:
+
+```rb
+# config/initializers/sewing_kit.rb
+SewingKit.configure do |config|
+  config.test_manifest_mode = :use_precompiled_assets
+end
+```
+
+If your tests require production assets, precompile using `sewing-kit build --mode production` instead.
+
 ## FAQ
 
 ### Which version of sewing-kit can I use?

data/lib/sewing_kit/configuration.rb

@@ -3,12 +3,21 @@ module SewingKit
   class Configuration
     attr_accessor :build_options, :dev_server_sewing_kit_bin, :manifest_name,
       :manifest_path
+    attr_reader :test_manifest_mode
+
+    def test_manifest_mode=(mode)
+      valid_modes = [:return_no_assets, :use_precompiled_assets]
+      raise "Unknown mode '#{mode}' (valid modes are: #{valid_modes})" unless valid_modes.include?(mode)
+
+      @test_manifest_mode = mode
+    end
 
     def initialize
       @build_options = nil
       @manifest_name = 'sewing-kit-manifest.json'
       @manifest_path = nil
       @dev_server_sewing_kit_bin = 'node_modules/.bin/sewing-kit'
+      self.test_manifest_mode = :return_no_assets
     end
   end
 

data/lib/sewing_kit/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module SewingKit
-  VERSION = "0.93.0"
+  VERSION = "0.94.0"
 end

data/lib/sewing_kit/webpack/manifest.rb

@@ -54,13 +54,30 @@ module SewingKit
         end
 
         def instance
-          mode = ENV['NODE_ENV'] || Rails.env.to_s
-          @instance ||= if mode == 'development' && ENV['SK_SIMULATE_PRODUCTION'] != '1'
+          return Production.new if simulate_production?
+
+          @instance ||= if mode == 'development'
             Development.new
+          elsif skip_assets?
+            TestWithNoAssets.new
           else
             Production.new
           end
         end
+
+        private
+
+        def mode
+          ENV['NODE_ENV'] || Rails.env.to_s
+        end
+
+        def skip_assets?
+          mode == 'test' && SewingKit.configuration.test_manifest_mode == :return_no_assets
+        end
+
+        def simulate_production?
+          ENV['SK_SIMULATE_PRODUCTION'] == '1' || ENV['SK_SIMULATE_PRODUCTION'] == 'true'
+        end
       end
     end
   end
@@ -68,3 +85,4 @@ end
 
 require 'sewing_kit/webpack/manifest/development'
 require 'sewing_kit/webpack/manifest/production'
+require 'sewing_kit/webpack/manifest/test_with_no_assets'

data/lib/sewing_kit/webpack/manifest/test_with_no_assets.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'sewing_kit/webpack/manifest/base'
+
+module SewingKit
+  module Webpack
+    class Manifest
+      class TestWithNoAssets < Base
+        def asset_bundle_name(_user_agent)
+          'test'
+        end
+
+        def asset_dependencies(_entrypoint_name, _user_agent)
+          []
+        end
+
+        def manifest
+          raise OnlyUseInProductionError
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sewing_kit
 version: !ruby/object:Gem::Version
-  version: 0.93.0
+  version: 0.94.0
 platform: ruby
 authors:
 - Chris Sauve
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2019-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -114,6 +114,7 @@ files:
 - lib/sewing_kit/webpack/manifest/base.rb
 - lib/sewing_kit/webpack/manifest/development.rb
 - lib/sewing_kit/webpack/manifest/production.rb
+- lib/sewing_kit/webpack/manifest/test_with_no_assets.rb
 - lib/sewing_kit/webpack/webpack.rb
 - lib/tasks/sewing_kit.rake
 homepage: