vite_rails 1.0.10 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de1ef14e664eb5f06527b1126e5508598d50289c855edbf27d6e373f6ba805e1
-  data.tar.gz: 6754500ef38d0dcaba0e7d89de42da5b6f51fff79e215d9a4b02f116a332e13d
+  metadata.gz: 9c6ae06bd2fe02d39882813646c291aa1984bf6f4bfbd337859c8527f83cdd66
+  data.tar.gz: 932af2eeadf8830685a6f1d30431849b1e46227147f34a11b286824d3ce80cf7
 SHA512:
-  metadata.gz: 3207af12e9a3304b12da3f549c4ae1fe2610bb9a5511f164040b8a7e82e2324b472ebbc90163142db6fa06a5752acac2f38fb0c6ecefed0690ae6f8c2981702f
-  data.tar.gz: c84109e20d0ba02b594de5e99922abeee23cc69146b955816c29aed23a1b65cc1db7e6e39eae67458fb8ceb74b38784e22fad5ac98f6c209f5697e46e0bca9ac
+  metadata.gz: 67f388f8c74bd39ee14f9d8033941a7616400f9e725a1c2cec7f459f9faa06457dcb113648d9bdb672b5497093f3905bddc13928b834c91f43cef08a58de0e65
+  data.tar.gz: fba446503a41accc9bd4a769042858789615b2095171d6c138c0f2aaf0471ce741da98d9aa058fabc1ee92e2f667b8c19bcab48980ea4288d4b4400b53d94f15

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Vite Rails 1.0.11  (2020-01-24)
+
+- Fix bug in `assetHost` that caused `base` to be configured incorrectly.
+- Allow installing `vite` and `vite-plugin-ruby` as devDependencies, and install them when precompiling assets.
+- Move `base` to the configuration root after Vite's update in beta.38
+
 ## Vite Rails 1.0.10  (2020-01-23)
 
 - Use `path_to_asset` in `vite_asset_path` so that it's prefixed automatically

data/README.md

@@ -1,5 +1,16 @@
 <h1 align="center">
-  Vite ⚡️ Rails
+  <a href="https://vite-rails.netlify.app/">
+    <img src="https://raw.githubusercontent.com/ElMassimo/vite_rails/main/docs/public/logo.svg" width="120px"/>
+  </a>
+
+  <br>
+
+  <a href="https://vite-rails.netlify.app/">
+    Vite Rails
+  </a>
+
+  <br>
+  
   <p align="center">
     <a href="https://github.com/ElMassimo/vite_rails/actions">
       <img alt="Build Status" src="https://github.com/ElMassimo/vite_rails/workflows/build/badge.svg"/>

data/lib/install/config/vite.config.ts

@@ -6,6 +6,6 @@ export default defineConfig({
     RubyPlugin(),
   ],
   optimizeDeps: {
-    exclude: [/webpack/, /vite-plugin-ruby/],
+    exclude: [/webpack/], // In case webpacker is installed (these deps won't be imported)
   },
 })

data/lib/install/template.rb

@@ -33,8 +33,8 @@ Dir.chdir(Rails.root) do
   vite_version = package_json.match(/"vite": "(.*)"/)[1]
   plugin_version = package_json.match(/"vite-plugin-ruby": "(.*)"/)[1]
 
-  say 'Installing vite as direct dependencies'
-  run "yarn add vite@#{ vite_version } vite-plugin-ruby@#{ plugin_version }"
+  say 'Installing vite as build dependencies'
+  run "yarn add -D vite@#{ vite_version } vite-plugin-ruby@#{ plugin_version }"
 end
 
 say 'Vite ⚡️ Rails successfully installed! 🎉', :green

data/lib/tasks/vite/build.rake

@@ -3,14 +3,24 @@
 $stdout.sync = true
 
 def enhance_assets_precompile
