vite_ruby 3.9.1 → 4.0.0.alpha1

data/lib/vite_ruby/manifest.rb

@@ -7,7 +7,7 @@
 #   lookup_entrypoint('calendar', type: :javascript)
 #   => { "file" => "/vite/assets/calendar-1016838bab065ae1e314.js", "imports" => [] }
 #
-# NOTE: Using `"autoBuild": true` in `config/vite.json` file will trigger a build
+# NOTE: Using "autoBuild": true` in `config/vite.json` file will trigger a build
 # on demand as needed, before performing any lookup.
 class ViteRuby::Manifest
   def initialize(vite_ruby)
@@ -19,20 +19,19 @@ class ViteRuby::Manifest
   #
   # Raises an error if the resource could not be found in the manifest.
   def path_for(name, **options)
-    lookup!(name, **options).fetch("file")
+    lookup!(name, **options).fetch('file')
   end
 
-  # Public: Returns scripts, imported modules, and stylesheets for the specified
+  # Public: Returns entries, imported modules, and stylesheets for the specified
   # entrypoint files.
   def resolve_entries(*names, **options)
     entries = names.map { |name| lookup!(name, **options) }
-    script_paths = entries.map { |entry| entry.fetch("file") }
 
-    imports = dev_server_running? ? [] : entries.flat_map { |entry| entry["imports"] }.compact
+    imports = dev_server_running? ? [] : entries.flat_map { |entry| entry['imports'] }.compact.uniq
     {
-      scripts: script_paths,
-      imports: imports.filter_map { |entry| entry.fetch("file") }.uniq,
-      stylesheets: dev_server_running? ? [] : (entries + imports).flat_map { |entry| entry["css"] }.compact.uniq,
+      main: entries.map(&TO_ENTRY),
+      imports: imports.map(&TO_ENTRY).uniq,
+      stylesheets: dev_server_running? ? [] : (entries + imports).flat_map { |entry| entry['css'] }.compact.uniq,
     }
   end
 
@@ -43,7 +42,7 @@ class ViteRuby::Manifest
 
   # Public: The path from where the browser can download the Vite HMR client.
   def vite_client_src
-    prefix_asset_with_host("@vite/client") if dev_server_running?
+    prefix_asset_with_host('@vite/client') if dev_server_running?
   end
 
   # Public: The content of the preamble needed by the React Refresh plugin.
@@ -51,27 +50,21 @@ class ViteRuby::Manifest
     if dev_server_running?
       <<~REACT_REFRESH
         <script type="module">
-          #{react_preamble_code}
+          import RefreshRuntime from '#{ prefix_asset_with_host('@react-refresh') }'
+          RefreshRuntime.injectIntoGlobalHook(window)
+          window.$RefreshReg$ = () => {}
+          window.$RefreshSig$ = () => (type) => type
+          window.__vite_plugin_react_preamble_installed__ = true
         </script>
       REACT_REFRESH
     end
   end
 
-  # Public: Source script for the React Refresh plugin.
-  def react_preamble_code
-    if dev_server_running?
-      <<~REACT_PREAMBLE_CODE
-        import RefreshRuntime from '#{prefix_asset_with_host("@react-refresh")}'
-        RefreshRuntime.injectIntoGlobalHook(window)
-        window.$RefreshReg$ = () => {}
-        window.$RefreshSig$ = () => (type) => type
-        window.__vite_plugin_react_preamble_installed__ = true
-      REACT_PREAMBLE_CODE
-    end
-  end
-
 protected
 
+  # Internal: Returns a [src, attrs] entry.
+  TO_ENTRY = ->(entry) { [entry.fetch('file'), entry.slice('integrity').symbolize_keys] }
+
   # Internal: Strict version of lookup.
   #
   # Returns a relative path for the asset, or raises an error if not found.
@@ -87,7 +80,7 @@ protected
   #   manifest.lookup('calendar.js')
   #   => { "file" => "/vite/assets/calendar-1016838bab065ae1e122.js", "imports" => [] }
   def lookup(name, **options)
-    @build_mutex.synchronize { builder.build || (return nil) } if should_build?
+    @build_mutex.synchronize { builder.build } if should_build?
 
     find_manifest_entry resolve_entry_name(name, **options)
   end
@@ -95,7 +88,7 @@ protected
 private
 
   # Internal: The prefix used by Vite.js to request files with an absolute path.
-  FS_PREFIX = "/@fs/"
+  FS_PREFIX = '/@fs/'
 
   extend Forwardable
 
