better_vite_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8aa9948651f9cdf4792fdc963c80b45192904b1515298aa2a51d5ccda21a7744
+  data.tar.gz: e217785641ddc537f9fba68f254baad56fbe607e8d26224c6b3931d21620a53c
+SHA512:
+  metadata.gz: 77876f7bc002d468e2eb348990fd2898c6983950b708cfd075486d3b625ffe0e7db25ebc6e942a270a412309aa58497d0c19dc9bf7e0cc6c7a2b560693f1ccbd
+  data.tar.gz: a402d5bedc937a416aa28a9403044de878f2e94bcdf49de7f70bd274311b08737c4ef28ba018c20e5d25d0d092e20a5f318f6c117170e88c273a623b16ab442d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Umberto Peserico
+
+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,68 @@
+# BetterViteHelper
+
+Rails Engine providing Vite view helpers with automatic dev server detection and manifest-based asset resolution.
+
+## Requirements
+
+- Ruby >= 3.4.7
+- Rails >= 8.0.0, < 8.2
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "better_vite_helper"
+```
+
+Then run:
+
+```bash
+bundle install
+bin/rails generate better_vite_helper:install
+```
+
+This copies `vite.config.js` and `postcss.config.js` to your application.
+
+## Usage
+
+### View Helpers
+
+```erb
+<%# Include JavaScript entry %>
+<%= vite_javascript_include_tag "application.js" %>
+
+<%# Include stylesheet (production only, Vite handles HMR in dev) %>
+<%= vite_stylesheet_link_tag "application.css" %>
+
+<%# Get asset path directly %>
+<%= vite_asset_path "application.js" %>
+
+<%# Check if dev server is running %>
+<% if vite_development? %>
+  <!-- dev mode -->
+<% end %>
+```
+
+### Configuration
+
+```ruby
+# config/initializers/better_vite_helper.rb
+BetterViteHelper.configure do |config|
+  config.dev_server_url = "http://localhost:5173"  # default, or ENV["VITE_DEV_SERVER_URL"]
+  config.manifest_path = Rails.root.join("public/assets/.vite/manifest.json")  # default
+  config.asset_host = "https://cdn.example.com"  # optional, falls back to Rails.application.config.asset_host
+end
+```
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec           # Run tests
+bin/rubocop -a              # Lint and auto-fix
+```
+
+## 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,15 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bundler/gem_tasks"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake" if File.exist?(APP_RAKEFILE)
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # rspec not available
+end

data/lib/better_vite_helper/configuration.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module BetterViteHelper
+  class Configuration
+    attr_accessor :asset_host
+    attr_writer :manifest_path, :dev_server_url
+
+    def initialize
+      @manifest_path = nil
+      @dev_server_url = nil
+      @asset_host = nil
+    end
+
+    def manifest_path
+      @manifest_path || default_manifest_path
+    end
+
+    def dev_server_url
+      @dev_server_url || ENV.fetch("VITE_DEV_SERVER_URL", "http://localhost:5173")
+    end
+
+    private
+
+    def default_manifest_path
+      Rails.root.join("public/assets/.vite/manifest.json")
+    end
+  end
+end

data/lib/better_vite_helper/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BetterViteHelper
+  class Railtie < ::Rails::Railtie
+    initializer "better_vite_helper.view_helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include BetterViteHelper::ViewHelpers
+      end
+    end
+  end
+end

data/lib/better_vite_helper/version.rb

@@ -0,0 +1,3 @@
+module BetterViteHelper
+  VERSION = "0.1.0"
+end

data/lib/better_vite_helper/view_helpers.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "json"
+
+module BetterViteHelper
+  module ViewHelpers
+    def vite_development?
+      Rails.env.development? && vite_dev_server_running?
+    end
+
+    def vite_dev_server_running?
+      return @vite_dev_server_running if defined?(@vite_dev_server_running)
+
+      @vite_dev_server_running = begin
+        uri = URI("#{BetterViteHelper.configuration.dev_server_url}/")
+        Net::HTTP.get_response(uri)
+        true
+      rescue StandardError
+        false
+      end
+    end
+
+    def vite_manifest
+      return {} if vite_development?
+
+      @vite_manifest ||= begin
+        manifest_path = BetterViteHelper.configuration.manifest_path
+        JSON.parse(File.read(manifest_path))
+      rescue Errno::ENOENT
+        Rails.logger.error "Vite manifest not found at #{manifest_path}"
+        raise "Vite manifest not found. Run 'yarn build' to generate assets."
+      rescue JSON::ParserError => e
+        Rails.logger.error "Invalid Vite manifest: #{e.message}"
+        raise "Invalid Vite manifest format"
+      end
+    end
+
+    def vite_asset_path(entry_name)
+      if vite_development?
+        dev_asset_path(entry_name)
+      else
+        production_asset_path(entry_name)
+      end
+    end
+
+    def vite_javascript_include_tag(entry_name, **options)
+      path = vite_asset_path(entry_name)
+      default_options = { type: "module", defer: true, crossorigin: "anonymous" }
+      javascript_include_tag(path, **default_options.merge(options))
+    end
+
+    def vite_stylesheet_link_tag(entry_name, **options)
+      return "" if vite_development?
+
+      manifest_key = resolve_manifest_key(entry_name)
+      asset = vite_manifest[manifest_key] or raise "Vite entry '#{entry_name}' not found in manifest"
+
+      if manifest_key.include?("stylesheets") || asset["file"].end_with?(".css")
+        css_path = build_asset_url(asset["file"])
+        stylesheet_link_tag(css_path, **{ media: "all" }.merge(options))
+      else
+        ""
+      end
+    end
+
+    def reset_vite_manifest_cache!
+      @vite_manifest = nil
+    end
+
+    def reset_vite_dev_server_cache!
+      remove_instance_variable(:@vite_dev_server_running) if defined?(@vite_dev_server_running)
+    end
+
+    private
+
+    def dev_asset_path(entry_name)
+      base_url = resolved_asset_host || BetterViteHelper.configuration.dev_server_url
+      case entry_name
+      when "application.js"
+        "#{base_url}/app/assets/javascripts/application.js"
+      when "application.css"
+        "#{base_url}/app/assets/stylesheets/application.css"
+      else
+        "#{base_url}/#{entry_name}"
+      end
+    end
+
+    def production_asset_path(entry_name)
+      manifest_key = resolve_manifest_key(entry_name)
+      asset = vite_manifest[manifest_key] or raise "Vite entry '#{entry_name}' not found in manifest"
+      build_asset_url(asset["file"])
+    end
+
+    def resolve_manifest_key(entry_name)
+      case entry_name
+      when "application.js"
+        "app/assets/javascripts/application.js"
+      when "application.css"
+        "app/assets/stylesheets/application.css"
+      else
+        entry_name
+      end
+    end
+
+    def build_asset_url(file)
+      if resolved_asset_host
+        "#{resolved_asset_host}/assets/#{file}"
+      else
+        "/assets/#{file}"
+      end
+    end
+
+    def resolved_asset_host
+      BetterViteHelper.configuration.asset_host || Rails.application.config.asset_host
+    end
+  end
+end

