move integrety check config to yaml (#1669)

Author: lsylvester

README.md

@@ -278,16 +278,20 @@ yarn add @rails/[email protected]
 
 By default, in development, webpacker runs a yarn integrity check to ensure that all local JavaScript packages are up-to-date. This is similar to what bundler does currently in Rails, but for JavaScript packages. If your system is out of date, then Rails will not initialize. You will be asked to upgrade your local JavaScript packages by running `yarn install`.
 
-To turn off this option, you will need to override the default by adding a new config option to your Rails development environment configuration file (`config/environment/development.rb`):
+To turn off this option, you will need to change the default setting in `config/webpacker.yml`:
 
-```
-config.webpacker.check_yarn_integrity = false
+```yaml
+# config/webpacker.yml
+development:
+  ...
+  # Verifies that versions and hashed value of the package contents in the project's package.json
+  check_yarn_integrity: false
 ```
 
-You may also turn on this feature by adding the config option to any Rails environment configuration file:
+You may also turn on this feature by adding the config option for any Rails environment in `config/webpacker.yml`:
 
-```
-config.webpacker.check_yarn_integrity = true
+```yaml
+  check_yarn_integrity: true
 ```
 
 ## Integrations

lib/install/config/webpacker.yml

@@ -5,6 +5,7 @@ default: &default
   source_entry_path: packs
   public_output_path: packs
   cache_path: tmp/cache/webpacker
+  check_yarn_integrity: false
 
   # Additional paths webpack should lookup modules
   # ['app/assets', 'engine/foo/app/assets']
@@ -31,6 +32,9 @@ development:
   <<: *default
   compile: true
 
+  # Verifies that versions and hashed value of the package contents in the project's package.json
+  check_yarn_integrity: true
+
   # Reference: https://webpack.js.org/configuration/dev-server/
   dev_server:
     https: false

lib/install/template.rb

@@ -22,21 +22,6 @@
 
 apply "#{__dir__}/binstubs.rb"
 
-say "Adding configurations"
-
-check_yarn_integrity_config = ->(value) { <<CONFIG.indent(2) }
-# Verifies that versions and hashed value of the package contents in the project's package.json
-config.webpacker.check_yarn_integrity = #{value}
-CONFIG
-
-if Rails::VERSION::MAJOR >= 5
-  environment check_yarn_integrity_config.call("true"), env: :development
-  environment check_yarn_integrity_config.call("false"), env: :production
-else
-  inject_into_file "config/environments/development.rb", "\n#{check_yarn_integrity_config.call("true")}", after: "Rails.application.configure do", verbose: false
-  inject_into_file "config/environments/production.rb", "\n#{check_yarn_integrity_config.call("false")}", after: "Rails.application.configure do", verbose: false
-end
-
 if File.exists?(".gitignore")
   append_to_file ".gitignore", <<-EOS
 /public/packs

lib/webpacker/commands.rb

@@ -11,7 +11,6 @@ def clobber
   end
 
   def bootstrap
-    config.refresh
     manifest.refresh
   end
 

lib/webpacker/configuration.rb

@@ -11,10 +11,6 @@ def initialize(root_path:, config_path:, env:)
     @env = env
   end
 
-  def refresh
-    @data = load
-  end
-
   def dev_server
     fetch(:dev_server)
   end
@@ -63,6 +59,14 @@ def extensions
     fetch(:extensions)
   end
 
+  def check_yarn_integrity=(value)
+    data[:check_yarn_integrity] = value
+  end
+
+  def check_yarn_integrity?
+    fetch(:check_yarn_integrity)
+  end
+
   private
     def fetch(key)
       data.fetch(key, defaults[key])

lib/webpacker/railtie.rb

@@ -6,7 +6,12 @@
 class Webpacker::Engine < ::Rails::Engine
   # Allows Webpacker config values to be set via Rails env config files
   config.webpacker = ActiveSupport::OrderedOptions.new
-  config.webpacker.check_yarn_integrity = false
+
+  initializer "webpacker.set_configs" do |app|
+    if app.config.webpacker.key?(:check_yarn_integrity)
+      Webpacker.config.check_yarn_integrity = app.config.webpacker.check_yarn_integrity
+    end
+  end
 
   # ================================
   # Check Yarn Integrity Initializer
@@ -24,7 +29,7 @@ class Webpacker::Engine < ::Rails::Engine
   #     - edit config/environments/production.rb
   #     - add `config.webpacker.check_yarn_integrity = true`
   initializer "webpacker.yarn_check" do |app|
-    if File.exist?("yarn.lock") && app.config.webpacker.check_yarn_integrity
+    if File.exist?("yarn.lock") && Webpacker.config.check_yarn_integrity?
       output = `yarn check --integrity 2>&1`
 
       unless $?.success?
@@ -34,8 +39,8 @@ class Webpacker::Engine < ::Rails::Engine
         $stderr.puts "  Please run `yarn install` to update."
         $stderr.puts "========================================"
         $stderr.puts "\n\n"
-        $stderr.puts "To disable this check, please add `config.webpacker.check_yarn_integrity = false`"
-        $stderr.puts "to your Rails development config file (config/environments/development.rb)."
+        $stderr.puts "To disable this check, please change `check_yarn_integrity`"
+        $stderr.puts "to `false` in your webpacker config file (config/webpacker.yml)."
         $stderr.puts "\n\n"
         $stderr.puts output
         $stderr.puts "\n\n"
@@ -77,7 +82,10 @@ class Webpacker::Engine < ::Rails::Engine
   initializer "webpacker.bootstrap" do
     if defined?(Rails::Server) || defined?(Rails::Console)
       Webpacker.bootstrap
-      Spring.after_fork { Webpacker.bootstrap } if defined?(Spring)
+      if defined?(Spring)
+        Spring.after_fork { Webpacker.bootstrap }
+        Spring.watch(Webpacker.config.config_path)
+      end
     end
   end
 end

test/compiler_test.rb

@@ -25,7 +25,7 @@ def test_default_watched_paths
     assert_equal Webpacker.compiler.send(:default_watched_paths), [
       "app/assets/**/*",
       "/etc/yarn/**/*",
-      "test/test_app/app/javascript/**/*",
+      "app/javascript/**/*",
       "yarn.lock",
       "package.json",
       "config/webpack/**/*"

test/test_app/config.ru

@@ -0,0 +1,5 @@
+# This file allows the `Rails.root` to be correctly determined.
+
+require_relative "config/environment"
+
+run Rails.application

test/test_helper.rb

@@ -8,9 +8,7 @@
 
 Rails.env = "production"
 
-Webpacker.instance = Webpacker::Instance.new \
-  root_path: Pathname.new(File.expand_path("test_app", __dir__)),
-  config_path: Pathname.new(File.expand_path("./test_app/config/webpacker.yml", __dir__))
+Webpacker.instance = ::Webpacker::Instance.new
 
 class Webpacker::Test < Minitest::Test
   private