@@ -110,7 +103,7 @@ private
   # Internal: Finds the specified entry in the manifest.
   def find_manifest_entry(name)
     if dev_server_running?
-      {"file" => prefix_vite_asset(name)}
+      { 'file' => prefix_vite_asset(name) }
     else
       manifest[name]
     end
@@ -128,36 +121,29 @@ private
 
   # Internal: Loads and merges the manifest files, resolving the asset paths.
   def load_manifest
-    config.manifest_paths
-      .map { |path| JSON.parse(path.read) }
-      .inject({}, &:merge)
-      .tap { |manifest| resolve_references(manifest) }
+    files = [config.manifest_path, config.assets_manifest_path].select(&:exist?)
+    files.map { |path| JSON.parse(path.read) }.inject({}, &:merge).tap(&method(:resolve_references))
   end
 
   # Internal: Scopes an asset to the output folder in public, as a path.
   def prefix_vite_asset(path)
-    File.join(vite_asset_origin || "/", config.public_output_dir, path)
+    File.join("/#{ config.public_output_dir }", path)
   end
 
   # Internal: Prefixes an asset with the `asset_host` for tags that do not use
   # the framework tag helpers.
   def prefix_asset_with_host(path)
-    File.join(vite_asset_origin || config.asset_host || "/", config.public_output_dir, path)
-  end
-
-  # Internal: The origin of assets managed by Vite.
-  def vite_asset_origin
-    config.origin if dev_server_running? && config.skip_proxy
+    File.join(config.asset_host || '/', config.public_output_dir, path)
   end
 
   # Internal: Resolves the paths that reference a manifest entry.
   def resolve_references(manifest)
     manifest.each_value do |entry|
-      entry["file"] = prefix_vite_asset(entry["file"])
+      entry['file'] = prefix_vite_asset(entry['file'])
       %w[css assets].each do |key|
         entry[key] = entry[key].map { |path| prefix_vite_asset(path) } if entry[key]
       end
-      entry["imports"]&.map! { |name| manifest.fetch(name) }
+      entry['imports']&.map! { |name| manifest.fetch(name) }
     end
   end
 
@@ -166,7 +152,7 @@ private
     return resolve_virtual_entry(name) if type == :virtual
 
     name = with_file_extension(name.to_s, type)
-    raise ArgumentError, "Asset names can not be relative. Found: #{name}" if name.start_with?(".")
+    raise ArgumentError, "Asset names can not be relative. Found: #{ name }" if name.start_with?('.')
 
     # Explicit path, relative to the source_code_dir.
     name.sub(%r{^~/(.+)$}) { return Regexp.last_match(1) }
@@ -175,7 +161,7 @@ private
     name.sub(%r{^/(.+)$}) { return resolve_absolute_entry(Regexp.last_match(1)) }
 
     # Sugar: Prefix with the entrypoints dir if the path is not nested.
-    name.include?("/") ? name : File.join(config.entrypoints_dir, name)
+    name.include?('/') ? name : File.join(config.entrypoints_dir, name)
   end
 
   # Internal: Entry names in the manifest are relative to the Vite.js.
@@ -196,7 +182,7 @@ private
   # Internal: Adds a file extension to the file name, unless it already has one.
   def with_file_extension(name, entry_type)
     if File.extname(name).empty? && (ext = extension_for_type(entry_type))
-      "#{name}.#{ext}"
+      "#{ name }.#{ ext }"
     else
       name
     end
@@ -205,16 +191,16 @@ private
   # Internal: Allows to receive :javascript and :stylesheet as :type in helpers.
   def extension_for_type(entry_type)
     case entry_type
-    when :javascript then "js"
-    when :stylesheet then "css"
-    when :typescript then "ts"
+    when :javascript then 'js'
+    when :stylesheet then 'css'
+    when :typescript then 'ts'
     else entry_type
     end
   end
 
   # Internal: Raises a detailed message when an entry is missing in the manifest.
   def missing_entry_error(name, **options)
