vite_rails 1.0.8 → 2.0.0

data/lib/tasks/vite/binstubs.rake

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-binstubs_template_path = File.expand_path('../../install/binstubs.rb', __dir__).freeze
-bin_path = ENV['BUNDLE_BIN'] || Rails.root.join('bin')
-
-namespace :vite do
-  desc 'Installs Vite binstubs in this application'
-  task :binstubs do |task|
-    prefix = task.name.split(/#|vite:binstubs/).first
-    exec "#{ RbConfig.ruby } #{ bin_path }/rails #{ prefix }app:template LOCATION=#{ binstubs_template_path }"
-  end
-end

data/lib/tasks/vite/build.rake

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-$stdout.sync = true
-
-def enhance_assets_precompile
-  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 'Compile JavaScript packs using vite for production with digests'
-  task build: [:'vite:verify_install', :environment] do
-    ViteRails.with_node_env(ENV.fetch('NODE_ENV', 'production')) do
-      ViteRails.ensure_log_goes_to_stdout do
-        ViteRails.build || exit!
-      end
-    end
-  end
-end
-
-# Compile packs after we've compiled all other assets during precompilation
-skip_vite_precompile = %w[no false n f].include?(ENV['VITE_RUBY_PRECOMPILE'])
-
-unless skip_vite_precompile
-  if Rake::Task.task_defined?('assets:precompile')
-    enhance_assets_precompile
-  else
-    Rake::Task.define_task('assets:precompile' => [:'vite:install_dependencies', :'vite:build'])
-  end
-end

data/lib/tasks/vite/clean.rake

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-$stdout.sync = true
-
-namespace :vite do
-  desc 'Remove old compiled vites'
-  task :clean, [:keep, :age] => [:'vite:verify_install', :environment] do |_, args|
-    ViteRails.ensure_log_goes_to_stdout do
-      ViteRails.clean(keep_up_to: Integer(args.keep || 2), age_in_seconds: Integer(args.age || 3600))
-    end
-  end
-end
-
-skip_vite_clean = %w[no false n f].include?(ENV['VITE_RUBY_PRECOMPILE'])
-
-unless skip_vite_clean
-  # Run clean if the assets:clean is run
-  if Rake::Task.task_defined?('assets:clean')
-    Rake::Task['assets:clean'].enhance do
-      Rake::Task['vite:clean'].invoke
-    end
-  else
-    Rake::Task.define_task('assets:clean' => 'vite:clean')
-  end
-end

data/lib/tasks/vite/clobber.rake

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-namespace :vite do
-  desc 'Remove the vite build output directory'
-  task clobber: [:'vite:verify_install', :environment] do
-    ViteRails.clobber
-    $stdout.puts "Removed vite build output directory #{ ViteRails.config.build_output_dir }"
-  end
-end
-
-skip_vite_clobber = %w[no false n f].include?(ENV['VITE_RUBY_PRECOMPILE'])
-
-unless skip_vite_clobber
-  # Run clobber if the assets:clobber is run
-  if Rake::Task.task_defined?('assets:clobber')
-    Rake::Task['assets:clobber'].enhance do
-      Rake::Task['vite:clobber'].invoke
-    end
-  end
-end

data/lib/tasks/vite/info.rake

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-namespace :vite do
-  desc "Provide information on ViteRails's environment"
-  task :info do
-    Dir.chdir(Rails.root) do
-      $stdout.puts "Ruby: #{ `ruby --version` }"
-      $stdout.puts "Rails: #{ Rails.version }"
-      $stdout.puts "ViteRails: #{ ViteRails::VERSION }"
-      $stdout.puts "Node: #{ `node --version` }"
-      $stdout.puts "Yarn: #{ `yarn --version` }"
-
-      $stdout.puts "\n"
-      $stdout.puts "vite-plugin-ruby: \n#{ `npm list vite-plugin-ruby version` }"
-
-      $stdout.puts "Is bin/vite present?: #{ File.exist? 'bin/vite' }"
-      $stdout.puts "Is bin/yarn present?: #{ File.exist? 'bin/yarn' }"
-    end
-  end
-end

data/lib/tasks/vite/install.rake

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-install_template_path = File.expand_path('../../install/template.rb', __dir__).freeze
-bin_path = ENV['BUNDLE_BIN'] || Rails.root.join('bin')
-
-namespace :vite do
-  desc 'Install ViteRails in this application'
-  task :install do |task|
-    prefix = task.name.split(/#|vite:install/).first
-    exec "#{ RbConfig.ruby } #{ bin_path }/rails #{ prefix }app:template LOCATION=#{ install_template_path }"
-  end
-end

data/lib/tasks/vite/install_dependencies.rake

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-namespace :vite do
-  desc 'Support for older Rails versions. 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
-      system({ 'NODE_ENV' => node_env }, install_command)
-    end
-  end
-end

data/lib/tasks/vite/verify_install.rake

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-namespace :vite do
-  desc 'Verifies if Vite Rails is installed'
-  task :verify_install do
-    unless File.exist?(Rails.root.join('bin/vite'))
-      warn <<~WARN
-        vite binstub not found.
-        Have you run rails vite:install?
-        Make sure the bin directory and bin/vite are not included in .gitignore
-      WARN
-      exit!
-    end
-    unless ViteRails.config.config_path.exist?
-      path = ViteRails.config.config_path.relative_path_from(Pathname.new(pwd)).to_s
-      warn <<~WARN
-        Configuration #{ path } file for vite-plugin-ruby not found.
-        Make sure vite:install has run successfully before running dependent tasks.
-      WARN
-      exit!
-    end
-  end
-end

data/lib/vite_rails/builder.rb

@@ -1,113 +0,0 @@
-# frozen_string_literal: true
-
-require 'open3'
-require 'digest/sha1'
-
-# Public: Keeps track of watched files and triggers builds as needed.
-class ViteRails::Builder
-  def initialize(vite_rails)
-    @vite_rails = vite_rails
-  end
-
-  # Public: Checks if the watched files have changed since the last compilation,
-  # and triggers a Vite build if any files have changed.
-  def build
-    if stale?
-      build_with_vite.tap { record_files_digest }
-    else
-      logger.debug 'Skipping build. Vite assets are already up-to-date ⚡️'
-      true
-    end
-  end
-
-  # Public: Returns true if all the assets built by Vite are up to date.
-  def fresh?
-    previous_files_digest&.== watched_files_digest
-  end
-
-  # Public: Returns true if any of the assets built by Vite is out of date.
-  def stale?
-    !fresh?
-  end
-
-private
-
-  delegate :config, :logger, to: :@vite_rails
-
-  # Internal: Writes a digest of the watched files to disk for future checks.
-  def record_files_digest
-    config.build_cache_dir.mkpath
-    files_digest_path.write(watched_files_digest)
-  end
-
-  # Internal: The path of where a digest of the watched files is stored.
-  def files_digest_path
-    config.build_cache_dir.join("last-compilation-digest-#{ config.mode }")
-  end
-
-  # Internal: Reads a digest of watched files from disk.
-  def previous_files_digest
-    files_digest_path.read if files_digest_path.exist? && config.manifest_path.exist?
-  rescue Errno::ENOENT, Errno::ENOTDIR
-  end
-
-  # Internal: Returns a digest of all the watched files, allowing to detect
-  # changes, and skip Vite builds if no files have changed.
-  def watched_files_digest
-    Dir.chdir File.expand_path(config.root) do
-      files = Dir[*watched_paths].reject { |f| File.directory?(f) }
-      file_ids = files.sort.map { |f| "#{ File.basename(f) }/#{ Digest::SHA1.file(f).hexdigest }" }
-      Digest::SHA1.hexdigest(file_ids.join('/'))
-    end
-  end
-
-  # Public: Initiates a Vite build command to generate assets.
-  #
-  # Returns true if the build is successful, or false if it failed.
-  def build_with_vite
-    logger.info 'Building with Vite ⚡️'
-
-    stdout, stderr, status = Open3.capture3(vite_env,
-      "#{ which_ruby } ./bin/vite build --mode #{ config.mode }", chdir: File.expand_path(config.root))
-
-    if status.success?
-      logger.info "Build with Vite complete: #{ config.build_output_dir }"
-      logger.error(stderr.to_s) unless stderr.empty?
-      logger.info(stdout) unless config.hide_build_console_output
-    else
-      non_empty_streams = [stdout, stderr].delete_if(&:empty?)
-      logger.error "Build with Vite failed:\n#{ non_empty_streams.join("\n\n") }"
-    end
-
-    status.success?
-  end
-
-  # Internal: Used to prefix the bin/vite executable file.
-  def which_ruby
-    bin_vite_path = config.root.join('bin/vite')
-    first_line = File.readlines(bin_vite_path).first.chomp
-    /ruby/.match?(first_line) ? RbConfig.ruby : ''
-  end
-
-  # Internal: Files and directories that should be watched for changes.
-  #
-  # NOTE: You can specify additional ones in vite.json using "watchAdditionalPaths": [...]
-  def watched_paths
-    [
-      *config.watch_additional_paths,
-      "#{ config.source_code_dir }/**/*",
-      'yarn.lock',
-      'package.json',
-      config.config_path,
-    ].freeze
-  end
-
-  # Internal: Sets additional environment variables for vite-plugin-ruby.
-  def vite_env
-    ViteRails.env.merge(
-      "#{ ViteRails::ENV_PREFIX }_CONFIG_PATH" => config.config_path,
-      "#{ ViteRails::ENV_PREFIX }_MODE" => config.mode,
-      "#{ ViteRails::ENV_PREFIX }_ROOT" => config.root,
-    ).transform_values(&:to_s)
-  end
-end

data/lib/vite_rails/commands.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-# Public: Encapsulates common tasks, available both programatically and in Rake.
-class ViteRails::Commands
-  def initialize(vite_rails)
-    @vite_rails = vite_rails
-  end
-
-  # Public: Loads the manifest with all the entries compiled by Vite.
-  def bootstrap
-    manifest.refresh
-  end
-
-  # Public: Builds all assets that are managed by Vite, from the entrypoints.
-  def build
-    builder.build.tap { manifest.refresh }
-  end
-
-  # Public: Removes all build cache and previously compiled assets.
-  def clobber
-    config.build_output_dir.rmtree if config.build_output_dir.exist?
-    config.build_cache_dir.rmtree if config.build_cache_dir.exist?
-  end
-
-  # Public: Cleanup old assets in the output directory.
-  #
-  # keep_up_to - Max amount of backups to preserve.
-  # age_in_seconds - Amount of time to look back in order to preserve them.
-  #
-  # NOTE: By default keeps the last version, or 2 if created in the past hour.
-  #
-  # Examples:
-  #   To force only 1 backup to be kept: clean(1, 0)
-  #   To only keep files created within the last 10 minutes: clean(0, 600)
-  def clean(keep_up_to: 2, age_in_seconds: 3600)
-    return false unless config.build_output_dir.exist? && config.manifest_path.exist?
-
-    versions.sort.reverse
-      .each_with_index
-      .drop_while { |(mtime, _), index|
-        max_age = [0, Time.now - Time.at(mtime)].max
-        max_age < age_in_seconds || index < keep_up_to
-      }
-      .each do |(_, files), _index|
-        files.each do |file|
-          next unless File.file?(file)
-
-          File.delete(file)
-          logger.info("Removed #{ file }")
-        end
-      end
-    true
-  end
-
-private
-
-  delegate :config, :builder, :manifest, :logger, to: :@vite_rails
-
-  def versions
-    all_files = Dir.glob("#{ config.build_output_dir }/**/*")
-    entries = all_files - [config.manifest_path] - current_version_files
-    entries.reject { |file| File.directory?(file) }.group_by { |file| File.mtime(file).utc.to_i }
-  end
-
-  def current_version_files
-    Dir.glob(manifest.refresh.values.map { |value| config.build_output_dir.join("#{ value['file'] }*") })
-  end
-end

data/lib/vite_rails/dev_server.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-# Public: Allows to verify if a Vite development server is already running.
-class ViteRails::DevServer
-  # Public: Configure dev server connection timeout (in seconds).
-  # Example:
-  #   ViteRails.dev_server.connect_timeout = 1
-  cattr_accessor(:connect_timeout) { 0.01 }
-
-  def initialize(config)
-    @config = config
-  end
-
-  # Public: Returns true if the Vite development server is reachable.
-  def running?
-    Socket.tcp(host, port, connect_timeout: connect_timeout).close
-    true
-  rescue StandardError
-    false
-  end
-
-  delegate :host, :port, to: :@config
-end

data/lib/vite_rails/dev_server_proxy.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require 'rack/proxy'
-
-# Public: Allows to relay asset requests to the Vite development server.
-class ViteRails::DevServerProxy < Rack::Proxy
-  VITE_DEPENDENCY_PREFIX = '/@'
-
-  def initialize(app = nil, options = {})
-    @vite_rails = options.delete(:vite_rails) || ViteRails.instance
-    options[:streaming] = false if Rails.env.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['REQUEST_URI'], env['HTTP_REFERER']) && dev_server.running?
-      env['REQUEST_URI'] = env['REQUEST_URI']
-        .sub(vite_asset_url_prefix, '/')
-        .sub('.ts.js', '.ts') # Patch: Rails helpers always append the extension.
-      env['PATH_INFO'], env['QUERY_STRING'] = env['REQUEST_URI'].split('?')
-
-      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'] = ''
-      super(env)
-    else
-      @app.call(env)
-    end
-  end
-
-private
-
-  delegate :config, :dev_server, to: :@vite_rails
-
-  def vite_should_handle?(url, referer)
-    return true if url.start_with?(vite_asset_url_prefix) # Vite Asset
-    return true if url.start_with?(VITE_DEPENDENCY_PREFIX) # Vite Package Asset
-    return true if url.include?('?t=') # Hot Reload
-    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_rails/helper.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-# Public: Allows to render HTML tags for scripts and styles processed by Vite.
-module ViteRails::Helper
-  DEFAULT_VITE_SKIP_PRELOAD_TAGS = Rails::VERSION::MAJOR <= 5 && Rails::VERSION::MINOR < 2
-
-  # Public: Returns the current Vite Rails instance.
-  def current_vite_instance
-    ViteRails.instance
-  end
-
-  # 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?
-  end
-
-  # Public: Computes the relative path for the specified given Vite asset.
-  #
-  # Example:
-  #   <%= vite_asset_path 'calendar.css' %> # => "/vite/assets/calendar-1016838bab065ae1e122.css"
-  def vite_asset_path(name, **options)
-    current_vite_instance.manifest.lookup!(name, **options).fetch('file')
-  end
-
-  # Public: Renders a <script> tag for the specified Vite entrypoints.
-  def vite_javascript_tag(*names,
-                          type: 'module',
-                          asset_type: :javascript,
-                          skip_preload_tags: DEFAULT_VITE_SKIP_PRELOAD_TAGS,
-                          skip_style_tags: false,
-                          crossorigin: 'anonymous',
-                          **options)
-    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'] }, type: type, crossorigin: crossorigin, **options)
-
-    unless skip_preload_tags || ViteRails.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?
-      style_paths = names.map { |name| current_vite_instance.manifest.lookup(name, type: :stylesheet)&.fetch('file') }.compact
-      style_tags = stylesheet_link_tag(*style_paths)
-    end
-
-    safe_join [js_tags, preload_tags, style_tags]
-  end
-
-  # Public: Renders a <script> tag for the specified Vite entrypoints.
-  #
-  # NOTE: Because TypeScript is not a valid target in browsers, we only specify
-  # the ts file when running the Vite development server.
-  def vite_typescript_tag(*names, **options)
-    vite_javascript_tag(*names, asset_type: :typescript, **options)
-  end
-
-  # Public: Renders a <link> tag for the specified Vite entrypoints.
-  def vite_stylesheet_tag(*names, **options)
-    stylesheet_link_tag(*sources_from_vite_manifest(names, type: :stylesheet), **options)
-  end
-
-private
-
-  def sources_from_vite_manifest(names, type:)
-    names.map { |name| vite_asset_path(name, type: type) }
-  end
-end