jetpacker 0.1.0 → 0.2.0

data/package/utils/__tests__/deep_assign.js

@@ -0,0 +1,32 @@
+/* global test expect */
+
+const deepAssign = require('../deep_assign')
+
+describe('deepAssign()', () => {
+  test('deeply assigns nested properties', () => {
+    const object = { foo: { bar: { } } }
+    const path = 'foo.bar'
+    const value = { x: 1, y: 2 }
+    const expectation = { foo: { bar: { x: 1, y: 2 } } }
+    expect(deepAssign(object, path, value)).toEqual(expectation)
+  })
+
+  test('allows assignment of a literal false', () => {
+    const object = { foo: { bar: { } } }
+    const path = 'foo.bar'
+    const value = false
+    const expectation = { foo: { bar: false } }
+    expect(deepAssign(object, path, value)).toEqual(expectation)
+  })
+
+  test('does not allow assignment of other falsy values', () => {
+    const object = { foo: { bar: { } } }
+    const path = 'foo.bar'
+    const values = [undefined, null, 0, '']
+
+    values.forEach(value => {
+      const expectation = new Error(`Value can't be ${value}`)
+      expect(() => deepAssign(object, path, value)).toThrow(expectation)
+    })
+  })
+})

data/package/utils/__tests__/deep_merge.js

@@ -0,0 +1,10 @@
+/* global test expect */
+
+const deepMerge = require('../deep_merge')
+
+test('deep merge objects together', () => {
+  const object1 = { foo: { bar: [1, 2, 3], z: 1 }, x: 0 }
+  const object2 = { foo: { bar: ['x', 'y'] }, x: 1, y: 2 }
+  const expectation = { foo: { bar: [1, 2, 3, 'x', 'y'], z: 1 }, x: 1, y: 2 }
+  expect(deepMerge(object1, object2)).toEqual(expectation)
+})

data/package/utils/__tests__/get_style_rule.js

@@ -0,0 +1,65 @@
+const { chdirTestApp, chdirCwd } = require('../helpers')
+
+chdirTestApp()
+
+const getStyleRule = require('../get_style_rule')
+
+describe('getStyleRule', () => {
+  afterAll(chdirCwd)
+
+  test('excludes modules by default', () => {
+    const cssRule = getStyleRule(/\.(css)$/i)
+    const expectation = {
+      test: /\.(css)$/i,
+      exclude: /\.module\.[a-z]+$/
+    }
+
+    expect(cssRule).toMatchObject(expectation)
+  })
+
+  test('includes modules if set to true', () => {
+    const cssRule = getStyleRule(/\.(scss)$/i, true)
+    const expectation = {
+      test: /\.(scss)$/i,
+      include: /\.module\.[a-z]+$/
+    }
+
+    expect(cssRule).toMatchObject(expectation)
+  })
+
+  test('adds extra preprocessors if supplied', () => {
+    const expectation = [{ foo: 'bar' }]
+    const cssRule = getStyleRule(/\.(css)$/i, true, expectation)
+
+    expect(cssRule.use).toMatchObject(expect.arrayContaining(expectation))
+  })
+
+  test('adds mini-css-extract-plugin when extract_css is true', () => {
+    const MiniCssExtractPlugin = require('mini-css-extract-plugin')
+    const expectation = [MiniCssExtractPlugin.loader]
+
+    require('../../config').extract_css = true
+    const cssRule = getStyleRule(/\.(css)$/i)
+
+    expect(cssRule.use).toMatchObject(expect.arrayContaining(expectation))
+  })
+
+  test('adds style-loader when extract_css is true', () => {
+    const expectation = [{loader: 'style-loader'}]
+
+    require('../../config').extract_css = false
+    const cssRule = getStyleRule(/\.(css)$/i)
+
+    expect(cssRule.use).toMatchObject(expect.objectContaining(expectation))
+  })
+
+  test(`doesn't add mini-css-extract-plugin when extract_css is false`, () => {
+    const MiniCssExtractPlugin = require('mini-css-extract-plugin')
+    const expectation = [MiniCssExtractPlugin.loader]
+
+    require('../../config').extract_css = false
+    const cssRule = getStyleRule(/\.(css)$/i)
+
+    expect(cssRule.use).toMatchObject(expect.not.arrayContaining(expectation))
+  })
+})

data/package/utils/__tests__/objectify.js

