Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 23 additions & 9 deletions lib/herb/engine.rb
Original file line number Diff line number Diff line change
Expand Up @@ -148,15 +148,7 @@ def initialize(input, properties = {})
@src << "; ensure\n #{@bufvar} = __original_outvar\nend\n" if properties[:ensure]

if properties.fetch(:validate_ruby, false)
require "prism"

prism_result = Prism.parse(@src)
syntax_errors = prism_result.errors.reject { |e| e.type == :invalid_yield }

if syntax_errors.any?
details = syntax_errors.map { |e| " - #{e.message} (line #{e.location.start_line})" }.join("\n")
raise InvalidRubyError.new("Compiled template produced invalid Ruby:\n#{details}", compiled_source: @src)
end
ensure_valid_ruby!(@src)
end

@src.freeze
Expand Down Expand Up @@ -440,5 +432,27 @@ def add_parser_error_overlay(parser_errors, input)
def default_visitors
[]
end

def ensure_valid_ruby!(source)
RubyVM::InstructionSequence.compile(source)
rescue SyntaxError => e
return if e.message.include?("Invalid yield")

begin
require "prism"
rescue LoadError
# Prism not available, fall through
end

raise InvalidRubyError.new("Compiled template produced invalid Ruby:\n - #{e.message}", compiled_source: @src) unless defined?(Prism)

prism_result = Prism.parse(@src)
syntax_errors = prism_result.errors.reject { |error| error.type == :invalid_yield }

if syntax_errors.any?
details = syntax_errors.map { |err| " - #{err.message} (line #{err.location.start_line})" }.join("\n")
raise InvalidRubyError.new("Compiled template produced invalid Ruby:\n#{details}", compiled_source: @src)
end
end
end
end
6 changes: 5 additions & 1 deletion lib/herb/prism_inspect.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ class << self
def inspect_prism_serialized(serialized_bytes, source, prefix)
return "∅" unless serialized_bytes

require "prism"
begin
require "prism"
rescue LoadError
return "(#{serialized_bytes.bytesize} bytes, prism gem not available)"
end

node = Prism.load(source, serialized_bytes).value
return "∅" unless node
Expand Down
2 changes: 2 additions & 0 deletions sig/herb/engine.rbs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions sig/rubyvm.rbs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 7 additions & 1 deletion templates/lib/herb/ast/nodes.rb.erb
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,13 @@ module Herb
return nil unless prism_node
return nil unless source

require "prism"
begin
require "prism"
rescue LoadError
warn "The 'prism' gem is required to deserialize Prism nodes. Add it to your Gemfile or install it with: gem install prism"
return nil
end

Prism.load(source, prism_node).value
end

Expand Down
30 changes: 30 additions & 0 deletions test/engine/engine_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -237,5 +237,35 @@ class EngineTest < Minitest::Spec

assert_compiled_snapshot(template)
end

test "validate_ruby passes for valid Ruby" do
template = <<~ERB
<% if true %>
<div>Hello</div>
<% end %>
ERB

engine = Herb::Engine.new(template, validate_ruby: true)
assert engine.src
end

test "validate_ruby raises InvalidRubyError for invalid compiled Ruby" do
engine = Herb::Engine.allocate
engine.instance_variable_set(:@src, "def foo(")

error = assert_raises(Herb::Engine::InvalidRubyError) do
engine.send(:ensure_valid_ruby!, "def foo(")
end

assert_match(/Compiled template produced invalid Ruby/, error.message)
assert error.compiled_source
end

test "validate_ruby does not raise for valid compiled Ruby" do
engine = Herb::Engine.allocate
engine.instance_variable_set(:@src, "def foo; end")

engine.send(:ensure_valid_ruby!, "def foo; end")
end
end
end
Loading