shakapacker 6.5.4 → 7.0.2

data/spec/shakapacker/configuration_spec.rb

@@ -0,0 +1,323 @@
+require_relative "spec_helper_initializer"
+
+describe "Shakapacker::Configuration" do
+  ROOT_PATH = Pathname.new(File.expand_path("./test_app", __dir__))
+
+  context "with standard shakapacker.yml" do
+    let(:config) do
+      Shakapacker::Configuration.new(
+        root_path: ROOT_PATH,
+        config_path: Pathname.new(File.expand_path("./test_app/config/shakapacker.yml", __dir__)),
+        env: "production"
+      )
+    end
+
+    it "#source_path returns correct path" do
+      source_path = File.expand_path File.join(File.dirname(__FILE__), "./test_app/app/javascript").to_s
+      expect(config.source_path.to_s).to eq source_path
+    end
+
+    it "#source_entry_path returns correct path" do
+      source_entry_path = File.expand_path File.join(File.dirname(__FILE__), "./test_app/app/javascript", "entrypoints").to_s
+      expect(config.source_entry_path.to_s).to eq source_entry_path
+    end
+
+    it "#public_root_path returns correct path" do
+      public_root_path = File.expand_path File.join(File.dirname(__FILE__), "./test_app/public").to_s
+      expect(config.public_path.to_s).to eq public_root_path
+    end
+
+    it "#public_output_path returns correct path" do
+      public_output_path = File.expand_path File.join(File.dirname(__FILE__), "./test_app/public/packs").to_s
+      expect(config.public_output_path.to_s).to eq public_output_path
+    end
+
+    it "#public_manifest_path returns correct path" do
+      public_manifest_path = File.expand_path File.join(File.dirname(__FILE__), "./test_app/public/packs", "manifest.json").to_s
+      expect(config.public_manifest_path.to_s).to eq public_manifest_path
+    end
+
+    it "#manifest_path returns correct path" do
+      manifest_path = File.expand_path File.join(File.dirname(__FILE__), "./test_app/public/packs", "manifest.json").to_s
+      expect(config.manifest_path.to_s).to eq manifest_path
+    end
+
+    it "#cache_path returns correct path" do
+      cache_path = File.expand_path File.join(File.dirname(__FILE__), "./test_app/tmp/shakapacker").to_s
+      expect(config.cache_path.to_s).to eq cache_path
+    end
+
+    it "#additional_paths returns correct path" do
+      expect(config.additional_paths).to eq ["app/assets", "/etc/yarn", "some.config.js", "app/elm"]
+    end
+
+    describe "#cache_manifest?" do
+      it "returns true in production environment" do
+        expect(config.cache_manifest?).to be true
+      end
+
+      it "returns false in developemnt environemnt" do
+        with_rails_env("development") do
+          expect(Shakapacker.config.cache_manifest?).to be false
+        end
+      end
+
+      it "returns false in test environment" do
+        with_rails_env("test") do
+          expect(Shakapacker.config.cache_manifest?).to be false
+        end
+      end
+    end
+
+    describe "#compile?" do
+      it "returns false in production environment" do
+        expect(config.compile?).to be false
+      end
+
+      it "returns true in developemnt environemnt" do
+        with_rails_env("development") do
+          expect(Shakapacker.config.compile?).to be true
+        end
+      end
+
+      it "returns true in test environemnt" do
+        with_rails_env("test") do
+          expect(Shakapacker.config.compile?).to be true
+        end
+      end
+    end
+
+    describe "#nested_entries?" do
+      it "returns false in production environment" do
+        expect(config.nested_entries?).to be false
+      end
+
+      it "returns false in development environment" do
+        with_rails_env("development") do
+          expect(Shakapacker.config.nested_entries?).to be false
+        end
+      end
+
+      it "returns false in test environment" do
+        with_rails_env("test") do
+          expect(Shakapacker.config.nested_entries?).to be false
+        end
+      end
+    end
+
+    describe "#ensure_consistent_versioning?" do
+      it "returns false in production environment" do
+        expect(config.ensure_consistent_versioning?).to be false
+      end
+
+      it "returns true in development environment" do
+        with_rails_env("development") do
+          expect(Shakapacker.config.ensure_consistent_versioning?).to be true
+        end
+      end
+
+      it "returns false in test environment" do
+        with_rails_env("test") do
+          expect(Shakapacker.config.ensure_consistent_versioning?).to be false
+        end
+      end
+    end
+
+    describe "#shakapacker_precompile?" do
+      before :each do
+        ENV["SHAKAPACKER_PRECOMPILE"] = nil
+      end
+
+      subject { config.shakapacker_precompile? }
+
+      it "returns true when SHAKAPACKER_PRECOMPILE is unset" do
+        is_expected.to be true
+      end
+
+      it "returns false when SHAKAPACKER_PRECOMPILE sets to no" do
+        ENV["SHAKAPACKER_PRECOMPILE"] = "no"
+        is_expected.to be false
+      end
+
+      it "returns true when SHAKAPACKER_PRECOMPILE sets to yes" do
+        ENV["SHAKAPACKER_PRECOMPILE"] = "yes"
+        is_expected.to be true
+      end
+
+      it "returns false when SHAKAPACKER_PRECOMPILE sets to false" do
+        ENV["SHAKAPACKER_PRECOMPILE"] = "false"
+        is_expected.to be false
+      end
+
+      it "returns true when SHAKAPACKER_PRECOMPILE sets to true" do
+        ENV["SHAKAPACKER_PRECOMPILE"] = "true"
+        is_expected.to be true
+      end
+
+      it "returns false when SHAKAPACKER_PRECOMPILE sets to n" do
+        ENV["SHAKAPACKER_PRECOMPILE"] = "n"
+        is_expected.to be false
+      end
+
+      it "returns true when SHAKAPACKER_PRECOMPILE sets to y" do
+        ENV["SHAKAPACKER_PRECOMPILE"] = "y"
+        is_expected.to be true
+      end
+
+      it "returns false when SHAKAPACKER_PRECOMPILE sets to f" do
+        ENV["SHAKAPACKER_PRECOMPILE"] = "f"
+        is_expected.to be false
+      end
+
+      it "returns true when SHAKAPACKER_PRECOMPILE sets to t" do
+        ENV["SHAKAPACKER_PRECOMPILE"] = "t"
+        is_expected.to be true
+      end
+    end
+  end
+
+  context "with shakapacker config file containing public_output_path entry" do
+    config = Shakapacker::Configuration.new(
+      root_path: ROOT_PATH,
+      config_path: Pathname.new(File.expand_path("./test_app/config/shakapacker_public_root.yml", __dir__)),
+      env: "production"
+    )
+
+    it "#public_output_path returns correct path" do
+      expected_public_output_path = File.expand_path File.join(File.dirname(__FILE__), "./public/packs").to_s
+      expect(config.public_output_path.to_s).to eq expected_public_output_path
+    end
+  end
+
+  context "with shakapacker config file containing manifext_path entry" do
+    config = Shakapacker::Configuration.new(
+      root_path: ROOT_PATH,
+      config_path: Pathname.new(File.expand_path("./test_app/config/shakapacker_manifest_path.yml", __dir__)),
+      env: "production"
+    )
+
+    it "#manifest_path returns correct expected value" do
+      expected_manifest_path = File.expand_path File.join(File.dirname(__FILE__), "./test_app/app/javascript", "manifest.json").to_s
+      expect(config.manifest_path.to_s).to eq expected_manifest_path
+    end
+  end
+
+  context "with shakapacker_precompile entry set to false" do
+    describe "#shakapacker_precompile?" do
+      before :each do
+        ENV["SHAKAPACKER_PRECOMPILE"] = nil
+      end
+
+      let(:config) {
+        Shakapacker::Configuration.new(
+          root_path: ROOT_PATH,
+          config_path: Pathname.new(File.expand_path("./test_app/config/shakapacker_no_precompile.yml", __dir__)),
+          env: "production"
+        )
+      }
+
+      subject { config.shakapacker_precompile? }
+
+      it "returns false with unset SHAKAPACKER_PRECOMPILE" do
+        expect(subject).to be false
+      end
+
+      it "returns true with SHAKAPACKER_PRECOMPILE set to true" do
+        ENV["SHAKAPACKER_PRECOMPILE"] = "true"
+        expect(subject).to be true
+      end
+
+      it "returns false with SHAKAPACKER_PRECOMPILE set to nil" do
+        ENV["SHAKAPACKER_PRECOMPILE"] = nil
+        expect(subject).to be false
+      end
+    end
+  end
+
+  context "with shakapacker config file containing invalid path" do
+    config = Shakapacker::Configuration.new(
+      root_path: ROOT_PATH,
+      config_path: Pathname.new(File.expand_path("./test_app/config/invalid_path.yml", __dir__)),
+      env: "default"
+    )
+
+    it "#shakapacker_precompile? returns false" do
+      expect(config.shakapacker_precompile?).to be false
+    end
+  end
+
+  context "with shakapacker config file with defaults fallback" do
+    let(:config) do
+      Shakapacker::Configuration.new(
+        root_path: ROOT_PATH,
+        config_path: Pathname.new(File.expand_path("./test_app/config/shakapacker_defaults_fallback.yml", __dir__)),
+        env: "default"
+      )
+    end
+
+    it "#cache_manifest? falls back to 'default' config from bundled file" do
+      expect(config.cache_manifest?).to be false
+    end
+
+    it "#shakapacker_precompile? uses 'default' config from custom file" do
+      expect(config.shakapacker_precompile?).to be false
+    end
+  end
+
+  context "falls back to bundled production config for custom environments" do
+    let(:config) do
+      Shakapacker::Configuration.new(
+        root_path: ROOT_PATH,
+        config_path: Pathname.new(File.expand_path("./test_app/config/shakapacker_defaults_fallback.yml", __dir__)),
+        env: "staging"
+      )
+    end
+
+    it "#cache_manifest? fall back to 'production' config from bundled file" do
+      expect(config.cache_manifest?).to be true
+    end
+    it "#shakapacker_precompile? use 'staging' config from custom file" do
+      expect(config.shakapacker_precompile?).to be false
+    end
+  end
+
+  context "#source_entry_path" do
+    let(:config) do
+      Shakapacker::Configuration.new(
+        root_path: ROOT_PATH,
+        config_path: Pathname.new(File.expand_path("./test_app/config/shakapacker.yml", __dir__)),
+        env: "production"
+      )
+    end
+
+    it "returns correct path with source_entry_path starting with 'extra_path'" do
+      allow(config).to receive(:fetch).with(:source_path).and_return("the_source_path")
+      allow(config).to receive(:fetch).with(:source_entry_path).and_return("extra_path")
+
+      actual = config.source_entry_path.to_s
+      expected = "#{config.source_path.to_s}/extra_path"
+
+      expect(actual).to eq(expected)
+    end
+
+    it "returns correct path with source_entry_path starting with /" do
+      allow(config).to receive(:fetch).with(:source_path).and_return("the_source_path")
+      allow(config).to receive(:fetch).with(:source_entry_path).and_return("/")
+
+      actual = config.source_entry_path.to_s
+      expected = config.source_path.to_s
+
+      expect(actual).to eq(expected)
+    end
+
+    it "returns correct path with source_entry_path starting with /extra_path" do
+      allow(config).to receive(:fetch).with(:source_path).and_return("the_source_path")
+      allow(config).to receive(:fetch).with(:source_entry_path).and_return("/extra_path")
+
+      actual = config.source_entry_path.to_s
+      expected = "#{config.source_path.to_s}/extra_path"
+
+      expect(actual).to eq(expected)
+    end
+  end
+end

