svelte-on-rails 0.0.16 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 677cbdec13a7a29dad5a6601755976aebce32a9cd5d4d132d62682650887b81d
-  data.tar.gz: 3cd12a78ff280021ff44ba0bc29371a3268a4b50de93264f9388925cc6fdad21
+  metadata.gz: 0bdaed0f08472a9dde76f78c8d69f99b1b9cd1422ed75631620e3e60cff5c8ba
+  data.tar.gz: 6dedb73fdb5b1a85bdd6996c7947e9a66ab5e69663e86a5f868d1dfd20dc8115
 SHA512:
-  metadata.gz: 289186502e09d9e27b75b17f633cd017f066470efeafcaf1c9ab979f716f60705f4b7d7505da496380171d00ef971eef14b22fcfbb83781be810732ed3f4d3dc
-  data.tar.gz: 620d66d405bfea65fc134c837c7832ea3c7dae6c566aaedea3431a2ebb8906700a9255afd088ff65ab607ea5789132760c2b12f3b3e2c4676ce36a6ecf540747
+  metadata.gz: 270ba6319f043ac8aa36bf437d338a400aa2b03005d060b93e86c939df638c40688faf57c0758ccc231031ae6da969bc57d9570a04ae649c7f912e3df41a893f
+  data.tar.gz: 272da007dd9136464b1705b47f4d6fc0f1a3ba046ee1299d70442648c3b412b8450cf655d3888b60a4c7a117fa9a4ee63e56b01adc3d0742be7fcd7bcb763432

data/README.md

@@ -49,78 +49,47 @@ If you want to start from a new rails app, follow theese tutorials
 within the app folder
 
 ```bash
-  bundle add svelte-on-rails
+bundle add svelte-on-rails
 ```
 ```bash
-  rails svelte_on_rails:install_for_vite_and_turbo
+rails svelte_on_rails:install_for_vite_and_turbo
 ```
 
 
-This will create a little config file, istalls the npm package,
+This will create a little config file, installs the npm package,
 creates a initializer file and adds the import statement on `appplication.js` entrypoint file
 and it adds a HelloWorld.svelte component.
 If not installed, it installs `@hotwired/turbo-rails` too.
 
-Add a controller and a view with the view helper and you should see «Greetings from Svelte on your view».
+#### Minimal installer
 
-There is also a smaller installer:
+There is also a minimal installer:
 
 ```bash
-$ rails svelte_on_rails:install
+rails svelte_on_rails:install
 ```
 
 that does nothing else than creating a config file.
 
-Within the config file, there are two tags:
+Within the config file, there are mainly two important 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.
+## Check if it all works
 
-## Test if it works
+Add a controller and a view with the helper `= svelte_component('HelloWorld', items: ['item1', 'item2'])`.
+On loading you will see
 
-On the view
+- Rendered HelloWorld.svelte server-side: 0.075ms
 
-```haml
-= svelte_component("myComponent", items: ['item1', 'item2'])
-```
-
-Above mentioned installer adds `HelloWorld.svelte`, like so:
-
-```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}
-</ul>
-
-<style>
-  button {
-    background-color: darkred;
-    color: white;
-    padding: 10px;
-    border: none;
-  }
-</style>
-```
-
-And you should see «Greetings from svelte» on the browser.
+On the rails console and you will see «Greetings from svelte» 
+on your view with a styled «Increment» button.
+Styles you find within the svelte component.
+Click this button and see that the component is alive.
 
-Click the counter button and check if the component is alive.
+On [@csedl/svelte-on-rails](https://www.npmjs.com/package/@csedl/svelte-on-rails) 
+are details how the frontend part is working.
 
 Without the npm package installed, 
 or by passing `render_server_side: true` and `hydrate: false` to the view helper,

data/lib/svelte_on_rails/view_helpers.rb

@@ -7,11 +7,13 @@ module SvelteOnRails
       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"
+      if !File.exist?(file_path)
+        raise file_not_found_messsage(filename)
+      elsif conf.watch_changes? && !SvelteOnRails::RenderServerSide.file_exist_case_sensitive?(cff, filename + '.svelte')
+        # on development environments we check case sensitivity too
+        msg = "File found but Upper and lower case letters are incorrect\n" +
+          "(This check is only on development environments when watch_changes is true):\n."
+        raise file_case_sensitive_messsage(filename)
       end
 
       # check what to do
@@ -74,5 +76,25 @@ module SvelteOnRails
       end
     end
 
+    def file_not_found_messsage(filename)
+      conf = SvelteOnRails::Configuration.instance
+      ff = conf.frontend_folder
+      cf = conf.components_folder
+      "svelte-on-rails gem, view helper #svelte_component\n\nFile not found:\n" +
+        "#{conf.components_folder_full + "#{filename}.svelte"}\n\n" +
+        "Your configurations are:\n\nfrontend_folder: «#{ff}»\ncomponents_folder: «#{cf}»\n.. and the filename attribute for the view helper: «#{filename}»\n"
+    end
+
+    def file_case_sensitive_messsage(filename)
+      conf = SvelteOnRails::Configuration.instance
+      ff = conf.frontend_folder
+      cf = conf.components_folder
+      "svelte-on-rails gem, view helper #svelte_component\n\n" +
+        "File found but Upper and lower case letters are incorrect:\n" +
+        "(This check is only on development environments when watch_changes is true)\n\n" +
+        "#{conf.components_folder_full + "#{filename}.svelte"}\n\n" +
+        "Your configurations are:\nfrontend_folder: «#{ff}»\ncomponents_folder: «#{cf}»\n.. and the filename attribute for the view helper: «#{filename}»\n"
+    end
+
   end
 end

data/lib/tasks/svelte_on_rails_tasks.rake

@@ -12,7 +12,7 @@ namespace :svelte_on_rails do
   end
 
   desc "Installs SvelteOnRails for usage together with vite_rails and @hotwired/turbo-rails"
-  task :install_for_and_vite_turbo do
+  task :install_for_vite_and_turbo do
 
     create_configuration_file
 
@@ -28,6 +28,7 @@ namespace :svelte_on_rails do
 
     puts ''
     puts 'SvelteOnRails installed successfully for using together with vite_rails and @hotwired/turbo-rails.'
+    puts 'Restart the server and check if it all works.'
     puts 'Happy coding!'
 
   end
@@ -50,11 +51,12 @@ namespace :svelte_on_rails do
     file_content = File.exist?(pkg_js) ? File.read(pkg_js) : ""
 
     if file_content.match?(/#{package_name}/)
-      puts "#{package_name} is already installed."
+      puts "#{package_name} is already present in package.json, assuming that it is set up well and working."
     else
       puts "Installing #{package_name} via npm..."
       if system("npm install #{package_name}")
         puts "#{package_name} successfully installed."
+        add_line_to_file(Rails.root.join("app", "frontend", "entrypoints", "application.js"), "import '#{package_name}';")
       else
         abort "Failed to install #{package_name}. Please ensure npm is installed and try running 'npm install #{package_name}' manually."
       end

metadata

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