@@ -0,0 +1,9 @@
+/* global test expect */
+
+const objectify = require('../objectify')
+
+test('Get object from a string path', () => {
+  const object = { foo: { bar: { x: 1 } } }
+  expect(objectify('foo.bar', object)).toEqual({ x: 1 })
+  expect(objectify('some.bar', object)).toEqual(undefined)
+})

data/package/utils/deep_assign.js

@@ -0,0 +1,22 @@
+const { canMerge, prettyPrint } = require('./helpers')
+const deepMerge = require('./deep_merge')
+
+const deepAssign = (obj, path, value) => {
+  if (!value && value !== false) throw new Error(`Value can't be ${value}`)
+
+  const keys = path.split('.')
+  const key = keys.pop()
+
+  const objRef = keys.reduce((acc, currentValue) => {
+    /* eslint no-param-reassign: 0 */
+    if (!acc[currentValue]) acc[currentValue] = {}
+    return acc[currentValue]
+  }, obj)
+
+  if (!objRef) throw new Error(`Prop not found: ${path} in ${prettyPrint(obj)}`)
+
+  objRef[key] = canMerge(value) ? deepMerge(objRef[key], value) : value
+  return obj
+}
+
+module.exports = deepAssign

data/package/utils/deep_merge.js

@@ -0,0 +1,22 @@
+const {
+  isObject, isArray, isEqual, isEmpty
+} = require('./helpers')
+
+const deepMerge = (target, source) => {
+  if (isEmpty(target)) return source
+  if (isEmpty(source)) return target
+  if (isEqual(target, source)) return source
+  if (isArray(target) && isArray(source)) return [...new Set([...target, ...source])]
+  if (!(isObject(target) && isObject(source))) return source
+
+  return [...Object.keys(target), ...Object.keys(source)].reduce(
+    (result, key) => ({
+
+      ...result,
+      [key]: deepMerge(target[key], source[key])
+    }),
+    {}
+  )
+}
+
+module.exports = deepMerge

data/package/utils/get_style_rule.js

@@ -0,0 +1,45 @@
+const MiniCssExtractPlugin = require('mini-css-extract-plugin')
+const { resolve } = require('path')
+const config = require('../config')
+
+const styleLoader = {
+  loader: 'style-loader'
+}
+
+const getStyleRule = (test, modules = false, preprocessors = []) => {
+  const use = [
+    {
+      loader: 'css-loader',
+      options: {
+        sourceMap: true,
+        importLoaders: 2,
+        modules: modules ? {
+          localIdentName: '[name]__[local]___[hash:base64:5]'
+        } : false
+      }
+    },
+    {
+      loader: 'postcss-loader',
+      options: {
+        config: { path: resolve() },
+        sourceMap: true
+      }
+    },
+    ...preprocessors
+  ]
+
+  const options = modules ? { include: /\.module\.[a-z]+$/ } : { exclude: /\.module\.[a-z]+$/ }
+
+  if (config.extract_css) {
+    use.unshift(MiniCssExtractPlugin.loader)
+  } else {
+    use.unshift(styleLoader)
+  }
+
+  // sideEffects - See https://github.com/webpack/webpack/issues/6571
+  return {
+    test, use, sideEffects: !modules, ...options
+  }
+}
+
+module.exports = getStyleRule

data/package/utils/helpers.js

@@ -0,0 +1,58 @@
+const { stringify } = require('flatted/cjs')
+
+const isObject = (value) => typeof value === 'object'
+  && value !== null
+  && (value.length === undefined || value.length === null)
+
+const isNotObject = (value) => !isObject(value)
+
+const isBoolean = (str) => /^true/.test(str) || /^false/.test(str)
+
+const isEmpty = (value) => value === null || value === undefined
+
+const isString = (key) => key && typeof key === 'string'
+
+const isStrPath = (key) => {
+  if (!isString(key)) throw new Error(`Key ${key} should be string`)
+  return isString(key) && key.includes('.')
+}
+
+const isArray = (value) => Array.isArray(value)
+
+const isEqual = (target, source) => stringify(target) === stringify(source)
+
+const canMerge = (value) => isObject(value) || isArray(value)
+
+const prettyPrint = (obj) => JSON.stringify(obj, null, 2)
+
+const chdirTestApp = () => {
+  try {
+    return process.chdir('test/test_app')
+  } catch (e) {
+    return null
+  }
+}
+
+const chdirCwd = () => process.chdir(process.cwd())
+
+const resetEnv = () => {
+  process.env = {}
+}
+
+const ensureTrailingSlash = (path) => (path.endsWith('/') ? path : `${path}/`)
+
+module.exports = {
+  chdirTestApp,
+  chdirCwd,
+  ensureTrailingSlash,
+  isObject,
+  isNotObject,
+  isBoolean,
+  isArray,
+  isEqual,
+  isEmpty,
+  isStrPath,
+  canMerge,
+  prettyPrint,
+  resetEnv
+}

