humid 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a783b726d5542a0abfc94fc1918aad0212c13ac7b6db8b8efd90c5452a222b2e
-  data.tar.gz: b9c3719ace7b00d210c992b48f9c4ee02010e81d19c30aa47e8bf6fdd9e9373b
+  metadata.gz: b8422854ba8184e3afc75af501ec45002304538e9f756ea3ee3bdd58b15d98de
+  data.tar.gz: 8e8025cba53a2ed0e54aecb85701bcb65a7d39798f241ef4e5d3aeea391367aa
 SHA512:
-  metadata.gz: d29027f962022c6f8d5aeaf09c11730d572a32f8936e025fc04c3490921ac51468f6567e99f29aeb090a344150fa5edce2bbe14e83c18bfe9afc62e89fb34a87
-  data.tar.gz: 9ceb09c4bebef88f71f3b9c229c9317526a1d5cd5100dce4a270aad383334401a14baa7e108417170c5c3cad122523e9539733404d4c9a3cdf6f7bb8c2ec5dbf
+  metadata.gz: 404f369b35a24b2b313bf2a5d572746b1d4262df0b5ee4988f69540a878502045d046279714432d77b367366e98031818f6c3f3c26747f67e916581335b4004f
+  data.tar.gz: 38feb90293fd0340155314e6300e5a3ff70a8ee5f2d2e7fb081c0bf89ea8b7826a7297d52b15888d05f447ff64738da454cc4ede07ff9a152236ae7318fd5380

data/README.md

@@ -1,11 +1,10 @@
 # Humid
