Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
694 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
# frozen_string_literal: true | ||
|
||
require 'rainbow' | ||
|
||
module RuboCop | ||
module AST | ||
class NodePattern | ||
class Compiler | ||
# Variant of the Compiler with tracing information for nodes | ||
class Debug < Compiler | ||
attr_reader :trace, :node_ids | ||
|
||
# @api private | ||
Colorizer = Struct.new(:compiler) do # rubocop:disable Metrics/BlockLength | ||
def colorize(ast, color_map: self.color_map(ast)) | ||
ast.loc.expression.source_buffer.source.chars.map.with_index do |char, i| | ||
Rainbow(char).color((color_map[i] || COLORS[:not_visitable])) | ||
end.join | ||
end | ||
|
||
def color_map(ast) | ||
ast.each_descendant | ||
.map { |node| color_map_for(node) } | ||
.inject(color_map_for(ast), :merge) | ||
end | ||
|
||
private | ||
|
||
COLORS = { | ||
not_visited: :yellow, | ||
not_visitable: :lightseagreen, | ||
nil => :red, | ||
true => :green | ||
}.freeze | ||
|
||
def color_map_for(node) | ||
return {} unless (range = node.loc&.expression) | ||
|
||
color = COLORS.fetch(visited(node)) | ||
range.to_a.to_h { |char| [char, color] } | ||
end | ||
|
||
def visited(node) | ||
id = compiler.node_ids.fetch(node) { return :not_visitable } | ||
return :not_visited unless compiler.trace[:enter][id] | ||
|
||
compiler.trace[:success][id] | ||
end | ||
end | ||
def initialize | ||
super | ||
@node_ids = Hash.new { |h, k| h[k] = h.size }.compare_by_identity | ||
@trace = { enter: {}, success: {} } | ||
end | ||
|
||
def named_parameters | ||
super << :trace | ||
end | ||
|
||
def parser | ||
Parser::WithMeta | ||
end | ||
|
||
# @api private | ||
module InstrumentationSubcompiler | ||
def do_compile | ||
"#{tracer(:enter)} && #{super} && #{tracer(:success)}" | ||
end | ||
|
||
private | ||
|
||
def tracer(kind) | ||
id = compiler.node_ids[node] | ||
"(trace[:#{kind}][#{id}] ||= true)" | ||
end | ||
end | ||
|
||
# @api private | ||
class NodePatternSubcompiler < Compiler::NodePatternSubcompiler | ||
include InstrumentationSubcompiler | ||
end | ||
|
||
# @api private | ||
class SequenceSubcompiler < Compiler::SequenceSubcompiler | ||
include InstrumentationSubcompiler | ||
end | ||
end | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module AST | ||
class NodePattern | ||
class Parser | ||
# Overrides Parser to use `WithMeta` variants and provide additional methods | ||
class WithMeta < Parser | ||
# Overrides Lexer to token locations and comments | ||
class Lexer < NodePattern::Lexer | ||
attr_reader :source_buffer | ||
|
||
def initialize(str_or_buffer) | ||
@source_buffer = if str_or_buffer.respond_to?(:source) | ||
str_or_buffer | ||
else | ||
::Parser::Source::Buffer.new('(string)', source: str_or_buffer) | ||
end | ||
@comments = [] | ||
super(@source_buffer.source) | ||
end | ||
|
||
def token(type, value) | ||
super(type, [value, pos]) | ||
end | ||
|
||
def emit_comment | ||
@comments << Comment.new(pos) | ||
super | ||
end | ||
|
||
# @return [::Parser::Source::Range] last match's position | ||
def pos | ||
::Parser::Source::Range.new(source_buffer, ss.pos - ss.matched_size, ss.pos) | ||
end | ||
end | ||
|
||
# Overrides Builder to emit nodes with locations | ||
class Builder < NodePattern::Builder | ||
def emit_atom(type, token) | ||
value, loc = token | ||
begin_l = loc.resize(1) | ||
end_l = loc.end.adjust(begin_pos: -1) | ||
begin_l = nil if begin_l.source.match?(/\w/) | ||
end_l = nil if end_l.source.match?(/\w/) | ||
n(type, [value], source_map(token, begin_t: begin_l, end_t: end_l)) | ||
end | ||
|
||
def emit_unary_op(type, operator_t = nil, *children) | ||
children[-1] = children[-1].first if children[-1].is_a?(Array) # token? | ||
map = source_map(children.first.loc.expression, operator_t: operator_t) | ||
n(type, children, map) | ||
end | ||
|
||
def emit_list(type, begin_t, children, end_t) | ||
expr = children.first.loc.expression.join(children.last.loc.expression) | ||
map = source_map(expr, begin_t: begin_t, end_t: end_t) | ||
n(type, children, map) | ||
end | ||
|
||
def emit_call(type, selector_t, args = nil) | ||
selector, = selector_t | ||
begin_t, arg_nodes, end_t = args | ||
|
||
map = source_map(selector_t, begin_t: begin_t, end_t: end_t, selector_t: selector_t) | ||
n(type, [selector, *arg_nodes], map) | ||
end | ||
|
||
private | ||
|
||
def n(type, children, source_map) | ||
super(type, children, { location: source_map }) | ||
end | ||
|
||
def loc(token_or_range) | ||
return token_or_range[1] if token_or_range.is_a?(Array) | ||
|
||
token_or_range | ||
end | ||
|
||
def join_exprs(left_expr, right_expr) | ||
left_expr.loc.expression | ||
.join(right_expr.loc.expression) | ||
end | ||
|
||
def source_map(token_or_range, begin_t: nil, end_t: nil, operator_t: nil, selector_t: nil) | ||
expression_l = loc(token_or_range) | ||
expression_l = expression_l.expression if expression_l.respond_to?(:expression) | ||
locs = [begin_t, end_t, operator_t, selector_t].map { |token| loc(token) } | ||
begin_l, end_l, operator_l, selector_l = locs | ||
|
||
expression_l = locs.compact.inject(expression_l, :join) | ||
|
||
::Parser::Source::Map::Send.new(_dot_l = nil, selector_l, begin_l, end_l, expression_l) | ||
.with_operator(operator_l) | ||
end | ||
end | ||
|
||
## | ||
# (Similar API to `parser` gem) | ||
# Parses a source and returns the AST and the source code comments. | ||
# | ||
# @see #parse | ||
# @return [Array] | ||
# | ||
def parse_with_comments(_source) | ||
parse(source_buffer) do |ast, lexer| | ||
[ast, lexer.comments, lexer.tokens] | ||
end | ||
end | ||
|
||
## | ||
# (Similar API to `parser` gem) | ||
# Parses a source and returns the AST, the source code comments, | ||
# and the tokens emitted by the lexer. | ||
# | ||
# @param [Parser::Source::Buffer, String] source | ||
# @param [Boolean] recover If true, recover from syntax errors. False by default. | ||
# @return [Array] | ||
# | ||
def tokenize(source) | ||
parse(source) do |ast, lexer| | ||
[ast, lexer.comments, lexer.tokens] | ||
end | ||
end | ||
end | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,28 @@ | ||
# frozen_string_literal: true | ||
|
||
require_relative 'parse_helper' | ||
|
||
Failure = Struct.new(:expected, :actual) | ||
|
||
module NodePatternHelper | ||
include ParseHelper | ||
|
||
def assert_equal(expected, actual, mess = nil) | ||
expect(actual).to eq(expected), *mess | ||
end | ||
|
||
def assert(test, mess = nil) | ||
expect(test).to eq(true), *mess | ||
end | ||
|
||
def expect_parsing(ast, source, source_maps) | ||
version = '-' | ||
try_parsing(ast, source, parser, source_maps, version) | ||
end | ||
end | ||
|
||
RSpec.shared_context 'parser' do | ||
let(:parser) { RuboCop::AST::NodePattern::Parser.new } | ||
include NodePatternHelper | ||
|
||
let(:parser) { RuboCop::AST::NodePattern::Parser::WithMeta.new } | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.