svelte-on-rails 5.3.1 → 5.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b172f3a295136f0317cc6fabb713262b1d1ac813894ef7e07f9b48da61f01a0
-  data.tar.gz: 477f5ce8a86e4d0e7bbf508be99486a9763454ee027b43240cb3432cf5250c37
+  metadata.gz: 66ba05e463ee27dcf6234fd49f46f1879daecd331f52549080d1d9f2f9e0748d
+  data.tar.gz: 1947be68d44b723ed074098728db6a0aaba6e5c5bbbb72dc09604b5fc4dc93f3
 SHA512:
-  metadata.gz: 2f2595ac48833224788450ce49f31d775ffcd552dd628b630caa450045b02a38c725c81fadeaf4833b6eb8134d32b28c7c1b69fd387b639d0c9c655a22549a08
-  data.tar.gz: fd6aecc7d1923717b5e0119b337d221d6cf0e5c1e4a6b95f5a2a58911787b0e5a4587022850ea546a2c9e385e7d19a8fd96856ecbb07f010830bbe0d5319641b
+  metadata.gz: 3c4a60a0c0f2d372535af2a7972c4df70ecb2958e0f0f2e9c718f6aeeccbab8f2797c329ec8ea789e5aa9d9e5154bc5b5cc88f70d0a5211416aa1d5d0296d8ad
+  data.tar.gz: afa1cef4cef2787e3da4d0a040b6261f1313b503ae149238faa74f779c46a5d78a569a4ac98c84d0e76276c514d8940f9dd6b6086a58c9c7e54490a2671d18a1

data/README.md

@@ -5,20 +5,11 @@
 
 ---
 
