RubyGems - actionview-svelte-handler - Versions diffs - 0.5.7 → 0.7.0 - Mend

actionview-svelte-handler 0.5.7 → 0.7.0

Files changed (25) hide show

checksums.yaml +4 -4
data/Gemfile.lock +2 -1
data/README.md +1 -1
data/actionview-svelte-handler.gemspec +3 -0
data/lib/actionview-svelte-handler.rb +1 -0
data/lib/generators/svelte/install_generator.rb +2 -1
data/lib/svelte/errors.rb +140 -138
data/lib/svelte/handler.rb +45 -41
data/lib/svelte/helpers.rb +1 -1
data/lib/svelte/js/builder.js +78 -37
data/lib/svelte/railtie.rb +3 -0
data/lib/svelte/templates/assembler.js.erb +5 -3
data/lib/svelte/templates/island.html.erb +7 -9
data/lib/svelte/version.rb +1 -1
data/lib/svelte.rb +9 -6
data/lib/ts/builder.ts +72 -34
data/lib/ts/types/builder.d.ts +4 -2
data/package-lock.json +970 -114
data/package.json +11 -3
data/rbs_collection.lock.yaml +60 -28
data/sig/lib/svelte/errors.rbs +35 -34
data/sig/lib/svelte.rbs +1 -1
data/tmp/.gitkeep +0 -0
metadata +19 -4
data/svelte-on-rails.png +0 -0

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35a9952571d74905f67d9219dd86b759f2ac7b11c42fc68a0817f964247fa0d4
-  data.tar.gz: be744cb8c46cfaafe8e4d3a707499038eb6f3200f0256cc947d766ed325d0d08
+  metadata.gz: 1fcb603925b52a51a8488d83da752370c24135602c464b51993f86b58fedf1af
+  data.tar.gz: 7f3e9f80901d4b567758e259ab37e5ed7a315459a3b1b867b9f2f847b1697b29
 SHA512:
-  metadata.gz: c7ca8ce660365595737c2f60e04b6c027a11f879e540f3af405d31fe168caf58914cb7b7e1a74c08c4ee74e2c226d01c5cb45b39944d981b5eb564074a25c5b2
-  data.tar.gz: 28fbb9843d9893b9a92a03c26296e7fe3271548ceea5a5e2a559d578d3ec5ff545a3de7f0076e0c62b7605b9494d9996ef397130186313f70030427a4ff41c7b
+  metadata.gz: a4260e66a28e3006940465ef5158f3bdf9cc2559327ca14ca4f4ff7c75d405bf051abc7e95de2452e5083a6ef68d51375735735340039ea4fc54ce1f0a4eb6e8
+  data.tar.gz: 0b131aebc945768f2a7bfd0a4d16cddf80e4198a54d59dffa48a4da6b76573bfc5e439a332e5ee3c4189fc2f29bc2f5cde3e3045dc44330482244c0406a90f46

data/Gemfile.lock CHANGED Viewed

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    actionview-svelte-handler (0.5.7)
+    actionview-svelte-handler (0.7.0)
       rails (~> 7.0)
+      zeitwerk (~> 2)
 GEM
   remote: https://rubygems.org/

data/README.md CHANGED Viewed

@@ -1,4 +1,4 @@
-<img src="https://codeberg.org/reesericci/actionview-svelte-handler/raw/branch/main/svelte-on-rails.png" width="100px">
+<img src="https://codeberg.org/reesericci/actionview-svelte-handler/raw/branch/main/docs/public/logo.png" width="100px">
 # `actionview-svelte-handler`

data/actionview-svelte-handler.gemspec CHANGED Viewed

@@ -2,6 +2,7 @@ require_relative "lib/svelte/version"
 Gem::Specification.new do |spec|
   spec.name = "actionview-svelte-handler"
+  spec.autorequire = "svelte"
   spec.version = Svelte::VERSION
   spec.authors = ["reesericci"]
   spec.email = ["me@reeseric.ci"]
@@ -18,4 +19,6 @@ Gem::Specification.new do |spec|
   end
   spec.add_runtime_dependency "rails", "~> 7.0"
+  spec.add_dependency "zeitwerk", "~> 2"
 end

