svelte-on-rails 11.0.10 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bde355e06f9c67b4bddea860a356d1574a0835966d5b63a2170293024c676a05
-  data.tar.gz: 0a6f0db199a045ad2cc5338d0700b1679d114cc8e26389c4d8abc38db389a8be
+  metadata.gz: fb357cd39ec18f7dc77764d09b78cb12a7a002df261b85d022d87c0c4337c7fe
+  data.tar.gz: 335302f38a588c5dca3b997e20c93093a4022bbbcbe61ff58528ce5250a524ae
 SHA512:
-  metadata.gz: ec78cc57811b3803d3130ad37c1c4a8c96f2736e515c4c2a69dc6d9fb22a6655f98d350d1a902bca767ded50e5c9ff08e4575343e0de019ab4de01cf015ffb54
-  data.tar.gz: 259e6ac460b837e0e8faa9fa37163463c916a72a642993297335202a6a874ede1bc925b02f3c01c628806952fed2dc10df90bead409d7861a41069470659794c
+  metadata.gz: aac83b836117549e9d838d5d16fb86301f2e4d0fdf91a82125a1f216c9899c1ab2c702dc3cbf636a0caf1f7457788943007195bdb14146f62302e00fb31d7d83
+  data.tar.gz: '08f845a7c90c0a450e7f8eb549a7a5b6dcd73052528896dd76e8b3075b66629fe4da7c825e01101dca7a96615f5cde2718ab86693092c10d063bb7d5b5a10947'

data/lib/svelte-on-rails.rb

@@ -31,6 +31,7 @@ require 'generators/svelte_on_rails/update/update_generator'
 require 'generators/showcase_generator'
 
 require 'digest/xxhash'
+require 'benchmark'
 
 module SvelteOnRails
   class << self

data/lib/svelte_on_rails/configuration.rb

@@ -61,7 +61,6 @@ module SvelteOnRails
         @redis_instance = Redis.new(url: redis_cache_store[:url])
       end
 
-
       validate_configs
     end
 
@@ -77,6 +76,24 @@ module SvelteOnRails
       @configs[:watch_changes] == true
     end
 
+    def debug_log(debug, component_basename, subject, &block)
+      msg = "  [svelte-on-rails:#{component_basename}] #{subject}"
+      if !block_given?
+        Rails.logger.debug(msg)
+      else
+        if debug || @configs[:debug]
+          r = nil
+          sec = Benchmark.realtime do
+            r = block.call
+          end
+          Rails.logger.debug("#{msg} (#{(sec * 1000.0).round(2)}ms)")
+          r
+        else
+          block.call
+        end
+      end
+    end
+
     def rails_root(root_url = nil)
       root_url || Rails.root
     end
@@ -213,7 +230,6 @@ module SvelteOnRails
         raise "[svelte-on-rails] Missing configuration: #{k}" if !@configs.key?(k) && v.keys.include?(:required)
       end
 
-
     end
 
   end

data/lib/svelte_on_rails/lib/utils.rb

@@ -74,6 +74,7 @@ module SvelteOnRails
         {
           path: path,
           component: [(dir.present? ? dir : nil), basename].compact.join('/'),
+          component_basename: basename,
           vite_path: vite_path
         }
       end

data/lib/svelte_on_rails/lib/view_helper_support.rb

@@ -21,9 +21,10 @@ module SvelteOnRails
           validate_options
           ensure_valid_component_and_manifest!(component)
 
-          if @conf.component_changed?(component_paths[:path])
-            debug_log("Rebuilding assets...")
-            @conf.vite_build
+          if @conf.component_changed?(component_paths[:path], debug?, component_paths[:component_basename])
+            @conf.debug_log(debug?, component_paths[:component_basename], "Rebuilding assets...") do
+              @conf.vite_build
+            end
           end
 
         end
@@ -71,24 +72,18 @@ module SvelteOnRails
       def log_completed(message)
         ms = ((Time.now - @start_time) * 1000)
         @conf.request_metrics[:total_time] += ms
-        Rails.logger.info "  [SvelteOnRails] #{message} (#{ms.round(1)}ms)"
+        Rails.logger.info "  [svelte-on-rails:#{component_paths[:component_basename]}] #{message} (#{ms.round(1)}ms)"
 
       end
 
-      def debug_log(message)
-        if debug?
-          Rails.logger.debug("  [SvelteOnRails:debug] #{message}")
-        end
-      end
-
       def render_cached(view_context, &block)
 
         # debug
 
         if debug?
 
-          debug_log("Rendering #{component_paths[:component]}")
-          debug_log("Redis configuration: #{@conf.redis_cache_store}")
+          @conf.debug_log(true, component_paths[:component_basename], "Rendering...")
+          @conf.debug_log(true, component_paths[:component_basename], "Redis configuration: #{@conf.redis_cache_store}")
           ttl = conf.redis_instance.ttl(@cache_key)
 
           key_stat = if @cached_content.present?
@@ -103,7 +98,7 @@ module SvelteOnRails
                        ", ttl was: #{ttl} seconds, now set to: #{redis_expiration_seconds} seconds"
                      end
 
-          debug_log("Cache key: «#{@cache_key}» (#{key_stat}#{ttl_stat})")
+          @conf.debug_log(true, component_paths[:component_basename], "Cache key: «#{@cache_key}» (#{key_stat}#{ttl_stat})")
 
         end
 
@@ -114,13 +109,13 @@ module SvelteOnRails
         # render
 
         res = if @cached_content
-                log_message = "Returned #{component_paths[:component]} from cache"
+                log_message = "Returned from cache"
                 @cached_content.html_safe
               else
-                log_message = "Rendered #{component_paths[:component]} and stored to cache"
-                debug_log("Cache recalculating for key: #{@cache_key}")
+                log_message = "Rendered and stored to cache"
+                @conf.debug_log(debug?, component_paths[:component_basename], "Cache recalculating for key: #{@cache_key}")
                 r = view_context.instance_eval(&block)
-                debug_log("Cache recalculated")
+                @conf.debug_log(debug?, component_paths[:component_basename], "Cache recalculated")
 
                 @conf.redis_instance.set(@cache_key, r)
                 r
@@ -133,7 +128,7 @@ module SvelteOnRails
 
       def render(view_context, &block)
 
-        debug_log("Rendering component #{component_paths[:component]}")
+        @conf.debug_log(debug?, component_paths[:component_basename], "Rendering ...")
 
         r = view_context.instance_eval(&block)
 
@@ -150,7 +145,7 @@ module SvelteOnRails
         end
         p = component_paths
 
-        # validate file-path
+        # validate filename
 
         unless p[:path].present?
           raise <<~TEXT
@@ -158,12 +153,19 @@ module SvelteOnRails
 
           TEXT
         end
+        unless p[:component_basename].match?(/^[A-Z][A-Za-z0-9]+$/)
+          raise <<~TEXT
+            [svelte-on-rails] Invalid filename: «#{p[:component_basename]}»
+            Component names must be CamelCased.
+
+          TEXT
+        end
 
         # validate manifest.json matching to file-path derived from component-name
 
-        unless @conf.manifest[p[:path]]
+        unless @conf.manifest(debug?, p[:component_basename])[p[:path]]
           @conf.vite_build
-          unless @conf.manifest[p[:path]]
+          unless @conf.manifest(debug?, p[:component_basename])[p[:path]]
             raise <<~TEXT
               [svelte-on-rails] No manifest found for component: «#{p[:path]}»
               Available keys in current manifest.json are:
@@ -207,7 +209,7 @@ module SvelteOnRails
 
       def fetch_cached_content(component, controller_path, props, options, html_options)
 
-        fingerprint = ( @conf.watch_changes? ? @conf.fingerprint(component_paths[:path]) : '' )
+        fingerprint = (@conf.watch_changes? ? @conf.fingerprint(component_paths[:path], debug?, component_paths[:component_basename]) : '')
 
         cache_key_raw = controller_path + component +
                         props.to_s + options.to_s + html_options.to_s +

data/lib/svelte_on_rails/lib/watch_asset_changes.rb

@@ -16,10 +16,10 @@ module SvelteOnRails
       end
 
       # go recursively through the entrypoints subtree and check if any of them changed
-      def component_changed?(component_path)
+      def component_changed?(component_path, debug, component_basename)
         @component_files ||= {}
         @debug_double_files = []
-        paths = @component_files[component_path] ||= fetch_source_files(component_path)
+        paths = @component_files[component_path] ||= fetch_source_files(component_path, debug, component_basename)
         paths.each do |file|
           mtime = File.mtime(file).to_f.round(3)
           if mtime > last_build
@@ -29,13 +29,15 @@ module SvelteOnRails
         false
       end
 
-      def fingerprint(component_path)
+      def fingerprint(component_path, debug, component_basename)
         # We do not cache this as this function is only for development.
         # Therefore, it is fast enough.
-        build_fingerprint(component_path)
+        debug_log(debug, component_basename, "Building fingerprint") do
+          build_fingerprint(component_path, debug, component_basename)
+        end
       end
 
-      def manifest
+      def manifest(debug, component_basename)
 
         # ensure we have a current manifest loaded
 
@@ -43,13 +45,18 @@ module SvelteOnRails
           @manifest = {}
         end
 
-        if !@manifest.present?
-          @manifest_mtime = File.mtime(manifest_json_path).to_f.round(3)
-          @manifest = JSON.parse(File.read(manifest_json_path))
-        else
-          @manifest
+        if @manifest.empty?
+          debug_log(
+            debug,
+            component_basename,
+            "Manifest loaded"
+          ) do
+            @manifest_mtime = File.mtime(manifest_json_path).to_f.round(3)
+            @manifest = JSON.parse(File.read(manifest_json_path))
+          end
         end
 
+        @manifest
       end
 
       private
@@ -71,19 +78,19 @@ module SvelteOnRails
         @last_build
       end
 
-      def fetch_source_files(component, files = [])
-        _manifest = manifest[component]
+      def fetch_source_files(component, debug, component_basename, files = [])
+        _manifest = manifest(debug, component_basename)[component]
         raise "ERROR: Could not find manifest entry for «#{component}»\n\nmanifest:\n+++\n#{manifest}\n+++" unless _manifest
 
         if _manifest['src']
           add_file(files, rails_root.join(_manifest['src']).to_s)
-          add_files(files, chunk_files(component))
+          add_files(files, chunk_files(component, debug, component_basename))
         elsif _manifest['file']
-          add_files(files, chunk_files(component))
+          add_files(files, chunk_files(component, debug, component_basename))
         end
 
         _manifest['imports'].to_a.each do |import|
-          files = fetch_source_files(import, files)
+          files = fetch_source_files(import, debug, component_basename, files)
         end
 
         files
@@ -107,19 +114,19 @@ module SvelteOnRails
         end
       end
 
-      def chunk_files(component_path)
-        asset_file = manifest[component_path]['file']
+      def chunk_files(component_path, debug, component_basename)
+        asset_file = manifest(debug, component_basename)[component_path]['file']
         dev_modules_map[asset_file].to_a
       end
 
-      def build_fingerprint(component, str = '')
-        _manifest = manifest[component]
+      def build_fingerprint(component, debug, component_basename, str = '')
+        _manifest = manifest(debug, component_basename)[component]
         raise "ERROR: Could not find manifest entry for «#{component}»" unless _manifest
         _str = _manifest['file'].split(_manifest['name']).last
         str << _str[0, _str.rindex('.')]
 
         _manifest['imports'].to_a.each do |import|
-          build_fingerprint(import, str)
+          build_fingerprint(import, debug, component_basename, str)
         end
 
         str

data/lib/svelte_on_rails/renderer/renderer.rb

@@ -6,13 +6,14 @@ module SvelteOnRails
     require 'base64'
     require 'json'
 
-    def self.render(component_path, props)
+    def self.render(paths, props, debug)
       utils = SvelteOnRails::Lib::Utils
       cnf = SvelteOnRails::Configuration.instance
-      manifest = cnf.manifest[component_path]
+      mn = cnf.manifest(debug, paths[:component_basename])
+      manifest = mn[paths[:path]]
 
       if manifest.nil?
-        raise "[svelte-on-rails:Renderer.render] ERROR: No manifest found for component: «#{component_path}»\nAvailable keys in current manifest.json are:\n\n+++\n • #{cnf.manifest.keys.join("\n • ")}\n+++\n."
+        raise "[svelte-on-rails:#{paths[:component_basename]}] ERROR: No manifest found!\nAvailable keys in current manifest.json are:\n\n+++\n • #{cnf.manifest.keys.join("\n • ")}\n+++\n."
       end
 
       cmd = [
@@ -30,7 +31,7 @@ module SvelteOnRails
       ary = stdout.split('[svelte-on-rails:successful-json-response]')
 
       unless ary.length == 2
-        raise "[svelte-on-rails] render ERROR for component: #{component_path}\n\ncommand:\n+++\n#{cmd}\n+++\n\nstdout:\n+++\n#{stdout}+++\n\n\nstderr:\n+++\n#{stderr}+++"
+        raise "[svelte-on-rails:#{paths[:component_basename]}] RENDER ERROR\n\ncommand:\n+++\n#{cmd}\n+++\n\nstdout:\n+++\n#{stdout}+++\n\n\nstderr:\n+++\n#{stderr}+++"
       end
 
       begin
@@ -38,7 +39,7 @@ module SvelteOnRails
         res = JSON.parse(ary[1])
 
         unless status.to_s.match(/^pid [0-9]+ exit 0$/)
-          cmp = "#{component_path} was returned «#{status.to_s}»\n\n"
+          cmp = "#{paths[:path]} 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

data/lib/svelte_on_rails/view_helpers.rb

@@ -32,7 +32,7 @@ module SvelteOnRails
 
       if support.ssr?
 
-        ssr_result = SvelteOnRails::Renderer.render(support.component_paths[:path], props)
+        ssr_result = SvelteOnRails::Renderer.render(support.component_paths, props, support.debug?)
         content_tag(:div, support.tag_attributes(html_options, props)) do
           concat(ssr_result['head'].html_safe)
           concat(ssr_result['html'].sub('<!--[-->', '').sub('<!--]-->', '').html_safe)

metadata

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