vite_ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 522fa472785527e2ee77fac1df4b7471a7d9dbce81ac768f0723604389151d74
+  data.tar.gz: 7e080892e4b503768b43d04cd9c562c655ff76cb939ceb956b72e278500994fe
+SHA512:
+  metadata.gz: 14cc69c07939b2b67a0bb1f7a2ef3db95373f2ab12e83bf826ade50ceb877ff7d25db823c8b928247c7e81ee8a50e556c213806317a64c09a77c4c88a4f68c62
+  data.tar.gz: e41055b2a38e7e24ee8ba3a9f942448068f427187f8c300d6a3721a295573937a08c956307d9a4246d30a440e00ec015815e45ee2a8aef49d2790e7e0004164f

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## Vite Ruby 1.0.0 (2020-02-09)
+
+- Initial release, extracted core functionality from `vite_rails`.

data/CONTRIBUTING.md

@@ -0,0 +1,33 @@
+## Setting Up a Development Environment
+
+1. Install [Yarn](https://yarnpkg.com/)
+
+2. Run the following commands to set up the development environment.
+
+```
+bundle install
+```
+
+## 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,82 @@
+<h1 align="center">
+  <a href="https://vite-rails.netlify.app/">
+    <img src="https://raw.githubusercontent.com/ElMassimo/vite_rails/main/docs/public/logo.svg" width="120px"/>
+  </a>
+
+  <br>
+
+  <a href="https://vite-rails.netlify.app/">
+    Vite Ruby
+  </a>
+
+  <br>
+
+  <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_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_rails/blob/master/LICENSE.txt">
+      <img alt="License" src="https://img.shields.io/badge/license-MIT-428F7E.svg"/>
+    </a>
+  </p>
+</h1>
+
+[website]: https://vite-rails.netlify.app/
+[configuration reference]: https://vite-rails.netlify.app/config/
+[features]: https://vite-rails.netlify.app/guide/introduction.html
+[guides]: https://vite-rails.netlify.app/guide/
+[config]: https://vite-rails.netlify.app/config/
+[vite_rails]: https://github.com/ElMassimo/vite_rails
+[webpacker]: https://github.com/rails/webpacker
+[vite]: http://vitejs.dev/
+[config file]: https://github.com/ElMassimo/vite_rails/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_rails/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
+[Discussions]: https://github.com/ElMassimo/vite_rails/discussions
+[vite_rails]: https://github.com/ElMassimo/vite_rails/tree/main/vite_rails
+[vite_ruby]: https://github.com/ElMassimo/vite_rails/tree/main/vite_ruby
+[vite_hanami]: https://github.com/ElMassimo/vite_rails/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!
+
+
+## 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,17 @@
+{
+  "assetHost": null,
+  "assetsDir": "assets",
+  "autoBuild": false,
+  "buildCacheDir": "tmp/cache/vite",
+  "publicOutputDir": "vite",
+  "configPath": "config/vite.json",
+  "devServerConnectTimeout": 0.01,
+  "publicDir": "public",
+  "entrypointsDir": "entrypoints",
+  "sourceCodeDir": "app/frontend",
+  "host": "localhost",
+  "https": null,
+  "port": 3036,
+  "hideBuildConsoleOutput": false,
+  "watchAdditionalPaths": []
+}

data/exe/vite

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

data/lib/tasks/vite.rake

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+$stdout.sync = true
+
+require 'rake'
+
+namespace :vite do
+  task :binstubs do
+    ViteRuby.commands.install_binstubs
+  end
+
+  desc 'Compile JavaScript packs using vite for production with digests'
+  task build: :'vite:verify_install' do
+    ViteRuby.commands.build_from_task
+  end
+
+  desc 'Remove old compiled vites'
+  task :clean, [:keep, :age] => :'vite:verify_install' do |_, args|
+    ViteRuby.commands.clean_from_task(args)
+  end
+
+  desc 'Remove the vite build output directory'
+  task clobber: :'vite:verify_install' do
+    ViteRuby.commands.clobber
+    $stdout.puts "Removed vite build output directory #{ ViteRuby.config.build_output_dir }"
+  end
+
+  desc 'Verifies if ViteRuby is properly installed in this application'
+  task :verify_install do
+    ViteRuby.commands.verify_install
+  end
+
+  desc 'Install all JavaScript dependencies'
+  task :install_dependencies do
+    system({ 'NODE_ENV' => 'development' }, 'npx ci')
+  end
+
+  desc "Provide information on ViteRuby's environment"
+  task :info do
+    ViteRuby.commands.print_info
+  end
+end
+
+if Rake::Task.task_defined?('assets:precompile')
+  Rake::Task['assets:precompile'].enhance do |task|
+    prefix = task.name.split(/#|assets:precompile/).first
+    Rake::Task["#{ prefix }vite:build"].invoke
+  end
+else
+  Rake::Task.define_task('assets:precompile' => ['vite:install_dependencies', 'vite:build'])
+end

data/lib/vite_ruby.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'forwardable'
+require 'pathname'
+
+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.setup
+
+class ViteRuby
+  # Internal: Prefix used for environment variables that modify the configuration.
+  ENV_PREFIX = 'VITE_RUBY'
+
+  # Internal: Versions used by default when running `vite install`.
+  DEFAULT_VITE_VERSION = '^2.0.0-beta.65'
+  DEFAULT_PLUGIN_VERSION = '^1.0.8'
+
+  # Internal: Ruby Frameworks that have a companion library for Vite Ruby.
+  SUPPORTED_FRAMEWORKS = %w[rails hanami roda].freeze
+
+  class << self
+    extend Forwardable
+
+    def_delegators :instance, :config, :commands, :run_proxy?
+    def_delegators :config, :mode
+    def_delegators :commands, :build
+    def_delegators 'ViteRuby::Runner.new', :run
+
+    def instance
+      @instance ||= ViteRuby.new
+    end
+
+    # Public: Additional environment variables to pass to Vite.
+    #
+    # Example:
+    #   ViteRuby.env['VITE_RUBY_CONFIG_PATH'] = 'config/alternate_vite.json'
+    def env
+      @env ||= load_env_variables
+    end
+
+    # Internal: Refreshes the manifest.
+    def bootstrap
+      instance.manifest.refresh
+    end
+
+    # Internal: Loads all available rake tasks.
+    def install_tasks
+      load File.expand_path('tasks/vite.rake', __dir__)
+    end
+
+    # Internal: Refreshes the config after setting the env vars.
+    def reload_with(env_vars)
+      env.update(env_vars)
+      @instance = nil
+      config
+    end
+
+    # Internal: Allows to obtain any env variables for configuration options.
+    def load_env_variables
+      ENV.select { |key, _| key.start_with?(ENV_PREFIX) }
+    end
+
+    # Internal: Detects if the application has installed a framework-specific
+    # variant of Vite Ruby.
+    def framework_libraries
+      SUPPORTED_FRAMEWORKS.map { |framework|
+        if library = Gem.loaded_specs["vite_#{ framework }"]
+          [framework, library]
+        end
+      }.compact
+    end
+  end
+
+  attr_writer :logger
+
+  def logger
+    @logger ||= Logger.new($stdout)
+  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 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 SystemCallError
+    @running_at = false
+  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
+
+  # Public: Keeps track of watched files and triggers builds as needed.
+  def builder
+    @builder ||= ViteRuby::Builder.new(self)
+  end
+
+  # Internal: Helper to run commands related with Vite.
+  def commands
+    @commands ||= ViteRuby::Commands.new(self)
+  end
+
+  # Public: Current instance configuration for Vite.
+  def config
+    @config ||= ViteRuby::Config.resolve_config
+  end
+
+  # Public: Enables looking up assets managed by Vite using name and type.
+  def manifest
+    @manifest ||= ViteRuby::Manifest.new(self)
+  end
+end

data/lib/vite_ruby/builder.rb

@@ -0,0 +1,103 @@
+# 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
+    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
+
+  extend Forwardable
+
+  def_delegators :@vite_ruby, :config, :logger
+
+  # 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 = ViteRuby.run(['build'], capture: true)
+    log_build_result(stdout, stderr, status)
+
+    status.success?
+  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.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
+  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
+end