data/lib/actionview-svelte-handler.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ require "svelte"

data/lib/generators/svelte/install_generator.rb CHANGED Viewed

@@ -9,7 +9,8 @@ module Svelte
       insert_into_file "app/views/layouts/application.html.erb",
         "\n    <%= svelte_tags %>",
         after: "<head>"
-      `npm install #{Gem::Specification.find_by_name("actionview-svelte-handler").gem_dir} --install-links --save=false`
+      `npm link #{Gem::Specification.find_by_name("actionview-svelte-handler").gem_dir} --save`
+      `npm install`
     end
   end
 end

data/lib/svelte/errors.rb CHANGED Viewed

@@ -1,148 +1,150 @@
 require "active_support/syntax_error_proxy"
 require "action_view/template/error"
 module Svelte
-  class CompilerError < ActiveSupport::SyntaxErrorProxy # steep:ignore UnknownConstant
-    attr_accessor :location, :suggestion, :template
-    def initialize(message, location)
-      @location = location
-      @sugggestion = @location.dig(:suggestion) || ""
-      # steep:ignore:start
-      super(message) # : self
-      # steep:ignore:end
-    end
-    def message
-      to_s
-    end
-    def backtrace
-      if suggestion
-        ["#{Rails.root.join location[:file]}:#{location[:line]}:#{message}, #{suggestion}"] + caller
-      else
-        ["#{Rails.root.join location[:file]}:#{location[:line]}:#{message}"] + caller
+  module Errors
+    class CompilerError < ActiveSupport::SyntaxErrorProxy # steep:ignore UnknownConstant
+      attr_accessor :location, :suggestion, :template
+      def initialize(message, location)
+        @location = location
+        @sugggestion = @location.dig(:suggestion) || ""
+        # steep:ignore:start
+        super(message) # : self
+        # steep:ignore:end
       end
-    end
-    def cause
-      nil
-    end
-    def bindings
-      [template.send(:binding)]
-    end
-    def backtrace_locations
-      traces = backtrace.map { |trace|
-        file, line = trace.match(/^(.+?):(\d+).*$/, &:captures) || trace
-        ActiveSupport::SyntaxErrorProxy::BacktraceLocation.new(file, line.to_i, trace) # steep:ignore UnknownConstant
-      }
-      traces.map { |loc| ActiveSupport::SyntaxErrorProxy::BacktraceLocationProxy.new(loc, self) } # steep:ignore UnknownConstant
-    end
-    def annotated_source_code
-      location[:lineText].split("\n").map.with_index(1) { |line, index|
-        indentation = " " * 4
-        "#{index}:#{indentation}#{line}"
-      }
-    end
-  end
-  class TemplateError < StandardError
-    attr_reader :cause, :template
-    SOURCE_CODE_RADIUS = 3
-    def initialize(template, error)
-      raise("Did not provide cause error") unless error
-      @cause = error
-      raise("Did not provide template") unless template
-      @template, @sub_templates = template, nil
-      raise("Cause error is nil for TemplateError") unless @cause
-      @cause.template = template
-      # steep:ignore:start
-      super(@cause.message) # : self
-      # steep:ignore:end
-    end
-    def message
-      @cause.message
-    end
-    def annotated_source_code
-      @cause.annotated_source_code
-    end
-    # Following is copypasta-ed from ActionView::Template::Error
-    def backtrace
-      @cause.backtrace
-    end
-    def backtrace_locations
-      @cause.backtrace_locations
-    end
-    def file_name
-      @template.identifier
-    end
-    def sub_template_message
-      if @sub_templates
-        "Trace of template inclusion: " +
-          @sub_templates.collect(&:inspect).join(", ")
-      else
-        ""
+      def message
+        to_s
       end
-    end
-    def source_extract(indentation = 0)
-      return [] unless (num = line_number)
-      num = num.to_i
-      source_code = @template.encode!.split("\n")
-      start_on_line = [num - SOURCE_CODE_RADIUS - 1, 0].max
-      end_on_line = [num + SOURCE_CODE_RADIUS - 1, source_code.length].min
-      indent = end_on_line.to_s.size + indentation
-      return [] unless (source_code = source_code[start_on_line..end_on_line])
-      formatted_code_for(source_code, start_on_line, indent)
-    end
-    def sub_template_of(template_path)
-      @sub_templates ||= []
-      @sub_templates << template_path
-    end
-    def line_number
-      @line_number ||=
-        if file_name
-          regexp = /#{Regexp.escape File.basename(file_name)}:(\d+)/
-          $1 if message =~ regexp || backtrace.find { |line| line =~ regexp }
+      def backtrace
+        if suggestion
+          ["#{Rails.root.join location[:file]}:#{location[:line]}:#{message}, #{suggestion}"] + caller
+        else
+          ["#{Rails.root.join location[:file]}:#{location[:line]}:#{message}"] + caller
         end
+      end
+      def cause
+        nil
+      end
+      def bindings
+        [template.send(:binding)]
+      end
+      def backtrace_locations
+        traces = backtrace.map { |trace|
+          file, line = trace.match(/^(.+?):(\d+).*$/, &:captures) || trace
+          ActiveSupport::SyntaxErrorProxy::BacktraceLocation.new(file, line.to_i, trace) # steep:ignore UnknownConstant
+        }
+        traces.map { |loc| ActiveSupport::SyntaxErrorProxy::BacktraceLocationProxy.new(loc, self) } # steep:ignore UnknownConstant
+      end
+      def annotated_source_code
+        location[:lineText].split("\n").map.with_index(1) { |line, index|
+          indentation = " " * 4
+          "#{index}:#{indentation}#{line}"
+        }
+      end
     end
-    private
-    def source_location
-      if line_number
-        "on line ##{line_number} of "
-      else
-        "in "
-      end + file_name
-    end
-    def formatted_code_for(source_code, line_counter, indent)
-      raise("line counter is nil") if line_counter.nil?
-      indent_template = "%#{indent}s: %s"
-      source_code.map do |line|
-        line_counter += 1
-        indent_template % [line_counter, line]
+    class TemplateError < StandardError
+      attr_reader :cause, :template
+      SOURCE_CODE_RADIUS = 3
+      def initialize(template, error)
+        raise("Did not provide cause error") unless error
+        @cause = error
+        raise("Did not provide template") unless template
+        @template, @sub_templates = template, nil
+        raise("Cause error is nil for TemplateError") unless @cause
+        @cause.template = template
+        # steep:ignore:start
+        super(@cause.message) # : self
+        # steep:ignore:end
+      end
+      def message
+        @cause.message
+      end
+      def annotated_source_code
+        @cause.annotated_source_code
+      end
+      # Following is copypasta-ed from ActionView::Template::Error
+      def backtrace
+        @cause.backtrace
+      end
+      def backtrace_locations
+        @cause.backtrace_locations
+      end
+      def file_name
+        @template.identifier
+      end
+      def sub_template_message
+        if @sub_templates
+          "Trace of template inclusion: " +
+            @sub_templates.collect(&:inspect).join(", ")
+        else
+          ""
+        end
+      end
+      def source_extract(indentation = 0)
+        return [] unless (num = line_number)
+        num = num.to_i
+        source_code = @template.encode!.split("\n")
+        start_on_line = [num - SOURCE_CODE_RADIUS - 1, 0].max
+        end_on_line = [num + SOURCE_CODE_RADIUS - 1, source_code.length].min
+        indent = end_on_line.to_s.size + indentation
+        return [] unless (source_code = source_code[start_on_line..end_on_line])
+        formatted_code_for(source_code, start_on_line, indent)
+      end
+      def sub_template_of(template_path)
+        @sub_templates ||= []
+        @sub_templates << template_path
+      end
+      def line_number
+        @line_number ||=
+          if file_name
+            regexp = /#{Regexp.escape File.basename(file_name)}:(\d+)/
+            $1 if message =~ regexp || backtrace.find { |line| line =~ regexp }
+          end
+      end
+      private
+      def source_location
+        if line_number
+          "on line ##{line_number} of "
+        else
+          "in "
+        end + file_name
+      end
+      def formatted_code_for(source_code, line_counter, indent)
+        raise("line counter is nil") if line_counter.nil?
+        indent_template = "%#{indent}s: %s"
+        source_code.map do |line|
+          line_counter += 1
+          indent_template % [line_counter, line]
+        end
       end
     end
   end

data/lib/svelte/handler.rb CHANGED Viewed

@@ -1,5 +1,6 @@
 require "erb"
 require "svelte/helpers"
+require "ostruct"
 module Svelte
   DISCARD_PROPS = %w[lookup_context view_renderer current_template output_buffer view_flow rendered_format marked_for_same_origin_verification virtual_path]
@@ -13,50 +14,53 @@ module Svelte
       digest = Digest::SHA256.base64digest(source)
       <<-RUBY
-        template = ObjectSpace._id2ref(#{template.object_id})
-        Svelte.props.merge!(
-          instance_values.reject { |k,v|
-            k.start_with?("_") || Svelte::DISCARD_PROPS.include?(k)
-          }
-        ) { |key,old,new| old }
-        Svelte.props.deep_symbolize_keys!
-        if local_assigns.dig(:svelte) == nil
-          local_assigns[:svelte] = {}
-        end
-        assembler = nil
-        assembler = Tempfile.new(['assembler', ".mjs"], '#{Svelte.gem_dir}/tmp')
+        Dir.mktmpdir("svelte", Rails.root.join('tmp')) do |dir|
+          template = OpenStruct.new(JSON.parse('#{template.to_json}').deep_symbolize_keys)
-        assembler.write(ERB.new(File.read('#{Svelte.gem_dir}/lib/svelte/templates/assembler.js.erb')).result_with_hash({
-          path: '#{Rails.root.join template.identifier}',
-          locals: local_assigns,
-          compiled_client: j(Rails.cache.read('svelte/template/client' + '#{digest}')),
-          compiled_server: j(Rails.cache.read('svelte/template/server' + '#{digest}')),
-          ssr: Svelte.precedence(local_assigns.dig(:svelte, :ssr), template.variant.nil? ? nil : (template.variant == "server"), Svelte.ssr)
-        }))
-        assembler.rewind
+          Svelte.props.merge!(
+            instance_values.reject { |k,v|
+              k.start_with?("_") || Svelte::DISCARD_PROPS.include?(k)
+            }
+          ) { |key,old,new| old }
+          Svelte.props.deep_symbolize_keys!
+          if local_assigns.dig(:svelte) == nil
+            local_assigns[:svelte] = {}
+          end
+          assembler = nil
-        result = JSON.parse(`NODE_NO_WARNINGS=1 node --experimental-vm-modules \#{assembler.path}`).deep_symbolize_keys
-        if result[:error]
-          e = Svelte::CompilerError.new(result.dig(:error, :text), result.dig(:error, :location))
-          raise Svelte::TemplateError.new(template, e)
+          assembler = Tempfile.new(['assembler', ".mjs"], dir)
+          assembler.write(ERB.new(File.read('#{Svelte.gem_dir}/lib/svelte/templates/assembler.js.erb')).result_with_hash({
+            path: '#{Rails.root.join template.identifier}',
+            locals: local_assigns,
+            compiled_client: j(Rails.cache.read('svelte/template/client' + '#{digest}')),
+            compiled_server: j(Rails.cache.read('svelte/template/server' + '#{digest}')),
+            ssr: Svelte.precedence(local_assigns.dig(:svelte, :ssr), template.variant.nil? ? nil : (template.variant == "server"), Svelte.ssr)
+          }))
+          assembler.rewind
+          result = JSON.parse(`NODE_PATH=#{Rails.root.join("node_modules")} NODE_NO_WARNINGS=1 node --experimental-vm-modules \#{assembler.path}`).deep_symbolize_keys
+          if result[:error]
+            e = Svelte::Errors::CompilerError.new(result.dig(:error, :text), result.dig(:error, :location))
+            raise Svelte::Errors::TemplateError.new(template, e)
+          end
+          assembler&.close
+          assembler&.unlink
+          Rails.cache.write("svelte/template/client/" + '#{digest}', result[:compiled][:client], expires_in: 14.days)
+          Rails.cache.write("svelte/template/server/" + '#{digest}', result[:compiled][:server], expires_in: 14.days)
+          content_for(:head, (result.dig(:server, :head) || "").html_safe)
+          ERB.new(File.read("#{Svelte.gem_dir}/lib/svelte/templates/island.html.erb")).result_with_hash({ result:, locals: local_assigns, digest: "#{digest}", bind: binding })
         end
-        assembler&.close
-        assembler&.unlink
-        Rails.cache.write("svelte/template/client/" + '#{digest}', result[:compiled][:client], expires_in: 14.days)
-        Rails.cache.write("svelte/template/server/" + '#{digest}', result[:compiled][:server], expires_in: 14.days)
-        content_for(:head, (result.dig(:server, :head) || "").html_safe)
-        ERB.new(File.read("#{Svelte.gem_dir}/lib/svelte/templates/island.html.erb")).result_with_hash({ result:, locals: local_assigns, digest: "#{digest}", bind: binding })
       RUBY
     end

data/lib/svelte/helpers.rb CHANGED Viewed

@@ -9,7 +9,7 @@ module Svelte
         window.props = readable(JSON.parse("#{j(Svelte.props.to_json)}"))
       JS
-      content_for(:head) + "\n" + tag.script(js.html_safe, type: "module") # steep:ignore RequiredBlockMissing
+      ((content_for(:head).presence || "") + "\n" + tag.script(js.html_safe, type: "module")).html_safe # steep:ignore RequiredBlockMissing
     end
     delegate :destructure_attrs, to: :class

data/lib/svelte/js/builder.js CHANGED Viewed

@@ -6,10 +6,16 @@
 import { readable } from "svelte/store";
 import { importFromStringSync } from "module-from-string";
-import * as esbuild from "esbuild";
-import sveltePlugin from "esbuild-svelte";
 import { sveltePreprocess } from "svelte-preprocess";
 import * as recast from "recast";
+import { rollup } from "rollup";
+import svelte from "rollup-plugin-svelte";
+import alias from "@rollup/plugin-alias";
+import commonjs from "@rollup/plugin-commonjs";
+import { nodeResolve } from "@rollup/plugin-node-resolve";
+import virtual from "@rollup/plugin-virtual";
+import swc from "@rollup/plugin-swc";
+import path from "node:path";
 class Builder {
   path;
   props;
@@ -18,9 +24,12 @@ class Builder {
   ssr;
   workingDir;
   preprocess;
-  constructor(path, props, locals, client, server, ssr, workingDir, preprocess) {
-    this.path = path;
-    this.props = readable(props);
+  pathAliases;
+  root;
+  constructor(path2, root, props, locals, client, server, ssr, workingDir, preprocess, pathAliases) {
+    this.path = path2;
+    this.root = root;
+    this.props = readable(Object.assign(props, locals, props));
     this.locals = locals;
     this.compiled = {
       client,
@@ -29,61 +38,93 @@ class Builder {
     this.ssr = ssr;
     this.workingDir = workingDir;
     this.preprocess = preprocess;
+    this.pathAliases = pathAliases;
   }
-  async bundle(generate, sveltePath = "svelte") {
-    const bundle = await esbuild.build({
-      entryPoints: [this.path],
-      mainFields: ["svelte", "browser", "module", "main"],
-      conditions: ["svelte", "browser"],
-      absWorkingDir: this.workingDir,
-      write: false,
-      outfile: "component.js",
-      bundle: true,
-      format: "esm",
-      metafile: true,
+  async bundle(generate) {
+    const bundle = (await (await rollup({
+      input: "entry",
+      output: {
+        format: "esm",
+        sourcemap: true
+      },
+      watch: {
+        skipWrite: true
+      },
       plugins: [
-        // @ts-expect-error
-        sveltePlugin({
+        // @ts-expect-error see https://github.com/rollup/plugins/issues/1662
+        virtual({
+          entry: `import App from '${this.path}'; export default App`
+        }),
+        // @ts-expect-error see https://github.com/rollup/plugins/issues/1662
+        svelte({
           compilerOptions: {
             generate,
             css: "injected",
-            hydratable: true,
-            sveltePath
+            hydratable: true
           },
+          emitCss: false,
           preprocess: sveltePreprocess(this.preprocess),
-          filterWarnings: (warning) => {
-            if (warning.code === "missing-declaration" && warning.message.includes("'props'")) {
-              return false;
-            }
-            return true;
+          onwarn: (warning, handler) => {
+            if (warning.code === "missing-declaration" && warning.message.includes("'props'")) return;
+            throw new Error(warning.message);
+          }
+        }),
+        // @ts-expect-error see https://github.com/rollup/plugins/issues/1662
+        alias({
+          entries: Object.entries(this.pathAliases || {}).map((k, v) => {
+            return new Object({ find: k, replacement: v });
+          })
+        }),
+        // @ts-expect-error see https://github.com/rollup/plugins/issues/1662
+        commonjs(),
+        nodeResolve({
+          browser: true,
+          exportConditions: ["svelte"],
+          extensions: [".svelte"]
+        }),
+        // @ts-expect-error see https://github.com/rollup/plugins/issues/1662
+        swc({
+          swc: {
+            jsc: {
+              target: "es6",
+              minify: {
+                format: {
+                  comments: "all"
+                }
+              }
+            },
+            minify: true,
+            sourceMaps: true,
+            inlineSourcesContent: true
           }
         })
       ]
+    })).generate({ format: "esm", sourcemap: true })).output;
+    bundle[0].map.sources = bundle[0].map.sources.map((el) => {
+      return path.relative(this.path, this.root) + "/" + path.relative(this.root, el);
     });
-    const throwables = [].concat(bundle.errors, bundle.warnings);
-    if (throwables.length > 0) {
-      throw throwables[0];
-    }
-    return bundle.outputFiles[0].text;
+    return `//# sourceMappingURL=${bundle[0].map.toUrl()}
+//# sourceURL=${path.relative(this.path, this.root) + "/" + path.relative(this.root, this.path)}
+${bundle[0].code}`.trim();
   }
   async client() {
-    return this.compiled?.client || this.standardizeClient(await this.bundle("dom", "https://esm.sh/svelte"));
+    return this.compiled?.client || this.standardizeClient(await this.bundle("dom"));
   }
   standardizeClient(code) {
     const ast = recast.parse(code);
     let name;
     recast.visit(ast, {
-      visitExportNamedDeclaration: (path) => {
-        const stagingName = path.node?.specifiers?.[0].local?.name;
+      visitExportNamedDeclaration: (path2) => {
+        const stagingName = path2.node?.specifiers?.[0].local?.name;
         name = typeof stagingName !== "string" ? "" : stagingName;
-        path.prune();
+        path2.prune();
         return false;
       }
     });
     recast.visit(ast, {
-      visitIdentifier: (path) => {
-        if (path.node.name === name) {
-          path.node.name = "App";
+      visitIdentifier: (path2) => {
+        if (path2.node.name === name) {
+          path2.node.name = "App";
         }
         return false;
       }

data/lib/svelte/railtie.rb CHANGED Viewed

@@ -4,6 +4,9 @@ require "svelte/helpers"
 module Svelte
   class Railtie < ::Rails::Railtie
     initializer "svelte" do |app|
+      `npm link #{Gem::Specification.find_by_name("actionview-svelte-handler").gem_dir} --save`
+      `npm install --install-links`
       ActiveSupport.on_load :action_view do
         ActionView::Template.register_template_handler :svelte, Svelte::Handler
         ActionView::Base.send :include, Svelte::Helpers

data/lib/svelte/templates/assembler.js.erb CHANGED Viewed

@@ -1,14 +1,16 @@
-import Builder from "<%= "#{Svelte.gem_dir}/lib/svelte/js/builder.js" %>";
+import Builder from "actionview-svelte-handler";
 const bob = new Builder(
-  '<%= path %>',
+  '<%= path %>',
+  '<%= Rails.root %>',
   JSON.parse('<%= Svelte.props.to_json || "{}" %>'),
   JSON.parse('<%= locals.to_json || "{}" %>'),
   '<%= compiled_client || "" %>',
   '<%= compiled_server || "" %>',
   <%= ssr %>,
   '<%= Rails.root %>',
-  JSON.parse('<%= Svelte.preprocess.to_json || "{}" %>')
+  JSON.parse('<%= Svelte.preprocess.to_json || "{}" %>'),
+  JSON.parse('<%= Svelte.aliases.to_json || "{}" %>')
 )
 const built = await bob.build()