minivite_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 346d0e1dda504de6fe45499ad41cbc3d1561aea6be67b7703c4a4beb67df27c5
+  data.tar.gz: f9f7fa0218f21622446b89a095d6d5ec4631ff4df8cd216172673c209d83c92c
+SHA512:
+  metadata.gz: 33b98d69cca67c961f6af9efadd61499b71f2e97b0585275fa6c1d2d67092bd1c7ae592f4ee356fead6d9acb5a518c94812ef115a2441b2dffd7e2a72e79adca
+  data.tar.gz: 7d7b59b04ed4f778b9fa079eac169af790802d40c89f01d273f5eb85bc1faa0a6b76396da051eb1ac10024fbfe3553b424ea7d07aefe4fe71c257b8d389dce4d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,7 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+Layout/LineLength:
+  Max: 120

data/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "cSpell.words": [
+    "Minivite",
+    "vite"
+  ]
+}

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in minivite_rails.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,126 @@
+PATH
+  remote: .
+  specs:
+    minivite_rails (0.1.0)
+      actionview (>= 6.0.0)
+      railties (>= 6.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.4.2)
+      actionview (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.4.2)
+      activesupport (= 7.0.4.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.4.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.2.0)
+    crass (1.0.6)
+    debug (1.7.1)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    erubi (1.12.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.6.2)
+      reline (>= 0.3.0)
+    json (2.6.3)
+    loofah (2.19.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    minitest (5.17.0)
+    nokogiri (1.14.1-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rack (2.2.6.2)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (7.0.4.2)
+      actionpack (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    reline (0.3.2)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.42.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    rubocop-rspec (2.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.11.0)
+    thor (1.2.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-darwin-22
+
+DEPENDENCIES
+  debug (~> 1.0)
+  minivite_rails!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rspec (~> 2.18)
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Linh Tran
+
+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,201 @@
+# MiniviteRails
+
+MiniviteRails provides minimal integration with [Vite](https://vitejs.dev/) for Rails projects.
+
+__DISCLAIMER:__ This gem is not thoroughly tested and is not yet ready for production use. For battle-tested and full featured integration with Vite for not only Rails but Ruby projects, please check out [vite_ruby](https://vite-ruby.netlify.app/). In fact, this gem reuses a lot of code from [vite_ruby](https://vite-ruby.netlify.app/) and is intended just for my projects' specific use cases that requires full manual control over Vite's configuration and build process.
+
+## Features
+
+* Rails view helpers to resolve paths to assets which are built by Vite (both by Vite's dev server and by Vite's build process).
+* Support multiple configurations for Vite
+
+### Notes
+
+* MiniviteRails does not automatically install Vite and manage Vite's configuration. You must install Vite, its dependencies and manage Vite's configuration manually.
+* It also does not provide any integration with Rails' asset pipeline. So you must use Vite to build all your assets.
+
+If you need above features, please use [vite_ruby](https://vite-ruby.netlify.app/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minivite_rails'
+```
+
+And then run:
+
+```sh
+$ bundle install
+```
+
+## Configuration
+
+After installed, configure your Rails app below as a new file `config/initializers/minivite_rails.rb`.
+
+```rb
+MiniviteRails.configuration do |c|
+  # By default c.cache is set to `false`, which means an application always parses a
+  # manifest.json. In development, you should set cache false usually.
+  # Instead, setting it `true` which caches the manifest in memory is recommended basically.
+  c.cache = Rails.env.production?
+
+  # Register vite dev server address here, if you are using vite dev server.
+  # It will only be used in development mode.
+  c.vite_dev_server = 'http://127.0.0.1:5173'
+
+  # Vite base path, default will be `/vite`
+  # c.public_base_path = '/vite'
+
+  # Vite public directory, default will be `public`
+  # c.public_dir, default: 'public'
+
+  # Vite manifest file path, default will be `#{c.public_dir}#{c.public_base_path}/manifest.json`
+  # c.manifest_path = "#{c.public_dir}#{c.public_base_path}/manifest.json"
+end
+```
+
+With the above default configuration, you are expected to have a Vite's configuration like below:
+
+```js
+import { fileURLToPath, URL } from 'node:url'
+
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+
+export default defineConfig({
+  base: '/vite',
+  plugins: [vue()],
+  build: {
+    manifest: true, // This is required
+    rollupOptions: {
+      input: fileURLToPath(new URL('./src/main.ts', import.meta.url)) // The entry file of your application, it will depends on your project structure
+    },
+    // For this example, the frontend code and vite configuration file are directly in a child folder from the root of the Rails project.
+    outDir: fileURLToPath(new URL('../public/vite', import.meta.url)),
+    emptyOutDir: true,
+  },
+  server: {
+    origin: 'http://127.0.0.1:5173' // For referencing assets from vite dev server
+  }
+})
+```
+
+## Usage
+
+### Rails view helpers
+
+Use the following helpers in your Rails views to resolve paths to assets which are built by Vite.
+
+### `vite_javascript_tag`
+
+Renders a `<script>` tag for the specified Vite js entrypoints. This is the most commonly used helper and will also load needed css entrypoints.
+
+```erb
+<%= vite_javascript_tag 'src/main.js' %>
+```
+
+### `vite_typescript_tag`
+
+Same as `vite_javascript_tag` but for typescript entrypoints
+
+### `vite_stylesheet_tag`
+
+Renders a `<link>` tag for the specified Vite css entrypoints
+
+```erb
+<%= vite_stylesheet_tag 'app.css' %>
+```
+
+### `vite_client_tag`
+
+Render a script tag to load vite/client to enable HMR
+
+```erb
+<%= vite_client_tag %>
+```
+
+### `vite_react_refesth_tag`
+
+Render a script tag to enable HMR with React Refresh
+
+```erb
+<%= vite_react_refesh_tag %>
+```
+
+### `vite_asset_path`
+
+Render a path to a specified asset built by Vite
+
+```erb
+<%= vite_asset_path 'calender.js' %>
+```
+
+### `vite_asset_url`
+
+Same as `vite_asset_path` but returns a full URL
+
+### `vite_image_tag`
+
+Renders an `<img>` tag for the specified Vite image asset
+
+```erb
+<%= vite_image_tag 'logo.png' %>
+```
+
+### Multiple configurations
+
+Besides the main configuration, you can also register multiple configurations for Vite. For example, you may want to have a separate configuration for your admin panel.
+
+```rb
+MiniviteRails.configuration do |c|
+  # Main configuration
+  c.cache = Rails.env.production?
+  c.vite_dev_server = 'http://127.0.0.1:5173'
+
+  # Sub configuration for admin panel
+  c.add :admin do |sc|
+    sc.public_base_path = '/vite_admin'
+    sc.vite_dev_server = 'http://127.0.0.1:5174'
+  end
+end
+```
+
+And the corresponding Vite configuration for admin panel:
+
+```js
+import { fileURLToPath, URL } from 'node:url'
+import { defineConfig } from 'vite'
+import react from '@vitejs/plugin-react'
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  base: '/vite_ops/',
+  plugins: [react()],
+  build: {
+    manifest: true, // This is required
+    rollupOptions: {
+      input: fileURLToPath(new URL('./src/main.jsx', import.meta.url))
+    },
+    outDir: fileURLToPath(new URL('../public/vite_admin', import.meta.url)),
+    emptyOutDir: true,
+  },
+  server: {
+    port: 5174,
+    origin: 'http://127.0.0.1:5174'
+  }
+})
+
+```
+
+## Special Thanks
+
+This project uses ideas and codes from the following projects:
+
+* [vite_ruby](https://github.com/ElMassimo/vite_ruby)
+* [minipack](https://github.com/nikushi/minipack)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/minivite_rails/configuration.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module MiniviteRails
+  class Configuration
+    class Error < StandardError; end
+
+    ROOT_DEFAULT_ID = :''
+
+    class << self
+      def config_attr(prop, default: nil)
+        define_method(prop) do
+          # If not overridden, children will use parent's setting
+          @config.fetch(prop) do
+            @parent ? @parent.public_send(prop) : default
+          end
+        end
+
+        define_method("#{prop}=".to_sym) do |v|
+          @config[prop] = v
+        end
+      end
+    end
+
+    # Private
+    config_attr :id, default: ROOT_DEFAULT_ID
+    config_attr :cache, default: false
+    # The base directory of the frontend.
+    config_attr :vite_dev_server
+    config_attr :manifest_path
+    config_attr :public_base_path, default: '/vite'
+    config_attr :public_dir, default: 'public'
+
+    # Initializes a new instance of Configuration class.
+    def initialize
+      @parent = nil
+      @children = {}
+      @config = {}
+    end
+
+    def public_asset_dir
+      File.expand_path('.', File.join(public_dir, public_base_path))
+    end
+
+    def manifest
+      @manifest ||= Manifest.new(self)
+    end
+
+    def reload_manifest
+      @manifest&.update_config(self)
+      @children.each_value(&:reload_manifest)
+    end
+
+    def add(id)
+      raise Error, 'Can only define sub configuration from root config' unless root?
+      raise Error, 'Id already used by root configuration' if id == @config[:id]
+
+      @children[id] ||= self.class.new.tap do |c|
+        c.instance_variable_set(:@parent, self)
+        c.instance_variable_set(:@children, nil)
+        c.id = id
+        yield c if block_given?
+      end
+    end
+
+    def child_by_id(id)
+      raise Error, 'Can only get sub configuration from root config' unless root?
+
+      return self if id == @config[:id] # return itself if id is root id
+
+      @children.fetch(id)
+    rescue KeyError
+      raise Error, "No sub configuration with id #{id}"
+    end
+
+    def root?
+      @parent.nil?
+    end
+  end
+end

data/lib/minivite_rails/manifest.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+# Modified from vite_ruby's source code
+# https://github.com/ElMassimo/vite_ruby/blob/main/vite_ruby/lib/vite_ruby/manifest.rb
+
+require 'json'
+require 'active_support/core_ext/object/blank'
+require 'rails'
+
+module MiniviteRails
+  class Manifest
+    class FileNotFoundError < StandardError; end
+    class MissingEntryError < StandardError; end
+
+    attr_reader :config, :manifest_path
+
+    def initialize(config)
+      update_config(config)
+    end
+
+    def update_config(config)
+      @config = config
+      @manifest_path = config.manifest_path || File.join(config.public_asset_dir, 'manifest.json')
+      @data = nil
+    end
+
+    def data
+      return load_manifest unless config.cache
+
+      @data ||= load_manifest
+    end
+
+    def path_for(name, **options)
+      lookup!(name, **options).fetch('file')
+    end
+
+    def vite_client_src
+      prefix_vite_asset('@vite/client') if dev_server_available?
+    end
+
+    def resolve_entries(*names, **options)
+      entries = names.map { |name| lookup!(name, **options) }
+      script_paths = entries.map { |entry| entry.fetch('file') }
+
+      imports = dev_server_available? ? [] : entries.flat_map { |entry| entry['imports'] }.compact.uniq
+      {
+        scripts: script_paths,
+        imports: imports.map { |entry| entry.fetch('file') }.uniq,
+        stylesheets: dev_server_available? ? [] : (entries + imports).flat_map { |entry| entry['css'] }.compact.uniq
+      }
+    end
+
+    def react_refresh_preamble
+      return unless dev_server_available?
+
+      <<~REACT_REFRESH
+        <script type="module">
+          import RefreshRuntime from '#{prefix_vite_asset('@react-refresh')}'
+          RefreshRuntime.injectIntoGlobalHook(window)
+          window.$RefreshReg$ = () => {}
+          window.$RefreshSig$ = () => (type) => type
+          window.__vite_plugin_react_preamble_installed__ = true
+        </script>
+      REACT_REFRESH
+    end
+
+    protected
+
+    def dev_server_available?
+      !Rails.env.production? && config.vite_dev_server.present?
+    end
+
+    def load_manifest
+      u = URI.parse(manifest_path)
+      data = nil
+      if u.scheme == 'file' || u.path == manifest_path # file path
+        raise(FileNotFoundError, "#{manifest_path}: no such manifest found") unless File.exist?(manifest_path)
+
+        data = File.read(manifest_path)
+      else
+        # http url
+        data = u.read
+      end
+      JSON.parse(data).tap(&method(:resolve_references))
+    end
+
+    def prefix_vite_asset(path)
+      root_path = dev_server_available? ? config.vite_dev_server : '/'
+      File.join(root_path, config.public_base_path, path)
+    end
+
+    # Internal: Resolves the paths that reference a manifest entry.
+    def resolve_references(manifest)
+      manifest.each_value do |entry|
+        entry['file'] = prefix_vite_asset(entry['file'])
+        %w[css assets].each do |key|
+          entry[key] = entry[key].map { |path| prefix_vite_asset(path) } if entry[key]
+        end
+        entry['imports']&.map! { |name| manifest.fetch(name) }
+      end
+    end
+
+    def lookup!(name, **options)
+      lookup(name, **options) || missing_entry_error(name, **options)
+    end
+
+    # Internal: Computes the path for a given Vite asset using manifest.json.
+    #
+    # Returns a relative path, or nil if the asset is not found.
+    #
+    # Example:
+    #   manifest.lookup('calendar.js')
+    #   => { "file" => "/vite/assets/calendar-1016838bab065ae1e122.js", "imports" => [] }
+    def lookup(name, **options)
+      find_manifest_entry resolve_entry_name(name, **options)
+    end
+
+    def find_manifest_entry(name)
+      if dev_server_available?
+        { 'file' => prefix_vite_asset(name) }
+      else
+        data[name]
+      end
+    end
+
+    def resolve_entry_name(name, type: nil)
+      return resolve_virtual_entry(name) if type == :virtual
+
+      name = with_file_extension(name.to_s, type)
+      raise ArgumentError, "Asset names can not be relative. Found: #{name}" if name.start_with?('.')
+
+      # Explicit path, relative to the source_code_dir.
+      name.sub(%r{^~/(.+)$}) { return Regexp.last_match(1) }
+      name
+    end
+
+    # Internal: Resolves a virtual entry by walking all the manifest keys.
+    def resolve_virtual_entry(name)
+      data.keys.find { |file| file.include?(name) } || name
+    end
+
+    # Internal: Adds a file extension to the file name, unless it already has one.
+    def with_file_extension(name, entry_type)
+      if File.extname(name).empty? && (ext = extension_for_type(entry_type))
+        "#{name}.#{ext}"
+      else
+        name
+      end
+    end
+
+    # Internal: Allows to receive :javascript and :stylesheet as :type in helpers.
+    def extension_for_type(entry_type)
+      case entry_type
+      when :javascript then 'js'
+      when :stylesheet then 'css'
+      when :typescript then 'ts'
+      else entry_type
+      end
+    end
+
+    # Internal: Raises a detailed message when an entry is missing in the manifest.
+    def missing_entry_error(name, **_options)
+      raise MissingEntryError, <<~MSG
+        Can not find #{name} in #{manifest_path}.
+        Your manifest contains:
+        #{JSON.pretty_generate(data)}
+      MSG
+    end
+  end
+end

data/lib/minivite_rails/tag_helpers.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+# Use tag helpers from Vite Ruby
+# https://github.com/ElMassimo/vite_ruby/blob/main/vite_rails/lib/vite_rails/tag_helpers.rb
+
+# Public: Allows to render HTML tags for scripts and styles processed by Vite.
+module MiniviteRails
+  module TagHelpers
+    # Public: Renders a script tag for vite/client to enable HMR in development.
+    def vite_client_tag(id: nil, **options)
+      src = vite_manifest(id: id).vite_client_src
+      return unless src
+
+      javascript_include_tag(src, type: 'module', extname: false, **options)
+    end
+
+    # Public: Renders a script tag to enable HMR with React Refresh.
+    def vite_react_refresh_tag(id: nil)
+      vite_manifest(id: id).react_refresh_preamble&.html_safe
+    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, id: nil, **options)
+      path_to_asset vite_manifest(id: id).path_for(name, **options)
+    end
+
+    # Public: Resolves the url for the specified Vite asset.
+    #
+    # Example:
+    #   <%= vite_asset_url 'calendar.css' %> # => "https://example.com/vite/assets/calendar-1016838bab065ae1e122.css"
+    def vite_asset_url(name, id: nil, **options)
+      url_to_asset vite_manifest(id: id).path_for(name, **options)
+    end
+
+    # Public: Renders a <script> tag for the specified Vite entrypoints.
+    def vite_javascript_tag(*names,
+                            id: nil,
+                            type: 'module',
+                            asset_type: :javascript,
+                            skip_preload_tags: false,
+                            skip_style_tags: false,
+                            crossorigin: 'anonymous',
+                            media: 'screen',
+                            **options)
+      entries = vite_manifest(id: id).resolve_entries(*names, type: asset_type)
+      tags = javascript_include_tag(*entries.fetch(:scripts), crossorigin: crossorigin, type: type, extname: false,
+                                                              **options)
+      tags << vite_preload_tag(*entries.fetch(:imports), crossorigin: crossorigin, **options) unless skip_preload_tags
+
+      options[:extname] = false if Rails::VERSION::MAJOR >= 7
+
+      tags << stylesheet_link_tag(*entries.fetch(:stylesheets), media: media, **options) unless skip_style_tags
+
+      tags
+    end
+
+    # Public: Renders a <script> tag for the specified Vite entrypoints.
+    def vite_typescript_tag(*names, id: nil, **options)
+      vite_javascript_tag(*names, id: id, asset_type: :typescript, **options)
+    end
+
+    # Public: Renders a <link> tag for the specified Vite entrypoints.
+    def vite_stylesheet_tag(*names, id: nil, **options)
+      style_paths = names.map { |name| vite_asset_path(name, id: id, type: :stylesheet) }
+
+      options[:extname] = false if Rails::VERSION::MAJOR >= 7
+
+      stylesheet_link_tag(*style_paths, **options)
+    end
+
+    # Public: Renders an <img> tag for the specified Vite asset.
+    def vite_image_tag(name, id: nil, **options)
+      if options[:srcset] && !options[:srcset].is_a?(String)
+        options[:srcset] = options[:srcset].map do |src_name, size|
+          "#{vite_asset_path(src_name, id: id)} #{size}"
+        end.join(', ')
+      end
+
+      image_tag(vite_asset_path(name, id: id), options)
+    end
+
+    private
+
+    # Internal: Returns the current manifest loaded by Vite Ruby.
+    def vite_manifest(id: nil)
+      MiniviteRails.manifest(id: id)
+    end
+
+    # Internal: Renders a modulepreload link tag.
+    def vite_preload_tag(*sources, crossorigin:, **options)
+      sources.map do |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, **options)
+      end.join("\n").html_safe
+    end
+  end
+end

data/lib/minivite_rails/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MiniviteRails
+  VERSION = '0.1.0'
+end

data/lib/minivite_rails.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module MiniviteRails
+  require 'minivite_rails/configuration'
+  require 'minivite_rails/manifest'
+  require 'minivite_rails/tag_helpers'
+  require 'minivite_rails/version'
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+      yield @configuration if block_given?
+      @configuration
+    end
+
+    def manifest(id: nil)
+      raise 'MiniviteRails is not configured' if @configuration.nil?
+
+      return @configuration.manifest if id.nil?
+
+      @configuration.child_by_id(id).manifest
+    end
+  end
+end
+
+require 'active_support/lazy_load_hooks'
+ActiveSupport.on_load :action_view do
+  ::ActionView::Base.include MiniviteRails::TagHelpers
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: minivite_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Linh Tran
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+description: Minivite Ruby Gem
+email:
+- linh.mtran168@live.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".vscode/settings.json"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/minivite_rails.rb
+- lib/minivite_rails/configuration.rb
+- lib/minivite_rails/manifest.rb
+- lib/minivite_rails/tag_helpers.rb
+- lib/minivite_rails/version.rb
+homepage: https://github.com/linhmtran168/minivite_rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/linhmtran168/minivite_rails
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Minivite Ruby Gem
+test_files: []