svelte-on-rails 0.0.12 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 202f1fbacaa78ff38947e7665f87e21a904f6cb25fdab0e2c3280f8cd8d47c8c
-  data.tar.gz: 18024b88f324f8e6a2e95832b6bec156154ff00692ad849952dc5739d6875634
+  metadata.gz: 8b31efba828e0d1f3416c684638903a5d80e42978b1ebe30a67fd447ae8d2bad
+  data.tar.gz: 45dbe8cd7110c0e36401ab1816c5186265850f79337783cd7a034a1677a6697e
 SHA512:
-  metadata.gz: dc2bd126266183b839b66a9f42febc0f72b1a75f9d104b3b00cd8f15d80aa92345aa47060444cca49190fd9d6317517560e2d648d5680f6f732aee1ecafe950a
-  data.tar.gz: 405093ef539c984afe97a78dca95e70c43c920da0cce9b01c12e1c5e3a75bb91139a74cb8fb6df9384d506eeecb36a510cda8014a2fca700d1a06d487ab3805e
+  metadata.gz: 9a73256d665867beb93c8221ecbdda94c4f8a5fab1cad3e226c4345804bd13a101b0da58177a6b9e58eeb822ca5bed99cd124eba01e939da348f5ec15ab2ca35
+  data.tar.gz: e7d878a42a7b7e57db9a9c061d059b7e8afd26a46df0f1bf1eac431227e3575d44f944bed9b0362bbb42b2d8343a43c1487b87012d7d68975d7a78b0d9587002

data/README.md

@@ -2,11 +2,11 @@
 
 Seamless and robust Svelte in Rails integration.
 
-By default an when installed together with hotwired/turbo, it renders
+By default, and 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.
+requests it provides a empty tag that will be mounted on the frontend by the associated npm package [@csedl/svelte-on-rails](https://www.npmjs.com/package/@csedl/svelte-on-rails) on the frontend.
 
-This way works perfectly together with turbo, you will never notice 
+This way svelte 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.
 
@@ -14,15 +14,19 @@ Server-side rendering is the bottleneck on such a pipeline.
 Although rollup is powerful, this gem is in an early state 
 and there may be limitations.
 
-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, 
+Javascript is written 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.
 
+But we have done everything we can to make your setup work smoothly.
+
 This all is developed on Rails-7 together with `vite_rails`.
 
 Thanks to [shakacode](https://github.com/shakacode/react_on_rails) 
 and [ElMassimo](https://github.com/ElMassimo) because they all helped me with theyr gems.
 
+If you have issues, please open one and contributors are welcome!
+
 ## Requirements
 
 - actual node installed on the server
@@ -50,7 +54,7 @@ This will create a little config file, please read the comments there and set th
 
 Set up the npm module [@csedl/svelte-on-rails](https://www.npmjs.com/package/@csedl/svelte-on-rails) on the client side.
 
-## Usage
+## Test if it works
 
 On the view
 
@@ -58,16 +62,22 @@ On the view
 = svelte_component("myComponent", items: ['item1', 'item2'])
 ```
 
-Within the `components_folder` (configs above) a component like `myComponent.svelte`
+Within the `components_folder` (configs above), create a component like `myComponent.svelte`
 
 ```sveltehtml
 <script>
   export let items
+  let count = 0;
+
+  function increment() {
+    count += 1;
+  }
 </script>
 
 <h1>Greetings from svelte</h1>
 
 <ul>
+  <button on:click={increment}>Increment: {count}</button>
   {#each items as item}
     <li>{item}</li>
   {/each}
@@ -82,6 +92,10 @@ Within the `components_folder` (configs above) a component like `myComponent.sve
 
 And you should see «Greetings from svelte» on the browser.
 
+Click the counter button and check if the component is alive.
+
+Without the npm package installed, you would see the same html, but the increment button would not work.
+
 I inserted very detailed error messages on rails and on the
 npm package, so please check the logs on your browser.
 
@@ -154,14 +168,16 @@ Example from the rails console for a medium complex component
 - Compiled MyComponent.svelte.js: 0.411ms
   - => happens only once
 - Rendered MyComponent.svelte server-side: 0.518ms
-  - => happens on every request
+  - => happens on every SSR request
+- Rendered MyComponent.svelte as empty element that will be mounted on the client side
+  - => subsequent calls
 - Completed 200 OK in 521ms (Views: 520.2ms | ActiveRecord: 0.0ms (0 queries, 0 cached) | GC: 0.3ms)
 
-Best is to work with the `render_server_side: :auto` option, which you can
-set as default on the config file. Then, the server does the SSR only on 
-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 the npm package and this gem is tested together.
+testings (based on playwright) where the npm package and this gem is tested together.
+
+## Licence
+
+License is MIT

data/lib/svelte_on_rails/render_server_side.rb

@@ -125,7 +125,9 @@ module SvelteOnRails
       full_path = File.join(containing_dir, filename)
 
       # Check if the file exists and the path matches case-sensitively
-      File.exist?(full_path) && Dir[File.join(containing_dir, "*")].any? { |f| f == full_path }
+      File.exist?(full_path) && Dir[File.join(containing_dir, "**/*")].any? do |f|
+        f == full_path
+      end
     end
 
 

data/lib/svelte_on_rails/view_helpers.rb

@@ -68,7 +68,7 @@ module SvelteOnRails
       else
 
         # render empty element
-
+        Rails.logger.info "  Rendered #{filename}.svelte as empty element that will be mounted on the client side"
         content_tag(:div, options) {}
 
       end

data/lib/tasks/svelte_on_rails_tasks.rake

@@ -11,7 +11,7 @@ namespace :svelte_on_rails do
     config_path = Rails.root.join("config", "svelte_on_rails.yml")
 
     if File.exist?(config_path)
-      puts "Configuration file already exists at #{config_path}"
+      puts "Configuration file already exists at file://#{config_path}"
     else
       File.write(config_path, <<~YAML)
         
@@ -30,12 +30,16 @@ namespace :svelte_on_rails do
         
         development:
           watch_changes: true
-          # check on every request if any file within the svelte components folder have changed
+          # Check on every request if any file within the svelte components folder have changed, for recompiling
+          # Case sensitive path checking, even the file system is case insensitive
+          # Make sure this ist set to tue for development and test, but not for production
           
         test:
+          watch_changes: true
+          
         production:
       YAML
-      puts "Created configuration file at #{config_path}"
+      puts "Created configuration file at file://#{config_path}"
     end
   end
 end

metadata

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