svelte-on-rails 0.0.8 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aba69e94b04ba2d0c43da02f80e099809cd05212d10d73a78a9aea5ff85a246a
-  data.tar.gz: 106f58f63c9026dd4a108c8b0c70f41de0114b2f19613270f46815e933316992
+  metadata.gz: 91e3a5e36988fe3fd9aa4cbf83c5dd475dae2919dc788afd3e1c3ba399690490
+  data.tar.gz: d9d60ad9b06e29bd1b744575f80bcd2ea9edbe60cc4a1badc6e8178867ff8b36
 SHA512:
-  metadata.gz: a9e991fc9c21ee04731b34038a4dd1d6cfae0dab92d23beccdb3b73bbc0fde11c5559b1b3db521f52493bee36a8b58d0b829b71606b18d2e91fa41c6a71e11bf
-  data.tar.gz: fac8155c37ff8d1c5fd95e8b61b36f40ef600f8e8f49f19e3b39b116703081f109471cb92d8814ebd0e2f4b6a455fc405aea67b47aa72c583717b920f39f0eae
+  metadata.gz: 8e8fa476b10eed4dd4ef9772c60b8e66bdf87fd7627458d9ba301520be94ad7ff96de9ac72ac6cbf85312473cfec42138e94e10110a7647b5a2e412bf460bb2e
+  data.tar.gz: 4539559ff01e47a4138f91cc7258846aa31ca4353b643a8c06dd5995e6cad991f597f2ec2a92fb48a0e4fcfff86191fdebd05354ae1d21fc6d26fc931a471ed3

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,10 @@ would render a component like `myComponent.svelte`
 </style>
 ```
 
+And you should see «Greetings from svelte» on the browser.
+
+I inserted very detailed error messages on rails and on the
+npm package, so please check the logs on your browser.
 
 ### Import statements
 
@@ -153,4 +164,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/configuration.rb

@@ -21,7 +21,7 @@ module SvelteOnRails
       load_yaml_config if defined?(Rails)
     end
 
-    def watch_changes
+    def watch_changes?
       if @configs[Rails.env]
         @configs[Rails.env]['watch_changes'] == true
       else
@@ -34,11 +34,19 @@ module SvelteOnRails
     end
 
     def frontend_folder
+      @configs['frontend_folder']
+    end
+
+    def frontend_folder_full
       rails_root.join(@configs['frontend_folder'].to_s)
     end
 
+    def components_folder_full
+      Pathname.new(frontend_folder_full).join(components_folder.to_s)
+    end
+
     def components_folder
-      frontend_folder.join(@configs['components_folder'].to_s)
+      @configs['components_folder']
     end
 
     def render_server_side

data/lib/svelte_on_rails/render_server_side.rb

@@ -5,19 +5,17 @@ module SvelteOnRails
 
     def initialize(filename)
 
-      @svelte_file = SvelteOnRails::Configuration.instance.components_folder + filename
+      @svelte_file = SvelteOnRails::Configuration.instance.components_folder_full + filename
       @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
 
       # letzte Änderung innerhalb des ordners ermitteln
 
-      watch_changes = SvelteOnRails::Configuration.instance.watch_changes
+      watch_changes = SvelteOnRails::Configuration.instance.watch_changes?
       ts_file = SvelteOnRails::Configuration.instance.dist_folder.join('reset_timestamp')
 
       have_changes = if watch_changes && File.exist?(ts_file)
@@ -122,5 +120,11 @@ module SvelteOnRails
       FileUtils.touch SvelteOnRails::Configuration.instance.dist_folder.join('reset_timestamp')
     end
 
+    def self.file_exist_case_sensitive?(containing_dir, filename)
+      # because some filesystems are case insensitive we test case sensitive
+      Dir[File.join(containing_dir, "*")].select {|f| File.basename(f) == filename}.any?
+    end
+
+
   end
 end

data/lib/svelte_on_rails/view_helpers.rb

@@ -3,12 +3,23 @@ module SvelteOnRails
 
     def svelte_component(filename, props = {})
 
+      # check filename
+      conf = SvelteOnRails::Configuration.instance
+      cff = conf.components_folder_full
+      file_path = cff + "#{filename}.svelte"
+      found = (conf.watch_changes? ? SvelteOnRails::RenderServerSide.file_exist_case_sensitive?(cff, filename + '.svelte') : File.exist?(file_path))
+      unless found
+        ff = conf.frontend_folder
+        cf = conf.components_folder
+        raise "File not found: #{file_path}\nsvelte-on-rails gem, view helper #svelte_component\n\nYour configurations are:\nfrontend_folder: «#{ff}»\ncomponents_folder: «#{cf}»\n.. and the filename attribute for the view helper: «#{filename}»\n"
+      end
+
       # check what to do
 
       rss = if props.key?(:render_server_side)
               props.delete(:render_server_side)
             else
-              SvelteOnRails::Configuration.instance.render_server_side
+              conf.render_server_side
             end
       unless [true, false, :auto].include?(rss)
         raise "Only true, false or auto are allowed for the argument #render_server_side"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: svelte-on-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.10
 platform: ruby
 authors:
 - Christian Sedlmair
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-16 00:00:00.000000000 Z
+date: 2025-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties