RubyGems - shakapacker - Versions diffs - 7.0.0.rc.0 → 7.0.0.rc.2 - Mend

shakapacker 7.0.0.rc.0 → 7.0.0.rc.2

Files changed (201) hide show

data/spec/generator_specs/e2e_template/files/app/controllers/home_controller.rb ADDED Viewed

@@ -0,0 +1,4 @@
+class HomeController < ApplicationController
+  def index
+  end
+end

data/spec/generator_specs/e2e_template/files/app/javascript/components/App.js ADDED Viewed

@@ -0,0 +1,12 @@
+import React from 'react'
+function App() {
+  return (
+    <div className="App">
+      <h1>App component</h1>
+      <p>Text from react component!</p>
+    </div>
+  )
+}
+export default App

data/spec/generator_specs/e2e_template/files/app/javascript/packs/application.js ADDED Viewed

@@ -0,0 +1,10 @@
+import React from 'react'
+import ReactDOM from 'react-dom/client'
+import App from '../components/App'
+const root = ReactDOM.createRoot(document.getElementById('root'))
+root.render(
+  <React.StrictMode>
+    <App />
+  </React.StrictMode>
+)

data/spec/generator_specs/e2e_template/files/app/views/home/index.html.erb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ <h1>Home#index</h1>
2	+ <p>Find me in app/views/home/index.html.erb</p>

data/spec/generator_specs/e2e_template/files/app/views/layouts/application.html.erb ADDED Viewed

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Sh7InstallTest</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <%= stylesheet_link_tag "application" %>
+    <%= javascript_pack_tag "application" %>
+  </head>
+  <body>
+    <%= yield %>
+    <div id="root"></div>
+  </body>
+</html>

data/spec/generator_specs/e2e_template/files/config/routes.rb ADDED Viewed

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get "home/index"
+end

data/spec/generator_specs/e2e_template/files/spec/system/test_react_component_renders_spec.rb ADDED Viewed

@@ -0,0 +1,13 @@
+require "rails_helper"
+RSpec.describe "home/index", type: :system, js: true do
+  before do
+    driven_by(:selenium_headless)
+  end
+  it "renders the App component" do
+    visit "home/index"
+    expect(page.body).to match "App component"
+  end
+end

data/spec/generator_specs/e2e_template/template.rb ADDED Viewed

