1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
# typed: true
# frozen_string_literal: true
require "test_helper"
class FormattingTest < Minitest::Test
def setup
@global_state = RubyLsp::GlobalState.new
@global_state.formatter = "rubocop"
@global_state.register_formatter(
"rubocop",
RubyLsp::Requests::Support::RuboCopFormatter.new,
)
@global_state.register_formatter(
"syntax_tree",
RubyLsp::Requests::Support::SyntaxTreeFormatter.new,
)
source = +<<~RUBY
class Foo
def foo
end
end
RUBY
@uri = URI::Generic.from_path(path: __FILE__)
@document = RubyLsp::RubyDocument.new(source: source, version: 1, uri: @uri, global_state: @global_state)
end
def test_formats_with_rubocop
assert_equal(<<~RUBY, formatted_document("rubocop"))
# typed: true
# frozen_string_literal: true
class Foo
def foo
end
end
RUBY
end
def test_formats_with_syntax_tree
assert_equal(<<~RUBY, formatted_document("syntax_tree"))
class Foo
def foo
end
end
RUBY
end
def test_does_not_format_with_formatter_is_none
original_formatter = @global_state.formatter
@global_state.formatter = "none"
document = RubyLsp::RubyDocument.new(source: "def foo", version: 1, uri: @uri, global_state: @global_state)
assert_nil(RubyLsp::Requests::Formatting.new(@global_state, document).perform)
ensure
@global_state.formatter = original_formatter
end
def test_syntax_tree_formatting_uses_options_from_streerc
config_contents = <<~TXT
--print-width=100
--plugins=plugin/trailing_comma
TXT
with_syntax_tree_config_file(config_contents) do
@document = RubyLsp::RubyDocument.new(source: +<<~RUBY, version: 1, uri: @uri, global_state: @global_state)
class Foo
def foo
{one: "#{"a" * 50}", two: "#{"b" * 50}"}
SomeClass.with(arguments).and_more_methods.some_are_wordy.who_is_demeter_again?
end
end
RUBY
assert_equal(<<~RUBY, formatted_document("syntax_tree"))
class Foo
def foo
{
one: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
two: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
}
SomeClass.with(arguments).and_more_methods.some_are_wordy.who_is_demeter_again?
end
end
RUBY
end
end
def test_syntax_tree_formatting_ignores_syntax_invalid_documents
require "ruby_lsp/requests/formatting"
@global_state.formatter = "syntax_tree"
document = RubyLsp::RubyDocument.new(source: "def foo", version: 1, uri: @uri, global_state: @global_state)
assert_nil(RubyLsp::Requests::Formatting.new(@global_state, document).perform)
end
def test_syntax_tree_formatting_returns_nil_if_file_matches_ignore_files_options_from_streerc
config_contents = <<~TXT
--ignore-files=#{Pathname.new(__FILE__).relative_path_from(Dir.pwd)}
TXT
with_syntax_tree_config_file(config_contents) do
@document = RubyLsp::RubyDocument.new(source: +<<~RUBY, version: 1, uri: @uri, global_state: @global_state)
class Foo
def foo
end
end
RUBY
assert_nil(formatted_document("syntax_tree"))
end
end
def test_rubocop_formatting_ignores_syntax_invalid_documents
document = RubyLsp::RubyDocument.new(source: "def foo", version: 1, uri: @uri, global_state: @global_state)
assert_nil(RubyLsp::Requests::Formatting.new(@global_state, document).perform)
end
def test_returns_nil_if_document_is_already_formatted
document = RubyLsp::RubyDocument.new(source: +<<~RUBY, version: 1, uri: @uri, global_state: @global_state)
# typed: strict
# frozen_string_literal: true
class Foo
def foo
end
end
RUBY
assert_nil(RubyLsp::Requests::Formatting.new(@global_state, document).perform)
end
def test_allows_specifying_formatter
SyntaxTree
.expects(:format)
.with(
@document.source,
instance_of(Integer),
has_entry(options: instance_of(SyntaxTree::Formatter::Options)),
)
.once
formatted_document("syntax_tree")
end
def test_returns_nil_when_formatter_is_invalid
assert_nil(formatted_document("invalid"))
end
def test_using_a_custom_formatter
formatter_class = Class.new do
include RubyLsp::Requests::Support::Formatter
def run_formatting(uri, document)
"#{document.source}\n# formatter by my-custom-formatter"
end
end
@global_state.register_formatter("my-custom-formatter", formatter_class.new)
assert_includes(formatted_document("my-custom-formatter"), "# formatter by my-custom-formatter")
end
def test_returns_nil_when_formatter_is_none
assert_nil(formatted_document("none"))
end
private
def formatted_document(formatter)
@global_state.formatter = formatter
RubyLsp::Requests::Formatting.new(@global_state, @document).perform&.first&.new_text
end
def with_syntax_tree_config_file(contents)
filepath = File.join(Dir.pwd, ".streerc")
File.write(filepath, contents)
formatter_with_options = RubyLsp::Requests::Support::SyntaxTreeFormatter.new
@global_state.stubs(:active_formatter).returns(formatter_with_options)
yield
ensure
FileUtils.rm(filepath) if filepath
end
end
|
