actionview-svelte-handler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a8d743d73bb7a9c2d20b16c9ba153ee83bb558800780f9913ed92edd6b9c3f5
+  data.tar.gz: 2b506e0b2402d4c236e24caaf1d8ee09db301585568bfbbb3f5e68c90dd21e3a
+SHA512:
+  metadata.gz: 37254f91eb9aded2426d894cf44047af5b0d31c73f99ec9946aff73518301b24d537c63888151e1a542fcd725360036de91551450893c83337f7dba3a87de1f0
+  data.tar.gz: 1536e077c112bd44b1785792892f39f0cd5ea4057bf5a23ee6758cdcd94631ce93fd2ff787b4164a7d99648f64fd49f2c17064f32353069cfd995fe78006821c

data/LICENSE.md

@@ -0,0 +1,157 @@
+# GNU LESSER GENERAL PUBLIC LICENSE
+
+Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc.
+<https://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates the
+terms and conditions of version 3 of the GNU General Public License,
+supplemented by the additional permissions listed below.
+
+## 0. Additional Definitions.
+
+As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the
+GNU General Public License.
+
+"The Library" refers to a covered work governed by this License, other
+than an Application or a Combined Work as defined below.
+
+An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+## 1. Exception to Section 3 of the GNU GPL.
+
+You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+## 2. Conveying Modified Versions.
+
+If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+-   a) under this License, provided that you make a good faith effort
+    to ensure that, in the event an Application does not supply the
+    function or data, the facility still operates, and performs
+    whatever part of its purpose remains meaningful, or
+-   b) under the GNU GPL, with none of the additional permissions of
+    this License applicable to that copy.
+
+## 3. Object Code Incorporating Material from Library Header Files.
+
+The object code form of an Application may incorporate material from a
+header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+-   a) Give prominent notice with each copy of the object code that
+    the Library is used in it and that the Library and its use are
+    covered by this License.
+-   b) Accompany the object code with a copy of the GNU GPL and this
+    license document.
+
+## 4. Combined Works.
+
+You may convey a Combined Work under terms of your choice that, taken
+together, effectively do not restrict modification of the portions of
+the Library contained in the Combined Work and reverse engineering for
+debugging such modifications, if you also do each of the following:
+
+-   a) Give prominent notice with each copy of the Combined Work that
+    the Library is used in it and that the Library and its use are
+    covered by this License.
+-   b) Accompany the Combined Work with a copy of the GNU GPL and this
+    license document.
+-   c) For a Combined Work that displays copyright notices during
+    execution, include the copyright notice for the Library among
+    these notices, as well as a reference directing the user to the
+    copies of the GNU GPL and this license document.
+-   d) Do one of the following:
+    -   0) Convey the Minimal Corresponding Source under the terms of
+        this License, and the Corresponding Application Code in a form
+        suitable for, and under terms that permit, the user to
+        recombine or relink the Application with a modified version of
+        the Linked Version to produce a modified Combined Work, in the
+        manner specified by section 6 of the GNU GPL for conveying
+        Corresponding Source.
+    -   1) Use a suitable shared library mechanism for linking with
+        the Library. A suitable mechanism is one that (a) uses at run
+        time a copy of the Library already present on the user's
+        computer system, and (b) will operate properly with a modified
+        version of the Library that is interface-compatible with the
+        Linked Version.
+-   e) Provide Installation Information, but only if you would
+    otherwise be required to provide such information under section 6
+    of the GNU GPL, and only to the extent that such information is
+    necessary to install and execute a modified version of the
+    Combined Work produced by recombining or relinking the Application
+    with a modified version of the Linked Version. (If you use option
+    4d0, the Installation Information must accompany the Minimal
+    Corresponding Source and Corresponding Application Code. If you
+    use option 4d1, you must provide the Installation Information in
+    the manner specified by section 6 of the GNU GPL for conveying
+    Corresponding Source.)
+
+## 5. Combined Libraries.
+
+You may place library facilities that are a work based on the Library
+side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+-   a) Accompany the combined library with a copy of the same work
+    based on the Library, uncombined with any other library
+    facilities, conveyed under the terms of this License.
+-   b) Give prominent notice with the combined library that part of it
+    is a work based on the Library, and explaining where to find the
+    accompanying uncombined form of the same work.
+
+## 6. Revised Versions of the GNU Lesser General Public License.
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library
+as you received it specifies that a certain numbered version of the
+GNU Lesser General Public License "or any later version" applies to
+it, you have the option of following the terms and conditions either
+of that published version or of any later version published by the
+Free Software Foundation. If the Library as you received it does not
+specify a version number of the GNU Lesser General Public License, you
+may choose any version of the GNU Lesser General Public License ever
+published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,57 @@
+# actionview-svelte-handler
+
+Create `.svelte` views seamlessly in Rails applications.
+
+## Usage
+
+Add `.html.svelte` views to your application instead of `.html.erb`. Note that ERB helpers will cease to be available.
+
+To pass props, use the `Svelte.props` object in your controller then access it like a store with `$props`:
+
+`users_controller.rb`:
+
+```ruby
+def show
+  Svelte.props[:user] = User.find_by(username: params[:username])
+end
+```
+
+`show.html.svelte`:
+
+```html
+<script>
+  let name = $props.user.name
+  $: mailto = "mailto://" + $props.user.email
+</script>
+
+<h1>Hello, {name}</h1>
+<a href={mailto}>{$props.user.email}</a>
+
+<style>
+  h1 {
+    color: red
+  }
+</style>
+```
+
+## Installation
+
+1. Ensure you have the [Bun](https://bun.sh) JavaScript runtime in your `$PATH`
+
+3. Execute:
+
+```bash
+  bundle add actionview-svelte-helper
+```
+
+4. And then add the `svelte_tags` helper at the end of the `<head>` in `application.html.erb`:
+
+```erb
+  <head>
+    <!-- other head content -->
+    <%= svelte_tags %>
+  </head>
+```
+
+## License
+The gem is available as open source under the terms of the [LGPL License](https://opensource.org/license/lgpl-3-0).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/svelte/handler.rb

@@ -0,0 +1,47 @@
+module Svelte
+  class Handler < ActionView::Template::Handlers::Raw
+    include ActionView::Helpers::JavaScriptHelper
+
+    def call(template, source)
+      file = Tempfile.new
+      src = Tempfile.new
+      src.write source.b
+      src.rewind
+
+      file.write <<-JS
+        import { compile } from 'svelte/compiler';
+
+        const src = await Bun.file("#{src.path}").text()
+        const result = compile(src, {generate: "dom", name: "Component", css: "injected", sveltePath: "https://esm.sh/svelte"})
+
+        process.stdout.write(JSON.stringify(result))
+      JS
+
+      file.rewind
+
+      compiled = JSON.parse(%x(bun run #{file.path})).deep_symbolize_keys
+
+      source = <<-HTML
+        <is-land on:visible on:idle>
+          <template data-island>
+            <div id="svelte-app-client">
+            </div>
+            
+            <script type="module">
+              #{compiled.dig(:js, :code)}
+              
+              new Component({ target: document.getElementById("svelte-app-client") });
+            </script>
+            
+          </template>
+        </is-land>
+      HTML
+
+      super
+    end
+
+    def self.call(template, source)
+      new.call(template, source)
+    end
+  end
+end

data/lib/svelte/helpers.rb

@@ -0,0 +1,16 @@
+module Svelte
+  module Helpers 
+    include ActionView::Helpers::JavaScriptHelper
+    def svelte_tags
+      js = <<-JS
+        import "https://esm.sh/@11ty/is-land";
+        import "https://esm.sh/@11ty/is-land/is-land-autoinit.js";
+        import { readable } from "https://esm.sh/svelte/store"
+
+        window.props = readable(JSON.parse("#{j(Svelte.props.to_json)}"))
+      JS
+      
+      tag.script(js.html_safe, type: "module")
+    end
+  end
+end

data/lib/svelte/railtie.rb

@@ -0,0 +1,13 @@
+require "svelte/handler"
+require "svelte/helpers"
+
+module Svelte
+  class Railtie < ::Rails::Railtie
+    initializer "svelte.register_actionview" do
+      ActiveSupport.on_load :action_view do
+        ActionView::Template.register_template_handler :svelte, Svelte::Handler
+        ActionView::Base.send :include, Svelte::Helpers
+      end
+    end
+  end
+end

data/lib/svelte/version.rb

@@ -0,0 +1,3 @@
+module Svelte
+  VERSION = "0.1.0"
+end

data/lib/svelte.rb

@@ -0,0 +1,11 @@
+require "svelte/railtie"
+require "svelte/handler"
+require "svelte/helpers"
+require "svelte/version"
+require "active_support/isolated_execution_state"
+
+module Svelte
+  def self.props
+    ActiveSupport::IsolatedExecutionState[:svelte_props] ||= {}
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: actionview-svelte-handler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- reesericci
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: Documentation is available at https://codeberg.org/reesericci/actionview-svelte-handler
+email:
+- me@reeseric.ci
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/svelte.rb
+- lib/svelte/handler.rb
+- lib/svelte/helpers.rb
+- lib/svelte/railtie.rb
+- lib/svelte/version.rb
+homepage: https://codeberg.org/reesericci/actionview-svelte-handler
+licenses:
+- LGPL-v3.0-or-later
+metadata:
+  homepage_uri: https://codeberg.org/reesericci/actionview-svelte-handler
+  source_code_uri: https://codeberg.org/reesericci/actionview-svelte-handler
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Create .svelte views seamlessly in Rails applications
+test_files: []