data/spec/shakapacker/dev_server_runner_spec.rb

@@ -0,0 +1,72 @@
+require_relative "spec_helper_initializer"
+require "shakapacker/dev_server_runner"
+
+describe "DevServerRunner" do
+  before do
+    @original_node_env, ENV["NODE_ENV"] = ENV["NODE_ENV"], "development"
+    @original_rails_env, ENV["RAILS_ENV"] = ENV["RAILS_ENV"], "development"
+    @original_shakapacker_config = ENV["SHAKAPACKER_CONFIG"]
+  end
+
+  after do
+    ENV["NODE_ENV"] = @original_node_env
+    ENV["RAILS_ENV"] = @original_rails_env
+    ENV["SHAKAPACKER_CONFIG"] = @original_shakapacker_config
+  end
+
+  let(:test_app_path) { File.expand_path("./test_app", __dir__) }
+
+  it "run cmd via node modules" do
+    cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
+    verify_command(cmd, use_node_modules: true)
+  end
+  it "run cmd via yarn" do
+    cmd = ["yarn", "webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
+    verify_command(cmd, use_node_modules: false)
+  end
+  it "run cmd argv" do
+    cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js", "--quiet"]
+    verify_command(cmd, argv: (["--quiet"]))
+  end
+  it "run cmd argv with https" do
+    cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js", "--https"]
+
+    dev_server = double()
+    allow(dev_server).to receive(:host).and_return("localhost")
+    allow(dev_server).to receive(:port).and_return("3035")
+    allow(dev_server).to receive(:pretty?).and_return(false)
+    allow(dev_server).to receive(:https?).and_return(true)
+    allow(dev_server).to receive(:hmr?).and_return(false)
+
+    allow(Shakapacker::DevServer).to receive(:new) do
+      verify_command(cmd, argv: (["--https"]))
+    end.and_return(dev_server)
+  end
+  it "accepts environment variables" do
+    cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
+    env = Shakapacker::Compiler.env.dup
+    ENV["SHAKAPACKER_CONFIG"] = env["SHAKAPACKER_CONFIG"] = "#{test_app_path}/config/shakapacker_other_location.yml"
+    env["WEBPACK_SERVE"] = "true"
+    verify_command(cmd, env: env)
+  end
+
+  private
+
+    def verify_command(cmd, use_node_modules: true, argv: [], env: Shakapacker::Compiler.env)
+      cwd = Dir.pwd
+      Dir.chdir(test_app_path)
+      klass = Shakapacker::DevServerRunner
+      instance = klass.new(argv)
+
+      allow(klass).to receive(:new).and_return(instance)
+      allow(instance).to receive(:node_modules_bin_exist?).and_return(use_node_modules)
+      allow(Kernel).to receive(:exec).with(env, *cmd)
+
+      klass.run(argv)
+
+      expect(Kernel).to have_received(:exec).with(env, *cmd)
+
+      ensure
+        Dir.chdir(cwd)
+    end
+end

data/spec/shakapacker/dev_server_spec.rb

@@ -0,0 +1,133 @@
+require_relative "spec_helper_initializer"
+
+describe "DevServer" do
+  it "doesn't run by default" do
+    expect(Shakapacker.dev_server.running?).to be_falsy
+  end
+
+  it "uses localhost as host in development environment" do
+    with_rails_env("development") do
+      expect(Shakapacker.dev_server.host).to eq "localhost"
+    end
+  end
+
+  it "uses port 3035 in development environment" do
+    with_rails_env("development") do
+      expect(Shakapacker.dev_server.port).to eq 3035
+    end
+  end
+
+  it "doesn't use https in development environment" do
+    with_rails_env("development") do
+      expect(Shakapacker.dev_server.https?).to be false
+    end
+  end
+
+  it "uses http protocol in development environment" do
+    with_rails_env("development") do
+      expect(Shakapacker.dev_server.protocol).to eq "http"
+    end
+  end
+
+  it "sets host_with_port to localhost:3035 in development environment" do
+    with_rails_env("development") do
+      expect(Shakapacker.dev_server.host_with_port).to eq "localhost:3035"
+    end
+  end
+
+  it "doesn't use pretty in development environment" do
+    with_rails_env("development") do
+      expect(Shakapacker.dev_server.pretty?).to be false
+    end
+  end
+
+  it "users SHAKAPACKER_DEV_SERVER for DEFAULT_ENV_PREFIX" do
+    expect(Shakapacker::DevServer::DEFAULT_ENV_PREFIX).to eq "SHAKAPACKER_DEV_SERVER"
+  end
+
+  context "#protocol in development environment" do
+    let(:dev_server) { Shakapacker.dev_server }
+
+    it "returns `http` by default (with unset `server` and `https`)" do
+      with_rails_env("development") do
+        expect(dev_server.protocol).to eq "http"
+      end
+    end
+
+    it "returns `https` when `server` is set to `https`" do
+      expect(dev_server).to receive(:server).and_return("https")
+
+      with_rails_env("development") do
+        expect(dev_server.protocol).to eq "https"
+      end
+    end
+
+    it "returns `https` with unset `server` and `https` set to `true`" do
+      expect(dev_server).to receive(:server).and_return("http")
+      expect(dev_server).to receive(:https?).and_return(true)
+
+      with_rails_env("development") do
+        expect(dev_server.protocol).to eq "https"
+      end
+    end
+  end
+
+  context "#server in development environment" do
+    let(:dev_server) { Shakapacker.dev_server }
+
+    it "returns `http` when unset" do
+      expect(dev_server).to receive(:fetch).with(:server).and_return(nil)
+
+      with_rails_env("development") do
+        expect(dev_server.server).to eq "http"
+      end
+    end
+
+    it "returns `http` when set to `https`" do
+      expect(dev_server).to receive(:fetch).with(:server).and_return("http")
+
+      with_rails_env("development") do
+        expect(dev_server.server).to eq "http"
+      end
+    end
+
+    it "returns `http` when set to a hash with `type: http`" do
+      expect(dev_server).to receive(:fetch).with(:server).and_return({
+        type: "http",
+        options: {}
+      })
+
+      with_rails_env("development") do
+        expect(dev_server.server).to eq "http"
+      end
+    end
+
+    it "returns `https` when set to `https`" do
+      expect(dev_server).to receive(:fetch).with(:server).and_return("https")
+
+      with_rails_env("development") do
+        expect(dev_server.server).to eq "https"
+      end
+    end
+
+    it "returns `https` when set to a hash with `type: https`" do
+      expect(dev_server).to receive(:fetch).with(:server).and_return({
+        type: "https",
+        options: {}
+      })
+
+      with_rails_env("development") do
+        expect(dev_server.server).to eq "https"
+      end
+    end
+
+    it "returns `http` when set to any value except `http` and `https`" do
+      expect(dev_server).to receive(:fetch).twice.with(:server).and_return("other-than-https")
+
+      with_rails_env("development") do
+        expect(dev_server.server).to eq "http"
+        expect { dev_server.server }.to output(/WARNING/).to_stdout
+      end
+    end
+  end
+end

data/spec/shakapacker/digest_strategy_spec.rb

@@ -0,0 +1,35 @@
+require_relative "spec_helper_initializer"
+
+describe "DigestStrategy" do
+  def remove_compilation_digest_path
+    @digest_strategy.send(:compilation_digest_path).tap do |path|
+      path.delete if path.exist?
+    end
+  end
+
+  before :all do
+    @digest_strategy = Shakapacker::DigestStrategy.new
+    remove_compilation_digest_path
+  end
+
+  after :all do
+    remove_compilation_digest_path
+  end
+
+  it "is not fresh before compilation" do
+    expect(@digest_strategy.stale?).to be true
+    expect(@digest_strategy.fresh?).to be_falsy
+  end
+
+  it "is fresh after compilation" do
+    @digest_strategy.after_compile_hook
+    expect(@digest_strategy.stale?).to be false
+    expect(@digest_strategy.fresh?).to be true
+  end
+
+  it "generates correct compilation_digest_path" do
+    actual_path = @digest_strategy.send(:compilation_digest_path).basename.to_s
+    expected_path = "last-compilation-digest-#{Shakapacker.env}"
+    expect(actual_path).to eq expected_path
+  end
+end

data/spec/shakapacker/engine_rake_tasks_spec.rb

@@ -0,0 +1,43 @@
+require_relative "spec_helper_initializer"
+
+describe "EngineRakeTasks" do
+  before :context do
+    remove_webpack_binstubs
+  end
+
+  after :context do
+    remove_webpack_binstubs
+  end
+
+  it "mounts app:shakapacker task successfully" do
+    output = Dir.chdir(mounted_app_path) { `rake -T` }
+    expect(output).to include "app:shakapacker"
+  end
+
+  it "binstubs adds only expected files to bin directory" do
+    Dir.chdir(mounted_app_path) { `bundle exec rake app:shakapacker:binstubs` }
+    expected_binstub_paths.each { |path| expect(File.exist?(path)).to be true }
+  end
+
+  private
+    def mounted_app_path
+      File.expand_path("../mounted_app", __dir__)
+    end
+
+    def current_files_in_bin
+      Dir.glob("#{mounted_app_path}/test/dummy/bin/*")
+    end
+
+    def expected_binstub_paths
+      gem_path = File.expand_path("../..", __dir__)
+      Dir.chdir("#{gem_path}/lib/install/bin") do
+        Dir.glob("*").map { |file| "#{mounted_app_path}/test/dummy/bin/#{file}" }
+      end
+    end
+
+    def remove_webpack_binstubs
+      expected_binstub_paths.each do |path|
+        File.delete(path) if File.exist?(path)
+      end
+    end
+end

data/spec/shakapacker/env_spec.rb

@@ -0,0 +1,23 @@
+require_relative "spec_helper_initializer"
+
+RSpec.describe "Env" do
+  it "uses the same env for Rails and Shakapacker" do
+    expect(Shakapacker.env).to eq Rails.env
+  end
+
+  it "uses production env without config" do
+    with_rails_env("foo") do
+      expect(Shakapacker.env).to eq "production"
+    end
+  end
+
+  it "uses the given env in custom config" do
+    with_rails_env("staging") do
+      expect(Shakapacker.env).to eq "staging"
+    end
+  end
+
+  it "uses 'production' as default env" do
+    expect(Shakapacker::DEFAULT_ENV).to eq "production"
+  end
+end