vite_ruby 1.0.0

data/lib/vite_ruby/dev_server_proxy.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'rack/proxy'
+
+# Public: Allows to relay asset requests to the Vite development server.
+class ViteRuby::DevServerProxy < Rack::Proxy
+  HOST_WITH_PORT_REGEX = %r{^(.+?)(:\d+)/}
+  VITE_DEPENDENCY_PREFIX = '/@'
+
+  def initialize(app = nil, options = {})
+    @vite_ruby = options.delete(:vite_ruby) || ViteRuby.instance
+    options[:streaming] = false if ViteRuby.mode == 'test' && !options.key?(:streaming)
+    super
+  end
+
+  # Rack: Intercept asset requests and send them to the Vite server.
+  def perform_request(env)
+    if vite_should_handle?(env) && dev_server_running?
+      forward_to_vite_dev_server(env)
+      super(env)
+    else
+      @app.call(env)
+    end
+  end
+
+private
+
+  extend Forwardable
+
+  def_delegators :@vite_ruby, :config, :dev_server_running?
+
+  def rewrite_uri_for_vite(env)
+    uri = env.fetch('REQUEST_URI') { [env['PATH_INFO'], env['QUERY_STRING']].reject { |str| str.to_s.strip.empty? }.join('?') }
+      .sub(vite_asset_url_prefix, '/')
+      .sub(HOST_WITH_PORT_REGEX, '/') # Hanami adds the host and port.
+      .sub('.ts.js', '.ts') # Hanami's javascript helper always adds the extension.
+    env['PATH_INFO'], env['QUERY_STRING'] = (env['REQUEST_URI'] = uri).split('?')
+  end
+
+  def forward_to_vite_dev_server(env)
+    rewrite_uri_for_vite(env)
+    env['HTTP_HOST'] = env['HTTP_X_FORWARDED_HOST'] = config.host
+    env['HTTP_X_FORWARDED_SERVER'] = config.host_with_port
+    env['HTTP_PORT'] = env['HTTP_X_FORWARDED_PORT'] = config.port.to_s
+    env['HTTP_X_FORWARDED_PROTO'] = env['HTTP_X_FORWARDED_SCHEME'] = config.protocol
+    env['HTTPS'] = env['HTTP_X_FORWARDED_SSL'] = 'off' unless config.https
+    env['SCRIPT_NAME'] = ''
+  end
+
+  def vite_should_handle?(env)
+    path, query, referer = env['PATH_INFO'], env['QUERY_STRING'], env['HTTP_REFERER']
+    return true if path.start_with?(vite_asset_url_prefix) # Vite asset
+    return true if path.start_with?(VITE_DEPENDENCY_PREFIX) # Packages and imports
+    return true if query&.start_with?('t=') # Hot Reload for a stylesheet
+    return true if query&.start_with?('import&') # Hot Reload for an imported entrypoint
+    return true if referer && URI.parse(referer).path.start_with?(vite_asset_url_prefix) # Entry imported from another entry.
+  end
+
+  def vite_asset_url_prefix
+    @vite_asset_url_prefix ||= "/#{ config.public_output_dir }/"
+  end
+end

