sewing_kit 0.32.0.pre.beta.pre.4 → 0.91.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '008f81a3e9adde12cbfe60d59ae86b0645bfd3b41547d82cef8f0cae15ab481c'
-  data.tar.gz: e890677d3c76735ce57ce27017288f034e127697033b59649a6e06f89534d9ad
+  metadata.gz: 3f6d423df01ea72b33c61ce184e02adec82b1e10b5e490b0be2b125270357982
+  data.tar.gz: 54493dde6260a14b4a4bd364541c166a4521c588b8a3ae2191cfe60b12e89b63
 SHA512:
-  metadata.gz: 3b1c692d5f1bbdd61cfcd18a523421b3943b482f767bbd29773f9afbc5e787a027dd6a313e21fb861fa2f40258a2ffe39020f5b61b187109156d7de56406c6e4
-  data.tar.gz: b8d2382294d12cedbfb891c266b3e09262b2bb36d8523f5c1bec1e65528ba9b94fa6ef795e347617635c7e76d191d131aa02ca0467efae27ee9b87fafa8b429e
+  metadata.gz: a426f2fdf3447168389f235512c268832e0c841f216cbcb8f5b8e65c8815deb8d696bab5b702d5c35b6cbbcf686fb4a1182694b99660fb0525a81a84dd92611b
+  data.tar.gz: ddaf36cd7851bce4d400e78af172c5f66ecb7404fea9e47c424f405e9feda62f1792b2bc4acba372257dd3300c3b81a7d566a04e6b4101a7003c1c0be5d8c9f2

data/README.md

@@ -1,13 +1,15 @@
-# sewing_kit [![Build status](https://badge.buildkite.com/e7cdc87e61b9fe80e91e8686b6bfba53ca26a36366eb811a50.svg)](https://buildkite.com/shopify/sewing-kit-1)
+# sewing_kit [![Build status](https://badge.buildkite.com/e7cdc87e61b9fe80e91e8686b6bfba53ca26a36366eb811a50.svg)](https://buildkite.com/shopify/sewing-kit-gem-ci)
 
 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](https://github.com/Shopify/sewing-kit#sewing-kit).
+This document focuses on Rails integration. For details of `sewing-kit`'s configuration and usage, see the [sewing-kit documentation](/README.md).
 
 ## Quick Start
+
 Create a Rails project using `dev init` then:
 
 ### Install Sewing Kits
+
 ```sh
 # Add Ruby/Node dependencies
 bundle add sewing_kit
@@ -21,9 +23,11 @@ dev up
 ```
 
 ### Add JavaScript
-sewing_kit looks for JavaScript in `app/ui/index.js`.  The code in `index.js` (and any imported JS/CSS) will be built into a `main` bundle.
+
+sewing_kit looks for JavaScript in `app/ui/index.js`. The code in `index.js` (and any imported JS/CSS) will be built into a `main` bundle.
 
 ### Link to JS/CSS with `erb` Helpers
+
 The `main` bundle is imported into `erb` files using Rails helpers:
 
 ```erb
@@ -34,6 +38,7 @@ The `main` bundle is imported into `erb` files using Rails helpers:
 **Note:** CSS `<link>` tags appear only in production; in development, CSS is embedded within the `main.js` bundle.
 
 ## Minimal Project Layout
+
 ```
 ├── Gemfile (must contain "gem 'sewing_kit")
 ├── package.json (must specify '@shopify/sewing-kit' as a 'devDependency')
@@ -47,7 +52,9 @@ The `main` bundle is imported into `erb` files using Rails helpers:
 ```
 
 ## Rails, Polaris, and React Layout
-A typical Polaris app will use React to render views and components.  The following layout shows best practice locations for:
+
+A typical Polaris app will use React to render views and components. The following layout shows best practice locations for:
+
 - Global SCSS settings
 - App sections (roughly analogous to Rails routes)
 - Components
@@ -82,29 +89,36 @@ A typical Polaris app will use React to render views and components.  The follow
 ```
 
 ## 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.
+
+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/rails_sewing_kit_example/blob/master/app/ui/App.jsx))
-* In an `erb` view, add a placeholder for React content ([example](https://github.com/Shopify/rails_sewing_kit_example/blob/master/app/views/home/index.html.erb#L4))
-* In `index.js`, render a React component into the placeholder element ([example](https://github.com/Shopify/rails_sewing_kit_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/rails_sewing_kit_example/blob/master/app/views/layouts/application.html.erb#L8))
+
+- Create a React app in `app/ui/App.js` ([example](https://github.com/Shopify/rails_sewing_kit_example/blob/master/app/ui/App.jsx))
+- In an `erb` view, add a placeholder for React content ([example](https://github.com/Shopify/rails_sewing_kit_example/blob/master/app/views/home/index.html.erb#L4))
+- In `index.js`, render a React component into the placeholder element ([example](https://github.com/Shopify/rails_sewing_kit_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/rails_sewing_kit_example/blob/master/app/views/layouts/application.html.erb#L8))
 
 ## FAQ
+
 ### 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.
+
+By moving everything into `package.json#dependencies`. This is necessary because Rails 5.2 prunes `devDependencies` during asset compilation.
 
 ### How can I test a production verison of my changes?
-Ideally, by deploying to a `staging` environment.  If that is not possible, a production-like local development experience is available via:
+
+Ideally, by deploying to a `staging` environment. If that is not possible, a production-like local development experience is available via:
+
 ```sh
 NODE_ENV=production bundle exec rake assets:precompile
 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.
+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.

data/lib/sewing_kit/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module SewingKit
-  VERSION = "0.32.0-beta-4"
+  VERSION = "0.91.0"
 end

data/lib/sewing_kit/webpack/helper.rb

@@ -17,7 +17,7 @@ module SewingKit
       def sewing_kit_assets(entrypoint_name, extension: 'js')
         return '' unless entrypoint_name.present?
 
-        assets = SewingKit::Webpack::Manifest.asset_dependencies(entrypoint_name)
+        assets = SewingKit::Webpack::Manifest.asset_dependencies(entrypoint_name, request.user_agent)
 
         raise UnknownAssetError, "#{entrypoint_name} was not found in manifest." if raise_unknown_error? assets
         return [] unless assets && assets[extension]

data/lib/sewing_kit/webpack/manifest.rb

@@ -43,16 +43,10 @@ module SewingKit
         end
       end
 
-      class LegacyManifestError < StandardError
-        def initialize(manifest)
-          super "manifest must contain 'entrypoints' key (found: #{manifest})"
-        end
-      end
-
       class << self
         # :nodoc:
-        def asset_dependencies(entrypoint_name)
-          instance.asset_dependencies(entrypoint_name)
+        def asset_dependencies(entrypoint_name, user_agent)
+          instance.asset_dependencies(entrypoint_name, user_agent)
         end
 
         def clear_cache!

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

@@ -9,22 +9,30 @@ module SewingKit
           @metadata = nil
         end
 
-        # :nodoc:
-        def asset_dependencies(entrypoint_name)
-          current_metadata = metadata
-          if current_metadata.key?('development')
-            current_metadata['development']['hangTight']
-          else
-            current_metadata['entrypoints'][entrypoint_name]
-          end
-        end
-
         def clear_cache!
           @metadata = nil
         end
 
         def manifest
-          metadata['assets']
+          current_metadata = metadata
+
+          if current_metadata.is_a?(Array)
+            all_assets = current_metadata.flat_map do |data|
+              data['assets']['all'].values
+            end
+
+            # sewing-kit asset manifests return a numerically indexed hash, not a true array,
+            # so we need to change it back to a hash for compatibility
+            asset_hash = all_assets.each_with_index
+              .collect { |asset, index| [index, asset] }
+              .to_h
+
+            {
+              "all" => asset_hash,
+            }
+          else
+            current_metadata['assets']
+          end
         end
 
         def self.load_metadata_from_node

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

@@ -10,28 +10,44 @@ module SewingKit
           @metadata_path = nil
         end
 
+        def asset_dependencies(entrypoint_name, _target)
+          current_metadata = metadata
+          if current_metadata.key?('development')
+            current_metadata['development']['hangTight']
+          else
+            current_metadata['entrypoints'][entrypoint_name]
+          end
+        end
+
         def clear_cache!
           super
           @metadata_path = nil
         end
 
+        def manifest
+          raise OnlyUseInProductionError
+        end
+
         def metadata
           load_metadata
         end
 
         def load_metadata
           begin
-            return load_metadata_from_fs(@metadata_path) if @metadata_path
+            if @metadata_path
+              result = load_metadata_from_fs(@metadata_path)
+              return normalize_metadata(result)
+            end
           rescue => e
             Rails.logger.warn "[sewing_kit] could not read manifest from #{@metadata_path}; falling back to node.  #{e}"
             @metadata_path = nil
           end
 
           result = SewingKit::Webpack::Manifest::Base.load_metadata_from_node
-          raise LegacyManifestError, result unless result['entrypoints'] || result['development']
 
-          @metadata_path = result && result['path']
-          result
+          metadata = normalize_metadata(result)
+          @metadata_path = metadata && metadata['path']
+          metadata
         end
 
         def load_metadata_from_fs(path)
@@ -50,10 +66,25 @@ module SewingKit
 
         protected
 
+        def normalize_metadata(maybe_array_metadata)
+          if maybe_array_metadata.is_a?(Array)
+            maybe_array_metadata.last
+          else
+            maybe_array_metadata
+          end
+        end
+
         def mode
           'development'
         end
       end
+
+      class OnlyUseInProductionError < StandardError
+        def initialize
+          super "The SewingKit::Webpack::Manifest#manifest is intended "\
+          "for deploying assets to a CDN. Do not use it in development."
+        end
+      end
     end
   end
 end

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'sewing_kit/webpack/manifest/base'
+require 'browserslist_useragent'
 
 module SewingKit
   module Webpack
@@ -9,14 +10,33 @@ module SewingKit
         @metadata_path = nil
 
         # :nodoc:
-        def asset_dependencies(entrypoint_name)
-          metadata['entrypoints'][entrypoint_name]
+        def asset_dependencies(entrypoint_name, user_agent)
+          metadata_for(user_agent)['entrypoints'][entrypoint_name]
         end
 
         def metadata
-          manifest = SewingKit::CachedProductionManifest
-          raise LegacyManifestError, manifest unless manifest['entrypoints']
-          manifest
+          SewingKit::CachedProductionManifest
+        end
+
+        private
+
+        def metadata_for(user_agent)
+          if metadata.is_a?(Array)
+            find_matching_metadata(metadata, user_agent)
+          else
+            metadata
+          end
+        end
+
+        def find_matching_metadata(consolidated_metadata, user_agent)
+          found = consolidated_metadata.find do |metadata|
+            return nil if metadata["resolvedBrowsers"].nil?
+            matcher = BrowserslistUseragent::Match.new(metadata["resolvedBrowsers"], user_agent)
+
+            matcher.browser? && matcher.version?(allow_higher: true)
+          end
+
+          found || consolidated_metadata.last
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sewing_kit
 version: !ruby/object:Gem::Version
-  version: 0.32.0.pre.beta.pre.4
+  version: 0.91.0
 platform: ruby
 authors:
 - Chris Sauve
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-26 00:00:00.000000000 Z
+date: 2019-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: browserslist_useragent
+  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: rails
   requirement: !ruby/object:Gem::Requirement
@@ -117,9 +131,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6