-    raise ViteRuby::MissingEntrypointError.new(
+    raise ViteRuby::MissingEntrypointError, OpenStruct.new(
       file_name: resolve_entry_name(name, **options),
       last_build: builder.last_build_metadata,
       manifest: @manifest,

data/lib/vite_ruby/missing_entrypoint_error.rb

@@ -5,39 +5,31 @@
 # NOTE: The complexity here is justified by the improved usability of providing
 # a more specific error message depending on the situation.
 class ViteRuby::MissingEntrypointError < ViteRuby::Error
-  attr_reader :file_name, :last_build, :manifest, :config
+  extend Forwardable
+  def_delegators :@info, :file_name, :last_build, :manifest, :config
 
-  def initialize(file_name:, last_build:, manifest:, config:)
-    @file_name, @last_build, @manifest, @config = file_name, last_build, manifest, config
+  def initialize(info)
+    @info = info
     super <<~MSG
-      Vite Ruby can't find #{file_name} in the manifests.
+      Vite Ruby can't find #{ file_name } in #{ config.manifest_path.relative_path_from(config.root) } or #{ config.assets_manifest_path.relative_path_from(config.root) }.
 
       Possible causes:
-      #{possible_causes(last_build)}
+      #{ possible_causes(last_build) }
       :troubleshooting:
-      #{"Manifest files found:\n#{config.manifest_paths.map { |path| "  #{path.relative_path_from(config.root)}" }.join("\n")}\n" if last_build.success}
-      #{"Content in your manifests:\n#{JSON.pretty_generate(manifest)}\n" if last_build.success}
-      #{"Last build in #{config.mode} mode:\n#{last_build.to_json}\n" if last_build.success}
+      #{ "\nContent in your manifests:\n#{ JSON.pretty_generate(manifest) }\n" if last_build.success }
+      #{ "Last build in #{ config.mode } mode:\n#{ last_build.to_json }\n" unless last_build.success.nil? }
     MSG
   end
 
   def possible_causes(last_build)
-    if last_build.success == false
-      FAILED_BUILD_CAUSES
-        .sub(":mode:", config.mode)
-        .sub(":errors:", last_build.errors.to_s.gsub(/^(?!$)/, "  "))
-    elsif config.auto_build
-      DEFAULT_CAUSES
-    else
-      DEFAULT_CAUSES + NO_AUTO_BUILD_CAUSES
-    end
-  end
+    return FAILED_BUILD_CAUSES.sub(':mode:', config.mode) if last_build.success == false
+    return DEFAULT_CAUSES if config.auto_build
 
-  FAILED_BUILD_CAUSES = <<~MSG
-      - The last build failed. Try running `bin/vite build --clear --mode=:mode:` manually and check for errors.
+    DEFAULT_CAUSES + NO_AUTO_BUILD_CAUSES
+  end
 
-    Errors:
-    :errors:
+  FAILED_BUILD_CAUSES = <<-MSG
+  - The last build failed. Try running `bin/vite build --clear --mode=:mode:` manually and check for errors.
   MSG
 
   DEFAULT_CAUSES = <<-MSG

data/lib/vite_ruby/missing_executable_error.rb

@@ -7,7 +7,7 @@ class ViteRuby::MissingExecutableError < ViteRuby::Error
       ❌ The vite binary is not available. Have you installed the npm packages?
 
       :troubleshooting:
-      #{error}
+      #{ error }
     MSG
   end
 end

data/lib/vite_ruby/runner.rb

@@ -8,11 +8,11 @@ class ViteRuby::Runner
 
   # Public: Executes Vite with the specified arguments.
   def run(argv, exec: false)
-    config.within_root {
+    Dir.chdir(config.root) {
       cmd = command_for(argv)
       return Kernel.exec(*cmd) if exec
 
-      log_or_noop = ->(line) { logger.info("vite") { line } } unless config.hide_build_console_output
+      log_or_noop = ->(line) { logger.info('vite') { line } } unless config.hide_build_console_output
       ViteRuby::IO.capture(*cmd, chdir: config.root, with_output: log_or_noop)
     }
   rescue Errno::ENOENT => error
@@ -23,31 +23,23 @@ private
 
   extend Forwardable
 
-  def_delegators :@vite_ruby, :config, :logger, :env
+  def_delegators :@vite_ruby, :config, :logger
 
   # Internal: Returns an Array with the command to run.
   def command_for(args)
-    [config.to_env(env)].tap do |cmd|
-      exec_args, vite_args = args.partition { |arg| arg.start_with?("--node-options") }
-      cmd.push(*vite_executable(*exec_args))
-      cmd.push(*vite_args)
-      cmd.push("--mode", config.mode) unless args.include?("--mode") || args.include?("-m")
+    [config.to_env].tap do |cmd|
+      args = args.clone
+      cmd.push('node', '--inspect-brk') if args.delete('--inspect')
+      cmd.push('node', '--trace-deprecation') if args.delete('--trace_deprecation')
+      cmd.push(vite_executable)
+      cmd.push(*args)
+      cmd.push('--mode', config.mode) unless args.include?('--mode') || args.include?('-m')
     end
   end
 
   # Internal: Resolves to an executable for Vite.
-  def vite_executable(*exec_args)
+  def vite_executable
     bin_path = config.vite_bin_path
-    return [bin_path] if bin_path && File.exist?(bin_path)
-
-    x = case config.package_manager
-    when "npm" then %w[npx]
-    when "pnpm" then %w[pnpm exec]
-    when "bun" then %w[bun x --bun]
-    when "yarn" then %w[yarn]
-    else raise ArgumentError, "Unknown package manager #{config.package_manager.inspect}"
-    end
-
-    [*x, *exec_args, "vite"]
+    File.exist?(bin_path) ? bin_path : "#{ `npm bin`.chomp }/vite"
   end
 end

data/lib/vite_ruby/version.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 class ViteRuby
-  VERSION = "3.9.1"
+  VERSION = '4.0.0.alpha1'
 
   # Internal: Versions used by default when running `vite install`.
-  DEFAULT_VITE_VERSION = "^5.0.0"
-  DEFAULT_PLUGIN_VERSION = "^5.1.0"
+  DEFAULT_VITE_VERSION = '^2.7.7'
+  DEFAULT_PLUGIN_VERSION = '^3.0.5'
 end

data/lib/vite_ruby.rb

@@ -1,38 +1,39 @@
 # frozen_string_literal: true
 
-require "logger"
-require "forwardable"
-require "pathname"
-require "socket"
+require 'logger'
+require 'forwardable'
+require 'pathname'
+require 'socket'
 
-require "zeitwerk"
+require 'zeitwerk'
 loader = Zeitwerk::Loader.for_gem
-loader.ignore("#{__dir__}/install")
-loader.ignore("#{__dir__}/tasks")
-loader.ignore("#{__dir__}/exe")
-loader.inflector.inflect("cli" => "CLI")
-loader.inflector.inflect("ssr" => "SSR")
-loader.inflector.inflect("io" => "IO")
+loader.ignore("#{ __dir__ }/install")
+loader.ignore("#{ __dir__ }/tasks")
+loader.ignore("#{ __dir__ }/exe")
+loader.inflector.inflect('cli' => 'CLI')
+loader.inflector.inflect('io' => 'IO')
 loader.setup
 
+require 'vite_ruby/version'
+
 class ViteRuby
   # Internal: Prefix used for environment variables that modify the configuration.
-  ENV_PREFIX = "VITE_RUBY"
+  ENV_PREFIX = 'VITE_RUBY'
 
   # Internal: Companion libraries for Vite Ruby, and their target framework.
   COMPANION_LIBRARIES = {
-    "vite_rails" => "rails",
-    "vite_hanami" => "hanami",
-    "vite_padrino" => "padrino",
-    "jekyll-vite" => "jekyll",
-    "vite_rails_legacy" => "rails",
-    "vite_plugin_legacy" => "rack",
+    'vite_rails' => 'rails',
+    'vite_hanami' => 'hanami',
+    'vite_padrino' => 'padrino',
+    'jekyll-vite' => 'jekyll',
+    'vite_rails_legacy' => 'rails',
+    'vite_plugin_legacy' => 'rack',
   }
 
   class << self
     extend Forwardable
 
-    def_delegators :instance, :config, :configure, :commands, :digest, :env, :run, :run_proxy?
+    def_delegators :instance, :config, :commands, :env, :run, :run_proxy?
     def_delegators :config, :mode
 
     def instance
@@ -46,7 +47,7 @@ class ViteRuby
 
     # Internal: Loads all available rake tasks.
     def install_tasks
-      load File.expand_path("tasks/vite.rake", __dir__)
+      load File.expand_path('tasks/vite.rake', __dir__)
     end
 
     # Internal: Creates a new instance with the specified options.
@@ -57,11 +58,11 @@ class ViteRuby
     # Internal: Detects if the application has installed a framework-specific
     # variant of Vite Ruby.
     def framework_libraries
-      COMPANION_LIBRARIES.filter_map { |name, framework|
+      COMPANION_LIBRARIES.map { |name, framework|
         if library = Gem.loaded_specs[name]
           [framework, library]
         end
-      }
+      }.compact
     end
   end
 
@@ -75,26 +76,17 @@ class ViteRuby
     @logger ||= Logger.new($stdout)
   end
 
-  # Public: Returns a digest of all the watched files, allowing to detect
-  # changes. Useful to perform version checks in single-page applications.
-  def digest
-    builder.send(:watched_files_digest)
-  end
-
   # Public: Returns true if the Vite development server is currently running.
   # NOTE: Checks only once every second since every lookup calls this method.
   def dev_server_running?
     return false unless run_proxy?
-    return @running if defined?(@running) && Time.now - @running_checked_at < 1
-
-    begin
-      Socket.tcp(config.host, config.port, connect_timeout: config.dev_server_connect_timeout).close
-      @running = true
-    rescue
-      @running = false
-    ensure
-      @running_checked_at = Time.now
-    end
+    return true if defined?(@running_at) && @running_at && Time.now - @running_at < 1
+
+    Socket.tcp(config.host, config.port, connect_timeout: config.dev_server_connect_timeout).close
+    @running_at = Time.now
+    true
+  rescue StandardError
+    @running_at = false
   end
 
   # Public: Additional environment variables to pass to Vite.
@@ -107,9 +99,9 @@ class ViteRuby
 
   # Public: The proxy for assets should only run in development mode.
   def run_proxy?
-    config.mode == "development" || (config.mode == "test" && !ENV["CI"])
-  rescue => error
-    logger.error("Failed to check mode for Vite: #{error.message}")
+    config.mode == 'development' || (config.mode == 'test' && !ENV['CI'])
+  rescue StandardError => error
+    logger.error("Failed to check mode for Vite: #{ error.message }")
     false
   end
 
@@ -131,22 +123,15 @@ class ViteRuby
   # Public: Current instance configuration for Vite.
   def config
     unless defined?(@config)
-      configure
+      @config = ViteRuby::Config.resolve_config(**@config_options)
       @config.load_ruby_config
     end
 
     @config
   end
 
-  # Public: Allows overriding the configuration for this instance.
-  def configure(**options)
-    @config = ViteRuby::Config.resolve_config(**@config_options, **options)
-  end
-
   # Public: Enables looking up assets managed by Vite using name and type.
   def manifest
     @manifest ||= ViteRuby::Manifest.new(self)
   end
 end
-
-require "vite_ruby/version"

metadata

@@ -1,63 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: vite_ruby
 version: !ruby/object:Gem::Version
-  version: 3.9.1
+  version: 4.0.0.alpha1
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 2022-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.7'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.7'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: mutex_m
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rack-proxy
   requirement: !ruby/object:Gem::Requirement
@@ -213,7 +179,6 @@ files:
 - lib/vite_ruby/cli/dev.rb
 - lib/vite_ruby/cli/file_utils.rb
 - lib/vite_ruby/cli/install.rb
-- lib/vite_ruby/cli/ssr.rb
 - lib/vite_ruby/cli/upgrade.rb
 - lib/vite_ruby/cli/upgrade_packages.rb
 - lib/vite_ruby/cli/version.rb
@@ -236,9 +201,8 @@ homepage: https://github.com/ElMassimo/vite_ruby
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/ElMassimo/vite_ruby/tree/vite_ruby@3.9.1/vite_ruby
-  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@3.9.1/vite_ruby/CHANGELOG.md
-  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/ElMassimo/vite_ruby/tree/vite_ruby@4.0.0.alpha1/vite_ruby
+  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_ruby@4.0.0.alpha1/vite_ruby/CHANGELOG.md
 post_install_message: "Thanks for installing Vite Ruby!\n\nIf you upgraded the gem
   manually, please run:\n\tbundle exec vite upgrade"
 rdoc_options: []
@@ -248,14 +212,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Use Vite in Ruby and bring joy to your JavaScript experience

data/lib/vite_ruby/cli/ssr.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-class ViteRuby::CLI::SSR < ViteRuby::CLI::Vite
-  DEFAULT_ENV = CURRENT_ENV || "production"
-  JS_EXTENSIONS = %w[js mjs cjs]
-
-  desc "Run the resulting app from building in SSR mode."
-  executable_options
-
-  def call(mode:, inspect: false, trace_deprecation: false)
-    ViteRuby.env["VITE_RUBY_MODE"] = mode
-
-    ssr_entrypoint = JS_EXTENSIONS
-      .map { |ext| ViteRuby.config.ssr_output_dir.join("ssr.#{ext}") }
-      .find(&:exist?)
-
-    raise ArgumentError, "No ssr entrypoint found `#{ViteRuby.config.ssr_output_dir.relative_path_from(ViteRuby.config.root)}/ssr.{#{JS_EXTENSIONS.join(",")}}`. Have you run bin/vite build --ssr?" unless ssr_entrypoint
-
-    cmd = [
-      "node",
-      ("--inspect-brk" if inspect),
-      ("--trace-deprecation" if trace_deprecation),
-      ssr_entrypoint,
-    ]
-    Kernel.exec(*cmd.compact.map(&:to_s))
-  end
-end