vite_rails 1.0.0

data/lib/vite_rails/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ViteRails
+  VERSION = '1.0.0'
+end

data/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "only-for-workflows",
+  "version": "unknown",
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint package/"
+  },
+  "dependencies": {
+    "vite": "^2.0.0-beta.30",
+    "vite-plugin-ruby": "1.0.0"
+  },
+  "devDependencies": {
+    "@vitejs/plugin-vue": "^1.0.6",
+    "eslint": "^7.16.0",
+    "eslint-config-airbnb": "^18.2.0",
+    "eslint-config-prettier": "^7.1.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jsx-a11y": "^6.3.1",
+    "eslint-plugin-react": "^7.21.4",
+    "jest": "^26.5.3"
+  },
+  "jest": {
+    "testRegex": "(/__tests__/.*|(\\.|/))\\.jsx?$",
+    "roots": [
+      "<rootDir>/package"
+    ]
+  }
+}

data/package/default.vite.json

@@ -0,0 +1,15 @@
+{
+  "assetsDir": "assets",
+  "autoBuild": false,
+  "buildCacheDir": "tmp/cache/vite",
+  "publicOutputDir": "vite",
+  "configPath": "config/vite.json",
+  "publicDir": "public",
+  "entrypointsDir": "entrypoints",
+  "sourceCodeDir": "app/javascript",
+  "host": "localhost",
+  "https": null,
+  "port": 3036,
+  "hideBuildConsoleOutput": false,
+  "watchAdditionalPaths": []
+}

data/test/builder_test.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class BuilderTest < Minitest::Test
+  def remove_files_digest_path
+    ViteRails.builder.send(:files_digest_path).tap do |path|
+      path.delete if path.exist?
+    end
+  end
+
+  def setup
+    remove_files_digest_path
+  end
+
+  def teardown
+    remove_files_digest_path
+  end
+
+  def test_custom_environment_variables
+    assert_nil ViteRails.builder.send(:vite_env)['FOO']
+    ViteRails.env['FOO'] = 'BAR'
+    assert ViteRails.builder.send(:vite_env)['FOO'] == 'BAR'
+  ensure
+    ViteRails.env = {}
+  end
+
+  def test_freshness
+    assert ViteRails.builder.stale?
+    assert !ViteRails.builder.fresh?
+  end
+
+  def test_build
+    assert !ViteRails.builder.build
+  end
+
+  def test_freshness_on_build_success
+    status = OpenStruct.new(success?: true)
+
+    assert ViteRails.builder.stale?
+    Open3.stub :capture3, [:sterr, :stdout, status] do
+      ViteRails.builder.build
+      assert ViteRails.builder.fresh?
+    end
+  end
+
+  def test_freshness_on_build_fail
+    status = OpenStruct.new(success?: false)
+
+    assert ViteRails.builder.stale?
+    Open3.stub :capture3, [:sterr, :stdout, status] do
+      ViteRails.builder.build
+      assert ViteRails.builder.fresh?
+    end
+  end
+
+  def test_files_digest_path
+    assert_equal ViteRails.builder.send(:files_digest_path).basename.to_s, "last-compilation-digest-#{ ViteRails.config.mode }"
+  end
+
+  def test_external_env_variables
+    ViteRails.env = {}
+    assert_equal ViteRails.builder.send(:vite_env)['VITE_RUBY_MODE'], 'production'
+    assert_equal ViteRails.builder.send(:vite_env)['VITE_RUBY_ROOT'], Rails.root.to_s
+
+    ENV['VITE_RUBY_MODE'] = 'foo.bar'
+    ENV['VITE_RUBY_ROOT'] = '/baz'
+
+    assert_equal ViteRails.builder.send(:vite_env)['VITE_RUBY_MODE'], 'foo.bar'
+    assert_equal ViteRails.builder.send(:vite_env)['VITE_RUBY_ROOT'], '/baz'
+  end
+end

