shakapacker 6.0.0.rc.6

data/lib/install/bin/webpacker-dev-server

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+ENV["RAILS_ENV"] ||= "development"
+ENV["NODE_ENV"]  ||= ENV["RAILS_ENV"]
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "bundler/setup"
+
+require "webpacker"
+require "webpacker/dev_server_runner"
+
+APP_ROOT = File.expand_path("..", __dir__)
+Dir.chdir(APP_ROOT) do
+  Webpacker::DevServerRunner.run(ARGV)
+end

data/lib/install/bin/yarn

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+APP_ROOT = File.expand_path("..", __dir__)
+Dir.chdir(APP_ROOT) do
+  yarn = ENV["PATH"].split(File::PATH_SEPARATOR).
+    select { |dir| File.expand_path(dir) != __dir__ }.
+    product(["yarn", "yarnpkg", "yarn.cmd", "yarn.ps1"]).
+    map { |dir, file| File.expand_path(file, dir) }.
+    find { |file| File.executable?(file) }
+
+  if yarn
+    exec yarn, *ARGV
+  else
+    $stderr.puts "Yarn executable was not detected in the system."
+    $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
+    exit 1
+  end
+end

data/lib/install/binstubs.rb

@@ -0,0 +1,4 @@
+say "Copying binstubs"
+directory "#{__dir__}/bin", "bin"
+
+chmod "bin", 0755 & ~File.umask, verbose: false

data/lib/install/config/webpack/webpack.config.js

@@ -0,0 +1,5 @@
+const { webpackConfig } = require('@shakacode/shakapacker')
+
+// See the shakacode/shakapacker README and docs directory for advice on customizing your webpackConfig.
+
+module.exports = webpackConfig

data/lib/install/config/webpacker.yml

@@ -0,0 +1,64 @@
+# Note: You must restart bin/webpacker-dev-server for changes to take effect
+
+default: &default
+  source_path: app/javascript
+  source_entry_path: /
+  public_root_path: public
+  public_output_path: packs
+  cache_path: tmp/webpacker
+  webpack_compile_output: true
+
+  # Additional paths webpack should look up modules
+  # ['app/assets', 'engine/foo/app/assets']
+  additional_paths: []
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+development:
+  <<: *default
+  compile: true
+
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    port: 3035
+    # Hot Module Replacement updates modules while the application is running without a full reload
+    hmr: false
+    # Defaults to the inverse of hmr. Uncomment to manually set this.
+    # live_reload: true
+    client:
+      # Should we show a full-screen overlay in the browser when there are compiler errors or warnings?
+      overlay: true
+      # May also be a string
+      # webSocketURL:
+      #  hostname: "0.0.0.0"
+      #  pathname: "/ws"
+      #  port: 8080
+    # Should we use gzip compression?
+    compress: true
+    # Note that apps that do not check the host are vulnerable to DNS rebinding attacks
+    allowed_hosts: "all"
+    pretty: true
+    headers:
+      'Access-Control-Allow-Origin': '*'
+    static:
+      watch:
+        ignored: '**/node_modules/**'
+
+test:
+  <<: *default
+  compile: true
+
+  # Compile test packs to a separate directory
+  public_output_path: packs-test
+
+production:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Cache manifest.json for performance
+  cache_manifest: true

data/lib/install/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "app",
+  "private": true,
+  "dependencies": {
+  },
+  "version": "0.1.0",
+  "babel": {
+    "presets": [
+      "./node_modules/@shakacode/shakapacker/package/babel/preset.js"
+    ]
+  },
+  "browserslist": [
+    "defaults"
+  ]
+}

data/lib/install/template.rb

@@ -0,0 +1,100 @@
+# Install Webpacker
+copy_file "#{__dir__}/config/webpacker.yml", "config/webpacker.yml"
+copy_file "#{__dir__}/package.json", "package.json"
+
+say "Copying webpack core config"
+directory "#{__dir__}/config/webpack", "config/webpack"
+
+if Dir.exist?(Webpacker.config.source_path)
+  say "The packs app source directory already exists"
+else
+  say "Creating packs app source directory"
+  empty_directory "app/javascript"
+  copy_file "#{__dir__}/application.js", "app/javascript/application.js"
+end
+
+apply "#{__dir__}/binstubs.rb"
+
+git_ignore_path = Rails.root.join(".gitignore")
+if File.exist?(git_ignore_path)
+  append_to_file git_ignore_path do
+    "\n"                   +
+    "/public/packs\n"      +
+    "/public/packs-test\n" +
+    "/node_modules\n"      +
+    "/yarn-error.log\n"    +
+    "yarn-debug.log*\n"    +
+    ".yarn-integrity\n"
+  end
+end
+
+if (app_layout_path = Rails.root.join("app/views/layouts/application.html.erb")).exist?
+  say "Add JavaScript include tag in application layout"
+  insert_into_file app_layout_path.to_s, %(\n    <%= javascript_pack_tag "application" %>), before: /\s*<\/head>/
+else
+  say "Default application.html.erb is missing!", :red
+  say %(        Add <%= javascript_pack_tag "application" %> within the <head> tag in your custom layout.)
+end
+
+if (setup_path = Rails.root.join("bin/setup")).exist?
+  say "Run bin/yarn during bin/setup"
+  insert_into_file setup_path.to_s, <<-RUBY, after: %(  system("bundle check") || system!("bundle install")\n)
+
+  # Install JavaScript dependencies
+  system! "bin/yarn"
+RUBY
+end
+
+if (asset_config_path = Rails.root.join("config/initializers/assets.rb")).exist?
+  say "Add node_modules to the asset load path"
+  append_to_file asset_config_path, <<-RUBY
+
+# Add node_modules folder to the asset load path.
+Rails.application.config.assets.paths << Rails.root.join("node_modules")
+RUBY
+end
+
+if (csp_config_path = Rails.root.join("config/initializers/content_security_policy.rb")).exist?
+  say "Make note of webpack-dev-server exemption needed to csp"
+  insert_into_file csp_config_path, <<-RUBY, after: %(# Rails.application.config.content_security_policy do |policy|)
+  #   # If you are using webpack-dev-server then specify webpack-dev-server host
+  #   policy.connect_src :self, :https, "http://localhost:3035", "ws://localhost:3035" if Rails.env.development?
+RUBY
+end
+
+results = []
+
+Dir.chdir(Rails.root) do
+  if Webpacker::VERSION.match?(/^[0-9]+\.[0-9]+\.[0-9]+$/)
+    say "Installing @shakacode/shakapacker@#{Webpacker::VERSION}"
+    results << run("yarn add @shakacode/shakapacker@#{Webpacker::VERSION}")
+  else
+    say "Installing @shakacode/shakapacker@next"
+    results << run("yarn add @shakacode/shakapacker@next")
+  end
+
+  package_json = File.read("#{__dir__}/../../package.json")
+  peers = JSON.parse(package_json)["peerDependencies"]
+  peers_to_add = peers.reduce([]) do |result, (package, version)|
+    major_version = version.match(/(\d+)/)[1]
+    result << "#{package}@#{major_version}"
+  end.join(" ")
+
+  say "Adding @shakacode/shakapacker peerDependencies"
+  results << run("yarn add #{peers_to_add}")
+
+  say "Installing webpack-dev-server for live reloading as a development dependency"
+  results << run("yarn add --dev webpack-dev-server")
+end
+
+if Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR > 1
+  say "You need to allow webpack-dev-server host as allowed origin for connect-src.", :yellow
+  say "This can be done in Rails 5.2+ for development environment in the CSP initializer", :yellow
+  say "config/initializers/content_security_policy.rb with a snippet like this:", :yellow
+  say "policy.connect_src :self, :https, \"http://localhost:3035\", \"ws://localhost:3035\" if Rails.env.development?", :yellow
+end
+
+unless results.all?
+  say "Webpacker installation failed 😭 See above for details.", :red
+  exit 1
+end

data/lib/shakapacker/utils/git_utils.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "English"
+module Shakapacker
+  module Utils
+    module GitUtils
+      def self.uncommitted_changes?(message_handler)
+        return false if ENV["COVERAGE"] == "true"
+
+        status = `git status --porcelain`
+        return false if $CHILD_STATUS.success? && status.empty?
+
+        error = if $CHILD_STATUS.success?
+                  "You have uncommitted code. Please commit or stash your changes before continuing"
+                else
+                  "You do not have Git installed. Please install Git, and commit your changes before continuing"
+                end
+        message_handler.add_error(error)
+        true
+      end
+    end
+  end
+end

data/lib/shakapacker/utils/version_syntax_converter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "../../webpacker/version"
+
+module Shakapacker
+  module Utils
+    class VersionSyntaxConverter
+      def rubygem_to_npm(rubygem_version = Webpacker::VERSION)
+        regex_match = rubygem_version.match(/(\d+\.\d+\.\d+)[.\-]?(.+)?/)
+        return "#{regex_match[1]}-#{regex_match[2]}" if regex_match[2]
+
+        regex_match[1].to_s
+      end
+
+      def npm_to_rubygem(npm_version)
+        match = npm_version
+                  .tr("-", ".")
+                  .strip
+                  .match(/(\d.*)/)
+        match.present? ? match[0] : nil
+      end
+    end
+  end
+end

data/lib/tasks/webpacker/binstubs.rake

@@ -0,0 +1,15 @@
+binstubs_template_path = File.expand_path("../../install/binstubs.rb", __dir__).freeze
+bin_path = ENV["BUNDLE_BIN"] || Rails.root.join("bin")
+
+namespace :webpacker do
+  desc "Installs Webpacker binstubs in this application"
+  task binstubs: [:check_node, :check_yarn] do |task|
+    prefix = task.name.split(/#|webpacker:binstubs/).first
+
+    if Rails::VERSION::MAJOR >= 5
+      exec "#{RbConfig.ruby} #{bin_path}/rails #{prefix}app:template LOCATION='#{binstubs_template_path}'"
+    else
+      exec "#{RbConfig.ruby} #{bin_path}/rake #{prefix}rails:template LOCATION='#{binstubs_template_path}'"
+    end
+  end
+end

data/lib/tasks/webpacker/check_binstubs.rake

@@ -0,0 +1,12 @@
+namespace :webpacker do
+  desc "Verifies that bin/webpacker is present"
+  task :check_binstubs do
+    unless File.exist?(Rails.root.join("bin/webpacker"))
+      $stderr.puts "webpacker binstub not found.\n"\
+           "Have you run rails webpacker:install ?\n"\
+           "Make sure the bin directory and bin/webpacker are not included in .gitignore\n"\
+           "Exiting!"
+      exit!
+    end
+  end
+end

data/lib/tasks/webpacker/check_node.rake

@@ -0,0 +1,31 @@
+require "semantic_range"
+namespace :webpacker do
+  desc "Verifies if Node.js is installed"
+  task :check_node do
+    begin
+      node_version = `node -v || nodejs -v`.strip
+      raise Errno::ENOENT if node_version.blank?
+
+      pkg_path = Pathname.new("#{__dir__}/../../../package.json").realpath
+      node_range = JSON.parse(pkg_path.read)["engines"]["node"]
+      is_valid = SemanticRange.satisfies?(node_version, node_range) rescue false
+      semver_major = node_version[/\d+/] rescue nil
+      is_unstable = semver_major.to_i.odd? rescue false
+
+      if is_unstable
+        $stderr.puts "Warning: you are using an unstable release of Node.js (#{node_version}). If you encounter issues with Node.js, consider switching to an Active LTS release. More info: https://docs.npmjs.com/try-the-latest-stable-version-of-node"
+      end
+
+      unless is_valid
+        $stderr.puts "Webpacker requires Node.js \"#{node_range}\" and you are using #{node_version}"
+        $stderr.puts "Please upgrade Node.js https://nodejs.org/en/download/"
+        $stderr.puts "Exiting!"
+        exit!
+      end
+    rescue Errno::ENOENT
+      $stderr.puts "Node.js not installed. Please download and install Node.js https://nodejs.org/en/download/"
+      $stderr.puts "Exiting!"
+      exit!
+    end
+  end
+end

data/lib/tasks/webpacker/check_yarn.rake

@@ -0,0 +1,33 @@
+require "semantic_range"
+namespace :webpacker do
+  desc "Verifies if Yarn is installed"
+  task :check_yarn do
+    begin
+      which_command = Gem.win_platform? ? "where" : "which"
+      raise Errno::ENOENT if `#{which_command} yarn`.strip.empty?
+
+      yarn_version = `yarn --version`.strip
+      raise Errno::ENOENT if yarn_version.blank?
+
+      pkg_path = Pathname.new("#{__dir__}/../../../package.json").realpath
+      yarn_range = JSON.parse(pkg_path.read)["engines"]["yarn"]
+      is_valid = SemanticRange.satisfies?(yarn_version, yarn_range) rescue false
+      is_unsupported = SemanticRange.satisfies?(yarn_version, ">=4.0.0") rescue false
+
+      unless is_valid
+        $stderr.puts "Webpacker requires Yarn \"#{yarn_range}\" and you are using #{yarn_version}"
+        if is_unsupported
+          $stderr.puts "This version of Webpacker does not support Yarn #{yarn_version}. Please downgrade to a supported version of Yarn https://yarnpkg.com/lang/en/docs/install/"
+        else
+          $stderr.puts "Please upgrade Yarn https://yarnpkg.com/lang/en/docs/install/"
+        end
+        $stderr.puts "Exiting!"
+        exit!
+      end
+    rescue Errno::ENOENT
+      $stderr.puts "Yarn not installed. Please download and install Yarn from https://yarnpkg.com/lang/en/docs/install/"
+      $stderr.puts "Exiting!"
+      exit!
+    end
+  end
+end

data/lib/tasks/webpacker/clean.rake

@@ -0,0 +1,25 @@
+$stdout.sync = true
+
+require "webpacker/configuration"
+
+namespace :webpacker do
+  desc "Remove old compiled webpacks"
+  task :clean, [:keep, :age] => ["webpacker:verify_install", :environment] do |_, args|
+    Webpacker.ensure_log_goes_to_stdout do
+      Webpacker.clean(Integer(args.keep || 2), Integer(args.age || 3600))
+    end
+  end
+end
+
+skip_webpacker_clean = %w(no false n f).include?(ENV["WEBPACKER_PRECOMPILE"])
+
+unless skip_webpacker_clean
+  # Run clean if the assets:clean is run
+  if Rake::Task.task_defined?("assets:clean")
+    Rake::Task["assets:clean"].enhance do
+      Rake::Task["webpacker:clean"].invoke
+    end
+  else
+    Rake::Task.define_task("assets:clean" => "webpacker:clean")
+  end
+end

data/lib/tasks/webpacker/clobber.rake

@@ -0,0 +1,20 @@
+require "webpacker/configuration"
+
+namespace :webpacker do
+  desc "Remove the webpack compiled output directory"
+  task clobber: ["webpacker:verify_config", :environment] do
+    Webpacker.clobber
+    $stdout.puts "Removed webpack output path directory #{Webpacker.config.public_output_path}"
+  end
+end
+
+skip_webpacker_clobber = %w(no false n f).include?(ENV["WEBPACKER_PRECOMPILE"])
+
+unless skip_webpacker_clobber
+  # Run clobber if the assets:clobber is run
+  if Rake::Task.task_defined?("assets:clobber")
+    Rake::Task["assets:clobber"].enhance do
+      Rake::Task["webpacker:clobber"].invoke
+    end
+  end
+end

data/lib/tasks/webpacker/compile.rake

@@ -0,0 +1,45 @@
+$stdout.sync = true
+
+def yarn_install_available?
+  rails_major = Rails::VERSION::MAJOR
+  rails_minor = Rails::VERSION::MINOR
+
+  rails_major > 5 || (rails_major == 5 && rails_minor >= 1)
+end
+
+def enhance_assets_precompile
+  # yarn:install was added in Rails 5.1
+  deps = yarn_install_available? ? [] : ["webpacker:yarn_install"]
+  Rake::Task["assets:precompile"].enhance(deps) do |task|
+    prefix = task.name.split(/#|assets:precompile/).first
+
+    Rake::Task["#{prefix}webpacker:compile"].invoke
+  end
+end
+
+namespace :webpacker do
+  desc "Compile JavaScript packs using webpack for production with digests"
+  task compile: ["webpacker:verify_install", :environment] do
+    Webpacker.with_node_env(ENV.fetch("NODE_ENV", "production")) do
+      Webpacker.ensure_log_goes_to_stdout do
+        if Webpacker.compile
+          # Successful compilation!
+        else
+          # Failed compilation
+          exit!
+        end
+      end
+    end
+  end
+end
+
+# Compile packs after we've compiled all other assets during precompilation
+skip_webpacker_precompile = %w(no false n f).include?(ENV["WEBPACKER_PRECOMPILE"])
+
+unless skip_webpacker_precompile
+  if Rake::Task.task_defined?("assets:precompile")
+    enhance_assets_precompile
+  else
+    Rake::Task.define_task("assets:precompile" => ["webpacker:yarn_install", "webpacker:compile"])
+  end
+end

data/lib/tasks/webpacker/info.rake

@@ -0,0 +1,21 @@
+require "webpacker/version"
+
+namespace :webpacker do
+  desc "Provide information on Webpacker's environment"
+  task :info do
+    Dir.chdir(Rails.root) do
+      $stdout.puts "Ruby: #{`ruby --version`}"
+      $stdout.puts "Rails: #{Rails.version}"
+      $stdout.puts "Webpacker: #{Webpacker::VERSION}"
+      $stdout.puts "Node: #{`node --version`}"
+      $stdout.puts "Yarn: #{`yarn --version`}"
+
+      $stdout.puts "\n"
+      $stdout.puts "@shakacode/shakapacker: \n#{`npm list @shakacode/shakapacker version`}"
+
+      $stdout.puts "Is bin/webpacker present?: #{File.exist? 'bin/webpacker'}"
+      $stdout.puts "Is bin/webpacker-dev-server present?: #{File.exist? 'bin/webpacker-dev-server'}"
+      $stdout.puts "Is bin/yarn present?: #{File.exist? 'bin/yarn'}"
+    end
+  end
+end

data/lib/tasks/webpacker/install.rake

@@ -0,0 +1,17 @@
+install_template_path = File.expand_path("../../install/template.rb", __dir__).freeze
+bin_path = ENV["BUNDLE_BIN"] || Rails.root.join("bin")
+
+namespace :webpacker do
+  desc "Install Webpacker in this application"
+  task install: [:check_node, :check_yarn] do |task|
+    Webpacker::Configuration.installing = true
+
+    prefix = task.name.split(/#|webpacker:install/).first
+
+    if Rails::VERSION::MAJOR >= 5
+      exec "#{RbConfig.ruby} #{bin_path}/rails #{prefix}app:template LOCATION='#{install_template_path}'"
+    else
+      exec "#{RbConfig.ruby} #{bin_path}/rake #{prefix}rails:template LOCATION='#{install_template_path}'"
+    end
+  end
+end

data/lib/tasks/webpacker/verify_config.rake

@@ -0,0 +1,14 @@
+require "webpacker/configuration"
+
+namespace :webpacker do
+  desc "Verifies if the Webpacker config is present"
+  task :verify_config do
+    unless Webpacker.config.config_path.exist?
+      path = Webpacker.config.config_path.relative_path_from(Pathname.new(pwd)).to_s
+      $stderr.puts "Configuration #{path} file not found. \n"\
+           "Make sure webpacker:install is run successfully before " \
+           "running dependent tasks"
+      exit!
+    end
+  end
+end

data/lib/tasks/webpacker/verify_install.rake

@@ -0,0 +1,4 @@
+namespace :webpacker do
+  desc "Verifies if Webpacker is installed"
+  task verify_install: [:verify_config, :check_node, :check_yarn, :check_binstubs]
+end

data/lib/tasks/webpacker/yarn_install.rake

@@ -0,0 +1,18 @@
+namespace :webpacker do
+  desc "Support for older Rails versions. Install all JavaScript dependencies as specified via Yarn"
+  task :yarn_install do
+    valid_node_envs = %w[test development production]
+    node_env = ENV.fetch("NODE_ENV") do
+      valid_node_envs.include?(Rails.env) ? Rails.env : "production"
+    end
+    Dir.chdir(Rails.root) do
+      yarn_flags =
+        if `yarn --version`.start_with?("1")
+          "--no-progress --frozen-lockfile"
+        else
+          "--immutable"
+        end
+      system({ "NODE_ENV" => node_env }, "yarn install #{yarn_flags}")
+    end
+  end
+end

data/lib/tasks/webpacker.rake

@@ -0,0 +1,19 @@
+tasks = {
+  "webpacker:info"                    => "Provides information on Webpacker's environment",
+  "webpacker:install"                 => "Installs and setup webpack with Yarn",
+  "webpacker:compile"                 => "Compiles webpack bundles based on environment",
+  "webpacker:clean"                   => "Remove old compiled webpacks",
+  "webpacker:clobber"                 => "Removes the webpack compiled output directory",
+  "webpacker:check_node"              => "Verifies if Node.js is installed",
+  "webpacker:check_yarn"              => "Verifies if Yarn is installed",
+  "webpacker:check_binstubs"          => "Verifies that bin/webpacker is present",
+  "webpacker:binstubs"                => "Installs Webpacker binstubs in this application",
+  "webpacker:verify_install"          => "Verifies if Webpacker is installed",
+  "webpacker:yarn_install"            => "Support for older Rails versions. Install all JavaScript dependencies as specified via Yarn"
+}.freeze
+
+desc "Lists all available tasks in Webpacker"
+task :webpacker do
+  puts "Available Webpacker tasks are:"
+  tasks.each { |task, message| puts task.ljust(30) + message }
+end

data/lib/tasks/yarn.rake

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Duplicate of the yarn tasks still present in Rails until Webpacker <5 have been deprecated
+
+namespace :yarn do
+  desc "Install all JavaScript dependencies as specified via Yarn"
+  task :install do
+    begin
+      # Install only production deps when for not usual envs.
+      valid_node_envs = %w[test development production]
+      node_env = ENV.fetch("NODE_ENV") do
+        valid_node_envs.include?(Rails.env) ? Rails.env : "production"
+      end
+
+      yarn_flags =
+        if `#{RbConfig.ruby} "#{Rails.root}/bin/yarn" --version`.start_with?("1")
+          "--no-progress --frozen-lockfile"
+        else
+          "--immutable"
+        end
+
+      system(
+        { "NODE_ENV" => node_env },
+        "#{RbConfig.ruby} \"#{Rails.root}/bin/yarn\" install #{yarn_flags}",
+        exception: true
+      )
+    rescue Errno::ENOENT
+      $stderr.puts "bin/yarn was not found."
+      $stderr.puts "Please run `bundle exec rails app:update:bin` to create it."
+      exit 1
+    end
+  end
+end
+
+# Run Yarn prior to Sprockets assets precompilation, so dependencies are available for use.
+if Rake::Task.task_defined?("assets:precompile") && File.exist?(Rails.root.join("bin", "yarn"))
+  Rake::Task["assets:precompile"].enhance [ "yarn:install" ]
+end