webpacker-remote 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7c82d3d11b075effbc9efd05042438065ea37b9a46b2ad16298807fa9085706
+  data.tar.gz: 4e4d31ad15d8f4c9ec935e4dd332a426c7898889575196e42cd8061140799417
+SHA512:
+  metadata.gz: 750042b0c9f5132196ad095c4ae340bedaa3d26973c4efe4e45af67c8203ca03f920e2c8a1b16974a5c314d0e03b48f830503503e806d05736db29ac23ce802c
+  data.tar.gz: ed9d1bb82d933b0d2af2170fc13c517acf996b905fe3a5115d66fcedd37de8a9ac34520efca0bae3e9170fa39c07731d49afdfc772f034875a1a352572860ecf

data/.github/workflows/branch.yml

@@ -0,0 +1,33 @@
+name: branch
+on:
+  push:
+    branches-ignore:
+      - master
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.7' ]
+        webpacker: [ '5.2.1' ]
+    name: Ruby ${{ matrix.ruby }}, Webpacker ${{ matrix.webpacker }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.webpacker }}-${{ hashFiles('**/Gemfile') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.webpacker }}
+      - name: Test
+        env:
+          WEBPACKER_GEM_VERSION: ${{ matrix.webpacker }}
+          CI: true
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+          bundle exec rake ci

data/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: ci
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+  push:
+    branches:
+      - master
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.7' ]
+        webpacker: [ '5.2.1' ]
+    name: Ruby ${{ matrix.ruby }}, Webpacker ${{ matrix.webpacker }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.webpacker }}-${{ hashFiles('**/Gemfile') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.webpacker }}
+      - name: Test
+        env:
+          WEBPACKER_GEM_VERSION: ${{ matrix.webpacker }}
+          CI: true
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+          bundle exec rake ci

data/.gitignore

