actionview-svelte-handler 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa07b0a30bed3812a745c845a4e0906074e63d355e09812ebd138dde54416f21
-  data.tar.gz: 77410f77910319464178822fa8797415b8fe9851073518af6e4c0c07bc9a2bb0
+  metadata.gz: a6e128e00d55cf10c4227ef9962666d22945291c51908ba5944a921e9409f038
+  data.tar.gz: 89f864d3f18f58c4efce009b75f2dae79a88f0b9b5ccc6bce80db94e2910ef31
 SHA512:
-  metadata.gz: 726d5a198e94ceea5e1e5eaff320b2393a7cc106f1d807409c30c9e06ead56f033ca69c502d85a51ca72b3d0f3d0ef765f47f02c5241f3b39e240c90d759589b
-  data.tar.gz: 3f89592a576d8d6aa87b05ac9dd527e5f356c2803405a91d92bfdff6a76ad3162607743d3713f2707fd4a5fd0835e865b67ff761cbdf544bf737e74904ddca82
+  metadata.gz: 2d465f91a8e4e24c80bf11485edcd4657de64f9f4a355c7d18ef204839eacd1168f3aa3d22b030432955b77355adbb126d61eba5d0dcb632039ef5e0cffcae95
+  data.tar.gz: fb274f310264f5b719231b65b703985f9b4ead1828d1b27d631e9321e80b4ba7bb5c78ae4662d8e51f5bfb42781ca43210419a20589a9465a8fb24fad41a87d7

data/.forgejo/workflows/javascript_police.yml

@@ -0,0 +1,22 @@
+name: JavaScript Police
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches: [ main ]
+jobs:
+  lint_and_check_types:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up JS
+        uses: https://github.com/actions/setup-node@v4
+        with:
+          node-version: latest
+      - name: Install dependencies
+        run: npm install
+      - name: Lint code for consistent style
+        run: npm run lint
+      - name: Build & check types
+        run: npm run build

data/.forgejo/workflows/ruby_police.yml

@@ -0,0 +1,27 @@
+name: Ruby Police
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches: [ main ]
+
+jobs:
+  lint_and_check_types:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: https://github.com/ruby/setup-ruby@v1
+        with:
+          ruby-version: .ruby-version
+          bundler-cache: true
+      - name: Install Bundler
+        run: gem install bundler
+      - name: Lint code for consistent style
+        run: bundle exec standardrb --fix --format github
+      - name: Install RBS collection
+        run: bundle exec rbs collection install
+      - name: Check types
+        run: bundle exec steep check --jobs=24

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/doc/
+/log/*.log
+/pkg/
+/tmp/
+/test/dummy/db/*.sqlite3
+/test/dummy/db/*.sqlite3-*
+/test/dummy/log/*.log
+/test/dummy/storage/
+/test/dummy/tmp/
+*.gem
+/node_modules/
+.gem_rbs_collection/
+.ruby-lsp

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Specify your gem's dependencies in svelte.gemspec.
+gemspec
+
+# Start debugger with binding.b [https://github.com/ruby/debug]
+# gem "debug", ">= 1.0.0"
+
+gem "steep", "~> 1.7"
+
+gem "standard", "~> 1.39"
+
+gem "rbs", "~> 3.5"

data/Gemfile.lock

@@ -0,0 +1,284 @@
+PATH
+  remote: .
+  specs:
+    actionview-svelte-handler (0.4.1)
+      rails (>= 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activejob (= 7.1.3.4)
+      activerecord (= 7.1.3.4)
+      activestorage (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      actionview (= 7.1.3.4)
+      activejob (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.3.4)
+      actionview (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activerecord (= 7.1.3.4)
+      activestorage (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.3.4)
+      activesupport (= 7.1.3.4)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.3.4)
+      activesupport (= 7.1.3.4)
+      globalid (>= 0.3.6)
+    activemodel (7.1.3.4)
+      activesupport (= 7.1.3.4)
+    activerecord (7.1.3.4)
+      activemodel (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      timeout (>= 0.4.0)
+    activestorage (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activejob (= 7.1.3.4)
+      activerecord (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      marcel (~> 1.0)
+    activesupport (7.1.3.4)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    builder (3.3.0)
+    concurrent-ruby (1.3.3)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    csv (3.3.0)
+    date (3.3.4)
+    drb (2.2.1)
+    erubi (1.13.0)
+    ffi (1.17.0-aarch64-linux-gnu)
+    ffi (1.17.0-arm-linux-gnu)
+    ffi (1.17.0-arm64-darwin)
+    ffi (1.17.0-x86-linux-gnu)
+    ffi (1.17.0-x86_64-darwin)
+    ffi (1.17.0-x86_64-linux-gnu)
+    fileutils (1.7.2)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.14.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.6.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    mini_mime (1.1.5)
+    minitest (5.24.1)
+    mutex_m (0.2.0)
+    net-imap (0.4.14)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.0)
+      net-protocol
+    nio4r (2.7.3)
+    nokogiri (1.16.7-aarch64-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-arm-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.25.1)
+    parser (3.3.4.0)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.2)
+      stringio
+    racc (1.8.0)
+    rack (3.1.7)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.3.4)
+      actioncable (= 7.1.3.4)
+      actionmailbox (= 7.1.3.4)
+      actionmailer (= 7.1.3.4)
+      actionpack (= 7.1.3.4)
+      actiontext (= 7.1.3.4)
+      actionview (= 7.1.3.4)
+      activejob (= 7.1.3.4)
+      activemodel (= 7.1.3.4)
+      activerecord (= 7.1.3.4)
+      activestorage (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      bundler (>= 1.15.0)
+      railties (= 7.1.3.4)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rbs (3.5.2)
+      logger
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.2)
+    reline (0.5.9)
+      io-console (~> 0.5)
+    rexml (3.3.4)
+      strscan
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    securerandom (0.3.1)
+    standard (1.39.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.64.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.4)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.4.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.21.0)
+    steep (1.7.1)
+      activesupport (>= 5.1)
+      concurrent-ruby (>= 1.1.10)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      logger (>= 1.3.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 3.5.0.pre)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 4)
+    stringio (3.1.1)
+    strscan (3.1.0)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.3.1)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.16)
+
+PLATFORMS
+  aarch64-linux
+  arm-linux
+  arm64-darwin
+  x86-linux
+  x86_64-darwin
+  x86_64-linux
+
+DEPENDENCIES
+  actionview-svelte-handler!
+  rbs (~> 3.5)
+  standard (~> 1.39)
+  steep (~> 1.7)
+
+BUNDLED WITH
+   2.5.11

data/README.md

@@ -1,19 +1,27 @@
-# Action View Svelte Handler
+<img src="https://codeberg.org/reesericci/actionview-svelte-handler/raw/branch/main/svelte-on-rails.png" width="100px">
+
+# `actionview-svelte-handler`
 
 [![Copyleft License: LGPL-3.0-or-later](https://img.shields.io/badge/%F0%9F%84%AF_copyleft-LGPL--3.0--or--later-black)](https://spdx.org/licenses/LGPL-3.0-or-later.html)
 [![Gem Version](https://img.shields.io/gem/v/actionview-svelte-handler)](https://rubygems.org/gems/actionview-svelte-handler)
+<img src="https://web.badges.world/badges/operated/ruby3.png" alt="Ruby Powered" height="20px" style="image-rendering: pixelated;">
 
 `actionview-svelte-handler` is a template handler for Action View that allows you to create [Svelte](https://svelte.dev) views in Rails applications with ease.
 
 ## Usage
 
-Add `.html.svelte` views to your application instead of `.html.erb`. Note that ERB helpers will cease to be available.
+Add `.html.svelte` views to your application instead of `.html.erb`. 
+
+> [!CAUTION]
+> This will make ERB helpers unavailable because Svelte is registered as a template handler, replacing ERB when it is used.
+
+To pass props, use the `Svelte.props` object in your controller (or set instance variables), and then access them as a store with `$props`.
 
-To pass props, use the `Svelte.props` object in your controller, and then access it as a store with `$props`.
+### Example usage
 
-### Example
+#### Controller
 
-`users_controller.rb`:
+`app/controllers/users_controller.rb`:
 
 ```ruby
 def show
@@ -21,7 +29,9 @@ def show
 end
 ```
 
-`show.html.svelte`:
+#### View
+
+`app/views/users/show.html.svelte`:
 
 ```html
 <script>
@@ -39,33 +49,98 @@ end
 </style>
 ```
 
-### Server-side rendering
+### Configuration
+
+Configuration options can be found in `config/initializers/svelte.rb`. The following is a list of options and some information:
+
+| Option with type    | Description                                                            | Default                             |
+| ------------------- | ---------------------------------------------------------------------- | ----------------------------------- |
+| `ssr <bool>`     | Global server-side rendering. Does not override the svelte[ssr] local. | `true`                              |
+| `aliases <Hash[Symbol, String]>`    | Path aliases when importing from Svelte views.                         | See [path aliases](#path-aliases)   |
+| `preprocess <Hash[String \| Symbol, String]>` | Configuration for [svelte-preprocess](https://github.com/sveltejs/svelte-preprocess/blob/main/docs/usage.md) | `{}` |
+
+#### Example usage (with `Svelte.configure` block)
+
+`config/initializers/svelte.rb`:
+
+```ruby
+Svelte.configure do |config|
+  config.ssr = true
+  config.aliases = {
+    :$views => Rails.root.join("app", "views")
+  }
+end
+```
+
+### Locals
 
-Server-side rendering is enabled by default, but if you need to disable it for any reason, pass the `svelte[:ssr]` local to `render` like so:
+To set per-render options, we use a set of locals underneath the `svelte` hash. Locals are always the highest precedence
+
+| Option with type    | Description                                                                | Default                               |
+| ------------------- | -------------------------------------------------------------------------- | ------------------------------------- |
+| `ssr <bool>`        | Server-side prerendering                                                   | `true`                                |
+| `island <Hash[String, String]>` | HTML attributes for [is-land](https://github.com/11ty/is-land) | `{ "on:visible": "", "on:idle": "" }` |
+
+#### Example usage
+
+`app/controllers/example_controller.rb`:
 
 ```ruby
 render "view", locals: { svelte: { ssr: false } }
 ```
 
+### Variants
+
+To configure server-side rendering at a file level, you can use the `client` and `server` variants. Just set your file name like in the example.
+
+#### Example usage
+
+`app/views/example/show.html+client.svelte`
+
+`app/views/example/show.html+server.svelte`
+
+`app/controllers/example_controller.rb`:
+
+```ruby
+render "view", variant: "client"
+```
+
+### Path aliases
+
+Path aliases are used as quick references from your Svelte views to key paths in your application. They are primarily utilized when importing other Svelte components (i.e. partials).
+
+The list of path aliases set by the generator is as follows:
+
+| Alias    | Resolution                       |
+| -------- | -------------------------------- |
+| `$root`  | `Rails.root`                     |
+| `$app`   | `Rails.root.join "app"`          |
+| `$views` | `Rails.root.join "app", "views"` |
+
+#### Example usage
+
+```javascript
+  import Card from "$views/application/card.html.svelte"
+```
+
 ## Installation
 
 1. Ensure you have [Node.js >=v12.16.0](https://nodejs.org) and [NPM](https://npmjs.com) in your `$PATH`
 
-3. Execute:
+3. Add the `actionview-svelte-handler` gem to your Gemfile by executing:
 
 ```bash
   bundle add actionview-svelte-handler
 ```
 
-4. And then add the `svelte_tags` helper at the end of the `<head>` in `application.html.erb`:
+4. And then execute the generator:
 
-```html
-  <head>
-    <!-- other head content -->
-    <%= svelte_tags %>
-  </head>
+```bash
+  bin/rails generate svelte:install
 ```
 
+5. Enjoy!
+
 ## Copyright
 
 Copyright (C) 2024 [Software Freedom Conservancy](https://sfconservancy.org/assignment/603092cf-aeeb-4ee3-a5e0-903bd14805a8/) and Action View Svelte Handler contributors

data/Steepfile

@@ -0,0 +1,12 @@
+target :lib do
+  signature "sig"
+
+  check "lib"
+  ignore "lib/generators"
+  ignore "lib/svelte/railtie.rb"
+  ignore "lib/svelte/variabilization.rb"
+
+  library "activesupport"
+  library "actionview"
+  library "digest"
+end

data/actionview-svelte-handler.gemspec

@@ -0,0 +1,21 @@
+require_relative "lib/svelte/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "actionview-svelte-handler"
+  spec.version = Svelte::VERSION
+  spec.authors = ["reesericci"]
+  spec.email = ["me@reeseric.ci"]
+  spec.homepage = "https://codeberg.org/reesericci/actionview-svelte-handler"
+  spec.summary = "Create .svelte views seamlessly in Rails applications"
+  spec.description = "Documentation is available at #{spec.homepage}"
+  spec.license = "LGPL-v3.0-or-later"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.add_dependency "rails", ">= 7.0"
+end

data/bin/test

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../test", __dir__)
+
+require "bundler/setup"
+require "rails/plugin/test"

data/build.esbuild.js

@@ -0,0 +1,22 @@
+import * as esbuild from 'esbuild'
+
+const buildOpts = {
+  entryPoints: ['lib/ts/*.ts'],
+  bundle: false,
+  outdir: 'lib/svelte/js',
+  format: 'esm',
+  write: true,
+  platform: 'node',
+  banner: {
+    js: `/* 
+  IF YOU ARE READING THIS, YOU ARE VIEWING THE BUILT JS FROM THE SOURCE TYPESCRIPT AT ../ts/ .
+  
+  DO NOT MODIFY.
+*/
+`
+  }
+}
+
+await esbuild.build(buildOpts)
+
+export default buildOpts

data/lib/generators/svelte/install_generator.rb

@@ -0,0 +1,13 @@
+class Svelte::InstallGenerator < Rails::Generators::Base
+  desc "This generator installs actionview-svelte-handler"
+
+  source_root File.expand_path("templates/install", __dir__)
+
+  def install
+    copy_file "initializer.rb", "config/initializers/svelte.rb"
+    insert_into_file "app/views/layouts/application.html.erb",
+      "    <%= svelte_tags %>\n",
+      before: "</head>"
+    `npm install #{Svelte.gem_dir} --install-links --save=false`
+  end
+end

data/lib/generators/svelte/templates/install/initializer.rb

@@ -0,0 +1,17 @@
+Svelte.configure do |config|
+  # @note overridable at render time with svelte[:ssr] local
+  # @default true
+  # @return [Boolean] whether server-side rendering is enabled globally
+  config.ssr = true
+
+  # @return [Hash] path aliases available in ESM imports in Svelte files
+  config.aliases = {
+    :$root => Rails.root,
+    :$app => Rails.root.join("app"),
+    :$views => Rails.root.join("app", "views")
+  }
+
+  # @default {}
+  # @return [Hash] of your Svelte preprocess configuration
+  config.preprocess = {}
+end