svelte-on-rails 7.1.2 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 484b04267cd80435b0f5ea0f561e0b5a4658115ecffadbf283221b9809022985
-  data.tar.gz: ac2cca41825693eb678f25007528a87b22ffedb23dd744e5c573730451346860
+  metadata.gz: b2251e235c9c3ef4744e197e276e77ada5f0530baaf3b17ecbf9fc09a130cf98
+  data.tar.gz: b4359024b0fa5ce9ebf02b2384b1ae7931cbb4982670a2a3a000c8b2cdd20d42
 SHA512:
-  metadata.gz: be660994114829e76e6d2ef685ed718d499807bab18f955a7471facb688ec9647762b20c1d008a9e68153da95463b739951efb2f0aef05e1a2e563e85b85891b
-  data.tar.gz: 0421f4c6a5cc2e8812fe8722501631f399cbebb13c735580008ea902dd420bbb504df2d7f34a91ca98c427823b95972e121a83449749445e5d5886523ae802c9
+  metadata.gz: ab0dd3ba7377a4e485840bdddca3425ecacec267d98a37c74224450d2acffd34265dbb6021eaa443ced8e92205b70b4bfac6bc6e42d060670868730d81b7d586
+  data.tar.gz: c665f45bbe57aab35cec4601dff88160a6818ad4f7055b8163d26b470feec82c76f75c024779913fc96bfe67aa4f6cfce451f22f78165b051379adf3b6d9dcd3

data/README.md

@@ -11,7 +11,7 @@ Realizing [DHH's vision](https://rubyonrails.org/2021/12/15/Rails-7-fulfilling-a
 
 Svelte offers the simplest and most elegant soulution to building reactive, high-performance front-end components.
 
-See: [Comparitions on the guide](https://svelte-on-rails-docs-51acfa.gitlab.io/about/why.html)
+See: [Comparitions on the guide](https://svelte-on-rails.dev/about/why.html)
 
 # Features
 
@@ -93,9 +93,9 @@ And you will see "Svelte Hello World" on the browser! 👍  🤗
 
 # Contributors welcome
 
-see [Guide / run your first test](https://svelte-on-rails-docs-51acfa.gitlab.io/first_test.html)
+see [Guide / run your first test](https://svelte-on-rails.dev/first_test.html)
 
 
 ## Licence
 
-Copyright © 2025-2028 sedlmair.ch. Distributed by [MIT License](https://svelte-on-rails-docs-51acfa.gitlab.io/license.html)
+Copyright © 2025-2028 sedlmair.ch. Distributed by [MIT License](https://svelte-on-rails.dev/license.html)

data/lib/svelte_on_rails/configuration.rb

@@ -44,7 +44,7 @@ module SvelteOnRails
     end
 
     def redis_cache_store
-      (@configs[:redis_cache_store] || {}).with_indifferent_access
+      (@configs[:redis_cache_store] || {}).transform_keys(&:to_sym)
     end
 
     def redis_instance

data/lib/svelte_on_rails/lib/view_helper_support.rb

@@ -3,6 +3,8 @@ module SvelteOnRails
 
   module Lib
     class ViewHelperSupport
+
+      RENDER_OPTIONS = %i[ssr hydrate debug cache_key expires_in]
       attr_reader :filename, :options, :html_options, :request, :conf
 
       def initialize(file, props, html_options, options, request, caching = false)
@@ -20,7 +22,7 @@ module SvelteOnRails
         @options, @html_options = prepare_options(
           options,
           html_options,
-          %i[ssr hydrate debug cache_key expires_in]
+          RENDER_OPTIONS
         )
         @request = request
         @ssr = determine_ssr
@@ -110,6 +112,70 @@ module SvelteOnRails
         end
       end
 
+      def render_cached(view_context, &block)
+
+        cached_content = conf.redis_instance.get(cache_key)
+
+        # debug
+
+        if debug?
+
+          debug_log("Rendering component: «#{filename}», cache_key: «#{custom_cache_key}»")
+          debug_log("Redis configuration: #{conf.redis_cache_store}")
+          ttl = conf.redis_instance.ttl(cache_key)
+
+          key_stat = if cached_content.present?
+                       'has content'
+                     elsif conf.redis_instance.exists(cache_key)
+                       'exists but no content'
+                     else
+                       'not exists'
+                     end
+
+          ttl_stat = if conf.redis_instance.exists(cache_key)
+                       ", ttl was: #{ttl} seconds, now set to: #{redis_expiration_seconds} seconds"
+                     end
+
+          debug_log("Cache key: «#{cache_key}» (#{key_stat}#{ttl_stat})")
+
+        end
+
+        # increase expired time
+
+        conf.redis_instance.expire(cache_key, redis_expiration_seconds)
+
+        # render
+
+        log_message = '?'
+        res = if cached_content
+                log_message = "Returned #{filename}.svelte from cache"
+                cached_content.html_safe
+              else
+                log_message = "Rendered #{filename}.svelte and stored to cache"
+                debug_log("cache recalculating for key: #{cache_key}")
+                r = view_context.instance_eval(&block)
+                debug_log("cache recalculated")
+
+                conf.redis_instance.set(cache_key, r)
+                r
+              end
+        log_rendering(log_message)
+
+        res
+
+      end
+
+      def render(view_context, &block)
+
+        debug_log("Rendering component: #{filename}")
+
+        r = view_context.instance_eval(&block)
+
+        log_rendering("Rendered #{filename}.svelte #{'as empty element that will be mounted on the client side' unless ssr?}")
+
+        r
+      end
+
       private
 
       def determine_ssr
@@ -135,7 +201,7 @@ module SvelteOnRails
         ].compact.join('-')
 
         @cache_key_primary = [
-          conf.redis_cache_store[:namespace] ? conf.redis_cache_store[:namespace] : "svelte-on-rails:#{Rails.env}",
+          conf.redis_cache_store[:namespace] ? conf.redis_cache_store[:namespace] : "svelte-on-rails:#{Rails.env rescue 'unknown'}",
           filename_part,
         ].join(':')
 

data/lib/svelte_on_rails/renderer/renderer.rb

@@ -31,36 +31,32 @@ module SvelteOnRails
         cnf.rails_root
       ].join(' ')
 
-      Dir.chdir(cnf.rails_root) do
-        stdout, stderr, status = Open3.capture3(cmd, stdin_data: props.to_json)
+      stdout, stderr, status = Open3.capture3(cmd, stdin_data: props.to_json, chdir: cnf.rails_root)
 
-        ary = stdout.split('[svelte-on-rails:successful-json-response]')
+      ary = stdout.split('[svelte-on-rails:successful-json-response]')
 
-        unless ary.length == 2
-          raise "[svelte-on-rails] render ERROR for component: #{@component_files[:svelte_filename]}\n\ncommand:\n+++\n#{cmd}\n+++\n\nstdout:\n+++\n#{stdout}+++\n\n\nstderr:\n+++\n#{stderr}+++"
-        end
-
-
-        begin
+      unless ary.length == 2
+        raise "[svelte-on-rails] render ERROR for component: #{@component_files[:svelte_filename]}\n\ncommand:\n+++\n#{cmd}\n+++\n\nstdout:\n+++\n#{stdout}+++\n\n\nstderr:\n+++\n#{stderr}+++"
+      end
 
+      begin
 
-          res = JSON.parse(ary[1])
-          css_file = @component_files[:compiled_file] + '.css'
-          if File.exist?(css_file)
-            res['css'] = File.read(css_file)
-          end
+        res = JSON.parse(ary[1])
+        css_file = @component_files[:compiled_file] + '.css'
+        if File.exist?(css_file)
+          res['css'] = File.read(css_file)
+        end
 
-          unless status.to_s.match(/^pid [0-9]+ exit 0$/)
-            cmp = "#{@component_files[:svelte_filename]} was returned «#{status.to_s}»\n\n"
-            msg = "#{cmp}output from render.js (stderr) =>\n+++\n" + stderr + "+++\n\nRender Svelte Server-side =>\n#{cmd}\n\n"
-            utils.puts_warning(msg)
-          end
+        unless status.to_s.match(/^pid [0-9]+ exit 0$/)
+          cmp = "#{@component_files[:svelte_filename]} was returned «#{status.to_s}»\n\n"
+          msg = "#{cmp}output from render.js (stderr) =>\n+++\n" + stderr + "+++\n\nRender Svelte Server-side =>\n#{cmd}\n\n"
+          utils.puts_warning(msg)
+        end
 
-          return res
-        rescue JSON::ParserError => e
+        return res
 
-          raise "[svelte-on-rails] render ERROR Svelte Server-side for component: #{@component_files[:svelte_filename]}\n\nError message:\n+++\n#{e.message}\n+++\n\nstdout:\n+++\n#{stdout}+++\n\n\nstderr:\n+++\n#{stderr}+++"
-        end
+      rescue => e
+        raise "MY_ERR => #{e}\n\n+++\n#{e.backtrace.join("\n")}\n+++"
       end
     end
 

data/lib/svelte_on_rails/view_helpers.rb

@@ -2,80 +2,47 @@
 module SvelteOnRails
   module ViewHelpers
 
-    def svelte_component(path, props = {}, html: {}, options: {}, _props: {})
+    def svelte_component_ruby2(path, *args)
 
-      prp = validate_props(props, _props)
+      props, html, options = validate_ruby2_props(args)
 
-      support = SvelteOnRails::Lib::ViewHelperSupport.new(path, prp, html, options, request, false)
+      support = SvelteOnRails::Lib::ViewHelperSupport.new(path, props, html, options, request, false)
 
-      support.debug_log("Rendering component: #{path}")
-      log_message = '?'
-
-      log_message = "Rendered #{support.filename}.svelte #{'as empty element that will be mounted on the client side' unless support.ssr?}"
-      res = render_component(support)
-
-      support.log_rendering(log_message)
-
-      res
+      support.render(self) do
+        render_component(support)
+      end
 
     end
 
-    def cached_svelte_component(path, props = {}, html: {}, options: {}, _props: {})
-
-      prp = validate_props(props, _props)
+    def cached_svelte_component_ruby2(path, *args)
 
-      support = SvelteOnRails::Lib::ViewHelperSupport.new(path, prp, html, options, request, true)
+      props, html, options = validate_ruby2_props(args)
 
-      log_message = '?'
-      redis = support.conf.redis_instance
-      cached_content = redis.get(support.cache_key)
+      support = SvelteOnRails::Lib::ViewHelperSupport.new(path, props, html, options, request, true)
 
-      # TTL
-      if support.debug?
-
-        support.debug_log("Rendering component: «#{filename}», cache_key: «#{support.custom_cache_key}»")
-        support.debug_log("Redis configuration: #{support.conf.redis_cache_store}")
-        ttl = redis.ttl(support.cache_key)
+      support.render_cached(self) do
+        render_component(support)
+      end
 
-        key_stat = if cached_content.present?
-                     'has content'
-                   elsif redis.exists(support.cache_key)
-                     'exists but no content'
-                   else
-                     'not exists'
-                   end
+    end
 
-        ttl_stat = if redis.exists(support.cache_key)
-                     ", ttl was: #{ttl} seconds, now set to: #{support.redis_expiration_seconds} seconds"
-                   end
+    def svelte_component(path, props = {}, html: {}, options: {})
 
-        support.debug_log("Cache key: «#{support.cache_key}» (#{key_stat}#{ttl_stat})")
+      support = SvelteOnRails::Lib::ViewHelperSupport.new(path, props, html, options, request, false)
 
+      support.render(self) do
+        render_component(support)
       end
 
-      redis.expire(support.cache_key, support.redis_expiration_seconds)
-
-      res = if cached_content
-              log_message = "Returned #{support.filename}.svelte from cache"
-              cached_content.html_safe
-            else
-              log_message = "Rendered #{support.filename}.svelte and stored to cache"
-              support.debug_log("cache recalculating for key: #{support.cache_key}")
-              r = render_component(support)
-              support.debug_log("cache recalculated")
-
-              # redis.scan_each(match: "#{support.cache_key_primary}:*") do |key|
-              #   redis.del(key)
-              #   support.debug_log("deleted cache, pattern: «#{support.cache_key_primary}:*»,  key: #{key.sub("#{support.cache_key_primary}:", '[..]')}")
-              # end
+    end
 
-              redis.set(support.cache_key, r)
-              r
-            end
+    def cached_svelte_component(path, props = {}, html: {}, options: {})
 
-      support.log_rendering(log_message)
+      support = SvelteOnRails::Lib::ViewHelperSupport.new(path, props, html, options, request, true)
 
-      res
+      support.render_cached(self) do
+        render_component(support)
+      end
 
     end
 
@@ -98,18 +65,32 @@ module SvelteOnRails
       end
     end
 
-    def validate_props(props, _props)
-      if props.present? && _props.present?
-        raise "you can only pass props as the first argument OR use the _props keyword argument. the latter only is made as workaround for Apps <= ruby-3"
-      end
-      if RUBY_VERSION.split('.').first.to_i >= 3 && _props.present?
-        raise "The _props keyword-argument is only meant as workaround for Apps <= ruby-3 because of avoiding misinterpreting hash as keyword arguments"
+    def validate_ruby2_props(args)
+      last_is_kwargs = false
+      kw_err = false
+
+      if args.length > 2
+        kw_err = true
+      elsif args.length >= 1
+        if args.last.keys & [:html, :options]
+          last_is_kwargs = true
+          if (args.last.keys - [:html, :options]).present?
+            kw_err = true
+          end
+        end
       end
-      if props.present?
-        props
-      else
-        _props
+
+      if kw_err
+        raise "Invalid arguments: First argument can be a hash as svelte-properties, second and third arguments are keyword arguments: :html and/or :options"
       end
+
+      first_is_props = args.length == 1 && !last_is_kwargs || args.length == 2
+
+      [
+        (first_is_props ? args.first : nil),
+        (last_is_kwargs ? args[1][:html] : nil),
+        (last_is_kwargs ? args[1][:options] : nil),
+      ]
     end
 
   end

metadata

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