data/lib/better_vite_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "better_vite_helper/version"
+require "better_vite_helper/configuration"
+require "better_vite_helper/view_helpers"
+require "better_vite_helper/railtie"
+
+module BetterViteHelper
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

data/lib/generators/better_vite_helper/install/install_generator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module BetterViteHelper
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Copies Vite and PostCSS configuration files to your application"
+
+      def copy_vite_config
+        copy_file "vite.config.js", "vite.config.js"
+      end
+
+      def copy_postcss_config
+        copy_file "postcss.config.js", "postcss.config.js"
+      end
+
+      def show_post_install_message
+        say ""
+        say "BetterViteHelper installed successfully!", :green
+        say ""
+        say "Next steps:"
+        say "  1. Run 'yarn add -D vite' to install Vite"
+        say "  2. Add your JavaScript entry point at app/assets/javascripts/application.js"
+        say "  3. Add your CSS entry point at app/assets/stylesheets/application.css"
+        say "  4. Run 'yarn vite' for development or 'yarn vite build' for production"
+        say ""
+      end
+    end
+  end
+end

data/lib/generators/better_vite_helper/install/templates/postcss.config.js

@@ -0,0 +1,5 @@
+export default {
+  plugins: {
+    "@tailwindcss/postcss": {},
+  },
+}

data/lib/generators/better_vite_helper/install/templates/vite.config.js

@@ -0,0 +1,49 @@
+import { dirname, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+import { defineConfig } from "vite";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+export default defineConfig({
+  publicDir: false, // avoid conflicts with outDir
+  emptyOutDir: true,
+  css: {
+    devSourcemap: true,
+  },
+
+  server: {
+    port: 5173,
+    host: "0.0.0.0",
+    cors: true,
+    hmr: {
+      port: 5173,
+    },
+  },
+
+  build: {
+    outDir: "public/assets",
+    manifest: true,
+    sourcemap: true,
+    emptyOutDir: true,
+
+    rollupOptions: {
+      input: {
+        application: resolve(
+          __dirname,
+          "app/assets/javascripts/application.js"
+        ),
+        styles: resolve(__dirname, "app/assets/stylesheets/application.css"),
+      },
+      output: {
+        entryFileNames: "application-[hash].js",
+        assetFileNames: (info) => {
+          if (info.name?.endsWith(".css")) {
+            return "application-[hash][extname]";
+          }
+          return "[name]-[hash][extname]";
+        },
+      },
+      external: [],
+    },
+  },
+});

data/lib/tasks/better_vite_helper_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :better_vite_helper do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: better_vite_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Umberto Peserico
+- Alessio Bussolari
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+description: Rails Engine providing Vite view helpers with automatic dev server detection
+  and manifest-based asset resolution for seamless Vite integration in Rails applications.
+email:
+- umberto.peserico@pandev.it
+- alessio.bussolari@pandev.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/better_vite_helper.rb
+- lib/better_vite_helper/configuration.rb
+- lib/better_vite_helper/railtie.rb
+- lib/better_vite_helper/version.rb
+- lib/better_vite_helper/view_helpers.rb
+- lib/generators/better_vite_helper/install/install_generator.rb
+- lib/generators/better_vite_helper/install/templates/postcss.config.js
+- lib/generators/better_vite_helper/install/templates/vite.config.js
+- lib/tasks/better_vite_helper_tasks.rake
+homepage: https://github.com/pandev-srl/better_vite_helper
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pandev-srl/better_vite_helper
+  source_code_uri: https://github.com/pandev-srl/better_vite_helper
+  changelog_uri: https://github.com/pandev-srl/better_vite_helper/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Rails Engine providing Vite view helpers with automatic dev server detection
+test_files: []