data/package/utils/objectify.js

@@ -0,0 +1,3 @@
+const objectify = (path, obj) => path.split('.').reduce((prev, curr) => (prev ? prev[curr] : undefined), obj)
+
+module.exports = objectify

data/test/command_test.rb

@@ -0,0 +1,33 @@
+require "test_helper"
+
+class CommandTest < Minitest::Test
+  def test_compile_command_returns_success_status_when_stale
+    Webpacker.compiler.stub :stale?, true do
+      Webpacker.compiler.stub :run_webpack, true do
+        assert_equal true, Webpacker.commands.compile
+      end
+    end
+  end
+
+  def test_compile_command_returns_success_status_when_fresh
+    Webpacker.compiler.stub :stale?, false do
+      Webpacker.compiler.stub :run_webpack, true do
+        assert_equal true, Webpacker.commands.compile
+      end
+    end
+  end
+
+  def test_compile_command_returns_failure_status_when_stale
+    Webpacker.compiler.stub :stale?, true do
+      Webpacker.compiler.stub :run_webpack, false do
+        assert_equal false, Webpacker.commands.compile
+      end
+    end
+  end
+
+  def test_clean_command_works_with_nested_hashes_and_without_any_compiled_files
+    File.stub :delete, true do
+      assert Webpacker.commands.clean
+    end
+  end
+end

data/test/compiler_test.rb

