refract 1.2.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +30 -1
- data/lib/refract/basic_visitor.rb +3 -1
- data/lib/refract/converter.rb +37 -31
- data/lib/refract/formatter.rb +665 -312
- data/lib/refract/mutation_visitor.rb +8 -3
- data/lib/refract/nodes/alias_global_variable_node.rb +1 -1
- data/lib/refract/nodes/alias_method_node.rb +1 -1
- data/lib/refract/nodes/alternation_pattern_node.rb +1 -1
- data/lib/refract/nodes/and_node.rb +1 -1
- data/lib/refract/nodes/arguments_node.rb +1 -1
- data/lib/refract/nodes/array_node.rb +1 -1
- data/lib/refract/nodes/array_pattern_node.rb +1 -1
- data/lib/refract/nodes/assoc_node.rb +1 -1
- data/lib/refract/nodes/assoc_splat_node.rb +1 -1
- data/lib/refract/nodes/back_reference_read_node.rb +1 -1
- data/lib/refract/nodes/begin_node.rb +1 -1
- data/lib/refract/nodes/block_argument_node.rb +1 -1
- data/lib/refract/nodes/block_local_variable_node.rb +1 -1
- data/lib/refract/nodes/block_node.rb +1 -1
- data/lib/refract/nodes/block_parameter_node.rb +1 -1
- data/lib/refract/nodes/block_parameters_node.rb +1 -1
- data/lib/refract/nodes/break_node.rb +1 -1
- data/lib/refract/nodes/call_and_write_node.rb +1 -1
- data/lib/refract/nodes/call_node.rb +1 -1
- data/lib/refract/nodes/call_operator_write_node.rb +1 -1
- data/lib/refract/nodes/call_or_write_node.rb +1 -1
- data/lib/refract/nodes/call_target_node.rb +3 -2
- data/lib/refract/nodes/capture_pattern_node.rb +1 -1
- data/lib/refract/nodes/case_match_node.rb +1 -1
- data/lib/refract/nodes/case_node.rb +1 -1
- data/lib/refract/nodes/class_node.rb +1 -1
- data/lib/refract/nodes/class_variable_and_write_node.rb +1 -1
- data/lib/refract/nodes/class_variable_operator_write_node.rb +1 -1
- data/lib/refract/nodes/class_variable_or_write_node.rb +1 -1
- data/lib/refract/nodes/class_variable_read_node.rb +1 -1
- data/lib/refract/nodes/class_variable_target_node.rb +1 -1
- data/lib/refract/nodes/class_variable_write_node.rb +1 -1
- data/lib/refract/nodes/constant_and_write_node.rb +1 -1
- data/lib/refract/nodes/constant_operator_write_node.rb +1 -1
- data/lib/refract/nodes/constant_or_write_node.rb +1 -1
- data/lib/refract/nodes/constant_path_and_write_node.rb +1 -1
- data/lib/refract/nodes/constant_path_node.rb +1 -1
- data/lib/refract/nodes/constant_path_operator_write_node.rb +1 -1
- data/lib/refract/nodes/constant_path_or_write_node.rb +1 -1
- data/lib/refract/nodes/constant_path_target_node.rb +1 -1
- data/lib/refract/nodes/constant_path_write_node.rb +1 -1
- data/lib/refract/nodes/constant_read_node.rb +1 -1
- data/lib/refract/nodes/constant_target_node.rb +1 -1
- data/lib/refract/nodes/constant_write_node.rb +1 -1
- data/lib/refract/nodes/def_node.rb +1 -1
- data/lib/refract/nodes/defined_node.rb +1 -1
- data/lib/refract/nodes/else_node.rb +1 -1
- data/lib/refract/nodes/embedded_statements_node.rb +1 -1
- data/lib/refract/nodes/embedded_variable_node.rb +1 -1
- data/lib/refract/nodes/ensure_node.rb +1 -1
- data/lib/refract/nodes/find_pattern_node.rb +1 -1
- data/lib/refract/nodes/flip_flop_node.rb +1 -1
- data/lib/refract/nodes/float_node.rb +1 -1
- data/lib/refract/nodes/for_node.rb +1 -1
- data/lib/refract/nodes/forwarding_super_node.rb +1 -1
- data/lib/refract/nodes/global_variable_and_write_node.rb +1 -1
- data/lib/refract/nodes/global_variable_operator_write_node.rb +1 -1
- data/lib/refract/nodes/global_variable_or_write_node.rb +1 -1
- data/lib/refract/nodes/global_variable_read_node.rb +1 -1
- data/lib/refract/nodes/global_variable_target_node.rb +1 -1
- data/lib/refract/nodes/global_variable_write_node.rb +1 -1
- data/lib/refract/nodes/hash_node.rb +1 -1
- data/lib/refract/nodes/hash_pattern_node.rb +1 -1
- data/lib/refract/nodes/if_node.rb +1 -1
- data/lib/refract/nodes/imaginary_node.rb +1 -1
- data/lib/refract/nodes/implicit_node.rb +1 -1
- data/lib/refract/nodes/in_node.rb +1 -1
- data/lib/refract/nodes/index_and_write_node.rb +1 -1
- data/lib/refract/nodes/index_operator_write_node.rb +1 -1
- data/lib/refract/nodes/index_or_write_node.rb +1 -1
- data/lib/refract/nodes/index_target_node.rb +1 -1
- data/lib/refract/nodes/instance_variable_and_write_node.rb +1 -1
- data/lib/refract/nodes/instance_variable_operator_write_node.rb +1 -1
- data/lib/refract/nodes/instance_variable_or_write_node.rb +1 -1
- data/lib/refract/nodes/instance_variable_read_node.rb +1 -1
- data/lib/refract/nodes/instance_variable_target_node.rb +1 -1
- data/lib/refract/nodes/instance_variable_write_node.rb +1 -1
- data/lib/refract/nodes/integer_node.rb +1 -1
- data/lib/refract/nodes/interpolated_match_last_line_node.rb +1 -1
- data/lib/refract/nodes/interpolated_regular_expression_node.rb +1 -1
- data/lib/refract/nodes/interpolated_string_node.rb +1 -1
- data/lib/refract/nodes/interpolated_symbol_node.rb +1 -1
- data/lib/refract/nodes/interpolated_x_string_node.rb +1 -1
- data/lib/refract/nodes/keyword_hash_node.rb +1 -1
- data/lib/refract/nodes/keyword_rest_parameter_node.rb +1 -1
- data/lib/refract/nodes/lambda_node.rb +1 -1
- data/lib/refract/nodes/local_variable_and_write_node.rb +1 -1
- data/lib/refract/nodes/local_variable_operator_write_node.rb +1 -1
- data/lib/refract/nodes/local_variable_or_write_node.rb +1 -1
- data/lib/refract/nodes/local_variable_read_node.rb +3 -2
- data/lib/refract/nodes/local_variable_target_node.rb +3 -2
- data/lib/refract/nodes/local_variable_write_node.rb +3 -2
- data/lib/refract/nodes/match_last_line_node.rb +1 -1
- data/lib/refract/nodes/match_predicate_node.rb +1 -1
- data/lib/refract/nodes/match_required_node.rb +1 -1
- data/lib/refract/nodes/match_write_node.rb +1 -1
- data/lib/refract/nodes/module_node.rb +1 -1
- data/lib/refract/nodes/multi_target_node.rb +1 -1
- data/lib/refract/nodes/multi_write_node.rb +1 -1
- data/lib/refract/nodes/next_node.rb +1 -1
- data/lib/refract/nodes/numbered_reference_read_node.rb +1 -1
- data/lib/refract/nodes/optional_keyword_parameter_node.rb +1 -1
- data/lib/refract/nodes/optional_parameter_node.rb +1 -1
- data/lib/refract/nodes/or_node.rb +1 -1
- data/lib/refract/nodes/parameters_node.rb +1 -1
- data/lib/refract/nodes/parentheses_node.rb +1 -1
- data/lib/refract/nodes/pinned_expression_node.rb +1 -1
- data/lib/refract/nodes/pinned_variable_node.rb +1 -1
- data/lib/refract/nodes/post_execution_node.rb +1 -1
- data/lib/refract/nodes/pre_execution_node.rb +1 -1
- data/lib/refract/nodes/program_node.rb +1 -1
- data/lib/refract/nodes/range_node.rb +1 -1
- data/lib/refract/nodes/rational_node.rb +1 -1
- data/lib/refract/nodes/regular_expression_node.rb +1 -1
- data/lib/refract/nodes/required_keyword_parameter_node.rb +1 -1
- data/lib/refract/nodes/required_parameter_node.rb +1 -1
- data/lib/refract/nodes/rescue_modifier_node.rb +1 -1
- data/lib/refract/nodes/rescue_node.rb +1 -1
- data/lib/refract/nodes/rest_parameter_node.rb +1 -1
- data/lib/refract/nodes/return_node.rb +1 -1
- data/lib/refract/nodes/shareable_constant_node.rb +1 -1
- data/lib/refract/nodes/singleton_class_node.rb +1 -1
- data/lib/refract/nodes/splat_node.rb +1 -1
- data/lib/refract/nodes/statements_node.rb +1 -1
- data/lib/refract/nodes/string_node.rb +1 -1
- data/lib/refract/nodes/super_node.rb +1 -1
- data/lib/refract/nodes/symbol_node.rb +1 -1
- data/lib/refract/nodes/undef_node.rb +1 -1
- data/lib/refract/nodes/unless_node.rb +1 -1
- data/lib/refract/nodes/until_node.rb +1 -1
- data/lib/refract/nodes/when_node.rb +1 -1
- data/lib/refract/nodes/while_node.rb +1 -1
- data/lib/refract/nodes/x_string_node.rb +1 -1
- data/lib/refract/nodes/yield_node.rb +1 -1
- data/lib/refract/version.rb +1 -1
- data/lib/refract/visitor.rb +2 -2
- data/lib/refract.rb +49 -30
- data/lib/rubocop/cop/refract/ordered_visit_methods.rb +12 -84
- metadata +4 -4
data/lib/refract/visitor.rb
CHANGED
data/lib/refract.rb
CHANGED
|
@@ -5,31 +5,66 @@ require "zeitwerk"
|
|
|
5
5
|
|
|
6
6
|
module Refract
|
|
7
7
|
Loader = Zeitwerk::Loader.for_gem.tap do |loader|
|
|
8
|
-
loader.ignore("#{__dir__}/ruby_lsp")
|
|
9
8
|
loader.ignore("#{__dir__}/rubocop")
|
|
10
|
-
loader.collapse("#{__dir__}/refract/errors")
|
|
11
9
|
loader.collapse("#{__dir__}/refract/nodes")
|
|
12
10
|
loader.setup
|
|
13
11
|
end
|
|
14
12
|
|
|
15
13
|
class Node
|
|
16
14
|
def self.type
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
15
|
+
@type ||= begin
|
|
16
|
+
raise ArgumentError, "Anonymous node classes have no type. Assign #{self} to a constant before using it." unless name
|
|
17
|
+
|
|
18
|
+
name.split("::").last.gsub(/(?<=[A-Z])(?=[A-Z][a-z])|(?<=[a-z\d])(?=[A-Z])/, "_").downcase.freeze
|
|
19
|
+
end
|
|
20
20
|
end
|
|
21
21
|
|
|
22
|
-
def self.
|
|
23
|
-
|
|
22
|
+
def self.visit_method
|
|
23
|
+
@visit_method ||= :"visit_#{type}"
|
|
24
|
+
end
|
|
24
25
|
|
|
25
|
-
|
|
26
|
+
def self.attributes
|
|
27
|
+
@attributes ||= instance_method(:initialize).parameters.flat_map do |parameter|
|
|
26
28
|
case parameter
|
|
27
|
-
in [:key | :keyreq, :prism_node] then
|
|
28
|
-
in [:key | :keyreq, name] then name
|
|
29
|
+
in [:key | :keyreq, :prism_node] then []
|
|
30
|
+
in [:key | :keyreq, name] then [name]
|
|
31
|
+
in [:keyrest, *] then superclass.attributes
|
|
32
|
+
in [:rest | :block, *] then []
|
|
33
|
+
end
|
|
34
|
+
end.uniq.freeze
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
def self.inherited(node_class)
|
|
38
|
+
super
|
|
39
|
+
|
|
40
|
+
if node_class.name
|
|
41
|
+
node_class.class_eval("def accept(visitor) = visitor.#{node_class.visit_method}(self)", __FILE__, __LINE__)
|
|
42
|
+
else
|
|
43
|
+
node_class.define_method(:accept, Node.instance_method(:accept))
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
def self.method_added(method_name)
|
|
48
|
+
super
|
|
49
|
+
return unless :initialize == method_name
|
|
50
|
+
|
|
51
|
+
@attributes = nil
|
|
52
|
+
class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
|
|
53
|
+
# frozen_string_literal: true
|
|
54
|
+
|
|
55
|
+
def copy(#{attributes.map { |name| "#{name}: @#{name}" }.join(', ')})
|
|
56
|
+
self.class.new(prism_node: @prism_node, #{attributes.map { |name| "#{name}:" }.join(', ')})
|
|
29
57
|
end
|
|
30
|
-
|
|
58
|
+
|
|
59
|
+
def freeze
|
|
60
|
+
#{attributes.map { |name| "@#{name}.freeze if Array === @#{name} || Hash === @#{name} || String === @#{name}" }.join("\n")}
|
|
61
|
+
super
|
|
62
|
+
end
|
|
63
|
+
RUBY
|
|
31
64
|
end
|
|
32
65
|
|
|
66
|
+
attr_reader :prism_node
|
|
67
|
+
|
|
33
68
|
def type
|
|
34
69
|
self.class.type
|
|
35
70
|
end
|
|
@@ -46,32 +81,16 @@ module Refract
|
|
|
46
81
|
end
|
|
47
82
|
|
|
48
83
|
def accept(visitor)
|
|
49
|
-
self.class.
|
|
50
|
-
# frozen_string_literal: true
|
|
51
|
-
|
|
52
|
-
def accept(visitor)
|
|
53
|
-
visitor.visit_#{type}(self)
|
|
54
|
-
end
|
|
55
|
-
RUBY
|
|
56
|
-
|
|
57
|
-
accept(visitor)
|
|
84
|
+
visitor.__send__(self.class.visit_method, self)
|
|
58
85
|
end
|
|
59
86
|
|
|
60
87
|
def start_line
|
|
61
88
|
@prism_node&.location&.start_line
|
|
62
89
|
end
|
|
63
|
-
|
|
64
|
-
def copy(**props)
|
|
65
|
-
duplicate = dup
|
|
66
|
-
|
|
67
|
-
props.each do |k, v|
|
|
68
|
-
duplicate.public_send("#{k}=", v)
|
|
69
|
-
end
|
|
70
|
-
|
|
71
|
-
duplicate.freeze
|
|
72
|
-
end
|
|
73
90
|
end
|
|
74
91
|
|
|
92
|
+
extend self
|
|
93
|
+
|
|
75
94
|
def format_node(node)
|
|
76
95
|
Formatter.new.format_node(node).source
|
|
77
96
|
end
|
|
@@ -8,98 +8,26 @@ module RuboCop
|
|
|
8
8
|
|
|
9
9
|
MSG = "Visit blocks should be sorted alphabetically by node type. Expected `visit %<expected>s` but found `visit %<actual>s`."
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
visit_blocks = find_visit_blocks(node)
|
|
13
|
-
return if visit_blocks.size < 2
|
|
14
|
-
|
|
15
|
-
check_ordering(visit_blocks)
|
|
16
|
-
end
|
|
17
|
-
|
|
18
|
-
private def find_visit_blocks(class_node)
|
|
19
|
-
visit_blocks = []
|
|
20
|
-
|
|
21
|
-
class_node.each_descendant(:block) do |block_node|
|
|
22
|
-
send_node = block_node.send_node
|
|
23
|
-
next unless visit_method_call?(send_node)
|
|
24
|
-
|
|
25
|
-
visit_blocks << {
|
|
26
|
-
node: block_node,
|
|
27
|
-
node_type: extract_node_type(send_node),
|
|
28
|
-
line: block_node.loc.line,
|
|
29
|
-
}
|
|
30
|
-
end
|
|
31
|
-
|
|
32
|
-
visit_blocks
|
|
33
|
-
end
|
|
34
|
-
|
|
35
|
-
private def visit_method_call?(node)
|
|
36
|
-
return false unless node.send_type?
|
|
37
|
-
node.method_name == :visit &&
|
|
38
|
-
node.arguments.size == 1 &&
|
|
39
|
-
node.first_argument.const_type?
|
|
40
|
-
end
|
|
41
|
-
|
|
42
|
-
private def extract_node_type(node)
|
|
43
|
-
node.first_argument.const_name
|
|
44
|
-
end
|
|
11
|
+
def_node_matcher :visited_constant, "(any_block (send nil? :visit $const) ...)"
|
|
45
12
|
|
|
46
|
-
|
|
47
|
-
|
|
13
|
+
def on_class(node)
|
|
14
|
+
return unless node.body&.begin_type?
|
|
48
15
|
|
|
49
|
-
|
|
50
|
-
|
|
16
|
+
blocks = node.body.children.select { |child| visited_constant(child) }
|
|
17
|
+
sorted = blocks.sort_by.with_index { |block, index| [node_type(block), index] }
|
|
51
18
|
|
|
52
|
-
|
|
53
|
-
|
|
19
|
+
actual, expected = blocks.zip(sorted).find { |block, sorted_block| !block.equal?(sorted_block) }
|
|
20
|
+
return unless actual
|
|
54
21
|
|
|
55
|
-
|
|
56
|
-
block[:node].send_node.first_argument,
|
|
57
|
-
message: format(MSG, expected: expected_type, actual: actual_type),
|
|
58
|
-
) do |corrector|
|
|
59
|
-
autocorrect(corrector, visit_blocks, sorted_blocks)
|
|
60
|
-
end
|
|
22
|
+
message = format(MSG, expected: node_type(expected), actual: node_type(actual))
|
|
61
23
|
|
|
62
|
-
|
|
63
|
-
|
|
24
|
+
add_offense(visited_constant(actual), message:) do |corrector|
|
|
25
|
+
blocks.zip(sorted) { |block, sorted_block| corrector.replace(block, sorted_block.source) }
|
|
64
26
|
end
|
|
65
27
|
end
|
|
66
28
|
|
|
67
|
-
private def
|
|
68
|
-
|
|
69
|
-
block_sources = {}
|
|
70
|
-
original_blocks.each do |block|
|
|
71
|
-
block_sources[block[:node_type]] = extract_block_source(block[:node])
|
|
72
|
-
end
|
|
73
|
-
|
|
74
|
-
# Replace each block with its sorted version
|
|
75
|
-
original_blocks.each_with_index do |original_block, index|
|
|
76
|
-
sorted_type = sorted_blocks[index][:node_type]
|
|
77
|
-
corrector.replace(
|
|
78
|
-
original_block[:node].source_range,
|
|
79
|
-
block_sources[sorted_type],
|
|
80
|
-
)
|
|
81
|
-
end
|
|
82
|
-
end
|
|
83
|
-
|
|
84
|
-
private def extract_block_source(block_node)
|
|
85
|
-
# Get the source including proper indentation
|
|
86
|
-
source = block_node.source
|
|
87
|
-
|
|
88
|
-
# Check if there's a blank line after this block
|
|
89
|
-
if has_blank_line_after?(block_node)
|
|
90
|
-
source += "\n"
|
|
91
|
-
end
|
|
92
|
-
|
|
93
|
-
source
|
|
94
|
-
end
|
|
95
|
-
|
|
96
|
-
private def has_blank_line_after?(node)
|
|
97
|
-
last_line = node.loc.end.line
|
|
98
|
-
next_line = last_line + 1
|
|
99
|
-
|
|
100
|
-
return false if next_line >= processed_source.lines.size
|
|
101
|
-
|
|
102
|
-
processed_source.lines[next_line].blank?
|
|
29
|
+
private def node_type(block)
|
|
30
|
+
visited_constant(block).const_name
|
|
103
31
|
end
|
|
104
32
|
end
|
|
105
33
|
end
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: refract
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version:
|
|
4
|
+
version: 2.0.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Joel Drapper
|
|
@@ -15,14 +15,14 @@ dependencies:
|
|
|
15
15
|
requirements:
|
|
16
16
|
- - ">="
|
|
17
17
|
- !ruby/object:Gem::Version
|
|
18
|
-
version: '0'
|
|
18
|
+
version: '1.0'
|
|
19
19
|
type: :runtime
|
|
20
20
|
prerelease: false
|
|
21
21
|
version_requirements: !ruby/object:Gem::Requirement
|
|
22
22
|
requirements:
|
|
23
23
|
- - ">="
|
|
24
24
|
- !ruby/object:Gem::Version
|
|
25
|
-
version: '0'
|
|
25
|
+
version: '1.0'
|
|
26
26
|
- !ruby/object:Gem::Dependency
|
|
27
27
|
name: zeitwerk
|
|
28
28
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -221,7 +221,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
221
221
|
requirements:
|
|
222
222
|
- - ">="
|
|
223
223
|
- !ruby/object:Gem::Version
|
|
224
|
-
version: '3.
|
|
224
|
+
version: '3.3'
|
|
225
225
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
226
226
|
requirements:
|
|
227
227
|
- - ">="
|