Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move assignment check to RubyLex #670

Merged
merged 1 commit into from
Aug 11, 2023
Merged

Move assignment check to RubyLex #670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 1 addition & 45 deletions lib/irb.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,30 +429,6 @@ def IRB.irb_abort(irb, exception = Abort)
end

class Irb
ASSIGNMENT_NODE_TYPES = [
# Local, instance, global, class, constant, instance, and index assignment:
# "foo = bar",
# "@foo = bar",
# "$foo = bar",
# "@@foo = bar",
# "::Foo = bar",
# "a::Foo = bar",
# "Foo = bar"
# "foo.bar = 1"
# "foo[1] = bar"
:assign,

# Operation assignment:
# "foo += bar"
# "foo -= bar"
# "foo ||= bar"
# "foo &&= bar"
:opassign,

# Multiple assignment:
# "foo, bar = 1, 2
:massign,
]
# Note: instance and index assignment expressions could also be written like:
# "foo.bar=(1)" and "foo.[]=(1, bar)", when expressed that way, the former
# be parsed as :assign and echo will be suppressed, but the latter is
Expand Down Expand Up @@ -555,11 +531,9 @@ def eval_input

@scanner.configure_io(@context.io)

@scanner.each_top_level_statement do |line, line_no|
@scanner.each_top_level_statement do |line, line_no, is_assignment|
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a plan to add end_with_semicolon_check and number of parameter will increase. Then it will look like this.

@scanner.each_top_level_statement do |line, line_no, is_a, is_b, is_c|

end

How about this?

@scanner.each_top_level_statement do |line, line_no| # line_no and line is always needed.
  # IMO optional information of `line` should be explicitly calculated here
  is_a = @scanner.check_a?(line)
  is_c = @scanner.check_c?(line)
  is_d = @scanner.check_d?(line)
end

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the assignment check, I think it's better to be handled from each_top_level_statement so it's always calculated before line evaluation. I'm fine using the suggested pattern for semicolon check though.

I was also thinking instead of returning individual information as the yielding argument, perhaps we can encapsulate them inside a Statement object? But I will explore it after this and #669 is merged.

signal_status(:IN_EVAL) do
begin
# Assignment expression check should be done before evaluate_line to handle code like `a /2#/ if false; a = 1`
is_assignment = assignment_expression?(line)
evaluate_line(line, line_no)

if @context.echo?
Expand Down Expand Up @@ -867,24 +841,6 @@ def inspect
end
format("#<%s: %s>", self.class, ary.join(", "))
end

def assignment_expression?(line)
# Try to parse the line and check if the last of possibly multiple
# expressions is an assignment type.

# If the expression is invalid, Ripper.sexp should return nil which will
# result in false being returned. Any valid expression should return an
# s-expression where the second element of the top level array is an
# array of parsed expressions. The first element of each expression is the
# expression's type.
verbose, $VERBOSE = $VERBOSE, nil
code = "#{RubyLex.generate_local_variables_assign_code(@context.local_variables) || 'nil;'}\n#{line}"
# Get the last node_type of the line. drop(1) is to ignore the local_variables_assign_code part.
node_type = Ripper.sexp(code)&.dig(1)&.drop(1)&.dig(-1, 0)
ASSIGNMENT_NODE_TYPES.include?(node_type)
ensure
$VERBOSE = verbose
end
end

def @CONF.inspect
Expand Down
44 changes: 43 additions & 1 deletion lib/irb/ruby-lex.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,30 @@

# :stopdoc:
class RubyLex
ASSIGNMENT_NODE_TYPES = [
# Local, instance, global, class, constant, instance, and index assignment:
# "foo = bar",
# "@foo = bar",
# "$foo = bar",
# "@@foo = bar",
# "::Foo = bar",
# "a::Foo = bar",
# "Foo = bar"
# "foo.bar = 1"
# "foo[1] = bar"
:assign,

# Operation assignment:
# "foo += bar"
# "foo -= bar"
# "foo ||= bar"
# "foo &&= bar"
:opassign,

# Multiple assignment:
# "foo, bar = 1, 2
:massign,
]

class TerminateLineInput < StandardError
def initialize
Expand Down Expand Up @@ -248,13 +272,31 @@ def each_top_level_statement

if code != "\n"
code.force_encoding(@io.encoding)
yield code, @line_no
yield code, @line_no, assignment_expression?(code)
end
@line_no += code.count("\n")
rescue TerminateLineInput
end
end