-[![Build
-Status](https://circleci.com/gh/thoughtbot/humid.svg?style=shield)](https://circleci.com/gh/thoughtbot/humid)
 
-Humid is a lightweight wrapper around [mini_racer] and [webpacker] used to
-generate Server Side Rendered (SSR) pages from your javascript application.
-While it was built for React, it can work with any JS function that returns a
-HTML string.
+![Build Status](https://github.com/thoughtbot/humid/actions/workflows/build.yml/badge.svg?branch=main)
+
+Humid is a lightweight wrapper around [mini_racer] used to generate Server
+Side Rendered (SSR) pages from your js-bundling builds. While it was built
+for React, it can work with any JS function that returns a HTML string.
 
 ## Caution
 
@@ -34,16 +33,14 @@ Add an initializer to configure
 
 ```ruby
 Humid.configure do |config|
-  # Name of your webpacker pack file located in `app/javascript/packs/`. You
-  # should use a separate pack from your `application.js`.
-  #
-  # Defaults to "server_rendering.js"
-  config.server_rendering_pack = "server_rendering.js"
+  # Path to your build file located in `app/assets/build/`. You should use a
+  # separate build apart from your `application.js`.
+  # Required
+  config.application_path = "app/assets/build/server_rendering.js"
 
-  # Name of your webpacker pack source map.
-  #
-  # Defaults to `false`
-  config.use_source_map = true
+  # Path to your source map file
+  # Optional
+  config.source_map_path = "app/assets/build/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
@@ -78,8 +75,8 @@ end
 ```
 
 If you'd like support for source map support, you will need to
-1. Ensure `config.use_source_map` is set to `true`
-2. Add the following to your `server_rendering.js` pack.
+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({
@@ -91,6 +88,7 @@ require("source-map-support").install({
   }
 });
 ```
+A [sample] webpack.config is available for reference.
 
 ## The mini_racer environment.
 
@@ -112,7 +110,8 @@ respective methods on the configured logger.
 
 ## Usage
 
-Pass your HTML render function to `setHumidRenderer`
+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
@@ -156,41 +155,20 @@ 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.
+not detect the `mini_racer` environment. For example, in your `webpack.config.js`.
 
 ```diff
- // config/webpack/production.js
- // config/webpack/development.js
- // config/webpack/test.js
-
- process.env.NODE_ENV = process.env.NODE_ENV || 'development'
-
- const environment = require('./environment')
-+const path = require('path')
-+const ConfigObject = require('@rails/webpacker/package/config_types/config
-
--module.exports = environment.toWebpackConfig()
-+const webConfig = environment.toWebpackConfig()
-+const ssrConfig = new ConfigObject(webConfig.toObject())
-+
-+ssrConfig.delete('entry')
-+ssrConfig.merge({
-+  entry: {
-+    server_rendering: webConfig.entry.server_rendering
-+  },
-+  resolve: {
-+    alias: {
-+      'html-dom-parser': path.resolve(__dirname, '../../node_modules/html-dom-parser/lib/html-to-dom-server')
-+    }
-+  }
-+})
-+
-+delete webConfig.entry.server_rendering
-+module.exports = [ssrConfig, webConfig]
+...
+  resolve: {
+    alias: {
+      'html-dom-parser': path.resolve(__dirname, '../../node_modules/html-dom-parser/lib/html-to-dom-server')
+    }
+  }
+...
 ```
 
 ## Writing universal code
-[Vue has an amazing resource][vue_ssr] on how to write universal code. Below
+[Vue has a resource][vue_ssr] on how to write universal code. Below
 are a few highlights that are important to keep in mind.
 
 ### State
@@ -241,5 +219,5 @@ See [our other projects][community] or
 [community]: https://thoughtbot.com/community?utm_source=github
 [hire]: https://thoughtbot.com?utm_source=github
 [mini_racer]: https://github.com/rubyjs/mini_racer
-[webpacker]: https://github.com/rails/webpacker
 [vue_ssr]: https://ssr.vuejs.org/
+[sample]: ./webpack.config.js

data/lib/humid/version.rb

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

data/lib/humid.rb

@@ -1,6 +1,5 @@
 require "mini_racer"
 require "logger"
-require "webpacker"
 require "active_support"
 require "active_support/core_ext"
 require "humid/log_subscriber"
@@ -19,20 +18,15 @@ module Humid
 
   @@context = nil
 
-  config_accessor :server_rendering_pack do
-    "server_rendering.js"
-  end
-
-  config_accessor :use_source_map do
-    false
-  end
+  config_accessor :application_path
+  config_accessor :source_map_path
 
   config_accessor :raise_render_errors do
     true
   end
 
   config_accessor :logger do
-    Logger.new(STDOUT)
+    Logger.new($stdout)
   end
 
   config_accessor :context_options do
@@ -63,27 +57,7 @@ module Humid
     JS
   end
 
-  def handle_stale_files
-    if Webpacker.compiler.stale?
-      Webpacker.compiler.compile
-    end
-
-    public_path = Webpacker.config.public_path
-    server_rendering_pack = config.server_rendering_pack
-    source_path = public_path.join(Webpacker.manifest.lookup(server_rendering_pack)[1..-1])
-    filename = File.basename(source_path.to_s)
-
-    if @@current_filename != filename
-      dispose
-      create_context
-    end
-  end
-
   def context
-    if @@context && Webpacker.env.development?
-      handle_stale_files
-    end
-
     @@context
   end
 
@@ -95,7 +69,7 @@ module Humid
   end
 
   def create_context
-    ctx = MiniRacer::Context.new(config.context_options)
+    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) })
@@ -106,20 +80,13 @@ module Humid
     js << renderer
     ctx.eval(js)
 
-    public_path = Webpacker.config.public_path
-
-    webpack_source_file = Webpacker.manifest.lookup(config.server_rendering_pack)
-    if webpack_source_file.nil?
-      raise FileNotFound.new("Humid could not find a built pack for #{config.server_rendering_pack}")
-    end
+    source_path = config.application_path
+    map_path = config.source_map_path
 
-    if config.use_source_map
-      webpack_source_map = Webpacker.manifest.lookup("#{config.server_rendering_pack}.map")
-      map_path = public_path.join(webpack_source_map[1..-1])
+    if map_path
       ctx.attach("readSourceMap", proc { File.read(map_path) })
     end
 
-    source_path = public_path.join(webpack_source_file[1..-1])
     filename = File.basename(source_path.to_s)
     @@current_filename = filename
     ctx.eval(File.read(source_path), filename: filename)
@@ -131,7 +98,7 @@ module Humid
     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")
+      message = ([e.message] + e.backtrace.filter { |x| x.starts_with? "JavaScript" }).join("\n")
       render_error = Humid::RenderError.new(message)
 
       if config.raise_render_errors

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: humid
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Johny Ho
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-31 00:00:00.000000000 Z
+date: 2023-07-13 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: webpacker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: mini_racer
   requirement: !ruby/object:Gem::Requirement
@@ -44,70 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.0'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 description: Javascript SSR rendering for Rails
 email: jho406@gmail.com
 executables: []
@@ -119,9 +49,6 @@ files:
 - lib/humid/controller_runtime.rb
 - lib/humid/log_subscriber.rb
 - lib/humid/version.rb
-- spec/controller_runtime_spec.rb
-- spec/log_subscriber_spec.rb
-- spec/render_spec.rb
 homepage: https://github.com/thoughtbot/humid/
 licenses:
 - MIT
@@ -141,11 +68,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Javascript SSR rendering for Rails
-test_files:
-- spec/render_spec.rb
-- spec/log_subscriber_spec.rb
-- spec/controller_runtime_spec.rb
+test_files: []

data/spec/controller_runtime_spec.rb

@@ -1,79 +0,0 @@
-require_relative "./support/helper"
-
-describe Humid::ControllerRuntime do
-  controller_runtime = Humid::ControllerRuntime
-
-  def set_metric value
-    Humid::LogSubscriber.runtime = value
-  end
-
-  def clear_metric!
-    Humid::LogSubscriber.reset_runtime = 0
-  end
-
-  reference_controller_class = Class.new {
-    def process_action *_
-      @process_action = true
-    end
-
-    def cleanup_view_runtime *_
-      @cleanup_view_runtime.call
-    end
-
-    def append_info_to_payload *_
-      @append_info_to_payload = true
-    end
-
-    def self.log_process_action *_
-      @log_process_action.call
-    end
-  }
-
-  controller_class = Class.new reference_controller_class do
-    include controller_runtime
-
-    def logger
-      Logger.new(STDOUT)
-    end
-  end
-
-  let(:controller) { controller_class.new }
-
-  it "resets the metric before each action" do
-    set_metric 42
-    controller.send(:process_action, "foo")
-    expect(Humid::LogSubscriber.runtime).to be(0)
-    expect(controller.instance_variable_get("@process_action")).to be(true)
-  end
-
-  it "strips the metric of other sources of the runtime" do
-    set_metric 1
-    controller.instance_variable_set "@cleanup_view_runtime", -> {
-      controller.instance_variable_set "@cleanup_view_runtime", true
-      set_metric 13
-      42
-    }
-    returned = controller.send :cleanup_view_runtime
-    expect(controller.instance_variable_get("@cleanup_view_runtime")).to be(true)
-    expect(controller.humid_runtime).to eq(14)
-    expect(returned).to be(29)
-  end
-
-  it "appends the metric to payload" do
-    payload = {}
-    set_metric 42
-    controller.send :append_info_to_payload, payload
-    expect(controller.instance_variable_get("@append_info_to_payload")).to be(true)
-    expect(payload[:humid_runtime]).to eq(42)
-  end
-
-  it "adds metric to log message" do
-    controller_class.instance_variable_set "@log_process_action", -> {
-      controller_class.instance_variable_set "@log_process_action", true
-      []
-    }
-    messages = controller_class.log_process_action humid_runtime: 42.101
-    expect(controller_class.instance_variable_get("@log_process_action")).to be(true)
-    expect(messages).to eq(["Humid SSR: 42.1ms"])
-  end
-end

data/spec/log_subscriber_spec.rb

@@ -1,54 +0,0 @@
-require_relative "./support/helper"
-require "active_support/log_subscriber/test_helper"
-require "byebug"
-
-RSpec.describe Humid::LogSubscriber do
-  around(:each) do |example|
-    app_path = File.expand_path("./testapp", File.dirname(__FILE__))
-    Dir.chdir(app_path) do
-      example.run
-    end
-  end
-
-  before(:each) do
-    Humid::LogSubscriber.reset_runtime
-  end
-
-  context ".runtime" do
-    it "is returns the runtime from the thread local" do
-      expect(Humid::LogSubscriber.runtime).to eql 0
-      key = "attr_Humid::LogSubscriber_humid_runtime"
-      Thread.current[key] = 3
-      expect(Humid::LogSubscriber.runtime).to eql 3
-    end
-  end
-
-  context ".runtime=" do
-    it "sets the runtime in a thread-safe manner" do
-      expect(Humid::LogSubscriber.runtime).to eql 0
-      Humid::LogSubscriber.runtime = 3
-      key = "attr_Humid::LogSubscriber_humid_runtime"
-      expect(Thread.current[key]).to eql 3
-    end
-  end
-
-  context ".reset_runtime" do
-    it "resets the runtime" do
-      Humid::LogSubscriber.runtime = 3
-      key = "attr_Humid::LogSubscriber_humid_runtime"
-      expect(Thread.current[key]).to eql 3
-
-      Humid::LogSubscriber.reset_runtime
-      expect(Thread.current[key]).to eql 0
-      expect(Humid::LogSubscriber.runtime).to eql 0
-    end
-  end
-
-  it "is attached" do
-    allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
-    Humid.create_context
-    expect(Humid::LogSubscriber.runtime).to eql(0)
-    Humid.render
-    expect(Humid::LogSubscriber.runtime).to be > 0
-  end
-end

data/spec/render_spec.rb

@@ -1,188 +0,0 @@
-require_relative "./support/helper"
-
-RSpec.describe "Humid" do
-  around(:each) do |example|
-    app_path = File.expand_path("./testapp", File.dirname(__FILE__))
-    Dir.chdir(app_path) do
-      example.run
-    end
-  end
-
-  describe "create_context" do
-    after(:each) do
-      Humid.dispose
-    end
-
-    it "creates a context with initial js" do
-      allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
-      Humid.create_context
-
-      expect(Humid.context).to be_kind_of(MiniRacer::Context)
-    end
-
-    context "When the file can not be found" do
-      it "raises" do
-        allow(Humid.config).to receive("server_rendering_pack") { "does_not_exist.js" }
-
-        expect {
-          Humid.create_context
-        }.to raise_error(Humid::FileNotFound, "Humid could not find a built pack for does_not_exist.js")
-      end
-    end
-
-    it "does not have timeouts, immediates, and intervals" do
-      allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
-
-      Humid.create_context
-
-      expect {
-        Humid.context.eval("setTimeout()")
-      }.to raise_error(MiniRacer::RuntimeError, "ReferenceError: setTimeout is not defined")
-      expect {
-        Humid.context.eval("setInterval()")
-      }.to raise_error(MiniRacer::RuntimeError, "ReferenceError: setInterval is not defined")
-      expect {
-        Humid.context.eval("clearTimeout()")
-      }.to raise_error(MiniRacer::RuntimeError, "ReferenceError: clearTimeout is not defined")
-      expect {
-        Humid.context.eval("setImmediate()")
-      }.to raise_error(MiniRacer::RuntimeError, "ReferenceError: setImmediate is not defined")
-      expect {
-        Humid.context.eval("clearImmediate()")
-      }.to raise_error(MiniRacer::RuntimeError, "ReferenceError: clearImmediate is not defined")
-    end
-
-    it "proxies to Rails logger" do
-      allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
-      Humid.create_context
-      expect(Humid.logger).to receive(:info).with("hello")
-
-      Humid.context.eval("console.info('hello')")
-    end
-  end
-
-  describe "context" do
-    it "returns the created context" do
-      allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
-
-      Humid.create_context
-
-      expect(Humid.context).to be_kind_of(MiniRacer::Context)
-    end
-
-    context "when the js is stale and env is NOT dev`" do
-      it "does not recompile the JS" do
-        allow(Webpacker).to receive_message_chain("env.development?") { false }
-        allow(Webpacker).to receive_message_chain("compiler.stale?") { true }
-        allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
-
-        Humid.create_context
-        prev_context = Humid.context
-        expect(prev_context).to be_kind_of(MiniRacer::Context)
-
-        allow(Webpacker).to receive_message_chain("compiler.stale?") { true }
-
-        next_context = Humid.context
-
-        expect(prev_context).to eql(next_context)
-        expect(next_context).to be_kind_of(MiniRacer::Context)
-      end
-    end
-
-    context "when the env is development" do
-      it "compiles the JS when stale" do
-        allow(Webpacker).to receive_message_chain("env.development?") { true }
-        allow(Webpacker).to receive_message_chain("compiler.stale?") { true }
-        allow(Webpacker).to receive_message_chain("compiler.compile")
-        allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
-
-        Humid.create_context
-        prev_context = Humid.context
-        expect(prev_context).to be_kind_of(MiniRacer::Context)
-
-        allow(Webpacker).to receive_message_chain("compiler.stale?") { true }
-        # This simulates a changing file
-        allow(Humid.config).to receive("server_rendering_pack") { "simple_changed.js" }
-
-        next_context = Humid.context
-
-        expect(prev_context).to_not eql(next_context)
-        expect(next_context).to be_kind_of(MiniRacer::Context)
-      end
-
-      it "creates a new context when webpack-devserver already handled JS staleness" do
-        allow(Webpacker).to receive_message_chain("env.development?") { true }
-        allow(Webpacker).to receive_message_chain("compiler.stale?") { true }
-        allow(Webpacker).to receive_message_chain("compiler.compile")
-        allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
-
-        Humid.create_context
-        prev_context = Humid.context
-        expect(Humid.render).to eql("hello")
-        expect(prev_context).to be_kind_of(MiniRacer::Context)
-
-        allow(Webpacker).to receive_message_chain("compiler.stale?") { false }
-        # This simulates a changing file
-        allow(Humid.config).to receive("server_rendering_pack") { "simple_changed.js" }
-
-        next_context = Humid.context
-
-        expect(prev_context).to_not eql(next_context)
-        expect(next_context).to be_kind_of(MiniRacer::Context)
-        expect(Humid.render).to eql("hello changed")
-      end
-    end
-  end
-
-  describe "render" do
-    it "returns a js output" do
-      allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
-      Humid.create_context
-
-      expect(Humid.render).to eql("hello")
-    end
-
-    it "applys args to the func" do
-      allow(Humid.config).to receive("server_rendering_pack") { "args.js" }
-      Humid.create_context
-
-      args = ["a", 1, 2, [], {}]
-
-      expect(Humid.render(*args)).to eql({"0" => "a", "1" => 1, "2" => 2, "3" => [], "4" => {}})
-    end
-
-    it "can use source maps to see errors" do
-      allow(Humid.config).to receive("server_rendering_pack") { "reporting.js" }
-      allow(Humid.config).to receive("use_source_map") { true }
-
-      Humid.create_context
-
-      expect {
-        Humid.render
-      }.to raise_error { |error|
-        expect(error).to be_a(Humid::RenderError)
-        message = <<~MSG
-          Error: ^^ Look! These stack traces map to the actual source code :)
-          JavaScript at throwSomeError (/webpack:/app/javascript/packs/components/error-causing-component.js:2:1)
-          JavaScript at ErrorCausingComponent (/webpack:/app/javascript/packs/components/error-causing-component.js:8:1)
-          JavaScript at /webpack:/app/javascript/packs/reporting.js:18:1
-        MSG
-
-        expect(error.message).to eql message.strip
-      }
-    end
-
-    it "siliences render errors to the log" do
-      allow(Humid.config).to receive("server_rendering_pack") { "reporting.js" }
-      allow(Humid.config).to receive("raise_render_errors") { false }
-      allow(Humid.config).to receive("use_source_map") { true }
-
-      Humid.create_context
-
-      expect(Humid.logger).to receive(:error)
-      output = Humid.render
-
-      expect(output).to eql("")
-    end
-  end
-end