shakapacker 8.0.0 → 8.0.1

data/spec/generator_specs/generator_spec.rb

@@ -1,193 +0,0 @@
-require "pathname"
-require "rake"
-require "json"
-require "shakapacker/utils/misc"
-require "shakapacker/utils/version_syntax_converter"
-require "package_json"
-
-GEM_ROOT = Pathname.new(File.expand_path("../../..", __FILE__))
-SPEC_PATH = Pathname.new(File.expand_path("../", __FILE__))
-BASE_RAILS_APP_PATH = SPEC_PATH.join("base-rails-app")
-TEMP_RAILS_APP_PATH = SPEC_PATH.join("temp-rails-app")
-
-describe "Generator" do
-  before :all do
-    # Don't use --skip-git because we want .gitignore file to exist in the project
-    sh_in_dir({}, SPEC_PATH, %(
-      rails new base-rails-app --skip-javascript --skip-bundle --skip-spring
-      rm -rf base-rails-app/.git
-    ))
-
-    Bundler.with_unbundled_env do
-      sh_in_dir({}, BASE_RAILS_APP_PATH, %(
-        gem update bundler
-        bundle add shakapacker --path "#{GEM_ROOT}"
-      ))
-    end
-  end
-
-  after :all do
-    Dir.chdir(SPEC_PATH)
-    FileUtils.rm_rf(BASE_RAILS_APP_PATH)
-  end
-
-  describe "shakapacker:install" do
-    # TODO: ideally "yarn_berry" should be here too, but it requires more complex setup
-    NODE_PACKAGE_MANAGERS.reject { |fm| fm == "yarn_berry" }.each do |fallback_manager|
-      context "when using package_json with #{fallback_manager} as the manager" do
-        before :all do
-          sh_opts = { fallback_manager: fallback_manager }
-
-          sh_in_dir(sh_opts, SPEC_PATH, "cp -r '#{BASE_RAILS_APP_PATH}' '#{TEMP_RAILS_APP_PATH}'")
-
-          Bundler.with_unbundled_env do
-            sh_in_dir(sh_opts, TEMP_RAILS_APP_PATH, "FORCE=true bundle exec rails shakapacker:install")
-          end
-        end
-
-        after :all do
-          Dir.chdir(SPEC_PATH)
-          FileUtils.rm_rf(TEMP_RAILS_APP_PATH)
-        end
-
-        it "creates `config/shakapacker.yml`" do
-          config_file_relative_path = "config/shakapacker.yml"
-          actual_content = read(path_in_the_app(config_file_relative_path))
-          expected_content = read(path_in_the_gem(config_file_relative_path))
-
-          expect(actual_content).to eq expected_content
-        end
-
-        it "ensures the 'packageManager' field is set" do
-          package_json = PackageJson.read(path_in_the_app)
-
-          manager_name = fallback_manager.split("_")[0]
-
-          expect(package_json.fetch("packageManager", "")).to match(/#{manager_name}@\d+\.\d+\.\d+/)
-        end
-
-        it "creates webpack config directory and its files" do
-          expected_files = [
-            "webpack.config.js"
-          ]
-
-          Dir.chdir(path_in_the_app("config/webpack")) do
-            existing_files_in_config_webpack_dir = Dir.glob("*")
-            expect(existing_files_in_config_webpack_dir).to eq expected_files
-          end
-        end
-
-        it "adds binstubs" do
-          expected_binstubs = []
-          Dir.chdir(File.join(GEM_ROOT, "lib/install/bin")) do
-            expected_binstubs = Dir.glob("bin/*")
-          end
-
-          Dir.chdir(File.join(TEMP_RAILS_APP_PATH, "bin")) do
-            actual_binstubs = Dir.glob("*")
-            expect(actual_binstubs).to include(*expected_binstubs)
-          end
-        end
-
-        it "modifies .gitignore" do
-          actual_content = read(path_in_the_app(".gitignore"))
-
-          expect(actual_content).to match ".yarn-integrity"
-        end
-
-        it 'adds <%= javascript_pack_tag "application" %>' do
-          actual_content = read(path_in_the_app("app/views/layouts/application.html.erb"))
-
-          expect(actual_content).to match '<%= javascript_pack_tag "application" %>'
-        end
-
-        it "updates `bin/setup`" do
-          package_json = PackageJson.read(path_in_the_app)
-          cmd = package_json.manager.native_install_command.join(" ")
-
-          setup_file_content = read(path_in_the_app("bin/setup"))
-
-          expect(setup_file_content).to match %r(^\s*system!\(['"]#{cmd}['"]\))
-        end
-
-        it "adds relevant shakapacker version in package.json depending on gem version" do
-          npm_version = Shakapacker::Utils::VersionSyntaxConverter.new.rubygem_to_npm(Shakapacker::VERSION)
-
-          package_json = PackageJson.read(path_in_the_app)
-          actual_version = package_json.fetch("dependencies", {})["shakapacker"]
-
-          expect(actual_version).to eq(npm_version)
-        end
-
-        it "adds Shakapacker peer dependencies to package.json" do
-          package_json = PackageJson.read(path_in_the_app)
-          actual_dependencies = package_json.fetch("dependencies", {}).keys
-
-          expected_dependencies = %w(
-            @babel/core
-            @babel/plugin-transform-runtime
-            @babel/preset-env
-            @babel/runtime
-            babel-loader
-            compression-webpack-plugin
-            terser-webpack-plugin
-            webpack
-            webpack-assets-manifest
-            webpack-cli
-            webpack-merge
-          )
-
-          expect(actual_dependencies).to include(*expected_dependencies)
-        end
-
-        it "adds Shakapacker peer dev dependencies to package.json" do
-          package_json = PackageJson.read(path_in_the_app)
-          actual_dev_dependencies = package_json.fetch("devDependencies", {}).keys
-
-          expected_dev_dependencies = %w(
-            webpack-dev-server
-          )
-
-          expect(actual_dev_dependencies).to include(*expected_dev_dependencies)
-        end
-
-        context "with a basic react app setup" do
-          it "passes the test for rendering react component on the page" do
-            sh_opts = { fallback_manager: fallback_manager }
-
-            Bundler.with_unbundled_env do
-              sh_in_dir(sh_opts, TEMP_RAILS_APP_PATH, "./bin/rails app:template LOCATION=../e2e_template/template.rb")
-              expect(sh_in_dir(sh_opts, TEMP_RAILS_APP_PATH, "bundle exec rspec")).to be_truthy
-            end
-          end
-        end
-      end
-    end
-  end
-
-  private
-
-    def path_in_the_app(relative_path = nil)
-      Pathname.new(File.join([TEMP_RAILS_APP_PATH, relative_path].compact))
-    end
-
-    def path_in_the_gem(relative_path = nil)
-      Pathname.new(File.join([GEM_ROOT, "lib/install" , relative_path].compact))
-    end
-
-    def read(path)
-      File.read(path)
-    end
-
-    def sort_out_package_json(opts)
-      ENV["PATH"] = "#{SPEC_PATH}/fake-bin:#{ENV["PATH"]}"
-
-      ENV["SHAKAPACKER_EXPECTED_PACKAGE_MANGER"] = opts[:fallback_manager]
-      ENV["PACKAGE_JSON_FALLBACK_MANAGER"] = opts[:fallback_manager]
-    end
-
-    def sh_in_dir(opts, dir, *shell_commands)
-      sort_out_package_json(opts)
-      Shakapacker::Utils::Misc.sh_in_dir(dir, *shell_commands)
-    end
-end

data/spec/mounted_app/Rakefile

@@ -1,4 +0,0 @@
-require "bundler/setup"
-
-APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
-load "rails/tasks/engine.rake"

data/spec/mounted_app/package.json

@@ -1 +0,0 @@
-{}

data/spec/mounted_app/test/dummy/Rakefile

@@ -1,3 +0,0 @@
-require_relative "config/application"
-
-Rails.application.load_tasks

data/spec/mounted_app/test/dummy/bin/rails

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-APP_PATH = File.expand_path("../config/application", __dir__)
-require "rails/commands"

data/spec/mounted_app/test/dummy/bin/rake

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require "rake"
-Rake.application.run

data/spec/mounted_app/test/dummy/config/application.rb

@@ -1,10 +0,0 @@
-require "action_controller/railtie"
-require "action_view/railtie"
-require "shakapacker"
-
-module TestDummyApp
-  class Application < Rails::Application
-    config.secret_key_base = "abcdef"
-    config.eager_load = true
-  end
-end

data/spec/mounted_app/test/dummy/config/environment.rb

@@ -1,3 +0,0 @@
-require_relative "application"
-
-Rails.application.initialize!

data/spec/mounted_app/test/dummy/config/webpacker.yml

@@ -1,81 +0,0 @@
-# Note: You must restart bin/shakapacker-dev-server for changes to take effect
-
-default: &default
-  source_path: app/javascript
-  source_entry_path: entrypoints
-  public_output_path: packs
-  cache_path: tmp/shakapacker
-  webpack_loader: babel
-
-  # Additional paths webpack should look up modules
-  # ['app/assets', 'engine/foo/app/assets']
-  additional_paths:
-    - app/assets
-    - /etc/yarn
-
-  # Reload manifest.json on all requests so we reload latest compiled packs
-  cache_manifest: false
-
-  extensions:
-    - .js
-    - .sass
-    - .scss
-    - .css
-    - .module.sass
-    - .module.scss
-    - .module.css
-    - .png
-    - .svg
-    - .gif
-    - .jpeg
-    - .jpg
-
-development:
-  <<: *default
-  compile: true
-
-  # Reference: https://webpack.js.org/configuration/dev-server/
-  dev_server:
-    host: localhost
-    port: 3035
-    public: localhost:3035
-    hmr: false
-    # If HMR is on, CSS will by inlined by delivering it as part of the script payload via style-loader. Be sure
-    # that you add style-loader to your project dependencies.
-    #
-    # If you want to instead deliver CSS via <link> with the mini-extract-css-plugin, set inline_css to false.
-    # In that case, style-loader is not needed as a dependency.
-    #
-    # mini-extract-css-plugin is a required dependency in both cases.
-    inline_css: true
-    overlay: true
-    disable_host_check: true
-    use_local_ip: false
-
-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
-
-staging:
-  <<: *default
-
-  # Production depends on precompilation of packs prior to booting for performance.
-  compile: false
-
-  # Cache manifest.json for performance
-  cache_manifest: true
-
-  # Compile staging packs to a separate directory
-  public_output_path: packs-staging

data/spec/mounted_app/test/dummy/config.ru

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

data/spec/mounted_app/test/dummy/package.json

@@ -1,7 +0,0 @@
-{
-  "private": true,
-  "dependencies": {
-    "shakapacker": "file:../../../../"
-  },
-  "license": "MIT"
-}

data/spec/shakapacker/command_spec.rb

@@ -1,134 +0,0 @@
-require_relative "spec_helper_initializer"
-
-describe "Command" do
-  before do
-    allow(Shakapacker.logger).to receive(:info)
-  end
-
-  describe "#compile" do
-    it "returns success status when stale" do
-      expect(Shakapacker.compiler).to receive(:stale?).and_return(true)
-      expect(Shakapacker.compiler).to receive(:run_webpack).and_return(true)
-
-      expect(Shakapacker.commands.compile).to be true
-    end
-
-    it "returns success status when fresh" do
-      expect(Shakapacker.compiler).to receive(:stale?).and_return(false)
-
-      expect(Shakapacker.commands.compile).to be true
-    end
-
-    it "returns failure status when stale" do
-      expect(Shakapacker.compiler).to receive(:stale?).and_return(true)
-      expect(Shakapacker.compiler).to receive(:run_webpack).and_return(false)
-
-      expect(Shakapacker.commands.compile).to be false
-    end
-  end
-
-  describe "#clean" do
-    let(:now) { Time.parse("2021-01-01 12:34:56 UTC") }
-    let(:prev_files) do
-      # Test assets to be kept and deleted, path and mtime
-      {
-        # recent versions to be kept with Shakapacker.commands.clean(count = 2)
-        "js/application-deadbeef.js" => now - 4000,
-        "js/common-deadbeee.js" => now - 4002,
-        "css/common-deadbeed.css" => now - 4004,
-        "media/images/logo-deadbeeb.css" => now - 4006,
-        "js/application-1eadbeef.js" => now - 8000,
-        "js/common-1eadbeee.js" => now - 8002,
-        "css/common-1eadbeed.css" => now - 8004,
-        "media/images/logo-1eadbeeb.css" => now - 8006,
-        # new files to be kept with Shakapacker.commands.clean(age = 3600)
-        "js/brandnew-0001.js" => now,
-        "js/brandnew-0002.js" => now - 10,
-        "js/brandnew-0003.js" => now - 20,
-        "js/brandnew-0004.js" => now - 40,
-
-        # Compressed and map files
-        "js/application-deadbeef.js.br" => now - 4000,
-        "js/application-deadbeef.js.gz" => now - 4000,
-        "js/application-deadbeef.js.map" => now - 4000,
-        "js/application-deadbeef.js.map.br" => now - 4000,
-        "js/application-deadbeef.js.map.gz" => now - 4000,
-        "js/application-1eadbeef.js.br" => now - 4000,
-        "js/application-1eadbeef.js.gz" => now - 4000,
-        "js/application-1eadbeef.js.map" => now - 4000,
-        "js/application-1eadbeef.js.map.br" => now - 4000,
-        "js/application-1eadbeef.js.map.gz" => now - 4000,
-      }.transform_keys { |path| "#{Shakapacker.config.public_output_path}/#{path}" }
-    end
-
-    let(:expired_files) do
-      {
-        # old files that are outside count = 2 or age = 3600 and to be deleted
-        "js/application-0eadbeef.js" => now - 9000,
-        "js/common-0eadbeee.js" => now - 9002,
-        "css/common-0eadbeed.css" => now - 9004,
-        "js/brandnew-0005.js" => now - 3640,
-        # Compressed and map files
-        "js/application-0eadbeef.js.br" => now - 9000,
-        "js/application-0eadbeef.js.gz" => now - 9000,
-        "js/application-0eadbeef.js.map" => now - 9000,
-        "js/application-0eadbeef.js.map.br" => now - 9000,
-        "js/application-0eadbeef.js.map.gz" => now - 9000,
-      }.transform_keys { |path| "#{Shakapacker.config.public_output_path}/#{path}" }
-    end
-
-    let(:all_files) { prev_files.merge(expired_files) }
-
-    let(:file_delete_mock) { double("File Delete") }
-    let(:file_mtime_stub) { Proc.new { |longpath| all_files[longpath] } }
-    let(:file_delete_stub) { Proc.new { |longpath| file_delete_mock.delete(longpath) } }
-
-    before :context do
-      @dir_glob_stub = Proc.new { |arg|
-        case arg
-        when "#{Shakapacker.config.public_output_path}/**/*"
-          all_files.keys
-        else
-          []
-        end
-      }
-    end
-
-    it "works with nested hashes and without any compiled files" do
-      allow(File).to receive(:delete).and_return(true)
-      expect(Shakapacker.commands.clean).to be true
-    end
-
-    it "deletes only and only expired versioned files if no parameter passed" do
-      all_files.keys.each do |longpath|
-        allow(file_delete_mock).to receive(:delete).with(longpath)
-      end
-
-      with_time_dir_and_files_stub do
-        expect(Shakapacker.commands.clean).to be true
-
-        # Verify that only and only expired files are deleted
-        all_files.keys.each do |longpath|
-          if expired_files.has_key? longpath
-            expect(file_delete_mock).to have_received(:delete).with(longpath)
-          else
-            expect(file_delete_mock).to_not have_received(:delete).with(longpath)
-          end
-        end
-      end
-    end
-
-    private
-
-      def with_time_dir_and_files_stub(&proc)
-        allow(Time).to receive(:now).and_return(now)
-        allow(Dir).to receive(:glob) { |arg| @dir_glob_stub.call(arg) }
-        allow(File).to receive(:directory?).and_return(false)
-        allow(File).to receive(:file?).and_return(true)
-        allow(File).to receive(:mtime) { |arg| file_mtime_stub.call(arg) }
-        allow(File).to receive(:delete) { |arg| file_delete_stub.call(arg) }
-
-        yield proc
-      end
-  end
-end

data/spec/shakapacker/compiler_spec.rb

@@ -1,57 +0,0 @@
-require_relative "spec_helper_initializer"
-require "ostruct"
-
-describe "Shakapacker::Compiler" do
-  it "accepts custom environment variables" do
-    expect(Shakapacker.compiler.send(:webpack_env)["FOO"]).to be nil
-
-    Shakapacker.compiler.env["FOO"] = "BAR"
-    expect(Shakapacker.compiler.send(:webpack_env)["FOO"]).to eq "BAR"
-  ensure
-    Shakapacker.compiler.env = {}
-  end
-
-  it "returns true when fresh" do
-    mocked_strategy = double("Strategy")
-    expect(mocked_strategy).to receive(:stale?).and_return(false)
-
-    expect(Shakapacker.compiler).to receive(:strategy).and_return(mocked_strategy)
-
-    expect(Shakapacker.compiler.compile).to be true
-  end
-
-  it "returns true and calls after_compile_hook on successful compile" do
-    mocked_strategy = spy("Strategy")
-    expect(mocked_strategy).to receive(:stale?).and_return(true)
-
-    allow(Shakapacker.compiler).to receive(:strategy).and_return(mocked_strategy)
-
-    status = OpenStruct.new(success?: true)
-    allow(Open3).to receive(:capture3).and_return([:stderr, :stdout, status])
-
-    expect(Shakapacker.compiler.compile).to be true
-    expect(mocked_strategy).to have_received(:after_compile_hook)
-  end
-
-  it "returns false and calls after_compile_hook on failed compile" do
-    mocked_strategy = spy("Strategy")
-    allow(mocked_strategy).to receive(:stale?).and_return(true)
-    allow(mocked_strategy).to receive(:after_compile_hook)
-
-    allow(Shakapacker.compiler).to receive(:strategy).and_return(mocked_strategy)
-
-    status = OpenStruct.new(success?: false)
-    allow(Open3).to receive(:capture3).and_return([:stderr, :stdout, status])
-
-    expect(Shakapacker.compiler.compile).to be false
-    expect(mocked_strategy).to have_received(:after_compile_hook)
-  end
-
-  it "accepts external env variables" do
-    expect(Shakapacker.compiler.send(:webpack_env)["SHAKAPACKER_ASSET_HOST"]).to be nil
-
-    allow(ENV).to receive(:fetch).with("SHAKAPACKER_ASSET_HOST", nil).and_return("foo.bar")
-
-    expect(Shakapacker.compiler.send(:webpack_env)["SHAKAPACKER_ASSET_HOST"]).to eq "foo.bar"
-  end
-end

data/spec/shakapacker/compiler_strategy_spec.rb

@@ -1,24 +0,0 @@
-require_relative "spec_helper_initializer"
-
-describe "Shakapacker::CompilerStrategy" do
-  describe "#from_config" do
-    it "returns an instance of MtimeStrategy when compiler_strategy is set to mtime" do
-      allow(Shakapacker.config).to receive(:compiler_strategy).and_return("mtime")
-
-      expect(Shakapacker::CompilerStrategy.from_config).to be_an_instance_of(Shakapacker::MtimeStrategy)
-    end
-
-    it "returns an instance of DigestStrategy when compiler_strategy is set to digest" do
-      allow(Shakapacker.config).to receive(:compiler_strategy).and_return("digest")
-
-      expect(Shakapacker::CompilerStrategy.from_config).to be_an_instance_of(Shakapacker::DigestStrategy)
-    end
-
-    it "raise an exception for unknown compiler_strategy in the config file" do
-      expected_error_message = "Unknown strategy 'other'. Available options are 'mtime' and 'digest'."
-      allow(Shakapacker.config).to receive(:compiler_strategy).and_return("other")
-
-      expect { Shakapacker::CompilerStrategy.from_config }.to raise_error(expected_error_message)
-    end
-  end
-end