vite_rails 1.0.12 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57f866deafddde5401e02ec27cf751eb26a40a0be1fd832d9d3813fd7a69e721
-  data.tar.gz: 7cf22c583a3ac70f4353e227b0da4463b42067dd38f0c36774e665e619b31f2d
+  metadata.gz: 04dad5363dea685fe1e9e7ad2a852566927bd2804f0dab0ddecc8016da915dd0
+  data.tar.gz: 5a8d82f9cfbcf65bef55d28dfdf8cdf5bb77fb04ba83ce9db6b7c4eb2ffb749d
 SHA512:
-  metadata.gz: d101294de0e6f585b7df56c2881c465698f4c6ccbe8c4220117d7119c84f21e8b80e6aa2865dd353fa27b3b2c3d7a78095e80466c2d9b5f6eda60b6073a55ed0
-  data.tar.gz: fdbe92f7afafd6f82bafc6525a4099151efcdc385ce49e5cc5f696ea79efe5d411b6eaf093b9b1ec1402140a7d4ac34f629401fb70d9005535eaf38e989cf4cd
+  metadata.gz: 312c305aa1d69cfb57f93110c093cc7f8b5193a24c16aa5916efc60f8b284d86eba0090aa2e1831748526c7bf57ea6c8962b6d290d469d0ca1b0bdd014888431
+  data.tar.gz: d118d7eecbc36163b8ef3789d9198da5c991aab64f6da739381878e7b045c1d365155d22be92226665ce7583f99e0d6d60fd6b01aeb94f5596371a359a242a6d

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Vite Rails 2.0.0  (2020-02-09)
+
+- Extracted core functionality to `vite_ruby`.
+- User-facing API hasn't really changed, but internal classes have been renamed.
+- Installation script now injects tags to `application.html.erb` if it exists.
+
 ## Vite Rails 1.0.12  (2020-01-29)
 
 - Add support for Vite 2.0.0-beta.56, which modified the manifest to output a `css` field in the manifest.

data/README.md

@@ -1,54 +1,66 @@
 <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 href="https://vite-ruby.netlify.app/">
+    <img src="https://raw.githubusercontent.com/ElMassimo/vite_ruby/main/docs/public/logo.svg" width="120px"/>
   </a>
 
   <br>
 
-  <a href="https://vite-rails.netlify.app/">
+  <a href="https://vite-ruby.netlify.app/">
     Vite Rails
   </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 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_rails">
-      <img alt="Maintainability" src="https://codeclimate.com/github/ElMassimo/vite_rails/badges/gpa.svg"/>
+    <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_rails">
-      <img alt="Test Coverage" src="https://codeclimate.com/github/ElMassimo/vite_rails/badges/coverage.svg"/>
+    <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_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">
+    <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-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
+[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/tree/main/vite_rails
 [webpacker]: https://github.com/rails/webpacker
 [vite]: http://vitejs.dev/
-[config file]: https://github.com/ElMassimo/vite_rails/blob/main/package/default.vite.json
-[example app]: https://github.com/ElMassimo/vite_rails/tree/main/examples/blog
-[heroku]: https://vite-rails-demo.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__][vite_rails] allows you to use [Vite] to power the frontend of your Rails app.
+[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
+[no bundling]: https://vitejs.dev/guide/introduction.html#the-problem
+[bundling]: https://vitejs.dev/guide/introduction.html#why-bundle-for-production
 
 [Vite] is to frontend tooling as Ruby to programming, pure joy! 😍
 
-Check an [example app] running on [Heroku].
+[__Vite Rails__][vite_rails] provides a complete setup for Rails applications,
+allowing you to leverage [Vite] to power the frontend of your Rails app.
+
+## Why Vite? 🤔
+
+Vite [does not bundle your code during development][no bundling], which means the
+dev server is extremely __fast to start__, and your changes will be __updated instantly__.
+
+In production, Vite [bundles your code][bundling]
+with tree-shaking, lazy-loading, and common chunk splitting out of the box, to achieve optimal loading performance.
+
+Check [this video comparison with webpack](https://github.com/ElMassimo/pingcrm-vite/pull/1)
+which demonstrates the difference in speed during development.
 
 ## Features ⚡️
 
@@ -74,7 +86,7 @@ Then, run:
 
 ```bash
 bundle install
-bin/rake vite:install
+bundle exec vite install
 ```
 
 This will generate configuration files and a sample setup.
@@ -83,16 +95,9 @@ Additional installation instructions are available in the [documentation website
 
 ## Getting Started 💻
 
-Restart your Rails server, and then run <kbd>bin/vite</kbd> to start the Vite development server.
-
-Add the following your `views/layouts/application.html.erb`:
-
-```erb
-<%= vite_client_tag %>
-<%= vite_javascript_tag 'application' %>
-```
+Restart your Rails server, and then run <kbd>bin/vite dev</kbd> to start the Vite development server.
 
-Visit any page and you should see a printed console output: `Vite ⚡️ Rails`.
+Visit any page and you should see a printed console output: `Vite ⚡️ Ruby`.
 
 For more [guides] and a full [configuration reference], check the [documentation website][website].
 

data/lib/tasks/vite.rake

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'vite_ruby'
+ViteRuby.install_tasks
+
+namespace :vite_rails do
+  desc 'Fixes Rails management of node dev dependencies (build dependencies)'
+  task :set_node_env do
+    ENV['NODE_ENV'] = 'development'
+  end
+end
+
+# Set NODE_ENV before installation, so that Rails installs JS build dependencies
+# on servers that precompile assets.
+['yarn:install', 'webpacker:yarn_install'].each do |name|
+  Rake::Task[name].enhance([:'vite_rails:set_node_env']) if Rake::Task.task_defined?(name)
+end

data/lib/vite_rails.rb

@@ -1,85 +1,8 @@
 # frozen_string_literal: true
 
-require 'rails'
-require 'active_support/all'
+require 'vite_ruby'
 
-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'
-
-  class << self
-    delegate :config, :builder, :manifest, :commands, :dev_server, :dev_server_running?, :run_proxy?, to: :instance
-    delegate :mode, to: :config
-    delegate :bootstrap, :clean, :clean_from_rake, :clobber, :build, :build_from_rake, to: :commands
-
-    attr_writer :instance
-
-    def instance
-      @instance ||= ViteRails.new
-    end
-
-    def run(args)
-      $stdout.sync = true
-      ViteRails::Runner.new(args).run
-    end
-
-    # Internal: Allows to obtain any env variables for configuration options.
-    def load_env_variables
-      ENV.select { |key, _| key.start_with?(ENV_PREFIX) }
-    end
-  end
-
-  # Public: Additional environment variables to pass to Vite.
-  #
-  # Example:
-  #   ViteRails.env['VITE_RUBY_CONFIG_PATH'] = 'config/alternate_vite.json'
-  cattr_accessor(:env) { load_env_variables }
-
-  cattr_accessor(:logger) { ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT)) }
-
-  # Public: Returns true if the Vite development server is running.
-  def dev_server_running?
-    run_proxy? && dev_server.running?
-  end
-
-  # Public: The proxy for assets should only run in development mode.
-  def run_proxy?
-    config.mode == 'development'
-  rescue StandardError => error
-    ViteRails.logger.error("Failed to check mode for Vite: #{ error.message }")
-    false
-  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)
+require 'vite_rails/version'
+require 'vite_rails/config'
+require 'vite_rails/tag_helpers'
+require 'vite_rails/engine' if defined?(Rails)

data/lib/vite_rails/config.rb

@@ -1,139 +1,15 @@
 # frozen_string_literal: true
 
-require 'json'
-
-# Public: Allows to resolve configuration sourced from `config/vite.json` and
-# environment variables, combining them with the default options.
-class ViteRails::Config
-  delegate :as_json, :inspect, to: :@config
-
-  def initialize(attrs)
-    @config = attrs.tap { |config| coerce_values(config) }.freeze
-  end
-
-  def protocol
-    https ? 'https' : 'http'
-  end
-
-  def host_with_port
-    "#{ host }:#{ port }"
-  end
-
-  # Internal: Path where Vite outputs the manifest file.
-  def manifest_path
-    build_output_dir.join('manifest.json')
-  end
-
-  # Internal: Path where vite-plugin-ruby outputs the assets manifest file.
-  def assets_manifest_path
-    build_output_dir.join('manifest-assets.json')
-  end
-
-  # Public: The directory where Vite will store the built assets.
-  def build_output_dir
-    root.join(public_dir, public_output_dir)
-  end
-
-  # Public: The directory where the entries are located.
-  def resolved_entrypoints_dir
-    root.join(source_code_dir, entrypoints_dir)
-  end
-
-  # Internal: The directory where Vite stores its processing cache.
-  def vite_cache_dir
-    root.join('node_modules/.vite')
-  end
-
-  # Public: Sets additional environment variables for vite-plugin-ruby.
-  def to_env
-    CONFIGURABLE_WITH_ENV.each_with_object({}) do |option, env|
-      unless (value = @config[option]).nil?
-        env["#{ ViteRails::ENV_PREFIX }_#{ option.upcase }"] = value.to_s
-      end
-    end.merge(ViteRails.env)
-  end
-
-private
-
-  # Internal: Coerces all the configuration values, in case they were passed
-  # as environment variables which are always strings.
-  def coerce_values(config)
-    config['mode'] = config['mode'].to_s
-    config['port'] = config['port'].to_i
-    config['root'] = Pathname.new(config['root'])
-    config['build_cache_dir'] = config['root'].join(config['build_cache_dir'])
-    coerce_booleans(config, 'auto_build', 'hide_build_console_output', 'https')
-  end
-
-  # Internal: Coerces configuration options to boolean.
-  def coerce_booleans(config, *names)
-    names.each { |name| config[name] = [true, 'true'].include?(config[name]) }
-  end
-
-  class << self
-    # Public: Returns the project configuration for Vite.
-    def resolve_config(**attrs)
-      config = attrs.transform_keys(&:to_s).reverse_merge(config_defaults)
-      file_path = File.join(config['root'], config['config_path'])
-      file_config = config_from_file(file_path, mode: config['mode'])
-      new DEFAULT_CONFIG.merge(file_config).merge(config_from_env).merge(config)
-    end
-
-  private
-
-    # Internal: Default values for a Rails application.
-    def config_defaults
-      {
-        'asset_host' => option_from_env('asset_host') || Rails.application&.config&.action_controller&.asset_host,
-        'config_path' => option_from_env('config_path') || DEFAULT_CONFIG.fetch('config_path'),
-        'mode' => option_from_env('mode') || Rails.env.to_s,
-        'root' => option_from_env('root') || Rails.root || Dir.pwd,
-      }
-    end
-
-    # Internal: Used to load a JSON file from the specified path.
-    def load_json(path)
-      JSON.parse(File.read(File.expand_path(path))).deep_transform_keys(&:underscore)
-    end
-
-    # Internal: Retrieves a configuration option from environment variables.
-    def option_from_env(name)
-      ViteRails.env["#{ ViteRails::ENV_PREFIX }_#{ name.upcase }"]
-    end
-
-    # Internal: Extracts the configuration options provided as env vars.
-    def config_from_env
-      CONFIGURABLE_WITH_ENV.each_with_object({}) do |option, env_vars|
-        if value = option_from_env(option)
-          env_vars[option] = value
-        end
-      end
-    end
-
-    # Internal: Loads the configuration options provided in a JSON file.
-    def config_from_file(path, mode:)
-      multi_env_config = load_json(path)
-      multi_env_config.fetch('all', {})
-        .merge(multi_env_config.fetch(mode, {}))
-    rescue Errno::ENOENT => error
-      warn "Check that your vite.json configuration file is available in the load path. #{ error.message }"
-      {}
-    end
-  end
-
-  # Internal: Shared configuration with the Vite plugin for Ruby.
-  DEFAULT_CONFIG = load_json("#{ __dir__ }/../../package/default.vite.json").freeze
-
-  # Internal: Configuration options that can not be provided as env vars.
-  NOT_CONFIGURABLE_WITH_ENV = %w[watch_additional_paths].freeze
-
-  # Internal: Configuration options that can be provided as env vars.
-  CONFIGURABLE_WITH_ENV = (DEFAULT_CONFIG.keys + %w[mode root] - NOT_CONFIGURABLE_WITH_ENV).freeze
-
-public
-
-  # Define getters for the configuration options.
-  (CONFIGURABLE_WITH_ENV + NOT_CONFIGURABLE_WITH_ENV).each do |option|
-    define_method(option) { @config[option] }
+module ViteRails::Config
+  # Override: Default values for a Rails application.
+  def config_defaults
+    require 'rails'
+    super(
+      asset_host: Rails.application&.config&.action_controller&.asset_host,
+      mode: Rails.env.to_s,
+      root: Rails.root || Dir.pwd,
+    )
   end
 end
+
+ViteRuby::Config.singleton_class.prepend(ViteRails::Config)

data/lib/vite_rails/engine.rb

@@ -4,36 +4,32 @@ require 'rails/railtie'
 
 class ViteRails::Engine < Rails::Engine
   initializer 'vite_rails.proxy' do |app|
-    app.middleware.insert_before 0, ViteRails::DevServerProxy, ssl_verify_none: true if ViteRails.run_proxy?
+    app.middleware.insert_before 0, ViteRuby::DevServerProxy, ssl_verify_none: true if ViteRuby.run_proxy?
   end
 
   initializer 'vite_rails.helper' do
     ActiveSupport.on_load(:action_controller) do
-      ActionController::Base.helper(ViteRails::Helper)
+      ActionController::Base.helper(ViteRails::TagHelpers)
     end
 
     ActiveSupport.on_load(:action_view) do
-      include ViteRails::Helper
+      include ViteRails::TagHelpers
     end
   end
 
   initializer 'vite_rails.logger' do
     config.after_initialize do
-      ViteRails.logger = if ::Rails.logger.respond_to?(:tagged)
-                           ::Rails.logger
-                         else
-                           ActiveSupport::TaggedLogging.new(::Rails.logger)
-                         end
+      ViteRuby.instance.logger = Rails.logger
     end
   end
 
   initializer 'vite_rails.bootstrap' do
     if defined?(Rails::Server) || defined?(Rails::Console)
-      ViteRails.bootstrap
+      ViteRuby.bootstrap
       if defined?(Spring)
         require 'spring/watcher'
-        Spring.after_fork { ViteRails.bootstrap }
-        Spring.watch(ViteRails.config.config_path)
+        Spring.after_fork { ViteRuby.bootstrap }
+        Spring.watch(ViteRuby.config.config_path)
       end
     end
   end

data/lib/vite_rails/installation.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'vite_rails'
+
+# Internal: Extends the base installation script from Vite Ruby to work for a
+# typical Rails app.
+module ViteRails::Installation
+  RAILS_TEMPLATES = Pathname.new(File.expand_path('../../templates', __dir__))
+
+  # Override: Setup a typical apps/web Hanami app to use Vite.
+  def setup_app_files
+    cp RAILS_TEMPLATES.join('config/rails-vite.json'), config.config_path
+    setup_content_security_policy root.join('config/initializers/content_security_policy.rb')
+  end
+
+  # Internal: Configure CSP rules that allow to load @vite/client correctly.
+  def setup_content_security_policy(csp_file)
+    return unless csp_file.exist?
+
+    inject_line_after csp_file, 'policy.script_src', <<-CSP
+    # You may need to enable this in production as well depending on your setup.
+    policy.script_src *policy.script_src, :blob if Rails.env.test?
+    CSP
+    inject_line_after csp_file, 'policy.connect_src', <<-CSP
+    # Allow @vite/client to hot reload changes in development
+    policy.connect_src *policy.connect_src, "ws://\#{ ViteRuby.config.host_with_port }" if Rails.env.development?
+    CSP
+    inject_line_after csp_file, 'policy.script_src', <<-CSP
+    # Allow @vite/client to hot reload changes in development
+    policy.script_src *policy.script_src, :unsafe_eval, "http://#{ ViteRuby.config.host_with_port }" if Rails.env.development?
+    CSP
+  end
+
+  # Override: Create a sample JS file and attempt to inject it in an HTML template.
+  def install_sample_files
+    cp RAILS_TEMPLATES.join('entrypoints/application.js'), config.resolved_entrypoints_dir.join('application.js')
+
+    if (layout_file = root.join('app/views/layouts/application.html.erb')).exist?
+      inject_line_before layout_file, '</head>', <<-HTML
+    <%= vite_client_tag %>
+    <%= vite_javascript_tag 'application' %>
+      HTML
+    end
+  end
+end
+
+ViteRuby::CLI::Install.prepend(ViteRails::Installation)