+  # Before installing
+  ['yarn:install', 'webpacker:yarn_install'].each do |name|
+    Rake::Task[name].enhance([:'vite:set_node_env']) if Rake::Task.task_defined?(name)
+  end
+
+  # After precompiling
   Rake::Task['assets:precompile'].enhance do |task|
     prefix = task.name.split(/#|assets:precompile/).first
-
     Rake::Task["#{ prefix }vite:build"].invoke
   end
 end
 
 namespace :vite do
+  desc 'Fixes Rails management of node dev dependencies (build dependencies)'
+  task :set_node_env do
+    ENV['NODE_ENV'] = 'development'
+  end
+
   desc 'Compile JavaScript packs using vite for production with digests'
   task build: [:'vite:verify_install', :environment] do
     ViteRails.build_from_rake

data/lib/tasks/vite/install_dependencies.rake

@@ -1,19 +1,13 @@
 # frozen_string_literal: true
 
 namespace :vite do
-  desc 'Support for older Rails versions. Install all JavaScript dependencies as specified via Yarn'
+  desc 'Install all JavaScript dependencies as specified via Yarn'
   task :install_dependencies do
     valid_node_envs = %w[test development production]
     node_env = ENV.fetch('NODE_ENV') { valid_node_envs.include?(Rails.env) ? Rails.env : 'production' }
     Dir.chdir(Rails.root) do
-      install_command = if Rails.root.join('yarn.lock').exist?
-        v1 = `yarn --version`.start_with?('1')
-        "yarn install #{ v1 ? '--no-progress --frozen-lockfile' : '--immutable' }"
-      elsif Rails.root.join('pnpm-lock.yaml').exist?
-        'pnpm install'
-      else
-        'npm ci'
-      end
+      v1 = `yarn --version`.start_with?('1')
+      install_command = "yarn install #{ v1 ? '--no-progress --frozen-lockfile' : '--immutable' } --production=false"
       system({ 'NODE_ENV' => node_env }, install_command)
     end
   end

data/lib/vite_rails.rb

@@ -14,7 +14,7 @@ class ViteRails
   ENV_PREFIX = 'VITE_RUBY'
 
   class << self
-    delegate :config, :builder, :manifest, :commands, :dev_server, :dev_server_running?, to: :instance
+    delegate :config, :builder, :manifest, :commands, :dev_server, :dev_server_running?, :run_proxy?, to: :instance
     delegate :mode, to: :config
     delegate :bootstrap, :clean, :clean_from_rake, :clobber, :build, :build_from_rake, to: :commands
 
@@ -29,14 +29,6 @@ class ViteRails
       ViteRails::Runner.new(args).run
     end
 
-    # Public: The proxy for assets should only run in development mode.
-    def run_proxy?
-      config.mode == 'development'
-    rescue StandardError => error
-      logger.error("Failed to check mode for Vite: #{ error.message }")
-      false
-    end
-
     # Internal: Allows to obtain any env variables for configuration options.
     def load_env_variables
       ENV.select { |key, _| key.start_with?(ENV_PREFIX) }
@@ -53,7 +45,15 @@ class ViteRails
 
   # Public: Returns true if the Vite development server is running.
   def dev_server_running?
-    ViteRails.run_proxy? && dev_server.running?
+    run_proxy? && dev_server.running?
+  end
+
+  # Public: The proxy for assets should only run in development mode.
+  def run_proxy?
+    config.mode == 'development'
+  rescue StandardError => error
+    ViteRails.logger.error("Failed to check mode for Vite: #{ error.message }")
+    false
   end
 
   # Public: Current instance configuration for Vite.

data/lib/vite_rails/config.rb

@@ -55,7 +55,7 @@ private
   def coerce_values(config)
     config['mode'] = config['mode'].to_s
     config['port'] = config['port'].to_i
-    coerce_paths(config, 'root', 'public_output_dir')
+    config['root'] = Pathname.new(config['root'])
     config['build_cache_dir'] = config['root'].join(config['build_cache_dir'])
     coerce_booleans(config, 'auto_build', 'hide_build_console_output', 'https')
   end
@@ -65,14 +65,9 @@ private
     names.each { |name| config[name] = [true, 'true'].include?(config[name]) }
   end
 
-  # Internal: Converts configuration options to pathname.
-  def coerce_paths(config, *names)
-    names.each { |name| config[name] = Pathname.new(config[name]) unless config[name].nil? }
-  end
-
   class << self
     # Public: Returns the project configuration for Vite.
-    def resolve_config(attrs = {})
+    def resolve_config(**attrs)
       config = attrs.transform_keys(&:to_s).reverse_merge(config_defaults)
       file_path = File.join(config['root'], config['config_path'])
       file_config = config_from_file(file_path, mode: config['mode'])

data/lib/vite_rails/helper.rb

@@ -11,7 +11,9 @@ module ViteRails::Helper
 
   # Public: Renders a script tag for vite/client to enable HMR in development.
   def vite_client_tag
-    content_tag('script', '', src: '/@vite/client', type: 'module') if ViteRails.dev_server_running?
+    return unless current_vite_instance.dev_server_running?
+
+    content_tag('script', '', src: current_vite_instance.manifest.prefix_vite_asset('@vite/client'), type: 'module')
   end
 
   # Public: Resolves the path for the specified Vite asset.
@@ -33,12 +35,12 @@ module ViteRails::Helper
     js_entries = names.map { |name| current_vite_instance.manifest.lookup!(name, type: asset_type) }
     js_tags = javascript_include_tag(*js_entries.map { |entry| entry['file'] }, crossorigin: crossorigin, type: type, **options)
 
-    unless skip_preload_tags || ViteRails.dev_server_running?
+    unless skip_preload_tags || current_vite_instance.dev_server_running?
       preload_paths = js_entries.flat_map { |entry| entry['imports'] }.compact.uniq
       preload_tags = preload_paths.map { |path| preload_link_tag(path, crossorigin: crossorigin) }
     end
 
-    unless skip_style_tags || ViteRails.dev_server_running?
+    unless skip_style_tags || current_vite_instance.dev_server_running?
       style_paths = names.map { |name|
         current_vite_instance.manifest.lookup(name.delete_suffix('.js'), type: :stylesheet)&.fetch('file')
       }.compact

data/lib/vite_rails/manifest.rb

@@ -42,6 +42,11 @@ class ViteRails::Manifest
     @manifest = load_manifest
   end
 
+  # Public: Scopes an asset to the output folder in public, as a path.
+  def prefix_vite_asset(path)
+    File.join("/#{ config.public_output_dir }", path)
+  end
+
 private
 
   delegate :config, :builder, :dev_server_running?, to: :@vite_rails
@@ -55,7 +60,7 @@ private
   # Internal: Finds the specified entry in the manifest.
   def find_manifest_entry(name)
     if dev_server_running?
-      { 'file' => "/#{ config.public_output_dir.join(name.to_s) }" }
+      { 'file' => prefix_vite_asset(name.to_s) }
     else
       manifest[name.to_s]
     end
@@ -80,8 +85,8 @@ private
   def load_manifest
     if config.manifest_path.exist?
       JSON.parse(config.manifest_path.read).each do |_, entry|
-        entry['file'] = within_public_output_dir(entry['file'])
-        entry['imports'] = entry['imports']&.map { |path| within_public_output_dir(path) }
+        entry['file'] = prefix_vite_asset(entry['file'])
+        entry['imports'] = entry['imports']&.map { |path| prefix_vite_asset(path) }
       end
     else
       {}
@@ -96,11 +101,6 @@ private
     extension ? "#{ name }.#{ extension }" : name
   end
 
-  # Internal: Scopes the paths in the manifest to the output folder in public.
-  def within_public_output_dir(path)
-    "/#{ config.public_output_dir.join(path) }"
-  end
-
   # Internal: Allows to receive :javascript and :stylesheet as :type in helpers.
   def extension_for_type(entry_type)
     case entry_type

data/lib/vite_rails/version.rb

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

data/package.json

@@ -1,16 +1,19 @@
 {
   "name": "only-for-workflows",
   "version": "unknown",
+  "license": "MIT",
   "scripts": {
     "docs": "npm -C docs run docs",
     "docs:build": "npm -C docs run docs:build",
     "docs:search": "npm -C docs run docs:search",
     "docs:lint": "npm -C docs run lint",
+    "build": "rm -rf package/dist && npm -C package run prerelease",
+    "release": "rm -rf package/dist && npm -C package run release",
     "lint": "npm -C package run lint",
     "test": "npm -C package run test"
   },
   "dependencies": {
-    "vite": "^2.0.0-beta.34",
-    "vite-plugin-ruby": "^1.0.4"
+    "vite": "^2.0.0-beta.46",
+    "vite-plugin-ruby": "^1.0.5"
   }
 }

data/test/config_test.rb

@@ -120,7 +120,7 @@ class ConfigTest < ViteRails::Test
     assert_equal 'config/vite_additional_paths.json', @config.config_path
     assert_pathname 'tmp/vitebuild', @config.build_cache_dir
     assert_equal 'pb', @config.public_dir
-    assert_equal Pathname.new('ft'), @config.public_output_dir
+    assert_equal 'ft', @config.public_output_dir
     assert_pathname 'pb/ft', @config.build_output_dir
     assert_equal 'as', @config.assets_dir
     assert_equal 'app', @config.source_code_dir

data/test/dev_server_proxy_test.rb

@@ -11,6 +11,7 @@ class DevServerProxyTest < ViteRails::Test
       [200, { 'Content-Type' => 'application/json' }, env.to_json]
     })
     # Avoid actually using the proxy.
+    Rack::Proxy.remove_method(:perform_request)
     Rack::Proxy.define_method(:perform_request) { |env| capture_app.call(env) }
 
     ViteRails::DevServerProxy.new(capture_app)

data/test/engine_rake_tasks_test.rb

@@ -38,13 +38,13 @@ class EngineRakeTasksTest < Minitest::Test
     within_mounted_app { `bundle exec rake app:vite:clobber` }
     refute app_public_dir.exist?
   rescue Minitest::Assertion => error
-    raise error unless Rails.gem_version >= Gem::Version.new('6.1.0')
+    raise error, [error.message, @command_results.join("\n\n")].join("\n")
   end
 
 private
 
   def within_mounted_app
-    Dir.chdir(mounted_app_path) { yield }
+    Dir.chdir(mounted_app_path) { yield }.tap { |result| @command_results << result }
   end
 
   def mounted_app_path
@@ -76,5 +76,6 @@ private
     vite_config_ts_path.delete if vite_config_ts_path.exist?
     app_frontend_dir.rmtree if app_frontend_dir.exist?
     app_public_dir.rmtree if app_public_dir.exist?
+    @command_results = []
   end
 end

data/test/helper_test.rb

@@ -22,7 +22,7 @@ class HelperTest < ActionView::TestCase
   def test_vite_client_tag
     assert_nil vite_client_tag
     with_dev_server_running {
-      assert_equal '<script src="/@vite/client" type="module"></script>', vite_client_tag
+      assert_equal '<script src="/vite-production/@vite/client" type="module"></script>', vite_client_tag
     }
   end
 

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

@@ -1,8 +1,8 @@
 {
   "private": true,
-  "dependencies": {
-    "vite": "^2.0.0-beta.34",
-    "vite-plugin-ruby": "^1.0.2"
-  },
-  "license": "MIT"
+  "license": "MIT",
+  "devDependencies": {
+    "vite": "^2.0.0-beta.46",
+    "vite-plugin-ruby": "^1.0.5"
+  }
 }

data/test/mounted_app/test/dummy/yarn.lock

@@ -35,7 +35,7 @@ colorette@^1.2.1:
   resolved "https://registry.yarnpkg.com/colorette/-/colorette-1.2.1.tgz#4d0b921325c14faf92633086a536db6e89564b1b"
   integrity sha512-puCDz0CzydiSYOrnXpz/PKd69zRrribezjtE9yd4zvytoRc8+RY/KJPvtPFKZS3E3wP6neGyMe0vOTlHO5L3Pw==
 
-esbuild@^0.8.26:
+esbuild@^0.8.34:
   version "0.8.34"
   resolved "https://registry.yarnpkg.com/esbuild/-/esbuild-0.8.34.tgz#16b4ac58f74c821d2c5a8c2f0585ca96a38ab4e6"
   integrity sha512-tnr0V1ooakYr1aRLXQLzCn2GVG1kBTW3FWpRyC+NgrR3ntsouVpJOlTOV0BS4YLATx3/c+x3h/uBq9lWJlUAtQ==
