actionview-svelte-handler 0.5.5 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97206777a02770810bd34a7ae25fc086fd957a70b5e16c9daa3ec7ce4db66fd1
-  data.tar.gz: 9c30b773a3d63d31adecb966b32b411849000e11aed787212263c08893364de9
+  metadata.gz: 35a9952571d74905f67d9219dd86b759f2ac7b11c42fc68a0817f964247fa0d4
+  data.tar.gz: be744cb8c46cfaafe8e4d3a707499038eb6f3200f0256cc947d766ed325d0d08
 SHA512:
-  metadata.gz: c40dc6a7d81e65235970b8a63c53b72cf56df6a56e3cc4fbde48d29f11cd8eb8eb29118a94252518f6ecc2440cb1497c5caba80417ab1d0c81e0a0aaa77f8385
-  data.tar.gz: '08ca1b675e5357ca1ce8b12331933b70147588995a712e0edd977b3e65abe1ecb96a5cb7653adb2fa97ff01b3801383d20d5c8b346265efbaf95af8fdc0f0f3e'
+  metadata.gz: c7ca8ce660365595737c2f60e04b6c027a11f879e540f3af405d31fe168caf58914cb7b7e1a74c08c4ee74e2c226d01c5cb45b39944d981b5eb564074a25c5b2
+  data.tar.gz: 28fbb9843d9893b9a92a03c26296e7fe3271548ceea5a5e2a559d578d3ec5ff545a3de7f0076e0c62b7605b9494d9996ef397130186313f70030427a4ff41c7b

data/.gitignore

@@ -11,4 +11,6 @@
 *.gem
 /node_modules/
 .gem_rbs_collection/
-.ruby-lsp
+.ruby-lsp
+docs/.vitepress/dist
+docs/.vitepress/cache

data/Gemfile.lock

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

data/README.md

@@ -8,138 +8,10 @@
 
 `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
+> [!NOTE]
+>
+> The documentation for this gem is available at [svelte.rb.obl.ong](https://svelte.rb.obl.ong)
 
-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`.
-
-### Example usage
-
-#### Controller
-
-`app/controllers/users_controller.rb`:
-
-```ruby
-def show
-  Svelte.props[:user] = User.find_by(username: params[:username])
-end
-```
-
-#### View
-
-`app/views/users/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>
-```
-
-### 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
-
-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. Add the `actionview-svelte-handler` gem to your Gemfile by executing:
-
-```bash
-  bundle add actionview-svelte-handler
-```
-
-4. And then execute the generator:
-
-```bash
-  bin/rails generate svelte:install
-```
-
-5. Enjoy!
 
 ## Copyright
 

data/actionview-svelte-handler.gemspec

@@ -5,17 +5,17 @@ Gem::Specification.new do |spec|
   spec.version = Svelte::VERSION
   spec.authors = ["reesericci"]
   spec.email = ["me@reeseric.ci"]
-  spec.homepage = "https://codeberg.org/reesericci/actionview-svelte-handler"
+  spec.homepage = "https://svelte.rb.obl.ong"
   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.license = "LGPL-3.0-or-later"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://codeberg.org/reesericci/actionview-svelte-handler"
 
   spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|docs)/}) }
   end
 
-  spec.add_dependency "rails", ">= 7.0"
+  spec.add_runtime_dependency "rails", "~> 7.0"
 end

data/lib/svelte/version.rb

@@ -1,3 +1,3 @@
 module Svelte
-  VERSION = "0.5.5"
+  VERSION = "0.5.7"
 end