data/test/command_test.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class CommandTest < Minitest::Test
+  def test_compile_command_returns_success_status_when_stale
+    ViteRails.builder.stub :stale?, true do
+      ViteRails.builder.stub :run_vite, true do
+        assert_equal true, ViteRails.commands.compile
+      end
+    end
+  end
+
+  def test_compile_command_returns_success_status_when_fresh
+    ViteRails.builder.stub :stale?, false do
+      ViteRails.builder.stub :run_vite, true do
+        assert_equal true, ViteRails.commands.compile
+      end
+    end
+  end
+
+  def test_compile_command_returns_failure_status_when_stale
+    ViteRails.builder.stub :stale?, true do
+      ViteRails.builder.stub :run_vite, false do
+        assert_equal false, ViteRails.commands.compile
+      end
+    end
+  end
+
+  def test_clean_command_works_with_nested_hashes_and_without_any_compiled_files
+    File.stub :delete, true do
+      assert ViteRails.commands.clean
+    end
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class ConfigurationTest < ViteRails::Test
+  def setup
+    @config = ViteRails::Configuration.new(
+      root_path: Pathname.new(File.expand_path('test_app', __dir__)),
+      config_path: Pathname.new(File.expand_path('./test_app/config/vite.yml', __dir__)),
+      env: 'production',
+    )
+  end
+
+  def test_source_path
+    source_path = File.expand_path File.join(File.dirname(__FILE__), 'test_app/app/javascript').to_s
+    assert_equal source_path, @config.source_path.to_s
+  end
+
+  def test_source_entry_path
+    source_entry_path = File.expand_path File.join(File.dirname(__FILE__), 'test_app/app/javascript', 'packs').to_s
+    assert_equal @config.source_entry_path.to_s, source_entry_path
+  end
+
+  def test_public_root_path
+    public_root_path = File.expand_path File.join(File.dirname(__FILE__), 'test_app/public').to_s
+    assert_equal @config.public_path.to_s, public_root_path
+  end
+
+  def test_public_output_path
+    public_output_path = File.expand_path File.join(File.dirname(__FILE__), 'test_app/public/packs').to_s
+    assert_equal @config.public_output_path.to_s, public_output_path
+
+    @config = ViteRails::Configuration.new(
+      root_path: @config.root_path,
+      config_path: Pathname.new(File.expand_path('./test_app/config/vite_public_root.yml', __dir__)),
+      env: 'production',
+    )
+
+    public_output_path = File.expand_path File.join(File.dirname(__FILE__), 'public/packs').to_s
+    assert_equal @config.public_output_path.to_s, public_output_path
+  end
+
+  def test_public_manifest_path
+    public_manifest_path = File.expand_path File.join(File.dirname(__FILE__), 'test_app/public/packs', 'manifest.json').to_s
+    assert_equal @config.public_manifest_path.to_s, public_manifest_path
+  end
+
+  def test_cache_path
+    cache_path = File.expand_path File.join(File.dirname(__FILE__), 'test_app/tmp/cache/vite').to_s
+    assert_equal @config.cache_path.to_s, cache_path
+  end
+
+  def test_additional_paths
+    assert_equal @config.additional_paths, ['app/assets', '/etc/yarn', 'some.config.js', 'app/elm']
+  end
+
+  def test_cache_manifest?
+    assert @config.cache_manifest?
+
+    with_rails_env('development') do
+      refute ViteRails.config.cache_manifest?
+    end
+
+    with_rails_env('test') do
+      refute ViteRails.config.cache_manifest?
+    end
+  end
+
+  def test_compile?
+    refute @config.compile?
+
+    with_rails_env('development') do
+      assert ViteRails.config.compile?
+    end
+
+    with_rails_env('test') do
+      assert ViteRails.config.compile?
+    end
+  end
+end