data/lib/vite_ruby/manifest.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+# Public: Registry for accessing resources managed by Vite, using a generated
+# manifest file which maps entrypoint names to file paths.
+#
+# Example:
+#   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
+# on demand as needed, before performing any lookup.
+class ViteRuby::Manifest
+  class MissingEntryError < StandardError
+  end
+
+  def initialize(vite_ruby)
+    @vite_ruby = vite_ruby
+  end
+
+  # Public: Returns the path for the specified Vite entrypoint file.
+  #
+  # Raises an error if the resource could not be found in the manifest.
+  def path_for(name, **options)
+    lookup!(name, **options).fetch('file')
+  end
+
+  # Public: Returns scripts, 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.uniq
+    {
+      scripts: script_paths,
+      imports: imports.map { |entry| entry.fetch('file') }.uniq,
+      stylesheets: dev_server_running? ? [] : (entries + imports).flat_map { |entry| entry['css'] }.compact.uniq,
+    }
+  end
+
+  # Public: Refreshes the cached mappings by reading the updated manifest files.
+  def refresh
+    @manifest = load_manifest
+  end
+
+  # Public: The path from where the browser can download the Vite HMR client.
+  def vite_client_src
+    prefix_vite_asset('@vite/client') if dev_server_running?
+  end
+
+protected
+
+  # Internal: Strict version of lookup.
+  #
+  # Returns a relative path for the asset, or raises an error if not found.
+  def lookup!(*args, **options)
+    lookup(*args, **options) || missing_entry_error(*args, **options)
+  end
+
+  # Internal: Computes the path for a given Vite asset using manifest.json.
+  #
+  # Returns a relative path, or nil if the asset is not found.
+  #
+  # Example:
+  #   manifest.lookup('calendar.js')
+  #   => { "file" => "/vite/assets/calendar-1016838bab065ae1e122.js", "imports" => [] }
+  def lookup(name, type: nil)
+    build if should_build?
+
+    find_manifest_entry(with_file_extension(name, type))
+  end
+
+private
+
+  extend Forwardable
+
+  def_delegators :@vite_ruby, :config, :build, :dev_server_running?
+
+  # NOTE: Auto compilation is convenient when running tests, when the developer
+  # won't focus on the frontend, or when running the Vite server is not desired.
+  def should_build?
+    config.auto_build && !dev_server_running?
+  end
+
+  # Internal: Finds the specified entry in the manifest.
+  def find_manifest_entry(name)
+    if dev_server_running?
+      { 'file' => prefix_vite_asset(name.to_s) }
+    else
+      manifest[name.to_s]
+    end
+  end
+
+  # Internal: The parsed data from manifest.json.
+  #
+  # NOTE: When using build-on-demand in development and testing, the manifest
+  # is reloaded automatically before each lookup, to ensure it's always fresh.
+  def manifest
+    return refresh if config.auto_build
+
+    @manifest ||= load_manifest
+  end
+
+  # Internal: Loads and merges the manifest files, resolving the asset paths.
+  def load_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("/#{ 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['css'] = entry['css'].map { |path| prefix_vite_asset(path) } if entry['css']
+      entry['imports']&.map! { |name| manifest.fetch(name) }
+    end
+  end
+
+  # Internal: Adds a file extension to the file name, unless it already has one.
+  def with_file_extension(name, entry_type)
+    return name unless File.extname(name.to_s).empty?
+
+    extension = extension_for_type(entry_type)
+    extension ? "#{ name }.#{ extension }" : name
+  end
+
+  # 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'
+    else entry_type
+    end
+  end
+
+  # Internal: Raises a detailed message when an entry is missing in the manifest.
+  def missing_entry_error(name, type: nil, **_options)
+    file_name = with_file_extension(name, type)
+    raise ViteRuby::Manifest::MissingEntryError, <<~MSG
+      Vite Ruby can't find #{ file_name } in #{ config.manifest_path } or #{ config.assets_manifest_path }.
+
+      Possible causes:
+      #{ missing_entry_causes.map { |cause| "\t- #{ cause }" }.join("\n") }
+
+      Content in your manifests:
+      #{ JSON.pretty_generate(@manifest) }
+    MSG
+  end
+
+  def missing_entry_causes
+    local = config.auto_build
+    [
+      (dev_server_running? && 'Vite has not yet re-built your latest changes.'),
+      (local && !dev_server_running? && "\"autoBuild\": false in your #{ config.mode } configuration."),
+      (local && !dev_server_running? && 'The Vite development server has crashed or is no longer available.'),
+      'You have misconfigured config/vite.json file.',
+      (!local && 'Assets have not been precompiled'),
+    ].select(&:itself)
+  rescue StandardError
+    []
+  end
+end

data/lib/vite_ruby/runner.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+# Public: Executes Vite commands, providing conveniences for debugging.
+class ViteRuby::Runner
+  # Public: Executes Vite with the specified arguments.
+  def run(argv, **options)
+    $stdout.sync = true
+    detect_unsupported_switches!(argv)
+    execute_command(argv.clone, **options)
+  end
+
+private
+
+  UNSUPPORTED_SWITCHES = %w[--host --port --https --root -r --config -c].freeze
+
+  # Internal: Allows to prevent configuration mistakes by ensuring the Ruby app
+  # and vite-plugin-ruby are using the same configuration for the dev server.
+  def detect_unsupported_switches!(args)
+    return unless (unsupported = UNSUPPORTED_SWITCHES & args).any?
+
+    $stdout.puts "Please set the following switches in your vite.json instead: #{ unsupported }."
+    exit!
+  end
+
+  # Internal: Executes the command with the specified arguments.
+  def execute_command(args, capture: false)
+    if capture
+      Open3.capture3(*command_for(args), chdir: ViteRuby.config.root)
+    else
+      Dir.chdir(ViteRuby.config.root) { Kernel.exec(*command_for(args)) }
+    end
+  end
+
+  # Internal: Returns an Array with the command to run.
+  def command_for(args)
+    [vite_env].tap do |cmd|
+      cmd.append('node', '--inspect-brk') if args.include?('--debug')
+      cmd.append('node', '--trace-deprecation') if args.delete('--trace-deprecation')
+      cmd.append(*vite_executable(cmd))
+      cmd.append(*args)
+      cmd.append('--mode', ViteRuby.mode) unless args.include?('--mode') || args.include?('-m')
+    end
+  end
+
+  # Internal: The environment variables to pass to the command.
+  def vite_env
+    ViteRuby.config.to_env
+  end
+
+  # Internal: Resolves to an executable for Vite.
+  def vite_executable(cmd)
+    npx = cmd.include?('node') ? `which npx`.chomp("\n") : 'npx' rescue 'npx'
+    [npx, 'vite']
+  end
+end

data/lib/vite_ruby/version.rb

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

data/templates/config/vite.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'vite'
+import RubyPlugin from 'vite-plugin-ruby'
+
+export default defineConfig({
+  plugins: [
+    RubyPlugin(),
+  ],
+})

data/templates/config/vite.json

@@ -0,0 +1,15 @@
+{
+  "all": {
+    "sourceCodeDir": "frontend",
+    "watchAdditionalPaths": []
+  },
+  "development": {
+    "autoBuild": true,
+    "publicOutputDir": "vite-dev",
+    "port": 3036
+  },
+  "test": {
+    "autoBuild": true,
+    "publicOutputDir": "vite-test"
+  }
+}

data/templates/entrypoints/application.js

@@ -0,0 +1,8 @@
+// To see this message, follow the instructions for your Ruby framework.
+//
+// When using a plain API, perhaps it's better to generate an HTML entrypoint
+// and link to the scripts and stylesheets, and let Vite transform it.
+console.log('Vite ⚡️ Ruby')
+
+// Example: Import a stylesheet in <sourceCodeDir>/index.css
+// import '~/index.css'

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: vite_ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Máximo Mussini
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-02-10 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.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rack-proxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- maximomussini@gmail.com
+executables:
+- vite
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE.txt
+- README.md
+- default.vite.json
+- exe/vite
+- lib/tasks/vite.rake
+- lib/vite_ruby.rb
+- lib/vite_ruby/builder.rb
+- lib/vite_ruby/cli.rb
+- lib/vite_ruby/cli/build.rb
+- lib/vite_ruby/cli/dev.rb
+- lib/vite_ruby/cli/install.rb
+- lib/vite_ruby/cli/version.rb
+- lib/vite_ruby/commands.rb
+- lib/vite_ruby/config.rb
+- lib/vite_ruby/dev_server_proxy.rb
+- lib/vite_ruby/manifest.rb
+- lib/vite_ruby/runner.rb
+- lib/vite_ruby/version.rb
+- templates/config/vite.config.ts
+- templates/config/vite.json
+- templates/entrypoints/application.js
+homepage: https://github.com/ElMassimo/vite_rails
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/ElMassimo/vite_rails/tree/vite_ruby@1.0.0/vite_ruby
+  changelog_uri: https://github.com/ElMassimo/vite_rails/blob/vite_ruby@1.0.0/vite_ruby/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Use Vite in Ruby and bring joy to your JavaScript experience
+test_files: []