svelte-on-rails 7.1.3 → 8.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 970ffe37f898ba6c9f0b9069ae2116c5519f79c37d657e41e395b702a17e3863
-  data.tar.gz: 2268e86265ba09a36a0c3513263985e670eae3ff06261b7799211161489bbac2
+  metadata.gz: 9fd78748cd0a7f9c896123e31dbbccab10dc7d42bc394a14fbc66efa360a166d
+  data.tar.gz: ce14713af9654cdbeb0e2ddf5cb9e46174308d9018c668b97f1db47b083e0324
 SHA512:
-  metadata.gz: 668fc5b19bae1d1da87d864a081e6c5a7eb201f0f5b3df775c754d4c03ebc6c56b5eff69019d9508e9fedf47b399c1ae77c0eef4bbe3cc159fe0822afa2cfc7f
-  data.tar.gz: 736e4de6627a22755057fc5909ce87f642be1c80cac55bf6d74a461d3b02b23065935951779f989abcd9264dd6602df0f6bcfabb8746e30cafae9ce950c70d48
+  metadata.gz: 033d0d7cb3a2147119668913978f8a8fdba37d0467b7e7c756afaf60609352ed6bb2aa3805c1640c81a78dedb325eda7e298410c3df4485ed6f0fc7d796fa33c
+  data.tar.gz: f1b1830ad7056f1dff09077ba6576c6d64db6a8f27bfbfb9cc2dad70f128d0078137b9fbb970179c6702c677f443316f69c2d4f7e32dec33cca7aa37d6a8c6f9

data/README.md

@@ -52,7 +52,7 @@ If you have issues, please open one, and contributors are welcome!
 
 **PROPS ON RUBY <= 3**
 
-On ruby <3 Arguments can be misinterpreted, see [issue-10](https://gitlab.com/sedl/svelte-on-rails/-/issues/10)
+On ruby <3 Arguments are misinterpreted, see [issue-10](https://gitlab.com/sedl/svelte-on-rails/-/issues/10)
 
 
 ## Installation

data/lib/svelte_on_rails/active_record_extensions.rb

@@ -1,11 +1,8 @@
 # lib/svelte_on_rails/active_record_extensions.rb
 module SvelteOnRails
+
+
   module ActiveRecordExtensions
-    # def self.included(base)
-    #   unless defined?(ActiveRecord::Base) && base.ancestors.include?(ActiveRecord::Base)
-    #     raise 'SvelteOnRails::ActiveRecordExtensions can only be included in ActiveRecord models'
-    #   end
-    # end
 
     # Returns a hash of attributes, methods, and associations formatted for Svelte components
     def to_svelte(*attributes, **associations)
@@ -13,29 +10,38 @@ module SvelteOnRails
 
                        cl = SvelteOnRails::Lib::SvelteAttributes
                        r = cl.new.calculate_instance(self, attributes, associations)
-                       r.first.merge({self.class.to_s.underscore => r[1]})
+                       r.first.merge({ self.class.to_s.underscore => r[1] })
 
                      end
     end
 
   end
 
+
+
   module ActiveRecordClassExtensions
+
     def to_svelte(*attributes, **associations)
+
       @to_svelte ||= begin
                        cl = SvelteOnRails::Lib::SvelteAttributes
-                       cl.new.calculate_class(self, attributes, associations)
+                         cl.new.calculate_class(self, attributes, associations)
                      end
     end
+
   end
 
+
+
   module ActiveRecordRelationExtensions
+
     def to_svelte(*attributes, **associations)
       @to_svelte ||= begin
                        cl = SvelteOnRails::Lib::SvelteAttributes
                        cl.new.calculate_relation(self, attributes, associations)
                      end
     end
+
   end
 
 end

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/railtie.rb

@@ -15,16 +15,17 @@ module SvelteOnRails
 
     initializer 'svelte_on_rails.active_record_extensions' do
       ActiveSupport.on_load(:active_record) do
-        # Include instance-level extensions
+        # Include instance-level extensions for ActiveRecord instances (e.g., @article)
         include SvelteOnRails::ActiveRecordExtensions
-        # Extend with class-level extensions
-        extend SvelteOnRails::ActiveRecordClassExtensions
+
+        # Extend ActiveRecord::Base with class-level extensions (e.g., Article)
+        ActiveRecord::Base.extend SvelteOnRails::ActiveRecordClassExtensions
+
+        # This also extends ActiveRecord::Relation (e.g., @articles)
+        ActiveRecord::Relation.include SvelteOnRails::ActiveRecordRelationExtensions
+
       end
-    end
 
-    # Extend ActiveRecord::Relation
-    ActiveSupport.on_load(:active_record_relation) do
-      include SvelteOnRails::ActiveRecordRelationExtensions
     end
 
     rake_tasks do

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.3
+  version: 8.0.1
 platform: ruby
 authors:
 - Christian Sedlmair