data/test/dev_server_runner_test.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class DevServerRunnerTest < ViteRails::Test
+  def setup
+    @original_node_env, ENV['NODE_ENV'] = ENV['NODE_ENV'], 'development'
+    @original_rails_env, ENV['RAILS_ENV'] = ENV['RAILS_ENV'], 'development'
+  end
+
+  def teardown
+    ENV['NODE_ENV'] = @original_node_env
+    ENV['RAILS_ENV'] = @original_rails_env
+  end
+
+  def test_run_cmd_via_node_modules
+    cmd = ["#{ test_app_path }/node_modules/.bin/vite", '--mode', 'development']
+
+    verify_command(cmd, use_node_modules: true)
+  end
+
+  def test_run_cmd_via_yarn
+    cmd = ['yarn', 'vite', '--mode', 'development']
+
+    verify_command(cmd, use_node_modules: false)
+  end
+
+  def test_run_cmd_argv
+    cmd = ["#{ test_app_path }/node_modules/.bin/vite", '--quiet', '--mode', 'development']
+
+    verify_command(cmd, argv: ['--quiet'])
+  end
+
+  def test_run_cmd_argv_with_https
+    cmd = ["#{ test_app_path }/node_modules/.bin/vite", '--https', '--mode', 'development']
+
+    dev_server = ViteRails::DevServer.new({})
+    def dev_server.host
+      'localhost'
+    end
+
+    def dev_server.port
+      '3035'
+    end
+
+    def dev_server.pretty?
+      false
+    end
+
+    def dev_server.https?
+      true
+    end
+    ViteRails::DevServer.stub(:new, dev_server) do
+      verify_command(cmd, argv: ['--https'])
+    end
+  end
+
+private
+
+  def test_app_path
+    File.expand_path('test_app', __dir__)
+  end
+
+  def verify_command(cmd, use_node_modules: true, argv: [])
+    cwd = Dir.pwd
+    Dir.chdir(test_app_path)
+
+    klass = ViteRails::Runner
+    instance = klass.new(argv)
+    mock = Minitest::Mock.new
+    mock.expect(:call, nil, [ViteRails.env, *cmd])
+
+    klass.stub(:new, instance) do
+      instance.stub(:executable_exists?, use_node_modules) do
+        Kernel.stub(:exec, mock) { ViteRails.run(argv) }
+      end
+    end
+
+    mock.verify
+  ensure
+    Dir.chdir(cwd)
+  end
+end

data/test/dev_server_test.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class DevServerTest < ViteRails::Test
+  def test_running?
+    refute ViteRails.dev_server.running?
+  end
+
+  def test_host
+    with_rails_env('development') do
+      assert_equal ViteRails.config.host, 'localhost'
+    end
+  end
+
+  def test_port
+    with_rails_env('development') do
+      assert_equal ViteRails.config.port, 3035
+    end
+  end
+
+  def test_https?
+    with_rails_env('development') do
+      assert_equal ViteRails.config.https, false
+    end
+  end
+
+  def test_protocol
+    with_rails_env('development') do
+      assert_equal ViteRails.config.protocol, 'http'
+    end
+  end
+
+  def test_host_with_port
+    with_rails_env('development') do
+      assert_equal ViteRails.config.host_with_port, 'localhost:3035'
+    end
+  end
+end

data/test/engine_rake_tasks_test.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class EngineRakeTasksTest < Minitest::Test
+  def setup
+    remove_vite_binstubs
+  end
+
+  def teardown
+    remove_vite_binstubs
+  end
+
+  def test_task_mounted
+    output = Dir.chdir(mounted_app_path) { `rake -T` }
+    assert_includes output, 'app:vite'
+  end
+
+  def test_binstubs
+    Dir.chdir(mounted_app_path) { `bundle exec rake app:vite:binstubs` }
+    vite_binstub_paths.each { |path| assert File.exist?(path) }
+  end
+
+private
+
+  def mounted_app_path
+    File.expand_path('mounted_app', __dir__)
+  end
+
+  def vite_binstub_paths
+    [
+      "#{ mounted_app_path }/test/dummy/bin/vite",
+      "#{ mounted_app_path }/test/dummy/bin/vite-dev-server",
+    ]
+  end
+
+  def remove_vite_binstubs
+    vite_binstub_paths.each do |path|
+      File.delete(path) if File.exist?(path)
+    end
+  end
+end