@@ -0,0 +1,21 @@
+# install react
+system("yarn add react react-dom @babel/preset-react")
+# update webpack presets for react
+package_json_path = Rails.root.join("./package.json")
+insert_into_file(
+  package_json_path,
+  %(      "@babel/preset-react",\n),
+  after: /"presets": \[\n/
+)
+# install rspec-rails
+system("bundle add rspec-rails --group development,test")
+system("bundle exec rails g rspec:install")
+# copy files
+directory(
+  Rails.root.join("../e2e_template/files"),
+  Rails.root,
+  force: true
+)

data/spec/generator_specs/generator_spec.rb ADDED Viewed

@@ -0,0 +1,169 @@
+require "pathname"
+require "rake"
+require "json"
+require "shakapacker/utils/misc"
+require "shakapacker/utils/version_syntax_converter"
+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
+    context "in a normal Rails project" do
+      before :all do
+        sh_in_dir(SPEC_PATH, "cp -r #{BASE_RAILS_APP_PATH} #{TEMP_RAILS_APP_PATH}")
+        Bundler.with_unbundled_env do
+          sh_in_dir(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 "replaces package.json with template file" do
+        actual_content = read(path_in_the_app("package.json"))
+        expect(actual_content).to match /"name": "app",/
+      end
+      it "creates webpack config directory and its files" do
+        expected_files = [
+          "webpack.config.js"
+        ]
+        Dir.chdir(path_in_the_app("config/webpack")) do
+          exisiting_files_in_config_webpack_dir = Dir.glob("*")
+          expect(exisiting_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
+        setup_file_content = read(path_in_the_app("bin/setup"))
+        expect(setup_file_content).to match %r(^\s*system!\(['"]bin/yarn['"]\))
+      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)
+        actual_content = read(path_in_the_app("package.json"))
+        expect(actual_content).to match /"shakapacker": "#{npm_version}",/
+      end
+      it "adds Shakapacker peer dependencies to package.json" do
+        package_json = JSON.parse(File.read(path_in_the_app("package.json")))
+        actual_dependencies = package_json["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 = JSON.parse(File.read(path_in_the_app("package.json")))
+        actual_dev_dependencies = package_json["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
+          Bundler.with_unbundled_env do
+            sh_in_dir(TEMP_RAILS_APP_PATH, "./bin/rails app:template LOCATION=../e2e_template/template.rb")
+            expect(sh_in_dir(TEMP_RAILS_APP_PATH, "bundle exec rspec")).to be_truthy
+          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 sh_in_dir(dir, *shell_commands)
+      Shakapacker::Utils::Misc.sh_in_dir(dir, *shell_commands)
+    end
+end

data/spec/{configuration_spec.rb → shakapacker/configuration_spec.rb} RENAMED Viewed

@@ -1,7 +1,7 @@
 require_relative "spec_helper_initializer"
 describe "Shakapacker::Configuration" do
-  ROOT_PATH = Pathname.new(File.expand_path("test_app", __dir__))
+  ROOT_PATH = Pathname.new(File.expand_path("./test_app", __dir__))
   context "with standard shakapacker.yml" do
     let(:config) do
@@ -13,37 +13,37 @@ describe "Shakapacker::Configuration" do
     end
     it "#source_path returns correct path" do
-      source_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/app/javascript").to_s
+      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
+      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
+      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
+      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
+      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
+      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
+      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
@@ -184,7 +184,7 @@ describe "Shakapacker::Configuration" do
     )
     it "#public_output_path returns correct path" do
-      expected_public_output_path = File.expand_path File.join(File.dirname(__FILE__), "public/packs").to_s
+      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
@@ -197,7 +197,7 @@ describe "Shakapacker::Configuration" do
     )
     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
+      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

data/spec/{dev_server_runner_spec.rb → shakapacker/dev_server_runner_spec.rb} RENAMED Viewed

@@ -14,7 +14,7 @@ describe "DevServerRunner" do
     ENV["SHAKAPACKER_CONFIG"] = @original_shakapacker_config
   end
-  let(:test_app_path) { File.expand_path("test_app", __dir__) }
+  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"]

data/spec/{engine_rake_tasks_spec.rb → shakapacker/engine_rake_tasks_spec.rb} RENAMED Viewed

@@ -21,7 +21,7 @@ describe "EngineRakeTasks" do
   private
     def mounted_app_path
-      File.expand_path("mounted_app", __dir__)
+      File.expand_path("../mounted_app", __dir__)
     end
     def current_files_in_bin
@@ -29,7 +29,7 @@ describe "EngineRakeTasks" do
     end
     def expected_binstub_paths
-      gem_path = File.expand_path("..", __dir__)
+      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

data/spec/{manifest_spec.rb → shakapacker/manifest_spec.rb} RENAMED Viewed

@@ -1,7 +1,7 @@
 require_relative "spec_helper_initializer"
 describe "Shakapacker::Manifest" do
-  let(:manifest_path) { File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs", "manifest.json").to_s }
+  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"

data/spec/shakapacker/rake_tasks_spec.rb ADDED Viewed

@@ -0,0 +1,93 @@
+require_relative "spec_helper_initializer"
+describe "RakeTasks" do
+  TEST_APP_PATH = File.expand_path("./test_app", __dir__)
+  it "`rake -T` lists Shakapacker tasks" do
+    output = Dir.chdir(TEST_APP_PATH) { `rake -T` }
+    expect(output).to include "shakapacker"
+    expect(output).to include "shakapacker:check_binstubs"
+    expect(output).to include "shakapacker:check_node"
+    expect(output).to include "shakapacker:check_yarn"
+    expect(output).to include "shakapacker:clean"
+    expect(output).to include "shakapacker:clobber"
+    expect(output).to include "shakapacker:compile"
+    expect(output).to include "shakapacker:install"
+    expect(output).to include "shakapacker:verify_install"
+  end
+  it "`shakapacker:check_binstubs` doesn't get 'webpack binstub not found' error" do
+    output = Dir.chdir(TEST_APP_PATH) { `rake shakapacker:check_binstubs 2>&1` }
+    expect(output).to_not include "webpack binstub not found."
+  end
+  it "`shakapacker:check_node` doesn't get 'shakapacker requires Node.js' error" do
+    output = Dir.chdir(TEST_APP_PATH) { `rake shakapacker:check_node 2>&1` }
+    expect(output).to_not include "Shakapacker requires Node.js"
+  end
+  it "`shakapacker:check_yarn` doesn't get error related to yarn" do
+    output = Dir.chdir(TEST_APP_PATH) { `rake shakapacker:check_yarn 2>&1` }
+    expect(output).to_not include "Yarn not installed"
+    expect(output).to_not include "Shakapacker requires Yarn"
+  end
+  describe "`shakapacker:check_binstubs`" do
+    def with_temporary_file(file_name, &block)
+      FileUtils.touch(file_name, verbose: false)
+      yield if block_given?
+    ensure
+      FileUtils.rm_f(file_name, verbose: false)
+    end
+    before :all do
+      Dir.chdir(TEST_APP_PATH)
+    end
+    context "with existing `./bin/shapapacker` and `./bin/shapapacker-dev-server`" do
+      it "passes" do
+        expect { system("bundle exec rake shakapacker:check_binstubs") }.to output("").to_stdout_from_any_process
+      end
+    end
+    context "without `./bin/shakapacker`" do
+      before :all do
+        FileUtils.mv("bin/shakapacker", "bin/shakapacker_renamed")
+      end
+      after :all do
+        FileUtils.mv("bin/shakapacker_renamed", "bin/shakapacker")
+      end
+      it "passes if `./bin/webpacker exist" do
+        with_temporary_file("bin/webpacker") do
+          expect { system("bundle exec rake shakapacker:check_binstubs") }.to output(/DEPRECATION/).to_stdout_from_any_process
+        end
+      end
+      it "fails otherwise" do
+        expect { system("bundle exec rake shakapacker:check_binstubs") }.to output(/Couldn't find shakapacker binstubs!/).to_stdout_from_any_process
+      end
+    end
+    context "without `./bin/shakapacker-dev-server`" do
+      before :all do
+        FileUtils.mv("bin/shakapacker-dev-server", "bin/shakapacker-dev-server_renamed")
+      end
+      after :all do
+        FileUtils.mv("bin/shakapacker-dev-server_renamed", "bin/shakapacker-dev-server")
+      end
+      it "passes if `./bin/webpacker-dev-server exist" do
+        with_temporary_file("bin/webpacker-dev-server") do
+          expect { system("bundle exec rake shakapacker:check_binstubs") }.to output(/DEPRECATION/).to_stdout_from_any_process
+        end
+      end
+      it "fails otherwise" do
+        expect { system("bundle exec rake shakapacker:check_binstubs") }.to output(/Couldn't find shakapacker binstubs!/).to_stdout_from_any_process
+      end
+    end
+  end
+end

data/spec/{spec_helper_initializer.rb → shakapacker/spec_helper_initializer.rb} RENAMED Viewed

@@ -1,4 +1,4 @@
-require_relative "test_app/config/environment"
+require_relative "./test_app/config/environment"
 Rails.env = "production"

data/spec/shakapacker/test_app/config/webpack/webpack.config.js ADDED Viewed

File without changes

data/spec/shakapacker/test_app/some.config.js ADDED Viewed

File without changes

data/spec/{version_checker_spec.rb → shakapacker/version_checker_spec.rb} RENAMED Viewed

@@ -102,7 +102,7 @@ describe "VersionChecker::NodePackageVersion" do
   context "with no yarn.lock file" do
     def node_package_version(fixture_version:)
       Shakapacker::VersionChecker::NodePackageVersion.new(
-        File.expand_path("fixtures/#{fixture_version}_package.json", __dir__),
+        File.expand_path("../fixtures/#{fixture_version}_package.json", __dir__),
         "file/does/not/exist",
         "file/does/not/exist"
       )
@@ -272,8 +272,8 @@ describe "VersionChecker::NodePackageVersion" do
   context "with yarn.lock v1" do
     def node_package_version(fixture_version:)
       Shakapacker::VersionChecker::NodePackageVersion.new(
-        File.expand_path("fixtures/#{fixture_version}_package.json", __dir__),
-        File.expand_path("fixtures/#{fixture_version}_yarn.v1.lock", __dir__),
+        File.expand_path("../fixtures/#{fixture_version}_package.json", __dir__),
+        File.expand_path("../fixtures/#{fixture_version}_yarn.v1.lock", __dir__),
         "file/does/not/exist"
       )
     end
@@ -442,8 +442,8 @@ describe "VersionChecker::NodePackageVersion" do
   context "with yarn.lock v2" do
     def node_package_version(fixture_version:)
       Shakapacker::VersionChecker::NodePackageVersion.new(
-        File.expand_path("fixtures/#{fixture_version}_package.json", __dir__),
-        File.expand_path("fixtures/#{fixture_version}_yarn.v2.lock", __dir__),
+        File.expand_path("../fixtures/#{fixture_version}_package.json", __dir__),
+        File.expand_path("../fixtures/#{fixture_version}_yarn.v2.lock", __dir__),
         "file/does/not/exist"
       )
     end
@@ -612,9 +612,9 @@ describe "VersionChecker::NodePackageVersion" do
   context "with package-lock.json v1" do
     def node_package_version(fixture_version:)
       Shakapacker::VersionChecker::NodePackageVersion.new(
-        File.expand_path("fixtures/#{fixture_version}_package.json", __dir__),
+        File.expand_path("../fixtures/#{fixture_version}_package.json", __dir__),
         "file/does/not/exist",
-        File.expand_path("fixtures/#{fixture_version}_package-lock.v1.json", __dir__),
+        File.expand_path("../fixtures/#{fixture_version}_package-lock.v1.json", __dir__),
       )
     end
@@ -782,9 +782,9 @@ describe "VersionChecker::NodePackageVersion" do
   context "with package-lock.json v2" do
     def node_package_version(fixture_version:)
       Shakapacker::VersionChecker::NodePackageVersion.new(
-        File.expand_path("fixtures/#{fixture_version}_package.json", __dir__),
+        File.expand_path("../fixtures/#{fixture_version}_package.json", __dir__),
         "file/does/not/exist",
-        File.expand_path("fixtures/#{fixture_version}_package-lock.v2.json", __dir__),
+        File.expand_path("../fixtures/#{fixture_version}_package-lock.v2.json", __dir__),
       )
     end

data/spec/{webpack_runner_spec.rb → shakapacker/webpack_runner_spec.rb} RENAMED Viewed

@@ -32,7 +32,7 @@ describe "WebpackRunner" do
   private
     def test_app_path
-      File.expand_path("test_app", __dir__)
+      File.expand_path("./test_app", __dir__)
     end
     def verify_command(cmd, use_node_modules: true, argv: [])