vite_rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad566a46292f652f6533c40901952359b27afdc98224af3f67bd4414a906a951
+  data.tar.gz: f3a035a74e1f3d092b99d46a25dfd32cd2d6cb50071f7dc971473f0958a76893
+SHA512:
+  metadata.gz: 77d1dd2b22130bdee130dc814e4453d1c63ad6823c3cc0cd9e6a1f8a17c3f02adb31f8924e2f97d686dc707bbd2b56b327948e6e12f5bcdf2c47132f62293891
+  data.tar.gz: 635ea8d95ed3e8cd3dc0e2f44fd962fdf3920578bdeb51f6cabf2be251035555371d20adb1ac9ab5a6e81d6620def27a0b646fc2f3bd8f769869d328c1ef5c40

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## Vite Rails 1.0.0
+
+Initial Version

data/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+## Setting Up a Development Environment
+
+1. Install [Yarn](https://yarnpkg.com/)
+
+2. Run the following commands to set up the development environment.
+
+```
+bundle install
+yarn
+```
+
+## Making sure your changes pass all tests
+There are a number of automated checks which run on GitHub Actions when a pull request is created.
+You can run those checks on your own locally to make sure that your changes would not break the CI build.
+
+### 1. Check the code for JavaScript style violations
+```
+yarn lint
+```
+
+### 2. Check the code for Ruby style violations
+```
+bundle exec rubocop
+```
+
+### 3. Run the JavaScript test suite
+```
+yarn test
+```
+
+### 4. Run the Ruby test suite
+```
+bundle exec rake test
+```

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,64 @@
+<h1 align="center">
+  Vite ⚡️ Rails
+  <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"/>
+    </a> -->
+    <!-- <a href="https://codeclimate.com/github/ElMassimo/vite_rails">
+      <img alt="Maintainability" src="https://codeclimate.com/github/ElMassimo/vite_rails/badges/gpa.svg"/>
+    </a>
+    <a href="https://codeclimate.com/github/ElMassimo/vite_rails">
+      <img alt="Test Coverage" src="https://codeclimate.com/github/ElMassimo/vite_rails/badges/coverage.svg"/>
+    </a> -->
+    <a href="https://rubygems.org/gems/vite_rails">
+      <img alt="Gem Version" src="https://img.shields.io/gem/v/vite_rails.svg?colorB=e9573f"/>
+    </a>
+    <a href="https://github.com/ElMassimo/vite_rails/blob/master/LICENSE.txt">
+      <img alt="License" src="https://img.shields.io/badge/license-MIT-428F7E.svg"/>
+    </a>
+  </p>
+</h1>
+
+[vite_rails]: https://github.com/ElMassimo/vite_rails
+[webpacker]: https://github.com/rails/webpacker
+[vite]: http://vitejs.dev/
+
+[__Vite Rails__][vite_rails] allows you to use [Vite] to power the frontend.
+
+[Vite] is to frontend tooling as Ruby to programming, pure joy! 😍
+
+## Features ⚡️
+
+- 🤖 Automatic Entrypoint Detection
+- ⚡️ Hot Reload
+- ⚙️ Rake Tasks
+- 🪝 Hooks to <kbd>assets:precompile</kbd> and friends
+
+## Documentation 📖
+
+Coming Soon!
+
+## Installation 💿
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vite_rails'
+```
+
+Then, run:
+
+```bash
+bundle install
+bin/rake vite:install
+```
+
+This will generate configuration files and a sample setup.
+
+## Inspiration 💡
+
+- [webpacker]
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/install/binstubs.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+say 'Copying binstubs'
+directory "#{ __dir__ }/bin", 'bin'
+
+chmod 'bin', 0o755 & ~File.umask, verbose: false

data/lib/install/template.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# Install ViteRails
+copy_file "#{ __dir__ }/config/vite.json", ViteRails.config.config_path
+
+if Dir.exist?(ViteRails.config.source_code_dir)
+  say 'The JavaScript app source directory already exists. Move it and try again to see a basic setup.'
+else
+  say 'Creating JavaScript app source directory'
+  directory "#{ __dir__ }/javascript", ViteRails.config.source_code_dir
+end
+
+apply "#{ __dir__ }/binstubs.rb"
+
+git_ignore_path = Rails.root.join('.gitignore')
+if git_ignore_path.exist?
+  append_to_file(git_ignore_path) {
+    <<~GITIGNORE
+
+      # Vite on Rails
+      /public/vite
+      /public/vite-dev
+      /public/vite-test
+      node_modules
+      *.local
+      .DS_Store
+    GITIGNORE
+  }
+end
+
+install = if Rails.root.join('yarn.lock').exist?
+  'yarn add'
+elsif Rails.root.join('pnpm-lock.yaml').exist?
+  'pnpm install'
+else
+  'npm install'
+end
+
+Dir.chdir(Rails.root) do
+  say 'Installing JavaScript dependencies for Vite Rails'
+  package_json = File.read("#{ __dir__ }/../../package.json")
+
+  vite_version = package_json.match(/"vite": "(.*)"/)[1]
+  plugin_version = package_json.match(/"vite-plugin-ruby": "(.*)"/)[1]
+
+  say 'Installing vite as direct dependencies'
+  run "#{ install } vite@#{ vite_version } vite-plugin-ruby@#{ plugin_version }"
+end
+
+if Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR > 1
+  src = begin
+          "#{ ViteRails.config.protocol }://#{ ViteRails.config.host_with_port }"
+        rescue StandardError
+          'http://localhost:3036'
+        end
+  say 'You need to allow vite-dev-server host as allowed origin for connect-src.', :yellow
+  say 'This can be done in Rails 5.2+ for development environment in the CSP initializer', :yellow
+  say 'config/initializers/content_security_policy.rb with a snippet like this:', :yellow
+  say %(policy.connect_src :self, :https, "http://#{ src }", "ws://#{ src }" if Rails.env.development?), :yellow
+end
+
+say 'ViteRails successfully installed 🎉 🍰', :green

data/lib/vite_rails.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext/class/attribute_accessors'
+
+require 'zeitwerk'
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{ __dir__ }/install")
+loader.ignore("#{ __dir__ }/tasks")
+loader.setup
+
+class ViteRails
+  # Internal: Prefix used for environment variables that modify the configuration.
+  ENV_PREFIX = 'VITE_RUBY'
+
+  # Public: Additional environment variables to pass to Vite.
+  #
+  # Example:
+  #   ViteRails.env['VITE_RUBY_CONFIG_PATH'] = 'config/alternate_vite.json'
+  cattr_accessor(:env) { ENV.select { |key, _| key.start_with?(ENV_PREFIX) } }
+
+  cattr_accessor(:logger) { ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT)) }
+
+  class << self
+    delegate :config, :builder, :manifest, :commands, :dev_server, to: :instance
+    delegate :mode, to: :config
+    delegate :bootstrap, :clean, :clobber, :build, to: :commands
+
+    attr_writer :instance
+
+    def instance
+      @instance ||= ViteRails.new
+    end
+
+    def run(args)
+      $stdout.sync = true
+      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
+
+    def with_node_env(env)
+      original = ENV['NODE_ENV']
+      ENV['NODE_ENV'] = env
+      yield
+    ensure
+      ENV['NODE_ENV'] = original
+    end
+
+    def ensure_log_goes_to_stdout
+      old_logger = ViteRails.logger
+      ViteRails.logger = ActiveSupport::Logger.new(STDOUT)
+      yield
+    ensure
+      ViteRails.logger = old_logger
+    end
+  end
+
+  # Public: Current instance configuration for Vite.
+  def config
+    @config ||= ViteRails::Config.resolve_config
+  end
+
+  # Public: Keeps track of watched files and triggers builds as needed.
+  def builder
+    @builder ||= ViteRails::Builder.new(self)
+  end
+
+  # Public: Allows to check if the Vite development server is running.
+  def dev_server
+    @dev_server ||= ViteRails::DevServer.new(config)
+  end
+
+  # Public: Enables looking up assets managed by Vite using name and type.
+  def manifest
+    @manifest ||= ViteRails::Manifest.new(self)
+  end
+
+  # Internal: Helper to run commands related with Vite.
+  def commands
+    @commands ||= ViteRails::Commands.new(self)
+  end
+end
+
+ViteRails::Engine if defined?(Rails)

data/lib/vite_rails/builder.rb

@@ -0,0 +1,113 @@
+# 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

@@ -0,0 +1,68 @@
+# 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