-**Svelte on Rails: Modern Front-End + Rails Simplicity**
-
-Guided by our Principles:
-
-- **Minimal JavaScript but Reactive Power**
-- **Beautiful Code, More Joy, Better Results**
-- **Convention over Configuration**
-
-`svelte-on-rails` completes [DHH's vision](https://rubyonrails.org/2021/12/15/Rails-7-fulfilling-a-vision) 
-for modern front-end demands.
+Realizing [DHH's vision](https://rubyonrails.org/2021/12/15/Rails-7-fulfilling-a-vision) with modern front-end technologies.
 
 # Why Integrate Svelte?
 
-Svelte offers the simplest and most elegant approach to building reactive, high-performance front-end components.
+Svelte offers the simplest and most elegant soulution to building reactive, high-performance front-end components.
 
 - **Seamless Integration**
   - Works flawlessly with Hotwired/Turbo
@@ -388,39 +379,19 @@ on the svelte-on-rails config file or pass the `expires_in` as argument to the v
 
 Pass `debug: true` to the helper and you will see on the logs how your configuration works.
 
-## ActionCable / TurboStream
+## ActionCable vs. TurboStream
 
 There are two ways that the server can talk to the client over Websocket:
 
-- ActionCable transmits directly to the frontends javascript
-- TurboStreams is a wrapper around ActionCable
-  - You always need a html part for communication
-
-**Configs**
-
-Check the regarding keys and their commends on the [config file](https://gitlab.com/sedl/svelte-on-rails/-/blob/main/templates/config_base/config/svelte_on_rails.yml?ref_type=heads).
-From there, you just need:
-
-```yaml
-turbo_stream:
-  target_html_id: 'svelte-on-rails-stream-actions-box'
-  channel: 'public'
-```
-
-## ActionCable vs TurboStream
-
-- **ActionCable**
-  - Cleaner setup no html needed
-  - Seams to initialize securer, especially for testings (not: production)
-- **TurboStream**
-  - Secured Streams by html-tag `signed-stream-name` if you want to send confidential data 
-    over streams or have different channels for each user privileges
-  - Has [Compatibility issue with UJS](https://github.com/hotwired/turbo-rails?tab=readme-ov-file#compatibility-with-rails-ujs)
+- **ActionCable** transmits directly to the frontends javascript
+- **TurboStreams** is a wrapper around ActionCable
+  - You always need a html part for communication by secured channels
+  - Makes sense when you want to transfer confidential data or separate onto privileged user channels
+  - Has [compatibility issues with Rails-UJS](https://github.com/hotwired/turbo-rails?tab=readme-ov-file#compatibility-with-rails-ujs)
 
+    
 ## SvelteOnRails::ActionCable
 
-ActionCable is the more basic library behind `TurboStream` and it is a second Option to call Javascript Actions from the server.
-
 **Setup**
 
 Add `app/channels/svelte_on_rails_channel.rb`
@@ -437,7 +408,14 @@ class SvelteOnRailsChannel < ApplicationCable::Channel
 end
 ```
 
-run
+config
+
+```yaml
+action_cable:
+  channel: "svelte_on_rails_channel"
+```
+
+javascript
 
 ```shell
 npm i @rails/actioncable
@@ -510,11 +488,6 @@ on the whole `document` and fires the given event there.
 
 # SvelteOnRails::TurboStream
 
-Turbo Stream makes more sense when you think of sending confidential data to the components
-or you want to separate to channels based on user groups, for example.
-
-Few setup is needed for that:
-
 **Setup**
 
 Please setup the `turbo-rails` gem and follow the chapter [Come alive with Turbo Streams](https://github.com/hotwired/turbo-rails?tab=readme-ov-file#come-alive-with-turbo-streams), which mainly is:
@@ -541,6 +514,17 @@ you can test it by:
 
 When this works you are good to go.
 
+**Configs**
+
+Check the regarding keys and their commends on the [config file](https://gitlab.com/sedl/svelte-on-rails/-/blob/main/templates/config_base/config/svelte_on_rails.yml?ref_type=heads).
+From there, you just need:
+
+```yaml
+turbo_stream:
+  target_html_id: 'svelte-on-rails-stream-actions-box'
+  channel: 'public'
+```
+
 **Minimal Usage Example**
 
 And call this by:

data/lib/svelte_on_rails/action_cable.rb

@@ -40,7 +40,7 @@ module SvelteOnRails
 
       args = {
         eventDetail: event_detail,
-        component: '/false/',
+        component: ':false:',
         event: event,
         selector: selector
       }

data/lib/svelte_on_rails/active_record_extensions.rb

@@ -13,15 +13,20 @@ module SvelteOnRails
 
                                # separate offset and limit
 
-                               opts = attributes.grep(Hash).first.symbolize_keys
-                               offset = opts[:offset]
-                               limit = opts[:limit]
-                               attr = if offset || limit
-                                        unless self.respond_to?(:each)
-                                          raise 'offset and limit are only supported for record sets that respond to :each'
+                               h = attributes.grep(Hash)
+                               attr = if h.present?
+                                        opts = h.first.symbolize_keys
+                                        offset = opts[:offset]
+                                        limit = opts[:limit]
+                                        if offset || limit
+                                          unless self.respond_to?(:each)
+                                            raise 'offset and limit are only supported for record sets that respond to :each'
+                                          end
+                                          _opts = opts.reject { |key, _| [:offset, :limit].include?(key) }
+                                          attributes.select { |item| !item.is_a?(Hash) }.push(_opts)
+                                        else
+                                          attributes
                                         end
-                                        _opts = opts.reject { |key, _| [:offset, :limit].include?(key) }
-                                        attributes.select { |item| !item.is_a?(Hash) }.push(_opts)
                                       else
                                         attributes
                                       end

data/lib/svelte_on_rails/lib/view_helper_support.rb

@@ -79,7 +79,13 @@ module SvelteOnRails
 
       def render_ssr
         renderer = SvelteOnRails::Renderer.new(filename)
-        renderer.render(@svelte_props)
+        res = renderer.render(@svelte_props)
+        if res['html'].is_a?(Array)
+          res['html'] = res['html'].join
+          res
+        else
+          res
+        end
       end
 
       def custom_cache_key

data/lib/svelte_on_rails/renderer/render.js

@@ -14,13 +14,13 @@ import {loadComponentModule, readPropsFromStdin} from './utils.js';
 
     try {
         MyComponent(payload, props); // Writes directly to payload.out
-        console.log(`[svelte-on-rails:debug] written to payload`)
+        console.log(`[svelte-on-rails:debug] written to payload (typeof payload.out => «${typeof payload.out}»)`)
     } catch (error) {
         console.error('[svelte-on-rails:debug] Error rendering component:', error);
         process.exit(1);
     }
 
-    const res = {status: 'SUCCESS', html: payload.out.join('')};
+    const res = {status: 'SUCCESS', html: payload.out};
     console.log('[svelte-on-rails:successful-json-response]' + JSON.stringify(res));
 })();
 

data/lib/svelte_on_rails/turbo_stream.rb

@@ -40,7 +40,7 @@ module SvelteOnRails
 
       args = {
         eventDetail: event_detail,
-        component: '/false/',
+        component: ':false:',
         event: event,
         selector: selector
       }

data/templates/all_features_test/app/frontend/initializers/actionCable.js

@@ -1,5 +1,6 @@
 import { createConsumer } from "@rails/actioncable"
-import {dispatchSvelteStreamEvent, actionCableDebugLog} from '@csedl/svelte-on-rails'
+import { SvelteOnRails, dispatchSvelteStreamEvent, actionCableDebugLog } from '@csedl/svelte-on-rails'
+SvelteOnRails.debug = true
 
 const consumer = createConsumer()
 

metadata

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