shakapacker 7.3.0.beta.1 → 8.0.0.rc.2

data/lib/install/template.rb

@@ -1,12 +1,14 @@
 require "shakapacker/utils/misc"
+require "shakapacker/utils/manager"
 require "shakapacker/utils/version_syntax_converter"
+require "package_json"
 
 # Install Shakapacker
 
 force_option = ENV["FORCE"] ? { force: true } : {}
 
 copy_file "#{__dir__}/config/shakapacker.yml", "config/shakapacker.yml", force_option
-copy_file "#{__dir__}/package.json", "package.json", force_option
+remove_file "#{__dir__}/package.json" if force_option[:force]
 
 say "Copying webpack core config"
 directory "#{__dir__}/config/webpack", "config/webpack", force_option
@@ -43,22 +45,37 @@ else
 end
 
 def package_json
-  if @package_json.nil?
-    Shakapacker::Utils::Misc.require_package_json_gem
+  @package_json ||= PackageJson.new
+end
+
+# setup the package manager with default values
+package_json.merge! do |pj|
+  babel = pj.fetch("babel", {})
+
+  babel["presets"] ||= []
+  babel["presets"].push("./node_modules/shakapacker/package/babel/preset.js")
 
-    @package_json = PackageJson.read
+  package_manager = pj.fetch("packageManager") do
+    "#{Shakapacker::Utils::Manager.guess_binary}@#{Shakapacker::Utils::Manager.guess_version}"
   end
 
-  @package_json
+  {
+    "name" => "app",
+    "private" => true,
+    "version" => "0.1.0",
+    "babel" => babel,
+    "browserslist" => [
+      "defaults"
+    ],
+    "packageManager" => package_manager
+  }.merge(pj)
 end
 
+Shakapacker::Utils::Manager.error_unless_package_manager_is_obvious!
+
 # Ensure there is `system!("bin/yarn")` command in `./bin/setup` file
 if (setup_path = Rails.root.join("bin/setup")).exist?
-  def native_install_command
-    return "bin/yarn" unless Shakapacker::Utils::Misc.use_package_json_gem
-
-    package_json.manager.native_install_command.join(" ")
-  end
+  native_install_command = package_json.manager.native_install_command.join(" ")
 
   say "Run #{native_install_command} during bin/setup"
 
@@ -88,23 +105,14 @@ if (setup_path = Rails.root.join("bin/setup")).exist?
 end
 
 def add_dependencies(dependencies, type)
-  return package_json.manager.add!(dependencies, type: type) if Shakapacker::Utils::Misc.use_package_json_gem
-
-  # TODO: check that run actually errors
-  run("yarn add #{dependencies.join(" ")}") if type == :production
-  run("yarn add --dev #{dependencies.join(" ")}") if type == :dev
+  package_json.manager.add!(dependencies, type: type)
 rescue PackageJson::Error
   say "Shakapacker installation failed 😭 See above for details.", :red
   exit 1
 end
 
 def fetch_peer_dependencies
-  if Shakapacker::Utils::Misc.use_package_json_gem
-    return PackageJson.read("#{__dir__}/../../").fetch("peerDependencies")
-  end
-
-  package_json = File.read("#{__dir__}/../../package.json")
-  JSON.parse(package_json)["peerDependencies"]
+  PackageJson.read("#{__dir__}/../../").fetch("peerDependencies")
 end
 
 Dir.chdir(Rails.root) do
@@ -112,15 +120,13 @@ Dir.chdir(Rails.root) do
   say "Installing shakapacker@#{npm_version}"
   add_dependencies(["shakapacker@#{npm_version}"], :production)
 
-  if Shakapacker::Utils::Misc.use_package_json_gem
-    package_json.merge! do |pj|
-      {
-        "dependencies" => pj["dependencies"].merge({
-          # TODO: workaround for test suite - long-run need to actually account for diff pkg manager behaviour
-          "shakapacker" => pj["dependencies"]["shakapacker"].delete_prefix("^")
-        })
-      }
-    end
+  package_json.merge! do |pj|
+    {
+      "dependencies" => pj["dependencies"].merge({
+        # TODO: workaround for test suite - long-run need to actually account for diff pkg manager behaviour
+        "shakapacker" => pj["dependencies"]["shakapacker"].delete_prefix("^")
+      })
+    }
   end
 
   peers = fetch_peer_dependencies

data/lib/shakapacker/base_strategy.rb

@@ -16,7 +16,8 @@ module Shakapacker
         [
           *config.additional_paths.map { |path| "#{path}{,/**/*}" },
           "#{config.source_path}{,/**/*}",
-          "yarn.lock", "package.json",
+          "package.json", "package-lock.json", "yarn.lock",
+          "pnpm-lock.yaml", "bun.lockb",
           "config/webpack{,/**/*}"
         ].freeze
       end

data/lib/shakapacker/compiler.rb

@@ -72,7 +72,7 @@ class Shakapacker::Compiler
       config.root_path.join("tmp/shakapacker.lock")
     end
 
-    def optionalRubyRunner
+    def optional_ruby_runner
       first_line = File.readlines(bin_shakapacker_path).first.chomp
       /ruby/.match?(first_line) ? RbConfig.ruby : ""
     end
@@ -82,13 +82,13 @@ class Shakapacker::Compiler
 
       stdout, stderr, status = Open3.capture3(
         webpack_env,
-        "#{optionalRubyRunner} '#{bin_shakapacker_path}'",
+        "#{optional_ruby_runner} '#{bin_shakapacker_path}'",
         chdir: File.expand_path(config.root_path)
       )
 
       if status.success?
         logger.info "Compiled all packs in #{config.public_output_path}"
-        logger.error "#{stderr}" unless stderr.empty?
+        logger.warn "#{stderr}" unless stderr.empty?
 
         if config.webpack_compile_output?
           logger.info stdout
@@ -104,28 +104,13 @@ class Shakapacker::Compiler
     def webpack_env
       return env unless defined?(ActionController::Base)
 
-      Shakapacker.set_shakapacker_env_variables_for_backward_compatibility
-
       env.merge(
-        "SHAKAPACKER_ASSET_HOST"        => instance.config.asset_host,
-        "SHAKAPACKER_RELATIVE_URL_ROOT" => instance.config.relative_url_root,
-        "SHAKAPACKER_CONFIG"            => instance.config_path.to_s
+        "SHAKAPACKER_ASSET_HOST" => instance.config.asset_host,
+        "SHAKAPACKER_CONFIG"     => instance.config.config_path.to_s
       )
     end
 
     def bin_shakapacker_path
-      if File.exist?(config.root_path.join("bin/shakapacker"))
-        config.root_path.join("bin/shakapacker")
-      elsif File.exist?(config.root_path.join("bin/webpacker"))
-        Shakapacker.puts_deprecation_message(
-          Shakapacker.short_deprecation_message(
-            "bin/webpacker",
-            "bin/shakapacker"
-          )
-        )
-        config.root_path.join("bin/webpacker")
-      else
-        config.root_path.join("bin/shakapacker")
-      end
+      config.root_path.join("bin/shakapacker")
     end
 end

data/lib/shakapacker/configuration.rb

@@ -12,10 +12,7 @@ class Shakapacker::Configuration
   def initialize(root_path:, config_path:, env:)
     @root_path = root_path
     @env = env
-
-    # For backward compatibility
-    Shakapacker.set_shakapacker_env_variables_for_backward_compatibility
-    @config_path = Pathname.new(ENV["SHAKAPACKER_CONFIG"] || config_path)
+    @config_path = config_path
   end
 
   def dev_server
@@ -43,17 +40,6 @@ class Shakapacker::Configuration
     fetch(:shakapacker_precompile)
   end
 
-  def webpacker_precompile?
-    Shakapacker.puts_deprecation_message(
-      Shakapacker.short_deprecation_message(
-        "webpacker_precompile?",
-        "shakapacker_precompile?"
-      )
-    )
-
-    shakapacker_precompile?
-  end
-
   def source_path
     root_path.join(fetch(:source_path))
   end
@@ -103,17 +89,7 @@ class Shakapacker::Configuration
   end
 
   def fetch(key)
-    return data.fetch(key, defaults[key]) unless key == :webpacker_precompile
-
-    # for backward compatibility
-    Shakapacker.puts_deprecation_message(
-      Shakapacker.short_deprecation_message(
-        "webpacker_precompile",
-        "shakapacker_precompile"
-      )
-    )
-
-    data.fetch(key, defaults[:shakapacker_precompile])
+    data.fetch(key, defaults[key])
   end
 
   def asset_host
@@ -123,19 +99,6 @@ class Shakapacker::Configuration
     )
   end
 
-  def relative_url_root
-    result = ENV.fetch(
-      "SHAKAPACKER_RELATIVE_URL_ROOT",
-      fetch(:relative_url_root) || ActionController::Base.relative_url_root
-    )
-
-    if result
-      Shakapacker.puts_deprecation_message("The usage of relative_url_root is deprecated in Shakapacker and will be removed in v8.")
-    end
-
-    result
-  end
-
   private
     def data
       @data ||= load
@@ -149,13 +112,6 @@ class Shakapacker::Configuration
       end
       symbolized_config = config[env].deep_symbolize_keys
 
-      # For backward compatibility
-      if symbolized_config.key?(:shakapacker_precompile) && !symbolized_config.key?(:webpacker_precompile)
-        symbolized_config[:webpacker_precompile] = symbolized_config[:shakapacker_precompile]
-      elsif !symbolized_config.key?(:shakapacker_precompile) && symbolized_config.key?(:webpacker_precompile)
-        symbolized_config[:shakapacker_precompile] = symbolized_config[:webpacker_precompile]
-      end
-
       return symbolized_config
     rescue Errno::ENOENT => e
       if self.class.installing

data/lib/shakapacker/deprecation_helper.rb

@@ -1,87 +1,9 @@
 require "thor"
 
 module Shakapacker
-  DEPRECATION_GUIDE_URL = "https://github.com/shakacode/shakapacker/blob/master/docs/v7_upgrade.md"
-  DEPRECATION_MESSAGE = <<~MSG
-    DEPRECATION NOTICE:
-
-    Using webpacker spelling is deprecated in Shakapacker.
-    Update your project with the new spelling.
-
-    For more information about this process, check:
-    #{DEPRECATION_GUIDE_URL}
-  MSG
   SHELL = Thor::Shell::Color.new
 
-  def get_config_file_path_with_backward_compatibility(config_path)
-    if config_path.to_s.end_with?("shakapacker.yml") && !File.exist?(config_path)
-      webpacker_config_path = if config_path.class == Pathname
-        Pathname.new(config_path.to_s.gsub("shakapacker.yml", "webpacker.yml"))
-      else
-        config_path.gsub("shakapacker.yml", "webpacker.yml")
-      end
-
-      if File.exist?(webpacker_config_path)
-        puts_deprecation_message(
-          short_deprecation_message(
-            "config/webpacker.yml",
-            "config/shakapacker.yml"
-          )
-        )
-        return webpacker_config_path
-      end
-    end
-
-    config_path
-  end
-
-  def set_shakapacker_env_variables_for_backward_compatibility
-    webpacker_env_variables = ENV.select { |key| key.start_with?("WEBPACKER_") }
-
-    deprecation_message_body = ""
-
-    webpacker_env_variables.each do |webpacker_key, _|
-      shakapacker_key = webpacker_key.gsub("WEBPACKER_", "SHAKAPACKER_")
-      next if ENV.key?(shakapacker_key)
-
-      deprecation_message_body += <<~MSG
-        Use `#{shakapacker_key}` instead of the deprecated `#{webpacker_key}`.
-      MSG
-
-      ENV[shakapacker_key] = ENV[webpacker_key]
-    end
-
-    if deprecation_message_body.present?
-      Shakapacker.puts_deprecation_message(
-        <<~MSG
-          DEPRECATION NOTICE:
-
-          #{deprecation_message_body}
-          Read more: #{Shakapacker::DEPRECATION_GUIDE_URL}
-        MSG
-      )
-    end
-  end
-
-  def short_deprecation_message(old_usage, new_usage)
-    <<~MSG
-      DEPRECATION NOTICE:
-
-      Consider using `#{new_usage}` instead of the deprecated `#{old_usage}`.
-      Read more: #{DEPRECATION_GUIDE_URL}
-    MSG
-  end
-
   def puts_deprecation_message(message)
     SHELL.say "\n#{message}\n", :yellow
   end
-
-  def puts_rake_deprecation_message(webpacker_task_name)
-    Shakapacker.puts_deprecation_message(
-      Shakapacker.short_deprecation_message(
-        "rake #{webpacker_task_name}",
-        "rake #{webpacker_task_name.gsub("webpacker", "shakapacker")}"
-      )
-    )
-  end
 end

data/lib/shakapacker/dev_server.rb

@@ -30,21 +30,6 @@ class Shakapacker::DevServer
     fetch(:port)
   end
 
-  def https?
-    value = fetch(:https)
-
-    unless value.nil?
-      puts "WARNING: `https: true` has been deprecated in favor of `server: 'https'`"
-    end
-
-    case value
-    when true, "true", Hash
-      true
-    else
-      false
-    end
-  end
-
   def server
     server_value = fetch(:server)
     server_type = server_value.is_a?(Hash) ? server_value[:type] : server_value
@@ -65,7 +50,7 @@ class Shakapacker::DevServer
   end
 
   def protocol
-    return "https" if server == "https" || https? == true
+    return "https" if server == "https"
 
     "http"
   end

data/lib/shakapacker/dev_server_runner.rb

@@ -70,16 +70,7 @@ module Shakapacker
 
         cmd = build_cmd
 
-        if @argv.include?("--debug-webpacker")
-          Shakapacker.puts_deprecation_message(
-            Shakapacker.short_deprecation_message(
-              "--debug-webpacker",
-              "--debug-shakapacker"
-            )
-          )
-        end
-
-        if @argv.delete("--debug-shakapacker") || @argv.delete("--debug-webpacker")
+        if @argv.delete("--debug-shakapacker")
           env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --inspect-brk --trace-warnings"
         end
 
@@ -98,17 +89,7 @@ module Shakapacker
       end
 
       def build_cmd
-        if Shakapacker::Utils::Misc.use_package_json_gem
-          return package_json.manager.native_exec_command("webpack", ["serve"])
-        end
-
-        return ["#{@node_modules_bin_path}/webpack", "serve"] if node_modules_bin_exist?
-
-        ["yarn", "webpack", "serve"]
-      end
-
-      def node_modules_bin_exist?
-        File.exist?("#{@node_modules_bin_path}/webpack-dev-server")
+        package_json.manager.native_exec_command("webpack", ["serve"])
       end
   end
 end

data/lib/shakapacker/env.rb

@@ -20,7 +20,7 @@ class Shakapacker::Env
     end
 
     def fallback_env_warning
-      logger.info "RAILS_ENV=#{Rails.env} environment is not defined in config/shakapacker.yml, falling back to #{Shakapacker::DEFAULT_ENV} environment"
+      logger.info "RAILS_ENV=#{Rails.env} environment is not defined in #{config_path}, falling back to #{Shakapacker::DEFAULT_ENV} environment"
     end
 
     def available_environments

data/lib/shakapacker/helper.rb

@@ -98,7 +98,7 @@ module Shakapacker::Helper
   def javascript_pack_tag(*names, defer: true, **options)
     if @javascript_pack_tag_loaded
       raise "To prevent duplicated chunks on the page, you should call javascript_pack_tag only once on the page. " \
-      "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#view-helpers-javascript_pack_tag-and-stylesheet_pack_tag for the usage guide"
+      "Please refer to https://github.com/shakacode/shakapacker/blob/main/README.md#view-helpers-javascript_pack_tag-and-stylesheet_pack_tag for the usage guide"
     end
 
     append_javascript_pack_tag(*names, defer: defer)
@@ -169,7 +169,7 @@ module Shakapacker::Helper
   def append_stylesheet_pack_tag(*names)
     if @stylesheet_pack_tag_loaded
       raise "You can only call append_stylesheet_pack_tag before stylesheet_pack_tag helper. " \
-      "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#view-helper-append_javascript_pack_tag-prepend_javascript_pack_tag-and-append_stylesheet_pack_tag for the usage guide"
+      "Please refer to https://github.com/shakacode/shakapacker/blob/main/README.md#view-helper-append_javascript_pack_tag-prepend_javascript_pack_tag-and-append_stylesheet_pack_tag for the usage guide"
     end
 
     @stylesheet_pack_tag_queue ||= []
@@ -196,7 +196,7 @@ module Shakapacker::Helper
     def update_javascript_pack_tag_queue(defer:)
       if @javascript_pack_tag_loaded
         raise "You can only call #{caller_locations(1..1).first.label} before javascript_pack_tag helper. " \
-        "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#view-helper-append_javascript_pack_tag-prepend_javascript_pack_tag-and-append_stylesheet_pack_tag for the usage guide"
+        "Please refer to https://github.com/shakacode/shakapacker/blob/main/README.md#view-helper-append_javascript_pack_tag-prepend_javascript_pack_tag-and-append_stylesheet_pack_tag for the usage guide"
       end
 
       yield(defer ? :deferred : :non_deferred)

data/lib/shakapacker/instance.rb

@@ -7,9 +7,7 @@ class Shakapacker::Instance
 
   def initialize(root_path: Rails.root, config_path: Rails.root.join("config/shakapacker.yml"))
     @root_path = root_path
-
-    # For backward compatibility
-    @config_path = Shakapacker.get_config_file_path_with_backward_compatibility(config_path)
+    @config_path = Pathname.new(ENV["SHAKAPACKER_CONFIG"] || config_path)
   end
 
   def env

data/lib/shakapacker/manifest.rb

@@ -105,7 +105,7 @@ class Shakapacker::Manifest
     def missing_file_from_manifest_error(bundle_name)
       <<-MSG
 Shakapacker can't find #{bundle_name} in #{config.manifest_path}. Possible causes:
-1. You forgot to install node packages (try `yarn install`) or are running an incompatible version of Node
+1. You forgot to install javascript packages or are running an incompatible javascript runtime version
 2. Your app has code with a non-standard extension (like a `.jsx` file) but the extension is not in the `extensions` config in `config/shakapacker.yml`
 3. You have set compile: false (see `config/shakapacker.yml`) for this environment
    (unless you are using the `bin/shakapacker -w` or the `bin/shakapacker-dev-server`, in which case maybe you aren't running the dev server in the background?)

data/lib/shakapacker/railtie.rb

@@ -3,6 +3,7 @@ require "rails/railtie"
 require "shakapacker/helper"
 require "shakapacker/dev_server_proxy"
 require "shakapacker/version_checker"
+require "shakapacker/utils/manager"
 
 class Shakapacker::Engine < ::Rails::Engine
   # Allows Shakapacker config values to be set via Rails env config files
@@ -14,6 +15,12 @@ class Shakapacker::Engine < ::Rails::Engine
     end
   end
 
+  initializer "shakapacker.manager_checker" do
+    if File.exist?(Shakapacker::VersionChecker::NodePackageVersion.package_json_path)
+      Shakapacker::Utils::Manager.error_unless_package_manager_is_obvious!
+    end
+  end
+
   initializer "shakapacker.proxy" do |app|
     if (Shakapacker.config.dev_server.present? rescue nil)
       app.middleware.insert_before 0,

data/lib/shakapacker/runner.rb

@@ -1,4 +1,6 @@
 require "shakapacker/utils/misc"
+require "shakapacker/utils/manager"
+require "package_json"
 
 module Shakapacker
   class Runner
@@ -13,34 +15,18 @@ module Shakapacker
 
       @app_path              = File.expand_path(".", Dir.pwd)
       @webpack_config        = File.join(@app_path, "config/webpack/webpack.config.js")
-
-      Shakapacker.set_shakapacker_env_variables_for_backward_compatibility
-
-      @node_modules_bin_path = fetch_node_modules_bin_path
       @shakapacker_config    = ENV["SHAKAPACKER_CONFIG"] || File.join(@app_path, "config/shakapacker.yml")
 
-      @shakapacker_config = Shakapacker.get_config_file_path_with_backward_compatibility(@shakapacker_config)
-
       unless File.exist?(@webpack_config)
         $stderr.puts "webpack config #{@webpack_config} not found, please run 'bundle exec rails shakapacker:install' to install Shakapacker with default configs or add the missing config file for your custom environment."
         exit!
       end
-    end
 
-    def fetch_node_modules_bin_path
-      return nil if Shakapacker::Utils::Misc.use_package_json_gem
-
-      ENV["SHAKAPACKER_NODE_MODULES_BIN_PATH"] || `yarn bin`.chomp
+      Shakapacker::Utils::Manager.error_unless_package_manager_is_obvious!
     end
 
     def package_json
-      if @package_json.nil?
-        Shakapacker::Utils::Misc.require_package_json_gem
-
-        @package_json = PackageJson.read(@app_path)
-      end
-
-      @package_json
+      @package_json ||= PackageJson.read(@app_path)
     end
   end
 end

data/lib/shakapacker/utils/manager.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "package_json"
+
+module Shakapacker
+  module Utils
+    class Manager
+      class Error < StandardError; end
+
+      MANAGER_LOCKS = {
+        "bun" => "bun.lockb",
+        "npm" => "package-lock.json",
+        "pnpm" => "pnpm-lock.yaml",
+        "yarn" => "yarn.lock"
+      }
+
+      # Emits a warning if it's not obvious what package manager to use
+      def self.error_unless_package_manager_is_obvious!
+        return unless PackageJson.read.fetch("packageManager", nil).nil?
+
+        guessed_binary = guess_binary
+
+        return if guessed_binary == "npm"
+
+        raise Error, <<~MSG
+          You don't have "packageManager" set in your package.json
+          meaning that Shakapacker will use npm but you've got a #{MANAGER_LOCKS[guessed_binary]}
+          file meaning you probably want to be using #{guessed_binary} instead.
+
+          To make this happen, set "packageManager" in your package.json to #{guessed_binary}@#{guess_version}
+        MSG
+      end
+
+      # Guesses the binary of the package manager to use based on what lockfiles exist
+      #
+      # @return [String]
+      def self.guess_binary
+        MANAGER_LOCKS.find { |_, lock| File.exist?(lock) }&.first || "npm"
+      end
+
+      # Guesses the version of the package manager to use by calling `<manager> --version`
+      #
+      # @return [String]
+      def self.guess_version
+        require "open3"
+
+        command = "#{guess_binary} --version"
+        stdout, stderr, status = Open3.capture3(command)
+
+        unless status.success?
+          raise Error, "#{command} failed with exit code #{status.exitstatus}: #{stderr}"
+        end
+
+        stdout.chomp
+      end
+    end
+  end
+end

data/lib/shakapacker/utils/misc.rb

@@ -8,18 +8,6 @@ module Shakapacker
     class Misc
       extend FileUtils
 
-      def self.use_package_json_gem
-        ENV.fetch("SHAKAPACKER_USE_PACKAGE_JSON_GEM", "false").casecmp("true").zero?
-      end
-
-      def self.require_package_json_gem
-        unless use_package_json_gem
-          raise "PackageJson should not be used unless SHAKAPACKER_USE_PACKAGE_JSON_GEM is true"
-        end
-
-        require "package_json"
-      end
-
       def self.uncommitted_changes?(message_handler)
         return false if ENV["COVERAGE"] == "true"
 

data/lib/shakapacker/version.rb

@@ -1,4 +1,4 @@
 module Shakapacker
   # Change the version in package.json too, please!
-  VERSION = "7.3.0.beta.1".freeze
+  VERSION = "8.0.0.rc.2".freeze
 end