@@ -0,0 +1,75 @@
+require "test_helper"
+
+class CompilerTest < Minitest::Test
+  def remove_compilation_digest_path
+    Webpacker.compiler.send(:compilation_digest_path).tap do |path|
+      path.delete if path.exist?
+    end
+  end
+
+  def setup
+    remove_compilation_digest_path
+  end
+
+  def teardown
+    remove_compilation_digest_path
+  end
+
+  def test_custom_environment_variables
+    assert_nil Webpacker.compiler.send(:webpack_env)["FOO"]
+    Webpacker.compiler.env["FOO"] = "BAR"
+    assert Webpacker.compiler.send(:webpack_env)["FOO"] == "BAR"
+  ensure
+    Webpacker.compiler.env = {}
+  end
+
+  def test_default_watched_paths
+    assert_equal Webpacker.compiler.send(:default_watched_paths), [
+      "app/assets/**/*{.mjs,.js,.sass,.scss,.css,.module.sass,.module.scss,.module.css,.png,.svg,.gif,.jpeg,.jpg}",
+      "/etc/yarn/**/*{.mjs,.js,.sass,.scss,.css,.module.sass,.module.scss,.module.css,.png,.svg,.gif,.jpeg,.jpg}",
+      "app/javascript/**/*{.mjs,.js,.sass,.scss,.css,.module.sass,.module.scss,.module.css,.png,.svg,.gif,.jpeg,.jpg}",
+      "yarn.lock",
+      "package.json",
+      "config/webpack/**/*"
+    ]
+  end
+
+  def test_freshness
+    assert Webpacker.compiler.stale?
+    assert !Webpacker.compiler.fresh?
+  end
+
+  def test_freshness_on_compile_success
+    status = OpenStruct.new(success?: true)
+
+    assert Webpacker.compiler.stale?
+    Open3.stub :capture3, [:sterr, :stdout, status] do
+      Webpacker.compiler.compile
+      assert Webpacker.compiler.fresh?
+    end
+  end
+
+  def test_freshness_on_compile_fail
+    status = OpenStruct.new(success?: false)
+
+    assert Webpacker.compiler.stale?
+    Open3.stub :capture3, [:sterr, :stdout, status] do
+      Webpacker.compiler.compile
+      assert Webpacker.compiler.fresh?
+    end
+  end
+
+  def test_compilation_digest_path
+    assert_equal Webpacker.compiler.send(:compilation_digest_path).basename.to_s, "last-compilation-digest-#{Webpacker.env}"
+  end
+
+  def test_external_env_variables
+    assert_nil Webpacker.compiler.send(:webpack_env)["WEBPACKER_ASSET_HOST"]
+    assert_nil Webpacker.compiler.send(:webpack_env)["WEBPACKER_RELATIVE_URL_ROOT"]
+
+    ENV["WEBPACKER_ASSET_HOST"] = "foo.bar"
+    ENV["WEBPACKER_RELATIVE_URL_ROOT"] = "/baz"
+    assert_equal Webpacker.compiler.send(:webpack_env)["WEBPACKER_ASSET_HOST"], "foo.bar"
+    assert_equal Webpacker.compiler.send(:webpack_env)["WEBPACKER_RELATIVE_URL_ROOT"], "/baz"
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,108 @@
+require "test_helper"
+
+class ConfigurationTest < Webpacker::Test
+  def setup
+    @config = Webpacker::Configuration.new(
+      root_path: Pathname.new(File.expand_path("test_app", __dir__)),
+      config_path: Pathname.new(File.expand_path("./test_app/config/webpacker.yml", __dir__)),
+      env: "production"
+    )
+  end
+
+  def test_source_path
+    source_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/app/javascript").to_s
+    assert_equal source_path, @config.source_path.to_s
+  end
+
+  def test_source_path_globbed
+    assert_equal @config.source_path_globbed,
+                 "app/javascript/**/*{.mjs,.js,.sass,.scss,.css,.module.sass,.module.scss,.module.css,.png,.svg,.gif,.jpeg,.jpg}"
+  end
+
+  def test_source_entry_path
+    source_entry_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/app/javascript", "packs").to_s
+    assert_equal @config.source_entry_path.to_s, source_entry_path
+  end
+
+  def test_public_root_path
+    public_root_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public").to_s
+    assert_equal @config.public_path.to_s, public_root_path
+  end
+
+  def test_public_output_path
+    public_output_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs").to_s
+    assert_equal @config.public_output_path.to_s, public_output_path
+
+    @config = Webpacker::Configuration.new(
+      root_path: @config.root_path,
+      config_path: Pathname.new(File.expand_path("./test_app/config/webpacker_public_root.yml", __dir__)),
+      env: "production"
+    )
+
+    public_output_path = File.expand_path File.join(File.dirname(__FILE__), "public/packs").to_s
+    assert_equal @config.public_output_path.to_s, public_output_path
+  end
+
+  def test_public_manifest_path
+    public_manifest_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs", "manifest.json").to_s
+    assert_equal @config.public_manifest_path.to_s, public_manifest_path
+  end
+
+  def test_cache_path
+    cache_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/tmp/cache/webpacker").to_s
+    assert_equal @config.cache_path.to_s, cache_path
+  end
+
+  def test_resolved_paths
+    assert_equal @config.resolved_paths, ["app/assets", "/etc/yarn"]
+  end
+
+  def test_resolved_paths_globbed
+    assert_equal @config.resolved_paths_globbed, [
+      "app/assets/**/*{.mjs,.js,.sass,.scss,.css,.module.sass,.module.scss,.module.css,.png,.svg,.gif,.jpeg,.jpg}",
+      "/etc/yarn/**/*{.mjs,.js,.sass,.scss,.css,.module.sass,.module.scss,.module.css,.png,.svg,.gif,.jpeg,.jpg}"
+    ]
+  end
+
+  def test_extensions
+    config_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/config/webpacker.yml").to_s
+    webpacker_yml = YAML.load_file(config_path)
+    assert_equal @config.extensions, webpacker_yml["default"]["extensions"]
+  end
+
+  def test_cache_manifest?
+    assert @config.cache_manifest?
+
+    with_rails_env("development") do
+      refute Webpacker.config.cache_manifest?
+    end
+
+    with_rails_env("test") do
+      refute Webpacker.config.cache_manifest?
+    end
+  end
+
+  def test_compile?
+    refute @config.compile?
+
+    with_rails_env("development") do
+      assert Webpacker.config.compile?
+    end
+
+    with_rails_env("test") do
+      assert Webpacker.config.compile?
+    end
+  end
+
+  def test_extract_css?
+    assert @config.extract_css?
+
+    with_rails_env("development") do
+      refute Webpacker.config.extract_css?
+    end
+
+    with_rails_env("test") do
+      refute Webpacker.config.extract_css?
+    end
+  end
+end