data/test/helper_test.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class HelperTest < ActionView::TestCase
+  tests ViteRails::Helper
+
+  attr_reader :request
+
+  def setup
+    @request = Class.new do
+      def send_early_hints(links) end
+
+      def base_url
+        'https://example.com'
+      end
+    end.new
+  end
+
+  def test_asset_pack_path
+    assert_equal '/packs/bootstrap-300631c4f0e0f9c865bc.js', asset_pack_path('bootstrap.js')
+    assert_equal '/packs/bootstrap-c38deda30895059837cf.css', asset_pack_path('bootstrap.css')
+  end
+
+  def test_asset_pack_url
+    assert_equal 'https://example.com/packs/bootstrap-300631c4f0e0f9c865bc.js', asset_pack_url('bootstrap.js')
+    assert_equal 'https://example.com/packs/bootstrap-c38deda30895059837cf.css', asset_pack_url('bootstrap.css')
+  end
+
+  def test_image_pack_path
+    assert_equal '/packs/application-k344a6d59eef8632c9d1.png', image_pack_path('application.png')
+    assert_equal '/packs/media/images/image-c38deda30895059837cf.jpg', image_pack_path('image.jpg')
+    assert_equal '/packs/media/images/image-c38deda30895059837cf.jpg', image_pack_path('media/images/image.jpg')
+    assert_equal '/packs/media/images/nested/image-c38deda30895059837cf.jpg', image_pack_path('nested/image.jpg')
+    assert_equal '/packs/media/images/nested/image-c38deda30895059837cf.jpg', image_pack_path('media/images/nested/image.jpg')
+  end
+
+  def test_image_pack_url
+    assert_equal 'https://example.com/packs/application-k344a6d59eef8632c9d1.png', image_pack_url('application.png')
+    assert_equal 'https://example.com/packs/media/images/image-c38deda30895059837cf.jpg', image_pack_url('image.jpg')
+    assert_equal 'https://example.com/packs/media/images/image-c38deda30895059837cf.jpg', image_pack_url('media/images/image.jpg')
+    assert_equal 'https://example.com/packs/media/images/nested/image-c38deda30895059837cf.jpg', image_pack_url('nested/image.jpg')
+    assert_equal 'https://example.com/packs/media/images/nested/image-c38deda30895059837cf.jpg', image_pack_url('media/images/nested/image.jpg')
+  end
+
+  def test_image_pack_tag
+    assert_equal \
+      '<img alt="Edit Entry" src="/packs/application-k344a6d59eef8632c9d1.png" width="16" height="10" />',
+      image_pack_tag('application.png', size: '16x10', alt: 'Edit Entry')
+    assert_equal \
+      '<img alt="Edit Entry" src="/packs/media/images/image-c38deda30895059837cf.jpg" width="16" height="10" />',
+      image_pack_tag('image.jpg', size: '16x10', alt: 'Edit Entry')
+    assert_equal \
+      '<img alt="Edit Entry" src="/packs/media/images/image-c38deda30895059837cf.jpg" width="16" height="10" />',
+      image_pack_tag('media/images/image.jpg', size: '16x10', alt: 'Edit Entry')
+    assert_equal \
+      '<img alt="Edit Entry" src="/packs/media/images/nested/image-c38deda30895059837cf.jpg" width="16" height="10" />',
+      image_pack_tag('nested/image.jpg', size: '16x10', alt: 'Edit Entry')
+    assert_equal \
+      '<img alt="Edit Entry" src="/packs/media/images/nested/image-c38deda30895059837cf.jpg" width="16" height="10" />',
+      image_pack_tag('media/images/nested/image.jpg', size: '16x10', alt: 'Edit Entry')
+    assert_equal \
+      '<img srcset="/packs/media/images/image-2x-7cca48e6cae66ec07b8e.jpg 2x" src="/packs/media/images/image-c38deda30895059837cf.jpg" />',
+      image_pack_tag('media/images/image.jpg', srcset: { 'media/images/image-2x.jpg' => '2x' })
+  end
+
+  def test_favicon_pack_tag
+    assert_equal \
+      '<link rel="apple-touch-icon" type="image/png" href="/packs/application-k344a6d59eef8632c9d1.png" />',
+      favicon_pack_tag('application.png', rel: 'apple-touch-icon', type: 'image/png')
+    assert_equal \
+      '<link rel="apple-touch-icon" type="image/png" href="/packs/media/images/mb-icon-c38deda30895059837cf.png" />',
+      favicon_pack_tag('mb-icon.png', rel: 'apple-touch-icon', type: 'image/png')
+    assert_equal \
+      '<link rel="apple-touch-icon" type="image/png" href="/packs/media/images/mb-icon-c38deda30895059837cf.png" />',
+      favicon_pack_tag('media/images/mb-icon.png', rel: 'apple-touch-icon', type: 'image/png')
+    assert_equal \
+      '<link rel="apple-touch-icon" type="image/png" href="/packs/media/images/nested/mb-icon-c38deda30895059837cf.png" />',
+      favicon_pack_tag('nested/mb-icon.png', rel: 'apple-touch-icon', type: 'image/png')
+    assert_equal \
+      '<link rel="apple-touch-icon" type="image/png" href="/packs/media/images/nested/mb-icon-c38deda30895059837cf.png" />',
+      favicon_pack_tag('media/images/nested/mb-icon.png', rel: 'apple-touch-icon', type: 'image/png')
+  end
+
+  def test_javascript_pack_tag
+    assert_equal \
+      %(<script src="/packs/bootstrap-300631c4f0e0f9c865bc.js"></script>),
+      javascript_pack_tag('bootstrap.js')
+  end
+
+  def test_javascript_pack_tag_symbol
+    assert_equal \
+      %(<script src="/packs/bootstrap-300631c4f0e0f9c865bc.js"></script>),
+      javascript_pack_tag(:bootstrap)
+  end
+
+  def test_javascript_pack_tag_splat
+    assert_equal \
+      %(<script src="/packs/bootstrap-300631c4f0e0f9c865bc.js" defer="defer"></script>\n) +
+      %(<script src="/packs/application-k344a6d59eef8632c9d1.js" defer="defer"></script>),
+      javascript_pack_tag('bootstrap.js', 'application.js', defer: true)
+  end
+
+  def test_javascript_pack_tag_split_chunks
+    assert_equal \
+      %(<script src="/packs/vendors~application~bootstrap-c20632e7baf2c81200d3.chunk.js"></script>\n) +
+      %(<script src="/packs/vendors~application-e55f2aae30c07fb6d82a.chunk.js"></script>\n) +
+      %(<script src="/packs/application-k344a6d59eef8632c9d1.js"></script>),
+      javascript_packs_with_chunks_tag('application')
+  end
+
+  def test_stylesheet_pack_tag_split_chunks
+    assert_equal \
+      %(<link rel="stylesheet" media="screen" href="/packs/1-c20632e7baf2c81200d3.chunk.css" />\n) +
+      %(<link rel="stylesheet" media="screen" href="/packs/application-k344a6d59eef8632c9d1.chunk.css" />\n) +
+      %(<link rel="stylesheet" media="screen" href="/packs/hello_stimulus-k344a6d59eef8632c9d1.chunk.css" />),
+      stylesheet_packs_with_chunks_tag('application', 'hello_stimulus')
+  end
+
+  def test_stylesheet_pack_tag
+    assert_equal \
+      %(<link rel="stylesheet" media="screen" href="/packs/bootstrap-c38deda30895059837cf.css" />),
+      stylesheet_pack_tag('bootstrap.css')
+  end
+
+  def test_stylesheet_pack_tag_symbol
+    assert_equal \
+      %(<link rel="stylesheet" media="screen" href="/packs/bootstrap-c38deda30895059837cf.css" />),
+      stylesheet_pack_tag(:bootstrap)
+  end
+
+  def test_stylesheet_pack_tag_splat
+    assert_equal \
+      %(<link rel="stylesheet" media="all" href="/packs/bootstrap-c38deda30895059837cf.css" />\n) +
+      %(<link rel="stylesheet" media="all" href="/packs/application-dd6b1cd38bfa093df600.css" />),
+      stylesheet_pack_tag('bootstrap.css', 'application.css', media: 'all')
+  end
+end