Class: Spoom::Sorbet::Translate::SorbetSigsToRBSComments

Inherits:
Translator
  • Object
show all
Defined in:
lib/spoom/sorbet/translate/sorbet_sigs_to_rbs_comments.rb

Overview

Converts all ‘sig` nodes to RBS comments in the given Ruby code. It also handles type members and class annotations.

Instance Method Summary collapse

Methods inherited from Translator

#rewrite

Methods inherited from Visitor

#visit_alias_global_variable_node, #visit_alias_method_node, #visit_alternation_pattern_node, #visit_and_node, #visit_arguments_node, #visit_array_node, #visit_array_pattern_node, #visit_assoc_node, #visit_assoc_splat_node, #visit_back_reference_read_node, #visit_begin_node, #visit_block_argument_node, #visit_block_local_variable_node, #visit_block_node, #visit_block_parameter_node, #visit_block_parameters_node, #visit_break_node, #visit_call_and_write_node, #visit_call_operator_write_node, #visit_call_or_write_node, #visit_call_target_node, #visit_capture_pattern_node, #visit_case_match_node, #visit_case_node, #visit_child_nodes, #visit_class_variable_and_write_node, #visit_class_variable_operator_write_node, #visit_class_variable_or_write_node, #visit_class_variable_read_node, #visit_class_variable_target_node, #visit_class_variable_write_node, #visit_constant_and_write_node, #visit_constant_operator_write_node, #visit_constant_or_write_node, #visit_constant_path_and_write_node, #visit_constant_path_node, #visit_constant_path_operator_write_node, #visit_constant_path_or_write_node, #visit_constant_path_target_node, #visit_constant_path_write_node, #visit_constant_read_node, #visit_constant_target_node, #visit_defined_node, #visit_else_node, #visit_embedded_statements_node, #visit_embedded_variable_node, #visit_ensure_node, #visit_false_node, #visit_find_pattern_node, #visit_flip_flop_node, #visit_float_node, #visit_for_node, #visit_forwarding_arguments_node, #visit_forwarding_parameter_node, #visit_forwarding_super_node, #visit_global_variable_and_write_node, #visit_global_variable_operator_write_node, #visit_global_variable_or_write_node, #visit_global_variable_read_node, #visit_global_variable_target_node, #visit_global_variable_write_node, #visit_hash_node, #visit_hash_pattern_node, #visit_if_node, #visit_imaginary_node, #visit_implicit_node, #visit_implicit_rest_node, #visit_in_node, #visit_index_and_write_node, #visit_index_operator_write_node, #visit_index_or_write_node, #visit_index_target_node, #visit_instance_variable_and_write_node, #visit_instance_variable_operator_write_node, #visit_instance_variable_or_write_node, #visit_instance_variable_read_node, #visit_instance_variable_target_node, #visit_instance_variable_write_node, #visit_integer_node, #visit_interpolated_match_last_line_node, #visit_interpolated_regular_expression_node, #visit_interpolated_string_node, #visit_interpolated_symbol_node, #visit_interpolated_x_string_node, #visit_keyword_hash_node, #visit_keyword_rest_parameter_node, #visit_lambda_node, #visit_local_variable_and_write_node, #visit_local_variable_operator_write_node, #visit_local_variable_or_write_node, #visit_local_variable_read_node, #visit_local_variable_target_node, #visit_local_variable_write_node, #visit_match_last_line_node, #visit_match_predicate_node, #visit_match_required_node, #visit_match_write_node, #visit_missing_node, #visit_multi_target_node, #visit_multi_write_node, #visit_next_node, #visit_nil_node, #visit_no_keywords_parameter_node, #visit_numbered_parameters_node, #visit_numbered_reference_read_node, #visit_optional_keyword_parameter_node, #visit_optional_parameter_node, #visit_or_node, #visit_parameters_node, #visit_parentheses_node, #visit_pinned_expression_node, #visit_pinned_variable_node, #visit_post_execution_node, #visit_pre_execution_node, #visit_program_node, #visit_range_node, #visit_rational_node, #visit_redo_node, #visit_regular_expression_node, #visit_required_keyword_parameter_node, #visit_required_parameter_node, #visit_rescue_modifier_node, #visit_rescue_node, #visit_rest_parameter_node, #visit_retry_node, #visit_return_node, #visit_self_node, #visit_source_encoding_node, #visit_source_file_node, #visit_source_line_node, #visit_splat_node, #visit_statements_node, #visit_string_node, #visit_super_node, #visit_symbol_node, #visit_true_node, #visit_undef_node, #visit_unless_node, #visit_until_node, #visit_when_node, #visit_while_node, #visit_x_string_node, #visit_yield_node

Constructor Details

#initialize(ruby_contents, file:, positional_names:, max_line_length: nil, translate_generics: true, translate_helpers: true, translate_abstract_methods: true) ⇒ SorbetSigsToRBSComments

: ( | String, | file: String, | positional_names: bool, | ?max_line_length: Integer?, | ?translate_generics: bool, | ?translate_helpers: bool, | ?translate_abstract_methods: bool | ) -> void



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/spoom/sorbet/translate/sorbet_sigs_to_rbs_comments.rb', line 19

def initialize(
  ruby_contents,
  file:,
  positional_names:,
  max_line_length: nil,
  translate_generics: true,
  translate_helpers: true,
  translate_abstract_methods: true
)
  super(ruby_contents, file: file)

  @positional_names = positional_names #: bool
  @last_sigs = [] #: Array[[Prism::CallNode, RBI::Sig]]
  @class_annotations = [] #: Array[Prism::CallNode]
  @type_members = [] #: Array[String]
  @extend_t_helpers = [] #: Array[Prism::CallNode]
  @extend_t_generics = [] #: Array[Prism::CallNode]
  @seen_mixes_in_class_methods = false #: bool
  @max_line_length = max_line_length #: Integer?

  @translate_generics = translate_generics #: bool
  @translate_helpers = translate_helpers #: bool
  @translate_abstract_methods = translate_abstract_methods #: bool
end

Instance Method Details

#visit_call_node(node) ⇒ Object

: (Prism::CallNode) -> void



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/spoom/sorbet/translate/sorbet_sigs_to_rbs_comments.rb', line 100

def visit_call_node(node)
  case node.message
  when "sig"
    visit_sig(node)
  when "attr_reader", "attr_writer", "attr_accessor"
    visit_attr(node)
  when "extend"
    visit_extend(node)
  when "abstract!", "interface!", "sealed!", "final!", "requires_ancestor"
    @class_annotations << node
  when "mixes_in_class_methods"
    @seen_mixes_in_class_methods = true
  else
    super
  end
end

#visit_class_node(node) ⇒ Object

: (Prism::ClassNode) -> void



46
47
48
 
# File 'lib/spoom/sorbet/translate/sorbet_sigs_to_rbs_comments.rb', line 46

def visit_class_node(node)
  visit_scope(node) { super }
end

#visit_constant_write_node(node) ⇒ Object

: (Prism::ConstantWriteNode) -> void



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/spoom/sorbet/translate/sorbet_sigs_to_rbs_comments.rb', line 119

def visit_constant_write_node(node)
  return super unless @translate_generics

  call = node.value
  return super unless call.is_a?(Prism::CallNode)
  return super unless call.message == "type_member"

  @type_members << build_type_member_string(node)

  from = adjust_to_line_start(node.location.start_offset)
  to = adjust_to_line_end(node.location.end_offset)
  to = adjust_to_new_line(to)

  @rewriter << Source::Delete.new(from, to)
end

#visit_def_node(node) ⇒ Object

: (Prism::DefNode) -> void



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
 
# File 'lib/spoom/sorbet/translate/sorbet_sigs_to_rbs_comments.rb', line 64

def visit_def_node(node)
  last_sigs = collect_last_sigs
  return if last_sigs.empty?

  apply_member_annotations(last_sigs)

  # Build the RBI::Method node so we can print the method signature as RBS.
  builder = RBI::Parser::TreeBuilder.new(@ruby_contents, comments: [], file: @file)
  builder.visit(node)
  rbi_node = builder.tree.nodes.first #: as RBI::Method

  last_sigs.each do |node, sig|
    next if sig.is_abstract && !@translate_abstract_methods

    out = rbs_print(node.location.start_column) do |printer|
      printer.print_method_sig(rbi_node, sig)
    end
    @rewriter << Source::Replace.new(node.location.start_offset, node.location.end_offset, out)
  end

  if @translate_abstract_methods && last_sigs.any? { |_, sig| sig.is_abstract }
    @rewriter << Source::Replace.new(
      node.rparen_loc&.end_offset || node.name_loc.end_offset,
      node.location.end_offset - 1,
      if node.name.end_with?("=")
        indent = " " * node.location.start_column
        "\n#{indent}  raise NotImplementedError, \"Abstract method called\"\n#{indent}end"
      else
        " = raise NotImplementedError, \"Abstract method called\""
      end,
    )
  end
end

#visit_module_node(node) ⇒ Object

: (Prism::ModuleNode) -> void



52
53
54
 
# File 'lib/spoom/sorbet/translate/sorbet_sigs_to_rbs_comments.rb', line 52

def visit_module_node(node)
  visit_scope(node) { super }
end

#visit_singleton_class_node(node) ⇒ Object

: (Prism::SingletonClassNode) -> void



58
59
60
 
# File 'lib/spoom/sorbet/translate/sorbet_sigs_to_rbs_comments.rb', line 58

def visit_singleton_class_node(node)
  visit_scope(node) { super }
end