@@ -188,19 +188,19 @@ to-regex-range@^5.0.1:
   dependencies:
     is-number "^7.0.0"
 
-vite-plugin-ruby@^1.0.2:
-  version "1.0.2"
-  resolved "https://registry.yarnpkg.com/vite-plugin-ruby/-/vite-plugin-ruby-1.0.2.tgz#9c193982c912b6399d9b269136e533201b445fb1"
-  integrity sha512-m+CIyHiZElaW4TpdtyVQXnvLbz5ovYSwo5bTgr/ODLPMgmAqTaZu9GImPkIMZwp8PmBWnHT8h6vUtnIq0yFLOg==
+vite-plugin-ruby@^1.0.4:
+  version "1.0.4"
+  resolved "https://registry.yarnpkg.com/vite-plugin-ruby/-/vite-plugin-ruby-1.0.4.tgz#0f4a263fd79a082a84917a54b0881f02a3bbfa61"
+  integrity sha512-WJE+c2TGLwcbSHzkqcwCmPcHxasUnXmx5Bi1HPO89Yo+Mggi8t/fO/WIPUF7NxSlp9q2lq5/L3Vnkt3R/tolPg==
   dependencies:
     fast-glob "^3.2.4"
 
-vite@^2.0.0-beta.34:
-  version "2.0.0-beta.36"
-  resolved "https://registry.yarnpkg.com/vite/-/vite-2.0.0-beta.36.tgz#ccecac854ded0b7c0fe14c52c0460e1c23a9c70b"
-  integrity sha512-+Q/Twq1/tpNQIZl0HSFTqiEuP7lXj+6H/f9q63+s5I2K/sqgSUajL3PL7W9uUUIv9dYpJ1eLqkO42ppH9w9Ldw==
+vite@^2.0.0-beta.46:
+  version "2.0.0-beta.46"
+  resolved "https://registry.yarnpkg.com/vite/-/vite-2.0.0-beta.46.tgz#9c0d35019c350fbebd17f84c4e7243fffccd1819"
+  integrity sha512-RiiJdjiFDaM9youfcTFnCztstwBXHHSdsSATZVD5A4QSb39KJRTpSKoveFo0PT7VJM5HjOP7QC/sVOqX011F6Q==
   dependencies:
-    esbuild "^0.8.26"
+    esbuild "^0.8.34"
     postcss "^8.2.1"
     resolve "^1.19.0"
     rollup "^2.35.1"

data/test/rake_tasks_test.rb

@@ -38,8 +38,8 @@ class RakeTasksTest < Minitest::Test
       end
     end
 
-    refute_includes installed_node_module_names, 'right-pad',
-                    'Expected only production dependencies to be installed'
+    assert_includes installed_node_module_names, 'right-pad',
+                    'Expected development dependencies to be installed as well'
   end
 
 private

data/test/test_helper.rb

@@ -53,7 +53,7 @@ private
     klass = ViteRails::Runner
     instance = klass.new(argv)
     mock = Minitest::Mock.new
-    mock.expect(:call, nil, [ViteRails.env, *command, *argv, *flags])
+    mock.expect(:call, nil, [ViteRails.config.to_env, *command, *argv, *flags])
 
     klass.stub(:new, instance) do
       instance.stub(:executable_exists?, !use_yarn) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vite_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.0.11
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-23 00:00:00.000000000 Z
+date: 2021-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -185,8 +185,8 @@ homepage: https://github.com/ElMassimo/vite_rails
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/ElMassimo/vite_rails/tree/v1.0.10
-  changelog_uri: https://github.com/ElMassimo/vite_rails/blob/v1.0.10/CHANGELOG.md
+  source_code_uri: https://github.com/ElMassimo/vite_rails/tree/v1.0.11
+  changelog_uri: https://github.com/ElMassimo/vite_rails/blob/v1.0.11/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: