Class: Spoom::Sorbet::Translate::SorbetAssertionsToRBSComments

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

Overview

Translates Sorbet assertions to RBS comments.

Constant Summary collapse

LINE_BREAK =

: Integer

"\n".ord

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_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_node, #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_constant_write_node, #visit_def_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_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_module_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_singleton_class_node, #visit_source_encoding_node, #visit_source_file_node, #visit_source_line_node, #visit_splat_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:, translate_t_let: true, translate_t_cast: true, translate_t_bind: true, translate_t_must: true, translate_t_unsafe: true) ⇒ SorbetAssertionsToRBSComments

: ( | String, | file: String, | ?translate_t_let: bool, | ?translate_t_cast: bool, | ?translate_t_bind: bool, | ?translate_t_must: bool, | ?translate_t_unsafe: bool, | ) -> void



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/spoom/sorbet/translate/sorbet_assertions_to_rbs_comments.rb', line 20

def initialize(
  ruby_contents,
  file:,
  translate_t_let: true,
  translate_t_cast: true,
  translate_t_bind: true,
  translate_t_must: true,
  translate_t_unsafe: true
)
  super(ruby_contents, file: file)

  @translate_t_let = translate_t_let
  @translate_t_cast = translate_t_cast
  @translate_t_bind = translate_t_bind
  @translate_t_must = translate_t_must
  @translate_t_unsafe = translate_t_unsafe
end

Instance Method Details

#visit_if_node(node) ⇒ Object

: (Prism::IfNode) -> void



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/spoom/sorbet/translate/sorbet_assertions_to_rbs_comments.rb', line 49

def visit_if_node(node)
  if node.if_keyword_loc
    # We do not translate assertions in ternary expressions to avoid altering the semantic of the code.
    #
    # For example:
    # ```rb
    # a = T.must(b) ? T.must(c) : T.must(d)
    # ```
    #
    # would become
    # ```rb
    # a = T.must(b) ? T.must(c) : d #: !nil
    # ```
    #
    # which does not match the original intent.
    super
  end
end

#visit_statements_node(node) ⇒ Object

: (Prism::StatementsNode) -> void



40
41
42
43
44
45
 
# File 'lib/spoom/sorbet/translate/sorbet_assertions_to_rbs_comments.rb', line 40

def visit_statements_node(node)
  node.body.each do |statement|
    translated = maybe_translate_assertion(statement)
    visit(statement) unless translated
  end
end