vite_rails 1.0.9 → 2.0.1

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)

data/lib/vite_rails/tag_helpers.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# Public: Allows to render HTML tags for scripts and styles processed by Vite.
+module ViteRails::TagHelpers
+  # Public: Renders a script tag for vite/client to enable HMR in development.
+  def vite_client_tag
+    return unless src = vite_manifest.vite_client_src
+
+    tag.script(src: src, type: 'module')
+  end
+
+  # 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)
+    path_to_asset vite_manifest.path_for(name, **options)
+  end
+
+  # Public: Renders a <script> tag for the specified Vite entrypoints.
+  def vite_javascript_tag(*names,
+                          type: 'module',
+                          asset_type: :javascript,
+                          skip_preload_tags: false,
+                          skip_style_tags: false,
+                          crossorigin: 'anonymous',
+                          **options)
+    entries = vite_manifest.resolve_entries(*names, type: asset_type)
+    tags = javascript_include_tag(*entries.fetch(:scripts), crossorigin: crossorigin, type: type, **options)
+    tags << vite_preload_tag(*entries.fetch(:imports), crossorigin: crossorigin) unless skip_preload_tags
+    tags << stylesheet_link_tag(*entries.fetch(:stylesheets)) unless skip_style_tags
+    tags
+  end
+
+  # Public: Renders a <script> tag for the specified Vite entrypoints.
+  def vite_typescript_tag(*names, **options)
+    vite_javascript_tag(*names, asset_type: :typescript, extname: false, **options)
+  end
+
+  # Public: Renders a <link> tag for the specified Vite entrypoints.
+  def vite_stylesheet_tag(*names, **options)
+    style_paths = names.map { |name| vite_asset_path(name, type: :stylesheet) }
+    stylesheet_link_tag(*style_paths, **options)
+  end
+
+private
+
+  # Internal: Returns the current manifest loaded by Vite Ruby.
+  def vite_manifest
+    ViteRuby.instance.manifest
+  end
+
+  # Internal: Renders a modulepreload link tag.
+  def vite_preload_tag(*sources, crossorigin:)
+    sources.map { |source|
+      href = path_to_asset(source)
+      try(:request).try(:send_early_hints, 'Link' => %(<#{ href }>; rel=modulepreload; as=script; crossorigin=#{ crossorigin }))
+      tag.link(rel: 'modulepreload', href: href, as: 'script', crossorigin: crossorigin)
+    }.join("\n").html_safe
+  end
+end

data/lib/vite_rails/version.rb

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

data/{test/mounted_app/test/dummy/config/vite.json → templates/config/rails-vite.json}

@@ -1,5 +1,6 @@
 {
   "all": {
+    "sourceCodeDir": "app/frontend",
     "watchAdditionalPaths": []
   },
   "development": {

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: vite_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 2.0.1
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,41 +25,41 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.1'
 - !ruby/object:Gem::Dependency
-  name: rack-proxy
+  name: vite_ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
-  type: :runtime
+        version: 1.3.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
-  name: zeitwerk
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -67,33 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.93.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.93.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -119,74 +105,21 @@ files:
 - CONTRIBUTING.md
 - LICENSE.txt
 - README.md
-- lib/install/bin/vite
-- lib/install/binstubs.rb
-- lib/install/config/vite.config.ts
-- lib/install/config/vite.json
-- lib/install/javascript/entrypoints/application.js
-- lib/install/template.rb
-- lib/tasks/vite/binstubs.rake
-- lib/tasks/vite/build.rake
-- lib/tasks/vite/clean.rake
-- lib/tasks/vite/clobber.rake
-- lib/tasks/vite/info.rake
-- lib/tasks/vite/install.rake
-- lib/tasks/vite/install_dependencies.rake
-- lib/tasks/vite/verify_install.rake
+- lib/tasks/vite.rake
 - lib/vite_rails.rb
-- lib/vite_rails/builder.rb
-- lib/vite_rails/commands.rb
 - lib/vite_rails/config.rb
-- lib/vite_rails/dev_server.rb
-- lib/vite_rails/dev_server_proxy.rb
 - lib/vite_rails/engine.rb
-- lib/vite_rails/helper.rb
-- lib/vite_rails/manifest.rb
-- lib/vite_rails/runner.rb
+- lib/vite_rails/installation.rb
+- lib/vite_rails/tag_helpers.rb
 - lib/vite_rails/version.rb
-- package.json
-- package/default.vite.json
-- test/builder_test.rb
-- test/commands_test.rb
-- test/configuration_test.rb
-- test/dev_server_proxy_test.rb
-- test/dev_server_test.rb
-- test/engine_rake_tasks_test.rb
-- test/helper_test.rb
-- test/manifest_test.rb
-- test/mode_test.rb
-- test/mounted_app/Rakefile
-- test/mounted_app/test/dummy/Rakefile
-- test/mounted_app/test/dummy/bin/rails
-- test/mounted_app/test/dummy/bin/rake
-- test/mounted_app/test/dummy/config.ru
-- test/mounted_app/test/dummy/config/application.rb
-- test/mounted_app/test/dummy/config/environment.rb
-- test/mounted_app/test/dummy/config/vite.json
-- test/mounted_app/test/dummy/package.json
-- test/mounted_app/test/dummy/yarn.lock
-- test/rake_tasks_test.rb
-- test/runner_test.rb
-- test/test_app/Rakefile
-- test/test_app/app/frontend/entrypoints/application.js
-- test/test_app/bin/vite
-- test/test_app/config.ru
-- test/test_app/config/application.rb
-- test/test_app/config/environment.rb
-- test/test_app/config/vite.json
-- test/test_app/config/vite_additional_paths.json
-- test/test_app/config/vite_public_dir.json
-- test/test_app/package.json
-- test/test_app/public/vite-production/manifest.json
-- test/test_app/some.config.js
-- test/test_app/yarn.lock
-- test/test_helper.rb
-homepage: https://github.com/ElMassimo/vite_rails
+- templates/config/rails-vite.json
+- templates/entrypoints/application.js
+homepage: https://github.com/ElMassimo/vite_ruby
 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_ruby/tree/vite_rails@2.0.1/vite_rails
+  changelog_uri: https://github.com/ElMassimo/vite_ruby/blob/vite_rails@2.0.1/vite_rails/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -195,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -206,39 +139,4 @@ rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 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/dev_server_proxy_test.rb
-- test/dev_server_test.rb
-- test/engine_rake_tasks_test.rb
-- test/helper_test.rb
-- test/manifest_test.rb
-- test/mode_test.rb
-- test/mounted_app/Rakefile
-- test/mounted_app/test/dummy/Rakefile
-- test/mounted_app/test/dummy/bin/rails
-- test/mounted_app/test/dummy/bin/rake
-- test/mounted_app/test/dummy/config.ru
-- test/mounted_app/test/dummy/config/application.rb
-- test/mounted_app/test/dummy/config/environment.rb
-- test/mounted_app/test/dummy/config/vite.json
-- test/mounted_app/test/dummy/package.json
-- test/mounted_app/test/dummy/yarn.lock
-- test/rake_tasks_test.rb
-- test/runner_test.rb
-- test/test_app/Rakefile
-- test/test_app/app/frontend/entrypoints/application.js
-- test/test_app/bin/vite
-- test/test_app/config.ru
-- test/test_app/config/application.rb
-- test/test_app/config/environment.rb
-- test/test_app/config/vite.json
-- test/test_app/config/vite_additional_paths.json
-- test/test_app/config/vite_public_dir.json
-- test/test_app/package.json
-- test/test_app/public/vite-production/manifest.json
-- test/test_app/some.config.js
-- test/test_app/yarn.lock
-- test/test_helper.rb
+test_files: []

data/lib/install/bin/vite

@@ -1,17 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-ENV['RAILS_ENV'] ||= ENV['RACK_ENV'] || 'development'
-ENV['NODE_ENV']  ||= ENV['RAILS_ENV'] == 'development' ? 'development' : 'production'
-
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
-
-require 'bundler/setup'
-
-require 'vite_rails'
-
-APP_ROOT = File.expand_path('..', __dir__)
-Dir.chdir(APP_ROOT) do
-  ViteRails.run(ARGV)
-end

data/lib/install/binstubs.rb

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

data/lib/install/config/vite.config.ts

@@ -1,11 +0,0 @@
-import { defineConfig } from 'vite'
-import RubyPlugin from 'vite-plugin-ruby'
-
-export default defineConfig({
-  plugins: [
-    RubyPlugin(),
-  ],
-  optimizeDeps: {
-    exclude: [/webpack/, /vite-plugin-ruby/],
-  },
-})

data/lib/install/config/vite.json

@@ -1,14 +0,0 @@
-{
-  "all": {
-    "watchAdditionalPaths": []
-  },
-  "development": {
-    "autoBuild": true,
-    "publicOutputDir": "vite-dev",
-    "port": 3036
-  },
-  "test": {
-    "autoBuild": true,
-    "publicOutputDir": "vite-test"
-  }
-}

data/lib/install/template.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-# Install Vite Rails
-say 'Creating configuration files'
-copy_file "#{ __dir__ }/config/vite.json", ViteRails.config.config_path
-copy_file "#{ __dir__ }/config/vite.config.ts", Rails.root.join('vite.config.ts')
-
-say 'Creating entrypoints directory'
-directory "#{ __dir__ }/javascript/entrypoints", ViteRails.config.resolved_entrypoints_dir
-
-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
-
-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 "yarn add vite@#{ vite_version } vite-plugin-ruby@#{ plugin_version }"
-end
-
-say 'Vite ⚡️ Rails successfully installed! 🎉', :green