svelte-on-rails 3.0.6 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92b3d22db7b1abbebb142ddce45b41e73e4055d3ba17143661526c9bd5c7821a
-  data.tar.gz: ed7a18aafcb2c8ae9a81981063bcaf2295084ca76e5fa1e15d631838a9fb0f3a
+  metadata.gz: a8c8933b55b56b0a2adcc4c06542b0a9078b8e36408ae6afc9316289f2f2f924
+  data.tar.gz: 777395f46db7c8e2c88df9090b646088e39cb10cf9c2881ff7cd2f7a78dc8065
 SHA512:
-  metadata.gz: e3c2746a25bfd7a09ae517ff44d0674995c75f4d0857cf4559941d26a46619c21f572b9fce88eca3efa3accf13a1aa6b43b72ee5ea67de6ce0c2870f188f81a4
-  data.tar.gz: 5ba58975c8402de9ddade64a3961c611c536d0c96bc195b984cbe43c8cc691df24632394530c0f1f7c7f5c074a5acea442be9bda18437f27587e2b172573eddd
+  metadata.gz: 803bb9b519cc14baa104b41689c56dbe168fae17a1ec540a07dedcb8acc1200418f231446fe6ccd611f84d1c0607ffa335a312bed905512b5a95e12592bb6805
+  data.tar.gz: 51d06bdd84b8272d5af59bd9bbc4efd407d39a9b57c343a8d96a68e504770a135a951e18defa50b18e95443c319194c33e31287d922d63e7af4520f35345b85a

data/README.md

@@ -25,6 +25,8 @@ On every app there are parts where you want it to shine. This is where Svelte co
 - Super fast
 - **Compared to Stimulus**
   - No more writing double logic of the initial HTML state
+  - One Logic in one file!
+    - Render logic and script logic is in one file and, maybe, some css too.
   - Stimulus is great for rails views with some javascript, but, complex parts: You will love svelte.
 - **Compared to React**
   - No more shadow dom and all those packages that are supposed to improve performance (e.g. useCallback...)
@@ -66,16 +68,19 @@ Thanks to [shakacode](https://github.com/shakacode/react_on_rails)
 and [ElMassimo](https://github.com/ElMassimo) for inspiring and helping me with their gems.
 
 **STATUS:** This gem is in the early stages of development, but is ready for use.
-It has nearly 100% test coverage and all tests pass. Since 15 May 2025, it has been successfully
-implemented on my first customer's app: an ERP system with fat Svelte components that are crucial for the workflow.
-of this company.
+It has nearly 100% test coverage, with all tests passing. It has been in use since May/June 2025
+on the systems of my two biggest customers.
 
 If you have issues, please open one, and contributors are welcome!
 
 ## Requirements
 
 - actual node installed on the server
-- tested on ruby 3.2.2 and rails 7.1
+- tested on 
+  - ruby 3.2.2 and rails 7.1
+  - ruby 2.7.5 and rails 6.1
+  - vite@6 (v7 not supported, see issues)
+  - turbolinks and hotwired/turbo
 - vite_rails (the installer will install it by option --full or --vite)
 - svelte v5 (see: [how to install svelte on rails/vite](https://dev.to/chmich/setup-inertia-and-svelte-on-rails-7-3glk))
 - turbo (recommended / [how to install turbo on rails](https://github.com/hotwired/turbo-rails?tab=readme-ov-file#installation))
@@ -257,10 +262,8 @@ after any `*.svelte` file within the configured `components_folder` changed.
 
 `ssr: :auto` is the default option, as set on config file and can be overridden on the view helper.
 
-Works with `hotwired/turbo` only
-
 By passing the `ssr: :auto` option to the view helper,
-it checks if the request is an initial request (request header `X-Turbo-Request-ID` is present):
+it checks if the request is an initial request (request header `X-Turbo-Request-ID` is present // configurable by `non_ssr_request_header`):
 
 On Initial-Request, it adds the attribute `data-svelte-on-rails-initialize-action="hydrate"` and
 returns a server side rendered component that will be hydrated on the frontend by the npm package.
@@ -275,6 +278,20 @@ loaded on very first load to the frontend, then the most work is done
 in frontend and the server is relieved, except on initial request.
 You will see no unpleasant «blink» on the page.
 
+**Turbolinks**
+
+If you are working on turbolinks, you can config the header or set something like 
+ 
+```
+document.addEventListener('turbolinks:request-start', (event) => {
+    var xhr = event.data.xhr
+    xhr.setRequestHeader("X-Turbo-Request-ID", "any-content-for-skip-svelte-ssr")
+});
+```
+
+to your javascript file.
+
+
 **Tip: Performance optimisation for dropdowns**
 
 For example, with dropdowns, you will never see the unpleasant «blink» effect because
@@ -294,6 +311,28 @@ rails svelte_on_rails:add_hello_world
 rails svelte_on_rails:remove_hello_world
 ```
 
+## Deploy
+
+For example, by deploying with capistrano, you may add a step like 
+
+```ruby
+before 'deploy:assets:precompile', 'deploy:npm:install'
+namespace :deploy do
+  namespace :npm do
+    desc 'Install Node.js dependencies'
+    task :install do
+      on roles(:app) do
+        within release_path do
+          execute :npm, 'install'
+        end
+      end
+    end
+  end
+end
+```
+
+to `deploy.rb` for making sure the ssr compilation is working.
+
 ## Contributors Guide
 
 Contributors welcome!

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

@@ -43,7 +43,7 @@ module SvelteOnRails
         puts '-' * 80
         puts '• INSTALLING VITE-RAILS'
         vite_i = SvelteOnRails::Installer::Vite
-        vite_i.install_vite
+        vite_i.install_vite(major_version: 6)
       end
 
       def svelte_on_rails

data/lib/svelte_on_rails/configuration.rb

@@ -83,6 +83,15 @@ module SvelteOnRails
       end
     end
 
+    def non_ssr_request_header
+      rss = @configs['non_ssr_request_header']
+      if rss.present?
+        rss
+      else
+        'X-Turbo-Request-ID'
+      end
+    end
+
     # def dist_folder(app_root = nil)
     #   rails_root(app_root).join('public', 'svelteDist')
     # end

data/lib/svelte_on_rails/installer/npm.rb

@@ -2,19 +2,44 @@ module SvelteOnRails
   module Installer
     module Npm
 
-      def self.install_or_update_package(package_name, minimal_version: nil, update_to_latest: true, dev_dependency: false )
+      def self.install_or_update_package(package_name, minimal_version: nil, major_version: nil, update_to_latest: true, dev_dependency: false)
         pkg = inspect_package(package_name)
-        to_do = !check_version((pkg ? pkg[:version] : nil), minimal_version)
+        puts "#{package_name} already installed (#{pkg[:version].join('.')})" if pkg
+
+        to_do = if !pkg
+                  true
+                elsif major_version
+                  r = pkg[:version].first != major_version
+                  if r
+                    puts "updating to major version #{major_version}"
+                  else
+                    puts "nothing to do (major version #{major_version} OK)"
+                  end
+                  r
+                elsif minimal_version
+                  r = pkg[:version].first < minimal_version.first || pkg[:version].second < minimal_version.second
+                  puts "updating to minimal version #{minimal_version}" if r
+                  r
+                else
+                  puts 'nothing to do'
+                  false
+                end
+
         save_dev = (dev_dependency ? ' --save-dev' : '')
         if to_do
 
-          cmd = if update_to_latest
+          cmd = if major_version
+                  "npm install #{package_name}@#{major_version}#{save_dev}"
+                elsif update_to_latest
                   "npm install #{package_name}@latest#{save_dev}"
                 else
                   raise "ERROR: not implemented"
                 end
 
           stdout, stderr, status = Open3.capture3(cmd)
+
+          puts cmd
+
           if stderr.present?
             raise "ERROR #{cmd} => #{stderr}"
           end
@@ -52,7 +77,6 @@ module SvelteOnRails
         end
       end
 
-
       def self.inspect_package(package_name)
         pkg = nil
         version = nil
@@ -75,34 +99,33 @@ module SvelteOnRails
 
       end
 
-      def self.check_version(current_version, minimal_version)
-        if !current_version
-          return false
-        elsif !minimal_version.present?
-          return true
-        else
-          compare_version_arrays(current_version, minimal_version)
-        end
-      end
+      # def self.check_version(current_version, minimal_version)
+      #   if !current_version
+      #     return false
+      #   elsif !minimal_version.present?
+      #     return true
+      #   else
+      #     compare_version_arrays(current_version, minimal_version)
+      #   end
+      # end
 
       private
 
-      def self.compare_version_arrays(current_version, minimal_version)
-        raise "ERROR: current_version must be an array" unless current_version.is_a?(Array)
-        raise "ERROR: minimal_version must be an array" unless current_version.is_a?(Array)
-
-        current_version.each_with_index do |v, i|
-          raise "ERROR: current_version entries must be an integer" unless v.is_a?(Integer)
-
-          if minimal_version[i]
-            raise "ERROR: minimal_version entries must be an integer" unless minimal_version[i].is_a?(Integer)
-            if v < minimal_version[i]
-              return false
-            end
-          end
-        end
-        true
-      end
+      # def self.compare_version_arrays(current_version, minimal_version)
+      #   raise "ERROR: current_version must be an array" unless current_version.is_a?(Array)
+      #
+      #   current_version.each_with_index do |v, i|
+      #     raise "ERROR: current_version entries must be an integer" unless v.is_a?(Integer)
+      #
+      #     if minimal_version[i]
+      #       raise "ERROR: minimal_version entries must be an integer" unless minimal_version[i].is_a?(Integer)
+      #       if v < minimal_version[i]
+      #         return false
+      #       end
+      #     end
+      #   end
+      #   true
+      # end
 
     end
   end

data/lib/svelte_on_rails/installer/vite.rb

@@ -4,7 +4,7 @@ module SvelteOnRails
 
     module Vite
 
-      def self.install_vite
+      def self.install_vite(major_version: nil, minimal_version: nil)
         iu = SvelteOnRails::Installer::Utils
 
         puts '-' * 80
@@ -44,7 +44,7 @@ module SvelteOnRails
         # check npm package version
 
         ni = SvelteOnRails::Installer::Npm
-        ni.install_or_update_package('vite', minimal_version: [6, 1])
+        ni.install_or_update_package('vite', major_version: major_version, minimal_version: minimal_version)
 
       end
 

data/lib/svelte_on_rails/view_helpers.rb

@@ -26,7 +26,12 @@ module SvelteOnRails
       unless [true, false, :auto].include?(rss)
         raise "Only true, false or auto are allowed for the argument #ssr"
       end
-      ssr = (rss == :auto && request.headers['X-Turbo-Request-ID'].blank? || rss)
+
+      ssr = if [:auto, 'auto'].include?(rss)
+              request.headers[conf.non_ssr_request_header].blank?
+            else
+              rss
+            end
 
       hydrate = if props.key?(:hydrate)
                   props[:hydrate]

data/templates/config_base/config/svelte_on_rails.yml

@@ -11,6 +11,11 @@ ssr: :auto
 # :auto: render server side if request is initial request (works only with turbo, because it checks for the X-Turbo-Request-ID header)
 # when not server-side rendered the components must be built as custom elements, see node-package @csedl/svelte-on-rails
 
+non_ssr_request_header: 'X-Turbo-Request-ID'
+# when ssr: :auto =>
+# when this header contains any value (not blank), we are skipping server-side rendering
+# when this header is empty we assume initial request and doing server-side rendering
+
 development:
   watch_changes: true
   # Check on every request if any file within the svelte components folder have changed, for recompiling

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svelte-on-rails
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.1.1
 platform: ruby
 authors:
 - Christian Sedlmair