opal-vite-rails 0.3.16 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4324653e587faaeb544294659054bd01b0815ac4056950d8ee8de78c62fd8778
-  data.tar.gz: 00333bbe532cced98a84165a037bbd7df9247ed4cf06c568b0dce4e98cc79b5c
+  metadata.gz: f636fba332d720cdabb3fe9be702ba4ff112c9f84492fb14a9afc1bbbae2f2d2
+  data.tar.gz: 35706c079ab295a7fa5b8ffd4abd5d47674660b9b0f052e35baff6257f6375d0
 SHA512:
-  metadata.gz: 0a7a1739693c6aa93583d2bb0dc48c6dacf18ba215bd0b371d69ee9df396a5774838d9b234918b719d0b07b561c531f925cfe61079a93b9735bc2d4e4f38332e
-  data.tar.gz: 6d36e9693f19c772a3f91609a63104bbcbc6cab6bf267b3f542fc3142e218b21836d29200278bfeaac250f1bfe3d8f31fbf86e9b73b68f5ad5567a3a56599466
+  metadata.gz: 2a95c18d071d903977c48b8424365c51e57b91c2f1cf06bbeae1fa0a50f0afbe6836ed3162832f8215b78a7d46f4b73863e4a7d1fc1f7cea374a6cb1744a4c4a
+  data.tar.gz: b74c9c06b426f92fadef4beabaac4be18e29eb1d0788439a3f8c35ccb4451887e29a54eaeaded29625bbb9770070cab30608c2d2f44298c60fccdf621a4b7826

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 opal-vite contributors
+
+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

@@ -13,7 +13,7 @@ Seamless integration of [Opal](https://opalrb.com/) (Ruby to JavaScript compiler
 ## Requirements
 
 - Ruby >= 3.0
-- Rails >= 7.0
+- Rails >= 7.0, < 9
 - Node.js >= 18.0
 - Opal >= 1.8
 
@@ -207,7 +207,8 @@ You usually don't need to run it yourself: vite_rails already runs the Vite buil
 # Compile Opal assets for production
 rake opal_vite:compile
 
-# Clean compiled assets
+# Remove the Vite build output of the current RAILS_ENV
+# (public/vite-dev in development; public/vite only with RAILS_ENV=production)
 rake opal_vite:clean
 
 # Show configuration info

data/lib/opal/vite/rails/engine.rb

@@ -36,6 +36,11 @@ module Opal
           end
         end
 
+        initializer "opal_vite.deprecator" do |app|
+          # Rails.application.deprecators exists since Rails 7.1
+          app.deprecators[:opal_vite_rails] = Opal::Vite::Rails.deprecator if app.respond_to?(:deprecators)
+        end
+
         initializer "opal_vite.view_helpers" do
           ActiveSupport.on_load(:action_view) do
             include Opal::Vite::Rails::Helper

data/lib/opal/vite/rails/generators/install_generator.rb

@@ -51,7 +51,7 @@ module Opal
           end
 
           def create_package_json_entry
-            if File.exist?("package.json")
+            if File.exist?(File.join(destination_root, "package.json"))
               say "Adding vite-plugin-opal to package.json...", :green
               say "Run: npm install vite-plugin-opal", :yellow
             end

data/lib/opal/vite/rails/helper.rb

@@ -12,7 +12,10 @@ module Opal
         # modulepreload links), and vite_ruby already switches between the dev
         # server and the build manifest.
         def opal_javascript_tag(name, **options)
-          vite_javascript_tag("#{name}.js", **options)
+          name = name.to_s
+          # "application" and "application.js" are the same entrypoint
+          name = "#{name}.js" if File.extname(name).empty?
+          vite_javascript_tag(name, **options)
         end
 
         # Generate multiple script tags for Opal JavaScript files
@@ -39,12 +42,7 @@ module Opal
         # Hash's inspect string instead of a URL. #path_for returns the resolved
         # asset URL string.
         def opal_asset_path(name)
-          if defined?(ViteRuby)
-            ViteRuby.instance.manifest.path_for(name)
-          else
-            # Fallback to standard asset path
-            "/#{Opal::Vite::Rails.config.public_output_path}/#{name}"
-          end
+          ViteRuby.instance.manifest.path_for(name)
         end
 
         # Deprecated: outputs nothing.
@@ -54,7 +52,7 @@ module Opal
         # chunks, so there is no separate runtime file to load. A standalone
         # tag would load a second copy of the runtime in development.
         def opal_runtime_tag(**_options)
-          ActiveSupport::Deprecation.new("0.4", "opal-vite-rails").warn(
+          Opal::Vite::Rails.deprecator.warn(
             "opal_runtime_tag is no longer needed and outputs nothing; remove it from your views."
           )
           "".html_safe

data/lib/opal/vite/rails/version.rb

@@ -1,7 +1,7 @@
 module Opal
   module Vite
     module Rails
-      VERSION = "0.3.16"
+      VERSION = "0.4.0"
     end
   end
 end

data/lib/opal-vite-rails.rb

@@ -6,7 +6,6 @@ require "vite_rails"
 require_relative "opal/vite/rails/version"
 require_relative "opal/vite/rails/engine"
 require_relative "opal/vite/rails/helper"
-require_relative "opal/vite/rails/manifest"
 
 module Opal
   module Vite
@@ -19,6 +18,12 @@ module Opal
         def configure
           yield(config) if block_given?
         end
+
+        # Registered in Rails.application.deprecators by the engine, so that
+        # config.active_support.report_deprecations and friends apply to it.
+        def deprecator
+          @deprecator ||= ActiveSupport::Deprecation.new("0.4", "opal-vite-rails")
+        end
       end
 
       @config = OpenStruct.new(

data/lib/tasks/opal_vite.rake

@@ -12,16 +12,28 @@ namespace :opal_vite do
     puts "✅ Opal assets compiled successfully!"
   end
 
-  desc "Clean compiled Opal assets"
+  desc "Clean compiled Opal assets (the Vite build output of the current RAILS_ENV)"
   task clean: :environment do
     puts "Cleaning Opal assets..."
 
-    vite_dir = Rails.public_path.join("vite")
+    # The directory vite_ruby builds into for this environment (config/vite.json
+    # publicOutputDir), e.g. public/vite-dev in development and public/vite in
+    # production. A build you commit (public/vite) is only removed when this
+    # runs with RAILS_ENV=production.
+    vite = ViteRuby.config
+    vite_dir = vite.build_output_dir.expand_path
+    # Only ever delete a subdirectory of the public dir, so a misconfigured
+    # publicOutputDir ("", ".", "..") cannot wipe public/ or the app itself.
+    public_dir = vite.root.join(vite.public_dir).expand_path
+    unless vite_dir.to_s.start_with?("#{public_dir}#{File::SEPARATOR}")
+      abort "❌ Refusing to delete #{vite_dir}: it is not inside #{public_dir}"
+    end
+
     if vite_dir.exist?
       FileUtils.rm_rf(vite_dir)
       puts "✅ Cleaned #{vite_dir}"
     else
-      puts "No compiled assets found"
+      puts "No compiled assets found in #{vite_dir}"
     end
   end
 
@@ -33,15 +45,14 @@ namespace :opal_vite do
 
     puts "\nOpal-Vite version: #{Opal::Vite::VERSION}"
     puts "Rails root: #{Rails.root}"
-    puts "Vite manifest: #{Rails.public_path.join('vite', 'manifest.json')}"
-    puts "Opal source directory: #{Rails.root.join('app', 'opal')}"
 
-    if defined?(ViteRuby)
-      puts "\nViteRuby: Installed ✅"
-      puts "Vite dev server: #{ViteRuby.config.host}:#{ViteRuby.config.port}"
-    else
-      puts "\nViteRuby: Not installed ⚠️"
-    end
+    vite = ViteRuby.config
+    manifest = vite.manifest_paths.first
+    puts "Vite build output: #{vite.build_output_dir}"
+    puts "Vite manifest: #{manifest || vite.known_manifest_paths.first} (#{manifest ? 'found' : 'not built yet'})"
+    puts "Opal source directory: #{Rails.root.join(Opal::Vite::Rails.config.source_path)}"
+    puts "Vite source directory: #{vite.root.join(vite.source_code_dir)}"
+    puts "Vite dev server: #{vite.host}:#{vite.port}"
 
     puts "\n" + "="*60
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opal-vite-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.16
+  version: 0.4.0
 platform: ruby
 authors:
 - stofu1234
@@ -50,6 +50,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -57,6 +60,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +70,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -71,6 +80,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: vite_rails
   requirement: !ruby/object:Gem::Requirement
@@ -135,12 +147,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - lib/opal-vite-rails.rb
 - lib/opal/vite/rails/engine.rb
 - lib/opal/vite/rails/generators/install_generator.rb
 - lib/opal/vite/rails/helper.rb
-- lib/opal/vite/rails/manifest.rb
 - lib/opal/vite/rails/version.rb
 - lib/tasks/opal_vite.rake
 - templates/application.rb.tt

data/lib/opal/vite/rails/manifest.rb

@@ -1,64 +0,0 @@
-require "json"
-
-module Opal
-  module Vite
-    module Rails
-      class Manifest
-        def initialize(manifest_path = nil)
-          @manifest_path = manifest_path || default_manifest_path
-          @data = load_manifest
-        end
-
-        def lookup(name)
-          # Try exact match first
-          entry = @data[name]
-          return entry if entry
-
-          # Try with .rb extension
-          entry = @data["#{name}.rb"]
-          return entry if entry
-
-          # Try without extension
-          name_without_ext = name.sub(/\.(rb|js)$/, '')
-          entry = @data[name_without_ext]
-          return entry if entry
-
-          # Not found
-          nil
-        end
-
-        def [](name)
-          entry = lookup(name)
-          entry && entry['file']
-        end
-
-        def reload!
-          @data = load_manifest
-        end
-
-        private
-
-        def default_manifest_path
-          if defined?(::ViteRuby) && ::ViteRuby.instance.config.respond_to?(:manifest_paths)
-            vite_config = ::ViteRuby.instance.config
-            vite_config.manifest_paths.first ||
-              vite_config.build_output_dir.join('.vite', 'manifest.json')
-          elsif defined?(::Rails)
-            ::Rails.public_path.join('vite', 'manifest.json')
-          else
-            'public/vite/manifest.json'
-          end
-        end
-
-        def load_manifest
-          return {} unless File.exist?(@manifest_path)
-
-          JSON.parse(File.read(@manifest_path))
-        rescue JSON::ParserError => e
-          warn "Failed to parse Vite manifest at #{@manifest_path}: #{e.message}"
-          {}
-        end
-      end
-    end
-  end
-end