humid 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b62f6d6c3c7ffac0ba1c609965742a6a09dafebe0ebb9fc05cbae3c9200299e
-  data.tar.gz: 56557384d6768ada9b8fa9e9403720b5e75f03a579e39483892afcb631cb04a4
+  metadata.gz: 961eafadcfe1132cdd132c096a28aba48155c740b224c3cbc32b4fd9731c10a6
+  data.tar.gz: 8a3635e896a4915c508a096c3b9f60e7d51265b39c6c448150fb89a627a3ab06
 SHA512:
-  metadata.gz: 4465a746beab25d302782cc71b8a70cd7fe827dc6ce3058e6720056c121bb86357733a9d31a7c266ceee6a53f938b174fec1eef111dbc634aa6699ffccb30ac9
-  data.tar.gz: c5d8a1c61b84b49a14a78c7d198af09871bbdf9cebc8c9bbd1d4b32c2cdd95ac7de2bad06214f80ec12a8507158b8bb95a592eff313e51e454dcd768e5a2cdc1
+  metadata.gz: 7f9f13d45e1b4023cccdc88300c151024dbb08a5bcc73c24b1a81e089f1ad1d2a4ec1faea12feb81e13949e2c423a8e8a392d73bf45b547ecdcd20a6462b74b6
+  data.tar.gz: fba2e9ea74fdeab8a90f5503a0b34cf977ddb0006dcaf234ceff8b1d06548079461e0e5d17466cace1c68937b7fa290a5823ef0fe01352886b545b0fe87c9cc2

data/README.md

@@ -71,33 +71,54 @@ Humid.configure do |config|
   config.logger = Rails.env.local? ? Rails.logger : nil
 end
 
-# if Rails.env.local?
-#   # Use single_threaded mode for Spring and other forked envs.
-#   MiniRacer::Platform.set_flags! :single_threaded
-#   ctx = MiniRacer::Context.new(timeout: 100, ensure_gc_after_idle: 2000)
-#   MINI_RACER_CONTEXT = Humid.prepare(ctx)
-# end
+if Rails.env.local?
+  # Use single_threaded mode for Spring and other forked envs.
+  MiniRacer::Platform.set_flags! :single_threaded
+  ctx = MiniRacer::Context.new(timeout: 100, ensure_gc_after_idle: 2000)
+  MINI_RACER_CONTEXT = Humid.prepare(ctx)
+end
 ```
 
 ## Usage
 
+### Set a renderer
 
-### Create the MiniRacer Context.
+In your entry file, e.g, `server_rendering.js` (specified in
+`config.application_path`), pass your HTML render function to
+`setHumidRenderer`. There is no need to require the function, its included in
+the environment.
 
-On local development or test environments, uncomment the below.
+```javascript
+// Set a factory function that will create a new instance of our app
+// for each request.
+setHumidRenderer((json) => {
+  const initialState = JSON.parse(json)
 
-```ruby
-if Rails.env.local?
-  # Use single_threaded mode for Spring and other forked envs.
-  MiniRacer::Platform.set_flags! :single_threaded
-  ctx = MiniRacer::Context.new(timeout: 100, ensure_gc_after_idle: 2000)
-  MINI_RACER_CONTEXT = Humid.prepare(ctx)
-end
+  return ReactDOMServer.renderToString(
+    <Application initialPage={initialState}/>
+  )
+})
+```
+
+If you'd like support for source map support, you will need to add the following
+to the same file and set `config.source_map_path` like the configuration above.
+
+```javascript
+require("source-map-support").install({
+  retrieveSourceMap: filename => {
+    return {
+      url: filename,
+      map: readSourceMap(filename)
+    };
+  }
+});
 ```
 
+### Your webserver
+
 On production, keep in mind that `mini_racer` is **thread safe, but not fork
 safe**. When using with web servers that employ forking, create a
-`MINI_RACER_CONTEXT` with options of your choosing **on worker boot. There
+`MINI_RACER_CONTEXT` with options of your choosing on worker boot. **There
 should be no context created on the master process.**
 
 For example with puma:
@@ -106,6 +127,7 @@ For example with puma:
 # config/puma.rb
 on_worker_boot do
   ctx = MiniRacer::Context.new(timeout: 100, ensure_gc_after_idle: 2000)
+  
   MINI_RACER_CONTEXT = Humid.prepare(ctx)
 end
 
@@ -114,11 +136,8 @@ on_worker_shutdown do
 end
 ```
 
-### Prepare the context with `Humid.prepare`
-
-`Humid.prepare` will prepare the context's environment by [removing
-functions](#functions-not-available), delegate `console.log` and friends to
-your logger, load the SSR js bundle, and add the render function.
+`Humid.prepare` will prepare the context's
+[environment](#the-mini_racer-environment).
 
 You can also override config options per-context:
 
@@ -130,41 +149,10 @@ MINI_RACER_CONTEXT = Humid.prepare(
 )
 ```
 
-If you'd like support for source map support, you will need to
-
-1. Add the following to your entry file, e.g, `server_rendering.js`.
-2. set `config.source_map_path`.
-
-```javascript
-require("source-map-support").install({
-  retrieveSourceMap: filename => {
-    return {
-      url: filename,
-      map: readSourceMap(filename)
-    };
-  }
-});
-```
-
 See the [sample server_rendering.tsx](./sample/server_rendering.tsx) to see how
 it is integrated.
 
-### Add a renderer and call `Humid.render`
-
-In your entry file, e.g, `server_rendering.js`, pass your HTML render function
-to `setHumidRenderer`. There is no need to require the function.
-
-```javascript
-// Set a factory function that will create a new instance of our app
-// for each request.
-setHumidRenderer((json) => {
-  const initialState = JSON.parse(json)
-
-  return ReactDOMServer.renderToString(
-    <Application initialPage={initialState}/>
-  )
-})
-```
+### Call `Humid.render`
 
 And finally call `render` from ERB.
 
@@ -178,7 +166,7 @@ Instrumentation is included:
 Completed 200 OK in 14ms (Views: 0.2ms | Humid SSR: 11.0ms | ActiveRecord: 2.7ms)
 ```
 
-## The prepared `mini_racer` environment.
+## The `mini_racer` environment
 
 ### Functions not available
 

data/lib/humid/version.rb

@@ -1,3 +1,3 @@
 module Humid
-  VERSION = "0.5.0".freeze
+  VERSION = "0.6.0".freeze
 end

data/lib/humid.rb

@@ -13,6 +13,9 @@ module Humid
   class FileNotFound < StandardError
   end
 
+  class NotPrepared < StandardError
+  end
+
   mattr_accessor :config
 
   self.config = ActiveSupport::OrderedOptions.new.merge({
@@ -39,9 +42,7 @@ module Humid
       ctx.attach("console.warn", proc { |*args| logger.warn(fmt.call(:warn, *args)) })
     end
 
-    js = ""
-    js << remove_functions
-    js << renderer
+    js = remove_functions + renderer
     ctx.eval(js)
 
     source_path = effective_config.application_path
@@ -54,10 +55,17 @@ module Humid
     filename = File.basename(source_path.to_s)
     ctx.eval(File.read(source_path), filename: filename)
 
+    def ctx.humid_prepared?
+      true
+    end
+
     ctx
   end
 
   def render(ctx, *args)
+    is_prepared = ctx.respond_to?(:humid_prepared?) && ctx.humid_prepared?
+    raise Humid::NotPrepared, "Context was not prepared with Humid.prepare" unless is_prepared
+
     ActiveSupport::Notifications.instrument("render.humid") do
       ctx.call("__renderer", *args)
     rescue MiniRacer::RuntimeError => e

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: humid
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Johny Ho
@@ -37,7 +37,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '8.0'
-description: Javascript SSR rendering for Rails
+description: Javascript Server Side Rendering (SSR) for Rails
 email: jho406@gmail.com
 executables: []
 extensions: []
@@ -68,5 +68,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: Javascript SSR rendering for Rails
+summary: Javascript Server Side Rendering (SSR) for Rails
 test_files: []