@@ -0,0 +1,6 @@
+Gemfile.lock
+.rspec_status
+.bundle
+.rspec
+bin
+coverage/

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  NewCops: enable
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'codecov', require: false
+
+gem 'rake', '~> 12.0'
+gem 'rspec-github', '~> 2.3'
+
+gem 'rubocop', '~> 1.0'
+gem 'rubocop-performance', '~> 1.9.2'
+gem 'rubocop-rake', '~> 0.5.1'
+gem 'rubocop-rspec', '~> 2.1.0'
+
+group :development do
+  gem 'benchmark-ips', require: false
+  gem 'pry-byebug', '~> 3.9'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2020 Vlad Bokov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# Webpacker::Remote
+
+![](https://github.com/lunatic-cat/webpacker-remote/workflows/ci/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/webpacker-remote.svg)](https://badge.fury.io/rb/webpacker-remote)
+[![codecov](https://codecov.io/gh/lunatic-cat/webpacker-remote/branch/master/graph/badge.svg?token=X5K67X3V0Z)](undefined)
+
+- support for `create-react-app` developed in a separate repo
+- support for multiple external frontend builds, right now `webpacker` is [a singleton](https://github.com/rails/webpacker/blob/6ba995aed2b609a27e4e35ec28b2a7f688cce0cf/lib/webpacker/helper.rb#L5L7)
+
+## Usage
+
+- build `webpack` bundle & upload `build` directory (incl. `manifest.json`) before deploy
+- in `config/initializers/remote_webpacker.rb`
+
+```rb
+REMOTE_WEBPACKER = Webpacker::Remote.new(uri: 'https://../manifest.json')
+```
+
+- in `app/views/layouts/application.html.erb` (**not** `javascript_pack_tag`)
+
+```rb
+<%= javascript_packs_with_chunks_tag 'main', webpacker: REMOTE_WEBPACKER %>
+```
+
+Of course, you can use as many build as you like and do blue-green deployments using gems like `rollout`
+
+## CRA Requirements
+
+For `create-react-app` you should use `webpack-assets-manifest` instead of built-in `webpack-manifest-plugin`. You have to patch configuration like this:
+
+- in `package.json`
+
+```diff
++    "customize-cra": "^1.0.0",
++    "react-app-rewired": "^2.1.8"
++    "webpack-assets-manifest": "^3.1.1"
+...
+-    "build": "react-scripts build"
++    "build": "react-app-rewired build"
+```
+
+- add `config-overrides.js`
+
+```js
+const { override } = require("customize-cra");
+const WebpackAssetsManifest = require('webpack-assets-manifest')
+
+const whenInMode = (mode, fn) => config => (config.mode == mode) ? fn(config) : config;
+
+const removeWebpackPlugin = pluginName => config => {
+  config.plugins = config.plugins.filter(
+    p => p.constructor.name !== pluginName
+  );
+  return config;
+};
+
+const addWebpackPlugin = plugin => config => {
+  config.plugins.push(plugin);
+  return config;
+};
+
+const webpackerAssetManifestConfig = {
+  integrity: false,
+  entrypoints: true,
+  writeToDisk: true,
+  output: 'manifest.json'
+};
+
+module.exports = override(
+  removeWebpackPlugin('ManifestPlugin'),
+  whenInMode('production', addWebpackPlugin(new WebpackAssetsManifest(webpackerAssetManifestConfig)))
+);
+```
+
+- check `PUBLIC_URL='https://...' npm run build` and `build/manifest.json` should look like this:
+
+```json
+{
+  "entrypoints": {
+    "main": {
+      "js": [
+        "static/js/runtime-main...js",
+        "static/js/2...chunk.js",
+        "static/js/main...chunk.js"
+      ],
+      "js.map": [
+        "static/js/runtime-main...js.map",
+        "static/js/2...chunk.js.map",
+        "static/js/main...chunk.js.map"
+      ],
+      "css": [
+        "static/css/2...chunk.css",
+        "static/css/main...chunk.css"
+      ]
+    }
+  },
+  "main.css": "static/css/main...chunk.css",
+  "main.js": "static/js/main...chunk.js",
+  "main.js.map": "static/js/main...chunk.js.map",
+  "runtime-main.js": "static/js/runtime-main...js",
+  "runtime-main.js.map": "static/js/runtime-main...js.map"
+}
+```

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+RSpec::Core::RakeTask.new(:spec_github) do |t|
+  t.rspec_opts = '--format RSpec::Github::Formatter -f progress'
+end
+
+task ci: %i[rubocop spec_github]
+task default: %i[rubocop spec]

data/lib/webpacker/remote.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'uri'
+require 'net/http'
+require 'webpacker'
+
+class Webpacker::Remote < Webpacker::Instance
+  require 'webpacker/remote/manifest'
+  require 'webpacker/remote/configuration'
+
+  VERSION = '0.1.0'
+
+  class Error < StandardError; end
+
+  attr_reader :public_manifest_content
+
+  # fetch early, fail fast
+  def initialize(uri:, root_path: nil, config_path: nil) # rubocop:disable Lint/UnusedMethodArgument
+    super(root_path: nil, config_path: nil)
+    @public_manifest_content = JSON.parse(self.class.get_http_response(uri))
+    @root_path = @config_path = Pathname.new('/non-existing-path-for-ctor-compatibility')
+  rescue StandardError => e
+    raise Error, "#{e.class}: #{e.message}"
+  end
+
+  def manifest
+    @manifest ||= Webpacker::Remote::Manifest.new(self)
+  end
+
+  def config
+    @config ||= Webpacker::Remote::Configuration.new(
+      root_path: root_path,
+      config_path: config_path,
+      env: env
+    )
+  end
+
+  # right now this only supports builds done ahead of time
+  def env
+    'production'
+  end
+
+  def self.get_http_response(uri)
+    Net::HTTP.get_response(URI.parse(uri)).body
+  end
+end

data/lib/webpacker/remote/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'webpacker/configuration'
+
+class Webpacker::Remote::Configuration < Webpacker::Configuration
+  def load
+    {
+      cache_manifest: true,
+      check_yarn_integrity: false,
+      compile: false
+    }
+  end
+end

data/lib/webpacker/remote/manifest.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'webpacker/manifest'
+
+class Webpacker::Remote::Manifest < Webpacker::Manifest
+  def load
+    @webpacker.public_manifest_content
+  end
+end

data/webpacker-remote.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = 'webpacker-remote'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Vlad Bokov']
+  spec.email         = ['vlad@lunatic.cat']
+  spec.license       = 'MIT'
+
+  spec.summary       = 'Inject external webpack builds into Rails'
+  spec.description   = 'Use your webpack builds independently'
+  spec.homepage      = 'https://github.com/lunatic-cat/webpacker-remote'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/lunatic-cat/webpacker-remote'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('webpacker', ENV.fetch('WEBPACKER_GEM_VERSION', '~> 5.2'))
+
+  spec.add_development_dependency('rspec', '~> 3.0')
+  spec.add_development_dependency('rspec-expectations', '~> 3.0')
+  spec.add_development_dependency('simplecov', '~> 0.19')
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: webpacker-remote
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vlad Bokov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webpacker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+description: Use your webpack builds independently
+email:
+- vlad@lunatic.cat
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/branch.yml"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/webpacker/remote.rb
+- lib/webpacker/remote/configuration.rb
+- lib/webpacker/remote/manifest.rb
+- webpacker-remote.gemspec
+homepage: https://github.com/lunatic-cat/webpacker-remote
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lunatic-cat/webpacker-remote
+  source_code_uri: https://github.com/lunatic-cat/webpacker-remote
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Inject external webpack builds into Rails
+test_files: []