vite_rails 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7036c3650b1b44c82158220474b56e26488785cefb0a99044444708d603001a
-  data.tar.gz: 8161dbb668ff8c2308de6783e1dbff81faf60b13cd87393348070a2f8b2f9c18
+  metadata.gz: de1ef14e664eb5f06527b1126e5508598d50289c855edbf27d6e373f6ba805e1
+  data.tar.gz: 6754500ef38d0dcaba0e7d89de42da5b6f51fff79e215d9a4b02f116a332e13d
 SHA512:
-  metadata.gz: a5ecb6327e2009b5fcf8aa91f90989264538db013dafc4b34a361e11b60a8d69bd394d6c6e5043583ff1cfe35fe5464424e26b616304ee30089c9e5a06fa2bda
-  data.tar.gz: 04124e8f3c0063b1461185fbfb665623b0c49c6ea3712952a857eb1bb00886e420ae64335609f4879377013ef7f32506ef84400af52f9a3385c90b9b5c025193
+  metadata.gz: 3207af12e9a3304b12da3f549c4ae1fe2610bb9a5511f164040b8a7e82e2324b472ebbc90163142db6fa06a5752acac2f38fb0c6ecefed0690ae6f8c2981702f
+  data.tar.gz: c84109e20d0ba02b594de5e99922abeee23cc69146b955816c29aed23a1b65cc1db7e6e39eae67458fb8ceb74b38784e22fad5ac98f6c209f5697e46e0bca9ac

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Vite Rails 1.0.10  (2020-01-23)
+
+- Use `path_to_asset` in `vite_asset_path` so that it's prefixed automatically
+  when using a CDN (`config.action_controller.asset_host`).
+
 ## Vite Rails 1.0.9  (2020-01-22)
 
 - Ensure `configPath` and `publicDir` are scoped from `root`, both in Ruby and JS.

data/README.md

@@ -1,15 +1,15 @@
 <h1 align="center">
   Vite ⚡️ Rails
   <p align="center">
-<!--     <a href="https://github.com/ElMassimo/vite_rails/actions">
+    <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">
+    </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>
     <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>

data/lib/vite_rails/builder.rb

@@ -68,7 +68,7 @@ private
     logger.info 'Building with Vite ⚡️'
 
     command = "#{ which_ruby } ./bin/vite build --mode #{ config.mode }"
-    stdout, stderr, status = Open3.capture3(vite_env, command, chdir: File.expand_path(config.root))
+    stdout, stderr, status = Open3.capture3(ViteRails.config.to_env, command, chdir: File.expand_path(config.root))
 
     log_build_result(stdout, stderr, status)
 
@@ -108,13 +108,4 @@ private
       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

@@ -29,6 +29,7 @@ class ViteRails::Commands
   def clobber
     config.build_output_dir.rmtree if config.build_output_dir.exist?
     config.build_cache_dir.rmtree if config.build_cache_dir.exist?
+    config.vite_cache_dir.rmtree if config.vite_cache_dir.exist?
   end
 
   # Public: Receives arguments from a rake task.

data/lib/vite_rails/config.rb

@@ -9,11 +9,6 @@ class ViteRails::Config
 
   def initialize(attrs)
     @config = attrs.tap { |config| coerce_values(config) }.freeze
-
-    # Define getters for the configuration options.
-    CONFIGURABLE_WITH_ENV.each do |option|
-      define_singleton_method(option) { @config[option] }
-    end
   end
 
   def protocol
@@ -31,12 +26,26 @@ class ViteRails::Config
 
   # Public: The directory where Vite will store the built assets.
   def build_output_dir
-    public_dir.join(public_output_dir)
+    root.join(public_dir, public_output_dir)
   end
 
   # Public: The directory where the entries are located.
   def resolved_entrypoints_dir
-    source_code_dir.join(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
@@ -46,13 +55,9 @@ private
   def coerce_values(config)
     config['mode'] = config['mode'].to_s
     config['port'] = config['port'].to_i
+    coerce_paths(config, 'root', 'public_output_dir')
+    config['build_cache_dir'] = config['root'].join(config['build_cache_dir'])
     coerce_booleans(config, 'auto_build', 'hide_build_console_output', 'https')
-    coerce_paths(config, 'config_path', 'public_output_dir', 'root')
-
-    # Prefix paths that are relative to the project root.
-    config.slice('build_cache_dir', 'public_dir', 'source_code_dir').each do |option, dir|
-      config[option] = config['root'].join(dir) if dir
-    end
   end
 
   # Internal: Coerces configuration options to boolean.
@@ -68,38 +73,46 @@ private
   class << self
     # Public: Returns the project configuration for Vite.
     def resolve_config(attrs = {})
-      attrs = attrs.transform_keys(&:to_s)
-      mode = (attrs['mode'] ||= config_option_from_env('mode') || Rails.env.to_s).to_s
-      root = Pathname.new(attrs['root'] ||= config_option_from_env('root') || Rails.root || Dir.pwd)
-      config_path = (attrs['config_path'] ||= config_option_from_env('config_path') || DEFAULT_CONFIG.fetch('config_path'))
-      file_attrs = config_from_file(root: root, mode: mode, config_path: config_path)
-      new DEFAULT_CONFIG.merge(file_attrs).merge(config_from_env).merge(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 config_option_from_env(name)
+    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 |key, env_vars|
-        if value = config_option_from_env(key)
-          env_vars[key] = value
+      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(root:, mode:, config_path:)
-      multi_env_config = load_json(root.join(config_path))
+    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
@@ -111,6 +124,16 @@ private
   # 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]).freeze
+  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] }
+  end
 end

data/lib/vite_rails/dev_server_proxy.rb

@@ -29,7 +29,6 @@ private
   def rewrite_uri_for_vite(env)
     uri = env.fetch('REQUEST_URI') { [env['PATH_INFO'], env['QUERY_STRING']].reject(&:blank?).join('?') }
       .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'] = uri).split('?')
   end
 

data/lib/vite_rails/helper.rb

@@ -2,7 +2,7 @@
 
 # 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
+  DEFAULT_VITE_SKIP_PRELOAD_TAGS = Rails.gem_version < Gem::Version.new('5.2.0')
 
   # Public: Returns the current Vite Rails instance.
   def current_vite_instance
@@ -14,12 +14,12 @@ module ViteRails::Helper
     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.
+  # Public: Resolves the path for the specified 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')
+    path_to_asset current_vite_instance.manifest.lookup!(name, **options).fetch('file')
   end
 
   # Public: Renders a <script> tag for the specified Vite entrypoints.
@@ -53,7 +53,7 @@ module ViteRails::Helper
   # 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)
+    vite_javascript_tag(*names, asset_type: :typescript, extname: false, **options)
   end
 
   # Public: Renders a <link> tag for the specified Vite entrypoints.

data/lib/vite_rails/manifest.rb

@@ -130,9 +130,10 @@ private
     [
       (dev_server_running? && 'Vite has not yet re-built your latest changes.'),
       (local && !dev_server_running? && "\"autoBuild\": false in your #{ config.mode } configuration."),
+      (local && !dev_server_running? && 'The Vite development server has crashed or is no longer available.'),
       'You have misconfigured config/vite.json file.',
       (!local && 'Assets have not been precompiled'),
-    ].select(&:itself)
+    ].compact
   rescue StandardError
     []
   end

data/lib/vite_rails/runner.rb

@@ -33,7 +33,7 @@ private
     cmd.prepend('node', '--trace-deprecation') if args.delete('--trace-deprecation')
     args.append('--mode', ViteRails.mode) unless args.include?('--mode') || args.include?('-m')
     cmd += args
-    Dir.chdir(File.expand_path('.', Dir.pwd)) { Kernel.exec(ViteRails.env, *cmd) }
+    Dir.chdir(File.expand_path('.', Dir.pwd)) { Kernel.exec(ViteRails.config.to_env, *cmd) }
   end
 
   # Internal: Resolves to an executable for Vite.

data/lib/vite_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class ViteRails
-  VERSION = '1.0.9'
+  VERSION = '1.0.10'
 end

data/package.json

@@ -11,6 +11,6 @@
   },
   "dependencies": {
     "vite": "^2.0.0-beta.34",
-    "vite-plugin-ruby": "^1.0.3"
+    "vite-plugin-ruby": "^1.0.4"
   }
 }

data/package/default.vite.json

@@ -1,4 +1,5 @@
 {
+  "assetHost": null,
   "assetsDir": "assets",
   "autoBuild": false,
   "buildCacheDir": "tmp/cache/vite",

data/test/builder_test.rb

@@ -15,7 +15,7 @@ class BuilderTest < ViteRails::Test
   end
 
   def vite_env
-    ViteRails.builder.send(:vite_env)
+    ViteRails.config.to_env
   end
 
   def test_custom_environment_variables

data/test/{configuration_test.rb → config_test.rb}

@@ -2,7 +2,7 @@
 
 require 'test_helper'
 
-class ConfigurationTest < ViteRails::Test
+class ConfigTest < ViteRails::Test
   def expand_path(path)
     File.expand_path(Pathname.new(__dir__).join(path).to_s)
   end
@@ -24,7 +24,7 @@ class ConfigurationTest < ViteRails::Test
   end
 
   def test_source_code_dir
-    assert_path 'test_app/app/frontend', @config.source_code_dir
+    assert_equal 'app/frontend', @config.source_code_dir
   end
 
   def test_entrypoints_dir
@@ -32,7 +32,7 @@ class ConfigurationTest < ViteRails::Test
   end
 
   def test_public_dir
-    assert_path 'test_app/public', @config.public_dir
+    assert_equal 'public', @config.public_dir
   end
 
   def test_build_output_dir
@@ -85,6 +85,17 @@ class ConfigurationTest < ViteRails::Test
     end
   end
 
+  def test_to_env
+    env = @config.to_env
+    assert_nil env['VITE_RUBY_ASSET_HOST']
+
+    Rails.application.config.action_controller.asset_host = 'assets-cdn.com'
+    env = refresh_config.to_env
+    assert_equal env['VITE_RUBY_ASSET_HOST'], 'assets-cdn.com'
+  ensure
+    Rails.application.config.action_controller.asset_host = nil
+  end
+
   def test_environment_vars
     ViteRails.env = {
       'VITE_RUBY_AUTO_BUILD' => 'true',
@@ -106,13 +117,13 @@ class ConfigurationTest < ViteRails::Test
     assert_equal 1920, @config.port
     assert_equal true, @config.https
     assert_equal 'https', @config.protocol
-    assert_equal Pathname.new('config/vite_additional_paths.json'), @config.config_path
+    assert_equal 'config/vite_additional_paths.json', @config.config_path
     assert_pathname 'tmp/vitebuild', @config.build_cache_dir
-    assert_pathname 'pb', @config.public_dir
+    assert_equal 'pb', @config.public_dir
     assert_equal Pathname.new('ft'), @config.public_output_dir
     assert_pathname 'pb/ft', @config.build_output_dir
     assert_equal 'as', @config.assets_dir
-    assert_pathname 'app', @config.source_code_dir
+    assert_equal 'app', @config.source_code_dir
     assert_equal 'frontend/entrypoints', @config.entrypoints_dir
     assert_pathname 'app/frontend/entrypoints', @config.resolved_entrypoints_dir
     assert_equal true, @config.hide_build_console_output

data/test/helper_test.rb

@@ -63,7 +63,7 @@ class HelperTest < ActionView::TestCase
       assert_equal %(<script src="/vite-production/application.js" crossorigin="anonymous" type="module"></script>),
         vite_javascript_tag('application')
 
-      assert_equal %(<script src="/vite-production/application.ts.js" crossorigin="anonymous" type="module"></script>),
+      assert_equal %(<script src="/vite-production/application.ts" crossorigin="anonymous" type="module"></script>),
         vite_typescript_tag('application')
     }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vite_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -148,7 +148,7 @@ files:
 - package/default.vite.json
 - test/builder_test.rb
 - test/commands_test.rb
-- test/configuration_test.rb
+- test/config_test.rb
 - test/dev_server_proxy_test.rb
 - test/dev_server_test.rb
 - test/engine_rake_tasks_test.rb
@@ -185,8 +185,8 @@ homepage: https://github.com/ElMassimo/vite_rails
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/ElMassimo/vite_rails/tree/v1.0.9
-  changelog_uri: https://github.com/ElMassimo/vite_rails/blob/v1.0.9/CHANGELOG.md
+  source_code_uri: https://github.com/ElMassimo/vite_rails/tree/v1.0.10
+  changelog_uri: https://github.com/ElMassimo/vite_rails/blob/v1.0.10/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -209,7 +209,7 @@ summary: Use Vite in Rails and bring joy to your JavaScript experience
 test_files:
 - test/builder_test.rb
 - test/commands_test.rb
-- test/configuration_test.rb
+- test/config_test.rb
 - test/dev_server_proxy_test.rb
 - test/dev_server_test.rb
 - test/engine_rake_tasks_test.rb