vite_ruby-roda 3.9.2.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Maximo Mussini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+<h1 align="center">
+  <a href="https://vite-ruby.netlify.app/">
+    <img src="https://raw.githubusercontent.com/ElMassimo/vite_ruby/main/logo.svg" width="120px"/>
+  </a>
+
+  <br>
+
+  <a href="https://vite-ruby.netlify.app/">
+    Vite Ruby
+  </a>
+
+  <br>
+
+  <p align="center">
+    <a href="https://github.com/ElMassimo/vite_ruby/actions">
+      <img alt="Build Status" src="https://github.com/ElMassimo/vite_ruby/workflows/build/badge.svg"/>
+    </a>
+    <a href="https://codeclimate.com/github/ElMassimo/vite_ruby">
+      <img alt="Maintainability" src="https://codeclimate.com/github/ElMassimo/vite_ruby/badges/gpa.svg"/>
+    </a>
+    <a href="https://codeclimate.com/github/ElMassimo/vite_ruby">
+      <img alt="Test Coverage" src="https://codeclimate.com/github/ElMassimo/vite_ruby/badges/coverage.svg"/>
+    </a>
+    <a href="https://rubygems.org/gems/vite_ruby">
+      <img alt="Gem Version" src="https://img.shields.io/gem/v/vite_ruby.svg?colorB=e9573f"/>
+    </a>
+    <a href="https://github.com/ElMassimo/vite_ruby/blob/master/LICENSE.txt">
+      <img alt="License" src="https://img.shields.io/badge/license-MIT-428F7E.svg"/>
+    </a>
+  </p>
+</h1>
+
+[website]: https://vite-ruby.netlify.app/
+[configuration reference]: https://vite-ruby.netlify.app/config/
+[features]: https://vite-ruby.netlify.app/guide/introduction.html
+[guides]: https://vite-ruby.netlify.app/guide/
+[config]: https://vite-ruby.netlify.app/config/
+[vite_rails]: https://github.com/ElMassimo/vite_ruby
+[webpacker]: https://github.com/rails/webpacker
+[vite]: http://vitejs.dev/
+[config file]: https://github.com/ElMassimo/vite_ruby/blob/main/vite-plugin-ruby/default.vite.json
+[example app]: https://github.com/ElMassimo/pingcrm-vite
+[heroku]: https://pingcrm-vite.herokuapp.com/
+[Issues]: https://github.com/ElMassimo/vite_ruby/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
+[Discussions]: https://github.com/ElMassimo/vite_ruby/discussions
+[vite_rails]: https://github.com/ElMassimo/vite_ruby/tree/main/vite_rails
+[vite_ruby]: https://github.com/ElMassimo/vite_ruby/tree/main/vite_ruby
+[vite_hanami]: https://github.com/ElMassimo/vite_ruby/tree/main/vite_hanami
+
+
+[Vite] is to frontend tooling as Ruby to programming, pure joy! 😍
+
+This is the core library for Rack apps, used by [<kbd>vite_rails</kbd>][vite_rails] and [<kbd>vite_hanami</kbd>][vite_hanami].
+
+## Features ⚡️
+
+- 💡 Instant server start
+- ⚡️ Blazing fast hot reload
+- 🚀 Zero-config deployments
+- 🤝 Integrated with <kbd>assets:precompile</kbd>
+- [And more!][features]
+
+## Documentation 📖
+
+Visit the [documentation website][website] to check out the [guides] and searchable [configuration reference].
+
+## Contact ✉️
+
+Please use [Issues] to report bugs you find, and [Discussions] to make feature requests or get help.
+
+Don't hesitate to _⭐️ star the project_ if you find it useful!
+
+Using it in production? Always love to hear about it! 😃
+
+
+## Special Thanks 🙏
+
+- [webpacker]
+- [vite]
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/default.vite.json