def assignment_expression?(line)
# Try to parse the line and check if the last of possibly multiple
# expressions is an assignment type.

# If the expression is invalid, Ripper.sexp should return nil which will
# result in false being returned. Any valid expression should return an
# s-expression where the second element of the top level array is an
# array of parsed expressions. The first element of each expression is the
# expression's type.
verbose, $VERBOSE = $VERBOSE, nil
code = "#{RubyLex.generate_local_variables_assign_code(@context.local_variables) || 'nil;'}\n#{line}"
# Get the last node_type of the line. drop(1) is to ignore the local_variables_assign_code part.
node_type = Ripper.sexp(code)&.dig(1)&.drop(1)&.dig(-1, 0)
ASSIGNMENT_NODE_TYPES.include?(node_type)
ensure
$VERBOSE = verbose
end

def should_continue?(tokens)
# Look at the last token and check if IRB need to continue reading next line.
# Example code that should continue: `a\` `a +` `a.`
Expand Down
53 changes: 0 additions & 53 deletions test/irb/test_context.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,59 +202,6 @@ def test_default_config
assert_equal(true, @context.use_autocomplete?)
end

def test_assignment_expression
input = TestInputMethod.new
irb = IRB::Irb.new(IRB::WorkSpace.new(Object.new), input)
[
"foo = bar",
"@foo = bar",
"$foo = bar",
"@@foo = bar",
"::Foo = bar",
"a::Foo = bar",
"Foo = bar",
"foo.bar = 1",
"foo[1] = bar",
"foo += bar",
"foo -= bar",
"foo ||= bar",
"foo &&= bar",
"foo, bar = 1, 2",
"foo.bar=(1)",
"foo; foo = bar",
"foo; foo = bar; ;\n ;",
"foo\nfoo = bar",
].each do |exp|
assert(
irb.assignment_expression?(exp),
"#{exp.inspect}: should be an assignment expression"
)
end

[
"foo",
"foo.bar",
"foo[0]",
"foo = bar; foo",
"foo = bar\nfoo",
].each do |exp|
refute(
irb.assignment_expression?(exp),
"#{exp.inspect}: should not be an assignment expression"
)
end
end

def test_assignment_expression_with_local_variable
input = TestInputMethod.new
irb = IRB::Irb.new(IRB::WorkSpace.new(Object.new), input)
code = "a /1;x=1#/"
refute(irb.assignment_expression?(code), "#{code}: should not be an assignment expression")
irb.context.workspace.binding.eval('a = 1')
assert(irb.assignment_expression?(code), "#{code}: should be an assignment expression")
refute(irb.assignment_expression?(""), "empty code should not be an assignment expression")
end

def test_echo_on_assignment
input = TestInputMethod.new([
"a = 1\n",
Expand Down
54 changes: 54 additions & 0 deletions test/irb/test_ruby_lex.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -813,6 +813,60 @@ def test_indent_level_with_heredoc_and_embdoc
assert_indent_level(code_with_embdoc.lines, expected)
end

def test_assignment_expression
context = build_context
ruby_lex = RubyLex.new(context)

[
"foo = bar",
"@foo = bar",
"$foo = bar",
"@@foo = bar",
"::Foo = bar",
"a::Foo = bar",
"Foo = bar",
"foo.bar = 1",
"foo[1] = bar",
"foo += bar",
"foo -= bar",
"foo ||= bar",
"foo &&= bar",
"foo, bar = 1, 2",
"foo.bar=(1)",
"foo; foo = bar",
"foo; foo = bar; ;\n ;",
"foo\nfoo = bar",
].each do |exp|
assert(
ruby_lex.assignment_expression?(exp),
"#{exp.inspect}: should be an assignment expression"
)
end

[
"foo",
"foo.bar",
"foo[0]",
"foo = bar; foo",
"foo = bar\nfoo",
].each do |exp|
refute(
ruby_lex.assignment_expression?(exp),
"#{exp.inspect}: should not be an assignment expression"
)
end
end

def test_assignment_expression_with_local_variable
context = build_context
ruby_lex = RubyLex.new(context)
code = "a /1;x=1#/"
refute(ruby_lex.assignment_expression?(code), "#{code}: should not be an assignment expression")
context.workspace.binding.eval('a = 1')
assert(ruby_lex.assignment_expression?(code), "#{code}: should be an assignment expression")
refute(ruby_lex.assignment_expression?(""), "empty code should not be an assignment expression")
end

private

def build_context(local_variables = nil)
Expand Down