humid 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c7f343b4b1518296d59917fb37ce2f8a60ee6b1a57b71f3fd378ce2ad55a4d4
-  data.tar.gz: e11384d2812e0de2cb7e676fa237957d44fbe63cf788e73adf997c9a14b2015e
+  metadata.gz: f8a07ab8d934750bbdb01dc4596426d02edd7733d7bf87093b8ca36d5abbbb33
+  data.tar.gz: d3c9f28d92d637d8d4eb20e78676a0eacf09d7c922c0583448f3aacc1befe4fa
 SHA512:
-  metadata.gz: d5ca07bdd2c64b97f51c45dd14de734ab37e608704414a494461cce0645a10d4fcfb3c1e414152066c16b9be3f98c2f55fdcb6cd1cb6e3e7464e3ebb64e7ed8f
-  data.tar.gz: 52923317087b7439e80c347022acc55e102435367f3f0d54d52079f9e40129271aae60cba245bfe4d5d4352441988abd30882429f04d817e2528c029564a8cc3
+  metadata.gz: 311cdf7125016802906bc28b7545c80c22e01709ebe679ead307f68783bab051a9e30bc634b777ce41802ad9d6564288305c593aee5da05a40e853b8a7ce31f2
+  data.tar.gz: 43777369d6c7b2525957d11117be0b1df56e960dbea0ca7be822ebb1b0d7c1e9af5f406fea47619d7f50829e203f610fb1074b1435b6ccce310453f1db04bf05

data/README.md

@@ -1,4 +1,9 @@
-# Humid
+<div align="center">
+  <img src="./images/svg/humid-icon.svg" alt="Humid" width="128" />
+  <h1>Humid</h1>
+  <p>A few helpers for Javascript server-side rendering on Rails with <a
+  href="https://github.com/rubyjs/mini_racer">mini_racer</a></p>
+</div>
 
 ![Build Status](https://github.com/thoughtbot/humid/actions/workflows/build.yml/badge.svg?branch=main)
 
@@ -12,16 +17,20 @@ returns an HTML string.
 
 ## Design
 
-Humid is designed for the common case where all data is gathered before
-rendering. Your application fetches everything needed, passes it as props, and
-Humid returns the rendered HTML in a single synchronous call. It does not
-support streaming or async data fetching during render.
+Humid is designed with 2 goals in mind:
 
-## Caution
+1. Its for the common case where all data is gathered before rendering. Your
+application fetches everything needed, passes it as props, and Humid returns
+the rendered HTML in a single synchronous call. It does not support streaming
+or async data fetching during render.
 
-This project is in its early phases of development. Its interface,
-behavior, and name are likely to change drastically before a major version
-release.
+2. Its a stepping stone for when you want to scale on the edge using
+[Cloudflare V8 isolates](https://developers.cloudflare.com/workers/reference/how-workers-works/)
+.`mini_racer` is a bare V8 environment, if your JS bundle works with
+`mini_racer`, it'll work on Cloudflare V8 isolates.
+
+> [!NOTE]
+> See the [sample](./sample/) for a complete working example.
 
 ## Installation
 
@@ -72,7 +81,8 @@ Humid.configure do |config|
 end
 
 if Rails.env.local?
-  # Use single_threaded mode for Spring and other forked envs.
+  # Use single_threaded mode for dev and test environments.
+  # This will also work for mini_test parallel tests
   MiniRacer::Platform.set_flags! :single_threaded
   MINI_RACER_SSR = { context: MiniRacer::Context.new(timeout: 1000, ensure_gc_after_idle: 2000) }
 
@@ -161,9 +171,6 @@ MINI_RACER_SSR = { context: ctx }
 > [!NOTE]
 > If you pass a context that was already prepared, `prepare` will noop and return the context back to you.
 
-See the [sample server_rendering.tsx](./sample/server_rendering.tsx) to see how
-it is integrated.
-
 ### Call `Humid.render`
 
 And finally call `render` from ERB.
@@ -221,17 +228,19 @@ The default formatter returns `message` unchanged.
 
 ## Server-side libraries that detect node.js envs.
 
-You may need webpacker to create aliases for server friendly libraries that can
-not detect the `mini_racer` environment. For example, in `webpack.config.js`.
-
-```diff
-...
-  resolve: {
-    alias: {
-      'html-dom-parser': path.resolve(__dirname, '../../node_modules/html-dom-parser/lib/html-to-dom-server')
-    }
+Some libraries check for Node.js or browser globals to decide which code path
+to use. In `mini_racer`, neither environment is detected. You may need to
+configure your bundler to alias server-friendly versions. For example, in
+esbuild:
+
+```js
+// build_ssr.mjs
+await esbuild.build({
+  // ...
+  alias: {
+    'html-dom-parser': 'html-dom-parser/lib/html-to-dom-server'
   }
-...
+})
 ```
 
 ## Writing universal code
@@ -263,28 +272,9 @@ moving the `require` to `useEffect` in your component.
 ## Polyfills
 
 React SSR may import node.js dependencies that you need to polyfill for. See
-a sample esbuild [build script](./sample/bulid_ssr.js) and a [shim.js](./sample/shim.js)
+a sample esbuild [build script](./sample/build.mjs) and a [shim.js](./sample/shim.js)
 to get around these issues.
 
-## Testing
-
-The snippet When running in test environments that fork (e.g., parallel tests), each
-worker needs its own context since MiniRacer is not fork-safe. Using
-`MINI_RACER_SSR` as a hash makes this straightforward:
-
-```ruby
-ActiveSupport.on_load(:action_dispatch_integration_test) do
-  parallelize_setup do
-    MINI_RACER_SSR[:context].dispose
-    MINI_RACER_SSR[:context] = MiniRacer::Context.new(timeout: 1000, ensure_gc_after_idle: 2000)
-  end
-
-  parallelize_teardown do
-    MINI_RACER_SSR[:context].dispose
-  end
-end
-```
-
 ## Telemetry
 
 The `MiniRacer::Context` gives you access to V8 heap statistics for monitoring
@@ -321,13 +311,14 @@ end
 A steadily climbing `used_heap_size` across requests indicates a memory leak in
 your JavaScript bundle.
 
+
 ## Contributing
 
 Please see [CONTRIBUTING.md](/CONTRIBUTING.md).
 
 ## License
 
-Humid is Copyright © 2021-2024 Johny Ho.
+Humid is Copyright © 2021-2026 Johny Ho.
 It is free software, and may be redistributed under the terms specified in the
 [LICENSE](/LICENSE.md) file.
 
@@ -350,4 +341,4 @@ We are [available for hire][hire].
 
 [mini_racer]: https://github.com/rubyjs/mini_racer
 [vue_ssr]: https://ssr.vuejs.org/
-[sample]: ./webpack.config.js
+[sample]: ./sample/

data/lib/humid/version.rb

@@ -1,3 +1,3 @@
 module Humid
-  VERSION = "0.7.0".freeze
+  VERSION = "1.0.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: humid
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Johny Ho