humid 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8422854ba8184e3afc75af501ec45002304538e9f756ea3ee3bdd58b15d98de
-  data.tar.gz: 8e8025cba53a2ed0e54aecb85701bcb65a7d39798f241ef4e5d3aeea391367aa
+  metadata.gz: 6c4f5090d85ea4b1c4998f6c8533816a8875039f2ffe5b5785e3e571092445c6
+  data.tar.gz: 844410054db5d2c89fa3fc1fd3ac4d64f83605cf4a157573ebd6d172b01d0a7f
 SHA512:
-  metadata.gz: 404f369b35a24b2b313bf2a5d572746b1d4262df0b5ee4988f69540a878502045d046279714432d77b367366e98031818f6c3f3c26747f67e916581335b4004f
-  data.tar.gz: 38feb90293fd0340155314e6300e5a3ff70a8ee5f2d2e7fb081c0bf89ea8b7826a7297d52b15888d05f447ff64738da454cc4ede07ff9a152236ae7318fd5380
+  metadata.gz: 574e6c64e749180f964a3d9ffe4dd91f18179408901b4b26960b2ef3c9bbe12c601e0879fc97bb60b340ed0270be627aaf0cc92d18827deda5f45dd515d952c4
+  data.tar.gz: b1511fc86f5655ac063bf6d927866bd00096c7ddca23e822e2cd3dbe03a97d1e4f62288f1242c9b436e67695402c2a61a59e4f096a0dc0f3dbf450ac0fbdc250

data/README.md

@@ -33,14 +33,16 @@ Add an initializer to configure
 
 ```ruby
 Humid.configure do |config|
-  # Path to your build file located in `app/assets/build/`. You should use a
+  # Path to your build file located in `app/assets/builds/`. You should use a
   # separate build apart from your `application.js`.
+  #
   # Required
-  config.application_path = "app/assets/build/server_rendering.js"
+  config.application_path = Rails.root.join('app', 'assets', 'builds', 'server_rendering.js')
 
   # Path to your source map file
+  #
   # Optional
-  config.source_map_path = "app/assets/build/server_rendering.js.map"
+  config.source_map_path = Rails.root.join('app', 'assets', 'builds', 'server_rendering.js.map')
 
   # Raise errors if JS rendering failed. If false, the error will be
   # logged out to Rails log and Humid.render will return an empty string
@@ -52,8 +54,8 @@ Humid.configure do |config|
   # `console.log` and friends (`warn`, `error`) are delegated to
   # the respective logger levels on the ruby side.
   #
-  # Defaults to `Logger.new(STDOUT)`
-  config.logger = Rails.logger
+  # Defaults to `nil`
+  config.logger = Rails.env.development? ? Rails.logger : nil
 
   # Options passed to mini_racer.
   #
@@ -64,14 +66,27 @@ Humid.configure do |config|
   }
 end
 
-# Common development options
-if Rails.env.development? || Rails.env.test?
+# Capybara defines its own puma config which is set up to run a single puma process
+# with a thread pool. This ensures that a context gets created on that process.
+if Rails.env.test?
   # Use single_threaded mode for Spring and other forked envs.
   MiniRacer::Platform.set_flags! :single_threaded
+  Humid.create_context
+end
+```
+
+Then add to your `config/puma.rb`
+
+```
+workers ENV.fetch("WEB_CONCURRENCY") { 1 }
 
-  # If you're using Puma in single mode:
+on_worker_boot do
   Humid.create_context
 end
+
+on_worker_shutdown do
+  Humid.dispose
+end
 ```
 
 If you'd like support for source map support, you will need to
@@ -110,7 +125,7 @@ respective methods on the configured logger.
 
 ## Usage
 
-In your entry file, e.g, `server_rendering.js`, pass your HTML render function 
+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
@@ -128,7 +143,7 @@ setHumidRenderer((json) => {
 And finally call `render` from ERB.
 
 ```ruby
-<%= Humid.render(initial_state) %>
+<%= Humid.render(initial_state).html_safe %>
 ```
 
 Instrumentation is included:
@@ -140,7 +155,8 @@ Completed 200 OK in 14ms (Views: 0.2ms | Humid SSR: 11.0ms | ActiveRecord: 2.7ms
 ### Puma
 
 `mini_racer` is thread safe, but not fork safe. To use with web servers that
-employ forking, use `Humid.create_context` only on forked processes.
+employ forking, use `Humid.create_context` only on forked processes. On
+production, There should be no context created on the master process.
 
 ```ruby
 # Puma
@@ -155,7 +171,7 @@ end
 
 ### 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 your `webpack.config.js`.
+not detect the `mini_racer` environment. For example, in `webpack.config.js`.
 
 ```diff
 ...
@@ -180,19 +196,17 @@ every call.
 This provides better isolation, but as it is still a shared context, polluting
 `global` is still possible. Be careful of modifying `global` in your code.
 
-### Polyfills
+### Missing browser APIs
 
-Polyfills will fail when using in the `mini_racer` environment because of missing
-browser APIs. Account for this by moving the `require` to `componentDidMount`
-in your component.
+Polyfills and some libraries that depend on browser APIs will fail in the
+`mini_racer` environment because of missing browser APIs. Account for this by
+moving the `require` to `useEffect` in your component.
 
 ```
-componentDidMount() {
-  const dialogPolyfill = require('dialog-polyfill').default
-  dialogPolyfill.registerDialog(this.dialog.current)
-  this.dialog.current.open = this.props.open
-  this.dialog.current.showModal()
-}
+  useEffect(() => {
+    const svgPanZoom = require('svg-pan-zoom')
+    //...
+  }, [])
 ```
 
 ## Contributing
@@ -201,23 +215,28 @@ Please see [CONTRIBUTING.md](/CONTRIBUTING.md).
 
 ## License
 
-Humid is Copyright © 2021-2021 Johny Ho.
+Humid is Copyright © 2021-2024 Johny Ho.
 It is free software, and may be redistributed under the terms specified in the
 [LICENSE](/LICENSE.md) file.
 
+<!-- START /templates/footer.md -->
 ## About thoughtbot
 
-![thoughtbot](https://thoughtbot.com/brand_assets/93:44.svg)
+![thoughtbot](https://thoughtbot.com/thoughtbot-logo-for-readmes.svg)
 
-Humid is maintained and funded by thoughtbot, inc.
+This repo is maintained and funded by thoughtbot, inc.
 The names and logos for thoughtbot are trademarks of thoughtbot, inc.
 
 We love open source software!
-See [our other projects][community] or
-[hire us][hire] to design, develop, and grow your product.
+See [our other projects][community].
+We are [available for hire][hire].
 
 [community]: https://thoughtbot.com/community?utm_source=github
-[hire]: https://thoughtbot.com?utm_source=github
+[hire]: https://thoughtbot.com/hire-us?utm_source=github
+
+
+<!-- END /templates/footer.md -->
+
 [mini_racer]: https://github.com/rubyjs/mini_racer
 [vue_ssr]: https://ssr.vuejs.org/
 [sample]: ./webpack.config.js

data/lib/humid/controller_runtime.rb

@@ -1,4 +1,4 @@
-module Humid
+class Humid
   module ControllerRuntime
     extend ActiveSupport::Concern
 

data/lib/humid/log_subscriber.rb

@@ -1,4 +1,4 @@
-module Humid
+class Humid
   class LogSubscriber < ActiveSupport::LogSubscriber
     thread_cattr_accessor :humid_runtime
 

data/lib/humid/version.rb

@@ -1,3 +1,3 @@
-module Humid
-  VERSION = "0.0.6".freeze
+class Humid
+  VERSION = "0.1.0".freeze
 end

data/lib/humid.rb

@@ -6,106 +6,104 @@ require "humid/log_subscriber"
 require "humid/controller_runtime"
 require "humid/version"
 
-module Humid
-  extend self
-  include ActiveSupport::Configurable
+class Humid
+  @@context = nil
 
   class RenderError < StandardError
   end
 
   class FileNotFound < StandardError
   end
+  
+  class_attribute :config
 
-  @@context = nil
+  self.config = ActiveSupport::OrderedOptions.new.merge({
+    raise_render_errors: true,
+    context_options: {},
+  })
 
-  config_accessor :application_path
-  config_accessor :source_map_path
+  class << self
+    def configure
+      yield config
+    end
 
-  config_accessor :raise_render_errors do
-    true
-  end
+    def remove_functions
+      <<~JS
+        delete this.setTimeout;
+        delete this.setInterval;
+        delete this.clearTimeout;
+        delete this.clearInterval;
+        delete this.setImmediate;
+        delete this.clearImmediate;
+      JS
+    end
 
-  config_accessor :logger do
-    Logger.new($stdout)
-  end
+    def logger
+      config.logger
+    end
 
-  config_accessor :context_options do
-    {}
-  end
+    def renderer
+      <<~JS
+        var __renderer;
+        function setHumidRenderer(fn) {
+          __renderer = fn;
+        }
+      JS
+    end
 
-  def remove_functions
-    <<~JS
-      delete this.setTimeout;
-      delete this.setInterval;
-      delete this.clearTimeout;
-      delete this.clearInterval;
-      delete this.setImmediate;
-      delete this.clearImmediate;
-    JS
-  end
+    def context
+      @@context
+    end
 
-  def logger
-    config.logger
-  end
+    def dispose
+      if @@context
+        @@context.dispose
+        @@context = nil
+      end
+    end
 
-  def renderer
-    <<~JS
-      var __renderer;
-      function setHumidRenderer(fn) {
-        __renderer = fn;
-      }
-    JS
-  end
+    def create_context
+      ctx = MiniRacer::Context.new(**config.context_options)
 
-  def context
-    @@context
-  end
+      if logger
+        ctx.attach("console.log", proc { |err| logger.debug(err.to_s) })
+        ctx.attach("console.info", proc { |err| logger.info(err.to_s) })
+        ctx.attach("console.error", proc { |err| logger.error(err.to_s) })
+        ctx.attach("console.warn", proc { |err| logger.warn(err.to_s) })
+      end
 
-  def dispose
-    if @@context
-      @@context.dispose
-      @@context = nil
-    end
-  end
+      js = ""
+      js << remove_functions
+      js << renderer
+      ctx.eval(js)
 
-  def create_context
-    ctx = MiniRacer::Context.new(**config.context_options)
-    ctx.attach("console.log", proc { |err| logger.debug(err.to_s) })
-    ctx.attach("console.info", proc { |err| logger.info(err.to_s) })
-    ctx.attach("console.error", proc { |err| logger.error(err.to_s) })
-    ctx.attach("console.warn", proc { |err| logger.warn(err.to_s) })
+      source_path = config.application_path
+      map_path = config.source_map_path
 
-    js = ""
-    js << remove_functions
-    js << renderer
-    ctx.eval(js)
+      if map_path
+        ctx.attach("readSourceMap", proc { File.read(map_path) })
+      end
 
-    source_path = config.application_path
-    map_path = config.source_map_path
+      filename = File.basename(source_path.to_s)
+      @@current_filename = filename
+      ctx.eval(File.read(source_path), filename: filename)
 
-    if map_path
-      ctx.attach("readSourceMap", proc { File.read(map_path) })
+      @@context = ctx
     end
 
-    filename = File.basename(source_path.to_s)
-    @@current_filename = filename
-    ctx.eval(File.read(source_path), filename: filename)
-
-    @@context = ctx
-  end
-
-  def render(*args)
-    ActiveSupport::Notifications.instrument("render.humid") do
-      context.call("__renderer", *args)
-    rescue MiniRacer::RuntimeError => e
-      message = ([e.message] + e.backtrace.filter { |x| x.starts_with? "JavaScript" }).join("\n")
-      render_error = Humid::RenderError.new(message)
-
-      if config.raise_render_errors
-        raise render_error
-      else
-        config.logger.error(render_error.inspect)
-        ""
+    def render(*args)
+      ActiveSupport::Notifications.instrument("render.humid") do
+        context.call("__renderer", *args)
+      rescue MiniRacer::RuntimeError => e
+        message = ([e.message] + e.backtrace.filter { |x| x.starts_with? "JavaScript" }).join("\n")
+        render_error = Humid::RenderError.new(message)
+
+        if config.raise_render_errors
+          raise render_error
+        else
+          config.logger.error(render_error.inspect)
+          ""
+        end
       end
     end
   end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: humid
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Johny Ho
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_racer
@@ -28,16 +27,16 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
 description: Javascript SSR rendering for Rails
 email: jho406@gmail.com
 executables: []
@@ -53,7 +52,6 @@ homepage: https://github.com/thoughtbot/humid/
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -68,8 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Javascript SSR rendering for Rails
 test_files: []