-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix missing line break due to puts logic
In #225 it was reported that the output looks incorrect: ``` $ cat /tmp/4a71c7e417cc9eac0971e3a2519b295c/scratch.rb def x.y.z end $ ruby /tmp/4a71c7e417cc9eac0971e3a2519b295c/scratch.rb /tmp/4a71c7e417cc9eac0971e3a2519b295c/scratch.rb: --> /tmp/4a71c7e417cc9eac0971e3a2519b295c/scratch.rb expected a delimiter to close the parametersunexpected '.', ignoring it > 1 def x.y.z > 2 end ``` Specifically: ``` expected a delimiter to close the parametersunexpected '.', ignoring it ``` However this does not show up when executing the debug executable: ``` $ bin/bundle exec exe/syntax_suggest /tmp/4a71c7e417cc9eac0971e3a2519b295c/scratch.rb --> /tmp/4a71c7e417cc9eac0971e3a2519b295c/scratch.rb expected a delimiter to close the parameters unexpected '.', ignoring it > 1 def x.y.z > 2 end ``` This is because `exe/syntax_suggest` uses STDOUT.puts while calling `ruby` with the filename uses a fake IO object represented by MiniStringIO. This class was incorrectly not adding a newline to the end of the print. The fix was to move the class to it's own file where it can be tested and then fix the behavior. close #225 Co-authored-by: Andy Yong <[email protected]>
- Loading branch information
Showing
5 changed files
with
52 additions
and
18 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
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,24 @@ | ||
module SyntaxSuggest | ||
# Mini String IO [Private] | ||
# | ||
# Acts like a StringIO with reduced API, but without having to require that | ||
# class. | ||
class MiniStringIO | ||
EMPTY_ARG = Object.new | ||
|
||
def initialize(isatty: $stderr.isatty) | ||
@string = +"" | ||
@isatty = isatty | ||
end | ||
|
||
attr_reader :isatty | ||
def puts(value = EMPTY_ARG, **) | ||
if !value.equal?(EMPTY_ARG) | ||
@string << value | ||
end | ||
@string << $/ | ||
end | ||
|
||
attr_reader :string | ||
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,25 @@ | ||
# frozen_string_literal: true | ||
|
||
require_relative "../spec_helper" | ||
|
||
module SyntaxSuggest | ||
RSpec.describe "MiniStringIO" do | ||
it "#puts with no inputs" do | ||
io = MiniStringIO.new | ||
io.puts | ||
expect(io.string).to eq($/) | ||
end | ||
|
||
it "#puts with an input" do | ||
io = MiniStringIO.new | ||
io.puts "Hello" | ||
expect(io.string).to eq(["Hello", $/].join) | ||
end | ||
|
||
it "#puts with an input with a newline" do | ||
io = MiniStringIO.new | ||
io.puts "Hello\n" | ||
expect(io.string).to eq(["Hello\n", $/].join) | ||
end | ||
end | ||
end |