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.

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

Transform multiline brace blocks to do/end blocks #407

Open
wants to merge 3 commits into
base: trunk
Choose a base branch
from
Open
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
4 changes: 2 additions & 2 deletions fixtures/small/block_local_variables_expected.rb
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
y = 12
lambda { |x, ;y|
lambda do |x, ;y|
puts(x)
puts(y)
y = 19
puts(y)
}
end
.call(17)
puts(y)

Expand Down
4 changes: 2 additions & 2 deletions fixtures/small/blocks_with_only_comments_expected.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ def foo
end

# More comments!!
commented_brace_block {
commented_brace_block do
# Such plainness of the pre-baroque
# Hardly involves the eye, until
# It meets his left-hand gauntlet, still
# Clasped empty in the other; and
# One sees, with a sharp tender shock,

# His hand withdrawn, holding her hand.
}
end

method_call
end
12 changes: 12 additions & 0 deletions fixtures/small/brace_to_do_blocks_actual.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
things.map { |thing| stuff; thing ** 2 }

things.map { |thing|
# A comment makes this multiline!
thing
}

class Foo
# !! `example_dsl [].map { |k| k; k+1 }` is not equivalent to
# !! `example_dsl [].map do |k| k; k+1 end`
example_dsl [].map { |k| k; k+1 }
end
20 changes: 20 additions & 0 deletions fixtures/small/brace_to_do_blocks_expected.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
things.map do |thing|
stuff
thing ** 2
end

things.map do |thing|
# A comment makes this multiline!
thing
end

class Foo
# !! `example_dsl [].map { |k| k; k+1 }` is not equivalent to
# !! `example_dsl [].map do |k| k; k+1 end`
example_dsl(
[].map do |k|
k
k + 1
end
)
end
4 changes: 2 additions & 2 deletions fixtures/small/curly_line_breaking_expected.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
do_something { |a| [a] }
do_something { |a|
do_something do |a|
[
1,
2,
Expand Down Expand Up @@ -105,4 +105,4 @@
3,
3
]
}
end
8 changes: 4 additions & 4 deletions fixtures/small/method_chains_expected.rb
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
returns_array
.map { |foo|
.map do |foo|
thing = foo.idk
thing.call
}
end
.chain do |bar|
bar.do_stuff!
end
Expand Down Expand Up @@ -110,10 +110,10 @@ def example
.foo
.bar
.baz
.map { |x|
.map do |x|
multiline
block
}
end
.bacon
.next_call(
a: "",
Expand Down
4 changes: 2 additions & 2 deletions fixtures/small/multiline_chain_in_block_expected.rb
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
sig {
sig do
params(
route: String
).void
}
end
def ajax_get(route)
super
end
15 changes: 14 additions & 1 deletion librubyfmt/src/format.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3072,7 +3072,20 @@ fn should_multiline_call_chain(ps: &mut dyn ConcreteParserState, method_call: &M
}

pub fn format_block(ps: &mut dyn ConcreteParserState, b: Block) {
match b {
let block = match b {
Block::DoBlock(..) => b,
Block::BraceBlock(bb) => {
// Transform multiline BraceBlocks into do/end blocks
if bb.2.len() > 1
|| ps.will_render_as_multiline(Box::new(|ps| format_brace_block(ps, bb.clone())))
{
Block::DoBlock(bb.into_do_block())
} else {
Block::BraceBlock(bb)
}
}
};
match block {
Block::BraceBlock(bb) => format_brace_block(ps, bb),
Block::DoBlock(db) => format_do_block(ps, db),
}
Expand Down
11 changes: 11 additions & 0 deletions librubyfmt/src/ripper_tree_types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1912,6 +1912,17 @@ pub struct BraceBlock(
pub StartEnd,
);

impl BraceBlock {
pub fn into_do_block(self) -> DoBlock {
DoBlock(
do_block_tag,
self.1,
Box::new(BodyStmt(bodystmt_tag, self.2, None, None, None)),
self.3,
)
}
}

def_tag!(while_tag, "while");
#[derive(Deserialize, Debug, Clone)]
pub struct While(
Expand Down