svelte-on-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '04309bc3d95848982b66c90f7395f9d25c67c9adf9a65f4db968d7eb05c54542'
+  data.tar.gz: ac4b7759f6ea6ddc73117ffd1567a7ae504a1d867bbd33561c48607ea8441c16
+SHA512:
+  metadata.gz: be481f02888b3fa42e258ae52c7a08c9d7e79236a583dace0dbe1c73acbf4b79db67cf4e9d4c8322f7310792560ff2bef30b12db4667fa2c77d2eedf6f296b5b
+  data.tar.gz: d5f64ab65a7e8417905c30f4657dd941a7d7e174e786fd4ecd8c6bc65596cfc69d9776246b7c17d43dd2082c3044eacd04144329406f7c7b8cc5e5dac61affa9

data/README.md

@@ -0,0 +1,114 @@
+# Mount Svelte
+
+Render Svelte Components server-side via rollup.
+For performance reasons, compilation only happens when some code has changed.
+Although it should be independent, I developed and tested everything on `vite_rails`.
+
+## Status / Notice
+
+Server-side rendering is the bottleneck in this pipeline. Although rollup is mighty,
+this gem is in a early state and there sure are limitations.
+So, please always test your components early if they pass ssr. 
+
+I have written everything in ESM syntax.
+Although the common-js plugin is installed, I did not test it, 
+so `require` for example may not work in Svelte components. 
+To check which import statements work, please check the components in the 
+`spec/rails-vite-test-app/app/frontend/javascript/components` gem.
+
+## Requirements
+
+- actual node installed on the server
+- I tested it all on Rails-7
+
+## Installation
+
+```ruby
+gem "mount-svelte"
+
+# and execute
+$ rails mount_svelte:install
+#=> writes config/mount_svelte.yaml 
+#=> all configs there
+#=> required configs: frontend_folder and components_folder
+```
+
+setup the npm module [@csedl/mount-svelte](https://www.npmjs.com/package/@csedl/mount-svelte) on the client side
+
+## Usage
+
+```haml
+= svelte_component("myComponent", props = { items: ['item1', 'item2'] })
+```
+
+## Option render_server_side: :auto
+
+default: `true`
+
+Works with `hotwired/turbo` only
+
+By passing the `render_server_side: :auto` option to the view helper, 
+it checks if the request is an initial request (request header `X-Turbo-Request-ID` is not present), 
+then does nothing server-side but add a tag. Assuming the filename is `HelloWorld.svelte`:
+
+```haml
+= svelte_component("HelloWorld", message: "Property from the server", render_server_side: :auto, class: "box")
+#=> output on the rails-console:
+Added Svelte-Tag for custom element: «<hello-world message='Property from the server' class='box svelte-component'></hello-world>»
+```
+
+The functionality of the javascript part to create the custom element is not 
+included in this gem and its dependent node-module.
+
+Svelte can be built as a custom element, but that way svelte would add a `shadow dom`
+so that global styles would not be applied to the components.
+However, with [svelte-tag](https://www.npmjs.com/package/svelte-tag) (i am using this) or its fork `svelte-retag` you can build
+a custom element without shadow dom.
+
+This works perfectly with hotwired/turbo because the custom elements are built on the 
+first page load and survive page visits from turbo. If you then visit a page that 
+has the `%hello-world` tag, the component will appear immediately. 
+This is not a default setting, as it requires more configuration.
+
+## Styles
+
+For 99% of use cases you can just skip this chapter.
+
+You can simply work with global styles as well as styles within the svelte component.
+
+A server-side rendered svelte component has 2 states:
+
+#### Before hydration 
+
+- The `svelte_component` view helper renders the styles contained within the component 
+into a style tag within the component's wrapper element. This has to be done this way because of Turbo.
+- In very, very rare cases, global styles are not applied in the same way as after hydration.
+
+#### After hydration 
+
+- Svelte adds a style tag inside the header 
+- Svelte renders the component again, which removes the style tag inside the component wrapper.
+
+#### If you notice a "blink" 
+
+For the app to look stable, both states must appear in the same way. 
+Normally this is the case. But if there are problems, 
+or you want to see the state before hydration, for development purposes, you can pass 
+the `hydrate: false` option to the view helper, 
+and no hydration will happen for this component.
+
+
+## Performance
+
+Example from the rails console for a medium complex component
+
+- Compiled MyComponent.svelte.js: 0.411ms
+  - => happens only once
+- Rendered MyComponent.svelte server-side: 0.518ms
+  - => happens on every request
+- Completed 200 OK in 521ms (Views: 520.2ms | ActiveRecord: 0.0ms (0 queries, 0 cached) | GC: 0.3ms)
+
+## Testing
+
+Testings are within the gem by `rspec`. And there is a [rails project](https://gitlab.com/users/sedl/projects) with 
+testings (based on playwright) where some examples are built in.

data/lib/mount-svelte.rb

@@ -0,0 +1,13 @@
+require "mount_svelte/configuration"
+require "mount_svelte/view_helpers"
+require "mount_svelte/render_server_side"
+require "mount_svelte/railtie" if defined?(Rails)
+
+module MountSvelte
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+  end
+end

data/lib/mount_svelte/compile.js

@@ -0,0 +1,185 @@
+#!/usr/bin/env node
+
+import path from 'path';
+import fs from 'fs/promises';
+
+// Argumente: inputFile, outputDir, gemPath
+const args = process.argv.slice(2);
+const inputFile = args[0];
+const outputDir = args[1];
+const gemPath = args[2];
+
+if (!inputFile || !outputDir || !gemPath) {
+    console.error('Fehler: inputFile, outputDir und gemPath müssen angegeben werden.');
+    console.error('Verwendung: node script.js <inputFile> <outputDir> <gemPath>');
+    process.exit(1);
+}
+
+// Sicherstellen, dass gemPath existiert
+try {
+    await fs.access(gemPath);
+} catch (error) {
+    console.error(`Fehler: Der gemPath "${gemPath}" existiert nicht.`);
+    process.exit(1);
+}
+
+const fileName = path.basename(inputFile, '.svelte');
+const outputFile = path.join(outputDir, `${fileName}.js`);
+const outputCss = path.join(outputDir, `${fileName}.css`);
+
+// Pfad zu node_modules im Gem
+const gemNodeModules = path.join(gemPath, 'node_modules');
+
+// Dynamische Importe der Build-Tools aus dem Gem
+const { rollup } = await import(path.join(gemNodeModules, 'rollup', 'dist', 'rollup.js'));
+const svelte = await import(path.join(gemNodeModules, 'rollup-plugin-svelte', 'index.js')).then(m => m.default);
+const resolve = await import(path.join(gemNodeModules, '@rollup', 'plugin-node-resolve', 'dist', 'es', 'index.js')).then(m => m.default);
+const commonjs = await import(path.join(gemNodeModules, '@rollup/plugin-commonjs', 'dist', 'es', 'index.js')).then(m => m.default);
+const url = await import(path.join(gemNodeModules, '@rollup', 'plugin-url', 'dist', 'es', 'index.js')).then(m => m.default);
+const css = await import(path.join(gemNodeModules, 'rollup-plugin-css-only', 'dist', 'index.mjs')).then(m => m.default);
+const { sveltePreprocess } = await import(path.join(gemNodeModules, 'svelte-preprocess', 'dist', 'index.js'));
+
+// Plugin für Raw-Importe
+function rawResolver() {
+    return {
+        name: 'raw-resolver',
+        resolveId(source, importer) {
+            console.log(`Raw-Resolver: source=${source}, importer=${importer}`);
+            if (source.endsWith('?raw')) {
+                const actualSource = source.replace('?raw', '');
+                const resolved = path.resolve(path.dirname(importer), actualSource);
+                console.log(`Raw-Resolver: Auflösen von ${source} zu ${resolved}?raw`);
+                return `${resolved}?raw`;
+            }
+            return null;
+        },
+    };
+}
+
+function stringPlugin() {
+    return {
+        name: 'string',
+        async load(id) {
+            if (id.endsWith('?raw')) {
+                console.log(`String-Plugin: Lade ${id}`);
+                const actualId = id.replace('?raw', '');
+                try {
+                    const content = await fs.readFile(actualId, 'utf-8');
+                    console.log(`String-Plugin: Inhalt von ${actualId} geladen (Auszug): ${content.substring(0, 50)}...`);
+                    return `export default ${JSON.stringify(content)};`;
+                } catch (error) {
+                    console.error(`String-Plugin: Fehler beim Laden von ${actualId}:`, error);
+                    throw error;
+                }
+            }
+            return null;
+        },
+    };
+}
+
+// Plugin, um browser-spezifische Module im SSR zu ignorieren
+function ssrExternals() {
+    return {
+        name: 'ssr-externals',
+        resolveId(source) {
+            // Ignoriere Module wie axios während SSR
+            if (source === 'axios' || source.includes('form-data')) {
+                return { id: 'void 0', external: true };
+            }
+            return null;
+        },
+        load(id) {
+            if (id === 'void 0') {
+                return 'export default null;';
+            }
+            return null;
+        }
+    };
+}
+
+const rollupConfig = {
+    input: inputFile,
+    output: {
+        file: outputFile,
+        format: 'esm',
+    },
+    external: [
+        // Node.js-Built-ins, die nicht gebundelt werden sollen
+        'fs', 'path', 'url', 'module', 'http', 'https', 'zlib', 'stream', 'buffer',
+        // Browser-spezifische Module, die im SSR ignoriert werden
+        'axios', 'form-data'
+    ],
+    onwarn(warning, warn) {
+        // Ignoriere bestimmte Warnungen, z. B. Circular Dependencies
+        if (warning.code === 'CIRCULAR_DEPENDENCY') {
+            return;
+        }
+        // Ignoriere Warnungen für leere Chunks oder unbenutzte externe Module
+        if (warning.code === 'EMPTY_BUNDLE' || warning.code === 'UNUSED_EXTERNAL_IMPORT') {
+            return;
+        }
+        warn(warning);
+    },
+    plugins: [
+        svelte({
+            preprocess: sveltePreprocess({
+                typescript: true
+            }),
+            compilerOptions: {
+                generate: 'ssr',
+                hydratable: false
+            },
+            // Ignoriere browser-spezifische Module während SSR
+            onwarn(warning, handler) {
+                if (warning.code === 'MISSING_EXPORT' && warning.exporter.includes('axios')) {
+                    return;
+                }
+                handler(warning);
+            }
+        }),
+        rawResolver(),
+        stringPlugin(),
+        url({
+            include: ['**/*.jpg', '**/*.png', '**/*.jpeg', '**/*.gif'],
+            limit: 0,
+            destDir: outputDir,
+            publicPath: outputDir,
+            emitFiles: true,
+        }),
+        css({ output: path.basename(outputCss) }),
+        resolve({
+            dedupe: ['svelte'],
+            exportConditions: ['svelte', 'server'],
+            modulePaths: [gemNodeModules],
+            extensions: ['.mjs', '.js', '.cjs', '.ts'],
+            // Bevorzuge Node-spezifische Module
+            mainFields: ['main', 'module']
+        }),
+        commonjs({
+            // Behandle CommonJS-Module explizit
+            include: [/node_modules/],
+            // Transformiere gemischte ES/CommonJS-Module
+            transformMixedEsModules: true
+        }),
+        ssrExternals() // Neues Plugin zum Ignorieren von axios und form-data
+    ],
+};
+
+// Rollup-Build
+async function compile() {
+    try {
+        const startTime = performance.now();
+        const bundle = await rollup(rollupConfig);
+        await bundle.write(rollupConfig.output);
+        await bundle.close();
+        console.log(`Build erfolgreich: ${outputFile} und ${outputCss}`);
+        const endTime = performance.now();
+        const duration = (endTime - startTime).toFixed(2);
+        console.log(`Ausführungszeit: ${duration} ms`);
+    } catch (error) {
+        console.error('Build fehlgeschlagen:', error);
+        process.exit(1);
+    }
+}
+
+compile();

data/lib/mount_svelte/configuration.rb

@@ -0,0 +1,69 @@
+require "yaml"
+
+module MountSvelte
+  class Configuration
+
+    def self.instance
+      @instance ||= new
+    end
+
+    attr_accessor :configs
+
+    def initialize
+      @configs = {
+        development: {
+          watch_changes: true,
+        },
+        test: {
+          watch_changes: true,
+        }
+      }
+      load_yaml_config if defined?(Rails)
+    end
+
+    def watch_changes
+      if @configs[Rails.env]
+        @configs[Rails.env]['watch_changes'] == true
+      else
+        false
+      end
+    end
+
+    def rails_root
+      Rails.root
+    end
+
+    def frontend_folder
+      rails_root.join(@configs['frontend_folder'].to_s)
+    end
+
+    def components_folder
+      frontend_folder.join(@configs['components_folder'].to_s)
+    end
+
+    def render_server_side
+      rss = @configs['render_server_side']
+      if rss == false || rss == :auto
+        rss
+      else
+        true
+      end
+    end
+
+    def dist_folder
+      rails_root.join('public', 'svelte-dist')
+    end
+    private
+
+    def load_yaml_config
+      config_path = Rails.root.join("config", "mount_svelte.yml")
+      return unless File.exist?(config_path)
+
+      config_data = YAML.load_file(config_path)
+
+      if config_data
+        @configs = @configs.merge(config_data)
+      end
+    end
+  end
+end

data/lib/mount_svelte/node_modules/@ampproject/remapping/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.