shakapacker 6.5.5 → 6.5.6

data/spec/manifest_spec.rb

@@ -0,0 +1,98 @@
+describe "Webpacker::Manifest" do
+  let(:manifest_path) { File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs", "manifest.json").to_s }
+
+  it "#lookup! throws exception for a non-existing asset file" do
+    asset_file = "calendar.js"
+    expected_error_message = "Shakapacker can't find #{asset_file} in #{manifest_path}"
+
+    allow(Webpacker.config).to receive(:compile?).and_return(false)
+
+    expect {
+      Webpacker.manifest.lookup!(asset_file)
+    }.to raise_error(Webpacker::Manifest::MissingEntryError, /#{expected_error_message}/)
+  end
+
+  it "#lookup! throws exception for a non-existing asset file with type and without extension" do
+    asset_file = "calendar"
+    expected_error_message = "Shakapacker can't find #{asset_file}.js in #{manifest_path}"
+
+    allow(Webpacker.config).to receive(:compile?).and_return(false)
+
+    expect {
+      Webpacker.manifest.lookup!(asset_file, type: :javascript)
+    }.to raise_error(Webpacker::Manifest::MissingEntryError, /#{expected_error_message}/)
+  end
+
+  it "#lookup! returns path to bundled bootstrap.js" do
+    actual = Webpacker.manifest.lookup!("bootstrap.js")
+    expected = "/packs/bootstrap-300631c4f0e0f9c865bc.js"
+
+    expect(actual).to eq expected
+  end
+
+  it "#lookup_pack_with_chunks! returns array of path to bundled bootstrap with type of javascript" do
+    actual = Webpacker.manifest.lookup_pack_with_chunks!("bootstrap", type: :javascript)
+    expected = ["/packs/bootstrap-300631c4f0e0f9c865bc.js"]
+
+    expect(actual).to eq expected
+  end
+
+  it "#lookup_with_chunks! returns array of path to bundled bootstrap.js with type of javascript" do
+    actual = Webpacker.manifest.lookup_pack_with_chunks!("bootstrap.js", type: :javascript)
+    expected = ["/packs/bootstrap-300631c4f0e0f9c865bc.js"]
+
+    expect(actual).to eq expected
+  end
+
+  it "#lookup_with_chunks! returns array of path to bundled 'print/application' without extension and in a sub-directory" do
+    actual = Webpacker.manifest.lookup_pack_with_chunks!("print/application", type: :css)
+    expected = ["/packs/print/application-983b6c164a47f7ed49cd.css"]
+
+    expect(actual).to eq expected
+  end
+
+  it "#lookup_with_chunks! returns array of path to bundled 'print/application.css' in a sub-directory" do
+    actual = Webpacker.manifest.lookup_pack_with_chunks!("print/application.css", type: :css)
+    expected = ["/packs/print/application-983b6c164a47f7ed49cd.css"]
+
+    expect(actual).to eq expected
+  end
+
+  it "#lookup returns nil for non-existing asset file" do
+    expect(Webpacker.manifest.lookup("foo.js")).to be nil
+  end
+
+  it "#lookup_pack_with_chunks returns nil for non-existing asset file" do
+    expect(Webpacker.manifest.lookup_pack_with_chunks("foo.js")).to be nil
+  end
+
+  it "#lookup returns path for bootstrap.js" do
+    actual = Webpacker.manifest.lookup("bootstrap.js")
+    expected = "/packs/bootstrap-300631c4f0e0f9c865bc.js"
+
+    expect(actual).to eq expected
+  end
+
+  it "#lookup_pack_with_chunks! throws exception for a non-existing asset file" do
+    asset_file = "calendar"
+
+    expected_error_message = "Shakapacker can't find #{asset_file}.js in #{manifest_path}"
+
+    allow(Webpacker.config).to receive(:compile?).and_return(false)
+
+    expect {
+      Webpacker.manifest.lookup_pack_with_chunks!(asset_file, type: :javascript)
+    }.to raise_error(Webpacker::Manifest::MissingEntryError, /#{expected_error_message}/)
+  end
+
+  it "#lookup_pack_with_chunks! returns array of paths to bundled js files with 'application' in their name" do
+    actual_application_entrypoints = Webpacker.manifest.lookup_pack_with_chunks!("application", type: :javascript)
+    expected_application_entrypoints = [
+      "/packs/vendors~application~bootstrap-c20632e7baf2c81200d3.chunk.js",
+      "/packs/vendors~application-e55f2aae30c07fb6d82a.chunk.js",
+      "/packs/application-k344a6d59eef8632c9d1.js"
+    ]
+
+    expect(actual_application_entrypoints).to eq expected_application_entrypoints
+  end
+end

data/spec/mtime_strategy_spec.rb

@@ -0,0 +1,53 @@
+describe "Webpacker::MtimeStrategy" do
+  let(:mtime_strategy) { Webpacker::MtimeStrategy.new }
+  let(:manifest_timestamp) { Time.parse("2021-01-01 12:34:56 UTC") }
+
+  describe "#fresh?" do
+    it "returns false when manifest is missing" do
+      latest_timestamp = manifest_timestamp + 3600
+
+      with_stubs(latest_timestamp: latest_timestamp.to_i, manifest_exists: false) do
+        expect(mtime_strategy.fresh?).to be false
+      end
+    end
+
+    it "returns false when manifest is older" do
+      latest_timestamp = manifest_timestamp + 3600
+
+      with_stubs(latest_timestamp: latest_timestamp.to_i) do
+        expect(mtime_strategy.fresh?).to be false
+      end
+    end
+
+    it "returns true when manifest is new" do
+      latest_timestamp = manifest_timestamp - 3600
+
+      with_stubs(latest_timestamp: latest_timestamp.to_i) do
+        expect(mtime_strategy.fresh?).to be true
+      end
+    end
+  end
+
+  describe "#stale?" do
+    it "returns false when #fresh? is true" do
+      expect(mtime_strategy).to receive(:fresh?).and_return(true)
+
+      expect(mtime_strategy.stale?).to be false
+    end
+
+    it "returns true when #fresh? is false" do
+      expect(mtime_strategy).to receive(:fresh?).and_return(false)
+
+      expect(mtime_strategy.stale?).to be true
+    end
+  end
+
+  private
+
+    def with_stubs(latest_timestamp:, manifest_exists: true)
+      allow(mtime_strategy).to receive(:latest_modified_timestamp).and_return(latest_timestamp)
+      allow(FileTest).to receive(:exist?).and_return(manifest_exists)
+      allow(File).to receive(:mtime).and_return(manifest_timestamp)
+      yield
+    end
+end

data/spec/rake_tasks_spec.rb

@@ -0,0 +1,32 @@
+describe "RakeTasks" do
+  let(:test_app_path) { File.expand_path("test_app", __dir__) }
+
+  it "`rake -T` lists webpacker tasks" do
+    output = Dir.chdir(test_app_path) { `rake -T` }
+    expect(output).to include "webpacker"
+    expect(output).to include "webpacker:check_binstubs"
+    expect(output).to include "webpacker:check_node"
+    expect(output).to include "webpacker:check_yarn"
+    expect(output).to include "webpacker:clean"
+    expect(output).to include "webpacker:clobber"
+    expect(output).to include "webpacker:compile"
+    expect(output).to include "webpacker:install"
+    expect(output).to include "webpacker:verify_install"
+  end
+
+  it "`webpacker:check_binstubs` doesn't get 'webpack binstub not found' error" do
+    output = Dir.chdir(test_app_path) { `rake webpacker:check_binstubs 2>&1` }
+    expect(output).to_not include "webpack binstub not found."
+  end
+
+  it "`webpacker:check_node` doesn't get 'Webpacker requires Node.js' error" do
+    output = Dir.chdir(test_app_path) { `rake webpacker:check_node 2>&1` }
+    expect(output).to_not include "Webpacker requires Node.js"
+  end
+
+  it "`webpacker:check_yarn` doesn't get error related to yarn" do
+    output = Dir.chdir(test_app_path) { `rake webpacker:check_yarn 2>&1` }
+    expect(output).to_not include "Yarn not installed"
+    expect(output).to_not include "Webpacker requires Yarn"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,123 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  # https://relishapp.com/rspec/rspec-core/docs/configuration/zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end
+
+require_relative "test_app/config/environment"
+
+Rails.env = "production"
+
+Webpacker.instance = ::Webpacker::Instance.new
+
+def reloaded_config
+  Webpacker.instance.instance_variable_set(:@env, nil)
+  Webpacker.instance.instance_variable_set(:@config, nil)
+  Webpacker.instance.instance_variable_set(:@dev_server, nil)
+  Webpacker.env
+  Webpacker.config
+  Webpacker.dev_server
+end
+
+def with_rails_env(env)
+  original = Rails.env
+  Rails.env = ActiveSupport::StringInquirer.new(env)
+  reloaded_config
+  yield
+ensure
+  Rails.env = ActiveSupport::StringInquirer.new(original)
+  reloaded_config
+end

data/{test → spec}/test_app/public/packs/manifest.json

@@ -2,6 +2,7 @@
   "bootstrap.css": "/packs/bootstrap-c38deda30895059837cf.css",
   "application.css": "/packs/application-dd6b1cd38bfa093df600.css",
   "bootstrap.js": "/packs/bootstrap-300631c4f0e0f9c865bc.js",
+  "main.js": "/packs/main-e323a53c7f30f5d53cbb.js",
   "application.js": "/packs/application-k344a6d59eef8632c9d1.js",
   "application.png": "/packs/application-k344a6d59eef8632c9d1.png",
   "fonts/fa-regular-400.woff2": "/packs/fonts/fa-regular-400-944fb546bd7018b07190a32244f67dc9.woff2",
@@ -31,6 +32,13 @@
         ]
       }
     },
+    "main": {
+      "assets": {
+        "js": [
+          "/packs/main-e323a53c7f30f5d53cbb.js"
+        ]
+      }
+    },
     "hello_stimulus": {
       "assets": {
         "css": [