@@ -0,0 +1,26 @@
+{
+  "additionalEntrypoints": ["~/{assets,fonts,icons,images}/**/*"],
+  "assetHost": null,
+  "assetsDir": "assets",
+  "autoBuild": false,
+  "buildCacheDir": "tmp/cache/vite",
+  "publicOutputDir": "vite",
+  "configPath": "config/vite.json",
+  "devServerConnectTimeout": 0.01,
+  "packageManager": null,
+  "publicDir": "public",
+  "entrypointsDir": "entrypoints",
+  "sourceCodeDir": "app/frontend",
+  "skipCompatibilityCheck": false,
+  "skipProxy": false,
+  "host": "localhost",
+  "https": null,
+  "port": 3036,
+  "hideBuildConsoleOutput": false,
+  "viteBinPath": null,
+  "watchAdditionalPaths": [],
+  "base": "",
+  "ssrBuildEnabled": false,
+  "ssrEntrypoint": "~/ssr/ssr.{js,ts,jsx,tsx}",
+  "ssrOutputDir": "public/vite-ssr"
+}

data/exe/vite

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+ENV["RAILS_ENV"] ||= ENV["RACK_ENV"]
+
+require "bundler/setup"
+require "vite_ruby"
+
+cli = ViteRuby::CLI
+cli.require_framework_libraries
+
+Dry::CLI.new(cli).call

data/lib/tasks/vite.rake

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+$stdout.sync = true
+
+require "rake"
+
+namespace :vite do
+  task :binstubs do
+    ViteRuby.commands.install_binstubs
+  end
+
+  desc "Bundle frontend entrypoints using ViteRuby"
+  task build: :"vite:verify_install" do
+    ViteRuby.commands.build_from_task
+  end
+
+  desc "Bundle a Node.js app from the SSR entrypoint using ViteRuby"
+  task build_ssr: :"vite:verify_install" do
+    ViteRuby.commands.build_from_task("--ssr")
+  end
+
+  desc "Bundle entrypoints using Vite Ruby (SSR only if enabled)"
+  task build_all: :"vite:verify_install" do
+    ViteRuby.commands.build_from_task
+    ViteRuby.commands.build_from_task("--ssr") if ViteRuby.config.ssr_build_enabled
+  end
+
+  desc "Remove the build output directory for ViteRuby"
+  task clobber: :"vite:verify_install" do
+    ViteRuby.commands.clobber
+  end
+
+  desc "Verify if ViteRuby is properly installed in the app"
+  task :verify_install do
+    ViteRuby.commands.verify_install
+  end
+
+  desc "Ensure build dependencies like Vite are installed before bundling"
+  task :install_dependencies do
+    install_env_args = (ENV["VITE_RUBY_SKIP_INSTALL_DEV_DEPENDENCIES"] == "true") ? {} : {"NODE_ENV" => "development"}
+
+    install_cmd = case (pkg = ViteRuby.config.package_manager)
+    when "npm" then "npm ci"
+    else "#{pkg} install --frozen-lockfile"
+    end
+
+    system(install_env_args, install_cmd)
+  end
+
+  desc "Provide information on ViteRuby's environment"
+  task :info do
+    ViteRuby.commands.print_info
+  end
+end
+
+unless ENV["VITE_RUBY_SKIP_ASSETS_PRECOMPILE_EXTENSION"] == "true"
+  if Rake::Task.task_defined?("assets:precompile")
+    Rake::Task["assets:precompile"].enhance do |task|
+      prefix = task.name.split(/#|assets:precompile/).first
+      unless ENV["VITE_RUBY_SKIP_ASSETS_PRECOMPILE_INSTALL"] == "true"
+        Rake::Task["#{prefix}vite:install_dependencies"].invoke
+      end
+      Rake::Task["#{prefix}vite:build_all"].invoke
+    end
+  else
+    desc "Bundle Vite assets"
+    if ENV["VITE_RUBY_SKIP_ASSETS_PRECOMPILE_INSTALL"] == "true"
+      Rake::Task.define_task("assets:precompile" => "vite:build_all")
+    else
+      Rake::Task.define_task("assets:precompile" => ["vite:install_dependencies", "vite:build_all"])
+    end
+  end
+
+  if Rake::Task.task_defined?("assets:clobber")
+    Rake::Task["assets:clobber"].enhance do
+      Rake::Task["vite:clobber"].invoke
+    end
+  else
+    desc "Remove compiled assets"
+    Rake::Task.define_task("assets:clobber" => "vite:clobber")
+  end
+end
+
+# Any prerequisite task that installs packages should also install build dependencies.
+if ARGV.include?("assets:precompile")
+  if ViteRuby.commands.legacy_npm_version?
+    ENV["NPM_CONFIG_PRODUCTION"] = "false"
+  else
+    ENV["NPM_CONFIG_INCLUDE"] = "dev"
+  end
+
+  if ViteRuby.commands.legacy_yarn_version?
+    ENV["YARN_PRODUCTION"] = "false"
+  end
+end

data/lib/vite_ruby/build.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "json"
+require "time"
+
+# Internal: Value object with information about the last build.
+ViteRuby::Build = Struct.new(:success, :timestamp, :vite_ruby, :digest, :current_digest, :last_build_path, :errors, keyword_init: true) do
+  class << self
+    # Internal: Combines information from a previous build with the current digest.
+    def from_previous(last_build_path, current_digest)
+      new(
+        **parse_metadata(last_build_path),
+        current_digest: current_digest,
+        last_build_path: last_build_path,
+      )
+    end
+
+  private
+
+    # Internal: Reads metadata recorded on the last build, if it exists.
+    def parse_metadata(pathname)
+      return default_metadata unless pathname.exist?
+
+      JSON.parse(pathname.read.to_s).transform_keys(&:to_sym).slice(*members)
+    rescue JSON::JSONError, Errno::ENOENT, Errno::ENOTDIR
+      default_metadata
+    end
+
+    # Internal: To make it evident that there's no last build in error messages.
+    def default_metadata
+      {timestamp: "never", digest: "none"}
+    end
+  end
+
+  # Internal: A build is considered stale when watched files have changed since
+  # the last build, or when a certain time has ellapsed in case of failure.
+  def stale?
+    digest != current_digest || retry_failed? || vite_ruby != ViteRuby::VERSION
+  end
+
+  # Internal: A build is considered fresh if watched files have not changed, or
+  # the last failed build happened recently.
+  def fresh?
+    !stale?
+  end
+
+  # Internal: To avoid cascading build failures, if the last build failed and it
+  # happened within a short time window, a new build should not be triggered.
+  def retry_failed?
+    !success && Time.parse(timestamp) + 3 < Time.now # 3 seconds
+  rescue ArgumentError
+    true
+  end
+
+  # Internal: Returns a new build with the specified result.
+  def with_result(**attrs)
+    self.class.new(
+      **attrs,
+      timestamp: Time.now.strftime("%F %T"),
+      vite_ruby: ViteRuby::VERSION,
+      digest: current_digest,
+      current_digest: current_digest,
+      last_build_path: last_build_path,
+    )
+  end
+
+  # Internal: Writes the result of the new build to a local file.
+  def write_to_cache
+    last_build_path.write to_json
+  end
+
+  # Internal: Returns a JSON string with the metadata of the build.
+  def to_json(*_args)
+    JSON.pretty_generate(
+      success: success,
+      errors: errors,
+      timestamp: timestamp,
+      vite_ruby: vite_ruby,
+      digest: digest,
+    )
+  end
+end

data/lib/vite_ruby/builder.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "digest/sha1"
+
+# Public: Keeps track of watched files and triggers builds as needed.
+class ViteRuby::Builder
+  def initialize(vite_ruby)
+    @vite_ruby = vite_ruby
+  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(*args)
+    last_build = last_build_metadata(ssr: args.include?("--ssr"))
+
+    if args.delete("--force") || last_build.stale? || config.manifest_paths.empty?
+      stdout, stderr, status = build_with_vite(*args)
+      log_build_result(stdout, stderr, status)
+      record_build_metadata(last_build, errors: stderr, success: status.success?)
+      status.success?
+    elsif last_build.success
+      logger.debug "Skipping vite build. Watched files have not changed since the last build at #{last_build.timestamp}"
+      true
+    else
+      logger.error "Skipping vite build. Watched files have not changed since the build failed at #{last_build.timestamp} ❌"
+      false
+    end
+  end
+
+  # Internal: Reads the result of the last compilation from disk.
+  def last_build_metadata(ssr: false)
+    ViteRuby::Build.from_previous(last_build_path(ssr: ssr), watched_files_digest)
+  end
+
+private
+
+  extend Forwardable
+
+  def_delegators :@vite_ruby, :config, :logger, :run
+
+  # Internal: Writes a digest of the watched files to disk for future checks.
+  def record_build_metadata(build, **attrs)
+    config.build_cache_dir.mkpath
+    build.with_result(**attrs).write_to_cache
+  end
+
+  # Internal: The file path where metadata of the last build is stored.
+  def last_build_path(ssr:)
+    config.build_cache_dir.join("last#{"-ssr" if ssr}-build-#{config.mode}.json")
+  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
+    return @last_digest if @last_digest_at && Time.now - @last_digest_at < 1
+
+    config.within_root do
+      files = Dir[*config.watched_paths].reject { |f| File.directory?(f) }
+      file_ids = files.sort.map { |f| "#{File.basename(f)}/#{Digest::SHA1.file(f).hexdigest}" }
+      @last_digest_at = Time.now
+      @last_digest = Digest::SHA1.hexdigest(file_ids.join("/"))
+    end
+  end
+
+  # Public: Initiates a Vite build command to generate assets.
+  def build_with_vite(*args)
+    logger.info "Building with Vite ⚡️"
+
+    run(["build", *args])
+  end
+
+  # Internal: Outputs the build results.
+  #
+  # NOTE: By default it also outputs the manifest entries.
+  def log_build_result(_stdout, stderr, status)
+    if status.success?
+      logger.info "Build with Vite complete: #{config.build_output_dir}"
+      logger.error stderr unless stderr.empty?
+    else
+      logger.error stderr
+      logger.error status
+      logger.error "Build with Vite failed! ❌"
+      logger.error "❌ Check that vite and vite-plugin-ruby are in devDependencies and have been installed. " if stderr.include?("ERR! canceled")
+    end
+  end
+end

data/lib/vite_ruby/cli/build.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class ViteRuby::CLI::Build < ViteRuby::CLI::Vite
+  DEFAULT_ENV = CURRENT_ENV || "production"
+
+  desc "Bundle all entrypoints using Vite."
+  shared_options
+  option(:ssr, desc: "Build the SSR entrypoint instead", type: :boolean)
+  option(:force, desc: "Force the build even if assets have not changed", type: :boolean)
+  option(:watch, desc: "Start the Rollup watcher and rebuild on files changes", type: :boolean)
+  option(:profile, desc: "Gather performance metrics from the build ", type: :boolean)
+
+  def call(**options)
+    super { |args| ViteRuby.commands.build_from_task(*args) }
+  end
+end

data/lib/vite_ruby/cli/clobber.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class ViteRuby::CLI::Clobber < Dry::CLI::Command
+  desc "Clear the Vite cache, temp files, and builds"
+
+  current_env = ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
+
+  option(:mode, default: current_env, values: %w[development production test], aliases: ["m"], desc: "The mode to use")
+
+  def call(mode:, **)
+    ViteRuby.env["VITE_RUBY_MODE"] = mode
+    ViteRuby.commands.clobber
+  end
+end

data/lib/vite_ruby/cli/dev.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class ViteRuby::CLI::Dev < ViteRuby::CLI::Vite
+  DEFAULT_ENV = CURRENT_ENV || "development"
+
+  desc "Start the Vite development server."
+  shared_options
+  option(:force, desc: "Force Vite to re-bundle dependencies", type: :boolean)
+
+  def call(**options)
+    super { |args| ViteRuby.run(args, exec: true) }
+  end
+end

data/lib/vite_ruby/cli/file_utils.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "fileutils"
+
+# NOTE: Extracted from dry-cli version 0.6.0, which later removed this file as
+# it was refactored and extracted into the more complete (and complex) dry-files.
+module ViteRuby::CLI::FileUtils
+  class << self
+    # Creates a new file or rewrites the contents of an existing file.
+    #
+    # @since 1.2.11
+    # @api private
+    def write(path, *content)
+      mkdir_p(path)
+      File.open(path, File::CREAT | File::WRONLY | File::TRUNC) do |file|
+        file.write(Array(content).flatten.join)
+      end
+    end
+
+    # Copies source into destination.
+    #
+    # @since 1.2.11
+    # @api private
+    def cp(source, destination)
+      mkdir_p(destination)
+      FileUtils.cp(source, destination) unless File.exist?(destination)
+    end
+
+    # Adds a new line at the bottom of the file.
+    #
+    # @since 1.2.11
+    # @api private
+    def append(path, contents)
+      content = read_lines(path)
+      return if content.join.include?(contents)
+
+      content << "\n" unless content.last&.end_with?("\n")
+      content << "#{contents}\n"
+
+      write(path, content)
+    end
+
+    # Replace first line in `path` that contains `target` with `replacement`.
+    #
+    # @since 1.2.11
+    # @api private
+    def replace_first_line(path, target, replacement)
+      content = read_lines(path)
+      content[index(content, path, target)] = "#{replacement}\n"
+
+      write(path, content)
+    end
+
+    # Inject `contents` in `path` before `target`.
+    #
+    # @since 1.2.11
+    # @api private
+    def inject_line_before(path, target, contents)
+      _inject_line_before(path, target, contents, method(:index))
+    end
+
+    # Inject `contents` in `path` after `target`.
+    #
+    # @since 1.2.11
+    # @api private
+    def inject_line_after(path, target, contents)
+      _inject_line_after(path, target, contents, method(:index))
+    end
+
+    # Inject `contents` in `path` after last `target`.
+    #
+    # @since 1.2.11
+    # @api private
+    def inject_line_after_last(path, target, contents)
+      _inject_line_after(path, target, contents, method(:rindex))
+    end
+
+  private
+
+    # Creates all parent directories for the given file path.
+    #
+    # @since 1.2.11
+    # @api private
+    def mkdir_p(path)
+      Pathname.new(path).dirname.mkpath
+    end
+
+    # Returns an array with lines in the specified file, empty if it doesn't exist.
+    def read_lines(path)
+      File.exist?(path) ? File.readlines(path) : []
+    end
+
+    # @since 1.2.11
+    # @api private
+    def index(content, path, target)
+      content.index { |line| line.include?(target) } ||
+        raise(ArgumentError, "Cannot find `#{target}' inside `#{path}'.")
+    end
+
+    # @since 1.2.11
+    # @api private
+    def rindex(content, path, target)
+      content.rindex { |line| line.include?(target) } ||
+        raise(ArgumentError, "Cannot find `#{target}' inside `#{path}'.")
+    end
+
+    # @since 1.2.11
+    # @api private
+    def _inject_line_before(path, target, contents, finder)
+      content = read_lines(path)
+      return if content.join.include?(contents)
+
+      i = finder.call(content, path, target)
+
+      content.insert(i, "#{contents}\n")
+      write(path, content)
+    end
+
+    # @since 1.2.11
+    # @api private
+    def _inject_line_after(path, target, contents, finder)
+      content = read_lines(path)
+      return if content.join.include?(contents)
+
+      i = finder.call(content, path, target)
+
+      content.insert(i + 1, "#{contents}\n")
+      write(path, content)
+    end
+  end
+end