svelte-on-rails 7.0.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9417b9aeb24ed03a4514768dfb287e15a87da1f140b54cb23bd385f00700595a
-  data.tar.gz: 98153133cdb29712e373cd55b954075710d15c4bc207617debcde53cf66a4357
+  metadata.gz: 3d0391b58c56174ccd55c88487ebb02e71da117ee56834c7a271757cc2f9e4be
+  data.tar.gz: a0c3f07377ed6fa3b5ce816d72674aa2e2cba02c63ac55c1975a2ce6dfb5b8a2
 SHA512:
-  metadata.gz: 72255646b45908c55a8f4ce8a153df8ff106bff9541a371b7ce9249cbeff770288ed34ad7668ba3e0f479c03b029d61a84358c5ab55e36140bd6308864be1998
-  data.tar.gz: 6473071bd3628ce361d1b8796df21ae7ce206ec10de8ae6d4cd36a40778da2b8dab7f8b194b0fa86383907b0c68c14b200fbd969358dc10e9748b833a90b9c80
+  metadata.gz: 0fdf719228d92a54f0ee763c56493cb344521589f5cd6202f97a1779e35a5e9f9e5eda9c912ddcbd43695654729fcd3d5493a868c85ae8cfa9eed9ad504d9d29
+  data.tar.gz: 034c37f56fa009208ca065b88350048ebc612dbded303bf2bfa8cb36c83b7060c758555ae085ad830a85a030ab35ceec66c93c15b081f1ad8bc21a725242cef1

data/README.md

@@ -11,29 +11,7 @@ Realizing [DHH's vision](https://rubyonrails.org/2021/12/15/Rails-7-fulfilling-a
 
 Svelte offers the simplest and most elegant soulution to building reactive, high-performance front-end components.
 
-- **Compared to Single Page Apps (SPAs)**
-  - Full-stack development delivers maximum value:
-    - Unified testing from database to frontend
-    - Single-source system delivery
-  - For the most HTML Hotwired is enough
-- **Compared to integrated React or Vue**
-    - No virtual DOM, resulting in leaner packages and faster performance
-        - See Rich Harris’ [Rethinking Reactivity](https://svelte.dev/blog/svelte-3-rethinking-reactivity) (3:50–6:40) for a compelling comparison
-    - Easier to learn
-    - While React and Vue have larger communities, Svelte’s ecosystem is robust and growing, ideal for Rails integration
-- **Compared to Hotwired**
-  - Stimulus is a initializer, but not a tool for frontend-apps!
-  - Svelte eliminates redundant HTML initial state logic
-  - Consolidates component logic into a single file
-  - Offloads rendering to JavaScript by Frontend, Server side Rendering only where necessary, reducing server load
-- **Seamless Integration**
-    - Works flawlessly with Hotwired/Turbo
-    - Enhances Hotwire’s capabilities
-- **Developer-Friendly**
-    - Simple to learn, intuitive, and powerful
-    - Lightning-fast performance
-
-Svelte empowers Rails’ full-stack vision with modern, efficient front-end integration.
+See: [Comparitions on the guide](https://svelte-on-rails-docs-51acfa.gitlab.io/about/why.html)
 
 # Features
 
@@ -51,19 +29,31 @@ see [issues](https://gitlab.com/sedl/svelte-on-rails/-/issues)
 Renders Svelte components server-side and, together with [@csedl/svelte-on-rails](https://www.npmjs.com/package/@csedl/svelte-on-rails),
 hydrates the component on the frontend.
 
-This way svelte works perfectly together with turbo. You will never notice
-this unpleasant «blink» on the frontend while the whole process is maximum
-performance optimized.
-
-**STATUS:** This gem is in the early stages of development, but is ready for use.
-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.
+Together with `turbo-rails` or `turbolinks`, if configured, it renders server-side only on initial requests
+and delivers a empty tag that will be rendered by frontend.
 
 If you have issues, please open one, and contributors are welcome!
 
 ## Requirements
 
-[Requirements](https://svelte-on-rails-docs-51acfa.gitlab.io/requirements.html)
+- 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@5, @sveltejs/vite-plugin-svelte@5 (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))
+- npm on latest versions
+- actual node installed.
+    - if `nvm` is installed it gets the path to the node-binary from there.
+        - When `.nvmrc` is present on projects root, it is respected
+    - If node is not included on the PATH you can configure your node path by environment variable `SVELTE_ON_RAILS_NODE_BIN`
+
+**PROPS ON RUBY <= 3**
+
+
+
 
 ## Installation
 
@@ -99,64 +89,11 @@ Add it to the view
 <%= svelte_component('HelloWorld', {title: 'Hello World'}) %>
 ```
 
+And you will see "Svelte Hello World" on the browser! 👍  🤗
 
-And you should see "Svelte Hello World" on the browser! 👍  🤗
-
-**Explanation**
-
-this Minimal installer does:
-
-- add `app/frontend/initializers/svelte.js`
-- Adds a import statement for that initializer to `application.js`
-- add `app/frontend/ssr/ssr.js`
-- add `config/svelte_on_rails.yml`
-- add `vite-ssr.config.ts`
-- add command `npm run build:ssr` to package.json
-- installs or updates npm packages to the latest:
-  - `@csedl/svelte-on-rails`
-  - `typescript`
-  - `@types/node`
-
-
-## Process explanation
-
-**Why not client and server rendering in one process?**
-
-That was my idea! `application.js` which is the usual entry point for the client
-side could live on the same assets and manifest like svelte components that are
-compiled as chunks which each is its own entry point. This failed:
-
-- The `vite-plugin-ruby` did not support this: it constrained all to one entry point.
-- See how fat the `vite-ssr.config.ts` is. For the client side this is not necessary.
-
-At the end, I decided to split the process. For now it is cleaner. But that is not the last decision.
-
-**Why not compiling server side purely by rollup?**
-
-Advantages would be much slimmer packages and faster compilation. On the first
-step i did this and i backed up a working and tested code on the branch [rollup-ssr](https://gitlab.com/sedl/svelte-on-rails/-/blob/rollup-ssr/BRANCH_INFO.md?ref_type=heads).
-
-I decided to use Vite to bring the client and server side rendering
-closer together.
-
-But this, too, is not the last decision. 
-
-For now we proceed with vite.
-
-**How does it work now?**
-
-Client side rendering is done by vite like usual.
-
-Server side rendering is triggered, similar to [vite_rails](https://vite-ruby.netlify.app/guide/deployment.html)
-on `assets:precompile`, and, if `watch_changes` is configured, 
-which is default for development, it is triggered
-on every change of a `*.svelte` file within the configured `components_folder`.
-
-On the server side only the `*.svelte` files are served. Theyr included
-assets are linked to the client side assets folder, which is mapped by `manifest.json`.
+# Contributors welcome
 
-Then, vite has two output folders: `vite-dev` for development and `vite` for production.
-Within `vite-ssr.config.ts`, by the `RAILS_ENV` variable, is decided which one is used.
+see [Guide / run your first test](https://svelte-on-rails-docs-51acfa.gitlab.io/first_test.html)
 
 
 ## Licence

data/lib/svelte_on_rails/view_helpers.rb

@@ -2,9 +2,11 @@
 module SvelteOnRails
   module ViewHelpers
 
-    def svelte_component(path, props = {}, html: {}, options: {})
+    def svelte_component(path, props = {}, html: {}, options: {}, _props: {})
 
-      support = SvelteOnRails::Lib::ViewHelperSupport.new(path, props, html, options, request, false)
+      prp = validate_props(props, _props)
+
+      support = SvelteOnRails::Lib::ViewHelperSupport.new(path, prp, html, options, request, false)
 
       support.debug_log("Rendering component: #{path}")
       log_message = '?'
@@ -18,9 +20,11 @@ module SvelteOnRails
 
     end
 
-    def cached_svelte_component(path, props = {}, html: {}, options: {})
+    def cached_svelte_component(path, props = {}, html: {}, options: {}, _props: {})
+
+      prp = validate_props(props, _props)
 
-      support = SvelteOnRails::Lib::ViewHelperSupport.new(path, props, html, options, request, true)
+      support = SvelteOnRails::Lib::ViewHelperSupport.new(path, prp, html, options, request, true)
 
       log_message = '?'
       redis = support.conf.redis_instance
@@ -94,5 +98,19 @@ module SvelteOnRails
       end
     end
 
+    def validate_props(props, _props)
+      if props.present? && _props.present?
+        raise "you can only pass props as the first argument OR use the _props keyword argument. the latter only is made as workaround for Apps <= ruby-3"
+      end
+      if RUBY_VERSION.split('.').first.to_i >= 3 && _props.present?
+        raise "The _props keyword-argument is only meant as workaround for Apps <= ruby-3 because of avoiding misinterpreting hash as keyword arguments"
+      end
+      if props.present?
+        props
+      else
+        _props
+      end
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svelte-on-rails
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.1.0
 platform: ruby
 authors:
 - Christian Sedlmair
@@ -78,13 +78,13 @@ files:
 - templates/config_base/app/frontend/ssr/ssr.js
 - templates/config_base/config/svelte_on_rails.yml
 - templates/config_base/vite-ssr.config.ts
-homepage: https://gitlab.com/sedl/svelte-on-rails
+homepage: https://svelte-on-rails-docs-51acfa.gitlab.io/
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://gitlab.com/sedl/svelte-on-rails
-  source_code_uri: https://gitlab.com/sedl/svelte-on-rails
-  changelog_uri: https://gitlab.com/sedl/svelte-on-rails
+  homepage_uri: https://svelte-on-rails-docs-51acfa.gitlab.io/
+  source_code_uri: https://svelte-on-rails-docs-51acfa.gitlab.io/
+  changelog_uri: https://svelte-on-rails-docs-51acfa.gitlab.io/
   post_install: ruby -r svelte_on_rails/install -e 'SvelteOnRails::Install.run'
 rdoc_options: []
 require_paths: