svelte-on-rails 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 652cbedb8f5796094fde7e81e8e548de0065d33efcc9ccedac89772626b6c937
-  data.tar.gz: 324c08b71751b554662183e190dfe690cbe8fda05146a91c4fe42875956ce367
+  metadata.gz: 21cc2327494c663a2040c3775ec40e5fd4e3612a28e51eba172c13da07440ad0
+  data.tar.gz: 9773b7346d542202ae0670e2c79d03faca86164b513e398df0c0bf6c265efd87
 SHA512:
-  metadata.gz: be5231d79d34ed7ce9b5086c653b6f16d85bddffbf0c9ebf4fe7f8a8beb3e2841d26c9f86950aa4b17855b6530c68554eb696fd2e259c818f0505a4f86591eea
-  data.tar.gz: 4c428ca838a17cfe7609a0734b6419a4fb12feda2fed52aadbf72639bfa1f41eb0abf1cc2fa346a2456fc3f9a8af671f1696f5ccde045cab4a2ddbe58ae348b0
+  metadata.gz: 8d252352dcadea7d3fe44d937cff9b2e5a9376a7d6bdb8087cb19b9c15ad0084fe0d93c323ddad9cbc0ab5b82443cc3b023e61beb1b724405d0b9c8c6748dc55
+  data.tar.gz: 7b8be4d43e13f0bafe356a6dbc3b3052b44627b30fdb56509313993e14fb6bed039f411f4d9b0b045d53cb697f2b101b73488e4e136de4c433ad83621bccc92a

data/README.md

@@ -2,21 +2,21 @@
 
 Seamless and robust Svelte in Rails integration.
 
-Can render server-side (SSR), always or only on first request, and handle 
-subsequent turbo requests by mounting svelte components 
-on an empty element for server-side performance optimisation.
-Server-side compilation via rollup.
+By default an when installed together with hotwired/turbo, it renders
+svelte components on first request server side («SSR») and for subsequent
+requests it provides a empty tag that is filled up on the frontend by svelte.
+
+This way works perfectly together with turbo, you will never notice 
+this unpleasant «blink» on the frontend and it is maximum performance
+optimized. SSR compilation is handled by rollup.
 
 Server-side rendering is the bottleneck on such a pipeline. 
 Although rollup is powerful, this gem is in an early state 
-and there are certainly limitations.
-So please always test your components early if they pass ssr.
+and there may be limitations.
 
-I have written everything in ESM syntax.
+I have written everything in ESM syntax, orientated by the functionality of vite.
 Although the common-js plugin is installed, I have not tested it, 
 so for example `require` may not work in Svelte components.
-To check which import statements work, please check the components 
-in the `spec/rails-vite-test-app/app/frontend/javascript/components` gem.
 
 This all is developed on Rails-7 together with `vite_rails`.
 
@@ -27,7 +27,8 @@ and [ElMassimo](https://github.com/ElMassimo) because they all helped me with th
 
 - actual node installed on the server
 - tested on ruby 3.2.2 and rails 7.1
-- svelte (see: [install svelte on vite/rails](https://dev.to/chmich/setup-inertia-and-svelte-on-rails-7-3glk))
+- 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))
 
 ## Installation
 
@@ -35,31 +36,37 @@ add
 ```ruby
 gem "svelte-on-rails"
 ```
-to your gemfile
-
-and run
+to your gemfile and run
 
 ```ruby
+$ bundle
 $ rails svelte_on_rails:install
 ```
 
-This will create a little config file, please read the comments there.
+This will create a little config file, please read the comments there and set the tags:
+
+- `frontend_folder` (relative to Rails.root)
+- `components_folder` (relative to frontend_folder)
 
 Set up the npm module [@csedl/svelte-on-rails](https://www.npmjs.com/package/@csedl/svelte-on-rails) on the client side.
 
 ## Usage
 
+On the view
+
 ```haml
 = svelte_component("myComponent", items: ['item1', 'item2'])
 ```
 
-would render a component like `myComponent.svelte`
+Within the `components_folder` (configs above) a component like `myComponent.svelte`
 
 ```sveltehtml
 <script>
   export let items
 </script>
 
+<h1>Greetings from svelte</h1>
+
 <ul>
   {#each items as item}
     <li>{item}</li>
@@ -73,6 +80,7 @@ would render a component like `myComponent.svelte`
 </style>
 ```
 
+And you should see «Greetings from svelte» on the browser.
 
 ### Import statements
 
@@ -88,6 +96,8 @@ Among others there are
 
 ## Option `render_server_side: :auto`
 
+`render_server_side: :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 `render_server_side: :auto` option to the view helper, 
@@ -151,4 +161,4 @@ initial request and the rest happens on the frontend.
 ## Testing
 
 Testings are within the gem by `rspec`. And there is a [rails project](https://gitlab.com/users/sedl/projects) with 
-testings (based on playwright) where some examples are built in.
+testings (based on playwright) where the npm package and this gem is tested together.

data/lib/svelte_on_rails/render_server_side.rb

@@ -9,8 +9,6 @@ module SvelteOnRails
       @svelte_filename = filename
       @compiled_file = "#{SvelteOnRails::Configuration.instance.dist_folder}/#{(filename.match(/\.svelte$/) ? filename[0..-8] : filename)}"
 
-      raise "File not found: #{@svelte_file}" unless File.exist?(@svelte_file)
-
     end
 
     def compile_if_changes

data/lib/svelte_on_rails/view_helpers.rb

@@ -3,6 +3,10 @@ module SvelteOnRails
 
     def svelte_component(filename, props = {})
 
+      # check filename
+      file_path = SvelteOnRails::Configuration.instance.components_folder + "#{filename}.svelte"
+      raise "File not found: #{file_path}" unless File.exist?(file_path)
+
       # check what to do
 
       rss = if props.key?(:render_server_side)

data/lib/tasks/svelte_on_rails_tasks.rake

@@ -23,7 +23,7 @@ namespace :svelte_on_rails do
         # relative to frontend_folder
         # where your svelte components are located
         
-        render_server_side: true 
+        render_server_side: :auto 
         # options: true, false, :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

metadata

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