sewing_kit 0.92.1 → 0.93.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5deb1f80675a1e8b869c4e50d3f72d0460b752947192f1bdfef55c0df04aee24
-  data.tar.gz: 5243fe0c88e09e68b40b807c63467024202601ce7d13525bb7f9de74a6106e1f
+  metadata.gz: 2332ea58c71355f50a1c488183042654146d15c5de2a760e878947e0f34f94fd
+  data.tar.gz: 8bab2fe8bac88e5685c6a61f9a7f925a486b0dd6d864e30bb88a71c9c6003e59
 SHA512:
-  metadata.gz: df9ca32fc3d06d06067e9a218636524d20d3c0542eaad6111ffb3db6ddef1d8444692dfde49fe786f2731e609b032b6c0caeacaeb28ae953402483dd30df1674
-  data.tar.gz: 770786a01757467eaa8f74b6921f7145952ad96755a30cb601badb016ba9b14a98e351a6c54581dc6b1df0e42e8eb42b42321af27fddcebbe460e7992eea3c3b
+  metadata.gz: 12a99b5d80d7ad42943dda11faad69f2df93a682c48a36d9e14c9d1ff21ad31409119f210148b7b64c8f8d1e449adde9fce24aa4e2cf70954b777dd7fd876b13
+  data.tar.gz: c347db6c58d7b1152fcfc9e8243694d6597a8161a6b21ffc3806b7ff484d6396847151ec40cbc18ece73daa517aabf125bb6fa756f2886cd1b9ab22552b01cef

data/README.md

@@ -2,7 +2,7 @@
 
 Zero configuration, high performance front end development at organization scale.
 
-This document focuses on Rails integration. For details of `sewing-kit`'s configuration and usage, see the [sewing-kit documentation](/README.md).
+`sewing_kit` facilitates legacy Rails integration using ERB tags. For a more complete modern stack with performance-as-a-feature, consider [quilt_rails](https://github.com/Shopify/quilt/tree/master/gems/quilt_rails). For details of the `sewing-kit` node package's configuration and usage, see the [sewing-kit README](/README.md).
 
 ## Quick Start
 
@@ -68,6 +68,9 @@ A typical Polaris app will use React to render views and components. The followi
         ├── styles (optional)
         │   └── settings.scss (global vars and @polaris overrides)
         │
+        └── tests (optional)
+        │   └── each-test.ts
+        │   └── setup.ts
         └── components (optional)
             ├── App
             │   ├── index.js
@@ -88,17 +91,6 @@ A typical Polaris app will use React to render views and components. The followi
                     └── Home.js
 ```
 
-## Which version of sewing-kit can I use?
-
-Assume that the sewing*kit gem's latest minor version requires \_at least* the same minor version of the sewing-kit package.
-
-If sewing-kit makes a breaking change, this gem's minor version will be bumped to match the required sewing-kit version.
-
-## Transitioning from sprockets-commoner
-
-It is currently not recommended to use `sprockets-commoner` and `sewing_kit` in the same project.
-Minimally, it is required that the project does not have its own `babel-*` libraries that `sewing-kit` currently has as [dependencies](https://github.com/Shopify/sewing-kit/blob/master/package.json#L97~L102).
-
 ## React Boilerplate
 
 - Create a React app in `app/ui/App.js` ([example](https://github.com/Shopify/sewing-kit-gem-example/blob/master/app/ui/App.jsx))
@@ -106,8 +98,95 @@ Minimally, it is required that the project does not have its own `babel-*` libra
 - In `index.js`, render a React component into the placeholder element ([example](https://github.com/Shopify/sewing-kit-gem-example/blob/master/app/ui/index.js))
 - Use `sewing_kit_script_tag`/`sewing_kit_link_tag` helpers to link erb/js ([example](https://github.com/Shopify/sewing-kit-gem-example/blob/master/app/views/layouts/application.html.erb#L8))
 
+## Testing the front end
+
+For fast tests with consistent results, test front-end components using Jest instead of Rails integration tests.
+
+Use [`sewing-kit test`](https://github.com/Shopify/sewing-kit/blob/master/docs/commands/test.md#L3) to run all `.test.tsx` files in the `app/ui` directory. [Jest](https://jestjs.io) is used as a test runner, with customization available via [its sewing-kit plugin](https://github.com/Shopify/sewing-kit/blob/master/docs/plugins/jest.md).
+
+### Testing React
+
+For testing React applications we provide and support [`@shopify/react-testing`](https://github.com/Shopify/quilt/tree/master/packages/react-testing).
+
+#### Example
+
+Given a component `MyComponent.tsx`
+
+```tsx
+// app/components/MyComponent/MyComponent.tsx
+export function MyComponent({name}: {name: string}) {
+  return <div>Hello, {name}!</div>;
+}
+```
+
+A test would be written using Jest and `@shopify/react-testing`'s `mount` feature.
+
+```tsx
+// app/components/MyComponent/tests/MyComponent.test.tsx
+import {MyComponent} from '../MyComponent';
+
+describe('MyComponent', () => {
+  it('greets the given named person', () => {
+    const wrapper = mount(<MyComponent name="Kokusho" />);
+
+    // toContainReactText is a custom matcher provided by @shopify/react-testing/matchers
+    expect(wrapper).toContainReactText('Hello, Kokusho');
+  });
+});
+```
+
+### Test setup files
+
+By default, the jest plugin will look for test setup files under `/app/ui/tests`.
+
+`setup` can be used to add any custom polyfills needed for the testing environment.
+
+```tsx
+// app/ui/tests/setup.ts
+
+import 'isomorphic-fetch';
+import 'raf/polyfill';
+import {URL, URLSearchParams} from 'url';
+
+(global as any).URL = URL;
+(global as any).URLSearchParams = URLSearchParams;
+```
+
+`each-test` can be used for any logic that needs to run for each individual test suite. Any setup logic that needs to happen with `jest` globals in scope, such as importing custom matchers, should also be done here.
+
+```tsx
+// app/ui/tests/each-test.ts
+
+// we cannot import these in `setup` because `expect` will not be defined
+import '@shopify/react-testing/matchers';
+
+beforeAll(() => {
+  console.log('I will run before every test suite');
+});
+
+beforeEach(() => {
+  console.log('I will run before every test case');
+});
+
+afterEach(() => {
+  console.log('I will run after every test case');
+});
+
+afterAll(() => {
+  console.log('I will run after every test suite');
+});
+```
+
+For more complete documentation of the jest plugin see [it's documentation](/docs/plugins/jest.md).
+
 ## FAQ
 
+### Which version of sewing-kit can I use?
+
+Assume that the sewing*kit gem's latest minor version requires \_at least* the same minor version of the sewing-kit package.
+
+If sewing-kit makes a breaking change, this gem's minor version will be bumped to match the required sewing-kit version.
+
 ### How can I fix production builds that are failing due to missing devDependencies?
 
 By moving everything into `package.json#dependencies`. This is necessary because Rails 5.2 prunes `devDependencies` during asset compilation.
@@ -122,3 +201,7 @@ NODE_ENV=production SK_SIMULATE_PRODUCTION=1 dev run
 ```
 
 Note that code changes will not be automatically recompiled in this state. After verifying production behaviour, run `bundle exec rake assets:clobber` to get back to development mode.
+
+### My project is using `sprockets-commenoner`, can I use sewing_kit too?
+
+No. sprockets-commoner uses an outdated Babel version, and is no longer compatible with sewing-kit.

data/lib/sewing_kit/configuration.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 module SewingKit
   class Configuration
-    attr_accessor :build_options, :dev_server_sewing_kit_bin, :manifest_name
+    attr_accessor :build_options, :dev_server_sewing_kit_bin, :manifest_name,
+      :manifest_path
 
     def initialize
       @build_options = nil
       @manifest_name = 'sewing-kit-manifest.json'
+      @manifest_path = nil
       @dev_server_sewing_kit_bin = 'node_modules/.bin/sewing-kit'
     end
   end

data/lib/sewing_kit/railtie.rb

@@ -24,6 +24,10 @@ module SewingKit
         webpack_dev.start
       end
 
+      ActiveSupport.on_load(:action_controller) do
+        include SewingKit::Webpack::Helper
+      end
+
       ActiveSupport.on_load(:action_view) do
         include SewingKit::Webpack::Helper
       end

data/lib/sewing_kit/version.rb

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

data/lib/sewing_kit/webpack/helper.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
 require 'base64'
-require 'action_view/helpers'
 require 'sewing_kit/webpack/manifest'
 
 module SewingKit
   module Webpack
     module Helper
-      include ActionView::Helpers
-
       class UnknownAssetError < StandardError
       end
 
@@ -52,6 +49,10 @@ module SewingKit
         safe_join(tags, "\n")
       end
 
+      def sewing_kit_assets_bundle_name
+        SewingKit::Webpack::Manifest.asset_bundle_name(request.user_agent)
+      end
+
       private
 
       def create_asset_tag(tag_type, asset, tag_options)

data/lib/sewing_kit/webpack/manifest.rb

@@ -36,6 +36,10 @@ module SewingKit
       end
 
       class << self
+        def asset_bundle_name(user_agent)
+          instance.asset_bundle_name(user_agent)
+        end
+
         # :nodoc:
         def asset_dependencies(entrypoint_name, user_agent)
           instance.asset_dependencies(entrypoint_name, user_agent)

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

@@ -10,7 +10,11 @@ module SewingKit
           @metadata_path = nil
         end
 
-        def asset_dependencies(entrypoint_name, _target)
+        def asset_bundle_name(_user_agent)
+          'dev'
+        end
+
+        def asset_dependencies(entrypoint_name, _user_agent)
           current_metadata = metadata
           if current_metadata.key?('development')
             current_metadata['development']['hangTight']

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

@@ -9,6 +9,10 @@ module SewingKit
         @metadata = nil
         @metadata_path = nil
 
+        def asset_bundle_name(user_agent)
+          metadata_for(user_agent)['name']
+        end
+
         # :nodoc:
         def asset_dependencies(entrypoint_name, user_agent)
           metadata_for(user_agent)['entrypoints'][entrypoint_name]
@@ -44,6 +48,8 @@ module SewingKit
         end
 
         def path
+          return SewingKit.configuration.manifest_path unless SewingKit.configuration.manifest_path.nil?
+
           File.join(Rails.root, 'public', 'bundles', SewingKit.configuration.manifest_name)
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sewing_kit
 version: !ruby/object:Gem::Version
-  version: 0.92.1
+  version: 0.93.0
 platform: ruby
 authors:
 - Chris Sauve
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-08 00:00:00.000000000 Z
+date: 2019-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties